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"
19 static int config_fetch_recurse_submodules
= RECURSE_SUBMODULES_ON_DEMAND
;
20 static int config_update_recurse_submodules
= RECURSE_SUBMODULES_DEFAULT
;
21 static int parallel_jobs
= 1;
22 static struct string_list changed_submodule_paths
= STRING_LIST_INIT_NODUP
;
23 static int initialized_fetch_ref_tips
;
24 static struct sha1_array ref_tips_before_fetch
;
25 static struct sha1_array ref_tips_after_fetch
;
28 * The following flag is set if the .gitmodules file is unmerged. We then
29 * disable recursion for all submodules where .git/config doesn't have a
30 * matching config entry because we can't guess what might be configured in
31 * .gitmodules unless the user resolves the conflict. When a command line
32 * option is given (which always overrides configuration) this flag will be
35 static int gitmodules_is_unmerged
;
38 * This flag is set if the .gitmodules file had unstaged modifications on
39 * startup. This must be checked before allowing modifications to the
40 * .gitmodules file with the intention to stage them later, because when
41 * continuing we would stage the modifications the user didn't stage herself
42 * too. That might change in a future version when we learn to stage the
43 * changes we do ourselves without staging any previous modifications.
45 static int gitmodules_is_modified
;
47 int is_staging_gitmodules_ok(void)
49 return !gitmodules_is_modified
;
53 * Try to update the "path" entry in the "submodule.<name>" section of the
54 * .gitmodules file. Return 0 only if a .gitmodules file was found, a section
55 * with the correct path=<oldpath> setting was found and we could update it.
57 int update_path_in_gitmodules(const char *oldpath
, const char *newpath
)
59 struct strbuf entry
= STRBUF_INIT
;
60 const struct submodule
*submodule
;
62 if (!file_exists(".gitmodules")) /* Do nothing without .gitmodules */
65 if (gitmodules_is_unmerged
)
66 die(_("Cannot change unmerged .gitmodules, resolve merge conflicts first"));
68 submodule
= submodule_from_path(null_sha1
, oldpath
);
69 if (!submodule
|| !submodule
->name
) {
70 warning(_("Could not find section in .gitmodules where path=%s"), oldpath
);
73 strbuf_addstr(&entry
, "submodule.");
74 strbuf_addstr(&entry
, submodule
->name
);
75 strbuf_addstr(&entry
, ".path");
76 if (git_config_set_in_file_gently(".gitmodules", entry
.buf
, newpath
) < 0) {
77 /* Maybe the user already did that, don't error out here */
78 warning(_("Could not update .gitmodules entry %s"), entry
.buf
);
79 strbuf_release(&entry
);
82 strbuf_release(&entry
);
87 * Try to remove the "submodule.<name>" section from .gitmodules where the given
88 * path is configured. Return 0 only if a .gitmodules file was found, a section
89 * with the correct path=<path> setting was found and we could remove it.
91 int remove_path_from_gitmodules(const char *path
)
93 struct strbuf sect
= STRBUF_INIT
;
94 const struct submodule
*submodule
;
96 if (!file_exists(".gitmodules")) /* Do nothing without .gitmodules */
99 if (gitmodules_is_unmerged
)
100 die(_("Cannot change unmerged .gitmodules, resolve merge conflicts first"));
102 submodule
= submodule_from_path(null_sha1
, path
);
103 if (!submodule
|| !submodule
->name
) {
104 warning(_("Could not find section in .gitmodules where path=%s"), path
);
107 strbuf_addstr(§
, "submodule.");
108 strbuf_addstr(§
, submodule
->name
);
109 if (git_config_rename_section_in_file(".gitmodules", sect
.buf
, NULL
) < 0) {
110 /* Maybe the user already did that, don't error out here */
111 warning(_("Could not remove .gitmodules entry for %s"), path
);
112 strbuf_release(§
);
115 strbuf_release(§
);
119 void stage_updated_gitmodules(void)
121 if (add_file_to_cache(".gitmodules", 0))
122 die(_("staging updated .gitmodules failed"));
125 static int add_submodule_odb(const char *path
)
127 struct strbuf objects_directory
= STRBUF_INIT
;
130 ret
= strbuf_git_path_submodule(&objects_directory
, path
, "objects/");
133 if (!is_directory(objects_directory
.buf
)) {
137 add_to_alternates_memory(objects_directory
.buf
);
139 strbuf_release(&objects_directory
);
143 void set_diffopt_flags_from_submodule_config(struct diff_options
*diffopt
,
146 const struct submodule
*submodule
= submodule_from_path(null_sha1
, path
);
148 if (submodule
->ignore
)
149 handle_ignore_submodules_arg(diffopt
, submodule
->ignore
);
150 else if (gitmodules_is_unmerged
)
151 DIFF_OPT_SET(diffopt
, IGNORE_SUBMODULES
);
155 int submodule_config(const char *var
, const char *value
, void *cb
)
157 if (!strcmp(var
, "submodule.fetchjobs")) {
158 parallel_jobs
= git_config_int(var
, value
);
159 if (parallel_jobs
< 0)
160 die(_("negative values not allowed for submodule.fetchJobs"));
162 } else if (starts_with(var
, "submodule."))
163 return parse_submodule_config_option(var
, value
);
164 else if (!strcmp(var
, "fetch.recursesubmodules")) {
165 config_fetch_recurse_submodules
= parse_fetch_recurse_submodules_arg(var
, value
);
171 void gitmodules_config(void)
173 const char *work_tree
= get_git_work_tree();
175 struct strbuf gitmodules_path
= STRBUF_INIT
;
177 strbuf_addstr(&gitmodules_path
, work_tree
);
178 strbuf_addstr(&gitmodules_path
, "/.gitmodules");
179 if (read_cache() < 0)
180 die("index file corrupt");
181 pos
= cache_name_pos(".gitmodules", 11);
182 if (pos
< 0) { /* .gitmodules not found or isn't merged */
184 if (active_nr
> pos
) { /* there is a .gitmodules */
185 const struct cache_entry
*ce
= active_cache
[pos
];
186 if (ce_namelen(ce
) == 11 &&
187 !memcmp(ce
->name
, ".gitmodules", 11))
188 gitmodules_is_unmerged
= 1;
190 } else if (pos
< active_nr
) {
192 if (lstat(".gitmodules", &st
) == 0 &&
193 ce_match_stat(active_cache
[pos
], &st
, 0) & DATA_CHANGED
)
194 gitmodules_is_modified
= 1;
197 if (!gitmodules_is_unmerged
)
198 git_config_from_file(submodule_config
, gitmodules_path
.buf
, NULL
);
199 strbuf_release(&gitmodules_path
);
203 void gitmodules_config_sha1(const unsigned char *commit_sha1
)
205 struct strbuf rev
= STRBUF_INIT
;
206 unsigned char sha1
[20];
208 if (gitmodule_sha1_from_commit(commit_sha1
, sha1
, &rev
)) {
209 git_config_from_blob_sha1(submodule_config
, rev
.buf
,
212 strbuf_release(&rev
);
216 * Determine if a submodule has been initialized at a given 'path'
218 int is_submodule_initialized(const char *path
)
221 const struct submodule
*module
= NULL
;
223 module
= submodule_from_path(null_sha1
, path
);
226 char *key
= xstrfmt("submodule.%s.url", module
->name
);
229 ret
= !git_config_get_string(key
, &value
);
238 int is_submodule_populated_gently(const char *path
, int *return_error_code
)
241 char *gitdir
= xstrfmt("%s/.git", path
);
243 if (resolve_gitdir_gently(gitdir
, return_error_code
))
250 int parse_submodule_update_strategy(const char *value
,
251 struct submodule_update_strategy
*dst
)
253 free((void*)dst
->command
);
255 if (!strcmp(value
, "none"))
256 dst
->type
= SM_UPDATE_NONE
;
257 else if (!strcmp(value
, "checkout"))
258 dst
->type
= SM_UPDATE_CHECKOUT
;
259 else if (!strcmp(value
, "rebase"))
260 dst
->type
= SM_UPDATE_REBASE
;
261 else if (!strcmp(value
, "merge"))
262 dst
->type
= SM_UPDATE_MERGE
;
263 else if (skip_prefix(value
, "!", &value
)) {
264 dst
->type
= SM_UPDATE_COMMAND
;
265 dst
->command
= xstrdup(value
);
271 const char *submodule_strategy_to_string(const struct submodule_update_strategy
*s
)
273 struct strbuf sb
= STRBUF_INIT
;
275 case SM_UPDATE_CHECKOUT
:
277 case SM_UPDATE_MERGE
:
279 case SM_UPDATE_REBASE
:
283 case SM_UPDATE_UNSPECIFIED
:
285 case SM_UPDATE_COMMAND
:
286 strbuf_addf(&sb
, "!%s", s
->command
);
287 return strbuf_detach(&sb
, NULL
);
292 void handle_ignore_submodules_arg(struct diff_options
*diffopt
,
295 DIFF_OPT_CLR(diffopt
, IGNORE_SUBMODULES
);
296 DIFF_OPT_CLR(diffopt
, IGNORE_UNTRACKED_IN_SUBMODULES
);
297 DIFF_OPT_CLR(diffopt
, IGNORE_DIRTY_SUBMODULES
);
299 if (!strcmp(arg
, "all"))
300 DIFF_OPT_SET(diffopt
, IGNORE_SUBMODULES
);
301 else if (!strcmp(arg
, "untracked"))
302 DIFF_OPT_SET(diffopt
, IGNORE_UNTRACKED_IN_SUBMODULES
);
303 else if (!strcmp(arg
, "dirty"))
304 DIFF_OPT_SET(diffopt
, IGNORE_DIRTY_SUBMODULES
);
305 else if (strcmp(arg
, "none"))
306 die("bad --ignore-submodules argument: %s", arg
);
309 static int prepare_submodule_summary(struct rev_info
*rev
, const char *path
,
310 struct commit
*left
, struct commit
*right
,
311 struct commit_list
*merge_bases
)
313 struct commit_list
*list
;
315 init_revisions(rev
, NULL
);
316 setup_revisions(0, NULL
, rev
, NULL
);
318 rev
->first_parent_only
= 1;
319 left
->object
.flags
|= SYMMETRIC_LEFT
;
320 add_pending_object(rev
, &left
->object
, path
);
321 add_pending_object(rev
, &right
->object
, path
);
322 for (list
= merge_bases
; list
; list
= list
->next
) {
323 list
->item
->object
.flags
|= UNINTERESTING
;
324 add_pending_object(rev
, &list
->item
->object
,
325 oid_to_hex(&list
->item
->object
.oid
));
327 return prepare_revision_walk(rev
);
330 static void print_submodule_summary(struct rev_info
*rev
, FILE *f
,
331 const char *line_prefix
,
332 const char *del
, const char *add
, const char *reset
)
334 static const char format
[] = " %m %s";
335 struct strbuf sb
= STRBUF_INIT
;
336 struct commit
*commit
;
338 while ((commit
= get_revision(rev
))) {
339 struct pretty_print_context ctx
= {0};
340 ctx
.date_mode
= rev
->date_mode
;
341 ctx
.output_encoding
= get_log_output_encoding();
342 strbuf_setlen(&sb
, 0);
343 strbuf_addstr(&sb
, line_prefix
);
344 if (commit
->object
.flags
& SYMMETRIC_LEFT
) {
346 strbuf_addstr(&sb
, del
);
349 strbuf_addstr(&sb
, add
);
350 format_commit_message(commit
, format
, &sb
, &ctx
);
352 strbuf_addstr(&sb
, reset
);
353 strbuf_addch(&sb
, '\n');
354 fprintf(f
, "%s", sb
.buf
);
359 /* Helper function to display the submodule header line prior to the full
360 * summary output. If it can locate the submodule objects directory it will
361 * attempt to lookup both the left and right commits and put them into the
362 * left and right pointers.
364 static void show_submodule_header(FILE *f
, const char *path
,
365 const char *line_prefix
,
366 struct object_id
*one
, struct object_id
*two
,
367 unsigned dirty_submodule
, const char *meta
,
369 struct commit
**left
, struct commit
**right
,
370 struct commit_list
**merge_bases
)
372 const char *message
= NULL
;
373 struct strbuf sb
= STRBUF_INIT
;
374 int fast_forward
= 0, fast_backward
= 0;
376 if (dirty_submodule
& DIRTY_SUBMODULE_UNTRACKED
)
377 fprintf(f
, "%sSubmodule %s contains untracked content\n",
379 if (dirty_submodule
& DIRTY_SUBMODULE_MODIFIED
)
380 fprintf(f
, "%sSubmodule %s contains modified content\n",
383 if (is_null_oid(one
))
384 message
= "(new submodule)";
385 else if (is_null_oid(two
))
386 message
= "(submodule deleted)";
388 if (add_submodule_odb(path
)) {
390 message
= "(not initialized)";
395 * Attempt to lookup the commit references, and determine if this is
396 * a fast forward or fast backwards update.
398 *left
= lookup_commit_reference(one
->hash
);
399 *right
= lookup_commit_reference(two
->hash
);
402 * Warn about missing commits in the submodule project, but only if
405 if ((!is_null_oid(one
) && !*left
) ||
406 (!is_null_oid(two
) && !*right
))
407 message
= "(commits not present)";
409 *merge_bases
= get_merge_bases(*left
, *right
);
411 if ((*merge_bases
)->item
== *left
)
413 else if ((*merge_bases
)->item
== *right
)
417 if (!oidcmp(one
, two
)) {
423 strbuf_addf(&sb
, "%s%sSubmodule %s ", line_prefix
, meta
, path
);
424 strbuf_add_unique_abbrev(&sb
, one
->hash
, DEFAULT_ABBREV
);
425 strbuf_addstr(&sb
, (fast_backward
|| fast_forward
) ? ".." : "...");
426 strbuf_add_unique_abbrev(&sb
, two
->hash
, DEFAULT_ABBREV
);
428 strbuf_addf(&sb
, " %s%s\n", message
, reset
);
430 strbuf_addf(&sb
, "%s:%s\n", fast_backward
? " (rewind)" : "", reset
);
431 fwrite(sb
.buf
, sb
.len
, 1, f
);
436 void show_submodule_summary(FILE *f
, const char *path
,
437 const char *line_prefix
,
438 struct object_id
*one
, struct object_id
*two
,
439 unsigned dirty_submodule
, const char *meta
,
440 const char *del
, const char *add
, const char *reset
)
443 struct commit
*left
= NULL
, *right
= NULL
;
444 struct commit_list
*merge_bases
= NULL
;
446 show_submodule_header(f
, path
, line_prefix
, one
, two
, dirty_submodule
,
447 meta
, reset
, &left
, &right
, &merge_bases
);
450 * If we don't have both a left and a right pointer, there is no
451 * reason to try and display a summary. The header line should contain
452 * all the information the user needs.
457 /* Treat revision walker failure the same as missing commits */
458 if (prepare_submodule_summary(&rev
, path
, left
, right
, merge_bases
)) {
459 fprintf(f
, "%s(revision walker failed)\n", line_prefix
);
463 print_submodule_summary(&rev
, f
, line_prefix
, del
, add
, reset
);
467 free_commit_list(merge_bases
);
468 clear_commit_marks(left
, ~0);
469 clear_commit_marks(right
, ~0);
472 void show_submodule_inline_diff(FILE *f
, const char *path
,
473 const char *line_prefix
,
474 struct object_id
*one
, struct object_id
*two
,
475 unsigned dirty_submodule
, const char *meta
,
476 const char *del
, const char *add
, const char *reset
,
477 const struct diff_options
*o
)
479 const struct object_id
*old
= &empty_tree_oid
, *new = &empty_tree_oid
;
480 struct commit
*left
= NULL
, *right
= NULL
;
481 struct commit_list
*merge_bases
= NULL
;
482 struct strbuf submodule_dir
= STRBUF_INIT
;
483 struct child_process cp
= CHILD_PROCESS_INIT
;
485 show_submodule_header(f
, path
, line_prefix
, one
, two
, dirty_submodule
,
486 meta
, reset
, &left
, &right
, &merge_bases
);
488 /* We need a valid left and right commit to display a difference */
489 if (!(left
|| is_null_oid(one
)) ||
490 !(right
|| is_null_oid(two
)))
501 cp
.out
= dup(fileno(f
));
504 /* TODO: other options may need to be passed here. */
505 argv_array_push(&cp
.args
, "diff");
506 argv_array_pushf(&cp
.args
, "--line-prefix=%s", line_prefix
);
507 if (DIFF_OPT_TST(o
, REVERSE_DIFF
)) {
508 argv_array_pushf(&cp
.args
, "--src-prefix=%s%s/",
510 argv_array_pushf(&cp
.args
, "--dst-prefix=%s%s/",
513 argv_array_pushf(&cp
.args
, "--src-prefix=%s%s/",
515 argv_array_pushf(&cp
.args
, "--dst-prefix=%s%s/",
518 argv_array_push(&cp
.args
, oid_to_hex(old
));
520 * If the submodule has modified content, we will diff against the
521 * work tree, under the assumption that the user has asked for the
522 * diff format and wishes to actually see all differences even if they
523 * haven't yet been committed to the submodule yet.
525 if (!(dirty_submodule
& DIRTY_SUBMODULE_MODIFIED
))
526 argv_array_push(&cp
.args
, oid_to_hex(new));
528 if (run_command(&cp
))
529 fprintf(f
, "(diff failed)\n");
532 strbuf_release(&submodule_dir
);
534 free_commit_list(merge_bases
);
536 clear_commit_marks(left
, ~0);
538 clear_commit_marks(right
, ~0);
541 void set_config_fetch_recurse_submodules(int value
)
543 config_fetch_recurse_submodules
= value
;
546 void set_config_update_recurse_submodules(int value
)
548 config_update_recurse_submodules
= value
;
551 static int has_remote(const char *refname
, const struct object_id
*oid
,
552 int flags
, void *cb_data
)
557 static int append_sha1_to_argv(const unsigned char sha1
[20], void *data
)
559 struct argv_array
*argv
= data
;
560 argv_array_push(argv
, sha1_to_hex(sha1
));
564 static int check_has_commit(const unsigned char sha1
[20], void *data
)
566 int *has_commit
= data
;
568 if (!lookup_commit_reference(sha1
))
574 static int submodule_has_commits(const char *path
, struct sha1_array
*commits
)
578 if (add_submodule_odb(path
))
581 sha1_array_for_each_unique(commits
, check_has_commit
, &has_commit
);
585 static int submodule_needs_pushing(const char *path
, struct sha1_array
*commits
)
587 if (!submodule_has_commits(path
, commits
))
589 * NOTE: We do consider it safe to return "no" here. The
590 * correct answer would be "We do not know" instead of
591 * "No push needed", but it is quite hard to change
592 * the submodule pointer without having the submodule
593 * around. If a user did however change the submodules
594 * without having the submodule around, this indicates
595 * an expert who knows what they are doing or a
596 * maintainer integrating work from other people. In
597 * both cases it should be safe to skip this check.
601 if (for_each_remote_ref_submodule(path
, has_remote
, NULL
) > 0) {
602 struct child_process cp
= CHILD_PROCESS_INIT
;
603 struct strbuf buf
= STRBUF_INIT
;
604 int needs_pushing
= 0;
606 argv_array_push(&cp
.args
, "rev-list");
607 sha1_array_for_each_unique(commits
, append_sha1_to_argv
, &cp
.args
);
608 argv_array_pushl(&cp
.args
, "--not", "--remotes", "-n", "1" , NULL
);
610 prepare_submodule_repo_env(&cp
.env_array
);
615 if (start_command(&cp
))
616 die("Could not run 'git rev-list <commits> --not --remotes -n 1' command in submodule %s",
618 if (strbuf_read(&buf
, cp
.out
, 41))
622 strbuf_release(&buf
);
623 return needs_pushing
;
629 static struct sha1_array
*submodule_commits(struct string_list
*submodules
,
632 struct string_list_item
*item
;
634 item
= string_list_insert(submodules
, path
);
636 return (struct sha1_array
*) item
->util
;
638 /* NEEDSWORK: should we have sha1_array_init()? */
639 item
->util
= xcalloc(1, sizeof(struct sha1_array
));
640 return (struct sha1_array
*) item
->util
;
643 static void collect_submodules_from_diff(struct diff_queue_struct
*q
,
644 struct diff_options
*options
,
648 struct string_list
*submodules
= data
;
650 for (i
= 0; i
< q
->nr
; i
++) {
651 struct diff_filepair
*p
= q
->queue
[i
];
652 struct sha1_array
*commits
;
653 if (!S_ISGITLINK(p
->two
->mode
))
655 commits
= submodule_commits(submodules
, p
->two
->path
);
656 sha1_array_append(commits
, p
->two
->oid
.hash
);
660 static void find_unpushed_submodule_commits(struct commit
*commit
,
661 struct string_list
*needs_pushing
)
665 init_revisions(&rev
, NULL
);
666 rev
.diffopt
.output_format
|= DIFF_FORMAT_CALLBACK
;
667 rev
.diffopt
.format_callback
= collect_submodules_from_diff
;
668 rev
.diffopt
.format_callback_data
= needs_pushing
;
669 diff_tree_combined_merge(commit
, 1, &rev
);
672 static void free_submodules_sha1s(struct string_list
*submodules
)
674 struct string_list_item
*item
;
675 for_each_string_list_item(item
, submodules
)
676 sha1_array_clear((struct sha1_array
*) item
->util
);
677 string_list_clear(submodules
, 1);
680 int find_unpushed_submodules(struct sha1_array
*commits
,
681 const char *remotes_name
, struct string_list
*needs_pushing
)
684 struct commit
*commit
;
685 struct string_list submodules
= STRING_LIST_INIT_DUP
;
686 struct string_list_item
*submodule
;
687 struct argv_array argv
= ARGV_ARRAY_INIT
;
689 init_revisions(&rev
, NULL
);
691 /* argv.argv[0] will be ignored by setup_revisions */
692 argv_array_push(&argv
, "find_unpushed_submodules");
693 sha1_array_for_each_unique(commits
, append_sha1_to_argv
, &argv
);
694 argv_array_push(&argv
, "--not");
695 argv_array_pushf(&argv
, "--remotes=%s", remotes_name
);
697 setup_revisions(argv
.argc
, argv
.argv
, &rev
, NULL
);
698 if (prepare_revision_walk(&rev
))
699 die("revision walk setup failed");
701 while ((commit
= get_revision(&rev
)) != NULL
)
702 find_unpushed_submodule_commits(commit
, &submodules
);
704 reset_revision_walk();
705 argv_array_clear(&argv
);
707 for_each_string_list_item(submodule
, &submodules
) {
708 struct sha1_array
*commits
= (struct sha1_array
*) submodule
->util
;
710 if (submodule_needs_pushing(submodule
->string
, commits
))
711 string_list_insert(needs_pushing
, submodule
->string
);
713 free_submodules_sha1s(&submodules
);
715 return needs_pushing
->nr
;
718 static int push_submodule(const char *path
, int dry_run
)
720 if (add_submodule_odb(path
))
723 if (for_each_remote_ref_submodule(path
, has_remote
, NULL
) > 0) {
724 struct child_process cp
= CHILD_PROCESS_INIT
;
725 argv_array_push(&cp
.args
, "push");
727 argv_array_push(&cp
.args
, "--dry-run");
729 prepare_submodule_repo_env(&cp
.env_array
);
733 if (run_command(&cp
))
741 int push_unpushed_submodules(struct sha1_array
*commits
,
742 const char *remotes_name
,
746 struct string_list needs_pushing
= STRING_LIST_INIT_DUP
;
748 if (!find_unpushed_submodules(commits
, remotes_name
, &needs_pushing
))
751 for (i
= 0; i
< needs_pushing
.nr
; i
++) {
752 const char *path
= needs_pushing
.items
[i
].string
;
753 fprintf(stderr
, "Pushing submodule '%s'\n", path
);
754 if (!push_submodule(path
, dry_run
)) {
755 fprintf(stderr
, "Unable to push submodule '%s'\n", path
);
760 string_list_clear(&needs_pushing
, 0);
765 static int is_submodule_commit_present(const char *path
, unsigned char sha1
[20])
768 if (!add_submodule_odb(path
) && lookup_commit_reference(sha1
)) {
769 /* Even if the submodule is checked out and the commit is
770 * present, make sure it is reachable from a ref. */
771 struct child_process cp
= CHILD_PROCESS_INIT
;
772 const char *argv
[] = {"rev-list", "-n", "1", NULL
, "--not", "--all", NULL
};
773 struct strbuf buf
= STRBUF_INIT
;
775 argv
[3] = sha1_to_hex(sha1
);
777 prepare_submodule_repo_env(&cp
.env_array
);
781 if (!capture_command(&cp
, &buf
, 1024) && !buf
.len
)
784 strbuf_release(&buf
);
789 static void submodule_collect_changed_cb(struct diff_queue_struct
*q
,
790 struct diff_options
*options
,
794 for (i
= 0; i
< q
->nr
; i
++) {
795 struct diff_filepair
*p
= q
->queue
[i
];
796 if (!S_ISGITLINK(p
->two
->mode
))
799 if (S_ISGITLINK(p
->one
->mode
)) {
800 /* NEEDSWORK: We should honor the name configured in
801 * the .gitmodules file of the commit we are examining
802 * here to be able to correctly follow submodules
803 * being moved around. */
804 struct string_list_item
*path
;
805 path
= unsorted_string_list_lookup(&changed_submodule_paths
, p
->two
->path
);
806 if (!path
&& !is_submodule_commit_present(p
->two
->path
, p
->two
->oid
.hash
))
807 string_list_append(&changed_submodule_paths
, xstrdup(p
->two
->path
));
809 /* Submodule is new or was moved here */
810 /* NEEDSWORK: When the .git directories of submodules
811 * live inside the superprojects .git directory some
812 * day we should fetch new submodules directly into
813 * that location too when config or options request
814 * that so they can be checked out from there. */
820 static int add_sha1_to_array(const char *ref
, const struct object_id
*oid
,
821 int flags
, void *data
)
823 sha1_array_append(data
, oid
->hash
);
827 void check_for_new_submodule_commits(unsigned char new_sha1
[20])
829 if (!initialized_fetch_ref_tips
) {
830 for_each_ref(add_sha1_to_array
, &ref_tips_before_fetch
);
831 initialized_fetch_ref_tips
= 1;
834 sha1_array_append(&ref_tips_after_fetch
, new_sha1
);
837 static int add_sha1_to_argv(const unsigned char sha1
[20], void *data
)
839 argv_array_push(data
, sha1_to_hex(sha1
));
843 static void calculate_changed_submodule_paths(void)
846 struct commit
*commit
;
847 struct argv_array argv
= ARGV_ARRAY_INIT
;
849 /* No need to check if there are no submodules configured */
850 if (!submodule_from_path(NULL
, NULL
))
853 init_revisions(&rev
, NULL
);
854 argv_array_push(&argv
, "--"); /* argv[0] program name */
855 sha1_array_for_each_unique(&ref_tips_after_fetch
,
856 add_sha1_to_argv
, &argv
);
857 argv_array_push(&argv
, "--not");
858 sha1_array_for_each_unique(&ref_tips_before_fetch
,
859 add_sha1_to_argv
, &argv
);
860 setup_revisions(argv
.argc
, argv
.argv
, &rev
, NULL
);
861 if (prepare_revision_walk(&rev
))
862 die("revision walk setup failed");
865 * Collect all submodules (whether checked out or not) for which new
866 * commits have been recorded upstream in "changed_submodule_paths".
868 while ((commit
= get_revision(&rev
))) {
869 struct commit_list
*parent
= commit
->parents
;
871 struct diff_options diff_opts
;
872 diff_setup(&diff_opts
);
873 DIFF_OPT_SET(&diff_opts
, RECURSIVE
);
874 diff_opts
.output_format
|= DIFF_FORMAT_CALLBACK
;
875 diff_opts
.format_callback
= submodule_collect_changed_cb
;
876 diff_setup_done(&diff_opts
);
877 diff_tree_sha1(parent
->item
->object
.oid
.hash
, commit
->object
.oid
.hash
, "", &diff_opts
);
878 diffcore_std(&diff_opts
);
879 diff_flush(&diff_opts
);
880 parent
= parent
->next
;
884 argv_array_clear(&argv
);
885 sha1_array_clear(&ref_tips_before_fetch
);
886 sha1_array_clear(&ref_tips_after_fetch
);
887 initialized_fetch_ref_tips
= 0;
890 struct submodule_parallel_fetch
{
892 struct argv_array args
;
893 const char *work_tree
;
895 int command_line_option
;
899 #define SPF_INIT {0, ARGV_ARRAY_INIT, NULL, NULL, 0, 0, 0}
901 static int get_next_submodule(struct child_process
*cp
,
902 struct strbuf
*err
, void *data
, void **task_cb
)
905 struct submodule_parallel_fetch
*spf
= data
;
907 for (; spf
->count
< active_nr
; spf
->count
++) {
908 struct strbuf submodule_path
= STRBUF_INIT
;
909 struct strbuf submodule_git_dir
= STRBUF_INIT
;
910 struct strbuf submodule_prefix
= STRBUF_INIT
;
911 const struct cache_entry
*ce
= active_cache
[spf
->count
];
912 const char *git_dir
, *default_argv
;
913 const struct submodule
*submodule
;
915 if (!S_ISGITLINK(ce
->ce_mode
))
918 submodule
= submodule_from_path(null_sha1
, ce
->name
);
920 submodule
= submodule_from_name(null_sha1
, ce
->name
);
922 default_argv
= "yes";
923 if (spf
->command_line_option
== RECURSE_SUBMODULES_DEFAULT
) {
925 submodule
->fetch_recurse
!=
926 RECURSE_SUBMODULES_NONE
) {
927 if (submodule
->fetch_recurse
==
928 RECURSE_SUBMODULES_OFF
)
930 if (submodule
->fetch_recurse
==
931 RECURSE_SUBMODULES_ON_DEMAND
) {
932 if (!unsorted_string_list_lookup(&changed_submodule_paths
, ce
->name
))
934 default_argv
= "on-demand";
937 if ((config_fetch_recurse_submodules
== RECURSE_SUBMODULES_OFF
) ||
938 gitmodules_is_unmerged
)
940 if (config_fetch_recurse_submodules
== RECURSE_SUBMODULES_ON_DEMAND
) {
941 if (!unsorted_string_list_lookup(&changed_submodule_paths
, ce
->name
))
943 default_argv
= "on-demand";
946 } else if (spf
->command_line_option
== RECURSE_SUBMODULES_ON_DEMAND
) {
947 if (!unsorted_string_list_lookup(&changed_submodule_paths
, ce
->name
))
949 default_argv
= "on-demand";
952 strbuf_addf(&submodule_path
, "%s/%s", spf
->work_tree
, ce
->name
);
953 strbuf_addf(&submodule_git_dir
, "%s/.git", submodule_path
.buf
);
954 strbuf_addf(&submodule_prefix
, "%s%s/", spf
->prefix
, ce
->name
);
955 git_dir
= read_gitfile(submodule_git_dir
.buf
);
957 git_dir
= submodule_git_dir
.buf
;
958 if (is_directory(git_dir
)) {
959 child_process_init(cp
);
960 cp
->dir
= strbuf_detach(&submodule_path
, NULL
);
961 prepare_submodule_repo_env(&cp
->env_array
);
964 strbuf_addf(err
, "Fetching submodule %s%s\n",
965 spf
->prefix
, ce
->name
);
966 argv_array_init(&cp
->args
);
967 argv_array_pushv(&cp
->args
, spf
->args
.argv
);
968 argv_array_push(&cp
->args
, default_argv
);
969 argv_array_push(&cp
->args
, "--submodule-prefix");
970 argv_array_push(&cp
->args
, submodule_prefix
.buf
);
973 strbuf_release(&submodule_path
);
974 strbuf_release(&submodule_git_dir
);
975 strbuf_release(&submodule_prefix
);
984 static int fetch_start_failure(struct strbuf
*err
,
985 void *cb
, void *task_cb
)
987 struct submodule_parallel_fetch
*spf
= cb
;
994 static int fetch_finish(int retvalue
, struct strbuf
*err
,
995 void *cb
, void *task_cb
)
997 struct submodule_parallel_fetch
*spf
= cb
;
1005 int fetch_populated_submodules(const struct argv_array
*options
,
1006 const char *prefix
, int command_line_option
,
1007 int quiet
, int max_parallel_jobs
)
1010 struct submodule_parallel_fetch spf
= SPF_INIT
;
1012 spf
.work_tree
= get_git_work_tree();
1013 spf
.command_line_option
= command_line_option
;
1015 spf
.prefix
= prefix
;
1020 if (read_cache() < 0)
1021 die("index file corrupt");
1023 argv_array_push(&spf
.args
, "fetch");
1024 for (i
= 0; i
< options
->argc
; i
++)
1025 argv_array_push(&spf
.args
, options
->argv
[i
]);
1026 argv_array_push(&spf
.args
, "--recurse-submodules-default");
1027 /* default value, "--submodule-prefix" and its value are added later */
1029 if (max_parallel_jobs
< 0)
1030 max_parallel_jobs
= parallel_jobs
;
1032 calculate_changed_submodule_paths();
1033 run_processes_parallel(max_parallel_jobs
,
1035 fetch_start_failure
,
1039 argv_array_clear(&spf
.args
);
1041 string_list_clear(&changed_submodule_paths
, 1);
1045 unsigned is_submodule_modified(const char *path
, int ignore_untracked
)
1048 struct child_process cp
= CHILD_PROCESS_INIT
;
1049 const char *argv
[] = {
1055 struct strbuf buf
= STRBUF_INIT
;
1056 unsigned dirty_submodule
= 0;
1057 const char *line
, *next_line
;
1058 const char *git_dir
;
1060 strbuf_addf(&buf
, "%s/.git", path
);
1061 git_dir
= read_gitfile(buf
.buf
);
1064 if (!is_directory(git_dir
)) {
1065 strbuf_release(&buf
);
1066 /* The submodule is not checked out, so it is not modified */
1072 if (ignore_untracked
)
1076 prepare_submodule_repo_env(&cp
.env_array
);
1081 if (start_command(&cp
))
1082 die("Could not run 'git status --porcelain' in submodule %s", path
);
1084 len
= strbuf_read(&buf
, cp
.out
, 1024);
1087 if ((line
[0] == '?') && (line
[1] == '?')) {
1088 dirty_submodule
|= DIRTY_SUBMODULE_UNTRACKED
;
1089 if (dirty_submodule
& DIRTY_SUBMODULE_MODIFIED
)
1092 dirty_submodule
|= DIRTY_SUBMODULE_MODIFIED
;
1093 if (ignore_untracked
||
1094 (dirty_submodule
& DIRTY_SUBMODULE_UNTRACKED
))
1097 next_line
= strchr(line
, '\n');
1101 len
-= (next_line
- line
);
1106 if (finish_command(&cp
))
1107 die("'git status --porcelain' failed in submodule %s", path
);
1109 strbuf_release(&buf
);
1110 return dirty_submodule
;
1113 int submodule_uses_gitfile(const char *path
)
1115 struct child_process cp
= CHILD_PROCESS_INIT
;
1116 const char *argv
[] = {
1124 struct strbuf buf
= STRBUF_INIT
;
1125 const char *git_dir
;
1127 strbuf_addf(&buf
, "%s/.git", path
);
1128 git_dir
= read_gitfile(buf
.buf
);
1130 strbuf_release(&buf
);
1133 strbuf_release(&buf
);
1135 /* Now test that all nested submodules use a gitfile too */
1137 prepare_submodule_repo_env(&cp
.env_array
);
1143 if (run_command(&cp
))
1150 * Check if it is a bad idea to remove a submodule, i.e. if we'd lose data
1153 * Return 1 if we'd lose data, return 0 if the removal is fine,
1154 * and negative values for errors.
1156 int bad_to_remove_submodule(const char *path
, unsigned flags
)
1159 struct child_process cp
= CHILD_PROCESS_INIT
;
1160 struct strbuf buf
= STRBUF_INIT
;
1163 if (!file_exists(path
) || is_empty_dir(path
))
1166 if (!submodule_uses_gitfile(path
))
1169 argv_array_pushl(&cp
.args
, "status", "--porcelain",
1170 "--ignore-submodules=none", NULL
);
1172 if (flags
& SUBMODULE_REMOVAL_IGNORE_UNTRACKED
)
1173 argv_array_push(&cp
.args
, "-uno");
1175 argv_array_push(&cp
.args
, "-uall");
1177 if (!(flags
& SUBMODULE_REMOVAL_IGNORE_IGNORED_UNTRACKED
))
1178 argv_array_push(&cp
.args
, "--ignored");
1180 prepare_submodule_repo_env(&cp
.env_array
);
1185 if (start_command(&cp
)) {
1186 if (flags
& SUBMODULE_REMOVAL_DIE_ON_ERROR
)
1187 die(_("could not start 'git status in submodule '%s'"),
1193 len
= strbuf_read(&buf
, cp
.out
, 1024);
1198 if (finish_command(&cp
)) {
1199 if (flags
& SUBMODULE_REMOVAL_DIE_ON_ERROR
)
1200 die(_("could not run 'git status in submodule '%s'"),
1205 strbuf_release(&buf
);
1209 static int find_first_merges(struct object_array
*result
, const char *path
,
1210 struct commit
*a
, struct commit
*b
)
1213 struct object_array merges
= OBJECT_ARRAY_INIT
;
1214 struct commit
*commit
;
1215 int contains_another
;
1217 char merged_revision
[42];
1218 const char *rev_args
[] = { "rev-list", "--merges", "--ancestry-path",
1219 "--all", merged_revision
, NULL
};
1220 struct rev_info revs
;
1221 struct setup_revision_opt rev_opts
;
1223 memset(result
, 0, sizeof(struct object_array
));
1224 memset(&rev_opts
, 0, sizeof(rev_opts
));
1226 /* get all revisions that merge commit a */
1227 snprintf(merged_revision
, sizeof(merged_revision
), "^%s",
1228 oid_to_hex(&a
->object
.oid
));
1229 init_revisions(&revs
, NULL
);
1230 rev_opts
.submodule
= path
;
1231 setup_revisions(ARRAY_SIZE(rev_args
)-1, rev_args
, &revs
, &rev_opts
);
1233 /* save all revisions from the above list that contain b */
1234 if (prepare_revision_walk(&revs
))
1235 die("revision walk setup failed");
1236 while ((commit
= get_revision(&revs
)) != NULL
) {
1237 struct object
*o
= &(commit
->object
);
1238 if (in_merge_bases(b
, commit
))
1239 add_object_array(o
, NULL
, &merges
);
1241 reset_revision_walk();
1243 /* Now we've got all merges that contain a and b. Prune all
1244 * merges that contain another found merge and save them in
1247 for (i
= 0; i
< merges
.nr
; i
++) {
1248 struct commit
*m1
= (struct commit
*) merges
.objects
[i
].item
;
1250 contains_another
= 0;
1251 for (j
= 0; j
< merges
.nr
; j
++) {
1252 struct commit
*m2
= (struct commit
*) merges
.objects
[j
].item
;
1253 if (i
!= j
&& in_merge_bases(m2
, m1
)) {
1254 contains_another
= 1;
1259 if (!contains_another
)
1260 add_object_array(merges
.objects
[i
].item
, NULL
, result
);
1263 free(merges
.objects
);
1267 static void print_commit(struct commit
*commit
)
1269 struct strbuf sb
= STRBUF_INIT
;
1270 struct pretty_print_context ctx
= {0};
1271 ctx
.date_mode
.type
= DATE_NORMAL
;
1272 format_commit_message(commit
, " %h: %m %s", &sb
, &ctx
);
1273 fprintf(stderr
, "%s\n", sb
.buf
);
1274 strbuf_release(&sb
);
1277 #define MERGE_WARNING(path, msg) \
1278 warning("Failed to merge submodule %s (%s)", path, msg);
1280 int merge_submodule(unsigned char result
[20], const char *path
,
1281 const unsigned char base
[20], const unsigned char a
[20],
1282 const unsigned char b
[20], int search
)
1284 struct commit
*commit_base
, *commit_a
, *commit_b
;
1286 struct object_array merges
;
1290 /* store a in result in case we fail */
1293 /* we can not handle deletion conflicts */
1294 if (is_null_sha1(base
))
1296 if (is_null_sha1(a
))
1298 if (is_null_sha1(b
))
1301 if (add_submodule_odb(path
)) {
1302 MERGE_WARNING(path
, "not checked out");
1306 if (!(commit_base
= lookup_commit_reference(base
)) ||
1307 !(commit_a
= lookup_commit_reference(a
)) ||
1308 !(commit_b
= lookup_commit_reference(b
))) {
1309 MERGE_WARNING(path
, "commits not present");
1313 /* check whether both changes are forward */
1314 if (!in_merge_bases(commit_base
, commit_a
) ||
1315 !in_merge_bases(commit_base
, commit_b
)) {
1316 MERGE_WARNING(path
, "commits don't follow merge-base");
1320 /* Case #1: a is contained in b or vice versa */
1321 if (in_merge_bases(commit_a
, commit_b
)) {
1325 if (in_merge_bases(commit_b
, commit_a
)) {
1331 * Case #2: There are one or more merges that contain a and b in
1332 * the submodule. If there is only one, then present it as a
1333 * suggestion to the user, but leave it marked unmerged so the
1334 * user needs to confirm the resolution.
1337 /* Skip the search if makes no sense to the calling context. */
1341 /* find commit which merges them */
1342 parent_count
= find_first_merges(&merges
, path
, commit_a
, commit_b
);
1343 switch (parent_count
) {
1345 MERGE_WARNING(path
, "merge following commits not found");
1349 MERGE_WARNING(path
, "not fast-forward");
1350 fprintf(stderr
, "Found a possible merge resolution "
1351 "for the submodule:\n");
1352 print_commit((struct commit
*) merges
.objects
[0].item
);
1354 "If this is correct simply add it to the index "
1357 " git update-index --cacheinfo 160000 %s \"%s\"\n\n"
1358 "which will accept this suggestion.\n",
1359 oid_to_hex(&merges
.objects
[0].item
->oid
), path
);
1363 MERGE_WARNING(path
, "multiple merges found");
1364 for (i
= 0; i
< merges
.nr
; i
++)
1365 print_commit((struct commit
*) merges
.objects
[i
].item
);
1368 free(merges
.objects
);
1372 int parallel_submodules(void)
1374 return parallel_jobs
;
1377 void prepare_submodule_repo_env(struct argv_array
*out
)
1379 const char * const *var
;
1381 for (var
= local_repo_env
; *var
; var
++) {
1382 if (strcmp(*var
, CONFIG_DATA_ENVIRONMENT
))
1383 argv_array_push(out
, *var
);
1385 argv_array_pushf(out
, "%s=%s", GIT_DIR_ENVIRONMENT
,
1386 DEFAULT_GIT_DIR_ENVIRONMENT
);
1390 * Embeds a single submodules git directory into the superprojects git dir,
1393 static void relocate_single_git_dir_into_superproject(const char *prefix
,
1396 char *old_git_dir
= NULL
, *real_old_git_dir
= NULL
, *real_new_git_dir
= NULL
;
1397 const char *new_git_dir
;
1398 const struct submodule
*sub
;
1400 if (submodule_uses_worktrees(path
))
1401 die(_("relocate_gitdir for submodule '%s' with "
1402 "more than one worktree not supported"), path
);
1404 old_git_dir
= xstrfmt("%s/.git", path
);
1405 if (read_gitfile(old_git_dir
))
1406 /* If it is an actual gitfile, it doesn't need migration. */
1409 real_old_git_dir
= real_pathdup(old_git_dir
);
1411 sub
= submodule_from_path(null_sha1
, path
);
1413 die(_("could not lookup name for submodule '%s'"), path
);
1415 new_git_dir
= git_path("modules/%s", sub
->name
);
1416 if (safe_create_leading_directories_const(new_git_dir
) < 0)
1417 die(_("could not create directory '%s'"), new_git_dir
);
1418 real_new_git_dir
= real_pathdup(new_git_dir
);
1421 prefix
= get_super_prefix();
1423 fprintf(stderr
, _("Migrating git directory of '%s%s' from\n'%s' to\n'%s'\n"),
1424 prefix
? prefix
: "", path
,
1425 real_old_git_dir
, real_new_git_dir
);
1427 relocate_gitdir(path
, real_old_git_dir
, real_new_git_dir
);
1430 free(real_old_git_dir
);
1431 free(real_new_git_dir
);
1435 * Migrate the git directory of the submodule given by path from
1436 * having its git directory within the working tree to the git dir nested
1437 * in its superprojects git dir under modules/.
1439 void absorb_git_dir_into_superproject(const char *prefix
,
1444 const char *sub_git_dir
;
1445 struct strbuf gitdir
= STRBUF_INIT
;
1446 strbuf_addf(&gitdir
, "%s/.git", path
);
1447 sub_git_dir
= resolve_gitdir_gently(gitdir
.buf
, &err_code
);
1449 /* Not populated? */
1451 const struct submodule
*sub
;
1453 if (err_code
== READ_GITFILE_ERR_STAT_FAILED
) {
1454 /* unpopulated as expected */
1455 strbuf_release(&gitdir
);
1459 if (err_code
!= READ_GITFILE_ERR_NOT_A_REPO
)
1460 /* We don't know what broke here. */
1461 read_gitfile_error_die(err_code
, path
, NULL
);
1464 * Maybe populated, but no git directory was found?
1465 * This can happen if the superproject is a submodule
1466 * itself and was just absorbed. The absorption of the
1467 * superproject did not rewrite the git file links yet,
1470 sub
= submodule_from_path(null_sha1
, path
);
1472 die(_("could not lookup name for submodule '%s'"), path
);
1473 connect_work_tree_and_git_dir(path
,
1474 git_path("modules/%s", sub
->name
));
1476 /* Is it already absorbed into the superprojects git dir? */
1477 char *real_sub_git_dir
= real_pathdup(sub_git_dir
);
1478 char *real_common_git_dir
= real_pathdup(get_git_common_dir());
1480 if (!starts_with(real_sub_git_dir
, real_common_git_dir
))
1481 relocate_single_git_dir_into_superproject(prefix
, path
);
1483 free(real_sub_git_dir
);
1484 free(real_common_git_dir
);
1486 strbuf_release(&gitdir
);
1488 if (flags
& ABSORB_GITDIR_RECURSE_SUBMODULES
) {
1489 struct child_process cp
= CHILD_PROCESS_INIT
;
1490 struct strbuf sb
= STRBUF_INIT
;
1492 if (flags
& ~ABSORB_GITDIR_RECURSE_SUBMODULES
)
1493 die("BUG: we don't know how to pass the flags down?");
1495 if (get_super_prefix())
1496 strbuf_addstr(&sb
, get_super_prefix());
1497 strbuf_addstr(&sb
, path
);
1498 strbuf_addch(&sb
, '/');
1503 argv_array_pushl(&cp
.args
, "--super-prefix", sb
.buf
,
1504 "submodule--helper",
1505 "absorb-git-dirs", NULL
);
1506 prepare_submodule_repo_env(&cp
.env_array
);
1507 if (run_command(&cp
))
1508 die(_("could not recurse into submodule '%s'"), path
);
1510 strbuf_release(&sb
);