GNU bug report logs - #58324
28.1: Variable-name error in documentation of variables used to configure ElDoc mode

Previous Next

Full log

View this message in rfc822 format

From: help-debbugs <at> gnu.org (GNU bug Tracking System)
To: Stefan Kangas <stefankangas <at> gmail.com>
Cc: tracker <at> debbugs.gnu.org
Subject: bug#58324: closed (28.1: Variable-name error in documentation of
 variables used to configure ElDoc mode)
Date: Thu, 06 Oct 2022 07:35:02 +0000

[Message part 1 (text/plain, inline)]

Your message dated Thu, 6 Oct 2022 03:34:23 -0400
with message-id <CADwFkm=UBPcvU3M9axNANoC2dKoLj6f4e9RWb1R2qTAaGmXykg <at> mail.gmail.com>
and subject line Re: bug#58324: 28.1: Variable-name error in documentation of variables used to configure ElDoc mode
has caused the debbugs.gnu.org bug report #58324,
regarding 28.1: Variable-name error in documentation of variables used to configure ElDoc mode
to be marked as done.

(If you believe you have received this mail in error, please contact
help-debbugs <at> gnu.org.)


-- 
58324: https://debbugs.gnu.org/cgi/bugreport.cgi?bug=58324
GNU Bug Tracking System
Contact help-debbugs <at> gnu.org with problems

[Message part 2 (message/rfc822, inline)]

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 part 3 (message/rfc822, inline)]

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.