From: Junio C Hamano <gitster@pobox.com>
To: santiago@nyu.edu
Cc: git@vger.kernel.org, peff@peff.net, sunshine@sunshineco.com,
walters@verbum.org, Lukas P <luk.puehringer@gmail.com>
Subject: Re: [PATCH v2 2/5] ref-filter: add function to print single ref_array_item
Date: Tue, 27 Sep 2016 10:35:59 -0700 [thread overview]
Message-ID: <xmqqfuolp7nk.fsf@gitster.mtv.corp.google.com> (raw)
In-Reply-To: <20160926224233.32702-3-santiago@nyu.edu> (santiago@nyu.edu's message of "Mon, 26 Sep 2016 18:42:30 -0400")
santiago@nyu.edu writes:
> From: Lukas P <luk.puehringer@gmail.com>
>
> ref-filter functions are useful for printing git object information
> using a format specifier. However, some other modules may not want to use
> this functionality on a ref-array but only print a single item.
>
> Expose a format_ref function to create, pretty print and free individual
> ref-items.
>
> Signed-off-by: Lukas P <luk.puehringer@gmail.com>
> ---
> +void format_ref(const char *name, const unsigned char *sha1, const char *format,
> + unsigned kind)
> +{
> + struct ref_array_item *ref_item;
> + ref_item = new_ref_array_item(name, sha1, 0);
> + ref_item->kind = kind;
> + show_ref_array_item(ref_item, format, 0);
> + free_array_item(ref_item);
> +}
> +
> /* If no sorting option is given, use refname to sort as default */
> struct ref_sorting *ref_default_sorting(void)
> {
> diff --git a/ref-filter.h b/ref-filter.h
> index 14d435e..1ef7999 100644
> --- a/ref-filter.h
> +++ b/ref-filter.h
> @@ -107,4 +107,8 @@ struct ref_sorting *ref_default_sorting(void);
> /* Function to parse --merged and --no-merged options */
> int parse_opt_merge_filter(const struct option *opt, const char *arg, int unset);
>
> +/* Pretty-print a single ref */
> +void format_ref(const char *name, const unsigned char *sha1, const char *format,
> + unsigned kind);
The fact that you felt a need for comment before its name is a
strong sign that the name is not sufficiently descriptive and
understandable for readers to tell what the function is for.
Would pretty_print_ref() or show_ref_pretty() better names, perhaps?
next prev parent reply other threads:[~2016-09-27 17:36 UTC|newest]
Thread overview: 17+ messages / expand[flat|nested] mbox.gz Atom feed top
2016-09-26 22:42 [PATCH v2 0/5] Add --format to tag verification santiago
2016-09-26 22:42 ` [PATCH v2 1/5] gpg-interface, tag: add GPG_VERIFY_QUIET flag santiago
2016-09-27 17:36 ` Junio C Hamano
2016-09-27 18:17 ` Lukas Pühringer
2016-09-27 18:22 ` Junio C Hamano
2016-09-27 18:25 ` Lukas Pühringer
2016-09-27 18:31 ` Stefan Beller
2016-09-27 18:37 ` Lukas Pühringer
2016-09-26 22:42 ` [PATCH v2 2/5] ref-filter: add function to print single ref_array_item santiago
2016-09-27 17:35 ` Junio C Hamano [this message]
2016-09-26 22:42 ` [PATCH v2 3/5] tag: add format specifier to gpg_verify_tag santiago
2016-09-26 22:42 ` [PATCH v2 4/5] builtin/verify-tag: add --format to verify-tag santiago
2016-09-27 7:44 ` Philip Oakley
2016-09-27 14:38 ` Santiago Torres
2016-09-27 17:41 ` Junio C Hamano
2016-09-26 22:42 ` [PATCH v2 5/5] builtin/tag: add --format argument for tag -v santiago
2016-09-27 17:50 ` Junio C Hamano
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=xmqqfuolp7nk.fsf@gitster.mtv.corp.google.com \
--to=gitster@pobox.com \
--cc=git@vger.kernel.org \
--cc=luk.puehringer@gmail.com \
--cc=peff@peff.net \
--cc=santiago@nyu.edu \
--cc=sunshine@sunshineco.com \
--cc=walters@verbum.org \
/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).