From unknown Sun Jun 15 08:34:47 2025 Content-Disposition: inline Content-Transfer-Encoding: quoted-printable MIME-Version: 1.0 X-Mailer: MIME-tools 5.509 (Entity 5.509) Content-Type: text/plain; charset=utf-8 From: bug#29400 <29400@debbugs.gnu.org> To: bug#29400 <29400@debbugs.gnu.org> Subject: Status: 26.0; Add Elisp manual index entry for `defvar' to node `Compiler Errors' Reply-To: bug#29400 <29400@debbugs.gnu.org> Date: Sun, 15 Jun 2025 15:34:47 +0000 retitle 29400 26.0; Add Elisp manual index entry for `defvar' to node `Comp= iler Errors' reassign 29400 emacs submitter 29400 Drew Adams severity 29400 wishlist thanks From debbugs-submit-bounces@debbugs.gnu.org Wed Nov 22 11:50:52 2017 Received: (at submit) by debbugs.gnu.org; 22 Nov 2017 16:50:52 +0000 Received: from localhost ([127.0.0.1]:52974 helo=debbugs.gnu.org) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1eHYEd-000309-Tg for submit@debbugs.gnu.org; Wed, 22 Nov 2017 11:50:52 -0500 Received: from eggs.gnu.org ([208.118.235.92]:34618) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1eHYEc-0002zw-7H for submit@debbugs.gnu.org; Wed, 22 Nov 2017 11:50:50 -0500 Received: from Debian-exim by eggs.gnu.org with spam-scanned (Exim 4.71) (envelope-from ) id 1eHYEW-00046s-Aj for submit@debbugs.gnu.org; Wed, 22 Nov 2017 11:50:45 -0500 X-Spam-Checker-Version: SpamAssassin 3.3.2 (2011-06-06) on eggs.gnu.org X-Spam-Level: X-Spam-Status: No, score=0.8 required=5.0 tests=BAYES_50 autolearn=disabled version=3.3.2 Received: from lists.gnu.org ([2001:4830:134:3::11]:46015) by eggs.gnu.org with esmtps (TLS1.0:RSA_AES_256_CBC_SHA1:32) (Exim 4.71) (envelope-from ) id 1eHYEW-00046o-7p for submit@debbugs.gnu.org; Wed, 22 Nov 2017 11:50:44 -0500 Received: from eggs.gnu.org ([2001:4830:134:3::10]:53811) by lists.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1eHYEV-0005jp-52 for bug-gnu-emacs@gnu.org; Wed, 22 Nov 2017 11:50:43 -0500 Received: from Debian-exim by eggs.gnu.org with spam-scanned (Exim 4.71) (envelope-from ) id 1eHYEQ-000457-9O for bug-gnu-emacs@gnu.org; Wed, 22 Nov 2017 11:50:43 -0500 Received: from userp1040.oracle.com ([156.151.31.81]:48304) by eggs.gnu.org with esmtps (TLS1.0:DHE_RSA_AES_256_CBC_SHA1:32) (Exim 4.71) (envelope-from ) id 1eHYEQ-00044f-0d for bug-gnu-emacs@gnu.org; Wed, 22 Nov 2017 11:50:38 -0500 Received: from aserv0022.oracle.com (aserv0022.oracle.com [141.146.126.234]) by userp1040.oracle.com (Sentrion-MTA-4.3.2/Sentrion-MTA-4.3.2) with ESMTP id vAMGoZFw009413 (version=TLSv1.2 cipher=ECDHE-RSA-AES256-GCM-SHA384 bits=256 verify=OK) for ; Wed, 22 Nov 2017 16:50:36 GMT Received: from aserv0122.oracle.com (aserv0122.oracle.com [141.146.126.236]) by aserv0022.oracle.com (8.14.4/8.14.4) with ESMTP id vAMGoZ5l024469 (version=TLSv1/SSLv3 cipher=DHE-RSA-AES256-GCM-SHA384 bits=256 verify=OK) for ; Wed, 22 Nov 2017 16:50:35 GMT Received: from abhmp0006.oracle.com (abhmp0006.oracle.com [141.146.116.12]) by aserv0122.oracle.com (8.14.4/8.14.4) with ESMTP id vAMGoZ2K000409 for ; Wed, 22 Nov 2017 16:50:35 GMT MIME-Version: 1.0 Message-ID: Date: Wed, 22 Nov 2017 08:50:33 -0800 (PST) From: Drew Adams To: bug-gnu-emacs@gnu.org Subject: 26.0; Add Elisp manual index entry for `defvar' to node `Compiler Errors' X-Priority: 3 X-Mailer: Oracle Beehive Extensions for Outlook 2.0.1.9.1 (1003210) [OL 16.0.4615.0 (x86)] Content-Type: text/plain; charset=us-ascii Content-Transfer-Encoding: quoted-printable X-Source-IP: aserv0022.oracle.com [141.146.126.234] X-detected-operating-system: by eggs.gnu.org: GNU/Linux 2.4.x-2.6.x [generic] [fuzzy] X-detected-operating-system: by eggs.gnu.org: GNU/Linux 2.6.x X-Received-From: 2001:4830:134:3::11 X-Spam-Score: -5.0 (-----) X-Debbugs-Envelope-To: submit X-BeenThere: debbugs-submit@debbugs.gnu.org X-Mailman-Version: 2.1.18 Precedence: list List-Id: List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: debbugs-submit-bounces@debbugs.gnu.org Sender: "Debbugs-submit" X-Spam-Score: -5.0 (-----) 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=3Dx86_64-w64-mingw32 --without-compress-install 'CFLAGS=3D-O2 -static -g3'' From debbugs-submit-bounces@debbugs.gnu.org Fri Nov 24 09:43:21 2017 Received: (at 29400-done) by debbugs.gnu.org; 24 Nov 2017 14:43:21 +0000 Received: from localhost ([127.0.0.1]:54871 helo=debbugs.gnu.org) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1eIFCL-0000Y9-9p for submit@debbugs.gnu.org; Fri, 24 Nov 2017 09:43:21 -0500 Received: from eggs.gnu.org ([208.118.235.92]:44751) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1eIFCJ-0000Xt-Or for 29400-done@debbugs.gnu.org; Fri, 24 Nov 2017 09:43:19 -0500 Received: from Debian-exim by eggs.gnu.org with spam-scanned (Exim 4.71) (envelope-from ) id 1eIFC9-0007N0-L2 for 29400-done@debbugs.gnu.org; Fri, 24 Nov 2017 09:43:14 -0500 X-Spam-Checker-Version: SpamAssassin 3.3.2 (2011-06-06) on eggs.gnu.org X-Spam-Level: X-Spam-Status: No, score=-0.5 required=5.0 tests=BAYES_05,T_RP_MATCHES_RCVD autolearn=disabled version=3.3.2 Received: from fencepost.gnu.org ([2001:4830:134:3::e]:60372) by eggs.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1eIFC9-0007Mf-Hq; Fri, 24 Nov 2017 09:43:09 -0500 Received: from [176.228.60.248] (port=2946 helo=home-c4e4a596f7) by fencepost.gnu.org with esmtpsa (TLS1.2:RSA_AES_256_CBC_SHA1:256) (Exim 4.82) (envelope-from ) id 1eIFC7-0005ck-M7; Fri, 24 Nov 2017 09:43:09 -0500 Date: Fri, 24 Nov 2017 16:42:39 +0200 Message-Id: <83a7zbagbk.fsf@gnu.org> From: Eli Zaretskii To: Drew Adams In-reply-to: (message from Drew Adams on Wed, 22 Nov 2017 08:50:33 -0800 (PST)) Subject: Re: bug#29400: 26.0; Add Elisp manual index entry for `defvar' to node `Compiler Errors' References: X-detected-operating-system: by eggs.gnu.org: GNU/Linux 2.2.x-3.x [generic] X-Received-From: 2001:4830:134:3::e X-Spam-Score: -5.0 (-----) X-Debbugs-Envelope-To: 29400-done Cc: 29400-done@debbugs.gnu.org X-BeenThere: debbugs-submit@debbugs.gnu.org X-Mailman-Version: 2.1.18 Precedence: list List-Id: List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Reply-To: Eli Zaretskii Errors-To: debbugs-submit-bounces@debbugs.gnu.org Sender: "Debbugs-submit" X-Spam-Score: -5.0 (-----) > Date: Wed, 22 Nov 2017 08:50:33 -0800 (PST) > From: Drew Adams > > 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. From debbugs-submit-bounces@debbugs.gnu.org Fri Nov 24 11:54:50 2017 Received: (at 29400-done) by debbugs.gnu.org; 24 Nov 2017 16:54:50 +0000 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 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 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 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 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 MIME-Version: 1.0 Message-ID: Date: Fri, 24 Nov 2017 08:54:39 -0800 (PST) From: Drew Adams To: Eli Zaretskii , Drew Adams Subject: RE: bug#29400: 26.0; Add Elisp manual index entry for `defvar' to node `Compiler Errors' References: <> <<83a7zbagbk.fsf@gnu.org>> 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)] Content-Type: text/plain; charset=us-ascii Content-Transfer-Encoding: quoted-printable X-Source-IP: aserv0021.oracle.com [141.146.126.233] X-Spam-Score: -2.3 (--) X-Debbugs-Envelope-To: 29400-done Cc: 29400-done@debbugs.gnu.org X-BeenThere: debbugs-submit@debbugs.gnu.org X-Mailman-Version: 2.1.18 Precedence: list List-Id: List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: debbugs-submit-bounces@debbugs.gnu.org Sender: "Debbugs-submit" X-Spam-Score: -2.3 (--) > > 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. From debbugs-submit-bounces@debbugs.gnu.org Fri Nov 24 12:11:07 2017 Received: (at 29400) by debbugs.gnu.org; 24 Nov 2017 17:11:07 +0000 Received: from localhost ([127.0.0.1]:56244 helo=debbugs.gnu.org) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1eIHVL-0004UT-FQ for submit@debbugs.gnu.org; Fri, 24 Nov 2017 12:11:07 -0500 Received: from eggs.gnu.org ([208.118.235.92]:36350) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1eIHVI-0004Ty-Ot for 29400@debbugs.gnu.org; Fri, 24 Nov 2017 12:11:05 -0500 Received: from Debian-exim by eggs.gnu.org with spam-scanned (Exim 4.71) (envelope-from ) id 1eIHVA-0008AP-Cc for 29400@debbugs.gnu.org; Fri, 24 Nov 2017 12:10:59 -0500 X-Spam-Checker-Version: SpamAssassin 3.3.2 (2011-06-06) on eggs.gnu.org X-Spam-Level: X-Spam-Status: No, score=-1.9 required=5.0 tests=BAYES_00,T_RP_MATCHES_RCVD autolearn=disabled version=3.3.2 Received: from fencepost.gnu.org ([2001:4830:134:3::e]:34656) by eggs.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1eIHVA-000896-9C; Fri, 24 Nov 2017 12:10:56 -0500 Received: from [176.228.60.248] (port=3171 helo=home-c4e4a596f7) by fencepost.gnu.org with esmtpsa (TLS1.2:RSA_AES_256_CBC_SHA1:256) (Exim 4.82) (envelope-from ) id 1eIHV8-0007xY-Az; Fri, 24 Nov 2017 12:10:56 -0500 Date: Fri, 24 Nov 2017 19:10:28 +0200 Message-Id: <83wp2f8uwr.fsf@gnu.org> From: Eli Zaretskii To: Drew Adams In-reply-to: (message from Drew Adams on Fri, 24 Nov 2017 08:54:39 -0800 (PST)) Subject: Re: bug#29400: 26.0; Add Elisp manual index entry for `defvar' to node `Compiler Errors' References: <> <<83a7zbagbk.fsf@gnu.org>> X-detected-operating-system: by eggs.gnu.org: GNU/Linux 2.2.x-3.x [generic] X-Received-From: 2001:4830:134:3::e X-Spam-Score: -5.0 (-----) X-Debbugs-Envelope-To: 29400 Cc: 29400@debbugs.gnu.org X-BeenThere: debbugs-submit@debbugs.gnu.org X-Mailman-Version: 2.1.18 Precedence: list List-Id: List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Reply-To: Eli Zaretskii Errors-To: debbugs-submit-bounces@debbugs.gnu.org Sender: "Debbugs-submit" X-Spam-Score: -5.0 (-----) > Date: Fri, 24 Nov 2017 08:54:39 -0800 (PST) > From: Drew Adams > Cc: 29400-done@debbugs.gnu.org > > > 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. But defvar is described elsewhere, and index entries about it should lead there. And after my changes, the description there mentions its use for suppressing warnings, so I don't think an index entry leading elsewhere is needed. > Looking in the index for `warning' is not the only > reasonable way to use an index for this - see above. Feel free to suggest other topics, but "defvar" is definitely not one of them. From debbugs-submit-bounces@debbugs.gnu.org Fri Nov 24 12:39:17 2017 Received: (at 29400) by debbugs.gnu.org; 24 Nov 2017 17:39:17 +0000 Received: from localhost ([127.0.0.1]:56298 helo=debbugs.gnu.org) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1eIHwb-00079a-4f for submit@debbugs.gnu.org; Fri, 24 Nov 2017 12:39:17 -0500 Received: from userp1040.oracle.com ([156.151.31.81]:44262) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1eIHwZ-00079N-CJ for 29400@debbugs.gnu.org; Fri, 24 Nov 2017 12:39:15 -0500 Received: from userv0021.oracle.com (userv0021.oracle.com [156.151.31.71]) by userp1040.oracle.com (Sentrion-MTA-4.3.2/Sentrion-MTA-4.3.2) with ESMTP id vAOHd6eY002732 (version=TLSv1.2 cipher=ECDHE-RSA-AES256-GCM-SHA384 bits=256 verify=OK); Fri, 24 Nov 2017 17:39:07 GMT Received: from aserv0122.oracle.com (aserv0122.oracle.com [141.146.126.236]) by userv0021.oracle.com (8.14.4/8.14.4) with ESMTP id vAOHd5ds010195 (version=TLSv1/SSLv3 cipher=DHE-RSA-AES256-GCM-SHA384 bits=256 verify=OK); Fri, 24 Nov 2017 17:39:06 GMT Received: from abhmp0006.oracle.com (abhmp0006.oracle.com [141.146.116.12]) by aserv0122.oracle.com (8.14.4/8.14.4) with ESMTP id vAOHd5Dj003460; Fri, 24 Nov 2017 17:39:05 GMT MIME-Version: 1.0 Message-ID: <9e934c8b-2479-4c90-bc32-d4fba15ee153@default> Date: Fri, 24 Nov 2017 09:39:03 -0800 (PST) From: Drew Adams To: Eli Zaretskii , Drew Adams Subject: RE: bug#29400: 26.0; Add Elisp manual index entry for `defvar' to node `Compiler Errors' References: <<>> <<<83a7zbagbk.fsf@gnu.org>>> <> <<83wp2f8uwr.fsf@gnu.org>> In-Reply-To: <<83wp2f8uwr.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)] Content-Type: text/plain; charset=us-ascii Content-Transfer-Encoding: quoted-printable X-Source-IP: userv0021.oracle.com [156.151.31.71] X-Spam-Score: -2.3 (--) X-Debbugs-Envelope-To: 29400 Cc: 29400@debbugs.gnu.org X-BeenThere: debbugs-submit@debbugs.gnu.org X-Mailman-Version: 2.1.18 Precedence: list List-Id: List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: debbugs-submit-bounces@debbugs.gnu.org Sender: "Debbugs-submit" X-Spam-Score: -2.3 (--) > > > 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. >=20 > But defvar is described elsewhere, and index entries about it should > lead there. And after my changes, the description there mentions its > use for suppressing warnings, so I don't think an index entry leading > elsewhere is needed. That was the point of the bug report. You have added mention of supressing warnings to the node that is indexed by `defvar', which responds to the report. (And hopefully you will also have added there a link to the more complete coverage of compiler warnings.) > > Looking in the index for `warning' is not the only > > reasonable way to use an index for this - see above. >=20 > Feel free to suggest other topics, but "defvar" is > definitely not one of them. You just got through admitting that it is one of them. You corrected, you say, the node that index-entry `defvar' points to, by adding info there about suppressing warnings (and presumably linking to the node that deals more generally with such warnings and their suppression). From unknown Sun Jun 15 08:34:47 2025 Received: (at fakecontrol) by fakecontrolmessage; To: internal_control@debbugs.gnu.org From: Debbugs Internal Request Subject: Internal Control Message-Id: bug archived. Date: Sat, 23 Dec 2017 12:24:03 +0000 User-Agent: Fakemail v42.6.9 # This is a fake control message. # # The action: # bug archived. thanks # This fakemail brought to you by your local debbugs # administrator