From mboxrd@z Thu Jan 1 00:00:00 1970 Path: news.gmane.io!.POSTED.blaine.gmane.org!not-for-mail From: Damien Cassou Newsgroups: gmane.emacs.bugs Subject: bug#55569: Improve documentation of mail-user-agent Date: Sun, 22 May 2022 09:48:46 +0200 Message-ID: <87a6ba2ejl.fsf@cassou.me> References: <871qwmks7a.fsf@cassou.me> <83v8ty6q1o.fsf@gnu.org> <87czg62fx9.fsf@cassou.me> <83sfp26n6h.fsf@gnu.org> Mime-Version: 1.0 Content-Type: multipart/mixed; boundary="=-=-=" Injection-Info: ciao.gmane.io; posting-host="blaine.gmane.org:116.202.254.214"; logging-data="20345"; mail-complaints-to="usenet@ciao.gmane.io" Cc: 55569@debbugs.gnu.org To: Eli Zaretskii Original-X-From: bug-gnu-emacs-bounces+geb-bug-gnu-emacs=m.gmane-mx.org@gnu.org Sun May 22 09:49:10 2022 Return-path: Envelope-to: geb-bug-gnu-emacs@m.gmane-mx.org Original-Received: from lists.gnu.org ([209.51.188.17]) by ciao.gmane.io with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.92) (envelope-from ) id 1nsgKs-00058L-0l for geb-bug-gnu-emacs@m.gmane-mx.org; Sun, 22 May 2022 09:49:10 +0200 Original-Received: from localhost ([::1]:54710 helo=lists1p.gnu.org) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1nsgKq-00047I-In for geb-bug-gnu-emacs@m.gmane-mx.org; Sun, 22 May 2022 03:49:08 -0400 Original-Received: from eggs.gnu.org ([2001:470:142:3::10]:56924) by lists.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.90_1) (envelope-from ) id 1nsgKk-000479-CJ for bug-gnu-emacs@gnu.org; Sun, 22 May 2022 03:49:02 -0400 Original-Received: from debbugs.gnu.org ([209.51.188.43]:49711) by eggs.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_128_GCM_SHA256:128) (Exim 4.90_1) (envelope-from ) id 1nsgKk-0005JL-2c for bug-gnu-emacs@gnu.org; Sun, 22 May 2022 03:49:02 -0400 Original-Received: from Debian-debbugs by debbugs.gnu.org with local (Exim 4.84_2) (envelope-from ) id 1nsgKj-0001aH-W4 for bug-gnu-emacs@gnu.org; Sun, 22 May 2022 03:49:01 -0400 X-Loop: help-debbugs@gnu.org Resent-From: Damien Cassou Original-Sender: "Debbugs-submit" Resent-CC: bug-gnu-emacs@gnu.org Resent-Date: Sun, 22 May 2022 07:49:01 +0000 Resent-Message-ID: Resent-Sender: help-debbugs@gnu.org X-GNU-PR-Message: followup 55569 X-GNU-PR-Package: emacs X-GNU-PR-Keywords: patch Original-Received: via spool by 55569-submit@debbugs.gnu.org id=B55569.16532057356077 (code B ref 55569); Sun, 22 May 2022 07:49:01 +0000 Original-Received: (at 55569) by debbugs.gnu.org; 22 May 2022 07:48:55 +0000 Original-Received: from localhost ([127.0.0.1]:43608 helo=debbugs.gnu.org) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1nsgKc-0001Zw-LD for submit@debbugs.gnu.org; Sun, 22 May 2022 03:48:54 -0400 Original-Received: from mail.choca.pics ([80.67.172.235]:35590) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1nsgKX-0001Zj-KZ for 55569@debbugs.gnu.org; Sun, 22 May 2022 03:48:53 -0400 Original-Received: from localhost (localhost.localdomain [IPv6:::1]) by mail.choca.pics (Postfix) with ESMTP id 3169918197CC7; Sun, 22 May 2022 09:48:48 +0200 (CEST) Original-Received: from mail.choca.pics ([IPv6:::1]) by localhost (mail.choca.pics [IPv6:::1]) (amavisd-new, port 10032) with ESMTP id zli4lX5rWazZ; Sun, 22 May 2022 09:48:47 +0200 (CEST) Original-Received: from localhost (localhost.localdomain [IPv6:::1]) by mail.choca.pics (Postfix) with ESMTP id 51A791817C2C5; Sun, 22 May 2022 09:48:47 +0200 (CEST) X-Virus-Scanned: amavisd-new at choca.pics Original-Received: from mail.choca.pics ([IPv6:::1]) by localhost (mail.choca.pics [IPv6:::1]) (amavisd-new, port 10026) with ESMTP id YeCloFQz1W7k; Sun, 22 May 2022 09:48:47 +0200 (CEST) Original-Received: from localhost (153.226.95.79.rev.sfr.net [79.95.226.153]) by mail.choca.pics (Postfix) with ESMTPSA id E94D418193F60; Sun, 22 May 2022 09:48:46 +0200 (CEST) In-Reply-To: <83sfp26n6h.fsf@gnu.org> X-BeenThere: debbugs-submit@debbugs.gnu.org X-Mailman-Version: 2.1.18 Precedence: list X-BeenThere: bug-gnu-emacs@gnu.org List-Id: "Bug reports for GNU Emacs, the Swiss army knife of text editors" List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: bug-gnu-emacs-bounces+geb-bug-gnu-emacs=m.gmane-mx.org@gnu.org Original-Sender: "bug-gnu-emacs" Xref: news.gmane.io gmane.emacs.bugs:232877 Archived-At: --=-=-= Content-Type: text/plain Eli Zaretskii 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 --=-=-= Content-Type: text/x-patch Content-Disposition: attachment; filename=0001-Improve-documentation-of-mail-user-agent.patch >From 14361675353a4f026eacffd04b88c31bdd4cc9f9 Mon Sep 17 00:00:00 2001 From: Damien Cassou 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 --=-=-=--