2 #include "repository.h"
4 #include "submodule-config.h"
10 #include "run-command.h"
13 #include "string-list.h"
14 #include "sha1-array.h"
15 #include "argv-array.h"
17 #include "thread-utils.h"
21 #include "parse-options.h"
23 static int config_fetch_recurse_submodules
= RECURSE_SUBMODULES_ON_DEMAND
;
24 static int config_update_recurse_submodules
= RECURSE_SUBMODULES_OFF
;
25 static int parallel_jobs
= 1;
26 static struct string_list changed_submodule_paths
= STRING_LIST_INIT_DUP
;
27 static int initialized_fetch_ref_tips
;
28 static struct oid_array ref_tips_before_fetch
;
29 static struct oid_array ref_tips_after_fetch
;
32 * The following flag is set if the .gitmodules file is unmerged. We then
33 * disable recursion for all submodules where .git/config doesn't have a
34 * matching config entry because we can't guess what might be configured in
35 * .gitmodules unless the user resolves the conflict. When a command line
36 * option is given (which always overrides configuration) this flag will be
39 static int gitmodules_is_unmerged
;
42 * This flag is set if the .gitmodules file had unstaged modifications on
43 * startup. This must be checked before allowing modifications to the
44 * .gitmodules file with the intention to stage them later, because when
45 * continuing we would stage the modifications the user didn't stage herself
46 * too. That might change in a future version when we learn to stage the
47 * changes we do ourselves without staging any previous modifications.
49 static int gitmodules_is_modified
;
51 int is_staging_gitmodules_ok(void)
53 return !gitmodules_is_modified
;
57 * Try to update the "path" entry in the "submodule.<name>" section of the
58 * .gitmodules file. Return 0 only if a .gitmodules file was found, a section
59 * with the correct path=<oldpath> setting was found and we could update it.
61 int update_path_in_gitmodules(const char *oldpath
, const char *newpath
)
63 struct strbuf entry
= STRBUF_INIT
;
64 const struct submodule
*submodule
;
66 if (!file_exists(".gitmodules")) /* Do nothing without .gitmodules */
69 if (gitmodules_is_unmerged
)
70 die(_("Cannot change unmerged .gitmodules, resolve merge conflicts first"));
72 submodule
= submodule_from_path(null_sha1
, oldpath
);
73 if (!submodule
|| !submodule
->name
) {
74 warning(_("Could not find section in .gitmodules where path=%s"), oldpath
);
77 strbuf_addstr(&entry
, "submodule.");
78 strbuf_addstr(&entry
, submodule
->name
);
79 strbuf_addstr(&entry
, ".path");
80 if (git_config_set_in_file_gently(".gitmodules", entry
.buf
, newpath
) < 0) {
81 /* Maybe the user already did that, don't error out here */
82 warning(_("Could not update .gitmodules entry %s"), entry
.buf
);
83 strbuf_release(&entry
);
86 strbuf_release(&entry
);
91 * Try to remove the "submodule.<name>" section from .gitmodules where the given
92 * path is configured. Return 0 only if a .gitmodules file was found, a section
93 * with the correct path=<path> setting was found and we could remove it.
95 int remove_path_from_gitmodules(const char *path
)
97 struct strbuf sect
= STRBUF_INIT
;
98 const struct submodule
*submodule
;
100 if (!file_exists(".gitmodules")) /* Do nothing without .gitmodules */
103 if (gitmodules_is_unmerged
)
104 die(_("Cannot change unmerged .gitmodules, resolve merge conflicts first"));
106 submodule
= submodule_from_path(null_sha1
, path
);
107 if (!submodule
|| !submodule
->name
) {
108 warning(_("Could not find section in .gitmodules where path=%s"), path
);
111 strbuf_addstr(§
, "submodule.");
112 strbuf_addstr(§
, submodule
->name
);
113 if (git_config_rename_section_in_file(".gitmodules", sect
.buf
, NULL
) < 0) {
114 /* Maybe the user already did that, don't error out here */
115 warning(_("Could not remove .gitmodules entry for %s"), path
);
116 strbuf_release(§
);
119 strbuf_release(§
);
123 void stage_updated_gitmodules(void)
125 if (add_file_to_cache(".gitmodules", 0))
126 die(_("staging updated .gitmodules failed"));
129 static int add_submodule_odb(const char *path
)
131 struct strbuf objects_directory
= STRBUF_INIT
;
134 ret
= strbuf_git_path_submodule(&objects_directory
, path
, "objects/");
137 if (!is_directory(objects_directory
.buf
)) {
141 add_to_alternates_memory(objects_directory
.buf
);
143 strbuf_release(&objects_directory
);
147 void set_diffopt_flags_from_submodule_config(struct diff_options
*diffopt
,
150 const struct submodule
*submodule
= submodule_from_path(null_sha1
, path
);
152 if (submodule
->ignore
)
153 handle_ignore_submodules_arg(diffopt
, submodule
->ignore
);
154 else if (gitmodules_is_unmerged
)
155 DIFF_OPT_SET(diffopt
, IGNORE_SUBMODULES
);
159 /* For loading from the .gitmodules file. */
160 static int git_modules_config(const char *var
, const char *value
, void *cb
)
162 if (!strcmp(var
, "submodule.fetchjobs")) {
163 parallel_jobs
= git_config_int(var
, value
);
164 if (parallel_jobs
< 0)
165 die(_("negative values not allowed for submodule.fetchJobs"));
167 } else if (starts_with(var
, "submodule."))
168 return parse_submodule_config_option(var
, value
);
169 else if (!strcmp(var
, "fetch.recursesubmodules")) {
170 config_fetch_recurse_submodules
= parse_fetch_recurse_submodules_arg(var
, value
);
176 /* Loads all submodule settings from the config. */
177 int submodule_config(const char *var
, const char *value
, void *cb
)
179 if (!strcmp(var
, "submodule.recurse")) {
180 int v
= git_config_bool(var
, value
) ?
181 RECURSE_SUBMODULES_ON
: RECURSE_SUBMODULES_OFF
;
182 config_update_recurse_submodules
= v
;
185 return git_modules_config(var
, value
, cb
);
189 /* Cheap function that only determines if we're interested in submodules at all */
190 int git_default_submodule_config(const char *var
, const char *value
, void *cb
)
192 if (!strcmp(var
, "submodule.recurse")) {
193 int v
= git_config_bool(var
, value
) ?
194 RECURSE_SUBMODULES_ON
: RECURSE_SUBMODULES_OFF
;
195 config_update_recurse_submodules
= v
;
200 int option_parse_recurse_submodules_worktree_updater(const struct option
*opt
,
201 const char *arg
, int unset
)
204 config_update_recurse_submodules
= RECURSE_SUBMODULES_OFF
;
208 config_update_recurse_submodules
=
209 parse_update_recurse_submodules_arg(opt
->long_name
,
212 config_update_recurse_submodules
= RECURSE_SUBMODULES_ON
;
217 void load_submodule_cache(void)
219 if (config_update_recurse_submodules
== RECURSE_SUBMODULES_OFF
)
223 git_config(submodule_config
, NULL
);
226 void gitmodules_config(void)
228 const char *work_tree
= get_git_work_tree();
230 struct strbuf gitmodules_path
= STRBUF_INIT
;
232 strbuf_addstr(&gitmodules_path
, work_tree
);
233 strbuf_addstr(&gitmodules_path
, "/.gitmodules");
234 if (read_cache() < 0)
235 die("index file corrupt");
236 pos
= cache_name_pos(".gitmodules", 11);
237 if (pos
< 0) { /* .gitmodules not found or isn't merged */
239 if (active_nr
> pos
) { /* there is a .gitmodules */
240 const struct cache_entry
*ce
= active_cache
[pos
];
241 if (ce_namelen(ce
) == 11 &&
242 !memcmp(ce
->name
, ".gitmodules", 11))
243 gitmodules_is_unmerged
= 1;
245 } else if (pos
< active_nr
) {
247 if (lstat(".gitmodules", &st
) == 0 &&
248 ce_match_stat(active_cache
[pos
], &st
, 0) & DATA_CHANGED
)
249 gitmodules_is_modified
= 1;
252 if (!gitmodules_is_unmerged
)
253 git_config_from_file(git_modules_config
,
254 gitmodules_path
.buf
, NULL
);
255 strbuf_release(&gitmodules_path
);
259 static int gitmodules_cb(const char *var
, const char *value
, void *data
)
261 struct repository
*repo
= data
;
262 return submodule_config_option(repo
, var
, value
);
265 void repo_read_gitmodules(struct repository
*repo
)
267 char *gitmodules_path
= repo_worktree_path(repo
, ".gitmodules");
269 git_config_from_file(gitmodules_cb
, gitmodules_path
, repo
);
270 free(gitmodules_path
);
273 void gitmodules_config_sha1(const unsigned char *commit_sha1
)
275 struct strbuf rev
= STRBUF_INIT
;
276 unsigned char sha1
[20];
278 if (gitmodule_sha1_from_commit(commit_sha1
, sha1
, &rev
)) {
279 git_config_from_blob_sha1(git_modules_config
, rev
.buf
,
282 strbuf_release(&rev
);
286 * NEEDSWORK: With the addition of different configuration options to determine
287 * if a submodule is of interests, the validity of this function's name comes
288 * into question. Once the dust has settled and more concrete terminology is
289 * decided upon, come up with a more proper name for this function. One
290 * potential candidate could be 'is_submodule_active()'.
292 * Determine if a submodule has been initialized at a given 'path'
294 int is_submodule_initialized(const char *path
)
299 const struct string_list
*sl
;
300 const struct submodule
*module
= submodule_from_path(null_sha1
, path
);
302 /* early return if there isn't a path->module mapping */
306 /* submodule.<name>.active is set */
307 key
= xstrfmt("submodule.%s.active", module
->name
);
308 if (!git_config_get_bool(key
, &ret
)) {
314 /* submodule.active is set */
315 sl
= git_config_get_value_multi("submodule.active");
318 struct argv_array args
= ARGV_ARRAY_INIT
;
319 const struct string_list_item
*item
;
321 for_each_string_list_item(item
, sl
) {
322 argv_array_push(&args
, item
->string
);
325 parse_pathspec(&ps
, 0, 0, NULL
, args
.argv
);
326 ret
= match_pathspec(&ps
, path
, strlen(path
), 0, NULL
, 1);
328 argv_array_clear(&args
);
333 /* fallback to checking if the URL is set */
334 key
= xstrfmt("submodule.%s.url", module
->name
);
335 ret
= !git_config_get_string(key
, &value
);
342 int is_submodule_populated_gently(const char *path
, int *return_error_code
)
345 char *gitdir
= xstrfmt("%s/.git", path
);
347 if (resolve_gitdir_gently(gitdir
, return_error_code
))
355 * Dies if the provided 'prefix' corresponds to an unpopulated submodule
357 void die_in_unpopulated_submodule(const struct index_state
*istate
,
365 prefixlen
= strlen(prefix
);
367 for (i
= 0; i
< istate
->cache_nr
; i
++) {
368 struct cache_entry
*ce
= istate
->cache
[i
];
369 int ce_len
= ce_namelen(ce
);
371 if (!S_ISGITLINK(ce
->ce_mode
))
373 if (prefixlen
<= ce_len
)
375 if (strncmp(ce
->name
, prefix
, ce_len
))
377 if (prefix
[ce_len
] != '/')
380 die(_("in unpopulated submodule '%s'"), ce
->name
);
385 * Dies if any paths in the provided pathspec descends into a submodule
387 void die_path_inside_submodule(const struct index_state
*istate
,
388 const struct pathspec
*ps
)
392 for (i
= 0; i
< istate
->cache_nr
; i
++) {
393 struct cache_entry
*ce
= istate
->cache
[i
];
394 int ce_len
= ce_namelen(ce
);
396 if (!S_ISGITLINK(ce
->ce_mode
))
399 for (j
= 0; j
< ps
->nr
; j
++) {
400 const struct pathspec_item
*item
= &ps
->items
[j
];
402 if (item
->len
<= ce_len
)
404 if (item
->match
[ce_len
] != '/')
406 if (strncmp(ce
->name
, item
->match
, ce_len
))
408 if (item
->len
== ce_len
+ 1)
411 die(_("Pathspec '%s' is in submodule '%.*s'"),
412 item
->original
, ce_len
, ce
->name
);
417 int parse_submodule_update_strategy(const char *value
,
418 struct submodule_update_strategy
*dst
)
420 free((void*)dst
->command
);
422 if (!strcmp(value
, "none"))
423 dst
->type
= SM_UPDATE_NONE
;
424 else if (!strcmp(value
, "checkout"))
425 dst
->type
= SM_UPDATE_CHECKOUT
;
426 else if (!strcmp(value
, "rebase"))
427 dst
->type
= SM_UPDATE_REBASE
;
428 else if (!strcmp(value
, "merge"))
429 dst
->type
= SM_UPDATE_MERGE
;
430 else if (skip_prefix(value
, "!", &value
)) {
431 dst
->type
= SM_UPDATE_COMMAND
;
432 dst
->command
= xstrdup(value
);
438 const char *submodule_strategy_to_string(const struct submodule_update_strategy
*s
)
440 struct strbuf sb
= STRBUF_INIT
;
442 case SM_UPDATE_CHECKOUT
:
444 case SM_UPDATE_MERGE
:
446 case SM_UPDATE_REBASE
:
450 case SM_UPDATE_UNSPECIFIED
:
452 case SM_UPDATE_COMMAND
:
453 strbuf_addf(&sb
, "!%s", s
->command
);
454 return strbuf_detach(&sb
, NULL
);
459 void handle_ignore_submodules_arg(struct diff_options
*diffopt
,
462 DIFF_OPT_CLR(diffopt
, IGNORE_SUBMODULES
);
463 DIFF_OPT_CLR(diffopt
, IGNORE_UNTRACKED_IN_SUBMODULES
);
464 DIFF_OPT_CLR(diffopt
, IGNORE_DIRTY_SUBMODULES
);
466 if (!strcmp(arg
, "all"))
467 DIFF_OPT_SET(diffopt
, IGNORE_SUBMODULES
);
468 else if (!strcmp(arg
, "untracked"))
469 DIFF_OPT_SET(diffopt
, IGNORE_UNTRACKED_IN_SUBMODULES
);
470 else if (!strcmp(arg
, "dirty"))
471 DIFF_OPT_SET(diffopt
, IGNORE_DIRTY_SUBMODULES
);
472 else if (strcmp(arg
, "none"))
473 die("bad --ignore-submodules argument: %s", arg
);
476 static int prepare_submodule_summary(struct rev_info
*rev
, const char *path
,
477 struct commit
*left
, struct commit
*right
,
478 struct commit_list
*merge_bases
)
480 struct commit_list
*list
;
482 init_revisions(rev
, NULL
);
483 setup_revisions(0, NULL
, rev
, NULL
);
485 rev
->first_parent_only
= 1;
486 left
->object
.flags
|= SYMMETRIC_LEFT
;
487 add_pending_object(rev
, &left
->object
, path
);
488 add_pending_object(rev
, &right
->object
, path
);
489 for (list
= merge_bases
; list
; list
= list
->next
) {
490 list
->item
->object
.flags
|= UNINTERESTING
;
491 add_pending_object(rev
, &list
->item
->object
,
492 oid_to_hex(&list
->item
->object
.oid
));
494 return prepare_revision_walk(rev
);
497 static void print_submodule_summary(struct rev_info
*rev
, FILE *f
,
498 const char *line_prefix
,
499 const char *del
, const char *add
, const char *reset
)
501 static const char format
[] = " %m %s";
502 struct strbuf sb
= STRBUF_INIT
;
503 struct commit
*commit
;
505 while ((commit
= get_revision(rev
))) {
506 struct pretty_print_context ctx
= {0};
507 ctx
.date_mode
= rev
->date_mode
;
508 ctx
.output_encoding
= get_log_output_encoding();
509 strbuf_setlen(&sb
, 0);
510 strbuf_addstr(&sb
, line_prefix
);
511 if (commit
->object
.flags
& SYMMETRIC_LEFT
) {
513 strbuf_addstr(&sb
, del
);
516 strbuf_addstr(&sb
, add
);
517 format_commit_message(commit
, format
, &sb
, &ctx
);
519 strbuf_addstr(&sb
, reset
);
520 strbuf_addch(&sb
, '\n');
521 fprintf(f
, "%s", sb
.buf
);
526 static void prepare_submodule_repo_env_no_git_dir(struct argv_array
*out
)
528 const char * const *var
;
530 for (var
= local_repo_env
; *var
; var
++) {
531 if (strcmp(*var
, CONFIG_DATA_ENVIRONMENT
))
532 argv_array_push(out
, *var
);
536 void prepare_submodule_repo_env(struct argv_array
*out
)
538 prepare_submodule_repo_env_no_git_dir(out
);
539 argv_array_pushf(out
, "%s=%s", GIT_DIR_ENVIRONMENT
,
540 DEFAULT_GIT_DIR_ENVIRONMENT
);
543 /* Helper function to display the submodule header line prior to the full
544 * summary output. If it can locate the submodule objects directory it will
545 * attempt to lookup both the left and right commits and put them into the
546 * left and right pointers.
548 static void show_submodule_header(FILE *f
, const char *path
,
549 const char *line_prefix
,
550 struct object_id
*one
, struct object_id
*two
,
551 unsigned dirty_submodule
, const char *meta
,
553 struct commit
**left
, struct commit
**right
,
554 struct commit_list
**merge_bases
)
556 const char *message
= NULL
;
557 struct strbuf sb
= STRBUF_INIT
;
558 int fast_forward
= 0, fast_backward
= 0;
560 if (dirty_submodule
& DIRTY_SUBMODULE_UNTRACKED
)
561 fprintf(f
, "%sSubmodule %s contains untracked content\n",
563 if (dirty_submodule
& DIRTY_SUBMODULE_MODIFIED
)
564 fprintf(f
, "%sSubmodule %s contains modified content\n",
567 if (is_null_oid(one
))
568 message
= "(new submodule)";
569 else if (is_null_oid(two
))
570 message
= "(submodule deleted)";
572 if (add_submodule_odb(path
)) {
574 message
= "(not initialized)";
579 * Attempt to lookup the commit references, and determine if this is
580 * a fast forward or fast backwards update.
582 *left
= lookup_commit_reference(one
);
583 *right
= lookup_commit_reference(two
);
586 * Warn about missing commits in the submodule project, but only if
589 if ((!is_null_oid(one
) && !*left
) ||
590 (!is_null_oid(two
) && !*right
))
591 message
= "(commits not present)";
593 *merge_bases
= get_merge_bases(*left
, *right
);
595 if ((*merge_bases
)->item
== *left
)
597 else if ((*merge_bases
)->item
== *right
)
601 if (!oidcmp(one
, two
)) {
607 strbuf_addf(&sb
, "%s%sSubmodule %s ", line_prefix
, meta
, path
);
608 strbuf_add_unique_abbrev(&sb
, one
->hash
, DEFAULT_ABBREV
);
609 strbuf_addstr(&sb
, (fast_backward
|| fast_forward
) ? ".." : "...");
610 strbuf_add_unique_abbrev(&sb
, two
->hash
, DEFAULT_ABBREV
);
612 strbuf_addf(&sb
, " %s%s\n", message
, reset
);
614 strbuf_addf(&sb
, "%s:%s\n", fast_backward
? " (rewind)" : "", reset
);
615 fwrite(sb
.buf
, sb
.len
, 1, f
);
620 void show_submodule_summary(FILE *f
, const char *path
,
621 const char *line_prefix
,
622 struct object_id
*one
, struct object_id
*two
,
623 unsigned dirty_submodule
, const char *meta
,
624 const char *del
, const char *add
, const char *reset
)
627 struct commit
*left
= NULL
, *right
= NULL
;
628 struct commit_list
*merge_bases
= NULL
;
630 show_submodule_header(f
, path
, line_prefix
, one
, two
, dirty_submodule
,
631 meta
, reset
, &left
, &right
, &merge_bases
);
634 * If we don't have both a left and a right pointer, there is no
635 * reason to try and display a summary. The header line should contain
636 * all the information the user needs.
641 /* Treat revision walker failure the same as missing commits */
642 if (prepare_submodule_summary(&rev
, path
, left
, right
, merge_bases
)) {
643 fprintf(f
, "%s(revision walker failed)\n", line_prefix
);
647 print_submodule_summary(&rev
, f
, line_prefix
, del
, add
, reset
);
651 free_commit_list(merge_bases
);
652 clear_commit_marks(left
, ~0);
653 clear_commit_marks(right
, ~0);
656 void show_submodule_inline_diff(FILE *f
, const char *path
,
657 const char *line_prefix
,
658 struct object_id
*one
, struct object_id
*two
,
659 unsigned dirty_submodule
, const char *meta
,
660 const char *del
, const char *add
, const char *reset
,
661 const struct diff_options
*o
)
663 const struct object_id
*old
= &empty_tree_oid
, *new = &empty_tree_oid
;
664 struct commit
*left
= NULL
, *right
= NULL
;
665 struct commit_list
*merge_bases
= NULL
;
666 struct strbuf submodule_dir
= STRBUF_INIT
;
667 struct child_process cp
= CHILD_PROCESS_INIT
;
669 show_submodule_header(f
, path
, line_prefix
, one
, two
, dirty_submodule
,
670 meta
, reset
, &left
, &right
, &merge_bases
);
672 /* We need a valid left and right commit to display a difference */
673 if (!(left
|| is_null_oid(one
)) ||
674 !(right
|| is_null_oid(two
)))
685 cp
.out
= dup(fileno(f
));
688 /* TODO: other options may need to be passed here. */
689 argv_array_pushl(&cp
.args
, "diff", "--submodule=diff", NULL
);
691 argv_array_pushf(&cp
.args
, "--line-prefix=%s", line_prefix
);
692 if (DIFF_OPT_TST(o
, REVERSE_DIFF
)) {
693 argv_array_pushf(&cp
.args
, "--src-prefix=%s%s/",
695 argv_array_pushf(&cp
.args
, "--dst-prefix=%s%s/",
698 argv_array_pushf(&cp
.args
, "--src-prefix=%s%s/",
700 argv_array_pushf(&cp
.args
, "--dst-prefix=%s%s/",
703 argv_array_push(&cp
.args
, oid_to_hex(old
));
705 * If the submodule has modified content, we will diff against the
706 * work tree, under the assumption that the user has asked for the
707 * diff format and wishes to actually see all differences even if they
708 * haven't yet been committed to the submodule yet.
710 if (!(dirty_submodule
& DIRTY_SUBMODULE_MODIFIED
))
711 argv_array_push(&cp
.args
, oid_to_hex(new));
713 prepare_submodule_repo_env(&cp
.env_array
);
714 if (run_command(&cp
))
715 fprintf(f
, "(diff failed)\n");
718 strbuf_release(&submodule_dir
);
720 free_commit_list(merge_bases
);
722 clear_commit_marks(left
, ~0);
724 clear_commit_marks(right
, ~0);
727 void set_config_fetch_recurse_submodules(int value
)
729 config_fetch_recurse_submodules
= value
;
732 int should_update_submodules(void)
734 return config_update_recurse_submodules
== RECURSE_SUBMODULES_ON
;
737 const struct submodule
*submodule_from_ce(const struct cache_entry
*ce
)
739 if (!S_ISGITLINK(ce
->ce_mode
))
742 if (!should_update_submodules())
745 return submodule_from_path(null_sha1
, ce
->name
);
748 static struct oid_array
*submodule_commits(struct string_list
*submodules
,
751 struct string_list_item
*item
;
753 item
= string_list_insert(submodules
, path
);
755 return (struct oid_array
*) item
->util
;
757 /* NEEDSWORK: should we have oid_array_init()? */
758 item
->util
= xcalloc(1, sizeof(struct oid_array
));
759 return (struct oid_array
*) item
->util
;
762 static void collect_changed_submodules_cb(struct diff_queue_struct
*q
,
763 struct diff_options
*options
,
767 struct string_list
*changed
= data
;
769 for (i
= 0; i
< q
->nr
; i
++) {
770 struct diff_filepair
*p
= q
->queue
[i
];
771 struct oid_array
*commits
;
772 if (!S_ISGITLINK(p
->two
->mode
))
775 if (S_ISGITLINK(p
->one
->mode
)) {
777 * NEEDSWORK: We should honor the name configured in
778 * the .gitmodules file of the commit we are examining
779 * here to be able to correctly follow submodules
780 * being moved around.
782 commits
= submodule_commits(changed
, p
->two
->path
);
783 oid_array_append(commits
, &p
->two
->oid
);
785 /* Submodule is new or was moved here */
787 * NEEDSWORK: When the .git directories of submodules
788 * live inside the superprojects .git directory some
789 * day we should fetch new submodules directly into
790 * that location too when config or options request
791 * that so they can be checked out from there.
799 * Collect the paths of submodules in 'changed' which have changed based on
800 * the revisions as specified in 'argv'. Each entry in 'changed' will also
801 * have a corresponding 'struct oid_array' (in the 'util' field) which lists
802 * what the submodule pointers were updated to during the change.
804 static void collect_changed_submodules(struct string_list
*changed
,
805 struct argv_array
*argv
)
808 const struct commit
*commit
;
810 init_revisions(&rev
, NULL
);
811 setup_revisions(argv
->argc
, argv
->argv
, &rev
, NULL
);
812 if (prepare_revision_walk(&rev
))
813 die("revision walk setup failed");
815 while ((commit
= get_revision(&rev
))) {
816 struct rev_info diff_rev
;
818 init_revisions(&diff_rev
, NULL
);
819 diff_rev
.diffopt
.output_format
|= DIFF_FORMAT_CALLBACK
;
820 diff_rev
.diffopt
.format_callback
= collect_changed_submodules_cb
;
821 diff_rev
.diffopt
.format_callback_data
= changed
;
822 diff_tree_combined_merge(commit
, 1, &diff_rev
);
825 reset_revision_walk();
828 static void free_submodules_oids(struct string_list
*submodules
)
830 struct string_list_item
*item
;
831 for_each_string_list_item(item
, submodules
)
832 oid_array_clear((struct oid_array
*) item
->util
);
833 string_list_clear(submodules
, 1);
836 static int has_remote(const char *refname
, const struct object_id
*oid
,
837 int flags
, void *cb_data
)
842 static int append_oid_to_argv(const struct object_id
*oid
, void *data
)
844 struct argv_array
*argv
= data
;
845 argv_array_push(argv
, oid_to_hex(oid
));
849 static int check_has_commit(const struct object_id
*oid
, void *data
)
851 int *has_commit
= data
;
853 if (!lookup_commit_reference(oid
))
859 static int submodule_has_commits(const char *path
, struct oid_array
*commits
)
864 * Perform a cheap, but incorrect check for the existance of 'commits'.
865 * This is done by adding the submodule's object store to the in-core
866 * object store, and then querying for each commit's existance. If we
867 * do not have the commit object anywhere, there is no chance we have
868 * it in the object store of the correct submodule and have it
869 * reachable from a ref, so we can fail early without spawning rev-list
870 * which is expensive.
872 if (add_submodule_odb(path
))
875 oid_array_for_each_unique(commits
, check_has_commit
, &has_commit
);
879 * Even if the submodule is checked out and the commit is
880 * present, make sure it exists in the submodule's object store
881 * and that it is reachable from a ref.
883 struct child_process cp
= CHILD_PROCESS_INIT
;
884 struct strbuf out
= STRBUF_INIT
;
886 argv_array_pushl(&cp
.args
, "rev-list", "-n", "1", NULL
);
887 oid_array_for_each_unique(commits
, append_oid_to_argv
, &cp
.args
);
888 argv_array_pushl(&cp
.args
, "--not", "--all", NULL
);
890 prepare_submodule_repo_env(&cp
.env_array
);
895 if (capture_command(&cp
, &out
, GIT_MAX_HEXSZ
+ 1) || out
.len
)
898 strbuf_release(&out
);
904 static int submodule_needs_pushing(const char *path
, struct oid_array
*commits
)
906 if (!submodule_has_commits(path
, commits
))
908 * NOTE: We do consider it safe to return "no" here. The
909 * correct answer would be "We do not know" instead of
910 * "No push needed", but it is quite hard to change
911 * the submodule pointer without having the submodule
912 * around. If a user did however change the submodules
913 * without having the submodule around, this indicates
914 * an expert who knows what they are doing or a
915 * maintainer integrating work from other people. In
916 * both cases it should be safe to skip this check.
920 if (for_each_remote_ref_submodule(path
, has_remote
, NULL
) > 0) {
921 struct child_process cp
= CHILD_PROCESS_INIT
;
922 struct strbuf buf
= STRBUF_INIT
;
923 int needs_pushing
= 0;
925 argv_array_push(&cp
.args
, "rev-list");
926 oid_array_for_each_unique(commits
, append_oid_to_argv
, &cp
.args
);
927 argv_array_pushl(&cp
.args
, "--not", "--remotes", "-n", "1" , NULL
);
929 prepare_submodule_repo_env(&cp
.env_array
);
934 if (start_command(&cp
))
935 die("Could not run 'git rev-list <commits> --not --remotes -n 1' command in submodule %s",
937 if (strbuf_read(&buf
, cp
.out
, 41))
941 strbuf_release(&buf
);
942 return needs_pushing
;
948 int find_unpushed_submodules(struct oid_array
*commits
,
949 const char *remotes_name
, struct string_list
*needs_pushing
)
951 struct string_list submodules
= STRING_LIST_INIT_DUP
;
952 struct string_list_item
*submodule
;
953 struct argv_array argv
= ARGV_ARRAY_INIT
;
955 /* argv.argv[0] will be ignored by setup_revisions */
956 argv_array_push(&argv
, "find_unpushed_submodules");
957 oid_array_for_each_unique(commits
, append_oid_to_argv
, &argv
);
958 argv_array_push(&argv
, "--not");
959 argv_array_pushf(&argv
, "--remotes=%s", remotes_name
);
961 collect_changed_submodules(&submodules
, &argv
);
963 for_each_string_list_item(submodule
, &submodules
) {
964 struct oid_array
*commits
= submodule
->util
;
965 const char *path
= submodule
->string
;
967 if (submodule_needs_pushing(path
, commits
))
968 string_list_insert(needs_pushing
, path
);
971 free_submodules_oids(&submodules
);
972 argv_array_clear(&argv
);
974 return needs_pushing
->nr
;
977 static int push_submodule(const char *path
,
978 const struct remote
*remote
,
979 const char **refspec
, int refspec_nr
,
980 const struct string_list
*push_options
,
983 if (add_submodule_odb(path
))
986 if (for_each_remote_ref_submodule(path
, has_remote
, NULL
) > 0) {
987 struct child_process cp
= CHILD_PROCESS_INIT
;
988 argv_array_push(&cp
.args
, "push");
990 argv_array_push(&cp
.args
, "--dry-run");
992 if (push_options
&& push_options
->nr
) {
993 const struct string_list_item
*item
;
994 for_each_string_list_item(item
, push_options
)
995 argv_array_pushf(&cp
.args
, "--push-option=%s",
999 if (remote
->origin
!= REMOTE_UNCONFIGURED
) {
1001 argv_array_push(&cp
.args
, remote
->name
);
1002 for (i
= 0; i
< refspec_nr
; i
++)
1003 argv_array_push(&cp
.args
, refspec
[i
]);
1006 prepare_submodule_repo_env(&cp
.env_array
);
1010 if (run_command(&cp
))
1019 * Perform a check in the submodule to see if the remote and refspec work.
1020 * Die if the submodule can't be pushed.
1022 static void submodule_push_check(const char *path
, const struct remote
*remote
,
1023 const char **refspec
, int refspec_nr
)
1025 struct child_process cp
= CHILD_PROCESS_INIT
;
1028 argv_array_push(&cp
.args
, "submodule--helper");
1029 argv_array_push(&cp
.args
, "push-check");
1030 argv_array_push(&cp
.args
, remote
->name
);
1032 for (i
= 0; i
< refspec_nr
; i
++)
1033 argv_array_push(&cp
.args
, refspec
[i
]);
1035 prepare_submodule_repo_env(&cp
.env_array
);
1042 * Simply indicate if 'submodule--helper push-check' failed.
1043 * More detailed error information will be provided by the
1046 if (run_command(&cp
))
1047 die("process for submodule '%s' failed", path
);
1050 int push_unpushed_submodules(struct oid_array
*commits
,
1051 const struct remote
*remote
,
1052 const char **refspec
, int refspec_nr
,
1053 const struct string_list
*push_options
,
1057 struct string_list needs_pushing
= STRING_LIST_INIT_DUP
;
1059 if (!find_unpushed_submodules(commits
, remote
->name
, &needs_pushing
))
1063 * Verify that the remote and refspec can be propagated to all
1064 * submodules. This check can be skipped if the remote and refspec
1065 * won't be propagated due to the remote being unconfigured (e.g. a URL
1066 * instead of a remote name).
1068 if (remote
->origin
!= REMOTE_UNCONFIGURED
)
1069 for (i
= 0; i
< needs_pushing
.nr
; i
++)
1070 submodule_push_check(needs_pushing
.items
[i
].string
,
1071 remote
, refspec
, refspec_nr
);
1073 /* Actually push the submodules */
1074 for (i
= 0; i
< needs_pushing
.nr
; i
++) {
1075 const char *path
= needs_pushing
.items
[i
].string
;
1076 fprintf(stderr
, "Pushing submodule '%s'\n", path
);
1077 if (!push_submodule(path
, remote
, refspec
, refspec_nr
,
1078 push_options
, dry_run
)) {
1079 fprintf(stderr
, "Unable to push submodule '%s'\n", path
);
1084 string_list_clear(&needs_pushing
, 0);
1089 static int append_oid_to_array(const char *ref
, const struct object_id
*oid
,
1090 int flags
, void *data
)
1092 struct oid_array
*array
= data
;
1093 oid_array_append(array
, oid
);
1097 void check_for_new_submodule_commits(struct object_id
*oid
)
1099 if (!initialized_fetch_ref_tips
) {
1100 for_each_ref(append_oid_to_array
, &ref_tips_before_fetch
);
1101 initialized_fetch_ref_tips
= 1;
1104 oid_array_append(&ref_tips_after_fetch
, oid
);
1107 static void calculate_changed_submodule_paths(void)
1109 struct argv_array argv
= ARGV_ARRAY_INIT
;
1110 struct string_list changed_submodules
= STRING_LIST_INIT_DUP
;
1111 const struct string_list_item
*item
;
1113 /* No need to check if there are no submodules configured */
1114 if (!submodule_from_path(NULL
, NULL
))
1117 argv_array_push(&argv
, "--"); /* argv[0] program name */
1118 oid_array_for_each_unique(&ref_tips_after_fetch
,
1119 append_oid_to_argv
, &argv
);
1120 argv_array_push(&argv
, "--not");
1121 oid_array_for_each_unique(&ref_tips_before_fetch
,
1122 append_oid_to_argv
, &argv
);
1125 * Collect all submodules (whether checked out or not) for which new
1126 * commits have been recorded upstream in "changed_submodule_paths".
1128 collect_changed_submodules(&changed_submodules
, &argv
);
1130 for_each_string_list_item(item
, &changed_submodules
) {
1131 struct oid_array
*commits
= item
->util
;
1132 const char *path
= item
->string
;
1134 if (!submodule_has_commits(path
, commits
))
1135 string_list_append(&changed_submodule_paths
, path
);
1138 free_submodules_oids(&changed_submodules
);
1139 argv_array_clear(&argv
);
1140 oid_array_clear(&ref_tips_before_fetch
);
1141 oid_array_clear(&ref_tips_after_fetch
);
1142 initialized_fetch_ref_tips
= 0;
1145 struct submodule_parallel_fetch
{
1147 struct argv_array args
;
1148 const char *work_tree
;
1150 int command_line_option
;
1154 #define SPF_INIT {0, ARGV_ARRAY_INIT, NULL, NULL, 0, 0, 0}
1156 static int get_next_submodule(struct child_process
*cp
,
1157 struct strbuf
*err
, void *data
, void **task_cb
)
1160 struct submodule_parallel_fetch
*spf
= data
;
1162 for (; spf
->count
< active_nr
; spf
->count
++) {
1163 struct strbuf submodule_path
= STRBUF_INIT
;
1164 struct strbuf submodule_git_dir
= STRBUF_INIT
;
1165 struct strbuf submodule_prefix
= STRBUF_INIT
;
1166 const struct cache_entry
*ce
= active_cache
[spf
->count
];
1167 const char *git_dir
, *default_argv
;
1168 const struct submodule
*submodule
;
1170 if (!S_ISGITLINK(ce
->ce_mode
))
1173 submodule
= submodule_from_path(null_sha1
, ce
->name
);
1175 submodule
= submodule_from_name(null_sha1
, ce
->name
);
1177 default_argv
= "yes";
1178 if (spf
->command_line_option
== RECURSE_SUBMODULES_DEFAULT
) {
1180 submodule
->fetch_recurse
!=
1181 RECURSE_SUBMODULES_NONE
) {
1182 if (submodule
->fetch_recurse
==
1183 RECURSE_SUBMODULES_OFF
)
1185 if (submodule
->fetch_recurse
==
1186 RECURSE_SUBMODULES_ON_DEMAND
) {
1187 if (!unsorted_string_list_lookup(&changed_submodule_paths
, ce
->name
))
1189 default_argv
= "on-demand";
1192 if ((config_fetch_recurse_submodules
== RECURSE_SUBMODULES_OFF
) ||
1193 gitmodules_is_unmerged
)
1195 if (config_fetch_recurse_submodules
== RECURSE_SUBMODULES_ON_DEMAND
) {
1196 if (!unsorted_string_list_lookup(&changed_submodule_paths
, ce
->name
))
1198 default_argv
= "on-demand";
1201 } else if (spf
->command_line_option
== RECURSE_SUBMODULES_ON_DEMAND
) {
1202 if (!unsorted_string_list_lookup(&changed_submodule_paths
, ce
->name
))
1204 default_argv
= "on-demand";
1207 strbuf_addf(&submodule_path
, "%s/%s", spf
->work_tree
, ce
->name
);
1208 strbuf_addf(&submodule_git_dir
, "%s/.git", submodule_path
.buf
);
1209 strbuf_addf(&submodule_prefix
, "%s%s/", spf
->prefix
, ce
->name
);
1210 git_dir
= read_gitfile(submodule_git_dir
.buf
);
1212 git_dir
= submodule_git_dir
.buf
;
1213 if (is_directory(git_dir
)) {
1214 child_process_init(cp
);
1215 cp
->dir
= strbuf_detach(&submodule_path
, NULL
);
1216 prepare_submodule_repo_env(&cp
->env_array
);
1219 strbuf_addf(err
, "Fetching submodule %s%s\n",
1220 spf
->prefix
, ce
->name
);
1221 argv_array_init(&cp
->args
);
1222 argv_array_pushv(&cp
->args
, spf
->args
.argv
);
1223 argv_array_push(&cp
->args
, default_argv
);
1224 argv_array_push(&cp
->args
, "--submodule-prefix");
1225 argv_array_push(&cp
->args
, submodule_prefix
.buf
);
1228 strbuf_release(&submodule_path
);
1229 strbuf_release(&submodule_git_dir
);
1230 strbuf_release(&submodule_prefix
);
1239 static int fetch_start_failure(struct strbuf
*err
,
1240 void *cb
, void *task_cb
)
1242 struct submodule_parallel_fetch
*spf
= cb
;
1249 static int fetch_finish(int retvalue
, struct strbuf
*err
,
1250 void *cb
, void *task_cb
)
1252 struct submodule_parallel_fetch
*spf
= cb
;
1260 int fetch_populated_submodules(const struct argv_array
*options
,
1261 const char *prefix
, int command_line_option
,
1262 int quiet
, int max_parallel_jobs
)
1265 struct submodule_parallel_fetch spf
= SPF_INIT
;
1267 spf
.work_tree
= get_git_work_tree();
1268 spf
.command_line_option
= command_line_option
;
1270 spf
.prefix
= prefix
;
1275 if (read_cache() < 0)
1276 die("index file corrupt");
1278 argv_array_push(&spf
.args
, "fetch");
1279 for (i
= 0; i
< options
->argc
; i
++)
1280 argv_array_push(&spf
.args
, options
->argv
[i
]);
1281 argv_array_push(&spf
.args
, "--recurse-submodules-default");
1282 /* default value, "--submodule-prefix" and its value are added later */
1284 if (max_parallel_jobs
< 0)
1285 max_parallel_jobs
= parallel_jobs
;
1287 calculate_changed_submodule_paths();
1288 run_processes_parallel(max_parallel_jobs
,
1290 fetch_start_failure
,
1294 argv_array_clear(&spf
.args
);
1296 string_list_clear(&changed_submodule_paths
, 1);
1300 unsigned is_submodule_modified(const char *path
, int ignore_untracked
)
1302 struct child_process cp
= CHILD_PROCESS_INIT
;
1303 struct strbuf buf
= STRBUF_INIT
;
1305 unsigned dirty_submodule
= 0;
1306 const char *git_dir
;
1307 int ignore_cp_exit_code
= 0;
1309 strbuf_addf(&buf
, "%s/.git", path
);
1310 git_dir
= read_gitfile(buf
.buf
);
1313 if (!is_git_directory(git_dir
)) {
1314 if (is_directory(git_dir
))
1315 die(_("'%s' not recognized as a git repository"), git_dir
);
1316 strbuf_release(&buf
);
1317 /* The submodule is not checked out, so it is not modified */
1322 argv_array_pushl(&cp
.args
, "status", "--porcelain=2", NULL
);
1323 if (ignore_untracked
)
1324 argv_array_push(&cp
.args
, "-uno");
1326 prepare_submodule_repo_env(&cp
.env_array
);
1331 if (start_command(&cp
))
1332 die("Could not run 'git status --porcelain=2' in submodule %s", path
);
1334 fp
= xfdopen(cp
.out
, "r");
1335 while (strbuf_getwholeline(&buf
, fp
, '\n') != EOF
) {
1336 /* regular untracked files */
1337 if (buf
.buf
[0] == '?')
1338 dirty_submodule
|= DIRTY_SUBMODULE_UNTRACKED
;
1340 if (buf
.buf
[0] == 'u' ||
1341 buf
.buf
[0] == '1' ||
1342 buf
.buf
[0] == '2') {
1343 /* T = line type, XY = status, SSSS = submodule state */
1344 if (buf
.len
< strlen("T XY SSSS"))
1345 die("BUG: invalid status --porcelain=2 line %s",
1348 if (buf
.buf
[5] == 'S' && buf
.buf
[8] == 'U')
1349 /* nested untracked file */
1350 dirty_submodule
|= DIRTY_SUBMODULE_UNTRACKED
;
1352 if (buf
.buf
[0] == 'u' ||
1353 buf
.buf
[0] == '2' ||
1354 memcmp(buf
.buf
+ 5, "S..U", 4))
1356 dirty_submodule
|= DIRTY_SUBMODULE_MODIFIED
;
1359 if ((dirty_submodule
& DIRTY_SUBMODULE_MODIFIED
) &&
1360 ((dirty_submodule
& DIRTY_SUBMODULE_UNTRACKED
) ||
1361 ignore_untracked
)) {
1363 * We're not interested in any further information from
1364 * the child any more, neither output nor its exit code.
1366 ignore_cp_exit_code
= 1;
1372 if (finish_command(&cp
) && !ignore_cp_exit_code
)
1373 die("'git status --porcelain=2' failed in submodule %s", path
);
1375 strbuf_release(&buf
);
1376 return dirty_submodule
;
1379 int submodule_uses_gitfile(const char *path
)
1381 struct child_process cp
= CHILD_PROCESS_INIT
;
1382 const char *argv
[] = {
1390 struct strbuf buf
= STRBUF_INIT
;
1391 const char *git_dir
;
1393 strbuf_addf(&buf
, "%s/.git", path
);
1394 git_dir
= read_gitfile(buf
.buf
);
1396 strbuf_release(&buf
);
1399 strbuf_release(&buf
);
1401 /* Now test that all nested submodules use a gitfile too */
1403 prepare_submodule_repo_env(&cp
.env_array
);
1409 if (run_command(&cp
))
1416 * Check if it is a bad idea to remove a submodule, i.e. if we'd lose data
1419 * Return 1 if we'd lose data, return 0 if the removal is fine,
1420 * and negative values for errors.
1422 int bad_to_remove_submodule(const char *path
, unsigned flags
)
1425 struct child_process cp
= CHILD_PROCESS_INIT
;
1426 struct strbuf buf
= STRBUF_INIT
;
1429 if (!file_exists(path
) || is_empty_dir(path
))
1432 if (!submodule_uses_gitfile(path
))
1435 argv_array_pushl(&cp
.args
, "status", "--porcelain",
1436 "--ignore-submodules=none", NULL
);
1438 if (flags
& SUBMODULE_REMOVAL_IGNORE_UNTRACKED
)
1439 argv_array_push(&cp
.args
, "-uno");
1441 argv_array_push(&cp
.args
, "-uall");
1443 if (!(flags
& SUBMODULE_REMOVAL_IGNORE_IGNORED_UNTRACKED
))
1444 argv_array_push(&cp
.args
, "--ignored");
1446 prepare_submodule_repo_env(&cp
.env_array
);
1451 if (start_command(&cp
)) {
1452 if (flags
& SUBMODULE_REMOVAL_DIE_ON_ERROR
)
1453 die(_("could not start 'git status' in submodule '%s'"),
1459 len
= strbuf_read(&buf
, cp
.out
, 1024);
1464 if (finish_command(&cp
)) {
1465 if (flags
& SUBMODULE_REMOVAL_DIE_ON_ERROR
)
1466 die(_("could not run 'git status' in submodule '%s'"),
1471 strbuf_release(&buf
);
1475 static const char *get_super_prefix_or_empty(void)
1477 const char *s
= get_super_prefix();
1483 static int submodule_has_dirty_index(const struct submodule
*sub
)
1485 struct child_process cp
= CHILD_PROCESS_INIT
;
1487 prepare_submodule_repo_env(&cp
.env_array
);
1490 argv_array_pushl(&cp
.args
, "diff-index", "--quiet",
1491 "--cached", "HEAD", NULL
);
1495 if (start_command(&cp
))
1496 die("could not recurse into submodule '%s'", sub
->path
);
1498 return finish_command(&cp
);
1501 static void submodule_reset_index(const char *path
)
1503 struct child_process cp
= CHILD_PROCESS_INIT
;
1504 prepare_submodule_repo_env(&cp
.env_array
);
1510 argv_array_pushf(&cp
.args
, "--super-prefix=%s%s/",
1511 get_super_prefix_or_empty(), path
);
1512 argv_array_pushl(&cp
.args
, "read-tree", "-u", "--reset", NULL
);
1514 argv_array_push(&cp
.args
, EMPTY_TREE_SHA1_HEX
);
1516 if (run_command(&cp
))
1517 die("could not reset submodule index");
1521 * Moves a submodule at a given path from a given head to another new head.
1522 * For edge cases (a submodule coming into existence or removing a submodule)
1523 * pass NULL for old or new respectively.
1525 int submodule_move_head(const char *path
,
1531 struct child_process cp
= CHILD_PROCESS_INIT
;
1532 const struct submodule
*sub
;
1533 int *error_code_ptr
, error_code
;
1535 if (!is_submodule_initialized(path
))
1538 if (flags
& SUBMODULE_MOVE_HEAD_FORCE
)
1540 * Pass non NULL pointer to is_submodule_populated_gently
1541 * to prevent die()-ing. We'll use connect_work_tree_and_git_dir
1542 * to fixup the submodule in the force case later.
1544 error_code_ptr
= &error_code
;
1546 error_code_ptr
= NULL
;
1548 if (old
&& !is_submodule_populated_gently(path
, error_code_ptr
))
1551 sub
= submodule_from_path(null_sha1
, path
);
1554 die("BUG: could not get submodule information for '%s'", path
);
1556 if (old
&& !(flags
& SUBMODULE_MOVE_HEAD_FORCE
)) {
1557 /* Check if the submodule has a dirty index. */
1558 if (submodule_has_dirty_index(sub
))
1559 return error(_("submodule '%s' has dirty index"), path
);
1562 if (!(flags
& SUBMODULE_MOVE_HEAD_DRY_RUN
)) {
1564 if (!submodule_uses_gitfile(path
))
1565 absorb_git_dir_into_superproject("", path
,
1566 ABSORB_GITDIR_RECURSE_SUBMODULES
);
1568 char *gitdir
= xstrfmt("%s/modules/%s",
1569 get_git_common_dir(), sub
->name
);
1570 connect_work_tree_and_git_dir(path
, gitdir
);
1573 /* make sure the index is clean as well */
1574 submodule_reset_index(path
);
1577 if (old
&& (flags
& SUBMODULE_MOVE_HEAD_FORCE
)) {
1578 char *gitdir
= xstrfmt("%s/modules/%s",
1579 get_git_common_dir(), sub
->name
);
1580 connect_work_tree_and_git_dir(path
, gitdir
);
1585 prepare_submodule_repo_env(&cp
.env_array
);
1591 argv_array_pushf(&cp
.args
, "--super-prefix=%s%s/",
1592 get_super_prefix_or_empty(), path
);
1593 argv_array_pushl(&cp
.args
, "read-tree", "--recurse-submodules", NULL
);
1595 if (flags
& SUBMODULE_MOVE_HEAD_DRY_RUN
)
1596 argv_array_push(&cp
.args
, "-n");
1598 argv_array_push(&cp
.args
, "-u");
1600 if (flags
& SUBMODULE_MOVE_HEAD_FORCE
)
1601 argv_array_push(&cp
.args
, "--reset");
1603 argv_array_push(&cp
.args
, "-m");
1605 argv_array_push(&cp
.args
, old
? old
: EMPTY_TREE_SHA1_HEX
);
1606 argv_array_push(&cp
.args
, new ? new : EMPTY_TREE_SHA1_HEX
);
1608 if (run_command(&cp
)) {
1613 if (!(flags
& SUBMODULE_MOVE_HEAD_DRY_RUN
)) {
1615 child_process_init(&cp
);
1616 /* also set the HEAD accordingly */
1621 prepare_submodule_repo_env(&cp
.env_array
);
1622 argv_array_pushl(&cp
.args
, "update-ref", "HEAD", new, NULL
);
1624 if (run_command(&cp
)) {
1629 struct strbuf sb
= STRBUF_INIT
;
1631 strbuf_addf(&sb
, "%s/.git", path
);
1632 unlink_or_warn(sb
.buf
);
1633 strbuf_release(&sb
);
1635 if (is_empty_dir(path
))
1636 rmdir_or_warn(path
);
1643 static int find_first_merges(struct object_array
*result
, const char *path
,
1644 struct commit
*a
, struct commit
*b
)
1647 struct object_array merges
= OBJECT_ARRAY_INIT
;
1648 struct commit
*commit
;
1649 int contains_another
;
1651 char merged_revision
[42];
1652 const char *rev_args
[] = { "rev-list", "--merges", "--ancestry-path",
1653 "--all", merged_revision
, NULL
};
1654 struct rev_info revs
;
1655 struct setup_revision_opt rev_opts
;
1657 memset(result
, 0, sizeof(struct object_array
));
1658 memset(&rev_opts
, 0, sizeof(rev_opts
));
1660 /* get all revisions that merge commit a */
1661 xsnprintf(merged_revision
, sizeof(merged_revision
), "^%s",
1662 oid_to_hex(&a
->object
.oid
));
1663 init_revisions(&revs
, NULL
);
1664 rev_opts
.submodule
= path
;
1665 setup_revisions(ARRAY_SIZE(rev_args
)-1, rev_args
, &revs
, &rev_opts
);
1667 /* save all revisions from the above list that contain b */
1668 if (prepare_revision_walk(&revs
))
1669 die("revision walk setup failed");
1670 while ((commit
= get_revision(&revs
)) != NULL
) {
1671 struct object
*o
= &(commit
->object
);
1672 if (in_merge_bases(b
, commit
))
1673 add_object_array(o
, NULL
, &merges
);
1675 reset_revision_walk();
1677 /* Now we've got all merges that contain a and b. Prune all
1678 * merges that contain another found merge and save them in
1681 for (i
= 0; i
< merges
.nr
; i
++) {
1682 struct commit
*m1
= (struct commit
*) merges
.objects
[i
].item
;
1684 contains_another
= 0;
1685 for (j
= 0; j
< merges
.nr
; j
++) {
1686 struct commit
*m2
= (struct commit
*) merges
.objects
[j
].item
;
1687 if (i
!= j
&& in_merge_bases(m2
, m1
)) {
1688 contains_another
= 1;
1693 if (!contains_another
)
1694 add_object_array(merges
.objects
[i
].item
, NULL
, result
);
1697 free(merges
.objects
);
1701 static void print_commit(struct commit
*commit
)
1703 struct strbuf sb
= STRBUF_INIT
;
1704 struct pretty_print_context ctx
= {0};
1705 ctx
.date_mode
.type
= DATE_NORMAL
;
1706 format_commit_message(commit
, " %h: %m %s", &sb
, &ctx
);
1707 fprintf(stderr
, "%s\n", sb
.buf
);
1708 strbuf_release(&sb
);
1711 #define MERGE_WARNING(path, msg) \
1712 warning("Failed to merge submodule %s (%s)", path, msg);
1714 int merge_submodule(struct object_id
*result
, const char *path
,
1715 const struct object_id
*base
, const struct object_id
*a
,
1716 const struct object_id
*b
, int search
)
1718 struct commit
*commit_base
, *commit_a
, *commit_b
;
1720 struct object_array merges
;
1724 /* store a in result in case we fail */
1727 /* we can not handle deletion conflicts */
1728 if (is_null_oid(base
))
1735 if (add_submodule_odb(path
)) {
1736 MERGE_WARNING(path
, "not checked out");
1740 if (!(commit_base
= lookup_commit_reference(base
)) ||
1741 !(commit_a
= lookup_commit_reference(a
)) ||
1742 !(commit_b
= lookup_commit_reference(b
))) {
1743 MERGE_WARNING(path
, "commits not present");
1747 /* check whether both changes are forward */
1748 if (!in_merge_bases(commit_base
, commit_a
) ||
1749 !in_merge_bases(commit_base
, commit_b
)) {
1750 MERGE_WARNING(path
, "commits don't follow merge-base");
1754 /* Case #1: a is contained in b or vice versa */
1755 if (in_merge_bases(commit_a
, commit_b
)) {
1759 if (in_merge_bases(commit_b
, commit_a
)) {
1765 * Case #2: There are one or more merges that contain a and b in
1766 * the submodule. If there is only one, then present it as a
1767 * suggestion to the user, but leave it marked unmerged so the
1768 * user needs to confirm the resolution.
1771 /* Skip the search if makes no sense to the calling context. */
1775 /* find commit which merges them */
1776 parent_count
= find_first_merges(&merges
, path
, commit_a
, commit_b
);
1777 switch (parent_count
) {
1779 MERGE_WARNING(path
, "merge following commits not found");
1783 MERGE_WARNING(path
, "not fast-forward");
1784 fprintf(stderr
, "Found a possible merge resolution "
1785 "for the submodule:\n");
1786 print_commit((struct commit
*) merges
.objects
[0].item
);
1788 "If this is correct simply add it to the index "
1791 " git update-index --cacheinfo 160000 %s \"%s\"\n\n"
1792 "which will accept this suggestion.\n",
1793 oid_to_hex(&merges
.objects
[0].item
->oid
), path
);
1797 MERGE_WARNING(path
, "multiple merges found");
1798 for (i
= 0; i
< merges
.nr
; i
++)
1799 print_commit((struct commit
*) merges
.objects
[i
].item
);
1802 free(merges
.objects
);
1806 int parallel_submodules(void)
1808 return parallel_jobs
;
1812 * Embeds a single submodules git directory into the superprojects git dir,
1815 static void relocate_single_git_dir_into_superproject(const char *prefix
,
1818 char *old_git_dir
= NULL
, *real_old_git_dir
= NULL
, *real_new_git_dir
= NULL
;
1819 const char *new_git_dir
;
1820 const struct submodule
*sub
;
1822 if (submodule_uses_worktrees(path
))
1823 die(_("relocate_gitdir for submodule '%s' with "
1824 "more than one worktree not supported"), path
);
1826 old_git_dir
= xstrfmt("%s/.git", path
);
1827 if (read_gitfile(old_git_dir
))
1828 /* If it is an actual gitfile, it doesn't need migration. */
1831 real_old_git_dir
= real_pathdup(old_git_dir
, 1);
1833 sub
= submodule_from_path(null_sha1
, path
);
1835 die(_("could not lookup name for submodule '%s'"), path
);
1837 new_git_dir
= git_path("modules/%s", sub
->name
);
1838 if (safe_create_leading_directories_const(new_git_dir
) < 0)
1839 die(_("could not create directory '%s'"), new_git_dir
);
1840 real_new_git_dir
= real_pathdup(new_git_dir
, 1);
1842 fprintf(stderr
, _("Migrating git directory of '%s%s' from\n'%s' to\n'%s'\n"),
1843 get_super_prefix_or_empty(), path
,
1844 real_old_git_dir
, real_new_git_dir
);
1846 relocate_gitdir(path
, real_old_git_dir
, real_new_git_dir
);
1849 free(real_old_git_dir
);
1850 free(real_new_git_dir
);
1854 * Migrate the git directory of the submodule given by path from
1855 * having its git directory within the working tree to the git dir nested
1856 * in its superprojects git dir under modules/.
1858 void absorb_git_dir_into_superproject(const char *prefix
,
1863 const char *sub_git_dir
;
1864 struct strbuf gitdir
= STRBUF_INIT
;
1865 strbuf_addf(&gitdir
, "%s/.git", path
);
1866 sub_git_dir
= resolve_gitdir_gently(gitdir
.buf
, &err_code
);
1868 /* Not populated? */
1870 const struct submodule
*sub
;
1872 if (err_code
== READ_GITFILE_ERR_STAT_FAILED
) {
1873 /* unpopulated as expected */
1874 strbuf_release(&gitdir
);
1878 if (err_code
!= READ_GITFILE_ERR_NOT_A_REPO
)
1879 /* We don't know what broke here. */
1880 read_gitfile_error_die(err_code
, path
, NULL
);
1883 * Maybe populated, but no git directory was found?
1884 * This can happen if the superproject is a submodule
1885 * itself and was just absorbed. The absorption of the
1886 * superproject did not rewrite the git file links yet,
1889 sub
= submodule_from_path(null_sha1
, path
);
1891 die(_("could not lookup name for submodule '%s'"), path
);
1892 connect_work_tree_and_git_dir(path
,
1893 git_path("modules/%s", sub
->name
));
1895 /* Is it already absorbed into the superprojects git dir? */
1896 char *real_sub_git_dir
= real_pathdup(sub_git_dir
, 1);
1897 char *real_common_git_dir
= real_pathdup(get_git_common_dir(), 1);
1899 if (!starts_with(real_sub_git_dir
, real_common_git_dir
))
1900 relocate_single_git_dir_into_superproject(prefix
, path
);
1902 free(real_sub_git_dir
);
1903 free(real_common_git_dir
);
1905 strbuf_release(&gitdir
);
1907 if (flags
& ABSORB_GITDIR_RECURSE_SUBMODULES
) {
1908 struct child_process cp
= CHILD_PROCESS_INIT
;
1909 struct strbuf sb
= STRBUF_INIT
;
1911 if (flags
& ~ABSORB_GITDIR_RECURSE_SUBMODULES
)
1912 die("BUG: we don't know how to pass the flags down?");
1914 strbuf_addstr(&sb
, get_super_prefix_or_empty());
1915 strbuf_addstr(&sb
, path
);
1916 strbuf_addch(&sb
, '/');
1921 argv_array_pushl(&cp
.args
, "--super-prefix", sb
.buf
,
1922 "submodule--helper",
1923 "absorb-git-dirs", NULL
);
1924 prepare_submodule_repo_env(&cp
.env_array
);
1925 if (run_command(&cp
))
1926 die(_("could not recurse into submodule '%s'"), path
);
1928 strbuf_release(&sb
);
1932 const char *get_superproject_working_tree(void)
1934 struct child_process cp
= CHILD_PROCESS_INIT
;
1935 struct strbuf sb
= STRBUF_INIT
;
1936 const char *one_up
= real_path_if_valid("../");
1937 const char *cwd
= xgetcwd();
1938 const char *ret
= NULL
;
1939 const char *subpath
;
1943 if (!is_inside_work_tree())
1946 * We might have a superproject, but it is harder
1954 subpath
= relative_path(cwd
, one_up
, &sb
);
1956 prepare_submodule_repo_env(&cp
.env_array
);
1957 argv_array_pop(&cp
.env_array
);
1959 argv_array_pushl(&cp
.args
, "--literal-pathspecs", "-C", "..",
1960 "ls-files", "-z", "--stage", "--full-name", "--",
1969 if (start_command(&cp
))
1970 die(_("could not start ls-files in .."));
1972 len
= strbuf_read(&sb
, cp
.out
, PATH_MAX
);
1975 if (starts_with(sb
.buf
, "160000")) {
1977 int cwd_len
= strlen(cwd
);
1978 char *super_sub
, *super_wt
;
1981 * There is a superproject having this repo as a submodule.
1982 * The format is <mode> SP <hash> SP <stage> TAB <full name> \0,
1983 * We're only interested in the name after the tab.
1985 super_sub
= strchr(sb
.buf
, '\t') + 1;
1986 super_sub_len
= sb
.buf
+ sb
.len
- super_sub
- 1;
1988 if (super_sub_len
> cwd_len
||
1989 strcmp(&cwd
[cwd_len
- super_sub_len
], super_sub
))
1990 die (_("BUG: returned path string doesn't match cwd?"));
1992 super_wt
= xstrdup(cwd
);
1993 super_wt
[cwd_len
- super_sub_len
] = '\0';
1995 ret
= real_path(super_wt
);
1998 strbuf_release(&sb
);
2000 code
= finish_command(&cp
);
2003 /* '../' is not a git repository */
2005 if (code
== 0 && len
== 0)
2006 /* There is an unrelated git repository at '../' */
2009 die(_("ls-tree returned unexpected return code %d"), code
);
2014 int submodule_to_gitdir(struct strbuf
*buf
, const char *submodule
)
2016 const struct submodule
*sub
;
2017 const char *git_dir
;
2021 strbuf_addstr(buf
, submodule
);
2022 strbuf_complete(buf
, '/');
2023 strbuf_addstr(buf
, ".git");
2025 git_dir
= read_gitfile(buf
->buf
);
2028 strbuf_addstr(buf
, git_dir
);
2030 if (!is_git_directory(buf
->buf
)) {
2031 gitmodules_config();
2032 sub
= submodule_from_path(null_sha1
, submodule
);
2038 strbuf_git_path(buf
, "%s/%s", "modules", sub
->name
);