From unknown Wed Aug 20 03:22:53 2025 X-Loop: help-debbugs@gnu.org Subject: bug#14199: 24.3.50; `read-kbd-macro' doc Resent-From: "Drew Adams" Original-Sender: debbugs-submit-bounces@debbugs.gnu.org Resent-CC: bug-gnu-emacs@gnu.org Resent-Date: Sat, 13 Apr 2013 17:54:02 +0000 Resent-Message-ID: Resent-Sender: help-debbugs@gnu.org X-GNU-PR-Message: report 14199 X-GNU-PR-Package: emacs X-GNU-PR-Keywords: To: 14199@debbugs.gnu.org X-Debbugs-Original-To: Received: via spool by submit@debbugs.gnu.org id=B.136587560820525 (code B ref -1); Sat, 13 Apr 2013 17:54:02 +0000 Received: (at submit) by debbugs.gnu.org; 13 Apr 2013 17:53:28 +0000 Received: from localhost ([127.0.0.1]:48958 helo=debbugs.gnu.org) by debbugs.gnu.org with esmtp (Exim 4.72) (envelope-from ) id 1UR4dj-0005L0-Fu for submit@debbugs.gnu.org; Sat, 13 Apr 2013 13:53:27 -0400 Received: from eggs.gnu.org ([208.118.235.92]:40396) by debbugs.gnu.org with esmtp (Exim 4.72) (envelope-from ) id 1UR4dg-0005Ko-Dk for submit@debbugs.gnu.org; Sat, 13 Apr 2013 13:53:25 -0400 Received: from Debian-exim by eggs.gnu.org with spam-scanned (Exim 4.71) (envelope-from ) id 1UR4Zk-00029P-WB for submit@debbugs.gnu.org; Sat, 13 Apr 2013 13:49:22 -0400 X-Spam-Checker-Version: SpamAssassin 3.3.2 (2011-06-06) on eggs.gnu.org X-Spam-Level: X-Spam-Status: No, score=-106.6 required=5.0 tests=BAYES_00, RCVD_IN_DNSWL_MED, RP_MATCHES_RCVD, UNPARSEABLE_RELAY, USER_IN_WHITELIST autolearn=disabled version=3.3.2 Received: from lists.gnu.org ([208.118.235.17]:54448) by eggs.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1UR4Zk-00029K-Sl for submit@debbugs.gnu.org; Sat, 13 Apr 2013 13:49:20 -0400 Received: from eggs.gnu.org ([208.118.235.92]:51747) by lists.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1UR4Zj-0007OO-7t for bug-gnu-emacs@gnu.org; Sat, 13 Apr 2013 13:49:20 -0400 Received: from Debian-exim by eggs.gnu.org with spam-scanned (Exim 4.71) (envelope-from ) id 1UR4Zi-00028k-DW for bug-gnu-emacs@gnu.org; Sat, 13 Apr 2013 13:49:19 -0400 Received: from aserp1040.oracle.com ([141.146.126.69]:33798) by eggs.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1UR4Zi-00028e-6l for bug-gnu-emacs@gnu.org; Sat, 13 Apr 2013 13:49:18 -0400 Received: from acsinet22.oracle.com (acsinet22.oracle.com [141.146.126.238]) by aserp1040.oracle.com (Sentrion-MTA-4.3.1/Sentrion-MTA-4.3.1) with ESMTP id r3DHnGbp020174 (version=TLSv1/SSLv3 cipher=DHE-RSA-AES256-SHA bits=256 verify=OK) for ; Sat, 13 Apr 2013 17:49:17 GMT Received: from aserz7022.oracle.com (aserz7022.oracle.com [141.146.126.231]) by acsinet22.oracle.com (8.14.4+Sun/8.14.4) with ESMTP id r3DHnF2Z013032 (version=TLSv1/SSLv3 cipher=DHE-RSA-AES256-SHA bits=256 verify=FAIL) for ; Sat, 13 Apr 2013 17:49:16 GMT Received: from abhmt112.oracle.com (abhmt112.oracle.com [141.146.116.64]) by aserz7022.oracle.com (8.14.4+Sun/8.14.4) with ESMTP id r3DHnFWZ013028 for ; Sat, 13 Apr 2013 17:49:15 GMT Received: from dradamslap1 (/71.202.147.44) by default (Oracle Beehive Gateway v4.0) with ESMTP ; Sat, 13 Apr 2013 10:49:14 -0700 From: "Drew Adams" Date: Sat, 13 Apr 2013 10:49:04 -0700 Message-ID: <7A6B3EA5F62D48D291D7E316EF83AB17@us.oracle.com> MIME-Version: 1.0 Content-Type: text/plain; charset="us-ascii" Content-Transfer-Encoding: 7bit X-Mailer: Microsoft Office Outlook 11 Thread-Index: Ac44bzCYktdTYO8tThesl5TdBTgKfQ== X-MimeOLE: Produced By Microsoft MimeOLE V6.00.2900.6157 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: GNU/Linux 2.6.x X-Received-From: 208.118.235.17 X-Spam-Score: -4.3 (----) X-BeenThere: debbugs-submit@debbugs.gnu.org X-Mailman-Version: 2.1.13 Precedence: list List-Id: List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Sender: debbugs-submit-bounces@debbugs.gnu.org Errors-To: debbugs-submit-bounces@debbugs.gnu.org X-Spam-Score: -6.2 (------) In (elisp) `Describing Characters', description of `read-kbd-macro': 1. The signature and description are incorrect/incomplete. According to the source code and the doc string, the signature is (read-kbd-macro START &optional END). The doc string shows the correct signature, and it is clearer than the manual wrt the signature and the possibility of passing STRING and NEED-VECTOR instead. The manual needs to clearly point out that there are, in effect, two different signatures, even if one is considered primary. Each needs to be documented. So do not remove the existing description about STRING and NEED-VECTOR. Instead, supplement it with a description of the other signature and its behavior. 2. Mention that STRING has the form provided by `format-kbd-macro'. `format-kbd-macro' is mentioned nowhere in the manual, and this is a good place for it. In GNU Emacs 24.3.50.1 (i386-mingw-nt5.1.2600) of 2013-04-09 on ODIEONE Bzr revision: 112253 rgm@gnu.org-20130409101736-f1vzgrwt88suqqis Windowing system distributor `Microsoft Corp.', version 5.1.2600 Configured using: `configure --with-gcc (4.7) --no-opt --enable-checking --cflags -IC:/Devel/emacs/build/include --ldflags -LC:/Devel/emacs/build/lib' From unknown Wed Aug 20 03:22:53 2025 X-Loop: help-debbugs@gnu.org Subject: bug#14199: 24.3.50; `read-kbd-macro' doc Resent-From: Lars Ingebrigtsen Original-Sender: "Debbugs-submit" Resent-CC: bug-gnu-emacs@gnu.org Resent-Date: Sat, 08 Feb 2014 12:35:02 +0000 Resent-Message-ID: Resent-Sender: help-debbugs@gnu.org X-GNU-PR-Message: followup 14199 X-GNU-PR-Package: emacs X-GNU-PR-Keywords: To: "Drew Adams" Cc: 14199@debbugs.gnu.org Received: via spool by 14199-submit@debbugs.gnu.org id=B14199.139186287029230 (code B ref 14199); Sat, 08 Feb 2014 12:35:02 +0000 Received: (at 14199) by debbugs.gnu.org; 8 Feb 2014 12:34:30 +0000 Received: from localhost ([127.0.0.1]:56596 helo=debbugs.gnu.org) by debbugs.gnu.org with esmtp (Exim 4.80) (envelope-from ) id 1WC777-0007bL-Gk for submit@debbugs.gnu.org; Sat, 08 Feb 2014 07:34:30 -0500 Received: from hermes.netfonds.no ([80.91.224.195]:39073) by debbugs.gnu.org with esmtp (Exim 4.80) (envelope-from ) id 1WC774-0007b8-4G for 14199@debbugs.gnu.org; Sat, 08 Feb 2014 07:34:26 -0500 Received: from [204.14.154.233] (helo=building.gnus.org) by hermes.netfonds.no with esmtpsa (TLS1.0:RSA_AES_128_CBC_SHA1:16) (Exim 4.72) (envelope-from ) id 1WC76p-0002R1-CF; Sat, 08 Feb 2014 13:34:11 +0100 From: Lars Ingebrigtsen References: <7A6B3EA5F62D48D291D7E316EF83AB17@us.oracle.com> Date: Sat, 08 Feb 2014 04:33:02 -0800 In-Reply-To: <7A6B3EA5F62D48D291D7E316EF83AB17@us.oracle.com> (Drew Adams's message of "Sat, 13 Apr 2013 10:49:04 -0700") Message-ID: <87lhxlss1t.fsf@building.gnus.org> User-Agent: Gnus/5.13001 (Ma Gnus v0.10) Emacs/24.3.50 (gnu/linux) MIME-Version: 1.0 Content-Type: text/plain X-MailScanner-ID: 1WC76p-0002R1-CF X-Netfonds-MailScanner: Found to be clean X-Netfonds-MailScanner-From: larsi@gnus.org MailScanner-NULL-Check: 1392467652.00464@QLZyu6bR/qJiF2ynpTrtSg X-Spam-Status: No X-Spam-Score: 0.0 (/) X-BeenThere: debbugs-submit@debbugs.gnu.org X-Mailman-Version: 2.1.15 Precedence: list List-Id: List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: debbugs-submit-bounces@debbugs.gnu.org Sender: "Debbugs-submit" X-Spam-Score: 0.0 (/) "Drew Adams" writes: > In (elisp) `Describing Characters', description of `read-kbd-macro': > > 1. The signature and description are incorrect/incomplete. According to > the source code and the doc string, the signature is (read-kbd-macro > START &optional END). > > The doc string shows the correct signature, and it is clearer than > the manual wrt the signature and the possibility of passing STRING > and NEED-VECTOR instead. > > The manual needs to clearly point out that there are, in effect, two > different signatures, even if one is considered primary. Each needs > to be documented. The region-based interactive definition is documented in the Emacs manual, while the Lisp-based is in the lispref manual. I think that's probably ok, while it does seem pretty strange to reuse the meanings of the parameters. > 2. Mention that STRING has the form provided by `format-kbd-macro'. > `format-kbd-macro' is mentioned nowhere in the manual, and this is a > good place for it. Well, it mentions that it's an inverse of `key-description', which should cover it... -- (domestic pets only, the antidote for overdose, milk.) bloggy blog http://lars.ingebrigtsen.no/ From debbugs-submit-bounces@debbugs.gnu.org Sat Feb 08 07:34:33 2014 Received: (at control) by debbugs.gnu.org; 8 Feb 2014 12:34:34 +0000 Received: from localhost ([127.0.0.1]:56599 helo=debbugs.gnu.org) by debbugs.gnu.org with esmtp (Exim 4.80) (envelope-from ) id 1WC77A-0007bc-PO for submit@debbugs.gnu.org; Sat, 08 Feb 2014 07:34:33 -0500 Received: from hermes.netfonds.no ([80.91.224.195]:39079) by debbugs.gnu.org with esmtp (Exim 4.80) (envelope-from ) id 1WC778-0007bO-KR for control@debbugs.gnu.org; Sat, 08 Feb 2014 07:34:30 -0500 Received: from [204.14.154.233] (helo=building.gnus.org) by hermes.netfonds.no with esmtpsa (TLS1.0:RSA_AES_128_CBC_SHA1:16) (Exim 4.72) (envelope-from ) id 1WC76u-0002RD-Ga for control@debbugs.gnu.org; Sat, 08 Feb 2014 13:34:16 +0100 Date: Sat, 08 Feb 2014 04:33:07 -0800 Message-Id: <87k3d5ss1o.fsf@building.gnus.org> To: control@debbugs.gnu.org From: Lars Ingebrigtsen Subject: control message for bug #14199 X-MailScanner-ID: 1WC76u-0002RD-Ga X-Netfonds-MailScanner: Found to be clean X-Netfonds-MailScanner-From: larsi@gnus.org MailScanner-NULL-Check: 1392467657.31328@R1dS8Ya/5hLgbWkEV5Nyhw X-Spam-Status: No X-Spam-Score: 0.0 (/) X-Debbugs-Envelope-To: control X-BeenThere: debbugs-submit@debbugs.gnu.org X-Mailman-Version: 2.1.15 Precedence: list List-Id: List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: debbugs-submit-bounces@debbugs.gnu.org Sender: "Debbugs-submit" X-Spam-Score: 0.0 (/) close 14199 From unknown Wed Aug 20 03:22:53 2025 X-Loop: help-debbugs@gnu.org Subject: bug#14199: 24.3.50; `read-kbd-macro' doc Resent-From: Drew Adams Original-Sender: "Debbugs-submit" Resent-CC: bug-gnu-emacs@gnu.org Resent-Date: Mon, 10 Feb 2014 22:01:01 +0000 Resent-Message-ID: Resent-Sender: help-debbugs@gnu.org X-GNU-PR-Message: followup 14199 X-GNU-PR-Package: emacs X-GNU-PR-Keywords: To: Lars Ingebrigtsen Cc: 14199@debbugs.gnu.org Received: via spool by 14199-submit@debbugs.gnu.org id=B14199.13920696566153 (code B ref 14199); Mon, 10 Feb 2014 22:01:01 +0000 Received: (at 14199) by debbugs.gnu.org; 10 Feb 2014 22:00:56 +0000 Received: from localhost ([127.0.0.1]:41968 helo=debbugs.gnu.org) by debbugs.gnu.org with esmtp (Exim 4.80) (envelope-from ) id 1WCyuN-0001bB-LN for submit@debbugs.gnu.org; Mon, 10 Feb 2014 17:00:55 -0500 Received: from userp1040.oracle.com ([156.151.31.81]:30494) by debbugs.gnu.org with esmtp (Exim 4.80) (envelope-from ) id 1WCyuL-0001ax-7x for 14199@debbugs.gnu.org; Mon, 10 Feb 2014 17:00:54 -0500 Received: from acsinet21.oracle.com (acsinet21.oracle.com [141.146.126.237]) by userp1040.oracle.com (Sentrion-MTA-4.3.2/Sentrion-MTA-4.3.2) with ESMTP id s1AM0ku4008283 (version=TLSv1/SSLv3 cipher=DHE-RSA-AES256-SHA bits=256 verify=OK); Mon, 10 Feb 2014 22:00:47 GMT Received: from userz7021.oracle.com (userz7021.oracle.com [156.151.31.85]) by acsinet21.oracle.com (8.14.4+Sun/8.14.4) with ESMTP id s1AM0jJj015236 (version=TLSv1/SSLv3 cipher=DHE-RSA-AES256-SHA bits=256 verify=FAIL); Mon, 10 Feb 2014 22:00:46 GMT Received: from abhmp0015.oracle.com (abhmp0015.oracle.com [141.146.116.21]) by userz7021.oracle.com (8.14.4+Sun/8.14.4) with ESMTP id s1AM0jmN001109; Mon, 10 Feb 2014 22:00:45 GMT MIME-Version: 1.0 Message-ID: <15fe0e59-f4fc-468d-810a-933727eadc7d@default> Date: Mon, 10 Feb 2014 14:00:44 -0800 (PST) From: Drew Adams References: <7A6B3EA5F62D48D291D7E316EF83AB17@us.oracle.com> <87lhxlss1t.fsf@building.gnus.org> In-Reply-To: <87lhxlss1t.fsf@building.gnus.org> X-Priority: 3 X-Mailer: Oracle Beehive Extensions for Outlook 2.0.1.8 (707110) [OL 12.0.6680.5000 (x86)] Content-Type: text/plain; charset=us-ascii Content-Transfer-Encoding: quoted-printable X-Source-IP: acsinet21.oracle.com [141.146.126.237] X-Spam-Score: -2.9 (--) X-BeenThere: debbugs-submit@debbugs.gnu.org X-Mailman-Version: 2.1.15 Precedence: list List-Id: List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: debbugs-submit-bounces@debbugs.gnu.org Sender: "Debbugs-submit" X-Spam-Score: -2.9 (--) > The region-based interactive definition is documented in the Emacs > manual, while the Lisp-based is in the lispref manual. I think > that's probably ok, while it does seem pretty strange to reuse the > meanings of the parameters. That does not respond to the reported bug. > > 2. Mention that STRING has the form provided by `format-kbd- > > macro'. `format-kbd-macro' is mentioned nowhere in the manual, > > and this is a good place for it. >=20 > Well, it mentions that it's an inverse of `key-description', which > should cover it... Why close this bug without fixing it? I gave you the info needed: `format-kbd-macro' is precisely the thing missing - not some vague hand-waving about an inverse of `key-description'.