From 6c8f3d5d31960fa5ed86c7a6b4f43ba4b6629010 Mon Sep 17 00:00:00 2001 From: Otto Moerbeek Date: Tue, 9 Jun 2020 14:11:25 +0200 Subject: [PATCH] Fix doc generation warnings in recursor. Fixes #9167. --- pdns/recursordist/docs/index.rst | 4 ++-- pdns/recursordist/docs/manpages/pdns_recursor.1.rst | 2 +- pdns/recursordist/docs/metrics.rst | 8 ++++++-- pdns/recursordist/docs/settings.rst | 6 +++--- pdns/recursordist/docs/upgrade.rst | 10 +++++----- 5 files changed, 17 insertions(+), 13 deletions(-) diff --git a/pdns/recursordist/docs/index.rst b/pdns/recursordist/docs/index.rst index 5ebfc86066..eed0c533a0 100644 --- a/pdns/recursordist/docs/index.rst +++ b/pdns/recursordist/docs/index.rst @@ -64,7 +64,7 @@ If possible, supply the actual name of your domain and the IP address of your se I found a bug! ^^^^^^^^^^^^^^ As much as we'd like to think we are perfect, bugs happen. -If you have found a bug, please file a bug report on `GitHub `_. +If you have found a bug, please file a bug report on `GitHub bug report `_. Please fill in the template and we'll try our best to help you. I found a security issue! @@ -74,4 +74,4 @@ Please report this in private, see the :ref:`securitypolicy`. I have a good idea for a feature! ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ We like to work on new things! -You can file a feature request on `GitHub `_. +You can file a feature request on `GitHub feature request `_. diff --git a/pdns/recursordist/docs/manpages/pdns_recursor.1.rst b/pdns/recursordist/docs/manpages/pdns_recursor.1.rst index 4bd7d3de97..505224e657 100644 --- a/pdns/recursordist/docs/manpages/pdns_recursor.1.rst +++ b/pdns/recursordist/docs/manpages/pdns_recursor.1.rst @@ -90,7 +90,7 @@ at `` Maximum number of simultaneous TCP clients. --max-tcp-per-client= If set, maximum number of TCP sessions per client (IP address). ---query-local-address=
[,address...] +--query-local-address= Use *address* as Source IP address when sending queries. --quiet Suppress logging of questions and answers. diff --git a/pdns/recursordist/docs/metrics.rst b/pdns/recursordist/docs/metrics.rst index 8ee47de8f8..aed4878d5b 100644 --- a/pdns/recursordist/docs/metrics.rst +++ b/pdns/recursordist/docs/metrics.rst @@ -59,7 +59,10 @@ Should Carbon not be the preferred way of receiving metric, several other techni Using the Webserver ^^^^^^^^^^^^^^^^^^^ -The :doc:`API ` exposes a statistics endpoint at :http:get:`/api/v1/servers/:server_id/statistics`. +The :doc:`API ` exposes a statistics endpoint at + +.. http:get:: /api/v1/servers/:server_id/statistics + This endpoint exports all statistics in a single JSON document. Using ``rec_control`` @@ -252,7 +255,8 @@ number of outgoing queries dropped because of :ref:`setting-dont-query` settin qname-min-fallback-success ^^^^^^^^^^^^^^^^^^^^^^^^^^ .. versionadded:: 4.3.0 -number of successful queries due to fallback mechanism within :ref:`qname-minimization` setting. + +number of successful queries due to fallback mechanism within :ref:`setting-qname-minimization` setting. ecs-queries ^^^^^^^^^^^ diff --git a/pdns/recursordist/docs/settings.rst b/pdns/recursordist/docs/settings.rst index 26cc9989a4..7453078e71 100644 --- a/pdns/recursordist/docs/settings.rst +++ b/pdns/recursordist/docs/settings.rst @@ -885,7 +885,7 @@ Maximum number of seconds to cache an item in the DNS cache, no matter what the The minimum value of this setting is 15. i.e. setting this to lower than 15 will make this value 15. -.. _setting max-concurrent-requests-per-tcp-connection: +.. _setting-max-concurrent-requests-per-tcp-connection: ``max-concurrent-requests-per-tcp-connection`` ---------------------------------------------- @@ -1256,7 +1256,7 @@ Maximum number of seconds to cache a 'server failure' answer in the packet cache If set, PowerDNS will use distinct threads to listen to client sockets and distribute that work to worker-threads using a hash of the query. This feature should maximize the cache hit ratio. -To use more than one thread set `distributor-threads`_setting in version 4.2.0 or newer. +To use more than one thread set `distributor-threads` in version 4.2.0 or newer. Enabling should improve performance for medium sized resolvers. .. _setting-protobuf-use-kernel-timestamp: @@ -1886,7 +1886,7 @@ When set to "detailed", all information about the request and response are logge The value between the hooks is a UUID that is generated for each request. This can be used to find all lines related to a single request. .. note:: - The webserver logs these line on the NOTICE level. The :ref:`settings-loglevel` seting must be 5 or higher for these lines to end up in the log. + The webserver logs these line on the NOTICE level. The :ref:`setting-loglevel` seting must be 5 or higher for these lines to end up in the log. .. _setting-webserver-password: diff --git a/pdns/recursordist/docs/upgrade.rst b/pdns/recursordist/docs/upgrade.rst index ffe2f7a775..7ea9588fe7 100644 --- a/pdns/recursordist/docs/upgrade.rst +++ b/pdns/recursordist/docs/upgrade.rst @@ -37,11 +37,11 @@ Packages provided on `the PowerDNS Repository `__ wil New settings ^^^^^^^^^^^^ -- The :ref:`allow-trust-anchor-query` setting has been added. This setting controls if negative trust anchors can be queried. The default is `no`. -- The :ref:`max-concurrent-requests-per-tcp-connection` has been added. This setting controls how many requests are handled concurrently per incoming TCP connection. The default is 10. -- The :ref:`max-generate-steps` setting has been added. This sets the maximum number of steps that will be performed when loading a BIND zone with the ``$GENERATE`` directive. The default is 0, which is unlimited. -- The :ref:`nothing-below-nxdomain` setting has been added. This setting controls the way cached NXDOMAIN replies imply non-existence of a whole subtree. The default is `dnssec` which means that only DNSSEC validated NXDOMAINS results are used. -- The :ref:`qname-minimization` setting has been added. This options controls if QName Minimization is used. The default is `yes`. +- The :ref:`setting-allow-trust-anchor-query` setting has been added. This setting controls if negative trust anchors can be queried. The default is `no`. +- The :ref:`setting-max-concurrent-requests-per-tcp-connection` has been added. This setting controls how many requests are handled concurrently per incoming TCP connection. The default is 10. +- The :ref:`setting-max-generate-steps` setting has been added. This sets the maximum number of steps that will be performed when loading a BIND zone with the ``$GENERATE`` directive. The default is 0, which is unlimited. +- The :ref:`setting-nothing-below-nxdomain` setting has been added. This setting controls the way cached NXDOMAIN replies imply non-existence of a whole subtree. The default is `dnssec` which means that only DNSSEC validated NXDOMAINS results are used. +- The :ref:`setting-qname-minimization` setting has been added. This options controls if QName Minimization is used. The default is `yes`. 4.1.x to 4.2.0 -------------- -- 2.47.2