Address a Sphinx duplicate label warning

Both doc/man/ddns-confgen.rst and doc/man/tsig-keygen.rst include
bin/confgen/tsig-keygen.rst, which defines a "man_tsig-keygen" label.
This triggers the following warning when running sphinx-build with the
-W command line switch in the doc/man/ directory:

    ../../bin/confgen/tsig-keygen.rst:27: WARNING: duplicate label man_tsig-keygen, other instance in /tmp/bind9/doc/man/ddns-confgen.rst

Move the offending label from bin/confgen/tsig-keygen.rst to the proper
spot in doc/arm/manpages.rst to avoid effectively defining it twice in
different source documents while still allowing the relevant man page to
be referenced in the ARM.  Also rename that label so that it more
closely matches the content it points to.  As the label no longer
immediately precedes a section title in its new location, use
:ref:`Title <label>` syntax for the only reference to the
tsig-keygen/ddns-confgen man page in the ARM.

diff --git a/bin/confgen/tsig-keygen.rst b/bin/confgen/tsig-keygen.rst
index 2819d09d85a02c65a13f1a3fee14cc34ae84230f..0d709b41226401642d46a7d5b9dfedfe26838e79 100644 (file)
--- a/bin/confgen/tsig-keygen.rst
+++ b/bin/confgen/tsig-keygen.rst
@@ -21,8 +21,6 @@
 
 .. highlight: console
 
-.. _man_tsig-keygen:
-
 tsig-keygen, ddns-confgen - TSIG key generation tool
 ----------------------------------------------------
 

diff --git a/doc/arm/advanced.rst b/doc/arm/advanced.rst
index 82106e6804f9166cd345235e9bac9f9734033155..b82887aa278508c3ef0965f14e193ac3e593875a 100644 (file)
--- a/doc/arm/advanced.rst
+++ b/doc/arm/advanced.rst
@@ -416,7 +416,8 @@ email, etc.)
 
 ``tsig-keygen`` can also be run as ``ddns-confgen``, in which case its
 output includes additional configuration text for setting up dynamic DNS
-in ``named``. See :ref:`man_tsig-keygen` for details.
+in ``named``. See :ref:`tsig-keygen, ddns-confgen - TSIG key generation
+tool <man_tsig-keygen_ddns-confgen>` for details.
 
 Loading a New Key
 ~~~~~~~~~~~~~~~~~

diff --git a/doc/arm/manpages.rst b/doc/arm/manpages.rst
index 30996a16ab7f84a8e2771c27c2c8e634752ad51b..01f610beb4629e8741e6dfe247ff16f4db322f7b 100644 (file)
--- a/doc/arm/manpages.rst
+++ b/doc/arm/manpages.rst
@@ -46,4 +46,5 @@ Manual Pages
 .. include:: ../../bin/confgen/rndc-confgen.rst
 .. include:: ../../bin/rndc/rndc.conf.rst
 .. include:: ../../bin/rndc/rndc.rst
+.. _man_tsig-keygen_ddns-confgen:
 .. include:: ../../bin/confgen/tsig-keygen.rst