All of lore.kernel.org
 help / color / mirror / Atom feed
From: Junio C Hamano <gitster@pobox.com>
To: Kevin Daudt <me@ikke.info>
Cc: git@vger.kernel.org, Jonathan Nieder <jrnieder@gmail.com>
Subject: Re: [PATCH v2 1/2] doc/for-each-ref: consistently use '=' to between argument names and values
Date: Tue, 12 Sep 2017 11:28:00 +0900	[thread overview]
Message-ID: <xmqq8thk3b2n.fsf@gitster.mtv.corp.google.com> (raw)
In-Reply-To: <20170911193338.25985-1-me@ikke.info> (Kevin Daudt's message of "Mon, 11 Sep 2017 21:33:37 +0200")

Kevin Daudt <me@ikke.info> writes:

> 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.

> 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).

  parent reply	other threads:[~2017-09-12  2:28 UTC|newest]

Thread overview: 9+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2017-09-01 14:49 [PATCH] doc/for-each-ref: explicitly specify option names Kevin Daudt
2017-09-01 22:03 ` Jeff King
2017-09-01 23:03 ` Johannes Schindelin
2017-09-01 23:19 ` Jonathan Nieder
2017-09-02  2:03 ` Junio C Hamano
2017-09-11 19:33 ` [PATCH v2 1/2] doc/for-each-ref: consistently use '=' to between argument names and values Kevin Daudt
2017-09-11 19:33   ` [PATCH v2 2/2] doc/for-each-ref: explicitly specify option names Kevin Daudt
2017-09-12  2:28   ` Junio C Hamano [this message]
2017-09-12  4:38     ` [PATCH v2 1/2] doc/for-each-ref: consistently use '=' to between argument names and values Kevin Daudt

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=xmqq8thk3b2n.fsf@gitster.mtv.corp.google.com \
    --to=gitster@pobox.com \
    --cc=git@vger.kernel.org \
    --cc=jrnieder@gmail.com \
    --cc=me@ikke.info \
    /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. 
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.