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_update_recurse_submodules
= RECURSE_SUBMODULES_OFF
;
24 static struct string_list changed_submodule_paths
= STRING_LIST_INIT_DUP
;
25 static int initialized_fetch_ref_tips
;
26 static struct oid_array ref_tips_before_fetch
;
27 static struct oid_array ref_tips_after_fetch
;
30 * Check if the .gitmodules file is unmerged. Parsing of the .gitmodules file
31 * will be disabled because we can't guess what might be configured in
32 * .gitmodules unless the user resolves the conflict.
34 int is_gitmodules_unmerged(const struct index_state
*istate
)
36 int pos
= index_name_pos(istate
, GITMODULES_FILE
, strlen(GITMODULES_FILE
));
37 if (pos
< 0) { /* .gitmodules not found or isn't merged */
39 if (istate
->cache_nr
> pos
) { /* there is a .gitmodules */
40 const struct cache_entry
*ce
= istate
->cache
[pos
];
41 if (ce_namelen(ce
) == strlen(GITMODULES_FILE
) &&
42 !strcmp(ce
->name
, GITMODULES_FILE
))
51 * Check if the .gitmodules file has unstaged modifications. This must be
52 * checked before allowing modifications to the .gitmodules file with the
53 * intention to stage them later, because when continuing we would stage the
54 * modifications the user didn't stage herself too. That might change in a
55 * future version when we learn to stage the changes we do ourselves without
56 * staging any previous modifications.
58 int is_staging_gitmodules_ok(const struct index_state
*istate
)
60 int pos
= index_name_pos(istate
, GITMODULES_FILE
, strlen(GITMODULES_FILE
));
62 if ((pos
>= 0) && (pos
< istate
->cache_nr
)) {
64 if (lstat(GITMODULES_FILE
, &st
) == 0 &&
65 ce_match_stat(istate
->cache
[pos
], &st
, 0) & DATA_CHANGED
)
73 * Try to update the "path" entry in the "submodule.<name>" section of the
74 * .gitmodules file. Return 0 only if a .gitmodules file was found, a section
75 * with the correct path=<oldpath> setting was found and we could update it.
77 int update_path_in_gitmodules(const char *oldpath
, const char *newpath
)
79 struct strbuf entry
= STRBUF_INIT
;
80 const struct submodule
*submodule
;
82 if (!file_exists(GITMODULES_FILE
)) /* Do nothing without .gitmodules */
85 if (is_gitmodules_unmerged(&the_index
))
86 die(_("Cannot change unmerged .gitmodules, resolve merge conflicts first"));
88 submodule
= submodule_from_path(&null_oid
, oldpath
);
89 if (!submodule
|| !submodule
->name
) {
90 warning(_("Could not find section in .gitmodules where path=%s"), oldpath
);
93 strbuf_addstr(&entry
, "submodule.");
94 strbuf_addstr(&entry
, submodule
->name
);
95 strbuf_addstr(&entry
, ".path");
96 if (git_config_set_in_file_gently(GITMODULES_FILE
, entry
.buf
, newpath
) < 0) {
97 /* Maybe the user already did that, don't error out here */
98 warning(_("Could not update .gitmodules entry %s"), entry
.buf
);
99 strbuf_release(&entry
);
102 strbuf_release(&entry
);
107 * Try to remove the "submodule.<name>" section from .gitmodules where the given
108 * path is configured. Return 0 only if a .gitmodules file was found, a section
109 * with the correct path=<path> setting was found and we could remove it.
111 int remove_path_from_gitmodules(const char *path
)
113 struct strbuf sect
= STRBUF_INIT
;
114 const struct submodule
*submodule
;
116 if (!file_exists(GITMODULES_FILE
)) /* Do nothing without .gitmodules */
119 if (is_gitmodules_unmerged(&the_index
))
120 die(_("Cannot change unmerged .gitmodules, resolve merge conflicts first"));
122 submodule
= submodule_from_path(&null_oid
, path
);
123 if (!submodule
|| !submodule
->name
) {
124 warning(_("Could not find section in .gitmodules where path=%s"), path
);
127 strbuf_addstr(§
, "submodule.");
128 strbuf_addstr(§
, submodule
->name
);
129 if (git_config_rename_section_in_file(GITMODULES_FILE
, sect
.buf
, NULL
) < 0) {
130 /* Maybe the user already did that, don't error out here */
131 warning(_("Could not remove .gitmodules entry for %s"), path
);
132 strbuf_release(§
);
135 strbuf_release(§
);
139 void stage_updated_gitmodules(void)
141 if (add_file_to_cache(GITMODULES_FILE
, 0))
142 die(_("staging updated .gitmodules failed"));
145 static int add_submodule_odb(const char *path
)
147 struct strbuf objects_directory
= STRBUF_INIT
;
150 ret
= strbuf_git_path_submodule(&objects_directory
, path
, "objects/");
153 if (!is_directory(objects_directory
.buf
)) {
157 add_to_alternates_memory(objects_directory
.buf
);
159 strbuf_release(&objects_directory
);
163 void set_diffopt_flags_from_submodule_config(struct diff_options
*diffopt
,
166 const struct submodule
*submodule
= submodule_from_path(&null_oid
, path
);
168 if (submodule
->ignore
)
169 handle_ignore_submodules_arg(diffopt
, submodule
->ignore
);
170 else if (is_gitmodules_unmerged(&the_index
))
171 DIFF_OPT_SET(diffopt
, IGNORE_SUBMODULES
);
175 /* For loading from the .gitmodules file. */
176 static int git_modules_config(const char *var
, const char *value
, void *cb
)
178 if (starts_with(var
, "submodule."))
179 return parse_submodule_config_option(var
, value
);
183 /* Loads all submodule settings from the config. */
184 int submodule_config(const char *var
, const char *value
, void *cb
)
186 if (!strcmp(var
, "submodule.recurse")) {
187 int v
= git_config_bool(var
, value
) ?
188 RECURSE_SUBMODULES_ON
: RECURSE_SUBMODULES_OFF
;
189 config_update_recurse_submodules
= v
;
192 return git_modules_config(var
, value
, cb
);
196 /* Cheap function that only determines if we're interested in submodules at all */
197 int git_default_submodule_config(const char *var
, const char *value
, void *cb
)
199 if (!strcmp(var
, "submodule.recurse")) {
200 int v
= git_config_bool(var
, value
) ?
201 RECURSE_SUBMODULES_ON
: RECURSE_SUBMODULES_OFF
;
202 config_update_recurse_submodules
= v
;
207 int option_parse_recurse_submodules_worktree_updater(const struct option
*opt
,
208 const char *arg
, int unset
)
211 config_update_recurse_submodules
= RECURSE_SUBMODULES_OFF
;
215 config_update_recurse_submodules
=
216 parse_update_recurse_submodules_arg(opt
->long_name
,
219 config_update_recurse_submodules
= RECURSE_SUBMODULES_ON
;
224 void load_submodule_cache(void)
226 if (config_update_recurse_submodules
== RECURSE_SUBMODULES_OFF
)
230 git_config(submodule_config
, NULL
);
233 static int gitmodules_cb(const char *var
, const char *value
, void *data
)
235 struct repository
*repo
= data
;
236 return submodule_config_option(repo
, var
, value
);
239 void repo_read_gitmodules(struct repository
*repo
)
241 if (repo
->worktree
) {
244 if (repo_read_index(repo
) < 0)
247 gitmodules
= repo_worktree_path(repo
, GITMODULES_FILE
);
249 if (!is_gitmodules_unmerged(repo
->index
))
250 git_config_from_file(gitmodules_cb
, gitmodules
, repo
);
256 void gitmodules_config(void)
258 repo_read_gitmodules(the_repository
);
261 void gitmodules_config_oid(const struct object_id
*commit_oid
)
263 struct strbuf rev
= STRBUF_INIT
;
264 struct object_id oid
;
266 if (gitmodule_oid_from_commit(commit_oid
, &oid
, &rev
)) {
267 git_config_from_blob_oid(submodule_config
, rev
.buf
,
270 strbuf_release(&rev
);
274 * Determine if a submodule has been initialized at a given 'path'
276 int is_submodule_active(struct repository
*repo
, const char *path
)
281 const struct string_list
*sl
;
282 const struct submodule
*module
;
284 module
= submodule_from_cache(repo
, &null_oid
, path
);
286 /* early return if there isn't a path->module mapping */
290 /* submodule.<name>.active is set */
291 key
= xstrfmt("submodule.%s.active", module
->name
);
292 if (!repo_config_get_bool(repo
, key
, &ret
)) {
298 /* submodule.active is set */
299 sl
= repo_config_get_value_multi(repo
, "submodule.active");
302 struct argv_array args
= ARGV_ARRAY_INIT
;
303 const struct string_list_item
*item
;
305 for_each_string_list_item(item
, sl
) {
306 argv_array_push(&args
, item
->string
);
309 parse_pathspec(&ps
, 0, 0, NULL
, args
.argv
);
310 ret
= match_pathspec(&ps
, path
, strlen(path
), 0, NULL
, 1);
312 argv_array_clear(&args
);
317 /* fallback to checking if the URL is set */
318 key
= xstrfmt("submodule.%s.url", module
->name
);
319 ret
= !repo_config_get_string(repo
, key
, &value
);
326 int is_submodule_populated_gently(const char *path
, int *return_error_code
)
329 char *gitdir
= xstrfmt("%s/.git", path
);
331 if (resolve_gitdir_gently(gitdir
, return_error_code
))
339 * Dies if the provided 'prefix' corresponds to an unpopulated submodule
341 void die_in_unpopulated_submodule(const struct index_state
*istate
,
349 prefixlen
= strlen(prefix
);
351 for (i
= 0; i
< istate
->cache_nr
; i
++) {
352 struct cache_entry
*ce
= istate
->cache
[i
];
353 int ce_len
= ce_namelen(ce
);
355 if (!S_ISGITLINK(ce
->ce_mode
))
357 if (prefixlen
<= ce_len
)
359 if (strncmp(ce
->name
, prefix
, ce_len
))
361 if (prefix
[ce_len
] != '/')
364 die(_("in unpopulated submodule '%s'"), ce
->name
);
369 * Dies if any paths in the provided pathspec descends into a submodule
371 void die_path_inside_submodule(const struct index_state
*istate
,
372 const struct pathspec
*ps
)
376 for (i
= 0; i
< istate
->cache_nr
; i
++) {
377 struct cache_entry
*ce
= istate
->cache
[i
];
378 int ce_len
= ce_namelen(ce
);
380 if (!S_ISGITLINK(ce
->ce_mode
))
383 for (j
= 0; j
< ps
->nr
; j
++) {
384 const struct pathspec_item
*item
= &ps
->items
[j
];
386 if (item
->len
<= ce_len
)
388 if (item
->match
[ce_len
] != '/')
390 if (strncmp(ce
->name
, item
->match
, ce_len
))
392 if (item
->len
== ce_len
+ 1)
395 die(_("Pathspec '%s' is in submodule '%.*s'"),
396 item
->original
, ce_len
, ce
->name
);
401 int parse_submodule_update_strategy(const char *value
,
402 struct submodule_update_strategy
*dst
)
404 free((void*)dst
->command
);
406 if (!strcmp(value
, "none"))
407 dst
->type
= SM_UPDATE_NONE
;
408 else if (!strcmp(value
, "checkout"))
409 dst
->type
= SM_UPDATE_CHECKOUT
;
410 else if (!strcmp(value
, "rebase"))
411 dst
->type
= SM_UPDATE_REBASE
;
412 else if (!strcmp(value
, "merge"))
413 dst
->type
= SM_UPDATE_MERGE
;
414 else if (skip_prefix(value
, "!", &value
)) {
415 dst
->type
= SM_UPDATE_COMMAND
;
416 dst
->command
= xstrdup(value
);
422 const char *submodule_strategy_to_string(const struct submodule_update_strategy
*s
)
424 struct strbuf sb
= STRBUF_INIT
;
426 case SM_UPDATE_CHECKOUT
:
428 case SM_UPDATE_MERGE
:
430 case SM_UPDATE_REBASE
:
434 case SM_UPDATE_UNSPECIFIED
:
436 case SM_UPDATE_COMMAND
:
437 strbuf_addf(&sb
, "!%s", s
->command
);
438 return strbuf_detach(&sb
, NULL
);
443 void handle_ignore_submodules_arg(struct diff_options
*diffopt
,
446 DIFF_OPT_CLR(diffopt
, IGNORE_SUBMODULES
);
447 DIFF_OPT_CLR(diffopt
, IGNORE_UNTRACKED_IN_SUBMODULES
);
448 DIFF_OPT_CLR(diffopt
, IGNORE_DIRTY_SUBMODULES
);
450 if (!strcmp(arg
, "all"))
451 DIFF_OPT_SET(diffopt
, IGNORE_SUBMODULES
);
452 else if (!strcmp(arg
, "untracked"))
453 DIFF_OPT_SET(diffopt
, IGNORE_UNTRACKED_IN_SUBMODULES
);
454 else if (!strcmp(arg
, "dirty"))
455 DIFF_OPT_SET(diffopt
, IGNORE_DIRTY_SUBMODULES
);
456 else if (strcmp(arg
, "none"))
457 die("bad --ignore-submodules argument: %s", arg
);
460 static int prepare_submodule_summary(struct rev_info
*rev
, const char *path
,
461 struct commit
*left
, struct commit
*right
,
462 struct commit_list
*merge_bases
)
464 struct commit_list
*list
;
466 init_revisions(rev
, NULL
);
467 setup_revisions(0, NULL
, rev
, NULL
);
469 rev
->first_parent_only
= 1;
470 left
->object
.flags
|= SYMMETRIC_LEFT
;
471 add_pending_object(rev
, &left
->object
, path
);
472 add_pending_object(rev
, &right
->object
, path
);
473 for (list
= merge_bases
; list
; list
= list
->next
) {
474 list
->item
->object
.flags
|= UNINTERESTING
;
475 add_pending_object(rev
, &list
->item
->object
,
476 oid_to_hex(&list
->item
->object
.oid
));
478 return prepare_revision_walk(rev
);
481 static void print_submodule_summary(struct rev_info
*rev
, struct diff_options
*o
)
483 static const char format
[] = " %m %s";
484 struct strbuf sb
= STRBUF_INIT
;
485 struct commit
*commit
;
487 while ((commit
= get_revision(rev
))) {
488 struct pretty_print_context ctx
= {0};
489 ctx
.date_mode
= rev
->date_mode
;
490 ctx
.output_encoding
= get_log_output_encoding();
491 strbuf_setlen(&sb
, 0);
492 format_commit_message(commit
, format
, &sb
, &ctx
);
493 strbuf_addch(&sb
, '\n');
494 if (commit
->object
.flags
& SYMMETRIC_LEFT
)
495 diff_emit_submodule_del(o
, sb
.buf
);
497 diff_emit_submodule_add(o
, sb
.buf
);
502 static void prepare_submodule_repo_env_no_git_dir(struct argv_array
*out
)
504 const char * const *var
;
506 for (var
= local_repo_env
; *var
; var
++) {
507 if (strcmp(*var
, CONFIG_DATA_ENVIRONMENT
))
508 argv_array_push(out
, *var
);
512 void prepare_submodule_repo_env(struct argv_array
*out
)
514 prepare_submodule_repo_env_no_git_dir(out
);
515 argv_array_pushf(out
, "%s=%s", GIT_DIR_ENVIRONMENT
,
516 DEFAULT_GIT_DIR_ENVIRONMENT
);
519 /* Helper function to display the submodule header line prior to the full
520 * summary output. If it can locate the submodule objects directory it will
521 * attempt to lookup both the left and right commits and put them into the
522 * left and right pointers.
524 static void show_submodule_header(struct diff_options
*o
, const char *path
,
525 struct object_id
*one
, struct object_id
*two
,
526 unsigned dirty_submodule
,
527 struct commit
**left
, struct commit
**right
,
528 struct commit_list
**merge_bases
)
530 const char *message
= NULL
;
531 struct strbuf sb
= STRBUF_INIT
;
532 int fast_forward
= 0, fast_backward
= 0;
534 if (dirty_submodule
& DIRTY_SUBMODULE_UNTRACKED
)
535 diff_emit_submodule_untracked(o
, path
);
537 if (dirty_submodule
& DIRTY_SUBMODULE_MODIFIED
)
538 diff_emit_submodule_modified(o
, path
);
540 if (is_null_oid(one
))
541 message
= "(new submodule)";
542 else if (is_null_oid(two
))
543 message
= "(submodule deleted)";
545 if (add_submodule_odb(path
)) {
547 message
= "(not initialized)";
552 * Attempt to lookup the commit references, and determine if this is
553 * a fast forward or fast backwards update.
555 *left
= lookup_commit_reference(one
);
556 *right
= lookup_commit_reference(two
);
559 * Warn about missing commits in the submodule project, but only if
562 if ((!is_null_oid(one
) && !*left
) ||
563 (!is_null_oid(two
) && !*right
))
564 message
= "(commits not present)";
566 *merge_bases
= get_merge_bases(*left
, *right
);
568 if ((*merge_bases
)->item
== *left
)
570 else if ((*merge_bases
)->item
== *right
)
574 if (!oidcmp(one
, two
)) {
580 strbuf_addf(&sb
, "Submodule %s ", path
);
581 strbuf_add_unique_abbrev(&sb
, one
->hash
, DEFAULT_ABBREV
);
582 strbuf_addstr(&sb
, (fast_backward
|| fast_forward
) ? ".." : "...");
583 strbuf_add_unique_abbrev(&sb
, two
->hash
, DEFAULT_ABBREV
);
585 strbuf_addf(&sb
, " %s\n", message
);
587 strbuf_addf(&sb
, "%s:\n", fast_backward
? " (rewind)" : "");
588 diff_emit_submodule_header(o
, sb
.buf
);
593 void show_submodule_summary(struct diff_options
*o
, const char *path
,
594 struct object_id
*one
, struct object_id
*two
,
595 unsigned dirty_submodule
)
598 struct commit
*left
= NULL
, *right
= NULL
;
599 struct commit_list
*merge_bases
= NULL
;
601 show_submodule_header(o
, path
, one
, two
, dirty_submodule
,
602 &left
, &right
, &merge_bases
);
605 * If we don't have both a left and a right pointer, there is no
606 * reason to try and display a summary. The header line should contain
607 * all the information the user needs.
612 /* Treat revision walker failure the same as missing commits */
613 if (prepare_submodule_summary(&rev
, path
, left
, right
, merge_bases
)) {
614 diff_emit_submodule_error(o
, "(revision walker failed)\n");
618 print_submodule_summary(&rev
, o
);
622 free_commit_list(merge_bases
);
623 clear_commit_marks(left
, ~0);
624 clear_commit_marks(right
, ~0);
627 void show_submodule_inline_diff(struct diff_options
*o
, const char *path
,
628 struct object_id
*one
, struct object_id
*two
,
629 unsigned dirty_submodule
)
631 const struct object_id
*old
= &empty_tree_oid
, *new = &empty_tree_oid
;
632 struct commit
*left
= NULL
, *right
= NULL
;
633 struct commit_list
*merge_bases
= NULL
;
634 struct child_process cp
= CHILD_PROCESS_INIT
;
635 struct strbuf sb
= STRBUF_INIT
;
637 show_submodule_header(o
, path
, one
, two
, dirty_submodule
,
638 &left
, &right
, &merge_bases
);
640 /* We need a valid left and right commit to display a difference */
641 if (!(left
|| is_null_oid(one
)) ||
642 !(right
|| is_null_oid(two
)))
655 /* TODO: other options may need to be passed here. */
656 argv_array_pushl(&cp
.args
, "diff", "--submodule=diff", NULL
);
657 argv_array_pushf(&cp
.args
, "--color=%s", want_color(o
->use_color
) ?
660 if (DIFF_OPT_TST(o
, REVERSE_DIFF
)) {
661 argv_array_pushf(&cp
.args
, "--src-prefix=%s%s/",
663 argv_array_pushf(&cp
.args
, "--dst-prefix=%s%s/",
666 argv_array_pushf(&cp
.args
, "--src-prefix=%s%s/",
668 argv_array_pushf(&cp
.args
, "--dst-prefix=%s%s/",
671 argv_array_push(&cp
.args
, oid_to_hex(old
));
673 * If the submodule has modified content, we will diff against the
674 * work tree, under the assumption that the user has asked for the
675 * diff format and wishes to actually see all differences even if they
676 * haven't yet been committed to the submodule yet.
678 if (!(dirty_submodule
& DIRTY_SUBMODULE_MODIFIED
))
679 argv_array_push(&cp
.args
, oid_to_hex(new));
681 prepare_submodule_repo_env(&cp
.env_array
);
682 if (start_command(&cp
))
683 diff_emit_submodule_error(o
, "(diff failed)\n");
685 while (strbuf_getwholeline_fd(&sb
, cp
.out
, '\n') != EOF
)
686 diff_emit_submodule_pipethrough(o
, sb
.buf
, sb
.len
);
688 if (finish_command(&cp
))
689 diff_emit_submodule_error(o
, "(diff failed)\n");
694 free_commit_list(merge_bases
);
696 clear_commit_marks(left
, ~0);
698 clear_commit_marks(right
, ~0);
701 int should_update_submodules(void)
703 return config_update_recurse_submodules
== RECURSE_SUBMODULES_ON
;
706 const struct submodule
*submodule_from_ce(const struct cache_entry
*ce
)
708 if (!S_ISGITLINK(ce
->ce_mode
))
711 if (!should_update_submodules())
714 return submodule_from_path(&null_oid
, ce
->name
);
717 static struct oid_array
*submodule_commits(struct string_list
*submodules
,
720 struct string_list_item
*item
;
722 item
= string_list_insert(submodules
, path
);
724 return (struct oid_array
*) item
->util
;
726 /* NEEDSWORK: should we have oid_array_init()? */
727 item
->util
= xcalloc(1, sizeof(struct oid_array
));
728 return (struct oid_array
*) item
->util
;
731 static void collect_changed_submodules_cb(struct diff_queue_struct
*q
,
732 struct diff_options
*options
,
736 struct string_list
*changed
= data
;
738 for (i
= 0; i
< q
->nr
; i
++) {
739 struct diff_filepair
*p
= q
->queue
[i
];
740 struct oid_array
*commits
;
741 if (!S_ISGITLINK(p
->two
->mode
))
744 if (S_ISGITLINK(p
->one
->mode
)) {
746 * NEEDSWORK: We should honor the name configured in
747 * the .gitmodules file of the commit we are examining
748 * here to be able to correctly follow submodules
749 * being moved around.
751 commits
= submodule_commits(changed
, p
->two
->path
);
752 oid_array_append(commits
, &p
->two
->oid
);
754 /* Submodule is new or was moved here */
756 * NEEDSWORK: When the .git directories of submodules
757 * live inside the superprojects .git directory some
758 * day we should fetch new submodules directly into
759 * that location too when config or options request
760 * that so they can be checked out from there.
768 * Collect the paths of submodules in 'changed' which have changed based on
769 * the revisions as specified in 'argv'. Each entry in 'changed' will also
770 * have a corresponding 'struct oid_array' (in the 'util' field) which lists
771 * what the submodule pointers were updated to during the change.
773 static void collect_changed_submodules(struct string_list
*changed
,
774 struct argv_array
*argv
)
777 const struct commit
*commit
;
779 init_revisions(&rev
, NULL
);
780 setup_revisions(argv
->argc
, argv
->argv
, &rev
, NULL
);
781 if (prepare_revision_walk(&rev
))
782 die("revision walk setup failed");
784 while ((commit
= get_revision(&rev
))) {
785 struct rev_info diff_rev
;
787 init_revisions(&diff_rev
, NULL
);
788 diff_rev
.diffopt
.output_format
|= DIFF_FORMAT_CALLBACK
;
789 diff_rev
.diffopt
.format_callback
= collect_changed_submodules_cb
;
790 diff_rev
.diffopt
.format_callback_data
= changed
;
791 diff_tree_combined_merge(commit
, 1, &diff_rev
);
794 reset_revision_walk();
797 static void free_submodules_oids(struct string_list
*submodules
)
799 struct string_list_item
*item
;
800 for_each_string_list_item(item
, submodules
)
801 oid_array_clear((struct oid_array
*) item
->util
);
802 string_list_clear(submodules
, 1);
805 static int has_remote(const char *refname
, const struct object_id
*oid
,
806 int flags
, void *cb_data
)
811 static int append_oid_to_argv(const struct object_id
*oid
, void *data
)
813 struct argv_array
*argv
= data
;
814 argv_array_push(argv
, oid_to_hex(oid
));
818 static int check_has_commit(const struct object_id
*oid
, void *data
)
820 int *has_commit
= data
;
822 if (!lookup_commit_reference(oid
))
828 static int submodule_has_commits(const char *path
, struct oid_array
*commits
)
833 * Perform a cheap, but incorrect check for the existence of 'commits'.
834 * This is done by adding the submodule's object store to the in-core
835 * object store, and then querying for each commit's existence. If we
836 * do not have the commit object anywhere, there is no chance we have
837 * it in the object store of the correct submodule and have it
838 * reachable from a ref, so we can fail early without spawning rev-list
839 * which is expensive.
841 if (add_submodule_odb(path
))
844 oid_array_for_each_unique(commits
, check_has_commit
, &has_commit
);
848 * Even if the submodule is checked out and the commit is
849 * present, make sure it exists in the submodule's object store
850 * and that it is reachable from a ref.
852 struct child_process cp
= CHILD_PROCESS_INIT
;
853 struct strbuf out
= STRBUF_INIT
;
855 argv_array_pushl(&cp
.args
, "rev-list", "-n", "1", NULL
);
856 oid_array_for_each_unique(commits
, append_oid_to_argv
, &cp
.args
);
857 argv_array_pushl(&cp
.args
, "--not", "--all", NULL
);
859 prepare_submodule_repo_env(&cp
.env_array
);
864 if (capture_command(&cp
, &out
, GIT_MAX_HEXSZ
+ 1) || out
.len
)
867 strbuf_release(&out
);
873 static int submodule_needs_pushing(const char *path
, struct oid_array
*commits
)
875 if (!submodule_has_commits(path
, commits
))
877 * NOTE: We do consider it safe to return "no" here. The
878 * correct answer would be "We do not know" instead of
879 * "No push needed", but it is quite hard to change
880 * the submodule pointer without having the submodule
881 * around. If a user did however change the submodules
882 * without having the submodule around, this indicates
883 * an expert who knows what they are doing or a
884 * maintainer integrating work from other people. In
885 * both cases it should be safe to skip this check.
889 if (for_each_remote_ref_submodule(path
, has_remote
, NULL
) > 0) {
890 struct child_process cp
= CHILD_PROCESS_INIT
;
891 struct strbuf buf
= STRBUF_INIT
;
892 int needs_pushing
= 0;
894 argv_array_push(&cp
.args
, "rev-list");
895 oid_array_for_each_unique(commits
, append_oid_to_argv
, &cp
.args
);
896 argv_array_pushl(&cp
.args
, "--not", "--remotes", "-n", "1" , NULL
);
898 prepare_submodule_repo_env(&cp
.env_array
);
903 if (start_command(&cp
))
904 die("Could not run 'git rev-list <commits> --not --remotes -n 1' command in submodule %s",
906 if (strbuf_read(&buf
, cp
.out
, 41))
910 strbuf_release(&buf
);
911 return needs_pushing
;
917 int find_unpushed_submodules(struct oid_array
*commits
,
918 const char *remotes_name
, struct string_list
*needs_pushing
)
920 struct string_list submodules
= STRING_LIST_INIT_DUP
;
921 struct string_list_item
*submodule
;
922 struct argv_array argv
= ARGV_ARRAY_INIT
;
924 /* argv.argv[0] will be ignored by setup_revisions */
925 argv_array_push(&argv
, "find_unpushed_submodules");
926 oid_array_for_each_unique(commits
, append_oid_to_argv
, &argv
);
927 argv_array_push(&argv
, "--not");
928 argv_array_pushf(&argv
, "--remotes=%s", remotes_name
);
930 collect_changed_submodules(&submodules
, &argv
);
932 for_each_string_list_item(submodule
, &submodules
) {
933 struct oid_array
*commits
= submodule
->util
;
934 const char *path
= submodule
->string
;
936 if (submodule_needs_pushing(path
, commits
))
937 string_list_insert(needs_pushing
, path
);
940 free_submodules_oids(&submodules
);
941 argv_array_clear(&argv
);
943 return needs_pushing
->nr
;
946 static int push_submodule(const char *path
,
947 const struct remote
*remote
,
948 const char **refspec
, int refspec_nr
,
949 const struct string_list
*push_options
,
952 if (add_submodule_odb(path
))
955 if (for_each_remote_ref_submodule(path
, has_remote
, NULL
) > 0) {
956 struct child_process cp
= CHILD_PROCESS_INIT
;
957 argv_array_push(&cp
.args
, "push");
959 argv_array_push(&cp
.args
, "--dry-run");
961 if (push_options
&& push_options
->nr
) {
962 const struct string_list_item
*item
;
963 for_each_string_list_item(item
, push_options
)
964 argv_array_pushf(&cp
.args
, "--push-option=%s",
968 if (remote
->origin
!= REMOTE_UNCONFIGURED
) {
970 argv_array_push(&cp
.args
, remote
->name
);
971 for (i
= 0; i
< refspec_nr
; i
++)
972 argv_array_push(&cp
.args
, refspec
[i
]);
975 prepare_submodule_repo_env(&cp
.env_array
);
979 if (run_command(&cp
))
988 * Perform a check in the submodule to see if the remote and refspec work.
989 * Die if the submodule can't be pushed.
991 static void submodule_push_check(const char *path
, const char *head
,
992 const struct remote
*remote
,
993 const char **refspec
, int refspec_nr
)
995 struct child_process cp
= CHILD_PROCESS_INIT
;
998 argv_array_push(&cp
.args
, "submodule--helper");
999 argv_array_push(&cp
.args
, "push-check");
1000 argv_array_push(&cp
.args
, head
);
1001 argv_array_push(&cp
.args
, remote
->name
);
1003 for (i
= 0; i
< refspec_nr
; i
++)
1004 argv_array_push(&cp
.args
, refspec
[i
]);
1006 prepare_submodule_repo_env(&cp
.env_array
);
1013 * Simply indicate if 'submodule--helper push-check' failed.
1014 * More detailed error information will be provided by the
1017 if (run_command(&cp
))
1018 die("process for submodule '%s' failed", path
);
1021 int push_unpushed_submodules(struct oid_array
*commits
,
1022 const struct remote
*remote
,
1023 const char **refspec
, int refspec_nr
,
1024 const struct string_list
*push_options
,
1028 struct string_list needs_pushing
= STRING_LIST_INIT_DUP
;
1030 if (!find_unpushed_submodules(commits
, remote
->name
, &needs_pushing
))
1034 * Verify that the remote and refspec can be propagated to all
1035 * submodules. This check can be skipped if the remote and refspec
1036 * won't be propagated due to the remote being unconfigured (e.g. a URL
1037 * instead of a remote name).
1039 if (remote
->origin
!= REMOTE_UNCONFIGURED
) {
1041 struct object_id head_oid
;
1043 head
= resolve_refdup("HEAD", 0, head_oid
.hash
, NULL
);
1045 die(_("Failed to resolve HEAD as a valid ref."));
1047 for (i
= 0; i
< needs_pushing
.nr
; i
++)
1048 submodule_push_check(needs_pushing
.items
[i
].string
,
1050 refspec
, refspec_nr
);
1054 /* Actually push the submodules */
1055 for (i
= 0; i
< needs_pushing
.nr
; i
++) {
1056 const char *path
= needs_pushing
.items
[i
].string
;
1057 fprintf(stderr
, "Pushing submodule '%s'\n", path
);
1058 if (!push_submodule(path
, remote
, refspec
, refspec_nr
,
1059 push_options
, dry_run
)) {
1060 fprintf(stderr
, "Unable to push submodule '%s'\n", path
);
1065 string_list_clear(&needs_pushing
, 0);
1070 static int append_oid_to_array(const char *ref
, const struct object_id
*oid
,
1071 int flags
, void *data
)
1073 struct oid_array
*array
= data
;
1074 oid_array_append(array
, oid
);
1078 void check_for_new_submodule_commits(struct object_id
*oid
)
1080 if (!initialized_fetch_ref_tips
) {
1081 for_each_ref(append_oid_to_array
, &ref_tips_before_fetch
);
1082 initialized_fetch_ref_tips
= 1;
1085 oid_array_append(&ref_tips_after_fetch
, oid
);
1088 static void calculate_changed_submodule_paths(void)
1090 struct argv_array argv
= ARGV_ARRAY_INIT
;
1091 struct string_list changed_submodules
= STRING_LIST_INIT_DUP
;
1092 const struct string_list_item
*item
;
1094 /* No need to check if there are no submodules configured */
1095 if (!submodule_from_path(NULL
, NULL
))
1098 argv_array_push(&argv
, "--"); /* argv[0] program name */
1099 oid_array_for_each_unique(&ref_tips_after_fetch
,
1100 append_oid_to_argv
, &argv
);
1101 argv_array_push(&argv
, "--not");
1102 oid_array_for_each_unique(&ref_tips_before_fetch
,
1103 append_oid_to_argv
, &argv
);
1106 * Collect all submodules (whether checked out or not) for which new
1107 * commits have been recorded upstream in "changed_submodule_paths".
1109 collect_changed_submodules(&changed_submodules
, &argv
);
1111 for_each_string_list_item(item
, &changed_submodules
) {
1112 struct oid_array
*commits
= item
->util
;
1113 const char *path
= item
->string
;
1115 if (!submodule_has_commits(path
, commits
))
1116 string_list_append(&changed_submodule_paths
, path
);
1119 free_submodules_oids(&changed_submodules
);
1120 argv_array_clear(&argv
);
1121 oid_array_clear(&ref_tips_before_fetch
);
1122 oid_array_clear(&ref_tips_after_fetch
);
1123 initialized_fetch_ref_tips
= 0;
1126 int submodule_touches_in_range(struct object_id
*excl_oid
,
1127 struct object_id
*incl_oid
)
1129 struct string_list subs
= STRING_LIST_INIT_DUP
;
1130 struct argv_array args
= ARGV_ARRAY_INIT
;
1133 gitmodules_config();
1134 /* No need to check if there are no submodules configured */
1135 if (!submodule_from_path(NULL
, NULL
))
1138 argv_array_push(&args
, "--"); /* args[0] program name */
1139 argv_array_push(&args
, oid_to_hex(incl_oid
));
1140 argv_array_push(&args
, "--not");
1141 argv_array_push(&args
, oid_to_hex(excl_oid
));
1143 collect_changed_submodules(&subs
, &args
);
1146 argv_array_clear(&args
);
1148 free_submodules_oids(&subs
);
1152 struct submodule_parallel_fetch
{
1154 struct argv_array args
;
1155 const char *work_tree
;
1157 int command_line_option
;
1162 #define SPF_INIT {0, ARGV_ARRAY_INIT, NULL, NULL, 0, 0, 0, 0}
1164 static int get_next_submodule(struct child_process
*cp
,
1165 struct strbuf
*err
, void *data
, void **task_cb
)
1168 struct submodule_parallel_fetch
*spf
= data
;
1170 for (; spf
->count
< active_nr
; spf
->count
++) {
1171 struct strbuf submodule_path
= STRBUF_INIT
;
1172 struct strbuf submodule_git_dir
= STRBUF_INIT
;
1173 struct strbuf submodule_prefix
= STRBUF_INIT
;
1174 const struct cache_entry
*ce
= active_cache
[spf
->count
];
1175 const char *git_dir
, *default_argv
;
1176 const struct submodule
*submodule
;
1178 if (!S_ISGITLINK(ce
->ce_mode
))
1181 submodule
= submodule_from_path(&null_oid
, ce
->name
);
1183 submodule
= submodule_from_name(&null_oid
, ce
->name
);
1185 default_argv
= "yes";
1186 if (spf
->command_line_option
== RECURSE_SUBMODULES_DEFAULT
) {
1188 submodule
->fetch_recurse
!=
1189 RECURSE_SUBMODULES_NONE
) {
1190 if (submodule
->fetch_recurse
==
1191 RECURSE_SUBMODULES_OFF
)
1193 if (submodule
->fetch_recurse
==
1194 RECURSE_SUBMODULES_ON_DEMAND
) {
1195 if (!unsorted_string_list_lookup(&changed_submodule_paths
, ce
->name
))
1197 default_argv
= "on-demand";
1200 if (spf
->default_option
== RECURSE_SUBMODULES_OFF
)
1202 if (spf
->default_option
== RECURSE_SUBMODULES_ON_DEMAND
) {
1203 if (!unsorted_string_list_lookup(&changed_submodule_paths
, ce
->name
))
1205 default_argv
= "on-demand";
1208 } else if (spf
->command_line_option
== RECURSE_SUBMODULES_ON_DEMAND
) {
1209 if (!unsorted_string_list_lookup(&changed_submodule_paths
, ce
->name
))
1211 default_argv
= "on-demand";
1214 strbuf_addf(&submodule_path
, "%s/%s", spf
->work_tree
, ce
->name
);
1215 strbuf_addf(&submodule_git_dir
, "%s/.git", submodule_path
.buf
);
1216 strbuf_addf(&submodule_prefix
, "%s%s/", spf
->prefix
, ce
->name
);
1217 git_dir
= read_gitfile(submodule_git_dir
.buf
);
1219 git_dir
= submodule_git_dir
.buf
;
1220 if (is_directory(git_dir
)) {
1221 child_process_init(cp
);
1222 cp
->dir
= strbuf_detach(&submodule_path
, NULL
);
1223 prepare_submodule_repo_env(&cp
->env_array
);
1226 strbuf_addf(err
, "Fetching submodule %s%s\n",
1227 spf
->prefix
, ce
->name
);
1228 argv_array_init(&cp
->args
);
1229 argv_array_pushv(&cp
->args
, spf
->args
.argv
);
1230 argv_array_push(&cp
->args
, default_argv
);
1231 argv_array_push(&cp
->args
, "--submodule-prefix");
1232 argv_array_push(&cp
->args
, submodule_prefix
.buf
);
1235 strbuf_release(&submodule_path
);
1236 strbuf_release(&submodule_git_dir
);
1237 strbuf_release(&submodule_prefix
);
1246 static int fetch_start_failure(struct strbuf
*err
,
1247 void *cb
, void *task_cb
)
1249 struct submodule_parallel_fetch
*spf
= cb
;
1256 static int fetch_finish(int retvalue
, struct strbuf
*err
,
1257 void *cb
, void *task_cb
)
1259 struct submodule_parallel_fetch
*spf
= cb
;
1267 int fetch_populated_submodules(const struct argv_array
*options
,
1268 const char *prefix
, int command_line_option
,
1270 int quiet
, int max_parallel_jobs
)
1273 struct submodule_parallel_fetch spf
= SPF_INIT
;
1275 spf
.work_tree
= get_git_work_tree();
1276 spf
.command_line_option
= command_line_option
;
1277 spf
.default_option
= default_option
;
1279 spf
.prefix
= prefix
;
1284 if (read_cache() < 0)
1285 die("index file corrupt");
1287 argv_array_push(&spf
.args
, "fetch");
1288 for (i
= 0; i
< options
->argc
; i
++)
1289 argv_array_push(&spf
.args
, options
->argv
[i
]);
1290 argv_array_push(&spf
.args
, "--recurse-submodules-default");
1291 /* default value, "--submodule-prefix" and its value are added later */
1293 calculate_changed_submodule_paths();
1294 run_processes_parallel(max_parallel_jobs
,
1296 fetch_start_failure
,
1300 argv_array_clear(&spf
.args
);
1302 string_list_clear(&changed_submodule_paths
, 1);
1306 unsigned is_submodule_modified(const char *path
, int ignore_untracked
)
1308 struct child_process cp
= CHILD_PROCESS_INIT
;
1309 struct strbuf buf
= STRBUF_INIT
;
1311 unsigned dirty_submodule
= 0;
1312 const char *git_dir
;
1313 int ignore_cp_exit_code
= 0;
1315 strbuf_addf(&buf
, "%s/.git", path
);
1316 git_dir
= read_gitfile(buf
.buf
);
1319 if (!is_git_directory(git_dir
)) {
1320 if (is_directory(git_dir
))
1321 die(_("'%s' not recognized as a git repository"), git_dir
);
1322 strbuf_release(&buf
);
1323 /* The submodule is not checked out, so it is not modified */
1328 argv_array_pushl(&cp
.args
, "status", "--porcelain=2", NULL
);
1329 if (ignore_untracked
)
1330 argv_array_push(&cp
.args
, "-uno");
1332 prepare_submodule_repo_env(&cp
.env_array
);
1337 if (start_command(&cp
))
1338 die("Could not run 'git status --porcelain=2' in submodule %s", path
);
1340 fp
= xfdopen(cp
.out
, "r");
1341 while (strbuf_getwholeline(&buf
, fp
, '\n') != EOF
) {
1342 /* regular untracked files */
1343 if (buf
.buf
[0] == '?')
1344 dirty_submodule
|= DIRTY_SUBMODULE_UNTRACKED
;
1346 if (buf
.buf
[0] == 'u' ||
1347 buf
.buf
[0] == '1' ||
1348 buf
.buf
[0] == '2') {
1349 /* T = line type, XY = status, SSSS = submodule state */
1350 if (buf
.len
< strlen("T XY SSSS"))
1351 die("BUG: invalid status --porcelain=2 line %s",
1354 if (buf
.buf
[5] == 'S' && buf
.buf
[8] == 'U')
1355 /* nested untracked file */
1356 dirty_submodule
|= DIRTY_SUBMODULE_UNTRACKED
;
1358 if (buf
.buf
[0] == 'u' ||
1359 buf
.buf
[0] == '2' ||
1360 memcmp(buf
.buf
+ 5, "S..U", 4))
1362 dirty_submodule
|= DIRTY_SUBMODULE_MODIFIED
;
1365 if ((dirty_submodule
& DIRTY_SUBMODULE_MODIFIED
) &&
1366 ((dirty_submodule
& DIRTY_SUBMODULE_UNTRACKED
) ||
1367 ignore_untracked
)) {
1369 * We're not interested in any further information from
1370 * the child any more, neither output nor its exit code.
1372 ignore_cp_exit_code
= 1;
1378 if (finish_command(&cp
) && !ignore_cp_exit_code
)
1379 die("'git status --porcelain=2' failed in submodule %s", path
);
1381 strbuf_release(&buf
);
1382 return dirty_submodule
;
1385 int submodule_uses_gitfile(const char *path
)
1387 struct child_process cp
= CHILD_PROCESS_INIT
;
1388 const char *argv
[] = {
1396 struct strbuf buf
= STRBUF_INIT
;
1397 const char *git_dir
;
1399 strbuf_addf(&buf
, "%s/.git", path
);
1400 git_dir
= read_gitfile(buf
.buf
);
1402 strbuf_release(&buf
);
1405 strbuf_release(&buf
);
1407 /* Now test that all nested submodules use a gitfile too */
1409 prepare_submodule_repo_env(&cp
.env_array
);
1415 if (run_command(&cp
))
1422 * Check if it is a bad idea to remove a submodule, i.e. if we'd lose data
1425 * Return 1 if we'd lose data, return 0 if the removal is fine,
1426 * and negative values for errors.
1428 int bad_to_remove_submodule(const char *path
, unsigned flags
)
1431 struct child_process cp
= CHILD_PROCESS_INIT
;
1432 struct strbuf buf
= STRBUF_INIT
;
1435 if (!file_exists(path
) || is_empty_dir(path
))
1438 if (!submodule_uses_gitfile(path
))
1441 argv_array_pushl(&cp
.args
, "status", "--porcelain",
1442 "--ignore-submodules=none", NULL
);
1444 if (flags
& SUBMODULE_REMOVAL_IGNORE_UNTRACKED
)
1445 argv_array_push(&cp
.args
, "-uno");
1447 argv_array_push(&cp
.args
, "-uall");
1449 if (!(flags
& SUBMODULE_REMOVAL_IGNORE_IGNORED_UNTRACKED
))
1450 argv_array_push(&cp
.args
, "--ignored");
1452 prepare_submodule_repo_env(&cp
.env_array
);
1457 if (start_command(&cp
)) {
1458 if (flags
& SUBMODULE_REMOVAL_DIE_ON_ERROR
)
1459 die(_("could not start 'git status' in submodule '%s'"),
1465 len
= strbuf_read(&buf
, cp
.out
, 1024);
1470 if (finish_command(&cp
)) {
1471 if (flags
& SUBMODULE_REMOVAL_DIE_ON_ERROR
)
1472 die(_("could not run 'git status' in submodule '%s'"),
1477 strbuf_release(&buf
);
1481 static const char *get_super_prefix_or_empty(void)
1483 const char *s
= get_super_prefix();
1489 static int submodule_has_dirty_index(const struct submodule
*sub
)
1491 struct child_process cp
= CHILD_PROCESS_INIT
;
1493 prepare_submodule_repo_env(&cp
.env_array
);
1496 argv_array_pushl(&cp
.args
, "diff-index", "--quiet",
1497 "--cached", "HEAD", NULL
);
1501 if (start_command(&cp
))
1502 die("could not recurse into submodule '%s'", sub
->path
);
1504 return finish_command(&cp
);
1507 static void submodule_reset_index(const char *path
)
1509 struct child_process cp
= CHILD_PROCESS_INIT
;
1510 prepare_submodule_repo_env(&cp
.env_array
);
1516 argv_array_pushf(&cp
.args
, "--super-prefix=%s%s/",
1517 get_super_prefix_or_empty(), path
);
1518 argv_array_pushl(&cp
.args
, "read-tree", "-u", "--reset", NULL
);
1520 argv_array_push(&cp
.args
, EMPTY_TREE_SHA1_HEX
);
1522 if (run_command(&cp
))
1523 die("could not reset submodule index");
1527 * Moves a submodule at a given path from a given head to another new head.
1528 * For edge cases (a submodule coming into existence or removing a submodule)
1529 * pass NULL for old or new respectively.
1531 int submodule_move_head(const char *path
,
1537 struct child_process cp
= CHILD_PROCESS_INIT
;
1538 const struct submodule
*sub
;
1539 int *error_code_ptr
, error_code
;
1541 if (!is_submodule_active(the_repository
, path
))
1544 if (flags
& SUBMODULE_MOVE_HEAD_FORCE
)
1546 * Pass non NULL pointer to is_submodule_populated_gently
1547 * to prevent die()-ing. We'll use connect_work_tree_and_git_dir
1548 * to fixup the submodule in the force case later.
1550 error_code_ptr
= &error_code
;
1552 error_code_ptr
= NULL
;
1554 if (old
&& !is_submodule_populated_gently(path
, error_code_ptr
))
1557 sub
= submodule_from_path(&null_oid
, path
);
1560 die("BUG: could not get submodule information for '%s'", path
);
1562 if (old
&& !(flags
& SUBMODULE_MOVE_HEAD_FORCE
)) {
1563 /* Check if the submodule has a dirty index. */
1564 if (submodule_has_dirty_index(sub
))
1565 return error(_("submodule '%s' has dirty index"), path
);
1568 if (!(flags
& SUBMODULE_MOVE_HEAD_DRY_RUN
)) {
1570 if (!submodule_uses_gitfile(path
))
1571 absorb_git_dir_into_superproject("", path
,
1572 ABSORB_GITDIR_RECURSE_SUBMODULES
);
1574 char *gitdir
= xstrfmt("%s/modules/%s",
1575 get_git_common_dir(), sub
->name
);
1576 connect_work_tree_and_git_dir(path
, gitdir
);
1579 /* make sure the index is clean as well */
1580 submodule_reset_index(path
);
1583 if (old
&& (flags
& SUBMODULE_MOVE_HEAD_FORCE
)) {
1584 char *gitdir
= xstrfmt("%s/modules/%s",
1585 get_git_common_dir(), sub
->name
);
1586 connect_work_tree_and_git_dir(path
, gitdir
);
1591 prepare_submodule_repo_env(&cp
.env_array
);
1597 argv_array_pushf(&cp
.args
, "--super-prefix=%s%s/",
1598 get_super_prefix_or_empty(), path
);
1599 argv_array_pushl(&cp
.args
, "read-tree", "--recurse-submodules", NULL
);
1601 if (flags
& SUBMODULE_MOVE_HEAD_DRY_RUN
)
1602 argv_array_push(&cp
.args
, "-n");
1604 argv_array_push(&cp
.args
, "-u");
1606 if (flags
& SUBMODULE_MOVE_HEAD_FORCE
)
1607 argv_array_push(&cp
.args
, "--reset");
1609 argv_array_push(&cp
.args
, "-m");
1611 argv_array_push(&cp
.args
, old
? old
: EMPTY_TREE_SHA1_HEX
);
1612 argv_array_push(&cp
.args
, new ? new : EMPTY_TREE_SHA1_HEX
);
1614 if (run_command(&cp
)) {
1619 if (!(flags
& SUBMODULE_MOVE_HEAD_DRY_RUN
)) {
1621 child_process_init(&cp
);
1622 /* also set the HEAD accordingly */
1627 prepare_submodule_repo_env(&cp
.env_array
);
1628 argv_array_pushl(&cp
.args
, "update-ref", "HEAD", new, NULL
);
1630 if (run_command(&cp
)) {
1635 struct strbuf sb
= STRBUF_INIT
;
1637 strbuf_addf(&sb
, "%s/.git", path
);
1638 unlink_or_warn(sb
.buf
);
1639 strbuf_release(&sb
);
1641 if (is_empty_dir(path
))
1642 rmdir_or_warn(path
);
1649 static int find_first_merges(struct object_array
*result
, const char *path
,
1650 struct commit
*a
, struct commit
*b
)
1653 struct object_array merges
= OBJECT_ARRAY_INIT
;
1654 struct commit
*commit
;
1655 int contains_another
;
1657 char merged_revision
[42];
1658 const char *rev_args
[] = { "rev-list", "--merges", "--ancestry-path",
1659 "--all", merged_revision
, NULL
};
1660 struct rev_info revs
;
1661 struct setup_revision_opt rev_opts
;
1663 memset(result
, 0, sizeof(struct object_array
));
1664 memset(&rev_opts
, 0, sizeof(rev_opts
));
1666 /* get all revisions that merge commit a */
1667 xsnprintf(merged_revision
, sizeof(merged_revision
), "^%s",
1668 oid_to_hex(&a
->object
.oid
));
1669 init_revisions(&revs
, NULL
);
1670 rev_opts
.submodule
= path
;
1671 setup_revisions(ARRAY_SIZE(rev_args
)-1, rev_args
, &revs
, &rev_opts
);
1673 /* save all revisions from the above list that contain b */
1674 if (prepare_revision_walk(&revs
))
1675 die("revision walk setup failed");
1676 while ((commit
= get_revision(&revs
)) != NULL
) {
1677 struct object
*o
= &(commit
->object
);
1678 if (in_merge_bases(b
, commit
))
1679 add_object_array(o
, NULL
, &merges
);
1681 reset_revision_walk();
1683 /* Now we've got all merges that contain a and b. Prune all
1684 * merges that contain another found merge and save them in
1687 for (i
= 0; i
< merges
.nr
; i
++) {
1688 struct commit
*m1
= (struct commit
*) merges
.objects
[i
].item
;
1690 contains_another
= 0;
1691 for (j
= 0; j
< merges
.nr
; j
++) {
1692 struct commit
*m2
= (struct commit
*) merges
.objects
[j
].item
;
1693 if (i
!= j
&& in_merge_bases(m2
, m1
)) {
1694 contains_another
= 1;
1699 if (!contains_another
)
1700 add_object_array(merges
.objects
[i
].item
, NULL
, result
);
1703 free(merges
.objects
);
1707 static void print_commit(struct commit
*commit
)
1709 struct strbuf sb
= STRBUF_INIT
;
1710 struct pretty_print_context ctx
= {0};
1711 ctx
.date_mode
.type
= DATE_NORMAL
;
1712 format_commit_message(commit
, " %h: %m %s", &sb
, &ctx
);
1713 fprintf(stderr
, "%s\n", sb
.buf
);
1714 strbuf_release(&sb
);
1717 #define MERGE_WARNING(path, msg) \
1718 warning("Failed to merge submodule %s (%s)", path, msg);
1720 int merge_submodule(struct object_id
*result
, const char *path
,
1721 const struct object_id
*base
, const struct object_id
*a
,
1722 const struct object_id
*b
, int search
)
1724 struct commit
*commit_base
, *commit_a
, *commit_b
;
1726 struct object_array merges
;
1730 /* store a in result in case we fail */
1733 /* we can not handle deletion conflicts */
1734 if (is_null_oid(base
))
1741 if (add_submodule_odb(path
)) {
1742 MERGE_WARNING(path
, "not checked out");
1746 if (!(commit_base
= lookup_commit_reference(base
)) ||
1747 !(commit_a
= lookup_commit_reference(a
)) ||
1748 !(commit_b
= lookup_commit_reference(b
))) {
1749 MERGE_WARNING(path
, "commits not present");
1753 /* check whether both changes are forward */
1754 if (!in_merge_bases(commit_base
, commit_a
) ||
1755 !in_merge_bases(commit_base
, commit_b
)) {
1756 MERGE_WARNING(path
, "commits don't follow merge-base");
1760 /* Case #1: a is contained in b or vice versa */
1761 if (in_merge_bases(commit_a
, commit_b
)) {
1765 if (in_merge_bases(commit_b
, commit_a
)) {
1771 * Case #2: There are one or more merges that contain a and b in
1772 * the submodule. If there is only one, then present it as a
1773 * suggestion to the user, but leave it marked unmerged so the
1774 * user needs to confirm the resolution.
1777 /* Skip the search if makes no sense to the calling context. */
1781 /* find commit which merges them */
1782 parent_count
= find_first_merges(&merges
, path
, commit_a
, commit_b
);
1783 switch (parent_count
) {
1785 MERGE_WARNING(path
, "merge following commits not found");
1789 MERGE_WARNING(path
, "not fast-forward");
1790 fprintf(stderr
, "Found a possible merge resolution "
1791 "for the submodule:\n");
1792 print_commit((struct commit
*) merges
.objects
[0].item
);
1794 "If this is correct simply add it to the index "
1797 " git update-index --cacheinfo 160000 %s \"%s\"\n\n"
1798 "which will accept this suggestion.\n",
1799 oid_to_hex(&merges
.objects
[0].item
->oid
), path
);
1803 MERGE_WARNING(path
, "multiple merges found");
1804 for (i
= 0; i
< merges
.nr
; i
++)
1805 print_commit((struct commit
*) merges
.objects
[i
].item
);
1808 free(merges
.objects
);
1813 * Embeds a single submodules git directory into the superprojects git dir,
1816 static void relocate_single_git_dir_into_superproject(const char *prefix
,
1819 char *old_git_dir
= NULL
, *real_old_git_dir
= NULL
, *real_new_git_dir
= NULL
;
1820 const char *new_git_dir
;
1821 const struct submodule
*sub
;
1823 if (submodule_uses_worktrees(path
))
1824 die(_("relocate_gitdir for submodule '%s' with "
1825 "more than one worktree not supported"), path
);
1827 old_git_dir
= xstrfmt("%s/.git", path
);
1828 if (read_gitfile(old_git_dir
))
1829 /* If it is an actual gitfile, it doesn't need migration. */
1832 real_old_git_dir
= real_pathdup(old_git_dir
, 1);
1834 sub
= submodule_from_path(&null_oid
, path
);
1836 die(_("could not lookup name for submodule '%s'"), path
);
1838 new_git_dir
= git_path("modules/%s", sub
->name
);
1839 if (safe_create_leading_directories_const(new_git_dir
) < 0)
1840 die(_("could not create directory '%s'"), new_git_dir
);
1841 real_new_git_dir
= real_pathdup(new_git_dir
, 1);
1843 fprintf(stderr
, _("Migrating git directory of '%s%s' from\n'%s' to\n'%s'\n"),
1844 get_super_prefix_or_empty(), path
,
1845 real_old_git_dir
, real_new_git_dir
);
1847 relocate_gitdir(path
, real_old_git_dir
, real_new_git_dir
);
1850 free(real_old_git_dir
);
1851 free(real_new_git_dir
);
1855 * Migrate the git directory of the submodule given by path from
1856 * having its git directory within the working tree to the git dir nested
1857 * in its superprojects git dir under modules/.
1859 void absorb_git_dir_into_superproject(const char *prefix
,
1864 const char *sub_git_dir
;
1865 struct strbuf gitdir
= STRBUF_INIT
;
1866 strbuf_addf(&gitdir
, "%s/.git", path
);
1867 sub_git_dir
= resolve_gitdir_gently(gitdir
.buf
, &err_code
);
1869 /* Not populated? */
1871 const struct submodule
*sub
;
1873 if (err_code
== READ_GITFILE_ERR_STAT_FAILED
) {
1874 /* unpopulated as expected */
1875 strbuf_release(&gitdir
);
1879 if (err_code
!= READ_GITFILE_ERR_NOT_A_REPO
)
1880 /* We don't know what broke here. */
1881 read_gitfile_error_die(err_code
, path
, NULL
);
1884 * Maybe populated, but no git directory was found?
1885 * This can happen if the superproject is a submodule
1886 * itself and was just absorbed. The absorption of the
1887 * superproject did not rewrite the git file links yet,
1890 sub
= submodule_from_path(&null_oid
, path
);
1892 die(_("could not lookup name for submodule '%s'"), path
);
1893 connect_work_tree_and_git_dir(path
,
1894 git_path("modules/%s", sub
->name
));
1896 /* Is it already absorbed into the superprojects git dir? */
1897 char *real_sub_git_dir
= real_pathdup(sub_git_dir
, 1);
1898 char *real_common_git_dir
= real_pathdup(get_git_common_dir(), 1);
1900 if (!starts_with(real_sub_git_dir
, real_common_git_dir
))
1901 relocate_single_git_dir_into_superproject(prefix
, path
);
1903 free(real_sub_git_dir
);
1904 free(real_common_git_dir
);
1906 strbuf_release(&gitdir
);
1908 if (flags
& ABSORB_GITDIR_RECURSE_SUBMODULES
) {
1909 struct child_process cp
= CHILD_PROCESS_INIT
;
1910 struct strbuf sb
= STRBUF_INIT
;
1912 if (flags
& ~ABSORB_GITDIR_RECURSE_SUBMODULES
)
1913 die("BUG: we don't know how to pass the flags down?");
1915 strbuf_addstr(&sb
, get_super_prefix_or_empty());
1916 strbuf_addstr(&sb
, path
);
1917 strbuf_addch(&sb
, '/');
1922 argv_array_pushl(&cp
.args
, "--super-prefix", sb
.buf
,
1923 "submodule--helper",
1924 "absorb-git-dirs", NULL
);
1925 prepare_submodule_repo_env(&cp
.env_array
);
1926 if (run_command(&cp
))
1927 die(_("could not recurse into submodule '%s'"), path
);
1929 strbuf_release(&sb
);
1933 const char *get_superproject_working_tree(void)
1935 struct child_process cp
= CHILD_PROCESS_INIT
;
1936 struct strbuf sb
= STRBUF_INIT
;
1937 const char *one_up
= real_path_if_valid("../");
1938 const char *cwd
= xgetcwd();
1939 const char *ret
= NULL
;
1940 const char *subpath
;
1944 if (!is_inside_work_tree())
1947 * We might have a superproject, but it is harder
1955 subpath
= relative_path(cwd
, one_up
, &sb
);
1957 prepare_submodule_repo_env(&cp
.env_array
);
1958 argv_array_pop(&cp
.env_array
);
1960 argv_array_pushl(&cp
.args
, "--literal-pathspecs", "-C", "..",
1961 "ls-files", "-z", "--stage", "--full-name", "--",
1970 if (start_command(&cp
))
1971 die(_("could not start ls-files in .."));
1973 len
= strbuf_read(&sb
, cp
.out
, PATH_MAX
);
1976 if (starts_with(sb
.buf
, "160000")) {
1978 int cwd_len
= strlen(cwd
);
1979 char *super_sub
, *super_wt
;
1982 * There is a superproject having this repo as a submodule.
1983 * The format is <mode> SP <hash> SP <stage> TAB <full name> \0,
1984 * We're only interested in the name after the tab.
1986 super_sub
= strchr(sb
.buf
, '\t') + 1;
1987 super_sub_len
= sb
.buf
+ sb
.len
- super_sub
- 1;
1989 if (super_sub_len
> cwd_len
||
1990 strcmp(&cwd
[cwd_len
- super_sub_len
], super_sub
))
1991 die (_("BUG: returned path string doesn't match cwd?"));
1993 super_wt
= xstrdup(cwd
);
1994 super_wt
[cwd_len
- super_sub_len
] = '\0';
1996 ret
= real_path(super_wt
);
1999 strbuf_release(&sb
);
2001 code
= finish_command(&cp
);
2004 /* '../' is not a git repository */
2006 if (code
== 0 && len
== 0)
2007 /* There is an unrelated git repository at '../' */
2010 die(_("ls-tree returned unexpected return code %d"), code
);
2015 int submodule_to_gitdir(struct strbuf
*buf
, const char *submodule
)
2017 const struct submodule
*sub
;
2018 const char *git_dir
;
2022 strbuf_addstr(buf
, submodule
);
2023 strbuf_complete(buf
, '/');
2024 strbuf_addstr(buf
, ".git");
2026 git_dir
= read_gitfile(buf
->buf
);
2029 strbuf_addstr(buf
, git_dir
);
2031 if (!is_git_directory(buf
->buf
)) {
2032 gitmodules_config();
2033 sub
= submodule_from_path(&null_oid
, submodule
);
2039 strbuf_git_path(buf
, "%s/%s", "modules", sub
->name
);