]> git.donarmstrong.com Git - lilypond.git/commitdiff
Doc: CG: minor additions.
authorGraham Percival <graham@percival-music.ca>
Sun, 20 Dec 2009 23:57:49 +0000 (23:57 +0000)
committerGraham Percival <graham@percival-music.ca>
Sun, 20 Dec 2009 23:57:49 +0000 (23:57 +0000)
Documentation/contributor/doc-work.itexi
Documentation/contributor/lsr-work.itexi
Documentation/contributor/release-work.itexi

index 02ecf2fc1d29594f6f93e05f2bf193463b26c58f..0633d36430f7e0f549dfa463887f5fd5d348a253 100644 (file)
@@ -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
 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/.
 
 cross-references in the generated documentation such as the
 Internals Reference; e.g. you can grep scm/ and lily/.
 
index 371aa6cedae3c959d1f7b18a8c4f6c21a0e7af98..11a70d0ca254ab4ff8e91e9761be147a61241493 100644 (file)
@@ -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}.
 
 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.
 @item
 If the snippet uses scheme, check that everything looks good and
 there are no security risks.
index c5ef80ce93b32f039f0b741c0eeda892c64c3d8d..af2721ef2db19c10cba9b9f56c34adabaca2afce 100644 (file)
@@ -174,6 +174,11 @@ translation@@iro.umontreal.ca, mentioning lilypond-VERSION.pot
 
 * Run convert-ly on all files, bump parser minimum version.
 
 
 * 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:
 * Make FTP directories on lilypond.org
 
 * website: