]> git.donarmstrong.com Git - lilypond.git/commitdiff
Doc: CG: add instructions for building ajax search.
authorGraham Percival <graham@percival-music.ca>
Thu, 6 May 2010 15:33:29 +0000 (16:33 +0100)
committerGraham Percival <graham@percival-music.ca>
Fri, 28 May 2010 10:50:28 +0000 (11:50 +0100)
Documentation/included/compile.itexi

index 777582166d2feb0dd69e1d560575683049fdfdf3..ea38bd7847b140b85e018a1255bb87e1a1e0d6da 100644 (file)
@@ -568,6 +568,7 @@ re-install.  See @ref{Configuring target directories}.
 * Documentation editor's edit/compile cycle::
 * Building documentation::
 * Saving time with @code{CPU_COUNT}::
+* AJAX search::
 * Installing documentation::
 * Building documentation without compiling::
 @end menu
@@ -711,6 +712,23 @@ it is possible for @samp{make -j5 CPU_COUNT=5 doc} to work
 consistently even if @samp{make -j5} rarely succeeds.
 
 
+@node AJAX search
+@unnumberedsubsubsec AJAX search
+
+To build the documentation with interactive searching, use:
+
+@example
+make doc AJAX_SEARCH=1
+@end example
+
+This requires PHP, and you must view the docs via a http
+connection (you cannot view them on your local filesystem).
+
+@warning{Due to potential security or load issues, this option is
+not enabled in the official documentation builds.  Enable at your
+own risk.}
+
+
 @node Installing documentation
 @unnumberedsubsubsec Installing documentation