unofficial mirror of emacs-devel@gnu.org 
 help / color / mirror / code / Atom feed
From: "Eli Zaretskii" <eliz@gnu.org>
Cc: lennart.borgman.073@student.lu.se, karl@freefriends.org,
	emacs-devel@gnu.org
Subject: Re: Info - some notes about customization
Date: Sun, 05 Dec 2004 22:51:24 +0200	[thread overview]
Message-ID: <01c4db0c$Blat.v2.2.2$546f7e60@zahav.net.il> (raw)
In-Reply-To: <87mzwstx4z.fsf@jurta.org> (message from Juri Linkov on Sun, 05 Dec 2004 20:31:24 +0200)

> From: Juri Linkov <juri@jurta.org>
> Date: Sun, 05 Dec 2004 20:31:24 +0200
> Cc: eliz@gnu.org, emacs-devel@gnu.org, karl@freefriends.org
> 
> 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	other threads:[~2004-12-05 20:51 UTC|newest]

Thread overview: 4+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2004-12-04  0:00 Info - some notes about customization Lennart Borgman
2004-12-05 18:31 ` Juri Linkov
2004-12-05 20:51   ` Eli Zaretskii [this message]
2004-12-06  1:40   ` Richard Stallman

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

  List information: https://www.gnu.org/software/emacs/

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to='01c4db0c$Blat.v2.2.2$546f7e60@zahav.net.il' \
    --to=eliz@gnu.org \
    --cc=emacs-devel@gnu.org \
    --cc=karl@freefriends.org \
    --cc=lennart.borgman.073@student.lu.se \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
Code repositories for project(s) associated with this public inbox

	https://git.savannah.gnu.org/cgit/emacs.git

This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for read-only IMAP folder(s) and NNTP newsgroup(s).