1 #define NO_THE_INDEX_COMPATIBILITY_MACROS
4 #include "repository.h"
6 #include "submodule-config.h"
12 #include "run-command.h"
15 #include "string-list.h"
16 #include "sha1-array.h"
17 #include "argv-array.h"
19 #include "thread-utils.h"
23 #include "parse-options.h"
24 #include "object-store.h"
25 #include "commit-reach.h"
27 static int config_update_recurse_submodules
= RECURSE_SUBMODULES_OFF
;
28 static struct string_list changed_submodule_names
= STRING_LIST_INIT_DUP
;
29 static int initialized_fetch_ref_tips
;
30 static struct oid_array ref_tips_before_fetch
;
31 static struct oid_array ref_tips_after_fetch
;
34 * Check if the .gitmodules file is unmerged. Parsing of the .gitmodules file
35 * will be disabled because we can't guess what might be configured in
36 * .gitmodules unless the user resolves the conflict.
38 int is_gitmodules_unmerged(const struct index_state
*istate
)
40 int pos
= index_name_pos(istate
, GITMODULES_FILE
, strlen(GITMODULES_FILE
));
41 if (pos
< 0) { /* .gitmodules not found or isn't merged */
43 if (istate
->cache_nr
> pos
) { /* there is a .gitmodules */
44 const struct cache_entry
*ce
= istate
->cache
[pos
];
45 if (ce_namelen(ce
) == strlen(GITMODULES_FILE
) &&
46 !strcmp(ce
->name
, GITMODULES_FILE
))
55 * Check if the .gitmodules file has unstaged modifications. This must be
56 * checked before allowing modifications to the .gitmodules file with the
57 * intention to stage them later, because when continuing we would stage the
58 * modifications the user didn't stage herself too. That might change in a
59 * future version when we learn to stage the changes we do ourselves without
60 * staging any previous modifications.
62 int is_staging_gitmodules_ok(struct index_state
*istate
)
64 int pos
= index_name_pos(istate
, GITMODULES_FILE
, strlen(GITMODULES_FILE
));
66 if ((pos
>= 0) && (pos
< istate
->cache_nr
)) {
68 if (lstat(GITMODULES_FILE
, &st
) == 0 &&
69 ie_match_stat(istate
, istate
->cache
[pos
], &st
, 0) & DATA_CHANGED
)
76 static int for_each_remote_ref_submodule(const char *submodule
,
77 each_ref_fn fn
, void *cb_data
)
79 return refs_for_each_remote_ref(get_submodule_ref_store(submodule
),
84 * Try to update the "path" entry in the "submodule.<name>" section of the
85 * .gitmodules file. Return 0 only if a .gitmodules file was found, a section
86 * with the correct path=<oldpath> setting was found and we could update it.
88 int update_path_in_gitmodules(const char *oldpath
, const char *newpath
)
90 struct strbuf entry
= STRBUF_INIT
;
91 const struct submodule
*submodule
;
93 if (!file_exists(GITMODULES_FILE
)) /* Do nothing without .gitmodules */
96 if (is_gitmodules_unmerged(the_repository
->index
))
97 die(_("Cannot change unmerged .gitmodules, resolve merge conflicts first"));
99 submodule
= submodule_from_path(the_repository
, &null_oid
, oldpath
);
100 if (!submodule
|| !submodule
->name
) {
101 warning(_("Could not find section in .gitmodules where path=%s"), oldpath
);
104 strbuf_addstr(&entry
, "submodule.");
105 strbuf_addstr(&entry
, submodule
->name
);
106 strbuf_addstr(&entry
, ".path");
107 if (git_config_set_in_file_gently(GITMODULES_FILE
, entry
.buf
, newpath
) < 0) {
108 /* Maybe the user already did that, don't error out here */
109 warning(_("Could not update .gitmodules entry %s"), entry
.buf
);
110 strbuf_release(&entry
);
113 strbuf_release(&entry
);
118 * Try to remove the "submodule.<name>" section from .gitmodules where the given
119 * path is configured. Return 0 only if a .gitmodules file was found, a section
120 * with the correct path=<path> setting was found and we could remove it.
122 int remove_path_from_gitmodules(const char *path
)
124 struct strbuf sect
= STRBUF_INIT
;
125 const struct submodule
*submodule
;
127 if (!file_exists(GITMODULES_FILE
)) /* Do nothing without .gitmodules */
130 if (is_gitmodules_unmerged(the_repository
->index
))
131 die(_("Cannot change unmerged .gitmodules, resolve merge conflicts first"));
133 submodule
= submodule_from_path(the_repository
, &null_oid
, path
);
134 if (!submodule
|| !submodule
->name
) {
135 warning(_("Could not find section in .gitmodules where path=%s"), path
);
138 strbuf_addstr(§
, "submodule.");
139 strbuf_addstr(§
, submodule
->name
);
140 if (git_config_rename_section_in_file(GITMODULES_FILE
, sect
.buf
, NULL
) < 0) {
141 /* Maybe the user already did that, don't error out here */
142 warning(_("Could not remove .gitmodules entry for %s"), path
);
143 strbuf_release(§
);
146 strbuf_release(§
);
150 void stage_updated_gitmodules(struct index_state
*istate
)
152 if (add_file_to_index(istate
, GITMODULES_FILE
, 0))
153 die(_("staging updated .gitmodules failed"));
156 /* TODO: remove this function, use repo_submodule_init instead. */
157 int add_submodule_odb(const char *path
)
159 struct strbuf objects_directory
= STRBUF_INIT
;
162 ret
= strbuf_git_path_submodule(&objects_directory
, path
, "objects/");
165 if (!is_directory(objects_directory
.buf
)) {
169 add_to_alternates_memory(objects_directory
.buf
);
171 strbuf_release(&objects_directory
);
175 void set_diffopt_flags_from_submodule_config(struct diff_options
*diffopt
,
178 const struct submodule
*submodule
= submodule_from_path(the_repository
,
184 key
= xstrfmt("submodule.%s.ignore", submodule
->name
);
185 if (repo_config_get_string_const(the_repository
, key
, &ignore
))
186 ignore
= submodule
->ignore
;
190 handle_ignore_submodules_arg(diffopt
, ignore
);
191 else if (is_gitmodules_unmerged(the_repository
->index
))
192 diffopt
->flags
.ignore_submodules
= 1;
196 /* Cheap function that only determines if we're interested in submodules at all */
197 int git_default_submodule_config(const char *var
, const char *value
, void *cb
)
199 if (!strcmp(var
, "submodule.recurse")) {
200 int v
= git_config_bool(var
, value
) ?
201 RECURSE_SUBMODULES_ON
: RECURSE_SUBMODULES_OFF
;
202 config_update_recurse_submodules
= v
;
207 int option_parse_recurse_submodules_worktree_updater(const struct option
*opt
,
208 const char *arg
, int unset
)
211 config_update_recurse_submodules
= RECURSE_SUBMODULES_OFF
;
215 config_update_recurse_submodules
=
216 parse_update_recurse_submodules_arg(opt
->long_name
,
219 config_update_recurse_submodules
= RECURSE_SUBMODULES_ON
;
225 * Determine if a submodule has been initialized at a given 'path'
227 int is_submodule_active(struct repository
*repo
, const char *path
)
232 const struct string_list
*sl
;
233 const struct submodule
*module
;
235 module
= submodule_from_path(repo
, &null_oid
, path
);
237 /* early return if there isn't a path->module mapping */
241 /* submodule.<name>.active is set */
242 key
= xstrfmt("submodule.%s.active", module
->name
);
243 if (!repo_config_get_bool(repo
, key
, &ret
)) {
249 /* submodule.active is set */
250 sl
= repo_config_get_value_multi(repo
, "submodule.active");
253 struct argv_array args
= ARGV_ARRAY_INIT
;
254 const struct string_list_item
*item
;
256 for_each_string_list_item(item
, sl
) {
257 argv_array_push(&args
, item
->string
);
260 parse_pathspec(&ps
, 0, 0, NULL
, args
.argv
);
261 ret
= match_pathspec(repo
->index
, &ps
, path
, strlen(path
), 0, NULL
, 1);
263 argv_array_clear(&args
);
268 /* fallback to checking if the URL is set */
269 key
= xstrfmt("submodule.%s.url", module
->name
);
270 ret
= !repo_config_get_string(repo
, key
, &value
);
277 int is_submodule_populated_gently(const char *path
, int *return_error_code
)
280 char *gitdir
= xstrfmt("%s/.git", path
);
282 if (resolve_gitdir_gently(gitdir
, return_error_code
))
290 * Dies if the provided 'prefix' corresponds to an unpopulated submodule
292 void die_in_unpopulated_submodule(const struct index_state
*istate
,
300 prefixlen
= strlen(prefix
);
302 for (i
= 0; i
< istate
->cache_nr
; i
++) {
303 struct cache_entry
*ce
= istate
->cache
[i
];
304 int ce_len
= ce_namelen(ce
);
306 if (!S_ISGITLINK(ce
->ce_mode
))
308 if (prefixlen
<= ce_len
)
310 if (strncmp(ce
->name
, prefix
, ce_len
))
312 if (prefix
[ce_len
] != '/')
315 die(_("in unpopulated submodule '%s'"), ce
->name
);
320 * Dies if any paths in the provided pathspec descends into a submodule
322 void die_path_inside_submodule(const struct index_state
*istate
,
323 const struct pathspec
*ps
)
327 for (i
= 0; i
< istate
->cache_nr
; i
++) {
328 struct cache_entry
*ce
= istate
->cache
[i
];
329 int ce_len
= ce_namelen(ce
);
331 if (!S_ISGITLINK(ce
->ce_mode
))
334 for (j
= 0; j
< ps
->nr
; j
++) {
335 const struct pathspec_item
*item
= &ps
->items
[j
];
337 if (item
->len
<= ce_len
)
339 if (item
->match
[ce_len
] != '/')
341 if (strncmp(ce
->name
, item
->match
, ce_len
))
343 if (item
->len
== ce_len
+ 1)
346 die(_("Pathspec '%s' is in submodule '%.*s'"),
347 item
->original
, ce_len
, ce
->name
);
352 enum submodule_update_type
parse_submodule_update_type(const char *value
)
354 if (!strcmp(value
, "none"))
355 return SM_UPDATE_NONE
;
356 else if (!strcmp(value
, "checkout"))
357 return SM_UPDATE_CHECKOUT
;
358 else if (!strcmp(value
, "rebase"))
359 return SM_UPDATE_REBASE
;
360 else if (!strcmp(value
, "merge"))
361 return SM_UPDATE_MERGE
;
362 else if (*value
== '!')
363 return SM_UPDATE_COMMAND
;
365 return SM_UPDATE_UNSPECIFIED
;
368 int parse_submodule_update_strategy(const char *value
,
369 struct submodule_update_strategy
*dst
)
371 enum submodule_update_type type
;
373 free((void*)dst
->command
);
376 type
= parse_submodule_update_type(value
);
377 if (type
== SM_UPDATE_UNSPECIFIED
)
381 if (type
== SM_UPDATE_COMMAND
)
382 dst
->command
= xstrdup(value
+ 1);
387 const char *submodule_strategy_to_string(const struct submodule_update_strategy
*s
)
389 struct strbuf sb
= STRBUF_INIT
;
391 case SM_UPDATE_CHECKOUT
:
393 case SM_UPDATE_MERGE
:
395 case SM_UPDATE_REBASE
:
399 case SM_UPDATE_UNSPECIFIED
:
401 case SM_UPDATE_COMMAND
:
402 strbuf_addf(&sb
, "!%s", s
->command
);
403 return strbuf_detach(&sb
, NULL
);
408 void handle_ignore_submodules_arg(struct diff_options
*diffopt
,
411 diffopt
->flags
.ignore_submodules
= 0;
412 diffopt
->flags
.ignore_untracked_in_submodules
= 0;
413 diffopt
->flags
.ignore_dirty_submodules
= 0;
415 if (!strcmp(arg
, "all"))
416 diffopt
->flags
.ignore_submodules
= 1;
417 else if (!strcmp(arg
, "untracked"))
418 diffopt
->flags
.ignore_untracked_in_submodules
= 1;
419 else if (!strcmp(arg
, "dirty"))
420 diffopt
->flags
.ignore_dirty_submodules
= 1;
421 else if (strcmp(arg
, "none"))
422 die("bad --ignore-submodules argument: %s", arg
);
425 static int prepare_submodule_summary(struct rev_info
*rev
, const char *path
,
426 struct commit
*left
, struct commit
*right
,
427 struct commit_list
*merge_bases
)
429 struct commit_list
*list
;
431 repo_init_revisions(the_repository
, rev
, NULL
);
432 setup_revisions(0, NULL
, rev
, NULL
);
434 rev
->first_parent_only
= 1;
435 left
->object
.flags
|= SYMMETRIC_LEFT
;
436 add_pending_object(rev
, &left
->object
, path
);
437 add_pending_object(rev
, &right
->object
, path
);
438 for (list
= merge_bases
; list
; list
= list
->next
) {
439 list
->item
->object
.flags
|= UNINTERESTING
;
440 add_pending_object(rev
, &list
->item
->object
,
441 oid_to_hex(&list
->item
->object
.oid
));
443 return prepare_revision_walk(rev
);
446 static void print_submodule_summary(struct repository
*r
, struct rev_info
*rev
, struct diff_options
*o
)
448 static const char format
[] = " %m %s";
449 struct strbuf sb
= STRBUF_INIT
;
450 struct commit
*commit
;
452 while ((commit
= get_revision(rev
))) {
453 struct pretty_print_context ctx
= {0};
454 ctx
.date_mode
= rev
->date_mode
;
455 ctx
.output_encoding
= get_log_output_encoding();
456 strbuf_setlen(&sb
, 0);
457 repo_format_commit_message(r
, commit
, format
, &sb
,
459 strbuf_addch(&sb
, '\n');
460 if (commit
->object
.flags
& SYMMETRIC_LEFT
)
461 diff_emit_submodule_del(o
, sb
.buf
);
463 diff_emit_submodule_add(o
, sb
.buf
);
468 static void prepare_submodule_repo_env_no_git_dir(struct argv_array
*out
)
470 const char * const *var
;
472 for (var
= local_repo_env
; *var
; var
++) {
473 if (strcmp(*var
, CONFIG_DATA_ENVIRONMENT
))
474 argv_array_push(out
, *var
);
478 void prepare_submodule_repo_env(struct argv_array
*out
)
480 prepare_submodule_repo_env_no_git_dir(out
);
481 argv_array_pushf(out
, "%s=%s", GIT_DIR_ENVIRONMENT
,
482 DEFAULT_GIT_DIR_ENVIRONMENT
);
486 * Initialize a repository struct for a submodule based on the provided 'path'.
488 * Unlike repo_submodule_init, this tolerates submodules not present
489 * in .gitmodules. This function exists only to preserve historical behavior,
491 * Returns the repository struct on success,
492 * NULL when the submodule is not present.
494 static struct repository
*open_submodule(const char *path
)
496 struct strbuf sb
= STRBUF_INIT
;
497 struct repository
*out
= xmalloc(sizeof(*out
));
499 if (submodule_to_gitdir(&sb
, path
) || repo_init(out
, sb
.buf
, NULL
)) {
505 /* Mark it as a submodule */
506 out
->submodule_prefix
= xstrdup(path
);
513 * Helper function to display the submodule header line prior to the full
516 * If it can locate the submodule git directory it will create a repository
517 * handle for the submodule and lookup both the left and right commits and
518 * put them into the left and right pointers.
520 static void show_submodule_header(struct diff_options
*o
,
522 struct object_id
*one
, struct object_id
*two
,
523 unsigned dirty_submodule
,
524 struct repository
*sub
,
525 struct commit
**left
, struct commit
**right
,
526 struct commit_list
**merge_bases
)
528 const char *message
= NULL
;
529 struct strbuf sb
= STRBUF_INIT
;
530 int fast_forward
= 0, fast_backward
= 0;
532 if (dirty_submodule
& DIRTY_SUBMODULE_UNTRACKED
)
533 diff_emit_submodule_untracked(o
, path
);
535 if (dirty_submodule
& DIRTY_SUBMODULE_MODIFIED
)
536 diff_emit_submodule_modified(o
, path
);
538 if (is_null_oid(one
))
539 message
= "(new submodule)";
540 else if (is_null_oid(two
))
541 message
= "(submodule deleted)";
545 message
= "(commits not present)";
550 * Attempt to lookup the commit references, and determine if this is
551 * a fast forward or fast backwards update.
553 *left
= lookup_commit_reference(sub
, one
);
554 *right
= lookup_commit_reference(sub
, two
);
557 * Warn about missing commits in the submodule project, but only if
560 if ((!is_null_oid(one
) && !*left
) ||
561 (!is_null_oid(two
) && !*right
))
562 message
= "(commits not present)";
564 *merge_bases
= repo_get_merge_bases(sub
, *left
, *right
);
566 if ((*merge_bases
)->item
== *left
)
568 else if ((*merge_bases
)->item
== *right
)
572 if (oideq(one
, two
)) {
578 strbuf_addf(&sb
, "Submodule %s ", path
);
579 strbuf_add_unique_abbrev(&sb
, one
, DEFAULT_ABBREV
);
580 strbuf_addstr(&sb
, (fast_backward
|| fast_forward
) ? ".." : "...");
581 strbuf_add_unique_abbrev(&sb
, two
, DEFAULT_ABBREV
);
583 strbuf_addf(&sb
, " %s\n", message
);
585 strbuf_addf(&sb
, "%s:\n", fast_backward
? " (rewind)" : "");
586 diff_emit_submodule_header(o
, sb
.buf
);
591 void show_submodule_summary(struct diff_options
*o
, const char *path
,
592 struct object_id
*one
, struct object_id
*two
,
593 unsigned dirty_submodule
)
596 struct commit
*left
= NULL
, *right
= NULL
;
597 struct commit_list
*merge_bases
= NULL
;
598 struct repository
*sub
;
600 sub
= open_submodule(path
);
601 show_submodule_header(o
, path
, one
, two
, dirty_submodule
,
602 sub
, &left
, &right
, &merge_bases
);
605 * If we don't have both a left and a right pointer, there is no
606 * reason to try and display a summary. The header line should contain
607 * all the information the user needs.
609 if (!left
|| !right
|| !sub
)
612 /* Treat revision walker failure the same as missing commits */
613 if (prepare_submodule_summary(&rev
, path
, left
, right
, merge_bases
)) {
614 diff_emit_submodule_error(o
, "(revision walker failed)\n");
618 print_submodule_summary(sub
, &rev
, o
);
622 free_commit_list(merge_bases
);
623 clear_commit_marks(left
, ~0);
624 clear_commit_marks(right
, ~0);
631 void show_submodule_inline_diff(struct diff_options
*o
, const char *path
,
632 struct object_id
*one
, struct object_id
*two
,
633 unsigned dirty_submodule
)
635 const struct object_id
*old_oid
= the_hash_algo
->empty_tree
, *new_oid
= the_hash_algo
->empty_tree
;
636 struct commit
*left
= NULL
, *right
= NULL
;
637 struct commit_list
*merge_bases
= NULL
;
638 struct child_process cp
= CHILD_PROCESS_INIT
;
639 struct strbuf sb
= STRBUF_INIT
;
640 struct repository
*sub
;
642 sub
= open_submodule(path
);
643 show_submodule_header(o
, path
, one
, two
, dirty_submodule
,
644 sub
, &left
, &right
, &merge_bases
);
646 /* We need a valid left and right commit to display a difference */
647 if (!(left
|| is_null_oid(one
)) ||
648 !(right
|| is_null_oid(two
)))
661 /* TODO: other options may need to be passed here. */
662 argv_array_pushl(&cp
.args
, "diff", "--submodule=diff", NULL
);
663 argv_array_pushf(&cp
.args
, "--color=%s", want_color(o
->use_color
) ?
666 if (o
->flags
.reverse_diff
) {
667 argv_array_pushf(&cp
.args
, "--src-prefix=%s%s/",
669 argv_array_pushf(&cp
.args
, "--dst-prefix=%s%s/",
672 argv_array_pushf(&cp
.args
, "--src-prefix=%s%s/",
674 argv_array_pushf(&cp
.args
, "--dst-prefix=%s%s/",
677 argv_array_push(&cp
.args
, oid_to_hex(old_oid
));
679 * If the submodule has modified content, we will diff against the
680 * work tree, under the assumption that the user has asked for the
681 * diff format and wishes to actually see all differences even if they
682 * haven't yet been committed to the submodule yet.
684 if (!(dirty_submodule
& DIRTY_SUBMODULE_MODIFIED
))
685 argv_array_push(&cp
.args
, oid_to_hex(new_oid
));
687 prepare_submodule_repo_env(&cp
.env_array
);
688 if (start_command(&cp
))
689 diff_emit_submodule_error(o
, "(diff failed)\n");
691 while (strbuf_getwholeline_fd(&sb
, cp
.out
, '\n') != EOF
)
692 diff_emit_submodule_pipethrough(o
, sb
.buf
, sb
.len
);
694 if (finish_command(&cp
))
695 diff_emit_submodule_error(o
, "(diff failed)\n");
700 free_commit_list(merge_bases
);
702 clear_commit_marks(left
, ~0);
704 clear_commit_marks(right
, ~0);
711 int should_update_submodules(void)
713 return config_update_recurse_submodules
== RECURSE_SUBMODULES_ON
;
716 const struct submodule
*submodule_from_ce(const struct cache_entry
*ce
)
718 if (!S_ISGITLINK(ce
->ce_mode
))
721 if (!should_update_submodules())
724 return submodule_from_path(the_repository
, &null_oid
, ce
->name
);
727 static struct oid_array
*submodule_commits(struct string_list
*submodules
,
730 struct string_list_item
*item
;
732 item
= string_list_insert(submodules
, name
);
734 return (struct oid_array
*) item
->util
;
736 /* NEEDSWORK: should we have oid_array_init()? */
737 item
->util
= xcalloc(1, sizeof(struct oid_array
));
738 return (struct oid_array
*) item
->util
;
741 struct collect_changed_submodules_cb_data
{
742 struct string_list
*changed
;
743 const struct object_id
*commit_oid
;
747 * this would normally be two functions: default_name_from_path() and
748 * path_from_default_name(). Since the default name is the same as
749 * the submodule path we can get away with just one function which only
750 * checks whether there is a submodule in the working directory at that
753 static const char *default_name_or_path(const char *path_or_name
)
757 if (!is_submodule_populated_gently(path_or_name
, &error_code
))
763 static void collect_changed_submodules_cb(struct diff_queue_struct
*q
,
764 struct diff_options
*options
,
767 struct collect_changed_submodules_cb_data
*me
= data
;
768 struct string_list
*changed
= me
->changed
;
769 const struct object_id
*commit_oid
= me
->commit_oid
;
772 for (i
= 0; i
< q
->nr
; i
++) {
773 struct diff_filepair
*p
= q
->queue
[i
];
774 struct oid_array
*commits
;
775 const struct submodule
*submodule
;
778 if (!S_ISGITLINK(p
->two
->mode
))
781 submodule
= submodule_from_path(the_repository
,
782 commit_oid
, p
->two
->path
);
784 name
= submodule
->name
;
786 name
= default_name_or_path(p
->two
->path
);
787 /* make sure name does not collide with existing one */
789 submodule
= submodule_from_name(the_repository
,
792 warning("Submodule in commit %s at path: "
793 "'%s' collides with a submodule named "
794 "the same. Skipping it.",
795 oid_to_hex(commit_oid
), p
->two
->path
);
803 commits
= submodule_commits(changed
, name
);
804 oid_array_append(commits
, &p
->two
->oid
);
809 * Collect the paths of submodules in 'changed' which have changed based on
810 * the revisions as specified in 'argv'. Each entry in 'changed' will also
811 * have a corresponding 'struct oid_array' (in the 'util' field) which lists
812 * what the submodule pointers were updated to during the change.
814 static void collect_changed_submodules(struct index_state
*istate
,
815 struct string_list
*changed
,
816 struct argv_array
*argv
)
819 const struct commit
*commit
;
821 repo_init_revisions(the_repository
, &rev
, NULL
);
822 setup_revisions(argv
->argc
, argv
->argv
, &rev
, NULL
);
823 if (prepare_revision_walk(&rev
))
824 die("revision walk setup failed");
826 while ((commit
= get_revision(&rev
))) {
827 struct rev_info diff_rev
;
828 struct collect_changed_submodules_cb_data data
;
829 data
.changed
= changed
;
830 data
.commit_oid
= &commit
->object
.oid
;
832 repo_init_revisions(the_repository
, &diff_rev
, NULL
);
833 diff_rev
.diffopt
.output_format
|= DIFF_FORMAT_CALLBACK
;
834 diff_rev
.diffopt
.format_callback
= collect_changed_submodules_cb
;
835 diff_rev
.diffopt
.format_callback_data
= &data
;
836 diff_tree_combined_merge(commit
, 1, &diff_rev
);
839 reset_revision_walk();
842 static void free_submodules_oids(struct string_list
*submodules
)
844 struct string_list_item
*item
;
845 for_each_string_list_item(item
, submodules
)
846 oid_array_clear((struct oid_array
*) item
->util
);
847 string_list_clear(submodules
, 1);
850 static int has_remote(const char *refname
, const struct object_id
*oid
,
851 int flags
, void *cb_data
)
856 static int append_oid_to_argv(const struct object_id
*oid
, void *data
)
858 struct argv_array
*argv
= data
;
859 argv_array_push(argv
, oid_to_hex(oid
));
863 struct has_commit_data
{
868 static int check_has_commit(const struct object_id
*oid
, void *data
)
870 struct has_commit_data
*cb
= data
;
872 enum object_type type
= oid_object_info(the_repository
, oid
, NULL
);
879 * Object is missing or invalid. If invalid, an error message
880 * has already been printed.
885 die(_("submodule entry '%s' (%s) is a %s, not a commit"),
886 cb
->path
, oid_to_hex(oid
), type_name(type
));
890 static int submodule_has_commits(const char *path
, struct oid_array
*commits
)
892 struct has_commit_data has_commit
= { 1, path
};
895 * Perform a cheap, but incorrect check for the existence of 'commits'.
896 * This is done by adding the submodule's object store to the in-core
897 * object store, and then querying for each commit's existence. If we
898 * do not have the commit object anywhere, there is no chance we have
899 * it in the object store of the correct submodule and have it
900 * reachable from a ref, so we can fail early without spawning rev-list
901 * which is expensive.
903 if (add_submodule_odb(path
))
906 oid_array_for_each_unique(commits
, check_has_commit
, &has_commit
);
908 if (has_commit
.result
) {
910 * Even if the submodule is checked out and the commit is
911 * present, make sure it exists in the submodule's object store
912 * and that it is reachable from a ref.
914 struct child_process cp
= CHILD_PROCESS_INIT
;
915 struct strbuf out
= STRBUF_INIT
;
917 argv_array_pushl(&cp
.args
, "rev-list", "-n", "1", NULL
);
918 oid_array_for_each_unique(commits
, append_oid_to_argv
, &cp
.args
);
919 argv_array_pushl(&cp
.args
, "--not", "--all", NULL
);
921 prepare_submodule_repo_env(&cp
.env_array
);
926 if (capture_command(&cp
, &out
, GIT_MAX_HEXSZ
+ 1) || out
.len
)
927 has_commit
.result
= 0;
929 strbuf_release(&out
);
932 return has_commit
.result
;
935 static int submodule_needs_pushing(const char *path
, struct oid_array
*commits
)
937 if (!submodule_has_commits(path
, commits
))
939 * NOTE: We do consider it safe to return "no" here. The
940 * correct answer would be "We do not know" instead of
941 * "No push needed", but it is quite hard to change
942 * the submodule pointer without having the submodule
943 * around. If a user did however change the submodules
944 * without having the submodule around, this indicates
945 * an expert who knows what they are doing or a
946 * maintainer integrating work from other people. In
947 * both cases it should be safe to skip this check.
951 if (for_each_remote_ref_submodule(path
, has_remote
, NULL
) > 0) {
952 struct child_process cp
= CHILD_PROCESS_INIT
;
953 struct strbuf buf
= STRBUF_INIT
;
954 int needs_pushing
= 0;
956 argv_array_push(&cp
.args
, "rev-list");
957 oid_array_for_each_unique(commits
, append_oid_to_argv
, &cp
.args
);
958 argv_array_pushl(&cp
.args
, "--not", "--remotes", "-n", "1" , NULL
);
960 prepare_submodule_repo_env(&cp
.env_array
);
965 if (start_command(&cp
))
966 die("Could not run 'git rev-list <commits> --not --remotes -n 1' command in submodule %s",
968 if (strbuf_read(&buf
, cp
.out
, 41))
972 strbuf_release(&buf
);
973 return needs_pushing
;
979 int find_unpushed_submodules(struct index_state
*istate
,
980 struct oid_array
*commits
,
981 const char *remotes_name
,
982 struct string_list
*needs_pushing
)
984 struct string_list submodules
= STRING_LIST_INIT_DUP
;
985 struct string_list_item
*name
;
986 struct argv_array argv
= ARGV_ARRAY_INIT
;
988 /* argv.argv[0] will be ignored by setup_revisions */
989 argv_array_push(&argv
, "find_unpushed_submodules");
990 oid_array_for_each_unique(commits
, append_oid_to_argv
, &argv
);
991 argv_array_push(&argv
, "--not");
992 argv_array_pushf(&argv
, "--remotes=%s", remotes_name
);
994 collect_changed_submodules(istate
, &submodules
, &argv
);
996 for_each_string_list_item(name
, &submodules
) {
997 struct oid_array
*commits
= name
->util
;
998 const struct submodule
*submodule
;
999 const char *path
= NULL
;
1001 submodule
= submodule_from_name(the_repository
, &null_oid
, name
->string
);
1003 path
= submodule
->path
;
1005 path
= default_name_or_path(name
->string
);
1010 if (submodule_needs_pushing(path
, commits
))
1011 string_list_insert(needs_pushing
, path
);
1014 free_submodules_oids(&submodules
);
1015 argv_array_clear(&argv
);
1017 return needs_pushing
->nr
;
1020 static int push_submodule(const char *path
,
1021 const struct remote
*remote
,
1022 const struct refspec
*rs
,
1023 const struct string_list
*push_options
,
1026 if (for_each_remote_ref_submodule(path
, has_remote
, NULL
) > 0) {
1027 struct child_process cp
= CHILD_PROCESS_INIT
;
1028 argv_array_push(&cp
.args
, "push");
1030 argv_array_push(&cp
.args
, "--dry-run");
1032 if (push_options
&& push_options
->nr
) {
1033 const struct string_list_item
*item
;
1034 for_each_string_list_item(item
, push_options
)
1035 argv_array_pushf(&cp
.args
, "--push-option=%s",
1039 if (remote
->origin
!= REMOTE_UNCONFIGURED
) {
1041 argv_array_push(&cp
.args
, remote
->name
);
1042 for (i
= 0; i
< rs
->raw_nr
; i
++)
1043 argv_array_push(&cp
.args
, rs
->raw
[i
]);
1046 prepare_submodule_repo_env(&cp
.env_array
);
1050 if (run_command(&cp
))
1059 * Perform a check in the submodule to see if the remote and refspec work.
1060 * Die if the submodule can't be pushed.
1062 static void submodule_push_check(const char *path
, const char *head
,
1063 const struct remote
*remote
,
1064 const struct refspec
*rs
)
1066 struct child_process cp
= CHILD_PROCESS_INIT
;
1069 argv_array_push(&cp
.args
, "submodule--helper");
1070 argv_array_push(&cp
.args
, "push-check");
1071 argv_array_push(&cp
.args
, head
);
1072 argv_array_push(&cp
.args
, remote
->name
);
1074 for (i
= 0; i
< rs
->raw_nr
; i
++)
1075 argv_array_push(&cp
.args
, rs
->raw
[i
]);
1077 prepare_submodule_repo_env(&cp
.env_array
);
1084 * Simply indicate if 'submodule--helper push-check' failed.
1085 * More detailed error information will be provided by the
1088 if (run_command(&cp
))
1089 die("process for submodule '%s' failed", path
);
1092 int push_unpushed_submodules(struct index_state
*istate
,
1093 struct oid_array
*commits
,
1094 const struct remote
*remote
,
1095 const struct refspec
*rs
,
1096 const struct string_list
*push_options
,
1100 struct string_list needs_pushing
= STRING_LIST_INIT_DUP
;
1102 if (!find_unpushed_submodules(istate
, commits
,
1103 remote
->name
, &needs_pushing
))
1107 * Verify that the remote and refspec can be propagated to all
1108 * submodules. This check can be skipped if the remote and refspec
1109 * won't be propagated due to the remote being unconfigured (e.g. a URL
1110 * instead of a remote name).
1112 if (remote
->origin
!= REMOTE_UNCONFIGURED
) {
1114 struct object_id head_oid
;
1116 head
= resolve_refdup("HEAD", 0, &head_oid
, NULL
);
1118 die(_("Failed to resolve HEAD as a valid ref."));
1120 for (i
= 0; i
< needs_pushing
.nr
; i
++)
1121 submodule_push_check(needs_pushing
.items
[i
].string
,
1126 /* Actually push the submodules */
1127 for (i
= 0; i
< needs_pushing
.nr
; i
++) {
1128 const char *path
= needs_pushing
.items
[i
].string
;
1129 fprintf(stderr
, "Pushing submodule '%s'\n", path
);
1130 if (!push_submodule(path
, remote
, rs
,
1131 push_options
, dry_run
)) {
1132 fprintf(stderr
, "Unable to push submodule '%s'\n", path
);
1137 string_list_clear(&needs_pushing
, 0);
1142 static int append_oid_to_array(const char *ref
, const struct object_id
*oid
,
1143 int flags
, void *data
)
1145 struct oid_array
*array
= data
;
1146 oid_array_append(array
, oid
);
1150 void check_for_new_submodule_commits(struct object_id
*oid
)
1152 if (!initialized_fetch_ref_tips
) {
1153 for_each_ref(append_oid_to_array
, &ref_tips_before_fetch
);
1154 initialized_fetch_ref_tips
= 1;
1157 oid_array_append(&ref_tips_after_fetch
, oid
);
1160 static void calculate_changed_submodule_paths(struct index_state
*istate
)
1162 struct argv_array argv
= ARGV_ARRAY_INIT
;
1163 struct string_list changed_submodules
= STRING_LIST_INIT_DUP
;
1164 const struct string_list_item
*name
;
1166 /* No need to check if there are no submodules configured */
1167 if (!submodule_from_path(the_repository
, NULL
, NULL
))
1170 argv_array_push(&argv
, "--"); /* argv[0] program name */
1171 oid_array_for_each_unique(&ref_tips_after_fetch
,
1172 append_oid_to_argv
, &argv
);
1173 argv_array_push(&argv
, "--not");
1174 oid_array_for_each_unique(&ref_tips_before_fetch
,
1175 append_oid_to_argv
, &argv
);
1178 * Collect all submodules (whether checked out or not) for which new
1179 * commits have been recorded upstream in "changed_submodule_names".
1181 collect_changed_submodules(istate
, &changed_submodules
, &argv
);
1183 for_each_string_list_item(name
, &changed_submodules
) {
1184 struct oid_array
*commits
= name
->util
;
1185 const struct submodule
*submodule
;
1186 const char *path
= NULL
;
1188 submodule
= submodule_from_name(the_repository
, &null_oid
, name
->string
);
1190 path
= submodule
->path
;
1192 path
= default_name_or_path(name
->string
);
1197 if (!submodule_has_commits(path
, commits
))
1198 string_list_append(&changed_submodule_names
, name
->string
);
1201 free_submodules_oids(&changed_submodules
);
1202 argv_array_clear(&argv
);
1203 oid_array_clear(&ref_tips_before_fetch
);
1204 oid_array_clear(&ref_tips_after_fetch
);
1205 initialized_fetch_ref_tips
= 0;
1208 int submodule_touches_in_range(struct index_state
*istate
,
1209 struct object_id
*excl_oid
,
1210 struct object_id
*incl_oid
)
1212 struct string_list subs
= STRING_LIST_INIT_DUP
;
1213 struct argv_array args
= ARGV_ARRAY_INIT
;
1216 /* No need to check if there are no submodules configured */
1217 if (!submodule_from_path(the_repository
, NULL
, NULL
))
1220 argv_array_push(&args
, "--"); /* args[0] program name */
1221 argv_array_push(&args
, oid_to_hex(incl_oid
));
1222 if (!is_null_oid(excl_oid
)) {
1223 argv_array_push(&args
, "--not");
1224 argv_array_push(&args
, oid_to_hex(excl_oid
));
1227 collect_changed_submodules(istate
, &subs
, &args
);
1230 argv_array_clear(&args
);
1232 free_submodules_oids(&subs
);
1236 struct submodule_parallel_fetch
{
1238 struct argv_array args
;
1239 struct repository
*r
;
1241 int command_line_option
;
1246 #define SPF_INIT {0, ARGV_ARRAY_INIT, NULL, NULL, 0, 0, 0, 0}
1248 static int get_fetch_recurse_config(const struct submodule
*submodule
,
1249 struct submodule_parallel_fetch
*spf
)
1251 if (spf
->command_line_option
!= RECURSE_SUBMODULES_DEFAULT
)
1252 return spf
->command_line_option
;
1258 int fetch_recurse
= submodule
->fetch_recurse
;
1259 key
= xstrfmt("submodule.%s.fetchRecurseSubmodules", submodule
->name
);
1260 if (!repo_config_get_string_const(spf
->r
, key
, &value
)) {
1261 fetch_recurse
= parse_fetch_recurse_submodules_arg(key
, value
);
1265 if (fetch_recurse
!= RECURSE_SUBMODULES_NONE
)
1266 /* local config overrules everything except commandline */
1267 return fetch_recurse
;
1270 return spf
->default_option
;
1273 static int get_next_submodule(struct child_process
*cp
,
1274 struct strbuf
*err
, void *data
, void **task_cb
)
1277 struct submodule_parallel_fetch
*spf
= data
;
1279 for (; spf
->count
< spf
->r
->index
->cache_nr
; spf
->count
++) {
1280 struct strbuf submodule_path
= STRBUF_INIT
;
1281 struct strbuf submodule_git_dir
= STRBUF_INIT
;
1282 struct strbuf submodule_prefix
= STRBUF_INIT
;
1283 const struct cache_entry
*ce
= spf
->r
->index
->cache
[spf
->count
];
1284 const char *git_dir
, *default_argv
;
1285 const struct submodule
*submodule
;
1286 struct submodule default_submodule
= SUBMODULE_INIT
;
1288 if (!S_ISGITLINK(ce
->ce_mode
))
1291 submodule
= submodule_from_path(spf
->r
, &null_oid
, ce
->name
);
1293 const char *name
= default_name_or_path(ce
->name
);
1295 default_submodule
.path
= default_submodule
.name
= name
;
1296 submodule
= &default_submodule
;
1300 switch (get_fetch_recurse_config(submodule
, spf
))
1303 case RECURSE_SUBMODULES_DEFAULT
:
1304 case RECURSE_SUBMODULES_ON_DEMAND
:
1305 if (!submodule
|| !unsorted_string_list_lookup(&changed_submodule_names
,
1308 default_argv
= "on-demand";
1310 case RECURSE_SUBMODULES_ON
:
1311 default_argv
= "yes";
1313 case RECURSE_SUBMODULES_OFF
:
1317 strbuf_repo_worktree_path(&submodule_path
, spf
->r
, "%s", ce
->name
);
1318 strbuf_addf(&submodule_git_dir
, "%s/.git", submodule_path
.buf
);
1319 strbuf_addf(&submodule_prefix
, "%s%s/", spf
->prefix
, ce
->name
);
1320 git_dir
= read_gitfile(submodule_git_dir
.buf
);
1322 git_dir
= submodule_git_dir
.buf
;
1323 if (is_directory(git_dir
)) {
1324 child_process_init(cp
);
1325 cp
->dir
= strbuf_detach(&submodule_path
, NULL
);
1326 prepare_submodule_repo_env(&cp
->env_array
);
1329 strbuf_addf(err
, "Fetching submodule %s%s\n",
1330 spf
->prefix
, ce
->name
);
1331 argv_array_init(&cp
->args
);
1332 argv_array_pushv(&cp
->args
, spf
->args
.argv
);
1333 argv_array_push(&cp
->args
, default_argv
);
1334 argv_array_push(&cp
->args
, "--submodule-prefix");
1335 argv_array_push(&cp
->args
, submodule_prefix
.buf
);
1338 strbuf_release(&submodule_path
);
1339 strbuf_release(&submodule_git_dir
);
1340 strbuf_release(&submodule_prefix
);
1349 static int fetch_start_failure(struct strbuf
*err
,
1350 void *cb
, void *task_cb
)
1352 struct submodule_parallel_fetch
*spf
= cb
;
1359 static int fetch_finish(int retvalue
, struct strbuf
*err
,
1360 void *cb
, void *task_cb
)
1362 struct submodule_parallel_fetch
*spf
= cb
;
1370 int fetch_populated_submodules(struct repository
*r
,
1371 const struct argv_array
*options
,
1372 const char *prefix
, int command_line_option
,
1374 int quiet
, int max_parallel_jobs
)
1377 struct submodule_parallel_fetch spf
= SPF_INIT
;
1380 spf
.command_line_option
= command_line_option
;
1381 spf
.default_option
= default_option
;
1383 spf
.prefix
= prefix
;
1388 if (repo_read_index(r
) < 0)
1389 die("index file corrupt");
1391 argv_array_push(&spf
.args
, "fetch");
1392 for (i
= 0; i
< options
->argc
; i
++)
1393 argv_array_push(&spf
.args
, options
->argv
[i
]);
1394 argv_array_push(&spf
.args
, "--recurse-submodules-default");
1395 /* default value, "--submodule-prefix" and its value are added later */
1397 calculate_changed_submodule_paths(r
->index
);
1398 run_processes_parallel(max_parallel_jobs
,
1400 fetch_start_failure
,
1404 argv_array_clear(&spf
.args
);
1406 string_list_clear(&changed_submodule_names
, 1);
1410 unsigned is_submodule_modified(const char *path
, int ignore_untracked
)
1412 struct child_process cp
= CHILD_PROCESS_INIT
;
1413 struct strbuf buf
= STRBUF_INIT
;
1415 unsigned dirty_submodule
= 0;
1416 const char *git_dir
;
1417 int ignore_cp_exit_code
= 0;
1419 strbuf_addf(&buf
, "%s/.git", path
);
1420 git_dir
= read_gitfile(buf
.buf
);
1423 if (!is_git_directory(git_dir
)) {
1424 if (is_directory(git_dir
))
1425 die(_("'%s' not recognized as a git repository"), git_dir
);
1426 strbuf_release(&buf
);
1427 /* The submodule is not checked out, so it is not modified */
1432 argv_array_pushl(&cp
.args
, "status", "--porcelain=2", NULL
);
1433 if (ignore_untracked
)
1434 argv_array_push(&cp
.args
, "-uno");
1436 prepare_submodule_repo_env(&cp
.env_array
);
1441 if (start_command(&cp
))
1442 die("Could not run 'git status --porcelain=2' in submodule %s", path
);
1444 fp
= xfdopen(cp
.out
, "r");
1445 while (strbuf_getwholeline(&buf
, fp
, '\n') != EOF
) {
1446 /* regular untracked files */
1447 if (buf
.buf
[0] == '?')
1448 dirty_submodule
|= DIRTY_SUBMODULE_UNTRACKED
;
1450 if (buf
.buf
[0] == 'u' ||
1451 buf
.buf
[0] == '1' ||
1452 buf
.buf
[0] == '2') {
1453 /* T = line type, XY = status, SSSS = submodule state */
1454 if (buf
.len
< strlen("T XY SSSS"))
1455 BUG("invalid status --porcelain=2 line %s",
1458 if (buf
.buf
[5] == 'S' && buf
.buf
[8] == 'U')
1459 /* nested untracked file */
1460 dirty_submodule
|= DIRTY_SUBMODULE_UNTRACKED
;
1462 if (buf
.buf
[0] == 'u' ||
1463 buf
.buf
[0] == '2' ||
1464 memcmp(buf
.buf
+ 5, "S..U", 4))
1466 dirty_submodule
|= DIRTY_SUBMODULE_MODIFIED
;
1469 if ((dirty_submodule
& DIRTY_SUBMODULE_MODIFIED
) &&
1470 ((dirty_submodule
& DIRTY_SUBMODULE_UNTRACKED
) ||
1471 ignore_untracked
)) {
1473 * We're not interested in any further information from
1474 * the child any more, neither output nor its exit code.
1476 ignore_cp_exit_code
= 1;
1482 if (finish_command(&cp
) && !ignore_cp_exit_code
)
1483 die("'git status --porcelain=2' failed in submodule %s", path
);
1485 strbuf_release(&buf
);
1486 return dirty_submodule
;
1489 int submodule_uses_gitfile(const char *path
)
1491 struct child_process cp
= CHILD_PROCESS_INIT
;
1492 const char *argv
[] = {
1500 struct strbuf buf
= STRBUF_INIT
;
1501 const char *git_dir
;
1503 strbuf_addf(&buf
, "%s/.git", path
);
1504 git_dir
= read_gitfile(buf
.buf
);
1506 strbuf_release(&buf
);
1509 strbuf_release(&buf
);
1511 /* Now test that all nested submodules use a gitfile too */
1513 prepare_submodule_repo_env(&cp
.env_array
);
1519 if (run_command(&cp
))
1526 * Check if it is a bad idea to remove a submodule, i.e. if we'd lose data
1529 * Return 1 if we'd lose data, return 0 if the removal is fine,
1530 * and negative values for errors.
1532 int bad_to_remove_submodule(const char *path
, unsigned flags
)
1535 struct child_process cp
= CHILD_PROCESS_INIT
;
1536 struct strbuf buf
= STRBUF_INIT
;
1539 if (!file_exists(path
) || is_empty_dir(path
))
1542 if (!submodule_uses_gitfile(path
))
1545 argv_array_pushl(&cp
.args
, "status", "--porcelain",
1546 "--ignore-submodules=none", NULL
);
1548 if (flags
& SUBMODULE_REMOVAL_IGNORE_UNTRACKED
)
1549 argv_array_push(&cp
.args
, "-uno");
1551 argv_array_push(&cp
.args
, "-uall");
1553 if (!(flags
& SUBMODULE_REMOVAL_IGNORE_IGNORED_UNTRACKED
))
1554 argv_array_push(&cp
.args
, "--ignored");
1556 prepare_submodule_repo_env(&cp
.env_array
);
1561 if (start_command(&cp
)) {
1562 if (flags
& SUBMODULE_REMOVAL_DIE_ON_ERROR
)
1563 die(_("could not start 'git status' in submodule '%s'"),
1569 len
= strbuf_read(&buf
, cp
.out
, 1024);
1574 if (finish_command(&cp
)) {
1575 if (flags
& SUBMODULE_REMOVAL_DIE_ON_ERROR
)
1576 die(_("could not run 'git status' in submodule '%s'"),
1581 strbuf_release(&buf
);
1585 static const char *get_super_prefix_or_empty(void)
1587 const char *s
= get_super_prefix();
1593 static int submodule_has_dirty_index(const struct submodule
*sub
)
1595 struct child_process cp
= CHILD_PROCESS_INIT
;
1597 prepare_submodule_repo_env(&cp
.env_array
);
1600 argv_array_pushl(&cp
.args
, "diff-index", "--quiet",
1601 "--cached", "HEAD", NULL
);
1605 if (start_command(&cp
))
1606 die("could not recurse into submodule '%s'", sub
->path
);
1608 return finish_command(&cp
);
1611 static void submodule_reset_index(const char *path
)
1613 struct child_process cp
= CHILD_PROCESS_INIT
;
1614 prepare_submodule_repo_env(&cp
.env_array
);
1620 argv_array_pushf(&cp
.args
, "--super-prefix=%s%s/",
1621 get_super_prefix_or_empty(), path
);
1622 argv_array_pushl(&cp
.args
, "read-tree", "-u", "--reset", NULL
);
1624 argv_array_push(&cp
.args
, empty_tree_oid_hex());
1626 if (run_command(&cp
))
1627 die("could not reset submodule index");
1631 * Moves a submodule at a given path from a given head to another new head.
1632 * For edge cases (a submodule coming into existence or removing a submodule)
1633 * pass NULL for old or new respectively.
1635 int submodule_move_head(const char *path
,
1636 const char *old_head
,
1637 const char *new_head
,
1641 struct child_process cp
= CHILD_PROCESS_INIT
;
1642 const struct submodule
*sub
;
1643 int *error_code_ptr
, error_code
;
1645 if (!is_submodule_active(the_repository
, path
))
1648 if (flags
& SUBMODULE_MOVE_HEAD_FORCE
)
1650 * Pass non NULL pointer to is_submodule_populated_gently
1651 * to prevent die()-ing. We'll use connect_work_tree_and_git_dir
1652 * to fixup the submodule in the force case later.
1654 error_code_ptr
= &error_code
;
1656 error_code_ptr
= NULL
;
1658 if (old_head
&& !is_submodule_populated_gently(path
, error_code_ptr
))
1661 sub
= submodule_from_path(the_repository
, &null_oid
, path
);
1664 BUG("could not get submodule information for '%s'", path
);
1666 if (old_head
&& !(flags
& SUBMODULE_MOVE_HEAD_FORCE
)) {
1667 /* Check if the submodule has a dirty index. */
1668 if (submodule_has_dirty_index(sub
))
1669 return error(_("submodule '%s' has dirty index"), path
);
1672 if (!(flags
& SUBMODULE_MOVE_HEAD_DRY_RUN
)) {
1674 if (!submodule_uses_gitfile(path
))
1675 absorb_git_dir_into_superproject("", path
,
1676 ABSORB_GITDIR_RECURSE_SUBMODULES
);
1678 char *gitdir
= xstrfmt("%s/modules/%s",
1679 get_git_common_dir(), sub
->name
);
1680 connect_work_tree_and_git_dir(path
, gitdir
, 0);
1683 /* make sure the index is clean as well */
1684 submodule_reset_index(path
);
1687 if (old_head
&& (flags
& SUBMODULE_MOVE_HEAD_FORCE
)) {
1688 char *gitdir
= xstrfmt("%s/modules/%s",
1689 get_git_common_dir(), sub
->name
);
1690 connect_work_tree_and_git_dir(path
, gitdir
, 1);
1695 prepare_submodule_repo_env(&cp
.env_array
);
1701 argv_array_pushf(&cp
.args
, "--super-prefix=%s%s/",
1702 get_super_prefix_or_empty(), path
);
1703 argv_array_pushl(&cp
.args
, "read-tree", "--recurse-submodules", NULL
);
1705 if (flags
& SUBMODULE_MOVE_HEAD_DRY_RUN
)
1706 argv_array_push(&cp
.args
, "-n");
1708 argv_array_push(&cp
.args
, "-u");
1710 if (flags
& SUBMODULE_MOVE_HEAD_FORCE
)
1711 argv_array_push(&cp
.args
, "--reset");
1713 argv_array_push(&cp
.args
, "-m");
1715 if (!(flags
& SUBMODULE_MOVE_HEAD_FORCE
))
1716 argv_array_push(&cp
.args
, old_head
? old_head
: empty_tree_oid_hex());
1718 argv_array_push(&cp
.args
, new_head
? new_head
: empty_tree_oid_hex());
1720 if (run_command(&cp
)) {
1721 ret
= error(_("Submodule '%s' could not be updated."), path
);
1725 if (!(flags
& SUBMODULE_MOVE_HEAD_DRY_RUN
)) {
1727 child_process_init(&cp
);
1728 /* also set the HEAD accordingly */
1733 prepare_submodule_repo_env(&cp
.env_array
);
1734 argv_array_pushl(&cp
.args
, "update-ref", "HEAD",
1735 "--no-deref", new_head
, NULL
);
1737 if (run_command(&cp
)) {
1742 struct strbuf sb
= STRBUF_INIT
;
1744 strbuf_addf(&sb
, "%s/.git", path
);
1745 unlink_or_warn(sb
.buf
);
1746 strbuf_release(&sb
);
1748 if (is_empty_dir(path
))
1749 rmdir_or_warn(path
);
1757 * Embeds a single submodules git directory into the superprojects git dir,
1760 static void relocate_single_git_dir_into_superproject(const char *prefix
,
1763 char *old_git_dir
= NULL
, *real_old_git_dir
= NULL
, *real_new_git_dir
= NULL
;
1764 const char *new_git_dir
;
1765 const struct submodule
*sub
;
1767 if (submodule_uses_worktrees(path
))
1768 die(_("relocate_gitdir for submodule '%s' with "
1769 "more than one worktree not supported"), path
);
1771 old_git_dir
= xstrfmt("%s/.git", path
);
1772 if (read_gitfile(old_git_dir
))
1773 /* If it is an actual gitfile, it doesn't need migration. */
1776 real_old_git_dir
= real_pathdup(old_git_dir
, 1);
1778 sub
= submodule_from_path(the_repository
, &null_oid
, path
);
1780 die(_("could not lookup name for submodule '%s'"), path
);
1782 new_git_dir
= git_path("modules/%s", sub
->name
);
1783 if (safe_create_leading_directories_const(new_git_dir
) < 0)
1784 die(_("could not create directory '%s'"), new_git_dir
);
1785 real_new_git_dir
= real_pathdup(new_git_dir
, 1);
1787 fprintf(stderr
, _("Migrating git directory of '%s%s' from\n'%s' to\n'%s'\n"),
1788 get_super_prefix_or_empty(), path
,
1789 real_old_git_dir
, real_new_git_dir
);
1791 relocate_gitdir(path
, real_old_git_dir
, real_new_git_dir
);
1794 free(real_old_git_dir
);
1795 free(real_new_git_dir
);
1799 * Migrate the git directory of the submodule given by path from
1800 * having its git directory within the working tree to the git dir nested
1801 * in its superprojects git dir under modules/.
1803 void absorb_git_dir_into_superproject(const char *prefix
,
1808 const char *sub_git_dir
;
1809 struct strbuf gitdir
= STRBUF_INIT
;
1810 strbuf_addf(&gitdir
, "%s/.git", path
);
1811 sub_git_dir
= resolve_gitdir_gently(gitdir
.buf
, &err_code
);
1813 /* Not populated? */
1815 const struct submodule
*sub
;
1817 if (err_code
== READ_GITFILE_ERR_STAT_FAILED
) {
1818 /* unpopulated as expected */
1819 strbuf_release(&gitdir
);
1823 if (err_code
!= READ_GITFILE_ERR_NOT_A_REPO
)
1824 /* We don't know what broke here. */
1825 read_gitfile_error_die(err_code
, path
, NULL
);
1828 * Maybe populated, but no git directory was found?
1829 * This can happen if the superproject is a submodule
1830 * itself and was just absorbed. The absorption of the
1831 * superproject did not rewrite the git file links yet,
1834 sub
= submodule_from_path(the_repository
, &null_oid
, path
);
1836 die(_("could not lookup name for submodule '%s'"), path
);
1837 connect_work_tree_and_git_dir(path
,
1838 git_path("modules/%s", sub
->name
), 0);
1840 /* Is it already absorbed into the superprojects git dir? */
1841 char *real_sub_git_dir
= real_pathdup(sub_git_dir
, 1);
1842 char *real_common_git_dir
= real_pathdup(get_git_common_dir(), 1);
1844 if (!starts_with(real_sub_git_dir
, real_common_git_dir
))
1845 relocate_single_git_dir_into_superproject(prefix
, path
);
1847 free(real_sub_git_dir
);
1848 free(real_common_git_dir
);
1850 strbuf_release(&gitdir
);
1852 if (flags
& ABSORB_GITDIR_RECURSE_SUBMODULES
) {
1853 struct child_process cp
= CHILD_PROCESS_INIT
;
1854 struct strbuf sb
= STRBUF_INIT
;
1856 if (flags
& ~ABSORB_GITDIR_RECURSE_SUBMODULES
)
1857 BUG("we don't know how to pass the flags down?");
1859 strbuf_addstr(&sb
, get_super_prefix_or_empty());
1860 strbuf_addstr(&sb
, path
);
1861 strbuf_addch(&sb
, '/');
1866 argv_array_pushl(&cp
.args
, "--super-prefix", sb
.buf
,
1867 "submodule--helper",
1868 "absorb-git-dirs", NULL
);
1869 prepare_submodule_repo_env(&cp
.env_array
);
1870 if (run_command(&cp
))
1871 die(_("could not recurse into submodule '%s'"), path
);
1873 strbuf_release(&sb
);
1877 const char *get_superproject_working_tree(void)
1879 struct child_process cp
= CHILD_PROCESS_INIT
;
1880 struct strbuf sb
= STRBUF_INIT
;
1881 const char *one_up
= real_path_if_valid("../");
1882 const char *cwd
= xgetcwd();
1883 const char *ret
= NULL
;
1884 const char *subpath
;
1888 if (!is_inside_work_tree())
1891 * We might have a superproject, but it is harder
1899 subpath
= relative_path(cwd
, one_up
, &sb
);
1901 prepare_submodule_repo_env(&cp
.env_array
);
1902 argv_array_pop(&cp
.env_array
);
1904 argv_array_pushl(&cp
.args
, "--literal-pathspecs", "-C", "..",
1905 "ls-files", "-z", "--stage", "--full-name", "--",
1914 if (start_command(&cp
))
1915 die(_("could not start ls-files in .."));
1917 len
= strbuf_read(&sb
, cp
.out
, PATH_MAX
);
1920 if (starts_with(sb
.buf
, "160000")) {
1922 int cwd_len
= strlen(cwd
);
1923 char *super_sub
, *super_wt
;
1926 * There is a superproject having this repo as a submodule.
1927 * The format is <mode> SP <hash> SP <stage> TAB <full name> \0,
1928 * We're only interested in the name after the tab.
1930 super_sub
= strchr(sb
.buf
, '\t') + 1;
1931 super_sub_len
= strlen(super_sub
);
1933 if (super_sub_len
> cwd_len
||
1934 strcmp(&cwd
[cwd_len
- super_sub_len
], super_sub
))
1935 BUG("returned path string doesn't match cwd?");
1937 super_wt
= xstrdup(cwd
);
1938 super_wt
[cwd_len
- super_sub_len
] = '\0';
1940 ret
= real_path(super_wt
);
1943 strbuf_release(&sb
);
1945 code
= finish_command(&cp
);
1948 /* '../' is not a git repository */
1950 if (code
== 0 && len
== 0)
1951 /* There is an unrelated git repository at '../' */
1954 die(_("ls-tree returned unexpected return code %d"), code
);
1960 * Put the gitdir for a submodule (given relative to the main
1961 * repository worktree) into `buf`, or return -1 on error.
1963 int submodule_to_gitdir(struct strbuf
*buf
, const char *submodule
)
1965 const struct submodule
*sub
;
1966 const char *git_dir
;
1970 strbuf_addstr(buf
, submodule
);
1971 strbuf_complete(buf
, '/');
1972 strbuf_addstr(buf
, ".git");
1974 git_dir
= read_gitfile(buf
->buf
);
1977 strbuf_addstr(buf
, git_dir
);
1979 if (!is_git_directory(buf
->buf
)) {
1980 sub
= submodule_from_path(the_repository
, &null_oid
, submodule
);
1986 strbuf_git_path(buf
, "%s/%s", "modules", sub
->name
);