From: Jeremy Harris <jgh146exb@wizmail.org>
Date: Sun, 8 May 2022 12:20:49 +0000 (+0100)
Subject: Docs: clarify $authentication_failed.  Bug 2878
X-Git-Tag: exim-4.96-RC1~7
X-Git-Url: https://git.exim.org/exim.git/commitdiff_plain/6d8e1b63fda70bb4153034870cc8b68f9011d0e1

Docs: clarify $authentication_failed.  Bug 2878
---

diff --git a/doc/doc-docbook/spec.xfpt b/doc/doc-docbook/spec.xfpt
index 911f17ad8..eafd56fba 100644
--- a/doc/doc-docbook/spec.xfpt
+++ b/doc/doc-docbook/spec.xfpt
@@ -12536,9 +12536,10 @@ command that does not succeed. Otherwise it is set to &"0"&. This makes it
 possible to distinguish between &"did not try to authenticate"&
 (&$sender_host_authenticated$& is empty and &$authentication_failed$& is set to
 &"0"&) and &"tried to authenticate but failed"& (&$sender_host_authenticated$&
-is empty and &$authentication_failed$& is set to &"1"&). Failure includes any
-negative response to an AUTH command, including (for example) an attempt to use
-an undefined mechanism.
+is empty and &$authentication_failed$& is set to &"1"&).
+Failure includes cancellation of a authentication attempt,
+and any negative response to an AUTH command,
+(including, for example, an attempt to use an undefined mechanism).
 
 .vitem &$av_failed$&
 .cindex "content scanning" "AV scanner failure"