1 #include "git-compat-util.h"
3 #include "repository.h"
5 #include "submodule-config.h"
10 #include "environment.h"
14 #include "run-command.h"
17 #include "string-list.h"
18 #include "oid-array.h"
20 #include "thread-utils.h"
24 #include "parse-options.h"
25 #include "object-file.h"
26 #include "object-name.h"
27 #include "object-store-ll.h"
28 #include "commit-reach.h"
29 #include "read-cache-ll.h"
33 static int config_update_recurse_submodules
= RECURSE_SUBMODULES_OFF
;
34 static int initialized_fetch_ref_tips
;
35 static struct oid_array ref_tips_before_fetch
;
36 static struct oid_array ref_tips_after_fetch
;
39 * Check if the .gitmodules file is unmerged. Parsing of the .gitmodules file
40 * will be disabled because we can't guess what might be configured in
41 * .gitmodules unless the user resolves the conflict.
43 int is_gitmodules_unmerged(struct index_state
*istate
)
45 int pos
= index_name_pos(istate
, GITMODULES_FILE
, strlen(GITMODULES_FILE
));
46 if (pos
< 0) { /* .gitmodules not found or isn't merged */
48 if (istate
->cache_nr
> pos
) { /* there is a .gitmodules */
49 const struct cache_entry
*ce
= istate
->cache
[pos
];
50 if (ce_namelen(ce
) == strlen(GITMODULES_FILE
) &&
51 !strcmp(ce
->name
, GITMODULES_FILE
))
60 * Check if the .gitmodules file is safe to write.
62 * Writing to the .gitmodules file requires that the file exists in the
63 * working tree or, if it doesn't, that a brand new .gitmodules file is going
64 * to be created (i.e. it's neither in the index nor in the current branch).
66 * It is not safe to write to .gitmodules if it's not in the working tree but
67 * it is in the index or in the current branch, because writing new values
68 * (and staging them) would blindly overwrite ALL the old content.
70 int is_writing_gitmodules_ok(void)
73 return file_exists(GITMODULES_FILE
) ||
74 (repo_get_oid(the_repository
, GITMODULES_INDEX
, &oid
) < 0 && repo_get_oid(the_repository
, GITMODULES_HEAD
, &oid
) < 0);
78 * Check if the .gitmodules file has unstaged modifications. This must be
79 * checked before allowing modifications to the .gitmodules file with the
80 * intention to stage them later, because when continuing we would stage the
81 * modifications the user didn't stage herself too. That might change in a
82 * future version when we learn to stage the changes we do ourselves without
83 * staging any previous modifications.
85 int is_staging_gitmodules_ok(struct index_state
*istate
)
87 int pos
= index_name_pos(istate
, GITMODULES_FILE
, strlen(GITMODULES_FILE
));
89 if ((pos
>= 0) && (pos
< istate
->cache_nr
)) {
91 if (lstat(GITMODULES_FILE
, &st
) == 0 &&
92 ie_modified(istate
, istate
->cache
[pos
], &st
, 0) & DATA_CHANGED
)
99 static int for_each_remote_ref_submodule(const char *submodule
,
100 each_ref_fn fn
, void *cb_data
)
102 return refs_for_each_remote_ref(get_submodule_ref_store(submodule
),
107 * Try to update the "path" entry in the "submodule.<name>" section of the
108 * .gitmodules file. Return 0 only if a .gitmodules file was found, a section
109 * with the correct path=<oldpath> setting was found and we could update it.
111 int update_path_in_gitmodules(const char *oldpath
, const char *newpath
)
113 struct strbuf entry
= STRBUF_INIT
;
114 const struct submodule
*submodule
;
117 if (!file_exists(GITMODULES_FILE
)) /* Do nothing without .gitmodules */
120 if (is_gitmodules_unmerged(the_repository
->index
))
121 die(_("Cannot change unmerged .gitmodules, resolve merge conflicts first"));
123 submodule
= submodule_from_path(the_repository
, null_oid(), oldpath
);
124 if (!submodule
|| !submodule
->name
) {
125 warning(_("Could not find section in .gitmodules where path=%s"), oldpath
);
128 strbuf_addstr(&entry
, "submodule.");
129 strbuf_addstr(&entry
, submodule
->name
);
130 strbuf_addstr(&entry
, ".path");
131 ret
= config_set_in_gitmodules_file_gently(entry
.buf
, newpath
);
132 strbuf_release(&entry
);
137 * Try to remove the "submodule.<name>" section from .gitmodules where the given
138 * path is configured. Return 0 only if a .gitmodules file was found, a section
139 * with the correct path=<path> setting was found and we could remove it.
141 int remove_path_from_gitmodules(const char *path
)
143 struct strbuf sect
= STRBUF_INIT
;
144 const struct submodule
*submodule
;
146 if (!file_exists(GITMODULES_FILE
)) /* Do nothing without .gitmodules */
149 if (is_gitmodules_unmerged(the_repository
->index
))
150 die(_("Cannot change unmerged .gitmodules, resolve merge conflicts first"));
152 submodule
= submodule_from_path(the_repository
, null_oid(), path
);
153 if (!submodule
|| !submodule
->name
) {
154 warning(_("Could not find section in .gitmodules where path=%s"), path
);
157 strbuf_addstr(§
, "submodule.");
158 strbuf_addstr(§
, submodule
->name
);
159 if (git_config_rename_section_in_file(GITMODULES_FILE
, sect
.buf
, NULL
) < 0) {
160 /* Maybe the user already did that, don't error out here */
161 warning(_("Could not remove .gitmodules entry for %s"), path
);
162 strbuf_release(§
);
165 strbuf_release(§
);
169 void stage_updated_gitmodules(struct index_state
*istate
)
171 if (add_file_to_index(istate
, GITMODULES_FILE
, 0))
172 die(_("staging updated .gitmodules failed"));
175 static struct string_list added_submodule_odb_paths
= STRING_LIST_INIT_NODUP
;
177 void add_submodule_odb_by_path(const char *path
)
179 string_list_insert(&added_submodule_odb_paths
, xstrdup(path
));
182 int register_all_submodule_odb_as_alternates(void)
185 int ret
= added_submodule_odb_paths
.nr
;
187 for (i
= 0; i
< added_submodule_odb_paths
.nr
; i
++)
188 add_to_alternates_memory(added_submodule_odb_paths
.items
[i
].string
);
190 string_list_clear(&added_submodule_odb_paths
, 0);
191 trace2_data_intmax("submodule", the_repository
,
192 "register_all_submodule_odb_as_alternates/registered", ret
);
193 if (git_env_bool("GIT_TEST_FATAL_REGISTER_SUBMODULE_ODB", 0))
194 BUG("register_all_submodule_odb_as_alternates() called");
199 void set_diffopt_flags_from_submodule_config(struct diff_options
*diffopt
,
202 const struct submodule
*submodule
= submodule_from_path(the_repository
,
209 key
= xstrfmt("submodule.%s.ignore", submodule
->name
);
210 if (repo_config_get_string_tmp(the_repository
, key
, &ignore
))
211 ignore
= submodule
->ignore
;
215 handle_ignore_submodules_arg(diffopt
, ignore
);
216 else if (is_gitmodules_unmerged(the_repository
->index
))
217 diffopt
->flags
.ignore_submodules
= 1;
221 /* Cheap function that only determines if we're interested in submodules at all */
222 int git_default_submodule_config(const char *var
, const char *value
,
225 if (!strcmp(var
, "submodule.recurse")) {
226 int v
= git_config_bool(var
, value
) ?
227 RECURSE_SUBMODULES_ON
: RECURSE_SUBMODULES_OFF
;
228 config_update_recurse_submodules
= v
;
233 int option_parse_recurse_submodules_worktree_updater(const struct option
*opt
,
234 const char *arg
, int unset
)
237 config_update_recurse_submodules
= RECURSE_SUBMODULES_OFF
;
241 config_update_recurse_submodules
=
242 parse_update_recurse_submodules_arg(opt
->long_name
,
245 config_update_recurse_submodules
= RECURSE_SUBMODULES_ON
;
251 * Determine if a submodule has been initialized at a given 'path'
254 * NEEDSWORK: Emit a warning if submodule.active exists, but is valueless,
255 * ie, the config looks like: "[submodule] active\n".
256 * Since that is an invalid pathspec, we should inform the user.
258 int is_tree_submodule_active(struct repository
*repo
,
259 const struct object_id
*treeish_name
,
265 const struct string_list
*sl
;
266 const struct submodule
*module
;
268 module
= submodule_from_path(repo
, treeish_name
, path
);
270 /* early return if there isn't a path->module mapping */
274 /* submodule.<name>.active is set */
275 key
= xstrfmt("submodule.%s.active", module
->name
);
276 if (!repo_config_get_bool(repo
, key
, &ret
)) {
282 /* submodule.active is set */
283 if (!repo_config_get_string_multi(repo
, "submodule.active", &sl
)) {
285 struct strvec args
= STRVEC_INIT
;
286 const struct string_list_item
*item
;
288 for_each_string_list_item(item
, sl
) {
289 strvec_push(&args
, item
->string
);
292 parse_pathspec(&ps
, 0, 0, NULL
, args
.v
);
293 ret
= match_pathspec(repo
->index
, &ps
, path
, strlen(path
), 0, NULL
, 1);
300 /* fallback to checking if the URL is set */
301 key
= xstrfmt("submodule.%s.url", module
->name
);
302 ret
= !repo_config_get_string(repo
, key
, &value
);
309 int is_submodule_active(struct repository
*repo
, const char *path
)
311 return is_tree_submodule_active(repo
, null_oid(), path
);
314 int is_submodule_populated_gently(const char *path
, int *return_error_code
)
317 char *gitdir
= xstrfmt("%s/.git", path
);
319 if (resolve_gitdir_gently(gitdir
, return_error_code
))
327 * Dies if the provided 'prefix' corresponds to an unpopulated submodule
329 void die_in_unpopulated_submodule(struct index_state
*istate
,
337 prefixlen
= strlen(prefix
);
339 for (i
= 0; i
< istate
->cache_nr
; i
++) {
340 struct cache_entry
*ce
= istate
->cache
[i
];
341 int ce_len
= ce_namelen(ce
);
343 if (!S_ISGITLINK(ce
->ce_mode
))
345 if (prefixlen
<= ce_len
)
347 if (strncmp(ce
->name
, prefix
, ce_len
))
349 if (prefix
[ce_len
] != '/')
352 die(_("in unpopulated submodule '%s'"), ce
->name
);
357 * Dies if any paths in the provided pathspec descends into a submodule
359 void die_path_inside_submodule(struct index_state
*istate
,
360 const struct pathspec
*ps
)
364 for (i
= 0; i
< istate
->cache_nr
; i
++) {
365 struct cache_entry
*ce
= istate
->cache
[i
];
366 int ce_len
= ce_namelen(ce
);
368 if (!S_ISGITLINK(ce
->ce_mode
))
371 for (j
= 0; j
< ps
->nr
; j
++) {
372 const struct pathspec_item
*item
= &ps
->items
[j
];
374 if (item
->len
<= ce_len
)
376 if (item
->match
[ce_len
] != '/')
378 if (strncmp(ce
->name
, item
->match
, ce_len
))
380 if (item
->len
== ce_len
+ 1)
383 die(_("Pathspec '%s' is in submodule '%.*s'"),
384 item
->original
, ce_len
, ce
->name
);
389 enum submodule_update_type
parse_submodule_update_type(const char *value
)
391 if (!strcmp(value
, "none"))
392 return SM_UPDATE_NONE
;
393 else if (!strcmp(value
, "checkout"))
394 return SM_UPDATE_CHECKOUT
;
395 else if (!strcmp(value
, "rebase"))
396 return SM_UPDATE_REBASE
;
397 else if (!strcmp(value
, "merge"))
398 return SM_UPDATE_MERGE
;
399 else if (*value
== '!')
400 return SM_UPDATE_COMMAND
;
402 return SM_UPDATE_UNSPECIFIED
;
405 int parse_submodule_update_strategy(const char *value
,
406 struct submodule_update_strategy
*dst
)
408 enum submodule_update_type type
;
410 free((void*)dst
->command
);
413 type
= parse_submodule_update_type(value
);
414 if (type
== SM_UPDATE_UNSPECIFIED
)
418 if (type
== SM_UPDATE_COMMAND
)
419 dst
->command
= xstrdup(value
+ 1);
424 const char *submodule_update_type_to_string(enum submodule_update_type type
)
427 case SM_UPDATE_CHECKOUT
:
429 case SM_UPDATE_MERGE
:
431 case SM_UPDATE_REBASE
:
435 case SM_UPDATE_UNSPECIFIED
:
436 case SM_UPDATE_COMMAND
:
437 BUG("init_submodule() should handle type %d", type
);
439 BUG("unexpected update strategy type: %d", type
);
443 void handle_ignore_submodules_arg(struct diff_options
*diffopt
,
446 diffopt
->flags
.ignore_submodule_set
= 1;
447 diffopt
->flags
.ignore_submodules
= 0;
448 diffopt
->flags
.ignore_untracked_in_submodules
= 0;
449 diffopt
->flags
.ignore_dirty_submodules
= 0;
451 if (!strcmp(arg
, "all"))
452 diffopt
->flags
.ignore_submodules
= 1;
453 else if (!strcmp(arg
, "untracked"))
454 diffopt
->flags
.ignore_untracked_in_submodules
= 1;
455 else if (!strcmp(arg
, "dirty"))
456 diffopt
->flags
.ignore_dirty_submodules
= 1;
457 else if (strcmp(arg
, "none"))
458 die(_("bad --ignore-submodules argument: %s"), arg
);
460 * Please update _git_status() in git-completion.bash when you
465 static int prepare_submodule_diff_summary(struct repository
*r
, struct rev_info
*rev
,
467 struct commit
*left
, struct commit
*right
,
468 struct commit_list
*merge_bases
)
470 struct commit_list
*list
;
472 repo_init_revisions(r
, rev
, NULL
);
473 setup_revisions(0, NULL
, rev
, NULL
);
475 rev
->first_parent_only
= 1;
476 left
->object
.flags
|= SYMMETRIC_LEFT
;
477 add_pending_object(rev
, &left
->object
, path
);
478 add_pending_object(rev
, &right
->object
, path
);
479 for (list
= merge_bases
; list
; list
= list
->next
) {
480 list
->item
->object
.flags
|= UNINTERESTING
;
481 add_pending_object(rev
, &list
->item
->object
,
482 oid_to_hex(&list
->item
->object
.oid
));
484 return prepare_revision_walk(rev
);
487 static void print_submodule_diff_summary(struct repository
*r
, struct rev_info
*rev
, struct diff_options
*o
)
489 static const char format
[] = " %m %s";
490 struct strbuf sb
= STRBUF_INIT
;
491 struct commit
*commit
;
493 while ((commit
= get_revision(rev
))) {
494 struct pretty_print_context ctx
= {0};
495 ctx
.date_mode
= rev
->date_mode
;
496 ctx
.output_encoding
= get_log_output_encoding();
497 strbuf_setlen(&sb
, 0);
498 repo_format_commit_message(r
, commit
, format
, &sb
,
500 strbuf_addch(&sb
, '\n');
501 if (commit
->object
.flags
& SYMMETRIC_LEFT
)
502 diff_emit_submodule_del(o
, sb
.buf
);
504 diff_emit_submodule_add(o
, sb
.buf
);
509 void prepare_submodule_repo_env(struct strvec
*out
)
511 prepare_other_repo_env(out
, DEFAULT_GIT_DIR_ENVIRONMENT
);
514 static void prepare_submodule_repo_env_in_gitdir(struct strvec
*out
)
516 prepare_other_repo_env(out
, ".");
520 * Initialize a repository struct for a submodule based on the provided 'path'.
522 * Returns the repository struct on success,
523 * NULL when the submodule is not present.
525 static struct repository
*open_submodule(const char *path
)
527 struct strbuf sb
= STRBUF_INIT
;
528 struct repository
*out
= xmalloc(sizeof(*out
));
530 if (submodule_to_gitdir(&sb
, path
) || repo_init(out
, sb
.buf
, NULL
)) {
536 /* Mark it as a submodule */
537 out
->submodule_prefix
= xstrdup(path
);
544 * Helper function to display the submodule header line prior to the full
547 * If it can locate the submodule git directory it will create a repository
548 * handle for the submodule and lookup both the left and right commits and
549 * put them into the left and right pointers.
551 static void show_submodule_header(struct diff_options
*o
,
553 struct object_id
*one
, struct object_id
*two
,
554 unsigned dirty_submodule
,
555 struct repository
*sub
,
556 struct commit
**left
, struct commit
**right
,
557 struct commit_list
**merge_bases
)
559 const char *message
= NULL
;
560 struct strbuf sb
= STRBUF_INIT
;
561 int fast_forward
= 0, fast_backward
= 0;
563 if (dirty_submodule
& DIRTY_SUBMODULE_UNTRACKED
)
564 diff_emit_submodule_untracked(o
, path
);
566 if (dirty_submodule
& DIRTY_SUBMODULE_MODIFIED
)
567 diff_emit_submodule_modified(o
, path
);
569 if (is_null_oid(one
))
570 message
= "(new submodule)";
571 else if (is_null_oid(two
))
572 message
= "(submodule deleted)";
576 message
= "(commits not present)";
581 * Attempt to lookup the commit references, and determine if this is
582 * a fast forward or fast backwards update.
584 *left
= lookup_commit_reference(sub
, one
);
585 *right
= lookup_commit_reference(sub
, two
);
588 * Warn about missing commits in the submodule project, but only if
591 if ((!is_null_oid(one
) && !*left
) ||
592 (!is_null_oid(two
) && !*right
))
593 message
= "(commits not present)";
595 *merge_bases
= repo_get_merge_bases(sub
, *left
, *right
);
597 if ((*merge_bases
)->item
== *left
)
599 else if ((*merge_bases
)->item
== *right
)
603 if (oideq(one
, two
)) {
609 strbuf_addf(&sb
, "Submodule %s ", path
);
610 strbuf_add_unique_abbrev(&sb
, one
, DEFAULT_ABBREV
);
611 strbuf_addstr(&sb
, (fast_backward
|| fast_forward
) ? ".." : "...");
612 strbuf_add_unique_abbrev(&sb
, two
, DEFAULT_ABBREV
);
614 strbuf_addf(&sb
, " %s\n", message
);
616 strbuf_addf(&sb
, "%s:\n", fast_backward
? " (rewind)" : "");
617 diff_emit_submodule_header(o
, sb
.buf
);
622 void show_submodule_diff_summary(struct diff_options
*o
, const char *path
,
623 struct object_id
*one
, struct object_id
*two
,
624 unsigned dirty_submodule
)
626 struct rev_info rev
= REV_INFO_INIT
;
627 struct commit
*left
= NULL
, *right
= NULL
;
628 struct commit_list
*merge_bases
= NULL
;
629 struct repository
*sub
;
631 sub
= open_submodule(path
);
632 show_submodule_header(o
, path
, one
, two
, dirty_submodule
,
633 sub
, &left
, &right
, &merge_bases
);
636 * If we don't have both a left and a right pointer, there is no
637 * reason to try and display a summary. The header line should contain
638 * all the information the user needs.
640 if (!left
|| !right
|| !sub
)
643 /* Treat revision walker failure the same as missing commits */
644 if (prepare_submodule_diff_summary(sub
, &rev
, path
, left
, right
, merge_bases
)) {
645 diff_emit_submodule_error(o
, "(revision walker failed)\n");
649 print_submodule_diff_summary(sub
, &rev
, o
);
652 free_commit_list(merge_bases
);
653 release_revisions(&rev
);
654 clear_commit_marks(left
, ~0);
655 clear_commit_marks(right
, ~0);
662 void show_submodule_inline_diff(struct diff_options
*o
, const char *path
,
663 struct object_id
*one
, struct object_id
*two
,
664 unsigned dirty_submodule
)
666 const struct object_id
*old_oid
= the_hash_algo
->empty_tree
, *new_oid
= the_hash_algo
->empty_tree
;
667 struct commit
*left
= NULL
, *right
= NULL
;
668 struct commit_list
*merge_bases
= NULL
;
669 struct child_process cp
= CHILD_PROCESS_INIT
;
670 struct strbuf sb
= STRBUF_INIT
;
671 struct repository
*sub
;
673 sub
= open_submodule(path
);
674 show_submodule_header(o
, path
, one
, two
, dirty_submodule
,
675 sub
, &left
, &right
, &merge_bases
);
677 /* We need a valid left and right commit to display a difference */
678 if (!(left
|| is_null_oid(one
)) ||
679 !(right
|| is_null_oid(two
)))
692 /* TODO: other options may need to be passed here. */
693 strvec_pushl(&cp
.args
, "diff", "--submodule=diff", NULL
);
694 strvec_pushf(&cp
.args
, "--color=%s", want_color(o
->use_color
) ?
697 if (o
->flags
.reverse_diff
) {
698 strvec_pushf(&cp
.args
, "--src-prefix=%s%s/",
700 strvec_pushf(&cp
.args
, "--dst-prefix=%s%s/",
703 strvec_pushf(&cp
.args
, "--src-prefix=%s%s/",
705 strvec_pushf(&cp
.args
, "--dst-prefix=%s%s/",
708 strvec_push(&cp
.args
, oid_to_hex(old_oid
));
710 * If the submodule has modified content, we will diff against the
711 * work tree, under the assumption that the user has asked for the
712 * diff format and wishes to actually see all differences even if they
713 * haven't yet been committed to the submodule yet.
715 if (!(dirty_submodule
& DIRTY_SUBMODULE_MODIFIED
))
716 strvec_push(&cp
.args
, oid_to_hex(new_oid
));
718 prepare_submodule_repo_env(&cp
.env
);
720 if (!is_directory(path
)) {
721 /* fall back to absorbed git dir, if any */
724 cp
.dir
= sub
->gitdir
;
725 strvec_push(&cp
.env
, GIT_DIR_ENVIRONMENT
"=.");
726 strvec_push(&cp
.env
, GIT_WORK_TREE_ENVIRONMENT
"=.");
729 if (start_command(&cp
)) {
730 diff_emit_submodule_error(o
, "(diff failed)\n");
734 while (strbuf_getwholeline_fd(&sb
, cp
.out
, '\n') != EOF
)
735 diff_emit_submodule_pipethrough(o
, sb
.buf
, sb
.len
);
737 if (finish_command(&cp
))
738 diff_emit_submodule_error(o
, "(diff failed)\n");
742 free_commit_list(merge_bases
);
744 clear_commit_marks(left
, ~0);
746 clear_commit_marks(right
, ~0);
753 int should_update_submodules(void)
755 return config_update_recurse_submodules
== RECURSE_SUBMODULES_ON
;
758 const struct submodule
*submodule_from_ce(const struct cache_entry
*ce
)
760 if (!S_ISGITLINK(ce
->ce_mode
))
763 if (!should_update_submodules())
766 return submodule_from_path(the_repository
, null_oid(), ce
->name
);
770 struct collect_changed_submodules_cb_data
{
771 struct repository
*repo
;
772 struct string_list
*changed
;
773 const struct object_id
*commit_oid
;
777 * this would normally be two functions: default_name_from_path() and
778 * path_from_default_name(). Since the default name is the same as
779 * the submodule path we can get away with just one function which only
780 * checks whether there is a submodule in the working directory at that
783 static const char *default_name_or_path(const char *path_or_name
)
787 if (!is_submodule_populated_gently(path_or_name
, &error_code
))
794 * Holds relevant information for a changed submodule. Used as the .util
795 * member of the changed submodule name string_list_item.
797 * (super_oid, path) allows the submodule config to be read from _some_
798 * .gitmodules file. We store this information the first time we find a
799 * superproject commit that points to the submodule, but this is
800 * arbitrary - we can choose any (super_oid, path) that matches the
803 * NEEDSWORK: Storing an arbitrary commit is undesirable because we can't
804 * guarantee that we're reading the commit that the user would expect. A better
805 * scheme would be to just fetch a submodule by its name. This requires two
807 * - Create a function that behaves like repo_submodule_init(), but accepts a
808 * submodule name instead of treeish_name and path. This should be easy
809 * because repo_submodule_init() internally uses the submodule's name.
811 * - Replace most instances of 'struct submodule' (which is the .gitmodules
812 * config) with just the submodule name. This is OK because we expect
813 * submodule settings to be stored in .git/config (via "git submodule init"),
814 * not .gitmodules. This also lets us delete get_non_gitmodules_submodule(),
815 * which constructs a bogus 'struct submodule' for the sake of giving a
816 * placeholder name to a gitlink.
818 struct changed_submodule_data
{
820 * The first superproject commit in the rev walk that points to
823 const struct object_id
*super_oid
;
825 * Path to the submodule in the superproject commit referenced
829 /* The submodule commits that have changed in the rev walk. */
830 struct oid_array new_commits
;
833 static void changed_submodule_data_clear(struct changed_submodule_data
*cs_data
)
835 oid_array_clear(&cs_data
->new_commits
);
839 static void collect_changed_submodules_cb(struct diff_queue_struct
*q
,
840 struct diff_options
*options UNUSED
,
843 struct collect_changed_submodules_cb_data
*me
= data
;
844 struct string_list
*changed
= me
->changed
;
845 const struct object_id
*commit_oid
= me
->commit_oid
;
848 for (i
= 0; i
< q
->nr
; i
++) {
849 struct diff_filepair
*p
= q
->queue
[i
];
850 const struct submodule
*submodule
;
852 struct string_list_item
*item
;
853 struct changed_submodule_data
*cs_data
;
855 if (!S_ISGITLINK(p
->two
->mode
))
858 submodule
= submodule_from_path(me
->repo
,
859 commit_oid
, p
->two
->path
);
861 name
= submodule
->name
;
863 name
= default_name_or_path(p
->two
->path
);
864 /* make sure name does not collide with existing one */
866 submodule
= submodule_from_name(me
->repo
,
869 warning(_("Submodule in commit %s at path: "
870 "'%s' collides with a submodule named "
871 "the same. Skipping it."),
872 oid_to_hex(commit_oid
), p
->two
->path
);
880 item
= string_list_insert(changed
, name
);
882 cs_data
= item
->util
;
884 item
->util
= xcalloc(1, sizeof(struct changed_submodule_data
));
885 cs_data
= item
->util
;
886 cs_data
->super_oid
= commit_oid
;
887 cs_data
->path
= xstrdup(p
->two
->path
);
889 oid_array_append(&cs_data
->new_commits
, &p
->two
->oid
);
894 * Collect the paths of submodules in 'changed' which have changed based on
895 * the revisions as specified in 'argv'. Each entry in 'changed' will also
896 * have a corresponding 'struct oid_array' (in the 'util' field) which lists
897 * what the submodule pointers were updated to during the change.
899 static void collect_changed_submodules(struct repository
*r
,
900 struct string_list
*changed
,
904 const struct commit
*commit
;
906 struct setup_revision_opt s_r_opt
= {
907 .assume_dashdash
= 1,
910 save_warning
= warn_on_object_refname_ambiguity
;
911 warn_on_object_refname_ambiguity
= 0;
912 repo_init_revisions(r
, &rev
, NULL
);
913 setup_revisions(argv
->nr
, argv
->v
, &rev
, &s_r_opt
);
914 warn_on_object_refname_ambiguity
= save_warning
;
915 if (prepare_revision_walk(&rev
))
916 die(_("revision walk setup failed"));
918 while ((commit
= get_revision(&rev
))) {
919 struct rev_info diff_rev
;
920 struct collect_changed_submodules_cb_data data
;
922 data
.changed
= changed
;
923 data
.commit_oid
= &commit
->object
.oid
;
925 repo_init_revisions(r
, &diff_rev
, NULL
);
926 diff_rev
.diffopt
.output_format
|= DIFF_FORMAT_CALLBACK
;
927 diff_rev
.diffopt
.format_callback
= collect_changed_submodules_cb
;
928 diff_rev
.diffopt
.format_callback_data
= &data
;
929 diff_rev
.dense_combined_merges
= 1;
930 diff_tree_combined_merge(commit
, &diff_rev
);
931 release_revisions(&diff_rev
);
934 reset_revision_walk();
935 release_revisions(&rev
);
938 static void free_submodules_data(struct string_list
*submodules
)
940 struct string_list_item
*item
;
941 for_each_string_list_item(item
, submodules
)
942 changed_submodule_data_clear(item
->util
);
944 string_list_clear(submodules
, 1);
947 static int has_remote(const char *refname UNUSED
,
948 const struct object_id
*oid UNUSED
,
949 int flags UNUSED
, void *cb_data UNUSED
)
954 static int append_oid_to_argv(const struct object_id
*oid
, void *data
)
956 struct strvec
*argv
= data
;
957 strvec_push(argv
, oid_to_hex(oid
));
961 struct has_commit_data
{
962 struct repository
*repo
;
965 const struct object_id
*super_oid
;
968 static int check_has_commit(const struct object_id
*oid
, void *data
)
970 struct has_commit_data
*cb
= data
;
971 struct repository subrepo
;
972 enum object_type type
;
974 if (repo_submodule_init(&subrepo
, cb
->repo
, cb
->path
, cb
->super_oid
)) {
976 /* subrepo failed to init, so don't clean it up. */
980 type
= oid_object_info(&subrepo
, oid
, NULL
);
987 * Object is missing or invalid. If invalid, an error message
988 * has already been printed.
993 die(_("submodule entry '%s' (%s) is a %s, not a commit"),
994 cb
->path
, oid_to_hex(oid
), type_name(type
));
997 repo_clear(&subrepo
);
1001 static int submodule_has_commits(struct repository
*r
,
1003 const struct object_id
*super_oid
,
1004 struct oid_array
*commits
)
1006 struct has_commit_data has_commit
= {
1010 .super_oid
= super_oid
1013 oid_array_for_each_unique(commits
, check_has_commit
, &has_commit
);
1015 if (has_commit
.result
) {
1017 * Even if the submodule is checked out and the commit is
1018 * present, make sure it exists in the submodule's object store
1019 * and that it is reachable from a ref.
1021 struct child_process cp
= CHILD_PROCESS_INIT
;
1022 struct strbuf out
= STRBUF_INIT
;
1024 strvec_pushl(&cp
.args
, "rev-list", "-n", "1", NULL
);
1025 oid_array_for_each_unique(commits
, append_oid_to_argv
, &cp
.args
);
1026 strvec_pushl(&cp
.args
, "--not", "--all", NULL
);
1028 prepare_submodule_repo_env(&cp
.env
);
1033 if (capture_command(&cp
, &out
, GIT_MAX_HEXSZ
+ 1) || out
.len
)
1034 has_commit
.result
= 0;
1036 strbuf_release(&out
);
1039 return has_commit
.result
;
1042 static int submodule_needs_pushing(struct repository
*r
,
1044 struct oid_array
*commits
)
1046 if (!submodule_has_commits(r
, path
, null_oid(), commits
))
1048 * NOTE: We do consider it safe to return "no" here. The
1049 * correct answer would be "We do not know" instead of
1050 * "No push needed", but it is quite hard to change
1051 * the submodule pointer without having the submodule
1052 * around. If a user did however change the submodules
1053 * without having the submodule around, this indicates
1054 * an expert who knows what they are doing or a
1055 * maintainer integrating work from other people. In
1056 * both cases it should be safe to skip this check.
1060 if (for_each_remote_ref_submodule(path
, has_remote
, NULL
) > 0) {
1061 struct child_process cp
= CHILD_PROCESS_INIT
;
1062 struct strbuf buf
= STRBUF_INIT
;
1063 int needs_pushing
= 0;
1065 strvec_push(&cp
.args
, "rev-list");
1066 oid_array_for_each_unique(commits
, append_oid_to_argv
, &cp
.args
);
1067 strvec_pushl(&cp
.args
, "--not", "--remotes", "-n", "1" , NULL
);
1069 prepare_submodule_repo_env(&cp
.env
);
1074 if (start_command(&cp
))
1075 die(_("Could not run 'git rev-list <commits> --not --remotes -n 1' command in submodule %s"),
1077 if (strbuf_read(&buf
, cp
.out
, the_hash_algo
->hexsz
+ 1))
1079 finish_command(&cp
);
1081 strbuf_release(&buf
);
1082 return needs_pushing
;
1088 int find_unpushed_submodules(struct repository
*r
,
1089 struct oid_array
*commits
,
1090 const char *remotes_name
,
1091 struct string_list
*needs_pushing
)
1093 struct string_list submodules
= STRING_LIST_INIT_DUP
;
1094 struct string_list_item
*name
;
1095 struct strvec argv
= STRVEC_INIT
;
1097 /* argv.v[0] will be ignored by setup_revisions */
1098 strvec_push(&argv
, "find_unpushed_submodules");
1099 oid_array_for_each_unique(commits
, append_oid_to_argv
, &argv
);
1100 strvec_push(&argv
, "--not");
1101 strvec_pushf(&argv
, "--remotes=%s", remotes_name
);
1103 collect_changed_submodules(r
, &submodules
, &argv
);
1105 for_each_string_list_item(name
, &submodules
) {
1106 struct changed_submodule_data
*cs_data
= name
->util
;
1107 const struct submodule
*submodule
;
1108 const char *path
= NULL
;
1110 submodule
= submodule_from_name(r
, null_oid(), name
->string
);
1112 path
= submodule
->path
;
1114 path
= default_name_or_path(name
->string
);
1119 if (submodule_needs_pushing(r
, path
, &cs_data
->new_commits
))
1120 string_list_insert(needs_pushing
, path
);
1123 free_submodules_data(&submodules
);
1124 strvec_clear(&argv
);
1126 return needs_pushing
->nr
;
1129 static int push_submodule(const char *path
,
1130 const struct remote
*remote
,
1131 const struct refspec
*rs
,
1132 const struct string_list
*push_options
,
1135 if (for_each_remote_ref_submodule(path
, has_remote
, NULL
) > 0) {
1136 struct child_process cp
= CHILD_PROCESS_INIT
;
1137 strvec_push(&cp
.args
, "push");
1139 * When recursing into a submodule, treat any "only" configurations as "on-
1140 * demand", since "only" would not work (we need all submodules to be pushed
1141 * in order to be able to push the superproject).
1143 strvec_push(&cp
.args
, "--recurse-submodules=only-is-on-demand");
1145 strvec_push(&cp
.args
, "--dry-run");
1147 if (push_options
&& push_options
->nr
) {
1148 const struct string_list_item
*item
;
1149 for_each_string_list_item(item
, push_options
)
1150 strvec_pushf(&cp
.args
, "--push-option=%s",
1154 if (remote
->origin
!= REMOTE_UNCONFIGURED
) {
1156 strvec_push(&cp
.args
, remote
->name
);
1157 for (i
= 0; i
< rs
->raw_nr
; i
++)
1158 strvec_push(&cp
.args
, rs
->raw
[i
]);
1161 prepare_submodule_repo_env(&cp
.env
);
1165 if (run_command(&cp
))
1174 * Perform a check in the submodule to see if the remote and refspec work.
1175 * Die if the submodule can't be pushed.
1177 static void submodule_push_check(const char *path
, const char *head
,
1178 const struct remote
*remote
,
1179 const struct refspec
*rs
)
1181 struct child_process cp
= CHILD_PROCESS_INIT
;
1184 strvec_push(&cp
.args
, "submodule--helper");
1185 strvec_push(&cp
.args
, "push-check");
1186 strvec_push(&cp
.args
, head
);
1187 strvec_push(&cp
.args
, remote
->name
);
1189 for (i
= 0; i
< rs
->raw_nr
; i
++)
1190 strvec_push(&cp
.args
, rs
->raw
[i
]);
1192 prepare_submodule_repo_env(&cp
.env
);
1199 * Simply indicate if 'submodule--helper push-check' failed.
1200 * More detailed error information will be provided by the
1203 if (run_command(&cp
))
1204 die(_("process for submodule '%s' failed"), path
);
1207 int push_unpushed_submodules(struct repository
*r
,
1208 struct oid_array
*commits
,
1209 const struct remote
*remote
,
1210 const struct refspec
*rs
,
1211 const struct string_list
*push_options
,
1215 struct string_list needs_pushing
= STRING_LIST_INIT_DUP
;
1217 if (!find_unpushed_submodules(r
, commits
,
1218 remote
->name
, &needs_pushing
))
1222 * Verify that the remote and refspec can be propagated to all
1223 * submodules. This check can be skipped if the remote and refspec
1224 * won't be propagated due to the remote being unconfigured (e.g. a URL
1225 * instead of a remote name).
1227 if (remote
->origin
!= REMOTE_UNCONFIGURED
) {
1229 struct object_id head_oid
;
1231 head
= resolve_refdup("HEAD", 0, &head_oid
, NULL
);
1233 die(_("Failed to resolve HEAD as a valid ref."));
1235 for (i
= 0; i
< needs_pushing
.nr
; i
++)
1236 submodule_push_check(needs_pushing
.items
[i
].string
,
1241 /* Actually push the submodules */
1242 for (i
= 0; i
< needs_pushing
.nr
; i
++) {
1243 const char *path
= needs_pushing
.items
[i
].string
;
1244 fprintf(stderr
, _("Pushing submodule '%s'\n"), path
);
1245 if (!push_submodule(path
, remote
, rs
,
1246 push_options
, dry_run
)) {
1247 fprintf(stderr
, _("Unable to push submodule '%s'\n"), path
);
1252 string_list_clear(&needs_pushing
, 0);
1257 static int append_oid_to_array(const char *ref UNUSED
,
1258 const struct object_id
*oid
,
1259 int flags UNUSED
, void *data
)
1261 struct oid_array
*array
= data
;
1262 oid_array_append(array
, oid
);
1266 void check_for_new_submodule_commits(struct object_id
*oid
)
1268 if (!initialized_fetch_ref_tips
) {
1269 for_each_ref(append_oid_to_array
, &ref_tips_before_fetch
);
1270 initialized_fetch_ref_tips
= 1;
1273 oid_array_append(&ref_tips_after_fetch
, oid
);
1277 * Returns 1 if there is at least one submodule gitdir in
1278 * $GIT_DIR/modules and 0 otherwise. This follows
1279 * submodule_name_to_gitdir(), which looks for submodules in
1280 * $GIT_DIR/modules, not $GIT_COMMON_DIR.
1282 * A submodule can be moved to $GIT_DIR/modules manually by running "git
1283 * submodule absorbgitdirs", or it may be initialized there by "git
1284 * submodule update".
1286 static int repo_has_absorbed_submodules(struct repository
*r
)
1289 struct strbuf buf
= STRBUF_INIT
;
1291 strbuf_repo_git_path(&buf
, r
, "modules/");
1292 ret
= file_exists(buf
.buf
) && !is_empty_dir(buf
.buf
);
1293 strbuf_release(&buf
);
1297 static void calculate_changed_submodule_paths(struct repository
*r
,
1298 struct string_list
*changed_submodule_names
)
1300 struct strvec argv
= STRVEC_INIT
;
1301 struct string_list_item
*name
;
1303 /* No need to check if no submodules would be fetched */
1304 if (!submodule_from_path(r
, NULL
, NULL
) &&
1305 !repo_has_absorbed_submodules(r
))
1308 strvec_push(&argv
, "--"); /* argv[0] program name */
1309 oid_array_for_each_unique(&ref_tips_after_fetch
,
1310 append_oid_to_argv
, &argv
);
1311 strvec_push(&argv
, "--not");
1312 oid_array_for_each_unique(&ref_tips_before_fetch
,
1313 append_oid_to_argv
, &argv
);
1316 * Collect all submodules (whether checked out or not) for which new
1317 * commits have been recorded upstream in "changed_submodule_names".
1319 collect_changed_submodules(r
, changed_submodule_names
, &argv
);
1321 for_each_string_list_item(name
, changed_submodule_names
) {
1322 struct changed_submodule_data
*cs_data
= name
->util
;
1323 const struct submodule
*submodule
;
1324 const char *path
= NULL
;
1326 submodule
= submodule_from_name(r
, null_oid(), name
->string
);
1328 path
= submodule
->path
;
1330 path
= default_name_or_path(name
->string
);
1335 if (submodule_has_commits(r
, path
, null_oid(), &cs_data
->new_commits
)) {
1336 changed_submodule_data_clear(cs_data
);
1337 *name
->string
= '\0';
1341 string_list_remove_empty_items(changed_submodule_names
, 1);
1343 strvec_clear(&argv
);
1344 oid_array_clear(&ref_tips_before_fetch
);
1345 oid_array_clear(&ref_tips_after_fetch
);
1346 initialized_fetch_ref_tips
= 0;
1349 int submodule_touches_in_range(struct repository
*r
,
1350 struct object_id
*excl_oid
,
1351 struct object_id
*incl_oid
)
1353 struct string_list subs
= STRING_LIST_INIT_DUP
;
1354 struct strvec args
= STRVEC_INIT
;
1357 /* No need to check if there are no submodules configured */
1358 if (!submodule_from_path(r
, NULL
, NULL
))
1361 strvec_push(&args
, "--"); /* args[0] program name */
1362 strvec_push(&args
, oid_to_hex(incl_oid
));
1363 if (!is_null_oid(excl_oid
)) {
1364 strvec_push(&args
, "--not");
1365 strvec_push(&args
, oid_to_hex(excl_oid
));
1368 collect_changed_submodules(r
, &subs
, &args
);
1371 strvec_clear(&args
);
1373 free_submodules_data(&subs
);
1377 struct submodule_parallel_fetch
{
1379 * The index of the last index entry processed by
1380 * get_fetch_task_from_index().
1384 * The index of the last string_list entry processed by
1385 * get_fetch_task_from_changed().
1389 struct repository
*r
;
1391 int command_line_option
;
1397 * Names of submodules that have new commits. Generated by
1398 * walking the newly fetched superproject commits.
1400 struct string_list changed_submodule_names
;
1402 * Names of submodules that have already been processed. Lets us
1403 * avoid fetching the same submodule more than once.
1405 struct string_list seen_submodule_names
;
1407 /* Pending fetches by OIDs */
1408 struct fetch_task
**oid_fetch_tasks
;
1409 int oid_fetch_tasks_nr
, oid_fetch_tasks_alloc
;
1411 struct strbuf submodules_with_errors
;
1413 #define SPF_INIT { \
1414 .args = STRVEC_INIT, \
1415 .changed_submodule_names = STRING_LIST_INIT_DUP, \
1416 .seen_submodule_names = STRING_LIST_INIT_DUP, \
1417 .submodules_with_errors = STRBUF_INIT, \
1420 static int get_fetch_recurse_config(const struct submodule
*submodule
,
1421 struct submodule_parallel_fetch
*spf
)
1423 if (spf
->command_line_option
!= RECURSE_SUBMODULES_DEFAULT
)
1424 return spf
->command_line_option
;
1430 int fetch_recurse
= submodule
->fetch_recurse
;
1431 key
= xstrfmt("submodule.%s.fetchRecurseSubmodules", submodule
->name
);
1432 if (!repo_config_get_string_tmp(spf
->r
, key
, &value
)) {
1433 fetch_recurse
= parse_fetch_recurse_submodules_arg(key
, value
);
1437 if (fetch_recurse
!= RECURSE_SUBMODULES_NONE
)
1438 /* local config overrules everything except commandline */
1439 return fetch_recurse
;
1442 return spf
->default_option
;
1446 * Fetch in progress (if callback data) or
1447 * pending (if in oid_fetch_tasks in struct submodule_parallel_fetch)
1450 struct repository
*repo
;
1451 const struct submodule
*sub
;
1452 unsigned free_sub
: 1; /* Do we need to free the submodule? */
1453 const char *default_argv
; /* The default fetch mode. */
1454 struct strvec git_args
; /* Args for the child git process. */
1456 struct oid_array
*commits
; /* Ensure these commits are fetched */
1460 * When a submodule is not defined in .gitmodules, we cannot access it
1461 * via the regular submodule-config. Create a fake submodule, which we can
1464 static const struct submodule
*get_non_gitmodules_submodule(const char *path
)
1466 struct submodule
*ret
= NULL
;
1467 const char *name
= default_name_or_path(path
);
1472 ret
= xmalloc(sizeof(*ret
));
1473 memset(ret
, 0, sizeof(*ret
));
1477 return (const struct submodule
*) ret
;
1480 static void fetch_task_release(struct fetch_task
*p
)
1483 free((void*)p
->sub
);
1488 repo_clear(p
->repo
);
1489 FREE_AND_NULL(p
->repo
);
1491 strvec_clear(&p
->git_args
);
1494 static struct repository
*get_submodule_repo_for(struct repository
*r
,
1496 const struct object_id
*treeish_name
)
1498 struct repository
*ret
= xmalloc(sizeof(*ret
));
1500 if (repo_submodule_init(ret
, r
, path
, treeish_name
)) {
1508 static struct fetch_task
*fetch_task_create(struct submodule_parallel_fetch
*spf
,
1510 const struct object_id
*treeish_name
)
1512 struct fetch_task
*task
= xmalloc(sizeof(*task
));
1513 memset(task
, 0, sizeof(*task
));
1515 task
->sub
= submodule_from_path(spf
->r
, treeish_name
, path
);
1519 * No entry in .gitmodules? Technically not a submodule,
1520 * but historically we supported repositories that happen to be
1521 * in-place where a gitlink is. Keep supporting them.
1523 task
->sub
= get_non_gitmodules_submodule(path
);
1530 if (string_list_lookup(&spf
->seen_submodule_names
, task
->sub
->name
))
1533 switch (get_fetch_recurse_config(task
->sub
, spf
))
1536 case RECURSE_SUBMODULES_DEFAULT
:
1537 case RECURSE_SUBMODULES_ON_DEMAND
:
1539 !string_list_lookup(
1540 &spf
->changed_submodule_names
,
1543 task
->default_argv
= "on-demand";
1545 case RECURSE_SUBMODULES_ON
:
1546 task
->default_argv
= "yes";
1548 case RECURSE_SUBMODULES_OFF
:
1552 task
->repo
= get_submodule_repo_for(spf
->r
, path
, treeish_name
);
1557 fetch_task_release(task
);
1562 static struct fetch_task
*
1563 get_fetch_task_from_index(struct submodule_parallel_fetch
*spf
,
1566 for (; spf
->index_count
< spf
->r
->index
->cache_nr
; spf
->index_count
++) {
1567 const struct cache_entry
*ce
=
1568 spf
->r
->index
->cache
[spf
->index_count
];
1569 struct fetch_task
*task
;
1571 if (!S_ISGITLINK(ce
->ce_mode
))
1574 task
= fetch_task_create(spf
, ce
->name
, null_oid());
1580 strbuf_addf(err
, _("Fetching submodule %s%s\n"),
1581 spf
->prefix
, ce
->name
);
1586 struct strbuf empty_submodule_path
= STRBUF_INIT
;
1588 fetch_task_release(task
);
1592 * An empty directory is normal,
1593 * the submodule is not initialized
1595 strbuf_addf(&empty_submodule_path
, "%s/%s/",
1598 if (S_ISGITLINK(ce
->ce_mode
) &&
1599 !is_empty_dir(empty_submodule_path
.buf
)) {
1602 _("Could not access submodule '%s'\n"),
1605 strbuf_release(&empty_submodule_path
);
1611 static struct fetch_task
*
1612 get_fetch_task_from_changed(struct submodule_parallel_fetch
*spf
,
1615 for (; spf
->changed_count
< spf
->changed_submodule_names
.nr
;
1616 spf
->changed_count
++) {
1617 struct string_list_item item
=
1618 spf
->changed_submodule_names
.items
[spf
->changed_count
];
1619 struct changed_submodule_data
*cs_data
= item
.util
;
1620 struct fetch_task
*task
;
1622 if (!is_tree_submodule_active(spf
->r
, cs_data
->super_oid
,cs_data
->path
))
1625 task
= fetch_task_create(spf
, cs_data
->path
,
1626 cs_data
->super_oid
);
1631 strbuf_addf(err
, _("Could not access submodule '%s' at commit %s\n"),
1633 repo_find_unique_abbrev(the_repository
, cs_data
->super_oid
, DEFAULT_ABBREV
));
1635 fetch_task_release(task
);
1642 _("Fetching submodule %s%s at commit %s\n"),
1643 spf
->prefix
, task
->sub
->path
,
1644 repo_find_unique_abbrev(the_repository
, cs_data
->super_oid
,
1647 spf
->changed_count
++;
1649 * NEEDSWORK: Submodules set/unset a value for
1650 * core.worktree when they are populated/unpopulated by
1651 * "git checkout" (and similar commands, see
1652 * submodule_move_head() and
1653 * connect_work_tree_and_git_dir()), but if the
1654 * submodule is unpopulated in another way (e.g. "git
1655 * rm", "rm -r"), core.worktree will still be set even
1656 * though the directory doesn't exist, and the child
1657 * process will crash while trying to chdir into the
1658 * nonexistent directory.
1660 * In this case, we know that the submodule has no
1661 * working tree, so we can work around this by
1662 * setting "--work-tree=." (--bare does not work because
1663 * worktree settings take precedence over bare-ness).
1664 * However, this is not necessarily true in other cases,
1665 * so a generalized solution is still necessary.
1667 * Possible solutions:
1668 * - teach "git [add|rm]" to unset core.worktree and
1669 * discourage users from removing submodules without
1670 * using a Git command.
1671 * - teach submodule child processes to ignore stale
1672 * core.worktree values.
1674 strvec_push(&task
->git_args
, "--work-tree=.");
1680 static int get_next_submodule(struct child_process
*cp
, struct strbuf
*err
,
1681 void *data
, void **task_cb
)
1683 struct submodule_parallel_fetch
*spf
= data
;
1684 struct fetch_task
*task
=
1685 get_fetch_task_from_index(spf
, err
);
1687 task
= get_fetch_task_from_changed(spf
, err
);
1690 child_process_init(cp
);
1691 cp
->dir
= task
->repo
->gitdir
;
1692 prepare_submodule_repo_env_in_gitdir(&cp
->env
);
1694 strvec_init(&cp
->args
);
1695 if (task
->git_args
.nr
)
1696 strvec_pushv(&cp
->args
, task
->git_args
.v
);
1697 strvec_pushv(&cp
->args
, spf
->args
.v
);
1698 strvec_push(&cp
->args
, task
->default_argv
);
1699 strvec_pushf(&cp
->args
, "--submodule-prefix=%s%s/",
1700 spf
->prefix
, task
->sub
->path
);
1704 string_list_insert(&spf
->seen_submodule_names
, task
->sub
->name
);
1708 if (spf
->oid_fetch_tasks_nr
) {
1709 struct fetch_task
*task
=
1710 spf
->oid_fetch_tasks
[spf
->oid_fetch_tasks_nr
- 1];
1711 spf
->oid_fetch_tasks_nr
--;
1713 child_process_init(cp
);
1714 prepare_submodule_repo_env_in_gitdir(&cp
->env
);
1716 cp
->dir
= task
->repo
->gitdir
;
1718 strvec_init(&cp
->args
);
1719 strvec_pushv(&cp
->args
, spf
->args
.v
);
1720 strvec_push(&cp
->args
, "on-demand");
1721 strvec_pushf(&cp
->args
, "--submodule-prefix=%s%s/",
1722 spf
->prefix
, task
->sub
->path
);
1724 /* NEEDSWORK: have get_default_remote from submodule--helper */
1725 strvec_push(&cp
->args
, "origin");
1726 oid_array_for_each_unique(task
->commits
,
1727 append_oid_to_argv
, &cp
->args
);
1736 static int fetch_start_failure(struct strbuf
*err UNUSED
,
1737 void *cb
, void *task_cb
)
1739 struct submodule_parallel_fetch
*spf
= cb
;
1740 struct fetch_task
*task
= task_cb
;
1744 fetch_task_release(task
);
1748 static int commit_missing_in_sub(const struct object_id
*oid
, void *data
)
1750 struct repository
*subrepo
= data
;
1752 enum object_type type
= oid_object_info(subrepo
, oid
, NULL
);
1754 return type
!= OBJ_COMMIT
;
1757 static int fetch_finish(int retvalue
, struct strbuf
*err UNUSED
,
1758 void *cb
, void *task_cb
)
1760 struct submodule_parallel_fetch
*spf
= cb
;
1761 struct fetch_task
*task
= task_cb
;
1763 struct string_list_item
*it
;
1764 struct changed_submodule_data
*cs_data
;
1766 if (!task
|| !task
->sub
)
1767 BUG("callback cookie bogus");
1771 * NEEDSWORK: This indicates that the overall fetch
1772 * failed, even though there may be a subsequent fetch
1773 * by commit hash that might work. It may be a good
1774 * idea to not indicate failure in this case, and only
1775 * indicate failure if the subsequent fetch fails.
1779 strbuf_addf(&spf
->submodules_with_errors
, "\t%s\n",
1783 /* Is this the second time we process this submodule? */
1787 it
= string_list_lookup(&spf
->changed_submodule_names
, task
->sub
->name
);
1789 /* Could be an unchanged submodule, not contained in the list */
1793 oid_array_filter(&cs_data
->new_commits
,
1794 commit_missing_in_sub
,
1797 /* Are there commits we want, but do not exist? */
1798 if (cs_data
->new_commits
.nr
) {
1799 task
->commits
= &cs_data
->new_commits
;
1800 ALLOC_GROW(spf
->oid_fetch_tasks
,
1801 spf
->oid_fetch_tasks_nr
+ 1,
1802 spf
->oid_fetch_tasks_alloc
);
1803 spf
->oid_fetch_tasks
[spf
->oid_fetch_tasks_nr
] = task
;
1804 spf
->oid_fetch_tasks_nr
++;
1809 fetch_task_release(task
);
1814 int fetch_submodules(struct repository
*r
,
1815 const struct strvec
*options
,
1816 const char *prefix
, int command_line_option
,
1818 int quiet
, int max_parallel_jobs
)
1821 struct submodule_parallel_fetch spf
= SPF_INIT
;
1822 const struct run_process_parallel_opts opts
= {
1823 .tr2_category
= "submodule",
1824 .tr2_label
= "parallel/fetch",
1826 .processes
= max_parallel_jobs
,
1828 .get_next_task
= get_next_submodule
,
1829 .start_failure
= fetch_start_failure
,
1830 .task_finished
= fetch_finish
,
1835 spf
.command_line_option
= command_line_option
;
1836 spf
.default_option
= default_option
;
1838 spf
.prefix
= prefix
;
1843 if (repo_read_index(r
) < 0)
1844 die(_("index file corrupt"));
1846 strvec_push(&spf
.args
, "fetch");
1847 for (i
= 0; i
< options
->nr
; i
++)
1848 strvec_push(&spf
.args
, options
->v
[i
]);
1849 strvec_push(&spf
.args
, "--recurse-submodules-default");
1850 /* default value, "--submodule-prefix" and its value are added later */
1852 calculate_changed_submodule_paths(r
, &spf
.changed_submodule_names
);
1853 string_list_sort(&spf
.changed_submodule_names
);
1854 run_processes_parallel(&opts
);
1856 if (spf
.submodules_with_errors
.len
> 0)
1857 fprintf(stderr
, _("Errors during submodule fetch:\n%s"),
1858 spf
.submodules_with_errors
.buf
);
1861 strvec_clear(&spf
.args
);
1863 free_submodules_data(&spf
.changed_submodule_names
);
1867 unsigned is_submodule_modified(const char *path
, int ignore_untracked
)
1869 struct child_process cp
= CHILD_PROCESS_INIT
;
1870 struct strbuf buf
= STRBUF_INIT
;
1872 unsigned dirty_submodule
= 0;
1873 const char *git_dir
;
1874 int ignore_cp_exit_code
= 0;
1876 strbuf_addf(&buf
, "%s/.git", path
);
1877 git_dir
= read_gitfile(buf
.buf
);
1880 if (!is_git_directory(git_dir
)) {
1881 if (is_directory(git_dir
))
1882 die(_("'%s' not recognized as a git repository"), git_dir
);
1883 strbuf_release(&buf
);
1884 /* The submodule is not checked out, so it is not modified */
1889 strvec_pushl(&cp
.args
, "status", "--porcelain=2", NULL
);
1890 if (ignore_untracked
)
1891 strvec_push(&cp
.args
, "-uno");
1893 prepare_submodule_repo_env(&cp
.env
);
1898 if (start_command(&cp
))
1899 die(_("Could not run 'git status --porcelain=2' in submodule %s"), path
);
1901 fp
= xfdopen(cp
.out
, "r");
1902 while (strbuf_getwholeline(&buf
, fp
, '\n') != EOF
) {
1903 /* regular untracked files */
1904 if (buf
.buf
[0] == '?')
1905 dirty_submodule
|= DIRTY_SUBMODULE_UNTRACKED
;
1907 if (buf
.buf
[0] == 'u' ||
1908 buf
.buf
[0] == '1' ||
1909 buf
.buf
[0] == '2') {
1910 /* T = line type, XY = status, SSSS = submodule state */
1911 if (buf
.len
< strlen("T XY SSSS"))
1912 BUG("invalid status --porcelain=2 line %s",
1915 if (buf
.buf
[5] == 'S' && buf
.buf
[8] == 'U')
1916 /* nested untracked file */
1917 dirty_submodule
|= DIRTY_SUBMODULE_UNTRACKED
;
1919 if (buf
.buf
[0] == 'u' ||
1920 buf
.buf
[0] == '2' ||
1921 memcmp(buf
.buf
+ 5, "S..U", 4))
1923 dirty_submodule
|= DIRTY_SUBMODULE_MODIFIED
;
1926 if ((dirty_submodule
& DIRTY_SUBMODULE_MODIFIED
) &&
1927 ((dirty_submodule
& DIRTY_SUBMODULE_UNTRACKED
) ||
1928 ignore_untracked
)) {
1930 * We're not interested in any further information from
1931 * the child any more, neither output nor its exit code.
1933 ignore_cp_exit_code
= 1;
1939 if (finish_command(&cp
) && !ignore_cp_exit_code
)
1940 die(_("'git status --porcelain=2' failed in submodule %s"), path
);
1942 strbuf_release(&buf
);
1943 return dirty_submodule
;
1946 int submodule_uses_gitfile(const char *path
)
1948 struct child_process cp
= CHILD_PROCESS_INIT
;
1949 struct strbuf buf
= STRBUF_INIT
;
1950 const char *git_dir
;
1952 strbuf_addf(&buf
, "%s/.git", path
);
1953 git_dir
= read_gitfile(buf
.buf
);
1955 strbuf_release(&buf
);
1958 strbuf_release(&buf
);
1960 /* Now test that all nested submodules use a gitfile too */
1961 strvec_pushl(&cp
.args
,
1962 "submodule", "foreach", "--quiet", "--recursive",
1963 "test -f .git", NULL
);
1965 prepare_submodule_repo_env(&cp
.env
);
1971 if (run_command(&cp
))
1978 * Check if it is a bad idea to remove a submodule, i.e. if we'd lose data
1981 * Return 1 if we'd lose data, return 0 if the removal is fine,
1982 * and negative values for errors.
1984 int bad_to_remove_submodule(const char *path
, unsigned flags
)
1987 struct child_process cp
= CHILD_PROCESS_INIT
;
1988 struct strbuf buf
= STRBUF_INIT
;
1991 if (!file_exists(path
) || is_empty_dir(path
))
1994 if (!submodule_uses_gitfile(path
))
1997 strvec_pushl(&cp
.args
, "status", "--porcelain",
1998 "--ignore-submodules=none", NULL
);
2000 if (flags
& SUBMODULE_REMOVAL_IGNORE_UNTRACKED
)
2001 strvec_push(&cp
.args
, "-uno");
2003 strvec_push(&cp
.args
, "-uall");
2005 if (!(flags
& SUBMODULE_REMOVAL_IGNORE_IGNORED_UNTRACKED
))
2006 strvec_push(&cp
.args
, "--ignored");
2008 prepare_submodule_repo_env(&cp
.env
);
2013 if (start_command(&cp
)) {
2014 if (flags
& SUBMODULE_REMOVAL_DIE_ON_ERROR
)
2015 die(_("could not start 'git status' in submodule '%s'"),
2021 len
= strbuf_read(&buf
, cp
.out
, 1024);
2026 if (finish_command(&cp
)) {
2027 if (flags
& SUBMODULE_REMOVAL_DIE_ON_ERROR
)
2028 die(_("could not run 'git status' in submodule '%s'"),
2033 strbuf_release(&buf
);
2037 void submodule_unset_core_worktree(const struct submodule
*sub
)
2039 struct strbuf config_path
= STRBUF_INIT
;
2041 submodule_name_to_gitdir(&config_path
, the_repository
, sub
->name
);
2042 strbuf_addstr(&config_path
, "/config");
2044 if (git_config_set_in_file_gently(config_path
.buf
, "core.worktree", NULL
))
2045 warning(_("Could not unset core.worktree setting in submodule '%s'"),
2048 strbuf_release(&config_path
);
2051 static int submodule_has_dirty_index(const struct submodule
*sub
)
2053 struct child_process cp
= CHILD_PROCESS_INIT
;
2055 prepare_submodule_repo_env(&cp
.env
);
2058 strvec_pushl(&cp
.args
, "diff-index", "--quiet",
2059 "--cached", "HEAD", NULL
);
2063 if (start_command(&cp
))
2064 die(_("could not recurse into submodule '%s'"), sub
->path
);
2066 return finish_command(&cp
);
2069 static void submodule_reset_index(const char *path
, const char *super_prefix
)
2071 struct child_process cp
= CHILD_PROCESS_INIT
;
2072 prepare_submodule_repo_env(&cp
.env
);
2078 /* TODO: determine if this might overwright untracked files */
2079 strvec_pushl(&cp
.args
, "read-tree", "-u", "--reset", NULL
);
2080 strvec_pushf(&cp
.args
, "--super-prefix=%s%s/",
2081 (super_prefix
? super_prefix
: ""), path
);
2083 strvec_push(&cp
.args
, empty_tree_oid_hex());
2085 if (run_command(&cp
))
2086 die(_("could not reset submodule index"));
2090 * Moves a submodule at a given path from a given head to another new head.
2091 * For edge cases (a submodule coming into existence or removing a submodule)
2092 * pass NULL for old or new respectively.
2094 int submodule_move_head(const char *path
, const char *super_prefix
,
2095 const char *old_head
, 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
,
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
, super_prefix
);
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_pushl(&cp
.args
, "read-tree", "--recurse-submodules", NULL
);
2162 strvec_pushf(&cp
.args
, "--super-prefix=%s%s/",
2163 (super_prefix
? super_prefix
: ""), path
);
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
,
2264 const char *super_prefix
)
2266 char *old_git_dir
= NULL
, *real_old_git_dir
= NULL
, *real_new_git_dir
= NULL
;
2267 struct strbuf new_gitdir
= STRBUF_INIT
;
2268 const struct submodule
*sub
;
2270 if (submodule_uses_worktrees(path
))
2271 die(_("relocate_gitdir for submodule '%s' with "
2272 "more than one worktree not supported"), path
);
2274 old_git_dir
= xstrfmt("%s/.git", path
);
2275 if (read_gitfile(old_git_dir
))
2276 /* If it is an actual gitfile, it doesn't need migration. */
2279 real_old_git_dir
= real_pathdup(old_git_dir
, 1);
2281 sub
= submodule_from_path(the_repository
, null_oid(), path
);
2283 die(_("could not lookup name for submodule '%s'"), path
);
2285 submodule_name_to_gitdir(&new_gitdir
, the_repository
, sub
->name
);
2286 if (validate_submodule_git_dir(new_gitdir
.buf
, sub
->name
) < 0)
2287 die(_("refusing to move '%s' into an existing git dir"),
2289 if (safe_create_leading_directories_const(new_gitdir
.buf
) < 0)
2290 die(_("could not create directory '%s'"), new_gitdir
.buf
);
2291 real_new_git_dir
= real_pathdup(new_gitdir
.buf
, 1);
2293 fprintf(stderr
, _("Migrating git directory of '%s%s' from\n'%s' to\n'%s'\n"),
2294 super_prefix
? super_prefix
: "", path
,
2295 real_old_git_dir
, real_new_git_dir
);
2297 relocate_gitdir(path
, real_old_git_dir
, real_new_git_dir
);
2300 free(real_old_git_dir
);
2301 free(real_new_git_dir
);
2302 strbuf_release(&new_gitdir
);
2305 static void absorb_git_dir_into_superproject_recurse(const char *path
,
2306 const char *super_prefix
)
2309 struct child_process cp
= CHILD_PROCESS_INIT
;
2314 strvec_pushl(&cp
.args
, "submodule--helper",
2315 "absorbgitdirs", NULL
);
2316 strvec_pushf(&cp
.args
, "--super-prefix=%s%s/", super_prefix
?
2317 super_prefix
: "", path
);
2319 prepare_submodule_repo_env(&cp
.env
);
2320 if (run_command(&cp
))
2321 die(_("could not recurse into submodule '%s'"), path
);
2325 * Migrate the git directory of the submodule given by path from
2326 * having its git directory within the working tree to the git dir nested
2327 * in its superprojects git dir under modules/.
2329 void absorb_git_dir_into_superproject(const char *path
,
2330 const char *super_prefix
)
2333 const char *sub_git_dir
;
2334 struct strbuf gitdir
= STRBUF_INIT
;
2335 strbuf_addf(&gitdir
, "%s/.git", path
);
2336 sub_git_dir
= resolve_gitdir_gently(gitdir
.buf
, &err_code
);
2338 /* Not populated? */
2340 const struct submodule
*sub
;
2341 struct strbuf sub_gitdir
= STRBUF_INIT
;
2343 if (err_code
== READ_GITFILE_ERR_STAT_FAILED
) {
2344 /* unpopulated as expected */
2345 strbuf_release(&gitdir
);
2349 if (err_code
!= READ_GITFILE_ERR_NOT_A_REPO
)
2350 /* We don't know what broke here. */
2351 read_gitfile_error_die(err_code
, path
, NULL
);
2354 * Maybe populated, but no git directory was found?
2355 * This can happen if the superproject is a submodule
2356 * itself and was just absorbed. The absorption of the
2357 * superproject did not rewrite the git file links yet,
2360 sub
= submodule_from_path(the_repository
, null_oid(), path
);
2362 die(_("could not lookup name for submodule '%s'"), path
);
2363 submodule_name_to_gitdir(&sub_gitdir
, the_repository
, sub
->name
);
2364 connect_work_tree_and_git_dir(path
, sub_gitdir
.buf
, 0);
2365 strbuf_release(&sub_gitdir
);
2367 /* Is it already absorbed into the superprojects git dir? */
2368 char *real_sub_git_dir
= real_pathdup(sub_git_dir
, 1);
2369 char *real_common_git_dir
= real_pathdup(get_git_common_dir(), 1);
2371 if (!starts_with(real_sub_git_dir
, real_common_git_dir
))
2372 relocate_single_git_dir_into_superproject(path
, super_prefix
);
2374 free(real_sub_git_dir
);
2375 free(real_common_git_dir
);
2377 strbuf_release(&gitdir
);
2379 absorb_git_dir_into_superproject_recurse(path
, super_prefix
);
2382 int get_superproject_working_tree(struct strbuf
*buf
)
2384 struct child_process cp
= CHILD_PROCESS_INIT
;
2385 struct strbuf sb
= STRBUF_INIT
;
2386 struct strbuf one_up
= STRBUF_INIT
;
2387 char *cwd
= xgetcwd();
2389 const char *subpath
;
2393 if (!is_inside_work_tree())
2396 * We might have a superproject, but it is harder
2401 if (!strbuf_realpath(&one_up
, "../", 0))
2404 subpath
= relative_path(cwd
, one_up
.buf
, &sb
);
2405 strbuf_release(&one_up
);
2407 prepare_submodule_repo_env(&cp
.env
);
2408 strvec_pop(&cp
.env
);
2410 strvec_pushl(&cp
.args
, "--literal-pathspecs", "-C", "..",
2411 "ls-files", "-z", "--stage", "--full-name", "--",
2420 if (start_command(&cp
))
2421 die(_("could not start ls-files in .."));
2423 len
= strbuf_read(&sb
, cp
.out
, PATH_MAX
);
2426 if (starts_with(sb
.buf
, "160000")) {
2428 int cwd_len
= strlen(cwd
);
2429 char *super_sub
, *super_wt
;
2432 * There is a superproject having this repo as a submodule.
2433 * The format is <mode> SP <hash> SP <stage> TAB <full name> \0,
2434 * We're only interested in the name after the tab.
2436 super_sub
= strchr(sb
.buf
, '\t') + 1;
2437 super_sub_len
= strlen(super_sub
);
2439 if (super_sub_len
> cwd_len
||
2440 strcmp(&cwd
[cwd_len
- super_sub_len
], super_sub
))
2441 BUG("returned path string doesn't match cwd?");
2443 super_wt
= xstrdup(cwd
);
2444 super_wt
[cwd_len
- super_sub_len
] = '\0';
2446 strbuf_realpath(buf
, super_wt
, 1);
2451 strbuf_release(&sb
);
2453 code
= finish_command(&cp
);
2456 /* '../' is not a git repository */
2458 if (code
== 0 && len
== 0)
2459 /* There is an unrelated git repository at '../' */
2462 die(_("ls-tree returned unexpected return code %d"), code
);
2468 * Put the gitdir for a submodule (given relative to the main
2469 * repository worktree) into `buf`, or return -1 on error.
2471 int submodule_to_gitdir(struct strbuf
*buf
, const char *submodule
)
2473 const struct submodule
*sub
;
2474 const char *git_dir
;
2478 strbuf_addstr(buf
, submodule
);
2479 strbuf_complete(buf
, '/');
2480 strbuf_addstr(buf
, ".git");
2482 git_dir
= read_gitfile(buf
->buf
);
2485 strbuf_addstr(buf
, git_dir
);
2487 if (!is_git_directory(buf
->buf
)) {
2488 sub
= submodule_from_path(the_repository
, null_oid(),
2495 submodule_name_to_gitdir(buf
, the_repository
, sub
->name
);
2502 void submodule_name_to_gitdir(struct strbuf
*buf
, struct repository
*r
,
2503 const char *submodule_name
)
2506 * NEEDSWORK: The current way of mapping a submodule's name to
2507 * its location in .git/modules/ has problems with some naming
2508 * schemes. For example, if a submodule is named "foo" and
2509 * another is named "foo/bar" (whether present in the same
2510 * superproject commit or not - the problem will arise if both
2511 * superproject commits have been checked out at any point in
2512 * time), or if two submodule names only have different cases in
2513 * a case-insensitive filesystem.
2515 * There are several solutions, including encoding the path in
2516 * some way, introducing a submodule.<name>.gitdir config in
2517 * .git/config (not .gitmodules) that allows overriding what the
2518 * gitdir of a submodule would be (and teach Git, upon noticing
2519 * a clash, to automatically determine a non-clashing name and
2520 * to write such a config), or introducing a
2521 * submodule.<name>.gitdir config in .gitmodules that repo
2522 * administrators can explicitly set. Nothing has been decided,
2523 * so for now, just append the name at the end of the path.
2525 strbuf_repo_git_path(buf
, r
, "modules/");
2526 strbuf_addstr(buf
, submodule_name
);