stash: remove now superfluos help for "stash push"
[git.git] / submodule.c
blob63e7094e1620c2c3eb7dda0a8c38a833ae2d1c5a
1 #include "cache.h"
2 #include "repository.h"
3 #include "config.h"
4 #include "submodule-config.h"
5 #include "submodule.h"
6 #include "dir.h"
7 #include "diff.h"
8 #include "commit.h"
9 #include "revision.h"
10 #include "run-command.h"
11 #include "diffcore.h"
12 #include "refs.h"
13 #include "string-list.h"
14 #include "sha1-array.h"
15 #include "argv-array.h"
16 #include "blob.h"
17 #include "thread-utils.h"
18 #include "quote.h"
19 #include "remote.h"
20 #include "worktree.h"
21 #include "parse-options.h"
23 static int config_update_recurse_submodules = RECURSE_SUBMODULES_OFF;
24 static struct string_list changed_submodule_paths = STRING_LIST_INIT_DUP;
25 static int initialized_fetch_ref_tips;
26 static struct oid_array ref_tips_before_fetch;
27 static struct oid_array ref_tips_after_fetch;
30 * Check if the .gitmodules file is unmerged. Parsing of the .gitmodules file
31 * will be disabled because we can't guess what might be configured in
32 * .gitmodules unless the user resolves the conflict.
34 int is_gitmodules_unmerged(const struct index_state *istate)
36 int pos = index_name_pos(istate, GITMODULES_FILE, strlen(GITMODULES_FILE));
37 if (pos < 0) { /* .gitmodules not found or isn't merged */
38 pos = -1 - pos;
39 if (istate->cache_nr > pos) { /* there is a .gitmodules */
40 const struct cache_entry *ce = istate->cache[pos];
41 if (ce_namelen(ce) == strlen(GITMODULES_FILE) &&
42 !strcmp(ce->name, GITMODULES_FILE))
43 return 1;
47 return 0;
51 * Check if the .gitmodules file has unstaged modifications. This must be
52 * checked before allowing modifications to the .gitmodules file with the
53 * intention to stage them later, because when continuing we would stage the
54 * modifications the user didn't stage herself too. That might change in a
55 * future version when we learn to stage the changes we do ourselves without
56 * staging any previous modifications.
58 int is_staging_gitmodules_ok(const struct index_state *istate)
60 int pos = index_name_pos(istate, GITMODULES_FILE, strlen(GITMODULES_FILE));
62 if ((pos >= 0) && (pos < istate->cache_nr)) {
63 struct stat st;
64 if (lstat(GITMODULES_FILE, &st) == 0 &&
65 ce_match_stat(istate->cache[pos], &st, 0) & DATA_CHANGED)
66 return 0;
69 return 1;
72 static int for_each_remote_ref_submodule(const char *submodule,
73 each_ref_fn fn, void *cb_data)
75 return refs_for_each_remote_ref(get_submodule_ref_store(submodule),
76 fn, cb_data);
80 * Try to update the "path" entry in the "submodule.<name>" section of the
81 * .gitmodules file. Return 0 only if a .gitmodules file was found, a section
82 * with the correct path=<oldpath> setting was found and we could update it.
84 int update_path_in_gitmodules(const char *oldpath, const char *newpath)
86 struct strbuf entry = STRBUF_INIT;
87 const struct submodule *submodule;
89 if (!file_exists(GITMODULES_FILE)) /* Do nothing without .gitmodules */
90 return -1;
92 if (is_gitmodules_unmerged(&the_index))
93 die(_("Cannot change unmerged .gitmodules, resolve merge conflicts first"));
95 submodule = submodule_from_path(&null_oid, oldpath);
96 if (!submodule || !submodule->name) {
97 warning(_("Could not find section in .gitmodules where path=%s"), oldpath);
98 return -1;
100 strbuf_addstr(&entry, "submodule.");
101 strbuf_addstr(&entry, submodule->name);
102 strbuf_addstr(&entry, ".path");
103 if (git_config_set_in_file_gently(GITMODULES_FILE, entry.buf, newpath) < 0) {
104 /* Maybe the user already did that, don't error out here */
105 warning(_("Could not update .gitmodules entry %s"), entry.buf);
106 strbuf_release(&entry);
107 return -1;
109 strbuf_release(&entry);
110 return 0;
114 * Try to remove the "submodule.<name>" section from .gitmodules where the given
115 * path is configured. Return 0 only if a .gitmodules file was found, a section
116 * with the correct path=<path> setting was found and we could remove it.
118 int remove_path_from_gitmodules(const char *path)
120 struct strbuf sect = STRBUF_INIT;
121 const struct submodule *submodule;
123 if (!file_exists(GITMODULES_FILE)) /* Do nothing without .gitmodules */
124 return -1;
126 if (is_gitmodules_unmerged(&the_index))
127 die(_("Cannot change unmerged .gitmodules, resolve merge conflicts first"));
129 submodule = submodule_from_path(&null_oid, path);
130 if (!submodule || !submodule->name) {
131 warning(_("Could not find section in .gitmodules where path=%s"), path);
132 return -1;
134 strbuf_addstr(&sect, "submodule.");
135 strbuf_addstr(&sect, submodule->name);
136 if (git_config_rename_section_in_file(GITMODULES_FILE, sect.buf, NULL) < 0) {
137 /* Maybe the user already did that, don't error out here */
138 warning(_("Could not remove .gitmodules entry for %s"), path);
139 strbuf_release(&sect);
140 return -1;
142 strbuf_release(&sect);
143 return 0;
146 void stage_updated_gitmodules(void)
148 if (add_file_to_cache(GITMODULES_FILE, 0))
149 die(_("staging updated .gitmodules failed"));
152 static int add_submodule_odb(const char *path)
154 struct strbuf objects_directory = STRBUF_INIT;
155 int ret = 0;
157 ret = strbuf_git_path_submodule(&objects_directory, path, "objects/");
158 if (ret)
159 goto done;
160 if (!is_directory(objects_directory.buf)) {
161 ret = -1;
162 goto done;
164 add_to_alternates_memory(objects_directory.buf);
165 done:
166 strbuf_release(&objects_directory);
167 return ret;
170 void set_diffopt_flags_from_submodule_config(struct diff_options *diffopt,
171 const char *path)
173 const struct submodule *submodule = submodule_from_path(&null_oid, path);
174 if (submodule) {
175 const char *ignore;
176 char *key;
178 key = xstrfmt("submodule.%s.ignore", submodule->name);
179 if (repo_config_get_string_const(the_repository, key, &ignore))
180 ignore = submodule->ignore;
181 free(key);
183 if (ignore)
184 handle_ignore_submodules_arg(diffopt, ignore);
185 else if (is_gitmodules_unmerged(&the_index))
186 DIFF_OPT_SET(diffopt, IGNORE_SUBMODULES);
190 /* Cheap function that only determines if we're interested in submodules at all */
191 int git_default_submodule_config(const char *var, const char *value, void *cb)
193 if (!strcmp(var, "submodule.recurse")) {
194 int v = git_config_bool(var, value) ?
195 RECURSE_SUBMODULES_ON : RECURSE_SUBMODULES_OFF;
196 config_update_recurse_submodules = v;
198 return 0;
201 int option_parse_recurse_submodules_worktree_updater(const struct option *opt,
202 const char *arg, int unset)
204 if (unset) {
205 config_update_recurse_submodules = RECURSE_SUBMODULES_OFF;
206 return 0;
208 if (arg)
209 config_update_recurse_submodules =
210 parse_update_recurse_submodules_arg(opt->long_name,
211 arg);
212 else
213 config_update_recurse_submodules = RECURSE_SUBMODULES_ON;
215 return 0;
219 * Determine if a submodule has been initialized at a given 'path'
221 int is_submodule_active(struct repository *repo, const char *path)
223 int ret = 0;
224 char *key = NULL;
225 char *value = NULL;
226 const struct string_list *sl;
227 const struct submodule *module;
229 module = submodule_from_cache(repo, &null_oid, path);
231 /* early return if there isn't a path->module mapping */
232 if (!module)
233 return 0;
235 /* submodule.<name>.active is set */
236 key = xstrfmt("submodule.%s.active", module->name);
237 if (!repo_config_get_bool(repo, key, &ret)) {
238 free(key);
239 return ret;
241 free(key);
243 /* submodule.active is set */
244 sl = repo_config_get_value_multi(repo, "submodule.active");
245 if (sl) {
246 struct pathspec ps;
247 struct argv_array args = ARGV_ARRAY_INIT;
248 const struct string_list_item *item;
250 for_each_string_list_item(item, sl) {
251 argv_array_push(&args, item->string);
254 parse_pathspec(&ps, 0, 0, NULL, args.argv);
255 ret = match_pathspec(&ps, path, strlen(path), 0, NULL, 1);
257 argv_array_clear(&args);
258 clear_pathspec(&ps);
259 return ret;
262 /* fallback to checking if the URL is set */
263 key = xstrfmt("submodule.%s.url", module->name);
264 ret = !repo_config_get_string(repo, key, &value);
266 free(value);
267 free(key);
268 return ret;
271 int is_submodule_populated_gently(const char *path, int *return_error_code)
273 int ret = 0;
274 char *gitdir = xstrfmt("%s/.git", path);
276 if (resolve_gitdir_gently(gitdir, return_error_code))
277 ret = 1;
279 free(gitdir);
280 return ret;
284 * Dies if the provided 'prefix' corresponds to an unpopulated submodule
286 void die_in_unpopulated_submodule(const struct index_state *istate,
287 const char *prefix)
289 int i, prefixlen;
291 if (!prefix)
292 return;
294 prefixlen = strlen(prefix);
296 for (i = 0; i < istate->cache_nr; i++) {
297 struct cache_entry *ce = istate->cache[i];
298 int ce_len = ce_namelen(ce);
300 if (!S_ISGITLINK(ce->ce_mode))
301 continue;
302 if (prefixlen <= ce_len)
303 continue;
304 if (strncmp(ce->name, prefix, ce_len))
305 continue;
306 if (prefix[ce_len] != '/')
307 continue;
309 die(_("in unpopulated submodule '%s'"), ce->name);
314 * Dies if any paths in the provided pathspec descends into a submodule
316 void die_path_inside_submodule(const struct index_state *istate,
317 const struct pathspec *ps)
319 int i, j;
321 for (i = 0; i < istate->cache_nr; i++) {
322 struct cache_entry *ce = istate->cache[i];
323 int ce_len = ce_namelen(ce);
325 if (!S_ISGITLINK(ce->ce_mode))
326 continue;
328 for (j = 0; j < ps->nr ; j++) {
329 const struct pathspec_item *item = &ps->items[j];
331 if (item->len <= ce_len)
332 continue;
333 if (item->match[ce_len] != '/')
334 continue;
335 if (strncmp(ce->name, item->match, ce_len))
336 continue;
337 if (item->len == ce_len + 1)
338 continue;
340 die(_("Pathspec '%s' is in submodule '%.*s'"),
341 item->original, ce_len, ce->name);
346 enum submodule_update_type parse_submodule_update_type(const char *value)
348 if (!strcmp(value, "none"))
349 return SM_UPDATE_NONE;
350 else if (!strcmp(value, "checkout"))
351 return SM_UPDATE_CHECKOUT;
352 else if (!strcmp(value, "rebase"))
353 return SM_UPDATE_REBASE;
354 else if (!strcmp(value, "merge"))
355 return SM_UPDATE_MERGE;
356 else if (*value == '!')
357 return SM_UPDATE_COMMAND;
358 else
359 return SM_UPDATE_UNSPECIFIED;
362 int parse_submodule_update_strategy(const char *value,
363 struct submodule_update_strategy *dst)
365 enum submodule_update_type type;
367 free((void*)dst->command);
368 dst->command = NULL;
370 type = parse_submodule_update_type(value);
371 if (type == SM_UPDATE_UNSPECIFIED)
372 return -1;
374 dst->type = type;
375 if (type == SM_UPDATE_COMMAND)
376 dst->command = xstrdup(value + 1);
378 return 0;
381 const char *submodule_strategy_to_string(const struct submodule_update_strategy *s)
383 struct strbuf sb = STRBUF_INIT;
384 switch (s->type) {
385 case SM_UPDATE_CHECKOUT:
386 return "checkout";
387 case SM_UPDATE_MERGE:
388 return "merge";
389 case SM_UPDATE_REBASE:
390 return "rebase";
391 case SM_UPDATE_NONE:
392 return "none";
393 case SM_UPDATE_UNSPECIFIED:
394 return NULL;
395 case SM_UPDATE_COMMAND:
396 strbuf_addf(&sb, "!%s", s->command);
397 return strbuf_detach(&sb, NULL);
399 return NULL;
402 void handle_ignore_submodules_arg(struct diff_options *diffopt,
403 const char *arg)
405 DIFF_OPT_CLR(diffopt, IGNORE_SUBMODULES);
406 DIFF_OPT_CLR(diffopt, IGNORE_UNTRACKED_IN_SUBMODULES);
407 DIFF_OPT_CLR(diffopt, IGNORE_DIRTY_SUBMODULES);
409 if (!strcmp(arg, "all"))
410 DIFF_OPT_SET(diffopt, IGNORE_SUBMODULES);
411 else if (!strcmp(arg, "untracked"))
412 DIFF_OPT_SET(diffopt, IGNORE_UNTRACKED_IN_SUBMODULES);
413 else if (!strcmp(arg, "dirty"))
414 DIFF_OPT_SET(diffopt, IGNORE_DIRTY_SUBMODULES);
415 else if (strcmp(arg, "none"))
416 die("bad --ignore-submodules argument: %s", arg);
419 static int prepare_submodule_summary(struct rev_info *rev, const char *path,
420 struct commit *left, struct commit *right,
421 struct commit_list *merge_bases)
423 struct commit_list *list;
425 init_revisions(rev, NULL);
426 setup_revisions(0, NULL, rev, NULL);
427 rev->left_right = 1;
428 rev->first_parent_only = 1;
429 left->object.flags |= SYMMETRIC_LEFT;
430 add_pending_object(rev, &left->object, path);
431 add_pending_object(rev, &right->object, path);
432 for (list = merge_bases; list; list = list->next) {
433 list->item->object.flags |= UNINTERESTING;
434 add_pending_object(rev, &list->item->object,
435 oid_to_hex(&list->item->object.oid));
437 return prepare_revision_walk(rev);
440 static void print_submodule_summary(struct rev_info *rev, struct diff_options *o)
442 static const char format[] = " %m %s";
443 struct strbuf sb = STRBUF_INIT;
444 struct commit *commit;
446 while ((commit = get_revision(rev))) {
447 struct pretty_print_context ctx = {0};
448 ctx.date_mode = rev->date_mode;
449 ctx.output_encoding = get_log_output_encoding();
450 strbuf_setlen(&sb, 0);
451 format_commit_message(commit, format, &sb, &ctx);
452 strbuf_addch(&sb, '\n');
453 if (commit->object.flags & SYMMETRIC_LEFT)
454 diff_emit_submodule_del(o, sb.buf);
455 else
456 diff_emit_submodule_add(o, sb.buf);
458 strbuf_release(&sb);
461 static void prepare_submodule_repo_env_no_git_dir(struct argv_array *out)
463 const char * const *var;
465 for (var = local_repo_env; *var; var++) {
466 if (strcmp(*var, CONFIG_DATA_ENVIRONMENT))
467 argv_array_push(out, *var);
471 void prepare_submodule_repo_env(struct argv_array *out)
473 prepare_submodule_repo_env_no_git_dir(out);
474 argv_array_pushf(out, "%s=%s", GIT_DIR_ENVIRONMENT,
475 DEFAULT_GIT_DIR_ENVIRONMENT);
478 /* Helper function to display the submodule header line prior to the full
479 * summary output. If it can locate the submodule objects directory it will
480 * attempt to lookup both the left and right commits and put them into the
481 * left and right pointers.
483 static void show_submodule_header(struct diff_options *o, const char *path,
484 struct object_id *one, struct object_id *two,
485 unsigned dirty_submodule,
486 struct commit **left, struct commit **right,
487 struct commit_list **merge_bases)
489 const char *message = NULL;
490 struct strbuf sb = STRBUF_INIT;
491 int fast_forward = 0, fast_backward = 0;
493 if (dirty_submodule & DIRTY_SUBMODULE_UNTRACKED)
494 diff_emit_submodule_untracked(o, path);
496 if (dirty_submodule & DIRTY_SUBMODULE_MODIFIED)
497 diff_emit_submodule_modified(o, path);
499 if (is_null_oid(one))
500 message = "(new submodule)";
501 else if (is_null_oid(two))
502 message = "(submodule deleted)";
504 if (add_submodule_odb(path)) {
505 if (!message)
506 message = "(commits not present)";
507 goto output_header;
511 * Attempt to lookup the commit references, and determine if this is
512 * a fast forward or fast backwards update.
514 *left = lookup_commit_reference(one);
515 *right = lookup_commit_reference(two);
518 * Warn about missing commits in the submodule project, but only if
519 * they aren't null.
521 if ((!is_null_oid(one) && !*left) ||
522 (!is_null_oid(two) && !*right))
523 message = "(commits not present)";
525 *merge_bases = get_merge_bases(*left, *right);
526 if (*merge_bases) {
527 if ((*merge_bases)->item == *left)
528 fast_forward = 1;
529 else if ((*merge_bases)->item == *right)
530 fast_backward = 1;
533 if (!oidcmp(one, two)) {
534 strbuf_release(&sb);
535 return;
538 output_header:
539 strbuf_addf(&sb, "Submodule %s ", path);
540 strbuf_add_unique_abbrev(&sb, one->hash, DEFAULT_ABBREV);
541 strbuf_addstr(&sb, (fast_backward || fast_forward) ? ".." : "...");
542 strbuf_add_unique_abbrev(&sb, two->hash, DEFAULT_ABBREV);
543 if (message)
544 strbuf_addf(&sb, " %s\n", message);
545 else
546 strbuf_addf(&sb, "%s:\n", fast_backward ? " (rewind)" : "");
547 diff_emit_submodule_header(o, sb.buf);
549 strbuf_release(&sb);
552 void show_submodule_summary(struct diff_options *o, const char *path,
553 struct object_id *one, struct object_id *two,
554 unsigned dirty_submodule)
556 struct rev_info rev;
557 struct commit *left = NULL, *right = NULL;
558 struct commit_list *merge_bases = NULL;
560 show_submodule_header(o, path, one, two, dirty_submodule,
561 &left, &right, &merge_bases);
564 * If we don't have both a left and a right pointer, there is no
565 * reason to try and display a summary. The header line should contain
566 * all the information the user needs.
568 if (!left || !right)
569 goto out;
571 /* Treat revision walker failure the same as missing commits */
572 if (prepare_submodule_summary(&rev, path, left, right, merge_bases)) {
573 diff_emit_submodule_error(o, "(revision walker failed)\n");
574 goto out;
577 print_submodule_summary(&rev, o);
579 out:
580 if (merge_bases)
581 free_commit_list(merge_bases);
582 clear_commit_marks(left, ~0);
583 clear_commit_marks(right, ~0);
586 void show_submodule_inline_diff(struct diff_options *o, const char *path,
587 struct object_id *one, struct object_id *two,
588 unsigned dirty_submodule)
590 const struct object_id *old = &empty_tree_oid, *new = &empty_tree_oid;
591 struct commit *left = NULL, *right = NULL;
592 struct commit_list *merge_bases = NULL;
593 struct child_process cp = CHILD_PROCESS_INIT;
594 struct strbuf sb = STRBUF_INIT;
596 show_submodule_header(o, path, one, two, dirty_submodule,
597 &left, &right, &merge_bases);
599 /* We need a valid left and right commit to display a difference */
600 if (!(left || is_null_oid(one)) ||
601 !(right || is_null_oid(two)))
602 goto done;
604 if (left)
605 old = one;
606 if (right)
607 new = two;
609 cp.git_cmd = 1;
610 cp.dir = path;
611 cp.out = -1;
612 cp.no_stdin = 1;
614 /* TODO: other options may need to be passed here. */
615 argv_array_pushl(&cp.args, "diff", "--submodule=diff", NULL);
616 argv_array_pushf(&cp.args, "--color=%s", want_color(o->use_color) ?
617 "always" : "never");
619 if (DIFF_OPT_TST(o, REVERSE_DIFF)) {
620 argv_array_pushf(&cp.args, "--src-prefix=%s%s/",
621 o->b_prefix, path);
622 argv_array_pushf(&cp.args, "--dst-prefix=%s%s/",
623 o->a_prefix, path);
624 } else {
625 argv_array_pushf(&cp.args, "--src-prefix=%s%s/",
626 o->a_prefix, path);
627 argv_array_pushf(&cp.args, "--dst-prefix=%s%s/",
628 o->b_prefix, path);
630 argv_array_push(&cp.args, oid_to_hex(old));
632 * If the submodule has modified content, we will diff against the
633 * work tree, under the assumption that the user has asked for the
634 * diff format and wishes to actually see all differences even if they
635 * haven't yet been committed to the submodule yet.
637 if (!(dirty_submodule & DIRTY_SUBMODULE_MODIFIED))
638 argv_array_push(&cp.args, oid_to_hex(new));
640 prepare_submodule_repo_env(&cp.env_array);
641 if (start_command(&cp))
642 diff_emit_submodule_error(o, "(diff failed)\n");
644 while (strbuf_getwholeline_fd(&sb, cp.out, '\n') != EOF)
645 diff_emit_submodule_pipethrough(o, sb.buf, sb.len);
647 if (finish_command(&cp))
648 diff_emit_submodule_error(o, "(diff failed)\n");
650 done:
651 strbuf_release(&sb);
652 if (merge_bases)
653 free_commit_list(merge_bases);
654 if (left)
655 clear_commit_marks(left, ~0);
656 if (right)
657 clear_commit_marks(right, ~0);
660 int should_update_submodules(void)
662 return config_update_recurse_submodules == RECURSE_SUBMODULES_ON;
665 const struct submodule *submodule_from_ce(const struct cache_entry *ce)
667 if (!S_ISGITLINK(ce->ce_mode))
668 return NULL;
670 if (!should_update_submodules())
671 return NULL;
673 return submodule_from_path(&null_oid, ce->name);
676 static struct oid_array *submodule_commits(struct string_list *submodules,
677 const char *path)
679 struct string_list_item *item;
681 item = string_list_insert(submodules, path);
682 if (item->util)
683 return (struct oid_array *) item->util;
685 /* NEEDSWORK: should we have oid_array_init()? */
686 item->util = xcalloc(1, sizeof(struct oid_array));
687 return (struct oid_array *) item->util;
690 static void collect_changed_submodules_cb(struct diff_queue_struct *q,
691 struct diff_options *options,
692 void *data)
694 int i;
695 struct string_list *changed = data;
697 for (i = 0; i < q->nr; i++) {
698 struct diff_filepair *p = q->queue[i];
699 struct oid_array *commits;
700 if (!S_ISGITLINK(p->two->mode))
701 continue;
703 if (S_ISGITLINK(p->one->mode)) {
705 * NEEDSWORK: We should honor the name configured in
706 * the .gitmodules file of the commit we are examining
707 * here to be able to correctly follow submodules
708 * being moved around.
710 commits = submodule_commits(changed, p->two->path);
711 oid_array_append(commits, &p->two->oid);
712 } else {
713 /* Submodule is new or was moved here */
715 * NEEDSWORK: When the .git directories of submodules
716 * live inside the superprojects .git directory some
717 * day we should fetch new submodules directly into
718 * that location too when config or options request
719 * that so they can be checked out from there.
721 continue;
727 * Collect the paths of submodules in 'changed' which have changed based on
728 * the revisions as specified in 'argv'. Each entry in 'changed' will also
729 * have a corresponding 'struct oid_array' (in the 'util' field) which lists
730 * what the submodule pointers were updated to during the change.
732 static void collect_changed_submodules(struct string_list *changed,
733 struct argv_array *argv)
735 struct rev_info rev;
736 const struct commit *commit;
738 init_revisions(&rev, NULL);
739 setup_revisions(argv->argc, argv->argv, &rev, NULL);
740 if (prepare_revision_walk(&rev))
741 die("revision walk setup failed");
743 while ((commit = get_revision(&rev))) {
744 struct rev_info diff_rev;
746 init_revisions(&diff_rev, NULL);
747 diff_rev.diffopt.output_format |= DIFF_FORMAT_CALLBACK;
748 diff_rev.diffopt.format_callback = collect_changed_submodules_cb;
749 diff_rev.diffopt.format_callback_data = changed;
750 diff_tree_combined_merge(commit, 1, &diff_rev);
753 reset_revision_walk();
756 static void free_submodules_oids(struct string_list *submodules)
758 struct string_list_item *item;
759 for_each_string_list_item(item, submodules)
760 oid_array_clear((struct oid_array *) item->util);
761 string_list_clear(submodules, 1);
764 static int has_remote(const char *refname, const struct object_id *oid,
765 int flags, void *cb_data)
767 return 1;
770 static int append_oid_to_argv(const struct object_id *oid, void *data)
772 struct argv_array *argv = data;
773 argv_array_push(argv, oid_to_hex(oid));
774 return 0;
777 struct has_commit_data {
778 int result;
779 const char *path;
782 static int check_has_commit(const struct object_id *oid, void *data)
784 struct has_commit_data *cb = data;
786 enum object_type type = sha1_object_info(oid->hash, NULL);
788 switch (type) {
789 case OBJ_COMMIT:
790 return 0;
791 case OBJ_BAD:
793 * Object is missing or invalid. If invalid, an error message
794 * has already been printed.
796 cb->result = 0;
797 return 0;
798 default:
799 die(_("submodule entry '%s' (%s) is a %s, not a commit"),
800 cb->path, oid_to_hex(oid), typename(type));
804 static int submodule_has_commits(const char *path, struct oid_array *commits)
806 struct has_commit_data has_commit = { 1, path };
809 * Perform a cheap, but incorrect check for the existence of 'commits'.
810 * This is done by adding the submodule's object store to the in-core
811 * object store, and then querying for each commit's existence. If we
812 * do not have the commit object anywhere, there is no chance we have
813 * it in the object store of the correct submodule and have it
814 * reachable from a ref, so we can fail early without spawning rev-list
815 * which is expensive.
817 if (add_submodule_odb(path))
818 return 0;
820 oid_array_for_each_unique(commits, check_has_commit, &has_commit);
822 if (has_commit.result) {
824 * Even if the submodule is checked out and the commit is
825 * present, make sure it exists in the submodule's object store
826 * and that it is reachable from a ref.
828 struct child_process cp = CHILD_PROCESS_INIT;
829 struct strbuf out = STRBUF_INIT;
831 argv_array_pushl(&cp.args, "rev-list", "-n", "1", NULL);
832 oid_array_for_each_unique(commits, append_oid_to_argv, &cp.args);
833 argv_array_pushl(&cp.args, "--not", "--all", NULL);
835 prepare_submodule_repo_env(&cp.env_array);
836 cp.git_cmd = 1;
837 cp.no_stdin = 1;
838 cp.dir = path;
840 if (capture_command(&cp, &out, GIT_MAX_HEXSZ + 1) || out.len)
841 has_commit.result = 0;
843 strbuf_release(&out);
846 return has_commit.result;
849 static int submodule_needs_pushing(const char *path, struct oid_array *commits)
851 if (!submodule_has_commits(path, commits))
853 * NOTE: We do consider it safe to return "no" here. The
854 * correct answer would be "We do not know" instead of
855 * "No push needed", but it is quite hard to change
856 * the submodule pointer without having the submodule
857 * around. If a user did however change the submodules
858 * without having the submodule around, this indicates
859 * an expert who knows what they are doing or a
860 * maintainer integrating work from other people. In
861 * both cases it should be safe to skip this check.
863 return 0;
865 if (for_each_remote_ref_submodule(path, has_remote, NULL) > 0) {
866 struct child_process cp = CHILD_PROCESS_INIT;
867 struct strbuf buf = STRBUF_INIT;
868 int needs_pushing = 0;
870 argv_array_push(&cp.args, "rev-list");
871 oid_array_for_each_unique(commits, append_oid_to_argv, &cp.args);
872 argv_array_pushl(&cp.args, "--not", "--remotes", "-n", "1" , NULL);
874 prepare_submodule_repo_env(&cp.env_array);
875 cp.git_cmd = 1;
876 cp.no_stdin = 1;
877 cp.out = -1;
878 cp.dir = path;
879 if (start_command(&cp))
880 die("Could not run 'git rev-list <commits> --not --remotes -n 1' command in submodule %s",
881 path);
882 if (strbuf_read(&buf, cp.out, 41))
883 needs_pushing = 1;
884 finish_command(&cp);
885 close(cp.out);
886 strbuf_release(&buf);
887 return needs_pushing;
890 return 0;
893 int find_unpushed_submodules(struct oid_array *commits,
894 const char *remotes_name, struct string_list *needs_pushing)
896 struct string_list submodules = STRING_LIST_INIT_DUP;
897 struct string_list_item *submodule;
898 struct argv_array argv = ARGV_ARRAY_INIT;
900 /* argv.argv[0] will be ignored by setup_revisions */
901 argv_array_push(&argv, "find_unpushed_submodules");
902 oid_array_for_each_unique(commits, append_oid_to_argv, &argv);
903 argv_array_push(&argv, "--not");
904 argv_array_pushf(&argv, "--remotes=%s", remotes_name);
906 collect_changed_submodules(&submodules, &argv);
908 for_each_string_list_item(submodule, &submodules) {
909 struct oid_array *commits = submodule->util;
910 const char *path = submodule->string;
912 if (submodule_needs_pushing(path, commits))
913 string_list_insert(needs_pushing, path);
916 free_submodules_oids(&submodules);
917 argv_array_clear(&argv);
919 return needs_pushing->nr;
922 static int push_submodule(const char *path,
923 const struct remote *remote,
924 const char **refspec, int refspec_nr,
925 const struct string_list *push_options,
926 int dry_run)
928 if (add_submodule_odb(path))
929 return 1;
931 if (for_each_remote_ref_submodule(path, has_remote, NULL) > 0) {
932 struct child_process cp = CHILD_PROCESS_INIT;
933 argv_array_push(&cp.args, "push");
934 if (dry_run)
935 argv_array_push(&cp.args, "--dry-run");
937 if (push_options && push_options->nr) {
938 const struct string_list_item *item;
939 for_each_string_list_item(item, push_options)
940 argv_array_pushf(&cp.args, "--push-option=%s",
941 item->string);
944 if (remote->origin != REMOTE_UNCONFIGURED) {
945 int i;
946 argv_array_push(&cp.args, remote->name);
947 for (i = 0; i < refspec_nr; i++)
948 argv_array_push(&cp.args, refspec[i]);
951 prepare_submodule_repo_env(&cp.env_array);
952 cp.git_cmd = 1;
953 cp.no_stdin = 1;
954 cp.dir = path;
955 if (run_command(&cp))
956 return 0;
957 close(cp.out);
960 return 1;
964 * Perform a check in the submodule to see if the remote and refspec work.
965 * Die if the submodule can't be pushed.
967 static void submodule_push_check(const char *path, const char *head,
968 const struct remote *remote,
969 const char **refspec, int refspec_nr)
971 struct child_process cp = CHILD_PROCESS_INIT;
972 int i;
974 argv_array_push(&cp.args, "submodule--helper");
975 argv_array_push(&cp.args, "push-check");
976 argv_array_push(&cp.args, head);
977 argv_array_push(&cp.args, remote->name);
979 for (i = 0; i < refspec_nr; i++)
980 argv_array_push(&cp.args, refspec[i]);
982 prepare_submodule_repo_env(&cp.env_array);
983 cp.git_cmd = 1;
984 cp.no_stdin = 1;
985 cp.no_stdout = 1;
986 cp.dir = path;
989 * Simply indicate if 'submodule--helper push-check' failed.
990 * More detailed error information will be provided by the
991 * child process.
993 if (run_command(&cp))
994 die("process for submodule '%s' failed", path);
997 int push_unpushed_submodules(struct oid_array *commits,
998 const struct remote *remote,
999 const char **refspec, int refspec_nr,
1000 const struct string_list *push_options,
1001 int dry_run)
1003 int i, ret = 1;
1004 struct string_list needs_pushing = STRING_LIST_INIT_DUP;
1006 if (!find_unpushed_submodules(commits, remote->name, &needs_pushing))
1007 return 1;
1010 * Verify that the remote and refspec can be propagated to all
1011 * submodules. This check can be skipped if the remote and refspec
1012 * won't be propagated due to the remote being unconfigured (e.g. a URL
1013 * instead of a remote name).
1015 if (remote->origin != REMOTE_UNCONFIGURED) {
1016 char *head;
1017 struct object_id head_oid;
1019 head = resolve_refdup("HEAD", 0, head_oid.hash, NULL);
1020 if (!head)
1021 die(_("Failed to resolve HEAD as a valid ref."));
1023 for (i = 0; i < needs_pushing.nr; i++)
1024 submodule_push_check(needs_pushing.items[i].string,
1025 head, remote,
1026 refspec, refspec_nr);
1027 free(head);
1030 /* Actually push the submodules */
1031 for (i = 0; i < needs_pushing.nr; i++) {
1032 const char *path = needs_pushing.items[i].string;
1033 fprintf(stderr, "Pushing submodule '%s'\n", path);
1034 if (!push_submodule(path, remote, refspec, refspec_nr,
1035 push_options, dry_run)) {
1036 fprintf(stderr, "Unable to push submodule '%s'\n", path);
1037 ret = 0;
1041 string_list_clear(&needs_pushing, 0);
1043 return ret;
1046 static int append_oid_to_array(const char *ref, const struct object_id *oid,
1047 int flags, void *data)
1049 struct oid_array *array = data;
1050 oid_array_append(array, oid);
1051 return 0;
1054 void check_for_new_submodule_commits(struct object_id *oid)
1056 if (!initialized_fetch_ref_tips) {
1057 for_each_ref(append_oid_to_array, &ref_tips_before_fetch);
1058 initialized_fetch_ref_tips = 1;
1061 oid_array_append(&ref_tips_after_fetch, oid);
1064 static void calculate_changed_submodule_paths(void)
1066 struct argv_array argv = ARGV_ARRAY_INIT;
1067 struct string_list changed_submodules = STRING_LIST_INIT_DUP;
1068 const struct string_list_item *item;
1070 /* No need to check if there are no submodules configured */
1071 if (!submodule_from_path(NULL, NULL))
1072 return;
1074 argv_array_push(&argv, "--"); /* argv[0] program name */
1075 oid_array_for_each_unique(&ref_tips_after_fetch,
1076 append_oid_to_argv, &argv);
1077 argv_array_push(&argv, "--not");
1078 oid_array_for_each_unique(&ref_tips_before_fetch,
1079 append_oid_to_argv, &argv);
1082 * Collect all submodules (whether checked out or not) for which new
1083 * commits have been recorded upstream in "changed_submodule_paths".
1085 collect_changed_submodules(&changed_submodules, &argv);
1087 for_each_string_list_item(item, &changed_submodules) {
1088 struct oid_array *commits = item->util;
1089 const char *path = item->string;
1091 if (!submodule_has_commits(path, commits))
1092 string_list_append(&changed_submodule_paths, path);
1095 free_submodules_oids(&changed_submodules);
1096 argv_array_clear(&argv);
1097 oid_array_clear(&ref_tips_before_fetch);
1098 oid_array_clear(&ref_tips_after_fetch);
1099 initialized_fetch_ref_tips = 0;
1102 int submodule_touches_in_range(struct object_id *excl_oid,
1103 struct object_id *incl_oid)
1105 struct string_list subs = STRING_LIST_INIT_DUP;
1106 struct argv_array args = ARGV_ARRAY_INIT;
1107 int ret;
1109 /* No need to check if there are no submodules configured */
1110 if (!submodule_from_path(NULL, NULL))
1111 return 0;
1113 argv_array_push(&args, "--"); /* args[0] program name */
1114 argv_array_push(&args, oid_to_hex(incl_oid));
1115 argv_array_push(&args, "--not");
1116 argv_array_push(&args, oid_to_hex(excl_oid));
1118 collect_changed_submodules(&subs, &args);
1119 ret = subs.nr;
1121 argv_array_clear(&args);
1123 free_submodules_oids(&subs);
1124 return ret;
1127 struct submodule_parallel_fetch {
1128 int count;
1129 struct argv_array args;
1130 const char *work_tree;
1131 const char *prefix;
1132 int command_line_option;
1133 int default_option;
1134 int quiet;
1135 int result;
1137 #define SPF_INIT {0, ARGV_ARRAY_INIT, NULL, NULL, 0, 0, 0, 0}
1139 static int get_next_submodule(struct child_process *cp,
1140 struct strbuf *err, void *data, void **task_cb)
1142 int ret = 0;
1143 struct submodule_parallel_fetch *spf = data;
1145 for (; spf->count < active_nr; spf->count++) {
1146 struct strbuf submodule_path = STRBUF_INIT;
1147 struct strbuf submodule_git_dir = STRBUF_INIT;
1148 struct strbuf submodule_prefix = STRBUF_INIT;
1149 const struct cache_entry *ce = active_cache[spf->count];
1150 const char *git_dir, *default_argv;
1151 const struct submodule *submodule;
1153 if (!S_ISGITLINK(ce->ce_mode))
1154 continue;
1156 submodule = submodule_from_path(&null_oid, ce->name);
1158 default_argv = "yes";
1159 if (spf->command_line_option == RECURSE_SUBMODULES_DEFAULT) {
1160 int fetch_recurse = RECURSE_SUBMODULES_NONE;
1162 if (submodule) {
1163 char *key;
1164 const char *value;
1166 fetch_recurse = submodule->fetch_recurse;
1167 key = xstrfmt("submodule.%s.fetchRecurseSubmodules", submodule->name);
1168 if (!repo_config_get_string_const(the_repository, key, &value)) {
1169 fetch_recurse = parse_fetch_recurse_submodules_arg(key, value);
1171 free(key);
1174 if (fetch_recurse != RECURSE_SUBMODULES_NONE) {
1175 if (fetch_recurse == RECURSE_SUBMODULES_OFF)
1176 continue;
1177 if (fetch_recurse == RECURSE_SUBMODULES_ON_DEMAND) {
1178 if (!unsorted_string_list_lookup(&changed_submodule_paths, ce->name))
1179 continue;
1180 default_argv = "on-demand";
1182 } else {
1183 if (spf->default_option == RECURSE_SUBMODULES_OFF)
1184 continue;
1185 if (spf->default_option == RECURSE_SUBMODULES_ON_DEMAND) {
1186 if (!unsorted_string_list_lookup(&changed_submodule_paths, ce->name))
1187 continue;
1188 default_argv = "on-demand";
1191 } else if (spf->command_line_option == RECURSE_SUBMODULES_ON_DEMAND) {
1192 if (!unsorted_string_list_lookup(&changed_submodule_paths, ce->name))
1193 continue;
1194 default_argv = "on-demand";
1197 strbuf_addf(&submodule_path, "%s/%s", spf->work_tree, ce->name);
1198 strbuf_addf(&submodule_git_dir, "%s/.git", submodule_path.buf);
1199 strbuf_addf(&submodule_prefix, "%s%s/", spf->prefix, ce->name);
1200 git_dir = read_gitfile(submodule_git_dir.buf);
1201 if (!git_dir)
1202 git_dir = submodule_git_dir.buf;
1203 if (is_directory(git_dir)) {
1204 child_process_init(cp);
1205 cp->dir = strbuf_detach(&submodule_path, NULL);
1206 prepare_submodule_repo_env(&cp->env_array);
1207 cp->git_cmd = 1;
1208 if (!spf->quiet)
1209 strbuf_addf(err, "Fetching submodule %s%s\n",
1210 spf->prefix, ce->name);
1211 argv_array_init(&cp->args);
1212 argv_array_pushv(&cp->args, spf->args.argv);
1213 argv_array_push(&cp->args, default_argv);
1214 argv_array_push(&cp->args, "--submodule-prefix");
1215 argv_array_push(&cp->args, submodule_prefix.buf);
1216 ret = 1;
1218 strbuf_release(&submodule_path);
1219 strbuf_release(&submodule_git_dir);
1220 strbuf_release(&submodule_prefix);
1221 if (ret) {
1222 spf->count++;
1223 return 1;
1226 return 0;
1229 static int fetch_start_failure(struct strbuf *err,
1230 void *cb, void *task_cb)
1232 struct submodule_parallel_fetch *spf = cb;
1234 spf->result = 1;
1236 return 0;
1239 static int fetch_finish(int retvalue, struct strbuf *err,
1240 void *cb, void *task_cb)
1242 struct submodule_parallel_fetch *spf = cb;
1244 if (retvalue)
1245 spf->result = 1;
1247 return 0;
1250 int fetch_populated_submodules(const struct argv_array *options,
1251 const char *prefix, int command_line_option,
1252 int default_option,
1253 int quiet, int max_parallel_jobs)
1255 int i;
1256 struct submodule_parallel_fetch spf = SPF_INIT;
1258 spf.work_tree = get_git_work_tree();
1259 spf.command_line_option = command_line_option;
1260 spf.default_option = default_option;
1261 spf.quiet = quiet;
1262 spf.prefix = prefix;
1264 if (!spf.work_tree)
1265 goto out;
1267 if (read_cache() < 0)
1268 die("index file corrupt");
1270 argv_array_push(&spf.args, "fetch");
1271 for (i = 0; i < options->argc; i++)
1272 argv_array_push(&spf.args, options->argv[i]);
1273 argv_array_push(&spf.args, "--recurse-submodules-default");
1274 /* default value, "--submodule-prefix" and its value are added later */
1276 calculate_changed_submodule_paths();
1277 run_processes_parallel(max_parallel_jobs,
1278 get_next_submodule,
1279 fetch_start_failure,
1280 fetch_finish,
1281 &spf);
1283 argv_array_clear(&spf.args);
1284 out:
1285 string_list_clear(&changed_submodule_paths, 1);
1286 return spf.result;
1289 unsigned is_submodule_modified(const char *path, int ignore_untracked)
1291 struct child_process cp = CHILD_PROCESS_INIT;
1292 struct strbuf buf = STRBUF_INIT;
1293 FILE *fp;
1294 unsigned dirty_submodule = 0;
1295 const char *git_dir;
1296 int ignore_cp_exit_code = 0;
1298 strbuf_addf(&buf, "%s/.git", path);
1299 git_dir = read_gitfile(buf.buf);
1300 if (!git_dir)
1301 git_dir = buf.buf;
1302 if (!is_git_directory(git_dir)) {
1303 if (is_directory(git_dir))
1304 die(_("'%s' not recognized as a git repository"), git_dir);
1305 strbuf_release(&buf);
1306 /* The submodule is not checked out, so it is not modified */
1307 return 0;
1309 strbuf_reset(&buf);
1311 argv_array_pushl(&cp.args, "status", "--porcelain=2", NULL);
1312 if (ignore_untracked)
1313 argv_array_push(&cp.args, "-uno");
1315 prepare_submodule_repo_env(&cp.env_array);
1316 cp.git_cmd = 1;
1317 cp.no_stdin = 1;
1318 cp.out = -1;
1319 cp.dir = path;
1320 if (start_command(&cp))
1321 die("Could not run 'git status --porcelain=2' in submodule %s", path);
1323 fp = xfdopen(cp.out, "r");
1324 while (strbuf_getwholeline(&buf, fp, '\n') != EOF) {
1325 /* regular untracked files */
1326 if (buf.buf[0] == '?')
1327 dirty_submodule |= DIRTY_SUBMODULE_UNTRACKED;
1329 if (buf.buf[0] == 'u' ||
1330 buf.buf[0] == '1' ||
1331 buf.buf[0] == '2') {
1332 /* T = line type, XY = status, SSSS = submodule state */
1333 if (buf.len < strlen("T XY SSSS"))
1334 die("BUG: invalid status --porcelain=2 line %s",
1335 buf.buf);
1337 if (buf.buf[5] == 'S' && buf.buf[8] == 'U')
1338 /* nested untracked file */
1339 dirty_submodule |= DIRTY_SUBMODULE_UNTRACKED;
1341 if (buf.buf[0] == 'u' ||
1342 buf.buf[0] == '2' ||
1343 memcmp(buf.buf + 5, "S..U", 4))
1344 /* other change */
1345 dirty_submodule |= DIRTY_SUBMODULE_MODIFIED;
1348 if ((dirty_submodule & DIRTY_SUBMODULE_MODIFIED) &&
1349 ((dirty_submodule & DIRTY_SUBMODULE_UNTRACKED) ||
1350 ignore_untracked)) {
1352 * We're not interested in any further information from
1353 * the child any more, neither output nor its exit code.
1355 ignore_cp_exit_code = 1;
1356 break;
1359 fclose(fp);
1361 if (finish_command(&cp) && !ignore_cp_exit_code)
1362 die("'git status --porcelain=2' failed in submodule %s", path);
1364 strbuf_release(&buf);
1365 return dirty_submodule;
1368 int submodule_uses_gitfile(const char *path)
1370 struct child_process cp = CHILD_PROCESS_INIT;
1371 const char *argv[] = {
1372 "submodule",
1373 "foreach",
1374 "--quiet",
1375 "--recursive",
1376 "test -f .git",
1377 NULL,
1379 struct strbuf buf = STRBUF_INIT;
1380 const char *git_dir;
1382 strbuf_addf(&buf, "%s/.git", path);
1383 git_dir = read_gitfile(buf.buf);
1384 if (!git_dir) {
1385 strbuf_release(&buf);
1386 return 0;
1388 strbuf_release(&buf);
1390 /* Now test that all nested submodules use a gitfile too */
1391 cp.argv = argv;
1392 prepare_submodule_repo_env(&cp.env_array);
1393 cp.git_cmd = 1;
1394 cp.no_stdin = 1;
1395 cp.no_stderr = 1;
1396 cp.no_stdout = 1;
1397 cp.dir = path;
1398 if (run_command(&cp))
1399 return 0;
1401 return 1;
1405 * Check if it is a bad idea to remove a submodule, i.e. if we'd lose data
1406 * when doing so.
1408 * Return 1 if we'd lose data, return 0 if the removal is fine,
1409 * and negative values for errors.
1411 int bad_to_remove_submodule(const char *path, unsigned flags)
1413 ssize_t len;
1414 struct child_process cp = CHILD_PROCESS_INIT;
1415 struct strbuf buf = STRBUF_INIT;
1416 int ret = 0;
1418 if (!file_exists(path) || is_empty_dir(path))
1419 return 0;
1421 if (!submodule_uses_gitfile(path))
1422 return 1;
1424 argv_array_pushl(&cp.args, "status", "--porcelain",
1425 "--ignore-submodules=none", NULL);
1427 if (flags & SUBMODULE_REMOVAL_IGNORE_UNTRACKED)
1428 argv_array_push(&cp.args, "-uno");
1429 else
1430 argv_array_push(&cp.args, "-uall");
1432 if (!(flags & SUBMODULE_REMOVAL_IGNORE_IGNORED_UNTRACKED))
1433 argv_array_push(&cp.args, "--ignored");
1435 prepare_submodule_repo_env(&cp.env_array);
1436 cp.git_cmd = 1;
1437 cp.no_stdin = 1;
1438 cp.out = -1;
1439 cp.dir = path;
1440 if (start_command(&cp)) {
1441 if (flags & SUBMODULE_REMOVAL_DIE_ON_ERROR)
1442 die(_("could not start 'git status' in submodule '%s'"),
1443 path);
1444 ret = -1;
1445 goto out;
1448 len = strbuf_read(&buf, cp.out, 1024);
1449 if (len > 2)
1450 ret = 1;
1451 close(cp.out);
1453 if (finish_command(&cp)) {
1454 if (flags & SUBMODULE_REMOVAL_DIE_ON_ERROR)
1455 die(_("could not run 'git status' in submodule '%s'"),
1456 path);
1457 ret = -1;
1459 out:
1460 strbuf_release(&buf);
1461 return ret;
1464 static const char *get_super_prefix_or_empty(void)
1466 const char *s = get_super_prefix();
1467 if (!s)
1468 s = "";
1469 return s;
1472 static int submodule_has_dirty_index(const struct submodule *sub)
1474 struct child_process cp = CHILD_PROCESS_INIT;
1476 prepare_submodule_repo_env(&cp.env_array);
1478 cp.git_cmd = 1;
1479 argv_array_pushl(&cp.args, "diff-index", "--quiet",
1480 "--cached", "HEAD", NULL);
1481 cp.no_stdin = 1;
1482 cp.no_stdout = 1;
1483 cp.dir = sub->path;
1484 if (start_command(&cp))
1485 die("could not recurse into submodule '%s'", sub->path);
1487 return finish_command(&cp);
1490 static void submodule_reset_index(const char *path)
1492 struct child_process cp = CHILD_PROCESS_INIT;
1493 prepare_submodule_repo_env(&cp.env_array);
1495 cp.git_cmd = 1;
1496 cp.no_stdin = 1;
1497 cp.dir = path;
1499 argv_array_pushf(&cp.args, "--super-prefix=%s%s/",
1500 get_super_prefix_or_empty(), path);
1501 argv_array_pushl(&cp.args, "read-tree", "-u", "--reset", NULL);
1503 argv_array_push(&cp.args, EMPTY_TREE_SHA1_HEX);
1505 if (run_command(&cp))
1506 die("could not reset submodule index");
1510 * Moves a submodule at a given path from a given head to another new head.
1511 * For edge cases (a submodule coming into existence or removing a submodule)
1512 * pass NULL for old or new respectively.
1514 int submodule_move_head(const char *path,
1515 const char *old,
1516 const char *new,
1517 unsigned flags)
1519 int ret = 0;
1520 struct child_process cp = CHILD_PROCESS_INIT;
1521 const struct submodule *sub;
1522 int *error_code_ptr, error_code;
1524 if (!is_submodule_active(the_repository, path))
1525 return 0;
1527 if (flags & SUBMODULE_MOVE_HEAD_FORCE)
1529 * Pass non NULL pointer to is_submodule_populated_gently
1530 * to prevent die()-ing. We'll use connect_work_tree_and_git_dir
1531 * to fixup the submodule in the force case later.
1533 error_code_ptr = &error_code;
1534 else
1535 error_code_ptr = NULL;
1537 if (old && !is_submodule_populated_gently(path, error_code_ptr))
1538 return 0;
1540 sub = submodule_from_path(&null_oid, path);
1542 if (!sub)
1543 die("BUG: could not get submodule information for '%s'", path);
1545 if (old && !(flags & SUBMODULE_MOVE_HEAD_FORCE)) {
1546 /* Check if the submodule has a dirty index. */
1547 if (submodule_has_dirty_index(sub))
1548 return error(_("submodule '%s' has dirty index"), path);
1551 if (!(flags & SUBMODULE_MOVE_HEAD_DRY_RUN)) {
1552 if (old) {
1553 if (!submodule_uses_gitfile(path))
1554 absorb_git_dir_into_superproject("", path,
1555 ABSORB_GITDIR_RECURSE_SUBMODULES);
1556 } else {
1557 char *gitdir = xstrfmt("%s/modules/%s",
1558 get_git_common_dir(), sub->name);
1559 connect_work_tree_and_git_dir(path, gitdir);
1560 free(gitdir);
1562 /* make sure the index is clean as well */
1563 submodule_reset_index(path);
1566 if (old && (flags & SUBMODULE_MOVE_HEAD_FORCE)) {
1567 char *gitdir = xstrfmt("%s/modules/%s",
1568 get_git_common_dir(), sub->name);
1569 connect_work_tree_and_git_dir(path, gitdir);
1570 free(gitdir);
1574 prepare_submodule_repo_env(&cp.env_array);
1576 cp.git_cmd = 1;
1577 cp.no_stdin = 1;
1578 cp.dir = path;
1580 argv_array_pushf(&cp.args, "--super-prefix=%s%s/",
1581 get_super_prefix_or_empty(), path);
1582 argv_array_pushl(&cp.args, "read-tree", "--recurse-submodules", NULL);
1584 if (flags & SUBMODULE_MOVE_HEAD_DRY_RUN)
1585 argv_array_push(&cp.args, "-n");
1586 else
1587 argv_array_push(&cp.args, "-u");
1589 if (flags & SUBMODULE_MOVE_HEAD_FORCE)
1590 argv_array_push(&cp.args, "--reset");
1591 else
1592 argv_array_push(&cp.args, "-m");
1594 argv_array_push(&cp.args, old ? old : EMPTY_TREE_SHA1_HEX);
1595 argv_array_push(&cp.args, new ? new : EMPTY_TREE_SHA1_HEX);
1597 if (run_command(&cp)) {
1598 ret = -1;
1599 goto out;
1602 if (!(flags & SUBMODULE_MOVE_HEAD_DRY_RUN)) {
1603 if (new) {
1604 child_process_init(&cp);
1605 /* also set the HEAD accordingly */
1606 cp.git_cmd = 1;
1607 cp.no_stdin = 1;
1608 cp.dir = path;
1610 prepare_submodule_repo_env(&cp.env_array);
1611 argv_array_pushl(&cp.args, "update-ref", "HEAD", new, NULL);
1613 if (run_command(&cp)) {
1614 ret = -1;
1615 goto out;
1617 } else {
1618 struct strbuf sb = STRBUF_INIT;
1620 strbuf_addf(&sb, "%s/.git", path);
1621 unlink_or_warn(sb.buf);
1622 strbuf_release(&sb);
1624 if (is_empty_dir(path))
1625 rmdir_or_warn(path);
1628 out:
1629 return ret;
1632 static int find_first_merges(struct object_array *result, const char *path,
1633 struct commit *a, struct commit *b)
1635 int i, j;
1636 struct object_array merges = OBJECT_ARRAY_INIT;
1637 struct commit *commit;
1638 int contains_another;
1640 char merged_revision[42];
1641 const char *rev_args[] = { "rev-list", "--merges", "--ancestry-path",
1642 "--all", merged_revision, NULL };
1643 struct rev_info revs;
1644 struct setup_revision_opt rev_opts;
1646 memset(result, 0, sizeof(struct object_array));
1647 memset(&rev_opts, 0, sizeof(rev_opts));
1649 /* get all revisions that merge commit a */
1650 xsnprintf(merged_revision, sizeof(merged_revision), "^%s",
1651 oid_to_hex(&a->object.oid));
1652 init_revisions(&revs, NULL);
1653 rev_opts.submodule = path;
1654 /* FIXME: can't handle linked worktrees in submodules yet */
1655 revs.single_worktree = path != NULL;
1656 setup_revisions(ARRAY_SIZE(rev_args)-1, rev_args, &revs, &rev_opts);
1658 /* save all revisions from the above list that contain b */
1659 if (prepare_revision_walk(&revs))
1660 die("revision walk setup failed");
1661 while ((commit = get_revision(&revs)) != NULL) {
1662 struct object *o = &(commit->object);
1663 if (in_merge_bases(b, commit))
1664 add_object_array(o, NULL, &merges);
1666 reset_revision_walk();
1668 /* Now we've got all merges that contain a and b. Prune all
1669 * merges that contain another found merge and save them in
1670 * result.
1672 for (i = 0; i < merges.nr; i++) {
1673 struct commit *m1 = (struct commit *) merges.objects[i].item;
1675 contains_another = 0;
1676 for (j = 0; j < merges.nr; j++) {
1677 struct commit *m2 = (struct commit *) merges.objects[j].item;
1678 if (i != j && in_merge_bases(m2, m1)) {
1679 contains_another = 1;
1680 break;
1684 if (!contains_another)
1685 add_object_array(merges.objects[i].item, NULL, result);
1688 object_array_clear(&merges);
1689 return result->nr;
1692 static void print_commit(struct commit *commit)
1694 struct strbuf sb = STRBUF_INIT;
1695 struct pretty_print_context ctx = {0};
1696 ctx.date_mode.type = DATE_NORMAL;
1697 format_commit_message(commit, " %h: %m %s", &sb, &ctx);
1698 fprintf(stderr, "%s\n", sb.buf);
1699 strbuf_release(&sb);
1702 #define MERGE_WARNING(path, msg) \
1703 warning("Failed to merge submodule %s (%s)", path, msg);
1705 int merge_submodule(struct object_id *result, const char *path,
1706 const struct object_id *base, const struct object_id *a,
1707 const struct object_id *b, int search)
1709 struct commit *commit_base, *commit_a, *commit_b;
1710 int parent_count;
1711 struct object_array merges;
1713 int i;
1715 /* store a in result in case we fail */
1716 oidcpy(result, a);
1718 /* we can not handle deletion conflicts */
1719 if (is_null_oid(base))
1720 return 0;
1721 if (is_null_oid(a))
1722 return 0;
1723 if (is_null_oid(b))
1724 return 0;
1726 if (add_submodule_odb(path)) {
1727 MERGE_WARNING(path, "not checked out");
1728 return 0;
1731 if (!(commit_base = lookup_commit_reference(base)) ||
1732 !(commit_a = lookup_commit_reference(a)) ||
1733 !(commit_b = lookup_commit_reference(b))) {
1734 MERGE_WARNING(path, "commits not present");
1735 return 0;
1738 /* check whether both changes are forward */
1739 if (!in_merge_bases(commit_base, commit_a) ||
1740 !in_merge_bases(commit_base, commit_b)) {
1741 MERGE_WARNING(path, "commits don't follow merge-base");
1742 return 0;
1745 /* Case #1: a is contained in b or vice versa */
1746 if (in_merge_bases(commit_a, commit_b)) {
1747 oidcpy(result, b);
1748 return 1;
1750 if (in_merge_bases(commit_b, commit_a)) {
1751 oidcpy(result, a);
1752 return 1;
1756 * Case #2: There are one or more merges that contain a and b in
1757 * the submodule. If there is only one, then present it as a
1758 * suggestion to the user, but leave it marked unmerged so the
1759 * user needs to confirm the resolution.
1762 /* Skip the search if makes no sense to the calling context. */
1763 if (!search)
1764 return 0;
1766 /* find commit which merges them */
1767 parent_count = find_first_merges(&merges, path, commit_a, commit_b);
1768 switch (parent_count) {
1769 case 0:
1770 MERGE_WARNING(path, "merge following commits not found");
1771 break;
1773 case 1:
1774 MERGE_WARNING(path, "not fast-forward");
1775 fprintf(stderr, "Found a possible merge resolution "
1776 "for the submodule:\n");
1777 print_commit((struct commit *) merges.objects[0].item);
1778 fprintf(stderr,
1779 "If this is correct simply add it to the index "
1780 "for example\n"
1781 "by using:\n\n"
1782 " git update-index --cacheinfo 160000 %s \"%s\"\n\n"
1783 "which will accept this suggestion.\n",
1784 oid_to_hex(&merges.objects[0].item->oid), path);
1785 break;
1787 default:
1788 MERGE_WARNING(path, "multiple merges found");
1789 for (i = 0; i < merges.nr; i++)
1790 print_commit((struct commit *) merges.objects[i].item);
1793 object_array_clear(&merges);
1794 return 0;
1798 * Embeds a single submodules git directory into the superprojects git dir,
1799 * non recursively.
1801 static void relocate_single_git_dir_into_superproject(const char *prefix,
1802 const char *path)
1804 char *old_git_dir = NULL, *real_old_git_dir = NULL, *real_new_git_dir = NULL;
1805 const char *new_git_dir;
1806 const struct submodule *sub;
1808 if (submodule_uses_worktrees(path))
1809 die(_("relocate_gitdir for submodule '%s' with "
1810 "more than one worktree not supported"), path);
1812 old_git_dir = xstrfmt("%s/.git", path);
1813 if (read_gitfile(old_git_dir))
1814 /* If it is an actual gitfile, it doesn't need migration. */
1815 return;
1817 real_old_git_dir = real_pathdup(old_git_dir, 1);
1819 sub = submodule_from_path(&null_oid, path);
1820 if (!sub)
1821 die(_("could not lookup name for submodule '%s'"), path);
1823 new_git_dir = git_path("modules/%s", sub->name);
1824 if (safe_create_leading_directories_const(new_git_dir) < 0)
1825 die(_("could not create directory '%s'"), new_git_dir);
1826 real_new_git_dir = real_pathdup(new_git_dir, 1);
1828 fprintf(stderr, _("Migrating git directory of '%s%s' from\n'%s' to\n'%s'\n"),
1829 get_super_prefix_or_empty(), path,
1830 real_old_git_dir, real_new_git_dir);
1832 relocate_gitdir(path, real_old_git_dir, real_new_git_dir);
1834 free(old_git_dir);
1835 free(real_old_git_dir);
1836 free(real_new_git_dir);
1840 * Migrate the git directory of the submodule given by path from
1841 * having its git directory within the working tree to the git dir nested
1842 * in its superprojects git dir under modules/.
1844 void absorb_git_dir_into_superproject(const char *prefix,
1845 const char *path,
1846 unsigned flags)
1848 int err_code;
1849 const char *sub_git_dir;
1850 struct strbuf gitdir = STRBUF_INIT;
1851 strbuf_addf(&gitdir, "%s/.git", path);
1852 sub_git_dir = resolve_gitdir_gently(gitdir.buf, &err_code);
1854 /* Not populated? */
1855 if (!sub_git_dir) {
1856 const struct submodule *sub;
1858 if (err_code == READ_GITFILE_ERR_STAT_FAILED) {
1859 /* unpopulated as expected */
1860 strbuf_release(&gitdir);
1861 return;
1864 if (err_code != READ_GITFILE_ERR_NOT_A_REPO)
1865 /* We don't know what broke here. */
1866 read_gitfile_error_die(err_code, path, NULL);
1869 * Maybe populated, but no git directory was found?
1870 * This can happen if the superproject is a submodule
1871 * itself and was just absorbed. The absorption of the
1872 * superproject did not rewrite the git file links yet,
1873 * fix it now.
1875 sub = submodule_from_path(&null_oid, path);
1876 if (!sub)
1877 die(_("could not lookup name for submodule '%s'"), path);
1878 connect_work_tree_and_git_dir(path,
1879 git_path("modules/%s", sub->name));
1880 } else {
1881 /* Is it already absorbed into the superprojects git dir? */
1882 char *real_sub_git_dir = real_pathdup(sub_git_dir, 1);
1883 char *real_common_git_dir = real_pathdup(get_git_common_dir(), 1);
1885 if (!starts_with(real_sub_git_dir, real_common_git_dir))
1886 relocate_single_git_dir_into_superproject(prefix, path);
1888 free(real_sub_git_dir);
1889 free(real_common_git_dir);
1891 strbuf_release(&gitdir);
1893 if (flags & ABSORB_GITDIR_RECURSE_SUBMODULES) {
1894 struct child_process cp = CHILD_PROCESS_INIT;
1895 struct strbuf sb = STRBUF_INIT;
1897 if (flags & ~ABSORB_GITDIR_RECURSE_SUBMODULES)
1898 die("BUG: we don't know how to pass the flags down?");
1900 strbuf_addstr(&sb, get_super_prefix_or_empty());
1901 strbuf_addstr(&sb, path);
1902 strbuf_addch(&sb, '/');
1904 cp.dir = path;
1905 cp.git_cmd = 1;
1906 cp.no_stdin = 1;
1907 argv_array_pushl(&cp.args, "--super-prefix", sb.buf,
1908 "submodule--helper",
1909 "absorb-git-dirs", NULL);
1910 prepare_submodule_repo_env(&cp.env_array);
1911 if (run_command(&cp))
1912 die(_("could not recurse into submodule '%s'"), path);
1914 strbuf_release(&sb);
1918 const char *get_superproject_working_tree(void)
1920 struct child_process cp = CHILD_PROCESS_INIT;
1921 struct strbuf sb = STRBUF_INIT;
1922 const char *one_up = real_path_if_valid("../");
1923 const char *cwd = xgetcwd();
1924 const char *ret = NULL;
1925 const char *subpath;
1926 int code;
1927 ssize_t len;
1929 if (!is_inside_work_tree())
1931 * FIXME:
1932 * We might have a superproject, but it is harder
1933 * to determine.
1935 return NULL;
1937 if (!one_up)
1938 return NULL;
1940 subpath = relative_path(cwd, one_up, &sb);
1942 prepare_submodule_repo_env(&cp.env_array);
1943 argv_array_pop(&cp.env_array);
1945 argv_array_pushl(&cp.args, "--literal-pathspecs", "-C", "..",
1946 "ls-files", "-z", "--stage", "--full-name", "--",
1947 subpath, NULL);
1948 strbuf_reset(&sb);
1950 cp.no_stdin = 1;
1951 cp.no_stderr = 1;
1952 cp.out = -1;
1953 cp.git_cmd = 1;
1955 if (start_command(&cp))
1956 die(_("could not start ls-files in .."));
1958 len = strbuf_read(&sb, cp.out, PATH_MAX);
1959 close(cp.out);
1961 if (starts_with(sb.buf, "160000")) {
1962 int super_sub_len;
1963 int cwd_len = strlen(cwd);
1964 char *super_sub, *super_wt;
1967 * There is a superproject having this repo as a submodule.
1968 * The format is <mode> SP <hash> SP <stage> TAB <full name> \0,
1969 * We're only interested in the name after the tab.
1971 super_sub = strchr(sb.buf, '\t') + 1;
1972 super_sub_len = sb.buf + sb.len - super_sub - 1;
1974 if (super_sub_len > cwd_len ||
1975 strcmp(&cwd[cwd_len - super_sub_len], super_sub))
1976 die (_("BUG: returned path string doesn't match cwd?"));
1978 super_wt = xstrdup(cwd);
1979 super_wt[cwd_len - super_sub_len] = '\0';
1981 ret = real_path(super_wt);
1982 free(super_wt);
1984 strbuf_release(&sb);
1986 code = finish_command(&cp);
1988 if (code == 128)
1989 /* '../' is not a git repository */
1990 return NULL;
1991 if (code == 0 && len == 0)
1992 /* There is an unrelated git repository at '../' */
1993 return NULL;
1994 if (code)
1995 die(_("ls-tree returned unexpected return code %d"), code);
1997 return ret;
2001 * Put the gitdir for a submodule (given relative to the main
2002 * repository worktree) into `buf`, or return -1 on error.
2004 int submodule_to_gitdir(struct strbuf *buf, const char *submodule)
2006 const struct submodule *sub;
2007 const char *git_dir;
2008 int ret = 0;
2010 strbuf_reset(buf);
2011 strbuf_addstr(buf, submodule);
2012 strbuf_complete(buf, '/');
2013 strbuf_addstr(buf, ".git");
2015 git_dir = read_gitfile(buf->buf);
2016 if (git_dir) {
2017 strbuf_reset(buf);
2018 strbuf_addstr(buf, git_dir);
2020 if (!is_git_directory(buf->buf)) {
2021 sub = submodule_from_path(&null_oid, submodule);
2022 if (!sub) {
2023 ret = -1;
2024 goto cleanup;
2026 strbuf_reset(buf);
2027 strbuf_git_path(buf, "%s/%s", "modules", sub->name);
2030 cleanup:
2031 return ret;