From mboxrd@z Thu Jan 1 00:00:00 1970 Path: news.gmane.io!.POSTED.ciao.gmane.io!not-for-mail From: "Jorge P. de Morais Neto" Newsgroups: gmane.emacs.bugs Subject: bug#40561: 27.0.90; Mail-related errors in docstrings and manuals Date: Sat, 11 Apr 2020 16:00:50 -0300 Message-ID: <87ftd9sv8d.fsf@disroot.org> Mime-Version: 1.0 Content-Type: text/plain; charset=utf-8 Content-Transfer-Encoding: quoted-printable Injection-Info: ciao.gmane.io; posting-host="ciao.gmane.io:159.69.161.202"; logging-data="60699"; mail-complaints-to="usenet@ciao.gmane.io" To: 40561@debbugs.gnu.org Original-X-From: bug-gnu-emacs-bounces+geb-bug-gnu-emacs=m.gmane-mx.org@gnu.org Sat Apr 11 21:02:14 2020 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 1jNLOO-000Fe3-1S for geb-bug-gnu-emacs@m.gmane-mx.org; Sat, 11 Apr 2020 21:02:12 +0200 Original-Received: from localhost ([::1]:55066 helo=lists1p.gnu.org) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1jNLOM-0001mA-Pe for geb-bug-gnu-emacs@m.gmane-mx.org; Sat, 11 Apr 2020 15:02:10 -0400 Original-Received: from eggs.gnu.org ([2001:470:142:3::10]:38443) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1jNLOF-0001ll-Pd for bug-gnu-emacs@gnu.org; Sat, 11 Apr 2020 15:02:05 -0400 Original-Received: from Debian-exim by eggs.gnu.org with spam-scanned (Exim 4.71) (envelope-from ) id 1jNLOE-0008G3-FR for bug-gnu-emacs@gnu.org; Sat, 11 Apr 2020 15:02:03 -0400 Original-Received: from debbugs.gnu.org ([209.51.188.43]:45540) by eggs.gnu.org with esmtps (TLS1.0:RSA_AES_128_CBC_SHA1:16) (Exim 4.71) (envelope-from ) id 1jNLOE-0008Fw-Bz for bug-gnu-emacs@gnu.org; Sat, 11 Apr 2020 15:02:02 -0400 Original-Received: from Debian-debbugs by debbugs.gnu.org with local (Exim 4.84_2) (envelope-from ) id 1jNLOE-0002lm-AD for bug-gnu-emacs@gnu.org; Sat, 11 Apr 2020 15:02:02 -0400 X-Loop: help-debbugs@gnu.org Resent-From: "Jorge P. de Morais Neto" Original-Sender: "Debbugs-submit" Resent-CC: bug-gnu-emacs@gnu.org Resent-Date: Sat, 11 Apr 2020 19:02:02 +0000 Resent-Message-ID: Resent-Sender: help-debbugs@gnu.org X-GNU-PR-Message: report 40561 X-GNU-PR-Package: emacs X-Debbugs-Original-To: bug-gnu-emacs@gnu.org Original-Received: via spool by submit@debbugs.gnu.org id=B.158663170110611 (code B ref -1); Sat, 11 Apr 2020 19:02:02 +0000 Original-Received: (at submit) by debbugs.gnu.org; 11 Apr 2020 19:01:41 +0000 Original-Received: from localhost ([127.0.0.1]:57086 helo=debbugs.gnu.org) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1jNLNo-0002l0-BR for submit@debbugs.gnu.org; Sat, 11 Apr 2020 15:01:41 -0400 Original-Received: from lists.gnu.org ([209.51.188.17]:59681) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1jNLNm-0002ks-Gz for submit@debbugs.gnu.org; Sat, 11 Apr 2020 15:01:35 -0400 Original-Received: from eggs.gnu.org ([2001:470:142:3::10]:37646) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1jNLNk-0001fm-G8 for bug-gnu-emacs@gnu.org; Sat, 11 Apr 2020 15:01:34 -0400 Original-Received: from Debian-exim by eggs.gnu.org with spam-scanned (Exim 4.71) (envelope-from ) id 1jNLNh-0007o4-Sc for bug-gnu-emacs@gnu.org; Sat, 11 Apr 2020 15:01:31 -0400 Original-Received: from knopi.disroot.org ([178.21.23.139]:37078) by eggs.gnu.org with esmtps (TLS1.0:DHE_RSA_AES_256_CBC_SHA1:32) (Exim 4.71) (envelope-from ) id 1jNLNg-0007mp-1P for bug-gnu-emacs@gnu.org; Sat, 11 Apr 2020 15:01:28 -0400 Original-Received: from localhost (localhost [127.0.0.1]) by disroot.org (Postfix) with ESMTP id 478ED2CCF5 for ; Sat, 11 Apr 2020 21:01:24 +0200 (CEST) X-Virus-Scanned: Debian amavisd-new at disroot.org Original-Received: from knopi.disroot.org ([127.0.0.1]) by localhost (disroot.org [127.0.0.1]) (amavisd-new, port 10024) with ESMTP id 7V1Wi_SOwFUJ for ; Sat, 11 Apr 2020 21:01:22 +0200 (CEST) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/simple; d=disroot.org; s=mail; t=1586631682; bh=7+KWrm85x3JcSEdfGcuWWaG5wyEi1JaagNP1ws5OJok=; h=From:To:Subject:Date; b=bDiTmBaVzN0/XXvCOvtQUDOht/s6tGbU1abumjr7nwr69R3yhQuWPXtldjIjWWs7I 54K+FD25B3PAwS6nbFJsMS3upwwp/J8eOUYY6MLal/YSm1q7mtDhpAw32urvrmbVvD J6fSzgFdCO5G9PbbIEJBKPCVS2Z8lX36Z0IfdYrCW0cKu/VjVk6EtjzP56WUOThKyV v3BzeHOhoVc1HD7kjLB5JDtA/nP44kL6DStJ8HYn2tJSsYxgOc9T6RX7fk0nAL/qT2 zngL8pPkfMijq940WWZPW3In0SgbfGRCqrQ5o3vTyfZgZDnct4veAaNRbio1rrhUh6 sG2ignVHd8WAA== X-detected-operating-system: by eggs.gnu.org: GNU/Linux 2.2.x-3.x [generic] [fuzzy] X-BeenThere: debbugs-submit@debbugs.gnu.org X-Mailman-Version: 2.1.18 Precedence: list X-detected-operating-system: by eggs.gnu.org: GNU/Linux 2.2.x-3.x [generic] X-Received-From: 209.51.188.43 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:178209 Archived-At: * Mail-related documentation errors Hello. Below I report a series of small mail-related errors/inconsistencies in Emacs docstrings and Info manual. ** C-u C-x m [[info:emacs#Sending Mail]] says If you invoke the command with a prefix argument, =E2=80=98C-u C-x m=E2= =80=99, Emacs switches back to the last mail buffer, and asks if you want to erase the message in that buffer However, the docstring of `compose-mail' says just CONTINUE, if non-nil, says to continue editing a message already being composed. Interactively, CONTINUE is the prefix argument. And in my quick testing with emacs -q, `C-u C-x m' does not ask to erase the message, suggesting the docstring is correct but not the manual. ** [[info:emacs#Mail Headers]] *** mail-from-style In comparison with the `mail-from-style' docstring, the manual informs the wrong default and fails to mention that the variable is obsolete because only the `angles' value respects RFC2822[1]. And I think that, since the variable is now obsolete , then the Info manual should not even discuss it at length. 1: I don't know why the docstring mentions RFC 2822, as Wikipedia says that RFC 5322 replaced the earlier RFC 2822 in 2008. See https://en.wikipedia.org/wiki/Email#Internet_Message_Format *** `Mail-Followup-To' I could not understand the meaning of `Mail-Followup-To'. The manual describes a use case, but I did not understand what is the intended difference in behavior of a mail client that replies to a message containing `Mail-Followup-To' instead of `Mail-Reply-To' or `Reply-To'. ** [[info:emacs#Mail Aliases]] Is this feature still widely used? Are users supposed to manually maintain ~/.mailrc? Do not the great majority rely on more convenient completion mechanisms like LDAP, notmuch or EBDB? If so, it may be wise to move this manual section to the end, and mention (even if just in a generic way) that there are much more popular completion mechanisms. The Emacs manual is large, and it seems a good idea to organize it in such a way that the user can easily identify (and optionally skip) the less important sections. ** [[info:emacs#Mail Sending]] Why does this section describe the possible values of `send-mail-function' (used for Mail mode), when the section is about Message mode? ** [[info:emacs#Header Editing]] This section of the Info manual says that `message-tab' attempts to insert the full name corresponding to the address based on a couple of methods, including EUDC, a library that recognizes a number of directory server protocols[...] Failing that, it attempts to expand the address as a mail alias[...] The docstring, however, omits the fallback to mail alias completion. ** `mail-user-agent' docstring The docstring of `mail-user-agent' refers to the Info node `(message)' for Message mode and `(emacs)Sending Mail' for Mail mode. This is a bit misleading because `(emacs)Sending Mail' describes directly Message mode and only indirectly (by compatibility) does it describe Mail mode. * Feedback I am obsessed with detail and I welcome feedback about that -- please tell me whether I am nitpicking. Regards In GNU Emacs 27.0.90 (build 1, x86_64-pc-linux-gnu, GTK+ Version 3.24.5) of 2020-04-11 built on jorge--inspiron-5570 Repository revision: fd27685c1e68e742abf1698573dac53743f15e48 Repository branch: emacs-27 Windowing system distributor 'The X.Org Foundation', version 11.0.12004000 System Description: Debian GNU/Linux 10 (buster) [ I omitted some details generated by M-x report-emacs-bug that seem irrelevant to documentation bug reports. ] --=20 - - I am Brazilian. I hope my English is correct and I welcome feedback. - Please adopt free/libre formats like PDF, ODF, Org, LaTeX, Opus, WebM and= 7z. - Free/libre software for Replicant, LineageOS and Android: https://f-droid= .org - [[https://www.gnu.org/philosophy/free-sw.html][What is free software?]]