Recursor: Fix some manpage issues

diff --git a/pdns/recursordist/Makefile.am b/pdns/recursordist/Makefile.am
index 7b440bfe56668f20a94c64eca91f4e364cc98c4b..f732e5cf1bf5f2535b23b8cd78c991471402daab 100644 (file)
--- a/pdns/recursordist/Makefile.am
+++ b/pdns/recursordist/Makefile.am
@@ -369,7 +369,7 @@ dist_man_MANS=$(MANPAGES)
 
 if HAVE_VIRTUALENV
 if !HAVE_MANPAGES
-$(MANPAGES): %.1: docs/manpages/%.rst .venv
+$(MANPAGES): %: docs/manpages/%.rst .venv
        .venv/bin/python -msphinx -b man docs . $<
 endif # if !HAVE_MANPAGES
 

diff --git a/pdns/recursordist/docs/conf.py b/pdns/recursordist/docs/conf.py
index 2862469930e2012bfc44caf4eba1ec8a68eae3a0..8778c52a3eda525eaf6f607621793e72cdc9e9e2 100644 (file)
--- a/pdns/recursordist/docs/conf.py
+++ b/pdns/recursordist/docs/conf.py
@@ -61,7 +61,7 @@ author = 'PowerDNS.COM BV'
 # The short X.Y version.
 version = '4.1'
 # The full version, including alpha/beta/rc tags.
-release = '4.1.0-alpha1'
+#release = '4.1.0-alpha1'
 
 # The language for content autogenerated by Sphinx. Refer to documentation
 # for a list of supported languages.
@@ -169,8 +169,8 @@ latex_logo = 'common/powerdns-logo-500px.png'
 # One entry per manual page. List of tuples
 # (source start file, name, description, authors, manual section).
 man_pages = [
-    ('manpages/rec_control', 'rec_control', 'Command line tool to control a running Recursor', [author], 1),
-    ('manpages/pdns_recursor', 'pdns_recursor', 'The PowerDNS Recursor binary', [author], 1)
+    ('manpages/rec_control.1', 'rec_control', 'Command line tool to control a running Recursor', [author], 1),
+    ('manpages/pdns_recursor.1', 'pdns_recursor', 'The PowerDNS Recursor binary', [author], 1)
 ]
 
 

diff --git a/pdns/recursordist/docs/dnssec.rst b/pdns/recursordist/docs/dnssec.rst
index 110a8204137c67144e1089807865f9e38a893932..1c5e3a8b6f9e3214da57b9fc29ebc138885330f5 100644 (file)
--- a/pdns/recursordist/docs/dnssec.rst
+++ b/pdns/recursordist/docs/dnssec.rst
@@ -94,7 +94,7 @@ Now (re)start the recursor to load these trust anchors.
 
 Runtime Configuration of Trust Anchors
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-To change or add trust anchors at runtime, use the :doc:`manpages/rec_control` tool.
+To change or add trust anchors at runtime, use the :doc:`manpages/rec_control.1` tool.
 These runtime settings are not saved to disk.
 To make them permanent, they should be added to the :ref:`setting-lua-config-file` as described above.
 
@@ -142,7 +142,7 @@ This function requires the name of the zone and an optional reason:
 Runtime Configuration of Negative Trust Anchors
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
-The :doc:`manpages/rec_control` command can be used to manage the negative trust anchors of a running instance.
+The :doc:`manpages/rec_control.1` command can be used to manage the negative trust anchors of a running instance.
 These runtime settings are lost when restarting the recursor, more permanent NTAs should be added to the :ref:`setting-lua-config-file` with ``addNTA()``.
 
 Adding a negative trust anchor is done with the ``add-nta`` command (that optionally accepts a reason):

diff --git a/pdns/recursordist/docs/indexTOC.rst b/pdns/recursordist/docs/indexTOC.rst
index 88df07bbc79f61a6dcd422f3a8df06eb42c0718f..2f884b45a9e0a78cdf304212953624328372d552 100644 (file)
--- a/pdns/recursordist/docs/indexTOC.rst
+++ b/pdns/recursordist/docs/indexTOC.rst
@@ -17,7 +17,7 @@ PowerDNS Recursor
     dns64
     security
     settings
