From: Bagas Sanjaya Date: Fri, 4 Jul 2025 08:13:51 +0000 (+0700) Subject: pdns: Fix pdnsutil cross-references X-Git-Tag: rec-5.3.0-alpha2~8^2 X-Git-Url: http://git.ipfire.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=refs%2Fpull%2F15793%2Fhead;p=thirdparty%2Fpdns.git pdns: Fix pdnsutil cross-references Sphinx reports unknown document warnings when building html-docs: docs/backends/generic-sql.rst:104: WARNING: unknown document: pdnsutil docs/backends/geoip.rst:94: WARNING: unknown document: pdnsutil docs/changelog/4.0.rst:398: WARNING: unknown document: pdnsutil docs/changelog/4.0.rst:420: WARNING: unknown document: pdnsutil docs/changelog/4.1.rst:3: WARNING: unknown document: pdnsutil docs/changelog/4.1.rst:3: WARNING: unknown document: pdnsutil docs/changelog/4.1.rst:1: WARNING: unknown document: pdnsutil docs/changelog/4.7.rst:15: WARNING: unknown document: pdnsutil docs/changelog/4.7.rst:15: WARNING: unknown document: pdnsutil docs/changelog/4.7.rst:16: WARNING: unknown document: pdnsutil docs/changelog/4.7.rst:9: WARNING: unknown document: pdnsutil docs/guides/basic-database.rst:80: WARNING: unknown document: pdnsutil docs/guides/basic-database.rst:80: WARNING: unknown document: pdnsutil docs/guides/basic-database.rst:80: WARNING: unknown document: pdnsutil docs/running.rst:114: WARNING: unknown document: pdnsutil docs/upgrading.rst:58: WARNING: unknown document: pdnsutil Fix references to pdnsutil(1) manpage. Signed-off-by: Bagas Sanjaya --- diff --git a/docs/backends/generic-sql.rst b/docs/backends/generic-sql.rst index 6790ad1bbe..44bd82505c 100644 --- a/docs/backends/generic-sql.rst +++ b/docs/backends/generic-sql.rst @@ -101,7 +101,7 @@ setting "disabled" to ``1`` (for PostgreSQL: ``true``). By extension, when the SOA record for a domain is disabled, the entire domain is considered to be disabled. -This value cannot be set with :doc:`pdnsutil `. +This value cannot be set with :doc:`pdnsutil <../manpages/pdnsutil.1>`. Effects: the record (or domain, respectively) will not be visible to DNS clients. The REST API will still see the record (or domain). Even if a diff --git a/docs/backends/geoip.rst b/docs/backends/geoip.rst index 5e1ea9b176..4f358bbe5c 100644 --- a/docs/backends/geoip.rst +++ b/docs/backends/geoip.rst @@ -93,7 +93,7 @@ Specifies the full path of the zone configuration file to use. The file is re-op Specifies the full path of a directory that will contain DNSSEC keys. This option enables DNSSEC on the backend. Keys can be created/managed -with :doc:`pdnsutil `, and the backend stores these keys in files with key +with :doc:`pdnsutil <../manpages/pdnsutil.1>`, and the backend stores these keys in files with key flags and active/disabled state encoded in the key filenames. Zonefile format diff --git a/docs/changelog/4.0.rst b/docs/changelog/4.0.rst index 7685af212a..b021dad833 100644 --- a/docs/changelog/4.0.rst +++ b/docs/changelog/4.0.rst @@ -395,7 +395,7 @@ In addition to this cleanup, 4.0.0 brings the following new features: - Experimental support for ed25519 DNSSEC signatures (when compiled with libsodium support). - IXFR consumption support. -- Many new :doc:`pdnsutil ` commands +- Many new :doc:`pdnsutil <../manpages/pdnsutil.1>` commands - ``help`` command now produces the help - Warns if the configuration file cannot be read @@ -417,7 +417,7 @@ The following backend have been dropped in 4.0.0: Important changes: -- ``pdnssec`` has been renamed to :doc:`pdnsutil ` +- ``pdnssec`` has been renamed to :doc:`pdnsutil <../manpages/pdnsutil.1>` - PowerDNS Authoritative Server now listens by default on all IPv6 addresses. - The default for ``pdnsutil secure-zone`` has been changed from 1 2048 diff --git a/docs/changelog/4.1.rst b/docs/changelog/4.1.rst index c4b4f94ced..94c39bab72 100644 --- a/docs/changelog/4.1.rst +++ b/docs/changelog/4.1.rst @@ -517,7 +517,7 @@ Changelogs for 4.1.x This is the second release in the 4.1 train. - This is a bug-fix only release, with fixes to the LDAP and MySQL backends, the :doc:`pdnsutil ` tool, and PDNS internals. + This is a bug-fix only release, with fixes to the LDAP and MySQL backends, the :doc:`pdnsutil <../manpages/pdnsutil.1>` tool, and PDNS internals. Changes since 4.1.1: @@ -643,7 +643,7 @@ Changelogs for 4.1.x This is the third release candidate of the PowerDNS Authoritative Server in the 4.1 release train. This release features various bug fixes and some improvements to - :doc:`pdnsutil `. + :doc:`pdnsutil <../manpages/pdnsutil.1>`. .. change:: :tags: Bug Fixes @@ -682,7 +682,7 @@ Changelogs for 4.1.x :pullreq: 5883 :tickets: 5853 - Add ``add-meta`` command to :doc:`pdnsutil ` that can be used to append + Add ``add-meta`` command to :doc:`pdnsutil <../manpages/pdnsutil.1>` that can be used to append to existing metadata without clobbering it. .. change:: diff --git a/docs/changelog/4.7.rst b/docs/changelog/4.7.rst index 9722bfaff2..8f8024df9c 100644 --- a/docs/changelog/4.7.rst +++ b/docs/changelog/4.7.rst @@ -215,7 +215,7 @@ Changelogs for 4.7.x * lmdbbackend databases now get a UUID assigned, making it easy for external software to spot if a database was completely replaced * lmdbbackend databases now optionally use random IDs for objects * a new LUA function called ``ifurlextup``, and improvements in other LUA record functions - * autoprimary management in :doc:`pdnsutil ` and the HTTP API + * autoprimary management in :doc:`pdnsutil <../manpages/pdnsutil.1>` and the HTTP API * in beta, a key roller daemon, currently not packaged Please make sure to read the :doc:`upgrade notes <../upgrading>` before upgrading. @@ -258,7 +258,7 @@ Changelogs for 4.7.x * lmdbbackend databases now get a UUID assigned, making it easy for external software to spot if a database was completely replaced * lmdbbackend databases now optionally use random IDs for objects * a new LUA function called ``ifurlextup``, and improvements in other LUA record functions - * autoprimary management in :doc:`pdnsutil ` and the HTTP API + * autoprimary management in :doc:`pdnsutil <../manpages/pdnsutil.1>` and the HTTP API * in beta, a key roller daemon, currently not packaged Please make sure to read the :doc:`upgrade notes <../upgrading>` before upgrading. @@ -320,7 +320,7 @@ Changelogs for 4.7.x * lmdbbackend databases now get a UUID assigned, making it easy for external software to spot if a database was completely replaced * lmdbbackend databases now optionally use random IDs for objects * a new LUA function called ``ifurlextup``, and improvements in other LUA record functions - * autoprimary management in :doc:`pdnsutil ` and the HTTP API + * autoprimary management in :doc:`pdnsutil <../manpages/pdnsutil.1>` and the HTTP API Please make sure to read the :doc:`upgrade notes <../upgrading>` before upgrading. @@ -519,7 +519,7 @@ Changelogs for 4.7.x * lmdbbackend databases now get a UUID assigned, making it easy for external software to spot if a database was completely replaced * lmdbbackend databases now optionally use random IDs for objects * a new LUA function called ``ifurlextup`` - * autoprimary management in :doc:`pdnsutil ` and the HTTP API + * autoprimary management in :doc:`pdnsutil <../manpages/pdnsutil.1>` and the HTTP API Please make sure to read the :doc:`upgrade notes <../upgrading>` before upgrading. diff --git a/docs/guides/basic-database.rst b/docs/guides/basic-database.rst index e3bccbe676..aa24dcf9e1 100644 --- a/docs/guides/basic-database.rst +++ b/docs/guides/basic-database.rst @@ -77,9 +77,9 @@ Now, let's add a zone and some records:: This should be done as the ``pdns`` user (or root), as sqlite3 requires write access to the directory of the database file. .. note:: - :doc:`pdnsutil ` is a tool that can manipulate zones, set DNSSEC parameters for zones and does :doc:`many other <../manpages/pdnsutil.1>` things. - It is *highly* recommended to use :doc:`pdnsutil ` or the :doc:`HTTP API <../http-api/index>` to modify zones instead of using raw SQL, - as :doc:`pdnsutil ` and the API perform checks on the data and post-store changes to prevent issues when serving DNS data. + :doc:`pdnsutil <../manpages/pdnsutil.1>` is a tool that can manipulate zones, set DNSSEC parameters for zones and does many other things. + It is *highly* recommended to use :doc:`pdnsutil <../manpages/pdnsutil.1>` or the :doc:`HTTP API <../http-api/index>` to modify zones instead of using raw SQL, + as :doc:`pdnsutil <../manpages/pdnsutil.1>` and the API perform checks on the data and post-store changes to prevent issues when serving DNS data. If we now requery our database, ``www.example.com`` should be present:: diff --git a/docs/running.rst b/docs/running.rst index 51c627f4de..9c970dd8d1 100644 --- a/docs/running.rst +++ b/docs/running.rst @@ -111,7 +111,7 @@ Backend manipulation ``pdnsutil`` ~~~~~~~~~~~~ -To perform zone and record changes using inbuilt tools, the :doc:`pdnsutil ` command can be used. All available options are described in the online :doc:`manual page <../manpages/pdnsutil.1>` as well as in ``man pdnsutil``. +To perform zone and record changes using inbuilt tools, the ``pdnsutil`` command can be used. All available options are described in the online :doc:`manual page ` as well as in ``man pdnsutil``. Running in the foreground ------------------------- diff --git a/docs/upgrading.rst b/docs/upgrading.rst index 2715f9a4ff..68141d5bf5 100644 --- a/docs/upgrading.rst +++ b/docs/upgrading.rst @@ -55,7 +55,7 @@ If you want to listen on both IPv4 and IPv6, you need to add a line with ``0.0.0 pdnsutil behaviour changes ^^^^^^^^^^^^^^^^^^^^^^^^^^ -A few changes of behaviour have been implemented in :doc:`pdnsutil `. +A few changes of behaviour have been implemented in :doc:`pdnsutil `. * The ``add-zone-key`` command used to default to creating a ZSK, if no key type was given. This default has changed to KSK.