From: Jeff King <peff@peff•net>
To: Junio C Hamano <gitster@pobox•com>
Cc: Michael Haggerty <mhagger@alum•mit.edu>,
Stefan Beller <sbeller@google•com>,
git@vger•kernel.org
Subject: Re: [PATCH v2 12/12] refs: move the remaining ref module declarations to refs.h
Date: Mon, 15 Jun 2015 14:35:05 -0400 [thread overview]
Message-ID: <20150615183504.GB4041@peff.net> (raw)
In-Reply-To: <xmqqfv5salh9.fsf@gitster.dls.corp.google.com>
On Mon, Jun 15, 2015 at 11:13:22AM -0700, Junio C Hamano wrote:
> > @@ -78,15 +170,15 @@ typedef int each_ref_fn(const char *refname,
> > * modifies the reference also returns a nonzero value to immediately
> > * stop the iteration.
> > */
> > -extern int head_ref(each_ref_fn, void *);
> > +extern int head_ref(each_ref_fn fn, void *cb_data);
>
> For example, between these two, what did we gain?
>
> Because of their types, it already was clear what the two parameters
> are in the original, without noisewords like "fn" (which obviously
> stands for a "function", but that is clear due to "each_ref_fn").
I think the real benefit of naming parameters is that you can talk about
"fn" and "cb_data" by name in the docstring[1]. Of course we do not do
that here, so we could clearly wait until "if-and-when" we do so. But I
do not think it is a big deal for our style guide to say "we always name
parameters in declarations", and to bring things in line there (though
perhaps it should be a separate patch in that case).
[1] For instance, in the docstring here, which is just outside the
context, we use the awkward phrase "the specified callback
function". That would be much simpler as just `fn`, though having so
few parameters to these functions, it is fairly clear already.
> > -extern int for_each_glob_ref_in(each_ref_fn, const char *pattern, const char* prefix, void *);
> > +extern int for_each_glob_ref_in(each_ref_fn fn, const char *pattern, const char* prefix, void *cb_data);
>
> Likewise for addition of fn and cb_data.
>
> If you really want to make unrelated changes to this file, what you
> should fix is to update "const char* prefix" to "const char *prefix"
> ;-)
IMHO they are in the same boat (style fixes), and I would be happy to
see both improved. :)
-Peff
next prev parent reply other threads:[~2015-06-15 18:35 UTC|newest]
Thread overview: 30+ messages / expand[flat|nested] mbox.gz Atom feed top
2015-06-13 14:42 [PATCH v2 00/12] Improve "refs" module encapsulation Michael Haggerty
2015-06-13 14:42 ` [PATCH v2 01/12] delete_ref(): move declaration to refs.h Michael Haggerty
2015-06-13 14:42 ` [PATCH v2 02/12] remove_branches(): remove temporary Michael Haggerty
2015-06-13 14:42 ` [PATCH v2 03/12] delete_ref(): handle special case more explicitly Michael Haggerty
2015-06-15 18:22 ` Junio C Hamano
2015-06-13 14:42 ` [PATCH v2 04/12] delete_refs(): new function for the refs API Michael Haggerty
2015-06-13 14:42 ` [PATCH v2 05/12] delete_refs(): improve error message Michael Haggerty
2015-06-15 18:29 ` Junio C Hamano
2015-06-19 14:20 ` Michael Haggerty
2015-06-13 14:42 ` [PATCH v2 06/12] prune_remote(): use delete_refs() Michael Haggerty
2015-06-15 18:35 ` Junio C Hamano
2015-06-15 18:39 ` Jeff King
2015-06-15 19:45 ` Junio C Hamano
2015-06-13 14:42 ` [PATCH v2 07/12] repack_without_refs(): make function private Michael Haggerty
2015-06-13 14:42 ` [PATCH v2 08/12] initial_ref_transaction_commit(): function for initial ref creation Michael Haggerty
2015-06-15 18:04 ` Junio C Hamano
2015-06-15 18:39 ` Junio C Hamano
2015-06-15 18:57 ` Jeff King
2015-06-15 18:53 ` Junio C Hamano
2015-06-20 2:15 ` Michael Haggerty
2015-06-13 14:42 ` [PATCH v2 09/12] refs: remove some functions from the module's public interface Michael Haggerty
2015-06-13 14:42 ` [PATCH v2 10/12] initial_ref_transaction_commit(): check for duplicate refs Michael Haggerty
2015-06-13 14:42 ` [PATCH v2 11/12] initial_ref_transaction_commit(): check for ref D/F conflicts Michael Haggerty
2015-06-13 14:42 ` [PATCH v2 12/12] refs: move the remaining ref module declarations to refs.h Michael Haggerty
2015-06-15 18:13 ` Junio C Hamano
2015-06-15 18:35 ` Jeff King [this message]
2015-06-15 19:48 ` Junio C Hamano
2015-06-20 1:53 ` Michael Haggerty
2015-06-20 3:30 ` Junio C Hamano
2015-06-15 5:20 ` [PATCH v2 00/12] Improve "refs" module encapsulation Stefan Beller
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=20150615183504.GB4041@peff.net \
--to=peff@peff$(echo .)net \
--cc=git@vger$(echo .)kernel.org \
--cc=gitster@pobox$(echo .)com \
--cc=mhagger@alum$(echo .)mit.edu \
--cc=sbeller@google$(echo .)com \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox