GNU bug report logs - #58324
28.1: Variable-name error in documentation of variables used to configure ElDoc 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 58324 in the body.
You can then email your comments to 58324 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: Mark Harig <idirectscm <at> aim.com>
To: "bug-gnu-emacs <at> gnu.org" <bug-gnu-emacs <at> gnu.org>
Subject: 28.1: Variable-name error in documentation of variables used to
 configure ElDoc mode
Date: Thu, 6 Oct 2022 02:12:22 +0000 (UTC)

In the Emacs info manual, (emacs) Lisp Doc, one of the variables
documented is `eldoc-display-truncation-message'.  But C-h v is
unable to reference this variable to provide its description.
Instead, in the Eldoc customization group, there is the variable
named `eldoc-echo-area-display-truncation-message', whose
description appears to match the description at the (emacs) Lisp
Doc node of the Emacs info manual.

If this is the intended variable name, then the Emacs info manual
needs to be changed to use it.

(End of report.)

Message #10 received at 58324-done <at> debbugs.gnu.org (full text, mbox):

From: Stefan Kangas <stefankangas <at> gmail.com>
To: Mark Harig <idirectscm <at> aim.com>, 58324-done <at> debbugs.gnu.org
Subject: Re: bug#58324: 28.1: Variable-name error in documentation of
 variables used to configure ElDoc mode
Date: Thu, 6 Oct 2022 03:34:23 -0400

Mark Harig via "Bug reports for GNU Emacs, the Swiss army knife of text
editors" <bug-gnu-emacs <at> gnu.org> writes:

> In the Emacs info manual, (emacs) Lisp Doc, one of the variables
> documented is `eldoc-display-truncation-message'.  But C-h v is
> unable to reference this variable to provide its description.
> Instead, in the Eldoc customization group, there is the variable
> named `eldoc-echo-area-display-truncation-message', whose
> description appears to match the description at the (emacs) Lisp
> Doc node of the Emacs info manual.
>
> If this is the intended variable name, then the Emacs info manual
> needs to be changed to use it.

Thanks for the bug report.  The variable was renamed in commit
77c3928425, but the manual was unfortunately never updated.

I've now fixed this on the emacs-28 branch, so I'm closing this bug
report.

Previous Next

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