From mboxrd@z Thu Jan 1 00:00:00 1970 Path: news.gmane.org!not-for-mail From: Eli Zaretskii Newsgroups: gmane.emacs.bugs Subject: bug#20135: 25.0.50; Emacs manual typos for key bindings Date: Wed, 18 Mar 2015 19:34:17 +0200 Message-ID: <83619yxl9i.fsf@gnu.org> References: Reply-To: Eli Zaretskii NNTP-Posting-Host: plane.gmane.org X-Trace: ger.gmane.org 1426700124 22444 80.91.229.3 (18 Mar 2015 17:35:24 GMT) X-Complaints-To: usenet@ger.gmane.org NNTP-Posting-Date: Wed, 18 Mar 2015 17:35:24 +0000 (UTC) Cc: 20135@debbugs.gnu.org To: Drew Adams Original-X-From: bug-gnu-emacs-bounces+geb-bug-gnu-emacs=m.gmane.org@gnu.org Wed Mar 18 18:35:13 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 1YYHs6-0001zL-El for geb-bug-gnu-emacs@m.gmane.org; Wed, 18 Mar 2015 18:35:10 +0100 Original-Received: from localhost ([::1]:34994 helo=lists.gnu.org) by lists.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1YYHs5-0002WE-Rh for geb-bug-gnu-emacs@m.gmane.org; Wed, 18 Mar 2015 13:35:09 -0400 Original-Received: from eggs.gnu.org ([2001:4830:134:3::10]:48398) by lists.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1YYHs1-0002Ul-Aq for bug-gnu-emacs@gnu.org; Wed, 18 Mar 2015 13:35:06 -0400 Original-Received: from Debian-exim by eggs.gnu.org with spam-scanned (Exim 4.71) (envelope-from ) id 1YYHry-0000Nc-Ka for bug-gnu-emacs@gnu.org; Wed, 18 Mar 2015 13:35:05 -0400 Original-Received: from debbugs.gnu.org ([140.186.70.43]:53283) by eggs.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1YYHry-0000MU-Eq for bug-gnu-emacs@gnu.org; Wed, 18 Mar 2015 13:35:02 -0400 Original-Received: from Debian-debbugs by debbugs.gnu.org with local (Exim 4.80) (envelope-from ) id 1YYHrx-0007tM-Pq for bug-gnu-emacs@gnu.org; Wed, 18 Mar 2015 13:35:01 -0400 X-Loop: help-debbugs@gnu.org Resent-From: Eli Zaretskii Original-Sender: "Debbugs-submit" Resent-CC: bug-gnu-emacs@gnu.org Resent-Date: Wed, 18 Mar 2015 17:35:01 +0000 Resent-Message-ID: Resent-Sender: help-debbugs@gnu.org X-GNU-PR-Message: followup 20135 X-GNU-PR-Package: emacs X-GNU-PR-Keywords: Original-Received: via spool by 20135-submit@debbugs.gnu.org id=B20135.142670007130284 (code B ref 20135); Wed, 18 Mar 2015 17:35:01 +0000 Original-Received: (at 20135) by debbugs.gnu.org; 18 Mar 2015 17:34:31 +0000 Original-Received: from localhost ([127.0.0.1]:51851 helo=debbugs.gnu.org) by debbugs.gnu.org with esmtp (Exim 4.80) (envelope-from ) id 1YYHrT-0007sO-43 for submit@debbugs.gnu.org; Wed, 18 Mar 2015 13:34:31 -0400 Original-Received: from mtaout26.012.net.il ([80.179.55.182]:40616) by debbugs.gnu.org with esmtp (Exim 4.80) (envelope-from ) id 1YYHrQ-0007sE-6c for 20135@debbugs.gnu.org; Wed, 18 Mar 2015 13:34:29 -0400 Original-Received: from conversion-daemon.mtaout26.012.net.il by mtaout26.012.net.il (HyperSendmail v2007.08) id <0NLF00A004MB3R00@mtaout26.012.net.il> for 20135@debbugs.gnu.org; Wed, 18 Mar 2015 19:35:13 +0200 (IST) Original-Received: from HOME-C4E4A596F7 ([87.69.4.28]) by mtaout26.012.net.il (HyperSendmail v2007.08) with ESMTPA id <0NLF0025S4UP2F80@mtaout26.012.net.il>; Wed, 18 Mar 2015 19:35:13 +0200 (IST) In-reply-to: X-012-Sender: halo1@inter.net.il 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:100624 Archived-At: > Date: Wed, 18 Mar 2015 08:08:47 -0700 (PDT) > From: Drew Adams > > Do we write `' or `S-'? Or do we use both conventions, and if > so, are they interchangeable (same meaning)? S- is the right way for the manuals. > 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-')? We've been though this before, and AFAIK the manual was fixed to be consistent at that time. > In the manual, it seems that the more common syntax is `S-<...>', not > `'. However, in doc strings the opposite seems to be true (?). In the doc strings, that's substitution, right? It's not that these are written verbatim in the doc string, right? If so, they are formatted how the relevant APIs (key-description, I believe) do it. > 1. Node `View Mode': >. Presumably should be S-. Fixed. > 2. Node `Org Mode': . Should be S-, I'm guessing - or > possibly S-, depending on which key is meant. Fixed. > 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-. No, uppercase is OK here, for consistency with TAB, SPC, etc. Again, we've been through this before. > 8. Node `Minibuffer History': should presumably be M-n. No, it should be `M-n' (with the quotes). Fixed. > (Also, and should be and . No, that's OK. > 9. Node `Basic Indent': should be just C-j. Should be `C-j'; fixed. > 10. Node `Custom C Indent': should be just C-M-q. Again, `C-M-q'; fixed. > 11. Node `Term Mode: should be just C-c. `C-c'; fixed. > 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-'): That's OK: a single key can omit the quotes; a sequence should not. > 13. I wonder too about the function keys being written with uppercase: > instead of . In *Help* buffers (e.g. from `C-h k') they are > written using lowercase. Again, the manuals are consistent: all named keys are uppercased. If we want the doc strings to follow suit, the relevant primitives should be changed to follow suit. > 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. I did that in the past, and I don't think we have any inconsistencies left. Feel free to point out any you find. > 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. I won't object.