2 #include "submodule-config.h"
8 #include "run-command.h"
11 #include "string-list.h"
12 #include "sha1-array.h"
13 #include "argv-array.h"
15 #include "thread-utils.h"
18 static int config_fetch_recurse_submodules = RECURSE_SUBMODULES_ON_DEMAND;
19 static int parallel_jobs = 1;
20 static struct string_list changed_submodule_paths = STRING_LIST_INIT_NODUP;
21 static int initialized_fetch_ref_tips;
22 static struct sha1_array ref_tips_before_fetch;
23 static struct sha1_array ref_tips_after_fetch;
26 * The following flag is set if the .gitmodules file is unmerged. We then
27 * disable recursion for all submodules where .git/config doesn't have a
28 * matching config entry because we can't guess what might be configured in
29 * .gitmodules unless the user resolves the conflict. When a command line
30 * option is given (which always overrides configuration) this flag will be
33 static int gitmodules_is_unmerged;
36 * This flag is set if the .gitmodules file had unstaged modifications on
37 * startup. This must be checked before allowing modifications to the
38 * .gitmodules file with the intention to stage them later, because when
39 * continuing we would stage the modifications the user didn't stage herself
40 * too. That might change in a future version when we learn to stage the
41 * changes we do ourselves without staging any previous modifications.
43 static int gitmodules_is_modified;
45 int is_staging_gitmodules_ok(void)
47 return !gitmodules_is_modified;
51 * Try to update the "path" entry in the "submodule.<name>" section of the
52 * .gitmodules file. Return 0 only if a .gitmodules file was found, a section
53 * with the correct path=<oldpath> setting was found and we could update it.
55 int update_path_in_gitmodules(const char *oldpath, const char *newpath)
57 struct strbuf entry = STRBUF_INIT;
58 const struct submodule *submodule;
60 if (!file_exists(".gitmodules")) /* Do nothing without .gitmodules */
63 if (gitmodules_is_unmerged)
64 die(_("Cannot change unmerged .gitmodules, resolve merge conflicts first"));
66 submodule = submodule_from_path(null_sha1, oldpath);
67 if (!submodule || !submodule->name) {
68 warning(_("Could not find section in .gitmodules where path=%s"), oldpath);
71 strbuf_addstr(&entry, "submodule.");
72 strbuf_addstr(&entry, submodule->name);
73 strbuf_addstr(&entry, ".path");
74 if (git_config_set_in_file_gently(".gitmodules", entry.buf, newpath) < 0) {
75 /* Maybe the user already did that, don't error out here */
76 warning(_("Could not update .gitmodules entry %s"), entry.buf);
77 strbuf_release(&entry);
80 strbuf_release(&entry);
85 * Try to remove the "submodule.<name>" section from .gitmodules where the given
86 * path is configured. Return 0 only if a .gitmodules file was found, a section
87 * with the correct path=<path> setting was found and we could remove it.
89 int remove_path_from_gitmodules(const char *path)
91 struct strbuf sect = STRBUF_INIT;
92 const struct submodule *submodule;
94 if (!file_exists(".gitmodules")) /* Do nothing without .gitmodules */
97 if (gitmodules_is_unmerged)
98 die(_("Cannot change unmerged .gitmodules, resolve merge conflicts first"));
100 submodule = submodule_from_path(null_sha1, path);
101 if (!submodule || !submodule->name) {
102 warning(_("Could not find section in .gitmodules where path=%s"), path);
105 strbuf_addstr(§, "submodule.");
106 strbuf_addstr(§, submodule->name);
107 if (git_config_rename_section_in_file(".gitmodules", sect.buf, NULL) < 0) {
108 /* Maybe the user already did that, don't error out here */
109 warning(_("Could not remove .gitmodules entry for %s"), path);
110 strbuf_release(§);
113 strbuf_release(§);
117 void stage_updated_gitmodules(void)
119 if (add_file_to_cache(".gitmodules", 0))
120 die(_("staging updated .gitmodules failed"));
123 static int add_submodule_odb(const char *path)
125 struct strbuf objects_directory = STRBUF_INIT;
128 ret = strbuf_git_path_submodule(&objects_directory, path, "objects/");
131 if (!is_directory(objects_directory.buf)) {
135 add_to_alternates_memory(objects_directory.buf);
137 strbuf_release(&objects_directory);
141 void set_diffopt_flags_from_submodule_config(struct diff_options *diffopt,
144 const struct submodule *submodule = submodule_from_path(null_sha1, path);
146 if (submodule->ignore)
147 handle_ignore_submodules_arg(diffopt, submodule->ignore);
148 else if (gitmodules_is_unmerged)
149 DIFF_OPT_SET(diffopt, IGNORE_SUBMODULES);
153 int submodule_config(const char *var, const char *value, void *cb)
155 if (!strcmp(var, "submodule.fetchjobs")) {
156 parallel_jobs = git_config_int(var, value);
157 if (parallel_jobs < 0)
158 die(_("negative values not allowed for submodule.fetchJobs"));
160 } else if (starts_with(var, "submodule."))
161 return parse_submodule_config_option(var, value);
162 else if (!strcmp(var, "fetch.recursesubmodules")) {
163 config_fetch_recurse_submodules = parse_fetch_recurse_submodules_arg(var, value);
169 void gitmodules_config(void)
171 const char *work_tree = get_git_work_tree();
173 struct strbuf gitmodules_path = STRBUF_INIT;
175 strbuf_addstr(&gitmodules_path, work_tree);
176 strbuf_addstr(&gitmodules_path, "/.gitmodules");
177 if (read_cache() < 0)
178 die("index file corrupt");
179 pos = cache_name_pos(".gitmodules", 11);
180 if (pos < 0) { /* .gitmodules not found or isn't merged */
182 if (active_nr > pos) { /* there is a .gitmodules */
183 const struct cache_entry *ce = active_cache[pos];
184 if (ce_namelen(ce) == 11 &&
185 !memcmp(ce->name, ".gitmodules", 11))
186 gitmodules_is_unmerged = 1;
188 } else if (pos < active_nr) {
190 if (lstat(".gitmodules", &st) == 0 &&
191 ce_match_stat(active_cache[pos], &st, 0) & DATA_CHANGED)
192 gitmodules_is_modified = 1;
195 if (!gitmodules_is_unmerged)
196 git_config_from_file(submodule_config, gitmodules_path.buf, NULL);
197 strbuf_release(&gitmodules_path);
201 void gitmodules_config_sha1(const unsigned char *commit_sha1)
203 struct strbuf rev = STRBUF_INIT;
204 unsigned char sha1[20];
206 if (gitmodule_sha1_from_commit(commit_sha1, sha1, &rev)) {
207 git_config_from_blob_sha1(submodule_config, rev.buf,
210 strbuf_release(&rev);
214 * Determine if a submodule has been initialized at a given 'path'
216 int is_submodule_initialized(const char *path)
219 const struct submodule *module = NULL;
221 module = submodule_from_path(null_sha1, path);
224 char *key = xstrfmt("submodule.%s.url", module->name);
227 ret = !git_config_get_string(key, &value);
237 * Determine if a submodule has been populated at a given 'path'
239 int is_submodule_populated(const char *path)
242 char *gitdir = xstrfmt("%s/.git", path);
244 if (resolve_gitdir(gitdir))
251 int parse_submodule_update_strategy(const char *value,
252 struct submodule_update_strategy *dst)
254 free((void*)dst->command);
256 if (!strcmp(value, "none"))
257 dst->type = SM_UPDATE_NONE;
258 else if (!strcmp(value, "checkout"))
259 dst->type = SM_UPDATE_CHECKOUT;
260 else if (!strcmp(value, "rebase"))
261 dst->type = SM_UPDATE_REBASE;
262 else if (!strcmp(value, "merge"))
263 dst->type = SM_UPDATE_MERGE;
264 else if (skip_prefix(value, "!", &value)) {
265 dst->type = SM_UPDATE_COMMAND;
266 dst->command = xstrdup(value);
272 const char *submodule_strategy_to_string(const struct submodule_update_strategy *s)
274 struct strbuf sb = STRBUF_INIT;
276 case SM_UPDATE_CHECKOUT:
278 case SM_UPDATE_MERGE:
280 case SM_UPDATE_REBASE:
284 case SM_UPDATE_UNSPECIFIED:
286 case SM_UPDATE_COMMAND:
287 strbuf_addf(&sb, "!%s", s->command);
288 return strbuf_detach(&sb, NULL);
293 void handle_ignore_submodules_arg(struct diff_options *diffopt,
296 DIFF_OPT_CLR(diffopt, IGNORE_SUBMODULES);
297 DIFF_OPT_CLR(diffopt, IGNORE_UNTRACKED_IN_SUBMODULES);
298 DIFF_OPT_CLR(diffopt, IGNORE_DIRTY_SUBMODULES);
300 if (!strcmp(arg, "all"))
301 DIFF_OPT_SET(diffopt, IGNORE_SUBMODULES);
302 else if (!strcmp(arg, "untracked"))
303 DIFF_OPT_SET(diffopt, IGNORE_UNTRACKED_IN_SUBMODULES);
304 else if (!strcmp(arg, "dirty"))
305 DIFF_OPT_SET(diffopt, IGNORE_DIRTY_SUBMODULES);
306 else if (strcmp(arg, "none"))
307 die("bad --ignore-submodules argument: %s", arg);
310 static int prepare_submodule_summary(struct rev_info *rev, const char *path,
311 struct commit *left, struct commit *right,
312 struct commit_list *merge_bases)
314 struct commit_list *list;
316 init_revisions(rev, NULL);
317 setup_revisions(0, NULL, rev, NULL);
319 rev->first_parent_only = 1;
320 left->object.flags |= SYMMETRIC_LEFT;
321 add_pending_object(rev, &left->object, path);
322 add_pending_object(rev, &right->object, path);
323 for (list = merge_bases; list; list = list->next) {
324 list->item->object.flags |= UNINTERESTING;
325 add_pending_object(rev, &list->item->object,
326 oid_to_hex(&list->item->object.oid));
328 return prepare_revision_walk(rev);
331 static void print_submodule_summary(struct rev_info *rev, FILE *f,
332 const char *line_prefix,
333 const char *del, const char *add, const char *reset)
335 static const char format[] = " %m %s";
336 struct strbuf sb = STRBUF_INIT;
337 struct commit *commit;
339 while ((commit = get_revision(rev))) {
340 struct pretty_print_context ctx = {0};
341 ctx.date_mode = rev->date_mode;
342 ctx.output_encoding = get_log_output_encoding();
343 strbuf_setlen(&sb, 0);
344 strbuf_addstr(&sb, line_prefix);
345 if (commit->object.flags & SYMMETRIC_LEFT) {
347 strbuf_addstr(&sb, del);
350 strbuf_addstr(&sb, add);
351 format_commit_message(commit, format, &sb, &ctx);
353 strbuf_addstr(&sb, reset);
354 strbuf_addch(&sb, '\n');
355 fprintf(f, "%s", sb.buf);
360 /* Helper function to display the submodule header line prior to the full
361 * summary output. If it can locate the submodule objects directory it will
362 * attempt to lookup both the left and right commits and put them into the
363 * left and right pointers.
365 static void show_submodule_header(FILE *f, const char *path,
366 const char *line_prefix,
367 struct object_id *one, struct object_id *two,
368 unsigned dirty_submodule, const char *meta,
370 struct commit **left, struct commit **right,
371 struct commit_list **merge_bases)
373 const char *message = NULL;
374 struct strbuf sb = STRBUF_INIT;
375 int fast_forward = 0, fast_backward = 0;
377 if (dirty_submodule & DIRTY_SUBMODULE_UNTRACKED)
378 fprintf(f, "%sSubmodule %s contains untracked content\n",
380 if (dirty_submodule & DIRTY_SUBMODULE_MODIFIED)
381 fprintf(f, "%sSubmodule %s contains modified content\n",
384 if (is_null_oid(one))
385 message = "(new submodule)";
386 else if (is_null_oid(two))
387 message = "(submodule deleted)";
389 if (add_submodule_odb(path)) {
391 message = "(not initialized)";
396 * Attempt to lookup the commit references, and determine if this is
397 * a fast forward or fast backwards update.
399 *left = lookup_commit_reference(one->hash);
400 *right = lookup_commit_reference(two->hash);
403 * Warn about missing commits in the submodule project, but only if
406 if ((!is_null_oid(one) && !*left) ||
407 (!is_null_oid(two) && !*right))
408 message = "(commits not present)";
410 *merge_bases = get_merge_bases(*left, *right);
412 if ((*merge_bases)->item == *left)
414 else if ((*merge_bases)->item == *right)
418 if (!oidcmp(one, two)) {
424 strbuf_addf(&sb, "%s%sSubmodule %s ", line_prefix, meta, path);
425 strbuf_add_unique_abbrev(&sb, one->hash, DEFAULT_ABBREV);
426 strbuf_addstr(&sb, (fast_backward || fast_forward) ? ".." : "...");
427 strbuf_add_unique_abbrev(&sb, two->hash, DEFAULT_ABBREV);
429 strbuf_addf(&sb, " %s%s\n", message, reset);
431 strbuf_addf(&sb, "%s:%s\n", fast_backward ? " (rewind)" : "", reset);
432 fwrite(sb.buf, sb.len, 1, f);
437 void show_submodule_summary(FILE *f, const char *path,
438 const char *line_prefix,
439 struct object_id *one, struct object_id *two,
440 unsigned dirty_submodule, const char *meta,
441 const char *del, const char *add, const char *reset)
444 struct commit *left = NULL, *right = NULL;
445 struct commit_list *merge_bases = NULL;
447 show_submodule_header(f, path, line_prefix, one, two, dirty_submodule,
448 meta, reset, &left, &right, &merge_bases);
451 * If we don't have both a left and a right pointer, there is no
452 * reason to try and display a summary. The header line should contain
453 * all the information the user needs.
458 /* Treat revision walker failure the same as missing commits */
459 if (prepare_submodule_summary(&rev, path, left, right, merge_bases)) {
460 fprintf(f, "%s(revision walker failed)\n", line_prefix);
464 print_submodule_summary(&rev, f, line_prefix, del, add, reset);
468 free_commit_list(merge_bases);
469 clear_commit_marks(left, ~0);
470 clear_commit_marks(right, ~0);
473 void show_submodule_inline_diff(FILE *f, const char *path,
474 const char *line_prefix,
475 struct object_id *one, struct object_id *two,
476 unsigned dirty_submodule, const char *meta,
477 const char *del, const char *add, const char *reset,
478 const struct diff_options *o)
480 const struct object_id *old = &empty_tree_oid, *new = &empty_tree_oid;
481 struct commit *left = NULL, *right = NULL;
482 struct commit_list *merge_bases = NULL;
483 struct strbuf submodule_dir = STRBUF_INIT;
484 struct child_process cp = CHILD_PROCESS_INIT;
486 show_submodule_header(f, path, line_prefix, one, two, dirty_submodule,
487 meta, reset, &left, &right, &merge_bases);
489 /* We need a valid left and right commit to display a difference */
490 if (!(left || is_null_oid(one)) ||
491 !(right || is_null_oid(two)))
502 cp.out = dup(fileno(f));
505 /* TODO: other options may need to be passed here. */
506 argv_array_push(&cp.args, "diff");
507 argv_array_pushf(&cp.args, "--line-prefix=%s", line_prefix);
508 if (DIFF_OPT_TST(o, REVERSE_DIFF)) {
509 argv_array_pushf(&cp.args, "--src-prefix=%s%s/",
511 argv_array_pushf(&cp.args, "--dst-prefix=%s%s/",
514 argv_array_pushf(&cp.args, "--src-prefix=%s%s/",
516 argv_array_pushf(&cp.args, "--dst-prefix=%s%s/",
519 argv_array_push(&cp.args, oid_to_hex(old));
521 * If the submodule has modified content, we will diff against the
522 * work tree, under the assumption that the user has asked for the
523 * diff format and wishes to actually see all differences even if they
524 * haven't yet been committed to the submodule yet.
526 if (!(dirty_submodule & DIRTY_SUBMODULE_MODIFIED))
527 argv_array_push(&cp.args, oid_to_hex(new));
529 if (run_command(&cp))
530 fprintf(f, "(diff failed)\n");
533 strbuf_release(&submodule_dir);
535 free_commit_list(merge_bases);
537 clear_commit_marks(left, ~0);
539 clear_commit_marks(right, ~0);
542 void set_config_fetch_recurse_submodules(int value)
544 config_fetch_recurse_submodules = value;
547 static int has_remote(const char *refname, const struct object_id *oid,
548 int flags, void *cb_data)
553 static int submodule_needs_pushing(const char *path, const unsigned char sha1[20])
555 if (add_submodule_odb(path) || !lookup_commit_reference(sha1))
558 if (for_each_remote_ref_submodule(path, has_remote, NULL) > 0) {
559 struct child_process cp = CHILD_PROCESS_INIT;
560 const char *argv[] = {"rev-list", NULL, "--not", "--remotes", "-n", "1" , NULL};
561 struct strbuf buf = STRBUF_INIT;
562 int needs_pushing = 0;
564 argv[1] = sha1_to_hex(sha1);
566 prepare_submodule_repo_env(&cp.env_array);
571 if (start_command(&cp))
572 die("Could not run 'git rev-list %s --not --remotes -n 1' command in submodule %s",
573 sha1_to_hex(sha1), path);
574 if (strbuf_read(&buf, cp.out, 41))
578 strbuf_release(&buf);
579 return needs_pushing;
585 static void collect_submodules_from_diff(struct diff_queue_struct *q,
586 struct diff_options *options,
590 struct string_list *needs_pushing = data;
592 for (i = 0; i < q->nr; i++) {
593 struct diff_filepair *p = q->queue[i];
594 if (!S_ISGITLINK(p->two->mode))
596 if (submodule_needs_pushing(p->two->path, p->two->oid.hash))
597 string_list_insert(needs_pushing, p->two->path);
601 static void find_unpushed_submodule_commits(struct commit *commit,
602 struct string_list *needs_pushing)
606 init_revisions(&rev, NULL);
607 rev.diffopt.output_format |= DIFF_FORMAT_CALLBACK;
608 rev.diffopt.format_callback = collect_submodules_from_diff;
609 rev.diffopt.format_callback_data = needs_pushing;
610 diff_tree_combined_merge(commit, 1, &rev);
613 int find_unpushed_submodules(unsigned char new_sha1[20],
614 const char *remotes_name, struct string_list *needs_pushing)
617 struct commit *commit;
618 const char *argv[] = {NULL, NULL, "--not", "NULL", NULL};
619 int argc = ARRAY_SIZE(argv) - 1;
622 struct strbuf remotes_arg = STRBUF_INIT;
624 strbuf_addf(&remotes_arg, "--remotes=%s", remotes_name);
625 init_revisions(&rev, NULL);
626 sha1_copy = xstrdup(sha1_to_hex(new_sha1));
628 argv[3] = remotes_arg.buf;
629 setup_revisions(argc, argv, &rev, NULL);
630 if (prepare_revision_walk(&rev))
631 die("revision walk setup failed");
633 while ((commit = get_revision(&rev)) != NULL)
634 find_unpushed_submodule_commits(commit, needs_pushing);
636 reset_revision_walk();
638 strbuf_release(&remotes_arg);
640 return needs_pushing->nr;
643 static int push_submodule(const char *path)
645 if (add_submodule_odb(path))
648 if (for_each_remote_ref_submodule(path, has_remote, NULL) > 0) {
649 struct child_process cp = CHILD_PROCESS_INIT;
650 const char *argv[] = {"push", NULL};
653 prepare_submodule_repo_env(&cp.env_array);
657 if (run_command(&cp))
665 int push_unpushed_submodules(unsigned char new_sha1[20], const char *remotes_name)
668 struct string_list needs_pushing = STRING_LIST_INIT_DUP;
670 if (!find_unpushed_submodules(new_sha1, remotes_name, &needs_pushing))
673 for (i = 0; i < needs_pushing.nr; i++) {
674 const char *path = needs_pushing.items[i].string;
675 fprintf(stderr, "Pushing submodule '%s'\n", path);
676 if (!push_submodule(path)) {
677 fprintf(stderr, "Unable to push submodule '%s'\n", path);
682 string_list_clear(&needs_pushing, 0);
687 static int is_submodule_commit_present(const char *path, unsigned char sha1[20])
690 if (!add_submodule_odb(path) && lookup_commit_reference(sha1)) {
691 /* Even if the submodule is checked out and the commit is
692 * present, make sure it is reachable from a ref. */
693 struct child_process cp = CHILD_PROCESS_INIT;
694 const char *argv[] = {"rev-list", "-n", "1", NULL, "--not", "--all", NULL};
695 struct strbuf buf = STRBUF_INIT;
697 argv[3] = sha1_to_hex(sha1);
699 prepare_submodule_repo_env(&cp.env_array);
703 if (!capture_command(&cp, &buf, 1024) && !buf.len)
706 strbuf_release(&buf);
711 static void submodule_collect_changed_cb(struct diff_queue_struct *q,
712 struct diff_options *options,
716 for (i = 0; i < q->nr; i++) {
717 struct diff_filepair *p = q->queue[i];
718 if (!S_ISGITLINK(p->two->mode))
721 if (S_ISGITLINK(p->one->mode)) {
722 /* NEEDSWORK: We should honor the name configured in
723 * the .gitmodules file of the commit we are examining
724 * here to be able to correctly follow submodules
725 * being moved around. */
726 struct string_list_item *path;
727 path = unsorted_string_list_lookup(&changed_submodule_paths, p->two->path);
728 if (!path && !is_submodule_commit_present(p->two->path, p->two->oid.hash))
729 string_list_append(&changed_submodule_paths, xstrdup(p->two->path));
731 /* Submodule is new or was moved here */
732 /* NEEDSWORK: When the .git directories of submodules
733 * live inside the superprojects .git directory some
734 * day we should fetch new submodules directly into
735 * that location too when config or options request
736 * that so they can be checked out from there. */
742 static int add_sha1_to_array(const char *ref, const struct object_id *oid,
743 int flags, void *data)
745 sha1_array_append(data, oid->hash);
749 void check_for_new_submodule_commits(unsigned char new_sha1[20])
751 if (!initialized_fetch_ref_tips) {
752 for_each_ref(add_sha1_to_array, &ref_tips_before_fetch);
753 initialized_fetch_ref_tips = 1;
756 sha1_array_append(&ref_tips_after_fetch, new_sha1);
759 static int add_sha1_to_argv(const unsigned char sha1[20], void *data)
761 argv_array_push(data, sha1_to_hex(sha1));
765 static void calculate_changed_submodule_paths(void)
768 struct commit *commit;
769 struct argv_array argv = ARGV_ARRAY_INIT;
771 /* No need to check if there are no submodules configured */
772 if (!submodule_from_path(NULL, NULL))
775 init_revisions(&rev, NULL);
776 argv_array_push(&argv, "--"); /* argv[0] program name */
777 sha1_array_for_each_unique(&ref_tips_after_fetch,
778 add_sha1_to_argv, &argv);
779 argv_array_push(&argv, "--not");
780 sha1_array_for_each_unique(&ref_tips_before_fetch,
781 add_sha1_to_argv, &argv);
782 setup_revisions(argv.argc, argv.argv, &rev, NULL);
783 if (prepare_revision_walk(&rev))
784 die("revision walk setup failed");
787 * Collect all submodules (whether checked out or not) for which new
788 * commits have been recorded upstream in "changed_submodule_paths".
790 while ((commit = get_revision(&rev))) {
791 struct commit_list *parent = commit->parents;
793 struct diff_options diff_opts;
794 diff_setup(&diff_opts);
795 DIFF_OPT_SET(&diff_opts, RECURSIVE);
796 diff_opts.output_format |= DIFF_FORMAT_CALLBACK;
797 diff_opts.format_callback = submodule_collect_changed_cb;
798 diff_setup_done(&diff_opts);
799 diff_tree_sha1(parent->item->object.oid.hash, commit->object.oid.hash, "", &diff_opts);
800 diffcore_std(&diff_opts);
801 diff_flush(&diff_opts);
802 parent = parent->next;
806 argv_array_clear(&argv);
807 sha1_array_clear(&ref_tips_before_fetch);
808 sha1_array_clear(&ref_tips_after_fetch);
809 initialized_fetch_ref_tips = 0;
812 struct submodule_parallel_fetch {
814 struct argv_array args;
815 const char *work_tree;
817 int command_line_option;
821 #define SPF_INIT {0, ARGV_ARRAY_INIT, NULL, NULL, 0, 0, 0}
823 static int get_next_submodule(struct child_process *cp,
824 struct strbuf *err, void *data, void **task_cb)
827 struct submodule_parallel_fetch *spf = data;
829 for (; spf->count < active_nr; spf->count++) {
830 struct strbuf submodule_path = STRBUF_INIT;
831 struct strbuf submodule_git_dir = STRBUF_INIT;
832 struct strbuf submodule_prefix = STRBUF_INIT;
833 const struct cache_entry *ce = active_cache[spf->count];
834 const char *git_dir, *default_argv;
835 const struct submodule *submodule;
837 if (!S_ISGITLINK(ce->ce_mode))
840 submodule = submodule_from_path(null_sha1, ce->name);
842 submodule = submodule_from_name(null_sha1, ce->name);
844 default_argv = "yes";
845 if (spf->command_line_option == RECURSE_SUBMODULES_DEFAULT) {
847 submodule->fetch_recurse !=
848 RECURSE_SUBMODULES_NONE) {
849 if (submodule->fetch_recurse ==
850 RECURSE_SUBMODULES_OFF)
852 if (submodule->fetch_recurse ==
853 RECURSE_SUBMODULES_ON_DEMAND) {
854 if (!unsorted_string_list_lookup(&changed_submodule_paths, ce->name))
856 default_argv = "on-demand";
859 if ((config_fetch_recurse_submodules == RECURSE_SUBMODULES_OFF) ||
860 gitmodules_is_unmerged)
862 if (config_fetch_recurse_submodules == RECURSE_SUBMODULES_ON_DEMAND) {
863 if (!unsorted_string_list_lookup(&changed_submodule_paths, ce->name))
865 default_argv = "on-demand";
868 } else if (spf->command_line_option == RECURSE_SUBMODULES_ON_DEMAND) {
869 if (!unsorted_string_list_lookup(&changed_submodule_paths, ce->name))
871 default_argv = "on-demand";
874 strbuf_addf(&submodule_path, "%s/%s", spf->work_tree, ce->name);
875 strbuf_addf(&submodule_git_dir, "%s/.git", submodule_path.buf);
876 strbuf_addf(&submodule_prefix, "%s%s/", spf->prefix, ce->name);
877 git_dir = read_gitfile(submodule_git_dir.buf);
879 git_dir = submodule_git_dir.buf;
880 if (is_directory(git_dir)) {
881 child_process_init(cp);
882 cp->dir = strbuf_detach(&submodule_path, NULL);
883 prepare_submodule_repo_env(&cp->env_array);
886 strbuf_addf(err, "Fetching submodule %s%s\n",
887 spf->prefix, ce->name);
888 argv_array_init(&cp->args);
889 argv_array_pushv(&cp->args, spf->args.argv);
890 argv_array_push(&cp->args, default_argv);
891 argv_array_push(&cp->args, "--submodule-prefix");
892 argv_array_push(&cp->args, submodule_prefix.buf);
895 strbuf_release(&submodule_path);
896 strbuf_release(&submodule_git_dir);
897 strbuf_release(&submodule_prefix);
906 static int fetch_start_failure(struct strbuf *err,
907 void *cb, void *task_cb)
909 struct submodule_parallel_fetch *spf = cb;
916 static int fetch_finish(int retvalue, struct strbuf *err,
917 void *cb, void *task_cb)
919 struct submodule_parallel_fetch *spf = cb;
927 int fetch_populated_submodules(const struct argv_array *options,
928 const char *prefix, int command_line_option,
929 int quiet, int max_parallel_jobs)
932 struct submodule_parallel_fetch spf = SPF_INIT;
934 spf.work_tree = get_git_work_tree();
935 spf.command_line_option = command_line_option;
942 if (read_cache() < 0)
943 die("index file corrupt");
945 argv_array_push(&spf.args, "fetch");
946 for (i = 0; i < options->argc; i++)
947 argv_array_push(&spf.args, options->argv[i]);
948 argv_array_push(&spf.args, "--recurse-submodules-default");
949 /* default value, "--submodule-prefix" and its value are added later */
951 if (max_parallel_jobs < 0)
952 max_parallel_jobs = parallel_jobs;
954 calculate_changed_submodule_paths();
955 run_processes_parallel(max_parallel_jobs,
961 argv_array_clear(&spf.args);
963 string_list_clear(&changed_submodule_paths, 1);
967 unsigned is_submodule_modified(const char *path, int ignore_untracked)
970 struct child_process cp = CHILD_PROCESS_INIT;
971 const char *argv[] = {
977 struct strbuf buf = STRBUF_INIT;
978 unsigned dirty_submodule = 0;
979 const char *line, *next_line;
982 strbuf_addf(&buf, "%s/.git", path);
983 git_dir = read_gitfile(buf.buf);
986 if (!is_directory(git_dir)) {
987 strbuf_release(&buf);
988 /* The submodule is not checked out, so it is not modified */
994 if (ignore_untracked)
998 prepare_submodule_repo_env(&cp.env_array);
1003 if (start_command(&cp))
1004 die("Could not run 'git status --porcelain' in submodule %s", path);
1006 len = strbuf_read(&buf, cp.out, 1024);
1009 if ((line[0] == '?') && (line[1] == '?')) {
1010 dirty_submodule |= DIRTY_SUBMODULE_UNTRACKED;
1011 if (dirty_submodule & DIRTY_SUBMODULE_MODIFIED)
1014 dirty_submodule |= DIRTY_SUBMODULE_MODIFIED;
1015 if (ignore_untracked ||
1016 (dirty_submodule & DIRTY_SUBMODULE_UNTRACKED))
1019 next_line = strchr(line, '\n');
1023 len -= (next_line - line);
1028 if (finish_command(&cp))
1029 die("'git status --porcelain' failed in submodule %s", path);
1031 strbuf_release(&buf);
1032 return dirty_submodule;
1035 int submodule_uses_gitfile(const char *path)
1037 struct child_process cp = CHILD_PROCESS_INIT;
1038 const char *argv[] = {
1046 struct strbuf buf = STRBUF_INIT;
1047 const char *git_dir;
1049 strbuf_addf(&buf, "%s/.git", path);
1050 git_dir = read_gitfile(buf.buf);
1052 strbuf_release(&buf);
1055 strbuf_release(&buf);
1057 /* Now test that all nested submodules use a gitfile too */
1059 prepare_submodule_repo_env(&cp.env_array);
1065 if (run_command(&cp))
1071 int ok_to_remove_submodule(const char *path)
1074 struct child_process cp = CHILD_PROCESS_INIT;
1075 const char *argv[] = {
1079 "--ignore-submodules=none",
1082 struct strbuf buf = STRBUF_INIT;
1083 int ok_to_remove = 1;
1085 if (!file_exists(path) || is_empty_dir(path))
1088 if (!submodule_uses_gitfile(path))
1092 prepare_submodule_repo_env(&cp.env_array);
1097 if (start_command(&cp))
1098 die("Could not run 'git status --porcelain -uall --ignore-submodules=none' in submodule %s", path);
1100 len = strbuf_read(&buf, cp.out, 1024);
1105 if (finish_command(&cp))
1106 die("'git status --porcelain -uall --ignore-submodules=none' failed in submodule %s", path);
1108 strbuf_release(&buf);
1109 return ok_to_remove;
1112 static int find_first_merges(struct object_array *result, const char *path,
1113 struct commit *a, struct commit *b)
1116 struct object_array merges = OBJECT_ARRAY_INIT;
1117 struct commit *commit;
1118 int contains_another;
1120 char merged_revision[42];
1121 const char *rev_args[] = { "rev-list", "--merges", "--ancestry-path",
1122 "--all", merged_revision, NULL };
1123 struct rev_info revs;
1124 struct setup_revision_opt rev_opts;
1126 memset(result, 0, sizeof(struct object_array));
1127 memset(&rev_opts, 0, sizeof(rev_opts));
1129 /* get all revisions that merge commit a */
1130 snprintf(merged_revision, sizeof(merged_revision), "^%s",
1131 oid_to_hex(&a->object.oid));
1132 init_revisions(&revs, NULL);
1133 rev_opts.submodule = path;
1134 setup_revisions(ARRAY_SIZE(rev_args)-1, rev_args, &revs, &rev_opts);
1136 /* save all revisions from the above list that contain b */
1137 if (prepare_revision_walk(&revs))
1138 die("revision walk setup failed");
1139 while ((commit = get_revision(&revs)) != NULL) {
1140 struct object *o = &(commit->object);
1141 if (in_merge_bases(b, commit))
1142 add_object_array(o, NULL, &merges);
1144 reset_revision_walk();
1146 /* Now we've got all merges that contain a and b. Prune all
1147 * merges that contain another found merge and save them in
1150 for (i = 0; i < merges.nr; i++) {
1151 struct commit *m1 = (struct commit *) merges.objects[i].item;
1153 contains_another = 0;
1154 for (j = 0; j < merges.nr; j++) {
1155 struct commit *m2 = (struct commit *) merges.objects[j].item;
1156 if (i != j && in_merge_bases(m2, m1)) {
1157 contains_another = 1;
1162 if (!contains_another)
1163 add_object_array(merges.objects[i].item, NULL, result);
1166 free(merges.objects);
1170 static void print_commit(struct commit *commit)
1172 struct strbuf sb = STRBUF_INIT;
1173 struct pretty_print_context ctx = {0};
1174 ctx.date_mode.type = DATE_NORMAL;
1175 format_commit_message(commit, " %h: %m %s", &sb, &ctx);
1176 fprintf(stderr, "%s\n", sb.buf);
1177 strbuf_release(&sb);
1180 #define MERGE_WARNING(path, msg) \
1181 warning("Failed to merge submodule %s (%s)", path, msg);
1183 int merge_submodule(unsigned char result[20], const char *path,
1184 const unsigned char base[20], const unsigned char a[20],
1185 const unsigned char b[20], int search)
1187 struct commit *commit_base, *commit_a, *commit_b;
1189 struct object_array merges;
1193 /* store a in result in case we fail */
1196 /* we can not handle deletion conflicts */
1197 if (is_null_sha1(base))
1199 if (is_null_sha1(a))
1201 if (is_null_sha1(b))
1204 if (add_submodule_odb(path)) {
1205 MERGE_WARNING(path, "not checked out");
1209 if (!(commit_base = lookup_commit_reference(base)) ||
1210 !(commit_a = lookup_commit_reference(a)) ||
1211 !(commit_b = lookup_commit_reference(b))) {
1212 MERGE_WARNING(path, "commits not present");
1216 /* check whether both changes are forward */
1217 if (!in_merge_bases(commit_base, commit_a) ||
1218 !in_merge_bases(commit_base, commit_b)) {
1219 MERGE_WARNING(path, "commits don't follow merge-base");
1223 /* Case #1: a is contained in b or vice versa */
1224 if (in_merge_bases(commit_a, commit_b)) {
1228 if (in_merge_bases(commit_b, commit_a)) {
1234 * Case #2: There are one or more merges that contain a and b in
1235 * the submodule. If there is only one, then present it as a
1236 * suggestion to the user, but leave it marked unmerged so the
1237 * user needs to confirm the resolution.
1240 /* Skip the search if makes no sense to the calling context. */
1244 /* find commit which merges them */
1245 parent_count = find_first_merges(&merges, path, commit_a, commit_b);
1246 switch (parent_count) {
1248 MERGE_WARNING(path, "merge following commits not found");
1252 MERGE_WARNING(path, "not fast-forward");
1253 fprintf(stderr, "Found a possible merge resolution "
1254 "for the submodule:\n");
1255 print_commit((struct commit *) merges.objects[0].item);
1257 "If this is correct simply add it to the index "
1260 " git update-index --cacheinfo 160000 %s \"%s\"\n\n"
1261 "which will accept this suggestion.\n",
1262 oid_to_hex(&merges.objects[0].item->oid), path);
1266 MERGE_WARNING(path, "multiple merges found");
1267 for (i = 0; i < merges.nr; i++)
1268 print_commit((struct commit *) merges.objects[i].item);
1271 free(merges.objects);
1275 /* Update gitfile and core.worktree setting to connect work tree and git dir */
1276 void connect_work_tree_and_git_dir(const char *work_tree, const char *git_dir)
1278 struct strbuf file_name = STRBUF_INIT;
1279 struct strbuf rel_path = STRBUF_INIT;
1280 const char *real_work_tree = real_pathdup(work_tree);
1282 /* Update gitfile */
1283 strbuf_addf(&file_name, "%s/.git", work_tree);
1284 write_file(file_name.buf, "gitdir: %s",
1285 relative_path(git_dir, real_work_tree, &rel_path));
1287 /* Update core.worktree setting */
1288 strbuf_reset(&file_name);
1289 strbuf_addf(&file_name, "%s/config", git_dir);
1290 git_config_set_in_file(file_name.buf, "core.worktree",
1291 relative_path(real_work_tree, git_dir,
1294 strbuf_release(&file_name);
1295 strbuf_release(&rel_path);
1296 free((void *)real_work_tree);
1299 int parallel_submodules(void)
1301 return parallel_jobs;
1304 void prepare_submodule_repo_env(struct argv_array *out)
1306 const char * const *var;
1308 for (var = local_repo_env; *var; var++) {
1309 if (strcmp(*var, CONFIG_DATA_ENVIRONMENT))
1310 argv_array_push(out, *var);
1312 argv_array_push(out, "GIT_DIR=.git");