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"
27 static int config_update_recurse_submodules
= RECURSE_SUBMODULES_OFF
;
28 static int initialized_fetch_ref_tips
;
29 static struct oid_array ref_tips_before_fetch
;
30 static struct oid_array ref_tips_after_fetch
;
33 * Check if the .gitmodules file is unmerged. Parsing of the .gitmodules file
34 * will be disabled because we can't guess what might be configured in
35 * .gitmodules unless the user resolves the conflict.
37 int is_gitmodules_unmerged(struct index_state
*istate
)
39 int pos
= index_name_pos(istate
, GITMODULES_FILE
, strlen(GITMODULES_FILE
));
40 if (pos
< 0) { /* .gitmodules not found or isn't merged */
42 if (istate
->cache_nr
> pos
) { /* there is a .gitmodules */
43 const struct cache_entry
*ce
= istate
->cache
[pos
];
44 if (ce_namelen(ce
) == strlen(GITMODULES_FILE
) &&
45 !strcmp(ce
->name
, GITMODULES_FILE
))
54 * Check if the .gitmodules file is safe to write.
56 * Writing to the .gitmodules file requires that the file exists in the
57 * working tree or, if it doesn't, that a brand new .gitmodules file is going
58 * to be created (i.e. it's neither in the index nor in the current branch).
60 * It is not safe to write to .gitmodules if it's not in the working tree but
61 * it is in the index or in the current branch, because writing new values
62 * (and staging them) would blindly overwrite ALL the old content.
64 int is_writing_gitmodules_ok(void)
67 return file_exists(GITMODULES_FILE
) ||
68 (get_oid(GITMODULES_INDEX
, &oid
) < 0 && get_oid(GITMODULES_HEAD
, &oid
) < 0);
72 * Check if the .gitmodules file has unstaged modifications. This must be
73 * checked before allowing modifications to the .gitmodules file with the
74 * intention to stage them later, because when continuing we would stage the
75 * modifications the user didn't stage herself too. That might change in a
76 * future version when we learn to stage the changes we do ourselves without
77 * staging any previous modifications.
79 int is_staging_gitmodules_ok(struct index_state
*istate
)
81 int pos
= index_name_pos(istate
, GITMODULES_FILE
, strlen(GITMODULES_FILE
));
83 if ((pos
>= 0) && (pos
< istate
->cache_nr
)) {
85 if (lstat(GITMODULES_FILE
, &st
) == 0 &&
86 ie_modified(istate
, istate
->cache
[pos
], &st
, 0) & DATA_CHANGED
)
93 static int for_each_remote_ref_submodule(const char *submodule
,
94 each_ref_fn fn
, void *cb_data
)
96 return refs_for_each_remote_ref(get_submodule_ref_store(submodule
),
101 * Try to update the "path" entry in the "submodule.<name>" section of the
102 * .gitmodules file. Return 0 only if a .gitmodules file was found, a section
103 * with the correct path=<oldpath> setting was found and we could update it.
105 int update_path_in_gitmodules(const char *oldpath
, const char *newpath
)
107 struct strbuf entry
= STRBUF_INIT
;
108 const struct submodule
*submodule
;
111 if (!file_exists(GITMODULES_FILE
)) /* Do nothing without .gitmodules */
114 if (is_gitmodules_unmerged(the_repository
->index
))
115 die(_("Cannot change unmerged .gitmodules, resolve merge conflicts first"));
117 submodule
= submodule_from_path(the_repository
, null_oid(), oldpath
);
118 if (!submodule
|| !submodule
->name
) {
119 warning(_("Could not find section in .gitmodules where path=%s"), oldpath
);
122 strbuf_addstr(&entry
, "submodule.");
123 strbuf_addstr(&entry
, submodule
->name
);
124 strbuf_addstr(&entry
, ".path");
125 ret
= config_set_in_gitmodules_file_gently(entry
.buf
, newpath
);
126 strbuf_release(&entry
);
131 * Try to remove the "submodule.<name>" section from .gitmodules where the given
132 * path is configured. Return 0 only if a .gitmodules file was found, a section
133 * with the correct path=<path> setting was found and we could remove it.
135 int remove_path_from_gitmodules(const char *path
)
137 struct strbuf sect
= STRBUF_INIT
;
138 const struct submodule
*submodule
;
140 if (!file_exists(GITMODULES_FILE
)) /* Do nothing without .gitmodules */
143 if (is_gitmodules_unmerged(the_repository
->index
))
144 die(_("Cannot change unmerged .gitmodules, resolve merge conflicts first"));
146 submodule
= submodule_from_path(the_repository
, null_oid(), path
);
147 if (!submodule
|| !submodule
->name
) {
148 warning(_("Could not find section in .gitmodules where path=%s"), path
);
151 strbuf_addstr(§
, "submodule.");
152 strbuf_addstr(§
, submodule
->name
);
153 if (git_config_rename_section_in_file(GITMODULES_FILE
, sect
.buf
, NULL
) < 0) {
154 /* Maybe the user already did that, don't error out here */
155 warning(_("Could not remove .gitmodules entry for %s"), path
);
156 strbuf_release(§
);
159 strbuf_release(§
);
163 void stage_updated_gitmodules(struct index_state
*istate
)
165 if (add_file_to_index(istate
, GITMODULES_FILE
, 0))
166 die(_("staging updated .gitmodules failed"));
169 static struct string_list added_submodule_odb_paths
= STRING_LIST_INIT_NODUP
;
171 void add_submodule_odb_by_path(const char *path
)
173 string_list_insert(&added_submodule_odb_paths
, xstrdup(path
));
176 int register_all_submodule_odb_as_alternates(void)
179 int ret
= added_submodule_odb_paths
.nr
;
181 for (i
= 0; i
< added_submodule_odb_paths
.nr
; i
++)
182 add_to_alternates_memory(added_submodule_odb_paths
.items
[i
].string
);
184 string_list_clear(&added_submodule_odb_paths
, 0);
185 trace2_data_intmax("submodule", the_repository
,
186 "register_all_submodule_odb_as_alternates/registered", ret
);
187 if (git_env_bool("GIT_TEST_FATAL_REGISTER_SUBMODULE_ODB", 0))
188 BUG("register_all_submodule_odb_as_alternates() called");
193 void set_diffopt_flags_from_submodule_config(struct diff_options
*diffopt
,
196 const struct submodule
*submodule
= submodule_from_path(the_repository
,
203 key
= xstrfmt("submodule.%s.ignore", submodule
->name
);
204 if (repo_config_get_string_tmp(the_repository
, key
, &ignore
))
205 ignore
= submodule
->ignore
;
209 handle_ignore_submodules_arg(diffopt
, ignore
);
210 else if (is_gitmodules_unmerged(the_repository
->index
))
211 diffopt
->flags
.ignore_submodules
= 1;
215 /* Cheap function that only determines if we're interested in submodules at all */
216 int git_default_submodule_config(const char *var
, const char *value
, void *cb
)
218 if (!strcmp(var
, "submodule.recurse")) {
219 int v
= git_config_bool(var
, value
) ?
220 RECURSE_SUBMODULES_ON
: RECURSE_SUBMODULES_OFF
;
221 config_update_recurse_submodules
= v
;
226 int option_parse_recurse_submodules_worktree_updater(const struct option
*opt
,
227 const char *arg
, int unset
)
230 config_update_recurse_submodules
= RECURSE_SUBMODULES_OFF
;
234 config_update_recurse_submodules
=
235 parse_update_recurse_submodules_arg(opt
->long_name
,
238 config_update_recurse_submodules
= RECURSE_SUBMODULES_ON
;
244 * Determine if a submodule has been initialized at a given 'path'
247 * NEEDSWORK: Emit a warning if submodule.active exists, but is valueless,
248 * ie, the config looks like: "[submodule] active\n".
249 * Since that is an invalid pathspec, we should inform the user.
251 int is_tree_submodule_active(struct repository
*repo
,
252 const struct object_id
*treeish_name
,
258 const struct string_list
*sl
;
259 const struct submodule
*module
;
261 module
= submodule_from_path(repo
, treeish_name
, path
);
263 /* early return if there isn't a path->module mapping */
267 /* submodule.<name>.active is set */
268 key
= xstrfmt("submodule.%s.active", module
->name
);
269 if (!repo_config_get_bool(repo
, key
, &ret
)) {
275 /* submodule.active is set */
276 sl
= repo_config_get_value_multi(repo
, "submodule.active");
279 struct strvec args
= STRVEC_INIT
;
280 const struct string_list_item
*item
;
282 for_each_string_list_item(item
, sl
) {
283 strvec_push(&args
, item
->string
);
286 parse_pathspec(&ps
, 0, 0, NULL
, args
.v
);
287 ret
= match_pathspec(repo
->index
, &ps
, path
, strlen(path
), 0, NULL
, 1);
294 /* fallback to checking if the URL is set */
295 key
= xstrfmt("submodule.%s.url", module
->name
);
296 ret
= !repo_config_get_string(repo
, key
, &value
);
303 int is_submodule_active(struct repository
*repo
, const char *path
)
305 return is_tree_submodule_active(repo
, null_oid(), path
);
308 int is_submodule_populated_gently(const char *path
, int *return_error_code
)
311 char *gitdir
= xstrfmt("%s/.git", path
);
313 if (resolve_gitdir_gently(gitdir
, return_error_code
))
321 * Dies if the provided 'prefix' corresponds to an unpopulated submodule
323 void die_in_unpopulated_submodule(struct index_state
*istate
,
331 prefixlen
= strlen(prefix
);
333 for (i
= 0; i
< istate
->cache_nr
; i
++) {
334 struct cache_entry
*ce
= istate
->cache
[i
];
335 int ce_len
= ce_namelen(ce
);
337 if (!S_ISGITLINK(ce
->ce_mode
))
339 if (prefixlen
<= ce_len
)
341 if (strncmp(ce
->name
, prefix
, ce_len
))
343 if (prefix
[ce_len
] != '/')
346 die(_("in unpopulated submodule '%s'"), ce
->name
);
351 * Dies if any paths in the provided pathspec descends into a submodule
353 void die_path_inside_submodule(struct index_state
*istate
,
354 const struct pathspec
*ps
)
358 for (i
= 0; i
< istate
->cache_nr
; i
++) {
359 struct cache_entry
*ce
= istate
->cache
[i
];
360 int ce_len
= ce_namelen(ce
);
362 if (!S_ISGITLINK(ce
->ce_mode
))
365 for (j
= 0; j
< ps
->nr
; j
++) {
366 const struct pathspec_item
*item
= &ps
->items
[j
];
368 if (item
->len
<= ce_len
)
370 if (item
->match
[ce_len
] != '/')
372 if (strncmp(ce
->name
, item
->match
, ce_len
))
374 if (item
->len
== ce_len
+ 1)
377 die(_("Pathspec '%s' is in submodule '%.*s'"),
378 item
->original
, ce_len
, ce
->name
);
383 enum submodule_update_type
parse_submodule_update_type(const char *value
)
385 if (!strcmp(value
, "none"))
386 return SM_UPDATE_NONE
;
387 else if (!strcmp(value
, "checkout"))
388 return SM_UPDATE_CHECKOUT
;
389 else if (!strcmp(value
, "rebase"))
390 return SM_UPDATE_REBASE
;
391 else if (!strcmp(value
, "merge"))
392 return SM_UPDATE_MERGE
;
393 else if (*value
== '!')
394 return SM_UPDATE_COMMAND
;
396 return SM_UPDATE_UNSPECIFIED
;
399 int parse_submodule_update_strategy(const char *value
,
400 struct submodule_update_strategy
*dst
)
402 enum submodule_update_type type
;
404 free((void*)dst
->command
);
407 type
= parse_submodule_update_type(value
);
408 if (type
== SM_UPDATE_UNSPECIFIED
)
412 if (type
== SM_UPDATE_COMMAND
)
413 dst
->command
= xstrdup(value
+ 1);
418 const char *submodule_update_type_to_string(enum submodule_update_type type
)
421 case SM_UPDATE_CHECKOUT
:
423 case SM_UPDATE_MERGE
:
425 case SM_UPDATE_REBASE
:
429 case SM_UPDATE_UNSPECIFIED
:
430 case SM_UPDATE_COMMAND
:
431 BUG("init_submodule() should handle type %d", type
);
433 BUG("unexpected update strategy type: %d", type
);
437 void handle_ignore_submodules_arg(struct diff_options
*diffopt
,
440 diffopt
->flags
.ignore_submodule_set
= 1;
441 diffopt
->flags
.ignore_submodules
= 0;
442 diffopt
->flags
.ignore_untracked_in_submodules
= 0;
443 diffopt
->flags
.ignore_dirty_submodules
= 0;
445 if (!strcmp(arg
, "all"))
446 diffopt
->flags
.ignore_submodules
= 1;
447 else if (!strcmp(arg
, "untracked"))
448 diffopt
->flags
.ignore_untracked_in_submodules
= 1;
449 else if (!strcmp(arg
, "dirty"))
450 diffopt
->flags
.ignore_dirty_submodules
= 1;
451 else if (strcmp(arg
, "none"))
452 die(_("bad --ignore-submodules argument: %s"), arg
);
454 * Please update _git_status() in git-completion.bash when you
459 static int prepare_submodule_diff_summary(struct repository
*r
, struct rev_info
*rev
,
461 struct commit
*left
, struct commit
*right
,
462 struct commit_list
*merge_bases
)
464 struct commit_list
*list
;
466 repo_init_revisions(r
, 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_diff_summary(struct repository
*r
, 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 repo_format_commit_message(r
, commit
, format
, &sb
,
494 strbuf_addch(&sb
, '\n');
495 if (commit
->object
.flags
& SYMMETRIC_LEFT
)
496 diff_emit_submodule_del(o
, sb
.buf
);
498 diff_emit_submodule_add(o
, sb
.buf
);
503 void prepare_submodule_repo_env(struct strvec
*out
)
505 prepare_other_repo_env(out
, DEFAULT_GIT_DIR_ENVIRONMENT
);
508 static void prepare_submodule_repo_env_in_gitdir(struct strvec
*out
)
510 prepare_other_repo_env(out
, ".");
514 * Initialize a repository struct for a submodule based on the provided 'path'.
516 * Returns the repository struct on success,
517 * NULL when the submodule is not present.
519 static struct repository
*open_submodule(const char *path
)
521 struct strbuf sb
= STRBUF_INIT
;
522 struct repository
*out
= xmalloc(sizeof(*out
));
524 if (submodule_to_gitdir(&sb
, path
) || repo_init(out
, sb
.buf
, NULL
)) {
530 /* Mark it as a submodule */
531 out
->submodule_prefix
= xstrdup(path
);
538 * Helper function to display the submodule header line prior to the full
541 * If it can locate the submodule git directory it will create a repository
542 * handle for the submodule and lookup both the left and right commits and
543 * put them into the left and right pointers.
545 static void show_submodule_header(struct diff_options
*o
,
547 struct object_id
*one
, struct object_id
*two
,
548 unsigned dirty_submodule
,
549 struct repository
*sub
,
550 struct commit
**left
, struct commit
**right
,
551 struct commit_list
**merge_bases
)
553 const char *message
= NULL
;
554 struct strbuf sb
= STRBUF_INIT
;
555 int fast_forward
= 0, fast_backward
= 0;
557 if (dirty_submodule
& DIRTY_SUBMODULE_UNTRACKED
)
558 diff_emit_submodule_untracked(o
, path
);
560 if (dirty_submodule
& DIRTY_SUBMODULE_MODIFIED
)
561 diff_emit_submodule_modified(o
, path
);
563 if (is_null_oid(one
))
564 message
= "(new submodule)";
565 else if (is_null_oid(two
))
566 message
= "(submodule deleted)";
570 message
= "(commits not present)";
575 * Attempt to lookup the commit references, and determine if this is
576 * a fast forward or fast backwards update.
578 *left
= lookup_commit_reference(sub
, one
);
579 *right
= lookup_commit_reference(sub
, two
);
582 * Warn about missing commits in the submodule project, but only if
585 if ((!is_null_oid(one
) && !*left
) ||
586 (!is_null_oid(two
) && !*right
))
587 message
= "(commits not present)";
589 *merge_bases
= repo_get_merge_bases(sub
, *left
, *right
);
591 if ((*merge_bases
)->item
== *left
)
593 else if ((*merge_bases
)->item
== *right
)
597 if (oideq(one
, two
)) {
603 strbuf_addf(&sb
, "Submodule %s ", path
);
604 strbuf_add_unique_abbrev(&sb
, one
, DEFAULT_ABBREV
);
605 strbuf_addstr(&sb
, (fast_backward
|| fast_forward
) ? ".." : "...");
606 strbuf_add_unique_abbrev(&sb
, two
, DEFAULT_ABBREV
);
608 strbuf_addf(&sb
, " %s\n", message
);
610 strbuf_addf(&sb
, "%s:\n", fast_backward
? " (rewind)" : "");
611 diff_emit_submodule_header(o
, sb
.buf
);
616 void show_submodule_diff_summary(struct diff_options
*o
, const char *path
,
617 struct object_id
*one
, struct object_id
*two
,
618 unsigned dirty_submodule
)
620 struct rev_info rev
= REV_INFO_INIT
;
621 struct commit
*left
= NULL
, *right
= NULL
;
622 struct commit_list
*merge_bases
= NULL
;
623 struct repository
*sub
;
625 sub
= open_submodule(path
);
626 show_submodule_header(o
, path
, one
, two
, dirty_submodule
,
627 sub
, &left
, &right
, &merge_bases
);
630 * If we don't have both a left and a right pointer, there is no
631 * reason to try and display a summary. The header line should contain
632 * all the information the user needs.
634 if (!left
|| !right
|| !sub
)
637 /* Treat revision walker failure the same as missing commits */
638 if (prepare_submodule_diff_summary(sub
, &rev
, path
, left
, right
, merge_bases
)) {
639 diff_emit_submodule_error(o
, "(revision walker failed)\n");
643 print_submodule_diff_summary(sub
, &rev
, o
);
646 free_commit_list(merge_bases
);
647 release_revisions(&rev
);
648 clear_commit_marks(left
, ~0);
649 clear_commit_marks(right
, ~0);
656 void show_submodule_inline_diff(struct diff_options
*o
, const char *path
,
657 struct object_id
*one
, struct object_id
*two
,
658 unsigned dirty_submodule
)
660 const struct object_id
*old_oid
= the_hash_algo
->empty_tree
, *new_oid
= the_hash_algo
->empty_tree
;
661 struct commit
*left
= NULL
, *right
= NULL
;
662 struct commit_list
*merge_bases
= NULL
;
663 struct child_process cp
= CHILD_PROCESS_INIT
;
664 struct strbuf sb
= STRBUF_INIT
;
665 struct repository
*sub
;
667 sub
= open_submodule(path
);
668 show_submodule_header(o
, path
, one
, two
, dirty_submodule
,
669 sub
, &left
, &right
, &merge_bases
);
671 /* We need a valid left and right commit to display a difference */
672 if (!(left
|| is_null_oid(one
)) ||
673 !(right
|| is_null_oid(two
)))
686 /* TODO: other options may need to be passed here. */
687 strvec_pushl(&cp
.args
, "diff", "--submodule=diff", NULL
);
688 strvec_pushf(&cp
.args
, "--color=%s", want_color(o
->use_color
) ?
691 if (o
->flags
.reverse_diff
) {
692 strvec_pushf(&cp
.args
, "--src-prefix=%s%s/",
694 strvec_pushf(&cp
.args
, "--dst-prefix=%s%s/",
697 strvec_pushf(&cp
.args
, "--src-prefix=%s%s/",
699 strvec_pushf(&cp
.args
, "--dst-prefix=%s%s/",
702 strvec_push(&cp
.args
, oid_to_hex(old_oid
));
704 * If the submodule has modified content, we will diff against the
705 * work tree, under the assumption that the user has asked for the
706 * diff format and wishes to actually see all differences even if they
707 * haven't yet been committed to the submodule yet.
709 if (!(dirty_submodule
& DIRTY_SUBMODULE_MODIFIED
))
710 strvec_push(&cp
.args
, oid_to_hex(new_oid
));
712 prepare_submodule_repo_env(&cp
.env
);
714 if (!is_directory(path
)) {
715 /* fall back to absorbed git dir, if any */
718 cp
.dir
= sub
->gitdir
;
719 strvec_push(&cp
.env
, GIT_DIR_ENVIRONMENT
"=.");
720 strvec_push(&cp
.env
, GIT_WORK_TREE_ENVIRONMENT
"=.");
723 if (start_command(&cp
)) {
724 diff_emit_submodule_error(o
, "(diff failed)\n");
728 while (strbuf_getwholeline_fd(&sb
, cp
.out
, '\n') != EOF
)
729 diff_emit_submodule_pipethrough(o
, sb
.buf
, sb
.len
);
731 if (finish_command(&cp
))
732 diff_emit_submodule_error(o
, "(diff failed)\n");
736 free_commit_list(merge_bases
);
738 clear_commit_marks(left
, ~0);
740 clear_commit_marks(right
, ~0);
747 int should_update_submodules(void)
749 return config_update_recurse_submodules
== RECURSE_SUBMODULES_ON
;
752 const struct submodule
*submodule_from_ce(const struct cache_entry
*ce
)
754 if (!S_ISGITLINK(ce
->ce_mode
))
757 if (!should_update_submodules())
760 return submodule_from_path(the_repository
, null_oid(), ce
->name
);
764 struct collect_changed_submodules_cb_data
{
765 struct repository
*repo
;
766 struct string_list
*changed
;
767 const struct object_id
*commit_oid
;
771 * this would normally be two functions: default_name_from_path() and
772 * path_from_default_name(). Since the default name is the same as
773 * the submodule path we can get away with just one function which only
774 * checks whether there is a submodule in the working directory at that
777 static const char *default_name_or_path(const char *path_or_name
)
781 if (!is_submodule_populated_gently(path_or_name
, &error_code
))
788 * Holds relevant information for a changed submodule. Used as the .util
789 * member of the changed submodule name string_list_item.
791 * (super_oid, path) allows the submodule config to be read from _some_
792 * .gitmodules file. We store this information the first time we find a
793 * superproject commit that points to the submodule, but this is
794 * arbitrary - we can choose any (super_oid, path) that matches the
797 * NEEDSWORK: Storing an arbitrary commit is undesirable because we can't
798 * guarantee that we're reading the commit that the user would expect. A better
799 * scheme would be to just fetch a submodule by its name. This requires two
801 * - Create a function that behaves like repo_submodule_init(), but accepts a
802 * submodule name instead of treeish_name and path. This should be easy
803 * because repo_submodule_init() internally uses the submodule's name.
805 * - Replace most instances of 'struct submodule' (which is the .gitmodules
806 * config) with just the submodule name. This is OK because we expect
807 * submodule settings to be stored in .git/config (via "git submodule init"),
808 * not .gitmodules. This also lets us delete get_non_gitmodules_submodule(),
809 * which constructs a bogus 'struct submodule' for the sake of giving a
810 * placeholder name to a gitlink.
812 struct changed_submodule_data
{
814 * The first superproject commit in the rev walk that points to
817 const struct object_id
*super_oid
;
819 * Path to the submodule in the superproject commit referenced
823 /* The submodule commits that have changed in the rev walk. */
824 struct oid_array new_commits
;
827 static void changed_submodule_data_clear(struct changed_submodule_data
*cs_data
)
829 oid_array_clear(&cs_data
->new_commits
);
833 static void collect_changed_submodules_cb(struct diff_queue_struct
*q
,
834 struct diff_options
*options
,
837 struct collect_changed_submodules_cb_data
*me
= data
;
838 struct string_list
*changed
= me
->changed
;
839 const struct object_id
*commit_oid
= me
->commit_oid
;
842 for (i
= 0; i
< q
->nr
; i
++) {
843 struct diff_filepair
*p
= q
->queue
[i
];
844 const struct submodule
*submodule
;
846 struct string_list_item
*item
;
847 struct changed_submodule_data
*cs_data
;
849 if (!S_ISGITLINK(p
->two
->mode
))
852 submodule
= submodule_from_path(me
->repo
,
853 commit_oid
, p
->two
->path
);
855 name
= submodule
->name
;
857 name
= default_name_or_path(p
->two
->path
);
858 /* make sure name does not collide with existing one */
860 submodule
= submodule_from_name(me
->repo
,
863 warning(_("Submodule in commit %s at path: "
864 "'%s' collides with a submodule named "
865 "the same. Skipping it."),
866 oid_to_hex(commit_oid
), p
->two
->path
);
874 item
= string_list_insert(changed
, name
);
876 cs_data
= item
->util
;
878 item
->util
= xcalloc(1, sizeof(struct changed_submodule_data
));
879 cs_data
= item
->util
;
880 cs_data
->super_oid
= commit_oid
;
881 cs_data
->path
= xstrdup(p
->two
->path
);
883 oid_array_append(&cs_data
->new_commits
, &p
->two
->oid
);
888 * Collect the paths of submodules in 'changed' which have changed based on
889 * the revisions as specified in 'argv'. Each entry in 'changed' will also
890 * have a corresponding 'struct oid_array' (in the 'util' field) which lists
891 * what the submodule pointers were updated to during the change.
893 static void collect_changed_submodules(struct repository
*r
,
894 struct string_list
*changed
,
898 const struct commit
*commit
;
900 struct setup_revision_opt s_r_opt
= {
901 .assume_dashdash
= 1,
904 save_warning
= warn_on_object_refname_ambiguity
;
905 warn_on_object_refname_ambiguity
= 0;
906 repo_init_revisions(r
, &rev
, NULL
);
907 setup_revisions(argv
->nr
, argv
->v
, &rev
, &s_r_opt
);
908 warn_on_object_refname_ambiguity
= save_warning
;
909 if (prepare_revision_walk(&rev
))
910 die(_("revision walk setup failed"));
912 while ((commit
= get_revision(&rev
))) {
913 struct rev_info diff_rev
;
914 struct collect_changed_submodules_cb_data data
;
916 data
.changed
= changed
;
917 data
.commit_oid
= &commit
->object
.oid
;
919 repo_init_revisions(r
, &diff_rev
, NULL
);
920 diff_rev
.diffopt
.output_format
|= DIFF_FORMAT_CALLBACK
;
921 diff_rev
.diffopt
.format_callback
= collect_changed_submodules_cb
;
922 diff_rev
.diffopt
.format_callback_data
= &data
;
923 diff_rev
.dense_combined_merges
= 1;
924 diff_tree_combined_merge(commit
, &diff_rev
);
925 release_revisions(&diff_rev
);
928 reset_revision_walk();
929 release_revisions(&rev
);
932 static void free_submodules_data(struct string_list
*submodules
)
934 struct string_list_item
*item
;
935 for_each_string_list_item(item
, submodules
)
936 changed_submodule_data_clear(item
->util
);
938 string_list_clear(submodules
, 1);
941 static int has_remote(const char *refname
, const struct object_id
*oid
,
942 int flags
, void *cb_data
)
947 static int append_oid_to_argv(const struct object_id
*oid
, void *data
)
949 struct strvec
*argv
= data
;
950 strvec_push(argv
, oid_to_hex(oid
));
954 struct has_commit_data
{
955 struct repository
*repo
;
958 const struct object_id
*super_oid
;
961 static int check_has_commit(const struct object_id
*oid
, void *data
)
963 struct has_commit_data
*cb
= data
;
964 struct repository subrepo
;
965 enum object_type type
;
967 if (repo_submodule_init(&subrepo
, cb
->repo
, cb
->path
, cb
->super_oid
)) {
969 /* subrepo failed to init, so don't clean it up. */
973 type
= oid_object_info(&subrepo
, oid
, NULL
);
980 * Object is missing or invalid. If invalid, an error message
981 * has already been printed.
986 die(_("submodule entry '%s' (%s) is a %s, not a commit"),
987 cb
->path
, oid_to_hex(oid
), type_name(type
));
990 repo_clear(&subrepo
);
994 static int submodule_has_commits(struct repository
*r
,
996 const struct object_id
*super_oid
,
997 struct oid_array
*commits
)
999 struct has_commit_data has_commit
= {
1003 .super_oid
= super_oid
1006 oid_array_for_each_unique(commits
, check_has_commit
, &has_commit
);
1008 if (has_commit
.result
) {
1010 * Even if the submodule is checked out and the commit is
1011 * present, make sure it exists in the submodule's object store
1012 * and that it is reachable from a ref.
1014 struct child_process cp
= CHILD_PROCESS_INIT
;
1015 struct strbuf out
= STRBUF_INIT
;
1017 strvec_pushl(&cp
.args
, "rev-list", "-n", "1", NULL
);
1018 oid_array_for_each_unique(commits
, append_oid_to_argv
, &cp
.args
);
1019 strvec_pushl(&cp
.args
, "--not", "--all", NULL
);
1021 prepare_submodule_repo_env(&cp
.env
);
1026 if (capture_command(&cp
, &out
, GIT_MAX_HEXSZ
+ 1) || out
.len
)
1027 has_commit
.result
= 0;
1029 strbuf_release(&out
);
1032 return has_commit
.result
;
1035 static int submodule_needs_pushing(struct repository
*r
,
1037 struct oid_array
*commits
)
1039 if (!submodule_has_commits(r
, path
, null_oid(), commits
))
1041 * NOTE: We do consider it safe to return "no" here. The
1042 * correct answer would be "We do not know" instead of
1043 * "No push needed", but it is quite hard to change
1044 * the submodule pointer without having the submodule
1045 * around. If a user did however change the submodules
1046 * without having the submodule around, this indicates
1047 * an expert who knows what they are doing or a
1048 * maintainer integrating work from other people. In
1049 * both cases it should be safe to skip this check.
1053 if (for_each_remote_ref_submodule(path
, has_remote
, NULL
) > 0) {
1054 struct child_process cp
= CHILD_PROCESS_INIT
;
1055 struct strbuf buf
= STRBUF_INIT
;
1056 int needs_pushing
= 0;
1058 strvec_push(&cp
.args
, "rev-list");
1059 oid_array_for_each_unique(commits
, append_oid_to_argv
, &cp
.args
);
1060 strvec_pushl(&cp
.args
, "--not", "--remotes", "-n", "1" , NULL
);
1062 prepare_submodule_repo_env(&cp
.env
);
1067 if (start_command(&cp
))
1068 die(_("Could not run 'git rev-list <commits> --not --remotes -n 1' command in submodule %s"),
1070 if (strbuf_read(&buf
, cp
.out
, the_hash_algo
->hexsz
+ 1))
1072 finish_command(&cp
);
1074 strbuf_release(&buf
);
1075 return needs_pushing
;
1081 int find_unpushed_submodules(struct repository
*r
,
1082 struct oid_array
*commits
,
1083 const char *remotes_name
,
1084 struct string_list
*needs_pushing
)
1086 struct string_list submodules
= STRING_LIST_INIT_DUP
;
1087 struct string_list_item
*name
;
1088 struct strvec argv
= STRVEC_INIT
;
1090 /* argv.v[0] will be ignored by setup_revisions */
1091 strvec_push(&argv
, "find_unpushed_submodules");
1092 oid_array_for_each_unique(commits
, append_oid_to_argv
, &argv
);
1093 strvec_push(&argv
, "--not");
1094 strvec_pushf(&argv
, "--remotes=%s", remotes_name
);
1096 collect_changed_submodules(r
, &submodules
, &argv
);
1098 for_each_string_list_item(name
, &submodules
) {
1099 struct changed_submodule_data
*cs_data
= name
->util
;
1100 const struct submodule
*submodule
;
1101 const char *path
= NULL
;
1103 submodule
= submodule_from_name(r
, null_oid(), name
->string
);
1105 path
= submodule
->path
;
1107 path
= default_name_or_path(name
->string
);
1112 if (submodule_needs_pushing(r
, path
, &cs_data
->new_commits
))
1113 string_list_insert(needs_pushing
, path
);
1116 free_submodules_data(&submodules
);
1117 strvec_clear(&argv
);
1119 return needs_pushing
->nr
;
1122 static int push_submodule(const char *path
,
1123 const struct remote
*remote
,
1124 const struct refspec
*rs
,
1125 const struct string_list
*push_options
,
1128 if (for_each_remote_ref_submodule(path
, has_remote
, NULL
) > 0) {
1129 struct child_process cp
= CHILD_PROCESS_INIT
;
1130 strvec_push(&cp
.args
, "push");
1132 strvec_push(&cp
.args
, "--dry-run");
1134 if (push_options
&& push_options
->nr
) {
1135 const struct string_list_item
*item
;
1136 for_each_string_list_item(item
, push_options
)
1137 strvec_pushf(&cp
.args
, "--push-option=%s",
1141 if (remote
->origin
!= REMOTE_UNCONFIGURED
) {
1143 strvec_push(&cp
.args
, remote
->name
);
1144 for (i
= 0; i
< rs
->raw_nr
; i
++)
1145 strvec_push(&cp
.args
, rs
->raw
[i
]);
1148 prepare_submodule_repo_env(&cp
.env
);
1152 if (run_command(&cp
))
1161 * Perform a check in the submodule to see if the remote and refspec work.
1162 * Die if the submodule can't be pushed.
1164 static void submodule_push_check(const char *path
, const char *head
,
1165 const struct remote
*remote
,
1166 const struct refspec
*rs
)
1168 struct child_process cp
= CHILD_PROCESS_INIT
;
1171 strvec_push(&cp
.args
, "submodule--helper");
1172 strvec_push(&cp
.args
, "push-check");
1173 strvec_push(&cp
.args
, head
);
1174 strvec_push(&cp
.args
, remote
->name
);
1176 for (i
= 0; i
< rs
->raw_nr
; i
++)
1177 strvec_push(&cp
.args
, rs
->raw
[i
]);
1179 prepare_submodule_repo_env(&cp
.env
);
1186 * Simply indicate if 'submodule--helper push-check' failed.
1187 * More detailed error information will be provided by the
1190 if (run_command(&cp
))
1191 die(_("process for submodule '%s' failed"), path
);
1194 int push_unpushed_submodules(struct repository
*r
,
1195 struct oid_array
*commits
,
1196 const struct remote
*remote
,
1197 const struct refspec
*rs
,
1198 const struct string_list
*push_options
,
1202 struct string_list needs_pushing
= STRING_LIST_INIT_DUP
;
1204 if (!find_unpushed_submodules(r
, commits
,
1205 remote
->name
, &needs_pushing
))
1209 * Verify that the remote and refspec can be propagated to all
1210 * submodules. This check can be skipped if the remote and refspec
1211 * won't be propagated due to the remote being unconfigured (e.g. a URL
1212 * instead of a remote name).
1214 if (remote
->origin
!= REMOTE_UNCONFIGURED
) {
1216 struct object_id head_oid
;
1218 head
= resolve_refdup("HEAD", 0, &head_oid
, NULL
);
1220 die(_("Failed to resolve HEAD as a valid ref."));
1222 for (i
= 0; i
< needs_pushing
.nr
; i
++)
1223 submodule_push_check(needs_pushing
.items
[i
].string
,
1228 /* Actually push the submodules */
1229 for (i
= 0; i
< needs_pushing
.nr
; i
++) {
1230 const char *path
= needs_pushing
.items
[i
].string
;
1231 fprintf(stderr
, _("Pushing submodule '%s'\n"), path
);
1232 if (!push_submodule(path
, remote
, rs
,
1233 push_options
, dry_run
)) {
1234 fprintf(stderr
, _("Unable to push submodule '%s'\n"), path
);
1239 string_list_clear(&needs_pushing
, 0);
1244 static int append_oid_to_array(const char *ref
, const struct object_id
*oid
,
1245 int flags
, void *data
)
1247 struct oid_array
*array
= data
;
1248 oid_array_append(array
, oid
);
1252 void check_for_new_submodule_commits(struct object_id
*oid
)
1254 if (!initialized_fetch_ref_tips
) {
1255 for_each_ref(append_oid_to_array
, &ref_tips_before_fetch
);
1256 initialized_fetch_ref_tips
= 1;
1259 oid_array_append(&ref_tips_after_fetch
, oid
);
1263 * Returns 1 if there is at least one submodule gitdir in
1264 * $GIT_DIR/modules and 0 otherwise. This follows
1265 * submodule_name_to_gitdir(), which looks for submodules in
1266 * $GIT_DIR/modules, not $GIT_COMMON_DIR.
1268 * A submodule can be moved to $GIT_DIR/modules manually by running "git
1269 * submodule absorbgitdirs", or it may be initialized there by "git
1270 * submodule update".
1272 static int repo_has_absorbed_submodules(struct repository
*r
)
1275 struct strbuf buf
= STRBUF_INIT
;
1277 strbuf_repo_git_path(&buf
, r
, "modules/");
1278 ret
= file_exists(buf
.buf
) && !is_empty_dir(buf
.buf
);
1279 strbuf_release(&buf
);
1283 static void calculate_changed_submodule_paths(struct repository
*r
,
1284 struct string_list
*changed_submodule_names
)
1286 struct strvec argv
= STRVEC_INIT
;
1287 struct string_list_item
*name
;
1289 /* No need to check if no submodules would be fetched */
1290 if (!submodule_from_path(r
, NULL
, NULL
) &&
1291 !repo_has_absorbed_submodules(r
))
1294 strvec_push(&argv
, "--"); /* argv[0] program name */
1295 oid_array_for_each_unique(&ref_tips_after_fetch
,
1296 append_oid_to_argv
, &argv
);
1297 strvec_push(&argv
, "--not");
1298 oid_array_for_each_unique(&ref_tips_before_fetch
,
1299 append_oid_to_argv
, &argv
);
1302 * Collect all submodules (whether checked out or not) for which new
1303 * commits have been recorded upstream in "changed_submodule_names".
1305 collect_changed_submodules(r
, changed_submodule_names
, &argv
);
1307 for_each_string_list_item(name
, changed_submodule_names
) {
1308 struct changed_submodule_data
*cs_data
= name
->util
;
1309 const struct submodule
*submodule
;
1310 const char *path
= NULL
;
1312 submodule
= submodule_from_name(r
, null_oid(), name
->string
);
1314 path
= submodule
->path
;
1316 path
= default_name_or_path(name
->string
);
1321 if (submodule_has_commits(r
, path
, null_oid(), &cs_data
->new_commits
)) {
1322 changed_submodule_data_clear(cs_data
);
1323 *name
->string
= '\0';
1327 string_list_remove_empty_items(changed_submodule_names
, 1);
1329 strvec_clear(&argv
);
1330 oid_array_clear(&ref_tips_before_fetch
);
1331 oid_array_clear(&ref_tips_after_fetch
);
1332 initialized_fetch_ref_tips
= 0;
1335 int submodule_touches_in_range(struct repository
*r
,
1336 struct object_id
*excl_oid
,
1337 struct object_id
*incl_oid
)
1339 struct string_list subs
= STRING_LIST_INIT_DUP
;
1340 struct strvec args
= STRVEC_INIT
;
1343 /* No need to check if there are no submodules configured */
1344 if (!submodule_from_path(r
, NULL
, NULL
))
1347 strvec_push(&args
, "--"); /* args[0] program name */
1348 strvec_push(&args
, oid_to_hex(incl_oid
));
1349 if (!is_null_oid(excl_oid
)) {
1350 strvec_push(&args
, "--not");
1351 strvec_push(&args
, oid_to_hex(excl_oid
));
1354 collect_changed_submodules(r
, &subs
, &args
);
1357 strvec_clear(&args
);
1359 free_submodules_data(&subs
);
1363 struct submodule_parallel_fetch
{
1365 * The index of the last index entry processed by
1366 * get_fetch_task_from_index().
1370 * The index of the last string_list entry processed by
1371 * get_fetch_task_from_changed().
1375 struct repository
*r
;
1377 int command_line_option
;
1383 * Names of submodules that have new commits. Generated by
1384 * walking the newly fetched superproject commits.
1386 struct string_list changed_submodule_names
;
1388 * Names of submodules that have already been processed. Lets us
1389 * avoid fetching the same submodule more than once.
1391 struct string_list seen_submodule_names
;
1393 /* Pending fetches by OIDs */
1394 struct fetch_task
**oid_fetch_tasks
;
1395 int oid_fetch_tasks_nr
, oid_fetch_tasks_alloc
;
1397 struct strbuf submodules_with_errors
;
1399 #define SPF_INIT { \
1400 .args = STRVEC_INIT, \
1401 .changed_submodule_names = STRING_LIST_INIT_DUP, \
1402 .seen_submodule_names = STRING_LIST_INIT_DUP, \
1403 .submodules_with_errors = STRBUF_INIT, \
1406 static int get_fetch_recurse_config(const struct submodule
*submodule
,
1407 struct submodule_parallel_fetch
*spf
)
1409 if (spf
->command_line_option
!= RECURSE_SUBMODULES_DEFAULT
)
1410 return spf
->command_line_option
;
1416 int fetch_recurse
= submodule
->fetch_recurse
;
1417 key
= xstrfmt("submodule.%s.fetchRecurseSubmodules", submodule
->name
);
1418 if (!repo_config_get_string_tmp(spf
->r
, key
, &value
)) {
1419 fetch_recurse
= parse_fetch_recurse_submodules_arg(key
, value
);
1423 if (fetch_recurse
!= RECURSE_SUBMODULES_NONE
)
1424 /* local config overrules everything except commandline */
1425 return fetch_recurse
;
1428 return spf
->default_option
;
1432 * Fetch in progress (if callback data) or
1433 * pending (if in oid_fetch_tasks in struct submodule_parallel_fetch)
1436 struct repository
*repo
;
1437 const struct submodule
*sub
;
1438 unsigned free_sub
: 1; /* Do we need to free the submodule? */
1439 const char *default_argv
; /* The default fetch mode. */
1440 struct strvec git_args
; /* Args for the child git process. */
1442 struct oid_array
*commits
; /* Ensure these commits are fetched */
1446 * When a submodule is not defined in .gitmodules, we cannot access it
1447 * via the regular submodule-config. Create a fake submodule, which we can
1450 static const struct submodule
*get_non_gitmodules_submodule(const char *path
)
1452 struct submodule
*ret
= NULL
;
1453 const char *name
= default_name_or_path(path
);
1458 ret
= xmalloc(sizeof(*ret
));
1459 memset(ret
, 0, sizeof(*ret
));
1463 return (const struct submodule
*) ret
;
1466 static void fetch_task_release(struct fetch_task
*p
)
1469 free((void*)p
->sub
);
1474 repo_clear(p
->repo
);
1475 FREE_AND_NULL(p
->repo
);
1477 strvec_clear(&p
->git_args
);
1480 static struct repository
*get_submodule_repo_for(struct repository
*r
,
1482 const struct object_id
*treeish_name
)
1484 struct repository
*ret
= xmalloc(sizeof(*ret
));
1486 if (repo_submodule_init(ret
, r
, path
, treeish_name
)) {
1494 static struct fetch_task
*fetch_task_create(struct submodule_parallel_fetch
*spf
,
1496 const struct object_id
*treeish_name
)
1498 struct fetch_task
*task
= xmalloc(sizeof(*task
));
1499 memset(task
, 0, sizeof(*task
));
1501 task
->sub
= submodule_from_path(spf
->r
, treeish_name
, path
);
1505 * No entry in .gitmodules? Technically not a submodule,
1506 * but historically we supported repositories that happen to be
1507 * in-place where a gitlink is. Keep supporting them.
1509 task
->sub
= get_non_gitmodules_submodule(path
);
1516 if (string_list_lookup(&spf
->seen_submodule_names
, task
->sub
->name
))
1519 switch (get_fetch_recurse_config(task
->sub
, spf
))
1522 case RECURSE_SUBMODULES_DEFAULT
:
1523 case RECURSE_SUBMODULES_ON_DEMAND
:
1525 !string_list_lookup(
1526 &spf
->changed_submodule_names
,
1529 task
->default_argv
= "on-demand";
1531 case RECURSE_SUBMODULES_ON
:
1532 task
->default_argv
= "yes";
1534 case RECURSE_SUBMODULES_OFF
:
1538 task
->repo
= get_submodule_repo_for(spf
->r
, path
, treeish_name
);
1543 fetch_task_release(task
);
1548 static struct fetch_task
*
1549 get_fetch_task_from_index(struct submodule_parallel_fetch
*spf
,
1552 for (; spf
->index_count
< spf
->r
->index
->cache_nr
; spf
->index_count
++) {
1553 const struct cache_entry
*ce
=
1554 spf
->r
->index
->cache
[spf
->index_count
];
1555 struct fetch_task
*task
;
1557 if (!S_ISGITLINK(ce
->ce_mode
))
1560 task
= fetch_task_create(spf
, ce
->name
, null_oid());
1566 strbuf_addf(err
, _("Fetching submodule %s%s\n"),
1567 spf
->prefix
, ce
->name
);
1572 struct strbuf empty_submodule_path
= STRBUF_INIT
;
1574 fetch_task_release(task
);
1578 * An empty directory is normal,
1579 * the submodule is not initialized
1581 strbuf_addf(&empty_submodule_path
, "%s/%s/",
1584 if (S_ISGITLINK(ce
->ce_mode
) &&
1585 !is_empty_dir(empty_submodule_path
.buf
)) {
1588 _("Could not access submodule '%s'\n"),
1591 strbuf_release(&empty_submodule_path
);
1597 static struct fetch_task
*
1598 get_fetch_task_from_changed(struct submodule_parallel_fetch
*spf
,
1601 for (; spf
->changed_count
< spf
->changed_submodule_names
.nr
;
1602 spf
->changed_count
++) {
1603 struct string_list_item item
=
1604 spf
->changed_submodule_names
.items
[spf
->changed_count
];
1605 struct changed_submodule_data
*cs_data
= item
.util
;
1606 struct fetch_task
*task
;
1608 if (!is_tree_submodule_active(spf
->r
, cs_data
->super_oid
,cs_data
->path
))
1611 task
= fetch_task_create(spf
, cs_data
->path
,
1612 cs_data
->super_oid
);
1617 strbuf_addf(err
, _("Could not access submodule '%s' at commit %s\n"),
1619 find_unique_abbrev(cs_data
->super_oid
, DEFAULT_ABBREV
));
1621 fetch_task_release(task
);
1628 _("Fetching submodule %s%s at commit %s\n"),
1629 spf
->prefix
, task
->sub
->path
,
1630 find_unique_abbrev(cs_data
->super_oid
,
1633 spf
->changed_count
++;
1635 * NEEDSWORK: Submodules set/unset a value for
1636 * core.worktree when they are populated/unpopulated by
1637 * "git checkout" (and similar commands, see
1638 * submodule_move_head() and
1639 * connect_work_tree_and_git_dir()), but if the
1640 * submodule is unpopulated in another way (e.g. "git
1641 * rm", "rm -r"), core.worktree will still be set even
1642 * though the directory doesn't exist, and the child
1643 * process will crash while trying to chdir into the
1644 * nonexistent directory.
1646 * In this case, we know that the submodule has no
1647 * working tree, so we can work around this by
1648 * setting "--work-tree=." (--bare does not work because
1649 * worktree settings take precedence over bare-ness).
1650 * However, this is not necessarily true in other cases,
1651 * so a generalized solution is still necessary.
1653 * Possible solutions:
1654 * - teach "git [add|rm]" to unset core.worktree and
1655 * discourage users from removing submodules without
1656 * using a Git command.
1657 * - teach submodule child processes to ignore stale
1658 * core.worktree values.
1660 strvec_push(&task
->git_args
, "--work-tree=.");
1666 static int get_next_submodule(struct child_process
*cp
, struct strbuf
*err
,
1667 void *data
, void **task_cb
)
1669 struct submodule_parallel_fetch
*spf
= data
;
1670 struct fetch_task
*task
=
1671 get_fetch_task_from_index(spf
, err
);
1673 task
= get_fetch_task_from_changed(spf
, err
);
1676 struct strbuf submodule_prefix
= STRBUF_INIT
;
1678 child_process_init(cp
);
1679 cp
->dir
= task
->repo
->gitdir
;
1680 prepare_submodule_repo_env_in_gitdir(&cp
->env
);
1682 strvec_init(&cp
->args
);
1683 if (task
->git_args
.nr
)
1684 strvec_pushv(&cp
->args
, task
->git_args
.v
);
1685 strvec_pushv(&cp
->args
, spf
->args
.v
);
1686 strvec_push(&cp
->args
, task
->default_argv
);
1687 strvec_push(&cp
->args
, "--submodule-prefix");
1689 strbuf_addf(&submodule_prefix
, "%s%s/",
1692 strvec_push(&cp
->args
, submodule_prefix
.buf
);
1695 strbuf_release(&submodule_prefix
);
1696 string_list_insert(&spf
->seen_submodule_names
, task
->sub
->name
);
1700 if (spf
->oid_fetch_tasks_nr
) {
1701 struct fetch_task
*task
=
1702 spf
->oid_fetch_tasks
[spf
->oid_fetch_tasks_nr
- 1];
1703 struct strbuf submodule_prefix
= STRBUF_INIT
;
1704 spf
->oid_fetch_tasks_nr
--;
1706 strbuf_addf(&submodule_prefix
, "%s%s/",
1707 spf
->prefix
, task
->sub
->path
);
1709 child_process_init(cp
);
1710 prepare_submodule_repo_env_in_gitdir(&cp
->env
);
1712 cp
->dir
= task
->repo
->gitdir
;
1714 strvec_init(&cp
->args
);
1715 strvec_pushv(&cp
->args
, spf
->args
.v
);
1716 strvec_push(&cp
->args
, "on-demand");
1717 strvec_push(&cp
->args
, "--submodule-prefix");
1718 strvec_push(&cp
->args
, submodule_prefix
.buf
);
1720 /* NEEDSWORK: have get_default_remote from submodule--helper */
1721 strvec_push(&cp
->args
, "origin");
1722 oid_array_for_each_unique(task
->commits
,
1723 append_oid_to_argv
, &cp
->args
);
1726 strbuf_release(&submodule_prefix
);
1733 static int fetch_start_failure(struct strbuf
*err
,
1734 void *cb
, void *task_cb
)
1736 struct submodule_parallel_fetch
*spf
= cb
;
1737 struct fetch_task
*task
= task_cb
;
1741 fetch_task_release(task
);
1745 static int commit_missing_in_sub(const struct object_id
*oid
, void *data
)
1747 struct repository
*subrepo
= data
;
1749 enum object_type type
= oid_object_info(subrepo
, oid
, NULL
);
1751 return type
!= OBJ_COMMIT
;
1754 static int fetch_finish(int retvalue
, struct strbuf
*err
,
1755 void *cb
, void *task_cb
)
1757 struct submodule_parallel_fetch
*spf
= cb
;
1758 struct fetch_task
*task
= task_cb
;
1760 struct string_list_item
*it
;
1761 struct changed_submodule_data
*cs_data
;
1763 if (!task
|| !task
->sub
)
1764 BUG("callback cookie bogus");
1768 * NEEDSWORK: This indicates that the overall fetch
1769 * failed, even though there may be a subsequent fetch
1770 * by commit hash that might work. It may be a good
1771 * idea to not indicate failure in this case, and only
1772 * indicate failure if the subsequent fetch fails.
1776 strbuf_addf(&spf
->submodules_with_errors
, "\t%s\n",
1780 /* Is this the second time we process this submodule? */
1784 it
= string_list_lookup(&spf
->changed_submodule_names
, task
->sub
->name
);
1786 /* Could be an unchanged submodule, not contained in the list */
1790 oid_array_filter(&cs_data
->new_commits
,
1791 commit_missing_in_sub
,
1794 /* Are there commits we want, but do not exist? */
1795 if (cs_data
->new_commits
.nr
) {
1796 task
->commits
= &cs_data
->new_commits
;
1797 ALLOC_GROW(spf
->oid_fetch_tasks
,
1798 spf
->oid_fetch_tasks_nr
+ 1,
1799 spf
->oid_fetch_tasks_alloc
);
1800 spf
->oid_fetch_tasks
[spf
->oid_fetch_tasks_nr
] = task
;
1801 spf
->oid_fetch_tasks_nr
++;
1806 fetch_task_release(task
);
1811 int fetch_submodules(struct repository
*r
,
1812 const struct strvec
*options
,
1813 const char *prefix
, int command_line_option
,
1815 int quiet
, int max_parallel_jobs
)
1818 struct submodule_parallel_fetch spf
= SPF_INIT
;
1821 spf
.command_line_option
= command_line_option
;
1822 spf
.default_option
= default_option
;
1824 spf
.prefix
= prefix
;
1829 if (repo_read_index(r
) < 0)
1830 die(_("index file corrupt"));
1832 strvec_push(&spf
.args
, "fetch");
1833 for (i
= 0; i
< options
->nr
; i
++)
1834 strvec_push(&spf
.args
, options
->v
[i
]);
1835 strvec_push(&spf
.args
, "--recurse-submodules-default");
1836 /* default value, "--submodule-prefix" and its value are added later */
1838 calculate_changed_submodule_paths(r
, &spf
.changed_submodule_names
);
1839 string_list_sort(&spf
.changed_submodule_names
);
1840 run_processes_parallel_tr2(max_parallel_jobs
,
1842 fetch_start_failure
,
1845 "submodule", "parallel/fetch");
1847 if (spf
.submodules_with_errors
.len
> 0)
1848 fprintf(stderr
, _("Errors during submodule fetch:\n%s"),
1849 spf
.submodules_with_errors
.buf
);
1852 strvec_clear(&spf
.args
);
1854 free_submodules_data(&spf
.changed_submodule_names
);
1858 unsigned is_submodule_modified(const char *path
, int ignore_untracked
)
1860 struct child_process cp
= CHILD_PROCESS_INIT
;
1861 struct strbuf buf
= STRBUF_INIT
;
1863 unsigned dirty_submodule
= 0;
1864 const char *git_dir
;
1865 int ignore_cp_exit_code
= 0;
1867 strbuf_addf(&buf
, "%s/.git", path
);
1868 git_dir
= read_gitfile(buf
.buf
);
1871 if (!is_git_directory(git_dir
)) {
1872 if (is_directory(git_dir
))
1873 die(_("'%s' not recognized as a git repository"), git_dir
);
1874 strbuf_release(&buf
);
1875 /* The submodule is not checked out, so it is not modified */
1880 strvec_pushl(&cp
.args
, "status", "--porcelain=2", NULL
);
1881 if (ignore_untracked
)
1882 strvec_push(&cp
.args
, "-uno");
1884 prepare_submodule_repo_env(&cp
.env
);
1889 if (start_command(&cp
))
1890 die(_("Could not run 'git status --porcelain=2' in submodule %s"), path
);
1892 fp
= xfdopen(cp
.out
, "r");
1893 while (strbuf_getwholeline(&buf
, fp
, '\n') != EOF
) {
1894 /* regular untracked files */
1895 if (buf
.buf
[0] == '?')
1896 dirty_submodule
|= DIRTY_SUBMODULE_UNTRACKED
;
1898 if (buf
.buf
[0] == 'u' ||
1899 buf
.buf
[0] == '1' ||
1900 buf
.buf
[0] == '2') {
1901 /* T = line type, XY = status, SSSS = submodule state */
1902 if (buf
.len
< strlen("T XY SSSS"))
1903 BUG("invalid status --porcelain=2 line %s",
1906 if (buf
.buf
[5] == 'S' && buf
.buf
[8] == 'U')
1907 /* nested untracked file */
1908 dirty_submodule
|= DIRTY_SUBMODULE_UNTRACKED
;
1910 if (buf
.buf
[0] == 'u' ||
1911 buf
.buf
[0] == '2' ||
1912 memcmp(buf
.buf
+ 5, "S..U", 4))
1914 dirty_submodule
|= DIRTY_SUBMODULE_MODIFIED
;
1917 if ((dirty_submodule
& DIRTY_SUBMODULE_MODIFIED
) &&
1918 ((dirty_submodule
& DIRTY_SUBMODULE_UNTRACKED
) ||
1919 ignore_untracked
)) {
1921 * We're not interested in any further information from
1922 * the child any more, neither output nor its exit code.
1924 ignore_cp_exit_code
= 1;
1930 if (finish_command(&cp
) && !ignore_cp_exit_code
)
1931 die(_("'git status --porcelain=2' failed in submodule %s"), path
);
1933 strbuf_release(&buf
);
1934 return dirty_submodule
;
1937 int submodule_uses_gitfile(const char *path
)
1939 struct child_process cp
= CHILD_PROCESS_INIT
;
1940 struct strbuf buf
= STRBUF_INIT
;
1941 const char *git_dir
;
1943 strbuf_addf(&buf
, "%s/.git", path
);
1944 git_dir
= read_gitfile(buf
.buf
);
1946 strbuf_release(&buf
);
1949 strbuf_release(&buf
);
1951 /* Now test that all nested submodules use a gitfile too */
1952 strvec_pushl(&cp
.args
,
1953 "submodule", "foreach", "--quiet", "--recursive",
1954 "test -f .git", NULL
);
1956 prepare_submodule_repo_env(&cp
.env
);
1962 if (run_command(&cp
))
1969 * Check if it is a bad idea to remove a submodule, i.e. if we'd lose data
1972 * Return 1 if we'd lose data, return 0 if the removal is fine,
1973 * and negative values for errors.
1975 int bad_to_remove_submodule(const char *path
, unsigned flags
)
1978 struct child_process cp
= CHILD_PROCESS_INIT
;
1979 struct strbuf buf
= STRBUF_INIT
;
1982 if (!file_exists(path
) || is_empty_dir(path
))
1985 if (!submodule_uses_gitfile(path
))
1988 strvec_pushl(&cp
.args
, "status", "--porcelain",
1989 "--ignore-submodules=none", NULL
);
1991 if (flags
& SUBMODULE_REMOVAL_IGNORE_UNTRACKED
)
1992 strvec_push(&cp
.args
, "-uno");
1994 strvec_push(&cp
.args
, "-uall");
1996 if (!(flags
& SUBMODULE_REMOVAL_IGNORE_IGNORED_UNTRACKED
))
1997 strvec_push(&cp
.args
, "--ignored");
1999 prepare_submodule_repo_env(&cp
.env
);
2004 if (start_command(&cp
)) {
2005 if (flags
& SUBMODULE_REMOVAL_DIE_ON_ERROR
)
2006 die(_("could not start 'git status' in submodule '%s'"),
2012 len
= strbuf_read(&buf
, cp
.out
, 1024);
2017 if (finish_command(&cp
)) {
2018 if (flags
& SUBMODULE_REMOVAL_DIE_ON_ERROR
)
2019 die(_("could not run 'git status' in submodule '%s'"),
2024 strbuf_release(&buf
);
2028 void submodule_unset_core_worktree(const struct submodule
*sub
)
2030 struct strbuf config_path
= STRBUF_INIT
;
2032 submodule_name_to_gitdir(&config_path
, the_repository
, sub
->name
);
2033 strbuf_addstr(&config_path
, "/config");
2035 if (git_config_set_in_file_gently(config_path
.buf
, "core.worktree", NULL
))
2036 warning(_("Could not unset core.worktree setting in submodule '%s'"),
2039 strbuf_release(&config_path
);
2042 static const char *get_super_prefix_or_empty(void)
2044 const char *s
= get_super_prefix();
2050 static int submodule_has_dirty_index(const struct submodule
*sub
)
2052 struct child_process cp
= CHILD_PROCESS_INIT
;
2054 prepare_submodule_repo_env(&cp
.env
);
2057 strvec_pushl(&cp
.args
, "diff-index", "--quiet",
2058 "--cached", "HEAD", NULL
);
2062 if (start_command(&cp
))
2063 die(_("could not recurse into submodule '%s'"), sub
->path
);
2065 return finish_command(&cp
);
2068 static void submodule_reset_index(const char *path
)
2070 struct child_process cp
= CHILD_PROCESS_INIT
;
2071 prepare_submodule_repo_env(&cp
.env
);
2077 strvec_pushf(&cp
.args
, "--super-prefix=%s%s/",
2078 get_super_prefix_or_empty(), path
);
2079 /* TODO: determine if this might overwright untracked files */
2080 strvec_pushl(&cp
.args
, "read-tree", "-u", "--reset", NULL
);
2082 strvec_push(&cp
.args
, empty_tree_oid_hex());
2084 if (run_command(&cp
))
2085 die(_("could not reset submodule index"));
2089 * Moves a submodule at a given path from a given head to another new head.
2090 * For edge cases (a submodule coming into existence or removing a submodule)
2091 * pass NULL for old or new respectively.
2093 int submodule_move_head(const char *path
,
2094 const char *old_head
,
2095 const char *new_head
,
2099 struct child_process cp
= CHILD_PROCESS_INIT
;
2100 const struct submodule
*sub
;
2101 int *error_code_ptr
, error_code
;
2103 if (!is_submodule_active(the_repository
, path
))
2106 if (flags
& SUBMODULE_MOVE_HEAD_FORCE
)
2108 * Pass non NULL pointer to is_submodule_populated_gently
2109 * to prevent die()-ing. We'll use connect_work_tree_and_git_dir
2110 * to fixup the submodule in the force case later.
2112 error_code_ptr
= &error_code
;
2114 error_code_ptr
= NULL
;
2116 if (old_head
&& !is_submodule_populated_gently(path
, error_code_ptr
))
2119 sub
= submodule_from_path(the_repository
, null_oid(), path
);
2122 BUG("could not get submodule information for '%s'", path
);
2124 if (old_head
&& !(flags
& SUBMODULE_MOVE_HEAD_FORCE
)) {
2125 /* Check if the submodule has a dirty index. */
2126 if (submodule_has_dirty_index(sub
))
2127 return error(_("submodule '%s' has dirty index"), path
);
2130 if (!(flags
& SUBMODULE_MOVE_HEAD_DRY_RUN
)) {
2132 if (!submodule_uses_gitfile(path
))
2133 absorb_git_dir_into_superproject(path
,
2134 ABSORB_GITDIR_RECURSE_SUBMODULES
);
2136 struct strbuf gitdir
= STRBUF_INIT
;
2137 submodule_name_to_gitdir(&gitdir
, the_repository
,
2139 connect_work_tree_and_git_dir(path
, gitdir
.buf
, 0);
2140 strbuf_release(&gitdir
);
2142 /* make sure the index is clean as well */
2143 submodule_reset_index(path
);
2146 if (old_head
&& (flags
& SUBMODULE_MOVE_HEAD_FORCE
)) {
2147 struct strbuf gitdir
= STRBUF_INIT
;
2148 submodule_name_to_gitdir(&gitdir
, the_repository
,
2150 connect_work_tree_and_git_dir(path
, gitdir
.buf
, 1);
2151 strbuf_release(&gitdir
);
2155 prepare_submodule_repo_env(&cp
.env
);
2161 strvec_pushf(&cp
.args
, "--super-prefix=%s%s/",
2162 get_super_prefix_or_empty(), path
);
2163 strvec_pushl(&cp
.args
, "read-tree", "--recurse-submodules", NULL
);
2165 if (flags
& SUBMODULE_MOVE_HEAD_DRY_RUN
)
2166 strvec_push(&cp
.args
, "-n");
2168 strvec_push(&cp
.args
, "-u");
2170 if (flags
& SUBMODULE_MOVE_HEAD_FORCE
)
2171 strvec_push(&cp
.args
, "--reset");
2173 strvec_push(&cp
.args
, "-m");
2175 if (!(flags
& SUBMODULE_MOVE_HEAD_FORCE
))
2176 strvec_push(&cp
.args
, old_head
? old_head
: empty_tree_oid_hex());
2178 strvec_push(&cp
.args
, new_head
? new_head
: empty_tree_oid_hex());
2180 if (run_command(&cp
)) {
2181 ret
= error(_("Submodule '%s' could not be updated."), path
);
2185 if (!(flags
& SUBMODULE_MOVE_HEAD_DRY_RUN
)) {
2187 child_process_init(&cp
);
2188 /* also set the HEAD accordingly */
2193 prepare_submodule_repo_env(&cp
.env
);
2194 strvec_pushl(&cp
.args
, "update-ref", "HEAD",
2195 "--no-deref", new_head
, NULL
);
2197 if (run_command(&cp
)) {
2202 struct strbuf sb
= STRBUF_INIT
;
2204 strbuf_addf(&sb
, "%s/.git", path
);
2205 unlink_or_warn(sb
.buf
);
2206 strbuf_release(&sb
);
2208 if (is_empty_dir(path
))
2209 rmdir_or_warn(path
);
2211 submodule_unset_core_worktree(sub
);
2218 int validate_submodule_git_dir(char *git_dir
, const char *submodule_name
)
2220 size_t len
= strlen(git_dir
), suffix_len
= strlen(submodule_name
);
2224 if (len
<= suffix_len
|| (p
= git_dir
+ len
- suffix_len
)[-1] != '/' ||
2225 strcmp(p
, submodule_name
))
2226 BUG("submodule name '%s' not a suffix of git dir '%s'",
2227 submodule_name
, git_dir
);
2230 * We prevent the contents of sibling submodules' git directories to
2233 * Example: having a submodule named `hippo` and another one named
2234 * `hippo/hooks` would result in the git directories
2235 * `.git/modules/hippo/` and `.git/modules/hippo/hooks/`, respectively,
2236 * but the latter directory is already designated to contain the hooks
2240 if (is_dir_sep(*p
)) {
2244 if (is_git_directory(git_dir
))
2249 return error(_("submodule git dir '%s' is "
2250 "inside git dir '%.*s'"),
2252 (int)(p
- git_dir
), git_dir
);
2260 * Embeds a single submodules git directory into the superprojects git dir,
2263 static void relocate_single_git_dir_into_superproject(const char *path
)
2265 char *old_git_dir
= NULL
, *real_old_git_dir
= NULL
, *real_new_git_dir
= NULL
;
2266 struct strbuf new_gitdir
= STRBUF_INIT
;
2267 const struct submodule
*sub
;
2269 if (submodule_uses_worktrees(path
))
2270 die(_("relocate_gitdir for submodule '%s' with "
2271 "more than one worktree not supported"), path
);
2273 old_git_dir
= xstrfmt("%s/.git", path
);
2274 if (read_gitfile(old_git_dir
))
2275 /* If it is an actual gitfile, it doesn't need migration. */
2278 real_old_git_dir
= real_pathdup(old_git_dir
, 1);
2280 sub
= submodule_from_path(the_repository
, null_oid(), path
);
2282 die(_("could not lookup name for submodule '%s'"), path
);
2284 submodule_name_to_gitdir(&new_gitdir
, the_repository
, sub
->name
);
2285 if (validate_submodule_git_dir(new_gitdir
.buf
, sub
->name
) < 0)
2286 die(_("refusing to move '%s' into an existing git dir"),
2288 if (safe_create_leading_directories_const(new_gitdir
.buf
) < 0)
2289 die(_("could not create directory '%s'"), new_gitdir
.buf
);
2290 real_new_git_dir
= real_pathdup(new_gitdir
.buf
, 1);
2292 fprintf(stderr
, _("Migrating git directory of '%s%s' from\n'%s' to\n'%s'\n"),
2293 get_super_prefix_or_empty(), path
,
2294 real_old_git_dir
, real_new_git_dir
);
2296 relocate_gitdir(path
, real_old_git_dir
, real_new_git_dir
);
2299 free(real_old_git_dir
);
2300 free(real_new_git_dir
);
2301 strbuf_release(&new_gitdir
);
2305 * Migrate the git directory of the submodule given by path from
2306 * having its git directory within the working tree to the git dir nested
2307 * in its superprojects git dir under modules/.
2309 void absorb_git_dir_into_superproject(const char *path
,
2313 const char *sub_git_dir
;
2314 struct strbuf gitdir
= STRBUF_INIT
;
2315 strbuf_addf(&gitdir
, "%s/.git", path
);
2316 sub_git_dir
= resolve_gitdir_gently(gitdir
.buf
, &err_code
);
2318 /* Not populated? */
2320 const struct submodule
*sub
;
2321 struct strbuf sub_gitdir
= STRBUF_INIT
;
2323 if (err_code
== READ_GITFILE_ERR_STAT_FAILED
) {
2324 /* unpopulated as expected */
2325 strbuf_release(&gitdir
);
2329 if (err_code
!= READ_GITFILE_ERR_NOT_A_REPO
)
2330 /* We don't know what broke here. */
2331 read_gitfile_error_die(err_code
, path
, NULL
);
2334 * Maybe populated, but no git directory was found?
2335 * This can happen if the superproject is a submodule
2336 * itself and was just absorbed. The absorption of the
2337 * superproject did not rewrite the git file links yet,
2340 sub
= submodule_from_path(the_repository
, null_oid(), path
);
2342 die(_("could not lookup name for submodule '%s'"), path
);
2343 submodule_name_to_gitdir(&sub_gitdir
, the_repository
, sub
->name
);
2344 connect_work_tree_and_git_dir(path
, sub_gitdir
.buf
, 0);
2345 strbuf_release(&sub_gitdir
);
2347 /* Is it already absorbed into the superprojects git dir? */
2348 char *real_sub_git_dir
= real_pathdup(sub_git_dir
, 1);
2349 char *real_common_git_dir
= real_pathdup(get_git_common_dir(), 1);
2351 if (!starts_with(real_sub_git_dir
, real_common_git_dir
))
2352 relocate_single_git_dir_into_superproject(path
);
2354 free(real_sub_git_dir
);
2355 free(real_common_git_dir
);
2357 strbuf_release(&gitdir
);
2359 if (flags
& ABSORB_GITDIR_RECURSE_SUBMODULES
) {
2360 struct child_process cp
= CHILD_PROCESS_INIT
;
2361 struct strbuf sb
= STRBUF_INIT
;
2363 if (flags
& ~ABSORB_GITDIR_RECURSE_SUBMODULES
)
2364 BUG("we don't know how to pass the flags down?");
2366 strbuf_addstr(&sb
, get_super_prefix_or_empty());
2367 strbuf_addstr(&sb
, path
);
2368 strbuf_addch(&sb
, '/');
2373 strvec_pushl(&cp
.args
, "--super-prefix", sb
.buf
,
2374 "submodule--helper",
2375 "absorbgitdirs", NULL
);
2376 prepare_submodule_repo_env(&cp
.env
);
2377 if (run_command(&cp
))
2378 die(_("could not recurse into submodule '%s'"), path
);
2380 strbuf_release(&sb
);
2384 int get_superproject_working_tree(struct strbuf
*buf
)
2386 struct child_process cp
= CHILD_PROCESS_INIT
;
2387 struct strbuf sb
= STRBUF_INIT
;
2388 struct strbuf one_up
= STRBUF_INIT
;
2389 char *cwd
= xgetcwd();
2391 const char *subpath
;
2395 if (!is_inside_work_tree())
2398 * We might have a superproject, but it is harder
2403 if (!strbuf_realpath(&one_up
, "../", 0))
2406 subpath
= relative_path(cwd
, one_up
.buf
, &sb
);
2407 strbuf_release(&one_up
);
2409 prepare_submodule_repo_env(&cp
.env
);
2410 strvec_pop(&cp
.env
);
2412 strvec_pushl(&cp
.args
, "--literal-pathspecs", "-C", "..",
2413 "ls-files", "-z", "--stage", "--full-name", "--",
2422 if (start_command(&cp
))
2423 die(_("could not start ls-files in .."));
2425 len
= strbuf_read(&sb
, cp
.out
, PATH_MAX
);
2428 if (starts_with(sb
.buf
, "160000")) {
2430 int cwd_len
= strlen(cwd
);
2431 char *super_sub
, *super_wt
;
2434 * There is a superproject having this repo as a submodule.
2435 * The format is <mode> SP <hash> SP <stage> TAB <full name> \0,
2436 * We're only interested in the name after the tab.
2438 super_sub
= strchr(sb
.buf
, '\t') + 1;
2439 super_sub_len
= strlen(super_sub
);
2441 if (super_sub_len
> cwd_len
||
2442 strcmp(&cwd
[cwd_len
- super_sub_len
], super_sub
))
2443 BUG("returned path string doesn't match cwd?");
2445 super_wt
= xstrdup(cwd
);
2446 super_wt
[cwd_len
- super_sub_len
] = '\0';
2448 strbuf_realpath(buf
, super_wt
, 1);
2453 strbuf_release(&sb
);
2455 code
= finish_command(&cp
);
2458 /* '../' is not a git repository */
2460 if (code
== 0 && len
== 0)
2461 /* There is an unrelated git repository at '../' */
2464 die(_("ls-tree returned unexpected return code %d"), code
);
2470 * Put the gitdir for a submodule (given relative to the main
2471 * repository worktree) into `buf`, or return -1 on error.
2473 int submodule_to_gitdir(struct strbuf
*buf
, const char *submodule
)
2475 const struct submodule
*sub
;
2476 const char *git_dir
;
2480 strbuf_addstr(buf
, submodule
);
2481 strbuf_complete(buf
, '/');
2482 strbuf_addstr(buf
, ".git");
2484 git_dir
= read_gitfile(buf
->buf
);
2487 strbuf_addstr(buf
, git_dir
);
2489 if (!is_git_directory(buf
->buf
)) {
2490 sub
= submodule_from_path(the_repository
, null_oid(),
2497 submodule_name_to_gitdir(buf
, the_repository
, sub
->name
);
2504 void submodule_name_to_gitdir(struct strbuf
*buf
, struct repository
*r
,
2505 const char *submodule_name
)
2508 * NEEDSWORK: The current way of mapping a submodule's name to
2509 * its location in .git/modules/ has problems with some naming
2510 * schemes. For example, if a submodule is named "foo" and
2511 * another is named "foo/bar" (whether present in the same
2512 * superproject commit or not - the problem will arise if both
2513 * superproject commits have been checked out at any point in
2514 * time), or if two submodule names only have different cases in
2515 * a case-insensitive filesystem.
2517 * There are several solutions, including encoding the path in
2518 * some way, introducing a submodule.<name>.gitdir config in
2519 * .git/config (not .gitmodules) that allows overriding what the
2520 * gitdir of a submodule would be (and teach Git, upon noticing
2521 * a clash, to automatically determine a non-clashing name and
2522 * to write such a config), or introducing a
2523 * submodule.<name>.gitdir config in .gitmodules that repo
2524 * administrators can explicitly set. Nothing has been decided,
2525 * so for now, just append the name at the end of the path.
2527 strbuf_repo_git_path(buf
, r
, "modules/");
2528 strbuf_addstr(buf
, submodule_name
);