3918. [doc] Update check-spf documentation. [RT #36910]

diff --git a/CHANGES b/CHANGES
index 677b762e68007cb08399d3dae656a35aa07c8647..356e6864babbde68bcdbff3ba26db04d0c52f446 100644 (file)
--- a/CHANGES
+++ b/CHANGES
@@ -1,3 +1,5 @@
+3918.  [doc]           Update check-spf documentation. [RT #36910]
+
 3917.  [bug]           dig, nslookup and host now continue on names that are
                        too long after applying a search list elements.
                        [RT #36892]

diff --git a/doc/arm/Bv9ARM-book.xml b/doc/arm/Bv9ARM-book.xml
index 4a13e0d504b6c85fae30976eb1bc73b5684e77d5..b26a8b52f64a368d8d512b3f6c5f639f18a4c8f5 100644 (file)
--- a/doc/arm/Bv9ARM-book.xml
+++ b/doc/arm/Bv9ARM-book.xml
@@ -4690,7 +4690,7 @@ badresp:1,adberr:0,findfail:0,valfail:0]
     <optional> check-mx-cname ( <replaceable>warn</replaceable> | <replaceable>fail</replaceable> | <replaceable>ignore</replaceable> ); </optional>
     <optional> check-srv-cname ( <replaceable>warn</replaceable> | <replaceable>fail</replaceable> | <replaceable>ignore</replaceable> ); </optional>
     <optional> check-sibling <replaceable>yes_or_no</replaceable>; </optional>
-    <optional> check-spf ( <replaceable>warn</replaceable> | <replaceable>fail</replaceable> | <replaceable>ignore</replaceable> ); </optional>
+    <optional> check-spf ( <replaceable>warn</replaceable> | <replaceable>ignore</replaceable> ); </optional>
     <optional> allow-new-zones { <replaceable>yes_or_no</replaceable> }; </optional>
     <optional> allow-notify { <replaceable>address_match_list</replaceable> }; </optional>
     <optional> allow-query { <replaceable>address_match_list</replaceable> }; </optional>
@@ -6442,10 +6442,13 @@ options {
                  The default is <command>yes</command>.
                </para>
                <para>
-                 Check that the two forms of Sender Policy Framework
-                 records (TXT records starting with "v=spf1" and SPF) either
-                 both exist or both don't exist.  Warnings are
-                 emitted it they don't and be suppressed with
+                 The use of the SPF record for publishing Sender
+                 Policy Framework is deprecated as the migration
+                 from using TXT records to SPF records was abandoned.
+                 Enabling this option also checks that a TXT Sender
+                 Policy Framework record exists (starts with "v=spf1")
+                 if there is an SPF record. Warnings are emitted if the
+                 TXT record does not exist and can be suppressed with
                  <command>check-spf</command>.
                </para>
              </listitem>
@@ -6487,11 +6490,11 @@ options {
              <term><command>check-spf</command></term>
              <listitem>
                <para>
-                 When performing integrity checks, check that the
-                 two forms of Sender Policy Framwork records (TXT
-                 records starting with "v=spf1" and SPF) both exist
-                 or both don't exist and issue a warning if not
-                 met.  The default is <command>warn</command>.
+                 If <command>check-integrity</command> is set then
+                 check that there is a TXT Sender Policy Framework
+                 record present (starts with "v=spf1") if there is an
+                 SPF record present. The default is
+                 <command>warn</command>.
                </para>
              </listitem>
            </varlistentry>
@@ -9947,7 +9950,7 @@ view "external" {
     <optional> check-names (<constant>warn</constant>|<constant>fail</constant>|<constant>ignore</constant>) ; </optional>
     <optional> check-mx (<constant>warn</constant>|<constant>fail</constant>|<constant>ignore</constant>) ; </optional>
     <optional> check-wildcard <replaceable>yes_or_no</replaceable>; </optional>
-    <optional> check-spf ( <replaceable>warn</replaceable> | <replaceable>fail</replaceable> | <replaceable>ignore</replaceable> ); </optional>
+    <optional> check-spf ( <replaceable>warn</replaceable> | <replaceable>ignore</replaceable> ); </optional>
     <optional> check-integrity <replaceable>yes_or_no</replaceable> ; </optional>
     <optional> dialup <replaceable>dialup_option</replaceable> ; </optional>
     <optional> file <replaceable>string</replaceable> ; </optional>