]> git.donarmstrong.com Git - lilypond.git/commitdiff
Doc: CG: add --preview instructions to Issues.
authorGraham Percival <graham@percival-music.ca>
Fri, 25 Jun 2010 20:21:08 +0000 (21:21 +0100)
committerGraham Percival <graham@percival-music.ca>
Sat, 26 Jun 2010 05:11:31 +0000 (06:11 +0100)
Documentation/contributor/issues.itexi

index 5748f78cc8ba159f089c09aae2eab4e562fc32ae..bf90f06edcb73dd00149127ce771a81e6bea3a9c 100644 (file)
@@ -594,6 +594,36 @@ Add the issue and classify it according to the guidelines in
 @ref{Issue classification}.  In particular, the item should have
 @code{Status}, @code{Type-}, and @code{Priority-} labels.
 
+Include output with the first applicable method:
+
+@itemize
+
+@item
+If the issue has a notation example which fits in one system,
+generate a small @file{bug.preview.png} file with:
+
+@example
+lilypond -dpreview bug.ly
+@end example
+
+@item
+If the issue has an example which requires more than one system
+(i.e. a spacing bug), generate a @file{bug.png} file with:
+
+@example
+lilypond --png bug.ly
+@end example
+
+@item
+If the issue requires multi-page output, then generate a
+@file{bug.pdf} file with the normal:
+
+@example
+lilypond --png bug.ly
+@end example
+
+@end itemize
+
 @item
 After adding the issue, please send a response email to the same
 group(s) that the initial patch was sent to.  If the initial email