[exim-dev] [PATCH] Docs: fix cross-reference for $spf_receiv…

Góra strony
Delete this message
Reply to this message
Autor: Andreas Metzler
Data:  
Dla: exim-dev
Temat: [exim-dev] [PATCH] Docs: fix cross-reference for $spf_received
Hello,

the existing cross-reference point is broken, also the description is
unnecessary short, imho.

cu Andreas
--
`What a good friend you are to him, Dr. Maturin. His other friends are
so grateful to you.'
`I sew his ears on from time to time, sure'
>From 01054b307da64e3fe13c6a98911fc71de2a1044b Mon Sep 17 00:00:00 2001
From: Andreas Metzler <ametzler@???>
Date: Tue, 20 Jul 2021 13:13:19 +0200
Subject: [PATCH] Docs: fix cross-reference for $spf_received

---
doc/doc-docbook/spec.xfpt | 12 ++++++++----
1 file changed, 8 insertions(+), 4 deletions(-)

diff --git a/doc/doc-docbook/spec.xfpt b/doc/doc-docbook/spec.xfpt
index fef3dfce6..393085832 100644
--- a/doc/doc-docbook/spec.xfpt
+++ b/doc/doc-docbook/spec.xfpt
@@ -41869,10 +41869,14 @@ variables:

.vitem &$spf_received$&
.vindex &$spf_received$&
- This contains a complete Received-SPF: header that can be
- added to the message. Please note that according to the SPF
- draft, this header must be added at the top of the header
- list. Please see section 10 on how you can do this.
+ This contains a complete Received-SPF: header (name and
+ content) that can be added to the message. Please note that
+ according to the SPF draft, this header must be added at the
+ top of the header list, i.e. with
+.code
+add_header = :at_start:$spf_received
+.endd
+ See section &<<SECTaddheadacl>>& for further details.

Note: in case of "Best-guess" (see below), the convention is
to put this string in a header called X-SPF-Guess: instead.
--
2.30.2