From 208ca566e216f6d734501d3dad2a880643578f81 Mon Sep 17 00:00:00 2001 From: Graham Percival Date: Wed, 5 Jan 2011 05:22:07 +0000 Subject: [PATCH] CG: add warnings for docs to Quick start. --- Documentation/contributor/quick-start.itexi | 19 ++++++++++++------- Documentation/included/compile.itexi | 11 ++++++++--- 2 files changed, 20 insertions(+), 10 deletions(-) diff --git a/Documentation/contributor/quick-start.itexi b/Documentation/contributor/quick-start.itexi index a8e4e0d6be..e0ea3f6554 100644 --- a/Documentation/contributor/quick-start.itexi +++ b/Documentation/contributor/quick-start.itexi @@ -449,13 +449,7 @@ you bookmark the resulting page: firefox ~/lilypond-git/build/out-www/offline-root/index.html @end example -@subsubheading Other options - -To select different build options, or isolate certain parts of the -build, or to use multiple CPUs while building, read the rest of -this chapter. - -@subsubheading Installing LilyPond with lilydev +@subsubheading Installing Don't. There is no reason to install lilypond within lilydev. All development work can (and should) stay within the @@ -463,6 +457,17 @@ All development work can (and should) stay within the or typesetting work should be done with an official GUB release. +@subsubheading Problems and other options + +To select different build options, or isolate certain parts of the +build, or to use multiple CPUs while building, read +@ref{Compiling}. + +In particular, contributors working on the documentation should be +aware of some bugs in the build system, and should read the +workarounds in @ref{Generating documentation}. + + @node Now start work! @section Now start work! diff --git a/Documentation/included/compile.itexi b/Documentation/included/compile.itexi index 731aa58c0c..c05e013f5d 100644 --- a/Documentation/included/compile.itexi +++ b/Documentation/included/compile.itexi @@ -609,9 +609,14 @@ make [-j@var{X} CPU_COUNT=@var{X}] doc @emph{## usually faster than initial bui @item Reset: -@example -make doc-clean @emph{## use only as a last resort.} -@end example +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 +@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 +by a great deal. + @end itemize @node Building documentation -- 2.39.5