1 #define NO_THE_INDEX_COMPATIBILITY_MACROS
4 #include "repository.h"
6 #include "submodule-config.h"
12 #include "run-command.h"
15 #include "string-list.h"
16 #include "sha1-array.h"
17 #include "argv-array.h"
19 #include "thread-utils.h"
23 #include "parse-options.h"
24 #include "object-store.h"
25 #include "commit-reach.h"
27 static int config_update_recurse_submodules = RECURSE_SUBMODULES_OFF;
28 static struct string_list changed_submodule_names = STRING_LIST_INIT_DUP;
29 static int initialized_fetch_ref_tips;
30 static struct oid_array ref_tips_before_fetch;
31 static struct oid_array ref_tips_after_fetch;
34 * Check if the .gitmodules file is unmerged. Parsing of the .gitmodules file
35 * will be disabled because we can't guess what might be configured in
36 * .gitmodules unless the user resolves the conflict.
38 int is_gitmodules_unmerged(const struct index_state *istate)
40 int pos = index_name_pos(istate, GITMODULES_FILE, strlen(GITMODULES_FILE));
41 if (pos < 0) { /* .gitmodules not found or isn't merged */
43 if (istate->cache_nr > pos) { /* there is a .gitmodules */
44 const struct cache_entry *ce = istate->cache[pos];
45 if (ce_namelen(ce) == strlen(GITMODULES_FILE) &&
46 !strcmp(ce->name, GITMODULES_FILE))
55 * Check if the .gitmodules file is safe to write.
57 * Writing to the .gitmodules file requires that the file exists in the
58 * working tree or, if it doesn't, that a brand new .gitmodules file is going
59 * to be created (i.e. it's neither in the index nor in the current branch).
61 * It is not safe to write to .gitmodules if it's not in the working tree but
62 * it is in the index or in the current branch, because writing new values
63 * (and staging them) would blindly overwrite ALL the old content.
65 int is_writing_gitmodules_ok(void)
68 return file_exists(GITMODULES_FILE) ||
69 (get_oid(GITMODULES_INDEX, &oid) < 0 && get_oid(GITMODULES_HEAD, &oid) < 0);
73 * Check if the .gitmodules file has unstaged modifications. This must be
74 * checked before allowing modifications to the .gitmodules file with the
75 * intention to stage them later, because when continuing we would stage the
76 * modifications the user didn't stage herself too. That might change in a
77 * future version when we learn to stage the changes we do ourselves without
78 * staging any previous modifications.
80 int is_staging_gitmodules_ok(struct index_state *istate)
82 int pos = index_name_pos(istate, GITMODULES_FILE, strlen(GITMODULES_FILE));
84 if ((pos >= 0) && (pos < istate->cache_nr)) {
86 if (lstat(GITMODULES_FILE, &st) == 0 &&
87 ie_match_stat(istate, istate->cache[pos], &st, 0) & DATA_CHANGED)
94 static int for_each_remote_ref_submodule(const char *submodule,
95 each_ref_fn fn, void *cb_data)
97 return refs_for_each_remote_ref(get_submodule_ref_store(submodule),
102 * Try to update the "path" entry in the "submodule.<name>" section of the
103 * .gitmodules file. Return 0 only if a .gitmodules file was found, a section
104 * with the correct path=<oldpath> setting was found and we could update it.
106 int update_path_in_gitmodules(const char *oldpath, const char *newpath)
108 struct strbuf entry = STRBUF_INIT;
109 const struct submodule *submodule;
112 if (!file_exists(GITMODULES_FILE)) /* Do nothing without .gitmodules */
115 if (is_gitmodules_unmerged(the_repository->index))
116 die(_("Cannot change unmerged .gitmodules, resolve merge conflicts first"));
118 submodule = submodule_from_path(the_repository, &null_oid, oldpath);
119 if (!submodule || !submodule->name) {
120 warning(_("Could not find section in .gitmodules where path=%s"), oldpath);
123 strbuf_addstr(&entry, "submodule.");
124 strbuf_addstr(&entry, submodule->name);
125 strbuf_addstr(&entry, ".path");
126 ret = config_set_in_gitmodules_file_gently(entry.buf, newpath);
127 strbuf_release(&entry);
132 * Try to remove the "submodule.<name>" section from .gitmodules where the given
133 * path is configured. Return 0 only if a .gitmodules file was found, a section
134 * with the correct path=<path> setting was found and we could remove it.
136 int remove_path_from_gitmodules(const char *path)
138 struct strbuf sect = STRBUF_INIT;
139 const struct submodule *submodule;
141 if (!file_exists(GITMODULES_FILE)) /* Do nothing without .gitmodules */
144 if (is_gitmodules_unmerged(the_repository->index))
145 die(_("Cannot change unmerged .gitmodules, resolve merge conflicts first"));
147 submodule = submodule_from_path(the_repository, &null_oid, path);
148 if (!submodule || !submodule->name) {
149 warning(_("Could not find section in .gitmodules where path=%s"), path);
152 strbuf_addstr(§, "submodule.");
153 strbuf_addstr(§, submodule->name);
154 if (git_config_rename_section_in_file(GITMODULES_FILE, sect.buf, NULL) < 0) {
155 /* Maybe the user already did that, don't error out here */
156 warning(_("Could not remove .gitmodules entry for %s"), path);
157 strbuf_release(§);
160 strbuf_release(§);
164 void stage_updated_gitmodules(struct index_state *istate)
166 if (add_file_to_index(istate, GITMODULES_FILE, 0))
167 die(_("staging updated .gitmodules failed"));
170 /* TODO: remove this function, use repo_submodule_init instead. */
171 int add_submodule_odb(const char *path)
173 struct strbuf objects_directory = STRBUF_INIT;
176 ret = strbuf_git_path_submodule(&objects_directory, path, "objects/");
179 if (!is_directory(objects_directory.buf)) {
183 add_to_alternates_memory(objects_directory.buf);
185 strbuf_release(&objects_directory);
189 void set_diffopt_flags_from_submodule_config(struct diff_options *diffopt,
192 const struct submodule *submodule = submodule_from_path(the_repository,
198 key = xstrfmt("submodule.%s.ignore", submodule->name);
199 if (repo_config_get_string_const(the_repository, key, &ignore))
200 ignore = submodule->ignore;
204 handle_ignore_submodules_arg(diffopt, ignore);
205 else if (is_gitmodules_unmerged(the_repository->index))
206 diffopt->flags.ignore_submodules = 1;
210 /* Cheap function that only determines if we're interested in submodules at all */
211 int git_default_submodule_config(const char *var, const char *value, void *cb)
213 if (!strcmp(var, "submodule.recurse")) {
214 int v = git_config_bool(var, value) ?
215 RECURSE_SUBMODULES_ON : RECURSE_SUBMODULES_OFF;
216 config_update_recurse_submodules = v;
221 int option_parse_recurse_submodules_worktree_updater(const struct option *opt,
222 const char *arg, int unset)
225 config_update_recurse_submodules = RECURSE_SUBMODULES_OFF;
229 config_update_recurse_submodules =
230 parse_update_recurse_submodules_arg(opt->long_name,
233 config_update_recurse_submodules = RECURSE_SUBMODULES_ON;
239 * Determine if a submodule has been initialized at a given 'path'
241 int is_submodule_active(struct repository *repo, const char *path)
246 const struct string_list *sl;
247 const struct submodule *module;
249 module = submodule_from_path(repo, &null_oid, path);
251 /* early return if there isn't a path->module mapping */
255 /* submodule.<name>.active is set */
256 key = xstrfmt("submodule.%s.active", module->name);
257 if (!repo_config_get_bool(repo, key, &ret)) {
263 /* submodule.active is set */
264 sl = repo_config_get_value_multi(repo, "submodule.active");
267 struct argv_array args = ARGV_ARRAY_INIT;
268 const struct string_list_item *item;
270 for_each_string_list_item(item, sl) {
271 argv_array_push(&args, item->string);
274 parse_pathspec(&ps, 0, 0, NULL, args.argv);
275 ret = match_pathspec(repo->index, &ps, path, strlen(path), 0, NULL, 1);
277 argv_array_clear(&args);
282 /* fallback to checking if the URL is set */
283 key = xstrfmt("submodule.%s.url", module->name);
284 ret = !repo_config_get_string(repo, key, &value);
291 int is_submodule_populated_gently(const char *path, int *return_error_code)
294 char *gitdir = xstrfmt("%s/.git", path);
296 if (resolve_gitdir_gently(gitdir, return_error_code))
304 * Dies if the provided 'prefix' corresponds to an unpopulated submodule
306 void die_in_unpopulated_submodule(const struct index_state *istate,
314 prefixlen = strlen(prefix);
316 for (i = 0; i < istate->cache_nr; i++) {
317 struct cache_entry *ce = istate->cache[i];
318 int ce_len = ce_namelen(ce);
320 if (!S_ISGITLINK(ce->ce_mode))
322 if (prefixlen <= ce_len)
324 if (strncmp(ce->name, prefix, ce_len))
326 if (prefix[ce_len] != '/')
329 die(_("in unpopulated submodule '%s'"), ce->name);
334 * Dies if any paths in the provided pathspec descends into a submodule
336 void die_path_inside_submodule(const struct index_state *istate,
337 const struct pathspec *ps)
341 for (i = 0; i < istate->cache_nr; i++) {
342 struct cache_entry *ce = istate->cache[i];
343 int ce_len = ce_namelen(ce);
345 if (!S_ISGITLINK(ce->ce_mode))
348 for (j = 0; j < ps->nr ; j++) {
349 const struct pathspec_item *item = &ps->items[j];
351 if (item->len <= ce_len)
353 if (item->match[ce_len] != '/')
355 if (strncmp(ce->name, item->match, ce_len))
357 if (item->len == ce_len + 1)
360 die(_("Pathspec '%s' is in submodule '%.*s'"),
361 item->original, ce_len, ce->name);
366 enum submodule_update_type parse_submodule_update_type(const char *value)
368 if (!strcmp(value, "none"))
369 return SM_UPDATE_NONE;
370 else if (!strcmp(value, "checkout"))
371 return SM_UPDATE_CHECKOUT;
372 else if (!strcmp(value, "rebase"))
373 return SM_UPDATE_REBASE;
374 else if (!strcmp(value, "merge"))
375 return SM_UPDATE_MERGE;
376 else if (*value == '!')
377 return SM_UPDATE_COMMAND;
379 return SM_UPDATE_UNSPECIFIED;
382 int parse_submodule_update_strategy(const char *value,
383 struct submodule_update_strategy *dst)
385 enum submodule_update_type type;
387 free((void*)dst->command);
390 type = parse_submodule_update_type(value);
391 if (type == SM_UPDATE_UNSPECIFIED)
395 if (type == SM_UPDATE_COMMAND)
396 dst->command = xstrdup(value + 1);
401 const char *submodule_strategy_to_string(const struct submodule_update_strategy *s)
403 struct strbuf sb = STRBUF_INIT;
405 case SM_UPDATE_CHECKOUT:
407 case SM_UPDATE_MERGE:
409 case SM_UPDATE_REBASE:
413 case SM_UPDATE_UNSPECIFIED:
415 case SM_UPDATE_COMMAND:
416 strbuf_addf(&sb, "!%s", s->command);
417 return strbuf_detach(&sb, NULL);
422 void handle_ignore_submodules_arg(struct diff_options *diffopt,
425 diffopt->flags.ignore_submodules = 0;
426 diffopt->flags.ignore_untracked_in_submodules = 0;
427 diffopt->flags.ignore_dirty_submodules = 0;
429 if (!strcmp(arg, "all"))
430 diffopt->flags.ignore_submodules = 1;
431 else if (!strcmp(arg, "untracked"))
432 diffopt->flags.ignore_untracked_in_submodules = 1;
433 else if (!strcmp(arg, "dirty"))
434 diffopt->flags.ignore_dirty_submodules = 1;
435 else if (strcmp(arg, "none"))
436 die("bad --ignore-submodules argument: %s", arg);
439 static int prepare_submodule_summary(struct rev_info *rev, const char *path,
440 struct commit *left, struct commit *right,
441 struct commit_list *merge_bases)
443 struct commit_list *list;
445 repo_init_revisions(the_repository, rev, NULL);
446 setup_revisions(0, NULL, rev, NULL);
448 rev->first_parent_only = 1;
449 left->object.flags |= SYMMETRIC_LEFT;
450 add_pending_object(rev, &left->object, path);
451 add_pending_object(rev, &right->object, path);
452 for (list = merge_bases; list; list = list->next) {
453 list->item->object.flags |= UNINTERESTING;
454 add_pending_object(rev, &list->item->object,
455 oid_to_hex(&list->item->object.oid));
457 return prepare_revision_walk(rev);
460 static void print_submodule_summary(struct repository *r, struct rev_info *rev, struct diff_options *o)
462 static const char format[] = " %m %s";
463 struct strbuf sb = STRBUF_INIT;
464 struct commit *commit;
466 while ((commit = get_revision(rev))) {
467 struct pretty_print_context ctx = {0};
468 ctx.date_mode = rev->date_mode;
469 ctx.output_encoding = get_log_output_encoding();
470 strbuf_setlen(&sb, 0);
471 repo_format_commit_message(r, commit, format, &sb,
473 strbuf_addch(&sb, '\n');
474 if (commit->object.flags & SYMMETRIC_LEFT)
475 diff_emit_submodule_del(o, sb.buf);
477 diff_emit_submodule_add(o, sb.buf);
482 static void prepare_submodule_repo_env_no_git_dir(struct argv_array *out)
484 const char * const *var;
486 for (var = local_repo_env; *var; var++) {
487 if (strcmp(*var, CONFIG_DATA_ENVIRONMENT))
488 argv_array_push(out, *var);
492 void prepare_submodule_repo_env(struct argv_array *out)
494 prepare_submodule_repo_env_no_git_dir(out);
495 argv_array_pushf(out, "%s=%s", GIT_DIR_ENVIRONMENT,
496 DEFAULT_GIT_DIR_ENVIRONMENT);
500 * Initialize a repository struct for a submodule based on the provided 'path'.
502 * Unlike repo_submodule_init, this tolerates submodules not present
503 * in .gitmodules. This function exists only to preserve historical behavior,
505 * Returns the repository struct on success,
506 * NULL when the submodule is not present.
508 static struct repository *open_submodule(const char *path)
510 struct strbuf sb = STRBUF_INIT;
511 struct repository *out = xmalloc(sizeof(*out));
513 if (submodule_to_gitdir(&sb, path) || repo_init(out, sb.buf, NULL)) {
519 /* Mark it as a submodule */
520 out->submodule_prefix = xstrdup(path);
527 * Helper function to display the submodule header line prior to the full
530 * If it can locate the submodule git directory it will create a repository
531 * handle for the submodule and lookup both the left and right commits and
532 * put them into the left and right pointers.
534 static void show_submodule_header(struct diff_options *o,
536 struct object_id *one, struct object_id *two,
537 unsigned dirty_submodule,
538 struct repository *sub,
539 struct commit **left, struct commit **right,
540 struct commit_list **merge_bases)
542 const char *message = NULL;
543 struct strbuf sb = STRBUF_INIT;
544 int fast_forward = 0, fast_backward = 0;
546 if (dirty_submodule & DIRTY_SUBMODULE_UNTRACKED)
547 diff_emit_submodule_untracked(o, path);
549 if (dirty_submodule & DIRTY_SUBMODULE_MODIFIED)
550 diff_emit_submodule_modified(o, path);
552 if (is_null_oid(one))
553 message = "(new submodule)";
554 else if (is_null_oid(two))
555 message = "(submodule deleted)";
559 message = "(commits not present)";
564 * Attempt to lookup the commit references, and determine if this is
565 * a fast forward or fast backwards update.
567 *left = lookup_commit_reference(sub, one);
568 *right = lookup_commit_reference(sub, two);
571 * Warn about missing commits in the submodule project, but only if
574 if ((!is_null_oid(one) && !*left) ||
575 (!is_null_oid(two) && !*right))
576 message = "(commits not present)";
578 *merge_bases = repo_get_merge_bases(sub, *left, *right);
580 if ((*merge_bases)->item == *left)
582 else if ((*merge_bases)->item == *right)
586 if (oideq(one, two)) {
592 strbuf_addf(&sb, "Submodule %s ", path);
593 strbuf_add_unique_abbrev(&sb, one, DEFAULT_ABBREV);
594 strbuf_addstr(&sb, (fast_backward || fast_forward) ? ".." : "...");
595 strbuf_add_unique_abbrev(&sb, two, DEFAULT_ABBREV);
597 strbuf_addf(&sb, " %s\n", message);
599 strbuf_addf(&sb, "%s:\n", fast_backward ? " (rewind)" : "");
600 diff_emit_submodule_header(o, sb.buf);
605 void show_submodule_summary(struct diff_options *o, const char *path,
606 struct object_id *one, struct object_id *two,
607 unsigned dirty_submodule)
610 struct commit *left = NULL, *right = NULL;
611 struct commit_list *merge_bases = NULL;
612 struct repository *sub;
614 sub = open_submodule(path);
615 show_submodule_header(o, path, one, two, dirty_submodule,
616 sub, &left, &right, &merge_bases);
619 * If we don't have both a left and a right pointer, there is no
620 * reason to try and display a summary. The header line should contain
621 * all the information the user needs.
623 if (!left || !right || !sub)
626 /* Treat revision walker failure the same as missing commits */
627 if (prepare_submodule_summary(&rev, path, left, right, merge_bases)) {
628 diff_emit_submodule_error(o, "(revision walker failed)\n");
632 print_submodule_summary(sub, &rev, o);
636 free_commit_list(merge_bases);
637 clear_commit_marks(left, ~0);
638 clear_commit_marks(right, ~0);
645 void show_submodule_inline_diff(struct diff_options *o, const char *path,
646 struct object_id *one, struct object_id *two,
647 unsigned dirty_submodule)
649 const struct object_id *old_oid = the_hash_algo->empty_tree, *new_oid = the_hash_algo->empty_tree;
650 struct commit *left = NULL, *right = NULL;
651 struct commit_list *merge_bases = NULL;
652 struct child_process cp = CHILD_PROCESS_INIT;
653 struct strbuf sb = STRBUF_INIT;
654 struct repository *sub;
656 sub = open_submodule(path);
657 show_submodule_header(o, path, one, two, dirty_submodule,
658 sub, &left, &right, &merge_bases);
660 /* We need a valid left and right commit to display a difference */
661 if (!(left || is_null_oid(one)) ||
662 !(right || is_null_oid(two)))
675 /* TODO: other options may need to be passed here. */
676 argv_array_pushl(&cp.args, "diff", "--submodule=diff", NULL);
677 argv_array_pushf(&cp.args, "--color=%s", want_color(o->use_color) ?
680 if (o->flags.reverse_diff) {
681 argv_array_pushf(&cp.args, "--src-prefix=%s%s/",
683 argv_array_pushf(&cp.args, "--dst-prefix=%s%s/",
686 argv_array_pushf(&cp.args, "--src-prefix=%s%s/",
688 argv_array_pushf(&cp.args, "--dst-prefix=%s%s/",
691 argv_array_push(&cp.args, oid_to_hex(old_oid));
693 * If the submodule has modified content, we will diff against the
694 * work tree, under the assumption that the user has asked for the
695 * diff format and wishes to actually see all differences even if they
696 * haven't yet been committed to the submodule yet.
698 if (!(dirty_submodule & DIRTY_SUBMODULE_MODIFIED))
699 argv_array_push(&cp.args, oid_to_hex(new_oid));
701 prepare_submodule_repo_env(&cp.env_array);
702 if (start_command(&cp))
703 diff_emit_submodule_error(o, "(diff failed)\n");
705 while (strbuf_getwholeline_fd(&sb, cp.out, '\n') != EOF)
706 diff_emit_submodule_pipethrough(o, sb.buf, sb.len);
708 if (finish_command(&cp))
709 diff_emit_submodule_error(o, "(diff failed)\n");
714 free_commit_list(merge_bases);
716 clear_commit_marks(left, ~0);
718 clear_commit_marks(right, ~0);
725 int should_update_submodules(void)
727 return config_update_recurse_submodules == RECURSE_SUBMODULES_ON;
730 const struct submodule *submodule_from_ce(const struct cache_entry *ce)
732 if (!S_ISGITLINK(ce->ce_mode))
735 if (!should_update_submodules())
738 return submodule_from_path(the_repository, &null_oid, ce->name);
741 static struct oid_array *submodule_commits(struct string_list *submodules,
744 struct string_list_item *item;
746 item = string_list_insert(submodules, name);
748 return (struct oid_array *) item->util;
750 /* NEEDSWORK: should we have oid_array_init()? */
751 item->util = xcalloc(1, sizeof(struct oid_array));
752 return (struct oid_array *) item->util;
755 struct collect_changed_submodules_cb_data {
756 struct repository *repo;
757 struct string_list *changed;
758 const struct object_id *commit_oid;
762 * this would normally be two functions: default_name_from_path() and
763 * path_from_default_name(). Since the default name is the same as
764 * the submodule path we can get away with just one function which only
765 * checks whether there is a submodule in the working directory at that
768 static const char *default_name_or_path(const char *path_or_name)
772 if (!is_submodule_populated_gently(path_or_name, &error_code))
778 static void collect_changed_submodules_cb(struct diff_queue_struct *q,
779 struct diff_options *options,
782 struct collect_changed_submodules_cb_data *me = data;
783 struct string_list *changed = me->changed;
784 const struct object_id *commit_oid = me->commit_oid;
787 for (i = 0; i < q->nr; i++) {
788 struct diff_filepair *p = q->queue[i];
789 struct oid_array *commits;
790 const struct submodule *submodule;
793 if (!S_ISGITLINK(p->two->mode))
796 submodule = submodule_from_path(me->repo,
797 commit_oid, p->two->path);
799 name = submodule->name;
801 name = default_name_or_path(p->two->path);
802 /* make sure name does not collide with existing one */
804 submodule = submodule_from_name(me->repo,
807 warning("Submodule in commit %s at path: "
808 "'%s' collides with a submodule named "
809 "the same. Skipping it.",
810 oid_to_hex(commit_oid), p->two->path);
818 commits = submodule_commits(changed, name);
819 oid_array_append(commits, &p->two->oid);
824 * Collect the paths of submodules in 'changed' which have changed based on
825 * the revisions as specified in 'argv'. Each entry in 'changed' will also
826 * have a corresponding 'struct oid_array' (in the 'util' field) which lists
827 * what the submodule pointers were updated to during the change.
829 static void collect_changed_submodules(struct repository *r,
830 struct string_list *changed,
831 struct argv_array *argv)
834 const struct commit *commit;
836 repo_init_revisions(r, &rev, NULL);
837 setup_revisions(argv->argc, argv->argv, &rev, NULL);
838 if (prepare_revision_walk(&rev))
839 die("revision walk setup failed");
841 while ((commit = get_revision(&rev))) {
842 struct rev_info diff_rev;
843 struct collect_changed_submodules_cb_data data;
845 data.changed = changed;
846 data.commit_oid = &commit->object.oid;
848 repo_init_revisions(r, &diff_rev, NULL);
849 diff_rev.diffopt.output_format |= DIFF_FORMAT_CALLBACK;
850 diff_rev.diffopt.format_callback = collect_changed_submodules_cb;
851 diff_rev.diffopt.format_callback_data = &data;
852 diff_tree_combined_merge(commit, 1, &diff_rev);
855 reset_revision_walk();
858 static void free_submodules_oids(struct string_list *submodules)
860 struct string_list_item *item;
861 for_each_string_list_item(item, submodules)
862 oid_array_clear((struct oid_array *) item->util);
863 string_list_clear(submodules, 1);
866 static int has_remote(const char *refname, const struct object_id *oid,
867 int flags, void *cb_data)
872 static int append_oid_to_argv(const struct object_id *oid, void *data)
874 struct argv_array *argv = data;
875 argv_array_push(argv, oid_to_hex(oid));
879 struct has_commit_data {
880 struct repository *repo;
885 static int check_has_commit(const struct object_id *oid, void *data)
887 struct has_commit_data *cb = data;
889 enum object_type type = oid_object_info(cb->repo, oid, NULL);
896 * Object is missing or invalid. If invalid, an error message
897 * has already been printed.
902 die(_("submodule entry '%s' (%s) is a %s, not a commit"),
903 cb->path, oid_to_hex(oid), type_name(type));
907 static int submodule_has_commits(struct repository *r,
909 struct oid_array *commits)
911 struct has_commit_data has_commit = { r, 1, path };
914 * Perform a cheap, but incorrect check for the existence of 'commits'.
915 * This is done by adding the submodule's object store to the in-core
916 * object store, and then querying for each commit's existence. If we
917 * do not have the commit object anywhere, there is no chance we have
918 * it in the object store of the correct submodule and have it
919 * reachable from a ref, so we can fail early without spawning rev-list
920 * which is expensive.
922 if (add_submodule_odb(path))
925 oid_array_for_each_unique(commits, check_has_commit, &has_commit);
927 if (has_commit.result) {
929 * Even if the submodule is checked out and the commit is
930 * present, make sure it exists in the submodule's object store
931 * and that it is reachable from a ref.
933 struct child_process cp = CHILD_PROCESS_INIT;
934 struct strbuf out = STRBUF_INIT;
936 argv_array_pushl(&cp.args, "rev-list", "-n", "1", NULL);
937 oid_array_for_each_unique(commits, append_oid_to_argv, &cp.args);
938 argv_array_pushl(&cp.args, "--not", "--all", NULL);
940 prepare_submodule_repo_env(&cp.env_array);
945 if (capture_command(&cp, &out, GIT_MAX_HEXSZ + 1) || out.len)
946 has_commit.result = 0;
948 strbuf_release(&out);
951 return has_commit.result;
954 static int submodule_needs_pushing(struct repository *r,
956 struct oid_array *commits)
958 if (!submodule_has_commits(r, path, commits))
960 * NOTE: We do consider it safe to return "no" here. The
961 * correct answer would be "We do not know" instead of
962 * "No push needed", but it is quite hard to change
963 * the submodule pointer without having the submodule
964 * around. If a user did however change the submodules
965 * without having the submodule around, this indicates
966 * an expert who knows what they are doing or a
967 * maintainer integrating work from other people. In
968 * both cases it should be safe to skip this check.
972 if (for_each_remote_ref_submodule(path, has_remote, NULL) > 0) {
973 struct child_process cp = CHILD_PROCESS_INIT;
974 struct strbuf buf = STRBUF_INIT;
975 int needs_pushing = 0;
977 argv_array_push(&cp.args, "rev-list");
978 oid_array_for_each_unique(commits, append_oid_to_argv, &cp.args);
979 argv_array_pushl(&cp.args, "--not", "--remotes", "-n", "1" , NULL);
981 prepare_submodule_repo_env(&cp.env_array);
986 if (start_command(&cp))
987 die("Could not run 'git rev-list <commits> --not --remotes -n 1' command in submodule %s",
989 if (strbuf_read(&buf, cp.out, 41))
993 strbuf_release(&buf);
994 return needs_pushing;
1000 int find_unpushed_submodules(struct repository *r,
1001 struct oid_array *commits,
1002 const char *remotes_name,
1003 struct string_list *needs_pushing)
1005 struct string_list submodules = STRING_LIST_INIT_DUP;
1006 struct string_list_item *name;
1007 struct argv_array argv = ARGV_ARRAY_INIT;
1009 /* argv.argv[0] will be ignored by setup_revisions */
1010 argv_array_push(&argv, "find_unpushed_submodules");
1011 oid_array_for_each_unique(commits, append_oid_to_argv, &argv);
1012 argv_array_push(&argv, "--not");
1013 argv_array_pushf(&argv, "--remotes=%s", remotes_name);
1015 collect_changed_submodules(r, &submodules, &argv);
1017 for_each_string_list_item(name, &submodules) {
1018 struct oid_array *commits = name->util;
1019 const struct submodule *submodule;
1020 const char *path = NULL;
1022 submodule = submodule_from_name(r, &null_oid, name->string);
1024 path = submodule->path;
1026 path = default_name_or_path(name->string);
1031 if (submodule_needs_pushing(r, path, commits))
1032 string_list_insert(needs_pushing, path);
1035 free_submodules_oids(&submodules);
1036 argv_array_clear(&argv);
1038 return needs_pushing->nr;
1041 static int push_submodule(const char *path,
1042 const struct remote *remote,
1043 const struct refspec *rs,
1044 const struct string_list *push_options,
1047 if (for_each_remote_ref_submodule(path, has_remote, NULL) > 0) {
1048 struct child_process cp = CHILD_PROCESS_INIT;
1049 argv_array_push(&cp.args, "push");
1051 argv_array_push(&cp.args, "--dry-run");
1053 if (push_options && push_options->nr) {
1054 const struct string_list_item *item;
1055 for_each_string_list_item(item, push_options)
1056 argv_array_pushf(&cp.args, "--push-option=%s",
1060 if (remote->origin != REMOTE_UNCONFIGURED) {
1062 argv_array_push(&cp.args, remote->name);
1063 for (i = 0; i < rs->raw_nr; i++)
1064 argv_array_push(&cp.args, rs->raw[i]);
1067 prepare_submodule_repo_env(&cp.env_array);
1071 if (run_command(&cp))
1080 * Perform a check in the submodule to see if the remote and refspec work.
1081 * Die if the submodule can't be pushed.
1083 static void submodule_push_check(const char *path, const char *head,
1084 const struct remote *remote,
1085 const struct refspec *rs)
1087 struct child_process cp = CHILD_PROCESS_INIT;
1090 argv_array_push(&cp.args, "submodule--helper");
1091 argv_array_push(&cp.args, "push-check");
1092 argv_array_push(&cp.args, head);
1093 argv_array_push(&cp.args, remote->name);
1095 for (i = 0; i < rs->raw_nr; i++)
1096 argv_array_push(&cp.args, rs->raw[i]);
1098 prepare_submodule_repo_env(&cp.env_array);
1105 * Simply indicate if 'submodule--helper push-check' failed.
1106 * More detailed error information will be provided by the
1109 if (run_command(&cp))
1110 die("process for submodule '%s' failed", path);
1113 int push_unpushed_submodules(struct repository *r,
1114 struct oid_array *commits,
1115 const struct remote *remote,
1116 const struct refspec *rs,
1117 const struct string_list *push_options,
1121 struct string_list needs_pushing = STRING_LIST_INIT_DUP;
1123 if (!find_unpushed_submodules(r, commits,
1124 remote->name, &needs_pushing))
1128 * Verify that the remote and refspec can be propagated to all
1129 * submodules. This check can be skipped if the remote and refspec
1130 * won't be propagated due to the remote being unconfigured (e.g. a URL
1131 * instead of a remote name).
1133 if (remote->origin != REMOTE_UNCONFIGURED) {
1135 struct object_id head_oid;
1137 head = resolve_refdup("HEAD", 0, &head_oid, NULL);
1139 die(_("Failed to resolve HEAD as a valid ref."));
1141 for (i = 0; i < needs_pushing.nr; i++)
1142 submodule_push_check(needs_pushing.items[i].string,
1147 /* Actually push the submodules */
1148 for (i = 0; i < needs_pushing.nr; i++) {
1149 const char *path = needs_pushing.items[i].string;
1150 fprintf(stderr, "Pushing submodule '%s'\n", path);
1151 if (!push_submodule(path, remote, rs,
1152 push_options, dry_run)) {
1153 fprintf(stderr, "Unable to push submodule '%s'\n", path);
1158 string_list_clear(&needs_pushing, 0);
1163 static int append_oid_to_array(const char *ref, const struct object_id *oid,
1164 int flags, void *data)
1166 struct oid_array *array = data;
1167 oid_array_append(array, oid);
1171 void check_for_new_submodule_commits(struct object_id *oid)
1173 if (!initialized_fetch_ref_tips) {
1174 for_each_ref(append_oid_to_array, &ref_tips_before_fetch);
1175 initialized_fetch_ref_tips = 1;
1178 oid_array_append(&ref_tips_after_fetch, oid);
1181 static void calculate_changed_submodule_paths(struct repository *r)
1183 struct argv_array argv = ARGV_ARRAY_INIT;
1184 struct string_list changed_submodules = STRING_LIST_INIT_DUP;
1185 const struct string_list_item *name;
1187 /* No need to check if there are no submodules configured */
1188 if (!submodule_from_path(r, NULL, NULL))
1191 argv_array_push(&argv, "--"); /* argv[0] program name */
1192 oid_array_for_each_unique(&ref_tips_after_fetch,
1193 append_oid_to_argv, &argv);
1194 argv_array_push(&argv, "--not");
1195 oid_array_for_each_unique(&ref_tips_before_fetch,
1196 append_oid_to_argv, &argv);
1199 * Collect all submodules (whether checked out or not) for which new
1200 * commits have been recorded upstream in "changed_submodule_names".
1202 collect_changed_submodules(r, &changed_submodules, &argv);
1204 for_each_string_list_item(name, &changed_submodules) {
1205 struct oid_array *commits = name->util;
1206 const struct submodule *submodule;
1207 const char *path = NULL;
1209 submodule = submodule_from_name(r, &null_oid, name->string);
1211 path = submodule->path;
1213 path = default_name_or_path(name->string);
1218 if (!submodule_has_commits(r, path, commits))
1219 string_list_append(&changed_submodule_names, name->string);
1222 free_submodules_oids(&changed_submodules);
1223 argv_array_clear(&argv);
1224 oid_array_clear(&ref_tips_before_fetch);
1225 oid_array_clear(&ref_tips_after_fetch);
1226 initialized_fetch_ref_tips = 0;
1229 int submodule_touches_in_range(struct repository *r,
1230 struct object_id *excl_oid,
1231 struct object_id *incl_oid)
1233 struct string_list subs = STRING_LIST_INIT_DUP;
1234 struct argv_array args = ARGV_ARRAY_INIT;
1237 /* No need to check if there are no submodules configured */
1238 if (!submodule_from_path(r, NULL, NULL))
1241 argv_array_push(&args, "--"); /* args[0] program name */
1242 argv_array_push(&args, oid_to_hex(incl_oid));
1243 if (!is_null_oid(excl_oid)) {
1244 argv_array_push(&args, "--not");
1245 argv_array_push(&args, oid_to_hex(excl_oid));
1248 collect_changed_submodules(r, &subs, &args);
1251 argv_array_clear(&args);
1253 free_submodules_oids(&subs);
1257 struct submodule_parallel_fetch {
1259 struct argv_array args;
1260 struct repository *r;
1262 int command_line_option;
1267 #define SPF_INIT {0, ARGV_ARRAY_INIT, NULL, NULL, 0, 0, 0, 0}
1269 static int get_fetch_recurse_config(const struct submodule *submodule,
1270 struct submodule_parallel_fetch *spf)
1272 if (spf->command_line_option != RECURSE_SUBMODULES_DEFAULT)
1273 return spf->command_line_option;
1279 int fetch_recurse = submodule->fetch_recurse;
1280 key = xstrfmt("submodule.%s.fetchRecurseSubmodules", submodule->name);
1281 if (!repo_config_get_string_const(spf->r, key, &value)) {
1282 fetch_recurse = parse_fetch_recurse_submodules_arg(key, value);
1286 if (fetch_recurse != RECURSE_SUBMODULES_NONE)
1287 /* local config overrules everything except commandline */
1288 return fetch_recurse;
1291 return spf->default_option;
1294 static int get_next_submodule(struct child_process *cp,
1295 struct strbuf *err, void *data, void **task_cb)
1298 struct submodule_parallel_fetch *spf = data;
1300 for (; spf->count < spf->r->index->cache_nr; spf->count++) {
1301 struct strbuf submodule_path = STRBUF_INIT;
1302 struct strbuf submodule_git_dir = STRBUF_INIT;
1303 struct strbuf submodule_prefix = STRBUF_INIT;
1304 const struct cache_entry *ce = spf->r->index->cache[spf->count];
1305 const char *git_dir, *default_argv;
1306 const struct submodule *submodule;
1307 struct submodule default_submodule = SUBMODULE_INIT;
1309 if (!S_ISGITLINK(ce->ce_mode))
1312 submodule = submodule_from_path(spf->r, &null_oid, ce->name);
1314 const char *name = default_name_or_path(ce->name);
1316 default_submodule.path = default_submodule.name = name;
1317 submodule = &default_submodule;
1321 switch (get_fetch_recurse_config(submodule, spf))
1324 case RECURSE_SUBMODULES_DEFAULT:
1325 case RECURSE_SUBMODULES_ON_DEMAND:
1326 if (!submodule || !unsorted_string_list_lookup(&changed_submodule_names,
1329 default_argv = "on-demand";
1331 case RECURSE_SUBMODULES_ON:
1332 default_argv = "yes";
1334 case RECURSE_SUBMODULES_OFF:
1338 strbuf_repo_worktree_path(&submodule_path, spf->r, "%s", ce->name);
1339 strbuf_addf(&submodule_git_dir, "%s/.git", submodule_path.buf);
1340 strbuf_addf(&submodule_prefix, "%s%s/", spf->prefix, ce->name);
1341 git_dir = read_gitfile(submodule_git_dir.buf);
1343 git_dir = submodule_git_dir.buf;
1344 if (is_directory(git_dir)) {
1345 child_process_init(cp);
1346 cp->dir = strbuf_detach(&submodule_path, NULL);
1347 prepare_submodule_repo_env(&cp->env_array);
1350 strbuf_addf(err, "Fetching submodule %s%s\n",
1351 spf->prefix, ce->name);
1352 argv_array_init(&cp->args);
1353 argv_array_pushv(&cp->args, spf->args.argv);
1354 argv_array_push(&cp->args, default_argv);
1355 argv_array_push(&cp->args, "--submodule-prefix");
1356 argv_array_push(&cp->args, submodule_prefix.buf);
1359 strbuf_release(&submodule_path);
1360 strbuf_release(&submodule_git_dir);
1361 strbuf_release(&submodule_prefix);
1370 static int fetch_start_failure(struct strbuf *err,
1371 void *cb, void *task_cb)
1373 struct submodule_parallel_fetch *spf = cb;
1380 static int fetch_finish(int retvalue, struct strbuf *err,
1381 void *cb, void *task_cb)
1383 struct submodule_parallel_fetch *spf = cb;
1391 int fetch_populated_submodules(struct repository *r,
1392 const struct argv_array *options,
1393 const char *prefix, int command_line_option,
1395 int quiet, int max_parallel_jobs)
1398 struct submodule_parallel_fetch spf = SPF_INIT;
1401 spf.command_line_option = command_line_option;
1402 spf.default_option = default_option;
1404 spf.prefix = prefix;
1409 if (repo_read_index(r) < 0)
1410 die("index file corrupt");
1412 argv_array_push(&spf.args, "fetch");
1413 for (i = 0; i < options->argc; i++)
1414 argv_array_push(&spf.args, options->argv[i]);
1415 argv_array_push(&spf.args, "--recurse-submodules-default");
1416 /* default value, "--submodule-prefix" and its value are added later */
1418 calculate_changed_submodule_paths(r);
1419 run_processes_parallel(max_parallel_jobs,
1421 fetch_start_failure,
1425 argv_array_clear(&spf.args);
1427 string_list_clear(&changed_submodule_names, 1);
1431 unsigned is_submodule_modified(const char *path, int ignore_untracked)
1433 struct child_process cp = CHILD_PROCESS_INIT;
1434 struct strbuf buf = STRBUF_INIT;
1436 unsigned dirty_submodule = 0;
1437 const char *git_dir;
1438 int ignore_cp_exit_code = 0;
1440 strbuf_addf(&buf, "%s/.git", path);
1441 git_dir = read_gitfile(buf.buf);
1444 if (!is_git_directory(git_dir)) {
1445 if (is_directory(git_dir))
1446 die(_("'%s' not recognized as a git repository"), git_dir);
1447 strbuf_release(&buf);
1448 /* The submodule is not checked out, so it is not modified */
1453 argv_array_pushl(&cp.args, "status", "--porcelain=2", NULL);
1454 if (ignore_untracked)
1455 argv_array_push(&cp.args, "-uno");
1457 prepare_submodule_repo_env(&cp.env_array);
1462 if (start_command(&cp))
1463 die("Could not run 'git status --porcelain=2' in submodule %s", path);
1465 fp = xfdopen(cp.out, "r");
1466 while (strbuf_getwholeline(&buf, fp, '\n') != EOF) {
1467 /* regular untracked files */
1468 if (buf.buf[0] == '?')
1469 dirty_submodule |= DIRTY_SUBMODULE_UNTRACKED;
1471 if (buf.buf[0] == 'u' ||
1472 buf.buf[0] == '1' ||
1473 buf.buf[0] == '2') {
1474 /* T = line type, XY = status, SSSS = submodule state */
1475 if (buf.len < strlen("T XY SSSS"))
1476 BUG("invalid status --porcelain=2 line %s",
1479 if (buf.buf[5] == 'S' && buf.buf[8] == 'U')
1480 /* nested untracked file */
1481 dirty_submodule |= DIRTY_SUBMODULE_UNTRACKED;
1483 if (buf.buf[0] == 'u' ||
1484 buf.buf[0] == '2' ||
1485 memcmp(buf.buf + 5, "S..U", 4))
1487 dirty_submodule |= DIRTY_SUBMODULE_MODIFIED;
1490 if ((dirty_submodule & DIRTY_SUBMODULE_MODIFIED) &&
1491 ((dirty_submodule & DIRTY_SUBMODULE_UNTRACKED) ||
1492 ignore_untracked)) {
1494 * We're not interested in any further information from
1495 * the child any more, neither output nor its exit code.
1497 ignore_cp_exit_code = 1;
1503 if (finish_command(&cp) && !ignore_cp_exit_code)
1504 die("'git status --porcelain=2' failed in submodule %s", path);
1506 strbuf_release(&buf);
1507 return dirty_submodule;
1510 int submodule_uses_gitfile(const char *path)
1512 struct child_process cp = CHILD_PROCESS_INIT;
1513 const char *argv[] = {
1521 struct strbuf buf = STRBUF_INIT;
1522 const char *git_dir;
1524 strbuf_addf(&buf, "%s/.git", path);
1525 git_dir = read_gitfile(buf.buf);
1527 strbuf_release(&buf);
1530 strbuf_release(&buf);
1532 /* Now test that all nested submodules use a gitfile too */
1534 prepare_submodule_repo_env(&cp.env_array);
1540 if (run_command(&cp))
1547 * Check if it is a bad idea to remove a submodule, i.e. if we'd lose data
1550 * Return 1 if we'd lose data, return 0 if the removal is fine,
1551 * and negative values for errors.
1553 int bad_to_remove_submodule(const char *path, unsigned flags)
1556 struct child_process cp = CHILD_PROCESS_INIT;
1557 struct strbuf buf = STRBUF_INIT;
1560 if (!file_exists(path) || is_empty_dir(path))
1563 if (!submodule_uses_gitfile(path))
1566 argv_array_pushl(&cp.args, "status", "--porcelain",
1567 "--ignore-submodules=none", NULL);
1569 if (flags & SUBMODULE_REMOVAL_IGNORE_UNTRACKED)
1570 argv_array_push(&cp.args, "-uno");
1572 argv_array_push(&cp.args, "-uall");
1574 if (!(flags & SUBMODULE_REMOVAL_IGNORE_IGNORED_UNTRACKED))
1575 argv_array_push(&cp.args, "--ignored");
1577 prepare_submodule_repo_env(&cp.env_array);
1582 if (start_command(&cp)) {
1583 if (flags & SUBMODULE_REMOVAL_DIE_ON_ERROR)
1584 die(_("could not start 'git status' in submodule '%s'"),
1590 len = strbuf_read(&buf, cp.out, 1024);
1595 if (finish_command(&cp)) {
1596 if (flags & SUBMODULE_REMOVAL_DIE_ON_ERROR)
1597 die(_("could not run 'git status' in submodule '%s'"),
1602 strbuf_release(&buf);
1606 static const char *get_super_prefix_or_empty(void)
1608 const char *s = get_super_prefix();
1614 static int submodule_has_dirty_index(const struct submodule *sub)
1616 struct child_process cp = CHILD_PROCESS_INIT;
1618 prepare_submodule_repo_env(&cp.env_array);
1621 argv_array_pushl(&cp.args, "diff-index", "--quiet",
1622 "--cached", "HEAD", NULL);
1626 if (start_command(&cp))
1627 die("could not recurse into submodule '%s'", sub->path);
1629 return finish_command(&cp);
1632 static void submodule_reset_index(const char *path)
1634 struct child_process cp = CHILD_PROCESS_INIT;
1635 prepare_submodule_repo_env(&cp.env_array);
1641 argv_array_pushf(&cp.args, "--super-prefix=%s%s/",
1642 get_super_prefix_or_empty(), path);
1643 argv_array_pushl(&cp.args, "read-tree", "-u", "--reset", NULL);
1645 argv_array_push(&cp.args, empty_tree_oid_hex());
1647 if (run_command(&cp))
1648 die("could not reset submodule index");
1652 * Moves a submodule at a given path from a given head to another new head.
1653 * For edge cases (a submodule coming into existence or removing a submodule)
1654 * pass NULL for old or new respectively.
1656 int submodule_move_head(const char *path,
1657 const char *old_head,
1658 const char *new_head,
1662 struct child_process cp = CHILD_PROCESS_INIT;
1663 const struct submodule *sub;
1664 int *error_code_ptr, error_code;
1666 if (!is_submodule_active(the_repository, path))
1669 if (flags & SUBMODULE_MOVE_HEAD_FORCE)
1671 * Pass non NULL pointer to is_submodule_populated_gently
1672 * to prevent die()-ing. We'll use connect_work_tree_and_git_dir
1673 * to fixup the submodule in the force case later.
1675 error_code_ptr = &error_code;
1677 error_code_ptr = NULL;
1679 if (old_head && !is_submodule_populated_gently(path, error_code_ptr))
1682 sub = submodule_from_path(the_repository, &null_oid, path);
1685 BUG("could not get submodule information for '%s'", path);
1687 if (old_head && !(flags & SUBMODULE_MOVE_HEAD_FORCE)) {
1688 /* Check if the submodule has a dirty index. */
1689 if (submodule_has_dirty_index(sub))
1690 return error(_("submodule '%s' has dirty index"), path);
1693 if (!(flags & SUBMODULE_MOVE_HEAD_DRY_RUN)) {
1695 if (!submodule_uses_gitfile(path))
1696 absorb_git_dir_into_superproject("", path,
1697 ABSORB_GITDIR_RECURSE_SUBMODULES);
1699 char *gitdir = xstrfmt("%s/modules/%s",
1700 get_git_common_dir(), sub->name);
1701 connect_work_tree_and_git_dir(path, gitdir, 0);
1704 /* make sure the index is clean as well */
1705 submodule_reset_index(path);
1708 if (old_head && (flags & SUBMODULE_MOVE_HEAD_FORCE)) {
1709 char *gitdir = xstrfmt("%s/modules/%s",
1710 get_git_common_dir(), sub->name);
1711 connect_work_tree_and_git_dir(path, gitdir, 1);
1716 prepare_submodule_repo_env(&cp.env_array);
1722 argv_array_pushf(&cp.args, "--super-prefix=%s%s/",
1723 get_super_prefix_or_empty(), path);
1724 argv_array_pushl(&cp.args, "read-tree", "--recurse-submodules", NULL);
1726 if (flags & SUBMODULE_MOVE_HEAD_DRY_RUN)
1727 argv_array_push(&cp.args, "-n");
1729 argv_array_push(&cp.args, "-u");
1731 if (flags & SUBMODULE_MOVE_HEAD_FORCE)
1732 argv_array_push(&cp.args, "--reset");
1734 argv_array_push(&cp.args, "-m");
1736 if (!(flags & SUBMODULE_MOVE_HEAD_FORCE))
1737 argv_array_push(&cp.args, old_head ? old_head : empty_tree_oid_hex());
1739 argv_array_push(&cp.args, new_head ? new_head : empty_tree_oid_hex());
1741 if (run_command(&cp)) {
1742 ret = error(_("Submodule '%s' could not be updated."), path);
1746 if (!(flags & SUBMODULE_MOVE_HEAD_DRY_RUN)) {
1748 child_process_init(&cp);
1749 /* also set the HEAD accordingly */
1754 prepare_submodule_repo_env(&cp.env_array);
1755 argv_array_pushl(&cp.args, "update-ref", "HEAD",
1756 "--no-deref", new_head, NULL);
1758 if (run_command(&cp)) {
1763 struct strbuf sb = STRBUF_INIT;
1765 strbuf_addf(&sb, "%s/.git", path);
1766 unlink_or_warn(sb.buf);
1767 strbuf_release(&sb);
1769 if (is_empty_dir(path))
1770 rmdir_or_warn(path);
1778 * Embeds a single submodules git directory into the superprojects git dir,
1781 static void relocate_single_git_dir_into_superproject(const char *prefix,
1784 char *old_git_dir = NULL, *real_old_git_dir = NULL, *real_new_git_dir = NULL;
1785 const char *new_git_dir;
1786 const struct submodule *sub;
1788 if (submodule_uses_worktrees(path))
1789 die(_("relocate_gitdir for submodule '%s' with "
1790 "more than one worktree not supported"), path);
1792 old_git_dir = xstrfmt("%s/.git", path);
1793 if (read_gitfile(old_git_dir))
1794 /* If it is an actual gitfile, it doesn't need migration. */
1797 real_old_git_dir = real_pathdup(old_git_dir, 1);
1799 sub = submodule_from_path(the_repository, &null_oid, path);
1801 die(_("could not lookup name for submodule '%s'"), path);
1803 new_git_dir = git_path("modules/%s", sub->name);
1804 if (safe_create_leading_directories_const(new_git_dir) < 0)
1805 die(_("could not create directory '%s'"), new_git_dir);
1806 real_new_git_dir = real_pathdup(new_git_dir, 1);
1808 fprintf(stderr, _("Migrating git directory of '%s%s' from\n'%s' to\n'%s'\n"),
1809 get_super_prefix_or_empty(), path,
1810 real_old_git_dir, real_new_git_dir);
1812 relocate_gitdir(path, real_old_git_dir, real_new_git_dir);
1815 free(real_old_git_dir);
1816 free(real_new_git_dir);
1820 * Migrate the git directory of the submodule given by path from
1821 * having its git directory within the working tree to the git dir nested
1822 * in its superprojects git dir under modules/.
1824 void absorb_git_dir_into_superproject(const char *prefix,
1829 const char *sub_git_dir;
1830 struct strbuf gitdir = STRBUF_INIT;
1831 strbuf_addf(&gitdir, "%s/.git", path);
1832 sub_git_dir = resolve_gitdir_gently(gitdir.buf, &err_code);
1834 /* Not populated? */
1836 const struct submodule *sub;
1838 if (err_code == READ_GITFILE_ERR_STAT_FAILED) {
1839 /* unpopulated as expected */
1840 strbuf_release(&gitdir);
1844 if (err_code != READ_GITFILE_ERR_NOT_A_REPO)
1845 /* We don't know what broke here. */
1846 read_gitfile_error_die(err_code, path, NULL);
1849 * Maybe populated, but no git directory was found?
1850 * This can happen if the superproject is a submodule
1851 * itself and was just absorbed. The absorption of the
1852 * superproject did not rewrite the git file links yet,
1855 sub = submodule_from_path(the_repository, &null_oid, path);
1857 die(_("could not lookup name for submodule '%s'"), path);
1858 connect_work_tree_and_git_dir(path,
1859 git_path("modules/%s", sub->name), 0);
1861 /* Is it already absorbed into the superprojects git dir? */
1862 char *real_sub_git_dir = real_pathdup(sub_git_dir, 1);
1863 char *real_common_git_dir = real_pathdup(get_git_common_dir(), 1);
1865 if (!starts_with(real_sub_git_dir, real_common_git_dir))
1866 relocate_single_git_dir_into_superproject(prefix, path);
1868 free(real_sub_git_dir);
1869 free(real_common_git_dir);
1871 strbuf_release(&gitdir);
1873 if (flags & ABSORB_GITDIR_RECURSE_SUBMODULES) {
1874 struct child_process cp = CHILD_PROCESS_INIT;
1875 struct strbuf sb = STRBUF_INIT;
1877 if (flags & ~ABSORB_GITDIR_RECURSE_SUBMODULES)
1878 BUG("we don't know how to pass the flags down?");
1880 strbuf_addstr(&sb, get_super_prefix_or_empty());
1881 strbuf_addstr(&sb, path);
1882 strbuf_addch(&sb, '/');
1887 argv_array_pushl(&cp.args, "--super-prefix", sb.buf,
1888 "submodule--helper",
1889 "absorb-git-dirs", NULL);
1890 prepare_submodule_repo_env(&cp.env_array);
1891 if (run_command(&cp))
1892 die(_("could not recurse into submodule '%s'"), path);
1894 strbuf_release(&sb);
1898 const char *get_superproject_working_tree(void)
1900 struct child_process cp = CHILD_PROCESS_INIT;
1901 struct strbuf sb = STRBUF_INIT;
1902 const char *one_up = real_path_if_valid("../");
1903 const char *cwd = xgetcwd();
1904 const char *ret = NULL;
1905 const char *subpath;
1909 if (!is_inside_work_tree())
1912 * We might have a superproject, but it is harder
1920 subpath = relative_path(cwd, one_up, &sb);
1922 prepare_submodule_repo_env(&cp.env_array);
1923 argv_array_pop(&cp.env_array);
1925 argv_array_pushl(&cp.args, "--literal-pathspecs", "-C", "..",
1926 "ls-files", "-z", "--stage", "--full-name", "--",
1935 if (start_command(&cp))
1936 die(_("could not start ls-files in .."));
1938 len = strbuf_read(&sb, cp.out, PATH_MAX);
1941 if (starts_with(sb.buf, "160000")) {
1943 int cwd_len = strlen(cwd);
1944 char *super_sub, *super_wt;
1947 * There is a superproject having this repo as a submodule.
1948 * The format is <mode> SP <hash> SP <stage> TAB <full name> \0,
1949 * We're only interested in the name after the tab.
1951 super_sub = strchr(sb.buf, '\t') + 1;
1952 super_sub_len = strlen(super_sub);
1954 if (super_sub_len > cwd_len ||
1955 strcmp(&cwd[cwd_len - super_sub_len], super_sub))
1956 BUG("returned path string doesn't match cwd?");
1958 super_wt = xstrdup(cwd);
1959 super_wt[cwd_len - super_sub_len] = '\0';
1961 ret = real_path(super_wt);
1964 strbuf_release(&sb);
1966 code = finish_command(&cp);
1969 /* '../' is not a git repository */
1971 if (code == 0 && len == 0)
1972 /* There is an unrelated git repository at '../' */
1975 die(_("ls-tree returned unexpected return code %d"), code);
1981 * Put the gitdir for a submodule (given relative to the main
1982 * repository worktree) into `buf`, or return -1 on error.
1984 int submodule_to_gitdir(struct strbuf *buf, const char *submodule)
1986 const struct submodule *sub;
1987 const char *git_dir;
1991 strbuf_addstr(buf, submodule);
1992 strbuf_complete(buf, '/');
1993 strbuf_addstr(buf, ".git");
1995 git_dir = read_gitfile(buf->buf);
1998 strbuf_addstr(buf, git_dir);
2000 if (!is_git_directory(buf->buf)) {
2001 sub = submodule_from_path(the_repository, &null_oid, submodule);
2007 strbuf_git_path(buf, "%s/%s", "modules", sub->name);