bug#25033: [PATCH] Add a missing index for `man'.

[Hong Xu]

On 2016-11-26 Sat 01:29 GMT-0800, Eli Zaretskii <eliz@gnu.org> wrote:

>> From: Hong Xu <hong@topbug.net>
>> Date: Sat, 26 Nov 2016 01:18:26 -0800
>>
>>      * programs.texi (Man Page): Add the index for `man'.
>> ---
>>  doc/emacs/programs.texi | 1 +
>>  1 file changed, 1 insertion(+)
>>
>> diff --git a/doc/emacs/programs.texi b/doc/emacs/programs.texi
>> index e409affd67d1..fc9f8e88b47a 100644
>> --- a/doc/emacs/programs.texi
>> +++ b/doc/emacs/programs.texi
>> @@ -1193,6 +1193,7 @@ Man Page
>>  with Info (@pxref{Misc Help}).  This process is not finished, so it is
>>  still useful to read manual pages.
>>
>> +@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.

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.

signature.asc
Description: PGP signature