From: Otto Moerbeek Date: Mon, 11 Dec 2023 08:07:00 +0000 (+0100) Subject: Beter default value (saying "it depends") in generated docs for settings X-Git-Tag: dnsdist-1.9.0-alpha4~11^2 X-Git-Url: http://git.ipfire.org/?a=commitdiff_plain;h=refs%2Fpull%2F13588%2Fhead;p=thirdparty%2Fpdns.git Beter default value (saying "it depends") in generated docs for settings that are determined by distribution packaging. --- diff --git a/.github/actions/spell-check/expect.txt b/.github/actions/spell-check/expect.txt index b5083a386d..0465e6d06b 100644 --- a/.github/actions/spell-check/expect.txt +++ b/.github/actions/spell-check/expect.txt @@ -872,6 +872,8 @@ noaction noad noall nocookie +NODCACHEDIRNOD +NODCACHEDIRUDR noedns noerrors NOLOCK diff --git a/pdns/recursordist/settings/table.py b/pdns/recursordist/settings/table.py index 2a79096cd4..f9a292fb39 100644 --- a/pdns/recursordist/settings/table.py +++ b/pdns/recursordist/settings/table.py @@ -393,6 +393,7 @@ EMPTY? ''' 'section' : 'recursor', 'type' : LType.String, 'default' : 'SYSCONFDIR', + 'docdefault': 'Determined by distribution', 'help' : 'Location of configuration directory (recursor.conf or recursor.yml)', 'doc' : ''' Location of configuration directory (where ``recursor.conf`` or ``recursor.yml`` is stored). @@ -1716,6 +1717,7 @@ have no effect unless you remove the existing files. 'oldname' : 'new-domain-history-dir', 'type' : LType.String, 'default' : 'NODCACHEDIRNOD', + 'docdefault': 'Determined by distribution', 'help' : 'Persist new domain tracking data here to persist between restarts', 'doc' : ''' This setting controls which directory is used to store the on-disk @@ -2358,7 +2360,7 @@ Where to store the control socket and pidfile. The default depends on ``LOCALSTATEDIR`` or the ``--with-socketdir`` setting when building (usually ``/var/run`` or ``/run``). When using :ref:`setting-chroot` the default becomes ``/``. -Defaults to the ``RUNTIME_DIRECTORY`` environment variable when that variable has a value (e.g. under systemd). +The default value is overruled by the ``RUNTIME_DIRECTORY`` environment variable when that variable has a value (e.g. under systemd). ''', }, { @@ -2822,6 +2824,7 @@ have no effect unless you remove the existing files. 'section' : 'nod', 'type' : LType.String, 'default' : 'NODCACHEDIRUDR', + 'docdefault': 'Determined by distribution', 'help' : 'Persist unique response tracking data here to persist between restarts', 'doc' : ''' This setting controls which directory is used to store the on-disk