From mboxrd@z Thu Jan 1 00:00:00 1970 Path: news.gmane.io!.POSTED.blaine.gmane.org!not-for-mail From: Eli Zaretskii Newsgroups: gmane.emacs.bugs Subject: bug#55569: Improve documentation of mail-user-agent Date: Sun, 22 May 2022 10:28:38 +0300 Message-ID: <83sfp26n6h.fsf@gnu.org> References: <871qwmks7a.fsf@cassou.me> <83v8ty6q1o.fsf@gnu.org> <87czg62fx9.fsf@cassou.me> Injection-Info: ciao.gmane.io; posting-host="blaine.gmane.org:116.202.254.214"; logging-data="11928"; mail-complaints-to="usenet@ciao.gmane.io" Cc: 55569@debbugs.gnu.org To: Damien Cassou Original-X-From: bug-gnu-emacs-bounces+geb-bug-gnu-emacs=m.gmane-mx.org@gnu.org Sun May 22 09:30:27 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 1nsg2l-0002yd-0B for geb-bug-gnu-emacs@m.gmane-mx.org; Sun, 22 May 2022 09:30:27 +0200 Original-Received: from localhost ([::1]:44550 helo=lists1p.gnu.org) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1nsg2j-0003yi-R1 for geb-bug-gnu-emacs@m.gmane-mx.org; Sun, 22 May 2022 03:30:25 -0400 Original-Received: from eggs.gnu.org ([2001:470:142:3::10]:55418) by lists.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.90_1) (envelope-from ) id 1nsg2N-0003yI-Mk for bug-gnu-emacs@gnu.org; Sun, 22 May 2022 03:30:04 -0400 Original-Received: from debbugs.gnu.org ([209.51.188.43]:49705) by eggs.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_128_GCM_SHA256:128) (Exim 4.90_1) (envelope-from ) id 1nsg2N-0002cO-4I for bug-gnu-emacs@gnu.org; Sun, 22 May 2022 03:30:03 -0400 Original-Received: from Debian-debbugs by debbugs.gnu.org with local (Exim 4.84_2) (envelope-from ) id 1nsg2N-00015E-0H for bug-gnu-emacs@gnu.org; Sun, 22 May 2022 03:30:03 -0400 X-Loop: help-debbugs@gnu.org Resent-From: Eli Zaretskii Original-Sender: "Debbugs-submit" Resent-CC: bug-gnu-emacs@gnu.org Resent-Date: Sun, 22 May 2022 07:30:02 +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.16532045444067 (code B ref 55569); Sun, 22 May 2022 07:30:02 +0000 Original-Received: (at 55569) by debbugs.gnu.org; 22 May 2022 07:29:04 +0000 Original-Received: from localhost ([127.0.0.1]:43602 helo=debbugs.gnu.org) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1nsg1P-00013S-Uz for submit@debbugs.gnu.org; Sun, 22 May 2022 03:29:04 -0400 Original-Received: from eggs.gnu.org ([209.51.188.92]:33832) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1nsg1O-00012r-2I for 55569@debbugs.gnu.org; Sun, 22 May 2022 03:29:02 -0400 Original-Received: from fencepost.gnu.org ([2001:470:142:3::e]:36884) by eggs.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.90_1) (envelope-from ) id 1nsg1I-0002Xq-Dc; Sun, 22 May 2022 03:28:56 -0400 DKIM-Signature: v=1; a=rsa-sha256; q=dns/txt; c=relaxed/relaxed; d=gnu.org; s=fencepost-gnu-org; h=References:Subject:In-Reply-To:To:From:Date: mime-version; bh=/zmmKOatsKgodebUKV/H5czpTFn73LQaDAY1a7cJHdc=; b=K/Hx8FEMCV/L aPyCIBkHbHNNvltl1r9Gv58KzkrP472KusGSDE7KHbobu9bsU1xoIvqUHGuc65R+o2JVFOzISZZee wIS8T+T4qJAfzzYP040DHdK8xkZLeBnI1IvXQBZYwnsNwvZdYlESuH3i/yyObuH9YEb0bRS5vQ/p8 oD5uStEFI/QnOepy2b5aT0J8Va7ndc23fIyJ9sCc4+gsVynsGPZ6vKLo/m7aicAQN14daHpy4s5Mw klsgHC23DzVikdXgb0pr8tRIQ+ODDQGFyRVwA6/hBB7ScOerF0HbKzDxTaF9nb0LKoaypNHley6Dg PEO1Kze2cIm6gsZbppNd6w==; Original-Received: from [87.69.77.57] (port=2076 helo=home-c4e4a596f7) by fencepost.gnu.org with esmtpsa (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.90_1) (envelope-from ) id 1nsg1H-00057Q-PN; Sun, 22 May 2022 03:28:56 -0400 In-Reply-To: <87czg62fx9.fsf@cassou.me> (message from Damien Cassou on Sun, 22 May 2022 09:18:58 +0200) 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:232875 Archived-At: > From: Damien Cassou > Cc: 55569@debbugs.gnu.org > Date: Sun, 22 May 2022 09:18:58 +0200 > > Hi Eli, > > Eli Zaretskii writes: > >> +@code{mh-e-user-agent}. Additional options may be available; check > >> +with the author of your mail user agent package for details. You may > >> +also define another mail user agent using `define-mail-user-agent'. > > > > Thanks, but what do you mean by "the author of your mail user agent > > package"? > > > I mean that the authors of notmuch and mu4e both define a symbol to be > used as value for the `mail-user-agent` variable: `mu4e-user-agent` and > `notmuch-user-agent`. These symbols should be documented somewhere in > notmuch and mu4e manuals so their users know they should pass them to > `mail-user-agent`. There might be other mail user agent packages out > there that I don't know about. > > > > This is an Emacs user manual, and I very much doubt that > > Emacs users could figure out where and how to check that. > > > > Can we provide more practical advice here how to check for those > > additional options? > > > I could certainly mention the symbols for notmuch and mu4e if you think > that is ok to mention external packages inside the Emacs manual but I'm > not sure what else I could do. 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".