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#29888: 26.0; Emacs manual indexes Date: Thu, 28 Dec 2017 19:39:21 -0800 (PST) Message-ID: 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 1514518761 15401 195.159.176.226 (29 Dec 2017 03:39:21 GMT) X-Complaints-To: usenet@blaine.gmane.org NNTP-Posting-Date: Fri, 29 Dec 2017 03:39:21 +0000 (UTC) To: 29888@debbugs.gnu.org Original-X-From: bug-gnu-emacs-bounces+geb-bug-gnu-emacs=m.gmane.org@gnu.org Fri Dec 29 04:39:17 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 1eUlVr-0003Q7-KE for geb-bug-gnu-emacs@m.gmane.org; Fri, 29 Dec 2017 04:39:15 +0100 Original-Received: from localhost ([::1]:51845 helo=lists.gnu.org) by lists.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1eUlXo-0003jH-Od for geb-bug-gnu-emacs@m.gmane.org; Thu, 28 Dec 2017 22:41:16 -0500 Original-Received: from eggs.gnu.org ([2001:4830:134:3::10]:36812) by lists.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1eUlWj-00032e-2y for bug-gnu-emacs@gnu.org; Thu, 28 Dec 2017 22:40:10 -0500 Original-Received: from Debian-exim by eggs.gnu.org with spam-scanned (Exim 4.71) (envelope-from ) id 1eUlWe-0000BY-1d for bug-gnu-emacs@gnu.org; Thu, 28 Dec 2017 22:40:09 -0500 Original-Received: from debbugs.gnu.org ([208.118.235.43]:47011) by eggs.gnu.org with esmtps (TLS1.0:RSA_AES_128_CBC_SHA1:16) (Exim 4.71) (envelope-from ) id 1eUlWd-0000BN-T8 for bug-gnu-emacs@gnu.org; Thu, 28 Dec 2017 22:40:03 -0500 Original-Received: from Debian-debbugs by debbugs.gnu.org with local (Exim 4.84_2) (envelope-from ) id 1eUlWd-00038i-H0 for bug-gnu-emacs@gnu.org; Thu, 28 Dec 2017 22:40:03 -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, 29 Dec 2017 03:40:02 +0000 Resent-Message-ID: Resent-Sender: help-debbugs@gnu.org X-GNU-PR-Message: report 29888 X-GNU-PR-Package: emacs X-GNU-PR-Keywords: X-Debbugs-Original-To: bug-gnu-emacs@gnu.org Original-Received: via spool by submit@debbugs.gnu.org id=B.151451879412046 (code B ref -1); Fri, 29 Dec 2017 03:40:02 +0000 Original-Received: (at submit) by debbugs.gnu.org; 29 Dec 2017 03:39:54 +0000 Original-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 Original-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 Original-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 Original-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 Original-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 Original-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 Original-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 Original-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== Original-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 Original-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 Original-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 X-Priority: 3 X-Mailer: Oracle Beehive Extensions for Outlook 2.0.1.9.1 (1003210) [OL 16.0.4627.0 (x86)] 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-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:141587 Archived-At: 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''