From: Damien Cassou <damien@cassou.me>
To: Eli Zaretskii <eliz@gnu.org>
Cc: 55569@debbugs.gnu.org
Subject: bug#55569: Improve documentation of mail-user-agent
Date: Sun, 22 May 2022 09:48:46 +0200 [thread overview]
Message-ID: <87a6ba2ejl.fsf@cassou.me> (raw)
In-Reply-To: <83sfp26n6h.fsf@gnu.org>
[-- Attachment #1: Type: text/plain, Size: 450 bytes --]
Eli Zaretskii <eliz@gnu.org> writes:
> If those additional options are supposed to be documented in the MUA
> manual, let's suggest that users look in those manuals. That is IMO
> better than to send them to some unnamed "authors".
Here is a new version of the patch that references the "manual" instead
of the "authors".
--
Damien Cassou
"Success is the ability to go from one failure to another without
losing enthusiasm." --Winston Churchill
[-- Warning: decoded text below may be mangled, UTF-8 assumed --]
[-- Attachment #2: 0001-Improve-documentation-of-mail-user-agent.patch --]
[-- Type: text/x-patch, Size: 2019 bytes --]
From 14361675353a4f026eacffd04b88c31bdd4cc9f9 Mon Sep 17 00:00:00 2001
From: Damien Cassou <damien@cassou.me>
Date: Sun, 22 May 2022 08:09:38 +0200
Subject: [PATCH] Improve documentation of mail-user-agent.
* doc/emacs/sending.texi (Mail Methods): Add sentences.
* lisp/simple.el (mail-user-agent): Add sentences to the documentation
string.
---
doc/emacs/sending.texi | 4 +++-
lisp/simple.el | 7 ++++---
2 files changed, 7 insertions(+), 4 deletions(-)
diff --git a/doc/emacs/sending.texi b/doc/emacs/sending.texi
index ea87e0a77b..acdae8a263 100644
--- a/doc/emacs/sending.texi
+++ b/doc/emacs/sending.texi
@@ -667,7 +667,9 @@ Mail Methods
customize the variable @code{mail-user-agent}. Currently, legitimate
values include @code{message-user-agent} (Message mode)
@code{sendmail-user-agent} (Mail mode), @code{gnus-user-agent}, and
-@code{mh-e-user-agent}.
+@code{mh-e-user-agent}. Additional options may be available; check
+in the manual of your mail user agent package for details. You may
+also define another mail user agent using `define-mail-user-agent'.
If you select a different mail-composition method, the information
in this chapter about the mail buffer and Message mode does not apply;
diff --git a/lisp/simple.el b/lisp/simple.el
index 6906675f68..cdb7ce6832 100644
--- a/lisp/simple.el
+++ b/lisp/simple.el
@@ -9210,9 +9210,10 @@ mail-user-agent
paraphernalia if Gnus is running, particularly
the Gcc: header for archiving.
-Additional valid symbols may be available; check with the author of
-your package for details. The function should return non-nil if it
-succeeds.
+Additional valid symbols may be available; check in the manual of
+your mail user agent package for details. You may also define
+your own symbol to be used as value for this variable using
+`define-mail-user-agent'.
See also `read-mail-command' concerning reading mail."
:type '(radio (function-item :tag "Message package"
--
2.36.0
next prev parent reply other threads:[~2022-05-22 7:48 UTC|newest]
Thread overview: 6+ messages / expand[flat|nested] mbox.gz Atom feed top
2022-05-22 6:16 bug#55569: Improve documentation of mail-user-agent Damien Cassou
2022-05-22 6:26 ` Eli Zaretskii
2022-05-22 7:18 ` Damien Cassou
2022-05-22 7:28 ` Eli Zaretskii
2022-05-22 7:48 ` Damien Cassou [this message]
2022-05-22 8:18 ` Eli Zaretskii
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
List information: https://www.gnu.org/software/emacs/
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=87a6ba2ejl.fsf@cassou.me \
--to=damien@cassou.me \
--cc=55569@debbugs.gnu.org \
--cc=eliz@gnu.org \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
Code repositories for project(s) associated with this public inbox
https://git.savannah.gnu.org/cgit/emacs.git
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for read-only IMAP folder(s) and NNTP newsgroup(s).