From: Tomek Mrugalski <tomasz@isc.org>
Date: Mon, 4 Feb 2019 13:40:44 +0000 (+0100)
Subject: [#117,!207] --enable-generate-docs documented.
X-Git-Tag: 441-make-distcheck-fails-on-fedora-29_base~5
X-Git-Url: http://git.ipfire.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=549408276287dd8bd2319b7937e221945c78a1d6;p=thirdparty%2Fkea.git

[#117,!207] --enable-generate-docs documented.
---

diff --git a/doc/guide/install.xml b/doc/guide/install.xml
index fa2f4ef13b..9a63c30570 100644
--- a/doc/guide/install.xml
+++ b/doc/guide/install.xml
@@ -185,12 +185,12 @@ Debian and Ubuntu:
         <listitem>
         <para>
           Cpp-driver from DataStax is needed when using the --with-cql
-	  configuration flag to build Kea with Cassandra database backend.
+          configuration flag to build Kea with Cassandra database backend.
           In this case an instance of the Cassandra server running locally
           or on some other machine, reachable over the network from the
           machine running Kea, is required. Note that running the unit
           tests requires a local Cassandra server.
-	</para>
+        </para>
         </listitem>
 
         <listitem>
@@ -373,31 +373,6 @@ Debian and Ubuntu:
             </listitem>
           </varlistentry>
 
-          <varlistentry>
-            <term>--with-gtest, --with-gtest-source</term>
-            <listitem>
-              <simpara>Enable the building of the C++ Unit Tests using the
-                Google Test framework. This option specifies the path to the
-                gtest source. (If the framework
-                is not installed on your system, it can be downloaded
-                from <uri xmlns:xlink="http://www.w3.org/1999/xlink" xlink:href="https://github.com/google/googletest">https://github.com/google/googletest</uri>.)
-                from <ulink url="https://github.com/google/googletest"/>.)
-              </simpara>
-            </listitem>
-          </varlistentry>
-
-          <varlistentry>
-            <term>--with-benchmark, --with-benchmark-source</term>
-            <listitem>
-              <simpara>Enable the building of the database backend
-              benchmarks using the Google Benchmark framework. This
-              option specifies the path to the gtest source. (If the
-              framework is not installed on your system, it can be downloaded
-              from <ulink url="https://github.com/google/benchmark"/>.)
-              </simpara>
-            </listitem>
-          </varlistentry>
-
           <varlistentry>
             <term>--with-log4cplus</term>
             <listitem>
@@ -426,7 +401,85 @@ Debian and Ubuntu:
             </para>
           </note>
         </para>
-  <!-- TODO: lcov -->
+        <!-- TODO: lcov -->
+
+        <para>
+          There are also many additional options that are typically not used by
+          regular users. However, they may be useful for package maintainers,
+          developers or people who want to extend Kea code or send patches:
+          <variablelist>
+
+            <varlistentry>
+              <term>--enable-generate-docs</term>
+              <listitem>
+                <simpara>Enable the rebuilding Kea documentation. ISC publishes
+                Kea documentation for each release. However, in some cases you
+                may want to rebuild it. For example, if you want to change
+                something in the docs, or want to generate new one from git
+                sources that are not released yet.
+                <!-- @todo: describe what's needed here (xsltproc, also describe
+                     nonet variable -->
+                </simpara>
+              </listitem>
+            </varlistentry>
+
+            <varlistentry>
+              <term>--with-gtest, --with-gtest-source</term>
+              <listitem>
+                <simpara>Enable the building of the C++ Unit Tests using the
+                Google Test framework. This option specifies the path to the
+                gtest source. (If the framework
+                is not installed on your system, it can be downloaded
+                from <uri xmlns:xlink="http://www.w3.org/1999/xlink" xlink:href="https://github.com/google/googletest">https://github.com/google/googletest</uri>.)
+                from <ulink url="https://github.com/google/googletest"/>.)
+                </simpara>
+              </listitem>
+            </varlistentry>
+
+            <varlistentry>
+              <term>--enable-generate-docs</term>
+              <listitem>
+                <simpara>Enable the rebuilding Kea documentation. ISC publishes
+                Kea documentation for each release. However, in some cases you
+                may want to rebuild it. For example, if you want to change
+                something in the docs, or want to generate new one from git
+                sources that are not released yet.
+                <!-- @todo: describe what's needed here (xsltproc, also describe
+                     nonet variable -->
+                </simpara>
+              </listitem>
+            </varlistentry>
+
+            <varlistentry>
+              <term>--enable-generate-parser</term>
+              <listitem>
+                <simpara>Many Kea components have parsers implemented using Flex
+                (.ll files) and Bison (.yy files). Kea sources have C++/h files
+                generated out from them. By default Kea does not use Flex or
+                Bison to avoid requiring installation of unnecessary
+                dependencies for users. However, if you change anything in the
+                parses (such as add new parameter), you will need to use Flex
+                and Bison to regenerate parsers. This option lets you do that.
+                </simpara>
+              </listitem>
+            </varlistentry>
+
+            <varlistentry>
+              <term>--with-benchmark, --with-benchmark-source</term>
+              <listitem>
+                <simpara>Enable the building of the database backend
+                benchmarks using the Google Benchmark framework. This
+                option specifies the path to the gtest source. (If the
+                framework is not installed on your system, it can be downloaded
+                from <ulink url="https://github.com/google/benchmark"/>.)
+                This support is experimental.
+                </simpara>
+              </listitem>
+            </varlistentry>
+
+          </variablelist>
+        </para>
+
 
         <para>
           For example, the following command configures Kea to find the