Attempts to compile LilyPond natively on Windows have been
unsuccessful, though a workaround is available (see
-@rcontrib{Lilydev}).
+@rcontrib{LilyDev}).
@node Requirements
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
@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
make [-j@var{X}] @emph{## needed if editing outside}
@emph{## Documentation/, but useful anyway}
@emph{## for finding Texinfo errors.}
-touch Documentation/*te?? @emph{## bug workaround}
make [-j@var{X} CPU_COUNT=@var{X}] doc @emph{## usually faster than initial build.}
@end example
@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
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
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 LANGS='' doc
+make log-clean
@end example
-Compilation of documentation in Info format with images can be
-done separately by issuing:
+@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 info
+make LANGS='' doc
@end example
-@knownissues
-
-If source files have changed since the last documentation build,
-output files that need to be rebuilt are normally rebuilt, even if
-you do not run @code{make@tie{}doc-clean} first. However, build
-dependencies in the documentation are so complex that some
-newly-edited files may not be rebuilt as they should be; a
-workaround is to @command{touch} the top source file for any
-manual you've edited. For example, if you make changes to a file
-in @file{notation/}, do:
+@noindent Similarly, it is possible to compile a subset of the
+translated documentation by specifying their language codes on the
+command line. For example, the French and German translations are
+compiled with:
@example
-touch Documentation/notation.tely
+make LANGS='de fr' doc
@end example
-@noindent
-The top sources possibly affected by this are:
+@noindent Note that this will also compile the English version.
+
+Compilation of documentation in Info format with images can be
+done separately by issuing:
@example
-Documentation/extend.texi
-Documentation/changes.tely
-Documentation/contributor.texi
-Documentation/essay.tely
-Documentation/extending.tely
-Documentation/learning.tely
-Documentation/notation.tely
-Documentation/snippets.tely
-Documentation/usage.tely
-Documentation/web.texi
+make info
@end example
@noindent
-You can @command{touch} all of them at once with:
+An issue when switching branches between master and translation
+is the appearance/disappearance of translated versions of some manuals.
+If you see such a warning from make:
@example
-touch Documentation/*te??
+No rule to make target `X', needed by `Y'
@end example
@noindent
-However, this will rebuild all of the manuals
-indiscriminately---it is more efficient to @command{touch} only
-the affected files.
+Your best bet is to delete the file Y.dep and to try again.
@node Building a single document
@unnumberedsubsubsec Building a single document