From: Gert van Dijk Date: Sun, 31 Mar 2019 17:25:21 +0000 (+0200) Subject: docs: remove unintentional blockquotes in HTML X-Git-Tag: rec-4.2.0-rc1~45^2~38 X-Git-Url: http://git.ipfire.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=f404c4c680c20e6455e1e9b5b72f3e7a14a67920;p=thirdparty%2Fpdns.git docs: remove unintentional blockquotes in HTML Having leading spaces in either: * Lists * RST directives, such as .. toctree:: will lead to the listing being wrapped in an HTML
element with also the styling as such. This is probably unintentional and at least inconsistent with other occurrences. --- diff --git a/docs/backends/lua.rst b/docs/backends/lua.rst index aef67350c5..610f3f5c64 100644 --- a/docs/backends/lua.rst +++ b/docs/backends/lua.rst @@ -47,16 +47,16 @@ There is a couple of new functions for you to use in Lua: All these ``log_facilities`` is available: - * ``log_all`` - * ``log_ntlog`` - * ``log_alert`` - * ``log_critical`` - * ``log_error`` - * ``log_warning`` - * ``log_notice,`` - * ``log_info`` - * ``log_debug`` - * ``log_none`` +* ``log_all`` +* ``log_ntlog`` +* ``log_alert`` +* ``log_critical`` +* ``log_error`` +* ``log_warning`` +* ``log_notice,`` +* ``log_info`` +* ``log_debug`` +* ``log_none`` ``dnspacket()`` ~~~~~~~~~~~~~~~ diff --git a/docs/backends/remote.rst b/docs/backends/remote.rst index 61d794ca34..6a54b933d0 100644 --- a/docs/backends/remote.rst +++ b/docs/backends/remote.rst @@ -326,9 +326,9 @@ Returns the value(s) for variable kind for zone name. You **must** always return something, if there are no values, you shall return empty set or false. - * Mandatory: No - * Parameters: name - * Reply: hash of key to array of strings +* Mandatory: No +* Parameters: name +* Reply: hash of key to array of strings Example JSON/RPC '''''''''''''''' diff --git a/docs/changelog/4.1.rst b/docs/changelog/4.1.rst index 0b37c2614c..94cfe8f649 100644 --- a/docs/changelog/4.1.rst +++ b/docs/changelog/4.1.rst @@ -922,7 +922,7 @@ Changelogs for 4.1.x :tags: Tools, Improvements :pullreq: 4584 - Allow setting the account of a zone via pdnsutil (Tuxis Internet Engineering). + Allow setting the account of a zone via pdnsutil (Tuxis Internet Engineering). .. change:: :tags: Internals, New Features diff --git a/docs/common/security-policy.rst b/docs/common/security-policy.rst index 4c2b364609..6114a36560 100644 --- a/docs/common/security-policy.rst +++ b/docs/common/security-policy.rst @@ -19,7 +19,6 @@ Do note that only the PowerDNS software is in scope for the HackerOne program, n Disclosure Policy ^^^^^^^^^^^^^^^^^ - - Let us know as soon as possible upon discovery of a potential security issue, and we'll make every effort to quickly resolve the issue. - - Provide us a reasonable amount of time to resolve the issue before any disclosure to the public or a third-party. - - We will always credit researchers in our :doc:`../security-advisories/index`. - +- Let us know as soon as possible upon discovery of a potential security issue, and we'll make every effort to quickly resolve the issue. +- Provide us a reasonable amount of time to resolve the issue before any disclosure to the public or a third-party. +- We will always credit researchers in our :doc:`../security-advisories/index`. diff --git a/docs/index.rst b/docs/index.rst index ca5a8e7dd8..7ad7ee8dac 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -20,9 +20,9 @@ This documentation is also available as a `PDF document ` - * :doc:`Configure the Server ` - * :doc:`Configure the backend(s) ` +* :doc:`Install the Authoritative Server ` +* :doc:`Configure the Server ` +* :doc:`Configure the backend(s) ` Getting Support --------------- @@ -31,9 +31,9 @@ You may also help others (please do). Public support is available via several different channels: - * This documentation - * `The mailing list `_ - * ``#powerdns`` on `irc.oftc.net `_ +* This documentation +* `The mailing list `_ +* ``#powerdns`` on `irc.oftc.net `_ The PowerDNS company can provide help or support you in private as well. For first class and rapid support, please contact powerdns.support@powerdns.com, or see the `.com website `__. diff --git a/docs/lua-records/functions.rst b/docs/lua-records/functions.rst index d180c76b52..3b30327dab 100644 --- a/docs/lua-records/functions.rst +++ b/docs/lua-records/functions.rst @@ -188,17 +188,17 @@ Reverse DNS functions **Formatting options:** - - ``%1%`` to ``%4%`` are individual octets - - Example record query: ``1.0.0.127.in-addr.arpa`` - - ``%1%`` = 127 - - ``%2%`` = 0 - - ``%3%`` = 0 - - ``%4%`` = 1 - - ``%5%`` joins the four decimal octets together with dashes - - Example: ``%5%.static.example.com`` is equivalent to ``%1%-%2%-%3%-%4%.static.example.com`` - - ``%6%`` converts each octet from decimal to hexadecimal and joins them together - - Example: A query for ``15.0.0.127.in-addr.arpa`` - - ``%6`` would be ``7f00000f`` (127 is 7f, and 15 is 0f in hexadecimal) + - ``%1%`` to ``%4%`` are individual octets + - Example record query: ``1.0.0.127.in-addr.arpa`` + - ``%1%`` = 127 + - ``%2%`` = 0 + - ``%3%`` = 0 + - ``%4%`` = 1 + - ``%5%`` joins the four decimal octets together with dashes + - Example: ``%5%.static.example.com`` is equivalent to ``%1%-%2%-%3%-%4%.static.example.com`` + - ``%6%`` converts each octet from decimal to hexadecimal and joins them together + - Example: A query for ``15.0.0.127.in-addr.arpa`` + - ``%6`` would be ``7f00000f`` (127 is 7f, and 15 is 0f in hexadecimal) **NOTE:** At the current time, only forward dotted format works with :func:`createForward` (i.e. ``127.0.0.1.static.example.com``) @@ -255,18 +255,18 @@ Reverse DNS functions Formatting options: - - ``%1%`` to ``%32%`` are individual characters (nibbles) - - **Example PTR record query:** ``a.0.0.0.1.0.0.2.ip6.arpa`` - - ``%1%`` = 2 - - ``%2%`` = 0 - - ``%3%`` = 0 - - ``%4%`` = 1 - - ``%33%`` converts the compressed address format into a dashed format, e.g. ``2001:a::1`` to ``2001-a--1`` - - ``%34%`` to ``%41%`` represent the 8 uncompressed 2-byte chunks - - **Example:** PTR query for ``2001:a:b::123`` - - ``%34%`` - returns ``2001`` (chunk 1) - - ``%35%`` - returns ``000a`` (chunk 2) - - ``%41%`` - returns ``0123`` (chunk 8) + - ``%1%`` to ``%32%`` are individual characters (nibbles) + - **Example PTR record query:** ``a.0.0.0.1.0.0.2.ip6.arpa`` + - ``%1%`` = 2 + - ``%2%`` = 0 + - ``%3%`` = 0 + - ``%4%`` = 1 + - ``%33%`` converts the compressed address format into a dashed format, e.g. ``2001:a::1`` to ``2001-a--1`` + - ``%34%`` to ``%41%`` represent the 8 uncompressed 2-byte chunks + - **Example:** PTR query for ``2001:a:b::123`` + - ``%34%`` - returns ``2001`` (chunk 1) + - ``%35%`` - returns ``000a`` (chunk 2) + - ``%41%`` - returns ``0123`` (chunk 8) **NOTE:** At the current time, only dashed compressed format works for this function (i.e. ``2001-a-b--1.static6.example.com``) diff --git a/docs/lua-records/index.rst b/docs/lua-records/index.rst index 3c2a9b0864..d44dbe1a0b 100644 --- a/docs/lua-records/index.rst +++ b/docs/lua-records/index.rst @@ -200,7 +200,7 @@ explicitly, either globally (``enable-lua-records``) or per zone Reference --------- - .. toctree:: +.. toctree:: :maxdepth: 2 functions diff --git a/docs/lua-records/reference/comboaddress.rst b/docs/lua-records/reference/comboaddress.rst index 56156e2697..7d79eeec03 100644 --- a/docs/lua-records/reference/comboaddress.rst +++ b/docs/lua-records/reference/comboaddress.rst @@ -73,14 +73,14 @@ ComboAddressSet objects We provide a convenient object class that can store unique ComboAddresses in no particular order and allows fast retrieval of individual elements based on their values - .. code-block:: lua - - addr = newCA("1.2.3.4") - myset = newCAS() - myset:add(addr) - if myset:check(addr) then -- prints "found!" - print('found!') - end +.. code-block:: lua + + addr = newCA("1.2.3.4") + myset = newCAS() + myset:add(addr) + if myset:check(addr) then -- prints "found!" + print('found!') + end Functions and methods of a ``ComboAddressSet`` ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ diff --git a/docs/lua-records/reference/index.rst b/docs/lua-records/reference/index.rst index dbf23422a4..2ab827e1d8 100644 --- a/docs/lua-records/reference/index.rst +++ b/docs/lua-records/reference/index.rst @@ -1,7 +1,7 @@ LUA Reference ------------- - .. toctree:: +.. toctree:: :maxdepth: 2 comboaddress diff --git a/docs/lua-records/reference/misc.rst b/docs/lua-records/reference/misc.rst index 89e1f0f6ec..c9f28d7f5b 100644 --- a/docs/lua-records/reference/misc.rst +++ b/docs/lua-records/reference/misc.rst @@ -10,16 +10,16 @@ Other functions :param string message: The message to log :param int loglevel: The urgency level of the message. Defaults to `pdns.loglevels.Warning` - You can use the following constants as log levels : - - - `pdns.loglevels.Alert` - - `pdns.loglevels.Critical` - - `pdns.loglevels.Debug` - - `pdns.loglevels.Emergency` - - `pdns.loglevels.Info` - - `pdns.loglevels.Notice` - - `pdns.loglevels.Warning` - - `pdns.loglevels.Error` + You can use the following constants as log levels : + + - `pdns.loglevels.Alert` + - `pdns.loglevels.Critical` + - `pdns.loglevels.Debug` + - `pdns.loglevels.Emergency` + - `pdns.loglevels.Info` + - `pdns.loglevels.Notice` + - `pdns.loglevels.Warning` + - `pdns.loglevels.Error` .. function:: pdnsrandom([maximum]) diff --git a/docs/modes-of-operation.rst b/docs/modes-of-operation.rst index bf76cf28e9..15af055bed 100644 --- a/docs/modes-of-operation.rst +++ b/docs/modes-of-operation.rst @@ -201,12 +201,12 @@ itself as a slave for that zone. Before a supermaster notification succeeds, the following conditions must be met: - - :ref:`setting-supermaster` support must be enabled - - The supermaster must carry a SOA record for the notified domain - - The supermaster IP must be present in the 'supermaster' table - - The set of NS records for the domain, as retrieved by the slave from the supermaster, must include the name that goes with the IP address in the supermaster table - - If your master sends signed NOTIFY it will mark that TSIG key as the TSIG key used for retrieval as well - - If you turn off :ref:`setting-allow-unsigned-supermaster`, then your supermaster(s) are required to sign their notifications. +- :ref:`setting-supermaster` support must be enabled +- The supermaster must carry a SOA record for the notified domain +- The supermaster IP must be present in the 'supermaster' table +- The set of NS records for the domain, as retrieved by the slave from the supermaster, must include the name that goes with the IP address in the supermaster table +- If your master sends signed NOTIFY it will mark that TSIG key as the TSIG key used for retrieval as well +- If you turn off :ref:`setting-allow-unsigned-supermaster`, then your supermaster(s) are required to sign their notifications. .. warning:: If you use another PowerDNS server as master and have diff --git a/docs/running.rst b/docs/running.rst index 42b1ed8322..9900b96736 100644 --- a/docs/running.rst +++ b/docs/running.rst @@ -138,7 +138,7 @@ commands: - ``mrtg``: Dump statistics in mrtg format. See the performance :ref:`counters` documentation. - .. note:: +.. note:: Packages provided by Operating System vendors might support different or less commands.