From unknown Fri Jun 20 07:18:22 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#29888 <29888@debbugs.gnu.org> To: bug#29888 <29888@debbugs.gnu.org> Subject: Status: 26.0; Emacs manual indexes Reply-To: bug#29888 <29888@debbugs.gnu.org> Date: Fri, 20 Jun 2025 14:18:22 +0000 retitle 29888 26.0; Emacs manual indexes reassign 29888 emacs submitter 29888 Drew Adams severity 29888 minor thanks From debbugs-submit-bounces@debbugs.gnu.org Thu Dec 28 22:39:54 2017 Received: (at submit) by debbugs.gnu.org; 29 Dec 2017 03:39:54 +0000 Received: from localhost ([127.0.0.1]:55692 helo=debbugs.gnu.org) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1eUlWU-00038D-0p for submit@debbugs.gnu.org; Thu, 28 Dec 2017 22:39:54 -0500 Received: from eggs.gnu.org ([208.118.235.92]:45727) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1eUlWS-000381-EZ for submit@debbugs.gnu.org; Thu, 28 Dec 2017 22:39:53 -0500 Received: from Debian-exim by eggs.gnu.org with spam-scanned (Exim 4.71) (envelope-from ) id 1eUlWM-0008VK-7T for submit@debbugs.gnu.org; Thu, 28 Dec 2017 22:39:47 -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,T_DKIM_INVALID autolearn=disabled version=3.3.2 Received: from lists.gnu.org ([2001:4830:134:3::11]:39404) by eggs.gnu.org with esmtps (TLS1.0:RSA_AES_256_CBC_SHA1:32) (Exim 4.71) (envelope-from ) id 1eUlWM-0008VA-3j for submit@debbugs.gnu.org; Thu, 28 Dec 2017 22:39:46 -0500 Received: from eggs.gnu.org ([2001:4830:134:3::10]:36676) by lists.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1eUlWK-0002xA-FZ for bug-gnu-emacs@gnu.org; Thu, 28 Dec 2017 22:39:45 -0500 Received: from Debian-exim by eggs.gnu.org with spam-scanned (Exim 4.71) (envelope-from ) id 1eUlWF-0008R4-Ef for bug-gnu-emacs@gnu.org; Thu, 28 Dec 2017 22:39:44 -0500 Received: from userp2130.oracle.com ([156.151.31.86]:60300) by eggs.gnu.org with esmtps (TLS1.0:RSA_AES_256_CBC_SHA1:32) (Exim 4.71) (envelope-from ) id 1eUlWF-0008OS-2u for bug-gnu-emacs@gnu.org; Thu, 28 Dec 2017 22:39:39 -0500 Received: from pps.filterd (userp2130.oracle.com [127.0.0.1]) by userp2130.oracle.com (8.16.0.21/8.16.0.21) with SMTP id vBT3bbP3128544 for ; Fri, 29 Dec 2017 03:39:28 GMT DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=oracle.com; h=mime-version : message-id : date : from : sender : to : subject : content-type : content-transfer-encoding; s=corp-2017-10-26; bh=mUFA/dRI9uiWRFwej5QnmWZicMDqG3iDztUZ6xrY0wo=; b=tJk+7hsnJItm6THo+2ZaQbzVOSNX0wnGfUeZTNoHV8aLIyFO9exvn50/kx5tU/VdlIz6 Dzicuc0kYKdeRvdZtegcH+3fMhH+17feXPAqDfA2s8eeFZ7AN9IKfOFpkJrVjryrNpfx O0vHD9v6BpJjWw/8B/6IrD6fg+ayQ2jPtK+CFn/6TW8GQxbW+X1Ba8w2npN1P2UeftPB 6O6SwaYFc7Pc6p0kpsd5elgelPot4Eg7lJuhArCAsWB1ePs3GzJd+ApQEcIO71IQn38w YSRiL1JCRjXR5XVf7Dybdm6Vu+lB48HKF9REsEWy3erqTXgf2Da8YNOFMaTC7oN0oCQW 7Q== Received: from aserv0022.oracle.com (aserv0022.oracle.com [141.146.126.234]) by userp2130.oracle.com with ESMTP id 2f4ghduypr-1 (version=TLSv1.2 cipher=ECDHE-RSA-AES256-GCM-SHA384 bits=256 verify=OK) for ; Fri, 29 Dec 2017 03:39:28 +0000 Received: from userv0121.oracle.com (userv0121.oracle.com [156.151.31.72]) by aserv0022.oracle.com (8.14.4/8.14.4) with ESMTP id vBT3dOe8019763 (version=TLSv1/SSLv3 cipher=DHE-RSA-AES256-GCM-SHA384 bits=256 verify=FAIL) for ; Fri, 29 Dec 2017 03:39:27 GMT Received: from abhmp0010.oracle.com (abhmp0010.oracle.com [141.146.116.16]) by userv0121.oracle.com (8.14.4/8.13.8) with ESMTP id vBT3dNx0008424 for ; Fri, 29 Dec 2017 03:39:23 GMT MIME-Version: 1.0 Message-ID: Date: Thu, 28 Dec 2017 19:39:21 -0800 (PST) From: Drew Adams To: bug-gnu-emacs@gnu.org Subject: 26.0; Emacs manual indexes X-Priority: 3 X-Mailer: Oracle Beehive Extensions for Outlook 2.0.1.9.1 (1003210) [OL 16.0.4627.0 (x86)] Content-Type: text/plain; charset=us-ascii Content-Transfer-Encoding: quoted-printable X-Proofpoint-Virus-Version: vendor=nai engine=5900 definitions=8758 signatures=668649 X-Proofpoint-Spam-Details: rule=notspam policy=default score=0 suspectscore=1 malwarescore=0 phishscore=0 bulkscore=0 spamscore=0 mlxscore=0 mlxlogscore=999 adultscore=0 classifier=spam adjust=0 reason=mlx scancount=1 engine=8.0.1-1711220000 definitions=main-1712290049 X-detected-operating-system: by eggs.gnu.org: GNU/Linux 3.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: -4.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: -4.0 (----) 1. In `Command Index': Why these "mode, *" entries? Please consider removing these or adding (many) others. * mode, Glasses: MixedCase Words. (line 12) * mode, Org: Org Mode. (line 6) * mode, thumbs: File Conveniences. (line 60) 2. In `Concept Index': There are lots of "mode, *" entries? Why only these? Is this supposed to be complete (all modes mentioned in the manual)? It doesn't even include basic and longstanding modes such as Dired. What's the purpose of these entries (why these)? 3. In node `Top', the indexes are listed, with descriptions. * Key Index:: An item for each standard Emacs key sequence. * Option Index:: An item for every command-line option. * Command Index:: An item for each command name. * Variable Index:: An item for each documented variable. * Concept Index:: An item for each concept. Each of the descriptions says that the relevant index contains an (index) item "for each" whatever. Nope. It should say that it contains an item for the whatevers that are mentioned in the Emacs manual. What's more, the entry in `Top' for `Variable Index', unlike the others, adds "documented" to the description: "for each documented variable". That confuses things even more. It really gives the impression that, at least for variables, each Emacs variable that has a doc string has an entry in this index. It would be much clearer to say only that the given index has entries for whatevers: * Key Index:: Standard Emacs key sequences. * Option Index:: Command-line options. * Command Index:: Commands. * Variable Index:: Variables. * Concept Index:: Concepts. 4. In the Concept index: a. There are some entries that end with `<1>'. This convention should be explained (e.g. at the top). A short sentence should suffice. b. Some entries are essentially duplicated, for no good reason. E.g.: =20 * 7z: File Archives. (line 38) * '7z': File Archives. (line 38) * 'Alt' key (MS-Windows): Windows Keyboard. (line 17) * 'Alt' key invokes menu (Windows): Windows Keyboard. (line 79) * arc: File Archives. (line 38) * 'arc': File Archives. (line 38) * case in completion: Completion Options. (line 6) * case-sensitivity and completion: Completion Options. (line 6) * cvs: VC Directory Mode. (line 24) * CVS: Version Control Systems. (line 25) * echo area: Echo Area. (line 6) * echo area message: Echo Area. (line 19) * echoing: Echo Area. (line 9) * Emacs Lisp package: Packages. (line 6) * Emacs Lisp package archive: Packages. (line 6) c. Why are all of the files in quotes except `~/.emacs'? * '_emacs' init file, MS-Windows: Windows HOME. (line 43) * ~/.emacs file: Init File. (line 6) * '~/.emacs.d/gtkrc' file: GTK resources. (line 6) * '~/.gtkrc-2.0' file: GTK resources. (line 6) * '~/.Xdefaults' file: Resources. (line 6) * '~/.Xresources' file: Resources. (line 6) d. Some of the entries are not good, and seem arbitrary. A bad verb is one problem. Examples: * adding to the kill ring in Dired: Misc Dired Features. (line 19) * adjust buffer face height: Text Scale. (line 6) * aggressive scrolling: Auto Scrolling. (line 29) * attached frame (of speedbar): Speedbar. (line 6) * boredom: Amusements. (line 6) * buffer definitions index: Imenu. (line 6) * buttons at buffer position: Editing Format Info. (line 20) * compressing files (in Dired): Operating on Files. (line 106) * compression: Compressed Files. (line 6) * converting text to upper or lower case: Case. (line 20) * drastic changes: Reverting. (line 6) * emergency escape: Emergency Escape. (line 6) e. Hyphenation is inconsistent or wrong. Examples: * Auto Fill mode: Auto Fill. (line 6) * Auto Save mode: Auto Save. (line 6) * Auto-Revert mode: Reverting. (line 37) * auto-save for remote files: Auto Save Files. (line 26) * autoload: Lisp Libraries. (line 62) * button down events: Mouse Buttons. (line 6) f. Some entries are not specific enough. E.g.: * binding: Commands. (line 6) g. Some entries don't seem to correspond to their targets. E.g.: * blank lines in programs: Multi-Line Comments. (line 6) I looked only at entries from A to E. Any improvements you want to make are OK by me. If you make none, that's OK too (feel free to close). 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 Dec 29 11:13:42 2017 Received: (at 29888-done) by debbugs.gnu.org; 29 Dec 2017 16:13:42 +0000 Received: from localhost ([127.0.0.1]:56847 helo=debbugs.gnu.org) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1eUxHy-0007vO-8v for submit@debbugs.gnu.org; Fri, 29 Dec 2017 11:13:42 -0500 Received: from eggs.gnu.org ([208.118.235.92]:33117) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1eUxHx-0007vC-2n for 29888-done@debbugs.gnu.org; Fri, 29 Dec 2017 11:13:41 -0500 Received: from Debian-exim by eggs.gnu.org with spam-scanned (Exim 4.71) (envelope-from ) id 1eUxHn-0004ih-34 for 29888-done@debbugs.gnu.org; Fri, 29 Dec 2017 11:13:36 -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,T_RP_MATCHES_RCVD autolearn=disabled version=3.3.2 Received: from fencepost.gnu.org ([2001:4830:134:3::e]:54420) by eggs.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1eUxHm-0004ia-VV; Fri, 29 Dec 2017 11:13:31 -0500 Received: from [176.228.60.248] (port=3308 helo=home-c4e4a596f7) by fencepost.gnu.org with esmtpsa (TLS1.2:RSA_AES_256_CBC_SHA1:256) (Exim 4.82) (envelope-from ) id 1eUxHm-0006bp-EW; Fri, 29 Dec 2017 11:13:30 -0500 Date: Fri, 29 Dec 2017 18:13:14 +0200 Message-Id: <83po6xfr6t.fsf@gnu.org> From: Eli Zaretskii To: Drew Adams In-reply-to: (message from Drew Adams on Thu, 28 Dec 2017 19:39:21 -0800 (PST)) Subject: Re: bug#29888: 26.0; Emacs manual indexes 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: 29888-done Cc: 29888-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: Thu, 28 Dec 2017 19:39:21 -0800 (PST) > From: Drew Adams Thanks, I fixed most of these issues. > 1. In `Command Index': > > Why these "mode, *" entries? Please consider removing these or adding > (many) others. > > * mode, Glasses: MixedCase Words. (line 12) > * mode, Org: Org Mode. (line 6) > * mode, thumbs: File Conveniences. (line 60) They should be in Concept Index. > 2. In `Concept Index': > > There are lots of "mode, *" entries? Why only these? Is this supposed > to be complete (all modes mentioned in the manual)? It doesn't even > include basic and longstanding modes such as Dired. What's the purpose > of these entries (why these)? The purpose is to support "i mode TAB". I don't think Dired belongs here, because it's primarily a feature, its being a mode is very secondary. For the others, I guess the intent was to do this for modes whose names can be otherwise encountered in many other index entries. > 3. In node `Top', the indexes are listed, with descriptions. > > * Key Index:: An item for each standard Emacs key sequence. > * Option Index:: An item for every command-line option. > * Command Index:: An item for each command name. > * Variable Index:: An item for each documented variable. > * Concept Index:: An item for each concept. I ma a small change there, but by and large, I don't think this is too important, as people will rarely look at the descriptions of "Index" nodes. And menus are not in the printed manual. > 4. In the Concept index: > > a. There are some entries that end with `<1>'. > > This convention should be explained (e.g. at the top). A short sentence > should suffice. It's not an Emacs convention, it's a Texinfo convention. Most of such index entries are bugs/typos, or should be disambiguated by qualifying them by their context. Which is what I did. > b. Some entries are essentially duplicated, for no good reason. E.g.: Some of those were bugs, but most are not duplications, IMO. > c. Why are all of the files in quotes except `~/.emacs'? > > * '_emacs' init file, MS-Windows: Windows HOME. (line 43) > * ~/.emacs file: Init File. (line 6) > * '~/.emacs.d/gtkrc' file: GTK resources. (line 6) > * '~/.gtkrc-2.0' file: GTK resources. (line 6) > * '~/.Xdefaults' file: Resources. (line 6) > * '~/.Xresources' file: Resources. (line 6) They are not in quotes in my manual, and not in the official pretest zip archive. Not sure how you got them. > d. Some of the entries are not good, and seem arbitrary. A bad verb is > one problem. Examples: > > * adding to the kill ring in Dired: Misc Dired Features. (line 19) > * adjust buffer face height: Text Scale. (line 6) > * aggressive scrolling: Auto Scrolling. (line 29) > * attached frame (of speedbar): Speedbar. (line 6) > * boredom: Amusements. (line 6) > * buffer definitions index: Imenu. (line 6) > * buttons at buffer position: Editing Format Info. (line 20) > * compressing files (in Dired): Operating on Files. (line 106) > * compression: Compressed Files. (line 6) > * converting text to upper or lower case: Case. (line 20) > * drastic changes: Reverting. (line 6) > * emergency escape: Emergency Escape. (line 6) I don't see what's wrong with these. > e. Hyphenation is inconsistent or wrong. Examples: > > * Auto Fill mode: Auto Fill. (line 6) > * Auto Save mode: Auto Save. (line 6) > * Auto-Revert mode: Reverting. (line 37) > > * auto-save for remote files: Auto Save Files. (line 26) > * autoload: Lisp Libraries. (line 62) > > * button down events: Mouse Buttons. (line 6) I fixed "Auto-Revert Mode" and "button down events", the rest seem okay. > f. Some entries are not specific enough. E.g.: > > * binding: Commands. (line 6) > > g. Some entries don't seem to correspond to their targets. E.g.: > > * blank lines in programs: Multi-Line Comments. (line 6) Didn't see any problems with those. > I looked only at entries from A to E. Any improvements you want to make > are OK by me. If you make none, that's OK too (feel free to close). Thanks. From unknown Fri Jun 20 07:18:22 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, 27 Jan 2018 12:24:05 +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