]> git.donarmstrong.com Git - lilypond.git/blobdiff - Documentation/included/compile.itexi
Creates make log-clean and documents it
[lilypond.git] / Documentation / included / compile.itexi
index b9cfb9c45f32201e22a26451f1dda33bb034aefe..eb24c591807cdecbf7ab1df8e0d1a72ce6fa0bb3 100644 (file)
@@ -616,9 +616,11 @@ make [-j@var{X} CPU_COUNT=@var{X}] doc  @emph{## usually faster than initial bui
 @item
 Reset:
 
-In some cases, it is possible to clean the compiled documentation
-with @samp{make@tie{}doc-clean}, but this method is not guaranteed
-to fix everything.  Instead, we recommend that you delete your
+It is generally possible to remove the compiled documentation from
+your system
+with @samp{make@tie{}doc-clean}, but this method is not 100%
+guaranteed.  Instead, if you want to be sure you have a clean
+system, we recommend that you delete your
 @file{build/} directory, and begin compiling from scratch.  Since
 the documentation compile takes much longer than the
 non-documentation compile, this does not increase the overall time
@@ -660,9 +662,20 @@ the docs.  Please do not complain about anything which is broken
 in those places; the only complete set of documentation is in
 @file{out-www/offline-root/} from the top of the source tree.
 
-@code{make doc} compiles the documents for all languages.  To save
-some compile time, the English language documents can be compiled
-on their own with:
+@command{make@tie{}doc} sends the output from most of the
+compilation to logfiles.  If the build fails for any reason, it
+should prompt you with the name of a logfile which will provide
+information to help you work out why the build failed.  These
+logfiles are not deleted with @command{make@tie{}doc-clean}.  To
+remove all the logfiles generated by the compilation process, use:
+
+@example
+make log-clean
+@end example
+
+@code{make@tie{}doc} compiles the documents for all languages.  To
+save some compile time, the English language documents can be
+compiled on their own with:
 
 @example
 make LANGS='' doc