From: Michael Haggerty <mhagger@alum.mit.edu>
To: Stefan Beller <sbeller@google.com>
Cc: "Junio C Hamano" <gitster@pobox.com>,
"Nguyễn Thái Ngọc Duy" <pclouds@gmail.com>,
"Johannes Schindelin" <Johannes.Schindelin@gmx.de>,
"David Turner" <novalis@novalis.org>,
"git@vger.kernel.org" <git@vger.kernel.org>
Subject: Re: [PATCH 3/5] register_ref_store(): new function
Date: Thu, 9 Feb 2017 19:14:02 +0100 [thread overview]
Message-ID: <61f100b7-a663-512c-762f-3293a1c56711@alum.mit.edu> (raw)
In-Reply-To: <CAGZ79kYrqfmNGE0A63iYaW=MSFwANRXnn3kkxHE8kpOtF2KeLA@mail.gmail.com>
On 02/09/2017 06:20 PM, Stefan Beller wrote:
> On Thu, Feb 9, 2017 at 5:27 AM, Michael Haggerty <mhagger@alum.mit.edu> wrote:
>> Move the responsibility for registering the ref_store for a submodule
>> from base_ref_store_init() to a new function, register_ref_store(). Call
>> the latter from ref_store_init().
>>
>> This means that base_ref_store_init() can lose its submodule argument,
>> further weakening the 1:1 relationship between ref_stores and
>> submodules.
>>
>> Signed-off-by: Michael Haggerty <mhagger@alum.mit.edu>
>> ---
>
>
>
>
>> +
>> struct ref_store *ref_store_init(const char *submodule)
>> {
>> const char *be_name = "files";
>> struct ref_storage_be *be = find_ref_storage_backend(be_name);
>> + struct ref_store *refs;
>>
>> if (!be)
>> die("BUG: reference backend %s is unknown", be_name);
>>
>> if (!submodule || !*submodule)
>> - return be->init(NULL);
>> + refs = be->init(NULL);
>> else
>> - return be->init(submodule);
>> + refs = be->init(submodule);
>> +
>> + register_ref_store(refs, submodule);
>> + return refs;
>> }
>
> This function is already very readable, though maybe it would be
> more readable like so:
>
> {
> const char *be_name = "files";
> struct ref_storage_be *be = find_ref_storage_backend(be_name);
>
> if (!be)
> die("BUG: reference backend %s is unknown", be_name);
>
> /* replace empty string by NULL */
> if (submodule && !*submodule)
> submodule = NULL;
>
> register_ref_store(be->init(submodule), submodule);
> return refs;
> }
>
> Well, I dunno; the function inside the arguments to register seems ugly, though.
Nit: you forgot to define and initialize `refs` (for returning to the
caller).
Actually, there is an inconsistency between the docstring for this
function and its behavior. The docstring claims that it can handle
`submodule == ""`, and it tries to do so, but incorrectly. The problem
is that it passes an un-cleaned-up `submodule` to
`register_ref_store()`, which is expecting a cleaned-up one.
But this function is only called by get_ref_store(), which has already
arranged for the empty string to be passed along as NULL.
In fact, the only external entry point into these functions is
`get_ref_store()`. I think what I should do is make the other functions
private, and remove their attempts to handle `submodule == ""`. I'll fix
this up in a re-roll.
(I wonder whether anybody really passes the empty string into this
method. It never happens in the test suite. I doubt I can muster the
energy to audit all of the call paths.)
Michael
next prev parent reply other threads:[~2017-02-09 18:17 UTC|newest]
Thread overview: 28+ messages / expand[flat|nested] mbox.gz Atom feed top
2017-02-09 13:26 [PATCH 0/5] Store submodules in a hash, not a linked list Michael Haggerty
2017-02-09 13:26 ` [PATCH 1/5] refs: store submodule ref stores in a hashmap Michael Haggerty
2017-02-09 16:58 ` Stefan Beller
2017-02-09 17:40 ` Michael Haggerty
2017-02-09 17:43 ` Stefan Beller
2017-02-09 19:32 ` Jeff King
2017-02-09 20:34 ` Junio C Hamano
2017-02-10 4:04 ` Jeff King
2017-02-10 10:23 ` Michael Haggerty
2017-02-09 13:26 ` [PATCH 2/5] refs: push the submodule attribute down Michael Haggerty
2017-02-09 17:03 ` Stefan Beller
2017-02-09 21:07 ` Junio C Hamano
2017-02-09 13:27 ` [PATCH 3/5] register_ref_store(): new function Michael Haggerty
2017-02-09 17:20 ` Stefan Beller
2017-02-09 18:14 ` Michael Haggerty [this message]
2017-02-09 21:16 ` Junio C Hamano
2017-02-09 13:27 ` [PATCH 4/5] files_ref_store::submodule: use NULL for the main repository Michael Haggerty
2017-02-09 17:25 ` Stefan Beller
2017-02-09 21:19 ` Junio C Hamano
2017-02-09 21:36 ` Stefan Beller
2017-02-09 13:27 ` [PATCH 5/5] read_loose_refs(): read refs using resolve_ref_recursively() Michael Haggerty
2017-02-09 17:39 ` Stefan Beller
2017-02-09 19:48 ` [PATCH 0/5] Store submodules in a hash, not a linked list Junio C Hamano
2017-02-09 19:58 ` Jeff King
2017-02-09 21:23 ` Michael Haggerty
2017-02-10 0:40 ` Jeff King
2017-02-10 10:27 ` Michael Haggerty
2017-02-13 2:39 ` Duy Nguyen
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=61f100b7-a663-512c-762f-3293a1c56711@alum.mit.edu \
--to=mhagger@alum.mit.edu \
--cc=Johannes.Schindelin@gmx.de \
--cc=git@vger.kernel.org \
--cc=gitster@pobox.com \
--cc=novalis@novalis.org \
--cc=pclouds@gmail.com \
--cc=sbeller@google.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).