From 025a91a5c119234c5849b790d9bfe20e6ffe2a26 Mon Sep 17 00:00:00 2001
From: Trevor Daniels <t.daniels@treda.co.uk>
Date: Fri, 9 Mar 2012 17:42:59 +0000
Subject: [PATCH] Improve auxiliar/doc-section.sh

This is intended to quickly compile a section
of the manuals as a check during doc editing,
but parts of it were broken.  This patch returns
it to a usable state.

 - fix help

 - automatically invoke browser to view output

 - add choice of browser

 - fix pictures

 - re-implement option to delete or retain
   temp files
---
 scripts/auxiliar/doc-section.sh | 27 ++++++++++++++++++---------
 1 file changed, 18 insertions(+), 9 deletions(-)

diff --git a/scripts/auxiliar/doc-section.sh b/scripts/auxiliar/doc-section.sh
index 2c6b557a9a..963476840a 100755
--- a/scripts/auxiliar/doc-section.sh
+++ b/scripts/auxiliar/doc-section.sh
@@ -37,14 +37,15 @@
 
 usage () {
     cat <<EOF >&2
-Usage: $0 MANUAL SECTION
 
+Usage: $0 MANUAL SECTION
 e.g. $0 notation rhythms
+
 EOF
     exit "$1"
 }
 
-if [ "$1" == '-h' ] || [ "$1" == '--help' ]; then
+if [ "$1" = '-h' ] || [ "$1" = '--help' ]; then
     usage 0
 fi
 
@@ -59,6 +60,13 @@ else
     echo "\$LILYPOND_GIT was not set; auto-detected source tree at $LILYPOND_GIT"
 fi
 
+if [ -n "$BROWSER" ]; then
+    echo "Using browser from \$BROWSER: $BROWSER"
+else
+    echo "\$BROWSER not set; using firefox as default"
+    BROWSER="firefox"
+fi
+
 if test ! -e "$LILYPOND_GIT/DEDICATION"; then
     echo "Error: $LILYPOND_GIT did not look like a LilyPond source tree; aborting." >&2
     exit 1
@@ -105,6 +113,7 @@ fi
 cp "$LILYPOND_GIT/Documentation/common-macros.itexi" "$OUTPUT_DIR/common-macros.itexi"
 cp "$LILYPOND_GIT/Documentation/macros.itexi" "$DOC_DIR/macros.itexi"
 cp "$DOC_DIR/version.itexi" "$OUTPUT_DIR/version.itexi"
+cp -r "$LILYPOND_GIT/Documentation/pictures/" "$OUTPUT_DIR/out/pictures"
 
 if test -e "$OUTPUT_DIR/$SECTION.html"; then
     rm "$OUTPUT_DIR/$SECTION.html"
@@ -145,19 +154,19 @@ if test -f "$OUTPUT_DIR/out/$SECTION.texi"; then
         "$OUTPUT_DIR/$SECTION.texi"
 fi
 
-cat <<EOF
+echo "Displaying output in $BROWSER; close browser window when done."
 
-The $SECTION section of the $MANUAL manual should now be viewable at
+$BROWSER $OUTPUT_DIR/out/$SECTION.html
 
-  $OUTPUT_DIR/out/$SECTION.html
+cat <<EOF
 
-If you want to keep the generated docs around for a while, answer
-'n' to the next question.  If you only needed them to quickly check
-something, view them now and then answer 'y' when you're done.
+If you want to avoid recompiling the snippets on the next 
+invocation with '$MANUAL $SECTION', answer 'n' to the next question.
 
 EOF
 
-read -p "rm -rf $OUTPUT_DIR ? (y/n): "
+echo "Delete temp files? [y/n]"
+read REPLY;
 if [ "$REPLY" = "y" ]; then
     echo "deleting files"
     rm -rf "$OUTPUT_DIR"
-- 
2.39.2