From mboxrd@z Thu Jan 1 00:00:00 1970 Path: news.gmane.org!.POSTED!not-for-mail From: Drew Adams Newsgroups: gmane.emacs.bugs Subject: bug#29400: 26.0; Add Elisp manual index entry for `defvar' to node `Compiler Errors' Date: Fri, 24 Nov 2017 08:54:39 -0800 (PST) Message-ID: References: <> <<83a7zbagbk.fsf@gnu.org>> NNTP-Posting-Host: blaine.gmane.org Mime-Version: 1.0 Content-Type: text/plain; charset=us-ascii Content-Transfer-Encoding: quoted-printable X-Trace: blaine.gmane.org 1511542520 19667 195.159.176.226 (24 Nov 2017 16:55:20 GMT) X-Complaints-To: usenet@blaine.gmane.org NNTP-Posting-Date: Fri, 24 Nov 2017 16:55:20 +0000 (UTC) Cc: 29400-done@debbugs.gnu.org To: Eli Zaretskii , Drew Adams Original-X-From: bug-gnu-emacs-bounces+geb-bug-gnu-emacs=m.gmane.org@gnu.org Fri Nov 24 17:55:15 2017 Return-path: Envelope-to: geb-bug-gnu-emacs@m.gmane.org Original-Received: from lists.gnu.org ([208.118.235.17]) by blaine.gmane.org with esmtp (Exim 4.84_2) (envelope-from ) id 1eIHFr-0004DF-Lh for geb-bug-gnu-emacs@m.gmane.org; Fri, 24 Nov 2017 17:55:07 +0100 Original-Received: from localhost ([::1]:50197 helo=lists.gnu.org) by lists.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1eIHFx-00054k-GB for geb-bug-gnu-emacs@m.gmane.org; Fri, 24 Nov 2017 11:55:13 -0500 Original-Received: from eggs.gnu.org ([2001:4830:134:3::10]:50146) by lists.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1eIHFq-00054e-7u for bug-gnu-emacs@gnu.org; Fri, 24 Nov 2017 11:55:07 -0500 Original-Received: from Debian-exim by eggs.gnu.org with spam-scanned (Exim 4.71) (envelope-from ) id 1eIHFn-0001KW-4G for bug-gnu-emacs@gnu.org; Fri, 24 Nov 2017 11:55:06 -0500 Original-Received: from debbugs.gnu.org ([208.118.235.43]:47531) by eggs.gnu.org with esmtps (TLS1.0:RSA_AES_128_CBC_SHA1:16) (Exim 4.71) (envelope-from ) id 1eIHFm-0001HJ-SA for bug-gnu-emacs@gnu.org; Fri, 24 Nov 2017 11:55:02 -0500 Original-Received: from Debian-debbugs by debbugs.gnu.org with local (Exim 4.84_2) (envelope-from ) id 1eIHFm-00043M-J5 for bug-gnu-emacs@gnu.org; Fri, 24 Nov 2017 11:55:02 -0500 X-Loop: help-debbugs@gnu.org Resent-From: Drew Adams Original-Sender: "Debbugs-submit" Resent-CC: bug-gnu-emacs@gnu.org Resent-Date: Fri, 24 Nov 2017 16:55:02 +0000 Resent-Message-ID: Resent-Sender: help-debbugs@gnu.org X-GNU-PR-Message: followup 29400 X-GNU-PR-Package: emacs X-GNU-PR-Keywords: Original-Received: via spool by 29400-done@debbugs.gnu.org id=D29400.151154249015555 (code D ref 29400); Fri, 24 Nov 2017 16:55:02 +0000 Original-Received: (at 29400-done) by debbugs.gnu.org; 24 Nov 2017 16:54:50 +0000 Original-Received: from localhost ([127.0.0.1]:56212 helo=debbugs.gnu.org) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1eIHFZ-00042p-TX for submit@debbugs.gnu.org; Fri, 24 Nov 2017 11:54:50 -0500 Original-Received: from aserp1040.oracle.com ([141.146.126.69]:40533) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1eIHFY-00042a-E0 for 29400-done@debbugs.gnu.org; Fri, 24 Nov 2017 11:54:48 -0500 Original-Received: from aserv0021.oracle.com (aserv0021.oracle.com [141.146.126.233]) by aserp1040.oracle.com (Sentrion-MTA-4.3.2/Sentrion-MTA-4.3.2) with ESMTP id vAOGsgcY021916 (version=TLSv1.2 cipher=ECDHE-RSA-AES256-GCM-SHA384 bits=256 verify=OK); Fri, 24 Nov 2017 16:54:42 GMT Original-Received: from userv0122.oracle.com (userv0122.oracle.com [156.151.31.75]) by aserv0021.oracle.com (8.14.4/8.14.4) with ESMTP id vAOGsfLq011605 (version=TLSv1/SSLv3 cipher=DHE-RSA-AES256-GCM-SHA384 bits=256 verify=OK); Fri, 24 Nov 2017 16:54:41 GMT Original-Received: from abhmp0006.oracle.com (abhmp0006.oracle.com [141.146.116.12]) by userv0122.oracle.com (8.14.4/8.14.4) with ESMTP id vAOGsePR029987; Fri, 24 Nov 2017 16:54:41 GMT In-Reply-To: <<83a7zbagbk.fsf@gnu.org>> X-Priority: 3 X-Mailer: Oracle Beehive Extensions for Outlook 2.0.1.9.1 (1003210) [OL 16.0.4615.0 (x86)] X-Source-IP: aserv0021.oracle.com [141.146.126.233] X-BeenThere: debbugs-submit@debbugs.gnu.org X-Mailman-Version: 2.1.18 Precedence: list X-detected-operating-system: by eggs.gnu.org: GNU/Linux 2.2.x-3.x [generic] X-Received-From: 208.118.235.43 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.org@gnu.org Original-Sender: "bug-gnu-emacs" Xref: news.gmane.org gmane.emacs.bugs:140317 Archived-At: > > 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. >=20 > I added some index entries,=20 Thank you. > 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? To find exactly what the manual says about it. You might know that some Java method is what you want, but you might want to consult the Java doc again for details. Just because you know something about something that is in the manual doesn't mean that you never want to check the manual about it again. Or you might want to get to the doc to be able to point someone else to it (URL or manual+node-name). I often point users to sections of the manual. And in this case looking up `defvar' in the index is the first thing I would do. Imagining that someone who knows that `defvar' can be used to suppress some compiler warnings should never want or need to find where this is covered in the manual by checking `defvar' in the index suggests a narrow understanding of indexing - which is not normally what you show. > 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. Looking in the index for `warning' is not the only reasonable way to use an index for this - see above. > > 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'. >=20 > Done. Thanks.