GNU bug report logs - #29400
26.0; Add Elisp manual index entry for `defvar' to node `Compiler Errors'

Previous Next

Full log

View this message in rfc822 format

From: help-debbugs <at> gnu.org (GNU bug Tracking System)
To: Eli Zaretskii <eliz <at> gnu.org>
Cc: tracker <at> debbugs.gnu.org
Subject: bug#29400: closed (26.0; Add Elisp manual index entry for
 `defvar' to node `Compiler Errors')
Date: Fri, 24 Nov 2017 14:44:02 +0000

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

Your message dated Fri, 24 Nov 2017 16:42:39 +0200
with message-id <83a7zbagbk.fsf <at> gnu.org>
and subject line Re: bug#29400: 26.0; Add Elisp manual index entry for `defvar' to node `Compiler Errors'
has caused the debbugs.gnu.org bug report #29400,
regarding 26.0; Add Elisp manual index entry for `defvar' to node `Compiler Errors'
to be marked as done.

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


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

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

From: Drew Adams <drew.adams <at> oracle.com>
To: bug-gnu-emacs <at> gnu.org
Subject: 26.0; Add Elisp manual index entry for `defvar' to node `Compiler
 Errors'
Date: Wed, 22 Nov 2017 08:50:33 -0800 (PST)

Node `Compiler Errors' seems to be the only place in the Elisp manual
where we tell users that you can use a vacuous `defvar' (no value) to
suppress a byte-compiler warning about it not being defined.

But this node has no index entry - at least none that has the word
`defvar' in it.  Please add such an entry.

And please either add the same info (about this use of a vacuous
`defvar') to node `Defining Variables' or add a cross-reference from
that node to node `Compiler Errors'.

As it is now, it is not so easy to find this info.



In GNU Emacs 26.0.90 (build 3, x86_64-w64-mingw32)
 of 2017-10-13
Repository revision: 906224eba147bdfc0514090064e8e8f53160f1d4
Windowing system distributor `Microsoft Corp.', version 6.1.7601
Configured using:
 `configure --without-dbus --host=x86_64-w64-mingw32
 --without-compress-install 'CFLAGS=-O2 -static -g3''

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

From: Eli Zaretskii <eliz <at> gnu.org>
To: Drew Adams <drew.adams <at> oracle.com>
Cc: 29400-done <at> debbugs.gnu.org
Subject: Re: bug#29400: 26.0;
 Add Elisp manual index entry for `defvar' to node `Compiler Errors'
Date: Fri, 24 Nov 2017 16:42:39 +0200

> Date: Wed, 22 Nov 2017 08:50:33 -0800 (PST)
> From: Drew Adams <drew.adams <at> oracle.com>
> 
> Node `Compiler Errors' seems to be the only place in the Elisp manual
> where we tell users that you can use a vacuous `defvar' (no value) to
> suppress a byte-compiler warning about it not being defined.
> 
> But this node has no index entry - at least none that has the word
> `defvar' in it.  Please add such an entry.

I added some index entries, but I don't understand why you wanted an
index entry with "defvar" in it.  A reader who will look for "defvar"
when they want to find ways of suppressing compiler warnings already
knows that defvar is used for that purpose, so why would they use such
a topic at Info-index's prompt?  That's the opposite of what good
index entries should provide -- they should _lead_ to defvar's
description as the way to suppress warnings when the reader thinks of
"warnings" or some such.

> And please either add the same info (about this use of a vacuous
> `defvar') to node `Defining Variables' or add a cross-reference from
> that node to node `Compiler Errors'.

Done.

Previous Next

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