mir/kea
2
0
Fork 0
mirror of https://gitlab.isc.org/isc-projects/kea synced 2025-09-01 06:25:34 +00:00
Code Issues Releases Wiki Activity

[#3905] Fix more Meson flag documentation

Browse Source
This commit is contained in:
Andrei Pavel
2025-05-30 09:27:49 +03:00
parent 30c5499567
commit d85666cf22
3 changed files with 13 additions and 13 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
doc/devel/unit-tests.dox
View File

@@ -19,7 +19,7 @@ to mimic its installation. Meson tries its best to accommodate all typical
situations and to locate gtest on its own. If it cannot be found, linking situations and to locate gtest on its own. If it cannot be found, linking
/usr/src/googletest to the custom location should do the trick. If that does /usr/src/googletest to the custom location should do the trick. If that does
not work either, the Kea project has a gtest.wrap which instructs it how to not work either, the Kea project has a gtest.wrap which instructs it how to
fetch googletest on its own. The `-D tests` flag has to be provided. fetch googletest on its own. The `-D tests=enabled` flag has to be provided.
@code @code
meson setup build -D tests=enabled meson setup build -D tests=enabled

4
doc/sphinx/arm/config-backend.rst
View File

@@ -165,13 +165,13 @@ CB Components
To use a MySQL configuration backend, :ischooklib:`libdhcp_mysql.so` must To use a MySQL configuration backend, :ischooklib:`libdhcp_mysql.so` must
be compiled and the DHCP servers must be configured to load it. It is compiled be compiled and the DHCP servers must be configured to load it. It is compiled
when the ``-D mysql`` configuration switch is used during the Kea build. when the ``-D mysql=enabled`` configuration switch is used during the Kea build.
The MySQL C client libraries must be installed, as explained in The MySQL C client libraries must be installed, as explained in
:ref:`dhcp-install-configure`. :ref:`dhcp-install-configure`.
To use a PostgreSQL configuration backend, :ischooklib:`libdhcp_pgsql.so` must To use a PostgreSQL configuration backend, :ischooklib:`libdhcp_pgsql.so` must
be compiled and the DHCP servers must be configured to load it. It is compiled be compiled and the DHCP servers must be configured to load it. It is compiled
when the ``-D pgsql`` configuration switch is used during the Kea build. when the ``-D postgresql=enabled`` configuration switch is used during the Kea build.
The PostgreSQL C client libraries must be installed, as explained in The PostgreSQL C client libraries must be installed, as explained in
:ref:`dhcp-install-configure`. :ref:`dhcp-install-configure`.

20
doc/sphinx/arm/install.rst
View File

@@ -172,7 +172,7 @@ the system:
- The development tools automake, libtool, and pkg-config. - The development tools automake, libtool, and pkg-config.
- The MySQL client and the client development libraries, when using the - The MySQL client and the client development libraries, when using the
``-D mysql`` configuration flag to build the Kea MySQL database ``-D mysql=enabled`` configuration flag to build the Kea MySQL database
backend. In this case, an instance of the MySQL server running locally backend. In this case, an instance of the MySQL server running locally
or on a machine reachable over a network is required. Note that running or on a machine reachable over a network is required. Note that running
the unit tests requires a local MySQL server. the unit tests requires a local MySQL server.
@@ -185,17 +185,17 @@ the system:
- Sysrepo v1.4.140 and libyang v1.0.240, needed to connect to a Sysrepo - Sysrepo v1.4.140 and libyang v1.0.240, needed to connect to a Sysrepo
datastore. Earlier versions are no longer supported. When compiling from datastore. Earlier versions are no longer supported. When compiling from
sources, the configure switch that can be used is ``-D netconf``. sources, the configure switch that can be used is ``-D netconf=enabled``.
If these dependencies were installed in custom paths, point PKG_CONFIG_PATH If these dependencies were installed in custom paths, point PKG_CONFIG_PATH
to them. to them.
- The MIT Kerberos 5 or Heimdal libraries are needed by Kea DDNS server to - The MIT Kerberos 5 or Heimdal libraries are needed by Kea DDNS server to
sign and verify DNS updates using GSS-TSIG. The configuration switch which sign and verify DNS updates using GSS-TSIG. The configuration switch which
enables this functionality is ``-D krb5``. If this dependency is installed enables this functionality is ``-D krb5=enabled``. If this dependency is installed
in a custom path, point PKG_CONFIG_PATH to the .pc file or PATH to the in a custom path, point PKG_CONFIG_PATH to the .pc file or PATH to the
krb5-config tool. krb5-config tool.
- googletest (version 1.8 or later) is required when using the ``-D tests`` - googletest (version 1.8 or later) is required when using the ``-D tests=enabled``
configuration option to build the unit tests. configuration option to build the unit tests.
- The documentation generation tools `Sphinx <https://www.sphinx-doc.org/>`_, - The documentation generation tools `Sphinx <https://www.sphinx-doc.org/>`_,
@@ -307,7 +307,7 @@ Some commonly used options are:
- ``--prefix`` - ``--prefix``
Define the installation location (the default is ``/usr/local``). Define the installation location (the default is ``/usr/local``).
- ``-D mysql`` - ``-D mysql=enabled``
Build Kea with code to allow it to store leases and host reservations Build Kea with code to allow it to store leases and host reservations
in a MySQL database. in a MySQL database.
@@ -315,11 +315,11 @@ Some commonly used options are:
Build Kea with code to allow it to store leases and host reservations Build Kea with code to allow it to store leases and host reservations
in a PostgreSQL database. in a PostgreSQL database.
- ``-D krb5`` - ``-D krb5=enabled``
Build Kea with Kerberos5 with GSS-API support required by Build Kea with Kerberos5 with GSS-API support required by
:ischooklib:`libddns_gss_tsig.so`. :ischooklib:`libddns_gss_tsig.so`.
- ``-D netconf`` - ``-D netconf=enabled``
Build Kea with libyang and sysrepo support required by Build Kea with libyang and sysrepo support required by
:iscman:`kea-netconf`. :iscman:`kea-netconf`.
@@ -417,7 +417,7 @@ the creation of the lease database.
.. note:: .. note::
When unit tests are built with Kea (i.e. the ``-D tests`` configuration When unit tests are built with Kea (i.e. the ``-D tests=enabled`` configuration
option is specified), the databases must be manually pre-configured option is specified), the databases must be manually pre-configured
for the unit tests to run. The details of this configuration can be for the unit tests to run. The details of this configuration can be
found in the `Kea Developer's found in the `Kea Developer's
@@ -431,7 +431,7 @@ development libraries must be installed.
Build and install Kea as described in :ref:`installation`, Build and install Kea as described in :ref:`installation`,
with the following modification. To enable the MySQL database code, at the with the following modification. To enable the MySQL database code, at the
setup step (see :ref:`setup`), the ``-D mysql`` switch should be specified: setup step (see :ref:`setup`), the ``-D mysql=enabled`` switch should be specified:
.. code-block:: console .. code-block:: console
@@ -457,7 +457,7 @@ libraries are often packaged as ``libpq``.
Build and install Kea as described in :ref:`installation`, Build and install Kea as described in :ref:`installation`,
with the following modification. To enable the PostgreSQL database code, at the with the following modification. To enable the PostgreSQL database code, at the
setup step (see :ref:`setup`), the ``-D postgresql`` switch should be specified. setup step (see :ref:`setup`), the ``-D postgresql=enabled`` switch should be specified.
If PostgreSQL was not installed in the default location, the location can be If PostgreSQL was not installed in the default location, the location can be
selected by setting ``PKG_CONFIG_PATH=/path/to/libpq.pc:${PKG_CONFIG_PATH}`` selected by setting ``PKG_CONFIG_PATH=/path/to/libpq.pc:${PKG_CONFIG_PATH}``