From: Karthik Nayak <karthik.188@gmail.com>
To: Matthieu Moy <Matthieu.Moy@grenoble-inp.fr>
Cc: Git <git@vger.kernel.org>,
Christian Couder <christian.couder@gmail.com>,
Junio C Hamano <gitster@pobox.com>
Subject: Re: [PATCH v12 12/13] tag.c: implement '--format' option
Date: Thu, 20 Aug 2015 21:20:40 +0530 [thread overview]
Message-ID: <CAOLa=ZQfEeJofxe0ei_h7efrhMVnXMQ=K+5PzZ1fRWU0us7KBA@mail.gmail.com> (raw)
In-Reply-To: <vpq614b49dk.fsf@anie.imag.fr>
On Wed, Aug 19, 2015 at 8:23 PM, Matthieu Moy
<Matthieu.Moy@grenoble-inp.fr> wrote:
> Karthik Nayak <karthik.188@gmail.com> writes:
>
>> --- a/Documentation/git-tag.txt
>> +++ b/Documentation/git-tag.txt
>> @@ -158,6 +159,18 @@ This option is only applicable when listing tags without annotation lines.
>> The object that the new tag will refer to, usually a commit.
>> Defaults to HEAD.
>>
>> +<format>::
>> + A string that interpolates `%(fieldname)` from the object
>> + pointed at by a ref being shown. If `fieldname` is prefixed
>> + with an asterisk (`*`) and the ref points at a tag object, the
>> + value for the field in the object tag refers is used. When
>> + unspecified, defaults to `%(refname:short)`. It also
>> + interpolates `%%` to `%`, and `%xx` where `xx` are hex digits
>> + interpolates to character with hex code `xx`; for example
>> + `%00` interpolates to `\0` (NUL), `%09` to `\t` (TAB) and
>> + `%0a` to `\n` (LF). The fields are same as those in `git
>> + for-each-ref`.
>> +
>
> This documentation should probably be shortened to stg like
>
> A string that interpolates `%(fieldname)` from the object
> pointed at by a ref being shown. The format is the same as the
> one of linkgit:git-for-each-ref[1]. When unspecified, defaults
> to `%(refname:short)`
>
I guess this makes sense with what you're saying below, the --format option
for tag.c is more of an extra add-on, and such a discrioption may not be needed.
Will change this.
> Alternatively, you can extract the "FIELD NAMES" section of
> git-for-each-ref.txt to a separate file and include it in the doc for
> each command having this --format option (this is how it's done for "git
> log --format" IIRC). But taking that much space to describe hexadecimal
> escapes that very few people would use and not documenting the %(atoms)
> is counter-productive IMHO.
>
I guess, It'll be better to write a document on the whole of
ref-filter. I'll probably do that
at the end of this.
> I would favor the first option (keep it short, include a pointer) with
> Junio's remark in mind: "git tag" and "git branch" are meant to be
> simple commands, and the scary swiss-army-knife should remain "git
> for-each-ref".
>
> I am still (slightly) in favor of adding --format to tag and branch, as
> long as it does not make the commands too scary.
>
Will change this, thanks for the suggestions.
--
Regards,
Karthik Nayak
next prev parent reply other threads:[~2015-08-20 15:54 UTC|newest]
Thread overview: 38+ messages / expand[flat|nested] mbox.gz Atom feed top
2015-08-18 18:37 [PATCH v12 00/13] port tag.c to use ref-filter.c APIs Karthik Nayak
2015-08-18 18:37 ` [PATCH v12 01/13] ref-filter: move `struct atom_value` to ref-filter.c Karthik Nayak
2015-08-19 14:56 ` Matthieu Moy
2015-08-19 15:29 ` Karthik Nayak
2015-08-18 18:37 ` [PATCH v12 02/13] ref-filter: introduce ref_formatting_state Karthik Nayak
2015-08-18 18:37 ` [PATCH v12 03/13] ref-filter: introduce the ref_formatting_state stack machinery Karthik Nayak
2015-08-19 14:56 ` Matthieu Moy
2015-08-19 15:39 ` Karthik Nayak
2015-08-19 15:44 ` Matthieu Moy
2015-08-19 15:54 ` Karthik Nayak
2015-08-19 16:10 ` Karthik Nayak
2015-08-20 7:29 ` Matthieu Moy
2015-08-20 10:29 ` Karthik Nayak
2015-08-20 16:47 ` Junio C Hamano
2015-08-20 17:19 ` Matthieu Moy
2015-08-20 18:29 ` Junio C Hamano
2015-08-19 18:52 ` Junio C Hamano
2015-08-20 10:31 ` Karthik Nayak
2015-08-20 16:51 ` Junio C Hamano
2015-08-18 18:37 ` [PATCH v12 04/13] utf8: add function to align a string into given strbuf Karthik Nayak
2015-08-18 18:37 ` [PATCH v12 05/13] ref-filter: implement an `align` atom Karthik Nayak
2015-08-18 19:28 ` Karthik Nayak
2015-08-20 20:23 ` Eric Sunshine
2015-08-21 1:55 ` Karthik Nayak
2015-08-18 18:37 ` [PATCH v12 06/13] ref-filter: add option to filter out tags, branches and remotes Karthik Nayak
2015-08-18 18:37 ` [PATCH v12 07/13] ref-filter: support printing N lines from tag annotation Karthik Nayak
2015-08-18 18:37 ` [PATCH v12 08/13] ref-filter: add support to sort by version Karthik Nayak
2015-08-18 18:37 ` [PATCH v12 09/13] ref-filter: add option to match literal pattern Karthik Nayak
2015-08-18 18:37 ` [PATCH v12 10/13] tag.c: use 'ref-filter' data structures Karthik Nayak
2015-08-19 14:56 ` Matthieu Moy
2015-08-19 15:51 ` Karthik Nayak
2015-08-18 18:37 ` [PATCH v12 11/13] tag.c: use 'ref-filter' APIs Karthik Nayak
2015-08-18 18:37 ` [PATCH v12 12/13] tag.c: implement '--format' option Karthik Nayak
2015-08-19 14:53 ` Matthieu Moy
2015-08-20 15:50 ` Karthik Nayak [this message]
2015-08-18 18:37 ` [PATCH v12 13/13] tag.c: implement '--merged' and '--no-merged' options Karthik Nayak
2015-08-18 19:18 ` [PATCH v12 00/13] port tag.c to use ref-filter.c APIs Eric Sunshine
2015-08-18 19:25 ` Karthik Nayak
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='CAOLa=ZQfEeJofxe0ei_h7efrhMVnXMQ=K+5PzZ1fRWU0us7KBA@mail.gmail.com' \
--to=karthik.188@gmail.com \
--cc=Matthieu.Moy@grenoble-inp.fr \
--cc=christian.couder@gmail.com \
--cc=git@vger.kernel.org \
--cc=gitster@pobox.com \
/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).