3 #include "repository.h"
5 #include "submodule-config.h"
11 #include "run-command.h"
14 #include "string-list.h"
15 #include "oid-array.h"
18 #include "thread-utils.h"
22 #include "parse-options.h"
23 #include "object-store.h"
24 #include "commit-reach.h"
26 static int config_update_recurse_submodules
= RECURSE_SUBMODULES_OFF
;
27 static int initialized_fetch_ref_tips
;
28 static struct oid_array ref_tips_before_fetch
;
29 static struct oid_array ref_tips_after_fetch
;
32 * Check if the .gitmodules file is unmerged. Parsing of the .gitmodules file
33 * will be disabled because we can't guess what might be configured in
34 * .gitmodules unless the user resolves the conflict.
36 int is_gitmodules_unmerged(struct index_state
*istate
)
38 int pos
= index_name_pos(istate
, GITMODULES_FILE
, strlen(GITMODULES_FILE
));
39 if (pos
< 0) { /* .gitmodules not found or isn't merged */
41 if (istate
->cache_nr
> pos
) { /* there is a .gitmodules */
42 const struct cache_entry
*ce
= istate
->cache
[pos
];
43 if (ce_namelen(ce
) == strlen(GITMODULES_FILE
) &&
44 !strcmp(ce
->name
, GITMODULES_FILE
))
53 * Check if the .gitmodules file is safe to write.
55 * Writing to the .gitmodules file requires that the file exists in the
56 * working tree or, if it doesn't, that a brand new .gitmodules file is going
57 * to be created (i.e. it's neither in the index nor in the current branch).
59 * It is not safe to write to .gitmodules if it's not in the working tree but
60 * it is in the index or in the current branch, because writing new values
61 * (and staging them) would blindly overwrite ALL the old content.
63 int is_writing_gitmodules_ok(void)
66 return file_exists(GITMODULES_FILE
) ||
67 (get_oid(GITMODULES_INDEX
, &oid
) < 0 && get_oid(GITMODULES_HEAD
, &oid
) < 0);
71 * Check if the .gitmodules file has unstaged modifications. This must be
72 * checked before allowing modifications to the .gitmodules file with the
73 * intention to stage them later, because when continuing we would stage the
74 * modifications the user didn't stage herself too. That might change in a
75 * future version when we learn to stage the changes we do ourselves without
76 * staging any previous modifications.
78 int is_staging_gitmodules_ok(struct index_state
*istate
)
80 int pos
= index_name_pos(istate
, GITMODULES_FILE
, strlen(GITMODULES_FILE
));
82 if ((pos
>= 0) && (pos
< istate
->cache_nr
)) {
84 if (lstat(GITMODULES_FILE
, &st
) == 0 &&
85 ie_modified(istate
, istate
->cache
[pos
], &st
, 0) & DATA_CHANGED
)
92 static int for_each_remote_ref_submodule(const char *submodule
,
93 each_ref_fn fn
, void *cb_data
)
95 return refs_for_each_remote_ref(get_submodule_ref_store(submodule
),
100 * Try to update the "path" entry in the "submodule.<name>" section of the
101 * .gitmodules file. Return 0 only if a .gitmodules file was found, a section
102 * with the correct path=<oldpath> setting was found and we could update it.
104 int update_path_in_gitmodules(const char *oldpath
, const char *newpath
)
106 struct strbuf entry
= STRBUF_INIT
;
107 const struct submodule
*submodule
;
110 if (!file_exists(GITMODULES_FILE
)) /* Do nothing without .gitmodules */
113 if (is_gitmodules_unmerged(the_repository
->index
))
114 die(_("Cannot change unmerged .gitmodules, resolve merge conflicts first"));
116 submodule
= submodule_from_path(the_repository
, null_oid(), oldpath
);
117 if (!submodule
|| !submodule
->name
) {
118 warning(_("Could not find section in .gitmodules where path=%s"), oldpath
);
121 strbuf_addstr(&entry
, "submodule.");
122 strbuf_addstr(&entry
, submodule
->name
);
123 strbuf_addstr(&entry
, ".path");
124 ret
= config_set_in_gitmodules_file_gently(entry
.buf
, newpath
);
125 strbuf_release(&entry
);
130 * Try to remove the "submodule.<name>" section from .gitmodules where the given
131 * path is configured. Return 0 only if a .gitmodules file was found, a section
132 * with the correct path=<path> setting was found and we could remove it.
134 int remove_path_from_gitmodules(const char *path
)
136 struct strbuf sect
= STRBUF_INIT
;
137 const struct submodule
*submodule
;
139 if (!file_exists(GITMODULES_FILE
)) /* Do nothing without .gitmodules */
142 if (is_gitmodules_unmerged(the_repository
->index
))
143 die(_("Cannot change unmerged .gitmodules, resolve merge conflicts first"));
145 submodule
= submodule_from_path(the_repository
, null_oid(), path
);
146 if (!submodule
|| !submodule
->name
) {
147 warning(_("Could not find section in .gitmodules where path=%s"), path
);
150 strbuf_addstr(§
, "submodule.");
151 strbuf_addstr(§
, submodule
->name
);
152 if (git_config_rename_section_in_file(GITMODULES_FILE
, sect
.buf
, NULL
) < 0) {
153 /* Maybe the user already did that, don't error out here */
154 warning(_("Could not remove .gitmodules entry for %s"), path
);
155 strbuf_release(§
);
158 strbuf_release(§
);
162 void stage_updated_gitmodules(struct index_state
*istate
)
164 if (add_file_to_index(istate
, GITMODULES_FILE
, 0))
165 die(_("staging updated .gitmodules failed"));
168 static struct string_list added_submodule_odb_paths
= STRING_LIST_INIT_NODUP
;
170 /* TODO: remove this function, use repo_submodule_init instead. */
171 int add_submodule_odb(const char *path
)
173 struct strbuf objects_directory
= STRBUF_INIT
;
176 ret
= strbuf_git_path_submodule(&objects_directory
, path
, "objects/");
179 if (!is_directory(objects_directory
.buf
)) {
183 string_list_insert(&added_submodule_odb_paths
,
184 strbuf_detach(&objects_directory
, NULL
));
186 strbuf_release(&objects_directory
);
190 void add_submodule_odb_by_path(const char *path
)
192 string_list_insert(&added_submodule_odb_paths
, xstrdup(path
));
195 int register_all_submodule_odb_as_alternates(void)
198 int ret
= added_submodule_odb_paths
.nr
;
200 for (i
= 0; i
< added_submodule_odb_paths
.nr
; i
++)
201 add_to_alternates_memory(added_submodule_odb_paths
.items
[i
].string
);
203 string_list_clear(&added_submodule_odb_paths
, 0);
204 if (git_env_bool("GIT_TEST_FATAL_REGISTER_SUBMODULE_ODB", 0))
205 BUG("register_all_submodule_odb_as_alternates() called");
210 void set_diffopt_flags_from_submodule_config(struct diff_options
*diffopt
,
213 const struct submodule
*submodule
= submodule_from_path(the_repository
,
220 key
= xstrfmt("submodule.%s.ignore", submodule
->name
);
221 if (repo_config_get_string_tmp(the_repository
, key
, &ignore
))
222 ignore
= submodule
->ignore
;
226 handle_ignore_submodules_arg(diffopt
, ignore
);
227 else if (is_gitmodules_unmerged(the_repository
->index
))
228 diffopt
->flags
.ignore_submodules
= 1;
232 /* Cheap function that only determines if we're interested in submodules at all */
233 int git_default_submodule_config(const char *var
, const char *value
, void *cb
)
235 if (!strcmp(var
, "submodule.recurse")) {
236 int v
= git_config_bool(var
, value
) ?
237 RECURSE_SUBMODULES_ON
: RECURSE_SUBMODULES_OFF
;
238 config_update_recurse_submodules
= v
;
243 int option_parse_recurse_submodules_worktree_updater(const struct option
*opt
,
244 const char *arg
, int unset
)
247 config_update_recurse_submodules
= RECURSE_SUBMODULES_OFF
;
251 config_update_recurse_submodules
=
252 parse_update_recurse_submodules_arg(opt
->long_name
,
255 config_update_recurse_submodules
= RECURSE_SUBMODULES_ON
;
261 * Determine if a submodule has been initialized at a given 'path'
264 * NEEDSWORK: Emit a warning if submodule.active exists, but is valueless,
265 * ie, the config looks like: "[submodule] active\n".
266 * Since that is an invalid pathspec, we should inform the user.
268 int is_submodule_active(struct repository
*repo
, const char *path
)
273 const struct string_list
*sl
;
274 const struct submodule
*module
;
276 module
= submodule_from_path(repo
, null_oid(), path
);
278 /* early return if there isn't a path->module mapping */
282 /* submodule.<name>.active is set */
283 key
= xstrfmt("submodule.%s.active", module
->name
);
284 if (!repo_config_get_bool(repo
, key
, &ret
)) {
290 /* submodule.active is set */
291 sl
= repo_config_get_value_multi(repo
, "submodule.active");
294 struct strvec args
= STRVEC_INIT
;
295 const struct string_list_item
*item
;
297 for_each_string_list_item(item
, sl
) {
298 strvec_push(&args
, item
->string
);
301 parse_pathspec(&ps
, 0, 0, NULL
, args
.v
);
302 ret
= match_pathspec(repo
->index
, &ps
, path
, strlen(path
), 0, NULL
, 1);
309 /* fallback to checking if the URL is set */
310 key
= xstrfmt("submodule.%s.url", module
->name
);
311 ret
= !repo_config_get_string(repo
, key
, &value
);
318 int is_submodule_populated_gently(const char *path
, int *return_error_code
)
321 char *gitdir
= xstrfmt("%s/.git", path
);
323 if (resolve_gitdir_gently(gitdir
, return_error_code
))
331 * Dies if the provided 'prefix' corresponds to an unpopulated submodule
333 void die_in_unpopulated_submodule(struct index_state
*istate
,
341 prefixlen
= strlen(prefix
);
343 for (i
= 0; i
< istate
->cache_nr
; i
++) {
344 struct cache_entry
*ce
= istate
->cache
[i
];
345 int ce_len
= ce_namelen(ce
);
347 if (!S_ISGITLINK(ce
->ce_mode
))
349 if (prefixlen
<= ce_len
)
351 if (strncmp(ce
->name
, prefix
, ce_len
))
353 if (prefix
[ce_len
] != '/')
356 die(_("in unpopulated submodule '%s'"), ce
->name
);
361 * Dies if any paths in the provided pathspec descends into a submodule
363 void die_path_inside_submodule(struct index_state
*istate
,
364 const struct pathspec
*ps
)
368 for (i
= 0; i
< istate
->cache_nr
; i
++) {
369 struct cache_entry
*ce
= istate
->cache
[i
];
370 int ce_len
= ce_namelen(ce
);
372 if (!S_ISGITLINK(ce
->ce_mode
))
375 for (j
= 0; j
< ps
->nr
; j
++) {
376 const struct pathspec_item
*item
= &ps
->items
[j
];
378 if (item
->len
<= ce_len
)
380 if (item
->match
[ce_len
] != '/')
382 if (strncmp(ce
->name
, item
->match
, ce_len
))
384 if (item
->len
== ce_len
+ 1)
387 die(_("Pathspec '%s' is in submodule '%.*s'"),
388 item
->original
, ce_len
, ce
->name
);
393 enum submodule_update_type
parse_submodule_update_type(const char *value
)
395 if (!strcmp(value
, "none"))
396 return SM_UPDATE_NONE
;
397 else if (!strcmp(value
, "checkout"))
398 return SM_UPDATE_CHECKOUT
;
399 else if (!strcmp(value
, "rebase"))
400 return SM_UPDATE_REBASE
;
401 else if (!strcmp(value
, "merge"))
402 return SM_UPDATE_MERGE
;
403 else if (*value
== '!')
404 return SM_UPDATE_COMMAND
;
406 return SM_UPDATE_UNSPECIFIED
;
409 int parse_submodule_update_strategy(const char *value
,
410 struct submodule_update_strategy
*dst
)
412 enum submodule_update_type type
;
414 free((void*)dst
->command
);
417 type
= parse_submodule_update_type(value
);
418 if (type
== SM_UPDATE_UNSPECIFIED
)
422 if (type
== SM_UPDATE_COMMAND
)
423 dst
->command
= xstrdup(value
+ 1);
428 const char *submodule_strategy_to_string(const struct submodule_update_strategy
*s
)
430 struct strbuf sb
= STRBUF_INIT
;
432 case SM_UPDATE_CHECKOUT
:
434 case SM_UPDATE_MERGE
:
436 case SM_UPDATE_REBASE
:
440 case SM_UPDATE_UNSPECIFIED
:
442 case SM_UPDATE_COMMAND
:
443 strbuf_addf(&sb
, "!%s", s
->command
);
444 return strbuf_detach(&sb
, NULL
);
449 void handle_ignore_submodules_arg(struct diff_options
*diffopt
,
452 diffopt
->flags
.ignore_submodule_set
= 1;
453 diffopt
->flags
.ignore_submodules
= 0;
454 diffopt
->flags
.ignore_untracked_in_submodules
= 0;
455 diffopt
->flags
.ignore_dirty_submodules
= 0;
457 if (!strcmp(arg
, "all"))
458 diffopt
->flags
.ignore_submodules
= 1;
459 else if (!strcmp(arg
, "untracked"))
460 diffopt
->flags
.ignore_untracked_in_submodules
= 1;
461 else if (!strcmp(arg
, "dirty"))
462 diffopt
->flags
.ignore_dirty_submodules
= 1;
463 else if (strcmp(arg
, "none"))
464 die(_("bad --ignore-submodules argument: %s"), arg
);
466 * Please update _git_status() in git-completion.bash when you
471 static int prepare_submodule_diff_summary(struct repository
*r
, struct rev_info
*rev
,
473 struct commit
*left
, struct commit
*right
,
474 struct commit_list
*merge_bases
)
476 struct commit_list
*list
;
478 repo_init_revisions(r
, rev
, NULL
);
479 setup_revisions(0, NULL
, rev
, NULL
);
481 rev
->first_parent_only
= 1;
482 left
->object
.flags
|= SYMMETRIC_LEFT
;
483 add_pending_object(rev
, &left
->object
, path
);
484 add_pending_object(rev
, &right
->object
, path
);
485 for (list
= merge_bases
; list
; list
= list
->next
) {
486 list
->item
->object
.flags
|= UNINTERESTING
;
487 add_pending_object(rev
, &list
->item
->object
,
488 oid_to_hex(&list
->item
->object
.oid
));
490 return prepare_revision_walk(rev
);
493 static void print_submodule_diff_summary(struct repository
*r
, struct rev_info
*rev
, struct diff_options
*o
)
495 static const char format
[] = " %m %s";
496 struct strbuf sb
= STRBUF_INIT
;
497 struct commit
*commit
;
499 while ((commit
= get_revision(rev
))) {
500 struct pretty_print_context ctx
= {0};
501 ctx
.date_mode
= rev
->date_mode
;
502 ctx
.output_encoding
= get_log_output_encoding();
503 strbuf_setlen(&sb
, 0);
504 repo_format_commit_message(r
, commit
, format
, &sb
,
506 strbuf_addch(&sb
, '\n');
507 if (commit
->object
.flags
& SYMMETRIC_LEFT
)
508 diff_emit_submodule_del(o
, sb
.buf
);
510 diff_emit_submodule_add(o
, sb
.buf
);
515 void prepare_submodule_repo_env(struct strvec
*out
)
517 prepare_other_repo_env(out
, DEFAULT_GIT_DIR_ENVIRONMENT
);
520 static void prepare_submodule_repo_env_in_gitdir(struct strvec
*out
)
522 prepare_other_repo_env(out
, ".");
526 * Initialize a repository struct for a submodule based on the provided 'path'.
528 * Returns the repository struct on success,
529 * NULL when the submodule is not present.
531 static struct repository
*open_submodule(const char *path
)
533 struct strbuf sb
= STRBUF_INIT
;
534 struct repository
*out
= xmalloc(sizeof(*out
));
536 if (submodule_to_gitdir(&sb
, path
) || repo_init(out
, sb
.buf
, NULL
)) {
542 /* Mark it as a submodule */
543 out
->submodule_prefix
= xstrdup(path
);
550 * Helper function to display the submodule header line prior to the full
553 * If it can locate the submodule git directory it will create a repository
554 * handle for the submodule and lookup both the left and right commits and
555 * put them into the left and right pointers.
557 static void show_submodule_header(struct diff_options
*o
,
559 struct object_id
*one
, struct object_id
*two
,
560 unsigned dirty_submodule
,
561 struct repository
*sub
,
562 struct commit
**left
, struct commit
**right
,
563 struct commit_list
**merge_bases
)
565 const char *message
= NULL
;
566 struct strbuf sb
= STRBUF_INIT
;
567 int fast_forward
= 0, fast_backward
= 0;
569 if (dirty_submodule
& DIRTY_SUBMODULE_UNTRACKED
)
570 diff_emit_submodule_untracked(o
, path
);
572 if (dirty_submodule
& DIRTY_SUBMODULE_MODIFIED
)
573 diff_emit_submodule_modified(o
, path
);
575 if (is_null_oid(one
))
576 message
= "(new submodule)";
577 else if (is_null_oid(two
))
578 message
= "(submodule deleted)";
582 message
= "(commits not present)";
587 * Attempt to lookup the commit references, and determine if this is
588 * a fast forward or fast backwards update.
590 *left
= lookup_commit_reference(sub
, one
);
591 *right
= lookup_commit_reference(sub
, two
);
594 * Warn about missing commits in the submodule project, but only if
597 if ((!is_null_oid(one
) && !*left
) ||
598 (!is_null_oid(two
) && !*right
))
599 message
= "(commits not present)";
601 *merge_bases
= repo_get_merge_bases(sub
, *left
, *right
);
603 if ((*merge_bases
)->item
== *left
)
605 else if ((*merge_bases
)->item
== *right
)
609 if (oideq(one
, two
)) {
615 strbuf_addf(&sb
, "Submodule %s ", path
);
616 strbuf_add_unique_abbrev(&sb
, one
, DEFAULT_ABBREV
);
617 strbuf_addstr(&sb
, (fast_backward
|| fast_forward
) ? ".." : "...");
618 strbuf_add_unique_abbrev(&sb
, two
, DEFAULT_ABBREV
);
620 strbuf_addf(&sb
, " %s\n", message
);
622 strbuf_addf(&sb
, "%s:\n", fast_backward
? " (rewind)" : "");
623 diff_emit_submodule_header(o
, sb
.buf
);
628 void show_submodule_diff_summary(struct diff_options
*o
, const char *path
,
629 struct object_id
*one
, struct object_id
*two
,
630 unsigned dirty_submodule
)
633 struct commit
*left
= NULL
, *right
= NULL
;
634 struct commit_list
*merge_bases
= NULL
;
635 struct repository
*sub
;
637 sub
= open_submodule(path
);
638 show_submodule_header(o
, path
, one
, two
, dirty_submodule
,
639 sub
, &left
, &right
, &merge_bases
);
642 * If we don't have both a left and a right pointer, there is no
643 * reason to try and display a summary. The header line should contain
644 * all the information the user needs.
646 if (!left
|| !right
|| !sub
)
649 /* Treat revision walker failure the same as missing commits */
650 if (prepare_submodule_diff_summary(sub
, &rev
, path
, left
, right
, merge_bases
)) {
651 diff_emit_submodule_error(o
, "(revision walker failed)\n");
655 print_submodule_diff_summary(sub
, &rev
, o
);
659 free_commit_list(merge_bases
);
660 clear_commit_marks(left
, ~0);
661 clear_commit_marks(right
, ~0);
668 void show_submodule_inline_diff(struct diff_options
*o
, const char *path
,
669 struct object_id
*one
, struct object_id
*two
,
670 unsigned dirty_submodule
)
672 const struct object_id
*old_oid
= the_hash_algo
->empty_tree
, *new_oid
= the_hash_algo
->empty_tree
;
673 struct commit
*left
= NULL
, *right
= NULL
;
674 struct commit_list
*merge_bases
= NULL
;
675 struct child_process cp
= CHILD_PROCESS_INIT
;
676 struct strbuf sb
= STRBUF_INIT
;
677 struct repository
*sub
;
679 sub
= open_submodule(path
);
680 show_submodule_header(o
, path
, one
, two
, dirty_submodule
,
681 sub
, &left
, &right
, &merge_bases
);
683 /* We need a valid left and right commit to display a difference */
684 if (!(left
|| is_null_oid(one
)) ||
685 !(right
|| is_null_oid(two
)))
698 /* TODO: other options may need to be passed here. */
699 strvec_pushl(&cp
.args
, "diff", "--submodule=diff", NULL
);
700 strvec_pushf(&cp
.args
, "--color=%s", want_color(o
->use_color
) ?
703 if (o
->flags
.reverse_diff
) {
704 strvec_pushf(&cp
.args
, "--src-prefix=%s%s/",
706 strvec_pushf(&cp
.args
, "--dst-prefix=%s%s/",
709 strvec_pushf(&cp
.args
, "--src-prefix=%s%s/",
711 strvec_pushf(&cp
.args
, "--dst-prefix=%s%s/",
714 strvec_push(&cp
.args
, oid_to_hex(old_oid
));
716 * If the submodule has modified content, we will diff against the
717 * work tree, under the assumption that the user has asked for the
718 * diff format and wishes to actually see all differences even if they
719 * haven't yet been committed to the submodule yet.
721 if (!(dirty_submodule
& DIRTY_SUBMODULE_MODIFIED
))
722 strvec_push(&cp
.args
, oid_to_hex(new_oid
));
724 prepare_submodule_repo_env(&cp
.env_array
);
726 if (!is_directory(path
)) {
727 /* fall back to absorbed git dir, if any */
730 cp
.dir
= sub
->gitdir
;
731 strvec_push(&cp
.env_array
, GIT_DIR_ENVIRONMENT
"=.");
732 strvec_push(&cp
.env_array
, GIT_WORK_TREE_ENVIRONMENT
"=.");
735 if (start_command(&cp
)) {
736 diff_emit_submodule_error(o
, "(diff failed)\n");
740 while (strbuf_getwholeline_fd(&sb
, cp
.out
, '\n') != EOF
)
741 diff_emit_submodule_pipethrough(o
, sb
.buf
, sb
.len
);
743 if (finish_command(&cp
))
744 diff_emit_submodule_error(o
, "(diff failed)\n");
749 free_commit_list(merge_bases
);
751 clear_commit_marks(left
, ~0);
753 clear_commit_marks(right
, ~0);
760 int should_update_submodules(void)
762 return config_update_recurse_submodules
== RECURSE_SUBMODULES_ON
;
765 const struct submodule
*submodule_from_ce(const struct cache_entry
*ce
)
767 if (!S_ISGITLINK(ce
->ce_mode
))
770 if (!should_update_submodules())
773 return submodule_from_path(the_repository
, null_oid(), ce
->name
);
776 static struct oid_array
*submodule_commits(struct string_list
*submodules
,
779 struct string_list_item
*item
;
781 item
= string_list_insert(submodules
, name
);
783 return (struct oid_array
*) item
->util
;
785 /* NEEDSWORK: should we have oid_array_init()? */
786 item
->util
= xcalloc(1, sizeof(struct oid_array
));
787 return (struct oid_array
*) item
->util
;
790 struct collect_changed_submodules_cb_data
{
791 struct repository
*repo
;
792 struct string_list
*changed
;
793 const struct object_id
*commit_oid
;
797 * this would normally be two functions: default_name_from_path() and
798 * path_from_default_name(). Since the default name is the same as
799 * the submodule path we can get away with just one function which only
800 * checks whether there is a submodule in the working directory at that
803 static const char *default_name_or_path(const char *path_or_name
)
807 if (!is_submodule_populated_gently(path_or_name
, &error_code
))
813 static void collect_changed_submodules_cb(struct diff_queue_struct
*q
,
814 struct diff_options
*options
,
817 struct collect_changed_submodules_cb_data
*me
= data
;
818 struct string_list
*changed
= me
->changed
;
819 const struct object_id
*commit_oid
= me
->commit_oid
;
822 for (i
= 0; i
< q
->nr
; i
++) {
823 struct diff_filepair
*p
= q
->queue
[i
];
824 struct oid_array
*commits
;
825 const struct submodule
*submodule
;
828 if (!S_ISGITLINK(p
->two
->mode
))
831 submodule
= submodule_from_path(me
->repo
,
832 commit_oid
, p
->two
->path
);
834 name
= submodule
->name
;
836 name
= default_name_or_path(p
->two
->path
);
837 /* make sure name does not collide with existing one */
839 submodule
= submodule_from_name(me
->repo
,
842 warning(_("Submodule in commit %s at path: "
843 "'%s' collides with a submodule named "
844 "the same. Skipping it."),
845 oid_to_hex(commit_oid
), p
->two
->path
);
853 commits
= submodule_commits(changed
, name
);
854 oid_array_append(commits
, &p
->two
->oid
);
859 * Collect the paths of submodules in 'changed' which have changed based on
860 * the revisions as specified in 'argv'. Each entry in 'changed' will also
861 * have a corresponding 'struct oid_array' (in the 'util' field) which lists
862 * what the submodule pointers were updated to during the change.
864 static void collect_changed_submodules(struct repository
*r
,
865 struct string_list
*changed
,
869 const struct commit
*commit
;
871 struct setup_revision_opt s_r_opt
= {
872 .assume_dashdash
= 1,
875 save_warning
= warn_on_object_refname_ambiguity
;
876 warn_on_object_refname_ambiguity
= 0;
877 repo_init_revisions(r
, &rev
, NULL
);
878 setup_revisions(argv
->nr
, argv
->v
, &rev
, &s_r_opt
);
879 warn_on_object_refname_ambiguity
= save_warning
;
880 if (prepare_revision_walk(&rev
))
881 die(_("revision walk setup failed"));
883 while ((commit
= get_revision(&rev
))) {
884 struct rev_info diff_rev
;
885 struct collect_changed_submodules_cb_data data
;
887 data
.changed
= changed
;
888 data
.commit_oid
= &commit
->object
.oid
;
890 repo_init_revisions(r
, &diff_rev
, NULL
);
891 diff_rev
.diffopt
.output_format
|= DIFF_FORMAT_CALLBACK
;
892 diff_rev
.diffopt
.format_callback
= collect_changed_submodules_cb
;
893 diff_rev
.diffopt
.format_callback_data
= &data
;
894 diff_rev
.dense_combined_merges
= 1;
895 diff_tree_combined_merge(commit
, &diff_rev
);
898 reset_revision_walk();
901 static void free_submodules_oids(struct string_list
*submodules
)
903 struct string_list_item
*item
;
904 for_each_string_list_item(item
, submodules
)
905 oid_array_clear((struct oid_array
*) item
->util
);
906 string_list_clear(submodules
, 1);
909 static int has_remote(const char *refname
, const struct object_id
*oid
,
910 int flags
, void *cb_data
)
915 static int append_oid_to_argv(const struct object_id
*oid
, void *data
)
917 struct strvec
*argv
= data
;
918 strvec_push(argv
, oid_to_hex(oid
));
922 struct has_commit_data
{
923 struct repository
*repo
;
928 static int check_has_commit(const struct object_id
*oid
, void *data
)
930 struct has_commit_data
*cb
= data
;
932 enum object_type type
= oid_object_info(cb
->repo
, oid
, NULL
);
939 * Object is missing or invalid. If invalid, an error message
940 * has already been printed.
945 die(_("submodule entry '%s' (%s) is a %s, not a commit"),
946 cb
->path
, oid_to_hex(oid
), type_name(type
));
950 static int submodule_has_commits(struct repository
*r
,
952 struct oid_array
*commits
)
954 struct has_commit_data has_commit
= { r
, 1, path
};
957 * Perform a cheap, but incorrect check for the existence of 'commits'.
958 * This is done by adding the submodule's object store to the in-core
959 * object store, and then querying for each commit's existence. If we
960 * do not have the commit object anywhere, there is no chance we have
961 * it in the object store of the correct submodule and have it
962 * reachable from a ref, so we can fail early without spawning rev-list
963 * which is expensive.
965 if (add_submodule_odb(path
))
968 oid_array_for_each_unique(commits
, check_has_commit
, &has_commit
);
970 if (has_commit
.result
) {
972 * Even if the submodule is checked out and the commit is
973 * present, make sure it exists in the submodule's object store
974 * and that it is reachable from a ref.
976 struct child_process cp
= CHILD_PROCESS_INIT
;
977 struct strbuf out
= STRBUF_INIT
;
979 strvec_pushl(&cp
.args
, "rev-list", "-n", "1", NULL
);
980 oid_array_for_each_unique(commits
, append_oid_to_argv
, &cp
.args
);
981 strvec_pushl(&cp
.args
, "--not", "--all", NULL
);
983 prepare_submodule_repo_env(&cp
.env_array
);
988 if (capture_command(&cp
, &out
, GIT_MAX_HEXSZ
+ 1) || out
.len
)
989 has_commit
.result
= 0;
991 strbuf_release(&out
);
994 return has_commit
.result
;
997 static int submodule_needs_pushing(struct repository
*r
,
999 struct oid_array
*commits
)
1001 if (!submodule_has_commits(r
, path
, commits
))
1003 * NOTE: We do consider it safe to return "no" here. The
1004 * correct answer would be "We do not know" instead of
1005 * "No push needed", but it is quite hard to change
1006 * the submodule pointer without having the submodule
1007 * around. If a user did however change the submodules
1008 * without having the submodule around, this indicates
1009 * an expert who knows what they are doing or a
1010 * maintainer integrating work from other people. In
1011 * both cases it should be safe to skip this check.
1015 if (for_each_remote_ref_submodule(path
, has_remote
, NULL
) > 0) {
1016 struct child_process cp
= CHILD_PROCESS_INIT
;
1017 struct strbuf buf
= STRBUF_INIT
;
1018 int needs_pushing
= 0;
1020 strvec_push(&cp
.args
, "rev-list");
1021 oid_array_for_each_unique(commits
, append_oid_to_argv
, &cp
.args
);
1022 strvec_pushl(&cp
.args
, "--not", "--remotes", "-n", "1" , NULL
);
1024 prepare_submodule_repo_env(&cp
.env_array
);
1029 if (start_command(&cp
))
1030 die(_("Could not run 'git rev-list <commits> --not --remotes -n 1' command in submodule %s"),
1032 if (strbuf_read(&buf
, cp
.out
, the_hash_algo
->hexsz
+ 1))
1034 finish_command(&cp
);
1036 strbuf_release(&buf
);
1037 return needs_pushing
;
1043 int find_unpushed_submodules(struct repository
*r
,
1044 struct oid_array
*commits
,
1045 const char *remotes_name
,
1046 struct string_list
*needs_pushing
)
1048 struct string_list submodules
= STRING_LIST_INIT_DUP
;
1049 struct string_list_item
*name
;
1050 struct strvec argv
= STRVEC_INIT
;
1052 /* argv.v[0] will be ignored by setup_revisions */
1053 strvec_push(&argv
, "find_unpushed_submodules");
1054 oid_array_for_each_unique(commits
, append_oid_to_argv
, &argv
);
1055 strvec_push(&argv
, "--not");
1056 strvec_pushf(&argv
, "--remotes=%s", remotes_name
);
1058 collect_changed_submodules(r
, &submodules
, &argv
);
1060 for_each_string_list_item(name
, &submodules
) {
1061 struct oid_array
*commits
= name
->util
;
1062 const struct submodule
*submodule
;
1063 const char *path
= NULL
;
1065 submodule
= submodule_from_name(r
, null_oid(), name
->string
);
1067 path
= submodule
->path
;
1069 path
= default_name_or_path(name
->string
);
1074 if (submodule_needs_pushing(r
, path
, commits
))
1075 string_list_insert(needs_pushing
, path
);
1078 free_submodules_oids(&submodules
);
1079 strvec_clear(&argv
);
1081 return needs_pushing
->nr
;
1084 static int push_submodule(const char *path
,
1085 const struct remote
*remote
,
1086 const struct refspec
*rs
,
1087 const struct string_list
*push_options
,
1090 if (for_each_remote_ref_submodule(path
, has_remote
, NULL
) > 0) {
1091 struct child_process cp
= CHILD_PROCESS_INIT
;
1092 strvec_push(&cp
.args
, "push");
1094 strvec_push(&cp
.args
, "--dry-run");
1096 if (push_options
&& push_options
->nr
) {
1097 const struct string_list_item
*item
;
1098 for_each_string_list_item(item
, push_options
)
1099 strvec_pushf(&cp
.args
, "--push-option=%s",
1103 if (remote
->origin
!= REMOTE_UNCONFIGURED
) {
1105 strvec_push(&cp
.args
, remote
->name
);
1106 for (i
= 0; i
< rs
->raw_nr
; i
++)
1107 strvec_push(&cp
.args
, rs
->raw
[i
]);
1110 prepare_submodule_repo_env(&cp
.env_array
);
1114 if (run_command(&cp
))
1123 * Perform a check in the submodule to see if the remote and refspec work.
1124 * Die if the submodule can't be pushed.
1126 static void submodule_push_check(const char *path
, const char *head
,
1127 const struct remote
*remote
,
1128 const struct refspec
*rs
)
1130 struct child_process cp
= CHILD_PROCESS_INIT
;
1133 strvec_push(&cp
.args
, "submodule--helper");
1134 strvec_push(&cp
.args
, "push-check");
1135 strvec_push(&cp
.args
, head
);
1136 strvec_push(&cp
.args
, remote
->name
);
1138 for (i
= 0; i
< rs
->raw_nr
; i
++)
1139 strvec_push(&cp
.args
, rs
->raw
[i
]);
1141 prepare_submodule_repo_env(&cp
.env_array
);
1148 * Simply indicate if 'submodule--helper push-check' failed.
1149 * More detailed error information will be provided by the
1152 if (run_command(&cp
))
1153 die(_("process for submodule '%s' failed"), path
);
1156 int push_unpushed_submodules(struct repository
*r
,
1157 struct oid_array
*commits
,
1158 const struct remote
*remote
,
1159 const struct refspec
*rs
,
1160 const struct string_list
*push_options
,
1164 struct string_list needs_pushing
= STRING_LIST_INIT_DUP
;
1166 if (!find_unpushed_submodules(r
, commits
,
1167 remote
->name
, &needs_pushing
))
1171 * Verify that the remote and refspec can be propagated to all
1172 * submodules. This check can be skipped if the remote and refspec
1173 * won't be propagated due to the remote being unconfigured (e.g. a URL
1174 * instead of a remote name).
1176 if (remote
->origin
!= REMOTE_UNCONFIGURED
) {
1178 struct object_id head_oid
;
1180 head
= resolve_refdup("HEAD", 0, &head_oid
, NULL
);
1182 die(_("Failed to resolve HEAD as a valid ref."));
1184 for (i
= 0; i
< needs_pushing
.nr
; i
++)
1185 submodule_push_check(needs_pushing
.items
[i
].string
,
1190 /* Actually push the submodules */
1191 for (i
= 0; i
< needs_pushing
.nr
; i
++) {
1192 const char *path
= needs_pushing
.items
[i
].string
;
1193 fprintf(stderr
, _("Pushing submodule '%s'\n"), path
);
1194 if (!push_submodule(path
, remote
, rs
,
1195 push_options
, dry_run
)) {
1196 fprintf(stderr
, _("Unable to push submodule '%s'\n"), path
);
1201 string_list_clear(&needs_pushing
, 0);
1206 static int append_oid_to_array(const char *ref
, const struct object_id
*oid
,
1207 int flags
, void *data
)
1209 struct oid_array
*array
= data
;
1210 oid_array_append(array
, oid
);
1214 void check_for_new_submodule_commits(struct object_id
*oid
)
1216 if (!initialized_fetch_ref_tips
) {
1217 for_each_ref(append_oid_to_array
, &ref_tips_before_fetch
);
1218 initialized_fetch_ref_tips
= 1;
1221 oid_array_append(&ref_tips_after_fetch
, oid
);
1224 static void calculate_changed_submodule_paths(struct repository
*r
,
1225 struct string_list
*changed_submodule_names
)
1227 struct strvec argv
= STRVEC_INIT
;
1228 struct string_list_item
*name
;
1230 /* No need to check if there are no submodules configured */
1231 if (!submodule_from_path(r
, NULL
, NULL
))
1234 strvec_push(&argv
, "--"); /* argv[0] program name */
1235 oid_array_for_each_unique(&ref_tips_after_fetch
,
1236 append_oid_to_argv
, &argv
);
1237 strvec_push(&argv
, "--not");
1238 oid_array_for_each_unique(&ref_tips_before_fetch
,
1239 append_oid_to_argv
, &argv
);
1242 * Collect all submodules (whether checked out or not) for which new
1243 * commits have been recorded upstream in "changed_submodule_names".
1245 collect_changed_submodules(r
, changed_submodule_names
, &argv
);
1247 for_each_string_list_item(name
, changed_submodule_names
) {
1248 struct oid_array
*commits
= name
->util
;
1249 const struct submodule
*submodule
;
1250 const char *path
= NULL
;
1252 submodule
= submodule_from_name(r
, null_oid(), name
->string
);
1254 path
= submodule
->path
;
1256 path
= default_name_or_path(name
->string
);
1261 if (submodule_has_commits(r
, path
, commits
)) {
1262 oid_array_clear(commits
);
1263 *name
->string
= '\0';
1267 string_list_remove_empty_items(changed_submodule_names
, 1);
1269 strvec_clear(&argv
);
1270 oid_array_clear(&ref_tips_before_fetch
);
1271 oid_array_clear(&ref_tips_after_fetch
);
1272 initialized_fetch_ref_tips
= 0;
1275 int submodule_touches_in_range(struct repository
*r
,
1276 struct object_id
*excl_oid
,
1277 struct object_id
*incl_oid
)
1279 struct string_list subs
= STRING_LIST_INIT_DUP
;
1280 struct strvec args
= STRVEC_INIT
;
1283 /* No need to check if there are no submodules configured */
1284 if (!submodule_from_path(r
, NULL
, NULL
))
1287 strvec_push(&args
, "--"); /* args[0] program name */
1288 strvec_push(&args
, oid_to_hex(incl_oid
));
1289 if (!is_null_oid(excl_oid
)) {
1290 strvec_push(&args
, "--not");
1291 strvec_push(&args
, oid_to_hex(excl_oid
));
1294 collect_changed_submodules(r
, &subs
, &args
);
1297 strvec_clear(&args
);
1299 free_submodules_oids(&subs
);
1303 struct submodule_parallel_fetch
{
1306 struct repository
*r
;
1308 int command_line_option
;
1313 struct string_list changed_submodule_names
;
1315 /* Pending fetches by OIDs */
1316 struct fetch_task
**oid_fetch_tasks
;
1317 int oid_fetch_tasks_nr
, oid_fetch_tasks_alloc
;
1319 struct strbuf submodules_with_errors
;
1321 #define SPF_INIT {0, STRVEC_INIT, NULL, NULL, 0, 0, 0, 0, \
1322 STRING_LIST_INIT_DUP, \
1323 NULL, 0, 0, STRBUF_INIT}
1325 static int get_fetch_recurse_config(const struct submodule
*submodule
,
1326 struct submodule_parallel_fetch
*spf
)
1328 if (spf
->command_line_option
!= RECURSE_SUBMODULES_DEFAULT
)
1329 return spf
->command_line_option
;
1335 int fetch_recurse
= submodule
->fetch_recurse
;
1336 key
= xstrfmt("submodule.%s.fetchRecurseSubmodules", submodule
->name
);
1337 if (!repo_config_get_string_tmp(spf
->r
, key
, &value
)) {
1338 fetch_recurse
= parse_fetch_recurse_submodules_arg(key
, value
);
1342 if (fetch_recurse
!= RECURSE_SUBMODULES_NONE
)
1343 /* local config overrules everything except commandline */
1344 return fetch_recurse
;
1347 return spf
->default_option
;
1351 * Fetch in progress (if callback data) or
1352 * pending (if in oid_fetch_tasks in struct submodule_parallel_fetch)
1355 struct repository
*repo
;
1356 const struct submodule
*sub
;
1357 unsigned free_sub
: 1; /* Do we need to free the submodule? */
1359 struct oid_array
*commits
; /* Ensure these commits are fetched */
1363 * When a submodule is not defined in .gitmodules, we cannot access it
1364 * via the regular submodule-config. Create a fake submodule, which we can
1367 static const struct submodule
*get_non_gitmodules_submodule(const char *path
)
1369 struct submodule
*ret
= NULL
;
1370 const char *name
= default_name_or_path(path
);
1375 ret
= xmalloc(sizeof(*ret
));
1376 memset(ret
, 0, sizeof(*ret
));
1380 return (const struct submodule
*) ret
;
1383 static struct fetch_task
*fetch_task_create(struct repository
*r
,
1386 struct fetch_task
*task
= xmalloc(sizeof(*task
));
1387 memset(task
, 0, sizeof(*task
));
1389 task
->sub
= submodule_from_path(r
, null_oid(), path
);
1392 * No entry in .gitmodules? Technically not a submodule,
1393 * but historically we supported repositories that happen to be
1394 * in-place where a gitlink is. Keep supporting them.
1396 task
->sub
= get_non_gitmodules_submodule(path
);
1408 static void fetch_task_release(struct fetch_task
*p
)
1411 free((void*)p
->sub
);
1416 repo_clear(p
->repo
);
1417 FREE_AND_NULL(p
->repo
);
1420 static struct repository
*get_submodule_repo_for(struct repository
*r
,
1423 struct repository
*ret
= xmalloc(sizeof(*ret
));
1425 if (repo_submodule_init(ret
, r
, path
, null_oid())) {
1433 static int get_next_submodule(struct child_process
*cp
,
1434 struct strbuf
*err
, void *data
, void **task_cb
)
1436 struct submodule_parallel_fetch
*spf
= data
;
1438 for (; spf
->count
< spf
->r
->index
->cache_nr
; spf
->count
++) {
1439 const struct cache_entry
*ce
= spf
->r
->index
->cache
[spf
->count
];
1440 const char *default_argv
;
1441 struct fetch_task
*task
;
1443 if (!S_ISGITLINK(ce
->ce_mode
))
1446 task
= fetch_task_create(spf
->r
, ce
->name
);
1450 switch (get_fetch_recurse_config(task
->sub
, spf
))
1453 case RECURSE_SUBMODULES_DEFAULT
:
1454 case RECURSE_SUBMODULES_ON_DEMAND
:
1456 !string_list_lookup(
1457 &spf
->changed_submodule_names
,
1460 default_argv
= "on-demand";
1462 case RECURSE_SUBMODULES_ON
:
1463 default_argv
= "yes";
1465 case RECURSE_SUBMODULES_OFF
:
1469 task
->repo
= get_submodule_repo_for(spf
->r
, task
->sub
->path
);
1471 struct strbuf submodule_prefix
= STRBUF_INIT
;
1472 child_process_init(cp
);
1473 cp
->dir
= task
->repo
->gitdir
;
1474 prepare_submodule_repo_env_in_gitdir(&cp
->env_array
);
1477 strbuf_addf(err
, _("Fetching submodule %s%s\n"),
1478 spf
->prefix
, ce
->name
);
1479 strvec_init(&cp
->args
);
1480 strvec_pushv(&cp
->args
, spf
->args
.v
);
1481 strvec_push(&cp
->args
, default_argv
);
1482 strvec_push(&cp
->args
, "--submodule-prefix");
1484 strbuf_addf(&submodule_prefix
, "%s%s/",
1487 strvec_push(&cp
->args
, submodule_prefix
.buf
);
1492 strbuf_release(&submodule_prefix
);
1495 struct strbuf empty_submodule_path
= STRBUF_INIT
;
1497 fetch_task_release(task
);
1501 * An empty directory is normal,
1502 * the submodule is not initialized
1504 strbuf_addf(&empty_submodule_path
, "%s/%s/",
1507 if (S_ISGITLINK(ce
->ce_mode
) &&
1508 !is_empty_dir(empty_submodule_path
.buf
)) {
1511 _("Could not access submodule '%s'\n"),
1514 strbuf_release(&empty_submodule_path
);
1518 if (spf
->oid_fetch_tasks_nr
) {
1519 struct fetch_task
*task
=
1520 spf
->oid_fetch_tasks
[spf
->oid_fetch_tasks_nr
- 1];
1521 struct strbuf submodule_prefix
= STRBUF_INIT
;
1522 spf
->oid_fetch_tasks_nr
--;
1524 strbuf_addf(&submodule_prefix
, "%s%s/",
1525 spf
->prefix
, task
->sub
->path
);
1527 child_process_init(cp
);
1528 prepare_submodule_repo_env_in_gitdir(&cp
->env_array
);
1530 cp
->dir
= task
->repo
->gitdir
;
1532 strvec_init(&cp
->args
);
1533 strvec_pushv(&cp
->args
, spf
->args
.v
);
1534 strvec_push(&cp
->args
, "on-demand");
1535 strvec_push(&cp
->args
, "--submodule-prefix");
1536 strvec_push(&cp
->args
, submodule_prefix
.buf
);
1538 /* NEEDSWORK: have get_default_remote from submodule--helper */
1539 strvec_push(&cp
->args
, "origin");
1540 oid_array_for_each_unique(task
->commits
,
1541 append_oid_to_argv
, &cp
->args
);
1544 strbuf_release(&submodule_prefix
);
1551 static int fetch_start_failure(struct strbuf
*err
,
1552 void *cb
, void *task_cb
)
1554 struct submodule_parallel_fetch
*spf
= cb
;
1555 struct fetch_task
*task
= task_cb
;
1559 fetch_task_release(task
);
1563 static int commit_missing_in_sub(const struct object_id
*oid
, void *data
)
1565 struct repository
*subrepo
= data
;
1567 enum object_type type
= oid_object_info(subrepo
, oid
, NULL
);
1569 return type
!= OBJ_COMMIT
;
1572 static int fetch_finish(int retvalue
, struct strbuf
*err
,
1573 void *cb
, void *task_cb
)
1575 struct submodule_parallel_fetch
*spf
= cb
;
1576 struct fetch_task
*task
= task_cb
;
1578 struct string_list_item
*it
;
1579 struct oid_array
*commits
;
1581 if (!task
|| !task
->sub
)
1582 BUG("callback cookie bogus");
1586 * NEEDSWORK: This indicates that the overall fetch
1587 * failed, even though there may be a subsequent fetch
1588 * by commit hash that might work. It may be a good
1589 * idea to not indicate failure in this case, and only
1590 * indicate failure if the subsequent fetch fails.
1594 strbuf_addf(&spf
->submodules_with_errors
, "\t%s\n",
1598 /* Is this the second time we process this submodule? */
1602 it
= string_list_lookup(&spf
->changed_submodule_names
, task
->sub
->name
);
1604 /* Could be an unchanged submodule, not contained in the list */
1608 oid_array_filter(commits
,
1609 commit_missing_in_sub
,
1612 /* Are there commits we want, but do not exist? */
1614 task
->commits
= commits
;
1615 ALLOC_GROW(spf
->oid_fetch_tasks
,
1616 spf
->oid_fetch_tasks_nr
+ 1,
1617 spf
->oid_fetch_tasks_alloc
);
1618 spf
->oid_fetch_tasks
[spf
->oid_fetch_tasks_nr
] = task
;
1619 spf
->oid_fetch_tasks_nr
++;
1624 fetch_task_release(task
);
1629 int fetch_populated_submodules(struct repository
*r
,
1630 const struct strvec
*options
,
1631 const char *prefix
, int command_line_option
,
1633 int quiet
, int max_parallel_jobs
)
1636 struct submodule_parallel_fetch spf
= SPF_INIT
;
1639 spf
.command_line_option
= command_line_option
;
1640 spf
.default_option
= default_option
;
1642 spf
.prefix
= prefix
;
1647 if (repo_read_index(r
) < 0)
1648 die(_("index file corrupt"));
1650 strvec_push(&spf
.args
, "fetch");
1651 for (i
= 0; i
< options
->nr
; i
++)
1652 strvec_push(&spf
.args
, options
->v
[i
]);
1653 strvec_push(&spf
.args
, "--recurse-submodules-default");
1654 /* default value, "--submodule-prefix" and its value are added later */
1656 calculate_changed_submodule_paths(r
, &spf
.changed_submodule_names
);
1657 string_list_sort(&spf
.changed_submodule_names
);
1658 run_processes_parallel_tr2(max_parallel_jobs
,
1660 fetch_start_failure
,
1663 "submodule", "parallel/fetch");
1665 if (spf
.submodules_with_errors
.len
> 0)
1666 fprintf(stderr
, _("Errors during submodule fetch:\n%s"),
1667 spf
.submodules_with_errors
.buf
);
1670 strvec_clear(&spf
.args
);
1672 free_submodules_oids(&spf
.changed_submodule_names
);
1676 unsigned is_submodule_modified(const char *path
, int ignore_untracked
)
1678 struct child_process cp
= CHILD_PROCESS_INIT
;
1679 struct strbuf buf
= STRBUF_INIT
;
1681 unsigned dirty_submodule
= 0;
1682 const char *git_dir
;
1683 int ignore_cp_exit_code
= 0;
1685 strbuf_addf(&buf
, "%s/.git", path
);
1686 git_dir
= read_gitfile(buf
.buf
);
1689 if (!is_git_directory(git_dir
)) {
1690 if (is_directory(git_dir
))
1691 die(_("'%s' not recognized as a git repository"), git_dir
);
1692 strbuf_release(&buf
);
1693 /* The submodule is not checked out, so it is not modified */
1698 strvec_pushl(&cp
.args
, "status", "--porcelain=2", NULL
);
1699 if (ignore_untracked
)
1700 strvec_push(&cp
.args
, "-uno");
1702 prepare_submodule_repo_env(&cp
.env_array
);
1707 if (start_command(&cp
))
1708 die(_("Could not run 'git status --porcelain=2' in submodule %s"), path
);
1710 fp
= xfdopen(cp
.out
, "r");
1711 while (strbuf_getwholeline(&buf
, fp
, '\n') != EOF
) {
1712 /* regular untracked files */
1713 if (buf
.buf
[0] == '?')
1714 dirty_submodule
|= DIRTY_SUBMODULE_UNTRACKED
;
1716 if (buf
.buf
[0] == 'u' ||
1717 buf
.buf
[0] == '1' ||
1718 buf
.buf
[0] == '2') {
1719 /* T = line type, XY = status, SSSS = submodule state */
1720 if (buf
.len
< strlen("T XY SSSS"))
1721 BUG("invalid status --porcelain=2 line %s",
1724 if (buf
.buf
[5] == 'S' && buf
.buf
[8] == 'U')
1725 /* nested untracked file */
1726 dirty_submodule
|= DIRTY_SUBMODULE_UNTRACKED
;
1728 if (buf
.buf
[0] == 'u' ||
1729 buf
.buf
[0] == '2' ||
1730 memcmp(buf
.buf
+ 5, "S..U", 4))
1732 dirty_submodule
|= DIRTY_SUBMODULE_MODIFIED
;
1735 if ((dirty_submodule
& DIRTY_SUBMODULE_MODIFIED
) &&
1736 ((dirty_submodule
& DIRTY_SUBMODULE_UNTRACKED
) ||
1737 ignore_untracked
)) {
1739 * We're not interested in any further information from
1740 * the child any more, neither output nor its exit code.
1742 ignore_cp_exit_code
= 1;
1748 if (finish_command(&cp
) && !ignore_cp_exit_code
)
1749 die(_("'git status --porcelain=2' failed in submodule %s"), path
);
1751 strbuf_release(&buf
);
1752 return dirty_submodule
;
1755 int submodule_uses_gitfile(const char *path
)
1757 struct child_process cp
= CHILD_PROCESS_INIT
;
1758 struct strbuf buf
= STRBUF_INIT
;
1759 const char *git_dir
;
1761 strbuf_addf(&buf
, "%s/.git", path
);
1762 git_dir
= read_gitfile(buf
.buf
);
1764 strbuf_release(&buf
);
1767 strbuf_release(&buf
);
1769 /* Now test that all nested submodules use a gitfile too */
1770 strvec_pushl(&cp
.args
,
1771 "submodule", "foreach", "--quiet", "--recursive",
1772 "test -f .git", NULL
);
1774 prepare_submodule_repo_env(&cp
.env_array
);
1780 if (run_command(&cp
))
1787 * Check if it is a bad idea to remove a submodule, i.e. if we'd lose data
1790 * Return 1 if we'd lose data, return 0 if the removal is fine,
1791 * and negative values for errors.
1793 int bad_to_remove_submodule(const char *path
, unsigned flags
)
1796 struct child_process cp
= CHILD_PROCESS_INIT
;
1797 struct strbuf buf
= STRBUF_INIT
;
1800 if (!file_exists(path
) || is_empty_dir(path
))
1803 if (!submodule_uses_gitfile(path
))
1806 strvec_pushl(&cp
.args
, "status", "--porcelain",
1807 "--ignore-submodules=none", NULL
);
1809 if (flags
& SUBMODULE_REMOVAL_IGNORE_UNTRACKED
)
1810 strvec_push(&cp
.args
, "-uno");
1812 strvec_push(&cp
.args
, "-uall");
1814 if (!(flags
& SUBMODULE_REMOVAL_IGNORE_IGNORED_UNTRACKED
))
1815 strvec_push(&cp
.args
, "--ignored");
1817 prepare_submodule_repo_env(&cp
.env_array
);
1822 if (start_command(&cp
)) {
1823 if (flags
& SUBMODULE_REMOVAL_DIE_ON_ERROR
)
1824 die(_("could not start 'git status' in submodule '%s'"),
1830 len
= strbuf_read(&buf
, cp
.out
, 1024);
1835 if (finish_command(&cp
)) {
1836 if (flags
& SUBMODULE_REMOVAL_DIE_ON_ERROR
)
1837 die(_("could not run 'git status' in submodule '%s'"),
1842 strbuf_release(&buf
);
1846 void submodule_unset_core_worktree(const struct submodule
*sub
)
1848 struct strbuf config_path
= STRBUF_INIT
;
1850 submodule_name_to_gitdir(&config_path
, the_repository
, sub
->name
);
1851 strbuf_addstr(&config_path
, "/config");
1853 if (git_config_set_in_file_gently(config_path
.buf
, "core.worktree", NULL
))
1854 warning(_("Could not unset core.worktree setting in submodule '%s'"),
1857 strbuf_release(&config_path
);
1860 static const char *get_super_prefix_or_empty(void)
1862 const char *s
= get_super_prefix();
1868 static int submodule_has_dirty_index(const struct submodule
*sub
)
1870 struct child_process cp
= CHILD_PROCESS_INIT
;
1872 prepare_submodule_repo_env(&cp
.env_array
);
1875 strvec_pushl(&cp
.args
, "diff-index", "--quiet",
1876 "--cached", "HEAD", NULL
);
1880 if (start_command(&cp
))
1881 die(_("could not recurse into submodule '%s'"), sub
->path
);
1883 return finish_command(&cp
);
1886 static void submodule_reset_index(const char *path
)
1888 struct child_process cp
= CHILD_PROCESS_INIT
;
1889 prepare_submodule_repo_env(&cp
.env_array
);
1895 strvec_pushf(&cp
.args
, "--super-prefix=%s%s/",
1896 get_super_prefix_or_empty(), path
);
1897 strvec_pushl(&cp
.args
, "read-tree", "-u", "--reset", NULL
);
1899 strvec_push(&cp
.args
, empty_tree_oid_hex());
1901 if (run_command(&cp
))
1902 die(_("could not reset submodule index"));
1906 * Moves a submodule at a given path from a given head to another new head.
1907 * For edge cases (a submodule coming into existence or removing a submodule)
1908 * pass NULL for old or new respectively.
1910 int submodule_move_head(const char *path
,
1911 const char *old_head
,
1912 const char *new_head
,
1916 struct child_process cp
= CHILD_PROCESS_INIT
;
1917 const struct submodule
*sub
;
1918 int *error_code_ptr
, error_code
;
1920 if (!is_submodule_active(the_repository
, path
))
1923 if (flags
& SUBMODULE_MOVE_HEAD_FORCE
)
1925 * Pass non NULL pointer to is_submodule_populated_gently
1926 * to prevent die()-ing. We'll use connect_work_tree_and_git_dir
1927 * to fixup the submodule in the force case later.
1929 error_code_ptr
= &error_code
;
1931 error_code_ptr
= NULL
;
1933 if (old_head
&& !is_submodule_populated_gently(path
, error_code_ptr
))
1936 sub
= submodule_from_path(the_repository
, null_oid(), path
);
1939 BUG("could not get submodule information for '%s'", path
);
1941 if (old_head
&& !(flags
& SUBMODULE_MOVE_HEAD_FORCE
)) {
1942 /* Check if the submodule has a dirty index. */
1943 if (submodule_has_dirty_index(sub
))
1944 return error(_("submodule '%s' has dirty index"), path
);
1947 if (!(flags
& SUBMODULE_MOVE_HEAD_DRY_RUN
)) {
1949 if (!submodule_uses_gitfile(path
))
1950 absorb_git_dir_into_superproject(path
,
1951 ABSORB_GITDIR_RECURSE_SUBMODULES
);
1953 struct strbuf gitdir
= STRBUF_INIT
;
1954 submodule_name_to_gitdir(&gitdir
, the_repository
,
1956 connect_work_tree_and_git_dir(path
, gitdir
.buf
, 0);
1957 strbuf_release(&gitdir
);
1959 /* make sure the index is clean as well */
1960 submodule_reset_index(path
);
1963 if (old_head
&& (flags
& SUBMODULE_MOVE_HEAD_FORCE
)) {
1964 struct strbuf gitdir
= STRBUF_INIT
;
1965 submodule_name_to_gitdir(&gitdir
, the_repository
,
1967 connect_work_tree_and_git_dir(path
, gitdir
.buf
, 1);
1968 strbuf_release(&gitdir
);
1972 prepare_submodule_repo_env(&cp
.env_array
);
1978 strvec_pushf(&cp
.args
, "--super-prefix=%s%s/",
1979 get_super_prefix_or_empty(), path
);
1980 strvec_pushl(&cp
.args
, "read-tree", "--recurse-submodules", NULL
);
1982 if (flags
& SUBMODULE_MOVE_HEAD_DRY_RUN
)
1983 strvec_push(&cp
.args
, "-n");
1985 strvec_push(&cp
.args
, "-u");
1987 if (flags
& SUBMODULE_MOVE_HEAD_FORCE
)
1988 strvec_push(&cp
.args
, "--reset");
1990 strvec_push(&cp
.args
, "-m");
1992 if (!(flags
& SUBMODULE_MOVE_HEAD_FORCE
))
1993 strvec_push(&cp
.args
, old_head
? old_head
: empty_tree_oid_hex());
1995 strvec_push(&cp
.args
, new_head
? new_head
: empty_tree_oid_hex());
1997 if (run_command(&cp
)) {
1998 ret
= error(_("Submodule '%s' could not be updated."), path
);
2002 if (!(flags
& SUBMODULE_MOVE_HEAD_DRY_RUN
)) {
2004 child_process_init(&cp
);
2005 /* also set the HEAD accordingly */
2010 prepare_submodule_repo_env(&cp
.env_array
);
2011 strvec_pushl(&cp
.args
, "update-ref", "HEAD",
2012 "--no-deref", new_head
, NULL
);
2014 if (run_command(&cp
)) {
2019 struct strbuf sb
= STRBUF_INIT
;
2021 strbuf_addf(&sb
, "%s/.git", path
);
2022 unlink_or_warn(sb
.buf
);
2023 strbuf_release(&sb
);
2025 if (is_empty_dir(path
))
2026 rmdir_or_warn(path
);
2028 submodule_unset_core_worktree(sub
);
2035 int validate_submodule_git_dir(char *git_dir
, const char *submodule_name
)
2037 size_t len
= strlen(git_dir
), suffix_len
= strlen(submodule_name
);
2041 if (len
<= suffix_len
|| (p
= git_dir
+ len
- suffix_len
)[-1] != '/' ||
2042 strcmp(p
, submodule_name
))
2043 BUG("submodule name '%s' not a suffix of git dir '%s'",
2044 submodule_name
, git_dir
);
2047 * We prevent the contents of sibling submodules' git directories to
2050 * Example: having a submodule named `hippo` and another one named
2051 * `hippo/hooks` would result in the git directories
2052 * `.git/modules/hippo/` and `.git/modules/hippo/hooks/`, respectively,
2053 * but the latter directory is already designated to contain the hooks
2057 if (is_dir_sep(*p
)) {
2061 if (is_git_directory(git_dir
))
2066 return error(_("submodule git dir '%s' is "
2067 "inside git dir '%.*s'"),
2069 (int)(p
- git_dir
), git_dir
);
2077 * Embeds a single submodules git directory into the superprojects git dir,
2080 static void relocate_single_git_dir_into_superproject(const char *path
)
2082 char *old_git_dir
= NULL
, *real_old_git_dir
= NULL
, *real_new_git_dir
= NULL
;
2083 struct strbuf new_gitdir
= STRBUF_INIT
;
2084 const struct submodule
*sub
;
2086 if (submodule_uses_worktrees(path
))
2087 die(_("relocate_gitdir for submodule '%s' with "
2088 "more than one worktree not supported"), path
);
2090 old_git_dir
= xstrfmt("%s/.git", path
);
2091 if (read_gitfile(old_git_dir
))
2092 /* If it is an actual gitfile, it doesn't need migration. */
2095 real_old_git_dir
= real_pathdup(old_git_dir
, 1);
2097 sub
= submodule_from_path(the_repository
, null_oid(), path
);
2099 die(_("could not lookup name for submodule '%s'"), path
);
2101 submodule_name_to_gitdir(&new_gitdir
, the_repository
, sub
->name
);
2102 if (validate_submodule_git_dir(new_gitdir
.buf
, sub
->name
) < 0)
2103 die(_("refusing to move '%s' into an existing git dir"),
2105 if (safe_create_leading_directories_const(new_gitdir
.buf
) < 0)
2106 die(_("could not create directory '%s'"), new_gitdir
.buf
);
2107 real_new_git_dir
= real_pathdup(new_gitdir
.buf
, 1);
2109 fprintf(stderr
, _("Migrating git directory of '%s%s' from\n'%s' to\n'%s'\n"),
2110 get_super_prefix_or_empty(), path
,
2111 real_old_git_dir
, real_new_git_dir
);
2113 relocate_gitdir(path
, real_old_git_dir
, real_new_git_dir
);
2116 free(real_old_git_dir
);
2117 free(real_new_git_dir
);
2118 strbuf_release(&new_gitdir
);
2122 * Migrate the git directory of the submodule given by path from
2123 * having its git directory within the working tree to the git dir nested
2124 * in its superprojects git dir under modules/.
2126 void absorb_git_dir_into_superproject(const char *path
,
2130 const char *sub_git_dir
;
2131 struct strbuf gitdir
= STRBUF_INIT
;
2132 strbuf_addf(&gitdir
, "%s/.git", path
);
2133 sub_git_dir
= resolve_gitdir_gently(gitdir
.buf
, &err_code
);
2135 /* Not populated? */
2137 const struct submodule
*sub
;
2138 struct strbuf sub_gitdir
= STRBUF_INIT
;
2140 if (err_code
== READ_GITFILE_ERR_STAT_FAILED
) {
2141 /* unpopulated as expected */
2142 strbuf_release(&gitdir
);
2146 if (err_code
!= READ_GITFILE_ERR_NOT_A_REPO
)
2147 /* We don't know what broke here. */
2148 read_gitfile_error_die(err_code
, path
, NULL
);
2151 * Maybe populated, but no git directory was found?
2152 * This can happen if the superproject is a submodule
2153 * itself and was just absorbed. The absorption of the
2154 * superproject did not rewrite the git file links yet,
2157 sub
= submodule_from_path(the_repository
, null_oid(), path
);
2159 die(_("could not lookup name for submodule '%s'"), path
);
2160 submodule_name_to_gitdir(&sub_gitdir
, the_repository
, sub
->name
);
2161 connect_work_tree_and_git_dir(path
, sub_gitdir
.buf
, 0);
2162 strbuf_release(&sub_gitdir
);
2164 /* Is it already absorbed into the superprojects git dir? */
2165 char *real_sub_git_dir
= real_pathdup(sub_git_dir
, 1);
2166 char *real_common_git_dir
= real_pathdup(get_git_common_dir(), 1);
2168 if (!starts_with(real_sub_git_dir
, real_common_git_dir
))
2169 relocate_single_git_dir_into_superproject(path
);
2171 free(real_sub_git_dir
);
2172 free(real_common_git_dir
);
2174 strbuf_release(&gitdir
);
2176 if (flags
& ABSORB_GITDIR_RECURSE_SUBMODULES
) {
2177 struct child_process cp
= CHILD_PROCESS_INIT
;
2178 struct strbuf sb
= STRBUF_INIT
;
2180 if (flags
& ~ABSORB_GITDIR_RECURSE_SUBMODULES
)
2181 BUG("we don't know how to pass the flags down?");
2183 strbuf_addstr(&sb
, get_super_prefix_or_empty());
2184 strbuf_addstr(&sb
, path
);
2185 strbuf_addch(&sb
, '/');
2190 strvec_pushl(&cp
.args
, "--super-prefix", sb
.buf
,
2191 "submodule--helper",
2192 "absorb-git-dirs", NULL
);
2193 prepare_submodule_repo_env(&cp
.env_array
);
2194 if (run_command(&cp
))
2195 die(_("could not recurse into submodule '%s'"), path
);
2197 strbuf_release(&sb
);
2201 int get_superproject_working_tree(struct strbuf
*buf
)
2203 struct child_process cp
= CHILD_PROCESS_INIT
;
2204 struct strbuf sb
= STRBUF_INIT
;
2205 struct strbuf one_up
= STRBUF_INIT
;
2206 const char *cwd
= xgetcwd();
2208 const char *subpath
;
2212 if (!is_inside_work_tree())
2215 * We might have a superproject, but it is harder
2220 if (!strbuf_realpath(&one_up
, "../", 0))
2223 subpath
= relative_path(cwd
, one_up
.buf
, &sb
);
2224 strbuf_release(&one_up
);
2226 prepare_submodule_repo_env(&cp
.env_array
);
2227 strvec_pop(&cp
.env_array
);
2229 strvec_pushl(&cp
.args
, "--literal-pathspecs", "-C", "..",
2230 "ls-files", "-z", "--stage", "--full-name", "--",
2239 if (start_command(&cp
))
2240 die(_("could not start ls-files in .."));
2242 len
= strbuf_read(&sb
, cp
.out
, PATH_MAX
);
2245 if (starts_with(sb
.buf
, "160000")) {
2247 int cwd_len
= strlen(cwd
);
2248 char *super_sub
, *super_wt
;
2251 * There is a superproject having this repo as a submodule.
2252 * The format is <mode> SP <hash> SP <stage> TAB <full name> \0,
2253 * We're only interested in the name after the tab.
2255 super_sub
= strchr(sb
.buf
, '\t') + 1;
2256 super_sub_len
= strlen(super_sub
);
2258 if (super_sub_len
> cwd_len
||
2259 strcmp(&cwd
[cwd_len
- super_sub_len
], super_sub
))
2260 BUG("returned path string doesn't match cwd?");
2262 super_wt
= xstrdup(cwd
);
2263 super_wt
[cwd_len
- super_sub_len
] = '\0';
2265 strbuf_realpath(buf
, super_wt
, 1);
2269 strbuf_release(&sb
);
2271 code
= finish_command(&cp
);
2274 /* '../' is not a git repository */
2276 if (code
== 0 && len
== 0)
2277 /* There is an unrelated git repository at '../' */
2280 die(_("ls-tree returned unexpected return code %d"), code
);
2286 * Put the gitdir for a submodule (given relative to the main
2287 * repository worktree) into `buf`, or return -1 on error.
2289 int submodule_to_gitdir(struct strbuf
*buf
, const char *submodule
)
2291 const struct submodule
*sub
;
2292 const char *git_dir
;
2296 strbuf_addstr(buf
, submodule
);
2297 strbuf_complete(buf
, '/');
2298 strbuf_addstr(buf
, ".git");
2300 git_dir
= read_gitfile(buf
->buf
);
2303 strbuf_addstr(buf
, git_dir
);
2305 if (!is_git_directory(buf
->buf
)) {
2306 sub
= submodule_from_path(the_repository
, null_oid(),
2313 submodule_name_to_gitdir(buf
, the_repository
, sub
->name
);
2320 void submodule_name_to_gitdir(struct strbuf
*buf
, struct repository
*r
,
2321 const char *submodule_name
)
2324 * NEEDSWORK: The current way of mapping a submodule's name to
2325 * its location in .git/modules/ has problems with some naming
2326 * schemes. For example, if a submodule is named "foo" and
2327 * another is named "foo/bar" (whether present in the same
2328 * superproject commit or not - the problem will arise if both
2329 * superproject commits have been checked out at any point in
2330 * time), or if two submodule names only have different cases in
2331 * a case-insensitive filesystem.
2333 * There are several solutions, including encoding the path in
2334 * some way, introducing a submodule.<name>.gitdir config in
2335 * .git/config (not .gitmodules) that allows overriding what the
2336 * gitdir of a submodule would be (and teach Git, upon noticing
2337 * a clash, to automatically determine a non-clashing name and
2338 * to write such a config), or introducing a
2339 * submodule.<name>.gitdir config in .gitmodules that repo
2340 * administrators can explicitly set. Nothing has been decided,
2341 * so for now, just append the name at the end of the path.
2343 strbuf_repo_git_path(buf
, r
, "modules/");
2344 strbuf_addstr(buf
, submodule_name
);