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#17039: 24.3.50; doc of `kbd`: arg format Date: Tue, 18 Mar 2014 19:20:44 -0700 (PDT) Message-ID: <5a23b8ad-807e-4627-9764-8c804a03850a@default> 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 1395195739 2464 80.91.229.3 (19 Mar 2014 02:22:19 GMT) X-Complaints-To: usenet@ger.gmane.org NNTP-Posting-Date: Wed, 19 Mar 2014 02:22:19 +0000 (UTC) To: 17039@debbugs.gnu.org Original-X-From: bug-gnu-emacs-bounces+geb-bug-gnu-emacs=m.gmane.org@gnu.org Wed Mar 19 03:22:27 2014 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 1WQ69C-00074E-Hw for geb-bug-gnu-emacs@m.gmane.org; Wed, 19 Mar 2014 03:22:26 +0100 Original-Received: from localhost ([::1]:38321 helo=lists.gnu.org) by lists.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1WQ69C-0006KN-2C for geb-bug-gnu-emacs@m.gmane.org; Tue, 18 Mar 2014 22:22:26 -0400 Original-Received: from eggs.gnu.org ([2001:4830:134:3::10]:49336) by lists.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1WQ68y-0006J9-Fu for bug-gnu-emacs@gnu.org; Tue, 18 Mar 2014 22:22:22 -0400 Original-Received: from Debian-exim by eggs.gnu.org with spam-scanned (Exim 4.71) (envelope-from ) id 1WQ68o-0001mq-CX for bug-gnu-emacs@gnu.org; Tue, 18 Mar 2014 22:22:12 -0400 Original-Received: from debbugs.gnu.org ([140.186.70.43]:39391) by eggs.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1WQ68o-0001mm-9U for bug-gnu-emacs@gnu.org; Tue, 18 Mar 2014 22:22:02 -0400 Original-Received: from Debian-debbugs by debbugs.gnu.org with local (Exim 4.80) (envelope-from ) id 1WQ68o-0006wH-1G for bug-gnu-emacs@gnu.org; Tue, 18 Mar 2014 22:22: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, 19 Mar 2014 02:22:01 +0000 Resent-Message-ID: Resent-Sender: help-debbugs@gnu.org X-GNU-PR-Message: report 17039 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.139519568126612 (code B ref -1); Wed, 19 Mar 2014 02:22:01 +0000 Original-Received: (at submit) by debbugs.gnu.org; 19 Mar 2014 02:21:21 +0000 Original-Received: from localhost ([127.0.0.1]:40573 helo=debbugs.gnu.org) by debbugs.gnu.org with esmtp (Exim 4.80) (envelope-from ) id 1WQ688-0006v9-FY for submit@debbugs.gnu.org; Tue, 18 Mar 2014 22:21:20 -0400 Original-Received: from eggs.gnu.org ([208.118.235.92]:47484) by debbugs.gnu.org with esmtp (Exim 4.80) (envelope-from ) id 1WQ685-0006uy-A2 for submit@debbugs.gnu.org; Tue, 18 Mar 2014 22:21:18 -0400 Original-Received: from Debian-exim by eggs.gnu.org with spam-scanned (Exim 4.71) (envelope-from ) id 1WQ67v-0001fg-17 for submit@debbugs.gnu.org; Tue, 18 Mar 2014 22:21:17 -0400 Original-Received: from lists.gnu.org ([2001:4830:134:3::11]:37971) by eggs.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1WQ67u-0001fa-Us for submit@debbugs.gnu.org; Tue, 18 Mar 2014 22:21:06 -0400 Original-Received: from eggs.gnu.org ([2001:4830:134:3::10]:49145) by lists.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1WQ67l-0005DD-W6 for bug-gnu-emacs@gnu.org; Tue, 18 Mar 2014 22:21:06 -0400 Original-Received: from Debian-exim by eggs.gnu.org with spam-scanned (Exim 4.71) (envelope-from ) id 1WQ67d-0001cd-4g for bug-gnu-emacs@gnu.org; Tue, 18 Mar 2014 22:20:57 -0400 Original-Received: from userp1040.oracle.com ([156.151.31.81]:32928) by eggs.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1WQ67c-0001cV-Tc for bug-gnu-emacs@gnu.org; Tue, 18 Mar 2014 22:20:49 -0400 Original-Received: from acsinet22.oracle.com (acsinet22.oracle.com [141.146.126.238]) by userp1040.oracle.com (Sentrion-MTA-4.3.2/Sentrion-MTA-4.3.2) with ESMTP id s2J2KkKw013590 (version=TLSv1/SSLv3 cipher=DHE-RSA-AES256-SHA bits=256 verify=OK) for ; Wed, 19 Mar 2014 02:20:47 GMT Original-Received: from userz7021.oracle.com (userz7021.oracle.com [156.151.31.85]) by acsinet22.oracle.com (8.14.4+Sun/8.14.4) with ESMTP id s2J2KjEr015183 (version=TLSv1/SSLv3 cipher=DHE-RSA-AES256-SHA bits=256 verify=FAIL) for ; Wed, 19 Mar 2014 02:20:46 GMT Original-Received: from abhmp0006.oracle.com (abhmp0006.oracle.com [141.146.116.12]) by userz7021.oracle.com (8.14.4+Sun/8.14.4) with ESMTP id s2J2KjcD015197 for ; Wed, 19 Mar 2014 02:20:45 GMT X-Priority: 3 X-Mailer: Oracle Beehive Extensions for Outlook 2.0.1.8 (707110) [OL 12.0.6680.5000 (x86)] X-Source-IP: acsinet22.oracle.com [141.146.126.238] 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:86958 Archived-At: 1. The doc string says this: KEYS should be a string constant in the format used for saving keyboard macros (see `edmacro-mode'). That's all well and good, and it should be kept: the link provides valuable and complete info. However, most people consulting this doc will not be interested so much in `edmacro-mode' or even the complete description its doc string provides. They will be helped most (or at least additionally) by telling them that the format of argument KEYS is the format that `C-h k' uses to describe a key sequence. Please add that information, and please put it first, before adding the `edmacro-mode' link for more complete information about the format. 2. (emacs) `Init Rebinding' at least says, in passing, that the representation is "similar to how we have written key sequences in this manual". I'm not sure why it says "similar to" instead of the same as, unless that is a reference to the fact that keys are written a bit differently in a printed manual. Also confusing is the fact that the manual writes key sequences in different ways in the manual, only some of which correspond to the syntax expected by `kbd'. An example is given in the same node: (global-set-key "\C-x\M-l" ...). I don't really have a problem with what is said in that regard, though it is not too clear. But things would be much clearer if you would please add that the format is what `C-h k' shows in its help. `C-h k' is something that even newbies learn quickly. It gives them a point of reference, even if it does not detail the syntax rules (as does `C-h f edmacro-mode'). In GNU Emacs 24.3.50.1 (i686-pc-mingw32) of 2014-03-10 on ODIEONE Bzr revision: 116730 lekktu@gmail.com-20140311014451-rxr9uapugo5bedft Windowing system distributor `Microsoft Corp.', version 6.1.7601 Configured using: `configure --prefix=3D/c/Devel/emacs/binary --enable-checking=3Dyes,glyphs 'CFLAGS=3D-O0 -g3' LDFLAGS=3D-Lc:/Devel/emacs/lib 'CPPFLAGS=3D-DGC_MCHECK= =3D1 -Ic:/Devel/emacs/include''