Doc-de: update macros.itely and nitpicks

[lilypond.git] / Documentation / devel / lsr-work.itexi

diff --git a/Documentation/devel/lsr-work.itexi b/Documentation/devel/lsr-work.itexi
index 033cc98e8a95fac44806fc70d0b5977355ea899b..b3d49963440ce6b312376f31c78c2204d7cc0429 100644 (file)
--- a/Documentation/devel/lsr-work.itexi
+++ b/Documentation/devel/lsr-work.itexi
@@ -200,26 +200,29 @@ In any case, commit all changes to Git.
 
 
 @node Updating LSR to a new version
-@subsection Uptating LSR to a new version
+@section Updating LSR to a new version
 
-To update LSR,
+To update LSR, perform the following steps:
 
 @enumerate
 
 @item
 Download the latest snippet tarball, extract it, and run
-convert-ly on all files.
+@code{convert-ly} on all files using the command-line option
+@code{--to=VERSION} to ensure snippets are updated to the
+correct stable version.
 
 @item
-Copy relevant snippets (i.e. snippets whose version is equal to or
-less than the new version of lilypond) from @file{input/new/} into
+Copy relevant snippets (i.e., snippets whose version is equal to or
+less than the new version of LilyPond) from @file{input/new/} into
 the tarball.
 
 You must not rename any files during this, or the next, stage.
 
 @item
-Verify that all files compile with the new version of lilypond,
-ideally without any warnings or errors.
+Verify that all files compile with the new version of LilyPond,
+ideally without any warnings or errors.  To ease the process,
+you may use the shell script that appears after this list.
 
 Due to the workload involved, we @emph{do not} require that you
 verify that all snippets produce the expected output.  If you
@@ -239,3 +242,19 @@ included, then delete those snippets from @file{input/new/}.
 @end enumerate
 
 
+Here is a shell script to run all @code{.ly} files in a directory
+and redirect terminal output to text files, which are then
+searched for the word "failed" to see which snippets do not compile.
+
+@example
+#!/bin/bash
+
+for LILYFILE in *.ly
+do
+  STEM=$(basename "$LILYFILE" .ly)
+  echo "running $LILYFILE..."
+  lilypond --format=png -ddelete-intermediate-files "$LILYFILE" >& "$STEM".txt
+done
+
+grep failed *.txt
+@end example