]> git.ipfire.org Git - thirdparty/kea.git/commitdiff
[#3905] Fix more Meson flag documentation
authorAndrei Pavel <andrei@isc.org>
Fri, 30 May 2025 06:27:49 +0000 (09:27 +0300)
committerAndrei Pavel <andrei@isc.org>
Fri, 30 May 2025 16:06:18 +0000 (19:06 +0300)
doc/devel/unit-tests.dox
doc/sphinx/arm/config-backend.rst
doc/sphinx/arm/install.rst

index cc336f5a6965184abea2fb11d96be02ce157771c..7d2a9246ba351f8de8740d9eb85b10b956e0bb63 100644 (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
 /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
-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
 meson setup build -D tests=enabled
index 122ec31e0bb087e3a166e05c622a3cc4a44d71b5..714636678fb4a275b3cbb2a7f8126227393af232 100644 (file)
@@ -165,13 +165,13 @@ CB Components
 
 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
-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
 :ref:`dhcp-install-configure`.
 
 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
-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
 :ref:`dhcp-install-configure`.
 
index 1352c7d16af03eca546fa27d71efa31cd619c914..320f06f89dffdb84e6df1ce26bd1bf0315f19b8a 100644 (file)
@@ -172,7 +172,7 @@ the system:
 -  The development tools automake, libtool, and pkg-config.
 
 -  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
    or on a machine reachable over a network is required. Note that running
    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
    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
    to them.
 
 -  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
-   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
    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.
 
 -  The documentation generation tools `Sphinx <https://www.sphinx-doc.org/>`_,
@@ -307,7 +307,7 @@ Some commonly used options are:
  - ``--prefix``
    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
    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
    in a PostgreSQL database.
 
- - ``-D krb5``
+ - ``-D krb5=enabled``
    Build Kea with Kerberos5 with GSS-API support required by
    :ischooklib:`libddns_gss_tsig.so`.
 
- - ``-D netconf``
+ - ``-D netconf=enabled``
    Build Kea with libyang and sysrepo support required by
    :iscman:`kea-netconf`.
 
@@ -417,7 +417,7 @@ the creation of the lease database.
 
 .. 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
    for the unit tests to run. The details of this configuration can be
    found in the `Kea Developer's
@@ -431,7 +431,7 @@ development libraries must be installed.
 
 Build and install Kea as described in :ref:`installation`,
 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
 
@@ -457,7 +457,7 @@ libraries are often packaged as ``libpq``.
 
 Build and install Kea as described in :ref:`installation`,
 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
 selected by setting ``PKG_CONFIG_PATH=/path/to/libpq.pc:${PKG_CONFIG_PATH}``