From: Graham Percival <graham@percival-music.ca>
Date: Fri, 25 Jun 2010 20:21:08 +0000 (+0100)
Subject: Doc: CG: add --preview instructions to Issues.
X-Git-Tag: release/2.13.26-1~3
X-Git-Url: https://git.donarmstrong.com/?a=commitdiff_plain;h=8b2668b700e048bd34b025ebc2af3a8e9ff862a6;p=lilypond.git

Doc: CG: add --preview instructions to Issues.
---

diff --git a/Documentation/contributor/issues.itexi b/Documentation/contributor/issues.itexi
index 5748f78cc8..bf90f06edc 100644
--- a/Documentation/contributor/issues.itexi
+++ b/Documentation/contributor/issues.itexi
@@ -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