X-Git-Url: https://git.donarmstrong.com/?a=blobdiff_plain;f=Documentation%2Fincluded%2Fcompile.itexi;h=c3aa45de1cffeaaae70ba9c589b04c9e68eec87c;hb=5f2e79bd78f7c350167e61e38123d7a7db7ce362;hp=c05e013f5d79ff0a0968c81a51d84b4838ae2da8;hpb=5e44b5f4dba63d3649331e317286be089955edde;p=lilypond.git diff --git a/Documentation/included/compile.itexi b/Documentation/included/compile.itexi index c05e013f5d..c3aa45de1c 100644 --- a/Documentation/included/compile.itexi +++ b/Documentation/included/compile.itexi @@ -139,7 +139,9 @@ python@var{version}-dev @item @uref{http://flex.sourceforge.net/, Flex} @item @uref{http://fontforge.sf.net/, FontForge} (20060125 or -newer) +newer; 20100501 or newer is recommended; must be compiled +with @option{--enable-double}. Failure to do so can lead to +poor intersection calculations and poorly-rendered glyphs.) @item @uref{http://www.gnu.org/software/bison/, GNU Bison} @@ -394,7 +396,7 @@ directory. Here are the relevant lines taken from the output of By default, `@command{make@tie{}install}' will install all the files in @file{/usr/local/bin}, @file{/usr/local/lib} etc. You can specify an installation prefix other than @file{/usr/local} -using `@code{--prefix}', for instance `@code{--prefix=$HOME}'. +using `@option{--prefix}', for instance `@option{--prefix=$HOME}'. @end quotation A typical installation prefix is @file{$HOME/usr}: @@ -481,9 +483,9 @@ that case, running @samp{make} without the @option{-j} is advised. If you want to build multiple versions of LilyPond with different configuration settings, you can use the -@code{--enable-config=@var{CONF}} option of @command{configure}. -You should use @code{make@tie{}conf=@var{CONF}} to generate the -output in @file{out-@var{CONF}}. For example, suppose you want to +@option{--enable-config=@var{conf}} option of @command{configure}. +You should use @code{make@tie{}conf=@var{conf}} to generate the +output in @file{out-@var{conf}}. For example, suppose you want to build with and without profiling, then use the following for the normal build @@ -574,6 +576,7 @@ re-install. See @ref{Configuring target directories}. @menu * Documentation editor's edit/compile cycle:: * Building documentation:: +* Building a single document:: * Saving time with CPU_COUNT:: * AJAX search:: * Installing documentation:: @@ -602,7 +605,6 @@ Edit/compile cycle: 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 @@ -644,6 +646,25 @@ 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: + +@example +make LANGS='' doc +@end example + +@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 +make LANGS='de fr' doc +@end example + +@noindent Note that this will also compile the English version. + Compilation of documentation in Info format with images can be done separately by issuing: @@ -694,6 +715,33 @@ However, this will rebuild all of the manuals indiscriminately---it is more efficient to @command{touch} only the affected files. +@noindent +Another typical issue when switching branches between master and +lilypond/translation is the appearance/disappearance of translated +versions of some manuals. If you see such a warning from make: + +@example +No rule to make target `X', needed by `Y' +@end example + +@noindent +Your best bet is to delete the file Y.dep and to try again. + +@node Building a single document +@unnumberedsubsubsec Building a single document +It's possible to build a single document. For example, to rebuild +only @file{contributor.pdf}, do the following: + +@example +cd build/ +cd Documentation/ +touch ../../Documentation/contributor.texi +make out=www out-www/contributor.pdf +@end example + +If you are only working on a single document, test-building it in +this way can give substantial time savings - recreating +@file{contributor.pdf}, for example, takes a matter of seconds. @node Saving time with CPU_COUNT @unnumberedsubsubsec Saving time with @code{CPU_COUNT}