-    manpages/*
+    manpages/index
     security-advisories/index
     upgrade
     changelog/index

diff --git a/pdns/recursordist/docs/manpages/index.rst b/pdns/recursordist/docs/manpages/index.rst
new file mode 100644 (file)
index 0000000..048cb4a
--- /dev/null
+++ b/pdns/recursordist/docs/manpages/index.rst
@@ -0,0 +1,8 @@
+Manual Pages
+============
+
+.. toctree::
+  :maxdepth: 1
+  :glob:
+
+  *.1

diff --git a/pdns/recursordist/docs/manpages/pdns_recursor.rst b/pdns/recursordist/docs/manpages/pdns_recursor.1.rst
similarity index 98%
rename from pdns/recursordist/docs/manpages/pdns_recursor.rst
rename to pdns/recursordist/docs/manpages/pdns_recursor.1.rst
index a6b5c51e2739c696563b8e0f3fe083e62ffb7f0e..be117f450129d398bfe74cbad1ae92f3e3fab73e 100644 (file)
--- a/pdns/recursordist/docs/manpages/pdns_recursor.rst
+++ b/pdns/recursordist/docs/manpages/pdns_recursor.1.rst
@@ -1,5 +1,5 @@
-pdns_recursor manual page
-=======================
+pdns_recursor
+=============
 
 Synopsis
 --------

diff --git a/pdns/recursordist/docs/manpages/rec_control.rst b/pdns/recursordist/docs/manpages/rec_control.1.rst
similarity index 99%
rename from pdns/recursordist/docs/manpages/rec_control.rst
rename to pdns/recursordist/docs/manpages/rec_control.1.rst
index 649d29879cbe0568d2f5f1537d3b5d6da8a56b9b..3692416fd508e0d35615daf2b71e8003d3c7e83d 100644 (file)
--- a/pdns/recursordist/docs/manpages/rec_control.rst
+++ b/pdns/recursordist/docs/manpages/rec_control.1.rst
@@ -1,5 +1,5 @@
-rec_control manual page
-=======================
+rec_control
+===========
 
 Synopsis
 --------

diff --git a/pdns/recursordist/docs/metrics.rst b/pdns/recursordist/docs/metrics.rst
index 63d442dd25583c99e0bca3cd4e8e5880fb093880..73de56f1eafe6a1b37ab5114e746f54036d81b03 100644 (file)
--- a/pdns/recursordist/docs/metrics.rst
+++ b/pdns/recursordist/docs/metrics.rst
@@ -59,7 +59,7 @@ This endpoint exports all statistics in a single JSON document.
 
 Using ``rec_control``
 ^^^^^^^^^^^^^^^^^^^^^
-Metrics can also be gathered on the system itself by invoking :doc:`rec_control <manpages/rec_control>`::
+Metrics can also be gathered on the system itself by invoking :doc:`rec_control <manpages/rec_control.1>`::
 
    rec_control get-all
 

diff --git a/regression-tests.recursor/rec_control-manpage/command b/regression-tests.recursor/rec_control-manpage/command
index a84e9a063cbcf61b61c7057a7c4db8576dbdd584..6254d0a970b33fd8861049a45c791eb565a84b94 100755 (executable)
--- a/regression-tests.recursor/rec_control-manpage/command
+++ b/regression-tests.recursor/rec_control-manpage/command
@@ -10,7 +10,7 @@ fi
 
 missing_elements=""
 for element in $elements; do
-  grep -q -e "^$element" ../pdns/recursordist/docs/manpages/rec_control.rst || missing_elements="$element\n$missing_elements"
+  grep -q -e "^$element" ../pdns/recursordist/docs/manpages/rec_control.1.rst || missing_elements="$element\n$missing_elements"
 done
 
 if [ "x$missing_elements" != "x" ]; then