3 #include "repository.h"
5 #include "submodule-config.h"
11 #include "run-command.h"
14 #include "string-list.h"
15 #include "oid-array.h"
18 #include "thread-utils.h"
22 #include "parse-options.h"
23 #include "object-store.h"
24 #include "commit-reach.h"
26 static int config_update_recurse_submodules = RECURSE_SUBMODULES_OFF;
27 static int initialized_fetch_ref_tips;
28 static struct oid_array ref_tips_before_fetch;
29 static struct oid_array ref_tips_after_fetch;
32 * Check if the .gitmodules file is unmerged. Parsing of the .gitmodules file
33 * will be disabled because we can't guess what might be configured in
34 * .gitmodules unless the user resolves the conflict.
36 int is_gitmodules_unmerged(const struct index_state *istate)
38 int pos = index_name_pos(istate, GITMODULES_FILE, strlen(GITMODULES_FILE));
39 if (pos < 0) { /* .gitmodules not found or isn't merged */
41 if (istate->cache_nr > pos) { /* there is a .gitmodules */
42 const struct cache_entry *ce = istate->cache[pos];
43 if (ce_namelen(ce) == strlen(GITMODULES_FILE) &&
44 !strcmp(ce->name, GITMODULES_FILE))
53 * Check if the .gitmodules file is safe to write.
55 * Writing to the .gitmodules file requires that the file exists in the
56 * working tree or, if it doesn't, that a brand new .gitmodules file is going
57 * to be created (i.e. it's neither in the index nor in the current branch).
59 * It is not safe to write to .gitmodules if it's not in the working tree but
60 * it is in the index or in the current branch, because writing new values
61 * (and staging them) would blindly overwrite ALL the old content.
63 int is_writing_gitmodules_ok(void)
66 return file_exists(GITMODULES_FILE) ||
67 (get_oid(GITMODULES_INDEX, &oid) < 0 && get_oid(GITMODULES_HEAD, &oid) < 0);
71 * Check if the .gitmodules file has unstaged modifications. This must be
72 * checked before allowing modifications to the .gitmodules file with the
73 * intention to stage them later, because when continuing we would stage the
74 * modifications the user didn't stage herself too. That might change in a
75 * future version when we learn to stage the changes we do ourselves without
76 * staging any previous modifications.
78 int is_staging_gitmodules_ok(struct index_state *istate)
80 int pos = index_name_pos(istate, GITMODULES_FILE, strlen(GITMODULES_FILE));
82 if ((pos >= 0) && (pos < istate->cache_nr)) {
84 if (lstat(GITMODULES_FILE, &st) == 0 &&
85 ie_modified(istate, istate->cache[pos], &st, 0) & DATA_CHANGED)
92 static int for_each_remote_ref_submodule(const char *submodule,
93 each_ref_fn fn, void *cb_data)
95 return refs_for_each_remote_ref(get_submodule_ref_store(submodule),
100 * Try to update the "path" entry in the "submodule.<name>" section of the
101 * .gitmodules file. Return 0 only if a .gitmodules file was found, a section
102 * with the correct path=<oldpath> setting was found and we could update it.
104 int update_path_in_gitmodules(const char *oldpath, const char *newpath)
106 struct strbuf entry = STRBUF_INIT;
107 const struct submodule *submodule;
110 if (!file_exists(GITMODULES_FILE)) /* Do nothing without .gitmodules */
113 if (is_gitmodules_unmerged(the_repository->index))
114 die(_("Cannot change unmerged .gitmodules, resolve merge conflicts first"));
116 submodule = submodule_from_path(the_repository, &null_oid, oldpath);
117 if (!submodule || !submodule->name) {
118 warning(_("Could not find section in .gitmodules where path=%s"), oldpath);
121 strbuf_addstr(&entry, "submodule.");
122 strbuf_addstr(&entry, submodule->name);
123 strbuf_addstr(&entry, ".path");
124 ret = config_set_in_gitmodules_file_gently(entry.buf, newpath);
125 strbuf_release(&entry);
130 * Try to remove the "submodule.<name>" section from .gitmodules where the given
131 * path is configured. Return 0 only if a .gitmodules file was found, a section
132 * with the correct path=<path> setting was found and we could remove it.
134 int remove_path_from_gitmodules(const char *path)
136 struct strbuf sect = STRBUF_INIT;
137 const struct submodule *submodule;
139 if (!file_exists(GITMODULES_FILE)) /* Do nothing without .gitmodules */
142 if (is_gitmodules_unmerged(the_repository->index))
143 die(_("Cannot change unmerged .gitmodules, resolve merge conflicts first"));
145 submodule = submodule_from_path(the_repository, &null_oid, path);
146 if (!submodule || !submodule->name) {
147 warning(_("Could not find section in .gitmodules where path=%s"), path);
150 strbuf_addstr(§, "submodule.");
151 strbuf_addstr(§, submodule->name);
152 if (git_config_rename_section_in_file(GITMODULES_FILE, sect.buf, NULL) < 0) {
153 /* Maybe the user already did that, don't error out here */
154 warning(_("Could not remove .gitmodules entry for %s"), path);
155 strbuf_release(§);
158 strbuf_release(§);
162 void stage_updated_gitmodules(struct index_state *istate)
164 if (add_file_to_index(istate, GITMODULES_FILE, 0))
165 die(_("staging updated .gitmodules failed"));
168 /* TODO: remove this function, use repo_submodule_init instead. */
169 int add_submodule_odb(const char *path)
171 struct strbuf objects_directory = STRBUF_INIT;
174 ret = strbuf_git_path_submodule(&objects_directory, path, "objects/");
177 if (!is_directory(objects_directory.buf)) {
181 add_to_alternates_memory(objects_directory.buf);
183 strbuf_release(&objects_directory);
187 void set_diffopt_flags_from_submodule_config(struct diff_options *diffopt,
190 const struct submodule *submodule = submodule_from_path(the_repository,
196 key = xstrfmt("submodule.%s.ignore", submodule->name);
197 if (repo_config_get_string_tmp(the_repository, key, &ignore))
198 ignore = submodule->ignore;
202 handle_ignore_submodules_arg(diffopt, ignore);
203 else if (is_gitmodules_unmerged(the_repository->index))
204 diffopt->flags.ignore_submodules = 1;
208 /* Cheap function that only determines if we're interested in submodules at all */
209 int git_default_submodule_config(const char *var, const char *value, void *cb)
211 if (!strcmp(var, "submodule.recurse")) {
212 int v = git_config_bool(var, value) ?
213 RECURSE_SUBMODULES_ON : RECURSE_SUBMODULES_OFF;
214 config_update_recurse_submodules = v;
219 int option_parse_recurse_submodules_worktree_updater(const struct option *opt,
220 const char *arg, int unset)
223 config_update_recurse_submodules = RECURSE_SUBMODULES_OFF;
227 config_update_recurse_submodules =
228 parse_update_recurse_submodules_arg(opt->long_name,
231 config_update_recurse_submodules = RECURSE_SUBMODULES_ON;
237 * Determine if a submodule has been initialized at a given 'path'
239 int is_submodule_active(struct repository *repo, const char *path)
244 const struct string_list *sl;
245 const struct submodule *module;
247 module = submodule_from_path(repo, &null_oid, path);
249 /* early return if there isn't a path->module mapping */
253 /* submodule.<name>.active is set */
254 key = xstrfmt("submodule.%s.active", module->name);
255 if (!repo_config_get_bool(repo, key, &ret)) {
261 /* submodule.active is set */
262 sl = repo_config_get_value_multi(repo, "submodule.active");
265 struct strvec args = STRVEC_INIT;
266 const struct string_list_item *item;
268 for_each_string_list_item(item, sl) {
269 strvec_push(&args, item->string);
272 parse_pathspec(&ps, 0, 0, NULL, args.v);
273 ret = match_pathspec(repo->index, &ps, path, strlen(path), 0, NULL, 1);
280 /* fallback to checking if the URL is set */
281 key = xstrfmt("submodule.%s.url", module->name);
282 ret = !repo_config_get_string(repo, key, &value);
289 int is_submodule_populated_gently(const char *path, int *return_error_code)
292 char *gitdir = xstrfmt("%s/.git", path);
294 if (resolve_gitdir_gently(gitdir, return_error_code))
302 * Dies if the provided 'prefix' corresponds to an unpopulated submodule
304 void die_in_unpopulated_submodule(const struct index_state *istate,
312 prefixlen = strlen(prefix);
314 for (i = 0; i < istate->cache_nr; i++) {
315 struct cache_entry *ce = istate->cache[i];
316 int ce_len = ce_namelen(ce);
318 if (!S_ISGITLINK(ce->ce_mode))
320 if (prefixlen <= ce_len)
322 if (strncmp(ce->name, prefix, ce_len))
324 if (prefix[ce_len] != '/')
327 die(_("in unpopulated submodule '%s'"), ce->name);
332 * Dies if any paths in the provided pathspec descends into a submodule
334 void die_path_inside_submodule(const struct index_state *istate,
335 const struct pathspec *ps)
339 for (i = 0; i < istate->cache_nr; i++) {
340 struct cache_entry *ce = istate->cache[i];
341 int ce_len = ce_namelen(ce);
343 if (!S_ISGITLINK(ce->ce_mode))
346 for (j = 0; j < ps->nr ; j++) {
347 const struct pathspec_item *item = &ps->items[j];
349 if (item->len <= ce_len)
351 if (item->match[ce_len] != '/')
353 if (strncmp(ce->name, item->match, ce_len))
355 if (item->len == ce_len + 1)
358 die(_("Pathspec '%s' is in submodule '%.*s'"),
359 item->original, ce_len, ce->name);
364 enum submodule_update_type parse_submodule_update_type(const char *value)
366 if (!strcmp(value, "none"))
367 return SM_UPDATE_NONE;
368 else if (!strcmp(value, "checkout"))
369 return SM_UPDATE_CHECKOUT;
370 else if (!strcmp(value, "rebase"))
371 return SM_UPDATE_REBASE;
372 else if (!strcmp(value, "merge"))
373 return SM_UPDATE_MERGE;
374 else if (*value == '!')
375 return SM_UPDATE_COMMAND;
377 return SM_UPDATE_UNSPECIFIED;
380 int parse_submodule_update_strategy(const char *value,
381 struct submodule_update_strategy *dst)
383 enum submodule_update_type type;
385 free((void*)dst->command);
388 type = parse_submodule_update_type(value);
389 if (type == SM_UPDATE_UNSPECIFIED)
393 if (type == SM_UPDATE_COMMAND)
394 dst->command = xstrdup(value + 1);
399 const char *submodule_strategy_to_string(const struct submodule_update_strategy *s)
401 struct strbuf sb = STRBUF_INIT;
403 case SM_UPDATE_CHECKOUT:
405 case SM_UPDATE_MERGE:
407 case SM_UPDATE_REBASE:
411 case SM_UPDATE_UNSPECIFIED:
413 case SM_UPDATE_COMMAND:
414 strbuf_addf(&sb, "!%s", s->command);
415 return strbuf_detach(&sb, NULL);
420 void handle_ignore_submodules_arg(struct diff_options *diffopt,
423 diffopt->flags.ignore_submodule_set = 1;
424 diffopt->flags.ignore_submodules = 0;
425 diffopt->flags.ignore_untracked_in_submodules = 0;
426 diffopt->flags.ignore_dirty_submodules = 0;
428 if (!strcmp(arg, "all"))
429 diffopt->flags.ignore_submodules = 1;
430 else if (!strcmp(arg, "untracked"))
431 diffopt->flags.ignore_untracked_in_submodules = 1;
432 else if (!strcmp(arg, "dirty"))
433 diffopt->flags.ignore_dirty_submodules = 1;
434 else if (strcmp(arg, "none"))
435 die(_("bad --ignore-submodules argument: %s"), arg);
437 * Please update _git_status() in git-completion.bash when you
442 static int prepare_submodule_diff_summary(struct repository *r, struct rev_info *rev,
444 struct commit *left, struct commit *right,
445 struct commit_list *merge_bases)
447 struct commit_list *list;
449 repo_init_revisions(r, rev, NULL);
450 setup_revisions(0, NULL, rev, NULL);
452 rev->first_parent_only = 1;
453 left->object.flags |= SYMMETRIC_LEFT;
454 add_pending_object(rev, &left->object, path);
455 add_pending_object(rev, &right->object, path);
456 for (list = merge_bases; list; list = list->next) {
457 list->item->object.flags |= UNINTERESTING;
458 add_pending_object(rev, &list->item->object,
459 oid_to_hex(&list->item->object.oid));
461 return prepare_revision_walk(rev);
464 static void print_submodule_diff_summary(struct repository *r, struct rev_info *rev, struct diff_options *o)
466 static const char format[] = " %m %s";
467 struct strbuf sb = STRBUF_INIT;
468 struct commit *commit;
470 while ((commit = get_revision(rev))) {
471 struct pretty_print_context ctx = {0};
472 ctx.date_mode = rev->date_mode;
473 ctx.output_encoding = get_log_output_encoding();
474 strbuf_setlen(&sb, 0);
475 repo_format_commit_message(r, commit, format, &sb,
477 strbuf_addch(&sb, '\n');
478 if (commit->object.flags & SYMMETRIC_LEFT)
479 diff_emit_submodule_del(o, sb.buf);
481 diff_emit_submodule_add(o, sb.buf);
486 static void prepare_submodule_repo_env_no_git_dir(struct strvec *out)
488 const char * const *var;
490 for (var = local_repo_env; *var; var++) {
491 if (strcmp(*var, CONFIG_DATA_ENVIRONMENT))
492 strvec_push(out, *var);
496 void prepare_submodule_repo_env(struct strvec *out)
498 prepare_submodule_repo_env_no_git_dir(out);
499 strvec_pushf(out, "%s=%s", GIT_DIR_ENVIRONMENT,
500 DEFAULT_GIT_DIR_ENVIRONMENT);
503 static void prepare_submodule_repo_env_in_gitdir(struct strvec *out)
505 prepare_submodule_repo_env_no_git_dir(out);
506 strvec_pushf(out, "%s=.", GIT_DIR_ENVIRONMENT);
510 * Initialize a repository struct for a submodule based on the provided 'path'.
512 * Unlike repo_submodule_init, this tolerates submodules not present
513 * in .gitmodules. This function exists only to preserve historical behavior,
515 * Returns the repository struct on success,
516 * NULL when the submodule is not present.
518 static struct repository *open_submodule(const char *path)
520 struct strbuf sb = STRBUF_INIT;
521 struct repository *out = xmalloc(sizeof(*out));
523 if (submodule_to_gitdir(&sb, path) || repo_init(out, sb.buf, NULL)) {
529 /* Mark it as a submodule */
530 out->submodule_prefix = xstrdup(path);
537 * Helper function to display the submodule header line prior to the full
540 * If it can locate the submodule git directory it will create a repository
541 * handle for the submodule and lookup both the left and right commits and
542 * put them into the left and right pointers.
544 static void show_submodule_header(struct diff_options *o,
546 struct object_id *one, struct object_id *two,
547 unsigned dirty_submodule,
548 struct repository *sub,
549 struct commit **left, struct commit **right,
550 struct commit_list **merge_bases)
552 const char *message = NULL;
553 struct strbuf sb = STRBUF_INIT;
554 int fast_forward = 0, fast_backward = 0;
556 if (dirty_submodule & DIRTY_SUBMODULE_UNTRACKED)
557 diff_emit_submodule_untracked(o, path);
559 if (dirty_submodule & DIRTY_SUBMODULE_MODIFIED)
560 diff_emit_submodule_modified(o, path);
562 if (is_null_oid(one))
563 message = "(new submodule)";
564 else if (is_null_oid(two))
565 message = "(submodule deleted)";
569 message = "(commits not present)";
574 * Attempt to lookup the commit references, and determine if this is
575 * a fast forward or fast backwards update.
577 *left = lookup_commit_reference(sub, one);
578 *right = lookup_commit_reference(sub, two);
581 * Warn about missing commits in the submodule project, but only if
584 if ((!is_null_oid(one) && !*left) ||
585 (!is_null_oid(two) && !*right))
586 message = "(commits not present)";
588 *merge_bases = repo_get_merge_bases(sub, *left, *right);
590 if ((*merge_bases)->item == *left)
592 else if ((*merge_bases)->item == *right)
596 if (oideq(one, two)) {
602 strbuf_addf(&sb, "Submodule %s ", path);
603 strbuf_add_unique_abbrev(&sb, one, DEFAULT_ABBREV);
604 strbuf_addstr(&sb, (fast_backward || fast_forward) ? ".." : "...");
605 strbuf_add_unique_abbrev(&sb, two, DEFAULT_ABBREV);
607 strbuf_addf(&sb, " %s\n", message);
609 strbuf_addf(&sb, "%s:\n", fast_backward ? " (rewind)" : "");
610 diff_emit_submodule_header(o, sb.buf);
615 void show_submodule_diff_summary(struct diff_options *o, const char *path,
616 struct object_id *one, struct object_id *two,
617 unsigned dirty_submodule)
620 struct commit *left = NULL, *right = NULL;
621 struct commit_list *merge_bases = NULL;
622 struct repository *sub;
624 sub = open_submodule(path);
625 show_submodule_header(o, path, one, two, dirty_submodule,
626 sub, &left, &right, &merge_bases);
629 * If we don't have both a left and a right pointer, there is no
630 * reason to try and display a summary. The header line should contain
631 * all the information the user needs.
633 if (!left || !right || !sub)
636 /* Treat revision walker failure the same as missing commits */
637 if (prepare_submodule_diff_summary(sub, &rev, path, left, right, merge_bases)) {
638 diff_emit_submodule_error(o, "(revision walker failed)\n");
642 print_submodule_diff_summary(sub, &rev, o);
646 free_commit_list(merge_bases);
647 clear_commit_marks(left, ~0);
648 clear_commit_marks(right, ~0);
655 void show_submodule_inline_diff(struct diff_options *o, const char *path,
656 struct object_id *one, struct object_id *two,
657 unsigned dirty_submodule)
659 const struct object_id *old_oid = the_hash_algo->empty_tree, *new_oid = the_hash_algo->empty_tree;
660 struct commit *left = NULL, *right = NULL;
661 struct commit_list *merge_bases = NULL;
662 struct child_process cp = CHILD_PROCESS_INIT;
663 struct strbuf sb = STRBUF_INIT;
664 struct repository *sub;
666 sub = open_submodule(path);
667 show_submodule_header(o, path, one, two, dirty_submodule,
668 sub, &left, &right, &merge_bases);
670 /* We need a valid left and right commit to display a difference */
671 if (!(left || is_null_oid(one)) ||
672 !(right || is_null_oid(two)))
685 /* TODO: other options may need to be passed here. */
686 strvec_pushl(&cp.args, "diff", "--submodule=diff", NULL);
687 strvec_pushf(&cp.args, "--color=%s", want_color(o->use_color) ?
690 if (o->flags.reverse_diff) {
691 strvec_pushf(&cp.args, "--src-prefix=%s%s/",
693 strvec_pushf(&cp.args, "--dst-prefix=%s%s/",
696 strvec_pushf(&cp.args, "--src-prefix=%s%s/",
698 strvec_pushf(&cp.args, "--dst-prefix=%s%s/",
701 strvec_push(&cp.args, oid_to_hex(old_oid));
703 * If the submodule has modified content, we will diff against the
704 * work tree, under the assumption that the user has asked for the
705 * diff format and wishes to actually see all differences even if they
706 * haven't yet been committed to the submodule yet.
708 if (!(dirty_submodule & DIRTY_SUBMODULE_MODIFIED))
709 strvec_push(&cp.args, oid_to_hex(new_oid));
711 prepare_submodule_repo_env(&cp.env_array);
712 if (start_command(&cp))
713 diff_emit_submodule_error(o, "(diff failed)\n");
715 while (strbuf_getwholeline_fd(&sb, cp.out, '\n') != EOF)
716 diff_emit_submodule_pipethrough(o, sb.buf, sb.len);
718 if (finish_command(&cp))
719 diff_emit_submodule_error(o, "(diff failed)\n");
724 free_commit_list(merge_bases);
726 clear_commit_marks(left, ~0);
728 clear_commit_marks(right, ~0);
735 int should_update_submodules(void)
737 return config_update_recurse_submodules == RECURSE_SUBMODULES_ON;
740 const struct submodule *submodule_from_ce(const struct cache_entry *ce)
742 if (!S_ISGITLINK(ce->ce_mode))
745 if (!should_update_submodules())
748 return submodule_from_path(the_repository, &null_oid, ce->name);
751 static struct oid_array *submodule_commits(struct string_list *submodules,
754 struct string_list_item *item;
756 item = string_list_insert(submodules, name);
758 return (struct oid_array *) item->util;
760 /* NEEDSWORK: should we have oid_array_init()? */
761 item->util = xcalloc(1, sizeof(struct oid_array));
762 return (struct oid_array *) item->util;
765 struct collect_changed_submodules_cb_data {
766 struct repository *repo;
767 struct string_list *changed;
768 const struct object_id *commit_oid;
772 * this would normally be two functions: default_name_from_path() and
773 * path_from_default_name(). Since the default name is the same as
774 * the submodule path we can get away with just one function which only
775 * checks whether there is a submodule in the working directory at that
778 static const char *default_name_or_path(const char *path_or_name)
782 if (!is_submodule_populated_gently(path_or_name, &error_code))
788 static void collect_changed_submodules_cb(struct diff_queue_struct *q,
789 struct diff_options *options,
792 struct collect_changed_submodules_cb_data *me = data;
793 struct string_list *changed = me->changed;
794 const struct object_id *commit_oid = me->commit_oid;
797 for (i = 0; i < q->nr; i++) {
798 struct diff_filepair *p = q->queue[i];
799 struct oid_array *commits;
800 const struct submodule *submodule;
803 if (!S_ISGITLINK(p->two->mode))
806 submodule = submodule_from_path(me->repo,
807 commit_oid, p->two->path);
809 name = submodule->name;
811 name = default_name_or_path(p->two->path);
812 /* make sure name does not collide with existing one */
814 submodule = submodule_from_name(me->repo,
817 warning(_("Submodule in commit %s at path: "
818 "'%s' collides with a submodule named "
819 "the same. Skipping it."),
820 oid_to_hex(commit_oid), p->two->path);
828 commits = submodule_commits(changed, name);
829 oid_array_append(commits, &p->two->oid);
834 * Collect the paths of submodules in 'changed' which have changed based on
835 * the revisions as specified in 'argv'. Each entry in 'changed' will also
836 * have a corresponding 'struct oid_array' (in the 'util' field) which lists
837 * what the submodule pointers were updated to during the change.
839 static void collect_changed_submodules(struct repository *r,
840 struct string_list *changed,
844 const struct commit *commit;
846 struct setup_revision_opt s_r_opt = {
847 .assume_dashdash = 1,
850 save_warning = warn_on_object_refname_ambiguity;
851 warn_on_object_refname_ambiguity = 0;
852 repo_init_revisions(r, &rev, NULL);
853 setup_revisions(argv->nr, argv->v, &rev, &s_r_opt);
854 warn_on_object_refname_ambiguity = save_warning;
855 if (prepare_revision_walk(&rev))
856 die(_("revision walk setup failed"));
858 while ((commit = get_revision(&rev))) {
859 struct rev_info diff_rev;
860 struct collect_changed_submodules_cb_data data;
862 data.changed = changed;
863 data.commit_oid = &commit->object.oid;
865 repo_init_revisions(r, &diff_rev, NULL);
866 diff_rev.diffopt.output_format |= DIFF_FORMAT_CALLBACK;
867 diff_rev.diffopt.format_callback = collect_changed_submodules_cb;
868 diff_rev.diffopt.format_callback_data = &data;
869 diff_rev.dense_combined_merges = 1;
870 diff_tree_combined_merge(commit, &diff_rev);
873 reset_revision_walk();
876 static void free_submodules_oids(struct string_list *submodules)
878 struct string_list_item *item;
879 for_each_string_list_item(item, submodules)
880 oid_array_clear((struct oid_array *) item->util);
881 string_list_clear(submodules, 1);
884 static int has_remote(const char *refname, const struct object_id *oid,
885 int flags, void *cb_data)
890 static int append_oid_to_argv(const struct object_id *oid, void *data)
892 struct strvec *argv = data;
893 strvec_push(argv, oid_to_hex(oid));
897 struct has_commit_data {
898 struct repository *repo;
903 static int check_has_commit(const struct object_id *oid, void *data)
905 struct has_commit_data *cb = data;
907 enum object_type type = oid_object_info(cb->repo, oid, NULL);
914 * Object is missing or invalid. If invalid, an error message
915 * has already been printed.
920 die(_("submodule entry '%s' (%s) is a %s, not a commit"),
921 cb->path, oid_to_hex(oid), type_name(type));
925 static int submodule_has_commits(struct repository *r,
927 struct oid_array *commits)
929 struct has_commit_data has_commit = { r, 1, path };
932 * Perform a cheap, but incorrect check for the existence of 'commits'.
933 * This is done by adding the submodule's object store to the in-core
934 * object store, and then querying for each commit's existence. If we
935 * do not have the commit object anywhere, there is no chance we have
936 * it in the object store of the correct submodule and have it
937 * reachable from a ref, so we can fail early without spawning rev-list
938 * which is expensive.
940 if (add_submodule_odb(path))
943 oid_array_for_each_unique(commits, check_has_commit, &has_commit);
945 if (has_commit.result) {
947 * Even if the submodule is checked out and the commit is
948 * present, make sure it exists in the submodule's object store
949 * and that it is reachable from a ref.
951 struct child_process cp = CHILD_PROCESS_INIT;
952 struct strbuf out = STRBUF_INIT;
954 strvec_pushl(&cp.args, "rev-list", "-n", "1", NULL);
955 oid_array_for_each_unique(commits, append_oid_to_argv, &cp.args);
956 strvec_pushl(&cp.args, "--not", "--all", NULL);
958 prepare_submodule_repo_env(&cp.env_array);
963 if (capture_command(&cp, &out, GIT_MAX_HEXSZ + 1) || out.len)
964 has_commit.result = 0;
966 strbuf_release(&out);
969 return has_commit.result;
972 static int submodule_needs_pushing(struct repository *r,
974 struct oid_array *commits)
976 if (!submodule_has_commits(r, path, commits))
978 * NOTE: We do consider it safe to return "no" here. The
979 * correct answer would be "We do not know" instead of
980 * "No push needed", but it is quite hard to change
981 * the submodule pointer without having the submodule
982 * around. If a user did however change the submodules
983 * without having the submodule around, this indicates
984 * an expert who knows what they are doing or a
985 * maintainer integrating work from other people. In
986 * both cases it should be safe to skip this check.
990 if (for_each_remote_ref_submodule(path, has_remote, NULL) > 0) {
991 struct child_process cp = CHILD_PROCESS_INIT;
992 struct strbuf buf = STRBUF_INIT;
993 int needs_pushing = 0;
995 strvec_push(&cp.args, "rev-list");
996 oid_array_for_each_unique(commits, append_oid_to_argv, &cp.args);
997 strvec_pushl(&cp.args, "--not", "--remotes", "-n", "1" , NULL);
999 prepare_submodule_repo_env(&cp.env_array);
1004 if (start_command(&cp))
1005 die(_("Could not run 'git rev-list <commits> --not --remotes -n 1' command in submodule %s"),
1007 if (strbuf_read(&buf, cp.out, the_hash_algo->hexsz + 1))
1009 finish_command(&cp);
1011 strbuf_release(&buf);
1012 return needs_pushing;
1018 int find_unpushed_submodules(struct repository *r,
1019 struct oid_array *commits,
1020 const char *remotes_name,
1021 struct string_list *needs_pushing)
1023 struct string_list submodules = STRING_LIST_INIT_DUP;
1024 struct string_list_item *name;
1025 struct strvec argv = STRVEC_INIT;
1027 /* argv.v[0] will be ignored by setup_revisions */
1028 strvec_push(&argv, "find_unpushed_submodules");
1029 oid_array_for_each_unique(commits, append_oid_to_argv, &argv);
1030 strvec_push(&argv, "--not");
1031 strvec_pushf(&argv, "--remotes=%s", remotes_name);
1033 collect_changed_submodules(r, &submodules, &argv);
1035 for_each_string_list_item(name, &submodules) {
1036 struct oid_array *commits = name->util;
1037 const struct submodule *submodule;
1038 const char *path = NULL;
1040 submodule = submodule_from_name(r, &null_oid, name->string);
1042 path = submodule->path;
1044 path = default_name_or_path(name->string);
1049 if (submodule_needs_pushing(r, path, commits))
1050 string_list_insert(needs_pushing, path);
1053 free_submodules_oids(&submodules);
1054 strvec_clear(&argv);
1056 return needs_pushing->nr;
1059 static int push_submodule(const char *path,
1060 const struct remote *remote,
1061 const struct refspec *rs,
1062 const struct string_list *push_options,
1065 if (for_each_remote_ref_submodule(path, has_remote, NULL) > 0) {
1066 struct child_process cp = CHILD_PROCESS_INIT;
1067 strvec_push(&cp.args, "push");
1069 strvec_push(&cp.args, "--dry-run");
1071 if (push_options && push_options->nr) {
1072 const struct string_list_item *item;
1073 for_each_string_list_item(item, push_options)
1074 strvec_pushf(&cp.args, "--push-option=%s",
1078 if (remote->origin != REMOTE_UNCONFIGURED) {
1080 strvec_push(&cp.args, remote->name);
1081 for (i = 0; i < rs->raw_nr; i++)
1082 strvec_push(&cp.args, rs->raw[i]);
1085 prepare_submodule_repo_env(&cp.env_array);
1089 if (run_command(&cp))
1098 * Perform a check in the submodule to see if the remote and refspec work.
1099 * Die if the submodule can't be pushed.
1101 static void submodule_push_check(const char *path, const char *head,
1102 const struct remote *remote,
1103 const struct refspec *rs)
1105 struct child_process cp = CHILD_PROCESS_INIT;
1108 strvec_push(&cp.args, "submodule--helper");
1109 strvec_push(&cp.args, "push-check");
1110 strvec_push(&cp.args, head);
1111 strvec_push(&cp.args, remote->name);
1113 for (i = 0; i < rs->raw_nr; i++)
1114 strvec_push(&cp.args, rs->raw[i]);
1116 prepare_submodule_repo_env(&cp.env_array);
1123 * Simply indicate if 'submodule--helper push-check' failed.
1124 * More detailed error information will be provided by the
1127 if (run_command(&cp))
1128 die(_("process for submodule '%s' failed"), path);
1131 int push_unpushed_submodules(struct repository *r,
1132 struct oid_array *commits,
1133 const struct remote *remote,
1134 const struct refspec *rs,
1135 const struct string_list *push_options,
1139 struct string_list needs_pushing = STRING_LIST_INIT_DUP;
1141 if (!find_unpushed_submodules(r, commits,
1142 remote->name, &needs_pushing))
1146 * Verify that the remote and refspec can be propagated to all
1147 * submodules. This check can be skipped if the remote and refspec
1148 * won't be propagated due to the remote being unconfigured (e.g. a URL
1149 * instead of a remote name).
1151 if (remote->origin != REMOTE_UNCONFIGURED) {
1153 struct object_id head_oid;
1155 head = resolve_refdup("HEAD", 0, &head_oid, NULL);
1157 die(_("Failed to resolve HEAD as a valid ref."));
1159 for (i = 0; i < needs_pushing.nr; i++)
1160 submodule_push_check(needs_pushing.items[i].string,
1165 /* Actually push the submodules */
1166 for (i = 0; i < needs_pushing.nr; i++) {
1167 const char *path = needs_pushing.items[i].string;
1168 fprintf(stderr, _("Pushing submodule '%s'\n"), path);
1169 if (!push_submodule(path, remote, rs,
1170 push_options, dry_run)) {
1171 fprintf(stderr, _("Unable to push submodule '%s'\n"), path);
1176 string_list_clear(&needs_pushing, 0);
1181 static int append_oid_to_array(const char *ref, const struct object_id *oid,
1182 int flags, void *data)
1184 struct oid_array *array = data;
1185 oid_array_append(array, oid);
1189 void check_for_new_submodule_commits(struct object_id *oid)
1191 if (!initialized_fetch_ref_tips) {
1192 for_each_ref(append_oid_to_array, &ref_tips_before_fetch);
1193 initialized_fetch_ref_tips = 1;
1196 oid_array_append(&ref_tips_after_fetch, oid);
1199 static void calculate_changed_submodule_paths(struct repository *r,
1200 struct string_list *changed_submodule_names)
1202 struct strvec argv = STRVEC_INIT;
1203 struct string_list_item *name;
1205 /* No need to check if there are no submodules configured */
1206 if (!submodule_from_path(r, NULL, NULL))
1209 strvec_push(&argv, "--"); /* argv[0] program name */
1210 oid_array_for_each_unique(&ref_tips_after_fetch,
1211 append_oid_to_argv, &argv);
1212 strvec_push(&argv, "--not");
1213 oid_array_for_each_unique(&ref_tips_before_fetch,
1214 append_oid_to_argv, &argv);
1217 * Collect all submodules (whether checked out or not) for which new
1218 * commits have been recorded upstream in "changed_submodule_names".
1220 collect_changed_submodules(r, changed_submodule_names, &argv);
1222 for_each_string_list_item(name, changed_submodule_names) {
1223 struct oid_array *commits = name->util;
1224 const struct submodule *submodule;
1225 const char *path = NULL;
1227 submodule = submodule_from_name(r, &null_oid, name->string);
1229 path = submodule->path;
1231 path = default_name_or_path(name->string);
1236 if (submodule_has_commits(r, path, commits)) {
1237 oid_array_clear(commits);
1238 *name->string = '\0';
1242 string_list_remove_empty_items(changed_submodule_names, 1);
1244 strvec_clear(&argv);
1245 oid_array_clear(&ref_tips_before_fetch);
1246 oid_array_clear(&ref_tips_after_fetch);
1247 initialized_fetch_ref_tips = 0;
1250 int submodule_touches_in_range(struct repository *r,
1251 struct object_id *excl_oid,
1252 struct object_id *incl_oid)
1254 struct string_list subs = STRING_LIST_INIT_DUP;
1255 struct strvec args = STRVEC_INIT;
1258 /* No need to check if there are no submodules configured */
1259 if (!submodule_from_path(r, NULL, NULL))
1262 strvec_push(&args, "--"); /* args[0] program name */
1263 strvec_push(&args, oid_to_hex(incl_oid));
1264 if (!is_null_oid(excl_oid)) {
1265 strvec_push(&args, "--not");
1266 strvec_push(&args, oid_to_hex(excl_oid));
1269 collect_changed_submodules(r, &subs, &args);
1272 strvec_clear(&args);
1274 free_submodules_oids(&subs);
1278 struct submodule_parallel_fetch {
1281 struct repository *r;
1283 int command_line_option;
1288 struct string_list changed_submodule_names;
1290 /* Pending fetches by OIDs */
1291 struct fetch_task **oid_fetch_tasks;
1292 int oid_fetch_tasks_nr, oid_fetch_tasks_alloc;
1294 struct strbuf submodules_with_errors;
1296 #define SPF_INIT {0, STRVEC_INIT, NULL, NULL, 0, 0, 0, 0, \
1297 STRING_LIST_INIT_DUP, \
1298 NULL, 0, 0, STRBUF_INIT}
1300 static int get_fetch_recurse_config(const struct submodule *submodule,
1301 struct submodule_parallel_fetch *spf)
1303 if (spf->command_line_option != RECURSE_SUBMODULES_DEFAULT)
1304 return spf->command_line_option;
1310 int fetch_recurse = submodule->fetch_recurse;
1311 key = xstrfmt("submodule.%s.fetchRecurseSubmodules", submodule->name);
1312 if (!repo_config_get_string_tmp(spf->r, key, &value)) {
1313 fetch_recurse = parse_fetch_recurse_submodules_arg(key, value);
1317 if (fetch_recurse != RECURSE_SUBMODULES_NONE)
1318 /* local config overrules everything except commandline */
1319 return fetch_recurse;
1322 return spf->default_option;
1326 * Fetch in progress (if callback data) or
1327 * pending (if in oid_fetch_tasks in struct submodule_parallel_fetch)
1330 struct repository *repo;
1331 const struct submodule *sub;
1332 unsigned free_sub : 1; /* Do we need to free the submodule? */
1334 struct oid_array *commits; /* Ensure these commits are fetched */
1338 * When a submodule is not defined in .gitmodules, we cannot access it
1339 * via the regular submodule-config. Create a fake submodule, which we can
1342 static const struct submodule *get_non_gitmodules_submodule(const char *path)
1344 struct submodule *ret = NULL;
1345 const char *name = default_name_or_path(path);
1350 ret = xmalloc(sizeof(*ret));
1351 memset(ret, 0, sizeof(*ret));
1355 return (const struct submodule *) ret;
1358 static struct fetch_task *fetch_task_create(struct repository *r,
1361 struct fetch_task *task = xmalloc(sizeof(*task));
1362 memset(task, 0, sizeof(*task));
1364 task->sub = submodule_from_path(r, &null_oid, path);
1367 * No entry in .gitmodules? Technically not a submodule,
1368 * but historically we supported repositories that happen to be
1369 * in-place where a gitlink is. Keep supporting them.
1371 task->sub = get_non_gitmodules_submodule(path);
1383 static void fetch_task_release(struct fetch_task *p)
1386 free((void*)p->sub);
1391 repo_clear(p->repo);
1392 FREE_AND_NULL(p->repo);
1395 static struct repository *get_submodule_repo_for(struct repository *r,
1396 const struct submodule *sub)
1398 struct repository *ret = xmalloc(sizeof(*ret));
1400 if (repo_submodule_init(ret, r, sub)) {
1402 * No entry in .gitmodules? Technically not a submodule,
1403 * but historically we supported repositories that happen to be
1404 * in-place where a gitlink is. Keep supporting them.
1406 struct strbuf gitdir = STRBUF_INIT;
1407 strbuf_repo_worktree_path(&gitdir, r, "%s/.git", sub->path);
1408 if (repo_init(ret, gitdir.buf, NULL)) {
1409 strbuf_release(&gitdir);
1413 strbuf_release(&gitdir);
1419 static int get_next_submodule(struct child_process *cp,
1420 struct strbuf *err, void *data, void **task_cb)
1422 struct submodule_parallel_fetch *spf = data;
1424 for (; spf->count < spf->r->index->cache_nr; spf->count++) {
1425 const struct cache_entry *ce = spf->r->index->cache[spf->count];
1426 const char *default_argv;
1427 struct fetch_task *task;
1429 if (!S_ISGITLINK(ce->ce_mode))
1432 task = fetch_task_create(spf->r, ce->name);
1436 switch (get_fetch_recurse_config(task->sub, spf))
1439 case RECURSE_SUBMODULES_DEFAULT:
1440 case RECURSE_SUBMODULES_ON_DEMAND:
1442 !string_list_lookup(
1443 &spf->changed_submodule_names,
1446 default_argv = "on-demand";
1448 case RECURSE_SUBMODULES_ON:
1449 default_argv = "yes";
1451 case RECURSE_SUBMODULES_OFF:
1455 task->repo = get_submodule_repo_for(spf->r, task->sub);
1457 struct strbuf submodule_prefix = STRBUF_INIT;
1458 child_process_init(cp);
1459 cp->dir = task->repo->gitdir;
1460 prepare_submodule_repo_env_in_gitdir(&cp->env_array);
1463 strbuf_addf(err, _("Fetching submodule %s%s\n"),
1464 spf->prefix, ce->name);
1465 strvec_init(&cp->args);
1466 strvec_pushv(&cp->args, spf->args.v);
1467 strvec_push(&cp->args, default_argv);
1468 strvec_push(&cp->args, "--submodule-prefix");
1470 strbuf_addf(&submodule_prefix, "%s%s/",
1473 strvec_push(&cp->args, submodule_prefix.buf);
1478 strbuf_release(&submodule_prefix);
1481 struct strbuf empty_submodule_path = STRBUF_INIT;
1483 fetch_task_release(task);
1487 * An empty directory is normal,
1488 * the submodule is not initialized
1490 strbuf_addf(&empty_submodule_path, "%s/%s/",
1493 if (S_ISGITLINK(ce->ce_mode) &&
1494 !is_empty_dir(empty_submodule_path.buf)) {
1497 _("Could not access submodule '%s'\n"),
1500 strbuf_release(&empty_submodule_path);
1504 if (spf->oid_fetch_tasks_nr) {
1505 struct fetch_task *task =
1506 spf->oid_fetch_tasks[spf->oid_fetch_tasks_nr - 1];
1507 struct strbuf submodule_prefix = STRBUF_INIT;
1508 spf->oid_fetch_tasks_nr--;
1510 strbuf_addf(&submodule_prefix, "%s%s/",
1511 spf->prefix, task->sub->path);
1513 child_process_init(cp);
1514 prepare_submodule_repo_env_in_gitdir(&cp->env_array);
1516 cp->dir = task->repo->gitdir;
1518 strvec_init(&cp->args);
1519 strvec_pushv(&cp->args, spf->args.v);
1520 strvec_push(&cp->args, "on-demand");
1521 strvec_push(&cp->args, "--submodule-prefix");
1522 strvec_push(&cp->args, submodule_prefix.buf);
1524 /* NEEDSWORK: have get_default_remote from submodule--helper */
1525 strvec_push(&cp->args, "origin");
1526 oid_array_for_each_unique(task->commits,
1527 append_oid_to_argv, &cp->args);
1530 strbuf_release(&submodule_prefix);
1537 static int fetch_start_failure(struct strbuf *err,
1538 void *cb, void *task_cb)
1540 struct submodule_parallel_fetch *spf = cb;
1541 struct fetch_task *task = task_cb;
1545 fetch_task_release(task);
1549 static int commit_missing_in_sub(const struct object_id *oid, void *data)
1551 struct repository *subrepo = data;
1553 enum object_type type = oid_object_info(subrepo, oid, NULL);
1555 return type != OBJ_COMMIT;
1558 static int fetch_finish(int retvalue, struct strbuf *err,
1559 void *cb, void *task_cb)
1561 struct submodule_parallel_fetch *spf = cb;
1562 struct fetch_task *task = task_cb;
1564 struct string_list_item *it;
1565 struct oid_array *commits;
1567 if (!task || !task->sub)
1568 BUG("callback cookie bogus");
1572 * NEEDSWORK: This indicates that the overall fetch
1573 * failed, even though there may be a subsequent fetch
1574 * by commit hash that might work. It may be a good
1575 * idea to not indicate failure in this case, and only
1576 * indicate failure if the subsequent fetch fails.
1580 strbuf_addf(&spf->submodules_with_errors, "\t%s\n",
1584 /* Is this the second time we process this submodule? */
1588 it = string_list_lookup(&spf->changed_submodule_names, task->sub->name);
1590 /* Could be an unchanged submodule, not contained in the list */
1594 oid_array_filter(commits,
1595 commit_missing_in_sub,
1598 /* Are there commits we want, but do not exist? */
1600 task->commits = commits;
1601 ALLOC_GROW(spf->oid_fetch_tasks,
1602 spf->oid_fetch_tasks_nr + 1,
1603 spf->oid_fetch_tasks_alloc);
1604 spf->oid_fetch_tasks[spf->oid_fetch_tasks_nr] = task;
1605 spf->oid_fetch_tasks_nr++;
1610 fetch_task_release(task);
1615 int fetch_populated_submodules(struct repository *r,
1616 const struct strvec *options,
1617 const char *prefix, int command_line_option,
1619 int quiet, int max_parallel_jobs)
1622 struct submodule_parallel_fetch spf = SPF_INIT;
1625 spf.command_line_option = command_line_option;
1626 spf.default_option = default_option;
1628 spf.prefix = prefix;
1633 if (repo_read_index(r) < 0)
1634 die(_("index file corrupt"));
1636 strvec_push(&spf.args, "fetch");
1637 for (i = 0; i < options->nr; i++)
1638 strvec_push(&spf.args, options->v[i]);
1639 strvec_push(&spf.args, "--recurse-submodules-default");
1640 /* default value, "--submodule-prefix" and its value are added later */
1642 calculate_changed_submodule_paths(r, &spf.changed_submodule_names);
1643 string_list_sort(&spf.changed_submodule_names);
1644 run_processes_parallel_tr2(max_parallel_jobs,
1646 fetch_start_failure,
1649 "submodule", "parallel/fetch");
1651 if (spf.submodules_with_errors.len > 0)
1652 fprintf(stderr, _("Errors during submodule fetch:\n%s"),
1653 spf.submodules_with_errors.buf);
1656 strvec_clear(&spf.args);
1658 free_submodules_oids(&spf.changed_submodule_names);
1662 unsigned is_submodule_modified(const char *path, int ignore_untracked)
1664 struct child_process cp = CHILD_PROCESS_INIT;
1665 struct strbuf buf = STRBUF_INIT;
1667 unsigned dirty_submodule = 0;
1668 const char *git_dir;
1669 int ignore_cp_exit_code = 0;
1671 strbuf_addf(&buf, "%s/.git", path);
1672 git_dir = read_gitfile(buf.buf);
1675 if (!is_git_directory(git_dir)) {
1676 if (is_directory(git_dir))
1677 die(_("'%s' not recognized as a git repository"), git_dir);
1678 strbuf_release(&buf);
1679 /* The submodule is not checked out, so it is not modified */
1684 strvec_pushl(&cp.args, "status", "--porcelain=2", NULL);
1685 if (ignore_untracked)
1686 strvec_push(&cp.args, "-uno");
1688 prepare_submodule_repo_env(&cp.env_array);
1693 if (start_command(&cp))
1694 die(_("Could not run 'git status --porcelain=2' in submodule %s"), path);
1696 fp = xfdopen(cp.out, "r");
1697 while (strbuf_getwholeline(&buf, fp, '\n') != EOF) {
1698 /* regular untracked files */
1699 if (buf.buf[0] == '?')
1700 dirty_submodule |= DIRTY_SUBMODULE_UNTRACKED;
1702 if (buf.buf[0] == 'u' ||
1703 buf.buf[0] == '1' ||
1704 buf.buf[0] == '2') {
1705 /* T = line type, XY = status, SSSS = submodule state */
1706 if (buf.len < strlen("T XY SSSS"))
1707 BUG("invalid status --porcelain=2 line %s",
1710 if (buf.buf[5] == 'S' && buf.buf[8] == 'U')
1711 /* nested untracked file */
1712 dirty_submodule |= DIRTY_SUBMODULE_UNTRACKED;
1714 if (buf.buf[0] == 'u' ||
1715 buf.buf[0] == '2' ||
1716 memcmp(buf.buf + 5, "S..U", 4))
1718 dirty_submodule |= DIRTY_SUBMODULE_MODIFIED;
1721 if ((dirty_submodule & DIRTY_SUBMODULE_MODIFIED) &&
1722 ((dirty_submodule & DIRTY_SUBMODULE_UNTRACKED) ||
1723 ignore_untracked)) {
1725 * We're not interested in any further information from
1726 * the child any more, neither output nor its exit code.
1728 ignore_cp_exit_code = 1;
1734 if (finish_command(&cp) && !ignore_cp_exit_code)
1735 die(_("'git status --porcelain=2' failed in submodule %s"), path);
1737 strbuf_release(&buf);
1738 return dirty_submodule;
1741 int submodule_uses_gitfile(const char *path)
1743 struct child_process cp = CHILD_PROCESS_INIT;
1744 struct strbuf buf = STRBUF_INIT;
1745 const char *git_dir;
1747 strbuf_addf(&buf, "%s/.git", path);
1748 git_dir = read_gitfile(buf.buf);
1750 strbuf_release(&buf);
1753 strbuf_release(&buf);
1755 /* Now test that all nested submodules use a gitfile too */
1756 strvec_pushl(&cp.args,
1757 "submodule", "foreach", "--quiet", "--recursive",
1758 "test -f .git", NULL);
1760 prepare_submodule_repo_env(&cp.env_array);
1766 if (run_command(&cp))
1773 * Check if it is a bad idea to remove a submodule, i.e. if we'd lose data
1776 * Return 1 if we'd lose data, return 0 if the removal is fine,
1777 * and negative values for errors.
1779 int bad_to_remove_submodule(const char *path, unsigned flags)
1782 struct child_process cp = CHILD_PROCESS_INIT;
1783 struct strbuf buf = STRBUF_INIT;
1786 if (!file_exists(path) || is_empty_dir(path))
1789 if (!submodule_uses_gitfile(path))
1792 strvec_pushl(&cp.args, "status", "--porcelain",
1793 "--ignore-submodules=none", NULL);
1795 if (flags & SUBMODULE_REMOVAL_IGNORE_UNTRACKED)
1796 strvec_push(&cp.args, "-uno");
1798 strvec_push(&cp.args, "-uall");
1800 if (!(flags & SUBMODULE_REMOVAL_IGNORE_IGNORED_UNTRACKED))
1801 strvec_push(&cp.args, "--ignored");
1803 prepare_submodule_repo_env(&cp.env_array);
1808 if (start_command(&cp)) {
1809 if (flags & SUBMODULE_REMOVAL_DIE_ON_ERROR)
1810 die(_("could not start 'git status' in submodule '%s'"),
1816 len = strbuf_read(&buf, cp.out, 1024);
1821 if (finish_command(&cp)) {
1822 if (flags & SUBMODULE_REMOVAL_DIE_ON_ERROR)
1823 die(_("could not run 'git status' in submodule '%s'"),
1828 strbuf_release(&buf);
1832 void submodule_unset_core_worktree(const struct submodule *sub)
1834 char *config_path = xstrfmt("%s/modules/%s/config",
1835 get_git_dir(), sub->name);
1837 if (git_config_set_in_file_gently(config_path, "core.worktree", NULL))
1838 warning(_("Could not unset core.worktree setting in submodule '%s'"),
1844 static const char *get_super_prefix_or_empty(void)
1846 const char *s = get_super_prefix();
1852 static int submodule_has_dirty_index(const struct submodule *sub)
1854 struct child_process cp = CHILD_PROCESS_INIT;
1856 prepare_submodule_repo_env(&cp.env_array);
1859 strvec_pushl(&cp.args, "diff-index", "--quiet",
1860 "--cached", "HEAD", NULL);
1864 if (start_command(&cp))
1865 die(_("could not recurse into submodule '%s'"), sub->path);
1867 return finish_command(&cp);
1870 static void submodule_reset_index(const char *path)
1872 struct child_process cp = CHILD_PROCESS_INIT;
1873 prepare_submodule_repo_env(&cp.env_array);
1879 strvec_pushf(&cp.args, "--super-prefix=%s%s/",
1880 get_super_prefix_or_empty(), path);
1881 strvec_pushl(&cp.args, "read-tree", "-u", "--reset", NULL);
1883 strvec_push(&cp.args, empty_tree_oid_hex());
1885 if (run_command(&cp))
1886 die(_("could not reset submodule index"));
1890 * Moves a submodule at a given path from a given head to another new head.
1891 * For edge cases (a submodule coming into existence or removing a submodule)
1892 * pass NULL for old or new respectively.
1894 int submodule_move_head(const char *path,
1895 const char *old_head,
1896 const char *new_head,
1900 struct child_process cp = CHILD_PROCESS_INIT;
1901 const struct submodule *sub;
1902 int *error_code_ptr, error_code;
1904 if (!is_submodule_active(the_repository, path))
1907 if (flags & SUBMODULE_MOVE_HEAD_FORCE)
1909 * Pass non NULL pointer to is_submodule_populated_gently
1910 * to prevent die()-ing. We'll use connect_work_tree_and_git_dir
1911 * to fixup the submodule in the force case later.
1913 error_code_ptr = &error_code;
1915 error_code_ptr = NULL;
1917 if (old_head && !is_submodule_populated_gently(path, error_code_ptr))
1920 sub = submodule_from_path(the_repository, &null_oid, path);
1923 BUG("could not get submodule information for '%s'", path);
1925 if (old_head && !(flags & SUBMODULE_MOVE_HEAD_FORCE)) {
1926 /* Check if the submodule has a dirty index. */
1927 if (submodule_has_dirty_index(sub))
1928 return error(_("submodule '%s' has dirty index"), path);
1931 if (!(flags & SUBMODULE_MOVE_HEAD_DRY_RUN)) {
1933 if (!submodule_uses_gitfile(path))
1934 absorb_git_dir_into_superproject(path,
1935 ABSORB_GITDIR_RECURSE_SUBMODULES);
1937 char *gitdir = xstrfmt("%s/modules/%s",
1938 get_git_dir(), sub->name);
1939 connect_work_tree_and_git_dir(path, gitdir, 0);
1942 /* make sure the index is clean as well */
1943 submodule_reset_index(path);
1946 if (old_head && (flags & SUBMODULE_MOVE_HEAD_FORCE)) {
1947 char *gitdir = xstrfmt("%s/modules/%s",
1948 get_git_dir(), sub->name);
1949 connect_work_tree_and_git_dir(path, gitdir, 1);
1954 prepare_submodule_repo_env(&cp.env_array);
1960 strvec_pushf(&cp.args, "--super-prefix=%s%s/",
1961 get_super_prefix_or_empty(), path);
1962 strvec_pushl(&cp.args, "read-tree", "--recurse-submodules", NULL);
1964 if (flags & SUBMODULE_MOVE_HEAD_DRY_RUN)
1965 strvec_push(&cp.args, "-n");
1967 strvec_push(&cp.args, "-u");
1969 if (flags & SUBMODULE_MOVE_HEAD_FORCE)
1970 strvec_push(&cp.args, "--reset");
1972 strvec_push(&cp.args, "-m");
1974 if (!(flags & SUBMODULE_MOVE_HEAD_FORCE))
1975 strvec_push(&cp.args, old_head ? old_head : empty_tree_oid_hex());
1977 strvec_push(&cp.args, new_head ? new_head : empty_tree_oid_hex());
1979 if (run_command(&cp)) {
1980 ret = error(_("Submodule '%s' could not be updated."), path);
1984 if (!(flags & SUBMODULE_MOVE_HEAD_DRY_RUN)) {
1986 child_process_init(&cp);
1987 /* also set the HEAD accordingly */
1992 prepare_submodule_repo_env(&cp.env_array);
1993 strvec_pushl(&cp.args, "update-ref", "HEAD",
1994 "--no-deref", new_head, NULL);
1996 if (run_command(&cp)) {
2001 struct strbuf sb = STRBUF_INIT;
2003 strbuf_addf(&sb, "%s/.git", path);
2004 unlink_or_warn(sb.buf);
2005 strbuf_release(&sb);
2007 if (is_empty_dir(path))
2008 rmdir_or_warn(path);
2010 submodule_unset_core_worktree(sub);
2017 int validate_submodule_git_dir(char *git_dir, const char *submodule_name)
2019 size_t len = strlen(git_dir), suffix_len = strlen(submodule_name);
2023 if (len <= suffix_len || (p = git_dir + len - suffix_len)[-1] != '/' ||
2024 strcmp(p, submodule_name))
2025 BUG("submodule name '%s' not a suffix of git dir '%s'",
2026 submodule_name, git_dir);
2029 * We prevent the contents of sibling submodules' git directories to
2032 * Example: having a submodule named `hippo` and another one named
2033 * `hippo/hooks` would result in the git directories
2034 * `.git/modules/hippo/` and `.git/modules/hippo/hooks/`, respectively,
2035 * but the latter directory is already designated to contain the hooks
2039 if (is_dir_sep(*p)) {
2043 if (is_git_directory(git_dir))
2048 return error(_("submodule git dir '%s' is "
2049 "inside git dir '%.*s'"),
2051 (int)(p - git_dir), git_dir);
2059 * Embeds a single submodules git directory into the superprojects git dir,
2062 static void relocate_single_git_dir_into_superproject(const char *path)
2064 char *old_git_dir = NULL, *real_old_git_dir = NULL, *real_new_git_dir = NULL;
2066 const struct submodule *sub;
2068 if (submodule_uses_worktrees(path))
2069 die(_("relocate_gitdir for submodule '%s' with "
2070 "more than one worktree not supported"), path);
2072 old_git_dir = xstrfmt("%s/.git", path);
2073 if (read_gitfile(old_git_dir))
2074 /* If it is an actual gitfile, it doesn't need migration. */
2077 real_old_git_dir = real_pathdup(old_git_dir, 1);
2079 sub = submodule_from_path(the_repository, &null_oid, path);
2081 die(_("could not lookup name for submodule '%s'"), path);
2083 new_git_dir = git_pathdup("modules/%s", sub->name);
2084 if (validate_submodule_git_dir(new_git_dir, sub->name) < 0)
2085 die(_("refusing to move '%s' into an existing git dir"),
2087 if (safe_create_leading_directories_const(new_git_dir) < 0)
2088 die(_("could not create directory '%s'"), new_git_dir);
2089 real_new_git_dir = real_pathdup(new_git_dir, 1);
2092 fprintf(stderr, _("Migrating git directory of '%s%s' from\n'%s' to\n'%s'\n"),
2093 get_super_prefix_or_empty(), path,
2094 real_old_git_dir, real_new_git_dir);
2096 relocate_gitdir(path, real_old_git_dir, real_new_git_dir);
2099 free(real_old_git_dir);
2100 free(real_new_git_dir);
2104 * Migrate the git directory of the submodule given by path from
2105 * having its git directory within the working tree to the git dir nested
2106 * in its superprojects git dir under modules/.
2108 void absorb_git_dir_into_superproject(const char *path,
2112 const char *sub_git_dir;
2113 struct strbuf gitdir = STRBUF_INIT;
2114 strbuf_addf(&gitdir, "%s/.git", path);
2115 sub_git_dir = resolve_gitdir_gently(gitdir.buf, &err_code);
2117 /* Not populated? */
2119 const struct submodule *sub;
2121 if (err_code == READ_GITFILE_ERR_STAT_FAILED) {
2122 /* unpopulated as expected */
2123 strbuf_release(&gitdir);
2127 if (err_code != READ_GITFILE_ERR_NOT_A_REPO)
2128 /* We don't know what broke here. */
2129 read_gitfile_error_die(err_code, path, NULL);
2132 * Maybe populated, but no git directory was found?
2133 * This can happen if the superproject is a submodule
2134 * itself and was just absorbed. The absorption of the
2135 * superproject did not rewrite the git file links yet,
2138 sub = submodule_from_path(the_repository, &null_oid, path);
2140 die(_("could not lookup name for submodule '%s'"), path);
2141 connect_work_tree_and_git_dir(path,
2142 git_path("modules/%s", sub->name), 0);
2144 /* Is it already absorbed into the superprojects git dir? */
2145 char *real_sub_git_dir = real_pathdup(sub_git_dir, 1);
2146 char *real_common_git_dir = real_pathdup(get_git_common_dir(), 1);
2148 if (!starts_with(real_sub_git_dir, real_common_git_dir))
2149 relocate_single_git_dir_into_superproject(path);
2151 free(real_sub_git_dir);
2152 free(real_common_git_dir);
2154 strbuf_release(&gitdir);
2156 if (flags & ABSORB_GITDIR_RECURSE_SUBMODULES) {
2157 struct child_process cp = CHILD_PROCESS_INIT;
2158 struct strbuf sb = STRBUF_INIT;
2160 if (flags & ~ABSORB_GITDIR_RECURSE_SUBMODULES)
2161 BUG("we don't know how to pass the flags down?");
2163 strbuf_addstr(&sb, get_super_prefix_or_empty());
2164 strbuf_addstr(&sb, path);
2165 strbuf_addch(&sb, '/');
2170 strvec_pushl(&cp.args, "--super-prefix", sb.buf,
2171 "submodule--helper",
2172 "absorb-git-dirs", NULL);
2173 prepare_submodule_repo_env(&cp.env_array);
2174 if (run_command(&cp))
2175 die(_("could not recurse into submodule '%s'"), path);
2177 strbuf_release(&sb);
2181 int get_superproject_working_tree(struct strbuf *buf)
2183 struct child_process cp = CHILD_PROCESS_INIT;
2184 struct strbuf sb = STRBUF_INIT;
2185 struct strbuf one_up = STRBUF_INIT;
2186 const char *cwd = xgetcwd();
2188 const char *subpath;
2192 if (!is_inside_work_tree())
2195 * We might have a superproject, but it is harder
2200 if (!strbuf_realpath(&one_up, "../", 0))
2203 subpath = relative_path(cwd, one_up.buf, &sb);
2204 strbuf_release(&one_up);
2206 prepare_submodule_repo_env(&cp.env_array);
2207 strvec_pop(&cp.env_array);
2209 strvec_pushl(&cp.args, "--literal-pathspecs", "-C", "..",
2210 "ls-files", "-z", "--stage", "--full-name", "--",
2219 if (start_command(&cp))
2220 die(_("could not start ls-files in .."));
2222 len = strbuf_read(&sb, cp.out, PATH_MAX);
2225 if (starts_with(sb.buf, "160000")) {
2227 int cwd_len = strlen(cwd);
2228 char *super_sub, *super_wt;
2231 * There is a superproject having this repo as a submodule.
2232 * The format is <mode> SP <hash> SP <stage> TAB <full name> \0,
2233 * We're only interested in the name after the tab.
2235 super_sub = strchr(sb.buf, '\t') + 1;
2236 super_sub_len = strlen(super_sub);
2238 if (super_sub_len > cwd_len ||
2239 strcmp(&cwd[cwd_len - super_sub_len], super_sub))
2240 BUG("returned path string doesn't match cwd?");
2242 super_wt = xstrdup(cwd);
2243 super_wt[cwd_len - super_sub_len] = '\0';
2245 strbuf_realpath(buf, super_wt, 1);
2249 strbuf_release(&sb);
2251 code = finish_command(&cp);
2254 /* '../' is not a git repository */
2256 if (code == 0 && len == 0)
2257 /* There is an unrelated git repository at '../' */
2260 die(_("ls-tree returned unexpected return code %d"), code);
2266 * Put the gitdir for a submodule (given relative to the main
2267 * repository worktree) into `buf`, or return -1 on error.
2269 int submodule_to_gitdir(struct strbuf *buf, const char *submodule)
2271 const struct submodule *sub;
2272 const char *git_dir;
2276 strbuf_addstr(buf, submodule);
2277 strbuf_complete(buf, '/');
2278 strbuf_addstr(buf, ".git");
2280 git_dir = read_gitfile(buf->buf);
2283 strbuf_addstr(buf, git_dir);
2285 if (!is_git_directory(buf->buf)) {
2286 sub = submodule_from_path(the_repository, &null_oid, submodule);
2292 strbuf_git_path(buf, "%s/%s", "modules", sub->name);