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 if (validate_submodule_path(path
) < 0)
1016 oid_array_for_each_unique(commits
, check_has_commit
, &has_commit
);
1018 if (has_commit
.result
) {
1020 * Even if the submodule is checked out and the commit is
1021 * present, make sure it exists in the submodule's object store
1022 * and that it is reachable from a ref.
1024 struct child_process cp
= CHILD_PROCESS_INIT
;
1025 struct strbuf out
= STRBUF_INIT
;
1027 strvec_pushl(&cp
.args
, "rev-list", "-n", "1", NULL
);
1028 oid_array_for_each_unique(commits
, append_oid_to_argv
, &cp
.args
);
1029 strvec_pushl(&cp
.args
, "--not", "--all", NULL
);
1031 prepare_submodule_repo_env(&cp
.env
);
1036 if (capture_command(&cp
, &out
, GIT_MAX_HEXSZ
+ 1) || out
.len
)
1037 has_commit
.result
= 0;
1039 strbuf_release(&out
);
1042 return has_commit
.result
;
1045 static int submodule_needs_pushing(struct repository
*r
,
1047 struct oid_array
*commits
)
1049 if (!submodule_has_commits(r
, path
, null_oid(), commits
))
1051 * NOTE: We do consider it safe to return "no" here. The
1052 * correct answer would be "We do not know" instead of
1053 * "No push needed", but it is quite hard to change
1054 * the submodule pointer without having the submodule
1055 * around. If a user did however change the submodules
1056 * without having the submodule around, this indicates
1057 * an expert who knows what they are doing or a
1058 * maintainer integrating work from other people. In
1059 * both cases it should be safe to skip this check.
1063 if (for_each_remote_ref_submodule(path
, has_remote
, NULL
) > 0) {
1064 struct child_process cp
= CHILD_PROCESS_INIT
;
1065 struct strbuf buf
= STRBUF_INIT
;
1066 int needs_pushing
= 0;
1068 strvec_push(&cp
.args
, "rev-list");
1069 oid_array_for_each_unique(commits
, append_oid_to_argv
, &cp
.args
);
1070 strvec_pushl(&cp
.args
, "--not", "--remotes", "-n", "1" , NULL
);
1072 prepare_submodule_repo_env(&cp
.env
);
1077 if (start_command(&cp
))
1078 die(_("Could not run 'git rev-list <commits> --not --remotes -n 1' command in submodule %s"),
1080 if (strbuf_read(&buf
, cp
.out
, the_hash_algo
->hexsz
+ 1))
1082 finish_command(&cp
);
1084 strbuf_release(&buf
);
1085 return needs_pushing
;
1091 int find_unpushed_submodules(struct repository
*r
,
1092 struct oid_array
*commits
,
1093 const char *remotes_name
,
1094 struct string_list
*needs_pushing
)
1096 struct string_list submodules
= STRING_LIST_INIT_DUP
;
1097 struct string_list_item
*name
;
1098 struct strvec argv
= STRVEC_INIT
;
1100 /* argv.v[0] will be ignored by setup_revisions */
1101 strvec_push(&argv
, "find_unpushed_submodules");
1102 oid_array_for_each_unique(commits
, append_oid_to_argv
, &argv
);
1103 strvec_push(&argv
, "--not");
1104 strvec_pushf(&argv
, "--remotes=%s", remotes_name
);
1106 collect_changed_submodules(r
, &submodules
, &argv
);
1108 for_each_string_list_item(name
, &submodules
) {
1109 struct changed_submodule_data
*cs_data
= name
->util
;
1110 const struct submodule
*submodule
;
1111 const char *path
= NULL
;
1113 submodule
= submodule_from_name(r
, null_oid(), name
->string
);
1115 path
= submodule
->path
;
1117 path
= default_name_or_path(name
->string
);
1122 if (submodule_needs_pushing(r
, path
, &cs_data
->new_commits
))
1123 string_list_insert(needs_pushing
, path
);
1126 free_submodules_data(&submodules
);
1127 strvec_clear(&argv
);
1129 return needs_pushing
->nr
;
1132 static int push_submodule(const char *path
,
1133 const struct remote
*remote
,
1134 const struct refspec
*rs
,
1135 const struct string_list
*push_options
,
1138 if (validate_submodule_path(path
) < 0)
1141 if (for_each_remote_ref_submodule(path
, has_remote
, NULL
) > 0) {
1142 struct child_process cp
= CHILD_PROCESS_INIT
;
1143 strvec_push(&cp
.args
, "push");
1145 * When recursing into a submodule, treat any "only" configurations as "on-
1146 * demand", since "only" would not work (we need all submodules to be pushed
1147 * in order to be able to push the superproject).
1149 strvec_push(&cp
.args
, "--recurse-submodules=only-is-on-demand");
1151 strvec_push(&cp
.args
, "--dry-run");
1153 if (push_options
&& push_options
->nr
) {
1154 const struct string_list_item
*item
;
1155 for_each_string_list_item(item
, push_options
)
1156 strvec_pushf(&cp
.args
, "--push-option=%s",
1160 if (remote
->origin
!= REMOTE_UNCONFIGURED
) {
1162 strvec_push(&cp
.args
, remote
->name
);
1163 for (i
= 0; i
< rs
->raw_nr
; i
++)
1164 strvec_push(&cp
.args
, rs
->raw
[i
]);
1167 prepare_submodule_repo_env(&cp
.env
);
1171 if (run_command(&cp
))
1180 * Perform a check in the submodule to see if the remote and refspec work.
1181 * Die if the submodule can't be pushed.
1183 static void submodule_push_check(const char *path
, const char *head
,
1184 const struct remote
*remote
,
1185 const struct refspec
*rs
)
1187 struct child_process cp
= CHILD_PROCESS_INIT
;
1190 if (validate_submodule_path(path
) < 0)
1193 strvec_push(&cp
.args
, "submodule--helper");
1194 strvec_push(&cp
.args
, "push-check");
1195 strvec_push(&cp
.args
, head
);
1196 strvec_push(&cp
.args
, remote
->name
);
1198 for (i
= 0; i
< rs
->raw_nr
; i
++)
1199 strvec_push(&cp
.args
, rs
->raw
[i
]);
1201 prepare_submodule_repo_env(&cp
.env
);
1208 * Simply indicate if 'submodule--helper push-check' failed.
1209 * More detailed error information will be provided by the
1212 if (run_command(&cp
))
1213 die(_("process for submodule '%s' failed"), path
);
1216 int push_unpushed_submodules(struct repository
*r
,
1217 struct oid_array
*commits
,
1218 const struct remote
*remote
,
1219 const struct refspec
*rs
,
1220 const struct string_list
*push_options
,
1224 struct string_list needs_pushing
= STRING_LIST_INIT_DUP
;
1226 if (!find_unpushed_submodules(r
, commits
,
1227 remote
->name
, &needs_pushing
))
1231 * Verify that the remote and refspec can be propagated to all
1232 * submodules. This check can be skipped if the remote and refspec
1233 * won't be propagated due to the remote being unconfigured (e.g. a URL
1234 * instead of a remote name).
1236 if (remote
->origin
!= REMOTE_UNCONFIGURED
) {
1238 struct object_id head_oid
;
1240 head
= resolve_refdup("HEAD", 0, &head_oid
, NULL
);
1242 die(_("Failed to resolve HEAD as a valid ref."));
1244 for (i
= 0; i
< needs_pushing
.nr
; i
++)
1245 submodule_push_check(needs_pushing
.items
[i
].string
,
1250 /* Actually push the submodules */
1251 for (i
= 0; i
< needs_pushing
.nr
; i
++) {
1252 const char *path
= needs_pushing
.items
[i
].string
;
1253 fprintf(stderr
, _("Pushing submodule '%s'\n"), path
);
1254 if (!push_submodule(path
, remote
, rs
,
1255 push_options
, dry_run
)) {
1256 fprintf(stderr
, _("Unable to push submodule '%s'\n"), path
);
1261 string_list_clear(&needs_pushing
, 0);
1266 static int append_oid_to_array(const char *ref UNUSED
,
1267 const struct object_id
*oid
,
1268 int flags UNUSED
, void *data
)
1270 struct oid_array
*array
= data
;
1271 oid_array_append(array
, oid
);
1275 void check_for_new_submodule_commits(struct object_id
*oid
)
1277 if (!initialized_fetch_ref_tips
) {
1278 for_each_ref(append_oid_to_array
, &ref_tips_before_fetch
);
1279 initialized_fetch_ref_tips
= 1;
1282 oid_array_append(&ref_tips_after_fetch
, oid
);
1286 * Returns 1 if there is at least one submodule gitdir in
1287 * $GIT_DIR/modules and 0 otherwise. This follows
1288 * submodule_name_to_gitdir(), which looks for submodules in
1289 * $GIT_DIR/modules, not $GIT_COMMON_DIR.
1291 * A submodule can be moved to $GIT_DIR/modules manually by running "git
1292 * submodule absorbgitdirs", or it may be initialized there by "git
1293 * submodule update".
1295 static int repo_has_absorbed_submodules(struct repository
*r
)
1298 struct strbuf buf
= STRBUF_INIT
;
1300 strbuf_repo_git_path(&buf
, r
, "modules/");
1301 ret
= file_exists(buf
.buf
) && !is_empty_dir(buf
.buf
);
1302 strbuf_release(&buf
);
1306 static void calculate_changed_submodule_paths(struct repository
*r
,
1307 struct string_list
*changed_submodule_names
)
1309 struct strvec argv
= STRVEC_INIT
;
1310 struct string_list_item
*name
;
1312 /* No need to check if no submodules would be fetched */
1313 if (!submodule_from_path(r
, NULL
, NULL
) &&
1314 !repo_has_absorbed_submodules(r
))
1317 strvec_push(&argv
, "--"); /* argv[0] program name */
1318 oid_array_for_each_unique(&ref_tips_after_fetch
,
1319 append_oid_to_argv
, &argv
);
1320 strvec_push(&argv
, "--not");
1321 oid_array_for_each_unique(&ref_tips_before_fetch
,
1322 append_oid_to_argv
, &argv
);
1325 * Collect all submodules (whether checked out or not) for which new
1326 * commits have been recorded upstream in "changed_submodule_names".
1328 collect_changed_submodules(r
, changed_submodule_names
, &argv
);
1330 for_each_string_list_item(name
, changed_submodule_names
) {
1331 struct changed_submodule_data
*cs_data
= name
->util
;
1332 const struct submodule
*submodule
;
1333 const char *path
= NULL
;
1335 submodule
= submodule_from_name(r
, null_oid(), name
->string
);
1337 path
= submodule
->path
;
1339 path
= default_name_or_path(name
->string
);
1344 if (submodule_has_commits(r
, path
, null_oid(), &cs_data
->new_commits
)) {
1345 changed_submodule_data_clear(cs_data
);
1346 *name
->string
= '\0';
1350 string_list_remove_empty_items(changed_submodule_names
, 1);
1352 strvec_clear(&argv
);
1353 oid_array_clear(&ref_tips_before_fetch
);
1354 oid_array_clear(&ref_tips_after_fetch
);
1355 initialized_fetch_ref_tips
= 0;
1358 int submodule_touches_in_range(struct repository
*r
,
1359 struct object_id
*excl_oid
,
1360 struct object_id
*incl_oid
)
1362 struct string_list subs
= STRING_LIST_INIT_DUP
;
1363 struct strvec args
= STRVEC_INIT
;
1366 /* No need to check if there are no submodules configured */
1367 if (!submodule_from_path(r
, NULL
, NULL
))
1370 strvec_push(&args
, "--"); /* args[0] program name */
1371 strvec_push(&args
, oid_to_hex(incl_oid
));
1372 if (!is_null_oid(excl_oid
)) {
1373 strvec_push(&args
, "--not");
1374 strvec_push(&args
, oid_to_hex(excl_oid
));
1377 collect_changed_submodules(r
, &subs
, &args
);
1380 strvec_clear(&args
);
1382 free_submodules_data(&subs
);
1386 struct submodule_parallel_fetch
{
1388 * The index of the last index entry processed by
1389 * get_fetch_task_from_index().
1393 * The index of the last string_list entry processed by
1394 * get_fetch_task_from_changed().
1398 struct repository
*r
;
1400 int command_line_option
;
1406 * Names of submodules that have new commits. Generated by
1407 * walking the newly fetched superproject commits.
1409 struct string_list changed_submodule_names
;
1411 * Names of submodules that have already been processed. Lets us
1412 * avoid fetching the same submodule more than once.
1414 struct string_list seen_submodule_names
;
1416 /* Pending fetches by OIDs */
1417 struct fetch_task
**oid_fetch_tasks
;
1418 int oid_fetch_tasks_nr
, oid_fetch_tasks_alloc
;
1420 struct strbuf submodules_with_errors
;
1422 #define SPF_INIT { \
1423 .args = STRVEC_INIT, \
1424 .changed_submodule_names = STRING_LIST_INIT_DUP, \
1425 .seen_submodule_names = STRING_LIST_INIT_DUP, \
1426 .submodules_with_errors = STRBUF_INIT, \
1429 static int get_fetch_recurse_config(const struct submodule
*submodule
,
1430 struct submodule_parallel_fetch
*spf
)
1432 if (spf
->command_line_option
!= RECURSE_SUBMODULES_DEFAULT
)
1433 return spf
->command_line_option
;
1439 int fetch_recurse
= submodule
->fetch_recurse
;
1440 key
= xstrfmt("submodule.%s.fetchRecurseSubmodules", submodule
->name
);
1441 if (!repo_config_get_string_tmp(spf
->r
, key
, &value
)) {
1442 fetch_recurse
= parse_fetch_recurse_submodules_arg(key
, value
);
1446 if (fetch_recurse
!= RECURSE_SUBMODULES_NONE
)
1447 /* local config overrules everything except commandline */
1448 return fetch_recurse
;
1451 return spf
->default_option
;
1455 * Fetch in progress (if callback data) or
1456 * pending (if in oid_fetch_tasks in struct submodule_parallel_fetch)
1459 struct repository
*repo
;
1460 const struct submodule
*sub
;
1461 unsigned free_sub
: 1; /* Do we need to free the submodule? */
1462 const char *default_argv
; /* The default fetch mode. */
1463 struct strvec git_args
; /* Args for the child git process. */
1465 struct oid_array
*commits
; /* Ensure these commits are fetched */
1469 * When a submodule is not defined in .gitmodules, we cannot access it
1470 * via the regular submodule-config. Create a fake submodule, which we can
1473 static const struct submodule
*get_non_gitmodules_submodule(const char *path
)
1475 struct submodule
*ret
= NULL
;
1476 const char *name
= default_name_or_path(path
);
1481 ret
= xmalloc(sizeof(*ret
));
1482 memset(ret
, 0, sizeof(*ret
));
1486 return (const struct submodule
*) ret
;
1489 static void fetch_task_release(struct fetch_task
*p
)
1492 free((void*)p
->sub
);
1497 repo_clear(p
->repo
);
1498 FREE_AND_NULL(p
->repo
);
1500 strvec_clear(&p
->git_args
);
1503 static struct repository
*get_submodule_repo_for(struct repository
*r
,
1505 const struct object_id
*treeish_name
)
1507 struct repository
*ret
= xmalloc(sizeof(*ret
));
1509 if (repo_submodule_init(ret
, r
, path
, treeish_name
)) {
1517 static struct fetch_task
*fetch_task_create(struct submodule_parallel_fetch
*spf
,
1519 const struct object_id
*treeish_name
)
1521 struct fetch_task
*task
= xmalloc(sizeof(*task
));
1522 memset(task
, 0, sizeof(*task
));
1524 if (validate_submodule_path(path
) < 0)
1527 task
->sub
= submodule_from_path(spf
->r
, treeish_name
, path
);
1531 * No entry in .gitmodules? Technically not a submodule,
1532 * but historically we supported repositories that happen to be
1533 * in-place where a gitlink is. Keep supporting them.
1535 task
->sub
= get_non_gitmodules_submodule(path
);
1542 if (string_list_lookup(&spf
->seen_submodule_names
, task
->sub
->name
))
1545 switch (get_fetch_recurse_config(task
->sub
, spf
))
1548 case RECURSE_SUBMODULES_DEFAULT
:
1549 case RECURSE_SUBMODULES_ON_DEMAND
:
1551 !string_list_lookup(
1552 &spf
->changed_submodule_names
,
1555 task
->default_argv
= "on-demand";
1557 case RECURSE_SUBMODULES_ON
:
1558 task
->default_argv
= "yes";
1560 case RECURSE_SUBMODULES_OFF
:
1564 task
->repo
= get_submodule_repo_for(spf
->r
, path
, treeish_name
);
1569 fetch_task_release(task
);
1574 static struct fetch_task
*
1575 get_fetch_task_from_index(struct submodule_parallel_fetch
*spf
,
1578 for (; spf
->index_count
< spf
->r
->index
->cache_nr
; spf
->index_count
++) {
1579 const struct cache_entry
*ce
=
1580 spf
->r
->index
->cache
[spf
->index_count
];
1581 struct fetch_task
*task
;
1583 if (!S_ISGITLINK(ce
->ce_mode
))
1586 task
= fetch_task_create(spf
, ce
->name
, null_oid());
1592 strbuf_addf(err
, _("Fetching submodule %s%s\n"),
1593 spf
->prefix
, ce
->name
);
1598 struct strbuf empty_submodule_path
= STRBUF_INIT
;
1600 fetch_task_release(task
);
1604 * An empty directory is normal,
1605 * the submodule is not initialized
1607 strbuf_addf(&empty_submodule_path
, "%s/%s/",
1610 if (S_ISGITLINK(ce
->ce_mode
) &&
1611 !is_empty_dir(empty_submodule_path
.buf
)) {
1614 _("Could not access submodule '%s'\n"),
1617 strbuf_release(&empty_submodule_path
);
1623 static struct fetch_task
*
1624 get_fetch_task_from_changed(struct submodule_parallel_fetch
*spf
,
1627 for (; spf
->changed_count
< spf
->changed_submodule_names
.nr
;
1628 spf
->changed_count
++) {
1629 struct string_list_item item
=
1630 spf
->changed_submodule_names
.items
[spf
->changed_count
];
1631 struct changed_submodule_data
*cs_data
= item
.util
;
1632 struct fetch_task
*task
;
1634 if (!is_tree_submodule_active(spf
->r
, cs_data
->super_oid
,cs_data
->path
))
1637 task
= fetch_task_create(spf
, cs_data
->path
,
1638 cs_data
->super_oid
);
1643 strbuf_addf(err
, _("Could not access submodule '%s' at commit %s\n"),
1645 repo_find_unique_abbrev(the_repository
, cs_data
->super_oid
, DEFAULT_ABBREV
));
1647 fetch_task_release(task
);
1654 _("Fetching submodule %s%s at commit %s\n"),
1655 spf
->prefix
, task
->sub
->path
,
1656 repo_find_unique_abbrev(the_repository
, cs_data
->super_oid
,
1659 spf
->changed_count
++;
1661 * NEEDSWORK: Submodules set/unset a value for
1662 * core.worktree when they are populated/unpopulated by
1663 * "git checkout" (and similar commands, see
1664 * submodule_move_head() and
1665 * connect_work_tree_and_git_dir()), but if the
1666 * submodule is unpopulated in another way (e.g. "git
1667 * rm", "rm -r"), core.worktree will still be set even
1668 * though the directory doesn't exist, and the child
1669 * process will crash while trying to chdir into the
1670 * nonexistent directory.
1672 * In this case, we know that the submodule has no
1673 * working tree, so we can work around this by
1674 * setting "--work-tree=." (--bare does not work because
1675 * worktree settings take precedence over bare-ness).
1676 * However, this is not necessarily true in other cases,
1677 * so a generalized solution is still necessary.
1679 * Possible solutions:
1680 * - teach "git [add|rm]" to unset core.worktree and
1681 * discourage users from removing submodules without
1682 * using a Git command.
1683 * - teach submodule child processes to ignore stale
1684 * core.worktree values.
1686 strvec_push(&task
->git_args
, "--work-tree=.");
1692 static int get_next_submodule(struct child_process
*cp
, struct strbuf
*err
,
1693 void *data
, void **task_cb
)
1695 struct submodule_parallel_fetch
*spf
= data
;
1696 struct fetch_task
*task
=
1697 get_fetch_task_from_index(spf
, err
);
1699 task
= get_fetch_task_from_changed(spf
, err
);
1702 struct strbuf submodule_prefix
= STRBUF_INIT
;
1704 child_process_init(cp
);
1705 cp
->dir
= task
->repo
->gitdir
;
1706 prepare_submodule_repo_env_in_gitdir(&cp
->env
);
1708 strvec_init(&cp
->args
);
1709 if (task
->git_args
.nr
)
1710 strvec_pushv(&cp
->args
, task
->git_args
.v
);
1711 strvec_pushv(&cp
->args
, spf
->args
.v
);
1712 strvec_push(&cp
->args
, task
->default_argv
);
1713 strvec_push(&cp
->args
, "--submodule-prefix");
1715 strbuf_addf(&submodule_prefix
, "%s%s/",
1718 strvec_push(&cp
->args
, submodule_prefix
.buf
);
1721 strbuf_release(&submodule_prefix
);
1722 string_list_insert(&spf
->seen_submodule_names
, task
->sub
->name
);
1726 if (spf
->oid_fetch_tasks_nr
) {
1727 struct fetch_task
*task
=
1728 spf
->oid_fetch_tasks
[spf
->oid_fetch_tasks_nr
- 1];
1729 struct strbuf submodule_prefix
= STRBUF_INIT
;
1730 spf
->oid_fetch_tasks_nr
--;
1732 strbuf_addf(&submodule_prefix
, "%s%s/",
1733 spf
->prefix
, task
->sub
->path
);
1735 child_process_init(cp
);
1736 prepare_submodule_repo_env_in_gitdir(&cp
->env
);
1738 cp
->dir
= task
->repo
->gitdir
;
1740 strvec_init(&cp
->args
);
1741 strvec_pushv(&cp
->args
, spf
->args
.v
);
1742 strvec_push(&cp
->args
, "on-demand");
1743 strvec_push(&cp
->args
, "--submodule-prefix");
1744 strvec_push(&cp
->args
, submodule_prefix
.buf
);
1746 /* NEEDSWORK: have get_default_remote from submodule--helper */
1747 strvec_push(&cp
->args
, "origin");
1748 oid_array_for_each_unique(task
->commits
,
1749 append_oid_to_argv
, &cp
->args
);
1752 strbuf_release(&submodule_prefix
);
1759 static int fetch_start_failure(struct strbuf
*err UNUSED
,
1760 void *cb
, void *task_cb
)
1762 struct submodule_parallel_fetch
*spf
= cb
;
1763 struct fetch_task
*task
= task_cb
;
1767 fetch_task_release(task
);
1771 static int commit_missing_in_sub(const struct object_id
*oid
, void *data
)
1773 struct repository
*subrepo
= data
;
1775 enum object_type type
= oid_object_info(subrepo
, oid
, NULL
);
1777 return type
!= OBJ_COMMIT
;
1780 static int fetch_finish(int retvalue
, struct strbuf
*err UNUSED
,
1781 void *cb
, void *task_cb
)
1783 struct submodule_parallel_fetch
*spf
= cb
;
1784 struct fetch_task
*task
= task_cb
;
1786 struct string_list_item
*it
;
1787 struct changed_submodule_data
*cs_data
;
1789 if (!task
|| !task
->sub
)
1790 BUG("callback cookie bogus");
1794 * NEEDSWORK: This indicates that the overall fetch
1795 * failed, even though there may be a subsequent fetch
1796 * by commit hash that might work. It may be a good
1797 * idea to not indicate failure in this case, and only
1798 * indicate failure if the subsequent fetch fails.
1802 strbuf_addf(&spf
->submodules_with_errors
, "\t%s\n",
1806 /* Is this the second time we process this submodule? */
1810 it
= string_list_lookup(&spf
->changed_submodule_names
, task
->sub
->name
);
1812 /* Could be an unchanged submodule, not contained in the list */
1816 oid_array_filter(&cs_data
->new_commits
,
1817 commit_missing_in_sub
,
1820 /* Are there commits we want, but do not exist? */
1821 if (cs_data
->new_commits
.nr
) {
1822 task
->commits
= &cs_data
->new_commits
;
1823 ALLOC_GROW(spf
->oid_fetch_tasks
,
1824 spf
->oid_fetch_tasks_nr
+ 1,
1825 spf
->oid_fetch_tasks_alloc
);
1826 spf
->oid_fetch_tasks
[spf
->oid_fetch_tasks_nr
] = task
;
1827 spf
->oid_fetch_tasks_nr
++;
1832 fetch_task_release(task
);
1837 int fetch_submodules(struct repository
*r
,
1838 const struct strvec
*options
,
1839 const char *prefix
, int command_line_option
,
1841 int quiet
, int max_parallel_jobs
)
1844 struct submodule_parallel_fetch spf
= SPF_INIT
;
1845 const struct run_process_parallel_opts opts
= {
1846 .tr2_category
= "submodule",
1847 .tr2_label
= "parallel/fetch",
1849 .processes
= max_parallel_jobs
,
1851 .get_next_task
= get_next_submodule
,
1852 .start_failure
= fetch_start_failure
,
1853 .task_finished
= fetch_finish
,
1858 spf
.command_line_option
= command_line_option
;
1859 spf
.default_option
= default_option
;
1861 spf
.prefix
= prefix
;
1866 if (repo_read_index(r
) < 0)
1867 die(_("index file corrupt"));
1869 strvec_push(&spf
.args
, "fetch");
1870 for (i
= 0; i
< options
->nr
; i
++)
1871 strvec_push(&spf
.args
, options
->v
[i
]);
1872 strvec_push(&spf
.args
, "--recurse-submodules-default");
1873 /* default value, "--submodule-prefix" and its value are added later */
1875 calculate_changed_submodule_paths(r
, &spf
.changed_submodule_names
);
1876 string_list_sort(&spf
.changed_submodule_names
);
1877 run_processes_parallel(&opts
);
1879 if (spf
.submodules_with_errors
.len
> 0)
1880 fprintf(stderr
, _("Errors during submodule fetch:\n%s"),
1881 spf
.submodules_with_errors
.buf
);
1884 strvec_clear(&spf
.args
);
1886 free_submodules_data(&spf
.changed_submodule_names
);
1890 unsigned is_submodule_modified(const char *path
, int ignore_untracked
)
1892 struct child_process cp
= CHILD_PROCESS_INIT
;
1893 struct strbuf buf
= STRBUF_INIT
;
1895 unsigned dirty_submodule
= 0;
1896 const char *git_dir
;
1897 int ignore_cp_exit_code
= 0;
1899 if (validate_submodule_path(path
) < 0)
1902 strbuf_addf(&buf
, "%s/.git", path
);
1903 git_dir
= read_gitfile(buf
.buf
);
1906 if (!is_git_directory(git_dir
)) {
1907 if (is_directory(git_dir
))
1908 die(_("'%s' not recognized as a git repository"), git_dir
);
1909 strbuf_release(&buf
);
1910 /* The submodule is not checked out, so it is not modified */
1915 strvec_pushl(&cp
.args
, "status", "--porcelain=2", NULL
);
1916 if (ignore_untracked
)
1917 strvec_push(&cp
.args
, "-uno");
1919 prepare_submodule_repo_env(&cp
.env
);
1924 if (start_command(&cp
))
1925 die(_("Could not run 'git status --porcelain=2' in submodule %s"), path
);
1927 fp
= xfdopen(cp
.out
, "r");
1928 while (strbuf_getwholeline(&buf
, fp
, '\n') != EOF
) {
1929 /* regular untracked files */
1930 if (buf
.buf
[0] == '?')
1931 dirty_submodule
|= DIRTY_SUBMODULE_UNTRACKED
;
1933 if (buf
.buf
[0] == 'u' ||
1934 buf
.buf
[0] == '1' ||
1935 buf
.buf
[0] == '2') {
1936 /* T = line type, XY = status, SSSS = submodule state */
1937 if (buf
.len
< strlen("T XY SSSS"))
1938 BUG("invalid status --porcelain=2 line %s",
1941 if (buf
.buf
[5] == 'S' && buf
.buf
[8] == 'U')
1942 /* nested untracked file */
1943 dirty_submodule
|= DIRTY_SUBMODULE_UNTRACKED
;
1945 if (buf
.buf
[0] == 'u' ||
1946 buf
.buf
[0] == '2' ||
1947 memcmp(buf
.buf
+ 5, "S..U", 4))
1949 dirty_submodule
|= DIRTY_SUBMODULE_MODIFIED
;
1952 if ((dirty_submodule
& DIRTY_SUBMODULE_MODIFIED
) &&
1953 ((dirty_submodule
& DIRTY_SUBMODULE_UNTRACKED
) ||
1954 ignore_untracked
)) {
1956 * We're not interested in any further information from
1957 * the child any more, neither output nor its exit code.
1959 ignore_cp_exit_code
= 1;
1965 if (finish_command(&cp
) && !ignore_cp_exit_code
)
1966 die(_("'git status --porcelain=2' failed in submodule %s"), path
);
1968 strbuf_release(&buf
);
1969 return dirty_submodule
;
1972 int submodule_uses_gitfile(const char *path
)
1974 struct child_process cp
= CHILD_PROCESS_INIT
;
1975 struct strbuf buf
= STRBUF_INIT
;
1976 const char *git_dir
;
1978 if (validate_submodule_path(path
) < 0)
1981 strbuf_addf(&buf
, "%s/.git", path
);
1982 git_dir
= read_gitfile(buf
.buf
);
1984 strbuf_release(&buf
);
1987 strbuf_release(&buf
);
1989 /* Now test that all nested submodules use a gitfile too */
1990 strvec_pushl(&cp
.args
,
1991 "submodule", "foreach", "--quiet", "--recursive",
1992 "test -f .git", NULL
);
1994 prepare_submodule_repo_env(&cp
.env
);
2000 if (run_command(&cp
))
2007 * Check if it is a bad idea to remove a submodule, i.e. if we'd lose data
2010 * Return 1 if we'd lose data, return 0 if the removal is fine,
2011 * and negative values for errors.
2013 int bad_to_remove_submodule(const char *path
, unsigned flags
)
2016 struct child_process cp
= CHILD_PROCESS_INIT
;
2017 struct strbuf buf
= STRBUF_INIT
;
2020 if (validate_submodule_path(path
) < 0)
2023 if (!file_exists(path
) || is_empty_dir(path
))
2026 if (!submodule_uses_gitfile(path
))
2029 strvec_pushl(&cp
.args
, "status", "--porcelain",
2030 "--ignore-submodules=none", NULL
);
2032 if (flags
& SUBMODULE_REMOVAL_IGNORE_UNTRACKED
)
2033 strvec_push(&cp
.args
, "-uno");
2035 strvec_push(&cp
.args
, "-uall");
2037 if (!(flags
& SUBMODULE_REMOVAL_IGNORE_IGNORED_UNTRACKED
))
2038 strvec_push(&cp
.args
, "--ignored");
2040 prepare_submodule_repo_env(&cp
.env
);
2045 if (start_command(&cp
)) {
2046 if (flags
& SUBMODULE_REMOVAL_DIE_ON_ERROR
)
2047 die(_("could not start 'git status' in submodule '%s'"),
2053 len
= strbuf_read(&buf
, cp
.out
, 1024);
2058 if (finish_command(&cp
)) {
2059 if (flags
& SUBMODULE_REMOVAL_DIE_ON_ERROR
)
2060 die(_("could not run 'git status' in submodule '%s'"),
2065 strbuf_release(&buf
);
2069 void submodule_unset_core_worktree(const struct submodule
*sub
)
2071 struct strbuf config_path
= STRBUF_INIT
;
2073 if (validate_submodule_path(sub
->path
) < 0)
2076 submodule_name_to_gitdir(&config_path
, the_repository
, sub
->name
);
2077 strbuf_addstr(&config_path
, "/config");
2079 if (git_config_set_in_file_gently(config_path
.buf
, "core.worktree", NULL
))
2080 warning(_("Could not unset core.worktree setting in submodule '%s'"),
2083 strbuf_release(&config_path
);
2086 static int submodule_has_dirty_index(const struct submodule
*sub
)
2088 struct child_process cp
= CHILD_PROCESS_INIT
;
2090 if (validate_submodule_path(sub
->path
) < 0)
2093 prepare_submodule_repo_env(&cp
.env
);
2096 strvec_pushl(&cp
.args
, "diff-index", "--quiet",
2097 "--cached", "HEAD", NULL
);
2101 if (start_command(&cp
))
2102 die(_("could not recurse into submodule '%s'"), sub
->path
);
2104 return finish_command(&cp
);
2107 static void submodule_reset_index(const char *path
, const char *super_prefix
)
2109 struct child_process cp
= CHILD_PROCESS_INIT
;
2111 if (validate_submodule_path(path
) < 0)
2114 prepare_submodule_repo_env(&cp
.env
);
2120 /* TODO: determine if this might overwright untracked files */
2121 strvec_pushl(&cp
.args
, "read-tree", "-u", "--reset", NULL
);
2122 strvec_pushf(&cp
.args
, "--super-prefix=%s%s/",
2123 (super_prefix
? super_prefix
: ""), path
);
2125 strvec_push(&cp
.args
, empty_tree_oid_hex());
2127 if (run_command(&cp
))
2128 die(_("could not reset submodule index"));
2132 * Moves a submodule at a given path from a given head to another new head.
2133 * For edge cases (a submodule coming into existence or removing a submodule)
2134 * pass NULL for old or new respectively.
2136 int submodule_move_head(const char *path
, const char *super_prefix
,
2137 const char *old_head
, const char *new_head
,
2141 struct child_process cp
= CHILD_PROCESS_INIT
;
2142 const struct submodule
*sub
;
2143 int *error_code_ptr
, error_code
;
2145 if (!is_submodule_active(the_repository
, path
))
2148 if (flags
& SUBMODULE_MOVE_HEAD_FORCE
)
2150 * Pass non NULL pointer to is_submodule_populated_gently
2151 * to prevent die()-ing. We'll use connect_work_tree_and_git_dir
2152 * to fixup the submodule in the force case later.
2154 error_code_ptr
= &error_code
;
2156 error_code_ptr
= NULL
;
2158 if (old_head
&& !is_submodule_populated_gently(path
, error_code_ptr
))
2161 sub
= submodule_from_path(the_repository
, null_oid(), path
);
2164 BUG("could not get submodule information for '%s'", path
);
2166 if (old_head
&& !(flags
& SUBMODULE_MOVE_HEAD_FORCE
)) {
2167 /* Check if the submodule has a dirty index. */
2168 if (submodule_has_dirty_index(sub
))
2169 return error(_("submodule '%s' has dirty index"), path
);
2172 if (!(flags
& SUBMODULE_MOVE_HEAD_DRY_RUN
)) {
2174 if (!submodule_uses_gitfile(path
))
2175 absorb_git_dir_into_superproject(path
,
2178 char *dotgit
= xstrfmt("%s/.git", path
);
2179 char *git_dir
= xstrdup(read_gitfile(dotgit
));
2182 if (validate_submodule_git_dir(git_dir
,
2184 die(_("refusing to create/use '%s' in "
2185 "another submodule's git dir"),
2190 struct strbuf gitdir
= STRBUF_INIT
;
2191 submodule_name_to_gitdir(&gitdir
, the_repository
,
2193 if (validate_submodule_git_dir(gitdir
.buf
,
2195 die(_("refusing to create/use '%s' in another "
2196 "submodule's git dir"),
2198 connect_work_tree_and_git_dir(path
, gitdir
.buf
, 0);
2199 strbuf_release(&gitdir
);
2201 /* make sure the index is clean as well */
2202 submodule_reset_index(path
, super_prefix
);
2205 if (old_head
&& (flags
& SUBMODULE_MOVE_HEAD_FORCE
)) {
2206 struct strbuf gitdir
= STRBUF_INIT
;
2207 submodule_name_to_gitdir(&gitdir
, the_repository
,
2209 connect_work_tree_and_git_dir(path
, gitdir
.buf
, 1);
2210 strbuf_release(&gitdir
);
2214 prepare_submodule_repo_env(&cp
.env
);
2220 strvec_pushl(&cp
.args
, "read-tree", "--recurse-submodules", NULL
);
2221 strvec_pushf(&cp
.args
, "--super-prefix=%s%s/",
2222 (super_prefix
? super_prefix
: ""), path
);
2224 if (flags
& SUBMODULE_MOVE_HEAD_DRY_RUN
)
2225 strvec_push(&cp
.args
, "-n");
2227 strvec_push(&cp
.args
, "-u");
2229 if (flags
& SUBMODULE_MOVE_HEAD_FORCE
)
2230 strvec_push(&cp
.args
, "--reset");
2232 strvec_push(&cp
.args
, "-m");
2234 if (!(flags
& SUBMODULE_MOVE_HEAD_FORCE
))
2235 strvec_push(&cp
.args
, old_head
? old_head
: empty_tree_oid_hex());
2237 strvec_push(&cp
.args
, new_head
? new_head
: empty_tree_oid_hex());
2239 if (run_command(&cp
)) {
2240 ret
= error(_("Submodule '%s' could not be updated."), path
);
2244 if (!(flags
& SUBMODULE_MOVE_HEAD_DRY_RUN
)) {
2246 child_process_init(&cp
);
2247 /* also set the HEAD accordingly */
2252 prepare_submodule_repo_env(&cp
.env
);
2253 strvec_pushl(&cp
.args
, "update-ref", "HEAD",
2254 "--no-deref", new_head
, NULL
);
2256 if (run_command(&cp
)) {
2261 struct strbuf sb
= STRBUF_INIT
;
2263 strbuf_addf(&sb
, "%s/.git", path
);
2264 unlink_or_warn(sb
.buf
);
2265 strbuf_release(&sb
);
2267 if (is_empty_dir(path
))
2268 rmdir_or_warn(path
);
2270 submodule_unset_core_worktree(sub
);
2277 int validate_submodule_git_dir(char *git_dir
, const char *submodule_name
)
2279 size_t len
= strlen(git_dir
), suffix_len
= strlen(submodule_name
);
2283 if (len
<= suffix_len
|| (p
= git_dir
+ len
- suffix_len
)[-1] != '/' ||
2284 strcmp(p
, submodule_name
))
2285 BUG("submodule name '%s' not a suffix of git dir '%s'",
2286 submodule_name
, git_dir
);
2289 * We prevent the contents of sibling submodules' git directories to
2292 * Example: having a submodule named `hippo` and another one named
2293 * `hippo/hooks` would result in the git directories
2294 * `.git/modules/hippo/` and `.git/modules/hippo/hooks/`, respectively,
2295 * but the latter directory is already designated to contain the hooks
2299 if (is_dir_sep(*p
)) {
2303 if (is_git_directory(git_dir
))
2308 return error(_("submodule git dir '%s' is "
2309 "inside git dir '%.*s'"),
2311 (int)(p
- git_dir
), git_dir
);
2318 int validate_submodule_path(const char *path
)
2320 char *p
= xstrdup(path
);
2325 for (i
= 0; !ret
&& p
[i
]; i
++) {
2326 if (!is_dir_sep(p
[i
]))
2331 /* allow missing components, but no symlinks */
2332 ret
= lstat(p
, &st
) || !S_ISLNK(st
.st_mode
) ? 0 : -1;
2335 error(_("expected '%.*s' in submodule path '%s' not to "
2336 "be a symbolic link"), i
, p
, p
);
2338 if (!lstat(p
, &st
) && S_ISLNK(st
.st_mode
))
2339 ret
= error(_("expected submodule path '%s' not to be a "
2340 "symbolic link"), p
);
2347 * Embeds a single submodules git directory into the superprojects git dir,
2350 static void relocate_single_git_dir_into_superproject(const char *path
,
2351 const char *super_prefix
)
2353 char *old_git_dir
= NULL
, *real_old_git_dir
= NULL
, *real_new_git_dir
= NULL
;
2354 struct strbuf new_gitdir
= STRBUF_INIT
;
2355 const struct submodule
*sub
;
2357 if (validate_submodule_path(path
) < 0)
2360 if (submodule_uses_worktrees(path
))
2361 die(_("relocate_gitdir for submodule '%s' with "
2362 "more than one worktree not supported"), path
);
2364 old_git_dir
= xstrfmt("%s/.git", path
);
2365 if (read_gitfile(old_git_dir
))
2366 /* If it is an actual gitfile, it doesn't need migration. */
2369 real_old_git_dir
= real_pathdup(old_git_dir
, 1);
2371 sub
= submodule_from_path(the_repository
, null_oid(), path
);
2373 die(_("could not lookup name for submodule '%s'"), path
);
2375 submodule_name_to_gitdir(&new_gitdir
, the_repository
, sub
->name
);
2376 if (validate_submodule_git_dir(new_gitdir
.buf
, sub
->name
) < 0)
2377 die(_("refusing to move '%s' into an existing git dir"),
2379 if (safe_create_leading_directories_const(new_gitdir
.buf
) < 0)
2380 die(_("could not create directory '%s'"), new_gitdir
.buf
);
2381 real_new_git_dir
= real_pathdup(new_gitdir
.buf
, 1);
2383 fprintf(stderr
, _("Migrating git directory of '%s%s' from\n'%s' to\n'%s'\n"),
2384 super_prefix
? super_prefix
: "", path
,
2385 real_old_git_dir
, real_new_git_dir
);
2387 relocate_gitdir(path
, real_old_git_dir
, real_new_git_dir
);
2390 free(real_old_git_dir
);
2391 free(real_new_git_dir
);
2392 strbuf_release(&new_gitdir
);
2395 static void absorb_git_dir_into_superproject_recurse(const char *path
,
2396 const char *super_prefix
)
2399 struct child_process cp
= CHILD_PROCESS_INIT
;
2401 if (validate_submodule_path(path
) < 0)
2407 strvec_pushl(&cp
.args
, "submodule--helper",
2408 "absorbgitdirs", NULL
);
2409 strvec_pushf(&cp
.args
, "--super-prefix=%s%s/", super_prefix
?
2410 super_prefix
: "", path
);
2412 prepare_submodule_repo_env(&cp
.env
);
2413 if (run_command(&cp
))
2414 die(_("could not recurse into submodule '%s'"), path
);
2418 * Migrate the git directory of the submodule given by path from
2419 * having its git directory within the working tree to the git dir nested
2420 * in its superprojects git dir under modules/.
2422 void absorb_git_dir_into_superproject(const char *path
,
2423 const char *super_prefix
)
2426 const char *sub_git_dir
;
2427 struct strbuf gitdir
= STRBUF_INIT
;
2429 if (validate_submodule_path(path
) < 0)
2432 strbuf_addf(&gitdir
, "%s/.git", path
);
2433 sub_git_dir
= resolve_gitdir_gently(gitdir
.buf
, &err_code
);
2435 /* Not populated? */
2437 const struct submodule
*sub
;
2438 struct strbuf sub_gitdir
= STRBUF_INIT
;
2440 if (err_code
== READ_GITFILE_ERR_STAT_FAILED
) {
2441 /* unpopulated as expected */
2442 strbuf_release(&gitdir
);
2446 if (err_code
!= READ_GITFILE_ERR_NOT_A_REPO
)
2447 /* We don't know what broke here. */
2448 read_gitfile_error_die(err_code
, path
, NULL
);
2451 * Maybe populated, but no git directory was found?
2452 * This can happen if the superproject is a submodule
2453 * itself and was just absorbed. The absorption of the
2454 * superproject did not rewrite the git file links yet,
2457 sub
= submodule_from_path(the_repository
, null_oid(), path
);
2459 die(_("could not lookup name for submodule '%s'"), path
);
2460 submodule_name_to_gitdir(&sub_gitdir
, the_repository
, sub
->name
);
2461 connect_work_tree_and_git_dir(path
, sub_gitdir
.buf
, 0);
2462 strbuf_release(&sub_gitdir
);
2464 /* Is it already absorbed into the superprojects git dir? */
2465 char *real_sub_git_dir
= real_pathdup(sub_git_dir
, 1);
2466 char *real_common_git_dir
= real_pathdup(get_git_common_dir(), 1);
2468 if (!starts_with(real_sub_git_dir
, real_common_git_dir
))
2469 relocate_single_git_dir_into_superproject(path
, super_prefix
);
2471 free(real_sub_git_dir
);
2472 free(real_common_git_dir
);
2474 strbuf_release(&gitdir
);
2476 absorb_git_dir_into_superproject_recurse(path
, super_prefix
);
2479 int get_superproject_working_tree(struct strbuf
*buf
)
2481 struct child_process cp
= CHILD_PROCESS_INIT
;
2482 struct strbuf sb
= STRBUF_INIT
;
2483 struct strbuf one_up
= STRBUF_INIT
;
2484 char *cwd
= xgetcwd();
2486 const char *subpath
;
2490 if (!is_inside_work_tree())
2493 * We might have a superproject, but it is harder
2498 if (!strbuf_realpath(&one_up
, "../", 0))
2501 subpath
= relative_path(cwd
, one_up
.buf
, &sb
);
2502 strbuf_release(&one_up
);
2504 prepare_submodule_repo_env(&cp
.env
);
2505 strvec_pop(&cp
.env
);
2507 strvec_pushl(&cp
.args
, "--literal-pathspecs", "-C", "..",
2508 "ls-files", "-z", "--stage", "--full-name", "--",
2517 if (start_command(&cp
))
2518 die(_("could not start ls-files in .."));
2520 len
= strbuf_read(&sb
, cp
.out
, PATH_MAX
);
2523 if (starts_with(sb
.buf
, "160000")) {
2525 int cwd_len
= strlen(cwd
);
2526 char *super_sub
, *super_wt
;
2529 * There is a superproject having this repo as a submodule.
2530 * The format is <mode> SP <hash> SP <stage> TAB <full name> \0,
2531 * We're only interested in the name after the tab.
2533 super_sub
= strchr(sb
.buf
, '\t') + 1;
2534 super_sub_len
= strlen(super_sub
);
2536 if (super_sub_len
> cwd_len
||
2537 strcmp(&cwd
[cwd_len
- super_sub_len
], super_sub
))
2538 BUG("returned path string doesn't match cwd?");
2540 super_wt
= xstrdup(cwd
);
2541 super_wt
[cwd_len
- super_sub_len
] = '\0';
2543 strbuf_realpath(buf
, super_wt
, 1);
2548 strbuf_release(&sb
);
2550 code
= finish_command(&cp
);
2553 /* '../' is not a git repository */
2555 if (code
== 0 && len
== 0)
2556 /* There is an unrelated git repository at '../' */
2559 die(_("ls-tree returned unexpected return code %d"), code
);
2565 * Put the gitdir for a submodule (given relative to the main
2566 * repository worktree) into `buf`, or return -1 on error.
2568 int submodule_to_gitdir(struct strbuf
*buf
, const char *submodule
)
2570 const struct submodule
*sub
;
2571 const char *git_dir
;
2574 if (validate_submodule_path(submodule
) < 0)
2578 strbuf_addstr(buf
, submodule
);
2579 strbuf_complete(buf
, '/');
2580 strbuf_addstr(buf
, ".git");
2582 git_dir
= read_gitfile(buf
->buf
);
2585 strbuf_addstr(buf
, git_dir
);
2587 if (!is_git_directory(buf
->buf
)) {
2588 sub
= submodule_from_path(the_repository
, null_oid(),
2595 submodule_name_to_gitdir(buf
, the_repository
, sub
->name
);
2602 void submodule_name_to_gitdir(struct strbuf
*buf
, struct repository
*r
,
2603 const char *submodule_name
)
2606 * NEEDSWORK: The current way of mapping a submodule's name to
2607 * its location in .git/modules/ has problems with some naming
2608 * schemes. For example, if a submodule is named "foo" and
2609 * another is named "foo/bar" (whether present in the same
2610 * superproject commit or not - the problem will arise if both
2611 * superproject commits have been checked out at any point in
2612 * time), or if two submodule names only have different cases in
2613 * a case-insensitive filesystem.
2615 * There are several solutions, including encoding the path in
2616 * some way, introducing a submodule.<name>.gitdir config in
2617 * .git/config (not .gitmodules) that allows overriding what the
2618 * gitdir of a submodule would be (and teach Git, upon noticing
2619 * a clash, to automatically determine a non-clashing name and
2620 * to write such a config), or introducing a
2621 * submodule.<name>.gitdir config in .gitmodules that repo
2622 * administrators can explicitly set. Nothing has been decided,
2623 * so for now, just append the name at the end of the path.
2625 strbuf_repo_git_path(buf
, r
, "modules/");
2626 strbuf_addstr(buf
, submodule_name
);