Re: [PATCH v3 3/6] for-each-ref: introduce %(HEAD) asterisk marker

From: Eric Sunshine <sunshine@sunshineco.com>
Date: Nov 16, 2013, 23:23 UTC
Message-ID: <CAPig+cRkaQAZm76tzuPMnddaZE2qaN=yOF8O9dSaB4pzbBq9ww@mail.gmail.com>
In-Reply-To: <1384513148-22633-4-git-send-email-artagnon@gmail.com>

On Fri, Nov 15, 2013 at 5:59 AM, Ramkumar Ramachandra <artagnon@gmail.com> wrote:

Show 28 quoted lines

> 'git branch' shows which branch you are currently on with an '*', but
> 'git for-each-ref' misses this feature.  So, extend its format with
> %(HEAD) for the same effect.
>
> Now you can use the following format in for-each-ref:
>
>   %(HEAD) %(refname:short)
>
> to display an asterisk next to the current ref.
>
> Signed-off-by: Ramkumar Ramachandra <artagnon@gmail.com>
> ---
>  Documentation/git-for-each-ref.txt |  4 ++++
>  builtin/for-each-ref.c             | 13 +++++++++++--
>  t/t6300-for-each-ref.sh            |  2 ++
>  3 files changed, 17 insertions(+), 2 deletions(-)
>
> diff --git a/Documentation/git-for-each-ref.txt b/Documentation/git-for-each-ref.txt
> index f2e08d1..ab3da0e 100644
> --- a/Documentation/git-for-each-ref.txt
> +++ b/Documentation/git-for-each-ref.txt
> @@ -93,6 +93,10 @@ upstream::
>         from the displayed ref. Respects `:short` in the same way as
>         `refname` above.
>
> +HEAD::
> +       Used to indicate the currently checked out branch.  Is '*' if
> +       HEAD points to the current ref, and ' ' otherwise.

"Used to" sounds like it is explaining something it did in the past. None of the other field names are described in this fashion. Perhaps something simpler along the lines of:

    Asterisk "*" if HEAD matches the current ref (the checked out branch),
    otherwise space " ".

> +
>  In addition to the above, for commit and tag objects, the header
>  field names (`tree`, `parent`, `object`, `type`, and `tag`) can
>  be used to specify the value in the header field.