From mboxrd@z Thu Jan 1 00:00:00 1970 Path: news.gmane.org!.POSTED.blaine.gmane.org!not-for-mail From: Stefan Kangas Newsgroups: gmane.emacs.bugs Subject: bug#30660: mention describe-bindings on (info "(emacs) Keymaps") Date: Sun, 17 Nov 2019 21:36:53 +0100 Message-ID: <87wobyme8q.fsf@marxist.se> References: <831b5f34-28c7-4753-bed9-0a28de484aa8@default> <87tv8bul5g.fsf@gnus.org> <8336fvhxt0.fsf@gnu.org> <83o8yfbk79.fsf@gnu.org> <87ftj0wlel.fsf@marxist.se> <87k186pi8l.fsf@marxist.se> <83h8367luj.fsf@gnu.org> Mime-Version: 1.0 Content-Type: multipart/mixed; boundary="=-=-=" Injection-Info: blaine.gmane.org; posting-host="blaine.gmane.org:195.159.176.226"; logging-data="1185"; mail-complaints-to="usenet@blaine.gmane.org" User-Agent: Gnus/5.13 (Gnus v5.13) Emacs/27.0.50 (gnu/linux) Cc: larsi@gnus.org, 30660@debbugs.gnu.org, jidanni@jidanni.org To: Eli Zaretskii Original-X-From: bug-gnu-emacs-bounces+geb-bug-gnu-emacs=m.gmane.org@gnu.org Sun Nov 17 21:38:12 2019 Return-path: Envelope-to: geb-bug-gnu-emacs@m.gmane.org Original-Received: from lists.gnu.org ([209.51.188.17]) by blaine.gmane.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.89) (envelope-from ) id 1iWRJD-0000A2-NU for geb-bug-gnu-emacs@m.gmane.org; Sun, 17 Nov 2019 21:38:12 +0100 Original-Received: from localhost ([::1]:56240 helo=lists1p.gnu.org) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1iWRJC-0008JV-Fr for geb-bug-gnu-emacs@m.gmane.org; Sun, 17 Nov 2019 15:38:10 -0500 Original-Received: from eggs.gnu.org ([2001:470:142:3::10]:33607) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1iWRJ5-0008Hz-BK for bug-gnu-emacs@gnu.org; Sun, 17 Nov 2019 15:38:04 -0500 Original-Received: from Debian-exim by eggs.gnu.org with spam-scanned (Exim 4.71) (envelope-from ) id 1iWRJ3-00013u-SF for bug-gnu-emacs@gnu.org; Sun, 17 Nov 2019 15:38:03 -0500 Original-Received: from debbugs.gnu.org ([209.51.188.43]:33904) by eggs.gnu.org with esmtps (TLS1.0:RSA_AES_128_CBC_SHA1:16) (Exim 4.71) (envelope-from ) id 1iWRJ3-000137-OC for bug-gnu-emacs@gnu.org; Sun, 17 Nov 2019 15:38:01 -0500 Original-Received: from Debian-debbugs by debbugs.gnu.org with local (Exim 4.84_2) (envelope-from ) id 1iWRJ3-0007YU-JZ for bug-gnu-emacs@gnu.org; Sun, 17 Nov 2019 15:38:01 -0500 X-Loop: help-debbugs@gnu.org Resent-From: Stefan Kangas Original-Sender: "Debbugs-submit" Resent-CC: bug-gnu-emacs@gnu.org Resent-Date: Sun, 17 Nov 2019 20:38:01 +0000 Resent-Message-ID: Resent-Sender: help-debbugs@gnu.org X-GNU-PR-Message: followup 30660 X-GNU-PR-Package: emacs Original-Received: via spool by 30660-submit@debbugs.gnu.org id=B30660.157402302728977 (code B ref 30660); Sun, 17 Nov 2019 20:38:01 +0000 Original-Received: (at 30660) by debbugs.gnu.org; 17 Nov 2019 20:37:07 +0000 Original-Received: from localhost ([127.0.0.1]:42725 helo=debbugs.gnu.org) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1iWRIB-0007XJ-E5 for submit@debbugs.gnu.org; Sun, 17 Nov 2019 15:37:07 -0500 Original-Received: from ted.gofardesign.uk ([67.225.143.91]:56668) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1iWRI9-0007Wp-Lj for 30660@debbugs.gnu.org; Sun, 17 Nov 2019 15:37:06 -0500 DKIM-Signature: v=1; a=rsa-sha256; q=dns/txt; c=relaxed/relaxed; d=marxist.se; s=default; h=Content-Type:MIME-Version:Message-ID:Date:References: In-Reply-To:Subject:Cc:To:From:Sender:Reply-To:Content-Transfer-Encoding: Content-ID:Content-Description:Resent-Date:Resent-From:Resent-Sender: Resent-To:Resent-Cc:Resent-Message-ID:List-Id:List-Help:List-Unsubscribe: List-Subscribe:List-Post:List-Owner:List-Archive; bh=rIvLQFnAP9vna+HX1LeopHhXZTKTaCiBUWn9ec+Odo8=; b=heMetOxrYAH21Z9MF4n5sH9cQX lThZFHo+CikyMSQJ+x3RUZ7XT4/zbJOT3fBs0fXlp5iKqBVGb65vBGWXjsjsv8i7gpEDY0Yf2kY3K TbVn2upWlaHxX+lNtdzg7wvk4v4aTLw7TPzwaLrf8wQLVbHgD230rIb8lZXgVQYp+JCDA4hqwWSus PhQtCW24elB2nlT6tPVAcTzOPiqhj+PeK7fB3JQYL5MVWQFVGjacrrHMo2Jf/XcqQOKanPqnlewAW bc/EhERNGXnNwcRzhuk+8uSTgGelu1Z//PGWkwhRg3o+oF9k2EORiVrVIK3upEW/EPhajV+80GA7U bork5fmA==; Original-Received: from h-70-69.a785.priv.bahnhof.se ([155.4.70.69]:60580 helo=localhost) by ted.gofardesign.uk with esmtpsa (TLSv1.2:ECDHE-RSA-AES256-GCM-SHA384:256) (Exim 4.92) (envelope-from ) id 1iWRI2-000iLC-3Q; Sun, 17 Nov 2019 15:36:58 -0500 In-Reply-To: <83h8367luj.fsf@gnu.org> (Eli Zaretskii's message of "Thu, 14 Nov 2019 13:12:36 +0200") X-AntiAbuse: This header was added to track abuse, please include it with any abuse report X-AntiAbuse: Primary Hostname - ted.gofardesign.uk X-AntiAbuse: Original Domain - debbugs.gnu.org X-AntiAbuse: Originator/Caller UID/GID - [47 12] / [47 12] X-AntiAbuse: Sender Address Domain - marxist.se X-Get-Message-Sender-Via: ted.gofardesign.uk: authenticated_id: stefan@marxist.se X-Authenticated-Sender: ted.gofardesign.uk: stefan@marxist.se 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.org@gnu.org Original-Sender: "bug-gnu-emacs" Xref: news.gmane.org gmane.emacs.bugs:171855 Archived-At: --=-=-= Content-Type: text/plain Eli Zaretskii writes: > I don't know why describe-bindings was documented in both manuals, > and see no reason to continue doing so (the ELisp manual prints in 2 > large volumes, so avoiding any unnecessary bloat there is generally > a good idea). Here's a separate patch to remove it, while preserving the information by moving it to the doc string of 'describe-bindings'. WDYT? Best regards, Stefan Kangas --=-=-= Content-Type: text/x-diff Content-Disposition: inline; filename=0001-Remove-describe-bindings-from-elisp-manual.patch >From 872d71f8667d68ac449d89993f9f85138eb3c1bb Mon Sep 17 00:00:00 2001 From: Stefan Kangas Date: Fri, 15 Nov 2019 05:05:00 +0100 Subject: [PATCH] Remove describe-bindings from elisp manual Ref: https://debbugs.gnu.org/cgi/bugreport.cgi?bug=30660#74 * doc/lispref/keymaps.texi (Scanning Keymaps): Remove 'describe-bindings'. * lisp/help.el (describe-bindings): Add some information removed from the elisp manual to the doc string instead. --- doc/lispref/keymaps.texi | 23 ----------------------- lisp/help.el | 28 +++++++++++++++++++++------- 2 files changed, 21 insertions(+), 30 deletions(-) diff --git a/doc/lispref/keymaps.texi b/doc/lispref/keymaps.texi index 8ff329bdac..1162abfc2b 100644 --- a/doc/lispref/keymaps.texi +++ b/doc/lispref/keymaps.texi @@ -1987,29 +1987,6 @@ Scanning Keymaps @end table @end defun -@deffn Command describe-bindings &optional prefix buffer-or-name -This function creates a listing of all current key bindings, and -displays it in a buffer named @file{*Help*}. The text is grouped by -modes---minor modes first, then the major mode, then global bindings. - -If @var{prefix} is non-@code{nil}, it should be a prefix key; then the -listing includes only keys that start with @var{prefix}. - -When several characters with consecutive @acronym{ASCII} codes have the -same definition, they are shown together, as -@samp{@var{firstchar}..@var{lastchar}}. In this instance, you need to -know the @acronym{ASCII} codes to understand which characters this means. -For example, in the default global map, the characters @samp{@key{SPC} -..@: ~} are described by a single line. @key{SPC} is @acronym{ASCII} 32, -@kbd{~} is @acronym{ASCII} 126, and the characters between them include all -the normal printing characters, (e.g., letters, digits, punctuation, -etc.@:); all these characters are bound to @code{self-insert-command}. - -If @var{buffer-or-name} is non-@code{nil}, it should be a buffer or a -buffer name. Then @code{describe-bindings} lists that buffer's bindings, -instead of the current buffer's. -@end deffn - @node Menu Keymaps @section Menu Keymaps @cindex menu keymaps diff --git a/lisp/help.el b/lisp/help.el index 3b3d1f977e..7b5f4b4b31 100644 --- a/lisp/help.el +++ b/lisp/help.el @@ -492,13 +492,27 @@ view-lossage (defun describe-bindings (&optional prefix buffer) "Display a buffer showing a list of all defined keys, and their definitions. -The keys are displayed in order of precedence. - -The optional argument PREFIX, if non-nil, should be a key sequence; -then we display only bindings that start with that prefix. -The optional argument BUFFER specifies which buffer's bindings -to display (default, the current buffer). BUFFER can be a buffer -or a buffer name." +The keys are displayed in order of precedence: first local +bindings of minor modes, then local bindings defined by the +current major mode, and finally global bindings. + +If optional argument PREFIX is non-nil, it should be a key +sequence and means to display only bindings starting with that +prefix. + +If optional argument BUFFER is non-nil, it specifies which +buffer's bindings to display (by default, the current buffer). +BUFFER can be a buffer or a buffer name. + +When several characters with consecutive ASCII codes have the same +definition, they are shown together, as `FIRSTCHAR..LASTCHAR'. In +this instance, you need to know the ASCII codes to understand which +characters this means. For example, in the default global map, the +characters ` .. ~' are described by a single line. is +ASCII 32, `~' is ASCII 126, and the characters between them include +all the normal printing characters, (e.g., letters, digits, +punctuation, etc.); all these characters are bound to +`self-insert-command'." (interactive) (or buffer (setq buffer (current-buffer))) (help-setup-xref (list #'describe-bindings prefix buffer) -- 2.20.1 --=-=-=--