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: Sat, 17 Feb 2024 13:10:51 +0000 Message-ID: <87le7joy9l.fsf@jeremybryant.net> References: <871q9rvqbi.fsf@jeremybryant.net> <86wmrj148c.fsf@gnu.org> <87ttmkrlc5.fsf@jeremybryant.net> <86fry3xzae.fsf@gnu.org> <87zfwar3qd.fsf@jeremybryant.net> <87wmraptwj.fsf@jeremybryant.net> <86r0hew2pc.fsf@gnu.org> 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="24098"; mail-complaints-to="usenet@ciao.gmane.io" Cc: 68929@debbugs.gnu.org, justin@burkett.cc, monnier@iro.umontreal.ca To: Eli Zaretskii Original-X-From: bug-gnu-emacs-bounces+geb-bug-gnu-emacs=m.gmane-mx.org@gnu.org Sat Feb 17 17:24:59 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 1rbNUo-0005y7-VM for geb-bug-gnu-emacs@m.gmane-mx.org; Sat, 17 Feb 2024 17:24:59 +0100 Original-Received: from localhost ([::1] helo=lists1p.gnu.org) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1rbNUa-0008ST-Qz; Sat, 17 Feb 2024 11:24:44 -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 1rbNUY-0008Rx-LD for bug-gnu-emacs@gnu.org; Sat, 17 Feb 2024 11:24:42 -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 1rbNUY-00069z-Cr for bug-gnu-emacs@gnu.org; Sat, 17 Feb 2024 11:24:42 -0500 Original-Received: from Debian-debbugs by debbugs.gnu.org with local (Exim 4.84_2) (envelope-from ) id 1rbNUs-0004ot-4T for bug-gnu-emacs@gnu.org; Sat, 17 Feb 2024 11:25:02 -0500 X-Loop: help-debbugs@gnu.org Resent-From: Jeremy Bryant Original-Sender: "Debbugs-submit" Resent-CC: bug-gnu-emacs@gnu.org Resent-Date: Sat, 17 Feb 2024 16:25:02 +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 Original-Received: via spool by 68929-submit@debbugs.gnu.org id=B68929.170818707218484 (code B ref 68929); Sat, 17 Feb 2024 16:25:02 +0000 Original-Received: (at 68929) by debbugs.gnu.org; 17 Feb 2024 16:24:32 +0000 Original-Received: from localhost ([127.0.0.1]:33667 helo=debbugs.gnu.org) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1rbNUN-0004o3-PJ for submit@debbugs.gnu.org; Sat, 17 Feb 2024 11:24:32 -0500 Original-Received: from out-172.mta1.migadu.com ([95.215.58.172]:42426) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1rbNUL-0004nv-PM for 68929@debbugs.gnu.org; Sat, 17 Feb 2024 11:24:30 -0500 DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=jeremybryant.net; s=key1; t=1708187018; 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=mz16aDXwJRhybSHQyLgc28YAvkeei7ghgzJenl18a9w=; b=RIwXaCashWZsspoNHvAfZ9zJm/aQKKxVUyBavnChO9jLd+xoUznXeXKVXtkazmxdn1K/Gf LKV4XLTbuxqjlVrqnrCBIyvLzVvrNgknjFydEJNyM04QT0tKKFKQf6+491zdoEfZ/9KELL uFfYRTZXFaNgy793KIs8LEfBFiNUsntB5Riv+1kaefGQTonZqstdPhDRaDfyJHW4MwyQoT x0lkfdfikAbqPiExvAPXgFValDP2cAiyR63MsPJNe5UV/O8c0h8MtWAbhiiWCxyjBDPxpE T0R9gVO0aRqEkZT4mM4I/cq9QkUv+lJq6jT8AI0hAVBfdNbOlTQg+kwWWnWdNw== X-Report-Abuse: Please report any abuse attempt to abuse@migadu.com and include these headers. In-reply-to: <86r0hew2pc.fsf@gnu.org> X-Migadu-Flow: FLOW_OUT 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:280134 Archived-At: --=-=-= Content-Type: text/x-diff Content-Disposition: attachment; filename=0003-v2-Add-manual-entries-for-which-key.patch >From eae203569f73081e82035990a5a5ac1e0beb9083 Mon Sep 17 00:00:00 2001 From: Jeremy Bryant Date: Sun, 11 Feb 2024 21:26:41 +0000 Subject: [PATCH 3/3] Add manual entries for which-key * doc/emacs/display.texi (Display Custom): Briefly introduce which-key. * doc/emacs/help.texi (Key Help): Briefly mention which-key. --- doc/emacs/display.texi | 3 ++- doc/emacs/help.texi | 5 +++++ 2 files changed, 7 insertions(+), 1 deletion(-) diff --git a/doc/emacs/display.texi b/doc/emacs/display.texi index d2557d6148e..bda57d2b30e 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, see @ref{which-key}. @cindex mouse pointer @cindex hourglass pointer display diff --git a/doc/emacs/help.texi b/doc/emacs/help.texi index 99a4173ac29..1a76e663657 100644 --- a/doc/emacs/help.texi +++ b/doc/emacs/help.texi @@ -260,6 +260,11 @@ Key Help @code{widget-describe} commands, that should be run with point over the button. +@anchor which-key +@kbd{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 --=-=-= Content-Type: text/plain Eli Zaretskii writes: > LGTM, thanks. Some minor comments below. Revised patch attached. >> * doc/emacs/display.texi (Display Custom): brief mention >> * doc/emacs/help.texi (Key Help): reference node above > > The descriptions of the changes in these entries should be complete > sentences: begin with a capital letter and end with a period. Corrected in patch. Thank you for explaining, I now realise this was in CONTRIBUTE. > >> --- 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}). > > The parentheses here don't look right. It is better to say > > For a related help facility, see @ref{which-key}. > >> +@node which-key > > It is better to use > > @anchor which-key > > Then you don't need the @subsection at all. > >> + @command{M-x which-key} is a global minor mode which helps in > > @command is for shell commands. Here you show something the user > types, so the right markup is @kbd. Corrected in patch. Thanks, I have learnt more TeXinfo with this. --=-=-=--