From mboxrd@z Thu Jan 1 00:00:00 1970 Path: news.gmane.org!.POSTED!not-for-mail From: Hong Xu Newsgroups: gmane.emacs.bugs Subject: bug#25033: [PATCH] Add a missing index for `man'. Date: Sat, 26 Nov 2016 11:17:35 -0800 Message-ID: <87bmx2gieo.fsf@topbug.net> References: <1480151906-14773-1-git-send-email-hong@topbug.net> <83zikm1tdj.fsf@gnu.org> <8760nav9md.fsf@topbug.net> <83wpfq1nxu.fsf@gnu.org> NNTP-Posting-Host: blaine.gmane.org Mime-Version: 1.0 Content-Type: multipart/signed; boundary="=-=-="; micalg=pgp-sha1; protocol="application/pgp-signature" X-Trace: blaine.gmane.org 1480187894 31469 195.159.176.226 (26 Nov 2016 19:18:14 GMT) X-Complaints-To: usenet@blaine.gmane.org NNTP-Posting-Date: Sat, 26 Nov 2016 19:18:14 +0000 (UTC) User-Agent: mu4e 0.9.17; emacs 25.1.50.14 Cc: 25033@debbugs.gnu.org To: Eli Zaretskii Original-X-From: bug-gnu-emacs-bounces+geb-bug-gnu-emacs=m.gmane.org@gnu.org Sat Nov 26 20:18:10 2016 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 1cAiUD-0007W6-9P for geb-bug-gnu-emacs@m.gmane.org; Sat, 26 Nov 2016 20:18:09 +0100 Original-Received: from localhost ([::1]:51540 helo=lists.gnu.org) by lists.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1cAiUH-00088G-0D for geb-bug-gnu-emacs@m.gmane.org; Sat, 26 Nov 2016 14:18:13 -0500 Original-Received: from eggs.gnu.org ([2001:4830:134:3::10]:43514) by lists.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1cAiUB-000889-1r for bug-gnu-emacs@gnu.org; Sat, 26 Nov 2016 14:18:07 -0500 Original-Received: from Debian-exim by eggs.gnu.org with spam-scanned (Exim 4.71) (envelope-from ) id 1cAiU6-0002Ju-2f for bug-gnu-emacs@gnu.org; Sat, 26 Nov 2016 14:18:07 -0500 Original-Received: from debbugs.gnu.org ([208.118.235.43]:55472) by eggs.gnu.org with esmtps (TLS1.0:RSA_AES_128_CBC_SHA1:16) (Exim 4.71) (envelope-from ) id 1cAiU5-0002Jn-WE for bug-gnu-emacs@gnu.org; Sat, 26 Nov 2016 14:18:02 -0500 Original-Received: from Debian-debbugs by debbugs.gnu.org with local (Exim 4.84_2) (envelope-from ) id 1cAiU5-0008HA-Ol for bug-gnu-emacs@gnu.org; Sat, 26 Nov 2016 14:18:01 -0500 X-Loop: help-debbugs@gnu.org Resent-From: Hong Xu Original-Sender: "Debbugs-submit" Resent-CC: bug-gnu-emacs@gnu.org Resent-Date: Sat, 26 Nov 2016 19:18:01 +0000 Resent-Message-ID: Resent-Sender: help-debbugs@gnu.org X-GNU-PR-Message: followup 25033 X-GNU-PR-Package: emacs X-GNU-PR-Keywords: patch Original-Received: via spool by 25033-submit@debbugs.gnu.org id=B25033.148018787231797 (code B ref 25033); Sat, 26 Nov 2016 19:18:01 +0000 Original-Received: (at 25033) by debbugs.gnu.org; 26 Nov 2016 19:17:52 +0000 Original-Received: from localhost ([127.0.0.1]:42638 helo=debbugs.gnu.org) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1cAiTw-0008Gn-B1 for submit@debbugs.gnu.org; Sat, 26 Nov 2016 14:17:52 -0500 Original-Received: from sender163-mail.zoho.com ([74.201.84.163]:21436) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1cAiTu-0008Ge-51 for 25033@debbugs.gnu.org; Sat, 26 Nov 2016 14:17:50 -0500 Original-Received: from localhost (cpe-104-32-170-214.socal.res.rr.com [104.32.170.214]) by mx.zohomail.com with SMTPS id 1480187860446545.1896740980228; Sat, 26 Nov 2016 11:17:40 -0800 (PST) In-reply-to: <83wpfq1nxu.fsf@gnu.org> X-Zoho-Virus-Status: 1 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:126126 Archived-At: --=-=-= Content-Type: text/plain On 2016-11-26 Sat 03:27 GMT-0800, Eli Zaretskii wrote: >> From: Hong Xu >> Cc: 25033@debbugs.gnu.org >> Date: Sat, 26 Nov 2016 02:06:02 -0800 >> >> >> +@findex man >> >> @findex manual-entry >> >> You can read the man page for an operating system command, library >> >> function, or system call, with the @kbd{M-x man} command. This >> > >> > If I type "i man RET" in the current Emacs manual, I land in that >> > node, and "i man TAB" produces a list of completions one of which is >> > "man pages", which leads to the same node. So why did you see the >> > need for adding this index entry? >> >> The missing index actually confused me when I searched the manual for >> it, as it was hidden in my completion list. > > Please describe in more detail how it happened that it was hidden, > perhaps there's something I'm missing. > I use ivy-mode for completion. I was expecting there was an exact matching of "man", but there wasn't. A lot of other entries with higher scores were on the first page of the completion list. >> The main reason is though for the completeness of the documentation -- >> "man" should be an indexed function name just like "manual-entry". I >> don't see how it could be harmful to add this index, although the >> benefit may also not be significant. > > The harm is in having two or more index entries that begin with the > same text and point to the same page. That's not useful, and its only > effect is bloating the index, including in the printed version of the > manual (which increases the page count). So we try to avoid that. These are two different types of indices: one is a function, the other is a concept -- they locate in different indices. If a user wants to look for the man function, it can't be found in the function index. How about this: replace all "manual-entry" with "man" in the section, and remove the "manual-entry" index as well. In this way, the total number of indices won't increase. It also fixes the inconsistency -- both "M-x manual-entry" and "M-x man" are used without pointing out they are the same thing. --=-=-= Content-Type: application/pgp-signature; name="signature.asc" -----BEGIN PGP SIGNATURE----- Version: GnuPG v1 iQIcBAEBAgAGBQJYOd/QAAoJECZsfTOCL4R4Vr0QAI3vIvV2nNmShYo/Z1V1cGx8 3E4pcHvUr7vzgT5Hq7/meVTDT7j8jwhIQuCUIk+3Th37pktlyOhWnaL/H1H6S+/P /JHVrTNiEkpQBUH+BWTRCDAFiYg++7yjmWDnWEksMKVXoKz5rzY6t28LmsZ496M1 ujAUvWyw1b4QamYFj/N3S3fXyf17MOcdsJ2/RMMGg0AuCoNV/t13X13POO027qGM tu9Ck0rdxkLYB5UQgBG0qPgA/dj5QWrG7IKYwUTdUvv/KFdWY6Qak4XySGJRmf6X bcyRev4qR2d0n2yzDcaWD42JLvfiQuaYSOCO+ASzLff+uQQGq/V8ADDfpT2iGbsl udJVkWhHD64fVT9ia6d+iyU438ixURE4LzhTUIzirttQzgBMYdOxMClXx+mWsVhM oYUWeCJ+obuNiXR1ahu207zkIC7Y9v3dLKs9CzpZxwHB8DPVL2X4HHtzBMgK7B4q h0WAQxZCW41JM8EK57Vb+FWlGY9LKxq4S2OIx4D8pjuxGXylAVP96Xw1Nl3QrP7z 9pBMA5AqP1OBW+2uTtGX4B7ZsdaPlcyfG8XnUsYpUctBd+A86/rpZ0v0b/vew9Z0 tjv/XqH+SP9VDaat17QtPjR7Y2TvCxhGDoYLY8FRmbCXt+IXbtda1h6JCCi4rwW4 GVMqOaaE9IMwxE3TOoLr =1TE7 -----END PGP SIGNATURE----- --=-=-=--