2 #include "submodule-config.h"
8 #include "run-command.h"
11 #include "string-list.h"
12 #include "sha1-array.h"
13 #include "argv-array.h"
15 #include "thread-utils.h"
18 static int config_fetch_recurse_submodules
= RECURSE_SUBMODULES_ON_DEMAND
;
19 static int parallel_jobs
= 1;
20 static struct string_list changed_submodule_paths
= STRING_LIST_INIT_NODUP
;
21 static int initialized_fetch_ref_tips
;
22 static struct sha1_array ref_tips_before_fetch
;
23 static struct sha1_array ref_tips_after_fetch
;
26 * The following flag is set if the .gitmodules file is unmerged. We then
27 * disable recursion for all submodules where .git/config doesn't have a
28 * matching config entry because we can't guess what might be configured in
29 * .gitmodules unless the user resolves the conflict. When a command line
30 * option is given (which always overrides configuration) this flag will be
33 static int gitmodules_is_unmerged
;
36 * This flag is set if the .gitmodules file had unstaged modifications on
37 * startup. This must be checked before allowing modifications to the
38 * .gitmodules file with the intention to stage them later, because when
39 * continuing we would stage the modifications the user didn't stage herself
40 * too. That might change in a future version when we learn to stage the
41 * changes we do ourselves without staging any previous modifications.
43 static int gitmodules_is_modified
;
45 int is_staging_gitmodules_ok(void)
47 return !gitmodules_is_modified
;
51 * Try to update the "path" entry in the "submodule.<name>" section of the
52 * .gitmodules file. Return 0 only if a .gitmodules file was found, a section
53 * with the correct path=<oldpath> setting was found and we could update it.
55 int update_path_in_gitmodules(const char *oldpath
, const char *newpath
)
57 struct strbuf entry
= STRBUF_INIT
;
58 const struct submodule
*submodule
;
60 if (!file_exists(".gitmodules")) /* Do nothing without .gitmodules */
63 if (gitmodules_is_unmerged
)
64 die(_("Cannot change unmerged .gitmodules, resolve merge conflicts first"));
66 submodule
= submodule_from_path(null_sha1
, oldpath
);
67 if (!submodule
|| !submodule
->name
) {
68 warning(_("Could not find section in .gitmodules where path=%s"), oldpath
);
71 strbuf_addstr(&entry
, "submodule.");
72 strbuf_addstr(&entry
, submodule
->name
);
73 strbuf_addstr(&entry
, ".path");
74 if (git_config_set_in_file_gently(".gitmodules", entry
.buf
, newpath
) < 0) {
75 /* Maybe the user already did that, don't error out here */
76 warning(_("Could not update .gitmodules entry %s"), entry
.buf
);
77 strbuf_release(&entry
);
80 strbuf_release(&entry
);
85 * Try to remove the "submodule.<name>" section from .gitmodules where the given
86 * path is configured. Return 0 only if a .gitmodules file was found, a section
87 * with the correct path=<path> setting was found and we could remove it.
89 int remove_path_from_gitmodules(const char *path
)
91 struct strbuf sect
= STRBUF_INIT
;
92 const struct submodule
*submodule
;
94 if (!file_exists(".gitmodules")) /* Do nothing without .gitmodules */
97 if (gitmodules_is_unmerged
)
98 die(_("Cannot change unmerged .gitmodules, resolve merge conflicts first"));
100 submodule
= submodule_from_path(null_sha1
, path
);
101 if (!submodule
|| !submodule
->name
) {
102 warning(_("Could not find section in .gitmodules where path=%s"), path
);
105 strbuf_addstr(§
, "submodule.");
106 strbuf_addstr(§
, submodule
->name
);
107 if (git_config_rename_section_in_file(".gitmodules", sect
.buf
, NULL
) < 0) {
108 /* Maybe the user already did that, don't error out here */
109 warning(_("Could not remove .gitmodules entry for %s"), path
);
110 strbuf_release(§
);
113 strbuf_release(§
);
117 void stage_updated_gitmodules(void)
119 if (add_file_to_cache(".gitmodules", 0))
120 die(_("staging updated .gitmodules failed"));
123 static int add_submodule_odb(const char *path
)
125 struct strbuf objects_directory
= STRBUF_INIT
;
128 ret
= strbuf_git_path_submodule(&objects_directory
, path
, "objects/");
131 if (!is_directory(objects_directory
.buf
)) {
135 add_to_alternates_memory(objects_directory
.buf
);
137 strbuf_release(&objects_directory
);
141 void set_diffopt_flags_from_submodule_config(struct diff_options
*diffopt
,
144 const struct submodule
*submodule
= submodule_from_path(null_sha1
, path
);
146 if (submodule
->ignore
)
147 handle_ignore_submodules_arg(diffopt
, submodule
->ignore
);
148 else if (gitmodules_is_unmerged
)
149 DIFF_OPT_SET(diffopt
, IGNORE_SUBMODULES
);
153 int submodule_config(const char *var
, const char *value
, void *cb
)
155 if (!strcmp(var
, "submodule.fetchjobs")) {
156 parallel_jobs
= git_config_int(var
, value
);
157 if (parallel_jobs
< 0)
158 die(_("negative values not allowed for submodule.fetchJobs"));
160 } else if (starts_with(var
, "submodule."))
161 return parse_submodule_config_option(var
, value
);
162 else if (!strcmp(var
, "fetch.recursesubmodules")) {
163 config_fetch_recurse_submodules
= parse_fetch_recurse_submodules_arg(var
, value
);
169 void gitmodules_config(void)
171 const char *work_tree
= get_git_work_tree();
173 struct strbuf gitmodules_path
= STRBUF_INIT
;
175 strbuf_addstr(&gitmodules_path
, work_tree
);
176 strbuf_addstr(&gitmodules_path
, "/.gitmodules");
177 if (read_cache() < 0)
178 die("index file corrupt");
179 pos
= cache_name_pos(".gitmodules", 11);
180 if (pos
< 0) { /* .gitmodules not found or isn't merged */
182 if (active_nr
> pos
) { /* there is a .gitmodules */
183 const struct cache_entry
*ce
= active_cache
[pos
];
184 if (ce_namelen(ce
) == 11 &&
185 !memcmp(ce
->name
, ".gitmodules", 11))
186 gitmodules_is_unmerged
= 1;
188 } else if (pos
< active_nr
) {
190 if (lstat(".gitmodules", &st
) == 0 &&
191 ce_match_stat(active_cache
[pos
], &st
, 0) & DATA_CHANGED
)
192 gitmodules_is_modified
= 1;
195 if (!gitmodules_is_unmerged
)
196 git_config_from_file(submodule_config
, gitmodules_path
.buf
, NULL
);
197 strbuf_release(&gitmodules_path
);
201 int parse_submodule_update_strategy(const char *value
,
202 struct submodule_update_strategy
*dst
)
204 free((void*)dst
->command
);
206 if (!strcmp(value
, "none"))
207 dst
->type
= SM_UPDATE_NONE
;
208 else if (!strcmp(value
, "checkout"))
209 dst
->type
= SM_UPDATE_CHECKOUT
;
210 else if (!strcmp(value
, "rebase"))
211 dst
->type
= SM_UPDATE_REBASE
;
212 else if (!strcmp(value
, "merge"))
213 dst
->type
= SM_UPDATE_MERGE
;
214 else if (skip_prefix(value
, "!", &value
)) {
215 dst
->type
= SM_UPDATE_COMMAND
;
216 dst
->command
= xstrdup(value
);
222 const char *submodule_strategy_to_string(const struct submodule_update_strategy
*s
)
224 struct strbuf sb
= STRBUF_INIT
;
226 case SM_UPDATE_CHECKOUT
:
228 case SM_UPDATE_MERGE
:
230 case SM_UPDATE_REBASE
:
234 case SM_UPDATE_UNSPECIFIED
:
236 case SM_UPDATE_COMMAND
:
237 strbuf_addf(&sb
, "!%s", s
->command
);
238 return strbuf_detach(&sb
, NULL
);
243 void handle_ignore_submodules_arg(struct diff_options
*diffopt
,
246 DIFF_OPT_CLR(diffopt
, IGNORE_SUBMODULES
);
247 DIFF_OPT_CLR(diffopt
, IGNORE_UNTRACKED_IN_SUBMODULES
);
248 DIFF_OPT_CLR(diffopt
, IGNORE_DIRTY_SUBMODULES
);
250 if (!strcmp(arg
, "all"))
251 DIFF_OPT_SET(diffopt
, IGNORE_SUBMODULES
);
252 else if (!strcmp(arg
, "untracked"))
253 DIFF_OPT_SET(diffopt
, IGNORE_UNTRACKED_IN_SUBMODULES
);
254 else if (!strcmp(arg
, "dirty"))
255 DIFF_OPT_SET(diffopt
, IGNORE_DIRTY_SUBMODULES
);
256 else if (strcmp(arg
, "none"))
257 die("bad --ignore-submodules argument: %s", arg
);
260 static int prepare_submodule_summary(struct rev_info
*rev
, const char *path
,
261 struct commit
*left
, struct commit
*right
,
262 struct commit_list
*merge_bases
)
264 struct commit_list
*list
;
266 init_revisions(rev
, NULL
);
267 setup_revisions(0, NULL
, rev
, NULL
);
269 rev
->first_parent_only
= 1;
270 left
->object
.flags
|= SYMMETRIC_LEFT
;
271 add_pending_object(rev
, &left
->object
, path
);
272 add_pending_object(rev
, &right
->object
, path
);
273 for (list
= merge_bases
; list
; list
= list
->next
) {
274 list
->item
->object
.flags
|= UNINTERESTING
;
275 add_pending_object(rev
, &list
->item
->object
,
276 oid_to_hex(&list
->item
->object
.oid
));
278 return prepare_revision_walk(rev
);
281 static void print_submodule_summary(struct rev_info
*rev
, FILE *f
,
282 const char *line_prefix
,
283 const char *del
, const char *add
, const char *reset
)
285 static const char format
[] = " %m %s";
286 struct strbuf sb
= STRBUF_INIT
;
287 struct commit
*commit
;
289 while ((commit
= get_revision(rev
))) {
290 struct pretty_print_context ctx
= {0};
291 ctx
.date_mode
= rev
->date_mode
;
292 ctx
.output_encoding
= get_log_output_encoding();
293 strbuf_setlen(&sb
, 0);
294 strbuf_addstr(&sb
, line_prefix
);
295 if (commit
->object
.flags
& SYMMETRIC_LEFT
) {
297 strbuf_addstr(&sb
, del
);
300 strbuf_addstr(&sb
, add
);
301 format_commit_message(commit
, format
, &sb
, &ctx
);
303 strbuf_addstr(&sb
, reset
);
304 strbuf_addch(&sb
, '\n');
305 fprintf(f
, "%s", sb
.buf
);
310 /* Helper function to display the submodule header line prior to the full
311 * summary output. If it can locate the submodule objects directory it will
312 * attempt to lookup both the left and right commits and put them into the
313 * left and right pointers.
315 static void show_submodule_header(FILE *f
, const char *path
,
316 const char *line_prefix
,
317 struct object_id
*one
, struct object_id
*two
,
318 unsigned dirty_submodule
, const char *meta
,
320 struct commit
**left
, struct commit
**right
,
321 struct commit_list
**merge_bases
)
323 const char *message
= NULL
;
324 struct strbuf sb
= STRBUF_INIT
;
325 int fast_forward
= 0, fast_backward
= 0;
327 if (dirty_submodule
& DIRTY_SUBMODULE_UNTRACKED
)
328 fprintf(f
, "%sSubmodule %s contains untracked content\n",
330 if (dirty_submodule
& DIRTY_SUBMODULE_MODIFIED
)
331 fprintf(f
, "%sSubmodule %s contains modified content\n",
334 if (is_null_oid(one
))
335 message
= "(new submodule)";
336 else if (is_null_oid(two
))
337 message
= "(submodule deleted)";
339 if (add_submodule_odb(path
)) {
341 message
= "(not initialized)";
346 * Attempt to lookup the commit references, and determine if this is
347 * a fast forward or fast backwards update.
349 *left
= lookup_commit_reference(one
->hash
);
350 *right
= lookup_commit_reference(two
->hash
);
353 * Warn about missing commits in the submodule project, but only if
356 if ((!is_null_oid(one
) && !*left
) ||
357 (!is_null_oid(two
) && !*right
))
358 message
= "(commits not present)";
360 *merge_bases
= get_merge_bases(*left
, *right
);
362 if ((*merge_bases
)->item
== *left
)
364 else if ((*merge_bases
)->item
== *right
)
368 if (!oidcmp(one
, two
)) {
374 strbuf_addf(&sb
, "%s%sSubmodule %s ", line_prefix
, meta
, path
);
375 strbuf_add_unique_abbrev(&sb
, one
->hash
, DEFAULT_ABBREV
);
376 strbuf_addstr(&sb
, (fast_backward
|| fast_forward
) ? ".." : "...");
377 strbuf_add_unique_abbrev(&sb
, two
->hash
, DEFAULT_ABBREV
);
379 strbuf_addf(&sb
, " %s%s\n", message
, reset
);
381 strbuf_addf(&sb
, "%s:%s\n", fast_backward
? " (rewind)" : "", reset
);
382 fwrite(sb
.buf
, sb
.len
, 1, f
);
387 void show_submodule_summary(FILE *f
, const char *path
,
388 const char *line_prefix
,
389 struct object_id
*one
, struct object_id
*two
,
390 unsigned dirty_submodule
, const char *meta
,
391 const char *del
, const char *add
, const char *reset
)
394 struct commit
*left
= NULL
, *right
= NULL
;
395 struct commit_list
*merge_bases
= NULL
;
397 show_submodule_header(f
, path
, line_prefix
, one
, two
, dirty_submodule
,
398 meta
, reset
, &left
, &right
, &merge_bases
);
401 * If we don't have both a left and a right pointer, there is no
402 * reason to try and display a summary. The header line should contain
403 * all the information the user needs.
408 /* Treat revision walker failure the same as missing commits */
409 if (prepare_submodule_summary(&rev
, path
, left
, right
, merge_bases
)) {
410 fprintf(f
, "%s(revision walker failed)\n", line_prefix
);
414 print_submodule_summary(&rev
, f
, line_prefix
, del
, add
, reset
);
418 free_commit_list(merge_bases
);
419 clear_commit_marks(left
, ~0);
420 clear_commit_marks(right
, ~0);
423 void show_submodule_inline_diff(FILE *f
, const char *path
,
424 const char *line_prefix
,
425 struct object_id
*one
, struct object_id
*two
,
426 unsigned dirty_submodule
, const char *meta
,
427 const char *del
, const char *add
, const char *reset
,
428 const struct diff_options
*o
)
430 const struct object_id
*old
= &empty_tree_oid
, *new = &empty_tree_oid
;
431 struct commit
*left
= NULL
, *right
= NULL
;
432 struct commit_list
*merge_bases
= NULL
;
433 struct strbuf submodule_dir
= STRBUF_INIT
;
434 struct child_process cp
= CHILD_PROCESS_INIT
;
436 show_submodule_header(f
, path
, line_prefix
, one
, two
, dirty_submodule
,
437 meta
, reset
, &left
, &right
, &merge_bases
);
439 /* We need a valid left and right commit to display a difference */
440 if (!(left
|| is_null_oid(one
)) ||
441 !(right
|| is_null_oid(two
)))
452 cp
.out
= dup(fileno(f
));
455 /* TODO: other options may need to be passed here. */
456 argv_array_push(&cp
.args
, "diff");
457 argv_array_pushf(&cp
.args
, "--line-prefix=%s", line_prefix
);
458 if (DIFF_OPT_TST(o
, REVERSE_DIFF
)) {
459 argv_array_pushf(&cp
.args
, "--src-prefix=%s%s/",
461 argv_array_pushf(&cp
.args
, "--dst-prefix=%s%s/",
464 argv_array_pushf(&cp
.args
, "--src-prefix=%s%s/",
466 argv_array_pushf(&cp
.args
, "--dst-prefix=%s%s/",
469 argv_array_push(&cp
.args
, oid_to_hex(old
));
471 * If the submodule has modified content, we will diff against the
472 * work tree, under the assumption that the user has asked for the
473 * diff format and wishes to actually see all differences even if they
474 * haven't yet been committed to the submodule yet.
476 if (!(dirty_submodule
& DIRTY_SUBMODULE_MODIFIED
))
477 argv_array_push(&cp
.args
, oid_to_hex(new));
479 prepare_submodule_repo_env(&cp
.env_array
);
480 if (run_command(&cp
))
481 fprintf(f
, "(diff failed)\n");
484 strbuf_release(&submodule_dir
);
486 free_commit_list(merge_bases
);
488 clear_commit_marks(left
, ~0);
490 clear_commit_marks(right
, ~0);
493 void set_config_fetch_recurse_submodules(int value
)
495 config_fetch_recurse_submodules
= value
;
498 static int has_remote(const char *refname
, const struct object_id
*oid
,
499 int flags
, void *cb_data
)
504 static int append_sha1_to_argv(const unsigned char sha1
[20], void *data
)
506 struct argv_array
*argv
= data
;
507 argv_array_push(argv
, sha1_to_hex(sha1
));
511 static int check_has_commit(const unsigned char sha1
[20], void *data
)
513 int *has_commit
= data
;
515 if (!lookup_commit_reference(sha1
))
521 static int submodule_has_commits(const char *path
, struct sha1_array
*commits
)
525 if (add_submodule_odb(path
))
528 sha1_array_for_each_unique(commits
, check_has_commit
, &has_commit
);
532 static int submodule_needs_pushing(const char *path
, struct sha1_array
*commits
)
534 if (!submodule_has_commits(path
, commits
))
536 * NOTE: We do consider it safe to return "no" here. The
537 * correct answer would be "We do not know" instead of
538 * "No push needed", but it is quite hard to change
539 * the submodule pointer without having the submodule
540 * around. If a user did however change the submodules
541 * without having the submodule around, this indicates
542 * an expert who knows what they are doing or a
543 * maintainer integrating work from other people. In
544 * both cases it should be safe to skip this check.
548 if (for_each_remote_ref_submodule(path
, has_remote
, NULL
) > 0) {
549 struct child_process cp
= CHILD_PROCESS_INIT
;
550 struct strbuf buf
= STRBUF_INIT
;
551 int needs_pushing
= 0;
553 argv_array_push(&cp
.args
, "rev-list");
554 sha1_array_for_each_unique(commits
, append_sha1_to_argv
, &cp
.args
);
555 argv_array_pushl(&cp
.args
, "--not", "--remotes", "-n", "1" , NULL
);
557 prepare_submodule_repo_env(&cp
.env_array
);
562 if (start_command(&cp
))
563 die("Could not run 'git rev-list <commits> --not --remotes -n 1' command in submodule %s",
565 if (strbuf_read(&buf
, cp
.out
, 41))
569 strbuf_release(&buf
);
570 return needs_pushing
;
576 static struct sha1_array
*submodule_commits(struct string_list
*submodules
,
579 struct string_list_item
*item
;
581 item
= string_list_insert(submodules
, path
);
583 return (struct sha1_array
*) item
->util
;
585 /* NEEDSWORK: should we have sha1_array_init()? */
586 item
->util
= xcalloc(1, sizeof(struct sha1_array
));
587 return (struct sha1_array
*) item
->util
;
590 static void collect_submodules_from_diff(struct diff_queue_struct
*q
,
591 struct diff_options
*options
,
595 struct string_list
*submodules
= data
;
597 for (i
= 0; i
< q
->nr
; i
++) {
598 struct diff_filepair
*p
= q
->queue
[i
];
599 struct sha1_array
*commits
;
600 if (!S_ISGITLINK(p
->two
->mode
))
602 commits
= submodule_commits(submodules
, p
->two
->path
);
603 sha1_array_append(commits
, p
->two
->oid
.hash
);
607 static void find_unpushed_submodule_commits(struct commit
*commit
,
608 struct string_list
*needs_pushing
)
612 init_revisions(&rev
, NULL
);
613 rev
.diffopt
.output_format
|= DIFF_FORMAT_CALLBACK
;
614 rev
.diffopt
.format_callback
= collect_submodules_from_diff
;
615 rev
.diffopt
.format_callback_data
= needs_pushing
;
616 diff_tree_combined_merge(commit
, 1, &rev
);
619 static void free_submodules_sha1s(struct string_list
*submodules
)
621 struct string_list_item
*item
;
622 for_each_string_list_item(item
, submodules
)
623 sha1_array_clear((struct sha1_array
*) item
->util
);
624 string_list_clear(submodules
, 1);
627 int find_unpushed_submodules(struct sha1_array
*commits
,
628 const char *remotes_name
, struct string_list
*needs_pushing
)
631 struct commit
*commit
;
632 struct string_list submodules
= STRING_LIST_INIT_DUP
;
633 struct string_list_item
*submodule
;
634 struct argv_array argv
= ARGV_ARRAY_INIT
;
636 init_revisions(&rev
, NULL
);
638 /* argv.argv[0] will be ignored by setup_revisions */
639 argv_array_push(&argv
, "find_unpushed_submodules");
640 sha1_array_for_each_unique(commits
, append_sha1_to_argv
, &argv
);
641 argv_array_push(&argv
, "--not");
642 argv_array_pushf(&argv
, "--remotes=%s", remotes_name
);
644 setup_revisions(argv
.argc
, argv
.argv
, &rev
, NULL
);
645 if (prepare_revision_walk(&rev
))
646 die("revision walk setup failed");
648 while ((commit
= get_revision(&rev
)) != NULL
)
649 find_unpushed_submodule_commits(commit
, &submodules
);
651 reset_revision_walk();
652 argv_array_clear(&argv
);
654 for_each_string_list_item(submodule
, &submodules
) {
655 struct sha1_array
*commits
= (struct sha1_array
*) submodule
->util
;
657 if (submodule_needs_pushing(submodule
->string
, commits
))
658 string_list_insert(needs_pushing
, submodule
->string
);
660 free_submodules_sha1s(&submodules
);
662 return needs_pushing
->nr
;
665 static int push_submodule(const char *path
, int dry_run
)
667 if (add_submodule_odb(path
))
670 if (for_each_remote_ref_submodule(path
, has_remote
, NULL
) > 0) {
671 struct child_process cp
= CHILD_PROCESS_INIT
;
672 argv_array_push(&cp
.args
, "push");
674 argv_array_push(&cp
.args
, "--dry-run");
676 prepare_submodule_repo_env(&cp
.env_array
);
680 if (run_command(&cp
))
688 int push_unpushed_submodules(struct sha1_array
*commits
,
689 const char *remotes_name
,
693 struct string_list needs_pushing
= STRING_LIST_INIT_DUP
;
695 if (!find_unpushed_submodules(commits
, remotes_name
, &needs_pushing
))
698 for (i
= 0; i
< needs_pushing
.nr
; i
++) {
699 const char *path
= needs_pushing
.items
[i
].string
;
700 fprintf(stderr
, "Pushing submodule '%s'\n", path
);
701 if (!push_submodule(path
, dry_run
)) {
702 fprintf(stderr
, "Unable to push submodule '%s'\n", path
);
707 string_list_clear(&needs_pushing
, 0);
712 static int is_submodule_commit_present(const char *path
, unsigned char sha1
[20])
715 if (!add_submodule_odb(path
) && lookup_commit_reference(sha1
)) {
716 /* Even if the submodule is checked out and the commit is
717 * present, make sure it is reachable from a ref. */
718 struct child_process cp
= CHILD_PROCESS_INIT
;
719 const char *argv
[] = {"rev-list", "-n", "1", NULL
, "--not", "--all", NULL
};
720 struct strbuf buf
= STRBUF_INIT
;
722 argv
[3] = sha1_to_hex(sha1
);
724 prepare_submodule_repo_env(&cp
.env_array
);
728 if (!capture_command(&cp
, &buf
, 1024) && !buf
.len
)
731 strbuf_release(&buf
);
736 static void submodule_collect_changed_cb(struct diff_queue_struct
*q
,
737 struct diff_options
*options
,
741 for (i
= 0; i
< q
->nr
; i
++) {
742 struct diff_filepair
*p
= q
->queue
[i
];
743 if (!S_ISGITLINK(p
->two
->mode
))
746 if (S_ISGITLINK(p
->one
->mode
)) {
747 /* NEEDSWORK: We should honor the name configured in
748 * the .gitmodules file of the commit we are examining
749 * here to be able to correctly follow submodules
750 * being moved around. */
751 struct string_list_item
*path
;
752 path
= unsorted_string_list_lookup(&changed_submodule_paths
, p
->two
->path
);
753 if (!path
&& !is_submodule_commit_present(p
->two
->path
, p
->two
->oid
.hash
))
754 string_list_append(&changed_submodule_paths
, xstrdup(p
->two
->path
));
756 /* Submodule is new or was moved here */
757 /* NEEDSWORK: When the .git directories of submodules
758 * live inside the superprojects .git directory some
759 * day we should fetch new submodules directly into
760 * that location too when config or options request
761 * that so they can be checked out from there. */
767 static int add_sha1_to_array(const char *ref
, const struct object_id
*oid
,
768 int flags
, void *data
)
770 sha1_array_append(data
, oid
->hash
);
774 void check_for_new_submodule_commits(unsigned char new_sha1
[20])
776 if (!initialized_fetch_ref_tips
) {
777 for_each_ref(add_sha1_to_array
, &ref_tips_before_fetch
);
778 initialized_fetch_ref_tips
= 1;
781 sha1_array_append(&ref_tips_after_fetch
, new_sha1
);
784 static int add_sha1_to_argv(const unsigned char sha1
[20], void *data
)
786 argv_array_push(data
, sha1_to_hex(sha1
));
790 static void calculate_changed_submodule_paths(void)
793 struct commit
*commit
;
794 struct argv_array argv
= ARGV_ARRAY_INIT
;
796 /* No need to check if there are no submodules configured */
797 if (!submodule_from_path(NULL
, NULL
))
800 init_revisions(&rev
, NULL
);
801 argv_array_push(&argv
, "--"); /* argv[0] program name */
802 sha1_array_for_each_unique(&ref_tips_after_fetch
,
803 add_sha1_to_argv
, &argv
);
804 argv_array_push(&argv
, "--not");
805 sha1_array_for_each_unique(&ref_tips_before_fetch
,
806 add_sha1_to_argv
, &argv
);
807 setup_revisions(argv
.argc
, argv
.argv
, &rev
, NULL
);
808 if (prepare_revision_walk(&rev
))
809 die("revision walk setup failed");
812 * Collect all submodules (whether checked out or not) for which new
813 * commits have been recorded upstream in "changed_submodule_paths".
815 while ((commit
= get_revision(&rev
))) {
816 struct commit_list
*parent
= commit
->parents
;
818 struct diff_options diff_opts
;
819 diff_setup(&diff_opts
);
820 DIFF_OPT_SET(&diff_opts
, RECURSIVE
);
821 diff_opts
.output_format
|= DIFF_FORMAT_CALLBACK
;
822 diff_opts
.format_callback
= submodule_collect_changed_cb
;
823 diff_setup_done(&diff_opts
);
824 diff_tree_sha1(parent
->item
->object
.oid
.hash
, commit
->object
.oid
.hash
, "", &diff_opts
);
825 diffcore_std(&diff_opts
);
826 diff_flush(&diff_opts
);
827 parent
= parent
->next
;
831 argv_array_clear(&argv
);
832 sha1_array_clear(&ref_tips_before_fetch
);
833 sha1_array_clear(&ref_tips_after_fetch
);
834 initialized_fetch_ref_tips
= 0;
837 struct submodule_parallel_fetch
{
839 struct argv_array args
;
840 const char *work_tree
;
842 int command_line_option
;
846 #define SPF_INIT {0, ARGV_ARRAY_INIT, NULL, NULL, 0, 0, 0}
848 static int get_next_submodule(struct child_process
*cp
,
849 struct strbuf
*err
, void *data
, void **task_cb
)
852 struct submodule_parallel_fetch
*spf
= data
;
854 for (; spf
->count
< active_nr
; spf
->count
++) {
855 struct strbuf submodule_path
= STRBUF_INIT
;
856 struct strbuf submodule_git_dir
= STRBUF_INIT
;
857 struct strbuf submodule_prefix
= STRBUF_INIT
;
858 const struct cache_entry
*ce
= active_cache
[spf
->count
];
859 const char *git_dir
, *default_argv
;
860 const struct submodule
*submodule
;
862 if (!S_ISGITLINK(ce
->ce_mode
))
865 submodule
= submodule_from_path(null_sha1
, ce
->name
);
867 submodule
= submodule_from_name(null_sha1
, ce
->name
);
869 default_argv
= "yes";
870 if (spf
->command_line_option
== RECURSE_SUBMODULES_DEFAULT
) {
872 submodule
->fetch_recurse
!=
873 RECURSE_SUBMODULES_NONE
) {
874 if (submodule
->fetch_recurse
==
875 RECURSE_SUBMODULES_OFF
)
877 if (submodule
->fetch_recurse
==
878 RECURSE_SUBMODULES_ON_DEMAND
) {
879 if (!unsorted_string_list_lookup(&changed_submodule_paths
, ce
->name
))
881 default_argv
= "on-demand";
884 if ((config_fetch_recurse_submodules
== RECURSE_SUBMODULES_OFF
) ||
885 gitmodules_is_unmerged
)
887 if (config_fetch_recurse_submodules
== RECURSE_SUBMODULES_ON_DEMAND
) {
888 if (!unsorted_string_list_lookup(&changed_submodule_paths
, ce
->name
))
890 default_argv
= "on-demand";
893 } else if (spf
->command_line_option
== RECURSE_SUBMODULES_ON_DEMAND
) {
894 if (!unsorted_string_list_lookup(&changed_submodule_paths
, ce
->name
))
896 default_argv
= "on-demand";
899 strbuf_addf(&submodule_path
, "%s/%s", spf
->work_tree
, ce
->name
);
900 strbuf_addf(&submodule_git_dir
, "%s/.git", submodule_path
.buf
);
901 strbuf_addf(&submodule_prefix
, "%s%s/", spf
->prefix
, ce
->name
);
902 git_dir
= read_gitfile(submodule_git_dir
.buf
);
904 git_dir
= submodule_git_dir
.buf
;
905 if (is_directory(git_dir
)) {
906 child_process_init(cp
);
907 cp
->dir
= strbuf_detach(&submodule_path
, NULL
);
908 prepare_submodule_repo_env(&cp
->env_array
);
911 strbuf_addf(err
, "Fetching submodule %s%s\n",
912 spf
->prefix
, ce
->name
);
913 argv_array_init(&cp
->args
);
914 argv_array_pushv(&cp
->args
, spf
->args
.argv
);
915 argv_array_push(&cp
->args
, default_argv
);
916 argv_array_push(&cp
->args
, "--submodule-prefix");
917 argv_array_push(&cp
->args
, submodule_prefix
.buf
);
920 strbuf_release(&submodule_path
);
921 strbuf_release(&submodule_git_dir
);
922 strbuf_release(&submodule_prefix
);
931 static int fetch_start_failure(struct strbuf
*err
,
932 void *cb
, void *task_cb
)
934 struct submodule_parallel_fetch
*spf
= cb
;
941 static int fetch_finish(int retvalue
, struct strbuf
*err
,
942 void *cb
, void *task_cb
)
944 struct submodule_parallel_fetch
*spf
= cb
;
952 int fetch_populated_submodules(const struct argv_array
*options
,
953 const char *prefix
, int command_line_option
,
954 int quiet
, int max_parallel_jobs
)
957 struct submodule_parallel_fetch spf
= SPF_INIT
;
959 spf
.work_tree
= get_git_work_tree();
960 spf
.command_line_option
= command_line_option
;
967 if (read_cache() < 0)
968 die("index file corrupt");
970 argv_array_push(&spf
.args
, "fetch");
971 for (i
= 0; i
< options
->argc
; i
++)
972 argv_array_push(&spf
.args
, options
->argv
[i
]);
973 argv_array_push(&spf
.args
, "--recurse-submodules-default");
974 /* default value, "--submodule-prefix" and its value are added later */
976 if (max_parallel_jobs
< 0)
977 max_parallel_jobs
= parallel_jobs
;
979 calculate_changed_submodule_paths();
980 run_processes_parallel(max_parallel_jobs
,
986 argv_array_clear(&spf
.args
);
988 string_list_clear(&changed_submodule_paths
, 1);
992 unsigned is_submodule_modified(const char *path
, int ignore_untracked
)
995 struct child_process cp
= CHILD_PROCESS_INIT
;
996 const char *argv
[] = {
1002 struct strbuf buf
= STRBUF_INIT
;
1003 unsigned dirty_submodule
= 0;
1004 const char *line
, *next_line
;
1005 const char *git_dir
;
1007 strbuf_addf(&buf
, "%s/.git", path
);
1008 git_dir
= read_gitfile(buf
.buf
);
1011 if (!is_directory(git_dir
)) {
1012 strbuf_release(&buf
);
1013 /* The submodule is not checked out, so it is not modified */
1019 if (ignore_untracked
)
1023 prepare_submodule_repo_env(&cp
.env_array
);
1028 if (start_command(&cp
))
1029 die("Could not run 'git status --porcelain' in submodule %s", path
);
1031 len
= strbuf_read(&buf
, cp
.out
, 1024);
1034 if ((line
[0] == '?') && (line
[1] == '?')) {
1035 dirty_submodule
|= DIRTY_SUBMODULE_UNTRACKED
;
1036 if (dirty_submodule
& DIRTY_SUBMODULE_MODIFIED
)
1039 dirty_submodule
|= DIRTY_SUBMODULE_MODIFIED
;
1040 if (ignore_untracked
||
1041 (dirty_submodule
& DIRTY_SUBMODULE_UNTRACKED
))
1044 next_line
= strchr(line
, '\n');
1048 len
-= (next_line
- line
);
1053 if (finish_command(&cp
))
1054 die("'git status --porcelain' failed in submodule %s", path
);
1056 strbuf_release(&buf
);
1057 return dirty_submodule
;
1060 int submodule_uses_gitfile(const char *path
)
1062 struct child_process cp
= CHILD_PROCESS_INIT
;
1063 const char *argv
[] = {
1071 struct strbuf buf
= STRBUF_INIT
;
1072 const char *git_dir
;
1074 strbuf_addf(&buf
, "%s/.git", path
);
1075 git_dir
= read_gitfile(buf
.buf
);
1077 strbuf_release(&buf
);
1080 strbuf_release(&buf
);
1082 /* Now test that all nested submodules use a gitfile too */
1084 prepare_submodule_repo_env(&cp
.env_array
);
1090 if (run_command(&cp
))
1096 int ok_to_remove_submodule(const char *path
)
1099 struct child_process cp
= CHILD_PROCESS_INIT
;
1100 const char *argv
[] = {
1104 "--ignore-submodules=none",
1107 struct strbuf buf
= STRBUF_INIT
;
1108 int ok_to_remove
= 1;
1110 if (!file_exists(path
) || is_empty_dir(path
))
1113 if (!submodule_uses_gitfile(path
))
1117 prepare_submodule_repo_env(&cp
.env_array
);
1122 if (start_command(&cp
))
1123 die("Could not run 'git status --porcelain -uall --ignore-submodules=none' in submodule %s", path
);
1125 len
= strbuf_read(&buf
, cp
.out
, 1024);
1130 if (finish_command(&cp
))
1131 die("'git status --porcelain -uall --ignore-submodules=none' failed in submodule %s", path
);
1133 strbuf_release(&buf
);
1134 return ok_to_remove
;
1137 static int find_first_merges(struct object_array
*result
, const char *path
,
1138 struct commit
*a
, struct commit
*b
)
1141 struct object_array merges
= OBJECT_ARRAY_INIT
;
1142 struct commit
*commit
;
1143 int contains_another
;
1145 char merged_revision
[42];
1146 const char *rev_args
[] = { "rev-list", "--merges", "--ancestry-path",
1147 "--all", merged_revision
, NULL
};
1148 struct rev_info revs
;
1149 struct setup_revision_opt rev_opts
;
1151 memset(result
, 0, sizeof(struct object_array
));
1152 memset(&rev_opts
, 0, sizeof(rev_opts
));
1154 /* get all revisions that merge commit a */
1155 snprintf(merged_revision
, sizeof(merged_revision
), "^%s",
1156 oid_to_hex(&a
->object
.oid
));
1157 init_revisions(&revs
, NULL
);
1158 rev_opts
.submodule
= path
;
1159 setup_revisions(ARRAY_SIZE(rev_args
)-1, rev_args
, &revs
, &rev_opts
);
1161 /* save all revisions from the above list that contain b */
1162 if (prepare_revision_walk(&revs
))
1163 die("revision walk setup failed");
1164 while ((commit
= get_revision(&revs
)) != NULL
) {
1165 struct object
*o
= &(commit
->object
);
1166 if (in_merge_bases(b
, commit
))
1167 add_object_array(o
, NULL
, &merges
);
1169 reset_revision_walk();
1171 /* Now we've got all merges that contain a and b. Prune all
1172 * merges that contain another found merge and save them in
1175 for (i
= 0; i
< merges
.nr
; i
++) {
1176 struct commit
*m1
= (struct commit
*) merges
.objects
[i
].item
;
1178 contains_another
= 0;
1179 for (j
= 0; j
< merges
.nr
; j
++) {
1180 struct commit
*m2
= (struct commit
*) merges
.objects
[j
].item
;
1181 if (i
!= j
&& in_merge_bases(m2
, m1
)) {
1182 contains_another
= 1;
1187 if (!contains_another
)
1188 add_object_array(merges
.objects
[i
].item
, NULL
, result
);
1191 free(merges
.objects
);
1195 static void print_commit(struct commit
*commit
)
1197 struct strbuf sb
= STRBUF_INIT
;
1198 struct pretty_print_context ctx
= {0};
1199 ctx
.date_mode
.type
= DATE_NORMAL
;
1200 format_commit_message(commit
, " %h: %m %s", &sb
, &ctx
);
1201 fprintf(stderr
, "%s\n", sb
.buf
);
1202 strbuf_release(&sb
);
1205 #define MERGE_WARNING(path, msg) \
1206 warning("Failed to merge submodule %s (%s)", path, msg);
1208 int merge_submodule(unsigned char result
[20], const char *path
,
1209 const unsigned char base
[20], const unsigned char a
[20],
1210 const unsigned char b
[20], int search
)
1212 struct commit
*commit_base
, *commit_a
, *commit_b
;
1214 struct object_array merges
;
1218 /* store a in result in case we fail */
1221 /* we can not handle deletion conflicts */
1222 if (is_null_sha1(base
))
1224 if (is_null_sha1(a
))
1226 if (is_null_sha1(b
))
1229 if (add_submodule_odb(path
)) {
1230 MERGE_WARNING(path
, "not checked out");
1234 if (!(commit_base
= lookup_commit_reference(base
)) ||
1235 !(commit_a
= lookup_commit_reference(a
)) ||
1236 !(commit_b
= lookup_commit_reference(b
))) {
1237 MERGE_WARNING(path
, "commits not present");
1241 /* check whether both changes are forward */
1242 if (!in_merge_bases(commit_base
, commit_a
) ||
1243 !in_merge_bases(commit_base
, commit_b
)) {
1244 MERGE_WARNING(path
, "commits don't follow merge-base");
1248 /* Case #1: a is contained in b or vice versa */
1249 if (in_merge_bases(commit_a
, commit_b
)) {
1253 if (in_merge_bases(commit_b
, commit_a
)) {
1259 * Case #2: There are one or more merges that contain a and b in
1260 * the submodule. If there is only one, then present it as a
1261 * suggestion to the user, but leave it marked unmerged so the
1262 * user needs to confirm the resolution.
1265 /* Skip the search if makes no sense to the calling context. */
1269 /* find commit which merges them */
1270 parent_count
= find_first_merges(&merges
, path
, commit_a
, commit_b
);
1271 switch (parent_count
) {
1273 MERGE_WARNING(path
, "merge following commits not found");
1277 MERGE_WARNING(path
, "not fast-forward");
1278 fprintf(stderr
, "Found a possible merge resolution "
1279 "for the submodule:\n");
1280 print_commit((struct commit
*) merges
.objects
[0].item
);
1282 "If this is correct simply add it to the index "
1285 " git update-index --cacheinfo 160000 %s \"%s\"\n\n"
1286 "which will accept this suggestion.\n",
1287 oid_to_hex(&merges
.objects
[0].item
->oid
), path
);
1291 MERGE_WARNING(path
, "multiple merges found");
1292 for (i
= 0; i
< merges
.nr
; i
++)
1293 print_commit((struct commit
*) merges
.objects
[i
].item
);
1296 free(merges
.objects
);
1300 /* Update gitfile and core.worktree setting to connect work tree and git dir */
1301 void connect_work_tree_and_git_dir(const char *work_tree
, const char *git_dir
)
1303 struct strbuf file_name
= STRBUF_INIT
;
1304 struct strbuf rel_path
= STRBUF_INIT
;
1305 const char *real_work_tree
= xstrdup(real_path(work_tree
));
1307 /* Update gitfile */
1308 strbuf_addf(&file_name
, "%s/.git", work_tree
);
1309 write_file(file_name
.buf
, "gitdir: %s",
1310 relative_path(git_dir
, real_work_tree
, &rel_path
));
1312 /* Update core.worktree setting */
1313 strbuf_reset(&file_name
);
1314 strbuf_addf(&file_name
, "%s/config", git_dir
);
1315 git_config_set_in_file(file_name
.buf
, "core.worktree",
1316 relative_path(real_work_tree
, git_dir
,
1319 strbuf_release(&file_name
);
1320 strbuf_release(&rel_path
);
1321 free((void *)real_work_tree
);
1324 int parallel_submodules(void)
1326 return parallel_jobs
;
1329 void prepare_submodule_repo_env(struct argv_array
*out
)
1331 const char * const *var
;
1333 for (var
= local_repo_env
; *var
; var
++) {
1334 if (strcmp(*var
, CONFIG_DATA_ENVIRONMENT
))
1335 argv_array_push(out
, *var
);
1337 argv_array_push(out
, "GIT_DIR=.git");