From: Otto <otto.moerbeek@open-xchange.com>
Date: Wed, 17 Feb 2021 09:43:52 +0000 (+0100)
Subject: Docs and help texts
X-Git-Tag: dnsdist-1.6.0-alpha2~22^2~2
X-Git-Url: http://git.ipfire.org/?a=commitdiff_plain;h=0cca432081dd3fa311a83da98ddf7bd12d54aedd;p=thirdparty%2Fpdns.git

Docs and help texts
---

diff --git a/pdns/pdns_recursor.cc b/pdns/pdns_recursor.cc
index 7fd6d877ae..db1deb5db0 100644
--- a/pdns/pdns_recursor.cc
+++ b/pdns/pdns_recursor.cc
@@ -5369,7 +5369,7 @@ int main(int argc, char **argv)
     ::arg().set("dont-throttle-names", "Do not throttle nameservers with this name or suffix")="";
     ::arg().set("dont-throttle-netmasks", "Do not throttle nameservers with this IP netmask")="";
     ::arg().set("non-resolving-ns-max-fails", "Number of failed address resolves of a nameserver to start throttling it, 0 is disabled")="1";
-    ::arg().set("non-resolving-ns-throttle-time", "Number of seconds the throttle a namserver failing to resolve")="60";
+    ::arg().set("non-resolving-ns-throttle-time", "Number of seconds the throttle a nameserver with a name failing to resolve")="60";
 
     ::arg().set("hint-file", "If set, load root hints from this file")="";
     ::arg().set("max-cache-entries", "If set, maximum number of entries in the main cache")="1000000";
diff --git a/pdns/rec_channel_rec.cc b/pdns/rec_channel_rec.cc
index fd358fd7da..eb715ff675 100644
--- a/pdns/rec_channel_rec.cc
+++ b/pdns/rec_channel_rec.cc
@@ -1697,11 +1697,11 @@ RecursorControlChannel::Answer RecursorControlParser::getAnswer(int s, const str
 "clear-ta [DOMAIN]...             Clear the Trust Anchor for DOMAINs\n"
 "dump-cache <filename>            dump cache contents to the named file\n"
 "dump-edns [status] <filename>    dump EDNS status to the named file\n"
-"dump-nonresolving <filename>     dump non-resolving nameservers to the named file\n"
+"dump-failedservers <filename>    dump the failed servers to the named file\n"
+"dump-nonresolving <filename>     dump non-resolving nameservers addresses to the named file\n"
 "dump-nsspeeds <filename>         dump nsspeeds statistics to the named file\n"
 "dump-rpz <zone name> <filename>  dump the content of a RPZ zone to the named file\n"
 "dump-throttlemap <filename>      dump the contents of the throttle map to the named file\n"
-"dump-failedservers <filename>    dump the failed servers to the named file\n"
 "get [key1] [key2] ..             get specific statistics\n"
 "get-all                          get all statistics\n"
 "get-dont-throttle-names          get the list of names that are not allowed to be throttled\n"
diff --git a/pdns/recursordist/docs/manpages/rec_control.1.rst b/pdns/recursordist/docs/manpages/rec_control.1.rst
index a76e4570fd..454ce7e31d 100644
--- a/pdns/recursordist/docs/manpages/rec_control.1.rst
+++ b/pdns/recursordist/docs/manpages/rec_control.1.rst
@@ -97,6 +97,18 @@ dump-edns *FILENAME*
     already, PowerDNS will refuse to overwrite it. While dumping, the recursor
     will not answer questions.
 
+dump-failedservers *FILENAME*
+    Dump the contents of the failed server map 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.
+
+dump-nonresolving *FILENAME*
+    Dump the contents of the map of nameserver names that did not resolve to
+    an address.  This file should not exist already, PowerDNS will
+    refuse to overwrite it otherwise. While dumping, the recursor will
+    not answer questions.
+
 dump-nsspeeds *FILENAME*
     Dumps the nameserver speed statistics to the *FILENAME* mentioned. This
     file should not exist already, PowerDNS will refuse to overwrite it. While
@@ -115,12 +127,6 @@ dump-throttlemap *FILENAME*
     overwrite it otherwise. While dumping, the recursor will not answer
     questions.
 
-dump-failedservers *FILENAME*
-    Dump the contents of the failed server map 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.
-
 get *STATISTIC* [*STATISTIC*]...
     Retrieve a statistic. For items that can be queried, see
     :doc:`../metrics`
diff --git a/pdns/recursordist/docs/settings.rst b/pdns/recursordist/docs/settings.rst
index 64fa3f2628..94ea2bf37b 100644
--- a/pdns/recursordist/docs/settings.rst
+++ b/pdns/recursordist/docs/settings.rst
@@ -1246,6 +1246,30 @@ a new domain is observed.
 
 Number of milliseconds to wait for a remote authoritative server to respond.
 
+.. _setting-non-resolving-ns-max-fails:
+
+``non-resolving-ns-max-fails``
+------------------------------
+.. versionadded:: 4.5.0
+
+- Integer
+- Default: 1
+
+Number of failed address resolves of a nameserver name to start throttling it, 0 is disabled.
+Nameservers matching :ref:`setting-dont-throttle-names` will not be throttled.
+
+
+.. _setting-non-resolving-ns-throttle-time:
+
+``non-resolving-ns-max-throttle-time``
+--------------------------------------
+.. versionadded:: 4.5.0
+
+- Integer
+- Default: 60
+
+Number of seconds the throttle a nameserver with a name failing to resolve.
+
 .. _setting-nothing-below-nxdomain:
 
 ``nothing-below-nxdomain``