From mboxrd@z Thu Jan 1 00:00:00 1970 Path: news.gmane.io!.POSTED.blaine.gmane.org!not-for-mail From: Jeremy Bryant via "Bug reports for GNU Emacs, the Swiss army knife of text editors" Newsgroups: gmane.emacs.bugs Subject: bug#68929: [PATCH] Copy which-key from GNU ELPA into core Date: Sun, 11 Feb 2024 21:32:44 +0000 Message-ID: <87wmraptwj.fsf@jeremybryant.net> References: <871q9rvqbi.fsf@jeremybryant.net> <86wmrj148c.fsf@gnu.org> <87ttmkrlc5.fsf@jeremybryant.net> <86fry3xzae.fsf@gnu.org> <87zfwar3qd.fsf@jeremybryant.net> Reply-To: Jeremy Bryant Mime-Version: 1.0 Content-Type: multipart/mixed; boundary="=-=-=" Injection-Info: ciao.gmane.io; posting-host="blaine.gmane.org:116.202.254.214"; logging-data="23693"; mail-complaints-to="usenet@ciao.gmane.io" Cc: eliz@gnu.org, 68929@debbugs.gnu.org, justin@burkett.cc, monnier@iro.umontreal.ca To: Jeremy Bryant Original-X-From: bug-gnu-emacs-bounces+geb-bug-gnu-emacs=m.gmane-mx.org@gnu.org Sun Feb 11 22:56:17 2024 Return-path: Envelope-to: geb-bug-gnu-emacs@m.gmane-mx.org Original-Received: from lists.gnu.org ([209.51.188.17]) by ciao.gmane.io with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.92) (envelope-from ) id 1rZHo7-0005tZ-0b for geb-bug-gnu-emacs@m.gmane-mx.org; Sun, 11 Feb 2024 22:56:16 +0100 Original-Received: from localhost ([::1] helo=lists1p.gnu.org) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1rZHnf-0003xe-Kj; Sun, 11 Feb 2024 16:55:47 -0500 Original-Received: from eggs.gnu.org ([2001:470:142:3::10]) by lists.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.90_1) (envelope-from ) id 1rZHnd-0003xC-IF for bug-gnu-emacs@gnu.org; Sun, 11 Feb 2024 16:55:45 -0500 Original-Received: from debbugs.gnu.org ([2001:470:142:5::43]) by eggs.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_128_GCM_SHA256:128) (Exim 4.90_1) (envelope-from ) id 1rZHnd-0004NQ-A2 for bug-gnu-emacs@gnu.org; Sun, 11 Feb 2024 16:55:45 -0500 Original-Received: from Debian-debbugs by debbugs.gnu.org with local (Exim 4.84_2) (envelope-from ) id 1rZHnt-0004oF-MU for bug-gnu-emacs@gnu.org; Sun, 11 Feb 2024 16:56:01 -0500 X-Loop: help-debbugs@gnu.org Resent-From: Jeremy Bryant Original-Sender: "Debbugs-submit" Resent-CC: bug-gnu-emacs@gnu.org Resent-Date: Sun, 11 Feb 2024 21:56:01 +0000 Resent-Message-ID: Resent-Sender: help-debbugs@gnu.org X-GNU-PR-Message: followup 68929 X-GNU-PR-Package: emacs X-GNU-PR-Keywords: patch X-Debbugs-Original-Cc: Eli Zaretskii , 68929@debbugs.gnu.org, bug-gnu-emacs@gnu.org, justin@burkett.cc, monnier@iro.umontreal.ca Original-Received: via spool by submit@debbugs.gnu.org id=B.170768852918379 (code B ref -1); Sun, 11 Feb 2024 21:56:01 +0000 Original-Received: (at submit) by debbugs.gnu.org; 11 Feb 2024 21:55:29 +0000 Original-Received: from localhost ([127.0.0.1]:51532 helo=debbugs.gnu.org) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1rZHnL-0004mG-Vj for submit@debbugs.gnu.org; Sun, 11 Feb 2024 16:55:29 -0500 Original-Received: from lists.gnu.org ([2001:470:142::17]:39988) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1rZHTU-0003me-L4 for submit@debbugs.gnu.org; Sun, 11 Feb 2024 16:34:57 -0500 Original-Received: from eggs.gnu.org ([2001:470:142:3::10]) by lists.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.90_1) (envelope-from ) id 1rZHT8-0008Vl-Q5 for bug-gnu-emacs@gnu.org; Sun, 11 Feb 2024 16:34:34 -0500 Original-Received: from out-189.mta1.migadu.com ([2001:41d0:203:375::bd]) by eggs.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.90_1) (envelope-from ) id 1rZHT6-0000l1-Na for bug-gnu-emacs@gnu.org; Sun, 11 Feb 2024 16:34:34 -0500 DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=jeremybryant.net; s=key1; t=1707687267; h=from:from:reply-to:subject:subject:date:date:message-id:message-id: to:to:cc:cc:mime-version:mime-version:content-type:content-type: in-reply-to:in-reply-to:references:references; bh=HcmA3GRJvrlN88MAVkrvh7OI2ebcF+9F1394/bdhlgk=; b=IDuzH4Uasbq5XdjlEpqES7FpJozBN85EtK8DXdkR2i+pxvxd+L1kB+aa3XPBnRqAwclu1p 9l7b8xjg50dmAioWO95UOeMYcV2O6DInRrU282Q371cNlANhJ2tYNPc6nGLnBx7B/7l+r4 KR6bZ9v41X0LlrN+7pxSVBlTa7uBES+/Jyd7ZQCbtRRrkxzrA7K9vuPaUFggDOSTWPrd0D V7HzLyJvg5T4hfo/IfqvvRp6gFSEQBxIdeE2OxGxzRFCPtmRHCl2S6aXfbhQINHGJyDlj8 b8DPWWx2g4mQzT3ZFywE8fdrc7ESVZw2nq43BoNxnCIMxWAbd7a7XXtA20B4dw== X-Report-Abuse: Please report any abuse attempt to abuse@migadu.com and include these headers. In-reply-to: <87zfwar3qd.fsf@jeremybryant.net> X-Migadu-Flow: FLOW_OUT Received-SPF: pass client-ip=2001:41d0:203:375::bd; envelope-from=jb@jeremybryant.net; helo=out-189.mta1.migadu.com X-Spam_score_int: -20 X-Spam_score: -2.1 X-Spam_bar: -- X-Spam_report: (-2.1 / 5.0 requ) BAYES_00=-1.9, DKIM_SIGNED=0.1, DKIM_VALID=-0.1, DKIM_VALID_AU=-0.1, DKIM_VALID_EF=-0.1, SPF_HELO_NONE=0.001, SPF_PASS=-0.001, T_SCC_BODY_TEXT_LINE=-0.01 autolearn=ham autolearn_force=no X-Spam_action: no action X-BeenThere: debbugs-submit@debbugs.gnu.org X-Mailman-Version: 2.1.18 Precedence: list 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-mx.org@gnu.org Original-Sender: bug-gnu-emacs-bounces+geb-bug-gnu-emacs=m.gmane-mx.org@gnu.org Xref: news.gmane.io gmane.emacs.bugs:279872 Archived-At: --=-=-= Content-Type: text/plain > Eli Zaretskii writes: > >> Will the section be very long? How long? >> >> If it's not very long, I think the right place is in "Key Help", >> perhaps as a separate subsection below it. Also, I think which-key >> should be briefly mentioned in "Display Custom", where echo-keystrokes >> is described. >> >> If the section about which-key you envision is supposed to be long and >> detailed, perhaps it would be better to have a separate manual with >> all that stuff, whereas the Emacs user manual should have only a short >> description of the main features, and a cross-reference to the >> separate manual. > > I would propose to make a new section short enough to belong in the main > Emacs manual, as which-key's "keymay discovery" perspective should be > easier to find. > > I can volunteer to write a draft and confer with Justin, the actual > author, for completeness. Attached are a proposed patch for the Emacs manual, intentionally very short. Feedback welcome on any aspects. --=-=-= Content-Type: text/x-diff Content-Disposition: attachment; filename=0002-Add-manual-entries-for-which-key.patch >From c8264398374ad6eae380ea46428092efa0ba02fc Mon Sep 17 00:00:00 2001 From: Jeremy Bryant Date: Sun, 11 Feb 2024 21:26:41 +0000 Subject: [PATCH 2/2] Add manual entries for which-key * doc/emacs/display.texi (Display Custom): brief mention * doc/emacs/help.texi (Key Help): reference node above --- doc/emacs/display.texi | 3 ++- doc/emacs/help.texi | 6 ++++++ 2 files changed, 8 insertions(+), 1 deletion(-) diff --git a/doc/emacs/display.texi b/doc/emacs/display.texi index d2557d6148e..754f9b6d048 100644 --- a/doc/emacs/display.texi +++ b/doc/emacs/display.texi @@ -2215,7 +2215,8 @@ Display Custom default), the multi-character key sequence echo shown according to @code{echo-keystrokes} will include a short help text about keys which will invoke @code{describe-prefix-bindings} (@pxref{Misc Help}) to show -the list of commands for the prefix you already typed. +the list of commands for the prefix you already typed. For a related +help facility (@pxref{which-key}). @cindex mouse pointer @cindex hourglass pointer display diff --git a/doc/emacs/help.texi b/doc/emacs/help.texi index 99a4173ac29..25bb3ccc08a 100644 --- a/doc/emacs/help.texi +++ b/doc/emacs/help.texi @@ -260,6 +260,12 @@ Key Help @code{widget-describe} commands, that should be run with point over the button. +@node which-key +@subsection which-key + @command{M-x which-key} is a global minor mode which helps in + discovering keymaps. It displays keybindings following your currently + entered incomplete command (prefix), in a popup. + @node Name Help @section Help by Command or Variable Name -- 2.42.0 --=-=-=--