emacs-devel
[Top][All Lists]
Advanced

[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]

Re: Info - some notes about customization


From: Eli Zaretskii
Subject: Re: Info - some notes about customization
Date: Sun, 05 Dec 2004 22:51:24 +0200

> From: Juri Linkov <address@hidden>
> Date: Sun, 05 Dec 2004 20:31:24 +0200
> Cc: address@hidden, address@hidden, address@hidden
> 
> The node "Command Arguments" can't be renamed because then the
> standalone Info reader will fail to find this node with its
> -O, --show-options, --usage option.

It could be changed to one of the other node names that --usage looks
for.

> It looks for the following names:
> 
>     "%s invocation",
>     "Invoking %s",
>     "Preliminaries",  /* m4 has Invoking under Preliminaries! */
>     "Invocation",
>     "Command Arguments",/* Emacs */
>     "Invoking `%s'",
>     "%s options",
>     "Options",
>     "Option ",                /* e.g. "Option Summary" */
>     "Invoking",
>     "All options",    /* tar, paxutils */
>     "Arguments",
>     "%s cmdline",     /* ar */
>     "%s",             /* last resort */
> 
> and will find a completely irrelevant node when the
> "Command Arguments" node becomes renamed to something else.

The fact that the Info reader needs to jump through the hoops to find
the node that describes the command-line arguments is IMHO an evidence
of poor adherence to GNU coding standards.  It is IMHO a shame that
Emacs, of all GNU programs, is one of those which required the crazy
code I wrote to implement --usage, since standards.texi explicitly
says that a manual should have a node "PROGRAM Invocation" or
"Invoking PROGRAM", so that "info --usage" could find it.

So perhaps it's high time we changed the Emacs manual to have a node
"Emacs Invocation" ("Invoking Emacs" will interfere with the already
existing "Invoking emacsclient"), which will solve both of the
problems in one blow.




reply via email to

[Prev in Thread] Current Thread [Next in Thread]