From: "Robert P. J. Day" <rpjday@crashcourse.ca>
To: Git Mailing list <git@vger.kernel.org>
Subject: verifying syntax for optional and replaceable content in man pages
Date: Wed, 30 May 2018 07:39:15 -0400 (EDT) [thread overview]
Message-ID: <alpine.LFD.2.21.1805300733440.10096@localhost.localdomain> (raw)
willing to submit some patches to standardize the syntax of man
pages in terms of rendering "optional" and/or "replaceable" content,
and it seems like "man git-config" would be a good place to start:
SYNOPSIS
git config [<file-option>] [type] [--show-origin] [-z|--null] name [value [value_regex]]
git config [<file-option>] [type] --add name value
git config [<file-option>] [type] --replace-all name value [value_regex]
...snip ...
can i assume the proper (uniform) syntax for the above would be
(shortening lines):
... [<type>] [--show-origin] [-z|--null] <name> [<value> [<value_regex>]]
... [<type>] --add <name> <value>
... [<type>] --replace-all <name> <value> [<value_regex>]
and so on. is that the consensus? i wouldn't try to do it all at once,
maybe just a page at a time to not be too disruptive.
rday
--
========================================================================
Robert P. J. Day Ottawa, Ontario, CANADA
http://crashcourse.ca/dokuwiki
Twitter: http://twitter.com/rpjday
LinkedIn: http://ca.linkedin.com/in/rpjday
========================================================================
next reply other threads:[~2018-05-30 11:41 UTC|newest]
Thread overview: 3+ messages / expand[flat|nested] mbox.gz Atom feed top
2018-05-30 11:39 Robert P. J. Day [this message]
2018-05-30 17:54 ` Stefan Beller
2018-05-30 18:08 ` 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
* 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.1805300733440.10096@localhost.localdomain \
--to=rpjday@crashcourse.ca \
--cc=git@vger.kernel.org \
--subject='Re: verifying syntax for optional and replaceable content in man pages' \
/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
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 NNTP newsgroup(s).