Re: [PATCH v2 1/2] doc/for-each-ref: consistently use '=' to between argument names and values
- From
Junio C Hamano <gitster@pobox.com>
- Date
- Sep 12, 2017, 02:28 UTC
- Message-ID
- <xmqq8thk3b2n.fsf@gitster.mtv.corp.google.com>
- In-Reply-To
- <20170911193338.25985-1-me@ikke.info>
Kevin Daudt <me@ikke.info> writes:
Show 7 quoted lines
> The synopsis and description inconsistently add a '=' between the > argument name and it's value. Make this consistent. > > Signed-off-by: Kevin Daudt <me@ikke.info> > --- > Documentation/git-for-each-ref.txt | 15 ++++++++------- > 1 file changed, 8 insertions(+), 7 deletions(-)
Good idea, and I think it is in line with an earlier suggestion by Jonathan (cc'ed).
Thanks.
Show 45 quoted lines
> diff --git a/Documentation/git-for-each-ref.txt b/Documentation/git-for-each-ref.txt > index bb370c9c7..1015c88f6 100644 > --- a/Documentation/git-for-each-ref.txt > +++ b/Documentation/git-for-each-ref.txt > @@ -10,8 +10,9 @@ SYNOPSIS > [verse] > 'git for-each-ref' [--count=<count>] [--shell|--perl|--python|--tcl] > [(--sort=<key>)...] [--format=<format>] [<pattern>...] > - [--points-at <object>] [(--merged | --no-merged) [<object>]] > - [--contains [<object>]] [--no-contains [<object>]] > + [--points-at=<object>] > + (--merged[=<object>] | --no-merged[=<object>]) > + [--contains[=<object>]] [--no-contains[=<object>]] > > DESCRIPTION > ----------- > @@ -65,24 +66,24 @@ OPTIONS > the specified host language. This is meant to produce > a scriptlet that can directly be `eval`ed. > > ---points-at <object>:: > +--points-at=<object>:: > Only list refs which points at the given object. > > ---merged [<object>]:: > +--merged[=<object>]:: > Only list refs whose tips are reachable from the > specified commit (HEAD if not specified), > incompatible with `--no-merged`. > > ---no-merged [<object>]:: > +--no-merged[=<object>]:: > Only list refs whose tips are not reachable from the > specified commit (HEAD if not specified), > incompatible with `--merged`. > > ---contains [<object>]:: > +--contains[=<object>]:: > Only list refs which contain the specified commit (HEAD if not > specified). > > ---no-contains [<object>]:: > +--no-contains[=<object>]:: > Only list refs which don't contain the specified commit (HEAD > if not specified).