| Message ID | patch-v2-2.4-3d7bd9c33be-20210823T110136Z-avarab@gmail.com (mailing list archive) |
|---|---|
| State | Superseded |
| Headers | show |
| Series | bundle: show progress on "unbundle" | expand |
On 8/23/2021 7:02 AM, Ævar Arnfjörð Bjarmason wrote: ... > --- a/builtin/bundle.c > +++ b/builtin/bundle.c > @@ -165,7 +165,8 @@ static int cmd_bundle_unbundle(int argc, const char **argv, const char *prefix) > struct option options[] = { > OPT_END() > }; > - char *bundle_file; > + char* bundle_file; nit: errant movement of "*" here. > + struct strvec extra_args = STRVEC_INIT; ... > - ret = !!unbundle(the_repository, &header, bundle_fd, 0) || > + ret = !!unbundle(the_repository, &header, bundle_fd, &extra_args) || I'm assuming that you will be adding something that adds to extra_args in a future commit. It might be better to just convert the "0" to "NULL" here and add extra_args when you actually use it. > int unbundle(struct repository *r, struct bundle_header *header, > - int bundle_fd, int flags) > + int bundle_fd, struct strvec *extra_index_pack_args) > { > - const char *argv_index_pack[] = {"index-pack", > - "--fix-thin", "--stdin", NULL, NULL}; > struct child_process ip = CHILD_PROCESS_INIT; > + int i; > > - if (flags & BUNDLE_VERBOSE) > - argv_index_pack[3] = "-v"; > + strvec_push(&ip.args, "index-pack"); > + strvec_push(&ip.args, "--fix-thin"); > + strvec_push(&ip.args, "--stdin"); > + if (extra_index_pack_args) { > + struct strvec *extra = extra_index_pack_args; Creating a shorter variable name seems unnecessary. > + for (i = 0; i < extra->nr; i++) > + strvec_push(&ip.args, extra->v[i]); This seems like a good opportunity to create and use a strvec_concat() method. > + strvec_clear(extra_index_pack_args); Why is it the responsibility of this method to clear these args? I suppose it is convenient. It just seems a bit wrong to me. > /** > * Unbundle after reading the header with read_bundle_header(). > * > * We'll invoke "git index-pack --stdin --fix-thin" for you on the > * provided `bundle_fd` from read_bundle_header(). > + * > + * Provide extra_index_pack_args to pass any extra arguments > + * (e.g. "-v" for verbose/progress), NULL otherwise. The provided > + * extra_index_pack_args (if any) will be strvec_clear()'d for you > + * (like the run-command.h API itself does). > */ > int unbundle(struct repository *r, struct bundle_header *header, > - int bundle_fd, int flags); > + int bundle_fd, struct strvec *extra_index_pack_args); > int list_bundle_refs(struct bundle_header *header, > int argc, const char **argv); > > diff --git a/transport.c b/transport.c > index 17e9629710a..8bc4b5fcd3c 100644 > --- a/transport.c > +++ b/transport.c > @@ -162,12 +162,15 @@ static int fetch_refs_from_bundle(struct transport *transport, > int nr_heads, struct ref **to_fetch) > { > struct bundle_transport_data *data = transport->data; > + struct strvec extra_index_pack_args = STRVEC_INIT; > int ret; > > + strvec_push(&extra_index_pack_args, "-v"); > + > if (!data->get_refs_from_bundle_called) > get_refs_from_bundle(transport, 0, NULL); > ret = unbundle(the_repository, &data->header, data->fd, > - transport->progress ? BUNDLE_VERBOSE : 0); Previously, this was conditioned on 'transport->progress', but above you unconditionally add the "-v" option. Seems like a bug. > + &extra_index_pack_args); Thanks, -Stolee
On Tue, Aug 24 2021, Derrick Stolee wrote: > On 8/23/2021 7:02 AM, Ævar Arnfjörð Bjarmason wrote: > ... >> --- a/builtin/bundle.c >> +++ b/builtin/bundle.c >> @@ -165,7 +165,8 @@ static int cmd_bundle_unbundle(int argc, const char **argv, const char *prefix) >> struct option options[] = { >> OPT_END() >> }; >> - char *bundle_file; >> + char* bundle_file; > > nit: errant movement of "*" here. Ah, thanks. >> + struct strvec extra_args = STRVEC_INIT; > ... >> - ret = !!unbundle(the_repository, &header, bundle_fd, 0) || >> + ret = !!unbundle(the_repository, &header, bundle_fd, &extra_args) || > > I'm assuming that you will be adding something that adds to extra_args > in a future commit. It might be better to just convert the "0" to "NULL" > here and add extra_args when you actually use it. *nod*, commented on in the later commit. >> int unbundle(struct repository *r, struct bundle_header *header, >> - int bundle_fd, int flags) >> + int bundle_fd, struct strvec *extra_index_pack_args) >> { >> - const char *argv_index_pack[] = {"index-pack", >> - "--fix-thin", "--stdin", NULL, NULL}; >> struct child_process ip = CHILD_PROCESS_INIT; >> + int i; >> >> - if (flags & BUNDLE_VERBOSE) >> - argv_index_pack[3] = "-v"; >> + strvec_push(&ip.args, "index-pack"); >> + strvec_push(&ip.args, "--fix-thin"); >> + strvec_push(&ip.args, "--stdin"); >> + if (extra_index_pack_args) { >> + struct strvec *extra = extra_index_pack_args; > > Creating a shorter variable name seems unnecessary. Will skip it. >> + for (i = 0; i < extra->nr; i++) >> + strvec_push(&ip.args, extra->v[i]); > > This seems like a good opportunity to create and use a > strvec_concat() method. Yeah, I guess I could start with that. Will try it. >> + strvec_clear(extra_index_pack_args); > > Why is it the responsibility of this method to clear these args? > I suppose it is convenient. It just seems a bit wrong to me. Because of... >> /** >> * Unbundle after reading the header with read_bundle_header(). >> * >> * We'll invoke "git index-pack --stdin --fix-thin" for you on the >> * provided `bundle_fd` from read_bundle_header(). >> + * >> + * Provide extra_index_pack_args to pass any extra arguments >> + * (e.g. "-v" for verbose/progress), NULL otherwise. The provided >> + * extra_index_pack_args (if any) will be strvec_clear()'d for you >> + * (like the run-command.h API itself does). ... this, i.e. it's how the run-command.[ch] API already works for the same sort of thing elsewhere, I figured making them consistent was better than having them differ. I think that while in general the rule of having each function allocate & clear its own memory is a good one, that a notable good exception in our codebase is various "one-shot" functions such as the run-command API, i.e. APIs where the vast majority of callers just want to set things up for a one-off run. Having those common cases not require a that_api_release(&ctx) afterwards seems like a good idea in general. >> */ >> int unbundle(struct repository *r, struct bundle_header *header, >> - int bundle_fd, int flags); >> + int bundle_fd, struct strvec *extra_index_pack_args); >> int list_bundle_refs(struct bundle_header *header, >> int argc, const char **argv); >> >> diff --git a/transport.c b/transport.c >> index 17e9629710a..8bc4b5fcd3c 100644 >> --- a/transport.c >> +++ b/transport.c >> @@ -162,12 +162,15 @@ static int fetch_refs_from_bundle(struct transport *transport, >> int nr_heads, struct ref **to_fetch) >> { >> struct bundle_transport_data *data = transport->data; >> + struct strvec extra_index_pack_args = STRVEC_INIT; >> int ret; >> >> + strvec_push(&extra_index_pack_args, "-v"); >> + >> if (!data->get_refs_from_bundle_called) >> get_refs_from_bundle(transport, 0, NULL); >> ret = unbundle(the_repository, &data->header, data->fd, >> - transport->progress ? BUNDLE_VERBOSE : 0); > > Previously, this was conditioned on 'transport->progress', but above > you unconditionally add the "-v" option. Seems like a bug. Yes! Oops. Will fix. Thanks.
On 8/24/2021 5:41 PM, Ævar Arnfjörð Bjarmason wrote: > > On Tue, Aug 24 2021, Derrick Stolee wrote: > >> On 8/23/2021 7:02 AM, Ævar Arnfjörð Bjarmason wrote: >>> + strvec_clear(extra_index_pack_args); >> >> Why is it the responsibility of this method to clear these args? >> I suppose it is convenient. It just seems a bit wrong to me. > > Because of... > >>> /** >>> * Unbundle after reading the header with read_bundle_header(). >>> * >>> * We'll invoke "git index-pack --stdin --fix-thin" for you on the >>> * provided `bundle_fd` from read_bundle_header(). >>> + * >>> + * Provide extra_index_pack_args to pass any extra arguments >>> + * (e.g. "-v" for verbose/progress), NULL otherwise. The provided >>> + * extra_index_pack_args (if any) will be strvec_clear()'d for you >>> + * (like the run-command.h API itself does). > > ... this, i.e. it's how the run-command.[ch] API already works for the > same sort of thing elsewhere, I figured making them consistent was > better than having them differ. > > I think that while in general the rule of having each function allocate > & clear its own memory is a good one, that a notable good exception in > our codebase is various "one-shot" functions such as the run-command > API, i.e. APIs where the vast majority of callers just want to set > things up for a one-off run. Having those common cases not require a > that_api_release(&ctx) afterwards seems like a good idea in general. Makes sense to me. Thanks for explaining it. -Stolee
diff --git a/builtin/bundle.c b/builtin/bundle.c index 053a51bea1b..10f6f45770a 100644 --- a/builtin/bundle.c +++ b/builtin/bundle.c @@ -165,7 +165,8 @@ static int cmd_bundle_unbundle(int argc, const char **argv, const char *prefix) struct option options[] = { OPT_END() }; - char *bundle_file; + char* bundle_file; + struct strvec extra_args = STRVEC_INIT; argc = parse_options_cmd_bundle(argc, argv, prefix, builtin_bundle_unbundle_usage, options, &bundle_file); @@ -177,7 +178,7 @@ static int cmd_bundle_unbundle(int argc, const char **argv, const char *prefix) } if (!startup_info->have_repository) die(_("Need a repository to unbundle.")); - ret = !!unbundle(the_repository, &header, bundle_fd, 0) || + ret = !!unbundle(the_repository, &header, bundle_fd, &extra_args) || list_bundle_refs(&header, argc, argv); bundle_header_release(&header); cleanup: diff --git a/bundle.c b/bundle.c index ab63f402261..16d7e7f86f8 100644 --- a/bundle.c +++ b/bundle.c @@ -569,18 +569,23 @@ int create_bundle(struct repository *r, const char *path, } int unbundle(struct repository *r, struct bundle_header *header, - int bundle_fd, int flags) + int bundle_fd, struct strvec *extra_index_pack_args) { - const char *argv_index_pack[] = {"index-pack", - "--fix-thin", "--stdin", NULL, NULL}; struct child_process ip = CHILD_PROCESS_INIT; + int i; - if (flags & BUNDLE_VERBOSE) - argv_index_pack[3] = "-v"; + strvec_push(&ip.args, "index-pack"); + strvec_push(&ip.args, "--fix-thin"); + strvec_push(&ip.args, "--stdin"); + if (extra_index_pack_args) { + struct strvec *extra = extra_index_pack_args; + for (i = 0; i < extra->nr; i++) + strvec_push(&ip.args, extra->v[i]); + strvec_clear(extra_index_pack_args); + } if (verify_bundle(r, header, 0)) return -1; - ip.argv = argv_index_pack; ip.in = bundle_fd; ip.no_stdout = 1; ip.git_cmd = 1; diff --git a/bundle.h b/bundle.h index 84a6df1b65d..d47a7a3c69c 100644 --- a/bundle.h +++ b/bundle.h @@ -26,16 +26,20 @@ int create_bundle(struct repository *r, const char *path, int argc, const char **argv, struct strvec *pack_options, int version); int verify_bundle(struct repository *r, struct bundle_header *header, int verbose); -#define BUNDLE_VERBOSE 1 /** * Unbundle after reading the header with read_bundle_header(). * * We'll invoke "git index-pack --stdin --fix-thin" for you on the * provided `bundle_fd` from read_bundle_header(). + * + * Provide extra_index_pack_args to pass any extra arguments + * (e.g. "-v" for verbose/progress), NULL otherwise. The provided + * extra_index_pack_args (if any) will be strvec_clear()'d for you + * (like the run-command.h API itself does). */ int unbundle(struct repository *r, struct bundle_header *header, - int bundle_fd, int flags); + int bundle_fd, struct strvec *extra_index_pack_args); int list_bundle_refs(struct bundle_header *header, int argc, const char **argv); diff --git a/transport.c b/transport.c index 17e9629710a..8bc4b5fcd3c 100644 --- a/transport.c +++ b/transport.c @@ -162,12 +162,15 @@ static int fetch_refs_from_bundle(struct transport *transport, int nr_heads, struct ref **to_fetch) { struct bundle_transport_data *data = transport->data; + struct strvec extra_index_pack_args = STRVEC_INIT; int ret; + strvec_push(&extra_index_pack_args, "-v"); + if (!data->get_refs_from_bundle_called) get_refs_from_bundle(transport, 0, NULL); ret = unbundle(the_repository, &data->header, data->fd, - transport->progress ? BUNDLE_VERBOSE : 0); + &extra_index_pack_args); transport->hash_algo = data->header.hash_algo; return ret; }
Since the "flags" parameter was added in be042aff24c (Teach progress eye-candy to fetch_refs_from_bundle(), 2011-09-18) there's never been more than the one flag: BUNDLE_VERBOSE. Let's have the only caller who cares about that pass "-v" itself instead through new "extra_index_pack_args" parameter. The flexibility of being able to pass arbitrary arguments to "unbundle" will be used in a subsequent commit. We could pass NULL explicitly in cmd_bundle_unbundle(), but let's instead initialize an empty strvec and pass it, in anticipation of a subsequent commit wanting to add arguments to it. Signed-off-by: Ævar Arnfjörð Bjarmason <avarab@gmail.com> --- builtin/bundle.c | 5 +++-- bundle.c | 17 +++++++++++------ bundle.h | 8 ++++++-- transport.c | 5 ++++- 4 files changed, 24 insertions(+), 11 deletions(-)