Commit 54940827 authored by Tomek Mrugalski's avatar Tomek Mrugalski 🛰 Committed by Francis Dupont

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

parent ec3e03eb
......@@ -373,6 +373,56 @@ Debian and Ubuntu:
</listitem>
</varlistentry>
<varlistentry>
<term>--with-log4cplus</term>
<listitem>
<simpara>Define the path to find the Log4cplus headers
and libraries.
</simpara>
</listitem>
</varlistentry>
<varlistentry>
<term>--with-openssl</term>
<listitem>
<simpara>Replace Botan by the OpenSSL the cryptographic library.
By default <command>configure</command> searches for a valid
Botan installation:
if one is not found, it searches for OpenSSL.
</simpara>
</listitem>
</varlistentry>
</variablelist>
<note>
<para>
For instructions concerning the installation and configuration
of database backends for Kea, see <xref linkend="dhcp-install-configure"/>.
</para>
</note>
</para>
<!-- 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>
......@@ -387,46 +437,49 @@ Debian and Ubuntu:
</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"/>.)
<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-log4cplus</term>
<listitem>
<simpara>Define the path to find the Log4cplus headers
and libraries.
<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-openssl</term>
<term>--with-benchmark, --with-benchmark-source</term>
<listitem>
<simpara>Replace Botan by the OpenSSL the cryptographic library.
By default <command>configure</command> searches for a valid
Botan installation:
if one is not found, it searches for OpenSSL.
<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>
<note>
<para>
For instructions concerning the installation and configuration
of database backends for Kea, see <xref linkend="dhcp-install-configure"/>.
</para>
</note>
</para>
<!-- TODO: lcov -->
<para>
For example, the following command configures Kea to find the
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment