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);
202 * Determine if a submodule has been initialized at a given 'path'
204 int is_submodule_initialized(const char *path)
207 const struct submodule *module = NULL;
209 module = submodule_from_path(null_sha1, path);
212 char *key = xstrfmt("submodule.%s.url", module->name);
215 ret = !git_config_get_string(key, &value);
225 * Determine if a submodule has been populated at a given 'path'
227 int is_submodule_populated(const char *path)
230 char *gitdir = xstrfmt("%s/.git", path);
232 if (resolve_gitdir(gitdir))
239 int parse_submodule_update_strategy(const char *value,
240 struct submodule_update_strategy *dst)
242 free((void*)dst->command);
244 if (!strcmp(value, "none"))
245 dst->type = SM_UPDATE_NONE;
246 else if (!strcmp(value, "checkout"))
247 dst->type = SM_UPDATE_CHECKOUT;
248 else if (!strcmp(value, "rebase"))
249 dst->type = SM_UPDATE_REBASE;
250 else if (!strcmp(value, "merge"))
251 dst->type = SM_UPDATE_MERGE;
252 else if (skip_prefix(value, "!", &value)) {
253 dst->type = SM_UPDATE_COMMAND;
254 dst->command = xstrdup(value);
260 const char *submodule_strategy_to_string(const struct submodule_update_strategy *s)
262 struct strbuf sb = STRBUF_INIT;
264 case SM_UPDATE_CHECKOUT:
266 case SM_UPDATE_MERGE:
268 case SM_UPDATE_REBASE:
272 case SM_UPDATE_UNSPECIFIED:
274 case SM_UPDATE_COMMAND:
275 strbuf_addf(&sb, "!%s", s->command);
276 return strbuf_detach(&sb, NULL);
281 void handle_ignore_submodules_arg(struct diff_options *diffopt,
284 DIFF_OPT_CLR(diffopt, IGNORE_SUBMODULES);
285 DIFF_OPT_CLR(diffopt, IGNORE_UNTRACKED_IN_SUBMODULES);
286 DIFF_OPT_CLR(diffopt, IGNORE_DIRTY_SUBMODULES);
288 if (!strcmp(arg, "all"))
289 DIFF_OPT_SET(diffopt, IGNORE_SUBMODULES);
290 else if (!strcmp(arg, "untracked"))
291 DIFF_OPT_SET(diffopt, IGNORE_UNTRACKED_IN_SUBMODULES);
292 else if (!strcmp(arg, "dirty"))
293 DIFF_OPT_SET(diffopt, IGNORE_DIRTY_SUBMODULES);
294 else if (strcmp(arg, "none"))
295 die("bad --ignore-submodules argument: %s", arg);
298 static int prepare_submodule_summary(struct rev_info *rev, const char *path,
299 struct commit *left, struct commit *right,
300 struct commit_list *merge_bases)
302 struct commit_list *list;
304 init_revisions(rev, NULL);
305 setup_revisions(0, NULL, rev, NULL);
307 rev->first_parent_only = 1;
308 left->object.flags |= SYMMETRIC_LEFT;
309 add_pending_object(rev, &left->object, path);
310 add_pending_object(rev, &right->object, path);
311 for (list = merge_bases; list; list = list->next) {
312 list->item->object.flags |= UNINTERESTING;
313 add_pending_object(rev, &list->item->object,
314 oid_to_hex(&list->item->object.oid));
316 return prepare_revision_walk(rev);
319 static void print_submodule_summary(struct rev_info *rev, FILE *f,
320 const char *line_prefix,
321 const char *del, const char *add, const char *reset)
323 static const char format[] = " %m %s";
324 struct strbuf sb = STRBUF_INIT;
325 struct commit *commit;
327 while ((commit = get_revision(rev))) {
328 struct pretty_print_context ctx = {0};
329 ctx.date_mode = rev->date_mode;
330 ctx.output_encoding = get_log_output_encoding();
331 strbuf_setlen(&sb, 0);
332 strbuf_addstr(&sb, line_prefix);
333 if (commit->object.flags & SYMMETRIC_LEFT) {
335 strbuf_addstr(&sb, del);
338 strbuf_addstr(&sb, add);
339 format_commit_message(commit, format, &sb, &ctx);
341 strbuf_addstr(&sb, reset);
342 strbuf_addch(&sb, '\n');
343 fprintf(f, "%s", sb.buf);
348 /* Helper function to display the submodule header line prior to the full
349 * summary output. If it can locate the submodule objects directory it will
350 * attempt to lookup both the left and right commits and put them into the
351 * left and right pointers.
353 static void show_submodule_header(FILE *f, const char *path,
354 const char *line_prefix,
355 struct object_id *one, struct object_id *two,
356 unsigned dirty_submodule, const char *meta,
358 struct commit **left, struct commit **right,
359 struct commit_list **merge_bases)
361 const char *message = NULL;
362 struct strbuf sb = STRBUF_INIT;
363 int fast_forward = 0, fast_backward = 0;
365 if (dirty_submodule & DIRTY_SUBMODULE_UNTRACKED)
366 fprintf(f, "%sSubmodule %s contains untracked content\n",
368 if (dirty_submodule & DIRTY_SUBMODULE_MODIFIED)
369 fprintf(f, "%sSubmodule %s contains modified content\n",
372 if (is_null_oid(one))
373 message = "(new submodule)";
374 else if (is_null_oid(two))
375 message = "(submodule deleted)";
377 if (add_submodule_odb(path)) {
379 message = "(not initialized)";
384 * Attempt to lookup the commit references, and determine if this is
385 * a fast forward or fast backwards update.
387 *left = lookup_commit_reference(one->hash);
388 *right = lookup_commit_reference(two->hash);
391 * Warn about missing commits in the submodule project, but only if
394 if ((!is_null_oid(one) && !*left) ||
395 (!is_null_oid(two) && !*right))
396 message = "(commits not present)";
398 *merge_bases = get_merge_bases(*left, *right);
400 if ((*merge_bases)->item == *left)
402 else if ((*merge_bases)->item == *right)
406 if (!oidcmp(one, two)) {
412 strbuf_addf(&sb, "%s%sSubmodule %s ", line_prefix, meta, path);
413 strbuf_add_unique_abbrev(&sb, one->hash, DEFAULT_ABBREV);
414 strbuf_addstr(&sb, (fast_backward || fast_forward) ? ".." : "...");
415 strbuf_add_unique_abbrev(&sb, two->hash, DEFAULT_ABBREV);
417 strbuf_addf(&sb, " %s%s\n", message, reset);
419 strbuf_addf(&sb, "%s:%s\n", fast_backward ? " (rewind)" : "", reset);
420 fwrite(sb.buf, sb.len, 1, f);
425 void show_submodule_summary(FILE *f, const char *path,
426 const char *line_prefix,
427 struct object_id *one, struct object_id *two,
428 unsigned dirty_submodule, const char *meta,
429 const char *del, const char *add, const char *reset)
432 struct commit *left = NULL, *right = NULL;
433 struct commit_list *merge_bases = NULL;
435 show_submodule_header(f, path, line_prefix, one, two, dirty_submodule,
436 meta, reset, &left, &right, &merge_bases);
439 * If we don't have both a left and a right pointer, there is no
440 * reason to try and display a summary. The header line should contain
441 * all the information the user needs.
446 /* Treat revision walker failure the same as missing commits */
447 if (prepare_submodule_summary(&rev, path, left, right, merge_bases)) {
448 fprintf(f, "%s(revision walker failed)\n", line_prefix);
452 print_submodule_summary(&rev, f, line_prefix, del, add, reset);
456 free_commit_list(merge_bases);
457 clear_commit_marks(left, ~0);
458 clear_commit_marks(right, ~0);
461 void show_submodule_inline_diff(FILE *f, const char *path,
462 const char *line_prefix,
463 struct object_id *one, struct object_id *two,
464 unsigned dirty_submodule, const char *meta,
465 const char *del, const char *add, const char *reset,
466 const struct diff_options *o)
468 const struct object_id *old = &empty_tree_oid, *new = &empty_tree_oid;
469 struct commit *left = NULL, *right = NULL;
470 struct commit_list *merge_bases = NULL;
471 struct strbuf submodule_dir = STRBUF_INIT;
472 struct child_process cp = CHILD_PROCESS_INIT;
474 show_submodule_header(f, path, line_prefix, one, two, dirty_submodule,
475 meta, reset, &left, &right, &merge_bases);
477 /* We need a valid left and right commit to display a difference */
478 if (!(left || is_null_oid(one)) ||
479 !(right || is_null_oid(two)))
490 cp.out = dup(fileno(f));
493 /* TODO: other options may need to be passed here. */
494 argv_array_push(&cp.args, "diff");
495 argv_array_pushf(&cp.args, "--line-prefix=%s", line_prefix);
496 if (DIFF_OPT_TST(o, REVERSE_DIFF)) {
497 argv_array_pushf(&cp.args, "--src-prefix=%s%s/",
499 argv_array_pushf(&cp.args, "--dst-prefix=%s%s/",
502 argv_array_pushf(&cp.args, "--src-prefix=%s%s/",
504 argv_array_pushf(&cp.args, "--dst-prefix=%s%s/",
507 argv_array_push(&cp.args, oid_to_hex(old));
509 * If the submodule has modified content, we will diff against the
510 * work tree, under the assumption that the user has asked for the
511 * diff format and wishes to actually see all differences even if they
512 * haven't yet been committed to the submodule yet.
514 if (!(dirty_submodule & DIRTY_SUBMODULE_MODIFIED))
515 argv_array_push(&cp.args, oid_to_hex(new));
517 if (run_command(&cp))
518 fprintf(f, "(diff failed)\n");
521 strbuf_release(&submodule_dir);
523 free_commit_list(merge_bases);
525 clear_commit_marks(left, ~0);
527 clear_commit_marks(right, ~0);
530 void set_config_fetch_recurse_submodules(int value)
532 config_fetch_recurse_submodules = value;
535 static int has_remote(const char *refname, const struct object_id *oid,
536 int flags, void *cb_data)
541 static int submodule_needs_pushing(const char *path, const unsigned char sha1[20])
543 if (add_submodule_odb(path) || !lookup_commit_reference(sha1))
546 if (for_each_remote_ref_submodule(path, has_remote, NULL) > 0) {
547 struct child_process cp = CHILD_PROCESS_INIT;
548 const char *argv[] = {"rev-list", NULL, "--not", "--remotes", "-n", "1" , NULL};
549 struct strbuf buf = STRBUF_INIT;
550 int needs_pushing = 0;
552 argv[1] = sha1_to_hex(sha1);
554 prepare_submodule_repo_env(&cp.env_array);
559 if (start_command(&cp))
560 die("Could not run 'git rev-list %s --not --remotes -n 1' command in submodule %s",
561 sha1_to_hex(sha1), path);
562 if (strbuf_read(&buf, cp.out, 41))
566 strbuf_release(&buf);
567 return needs_pushing;
573 static void collect_submodules_from_diff(struct diff_queue_struct *q,
574 struct diff_options *options,
578 struct string_list *needs_pushing = data;
580 for (i = 0; i < q->nr; i++) {
581 struct diff_filepair *p = q->queue[i];
582 if (!S_ISGITLINK(p->two->mode))
584 if (submodule_needs_pushing(p->two->path, p->two->oid.hash))
585 string_list_insert(needs_pushing, p->two->path);
589 static void find_unpushed_submodule_commits(struct commit *commit,
590 struct string_list *needs_pushing)
594 init_revisions(&rev, NULL);
595 rev.diffopt.output_format |= DIFF_FORMAT_CALLBACK;
596 rev.diffopt.format_callback = collect_submodules_from_diff;
597 rev.diffopt.format_callback_data = needs_pushing;
598 diff_tree_combined_merge(commit, 1, &rev);
601 int find_unpushed_submodules(unsigned char new_sha1[20],
602 const char *remotes_name, struct string_list *needs_pushing)
605 struct commit *commit;
606 const char *argv[] = {NULL, NULL, "--not", "NULL", NULL};
607 int argc = ARRAY_SIZE(argv) - 1;
610 struct strbuf remotes_arg = STRBUF_INIT;
612 strbuf_addf(&remotes_arg, "--remotes=%s", remotes_name);
613 init_revisions(&rev, NULL);
614 sha1_copy = xstrdup(sha1_to_hex(new_sha1));
616 argv[3] = remotes_arg.buf;
617 setup_revisions(argc, argv, &rev, NULL);
618 if (prepare_revision_walk(&rev))
619 die("revision walk setup failed");
621 while ((commit = get_revision(&rev)) != NULL)
622 find_unpushed_submodule_commits(commit, needs_pushing);
624 reset_revision_walk();
626 strbuf_release(&remotes_arg);
628 return needs_pushing->nr;
631 static int push_submodule(const char *path)
633 if (add_submodule_odb(path))
636 if (for_each_remote_ref_submodule(path, has_remote, NULL) > 0) {
637 struct child_process cp = CHILD_PROCESS_INIT;
638 const char *argv[] = {"push", NULL};
641 prepare_submodule_repo_env(&cp.env_array);
645 if (run_command(&cp))
653 int push_unpushed_submodules(unsigned char new_sha1[20], const char *remotes_name)
656 struct string_list needs_pushing = STRING_LIST_INIT_DUP;
658 if (!find_unpushed_submodules(new_sha1, remotes_name, &needs_pushing))
661 for (i = 0; i < needs_pushing.nr; i++) {
662 const char *path = needs_pushing.items[i].string;
663 fprintf(stderr, "Pushing submodule '%s'\n", path);
664 if (!push_submodule(path)) {
665 fprintf(stderr, "Unable to push submodule '%s'\n", path);
670 string_list_clear(&needs_pushing, 0);
675 static int is_submodule_commit_present(const char *path, unsigned char sha1[20])
678 if (!add_submodule_odb(path) && lookup_commit_reference(sha1)) {
679 /* Even if the submodule is checked out and the commit is
680 * present, make sure it is reachable from a ref. */
681 struct child_process cp = CHILD_PROCESS_INIT;
682 const char *argv[] = {"rev-list", "-n", "1", NULL, "--not", "--all", NULL};
683 struct strbuf buf = STRBUF_INIT;
685 argv[3] = sha1_to_hex(sha1);
687 prepare_submodule_repo_env(&cp.env_array);
691 if (!capture_command(&cp, &buf, 1024) && !buf.len)
694 strbuf_release(&buf);
699 static void submodule_collect_changed_cb(struct diff_queue_struct *q,
700 struct diff_options *options,
704 for (i = 0; i < q->nr; i++) {
705 struct diff_filepair *p = q->queue[i];
706 if (!S_ISGITLINK(p->two->mode))
709 if (S_ISGITLINK(p->one->mode)) {
710 /* NEEDSWORK: We should honor the name configured in
711 * the .gitmodules file of the commit we are examining
712 * here to be able to correctly follow submodules
713 * being moved around. */
714 struct string_list_item *path;
715 path = unsorted_string_list_lookup(&changed_submodule_paths, p->two->path);
716 if (!path && !is_submodule_commit_present(p->two->path, p->two->oid.hash))
717 string_list_append(&changed_submodule_paths, xstrdup(p->two->path));
719 /* Submodule is new or was moved here */
720 /* NEEDSWORK: When the .git directories of submodules
721 * live inside the superprojects .git directory some
722 * day we should fetch new submodules directly into
723 * that location too when config or options request
724 * that so they can be checked out from there. */
730 static int add_sha1_to_array(const char *ref, const struct object_id *oid,
731 int flags, void *data)
733 sha1_array_append(data, oid->hash);
737 void check_for_new_submodule_commits(unsigned char new_sha1[20])
739 if (!initialized_fetch_ref_tips) {
740 for_each_ref(add_sha1_to_array, &ref_tips_before_fetch);
741 initialized_fetch_ref_tips = 1;
744 sha1_array_append(&ref_tips_after_fetch, new_sha1);
747 static int add_sha1_to_argv(const unsigned char sha1[20], void *data)
749 argv_array_push(data, sha1_to_hex(sha1));
753 static void calculate_changed_submodule_paths(void)
756 struct commit *commit;
757 struct argv_array argv = ARGV_ARRAY_INIT;
759 /* No need to check if there are no submodules configured */
760 if (!submodule_from_path(NULL, NULL))
763 init_revisions(&rev, NULL);
764 argv_array_push(&argv, "--"); /* argv[0] program name */
765 sha1_array_for_each_unique(&ref_tips_after_fetch,
766 add_sha1_to_argv, &argv);
767 argv_array_push(&argv, "--not");
768 sha1_array_for_each_unique(&ref_tips_before_fetch,
769 add_sha1_to_argv, &argv);
770 setup_revisions(argv.argc, argv.argv, &rev, NULL);
771 if (prepare_revision_walk(&rev))
772 die("revision walk setup failed");
775 * Collect all submodules (whether checked out or not) for which new
776 * commits have been recorded upstream in "changed_submodule_paths".
778 while ((commit = get_revision(&rev))) {
779 struct commit_list *parent = commit->parents;
781 struct diff_options diff_opts;
782 diff_setup(&diff_opts);
783 DIFF_OPT_SET(&diff_opts, RECURSIVE);
784 diff_opts.output_format |= DIFF_FORMAT_CALLBACK;
785 diff_opts.format_callback = submodule_collect_changed_cb;
786 diff_setup_done(&diff_opts);
787 diff_tree_sha1(parent->item->object.oid.hash, commit->object.oid.hash, "", &diff_opts);
788 diffcore_std(&diff_opts);
789 diff_flush(&diff_opts);
790 parent = parent->next;
794 argv_array_clear(&argv);
795 sha1_array_clear(&ref_tips_before_fetch);
796 sha1_array_clear(&ref_tips_after_fetch);
797 initialized_fetch_ref_tips = 0;
800 struct submodule_parallel_fetch {
802 struct argv_array args;
803 const char *work_tree;
805 int command_line_option;
809 #define SPF_INIT {0, ARGV_ARRAY_INIT, NULL, NULL, 0, 0, 0}
811 static int get_next_submodule(struct child_process *cp,
812 struct strbuf *err, void *data, void **task_cb)
815 struct submodule_parallel_fetch *spf = data;
817 for (; spf->count < active_nr; spf->count++) {
818 struct strbuf submodule_path = STRBUF_INIT;
819 struct strbuf submodule_git_dir = STRBUF_INIT;
820 struct strbuf submodule_prefix = STRBUF_INIT;
821 const struct cache_entry *ce = active_cache[spf->count];
822 const char *git_dir, *default_argv;
823 const struct submodule *submodule;
825 if (!S_ISGITLINK(ce->ce_mode))
828 submodule = submodule_from_path(null_sha1, ce->name);
830 submodule = submodule_from_name(null_sha1, ce->name);
832 default_argv = "yes";
833 if (spf->command_line_option == RECURSE_SUBMODULES_DEFAULT) {
835 submodule->fetch_recurse !=
836 RECURSE_SUBMODULES_NONE) {
837 if (submodule->fetch_recurse ==
838 RECURSE_SUBMODULES_OFF)
840 if (submodule->fetch_recurse ==
841 RECURSE_SUBMODULES_ON_DEMAND) {
842 if (!unsorted_string_list_lookup(&changed_submodule_paths, ce->name))
844 default_argv = "on-demand";
847 if ((config_fetch_recurse_submodules == RECURSE_SUBMODULES_OFF) ||
848 gitmodules_is_unmerged)
850 if (config_fetch_recurse_submodules == RECURSE_SUBMODULES_ON_DEMAND) {
851 if (!unsorted_string_list_lookup(&changed_submodule_paths, ce->name))
853 default_argv = "on-demand";
856 } else if (spf->command_line_option == RECURSE_SUBMODULES_ON_DEMAND) {
857 if (!unsorted_string_list_lookup(&changed_submodule_paths, ce->name))
859 default_argv = "on-demand";
862 strbuf_addf(&submodule_path, "%s/%s", spf->work_tree, ce->name);
863 strbuf_addf(&submodule_git_dir, "%s/.git", submodule_path.buf);
864 strbuf_addf(&submodule_prefix, "%s%s/", spf->prefix, ce->name);
865 git_dir = read_gitfile(submodule_git_dir.buf);
867 git_dir = submodule_git_dir.buf;
868 if (is_directory(git_dir)) {
869 child_process_init(cp);
870 cp->dir = strbuf_detach(&submodule_path, NULL);
871 prepare_submodule_repo_env(&cp->env_array);
874 strbuf_addf(err, "Fetching submodule %s%s\n",
875 spf->prefix, ce->name);
876 argv_array_init(&cp->args);
877 argv_array_pushv(&cp->args, spf->args.argv);
878 argv_array_push(&cp->args, default_argv);
879 argv_array_push(&cp->args, "--submodule-prefix");
880 argv_array_push(&cp->args, submodule_prefix.buf);
883 strbuf_release(&submodule_path);
884 strbuf_release(&submodule_git_dir);
885 strbuf_release(&submodule_prefix);
894 static int fetch_start_failure(struct strbuf *err,
895 void *cb, void *task_cb)
897 struct submodule_parallel_fetch *spf = cb;
904 static int fetch_finish(int retvalue, struct strbuf *err,
905 void *cb, void *task_cb)
907 struct submodule_parallel_fetch *spf = cb;
915 int fetch_populated_submodules(const struct argv_array *options,
916 const char *prefix, int command_line_option,
917 int quiet, int max_parallel_jobs)
920 struct submodule_parallel_fetch spf = SPF_INIT;
922 spf.work_tree = get_git_work_tree();
923 spf.command_line_option = command_line_option;
930 if (read_cache() < 0)
931 die("index file corrupt");
933 argv_array_push(&spf.args, "fetch");
934 for (i = 0; i < options->argc; i++)
935 argv_array_push(&spf.args, options->argv[i]);
936 argv_array_push(&spf.args, "--recurse-submodules-default");
937 /* default value, "--submodule-prefix" and its value are added later */
939 if (max_parallel_jobs < 0)
940 max_parallel_jobs = parallel_jobs;
942 calculate_changed_submodule_paths();
943 run_processes_parallel(max_parallel_jobs,
949 argv_array_clear(&spf.args);
951 string_list_clear(&changed_submodule_paths, 1);
955 unsigned is_submodule_modified(const char *path, int ignore_untracked)
958 struct child_process cp = CHILD_PROCESS_INIT;
959 const char *argv[] = {
965 struct strbuf buf = STRBUF_INIT;
966 unsigned dirty_submodule = 0;
967 const char *line, *next_line;
970 strbuf_addf(&buf, "%s/.git", path);
971 git_dir = read_gitfile(buf.buf);
974 if (!is_directory(git_dir)) {
975 strbuf_release(&buf);
976 /* The submodule is not checked out, so it is not modified */
982 if (ignore_untracked)
986 prepare_submodule_repo_env(&cp.env_array);
991 if (start_command(&cp))
992 die("Could not run 'git status --porcelain' in submodule %s", path);
994 len = strbuf_read(&buf, cp.out, 1024);
997 if ((line[0] == '?') && (line[1] == '?')) {
998 dirty_submodule |= DIRTY_SUBMODULE_UNTRACKED;
999 if (dirty_submodule & DIRTY_SUBMODULE_MODIFIED)
1002 dirty_submodule |= DIRTY_SUBMODULE_MODIFIED;
1003 if (ignore_untracked ||
1004 (dirty_submodule & DIRTY_SUBMODULE_UNTRACKED))
1007 next_line = strchr(line, '\n');
1011 len -= (next_line - line);
1016 if (finish_command(&cp))
1017 die("'git status --porcelain' failed in submodule %s", path);
1019 strbuf_release(&buf);
1020 return dirty_submodule;
1023 int submodule_uses_gitfile(const char *path)
1025 struct child_process cp = CHILD_PROCESS_INIT;
1026 const char *argv[] = {
1034 struct strbuf buf = STRBUF_INIT;
1035 const char *git_dir;
1037 strbuf_addf(&buf, "%s/.git", path);
1038 git_dir = read_gitfile(buf.buf);
1040 strbuf_release(&buf);
1043 strbuf_release(&buf);
1045 /* Now test that all nested submodules use a gitfile too */
1047 prepare_submodule_repo_env(&cp.env_array);
1053 if (run_command(&cp))
1059 int ok_to_remove_submodule(const char *path)
1062 struct child_process cp = CHILD_PROCESS_INIT;
1063 const char *argv[] = {
1067 "--ignore-submodules=none",
1070 struct strbuf buf = STRBUF_INIT;
1071 int ok_to_remove = 1;
1073 if (!file_exists(path) || is_empty_dir(path))
1076 if (!submodule_uses_gitfile(path))
1080 prepare_submodule_repo_env(&cp.env_array);
1085 if (start_command(&cp))
1086 die("Could not run 'git status --porcelain -uall --ignore-submodules=none' in submodule %s", path);
1088 len = strbuf_read(&buf, cp.out, 1024);
1093 if (finish_command(&cp))
1094 die("'git status --porcelain -uall --ignore-submodules=none' failed in submodule %s", path);
1096 strbuf_release(&buf);
1097 return ok_to_remove;
1100 static int find_first_merges(struct object_array *result, const char *path,
1101 struct commit *a, struct commit *b)
1104 struct object_array merges = OBJECT_ARRAY_INIT;
1105 struct commit *commit;
1106 int contains_another;
1108 char merged_revision[42];
1109 const char *rev_args[] = { "rev-list", "--merges", "--ancestry-path",
1110 "--all", merged_revision, NULL };
1111 struct rev_info revs;
1112 struct setup_revision_opt rev_opts;
1114 memset(result, 0, sizeof(struct object_array));
1115 memset(&rev_opts, 0, sizeof(rev_opts));
1117 /* get all revisions that merge commit a */
1118 snprintf(merged_revision, sizeof(merged_revision), "^%s",
1119 oid_to_hex(&a->object.oid));
1120 init_revisions(&revs, NULL);
1121 rev_opts.submodule = path;
1122 setup_revisions(ARRAY_SIZE(rev_args)-1, rev_args, &revs, &rev_opts);
1124 /* save all revisions from the above list that contain b */
1125 if (prepare_revision_walk(&revs))
1126 die("revision walk setup failed");
1127 while ((commit = get_revision(&revs)) != NULL) {
1128 struct object *o = &(commit->object);
1129 if (in_merge_bases(b, commit))
1130 add_object_array(o, NULL, &merges);
1132 reset_revision_walk();
1134 /* Now we've got all merges that contain a and b. Prune all
1135 * merges that contain another found merge and save them in
1138 for (i = 0; i < merges.nr; i++) {
1139 struct commit *m1 = (struct commit *) merges.objects[i].item;
1141 contains_another = 0;
1142 for (j = 0; j < merges.nr; j++) {
1143 struct commit *m2 = (struct commit *) merges.objects[j].item;
1144 if (i != j && in_merge_bases(m2, m1)) {
1145 contains_another = 1;
1150 if (!contains_another)
1151 add_object_array(merges.objects[i].item, NULL, result);
1154 free(merges.objects);
1158 static void print_commit(struct commit *commit)
1160 struct strbuf sb = STRBUF_INIT;
1161 struct pretty_print_context ctx = {0};
1162 ctx.date_mode.type = DATE_NORMAL;
1163 format_commit_message(commit, " %h: %m %s", &sb, &ctx);
1164 fprintf(stderr, "%s\n", sb.buf);
1165 strbuf_release(&sb);
1168 #define MERGE_WARNING(path, msg) \
1169 warning("Failed to merge submodule %s (%s)", path, msg);
1171 int merge_submodule(unsigned char result[20], const char *path,
1172 const unsigned char base[20], const unsigned char a[20],
1173 const unsigned char b[20], int search)
1175 struct commit *commit_base, *commit_a, *commit_b;
1177 struct object_array merges;
1181 /* store a in result in case we fail */
1184 /* we can not handle deletion conflicts */
1185 if (is_null_sha1(base))
1187 if (is_null_sha1(a))
1189 if (is_null_sha1(b))
1192 if (add_submodule_odb(path)) {
1193 MERGE_WARNING(path, "not checked out");
1197 if (!(commit_base = lookup_commit_reference(base)) ||
1198 !(commit_a = lookup_commit_reference(a)) ||
1199 !(commit_b = lookup_commit_reference(b))) {
1200 MERGE_WARNING(path, "commits not present");
1204 /* check whether both changes are forward */
1205 if (!in_merge_bases(commit_base, commit_a) ||
1206 !in_merge_bases(commit_base, commit_b)) {
1207 MERGE_WARNING(path, "commits don't follow merge-base");
1211 /* Case #1: a is contained in b or vice versa */
1212 if (in_merge_bases(commit_a, commit_b)) {
1216 if (in_merge_bases(commit_b, commit_a)) {
1222 * Case #2: There are one or more merges that contain a and b in
1223 * the submodule. If there is only one, then present it as a
1224 * suggestion to the user, but leave it marked unmerged so the
1225 * user needs to confirm the resolution.
1228 /* Skip the search if makes no sense to the calling context. */
1232 /* find commit which merges them */
1233 parent_count = find_first_merges(&merges, path, commit_a, commit_b);
1234 switch (parent_count) {
1236 MERGE_WARNING(path, "merge following commits not found");
1240 MERGE_WARNING(path, "not fast-forward");
1241 fprintf(stderr, "Found a possible merge resolution "
1242 "for the submodule:\n");
1243 print_commit((struct commit *) merges.objects[0].item);
1245 "If this is correct simply add it to the index "
1248 " git update-index --cacheinfo 160000 %s \"%s\"\n\n"
1249 "which will accept this suggestion.\n",
1250 oid_to_hex(&merges.objects[0].item->oid), path);
1254 MERGE_WARNING(path, "multiple merges found");
1255 for (i = 0; i < merges.nr; i++)
1256 print_commit((struct commit *) merges.objects[i].item);
1259 free(merges.objects);
1263 /* Update gitfile and core.worktree setting to connect work tree and git dir */
1264 void connect_work_tree_and_git_dir(const char *work_tree, const char *git_dir)
1266 struct strbuf file_name = STRBUF_INIT;
1267 struct strbuf rel_path = STRBUF_INIT;
1268 const char *real_work_tree = real_pathdup(work_tree);
1270 /* Update gitfile */
1271 strbuf_addf(&file_name, "%s/.git", work_tree);
1272 write_file(file_name.buf, "gitdir: %s",
1273 relative_path(git_dir, real_work_tree, &rel_path));
1275 /* Update core.worktree setting */
1276 strbuf_reset(&file_name);
1277 strbuf_addf(&file_name, "%s/config", git_dir);
1278 git_config_set_in_file(file_name.buf, "core.worktree",
1279 relative_path(real_work_tree, git_dir,
1282 strbuf_release(&file_name);
1283 strbuf_release(&rel_path);
1284 free((void *)real_work_tree);
1287 int parallel_submodules(void)
1289 return parallel_jobs;
1292 void prepare_submodule_repo_env(struct argv_array *out)
1294 const char * const *var;
1296 for (var = local_repo_env; *var; var++) {
1297 if (strcmp(*var, CONFIG_DATA_ENVIRONMENT))
1298 argv_array_push(out, *var);
1300 argv_array_push(out, "GIT_DIR=.git");