From 45bc88e5e9530c18879be2412aee33ba5d2bbf69 Mon Sep 17 00:00:00 2001
From: Scott Kitterman <scott@kitterman.com>
Date: Fri, 16 Feb 2018 16:22:44 -0500
Subject: [PATCH] Move Diagnostics option to initial beta release plan and add
 to dkimpy-milter.conf.5

---
 TODO                 | 8 ++++----
 dkimpy-milter.conf.5 | 7 +++++++
 2 files changed, 11 insertions(+), 4 deletions(-)

diff --git a/TODO b/TODO
index 8741444..7e40303 100644
--- a/TODO
+++ b/TODO
@@ -17,9 +17,11 @@ UserID              implemented     verified
 0.9.5 (Beta)
 AuthservID
 Canonicalization
+Diagnostics
 DiagnosticDirectory
 InternalHosts
-SyslogFacility 
+SyslogFacility
+SyslogSuccess
 
 1.0.0
 No additional features planned
@@ -29,14 +31,12 @@ Considered for near-term feature release
 AlwaysAddARHeader
 ChangeRootDirectory
 ClockDrift (requires dkimpy change)
-Diagnostics
-DNSTimeout (required dkmpy change)
+DNSTimeout (requires dkmpy change)
 MacroList
 MilterDebug
 MinimumKeyBits
 PeerList
 SignatureAlgorithm
-SyslogSuccess
 
 Later
 
diff --git a/dkimpy-milter.conf.5 b/dkimpy-milter.conf.5
index 99611d3..35e4eec 100644
--- a/dkimpy-milter.conf.5
+++ b/dkimpy-milter.conf.5
@@ -213,6 +213,13 @@ The value may include two different canonicalizations separated by a
 slash ("/") character, in which case the first will be applied to the
 header and the second to the body.
 
+.TP
+.I Diagnostics (Boolean)
+Requests the inclusion of "z=" tags in signatures, which encode the
+original header field set for use by verifiers when diagnosing verification
+failures.  Not recommended for normal operation. [dkimpy-milter specific: also
+increases the verbosity of Syslog logging if enabled.]
+
 .TP
 .I DiagnosticDirectory (string)
 Directory into which to write diagnostic reports when message verification