From ade906dcd40bfd2ffb37401252a86cbfc58e6661 Mon Sep 17 00:00:00 2001 From: Graham Percival Date: Thu, 6 May 2010 16:33:29 +0100 Subject: [PATCH] Doc: CG: add instructions for building ajax search. --- Documentation/included/compile.itexi | 18 ++++++++++++++++++ 1 file changed, 18 insertions(+) diff --git a/Documentation/included/compile.itexi b/Documentation/included/compile.itexi index 777582166d..ea38bd7847 100644 --- a/Documentation/included/compile.itexi +++ b/Documentation/included/compile.itexi @@ -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 -- 2.39.2