Docs tweaks (not neccesarily related)

PowerDNS · Oct 29, 2024 · bf763df · bf763df
1 parent b98ccba
commit bf763df
Show file tree

Hide file tree

Showing 4 changed files with 9 additions and 7 deletions.
diff --git a/pdns/recursordist/docs/manpages/rec_control.1.rst b/pdns/recursordist/docs/manpages/rec_control.1.rst
@@ -48,6 +48,8 @@ Options
                       control.
 --timeout=<num>       Number of seconds to wait for the remote PowerDNS
                       Recursor to respond.
+--version             Show the version number of this program. Note that the **version**
+                      command shows the version of the running recursor.
 
 Commands
 --------
@@ -179,7 +181,7 @@ hash-password [*WORK-FACTOR*]
 
 help
     Shows a list of supported commands understood by the running
-    :program:`pdns_recursor`
+    :program:`pdns_recursor`.
 
 list-dnssec-algos
     List supported (and potentially disabled) DNSSEC algorithms.
@@ -329,7 +331,7 @@ unload-lua-script
     Unloads Lua script if one was loaded.
 
 version
-    Report running version.
+    Report the version of the running Recursor.
 
 wipe-cache *DOMAIN* [*DOMAIN*] [...]
     Wipe entries for *DOMAIN* (exact name match) from the cache. This is useful

diff --git a/pdns/recursordist/docs/upgrade.rst b/pdns/recursordist/docs/upgrade.rst
@@ -10,7 +10,7 @@ When upgrading several versions, please read **all** notes applying to the upgra
 Changed behaviour
 ^^^^^^^^^^^^^^^^^
 Parsing of old-style settings is no longer enabled by default.
-Convert to YAML or pass ``--enable-old-settings` on the command line.
+Convert yor settings file to YAML (see :doc:`appendices/yamlconversion`) or pass ``--enable-old-settings`` on the command line.
 
 The way :ref:`setting-yaml-incoming.max_tcp_clients` is enforced has changed.
 If there are too many incoming TCP connections, new connections will be accepted but then closed immediately.

diff --git a/pdns/recursordist/rec_channel_rec.cc b/pdns/recursordist/rec_channel_rec.cc
@@ -1886,14 +1886,14 @@ static RecursorControlChannel::Answer help()
           "                                 notice: queries from cache aren't being counted yet\n"
           "get-remotelogger-stats           get remote logger statistics\n"
           "hash-password [work-factor]      ask for a password then return the hashed version\n"
-          "help                             get this list\n"
+          "help                             get this list (from the runnig recursor)\n"
           "list-dnssec-algos                list supported DNSSEC algorithms\n"
           "ping                             check that all threads are alive\n"
           "quit                             stop the recursor daemon\n"
           "quit-nicely                      stop the recursor daemon nicely\n"
           "reload-acls                      reload ACLS\n"
           "reload-lua-script [filename]     (re)load Lua script\n"
-          "reload-lua-config [filename]     (re)load Lua configuration file\n"
+          "reload-lua-config [filename]     (re)load Lua configuration file or equivalent YAML clauses\n"
           "reload-zones                     reload all auth and forward zones\n"
           "set-ecs-minimum-ttl value        set ecs-minimum-ttl-override\n"
           "set-max-aggr-nsec-cache-size value set new maximum aggressive NSEC cache size\n"
@@ -1917,7 +1917,7 @@ static RecursorControlChannel::Answer help()
           "top-servfail-remotes             show top remotes receiving servfail answers\n"
           "top-bogus-remotes                show top remotes receiving bogus answers\n"
           "unload-lua-script                unload Lua script\n"
-          "version                          return Recursor version number\n"
+          "version                          return version number of running Recursor\n"
           "wipe-cache domain0 [domain1] ..  wipe domain data from cache\n"
           "wipe-cache-typed type domain0 [domain1] ..  wipe domain data with qtype from cache\n"};
 }

diff --git a/pdns/recursordist/settings/docs-old-preamble-in.rst b/pdns/recursordist/settings/docs-old-preamble-in.rst
@@ -6,7 +6,7 @@ The command line overrides the configuration file.
 .. note::
    Starting with version 5.0.0, :program:`Recursor` supports a new YAML syntax for configuration files.
    A configuration using the old style syntax can be converted to a YAML configuration using the instructions in :doc:`appendices/yamlconversion`.
-   Starting with version 5.2.0, parsing of old-style settings must be explicitly enabled using a command line argument ``--enable-old-settings`.
+   Starting with version 5.2.0, parsing of old-style settings must be explicitly enabled using a command line argument ``--enable-old-settings``.
    In a future release support for the old-style settings described here will be dropped.
    See :doc:`yamlsettings` for details.