3 #include "repository.h"
5 #include "submodule-config.h"
11 #include "run-command.h"
14 #include "string-list.h"
15 #include "oid-array.h"
18 #include "thread-utils.h"
22 #include "parse-options.h"
23 #include "object-store.h"
24 #include "commit-reach.h"
26 static int config_update_recurse_submodules
= RECURSE_SUBMODULES_OFF
;
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 * Check if the .gitmodules file is unmerged. Parsing of the .gitmodules file
33 * will be disabled because we can't guess what might be configured in
34 * .gitmodules unless the user resolves the conflict.
36 int is_gitmodules_unmerged(struct index_state
*istate
)
38 int pos
= index_name_pos(istate
, GITMODULES_FILE
, strlen(GITMODULES_FILE
));
39 if (pos
< 0) { /* .gitmodules not found or isn't merged */
41 if (istate
->cache_nr
> pos
) { /* there is a .gitmodules */
42 const struct cache_entry
*ce
= istate
->cache
[pos
];
43 if (ce_namelen(ce
) == strlen(GITMODULES_FILE
) &&
44 !strcmp(ce
->name
, GITMODULES_FILE
))
53 * Check if the .gitmodules file is safe to write.
55 * Writing to the .gitmodules file requires that the file exists in the
56 * working tree or, if it doesn't, that a brand new .gitmodules file is going
57 * to be created (i.e. it's neither in the index nor in the current branch).
59 * It is not safe to write to .gitmodules if it's not in the working tree but
60 * it is in the index or in the current branch, because writing new values
61 * (and staging them) would blindly overwrite ALL the old content.
63 int is_writing_gitmodules_ok(void)
66 return file_exists(GITMODULES_FILE
) ||
67 (get_oid(GITMODULES_INDEX
, &oid
) < 0 && get_oid(GITMODULES_HEAD
, &oid
) < 0);
71 * Check if the .gitmodules file has unstaged modifications. This must be
72 * checked before allowing modifications to the .gitmodules file with the
73 * intention to stage them later, because when continuing we would stage the
74 * modifications the user didn't stage herself too. That might change in a
75 * future version when we learn to stage the changes we do ourselves without
76 * staging any previous modifications.
78 int is_staging_gitmodules_ok(struct index_state
*istate
)
80 int pos
= index_name_pos(istate
, GITMODULES_FILE
, strlen(GITMODULES_FILE
));
82 if ((pos
>= 0) && (pos
< istate
->cache_nr
)) {
84 if (lstat(GITMODULES_FILE
, &st
) == 0 &&
85 ie_modified(istate
, istate
->cache
[pos
], &st
, 0) & DATA_CHANGED
)
92 static int for_each_remote_ref_submodule(const char *submodule
,
93 each_ref_fn fn
, void *cb_data
)
95 return refs_for_each_remote_ref(get_submodule_ref_store(submodule
),
100 * Try to update the "path" entry in the "submodule.<name>" section of the
101 * .gitmodules file. Return 0 only if a .gitmodules file was found, a section
102 * with the correct path=<oldpath> setting was found and we could update it.
104 int update_path_in_gitmodules(const char *oldpath
, const char *newpath
)
106 struct strbuf entry
= STRBUF_INIT
;
107 const struct submodule
*submodule
;
110 if (!file_exists(GITMODULES_FILE
)) /* Do nothing without .gitmodules */
113 if (is_gitmodules_unmerged(the_repository
->index
))
114 die(_("Cannot change unmerged .gitmodules, resolve merge conflicts first"));
116 submodule
= submodule_from_path(the_repository
, null_oid(), oldpath
);
117 if (!submodule
|| !submodule
->name
) {
118 warning(_("Could not find section in .gitmodules where path=%s"), oldpath
);
121 strbuf_addstr(&entry
, "submodule.");
122 strbuf_addstr(&entry
, submodule
->name
);
123 strbuf_addstr(&entry
, ".path");
124 ret
= config_set_in_gitmodules_file_gently(entry
.buf
, newpath
);
125 strbuf_release(&entry
);
130 * Try to remove the "submodule.<name>" section from .gitmodules where the given
131 * path is configured. Return 0 only if a .gitmodules file was found, a section
132 * with the correct path=<path> setting was found and we could remove it.
134 int remove_path_from_gitmodules(const char *path
)
136 struct strbuf sect
= STRBUF_INIT
;
137 const struct submodule
*submodule
;
139 if (!file_exists(GITMODULES_FILE
)) /* Do nothing without .gitmodules */
142 if (is_gitmodules_unmerged(the_repository
->index
))
143 die(_("Cannot change unmerged .gitmodules, resolve merge conflicts first"));
145 submodule
= submodule_from_path(the_repository
, null_oid(), path
);
146 if (!submodule
|| !submodule
->name
) {
147 warning(_("Could not find section in .gitmodules where path=%s"), path
);
150 strbuf_addstr(§
, "submodule.");
151 strbuf_addstr(§
, submodule
->name
);
152 if (git_config_rename_section_in_file(GITMODULES_FILE
, sect
.buf
, NULL
) < 0) {
153 /* Maybe the user already did that, don't error out here */
154 warning(_("Could not remove .gitmodules entry for %s"), path
);
155 strbuf_release(§
);
158 strbuf_release(§
);
162 void stage_updated_gitmodules(struct index_state
*istate
)
164 if (add_file_to_index(istate
, GITMODULES_FILE
, 0))
165 die(_("staging updated .gitmodules failed"));
168 static struct string_list added_submodule_odb_paths
= STRING_LIST_INIT_NODUP
;
170 /* TODO: remove this function, use repo_submodule_init instead. */
171 int add_submodule_odb(const char *path
)
173 struct strbuf objects_directory
= STRBUF_INIT
;
176 ret
= strbuf_git_path_submodule(&objects_directory
, path
, "objects/");
179 if (!is_directory(objects_directory
.buf
)) {
183 string_list_insert(&added_submodule_odb_paths
,
184 strbuf_detach(&objects_directory
, NULL
));
186 strbuf_release(&objects_directory
);
190 void add_submodule_odb_by_path(const char *path
)
192 string_list_insert(&added_submodule_odb_paths
, xstrdup(path
));
195 int register_all_submodule_odb_as_alternates(void)
198 int ret
= added_submodule_odb_paths
.nr
;
200 for (i
= 0; i
< added_submodule_odb_paths
.nr
; i
++)
201 add_to_alternates_memory(added_submodule_odb_paths
.items
[i
].string
);
203 string_list_clear(&added_submodule_odb_paths
, 0);
204 if (git_env_bool("GIT_TEST_FATAL_REGISTER_SUBMODULE_ODB", 0))
205 BUG("register_all_submodule_odb_as_alternates() called");
210 void set_diffopt_flags_from_submodule_config(struct diff_options
*diffopt
,
213 const struct submodule
*submodule
= submodule_from_path(the_repository
,
220 key
= xstrfmt("submodule.%s.ignore", submodule
->name
);
221 if (repo_config_get_string_tmp(the_repository
, key
, &ignore
))
222 ignore
= submodule
->ignore
;
226 handle_ignore_submodules_arg(diffopt
, ignore
);
227 else if (is_gitmodules_unmerged(the_repository
->index
))
228 diffopt
->flags
.ignore_submodules
= 1;
232 /* Cheap function that only determines if we're interested in submodules at all */
233 int git_default_submodule_config(const char *var
, const char *value
, void *cb
)
235 if (!strcmp(var
, "submodule.recurse")) {
236 int v
= git_config_bool(var
, value
) ?
237 RECURSE_SUBMODULES_ON
: RECURSE_SUBMODULES_OFF
;
238 config_update_recurse_submodules
= v
;
243 int option_parse_recurse_submodules_worktree_updater(const struct option
*opt
,
244 const char *arg
, int unset
)
247 config_update_recurse_submodules
= RECURSE_SUBMODULES_OFF
;
251 config_update_recurse_submodules
=
252 parse_update_recurse_submodules_arg(opt
->long_name
,
255 config_update_recurse_submodules
= RECURSE_SUBMODULES_ON
;
261 * Determine if a submodule has been initialized at a given 'path'
263 int is_submodule_active(struct repository
*repo
, const char *path
)
268 const struct string_list
*sl
;
269 const struct submodule
*module
;
271 module
= submodule_from_path(repo
, null_oid(), path
);
273 /* early return if there isn't a path->module mapping */
277 /* submodule.<name>.active is set */
278 key
= xstrfmt("submodule.%s.active", module
->name
);
279 if (!repo_config_get_bool(repo
, key
, &ret
)) {
285 /* submodule.active is set */
286 sl
= repo_config_get_value_multi(repo
, "submodule.active");
289 struct strvec args
= STRVEC_INIT
;
290 const struct string_list_item
*item
;
292 for_each_string_list_item(item
, sl
) {
293 strvec_push(&args
, item
->string
);
296 parse_pathspec(&ps
, 0, 0, NULL
, args
.v
);
297 ret
= match_pathspec(repo
->index
, &ps
, path
, strlen(path
), 0, NULL
, 1);
304 /* fallback to checking if the URL is set */
305 key
= xstrfmt("submodule.%s.url", module
->name
);
306 ret
= !repo_config_get_string(repo
, key
, &value
);
313 int is_submodule_populated_gently(const char *path
, int *return_error_code
)
316 char *gitdir
= xstrfmt("%s/.git", path
);
318 if (resolve_gitdir_gently(gitdir
, return_error_code
))
326 * Dies if the provided 'prefix' corresponds to an unpopulated submodule
328 void die_in_unpopulated_submodule(struct index_state
*istate
,
336 prefixlen
= strlen(prefix
);
338 for (i
= 0; i
< istate
->cache_nr
; i
++) {
339 struct cache_entry
*ce
= istate
->cache
[i
];
340 int ce_len
= ce_namelen(ce
);
342 if (!S_ISGITLINK(ce
->ce_mode
))
344 if (prefixlen
<= ce_len
)
346 if (strncmp(ce
->name
, prefix
, ce_len
))
348 if (prefix
[ce_len
] != '/')
351 die(_("in unpopulated submodule '%s'"), ce
->name
);
356 * Dies if any paths in the provided pathspec descends into a submodule
358 void die_path_inside_submodule(struct index_state
*istate
,
359 const struct pathspec
*ps
)
363 for (i
= 0; i
< istate
->cache_nr
; i
++) {
364 struct cache_entry
*ce
= istate
->cache
[i
];
365 int ce_len
= ce_namelen(ce
);
367 if (!S_ISGITLINK(ce
->ce_mode
))
370 for (j
= 0; j
< ps
->nr
; j
++) {
371 const struct pathspec_item
*item
= &ps
->items
[j
];
373 if (item
->len
<= ce_len
)
375 if (item
->match
[ce_len
] != '/')
377 if (strncmp(ce
->name
, item
->match
, ce_len
))
379 if (item
->len
== ce_len
+ 1)
382 die(_("Pathspec '%s' is in submodule '%.*s'"),
383 item
->original
, ce_len
, ce
->name
);
388 enum submodule_update_type
parse_submodule_update_type(const char *value
)
390 if (!strcmp(value
, "none"))
391 return SM_UPDATE_NONE
;
392 else if (!strcmp(value
, "checkout"))
393 return SM_UPDATE_CHECKOUT
;
394 else if (!strcmp(value
, "rebase"))
395 return SM_UPDATE_REBASE
;
396 else if (!strcmp(value
, "merge"))
397 return SM_UPDATE_MERGE
;
398 else if (*value
== '!')
399 return SM_UPDATE_COMMAND
;
401 return SM_UPDATE_UNSPECIFIED
;
404 int parse_submodule_update_strategy(const char *value
,
405 struct submodule_update_strategy
*dst
)
407 enum submodule_update_type type
;
409 free((void*)dst
->command
);
412 type
= parse_submodule_update_type(value
);
413 if (type
== SM_UPDATE_UNSPECIFIED
)
417 if (type
== SM_UPDATE_COMMAND
)
418 dst
->command
= xstrdup(value
+ 1);
423 const char *submodule_strategy_to_string(const struct submodule_update_strategy
*s
)
425 struct strbuf sb
= STRBUF_INIT
;
427 case SM_UPDATE_CHECKOUT
:
429 case SM_UPDATE_MERGE
:
431 case SM_UPDATE_REBASE
:
435 case SM_UPDATE_UNSPECIFIED
:
437 case SM_UPDATE_COMMAND
:
438 strbuf_addf(&sb
, "!%s", s
->command
);
439 return strbuf_detach(&sb
, NULL
);
444 void handle_ignore_submodules_arg(struct diff_options
*diffopt
,
447 diffopt
->flags
.ignore_submodule_set
= 1;
448 diffopt
->flags
.ignore_submodules
= 0;
449 diffopt
->flags
.ignore_untracked_in_submodules
= 0;
450 diffopt
->flags
.ignore_dirty_submodules
= 0;
452 if (!strcmp(arg
, "all"))
453 diffopt
->flags
.ignore_submodules
= 1;
454 else if (!strcmp(arg
, "untracked"))
455 diffopt
->flags
.ignore_untracked_in_submodules
= 1;
456 else if (!strcmp(arg
, "dirty"))
457 diffopt
->flags
.ignore_dirty_submodules
= 1;
458 else if (strcmp(arg
, "none"))
459 die(_("bad --ignore-submodules argument: %s"), arg
);
461 * Please update _git_status() in git-completion.bash when you
466 static int prepare_submodule_diff_summary(struct repository
*r
, struct rev_info
*rev
,
468 struct commit
*left
, struct commit
*right
,
469 struct commit_list
*merge_bases
)
471 struct commit_list
*list
;
473 repo_init_revisions(r
, rev
, NULL
);
474 setup_revisions(0, NULL
, rev
, NULL
);
476 rev
->first_parent_only
= 1;
477 left
->object
.flags
|= SYMMETRIC_LEFT
;
478 add_pending_object(rev
, &left
->object
, path
);
479 add_pending_object(rev
, &right
->object
, path
);
480 for (list
= merge_bases
; list
; list
= list
->next
) {
481 list
->item
->object
.flags
|= UNINTERESTING
;
482 add_pending_object(rev
, &list
->item
->object
,
483 oid_to_hex(&list
->item
->object
.oid
));
485 return prepare_revision_walk(rev
);
488 static void print_submodule_diff_summary(struct repository
*r
, struct rev_info
*rev
, struct diff_options
*o
)
490 static const char format
[] = " %m %s";
491 struct strbuf sb
= STRBUF_INIT
;
492 struct commit
*commit
;
494 while ((commit
= get_revision(rev
))) {
495 struct pretty_print_context ctx
= {0};
496 ctx
.date_mode
= rev
->date_mode
;
497 ctx
.output_encoding
= get_log_output_encoding();
498 strbuf_setlen(&sb
, 0);
499 repo_format_commit_message(r
, commit
, format
, &sb
,
501 strbuf_addch(&sb
, '\n');
502 if (commit
->object
.flags
& SYMMETRIC_LEFT
)
503 diff_emit_submodule_del(o
, sb
.buf
);
505 diff_emit_submodule_add(o
, sb
.buf
);
510 void prepare_submodule_repo_env(struct strvec
*out
)
512 prepare_other_repo_env(out
, DEFAULT_GIT_DIR_ENVIRONMENT
);
515 static void prepare_submodule_repo_env_in_gitdir(struct strvec
*out
)
517 prepare_other_repo_env(out
, ".");
521 * Initialize a repository struct for a submodule based on the provided 'path'.
523 * Unlike repo_submodule_init, this tolerates submodules not present
524 * in .gitmodules. This function exists only to preserve historical behavior,
526 * Returns the repository struct on success,
527 * NULL when the submodule is not present.
529 static struct repository
*open_submodule(const char *path
)
531 struct strbuf sb
= STRBUF_INIT
;
532 struct repository
*out
= xmalloc(sizeof(*out
));
534 if (submodule_to_gitdir(&sb
, path
) || repo_init(out
, sb
.buf
, NULL
)) {
540 /* Mark it as a submodule */
541 out
->submodule_prefix
= xstrdup(path
);
548 * Helper function to display the submodule header line prior to the full
551 * If it can locate the submodule git directory it will create a repository
552 * handle for the submodule and lookup both the left and right commits and
553 * put them into the left and right pointers.
555 static void show_submodule_header(struct diff_options
*o
,
557 struct object_id
*one
, struct object_id
*two
,
558 unsigned dirty_submodule
,
559 struct repository
*sub
,
560 struct commit
**left
, struct commit
**right
,
561 struct commit_list
**merge_bases
)
563 const char *message
= NULL
;
564 struct strbuf sb
= STRBUF_INIT
;
565 int fast_forward
= 0, fast_backward
= 0;
567 if (dirty_submodule
& DIRTY_SUBMODULE_UNTRACKED
)
568 diff_emit_submodule_untracked(o
, path
);
570 if (dirty_submodule
& DIRTY_SUBMODULE_MODIFIED
)
571 diff_emit_submodule_modified(o
, path
);
573 if (is_null_oid(one
))
574 message
= "(new submodule)";
575 else if (is_null_oid(two
))
576 message
= "(submodule deleted)";
580 message
= "(commits not present)";
585 * Attempt to lookup the commit references, and determine if this is
586 * a fast forward or fast backwards update.
588 *left
= lookup_commit_reference(sub
, one
);
589 *right
= lookup_commit_reference(sub
, two
);
592 * Warn about missing commits in the submodule project, but only if
595 if ((!is_null_oid(one
) && !*left
) ||
596 (!is_null_oid(two
) && !*right
))
597 message
= "(commits not present)";
599 *merge_bases
= repo_get_merge_bases(sub
, *left
, *right
);
601 if ((*merge_bases
)->item
== *left
)
603 else if ((*merge_bases
)->item
== *right
)
607 if (oideq(one
, two
)) {
613 strbuf_addf(&sb
, "Submodule %s ", path
);
614 strbuf_add_unique_abbrev(&sb
, one
, DEFAULT_ABBREV
);
615 strbuf_addstr(&sb
, (fast_backward
|| fast_forward
) ? ".." : "...");
616 strbuf_add_unique_abbrev(&sb
, two
, DEFAULT_ABBREV
);
618 strbuf_addf(&sb
, " %s\n", message
);
620 strbuf_addf(&sb
, "%s:\n", fast_backward
? " (rewind)" : "");
621 diff_emit_submodule_header(o
, sb
.buf
);
626 void show_submodule_diff_summary(struct diff_options
*o
, const char *path
,
627 struct object_id
*one
, struct object_id
*two
,
628 unsigned dirty_submodule
)
631 struct commit
*left
= NULL
, *right
= NULL
;
632 struct commit_list
*merge_bases
= NULL
;
633 struct repository
*sub
;
635 sub
= open_submodule(path
);
636 show_submodule_header(o
, path
, one
, two
, dirty_submodule
,
637 sub
, &left
, &right
, &merge_bases
);
640 * If we don't have both a left and a right pointer, there is no
641 * reason to try and display a summary. The header line should contain
642 * all the information the user needs.
644 if (!left
|| !right
|| !sub
)
647 /* Treat revision walker failure the same as missing commits */
648 if (prepare_submodule_diff_summary(sub
, &rev
, path
, left
, right
, merge_bases
)) {
649 diff_emit_submodule_error(o
, "(revision walker failed)\n");
653 print_submodule_diff_summary(sub
, &rev
, o
);
657 free_commit_list(merge_bases
);
658 clear_commit_marks(left
, ~0);
659 clear_commit_marks(right
, ~0);
666 void show_submodule_inline_diff(struct diff_options
*o
, const char *path
,
667 struct object_id
*one
, struct object_id
*two
,
668 unsigned dirty_submodule
)
670 const struct object_id
*old_oid
= the_hash_algo
->empty_tree
, *new_oid
= the_hash_algo
->empty_tree
;
671 struct commit
*left
= NULL
, *right
= NULL
;
672 struct commit_list
*merge_bases
= NULL
;
673 struct child_process cp
= CHILD_PROCESS_INIT
;
674 struct strbuf sb
= STRBUF_INIT
;
675 struct repository
*sub
;
677 sub
= open_submodule(path
);
678 show_submodule_header(o
, path
, one
, two
, dirty_submodule
,
679 sub
, &left
, &right
, &merge_bases
);
681 /* We need a valid left and right commit to display a difference */
682 if (!(left
|| is_null_oid(one
)) ||
683 !(right
|| is_null_oid(two
)))
696 /* TODO: other options may need to be passed here. */
697 strvec_pushl(&cp
.args
, "diff", "--submodule=diff", NULL
);
698 strvec_pushf(&cp
.args
, "--color=%s", want_color(o
->use_color
) ?
701 if (o
->flags
.reverse_diff
) {
702 strvec_pushf(&cp
.args
, "--src-prefix=%s%s/",
704 strvec_pushf(&cp
.args
, "--dst-prefix=%s%s/",
707 strvec_pushf(&cp
.args
, "--src-prefix=%s%s/",
709 strvec_pushf(&cp
.args
, "--dst-prefix=%s%s/",
712 strvec_push(&cp
.args
, oid_to_hex(old_oid
));
714 * If the submodule has modified content, we will diff against the
715 * work tree, under the assumption that the user has asked for the
716 * diff format and wishes to actually see all differences even if they
717 * haven't yet been committed to the submodule yet.
719 if (!(dirty_submodule
& DIRTY_SUBMODULE_MODIFIED
))
720 strvec_push(&cp
.args
, oid_to_hex(new_oid
));
722 prepare_submodule_repo_env(&cp
.env_array
);
723 if (start_command(&cp
))
724 diff_emit_submodule_error(o
, "(diff failed)\n");
726 while (strbuf_getwholeline_fd(&sb
, cp
.out
, '\n') != EOF
)
727 diff_emit_submodule_pipethrough(o
, sb
.buf
, sb
.len
);
729 if (finish_command(&cp
))
730 diff_emit_submodule_error(o
, "(diff failed)\n");
735 free_commit_list(merge_bases
);
737 clear_commit_marks(left
, ~0);
739 clear_commit_marks(right
, ~0);
746 int should_update_submodules(void)
748 return config_update_recurse_submodules
== RECURSE_SUBMODULES_ON
;
751 const struct submodule
*submodule_from_ce(const struct cache_entry
*ce
)
753 if (!S_ISGITLINK(ce
->ce_mode
))
756 if (!should_update_submodules())
759 return submodule_from_path(the_repository
, null_oid(), ce
->name
);
762 static struct oid_array
*submodule_commits(struct string_list
*submodules
,
765 struct string_list_item
*item
;
767 item
= string_list_insert(submodules
, name
);
769 return (struct oid_array
*) item
->util
;
771 /* NEEDSWORK: should we have oid_array_init()? */
772 item
->util
= xcalloc(1, sizeof(struct oid_array
));
773 return (struct oid_array
*) item
->util
;
776 struct collect_changed_submodules_cb_data
{
777 struct repository
*repo
;
778 struct string_list
*changed
;
779 const struct object_id
*commit_oid
;
783 * this would normally be two functions: default_name_from_path() and
784 * path_from_default_name(). Since the default name is the same as
785 * the submodule path we can get away with just one function which only
786 * checks whether there is a submodule in the working directory at that
789 static const char *default_name_or_path(const char *path_or_name
)
793 if (!is_submodule_populated_gently(path_or_name
, &error_code
))
799 static void collect_changed_submodules_cb(struct diff_queue_struct
*q
,
800 struct diff_options
*options
,
803 struct collect_changed_submodules_cb_data
*me
= data
;
804 struct string_list
*changed
= me
->changed
;
805 const struct object_id
*commit_oid
= me
->commit_oid
;
808 for (i
= 0; i
< q
->nr
; i
++) {
809 struct diff_filepair
*p
= q
->queue
[i
];
810 struct oid_array
*commits
;
811 const struct submodule
*submodule
;
814 if (!S_ISGITLINK(p
->two
->mode
))
817 submodule
= submodule_from_path(me
->repo
,
818 commit_oid
, p
->two
->path
);
820 name
= submodule
->name
;
822 name
= default_name_or_path(p
->two
->path
);
823 /* make sure name does not collide with existing one */
825 submodule
= submodule_from_name(me
->repo
,
828 warning(_("Submodule in commit %s at path: "
829 "'%s' collides with a submodule named "
830 "the same. Skipping it."),
831 oid_to_hex(commit_oid
), p
->two
->path
);
839 commits
= submodule_commits(changed
, name
);
840 oid_array_append(commits
, &p
->two
->oid
);
845 * Collect the paths of submodules in 'changed' which have changed based on
846 * the revisions as specified in 'argv'. Each entry in 'changed' will also
847 * have a corresponding 'struct oid_array' (in the 'util' field) which lists
848 * what the submodule pointers were updated to during the change.
850 static void collect_changed_submodules(struct repository
*r
,
851 struct string_list
*changed
,
855 const struct commit
*commit
;
857 struct setup_revision_opt s_r_opt
= {
858 .assume_dashdash
= 1,
861 save_warning
= warn_on_object_refname_ambiguity
;
862 warn_on_object_refname_ambiguity
= 0;
863 repo_init_revisions(r
, &rev
, NULL
);
864 setup_revisions(argv
->nr
, argv
->v
, &rev
, &s_r_opt
);
865 warn_on_object_refname_ambiguity
= save_warning
;
866 if (prepare_revision_walk(&rev
))
867 die(_("revision walk setup failed"));
869 while ((commit
= get_revision(&rev
))) {
870 struct rev_info diff_rev
;
871 struct collect_changed_submodules_cb_data data
;
873 data
.changed
= changed
;
874 data
.commit_oid
= &commit
->object
.oid
;
876 repo_init_revisions(r
, &diff_rev
, NULL
);
877 diff_rev
.diffopt
.output_format
|= DIFF_FORMAT_CALLBACK
;
878 diff_rev
.diffopt
.format_callback
= collect_changed_submodules_cb
;
879 diff_rev
.diffopt
.format_callback_data
= &data
;
880 diff_rev
.dense_combined_merges
= 1;
881 diff_tree_combined_merge(commit
, &diff_rev
);
884 reset_revision_walk();
887 static void free_submodules_oids(struct string_list
*submodules
)
889 struct string_list_item
*item
;
890 for_each_string_list_item(item
, submodules
)
891 oid_array_clear((struct oid_array
*) item
->util
);
892 string_list_clear(submodules
, 1);
895 static int has_remote(const char *refname
, const struct object_id
*oid
,
896 int flags
, void *cb_data
)
901 static int append_oid_to_argv(const struct object_id
*oid
, void *data
)
903 struct strvec
*argv
= data
;
904 strvec_push(argv
, oid_to_hex(oid
));
908 struct has_commit_data
{
909 struct repository
*repo
;
914 static int check_has_commit(const struct object_id
*oid
, void *data
)
916 struct has_commit_data
*cb
= data
;
918 enum object_type type
= oid_object_info(cb
->repo
, oid
, NULL
);
925 * Object is missing or invalid. If invalid, an error message
926 * has already been printed.
931 die(_("submodule entry '%s' (%s) is a %s, not a commit"),
932 cb
->path
, oid_to_hex(oid
), type_name(type
));
936 static int submodule_has_commits(struct repository
*r
,
938 struct oid_array
*commits
)
940 struct has_commit_data has_commit
= { r
, 1, path
};
943 * Perform a cheap, but incorrect check for the existence of 'commits'.
944 * This is done by adding the submodule's object store to the in-core
945 * object store, and then querying for each commit's existence. If we
946 * do not have the commit object anywhere, there is no chance we have
947 * it in the object store of the correct submodule and have it
948 * reachable from a ref, so we can fail early without spawning rev-list
949 * which is expensive.
951 if (add_submodule_odb(path
))
954 oid_array_for_each_unique(commits
, check_has_commit
, &has_commit
);
956 if (has_commit
.result
) {
958 * Even if the submodule is checked out and the commit is
959 * present, make sure it exists in the submodule's object store
960 * and that it is reachable from a ref.
962 struct child_process cp
= CHILD_PROCESS_INIT
;
963 struct strbuf out
= STRBUF_INIT
;
965 strvec_pushl(&cp
.args
, "rev-list", "-n", "1", NULL
);
966 oid_array_for_each_unique(commits
, append_oid_to_argv
, &cp
.args
);
967 strvec_pushl(&cp
.args
, "--not", "--all", NULL
);
969 prepare_submodule_repo_env(&cp
.env_array
);
974 if (capture_command(&cp
, &out
, GIT_MAX_HEXSZ
+ 1) || out
.len
)
975 has_commit
.result
= 0;
977 strbuf_release(&out
);
980 return has_commit
.result
;
983 static int submodule_needs_pushing(struct repository
*r
,
985 struct oid_array
*commits
)
987 if (!submodule_has_commits(r
, path
, commits
))
989 * NOTE: We do consider it safe to return "no" here. The
990 * correct answer would be "We do not know" instead of
991 * "No push needed", but it is quite hard to change
992 * the submodule pointer without having the submodule
993 * around. If a user did however change the submodules
994 * without having the submodule around, this indicates
995 * an expert who knows what they are doing or a
996 * maintainer integrating work from other people. In
997 * both cases it should be safe to skip this check.
1001 if (for_each_remote_ref_submodule(path
, has_remote
, NULL
) > 0) {
1002 struct child_process cp
= CHILD_PROCESS_INIT
;
1003 struct strbuf buf
= STRBUF_INIT
;
1004 int needs_pushing
= 0;
1006 strvec_push(&cp
.args
, "rev-list");
1007 oid_array_for_each_unique(commits
, append_oid_to_argv
, &cp
.args
);
1008 strvec_pushl(&cp
.args
, "--not", "--remotes", "-n", "1" , NULL
);
1010 prepare_submodule_repo_env(&cp
.env_array
);
1015 if (start_command(&cp
))
1016 die(_("Could not run 'git rev-list <commits> --not --remotes -n 1' command in submodule %s"),
1018 if (strbuf_read(&buf
, cp
.out
, the_hash_algo
->hexsz
+ 1))
1020 finish_command(&cp
);
1022 strbuf_release(&buf
);
1023 return needs_pushing
;
1029 int find_unpushed_submodules(struct repository
*r
,
1030 struct oid_array
*commits
,
1031 const char *remotes_name
,
1032 struct string_list
*needs_pushing
)
1034 struct string_list submodules
= STRING_LIST_INIT_DUP
;
1035 struct string_list_item
*name
;
1036 struct strvec argv
= STRVEC_INIT
;
1038 /* argv.v[0] will be ignored by setup_revisions */
1039 strvec_push(&argv
, "find_unpushed_submodules");
1040 oid_array_for_each_unique(commits
, append_oid_to_argv
, &argv
);
1041 strvec_push(&argv
, "--not");
1042 strvec_pushf(&argv
, "--remotes=%s", remotes_name
);
1044 collect_changed_submodules(r
, &submodules
, &argv
);
1046 for_each_string_list_item(name
, &submodules
) {
1047 struct oid_array
*commits
= name
->util
;
1048 const struct submodule
*submodule
;
1049 const char *path
= NULL
;
1051 submodule
= submodule_from_name(r
, null_oid(), name
->string
);
1053 path
= submodule
->path
;
1055 path
= default_name_or_path(name
->string
);
1060 if (submodule_needs_pushing(r
, path
, commits
))
1061 string_list_insert(needs_pushing
, path
);
1064 free_submodules_oids(&submodules
);
1065 strvec_clear(&argv
);
1067 return needs_pushing
->nr
;
1070 static int push_submodule(const char *path
,
1071 const struct remote
*remote
,
1072 const struct refspec
*rs
,
1073 const struct string_list
*push_options
,
1076 if (for_each_remote_ref_submodule(path
, has_remote
, NULL
) > 0) {
1077 struct child_process cp
= CHILD_PROCESS_INIT
;
1078 strvec_push(&cp
.args
, "push");
1080 strvec_push(&cp
.args
, "--dry-run");
1082 if (push_options
&& push_options
->nr
) {
1083 const struct string_list_item
*item
;
1084 for_each_string_list_item(item
, push_options
)
1085 strvec_pushf(&cp
.args
, "--push-option=%s",
1089 if (remote
->origin
!= REMOTE_UNCONFIGURED
) {
1091 strvec_push(&cp
.args
, remote
->name
);
1092 for (i
= 0; i
< rs
->raw_nr
; i
++)
1093 strvec_push(&cp
.args
, rs
->raw
[i
]);
1096 prepare_submodule_repo_env(&cp
.env_array
);
1100 if (run_command(&cp
))
1109 * Perform a check in the submodule to see if the remote and refspec work.
1110 * Die if the submodule can't be pushed.
1112 static void submodule_push_check(const char *path
, const char *head
,
1113 const struct remote
*remote
,
1114 const struct refspec
*rs
)
1116 struct child_process cp
= CHILD_PROCESS_INIT
;
1119 strvec_push(&cp
.args
, "submodule--helper");
1120 strvec_push(&cp
.args
, "push-check");
1121 strvec_push(&cp
.args
, head
);
1122 strvec_push(&cp
.args
, remote
->name
);
1124 for (i
= 0; i
< rs
->raw_nr
; i
++)
1125 strvec_push(&cp
.args
, rs
->raw
[i
]);
1127 prepare_submodule_repo_env(&cp
.env_array
);
1134 * Simply indicate if 'submodule--helper push-check' failed.
1135 * More detailed error information will be provided by the
1138 if (run_command(&cp
))
1139 die(_("process for submodule '%s' failed"), path
);
1142 int push_unpushed_submodules(struct repository
*r
,
1143 struct oid_array
*commits
,
1144 const struct remote
*remote
,
1145 const struct refspec
*rs
,
1146 const struct string_list
*push_options
,
1150 struct string_list needs_pushing
= STRING_LIST_INIT_DUP
;
1152 if (!find_unpushed_submodules(r
, commits
,
1153 remote
->name
, &needs_pushing
))
1157 * Verify that the remote and refspec can be propagated to all
1158 * submodules. This check can be skipped if the remote and refspec
1159 * won't be propagated due to the remote being unconfigured (e.g. a URL
1160 * instead of a remote name).
1162 if (remote
->origin
!= REMOTE_UNCONFIGURED
) {
1164 struct object_id head_oid
;
1166 head
= resolve_refdup("HEAD", 0, &head_oid
, NULL
);
1168 die(_("Failed to resolve HEAD as a valid ref."));
1170 for (i
= 0; i
< needs_pushing
.nr
; i
++)
1171 submodule_push_check(needs_pushing
.items
[i
].string
,
1176 /* Actually push the submodules */
1177 for (i
= 0; i
< needs_pushing
.nr
; i
++) {
1178 const char *path
= needs_pushing
.items
[i
].string
;
1179 fprintf(stderr
, _("Pushing submodule '%s'\n"), path
);
1180 if (!push_submodule(path
, remote
, rs
,
1181 push_options
, dry_run
)) {
1182 fprintf(stderr
, _("Unable to push submodule '%s'\n"), path
);
1187 string_list_clear(&needs_pushing
, 0);
1192 static int append_oid_to_array(const char *ref
, const struct object_id
*oid
,
1193 int flags
, void *data
)
1195 struct oid_array
*array
= data
;
1196 oid_array_append(array
, oid
);
1200 void check_for_new_submodule_commits(struct object_id
*oid
)
1202 if (!initialized_fetch_ref_tips
) {
1203 for_each_ref(append_oid_to_array
, &ref_tips_before_fetch
);
1204 initialized_fetch_ref_tips
= 1;
1207 oid_array_append(&ref_tips_after_fetch
, oid
);
1210 static void calculate_changed_submodule_paths(struct repository
*r
,
1211 struct string_list
*changed_submodule_names
)
1213 struct strvec argv
= STRVEC_INIT
;
1214 struct string_list_item
*name
;
1216 /* No need to check if there are no submodules configured */
1217 if (!submodule_from_path(r
, NULL
, NULL
))
1220 strvec_push(&argv
, "--"); /* argv[0] program name */
1221 oid_array_for_each_unique(&ref_tips_after_fetch
,
1222 append_oid_to_argv
, &argv
);
1223 strvec_push(&argv
, "--not");
1224 oid_array_for_each_unique(&ref_tips_before_fetch
,
1225 append_oid_to_argv
, &argv
);
1228 * Collect all submodules (whether checked out or not) for which new
1229 * commits have been recorded upstream in "changed_submodule_names".
1231 collect_changed_submodules(r
, changed_submodule_names
, &argv
);
1233 for_each_string_list_item(name
, changed_submodule_names
) {
1234 struct oid_array
*commits
= name
->util
;
1235 const struct submodule
*submodule
;
1236 const char *path
= NULL
;
1238 submodule
= submodule_from_name(r
, null_oid(), name
->string
);
1240 path
= submodule
->path
;
1242 path
= default_name_or_path(name
->string
);
1247 if (submodule_has_commits(r
, path
, commits
)) {
1248 oid_array_clear(commits
);
1249 *name
->string
= '\0';
1253 string_list_remove_empty_items(changed_submodule_names
, 1);
1255 strvec_clear(&argv
);
1256 oid_array_clear(&ref_tips_before_fetch
);
1257 oid_array_clear(&ref_tips_after_fetch
);
1258 initialized_fetch_ref_tips
= 0;
1261 int submodule_touches_in_range(struct repository
*r
,
1262 struct object_id
*excl_oid
,
1263 struct object_id
*incl_oid
)
1265 struct string_list subs
= STRING_LIST_INIT_DUP
;
1266 struct strvec args
= STRVEC_INIT
;
1269 /* No need to check if there are no submodules configured */
1270 if (!submodule_from_path(r
, NULL
, NULL
))
1273 strvec_push(&args
, "--"); /* args[0] program name */
1274 strvec_push(&args
, oid_to_hex(incl_oid
));
1275 if (!is_null_oid(excl_oid
)) {
1276 strvec_push(&args
, "--not");
1277 strvec_push(&args
, oid_to_hex(excl_oid
));
1280 collect_changed_submodules(r
, &subs
, &args
);
1283 strvec_clear(&args
);
1285 free_submodules_oids(&subs
);
1289 struct submodule_parallel_fetch
{
1292 struct repository
*r
;
1294 int command_line_option
;
1299 struct string_list changed_submodule_names
;
1301 /* Pending fetches by OIDs */
1302 struct fetch_task
**oid_fetch_tasks
;
1303 int oid_fetch_tasks_nr
, oid_fetch_tasks_alloc
;
1305 struct strbuf submodules_with_errors
;
1307 #define SPF_INIT {0, STRVEC_INIT, NULL, NULL, 0, 0, 0, 0, \
1308 STRING_LIST_INIT_DUP, \
1309 NULL, 0, 0, STRBUF_INIT}
1311 static int get_fetch_recurse_config(const struct submodule
*submodule
,
1312 struct submodule_parallel_fetch
*spf
)
1314 if (spf
->command_line_option
!= RECURSE_SUBMODULES_DEFAULT
)
1315 return spf
->command_line_option
;
1321 int fetch_recurse
= submodule
->fetch_recurse
;
1322 key
= xstrfmt("submodule.%s.fetchRecurseSubmodules", submodule
->name
);
1323 if (!repo_config_get_string_tmp(spf
->r
, key
, &value
)) {
1324 fetch_recurse
= parse_fetch_recurse_submodules_arg(key
, value
);
1328 if (fetch_recurse
!= RECURSE_SUBMODULES_NONE
)
1329 /* local config overrules everything except commandline */
1330 return fetch_recurse
;
1333 return spf
->default_option
;
1337 * Fetch in progress (if callback data) or
1338 * pending (if in oid_fetch_tasks in struct submodule_parallel_fetch)
1341 struct repository
*repo
;
1342 const struct submodule
*sub
;
1343 unsigned free_sub
: 1; /* Do we need to free the submodule? */
1345 struct oid_array
*commits
; /* Ensure these commits are fetched */
1349 * When a submodule is not defined in .gitmodules, we cannot access it
1350 * via the regular submodule-config. Create a fake submodule, which we can
1353 static const struct submodule
*get_non_gitmodules_submodule(const char *path
)
1355 struct submodule
*ret
= NULL
;
1356 const char *name
= default_name_or_path(path
);
1361 ret
= xmalloc(sizeof(*ret
));
1362 memset(ret
, 0, sizeof(*ret
));
1366 return (const struct submodule
*) ret
;
1369 static struct fetch_task
*fetch_task_create(struct repository
*r
,
1372 struct fetch_task
*task
= xmalloc(sizeof(*task
));
1373 memset(task
, 0, sizeof(*task
));
1375 task
->sub
= submodule_from_path(r
, null_oid(), path
);
1378 * No entry in .gitmodules? Technically not a submodule,
1379 * but historically we supported repositories that happen to be
1380 * in-place where a gitlink is. Keep supporting them.
1382 task
->sub
= get_non_gitmodules_submodule(path
);
1394 static void fetch_task_release(struct fetch_task
*p
)
1397 free((void*)p
->sub
);
1402 repo_clear(p
->repo
);
1403 FREE_AND_NULL(p
->repo
);
1406 static struct repository
*get_submodule_repo_for(struct repository
*r
,
1407 const struct submodule
*sub
)
1409 struct repository
*ret
= xmalloc(sizeof(*ret
));
1411 if (repo_submodule_init(ret
, r
, sub
)) {
1413 * No entry in .gitmodules? Technically not a submodule,
1414 * but historically we supported repositories that happen to be
1415 * in-place where a gitlink is. Keep supporting them.
1417 struct strbuf gitdir
= STRBUF_INIT
;
1418 strbuf_repo_worktree_path(&gitdir
, r
, "%s/.git", sub
->path
);
1419 if (repo_init(ret
, gitdir
.buf
, NULL
)) {
1420 strbuf_release(&gitdir
);
1424 strbuf_release(&gitdir
);
1430 static int get_next_submodule(struct child_process
*cp
,
1431 struct strbuf
*err
, void *data
, void **task_cb
)
1433 struct submodule_parallel_fetch
*spf
= data
;
1435 for (; spf
->count
< spf
->r
->index
->cache_nr
; spf
->count
++) {
1436 const struct cache_entry
*ce
= spf
->r
->index
->cache
[spf
->count
];
1437 const char *default_argv
;
1438 struct fetch_task
*task
;
1440 if (!S_ISGITLINK(ce
->ce_mode
))
1443 task
= fetch_task_create(spf
->r
, ce
->name
);
1447 switch (get_fetch_recurse_config(task
->sub
, spf
))
1450 case RECURSE_SUBMODULES_DEFAULT
:
1451 case RECURSE_SUBMODULES_ON_DEMAND
:
1453 !string_list_lookup(
1454 &spf
->changed_submodule_names
,
1457 default_argv
= "on-demand";
1459 case RECURSE_SUBMODULES_ON
:
1460 default_argv
= "yes";
1462 case RECURSE_SUBMODULES_OFF
:
1466 task
->repo
= get_submodule_repo_for(spf
->r
, task
->sub
);
1468 struct strbuf submodule_prefix
= STRBUF_INIT
;
1469 child_process_init(cp
);
1470 cp
->dir
= task
->repo
->gitdir
;
1471 prepare_submodule_repo_env_in_gitdir(&cp
->env_array
);
1474 strbuf_addf(err
, _("Fetching submodule %s%s\n"),
1475 spf
->prefix
, ce
->name
);
1476 strvec_init(&cp
->args
);
1477 strvec_pushv(&cp
->args
, spf
->args
.v
);
1478 strvec_push(&cp
->args
, default_argv
);
1479 strvec_push(&cp
->args
, "--submodule-prefix");
1481 strbuf_addf(&submodule_prefix
, "%s%s/",
1484 strvec_push(&cp
->args
, submodule_prefix
.buf
);
1489 strbuf_release(&submodule_prefix
);
1492 struct strbuf empty_submodule_path
= STRBUF_INIT
;
1494 fetch_task_release(task
);
1498 * An empty directory is normal,
1499 * the submodule is not initialized
1501 strbuf_addf(&empty_submodule_path
, "%s/%s/",
1504 if (S_ISGITLINK(ce
->ce_mode
) &&
1505 !is_empty_dir(empty_submodule_path
.buf
)) {
1508 _("Could not access submodule '%s'\n"),
1511 strbuf_release(&empty_submodule_path
);
1515 if (spf
->oid_fetch_tasks_nr
) {
1516 struct fetch_task
*task
=
1517 spf
->oid_fetch_tasks
[spf
->oid_fetch_tasks_nr
- 1];
1518 struct strbuf submodule_prefix
= STRBUF_INIT
;
1519 spf
->oid_fetch_tasks_nr
--;
1521 strbuf_addf(&submodule_prefix
, "%s%s/",
1522 spf
->prefix
, task
->sub
->path
);
1524 child_process_init(cp
);
1525 prepare_submodule_repo_env_in_gitdir(&cp
->env_array
);
1527 cp
->dir
= task
->repo
->gitdir
;
1529 strvec_init(&cp
->args
);
1530 strvec_pushv(&cp
->args
, spf
->args
.v
);
1531 strvec_push(&cp
->args
, "on-demand");
1532 strvec_push(&cp
->args
, "--submodule-prefix");
1533 strvec_push(&cp
->args
, submodule_prefix
.buf
);
1535 /* NEEDSWORK: have get_default_remote from submodule--helper */
1536 strvec_push(&cp
->args
, "origin");
1537 oid_array_for_each_unique(task
->commits
,
1538 append_oid_to_argv
, &cp
->args
);
1541 strbuf_release(&submodule_prefix
);
1548 static int fetch_start_failure(struct strbuf
*err
,
1549 void *cb
, void *task_cb
)
1551 struct submodule_parallel_fetch
*spf
= cb
;
1552 struct fetch_task
*task
= task_cb
;
1556 fetch_task_release(task
);
1560 static int commit_missing_in_sub(const struct object_id
*oid
, void *data
)
1562 struct repository
*subrepo
= data
;
1564 enum object_type type
= oid_object_info(subrepo
, oid
, NULL
);
1566 return type
!= OBJ_COMMIT
;
1569 static int fetch_finish(int retvalue
, struct strbuf
*err
,
1570 void *cb
, void *task_cb
)
1572 struct submodule_parallel_fetch
*spf
= cb
;
1573 struct fetch_task
*task
= task_cb
;
1575 struct string_list_item
*it
;
1576 struct oid_array
*commits
;
1578 if (!task
|| !task
->sub
)
1579 BUG("callback cookie bogus");
1583 * NEEDSWORK: This indicates that the overall fetch
1584 * failed, even though there may be a subsequent fetch
1585 * by commit hash that might work. It may be a good
1586 * idea to not indicate failure in this case, and only
1587 * indicate failure if the subsequent fetch fails.
1591 strbuf_addf(&spf
->submodules_with_errors
, "\t%s\n",
1595 /* Is this the second time we process this submodule? */
1599 it
= string_list_lookup(&spf
->changed_submodule_names
, task
->sub
->name
);
1601 /* Could be an unchanged submodule, not contained in the list */
1605 oid_array_filter(commits
,
1606 commit_missing_in_sub
,
1609 /* Are there commits we want, but do not exist? */
1611 task
->commits
= commits
;
1612 ALLOC_GROW(spf
->oid_fetch_tasks
,
1613 spf
->oid_fetch_tasks_nr
+ 1,
1614 spf
->oid_fetch_tasks_alloc
);
1615 spf
->oid_fetch_tasks
[spf
->oid_fetch_tasks_nr
] = task
;
1616 spf
->oid_fetch_tasks_nr
++;
1621 fetch_task_release(task
);
1626 int fetch_populated_submodules(struct repository
*r
,
1627 const struct strvec
*options
,
1628 const char *prefix
, int command_line_option
,
1630 int quiet
, int max_parallel_jobs
)
1633 struct submodule_parallel_fetch spf
= SPF_INIT
;
1636 spf
.command_line_option
= command_line_option
;
1637 spf
.default_option
= default_option
;
1639 spf
.prefix
= prefix
;
1644 if (repo_read_index(r
) < 0)
1645 die(_("index file corrupt"));
1647 strvec_push(&spf
.args
, "fetch");
1648 for (i
= 0; i
< options
->nr
; i
++)
1649 strvec_push(&spf
.args
, options
->v
[i
]);
1650 strvec_push(&spf
.args
, "--recurse-submodules-default");
1651 /* default value, "--submodule-prefix" and its value are added later */
1653 calculate_changed_submodule_paths(r
, &spf
.changed_submodule_names
);
1654 string_list_sort(&spf
.changed_submodule_names
);
1655 run_processes_parallel_tr2(max_parallel_jobs
,
1657 fetch_start_failure
,
1660 "submodule", "parallel/fetch");
1662 if (spf
.submodules_with_errors
.len
> 0)
1663 fprintf(stderr
, _("Errors during submodule fetch:\n%s"),
1664 spf
.submodules_with_errors
.buf
);
1667 strvec_clear(&spf
.args
);
1669 free_submodules_oids(&spf
.changed_submodule_names
);
1673 unsigned is_submodule_modified(const char *path
, int ignore_untracked
)
1675 struct child_process cp
= CHILD_PROCESS_INIT
;
1676 struct strbuf buf
= STRBUF_INIT
;
1678 unsigned dirty_submodule
= 0;
1679 const char *git_dir
;
1680 int ignore_cp_exit_code
= 0;
1682 strbuf_addf(&buf
, "%s/.git", path
);
1683 git_dir
= read_gitfile(buf
.buf
);
1686 if (!is_git_directory(git_dir
)) {
1687 if (is_directory(git_dir
))
1688 die(_("'%s' not recognized as a git repository"), git_dir
);
1689 strbuf_release(&buf
);
1690 /* The submodule is not checked out, so it is not modified */
1695 strvec_pushl(&cp
.args
, "status", "--porcelain=2", NULL
);
1696 if (ignore_untracked
)
1697 strvec_push(&cp
.args
, "-uno");
1699 prepare_submodule_repo_env(&cp
.env_array
);
1704 if (start_command(&cp
))
1705 die(_("Could not run 'git status --porcelain=2' in submodule %s"), path
);
1707 fp
= xfdopen(cp
.out
, "r");
1708 while (strbuf_getwholeline(&buf
, fp
, '\n') != EOF
) {
1709 /* regular untracked files */
1710 if (buf
.buf
[0] == '?')
1711 dirty_submodule
|= DIRTY_SUBMODULE_UNTRACKED
;
1713 if (buf
.buf
[0] == 'u' ||
1714 buf
.buf
[0] == '1' ||
1715 buf
.buf
[0] == '2') {
1716 /* T = line type, XY = status, SSSS = submodule state */
1717 if (buf
.len
< strlen("T XY SSSS"))
1718 BUG("invalid status --porcelain=2 line %s",
1721 if (buf
.buf
[5] == 'S' && buf
.buf
[8] == 'U')
1722 /* nested untracked file */
1723 dirty_submodule
|= DIRTY_SUBMODULE_UNTRACKED
;
1725 if (buf
.buf
[0] == 'u' ||
1726 buf
.buf
[0] == '2' ||
1727 memcmp(buf
.buf
+ 5, "S..U", 4))
1729 dirty_submodule
|= DIRTY_SUBMODULE_MODIFIED
;
1732 if ((dirty_submodule
& DIRTY_SUBMODULE_MODIFIED
) &&
1733 ((dirty_submodule
& DIRTY_SUBMODULE_UNTRACKED
) ||
1734 ignore_untracked
)) {
1736 * We're not interested in any further information from
1737 * the child any more, neither output nor its exit code.
1739 ignore_cp_exit_code
= 1;
1745 if (finish_command(&cp
) && !ignore_cp_exit_code
)
1746 die(_("'git status --porcelain=2' failed in submodule %s"), path
);
1748 strbuf_release(&buf
);
1749 return dirty_submodule
;
1752 int submodule_uses_gitfile(const char *path
)
1754 struct child_process cp
= CHILD_PROCESS_INIT
;
1755 struct strbuf buf
= STRBUF_INIT
;
1756 const char *git_dir
;
1758 strbuf_addf(&buf
, "%s/.git", path
);
1759 git_dir
= read_gitfile(buf
.buf
);
1761 strbuf_release(&buf
);
1764 strbuf_release(&buf
);
1766 /* Now test that all nested submodules use a gitfile too */
1767 strvec_pushl(&cp
.args
,
1768 "submodule", "foreach", "--quiet", "--recursive",
1769 "test -f .git", NULL
);
1771 prepare_submodule_repo_env(&cp
.env_array
);
1777 if (run_command(&cp
))
1784 * Check if it is a bad idea to remove a submodule, i.e. if we'd lose data
1787 * Return 1 if we'd lose data, return 0 if the removal is fine,
1788 * and negative values for errors.
1790 int bad_to_remove_submodule(const char *path
, unsigned flags
)
1793 struct child_process cp
= CHILD_PROCESS_INIT
;
1794 struct strbuf buf
= STRBUF_INIT
;
1797 if (!file_exists(path
) || is_empty_dir(path
))
1800 if (!submodule_uses_gitfile(path
))
1803 strvec_pushl(&cp
.args
, "status", "--porcelain",
1804 "--ignore-submodules=none", NULL
);
1806 if (flags
& SUBMODULE_REMOVAL_IGNORE_UNTRACKED
)
1807 strvec_push(&cp
.args
, "-uno");
1809 strvec_push(&cp
.args
, "-uall");
1811 if (!(flags
& SUBMODULE_REMOVAL_IGNORE_IGNORED_UNTRACKED
))
1812 strvec_push(&cp
.args
, "--ignored");
1814 prepare_submodule_repo_env(&cp
.env_array
);
1819 if (start_command(&cp
)) {
1820 if (flags
& SUBMODULE_REMOVAL_DIE_ON_ERROR
)
1821 die(_("could not start 'git status' in submodule '%s'"),
1827 len
= strbuf_read(&buf
, cp
.out
, 1024);
1832 if (finish_command(&cp
)) {
1833 if (flags
& SUBMODULE_REMOVAL_DIE_ON_ERROR
)
1834 die(_("could not run 'git status' in submodule '%s'"),
1839 strbuf_release(&buf
);
1843 void submodule_unset_core_worktree(const struct submodule
*sub
)
1845 char *config_path
= xstrfmt("%s/modules/%s/config",
1846 get_git_dir(), sub
->name
);
1848 if (git_config_set_in_file_gently(config_path
, "core.worktree", NULL
))
1849 warning(_("Could not unset core.worktree setting in submodule '%s'"),
1855 static const char *get_super_prefix_or_empty(void)
1857 const char *s
= get_super_prefix();
1863 static int submodule_has_dirty_index(const struct submodule
*sub
)
1865 struct child_process cp
= CHILD_PROCESS_INIT
;
1867 prepare_submodule_repo_env(&cp
.env_array
);
1870 strvec_pushl(&cp
.args
, "diff-index", "--quiet",
1871 "--cached", "HEAD", NULL
);
1875 if (start_command(&cp
))
1876 die(_("could not recurse into submodule '%s'"), sub
->path
);
1878 return finish_command(&cp
);
1881 static void submodule_reset_index(const char *path
)
1883 struct child_process cp
= CHILD_PROCESS_INIT
;
1884 prepare_submodule_repo_env(&cp
.env_array
);
1890 strvec_pushf(&cp
.args
, "--super-prefix=%s%s/",
1891 get_super_prefix_or_empty(), path
);
1892 strvec_pushl(&cp
.args
, "read-tree", "-u", "--reset", NULL
);
1894 strvec_push(&cp
.args
, empty_tree_oid_hex());
1896 if (run_command(&cp
))
1897 die(_("could not reset submodule index"));
1901 * Moves a submodule at a given path from a given head to another new head.
1902 * For edge cases (a submodule coming into existence or removing a submodule)
1903 * pass NULL for old or new respectively.
1905 int submodule_move_head(const char *path
,
1906 const char *old_head
,
1907 const char *new_head
,
1911 struct child_process cp
= CHILD_PROCESS_INIT
;
1912 const struct submodule
*sub
;
1913 int *error_code_ptr
, error_code
;
1915 if (!is_submodule_active(the_repository
, path
))
1918 if (flags
& SUBMODULE_MOVE_HEAD_FORCE
)
1920 * Pass non NULL pointer to is_submodule_populated_gently
1921 * to prevent die()-ing. We'll use connect_work_tree_and_git_dir
1922 * to fixup the submodule in the force case later.
1924 error_code_ptr
= &error_code
;
1926 error_code_ptr
= NULL
;
1928 if (old_head
&& !is_submodule_populated_gently(path
, error_code_ptr
))
1931 sub
= submodule_from_path(the_repository
, null_oid(), path
);
1934 BUG("could not get submodule information for '%s'", path
);
1936 if (old_head
&& !(flags
& SUBMODULE_MOVE_HEAD_FORCE
)) {
1937 /* Check if the submodule has a dirty index. */
1938 if (submodule_has_dirty_index(sub
))
1939 return error(_("submodule '%s' has dirty index"), path
);
1942 if (!(flags
& SUBMODULE_MOVE_HEAD_DRY_RUN
)) {
1944 if (!submodule_uses_gitfile(path
))
1945 absorb_git_dir_into_superproject(path
,
1946 ABSORB_GITDIR_RECURSE_SUBMODULES
);
1948 char *gitdir
= xstrfmt("%s/modules/%s",
1949 get_git_dir(), sub
->name
);
1950 connect_work_tree_and_git_dir(path
, gitdir
, 0);
1953 /* make sure the index is clean as well */
1954 submodule_reset_index(path
);
1957 if (old_head
&& (flags
& SUBMODULE_MOVE_HEAD_FORCE
)) {
1958 char *gitdir
= xstrfmt("%s/modules/%s",
1959 get_git_dir(), sub
->name
);
1960 connect_work_tree_and_git_dir(path
, gitdir
, 1);
1965 prepare_submodule_repo_env(&cp
.env_array
);
1971 strvec_pushf(&cp
.args
, "--super-prefix=%s%s/",
1972 get_super_prefix_or_empty(), path
);
1973 strvec_pushl(&cp
.args
, "read-tree", "--recurse-submodules", NULL
);
1975 if (flags
& SUBMODULE_MOVE_HEAD_DRY_RUN
)
1976 strvec_push(&cp
.args
, "-n");
1978 strvec_push(&cp
.args
, "-u");
1980 if (flags
& SUBMODULE_MOVE_HEAD_FORCE
)
1981 strvec_push(&cp
.args
, "--reset");
1983 strvec_push(&cp
.args
, "-m");
1985 if (!(flags
& SUBMODULE_MOVE_HEAD_FORCE
))
1986 strvec_push(&cp
.args
, old_head
? old_head
: empty_tree_oid_hex());
1988 strvec_push(&cp
.args
, new_head
? new_head
: empty_tree_oid_hex());
1990 if (run_command(&cp
)) {
1991 ret
= error(_("Submodule '%s' could not be updated."), path
);
1995 if (!(flags
& SUBMODULE_MOVE_HEAD_DRY_RUN
)) {
1997 child_process_init(&cp
);
1998 /* also set the HEAD accordingly */
2003 prepare_submodule_repo_env(&cp
.env_array
);
2004 strvec_pushl(&cp
.args
, "update-ref", "HEAD",
2005 "--no-deref", new_head
, NULL
);
2007 if (run_command(&cp
)) {
2012 struct strbuf sb
= STRBUF_INIT
;
2014 strbuf_addf(&sb
, "%s/.git", path
);
2015 unlink_or_warn(sb
.buf
);
2016 strbuf_release(&sb
);
2018 if (is_empty_dir(path
))
2019 rmdir_or_warn(path
);
2021 submodule_unset_core_worktree(sub
);
2028 int validate_submodule_git_dir(char *git_dir
, const char *submodule_name
)
2030 size_t len
= strlen(git_dir
), suffix_len
= strlen(submodule_name
);
2034 if (len
<= suffix_len
|| (p
= git_dir
+ len
- suffix_len
)[-1] != '/' ||
2035 strcmp(p
, submodule_name
))
2036 BUG("submodule name '%s' not a suffix of git dir '%s'",
2037 submodule_name
, git_dir
);
2040 * We prevent the contents of sibling submodules' git directories to
2043 * Example: having a submodule named `hippo` and another one named
2044 * `hippo/hooks` would result in the git directories
2045 * `.git/modules/hippo/` and `.git/modules/hippo/hooks/`, respectively,
2046 * but the latter directory is already designated to contain the hooks
2050 if (is_dir_sep(*p
)) {
2054 if (is_git_directory(git_dir
))
2059 return error(_("submodule git dir '%s' is "
2060 "inside git dir '%.*s'"),
2062 (int)(p
- git_dir
), git_dir
);
2070 * Embeds a single submodules git directory into the superprojects git dir,
2073 static void relocate_single_git_dir_into_superproject(const char *path
)
2075 char *old_git_dir
= NULL
, *real_old_git_dir
= NULL
, *real_new_git_dir
= NULL
;
2077 const struct submodule
*sub
;
2079 if (submodule_uses_worktrees(path
))
2080 die(_("relocate_gitdir for submodule '%s' with "
2081 "more than one worktree not supported"), path
);
2083 old_git_dir
= xstrfmt("%s/.git", path
);
2084 if (read_gitfile(old_git_dir
))
2085 /* If it is an actual gitfile, it doesn't need migration. */
2088 real_old_git_dir
= real_pathdup(old_git_dir
, 1);
2090 sub
= submodule_from_path(the_repository
, null_oid(), path
);
2092 die(_("could not lookup name for submodule '%s'"), path
);
2094 new_git_dir
= git_pathdup("modules/%s", sub
->name
);
2095 if (validate_submodule_git_dir(new_git_dir
, sub
->name
) < 0)
2096 die(_("refusing to move '%s' into an existing git dir"),
2098 if (safe_create_leading_directories_const(new_git_dir
) < 0)
2099 die(_("could not create directory '%s'"), new_git_dir
);
2100 real_new_git_dir
= real_pathdup(new_git_dir
, 1);
2103 fprintf(stderr
, _("Migrating git directory of '%s%s' from\n'%s' to\n'%s'\n"),
2104 get_super_prefix_or_empty(), path
,
2105 real_old_git_dir
, real_new_git_dir
);
2107 relocate_gitdir(path
, real_old_git_dir
, real_new_git_dir
);
2110 free(real_old_git_dir
);
2111 free(real_new_git_dir
);
2115 * Migrate the git directory of the submodule given by path from
2116 * having its git directory within the working tree to the git dir nested
2117 * in its superprojects git dir under modules/.
2119 void absorb_git_dir_into_superproject(const char *path
,
2123 const char *sub_git_dir
;
2124 struct strbuf gitdir
= STRBUF_INIT
;
2125 strbuf_addf(&gitdir
, "%s/.git", path
);
2126 sub_git_dir
= resolve_gitdir_gently(gitdir
.buf
, &err_code
);
2128 /* Not populated? */
2130 const struct submodule
*sub
;
2132 if (err_code
== READ_GITFILE_ERR_STAT_FAILED
) {
2133 /* unpopulated as expected */
2134 strbuf_release(&gitdir
);
2138 if (err_code
!= READ_GITFILE_ERR_NOT_A_REPO
)
2139 /* We don't know what broke here. */
2140 read_gitfile_error_die(err_code
, path
, NULL
);
2143 * Maybe populated, but no git directory was found?
2144 * This can happen if the superproject is a submodule
2145 * itself and was just absorbed. The absorption of the
2146 * superproject did not rewrite the git file links yet,
2149 sub
= submodule_from_path(the_repository
, null_oid(), path
);
2151 die(_("could not lookup name for submodule '%s'"), path
);
2152 connect_work_tree_and_git_dir(path
,
2153 git_path("modules/%s", sub
->name
), 0);
2155 /* Is it already absorbed into the superprojects git dir? */
2156 char *real_sub_git_dir
= real_pathdup(sub_git_dir
, 1);
2157 char *real_common_git_dir
= real_pathdup(get_git_common_dir(), 1);
2159 if (!starts_with(real_sub_git_dir
, real_common_git_dir
))
2160 relocate_single_git_dir_into_superproject(path
);
2162 free(real_sub_git_dir
);
2163 free(real_common_git_dir
);
2165 strbuf_release(&gitdir
);
2167 if (flags
& ABSORB_GITDIR_RECURSE_SUBMODULES
) {
2168 struct child_process cp
= CHILD_PROCESS_INIT
;
2169 struct strbuf sb
= STRBUF_INIT
;
2171 if (flags
& ~ABSORB_GITDIR_RECURSE_SUBMODULES
)
2172 BUG("we don't know how to pass the flags down?");
2174 strbuf_addstr(&sb
, get_super_prefix_or_empty());
2175 strbuf_addstr(&sb
, path
);
2176 strbuf_addch(&sb
, '/');
2181 strvec_pushl(&cp
.args
, "--super-prefix", sb
.buf
,
2182 "submodule--helper",
2183 "absorb-git-dirs", NULL
);
2184 prepare_submodule_repo_env(&cp
.env_array
);
2185 if (run_command(&cp
))
2186 die(_("could not recurse into submodule '%s'"), path
);
2188 strbuf_release(&sb
);
2192 int get_superproject_working_tree(struct strbuf
*buf
)
2194 struct child_process cp
= CHILD_PROCESS_INIT
;
2195 struct strbuf sb
= STRBUF_INIT
;
2196 struct strbuf one_up
= STRBUF_INIT
;
2197 const char *cwd
= xgetcwd();
2199 const char *subpath
;
2203 if (!is_inside_work_tree())
2206 * We might have a superproject, but it is harder
2211 if (!strbuf_realpath(&one_up
, "../", 0))
2214 subpath
= relative_path(cwd
, one_up
.buf
, &sb
);
2215 strbuf_release(&one_up
);
2217 prepare_submodule_repo_env(&cp
.env_array
);
2218 strvec_pop(&cp
.env_array
);
2220 strvec_pushl(&cp
.args
, "--literal-pathspecs", "-C", "..",
2221 "ls-files", "-z", "--stage", "--full-name", "--",
2230 if (start_command(&cp
))
2231 die(_("could not start ls-files in .."));
2233 len
= strbuf_read(&sb
, cp
.out
, PATH_MAX
);
2236 if (starts_with(sb
.buf
, "160000")) {
2238 int cwd_len
= strlen(cwd
);
2239 char *super_sub
, *super_wt
;
2242 * There is a superproject having this repo as a submodule.
2243 * The format is <mode> SP <hash> SP <stage> TAB <full name> \0,
2244 * We're only interested in the name after the tab.
2246 super_sub
= strchr(sb
.buf
, '\t') + 1;
2247 super_sub_len
= strlen(super_sub
);
2249 if (super_sub_len
> cwd_len
||
2250 strcmp(&cwd
[cwd_len
- super_sub_len
], super_sub
))
2251 BUG("returned path string doesn't match cwd?");
2253 super_wt
= xstrdup(cwd
);
2254 super_wt
[cwd_len
- super_sub_len
] = '\0';
2256 strbuf_realpath(buf
, super_wt
, 1);
2260 strbuf_release(&sb
);
2262 code
= finish_command(&cp
);
2265 /* '../' is not a git repository */
2267 if (code
== 0 && len
== 0)
2268 /* There is an unrelated git repository at '../' */
2271 die(_("ls-tree returned unexpected return code %d"), code
);
2277 * Put the gitdir for a submodule (given relative to the main
2278 * repository worktree) into `buf`, or return -1 on error.
2280 int submodule_to_gitdir(struct strbuf
*buf
, const char *submodule
)
2282 const struct submodule
*sub
;
2283 const char *git_dir
;
2287 strbuf_addstr(buf
, submodule
);
2288 strbuf_complete(buf
, '/');
2289 strbuf_addstr(buf
, ".git");
2291 git_dir
= read_gitfile(buf
->buf
);
2294 strbuf_addstr(buf
, git_dir
);
2296 if (!is_git_directory(buf
->buf
)) {
2297 sub
= submodule_from_path(the_repository
, null_oid(),
2304 strbuf_git_path(buf
, "%s/%s", "modules", sub
->name
);