[GSoC][PATCH 04/13] submodule: port submodule subcommand 'status' from shell to C
This aims to make git-submodule 'status' a built-in. Hence, the function cmd_status() is ported from shell to C. This is done by introducing three functions: module_status(), submodule_status() and print_status(). The function module_status() acts as the front-end of the subcommand. It parses subcommand's options and then calls the function module_list_compute() for computing the list of submodules. Then this functions calls for_each_submodule_list() looping through the list obtained. Then for_each_submodule_list() calls submodule_status() for each of the submodule in its list. The function submodule_status() is responsible for generating the status each submodule it is called for, and then calls print_status(). Finally, the function print_status() handles the printing of submodule's status. Mentored-by: Christian CouderMentored-by: Stefan Beller Signed-off-by: Prathamesh Chavan --- builtin/submodule--helper.c | 156 git-submodule.sh| 49 +- 2 files changed, 157 insertions(+), 48 deletions(-) diff --git a/builtin/submodule--helper.c b/builtin/submodule--helper.c index 421eee1e2..1bf7bb2a2 100644 --- a/builtin/submodule--helper.c +++ b/builtin/submodule--helper.c @@ -560,6 +560,161 @@ static int module_init(int argc, const char **argv, const char *prefix) return 0; } +struct status_cb { + const char *prefix; + unsigned int quiet: 1; + unsigned int recursive: 1; + unsigned int cached: 1; +}; +#define STATUS_CB_INIT { NULL, 0, 0, 0 } + +static void print_status(struct status_cb *info, char state, const char *path, +const struct object_id *oid, const char *displaypath) +{ + if (info->quiet) + return; + + printf("%c%s %s", state, oid_to_hex(oid), displaypath); + + if (state == ' ' || state == '+') { + struct argv_array name_rev_args = ARGV_ARRAY_INIT; + + argv_array_pushl(_rev_args, "print-name-rev", +path, oid_to_hex(oid), NULL); + print_name_rev(name_rev_args.argc, name_rev_args.argv, + info->prefix); + + argv_array_clear(_rev_args); + } else { + printf("\n"); + } +} + +static int handle_submodule_head_ref(const char *refname, +const struct object_id *oid, int flags, +void *cb_data) +{ + struct object_id *output = cb_data; + if (oid) + oidcpy(output, oid); + + return 0; +} + +static void status_submodule(const struct cache_entry *list_item, void *cb_data) +{ + struct status_cb *info = cb_data; + char *displaypath; + struct argv_array diff_files_args = ARGV_ARRAY_INIT; + + if (!submodule_from_path(null_sha1, list_item->name)) + die(_("no submodule mapping found in .gitmodules for path '%s'"), + list_item->name); + + displaypath = get_submodule_displaypath(list_item->name, info->prefix); + + if (list_item->ce_flags) { + print_status(info, 'U', list_item->name, +_oid, displaypath); + goto cleanup; + } + + if (!is_submodule_active(the_repository, list_item->name)) { + print_status(info, '-', list_item->name, _item->oid, +displaypath); + goto cleanup; + } + + argv_array_pushl(_files_args, "diff-files", +"--ignore-submodules=dirty", "--quiet", "--", +list_item->name, NULL); + + if (!cmd_diff_files(diff_files_args.argc, diff_files_args.argv, + info->prefix)) { + print_status(info, ' ', list_item->name, _item->oid, +displaypath); + } else { + if (!info->cached) { + struct object_id oid; + + if (head_ref_submodule(list_item->name, + handle_submodule_head_ref, )) + die(_("could not resolve HEAD ref inside the" + "submodule '%s'"), list_item->name); + + print_status(info, '+', list_item->name, , +displaypath); + } else { + print_status(info, '+', list_item->name, +_item->oid, displaypath); + } + } + + if (info->recursive) { + struct child_process cpr = CHILD_PROCESS_INIT; + + cpr.git_cmd = 1; + cpr.dir = list_item->name; + prepare_submodule_repo_env(_array); + + argv_array_pushl(, "--super-prefix", displaypath, +
Re: [GSoC][PATCH 04/13] submodule: port submodule subcommand 'status' from shell to C
On Tue, Aug 1, 2017 at 2:42 AM, Stefan Bellerwrote: > On Mon, Jul 31, 2017 at 1:56 PM, Prathamesh Chavan wrote: >> This aims to make git-submodule 'status' a built-in. Hence, the function >> cmd_status() is ported from shell to C. This is done by introducing >> three functions: module_status(), submodule_status() and print_status(). >> >> The function module_status() acts as the front-end of the subcommand. >> It parses subcommand's options and then calls the function >> module_list_compute() for computing the list of submodules. Then >> this functions calls for_each_submodule_list() looping through the >> list obtained. >> >> Then for_each_submodule_list() calls submodule_status() for each of the >> submodule in its list. The function submodule_status() is responsible >> for generating the status each submodule it is called for, and >> then calls print_status(). >> >> Finally, the function print_status() handles the printing of submodule's >> status. >> >> Mentored-by: Christian Couder >> Mentored-by: Stefan Beller >> Signed-off-by: Prathamesh Chavan >> --- >> In this new version, the following changes have been made: >> * parameters passed to the function print_status() have been changed. >> Instead of passing char *sub_sha1, instead the object_id is being passed. >> >> * Also, since the passed parameter displaypath's value isn't changed >> by the function, it is passed to the funcition as const char *displaypath >> instead of char *displaypath. >> >> * the output type of the function handle_submodule_head_ref() is changed >> from strbuf to object_id, as we will use the object_id instead of the >> hex of sha1 being stored in a struct strbuf. >> >> * diff_files_args is cleared after using it by passing it as args in the >> function cmd_diff_files. >> >> * In the function status_submodule(), for checking if a submodule has merge >> conflicts, the patch currently checks if the value of any of the ce_flags >> is non-zero. Currently, I think the we aren't interested in a partiular >> flag, >> but I'm not sure on this. >> >> * Debugging leftovers and suprious new-lines are removed. >> >> * The confusion with displaypath being passed as te super-prefix in many >> of the ported subcommands may be a result of the fact that the >> function generating the displaypath: get_submodule_displaypath() >> uses the super-prefix as simply a path concatenated with the current >> submodule name to denote our current location. >> The function get_super_prefix() is declared in cache.h and defined in >> environment.c, but is majorly used in the builtin/submodule--helper.c >> and also in unpack-trees.c >> Also, for generating any submodule's displaypath, it would be important to >> have ".." passed to the submodule, and currently it is possible only via >> the >> super-prefix. >> This is also other instaces where the super-prefix contained ".." as well. >> One of such instance is Test 4 from t7406-submodule-update.sh >> Hence, maybe documenting the value of displaypath might a solution >> for the above problem. >> I'm just stating my views and would like to recieve your opinion on this >> matter. > > Yes, I agree that the display path is not quite easily understood as it can be > ambiguous. I am confused by this paragraph: > * does test 4 from 7406 fail here, or was it just the starting point > of the discussion and it all works fine? Sorry for misleading there. In the discussion earlier, Brandon mentioned that displaypath's value may contain ".." as well. To this, I replied pointing out one of the test which checks for the value of displaypath. In this test, ( Test 4 from t7406-submodule-update.sh), the value of displaypath is being calculated via the submodule_init() function present in submodule--helper.c Here, I wanted to point out that, even in the case of this function, the variable displaypath is evaluated after receiving the value of "../super/" as the value returned by the function get_super_prefix(). Hence, to correct this confusion about the usage of super-prefix, (which as pointed out by Brandon has been traditionally defined as the path from the root of the superproject down to the root of the submodule which further means that there should not ever be any relative '..'s.), we may either have to get the value of super-prefix's Documentation to accomodate this change, and to accept the way it is used in submodule--helper and the current patch series, or else, change the way it is being used in the various function, and used another method for evaluation of displaypath. Thanks, Prathamesh Chavan
Re: [GSoC][PATCH 04/13] submodule: port submodule subcommand 'status' from shell to C
On Mon, Jul 31, 2017 at 1:56 PM, Prathamesh Chavanwrote: > This aims to make git-submodule 'status' a built-in. Hence, the function > cmd_status() is ported from shell to C. This is done by introducing > three functions: module_status(), submodule_status() and print_status(). > > The function module_status() acts as the front-end of the subcommand. > It parses subcommand's options and then calls the function > module_list_compute() for computing the list of submodules. Then > this functions calls for_each_submodule_list() looping through the > list obtained. > > Then for_each_submodule_list() calls submodule_status() for each of the > submodule in its list. The function submodule_status() is responsible > for generating the status each submodule it is called for, and > then calls print_status(). > > Finally, the function print_status() handles the printing of submodule's > status. > > Mentored-by: Christian Couder > Mentored-by: Stefan Beller > Signed-off-by: Prathamesh Chavan > --- > In this new version, the following changes have been made: > * parameters passed to the function print_status() have been changed. > Instead of passing char *sub_sha1, instead the object_id is being passed. > > * Also, since the passed parameter displaypath's value isn't changed > by the function, it is passed to the funcition as const char *displaypath > instead of char *displaypath. > > * the output type of the function handle_submodule_head_ref() is changed > from strbuf to object_id, as we will use the object_id instead of the > hex of sha1 being stored in a struct strbuf. > > * diff_files_args is cleared after using it by passing it as args in the > function cmd_diff_files. > > * In the function status_submodule(), for checking if a submodule has merge > conflicts, the patch currently checks if the value of any of the ce_flags > is non-zero. Currently, I think the we aren't interested in a partiular > flag, > but I'm not sure on this. > > * Debugging leftovers and suprious new-lines are removed. > > * The confusion with displaypath being passed as te super-prefix in many > of the ported subcommands may be a result of the fact that the > function generating the displaypath: get_submodule_displaypath() > uses the super-prefix as simply a path concatenated with the current > submodule name to denote our current location. > The function get_super_prefix() is declared in cache.h and defined in > environment.c, but is majorly used in the builtin/submodule--helper.c > and also in unpack-trees.c > Also, for generating any submodule's displaypath, it would be important to > have ".." passed to the submodule, and currently it is possible only via the > super-prefix. > This is also other instaces where the super-prefix contained ".." as well. > One of such instance is Test 4 from t7406-submodule-update.sh > Hence, maybe documenting the value of displaypath might a solution > for the above problem. > I'm just stating my views and would like to recieve your opinion on this > matter. Yes, I agree that the display path is not quite easily understood as it can be ambiguous. I am confused by this paragraph: * does test 4 from 7406 fail here, or was it just the starting point of the discussion and it all works fine? I have reviewed the patches up to (and including this) patch and so far they look good to me. Thanks, Stefan
[GSoC][PATCH 04/13] submodule: port submodule subcommand 'status' from shell to C
This aims to make git-submodule 'status' a built-in. Hence, the function cmd_status() is ported from shell to C. This is done by introducing three functions: module_status(), submodule_status() and print_status(). The function module_status() acts as the front-end of the subcommand. It parses subcommand's options and then calls the function module_list_compute() for computing the list of submodules. Then this functions calls for_each_submodule_list() looping through the list obtained. Then for_each_submodule_list() calls submodule_status() for each of the submodule in its list. The function submodule_status() is responsible for generating the status each submodule it is called for, and then calls print_status(). Finally, the function print_status() handles the printing of submodule's status. Mentored-by: Christian CouderMentored-by: Stefan Beller Signed-off-by: Prathamesh Chavan --- In this new version, the following changes have been made: * parameters passed to the function print_status() have been changed. Instead of passing char *sub_sha1, instead the object_id is being passed. * Also, since the passed parameter displaypath's value isn't changed by the function, it is passed to the funcition as const char *displaypath instead of char *displaypath. * the output type of the function handle_submodule_head_ref() is changed from strbuf to object_id, as we will use the object_id instead of the hex of sha1 being stored in a struct strbuf. * diff_files_args is cleared after using it by passing it as args in the function cmd_diff_files. * In the function status_submodule(), for checking if a submodule has merge conflicts, the patch currently checks if the value of any of the ce_flags is non-zero. Currently, I think the we aren't interested in a partiular flag, but I'm not sure on this. * Debugging leftovers and suprious new-lines are removed. * The confusion with displaypath being passed as te super-prefix in many of the ported subcommands may be a result of the fact that the function generating the displaypath: get_submodule_displaypath() uses the super-prefix as simply a path concatenated with the current submodule name to denote our current location. The function get_super_prefix() is declared in cache.h and defined in environment.c, but is majorly used in the builtin/submodule--helper.c and also in unpack-trees.c Also, for generating any submodule's displaypath, it would be important to have ".." passed to the submodule, and currently it is possible only via the super-prefix. This is also other instaces where the super-prefix contained ".." as well. One of such instance is Test 4 from t7406-submodule-update.sh Hence, maybe documenting the value of displaypath might a solution for the above problem. I'm just stating my views and would like to recieve your opinion on this matter. builtin/submodule--helper.c | 154 git-submodule.sh| 49 +- 2 files changed, 155 insertions(+), 48 deletions(-) diff --git a/builtin/submodule--helper.c b/builtin/submodule--helper.c index 2cb72d68e..a6e6a48cc 100644 --- a/builtin/submodule--helper.c +++ b/builtin/submodule--helper.c @@ -561,6 +561,159 @@ static int module_init(int argc, const char **argv, const char *prefix) return 0; } +struct status_cb { + const char *prefix; + unsigned int quiet: 1; + unsigned int recursive: 1; + unsigned int cached: 1; +}; +#define STATUS_CB_INIT { NULL, 0, 0, 0 } + +static void print_status(struct status_cb *info, char state, const char *path, +const struct object_id *oid, const char *displaypath) +{ + if (info->quiet) + return; + + printf("%c%s %s", state, oid_to_hex(oid), displaypath); + + if (state == ' ' || state == '+') { + struct argv_array name_rev_args = ARGV_ARRAY_INIT; + + argv_array_pushl(_rev_args, "print-name-rev", +path, oid_to_hex(oid), NULL); + print_name_rev(name_rev_args.argc, name_rev_args.argv, + info->prefix); + } else { + printf("\n"); + } +} + +static int handle_submodule_head_ref(const char *refname, +const struct object_id *oid, int flags, +void *cb_data) +{ + struct object_id *output = cb_data; + if (oid) + oidcpy(output, oid); + + return 0; +} + +static void status_submodule(const struct cache_entry *list_item, void *cb_data) +{ + struct status_cb *info = cb_data; + char *displaypath; + struct argv_array diff_files_args = ARGV_ARRAY_INIT; + + if (!submodule_from_path(null_sha1, list_item->name)) + die(_("no submodule mapping found in .gitmodules for path
Re: [GSoC][PATCH 04/13] submodule: port submodule subcommand 'status' from shell to C
On 07/25, Prathamesh Chavan wrote: > This aims to make git-submodule 'status' a built-in. Hence, the function > cmd_status() is ported from shell to C. This is done by introducing > three functions: module_status(), submodule_status() and print_status(). > > The function module_status() acts as the front-end of the subcommand. > It parses subcommand's options and then calls the function > module_list_compute() for computing the list of submodules. Then > this functions calls for_each_submodule_list() looping through the > list obtained. > > Then for_each_submodule_list() calls submodule_status() for each of the > submodule in its list. The function submodule_status() is responsible > for generating the status each submodule it is called for, and > then calls print_status(). > > Finally, the function print_status() handles the printing of submodule's > status. > > Mentored-by: Christian Couder> Mentored-by: Stefan Beller > Signed-off-by: Prathamesh Chavan > --- > In this new version of patch, following changes were made: > * instead of using the ce_match_stat(), cmd_diff_files is used. > * currently, no comment about future scope of optimization wrt the > cmd_diff_files() usage was added as currently, I'm not fully sure of > the way to optimize the function. > > builtin/submodule--helper.c | 151 > > git-submodule.sh| 49 +- > 2 files changed, 152 insertions(+), 48 deletions(-) > > diff --git a/builtin/submodule--helper.c b/builtin/submodule--helper.c > index 80f744407..b39828174 100644 > --- a/builtin/submodule--helper.c > +++ b/builtin/submodule--helper.c > @@ -560,6 +560,156 @@ static int module_init(int argc, const char **argv, > const char *prefix) > return 0; > } > > +struct status_cb { > + const char *prefix; > + unsigned int quiet: 1; > + unsigned int recursive: 1; > + unsigned int cached: 1; > +}; > +#define STATUS_CB_INIT { NULL, 0, 0, 0 } > + > +static void print_status(struct status_cb *info, char state, const char > *path, > + char *sub_sha1, char *displaypath) Lets mark these strings as 'const char *' since you aren't modifying them in the function, only using them. Also it may make more sense to pass the 'struct object_id' instead of a hex string of the object id. Then you can call the necessary 'oid_to_hex' function when you are adding the object id to the argv array. That would also eliminate an allocation in 'status_submodule'. Also eliminates the need to use the word 'sha1' as we want to eliminate its usage in the codebase. > +{ > + if (info->quiet) > + return; > + > + printf("%c%s %s", state, sub_sha1, displaypath); > + > + if (state == ' ' || state == '+') { > + struct argv_array name_rev_args = ARGV_ARRAY_INIT; > + > + argv_array_pushl(_rev_args, "print-name-rev", > + path, sub_sha1, NULL); > + print_name_rev(name_rev_args.argc, name_rev_args.argv, > +info->prefix); > + } else { > + printf("\n"); > + } > +} > + > +static int handle_submodule_head_ref(const char *refname, > + const struct object_id *oid, int flags, > + void *cb_data) > +{ > + struct strbuf *output = cb_data; > + if (oid) > + strbuf_addstr(output, oid_to_hex(oid)); Since we're going to be working with 'struct object_id' instead of strings this would need to change slightly. Instead of copying into a strbuf we could just pass a pointer to a 'struct object_id' and use 'oidcpy' to copy the contents of oid to output. struct object_id *output = cb_data; if (oid) oidcpy(output, oid); > + return 0; > +} > + > +static void status_submodule(const struct cache_entry *list_item, void > *cb_data) > +{ > + struct status_cb *info = cb_data; > + char *sub_sha1 = xstrdup(oid_to_hex(_item->oid)); > + char *displaypath; > + struct argv_array diff_files_args = ARGV_ARRAY_INIT; 'diff_files_args' needs to be cleared at the end of the function when doing cleanup to prevent a memory leak. > + > + if (!submodule_from_path(null_sha1, list_item->name)) > + die(_("no submodule mapping found in .gitmodules for path > '%s'"), > + list_item->name); > + > + displaypath = get_submodule_displaypath(list_item->name, info->prefix); > + > + if (list_item->ce_flags) { Is there a particular flag we are interested in here or only that a flag is set? > + print_status(info, 'U', list_item->name, > + sha1_to_hex(null_sha1), displaypath); Since we are already using OID's in other parts of this code lets be consistant and use null_oid instead like 'oid_to_hex(_oid)'. > + goto cleanup; > + } > + > + if
[GSoC][PATCH 04/13] submodule: port submodule subcommand 'status' from shell to C
This aims to make git-submodule 'status' a built-in. Hence, the function cmd_status() is ported from shell to C. This is done by introducing three functions: module_status(), submodule_status() and print_status(). The function module_status() acts as the front-end of the subcommand. It parses subcommand's options and then calls the function module_list_compute() for computing the list of submodules. Then this functions calls for_each_submodule_list() looping through the list obtained. Then for_each_submodule_list() calls submodule_status() for each of the submodule in its list. The function submodule_status() is responsible for generating the status each submodule it is called for, and then calls print_status(). Finally, the function print_status() handles the printing of submodule's status. Mentored-by: Christian CouderMentored-by: Stefan Beller Signed-off-by: Prathamesh Chavan --- In this new version of patch, following changes were made: * instead of using the ce_match_stat(), cmd_diff_files is used. * currently, no comment about future scope of optimization wrt the cmd_diff_files() usage was added as currently, I'm not fully sure of the way to optimize the function. builtin/submodule--helper.c | 151 git-submodule.sh| 49 +- 2 files changed, 152 insertions(+), 48 deletions(-) diff --git a/builtin/submodule--helper.c b/builtin/submodule--helper.c index 80f744407..b39828174 100644 --- a/builtin/submodule--helper.c +++ b/builtin/submodule--helper.c @@ -560,6 +560,156 @@ static int module_init(int argc, const char **argv, const char *prefix) return 0; } +struct status_cb { + const char *prefix; + unsigned int quiet: 1; + unsigned int recursive: 1; + unsigned int cached: 1; +}; +#define STATUS_CB_INIT { NULL, 0, 0, 0 } + +static void print_status(struct status_cb *info, char state, const char *path, +char *sub_sha1, char *displaypath) +{ + if (info->quiet) + return; + + printf("%c%s %s", state, sub_sha1, displaypath); + + if (state == ' ' || state == '+') { + struct argv_array name_rev_args = ARGV_ARRAY_INIT; + + argv_array_pushl(_rev_args, "print-name-rev", +path, sub_sha1, NULL); + print_name_rev(name_rev_args.argc, name_rev_args.argv, + info->prefix); + } else { + printf("\n"); + } +} + +static int handle_submodule_head_ref(const char *refname, +const struct object_id *oid, int flags, +void *cb_data) +{ + struct strbuf *output = cb_data; + if (oid) + strbuf_addstr(output, oid_to_hex(oid)); + return 0; +} + +static void status_submodule(const struct cache_entry *list_item, void *cb_data) +{ + struct status_cb *info = cb_data; + char *sub_sha1 = xstrdup(oid_to_hex(_item->oid)); + char *displaypath; + struct argv_array diff_files_args = ARGV_ARRAY_INIT; + + if (!submodule_from_path(null_sha1, list_item->name)) + die(_("no submodule mapping found in .gitmodules for path '%s'"), + list_item->name); + + displaypath = get_submodule_displaypath(list_item->name, info->prefix); + + if (list_item->ce_flags) { + print_status(info, 'U', list_item->name, +sha1_to_hex(null_sha1), displaypath); + goto cleanup; + } + + if (!is_submodule_active(the_repository, list_item->name)) { + print_status(info, '-', list_item->name, sub_sha1, displaypath); + goto cleanup; + } + + argv_array_pushl(_files_args, "diff-files", +"--ignore-submodules=dirty", "--quiet", "--", +list_item->name, NULL); + + if (!cmd_diff_files(diff_files_args.argc, diff_files_args.argv, + info->prefix)) { + print_status(info, ' ', list_item->name, sub_sha1, displaypath); + } else { + if (!info->cached) { + struct strbuf sb = STRBUF_INIT; + if (head_ref_submodule(list_item->name, + handle_submodule_head_ref, )) + die(_("could not resolve HEAD ref inside the" + "submodule '%s'"), list_item->name); + print_status(info, '+', list_item->name, sb.buf, +displaypath); + strbuf_release(); + } else { + print_status(info, '+', list_item->name, sub_sha1, +displaypath); + } + } + +