From mboxrd@z Thu Jan 1 00:00:00 1970 Path: news.gmane.org!.POSTED!not-for-mail From: Eli Zaretskii Newsgroups: gmane.emacs.bugs Subject: bug#29888: 26.0; Emacs manual indexes Date: Fri, 29 Dec 2017 18:13:14 +0200 Message-ID: <83po6xfr6t.fsf@gnu.org> References: Reply-To: Eli Zaretskii NNTP-Posting-Host: blaine.gmane.org X-Trace: blaine.gmane.org 1514563936 17348 195.159.176.226 (29 Dec 2017 16:12:16 GMT) X-Complaints-To: usenet@blaine.gmane.org NNTP-Posting-Date: Fri, 29 Dec 2017 16:12:16 +0000 (UTC) Cc: 29888-done@debbugs.gnu.org To: Drew Adams Original-X-From: bug-gnu-emacs-bounces+geb-bug-gnu-emacs=m.gmane.org@gnu.org Fri Dec 29 17:12:12 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 1eUxGU-00045j-Tr for geb-bug-gnu-emacs@m.gmane.org; Fri, 29 Dec 2017 17:12:11 +0100 Original-Received: from localhost ([::1]:45915 helo=lists.gnu.org) by lists.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1eUxIT-0002AO-MZ for geb-bug-gnu-emacs@m.gmane.org; Fri, 29 Dec 2017 11:14:13 -0500 Original-Received: from eggs.gnu.org ([2001:4830:134:3::10]:52596) by lists.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1eUxIN-00028e-Pf for bug-gnu-emacs@gnu.org; Fri, 29 Dec 2017 11:14:08 -0500 Original-Received: from Debian-exim by eggs.gnu.org with spam-scanned (Exim 4.71) (envelope-from ) id 1eUxII-0005HO-PX for bug-gnu-emacs@gnu.org; Fri, 29 Dec 2017 11:14:07 -0500 Original-Received: from debbugs.gnu.org ([208.118.235.43]:48167) by eggs.gnu.org with esmtps (TLS1.0:RSA_AES_128_CBC_SHA1:16) (Exim 4.71) (envelope-from ) id 1eUxII-0005HF-LA for bug-gnu-emacs@gnu.org; Fri, 29 Dec 2017 11:14:02 -0500 Original-Received: from Debian-debbugs by debbugs.gnu.org with local (Exim 4.84_2) (envelope-from ) id 1eUxII-0007w8-FQ for bug-gnu-emacs@gnu.org; Fri, 29 Dec 2017 11:14:02 -0500 Resent-From: Eli Zaretskii Original-Sender: "Debbugs-submit" Resent-To: bug-gnu-emacs@gnu.org Resent-Date: Fri, 29 Dec 2017 16:14:02 +0000 Resent-Message-ID: Resent-Sender: help-debbugs@gnu.org X-GNU-PR-Message: cc-closed 29888 X-GNU-PR-Package: emacs X-GNU-PR-Keywords: Mail-Followup-To: 29888@debbugs.gnu.org, eliz@gnu.org, drew.adams@oracle.com Original-Received: via spool by 29888-done@debbugs.gnu.org id=D29888.151456402230470 (code D ref 29888); Fri, 29 Dec 2017 16:14:02 +0000 Original-Received: (at 29888-done) by debbugs.gnu.org; 29 Dec 2017 16:13:42 +0000 Original-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 Original-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 Original-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 Original-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 Original-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 In-reply-to: (message from Drew Adams on Thu, 28 Dec 2017 19:39:21 -0800 (PST)) X-detected-operating-system: by eggs.gnu.org: GNU/Linux 2.2.x-3.x [generic] 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:141592 Archived-At: > 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.