From: Kevin McCarthy <kevin@8t8.us>
Date: Fri, 14 Jun 2019 00:56:38 +0000 (-0700)
Subject: Improve $reverse_realname documentation.
X-Git-Tag: mutt-1-12-1-rel~3
X-Git-Url: https://granicus.if.org/sourcecode?a=commitdiff_plain;h=81fb9dd88b0de7ba4930ae25d5a7614b0bf04d13;p=mutt

Improve $reverse_realname documentation.

Make it clear that, even if set, a missing realname part of the
matching address will be filled in by $realname.
---

diff --git a/init.h b/init.h
index dcb157f0..79c1ff51 100644
--- a/init.h
+++ b/init.h
@@ -2922,15 +2922,22 @@ struct option_t MuttVars[] = {
   ** used doesn't match your ``$alternates'', the \fIFrom:\fP line will use
   ** your address on the current machine.
   ** .pp
-  ** Also see the ``$alternates'' command.
+  ** Also see the ``$alternates'' command and $$reverse_realname.
   */
   { "reverse_realname",	DT_BOOL, R_BOTH, OPTREVREAL, 1 },
   /*
   ** .pp
   ** This variable fine-tunes the behavior of the $$reverse_name feature.
-  ** When it is \fIset\fP, mutt will use the address from incoming messages as-is,
-  ** possibly including eventual real names.  When it is \fIunset\fP, mutt will
-  ** override any such real names with the setting of the $$realname variable.
+  ** .pp
+  ** When it is \fIunset\fP, Mutt will remove the real name part of a
+  ** matching address.  This allows the use of the email address
+  ** without having to also use what the sender put in the real name
+  ** field.
+  ** .pp
+  ** When it is \fIset\fP, Mutt will use the matching address as-is.
+  ** .pp
+  ** In either case, a missing real name will be filled in afterwards
+  ** using the value of $$realname.
   */
   { "rfc2047_parameters", DT_BOOL, R_NONE, OPTRFC2047PARAMS, 0 },
   /*