From dfc7b630db56f176b149666b0cdaf7d2f3b49a34 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Petr=20Men=C5=A1=C3=ADk?= Date: Sat, 24 Sep 2022 14:22:20 -0400 Subject: [PATCH 1/2] Compatibility for building ARM on older sphinx Make documentation building successful even on RHEL9 sphinx 3.4.3. It does not like case-insensitive matching of terms, so provide lowercase text description with Uppercase word reference. (cherry picked from commit bc6c6b1184ff1441bddb37cb4d3e2cf7481f2f1d) --- doc/arm/dnssec.inc.rst | 2 +- doc/arm/reference.rst | 8 ++++---- 2 files changed, 5 insertions(+), 5 deletions(-) diff --git a/doc/arm/dnssec.inc.rst b/doc/arm/dnssec.inc.rst index 0d7200054a..f4810aeeff 100644 --- a/doc/arm/dnssec.inc.rst +++ b/doc/arm/dnssec.inc.rst @@ -282,7 +282,7 @@ NSEC3 To sign using :ref:`NSEC3 ` instead of :ref:`NSEC `, add an NSEC3PARAM record to the initial update -request. The :term:`OPTOUT ` bit in the NSEC3 +request. The :term:`OPTOUT ` bit in the NSEC3 chain can be set in the flags field of the NSEC3PARAM record. diff --git a/doc/arm/reference.rst b/doc/arm/reference.rst index 26af274c00..9204b74ed6 100644 --- a/doc/arm/reference.rst +++ b/doc/arm/reference.rst @@ -35,7 +35,7 @@ The file :file:`named.conf` may contain three types of entities: Block :ref:`Blocks ` are containers for :term:`statements - ` which either have common functionality - for example, + ` which either have common functionality - for example, the definition of a cryptographic key in a :namedconf:ref:`key` block - or which define the scope of the statement - for example, a statement which appears in a :namedconf:ref:`zone` block has scope only for that zone. @@ -68,7 +68,7 @@ The file :file:`named.conf` may contain three types of entities: more argument/value pairs. The :any:`also-notify` statement may take a number of such argument/value pairs, such as ``also-notify port 5353;``, where ``port`` is the argument and ``5353`` is the corresponding value. - - Statements can appear in a single :term:`block` - for + - Statements can appear in a single :term:`block ` - for example, an :namedconf:ref:`algorithm` statement can appear only in a :namedconf:ref:`key` block - or in multiple blocks - for example, an :any:`also-notify` statement can appear in an :namedconf:ref:`options` @@ -6544,8 +6544,8 @@ The following options can be specified in a :any:`dnssec-policy` statement: of the indicated length. .. warning:: - Do not use extra :term:`iterations`, :term:`salt`, and - :term:`opt-out` unless their implications are fully understood. + Do not use extra :term:`iterations `, :term:`salt `, and + :term:`opt-out ` unless their implications are fully understood. A higher number of iterations causes interoperability problems and opens servers to CPU-exhausting DoS attacks. From ad59ef103fa941b63b7e2c8465c414deaf9b53fa Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Petr=20Men=C5=A1=C3=ADk?= Date: Mon, 26 Sep 2022 13:52:20 +0200 Subject: [PATCH 2/2] Simplify allowing warnings during ARM build RHEL8 Sphinx does not support all features used in ARM building. But with few emitted warnings it can build the documentation fine. Simplify warnings acceptance by allowing make doc SPHINX_W=''. (cherry picked from commit 3db7e241d25e7c6d50c7a8a26c84e84c0f7344c7) --- Makefile.docs | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/Makefile.docs b/Makefile.docs index 4a7b8e597a..13692895cd 100644 --- a/Makefile.docs +++ b/Makefile.docs @@ -2,6 +2,7 @@ SPHINX_V = $(SPHINX_V_@AM_V@) SPHINX_V_ = $(SPHINX_V_@AM_DEFAULT_V@) SPHINX_V_0 = -q SPHINX_V_1 = -n +SPHINX_W = -W AM_V_SPHINX = $(AM_V_SPHINX_@AM_V@) AM_V_SPHINX_ = $(AM_V_SPHINX_@AM_DEFAULT_V@) @@ -20,7 +21,7 @@ SESSION_KEY = .. |session_key| replace:: ``$(runstatedir)/session.key`` export RST_EPILOG = $(RNDC_CONF)$(LF)$(RNDC_KEY)$(LF)$(NAMED_CONF)$(LF)$(BIND_KEYS)$(LF)$(NAMED_PID)$(LF)$(SESSION_KEY) common_SPHINXOPTS = \ - -W \ + $(SPHINX_W) \ -c $(srcdir) \ -a \ $(SPHINX_V)