From: Otto Moerbeek <otto.moerbeek@open-xchange.com>
Date: Wed, 18 May 2022 09:29:13 +0000 (+0200)
Subject: Clarify naming of RPZ zones loaded by rpzFile.
X-Git-Tag: auth-4.8.0-alpha0~99^2
X-Git-Url: http://git.ipfire.org/?a=commitdiff_plain;h=refs%2Fpull%2F11627%2Fhead;p=thirdparty%2Fpdns.git

Clarify naming of RPZ zones loaded by rpzFile.

Also
- don't include local refs, they end up wrong in the man page. Replace them by URLs.
- add links to general docs on both maual pages.
---

diff --git a/pdns/recursordist/docs/lua-config/rpz.rst b/pdns/recursordist/docs/lua-config/rpz.rst
index 4efe0d7323..b4faf26be1 100644
--- a/pdns/recursordist/docs/lua-config/rpz.rst
+++ b/pdns/recursordist/docs/lua-config/rpz.rst
@@ -92,6 +92,7 @@ RPZ Configuration Functions
 .. function:: rpzFile(filename, settings)
 
   Load an RPZ from disk.
+  If multiple files are to be loaded, the zones can be distinguished by setting a ``policyName``, see below.
 
   :param str filename: The filename to load
   :param {} settings: A table to settings, see below
@@ -158,7 +159,7 @@ The maximum TTL value of the synthesized records, overriding a higher value from
 
 policyName
 ^^^^^^^^^^
-The name logged as 'appliedPolicy' in :doc:`protobuf <protobuf>` messages when this policy is applied.
+The name logged as ``appliedPolicy`` in :doc:`protobuf <protobuf>` messages when this policy is applied.
 Defaults to ``rpzFile`` for RPZs loaded by :func:`rpzFile` or the name of the zone for RPZs loaded by :func:`rpzPrimary`.
 
 tags
diff --git a/pdns/recursordist/docs/lua-scripting/dq.rst b/pdns/recursordist/docs/lua-scripting/dq.rst
index 6a7433af9c..5f94cf716a 100644
--- a/pdns/recursordist/docs/lua-scripting/dq.rst
+++ b/pdns/recursordist/docs/lua-scripting/dq.rst
@@ -353,7 +353,7 @@ The DNS header as returned by :meth:`DNSQuestion:getDH()` represents a header of
 DNSRecord Object
 ================
 
-See :doc:`DNSRecord <../dnsrecord>`.
+See :doc:`DNSRecord <dnsrecord>`.
 
 The EDNSOptionView Class
 ========================
diff --git a/pdns/recursordist/docs/manpages/pdns_recursor.1.rst b/pdns/recursordist/docs/manpages/pdns_recursor.1.rst
index e9ee42caff..47103dce87 100644
--- a/pdns/recursordist/docs/manpages/pdns_recursor.1.rst
+++ b/pdns/recursordist/docs/manpages/pdns_recursor.1.rst
@@ -119,3 +119,4 @@ See also
 --------
 :manpage:`rec_control(1)`
 :manpage:`systemctl(1)`
+`<https://docs.powerdns.com/recursor>`__
diff --git a/pdns/recursordist/docs/manpages/rec_control.1.rst b/pdns/recursordist/docs/manpages/rec_control.1.rst
index 0b2c222150..df2e42a7dd 100644
--- a/pdns/recursordist/docs/manpages/rec_control.1.rst
+++ b/pdns/recursordist/docs/manpages/rec_control.1.rst
@@ -122,7 +122,8 @@ dump-rpz *ZONE NAME* *FILE NAME*
     Dumps the content of the RPZ zone named *ZONE NAME* to the *FILENAME*
     mentioned. This file should not exist already, PowerDNS will refuse to
     overwrite it otherwise. While dumping, the recursor will not answer
-    questions.
+    questions. For details on how RPZ are named see
+    `<https://docs.powerdns.com/recursor/lua-config/rpz.html#policyname>`__.
 
 dump-saved-parent-ns-sets *FILE NAME*
     Dump the entries of the map containing saved parent NS sets
@@ -140,7 +141,7 @@ dump-throttlemap *FILENAME*
 
 get *STATISTIC* [*STATISTIC*]...
     Retrieve a statistic. For items that can be queried, see
-    :doc:`../metrics`
+    `<https://docs.powerdns.com/recursor/metrics.html>`__.
 
 get-all
     Retrieve all known statistics.
@@ -325,3 +326,4 @@ wipe-cache-typed *qtype* *DOMAIN* [*DOMAIN*] [...]
 See also
 --------
 :manpage:`pdns_recursor(1)`
+`<https://docs.powerdns.com/recursor>`__