From: Richard Copley <rcopley@gmail.com>
To: Eli Zaretskii <eliz@gnu.org>
Cc: Philipp Stephani <phst@google.com>,
p.stephani2@gmail.com, Paul Eggert <eggert@cs.ucla.edu>,
Richard Stallman <rms@gnu.org>,
Emacs Development <emacs-devel@gnu.org>
Subject: Re: [PATCH] Use recommended long options syntax in man page
Date: Wed, 10 Jan 2018 19:26:54 +0000 [thread overview]
Message-ID: <CAPM58ojEOgG5d_mOLRbHmkXKjqv4cr_mA+Xh-OtfNEPWaD=8tg@mail.gmail.com> (raw)
In-Reply-To: <83mv1m5qrl.fsf@gnu.org>
On 10 January 2018 at 03:36, Eli Zaretskii <eliz@gnu.org> wrote:
>> Cc: rms@gnu.org, phst@google.com, p.stephani2@gmail.com, emacs-devel@gnu.org
>> From: Paul Eggert <eggert@cs.ucla.edu>
>> Date: Tue, 9 Jan 2018 14:21:49 -0800
>>
>> That is true only for options with an optional argument, as Bug#24949#30
>> mentions. Most options are not that way, and we needn't recommend the
>> spurious "=" for them.
>
> Newbies or people who only rarely use these options would not know
> which arguments are optional, so recommending to always use a '='
> makes their muscle memory more future-proof.
Both arguments have merit. Manuals aren't just for newbies. Maybe
there's room to introduce the syntax with the = first, then elaborate
explaining the actual syntax in full. Or maybe that level of detail is
best left for the TexInfo manual.
next prev parent reply other threads:[~2018-01-10 19:26 UTC|newest]
Thread overview: 12+ messages / expand[flat|nested] mbox.gz Atom feed top
2018-01-07 23:12 [PATCH] Use recommended long options syntax in man page Philipp Stephani
2018-01-08 0:43 ` Paul Eggert
2018-01-09 2:51 ` Richard Stallman
2018-01-09 7:30 ` Paul Eggert
2018-01-09 17:24 ` Eli Zaretskii
2018-01-09 22:21 ` Paul Eggert
2018-01-10 3:36 ` Eli Zaretskii
2018-01-10 19:26 ` Richard Copley [this message]
2018-01-11 19:51 ` Richard Stallman
2018-01-17 22:33 ` Philipp Stephani
2018-01-10 3:03 ` Richard Stallman
2018-01-08 4:08 ` Eli Zaretskii
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
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to='CAPM58ojEOgG5d_mOLRbHmkXKjqv4cr_mA+Xh-OtfNEPWaD=8tg@mail.gmail.com' \
--to=rcopley@gmail.com \
--cc=eggert@cs.ucla.edu \
--cc=eliz@gnu.org \
--cc=emacs-devel@gnu.org \
--cc=p.stephani2@gmail.com \
--cc=phst@google.com \
--cc=rms@gnu.org \
/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 external index
https://git.savannah.gnu.org/cgit/emacs.git
https://git.savannah.gnu.org/cgit/emacs/org-mode.git
This is an external index of several public inboxes,
see mirroring instructions on how to clone and mirror
all data and code used by this external index.