]> git.donarmstrong.com Git - lilypond.git/commitdiff
CG tweak: some extra info on make doc and doc build times
authorJoseph Wakeling <joseph.wakeling@gmail.com>
Mon, 11 Jun 2012 11:02:01 +0000 (12:02 +0100)
committerPhil Holmes <mail@philholmes.net>
Mon, 11 Jun 2012 11:04:33 +0000 (12:04 +0100)
Documentation/included/compile.itexi

index 9b99b766fa4a5d2399df781ec7b6ca918e3a3371..b9cfb9c45f32201e22a26451f1dda33bb034aefe 100644 (file)
@@ -458,6 +458,10 @@ make help
 
 TODO: Describe what @command{make} actually does.
 
+@seealso
+@ref{Generating documentation} provides more info on the @command{make} targets
+used to build the LilyPond documentation.
+
 
 @node Saving time with the -j option
 @subsection Saving time with the @option{-j} option
@@ -593,7 +597,8 @@ Initial documentation build:
 
 @example
 make [-j@var{X}]
-make [-j@var{X} CPU_COUNT=@var{X}] doc  @emph{## can take an hour or more}
+make [-j@var{X} CPU_COUNT=@var{X}] doc          @emph{## can take an hour or more}
+make [-j@var{X} CPU_COUNT=@var{X}] doc-stage-1  @emph{## to build only PDF documentation}
 @end example
 
 @item
@@ -631,11 +636,20 @@ documentation can be built by issuing:
 make doc
 @end example
 
-The first time you run @command{make@tie{}doc}, the process can
-easily take an hour or more.  After that, @command{make@tie{}doc}
-only makes changes to the pre-built documentation where needed,
-so it may only take a minute or two to test changes if the
-documentation is already built.
+or, to build only the PDF documentation and not the HTML,
+
+@example
+make doc-stage-1
+@end example
+
+@warning{The first time you run @command{make@tie{}doc}, the
+process can easily take an hour or more with not much output
+on the command line.}
+
+After this initial build, @command{make@tie{}doc} only makes
+changes to the documentation where needed, so it may only take
+a minute or two to test changes if the documentation is already
+built.
 
 If @command{make@tie{}doc} succeeds, the HTML documentation tree
 is available in @file{out-www/offline-root/}, and can be browsed