Merge branch 'mm/merge-in-dirty-worktree-doc' into maint
[git/mjg.git] / submodule.c
blob1821a5b3160bd3a3e60f328b50b56a0208b2df9c
1 #include "cache.h"
2 #include "submodule.h"
3 #include "dir.h"
4 #include "diff.h"
5 #include "commit.h"
6 #include "revision.h"
7 #include "run-command.h"
8 #include "diffcore.h"
9 #include "refs.h"
10 #include "string-list.h"
11 #include "sha1-array.h"
12 #include "argv-array.h"
14 static struct string_list config_name_for_path;
15 static struct string_list config_fetch_recurse_submodules_for_name;
16 static struct string_list config_ignore_for_name;
17 static int config_fetch_recurse_submodules = RECURSE_SUBMODULES_ON_DEMAND;
18 static struct string_list changed_submodule_paths;
19 static int initialized_fetch_ref_tips;
20 static struct sha1_array ref_tips_before_fetch;
21 static struct sha1_array ref_tips_after_fetch;
24 * The following flag is set if the .gitmodules file is unmerged. We then
25 * disable recursion for all submodules where .git/config doesn't have a
26 * matching config entry because we can't guess what might be configured in
27 * .gitmodules unless the user resolves the conflict. When a command line
28 * option is given (which always overrides configuration) this flag will be
29 * ignored.
31 static int gitmodules_is_unmerged;
33 static int add_submodule_odb(const char *path)
35 struct strbuf objects_directory = STRBUF_INIT;
36 struct alternate_object_database *alt_odb;
37 int ret = 0;
38 const char *git_dir;
40 strbuf_addf(&objects_directory, "%s/.git", path);
41 git_dir = read_gitfile(objects_directory.buf);
42 if (git_dir) {
43 strbuf_reset(&objects_directory);
44 strbuf_addstr(&objects_directory, git_dir);
46 strbuf_addstr(&objects_directory, "/objects/");
47 if (!is_directory(objects_directory.buf)) {
48 ret = -1;
49 goto done;
51 /* avoid adding it twice */
52 for (alt_odb = alt_odb_list; alt_odb; alt_odb = alt_odb->next)
53 if (alt_odb->name - alt_odb->base == objects_directory.len &&
54 !strncmp(alt_odb->base, objects_directory.buf,
55 objects_directory.len))
56 goto done;
58 alt_odb = xmalloc(objects_directory.len + 42 + sizeof(*alt_odb));
59 alt_odb->next = alt_odb_list;
60 strcpy(alt_odb->base, objects_directory.buf);
61 alt_odb->name = alt_odb->base + objects_directory.len;
62 alt_odb->name[2] = '/';
63 alt_odb->name[40] = '\0';
64 alt_odb->name[41] = '\0';
65 alt_odb_list = alt_odb;
67 /* add possible alternates from the submodule */
68 read_info_alternates(objects_directory.buf, 0);
69 prepare_alt_odb();
70 done:
71 strbuf_release(&objects_directory);
72 return ret;
75 void set_diffopt_flags_from_submodule_config(struct diff_options *diffopt,
76 const char *path)
78 struct string_list_item *path_option, *ignore_option;
79 path_option = unsorted_string_list_lookup(&config_name_for_path, path);
80 if (path_option) {
81 ignore_option = unsorted_string_list_lookup(&config_ignore_for_name, path_option->util);
82 if (ignore_option)
83 handle_ignore_submodules_arg(diffopt, ignore_option->util);
84 else if (gitmodules_is_unmerged)
85 DIFF_OPT_SET(diffopt, IGNORE_SUBMODULES);
89 int submodule_config(const char *var, const char *value, void *cb)
91 if (!prefixcmp(var, "submodule."))
92 return parse_submodule_config_option(var, value);
93 else if (!strcmp(var, "fetch.recursesubmodules")) {
94 config_fetch_recurse_submodules = parse_fetch_recurse_submodules_arg(var, value);
95 return 0;
97 return 0;
100 void gitmodules_config(void)
102 const char *work_tree = get_git_work_tree();
103 if (work_tree) {
104 struct strbuf gitmodules_path = STRBUF_INIT;
105 int pos;
106 strbuf_addstr(&gitmodules_path, work_tree);
107 strbuf_addstr(&gitmodules_path, "/.gitmodules");
108 if (read_cache() < 0)
109 die("index file corrupt");
110 pos = cache_name_pos(".gitmodules", 11);
111 if (pos < 0) { /* .gitmodules not found or isn't merged */
112 pos = -1 - pos;
113 if (active_nr > pos) { /* there is a .gitmodules */
114 const struct cache_entry *ce = active_cache[pos];
115 if (ce_namelen(ce) == 11 &&
116 !memcmp(ce->name, ".gitmodules", 11))
117 gitmodules_is_unmerged = 1;
121 if (!gitmodules_is_unmerged)
122 git_config_from_file(submodule_config, gitmodules_path.buf, NULL);
123 strbuf_release(&gitmodules_path);
127 int parse_submodule_config_option(const char *var, const char *value)
129 struct string_list_item *config;
130 const char *name, *key;
131 int namelen;
133 if (parse_config_key(var, "submodule", &name, &namelen, &key) < 0 || !name)
134 return 0;
136 if (!strcmp(key, "path")) {
137 config = unsorted_string_list_lookup(&config_name_for_path, value);
138 if (config)
139 free(config->util);
140 else
141 config = string_list_append(&config_name_for_path, xstrdup(value));
142 config->util = xmemdupz(name, namelen);
143 } else if (!strcmp(key, "fetchrecursesubmodules")) {
144 char *name_cstr = xmemdupz(name, namelen);
145 config = unsorted_string_list_lookup(&config_fetch_recurse_submodules_for_name, name_cstr);
146 if (!config)
147 config = string_list_append(&config_fetch_recurse_submodules_for_name, name_cstr);
148 else
149 free(name_cstr);
150 config->util = (void *)(intptr_t)parse_fetch_recurse_submodules_arg(var, value);
151 } else if (!strcmp(key, "ignore")) {
152 char *name_cstr;
154 if (strcmp(value, "untracked") && strcmp(value, "dirty") &&
155 strcmp(value, "all") && strcmp(value, "none")) {
156 warning("Invalid parameter \"%s\" for config option \"submodule.%s.ignore\"", value, var);
157 return 0;
160 name_cstr = xmemdupz(name, namelen);
161 config = unsorted_string_list_lookup(&config_ignore_for_name, name_cstr);
162 if (config) {
163 free(config->util);
164 free(name_cstr);
165 } else
166 config = string_list_append(&config_ignore_for_name, name_cstr);
167 config->util = xstrdup(value);
168 return 0;
170 return 0;
173 void handle_ignore_submodules_arg(struct diff_options *diffopt,
174 const char *arg)
176 DIFF_OPT_CLR(diffopt, IGNORE_SUBMODULES);
177 DIFF_OPT_CLR(diffopt, IGNORE_UNTRACKED_IN_SUBMODULES);
178 DIFF_OPT_CLR(diffopt, IGNORE_DIRTY_SUBMODULES);
180 if (!strcmp(arg, "all"))
181 DIFF_OPT_SET(diffopt, IGNORE_SUBMODULES);
182 else if (!strcmp(arg, "untracked"))
183 DIFF_OPT_SET(diffopt, IGNORE_UNTRACKED_IN_SUBMODULES);
184 else if (!strcmp(arg, "dirty"))
185 DIFF_OPT_SET(diffopt, IGNORE_DIRTY_SUBMODULES);
186 else if (strcmp(arg, "none"))
187 die("bad --ignore-submodules argument: %s", arg);
190 static int prepare_submodule_summary(struct rev_info *rev, const char *path,
191 struct commit *left, struct commit *right,
192 int *fast_forward, int *fast_backward)
194 struct commit_list *merge_bases, *list;
196 init_revisions(rev, NULL);
197 setup_revisions(0, NULL, rev, NULL);
198 rev->left_right = 1;
199 rev->first_parent_only = 1;
200 left->object.flags |= SYMMETRIC_LEFT;
201 add_pending_object(rev, &left->object, path);
202 add_pending_object(rev, &right->object, path);
203 merge_bases = get_merge_bases(left, right, 1);
204 if (merge_bases) {
205 if (merge_bases->item == left)
206 *fast_forward = 1;
207 else if (merge_bases->item == right)
208 *fast_backward = 1;
210 for (list = merge_bases; list; list = list->next) {
211 list->item->object.flags |= UNINTERESTING;
212 add_pending_object(rev, &list->item->object,
213 sha1_to_hex(list->item->object.sha1));
215 return prepare_revision_walk(rev);
218 static void print_submodule_summary(struct rev_info *rev, FILE *f,
219 const char *line_prefix,
220 const char *del, const char *add, const char *reset)
222 static const char format[] = " %m %s";
223 struct strbuf sb = STRBUF_INIT;
224 struct commit *commit;
226 while ((commit = get_revision(rev))) {
227 struct pretty_print_context ctx = {0};
228 ctx.date_mode = rev->date_mode;
229 strbuf_setlen(&sb, 0);
230 strbuf_addstr(&sb, line_prefix);
231 if (commit->object.flags & SYMMETRIC_LEFT) {
232 if (del)
233 strbuf_addstr(&sb, del);
235 else if (add)
236 strbuf_addstr(&sb, add);
237 format_commit_message(commit, format, &sb, &ctx);
238 if (reset)
239 strbuf_addstr(&sb, reset);
240 strbuf_addch(&sb, '\n');
241 fprintf(f, "%s", sb.buf);
243 strbuf_release(&sb);
246 int parse_fetch_recurse_submodules_arg(const char *opt, const char *arg)
248 switch (git_config_maybe_bool(opt, arg)) {
249 case 1:
250 return RECURSE_SUBMODULES_ON;
251 case 0:
252 return RECURSE_SUBMODULES_OFF;
253 default:
254 if (!strcmp(arg, "on-demand"))
255 return RECURSE_SUBMODULES_ON_DEMAND;
256 die("bad %s argument: %s", opt, arg);
260 void show_submodule_summary(FILE *f, const char *path,
261 const char *line_prefix,
262 unsigned char one[20], unsigned char two[20],
263 unsigned dirty_submodule, const char *meta,
264 const char *del, const char *add, const char *reset)
266 struct rev_info rev;
267 struct commit *left = NULL, *right = NULL;
268 const char *message = NULL;
269 struct strbuf sb = STRBUF_INIT;
270 int fast_forward = 0, fast_backward = 0;
272 if (is_null_sha1(two))
273 message = "(submodule deleted)";
274 else if (add_submodule_odb(path))
275 message = "(not checked out)";
276 else if (is_null_sha1(one))
277 message = "(new submodule)";
278 else if (!(left = lookup_commit_reference(one)) ||
279 !(right = lookup_commit_reference(two)))
280 message = "(commits not present)";
281 else if (prepare_submodule_summary(&rev, path, left, right,
282 &fast_forward, &fast_backward))
283 message = "(revision walker failed)";
285 if (dirty_submodule & DIRTY_SUBMODULE_UNTRACKED)
286 fprintf(f, "%sSubmodule %s contains untracked content\n",
287 line_prefix, path);
288 if (dirty_submodule & DIRTY_SUBMODULE_MODIFIED)
289 fprintf(f, "%sSubmodule %s contains modified content\n",
290 line_prefix, path);
292 if (!hashcmp(one, two)) {
293 strbuf_release(&sb);
294 return;
297 strbuf_addf(&sb, "%s%sSubmodule %s %s..", line_prefix, meta, path,
298 find_unique_abbrev(one, DEFAULT_ABBREV));
299 if (!fast_backward && !fast_forward)
300 strbuf_addch(&sb, '.');
301 strbuf_addf(&sb, "%s", find_unique_abbrev(two, DEFAULT_ABBREV));
302 if (message)
303 strbuf_addf(&sb, " %s%s\n", message, reset);
304 else
305 strbuf_addf(&sb, "%s:%s\n", fast_backward ? " (rewind)" : "", reset);
306 fwrite(sb.buf, sb.len, 1, f);
308 if (!message) /* only NULL if we succeeded in setting up the walk */
309 print_submodule_summary(&rev, f, line_prefix, del, add, reset);
310 if (left)
311 clear_commit_marks(left, ~0);
312 if (right)
313 clear_commit_marks(right, ~0);
315 strbuf_release(&sb);
318 void set_config_fetch_recurse_submodules(int value)
320 config_fetch_recurse_submodules = value;
323 static int has_remote(const char *refname, const unsigned char *sha1, int flags, void *cb_data)
325 return 1;
328 static int submodule_needs_pushing(const char *path, const unsigned char sha1[20])
330 if (add_submodule_odb(path) || !lookup_commit_reference(sha1))
331 return 0;
333 if (for_each_remote_ref_submodule(path, has_remote, NULL) > 0) {
334 struct child_process cp;
335 const char *argv[] = {"rev-list", NULL, "--not", "--remotes", "-n", "1" , NULL};
336 struct strbuf buf = STRBUF_INIT;
337 int needs_pushing = 0;
339 argv[1] = sha1_to_hex(sha1);
340 memset(&cp, 0, sizeof(cp));
341 cp.argv = argv;
342 cp.env = local_repo_env;
343 cp.git_cmd = 1;
344 cp.no_stdin = 1;
345 cp.out = -1;
346 cp.dir = path;
347 if (start_command(&cp))
348 die("Could not run 'git rev-list %s --not --remotes -n 1' command in submodule %s",
349 sha1_to_hex(sha1), path);
350 if (strbuf_read(&buf, cp.out, 41))
351 needs_pushing = 1;
352 finish_command(&cp);
353 close(cp.out);
354 strbuf_release(&buf);
355 return needs_pushing;
358 return 0;
361 static void collect_submodules_from_diff(struct diff_queue_struct *q,
362 struct diff_options *options,
363 void *data)
365 int i;
366 struct string_list *needs_pushing = data;
368 for (i = 0; i < q->nr; i++) {
369 struct diff_filepair *p = q->queue[i];
370 if (!S_ISGITLINK(p->two->mode))
371 continue;
372 if (submodule_needs_pushing(p->two->path, p->two->sha1))
373 string_list_insert(needs_pushing, p->two->path);
377 static void find_unpushed_submodule_commits(struct commit *commit,
378 struct string_list *needs_pushing)
380 struct rev_info rev;
382 init_revisions(&rev, NULL);
383 rev.diffopt.output_format |= DIFF_FORMAT_CALLBACK;
384 rev.diffopt.format_callback = collect_submodules_from_diff;
385 rev.diffopt.format_callback_data = needs_pushing;
386 diff_tree_combined_merge(commit, 1, &rev);
389 int find_unpushed_submodules(unsigned char new_sha1[20],
390 const char *remotes_name, struct string_list *needs_pushing)
392 struct rev_info rev;
393 struct commit *commit;
394 const char *argv[] = {NULL, NULL, "--not", "NULL", NULL};
395 int argc = ARRAY_SIZE(argv) - 1;
396 char *sha1_copy;
398 struct strbuf remotes_arg = STRBUF_INIT;
400 strbuf_addf(&remotes_arg, "--remotes=%s", remotes_name);
401 init_revisions(&rev, NULL);
402 sha1_copy = xstrdup(sha1_to_hex(new_sha1));
403 argv[1] = sha1_copy;
404 argv[3] = remotes_arg.buf;
405 setup_revisions(argc, argv, &rev, NULL);
406 if (prepare_revision_walk(&rev))
407 die("revision walk setup failed");
409 while ((commit = get_revision(&rev)) != NULL)
410 find_unpushed_submodule_commits(commit, needs_pushing);
412 reset_revision_walk();
413 free(sha1_copy);
414 strbuf_release(&remotes_arg);
416 return needs_pushing->nr;
419 static int push_submodule(const char *path)
421 if (add_submodule_odb(path))
422 return 1;
424 if (for_each_remote_ref_submodule(path, has_remote, NULL) > 0) {
425 struct child_process cp;
426 const char *argv[] = {"push", NULL};
428 memset(&cp, 0, sizeof(cp));
429 cp.argv = argv;
430 cp.env = local_repo_env;
431 cp.git_cmd = 1;
432 cp.no_stdin = 1;
433 cp.dir = path;
434 if (run_command(&cp))
435 return 0;
436 close(cp.out);
439 return 1;
442 int push_unpushed_submodules(unsigned char new_sha1[20], const char *remotes_name)
444 int i, ret = 1;
445 struct string_list needs_pushing;
447 memset(&needs_pushing, 0, sizeof(struct string_list));
448 needs_pushing.strdup_strings = 1;
450 if (!find_unpushed_submodules(new_sha1, remotes_name, &needs_pushing))
451 return 1;
453 for (i = 0; i < needs_pushing.nr; i++) {
454 const char *path = needs_pushing.items[i].string;
455 fprintf(stderr, "Pushing submodule '%s'\n", path);
456 if (!push_submodule(path)) {
457 fprintf(stderr, "Unable to push submodule '%s'\n", path);
458 ret = 0;
462 string_list_clear(&needs_pushing, 0);
464 return ret;
467 static int is_submodule_commit_present(const char *path, unsigned char sha1[20])
469 int is_present = 0;
470 if (!add_submodule_odb(path) && lookup_commit_reference(sha1)) {
471 /* Even if the submodule is checked out and the commit is
472 * present, make sure it is reachable from a ref. */
473 struct child_process cp;
474 const char *argv[] = {"rev-list", "-n", "1", NULL, "--not", "--all", NULL};
475 struct strbuf buf = STRBUF_INIT;
477 argv[3] = sha1_to_hex(sha1);
478 memset(&cp, 0, sizeof(cp));
479 cp.argv = argv;
480 cp.env = local_repo_env;
481 cp.git_cmd = 1;
482 cp.no_stdin = 1;
483 cp.out = -1;
484 cp.dir = path;
485 if (!run_command(&cp) && !strbuf_read(&buf, cp.out, 1024))
486 is_present = 1;
488 close(cp.out);
489 strbuf_release(&buf);
491 return is_present;
494 static void submodule_collect_changed_cb(struct diff_queue_struct *q,
495 struct diff_options *options,
496 void *data)
498 int i;
499 for (i = 0; i < q->nr; i++) {
500 struct diff_filepair *p = q->queue[i];
501 if (!S_ISGITLINK(p->two->mode))
502 continue;
504 if (S_ISGITLINK(p->one->mode)) {
505 /* NEEDSWORK: We should honor the name configured in
506 * the .gitmodules file of the commit we are examining
507 * here to be able to correctly follow submodules
508 * being moved around. */
509 struct string_list_item *path;
510 path = unsorted_string_list_lookup(&changed_submodule_paths, p->two->path);
511 if (!path && !is_submodule_commit_present(p->two->path, p->two->sha1))
512 string_list_append(&changed_submodule_paths, xstrdup(p->two->path));
513 } else {
514 /* Submodule is new or was moved here */
515 /* NEEDSWORK: When the .git directories of submodules
516 * live inside the superprojects .git directory some
517 * day we should fetch new submodules directly into
518 * that location too when config or options request
519 * that so they can be checked out from there. */
520 continue;
525 static int add_sha1_to_array(const char *ref, const unsigned char *sha1,
526 int flags, void *data)
528 sha1_array_append(data, sha1);
529 return 0;
532 void check_for_new_submodule_commits(unsigned char new_sha1[20])
534 if (!initialized_fetch_ref_tips) {
535 for_each_ref(add_sha1_to_array, &ref_tips_before_fetch);
536 initialized_fetch_ref_tips = 1;
539 sha1_array_append(&ref_tips_after_fetch, new_sha1);
542 static void add_sha1_to_argv(const unsigned char sha1[20], void *data)
544 argv_array_push(data, sha1_to_hex(sha1));
547 static void calculate_changed_submodule_paths(void)
549 struct rev_info rev;
550 struct commit *commit;
551 struct argv_array argv = ARGV_ARRAY_INIT;
553 /* No need to check if there are no submodules configured */
554 if (!config_name_for_path.nr)
555 return;
557 init_revisions(&rev, NULL);
558 argv_array_push(&argv, "--"); /* argv[0] program name */
559 sha1_array_for_each_unique(&ref_tips_after_fetch,
560 add_sha1_to_argv, &argv);
561 argv_array_push(&argv, "--not");
562 sha1_array_for_each_unique(&ref_tips_before_fetch,
563 add_sha1_to_argv, &argv);
564 setup_revisions(argv.argc, argv.argv, &rev, NULL);
565 if (prepare_revision_walk(&rev))
566 die("revision walk setup failed");
569 * Collect all submodules (whether checked out or not) for which new
570 * commits have been recorded upstream in "changed_submodule_paths".
572 while ((commit = get_revision(&rev))) {
573 struct commit_list *parent = commit->parents;
574 while (parent) {
575 struct diff_options diff_opts;
576 diff_setup(&diff_opts);
577 DIFF_OPT_SET(&diff_opts, RECURSIVE);
578 diff_opts.output_format |= DIFF_FORMAT_CALLBACK;
579 diff_opts.format_callback = submodule_collect_changed_cb;
580 diff_setup_done(&diff_opts);
581 diff_tree_sha1(parent->item->object.sha1, commit->object.sha1, "", &diff_opts);
582 diffcore_std(&diff_opts);
583 diff_flush(&diff_opts);
584 parent = parent->next;
588 argv_array_clear(&argv);
589 sha1_array_clear(&ref_tips_before_fetch);
590 sha1_array_clear(&ref_tips_after_fetch);
591 initialized_fetch_ref_tips = 0;
594 int fetch_populated_submodules(const struct argv_array *options,
595 const char *prefix, int command_line_option,
596 int quiet)
598 int i, result = 0;
599 struct child_process cp;
600 struct argv_array argv = ARGV_ARRAY_INIT;
601 struct string_list_item *name_for_path;
602 const char *work_tree = get_git_work_tree();
603 if (!work_tree)
604 goto out;
606 if (read_cache() < 0)
607 die("index file corrupt");
609 argv_array_push(&argv, "fetch");
610 for (i = 0; i < options->argc; i++)
611 argv_array_push(&argv, options->argv[i]);
612 argv_array_push(&argv, "--recurse-submodules-default");
613 /* default value, "--submodule-prefix" and its value are added later */
615 memset(&cp, 0, sizeof(cp));
616 cp.env = local_repo_env;
617 cp.git_cmd = 1;
618 cp.no_stdin = 1;
620 calculate_changed_submodule_paths();
622 for (i = 0; i < active_nr; i++) {
623 struct strbuf submodule_path = STRBUF_INIT;
624 struct strbuf submodule_git_dir = STRBUF_INIT;
625 struct strbuf submodule_prefix = STRBUF_INIT;
626 struct cache_entry *ce = active_cache[i];
627 const char *git_dir, *name, *default_argv;
629 if (!S_ISGITLINK(ce->ce_mode))
630 continue;
632 name = ce->name;
633 name_for_path = unsorted_string_list_lookup(&config_name_for_path, ce->name);
634 if (name_for_path)
635 name = name_for_path->util;
637 default_argv = "yes";
638 if (command_line_option == RECURSE_SUBMODULES_DEFAULT) {
639 struct string_list_item *fetch_recurse_submodules_option;
640 fetch_recurse_submodules_option = unsorted_string_list_lookup(&config_fetch_recurse_submodules_for_name, name);
641 if (fetch_recurse_submodules_option) {
642 if ((intptr_t)fetch_recurse_submodules_option->util == RECURSE_SUBMODULES_OFF)
643 continue;
644 if ((intptr_t)fetch_recurse_submodules_option->util == RECURSE_SUBMODULES_ON_DEMAND) {
645 if (!unsorted_string_list_lookup(&changed_submodule_paths, ce->name))
646 continue;
647 default_argv = "on-demand";
649 } else {
650 if ((config_fetch_recurse_submodules == RECURSE_SUBMODULES_OFF) ||
651 gitmodules_is_unmerged)
652 continue;
653 if (config_fetch_recurse_submodules == RECURSE_SUBMODULES_ON_DEMAND) {
654 if (!unsorted_string_list_lookup(&changed_submodule_paths, ce->name))
655 continue;
656 default_argv = "on-demand";
659 } else if (command_line_option == RECURSE_SUBMODULES_ON_DEMAND) {
660 if (!unsorted_string_list_lookup(&changed_submodule_paths, ce->name))
661 continue;
662 default_argv = "on-demand";
665 strbuf_addf(&submodule_path, "%s/%s", work_tree, ce->name);
666 strbuf_addf(&submodule_git_dir, "%s/.git", submodule_path.buf);
667 strbuf_addf(&submodule_prefix, "%s%s/", prefix, ce->name);
668 git_dir = read_gitfile(submodule_git_dir.buf);
669 if (!git_dir)
670 git_dir = submodule_git_dir.buf;
671 if (is_directory(git_dir)) {
672 if (!quiet)
673 printf("Fetching submodule %s%s\n", prefix, ce->name);
674 cp.dir = submodule_path.buf;
675 argv_array_push(&argv, default_argv);
676 argv_array_push(&argv, "--submodule-prefix");
677 argv_array_push(&argv, submodule_prefix.buf);
678 cp.argv = argv.argv;
679 if (run_command(&cp))
680 result = 1;
681 argv_array_pop(&argv);
682 argv_array_pop(&argv);
683 argv_array_pop(&argv);
685 strbuf_release(&submodule_path);
686 strbuf_release(&submodule_git_dir);
687 strbuf_release(&submodule_prefix);
689 argv_array_clear(&argv);
690 out:
691 string_list_clear(&changed_submodule_paths, 1);
692 return result;
695 unsigned is_submodule_modified(const char *path, int ignore_untracked)
697 ssize_t len;
698 struct child_process cp;
699 const char *argv[] = {
700 "status",
701 "--porcelain",
702 NULL,
703 NULL,
705 struct strbuf buf = STRBUF_INIT;
706 unsigned dirty_submodule = 0;
707 const char *line, *next_line;
708 const char *git_dir;
710 strbuf_addf(&buf, "%s/.git", path);
711 git_dir = read_gitfile(buf.buf);
712 if (!git_dir)
713 git_dir = buf.buf;
714 if (!is_directory(git_dir)) {
715 strbuf_release(&buf);
716 /* The submodule is not checked out, so it is not modified */
717 return 0;
720 strbuf_reset(&buf);
722 if (ignore_untracked)
723 argv[2] = "-uno";
725 memset(&cp, 0, sizeof(cp));
726 cp.argv = argv;
727 cp.env = local_repo_env;
728 cp.git_cmd = 1;
729 cp.no_stdin = 1;
730 cp.out = -1;
731 cp.dir = path;
732 if (start_command(&cp))
733 die("Could not run 'git status --porcelain' in submodule %s", path);
735 len = strbuf_read(&buf, cp.out, 1024);
736 line = buf.buf;
737 while (len > 2) {
738 if ((line[0] == '?') && (line[1] == '?')) {
739 dirty_submodule |= DIRTY_SUBMODULE_UNTRACKED;
740 if (dirty_submodule & DIRTY_SUBMODULE_MODIFIED)
741 break;
742 } else {
743 dirty_submodule |= DIRTY_SUBMODULE_MODIFIED;
744 if (ignore_untracked ||
745 (dirty_submodule & DIRTY_SUBMODULE_UNTRACKED))
746 break;
748 next_line = strchr(line, '\n');
749 if (!next_line)
750 break;
751 next_line++;
752 len -= (next_line - line);
753 line = next_line;
755 close(cp.out);
757 if (finish_command(&cp))
758 die("'git status --porcelain' failed in submodule %s", path);
760 strbuf_release(&buf);
761 return dirty_submodule;
764 int submodule_uses_gitfile(const char *path)
766 struct child_process cp;
767 const char *argv[] = {
768 "submodule",
769 "foreach",
770 "--quiet",
771 "--recursive",
772 "test -f .git",
773 NULL,
775 struct strbuf buf = STRBUF_INIT;
776 const char *git_dir;
778 strbuf_addf(&buf, "%s/.git", path);
779 git_dir = read_gitfile(buf.buf);
780 if (!git_dir) {
781 strbuf_release(&buf);
782 return 0;
784 strbuf_release(&buf);
786 /* Now test that all nested submodules use a gitfile too */
787 memset(&cp, 0, sizeof(cp));
788 cp.argv = argv;
789 cp.env = local_repo_env;
790 cp.git_cmd = 1;
791 cp.no_stdin = 1;
792 cp.no_stderr = 1;
793 cp.no_stdout = 1;
794 cp.dir = path;
795 if (run_command(&cp))
796 return 0;
798 return 1;
801 int ok_to_remove_submodule(const char *path)
803 struct stat st;
804 ssize_t len;
805 struct child_process cp;
806 const char *argv[] = {
807 "status",
808 "--porcelain",
809 "-u",
810 "--ignore-submodules=none",
811 NULL,
813 struct strbuf buf = STRBUF_INIT;
814 int ok_to_remove = 1;
816 if ((lstat(path, &st) < 0) || is_empty_dir(path))
817 return 1;
819 if (!submodule_uses_gitfile(path))
820 return 0;
822 memset(&cp, 0, sizeof(cp));
823 cp.argv = argv;
824 cp.env = local_repo_env;
825 cp.git_cmd = 1;
826 cp.no_stdin = 1;
827 cp.out = -1;
828 cp.dir = path;
829 if (start_command(&cp))
830 die("Could not run 'git status --porcelain -uall --ignore-submodules=none' in submodule %s", path);
832 len = strbuf_read(&buf, cp.out, 1024);
833 if (len > 2)
834 ok_to_remove = 0;
835 close(cp.out);
837 if (finish_command(&cp))
838 die("'git status --porcelain -uall --ignore-submodules=none' failed in submodule %s", path);
840 strbuf_release(&buf);
841 return ok_to_remove;
844 static int find_first_merges(struct object_array *result, const char *path,
845 struct commit *a, struct commit *b)
847 int i, j;
848 struct object_array merges;
849 struct commit *commit;
850 int contains_another;
852 char merged_revision[42];
853 const char *rev_args[] = { "rev-list", "--merges", "--ancestry-path",
854 "--all", merged_revision, NULL };
855 struct rev_info revs;
856 struct setup_revision_opt rev_opts;
858 memset(&merges, 0, sizeof(merges));
859 memset(result, 0, sizeof(struct object_array));
860 memset(&rev_opts, 0, sizeof(rev_opts));
862 /* get all revisions that merge commit a */
863 snprintf(merged_revision, sizeof(merged_revision), "^%s",
864 sha1_to_hex(a->object.sha1));
865 init_revisions(&revs, NULL);
866 rev_opts.submodule = path;
867 setup_revisions(sizeof(rev_args)/sizeof(char *)-1, rev_args, &revs, &rev_opts);
869 /* save all revisions from the above list that contain b */
870 if (prepare_revision_walk(&revs))
871 die("revision walk setup failed");
872 while ((commit = get_revision(&revs)) != NULL) {
873 struct object *o = &(commit->object);
874 if (in_merge_bases(b, commit))
875 add_object_array(o, NULL, &merges);
877 reset_revision_walk();
879 /* Now we've got all merges that contain a and b. Prune all
880 * merges that contain another found merge and save them in
881 * result.
883 for (i = 0; i < merges.nr; i++) {
884 struct commit *m1 = (struct commit *) merges.objects[i].item;
886 contains_another = 0;
887 for (j = 0; j < merges.nr; j++) {
888 struct commit *m2 = (struct commit *) merges.objects[j].item;
889 if (i != j && in_merge_bases(m2, m1)) {
890 contains_another = 1;
891 break;
895 if (!contains_another)
896 add_object_array(merges.objects[i].item,
897 merges.objects[i].name, result);
900 free(merges.objects);
901 return result->nr;
904 static void print_commit(struct commit *commit)
906 struct strbuf sb = STRBUF_INIT;
907 struct pretty_print_context ctx = {0};
908 ctx.date_mode = DATE_NORMAL;
909 format_commit_message(commit, " %h: %m %s", &sb, &ctx);
910 fprintf(stderr, "%s\n", sb.buf);
911 strbuf_release(&sb);
914 #define MERGE_WARNING(path, msg) \
915 warning("Failed to merge submodule %s (%s)", path, msg);
917 int merge_submodule(unsigned char result[20], const char *path,
918 const unsigned char base[20], const unsigned char a[20],
919 const unsigned char b[20], int search)
921 struct commit *commit_base, *commit_a, *commit_b;
922 int parent_count;
923 struct object_array merges;
925 int i;
927 /* store a in result in case we fail */
928 hashcpy(result, a);
930 /* we can not handle deletion conflicts */
931 if (is_null_sha1(base))
932 return 0;
933 if (is_null_sha1(a))
934 return 0;
935 if (is_null_sha1(b))
936 return 0;
938 if (add_submodule_odb(path)) {
939 MERGE_WARNING(path, "not checked out");
940 return 0;
943 if (!(commit_base = lookup_commit_reference(base)) ||
944 !(commit_a = lookup_commit_reference(a)) ||
945 !(commit_b = lookup_commit_reference(b))) {
946 MERGE_WARNING(path, "commits not present");
947 return 0;
950 /* check whether both changes are forward */
951 if (!in_merge_bases(commit_base, commit_a) ||
952 !in_merge_bases(commit_base, commit_b)) {
953 MERGE_WARNING(path, "commits don't follow merge-base");
954 return 0;
957 /* Case #1: a is contained in b or vice versa */
958 if (in_merge_bases(commit_a, commit_b)) {
959 hashcpy(result, b);
960 return 1;
962 if (in_merge_bases(commit_b, commit_a)) {
963 hashcpy(result, a);
964 return 1;
968 * Case #2: There are one or more merges that contain a and b in
969 * the submodule. If there is only one, then present it as a
970 * suggestion to the user, but leave it marked unmerged so the
971 * user needs to confirm the resolution.
974 /* Skip the search if makes no sense to the calling context. */
975 if (!search)
976 return 0;
978 /* find commit which merges them */
979 parent_count = find_first_merges(&merges, path, commit_a, commit_b);
980 switch (parent_count) {
981 case 0:
982 MERGE_WARNING(path, "merge following commits not found");
983 break;
985 case 1:
986 MERGE_WARNING(path, "not fast-forward");
987 fprintf(stderr, "Found a possible merge resolution "
988 "for the submodule:\n");
989 print_commit((struct commit *) merges.objects[0].item);
990 fprintf(stderr,
991 "If this is correct simply add it to the index "
992 "for example\n"
993 "by using:\n\n"
994 " git update-index --cacheinfo 160000 %s \"%s\"\n\n"
995 "which will accept this suggestion.\n",
996 sha1_to_hex(merges.objects[0].item->sha1), path);
997 break;
999 default:
1000 MERGE_WARNING(path, "multiple merges found");
1001 for (i = 0; i < merges.nr; i++)
1002 print_commit((struct commit *) merges.objects[i].item);
1005 free(merges.objects);
1006 return 0;