From d03a3486639de982cfb6c6c315d76039bc5a0ac5 Mon Sep 17 00:00:00 2001 From: Graham Percival Date: Sun, 20 Dec 2009 23:57:49 +0000 Subject: [PATCH] Doc: CG: minor additions. --- Documentation/contributor/doc-work.itexi | 11 ++++++++--- Documentation/contributor/lsr-work.itexi | 4 ++++ Documentation/contributor/release-work.itexi | 5 +++++ 3 files changed, 17 insertions(+), 3 deletions(-) diff --git a/Documentation/contributor/doc-work.itexi b/Documentation/contributor/doc-work.itexi index 02ecf2fc1d..0633d36430 100644 --- a/Documentation/contributor/doc-work.itexi +++ b/Documentation/contributor/doc-work.itexi @@ -891,9 +891,14 @@ documentation, but they are not checked during compilation. However, if you compile the documentation, a script called check_texi_refs can help you with checking and fixing these cross-references; for information on usage, cd into a source tree -where documentation has been built, cd into Documentation and look -for check-xrefs and fix-xrefs targets in 'make help' output. Note -that you have to find yourself the source files to fix +where documentation has been built, cd into Documentation and run: + +@example +make check-xrefs +make fix-xrefs +@end example + +Note that you have to find yourself the source files to fix cross-references in the generated documentation such as the Internals Reference; e.g. you can grep scm/ and lily/. diff --git a/Documentation/contributor/lsr-work.itexi b/Documentation/contributor/lsr-work.itexi index 371aa6ceda..11a70d0ca2 100644 --- a/Documentation/contributor/lsr-work.itexi +++ b/Documentation/contributor/lsr-work.itexi @@ -106,6 +106,10 @@ the @qq{docs} tag and at least one other tag. If the snippet is tagged with @qq{docs}, check to see if it matches our guidelines for @ref{LilyPond formatting}. +Also, snippets tagged with @qq{docs} should not be explaining +(replicating) existing material in the docs. They should not +refer to the docs; the docs should refer to them. + @item If the snippet uses scheme, check that everything looks good and there are no security risks. diff --git a/Documentation/contributor/release-work.itexi b/Documentation/contributor/release-work.itexi index c5ef80ce93..af2721ef2d 100644 --- a/Documentation/contributor/release-work.itexi +++ b/Documentation/contributor/release-work.itexi @@ -174,6 +174,11 @@ translation@@iro.umontreal.ca, mentioning lilypond-VERSION.pot * Run convert-ly on all files, bump parser minimum version. +* update links to distros providing lilypond packages? link in +Documentation/web/download.itexi . This has nothing to do with +the release, but I'm dumping this here so I'll find it when I +reorganize this list later. -gp + * Make FTP directories on lilypond.org * website: -- 2.39.2