GNU bug report logs - #11202
24.0.93; shell.el: Documentation for M-x shell sometimes shows wrong keybinding for describe-mode

Previous Next

To add a comment to this bug, you must first unarchive it, by sending
a message to control AT debbugs.gnu.org, with unarchive 11202 in the body.
You can then email your comments to 11202 AT debbugs.gnu.org in the normal way.

Toggle the display of automated, internal messages from the tracker.

Message #5 received at submit <at> debbugs.gnu.org (full text, mbox):

From: David Röthlisberger <david <at> rothlis.net>
To: bug-gnu-emacs <at> gnu.org
Subject: 24.0.93; shell.el: Documentation for M-x shell sometimes shows wrong
	keybinding for describe-mode
Date: Sun, 8 Apr 2012 13:58:21 +0100

If I invoke 'M-x describe-function shell' when I am already in help-mode, the last sentence reads:

> (Type h in the shell buffer for a list of commands.)

(Normally --if describe-function is invoked from outside of help-mode-- it would read "C-h m" instead of "h".)

Patch below. Would you like me to provide a similar patch for all instances of "\\[describe-mode]" in the lisp directory?

Kind regards,
Dave.


From: David Rothlisberger <david <at> rothlis.net>
Date: Sun, 8 Apr 2012 13:50:28 +0100
Subject: [PATCH] * shell.el: Correct keybinding for `describe-mode' in
 `shell' docstring.

---
 lisp/shell.el |    2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/lisp/shell.el b/lisp/shell.el
index 7c5ce49..a9e2113 100644
--- a/lisp/shell.el
+++ b/lisp/shell.el
@@ -607,7 +607,7 @@ (defun shell (&optional buffer)
 and controlling the subjobs of the shell.  See `shell-mode'.
 See also the variable `shell-prompt-pattern'.
 
-To specify a coding system for converting non-ASCII characters
+\\<shell-mode-map>To specify a coding system for converting non-ASCII characters
 in the input and output to the shell, use \\[universal-coding-system-argument]
 before \\[shell].  You can also specify this with \\[set-buffer-process-coding-system]
 in the shell buffer, after you start the shell.
-- 
1.7.9.2

Message #8 received at 11202 <at> debbugs.gnu.org (full text, mbox):

From: David Röthlisberger <david <at> rothlis.net>
To: 11202 <at> debbugs.gnu.org
Subject: Re: bug#11202: Acknowledgement (24.0.93;
	shell.el: Documentation for M-x shell sometimes shows wrong
	keybinding for describe-mode)
Date: Sun, 15 Apr 2012 09:52:14 +0100

Note that this problem manifests itself more often than the original report implies.

In the *Help* buffer for `shell', if I navigate to the help for any of the linked functions or variables, then click the `[back]' link, the help text for `shell' has changed to the incorrect text as per the original report.

Message #11 received at 11202 <at> debbugs.gnu.org (full text, mbox):

From: Stefan Monnier <monnier <at> IRO.UMontreal.CA>
To: David Röthlisberger <david <at> rothlis.net>
Cc: 11202 <at> debbugs.gnu.org
Subject: Re: bug#11202: 24.0.93;
	shell.el: Documentation for M-x shell sometimes shows wrong
	keybinding for describe-mode
Date: Tue, 19 Jun 2012 14:14:09 -0400

> If I invoke 'M-x describe-function shell' when I am already in
> help-mode, the last sentence reads:
>> (Type h in the shell buffer for a list of commands.)

Yup, that's a bug.

> Patch below. Would you like me to provide a similar patch for all instances
> of "\\[describe-mode]" in the lisp directory?

Such a patch would be very welcome, yes.  Even better would be some way
to detect the problem automatically (maybe from checkdoc?).


        Stefan

Message #14 received at 11202 <at> debbugs.gnu.org (full text, mbox):

From: Lars Ingebrigtsen <larsi <at> gnus.org>
To: David Röthlisberger <david <at> rothlis.net>
Cc: 11202 <at> debbugs.gnu.org
Subject: Re: bug#11202: 24.0.93; shell.el: Documentation for M-x shell
 sometimes shows wrong keybinding for describe-mode
Date: Sat, 12 Oct 2019 07:11:28 +0200

David Röthlisberger <david <at> rothlis.net> writes:

> If I invoke 'M-x describe-function shell' when I am already in
> help-mode, the last sentence reads:
>
>> (Type h in the shell buffer for a list of commands.)
>
> (Normally --if describe-function is invoked from outside of
> help-mode-- it would read "C-h m" instead of "h".)
>
> Patch below.

I've now applied it to Emacs 27.

> Would you like me to provide a similar patch for all
> instances of "\\[describe-mode]" in the lisp directory?

This was apparently not done, but is perhaps best left to a new bug
report, if needed.

-- 
(domestic pets only, the antidote for overdose, milk.)
   bloggy blog: http://lars.ingebrigtsen.no

Previous Next

GNU bug tracking system
Copyright (C) 1999 Darren O. Benham, 1997,2003 nCipher Corporation Ltd, 1994-97 Ian Jackson.