From 14a5d8d1cbb74553ca6c45c97c33cb20c836fc72 Mon Sep 17 00:00:00 2001 From: Joseph Wakeling Date: Mon, 11 Jun 2012 12:02:01 +0100 Subject: [PATCH] CG tweak: some extra info on make doc and doc build times --- Documentation/included/compile.itexi | 26 ++++++++++++++++++++------ 1 file changed, 20 insertions(+), 6 deletions(-) diff --git a/Documentation/included/compile.itexi b/Documentation/included/compile.itexi index 9b99b766fa..b9cfb9c45f 100644 --- a/Documentation/included/compile.itexi +++ b/Documentation/included/compile.itexi @@ -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 -- 2.39.5