upstream/bind9
1
0
Fork 0
mirror of https://github.com/isc-projects/bind9.git synced 2026-06-03 13:59:27 -04:00
Code Issues Projects Releases Packages Wiki Activity Actions 6

Address a Sphinx duplicate label warning

Browse source 
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.
This commit is contained in:
Michał Kępień 2021-02-03 11:44:02 +01:00
parent 33db7ea16d
commit 84862e96c1
3 changed files with 3 additions and 3 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

2
bin/confgen/tsig-keygen.rst
View file

@ -21,8 +21,6 @@
.. highlight: console
.. _man_tsig-keygen:
tsig-keygen, ddns-confgen - TSIG key generation tool
----------------------------------------------------

3
doc/arm/advanced.rst
View file

@ -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
~~~~~~~~~~~~~~~~~

1
doc/arm/manpages.rst
View file

@ -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