From: "Robert P. J. Day" <rpjday@crashcourse.ca>
To: Git Mailing list <git@vger.kernel.org>
Subject: pedantry: is there a standard for what should be in the SYNOPSIS?
Date: Tue, 21 Nov 2017 09:49:41 -0500 (EST) [thread overview]
Message-ID: <alpine.LFD.2.21.1711210925530.6795@DESKTOP-1GPMCEJ> (raw)
following up on an earlier question of mine, is there a standard for
what options should be listed in either the SYNOPSIS or the
DESCRIPTION sections of a man page? i ask since i'm seeing some
definite inconsistency.
in addition to the patch i submitted earlier, here are some other
examples.
"man git-clone", the SYNOPSIS says nothing about options "--verbose"
or "-v", even though "git clone" supports those options and they're
mentioned further down that man page.
on that same man page, there are a number of options that have two
supported forms (eg., "-l" and "--local"), but the SYNOPSIS shows only
the short form, while many other man pages show both (for another
example of this, see "man git-clean", which shows only the short
forms).
also, regarding what seems to be a standard for some options, it
seems that many commands support both options "--verbose" and "-v" to
mean verbose operation (as long as "-v" isn't reserved for some other
option for that command, which occasionally happens). in cases where
"-v" is not being used, is there a reason to not just add it as an
equivalent to "--verbose"?
the same thing could be said with respect to "-n" (as long as it's
available) always being the short form of "--dry-run". and so on, and
so on.
oh, and i'm still wondering why some commands feel the need to
explain the function of "--", when that's the sort of thing that more
properly belongs in "man gitcli".
thoughts?
rday
--
========================================================================
Robert P. J. Day Ottawa, Ontario, CANADA
http://crashcourse.ca
Twitter: http://twitter.com/rpjday
LinkedIn: http://ca.linkedin.com/in/rpjday
========================================================================
next reply other threads:[~2017-11-21 14:51 UTC|newest]
Thread overview: 3+ messages / expand[flat|nested] mbox.gz Atom feed top
2017-11-21 14:49 Robert P. J. Day [this message]
2017-11-21 17:54 ` pedantry: is there a standard for what should be in the SYNOPSIS? Jonathan Nieder
2017-11-21 21:16 ` Robert P. J. Day
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: http://vger.kernel.org/majordomo-info.html
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=alpine.LFD.2.21.1711210925530.6795@DESKTOP-1GPMCEJ \
--to=rpjday@crashcourse.ca \
--cc=git@vger.kernel.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 public inbox
https://80x24.org/mirrors/git.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).