From mboxrd@z Thu Jan 1 00:00:00 1970 Path: news.gmane.org!not-for-mail From: Drew Adams Newsgroups: gmane.emacs.bugs Subject: bug#20135: 25.0.50; Emacs manual typos for key bindings Date: Wed, 18 Mar 2015 08:08:47 -0700 (PDT) Message-ID: NNTP-Posting-Host: plane.gmane.org Mime-Version: 1.0 Content-Type: text/plain; charset=us-ascii Content-Transfer-Encoding: quoted-printable X-Trace: ger.gmane.org 1426691370 28207 80.91.229.3 (18 Mar 2015 15:09:30 GMT) X-Complaints-To: usenet@ger.gmane.org NNTP-Posting-Date: Wed, 18 Mar 2015 15:09:30 +0000 (UTC) To: 20135@debbugs.gnu.org Original-X-From: bug-gnu-emacs-bounces+geb-bug-gnu-emacs=m.gmane.org@gnu.org Wed Mar 18 16:09:17 2015 Return-path: Envelope-to: geb-bug-gnu-emacs@m.gmane.org Original-Received: from lists.gnu.org ([208.118.235.17]) by plane.gmane.org with esmtp (Exim 4.69) (envelope-from ) id 1YYFas-00088r-HL for geb-bug-gnu-emacs@m.gmane.org; Wed, 18 Mar 2015 16:09:14 +0100 Original-Received: from localhost ([::1]:34297 helo=lists.gnu.org) by lists.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1YYFar-0002NF-AV for geb-bug-gnu-emacs@m.gmane.org; Wed, 18 Mar 2015 11:09:13 -0400 Original-Received: from eggs.gnu.org ([2001:4830:134:3::10]:38200) by lists.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1YYFan-0002Kt-7i for bug-gnu-emacs@gnu.org; Wed, 18 Mar 2015 11:09:10 -0400 Original-Received: from Debian-exim by eggs.gnu.org with spam-scanned (Exim 4.71) (envelope-from ) id 1YYFag-0007NJ-NU for bug-gnu-emacs@gnu.org; Wed, 18 Mar 2015 11:09:09 -0400 Original-Received: from debbugs.gnu.org ([140.186.70.43]:53193) by eggs.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1YYFag-0007N9-Ki for bug-gnu-emacs@gnu.org; Wed, 18 Mar 2015 11:09:02 -0400 Original-Received: from Debian-debbugs by debbugs.gnu.org with local (Exim 4.80) (envelope-from ) id 1YYFag-0002iz-Ae for bug-gnu-emacs@gnu.org; Wed, 18 Mar 2015 11:09:02 -0400 X-Loop: help-debbugs@gnu.org Resent-From: Drew Adams Original-Sender: "Debbugs-submit" Resent-CC: bug-gnu-emacs@gnu.org Resent-Date: Wed, 18 Mar 2015 15:09:02 +0000 Resent-Message-ID: Resent-Sender: help-debbugs@gnu.org X-GNU-PR-Message: report 20135 X-GNU-PR-Package: emacs X-GNU-PR-Keywords: X-Debbugs-Original-To: bug-gnu-emacs@gnu.org Original-Received: via spool by submit@debbugs.gnu.org id=B.142669134110467 (code B ref -1); Wed, 18 Mar 2015 15:09:02 +0000 Original-Received: (at submit) by debbugs.gnu.org; 18 Mar 2015 15:09:01 +0000 Original-Received: from localhost ([127.0.0.1]:51761 helo=debbugs.gnu.org) by debbugs.gnu.org with esmtp (Exim 4.80) (envelope-from ) id 1YYFae-0002ii-VQ for submit@debbugs.gnu.org; Wed, 18 Mar 2015 11:09:01 -0400 Original-Received: from eggs.gnu.org ([208.118.235.92]:36427) by debbugs.gnu.org with esmtp (Exim 4.80) (envelope-from ) id 1YYFab-0002iZ-J5 for submit@debbugs.gnu.org; Wed, 18 Mar 2015 11:08:58 -0400 Original-Received: from Debian-exim by eggs.gnu.org with spam-scanned (Exim 4.71) (envelope-from ) id 1YYFaa-0007Lv-Ac for submit@debbugs.gnu.org; Wed, 18 Mar 2015 11:08:57 -0400 Original-Received: from lists.gnu.org ([2001:4830:134:3::11]:52067) by eggs.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1YYFaa-0007Lp-7p for submit@debbugs.gnu.org; Wed, 18 Mar 2015 11:08:56 -0400 Original-Received: from eggs.gnu.org ([2001:4830:134:3::10]:38149) by lists.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1YYFaY-0002KY-RT for bug-gnu-emacs@gnu.org; Wed, 18 Mar 2015 11:08:56 -0400 Original-Received: from Debian-exim by eggs.gnu.org with spam-scanned (Exim 4.71) (envelope-from ) id 1YYFaV-0007L0-Lg for bug-gnu-emacs@gnu.org; Wed, 18 Mar 2015 11:08:54 -0400 Original-Received: from aserp1040.oracle.com ([141.146.126.69]:32511) by eggs.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1YYFaV-0007Ko-FL for bug-gnu-emacs@gnu.org; Wed, 18 Mar 2015 11:08:51 -0400 Original-Received: from ucsinet21.oracle.com (ucsinet21.oracle.com [156.151.31.93]) by aserp1040.oracle.com (Sentrion-MTA-4.3.2/Sentrion-MTA-4.3.2) with ESMTP id t2IF8ni4019713 (version=TLSv1/SSLv3 cipher=DHE-RSA-AES256-SHA bits=256 verify=OK) for ; Wed, 18 Mar 2015 15:08:50 GMT Original-Received: from userz7022.oracle.com (userz7022.oracle.com [156.151.31.86]) by ucsinet21.oracle.com (8.14.4+Sun/8.14.4) with ESMTP id t2IF8mh0015547 (version=TLSv1/SSLv3 cipher=DHE-RSA-AES256-SHA bits=256 verify=NO) for ; Wed, 18 Mar 2015 15:08:49 GMT Original-Received: from abhmp0001.oracle.com (abhmp0001.oracle.com [141.146.116.7]) by userz7022.oracle.com (8.14.5+Sun/8.14.4) with ESMTP id t2IF8mgP016946 for ; Wed, 18 Mar 2015 15:08:48 GMT X-Priority: 3 X-Mailer: Oracle Beehive Extensions for Outlook 2.0.1.8.2 (807160) [OL 12.0.6691.5000 (x86)] X-Source-IP: ucsinet21.oracle.com [156.151.31.93] X-detected-operating-system: by eggs.gnu.org: GNU/Linux 2.4.x-2.6.x [generic] X-detected-operating-system: by eggs.gnu.org: Error: Malformed IPv6 address (bad octet value). X-BeenThere: debbugs-submit@debbugs.gnu.org X-Mailman-Version: 2.1.15 Precedence: list X-detected-operating-system: by eggs.gnu.org: GNU/Linux 3.x X-Received-From: 140.186.70.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.org@gnu.org Original-Sender: bug-gnu-emacs-bounces+geb-bug-gnu-emacs=m.gmane.org@gnu.org Xref: news.gmane.org gmane.emacs.bugs:100616 Archived-At: One question is what is the conventional way to write a modifier followed by a (possibly pseudo) function key in the doc (manuals, doc strings). Do we write `' or `S-'? Or do we use both conventions, and if so, are they interchangeable (same meaning)? `kbd' accepts both: (kbd "") and (kbd "S-"), and the effect when binding such keys seems to be the same. Another question is about whether, aside from special cases (which are already called out, AFAIK), function-key names should be written using uppercase. For example, is `" correct, or should it be `" (or `S-')? In the manual, it seems that the more common syntax is `S-<...>', not `'. However, in doc strings the opposite seems to be true (?). As for the possible typos I came across in the Emacs manual: 1. Node `View Mode': >. Presumably should be S-. 2. Node `Org Mode': . Should be S-, I'm guessing - or possibly S-, depending on which key is meant. 3. Node `Setting Mark': S-. Should be S-, I think. 4. Node `Indentation Commands': S-, S-. Should be S-, S-. (Also: and should be and .) 5. Node `Setting Mark': S-. Should be S-. 6. Node `User Input': M- should be M-. 7. Node `Moving Point': C-, M-, C-, M- should be C-, M-, C-, M-. 8. Node `Minibuffer History': should presumably be M-n. (Also, and should be and . 9. Node `Basic Indent': should be just C-j. 10. Node `Custom C Indent': should be just C-M-q. 11. Node `Term Mode: should be just C-c. 12. There is also inconsistency in whether such keys are enclosed in quotes. Node `Rmail Scrolling' has both notations mixed even in the same sentence (e.g., , but `S-'): Since the most common thing to do while reading a message is to scroll through it by screenfuls, Rmail makes and (or `S-') do the same as `C-v' (`scroll-up-command') and `M-v' (`scroll-down-command') respectively. Likewise, node `Help Mode': ( vs `S- instead of . In *Help* buffers (e.g. from `C-h k') they are written using lowercase. If some of these look right to you then please try searching for the corrections I proposed, which I think are much more commonly employed. For example, if you think that is correct, then search also for . You will find, I think, that what I proposed is used more consistently. But there does seem to be a general disconnect between what is shown in *Help* by the help commands and what is shown in the manual by Info. Help uses whereas the manual uses S-. To me, we should use the same notation for both, and I would vote for the manual to fit what help uses. That is, I would suggest that we (consistently) use what `key-description' returns. So we would use `', for example, not `S-'. (key-description (kbd "")) ; =3D> (key-description (kbd "S-")) ; =3D> And `S-', not `'. But presumably is a different function key from , and the former should never be used to represent the latter. (key-description (kbd "")) ; =3D> (key-description (kbd "S-")) ; =3D> In GNU Emacs 25.0.50.1 (i686-pc-mingw32) of 2014-10-20 on LEG570 Bzr revision: 118168 rgm@gnu.org-20141020195941-icp42t8ttcnud09g Windowing system distributor `Microsoft Corp.', version 6.1.7601 Configured using: `configure --enable-checking=3Dyes,glyphs CPPFLAGS=3D-DGLYPH_DEBUG=3D1'