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 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 format_commit_message(commit
, format
, &sb
, &ctx
);
458 strbuf_addch(&sb
, '\n');
459 if (commit
->object
.flags
& SYMMETRIC_LEFT
)
460 diff_emit_submodule_del(o
, sb
.buf
);
462 diff_emit_submodule_add(o
, sb
.buf
);
467 static void prepare_submodule_repo_env_no_git_dir(struct argv_array
*out
)
469 const char * const *var
;
471 for (var
= local_repo_env
; *var
; var
++) {
472 if (strcmp(*var
, CONFIG_DATA_ENVIRONMENT
))
473 argv_array_push(out
, *var
);
477 void prepare_submodule_repo_env(struct argv_array
*out
)
479 prepare_submodule_repo_env_no_git_dir(out
);
480 argv_array_pushf(out
, "%s=%s", GIT_DIR_ENVIRONMENT
,
481 DEFAULT_GIT_DIR_ENVIRONMENT
);
484 /* Helper function to display the submodule header line prior to the full
485 * summary output. If it can locate the submodule objects directory it will
486 * attempt to lookup both the left and right commits and put them into the
487 * left and right pointers.
489 static void show_submodule_header(struct diff_options
*o
, const char *path
,
490 struct object_id
*one
, struct object_id
*two
,
491 unsigned dirty_submodule
,
492 struct commit
**left
, struct commit
**right
,
493 struct commit_list
**merge_bases
)
495 const char *message
= NULL
;
496 struct strbuf sb
= STRBUF_INIT
;
497 int fast_forward
= 0, fast_backward
= 0;
499 if (dirty_submodule
& DIRTY_SUBMODULE_UNTRACKED
)
500 diff_emit_submodule_untracked(o
, path
);
502 if (dirty_submodule
& DIRTY_SUBMODULE_MODIFIED
)
503 diff_emit_submodule_modified(o
, path
);
505 if (is_null_oid(one
))
506 message
= "(new submodule)";
507 else if (is_null_oid(two
))
508 message
= "(submodule deleted)";
510 if (add_submodule_odb(path
)) {
512 message
= "(commits not present)";
517 * Attempt to lookup the commit references, and determine if this is
518 * a fast forward or fast backwards update.
520 *left
= lookup_commit_reference(the_repository
, one
);
521 *right
= lookup_commit_reference(the_repository
, two
);
524 * Warn about missing commits in the submodule project, but only if
527 if ((!is_null_oid(one
) && !*left
) ||
528 (!is_null_oid(two
) && !*right
))
529 message
= "(commits not present)";
531 *merge_bases
= get_merge_bases(*left
, *right
);
533 if ((*merge_bases
)->item
== *left
)
535 else if ((*merge_bases
)->item
== *right
)
539 if (oideq(one
, two
)) {
545 strbuf_addf(&sb
, "Submodule %s ", path
);
546 strbuf_add_unique_abbrev(&sb
, one
, DEFAULT_ABBREV
);
547 strbuf_addstr(&sb
, (fast_backward
|| fast_forward
) ? ".." : "...");
548 strbuf_add_unique_abbrev(&sb
, two
, DEFAULT_ABBREV
);
550 strbuf_addf(&sb
, " %s\n", message
);
552 strbuf_addf(&sb
, "%s:\n", fast_backward
? " (rewind)" : "");
553 diff_emit_submodule_header(o
, sb
.buf
);
558 void show_submodule_summary(struct diff_options
*o
, const char *path
,
559 struct object_id
*one
, struct object_id
*two
,
560 unsigned dirty_submodule
)
563 struct commit
*left
= NULL
, *right
= NULL
;
564 struct commit_list
*merge_bases
= NULL
;
566 show_submodule_header(o
, path
, one
, two
, dirty_submodule
,
567 &left
, &right
, &merge_bases
);
570 * If we don't have both a left and a right pointer, there is no
571 * reason to try and display a summary. The header line should contain
572 * all the information the user needs.
577 /* Treat revision walker failure the same as missing commits */
578 if (prepare_submodule_summary(&rev
, path
, left
, right
, merge_bases
)) {
579 diff_emit_submodule_error(o
, "(revision walker failed)\n");
583 print_submodule_summary(&rev
, o
);
587 free_commit_list(merge_bases
);
588 clear_commit_marks(left
, ~0);
589 clear_commit_marks(right
, ~0);
592 void show_submodule_inline_diff(struct diff_options
*o
, const char *path
,
593 struct object_id
*one
, struct object_id
*two
,
594 unsigned dirty_submodule
)
596 const struct object_id
*old_oid
= the_hash_algo
->empty_tree
, *new_oid
= the_hash_algo
->empty_tree
;
597 struct commit
*left
= NULL
, *right
= NULL
;
598 struct commit_list
*merge_bases
= NULL
;
599 struct child_process cp
= CHILD_PROCESS_INIT
;
600 struct strbuf sb
= STRBUF_INIT
;
602 show_submodule_header(o
, path
, one
, two
, dirty_submodule
,
603 &left
, &right
, &merge_bases
);
605 /* We need a valid left and right commit to display a difference */
606 if (!(left
|| is_null_oid(one
)) ||
607 !(right
|| is_null_oid(two
)))
620 /* TODO: other options may need to be passed here. */
621 argv_array_pushl(&cp
.args
, "diff", "--submodule=diff", NULL
);
622 argv_array_pushf(&cp
.args
, "--color=%s", want_color(o
->use_color
) ?
625 if (o
->flags
.reverse_diff
) {
626 argv_array_pushf(&cp
.args
, "--src-prefix=%s%s/",
628 argv_array_pushf(&cp
.args
, "--dst-prefix=%s%s/",
631 argv_array_pushf(&cp
.args
, "--src-prefix=%s%s/",
633 argv_array_pushf(&cp
.args
, "--dst-prefix=%s%s/",
636 argv_array_push(&cp
.args
, oid_to_hex(old_oid
));
638 * If the submodule has modified content, we will diff against the
639 * work tree, under the assumption that the user has asked for the
640 * diff format and wishes to actually see all differences even if they
641 * haven't yet been committed to the submodule yet.
643 if (!(dirty_submodule
& DIRTY_SUBMODULE_MODIFIED
))
644 argv_array_push(&cp
.args
, oid_to_hex(new_oid
));
646 prepare_submodule_repo_env(&cp
.env_array
);
647 if (start_command(&cp
))
648 diff_emit_submodule_error(o
, "(diff failed)\n");
650 while (strbuf_getwholeline_fd(&sb
, cp
.out
, '\n') != EOF
)
651 diff_emit_submodule_pipethrough(o
, sb
.buf
, sb
.len
);
653 if (finish_command(&cp
))
654 diff_emit_submodule_error(o
, "(diff failed)\n");
659 free_commit_list(merge_bases
);
661 clear_commit_marks(left
, ~0);
663 clear_commit_marks(right
, ~0);
666 int should_update_submodules(void)
668 return config_update_recurse_submodules
== RECURSE_SUBMODULES_ON
;
671 const struct submodule
*submodule_from_ce(const struct cache_entry
*ce
)
673 if (!S_ISGITLINK(ce
->ce_mode
))
676 if (!should_update_submodules())
679 return submodule_from_path(the_repository
, &null_oid
, ce
->name
);
682 static struct oid_array
*submodule_commits(struct string_list
*submodules
,
685 struct string_list_item
*item
;
687 item
= string_list_insert(submodules
, name
);
689 return (struct oid_array
*) item
->util
;
691 /* NEEDSWORK: should we have oid_array_init()? */
692 item
->util
= xcalloc(1, sizeof(struct oid_array
));
693 return (struct oid_array
*) item
->util
;
696 struct collect_changed_submodules_cb_data
{
697 struct string_list
*changed
;
698 const struct object_id
*commit_oid
;
702 * this would normally be two functions: default_name_from_path() and
703 * path_from_default_name(). Since the default name is the same as
704 * the submodule path we can get away with just one function which only
705 * checks whether there is a submodule in the working directory at that
708 static const char *default_name_or_path(const char *path_or_name
)
712 if (!is_submodule_populated_gently(path_or_name
, &error_code
))
718 static void collect_changed_submodules_cb(struct diff_queue_struct
*q
,
719 struct diff_options
*options
,
722 struct collect_changed_submodules_cb_data
*me
= data
;
723 struct string_list
*changed
= me
->changed
;
724 const struct object_id
*commit_oid
= me
->commit_oid
;
727 for (i
= 0; i
< q
->nr
; i
++) {
728 struct diff_filepair
*p
= q
->queue
[i
];
729 struct oid_array
*commits
;
730 const struct submodule
*submodule
;
733 if (!S_ISGITLINK(p
->two
->mode
))
736 submodule
= submodule_from_path(the_repository
,
737 commit_oid
, p
->two
->path
);
739 name
= submodule
->name
;
741 name
= default_name_or_path(p
->two
->path
);
742 /* make sure name does not collide with existing one */
744 submodule
= submodule_from_name(the_repository
,
747 warning("Submodule in commit %s at path: "
748 "'%s' collides with a submodule named "
749 "the same. Skipping it.",
750 oid_to_hex(commit_oid
), p
->two
->path
);
758 commits
= submodule_commits(changed
, name
);
759 oid_array_append(commits
, &p
->two
->oid
);
764 * Collect the paths of submodules in 'changed' which have changed based on
765 * the revisions as specified in 'argv'. Each entry in 'changed' will also
766 * have a corresponding 'struct oid_array' (in the 'util' field) which lists
767 * what the submodule pointers were updated to during the change.
769 static void collect_changed_submodules(struct index_state
*istate
,
770 struct string_list
*changed
,
771 struct argv_array
*argv
)
774 const struct commit
*commit
;
776 repo_init_revisions(the_repository
, &rev
, NULL
);
777 setup_revisions(argv
->argc
, argv
->argv
, &rev
, NULL
);
778 if (prepare_revision_walk(&rev
))
779 die("revision walk setup failed");
781 while ((commit
= get_revision(&rev
))) {
782 struct rev_info diff_rev
;
783 struct collect_changed_submodules_cb_data data
;
784 data
.changed
= changed
;
785 data
.commit_oid
= &commit
->object
.oid
;
787 repo_init_revisions(the_repository
, &diff_rev
, NULL
);
788 diff_rev
.diffopt
.output_format
|= DIFF_FORMAT_CALLBACK
;
789 diff_rev
.diffopt
.format_callback
= collect_changed_submodules_cb
;
790 diff_rev
.diffopt
.format_callback_data
= &data
;
791 diff_tree_combined_merge(commit
, 1, &diff_rev
);
794 reset_revision_walk();
797 static void free_submodules_oids(struct string_list
*submodules
)
799 struct string_list_item
*item
;
800 for_each_string_list_item(item
, submodules
)
801 oid_array_clear((struct oid_array
*) item
->util
);
802 string_list_clear(submodules
, 1);
805 static int has_remote(const char *refname
, const struct object_id
*oid
,
806 int flags
, void *cb_data
)
811 static int append_oid_to_argv(const struct object_id
*oid
, void *data
)
813 struct argv_array
*argv
= data
;
814 argv_array_push(argv
, oid_to_hex(oid
));
818 struct has_commit_data
{
823 static int check_has_commit(const struct object_id
*oid
, void *data
)
825 struct has_commit_data
*cb
= data
;
827 enum object_type type
= oid_object_info(the_repository
, oid
, NULL
);
834 * Object is missing or invalid. If invalid, an error message
835 * has already been printed.
840 die(_("submodule entry '%s' (%s) is a %s, not a commit"),
841 cb
->path
, oid_to_hex(oid
), type_name(type
));
845 static int submodule_has_commits(const char *path
, struct oid_array
*commits
)
847 struct has_commit_data has_commit
= { 1, path
};
850 * Perform a cheap, but incorrect check for the existence of 'commits'.
851 * This is done by adding the submodule's object store to the in-core
852 * object store, and then querying for each commit's existence. If we
853 * do not have the commit object anywhere, there is no chance we have
854 * it in the object store of the correct submodule and have it
855 * reachable from a ref, so we can fail early without spawning rev-list
856 * which is expensive.
858 if (add_submodule_odb(path
))
861 oid_array_for_each_unique(commits
, check_has_commit
, &has_commit
);
863 if (has_commit
.result
) {
865 * Even if the submodule is checked out and the commit is
866 * present, make sure it exists in the submodule's object store
867 * and that it is reachable from a ref.
869 struct child_process cp
= CHILD_PROCESS_INIT
;
870 struct strbuf out
= STRBUF_INIT
;
872 argv_array_pushl(&cp
.args
, "rev-list", "-n", "1", NULL
);
873 oid_array_for_each_unique(commits
, append_oid_to_argv
, &cp
.args
);
874 argv_array_pushl(&cp
.args
, "--not", "--all", NULL
);
876 prepare_submodule_repo_env(&cp
.env_array
);
881 if (capture_command(&cp
, &out
, GIT_MAX_HEXSZ
+ 1) || out
.len
)
882 has_commit
.result
= 0;
884 strbuf_release(&out
);
887 return has_commit
.result
;
890 static int submodule_needs_pushing(const char *path
, struct oid_array
*commits
)
892 if (!submodule_has_commits(path
, commits
))
894 * NOTE: We do consider it safe to return "no" here. The
895 * correct answer would be "We do not know" instead of
896 * "No push needed", but it is quite hard to change
897 * the submodule pointer without having the submodule
898 * around. If a user did however change the submodules
899 * without having the submodule around, this indicates
900 * an expert who knows what they are doing or a
901 * maintainer integrating work from other people. In
902 * both cases it should be safe to skip this check.
906 if (for_each_remote_ref_submodule(path
, has_remote
, NULL
) > 0) {
907 struct child_process cp
= CHILD_PROCESS_INIT
;
908 struct strbuf buf
= STRBUF_INIT
;
909 int needs_pushing
= 0;
911 argv_array_push(&cp
.args
, "rev-list");
912 oid_array_for_each_unique(commits
, append_oid_to_argv
, &cp
.args
);
913 argv_array_pushl(&cp
.args
, "--not", "--remotes", "-n", "1" , NULL
);
915 prepare_submodule_repo_env(&cp
.env_array
);
920 if (start_command(&cp
))
921 die("Could not run 'git rev-list <commits> --not --remotes -n 1' command in submodule %s",
923 if (strbuf_read(&buf
, cp
.out
, 41))
927 strbuf_release(&buf
);
928 return needs_pushing
;
934 int find_unpushed_submodules(struct index_state
*istate
,
935 struct oid_array
*commits
,
936 const char *remotes_name
,
937 struct string_list
*needs_pushing
)
939 struct string_list submodules
= STRING_LIST_INIT_DUP
;
940 struct string_list_item
*name
;
941 struct argv_array argv
= ARGV_ARRAY_INIT
;
943 /* argv.argv[0] will be ignored by setup_revisions */
944 argv_array_push(&argv
, "find_unpushed_submodules");
945 oid_array_for_each_unique(commits
, append_oid_to_argv
, &argv
);
946 argv_array_push(&argv
, "--not");
947 argv_array_pushf(&argv
, "--remotes=%s", remotes_name
);
949 collect_changed_submodules(istate
, &submodules
, &argv
);
951 for_each_string_list_item(name
, &submodules
) {
952 struct oid_array
*commits
= name
->util
;
953 const struct submodule
*submodule
;
954 const char *path
= NULL
;
956 submodule
= submodule_from_name(the_repository
, &null_oid
, name
->string
);
958 path
= submodule
->path
;
960 path
= default_name_or_path(name
->string
);
965 if (submodule_needs_pushing(path
, commits
))
966 string_list_insert(needs_pushing
, path
);
969 free_submodules_oids(&submodules
);
970 argv_array_clear(&argv
);
972 return needs_pushing
->nr
;
975 static int push_submodule(const char *path
,
976 const struct remote
*remote
,
977 const struct refspec
*rs
,
978 const struct string_list
*push_options
,
981 if (add_submodule_odb(path
))
984 if (for_each_remote_ref_submodule(path
, has_remote
, NULL
) > 0) {
985 struct child_process cp
= CHILD_PROCESS_INIT
;
986 argv_array_push(&cp
.args
, "push");
988 argv_array_push(&cp
.args
, "--dry-run");
990 if (push_options
&& push_options
->nr
) {
991 const struct string_list_item
*item
;
992 for_each_string_list_item(item
, push_options
)
993 argv_array_pushf(&cp
.args
, "--push-option=%s",
997 if (remote
->origin
!= REMOTE_UNCONFIGURED
) {
999 argv_array_push(&cp
.args
, remote
->name
);
1000 for (i
= 0; i
< rs
->raw_nr
; i
++)
1001 argv_array_push(&cp
.args
, rs
->raw
[i
]);
1004 prepare_submodule_repo_env(&cp
.env_array
);
1008 if (run_command(&cp
))
1017 * Perform a check in the submodule to see if the remote and refspec work.
1018 * Die if the submodule can't be pushed.
1020 static void submodule_push_check(const char *path
, const char *head
,
1021 const struct remote
*remote
,
1022 const struct refspec
*rs
)
1024 struct child_process cp
= CHILD_PROCESS_INIT
;
1027 argv_array_push(&cp
.args
, "submodule--helper");
1028 argv_array_push(&cp
.args
, "push-check");
1029 argv_array_push(&cp
.args
, head
);
1030 argv_array_push(&cp
.args
, remote
->name
);
1032 for (i
= 0; i
< rs
->raw_nr
; i
++)
1033 argv_array_push(&cp
.args
, rs
->raw
[i
]);
1035 prepare_submodule_repo_env(&cp
.env_array
);
1042 * Simply indicate if 'submodule--helper push-check' failed.
1043 * More detailed error information will be provided by the
1046 if (run_command(&cp
))
1047 die("process for submodule '%s' failed", path
);
1050 int push_unpushed_submodules(struct index_state
*istate
,
1051 struct oid_array
*commits
,
1052 const struct remote
*remote
,
1053 const struct refspec
*rs
,
1054 const struct string_list
*push_options
,
1058 struct string_list needs_pushing
= STRING_LIST_INIT_DUP
;
1060 if (!find_unpushed_submodules(istate
, commits
,
1061 remote
->name
, &needs_pushing
))
1065 * Verify that the remote and refspec can be propagated to all
1066 * submodules. This check can be skipped if the remote and refspec
1067 * won't be propagated due to the remote being unconfigured (e.g. a URL
1068 * instead of a remote name).
1070 if (remote
->origin
!= REMOTE_UNCONFIGURED
) {
1072 struct object_id head_oid
;
1074 head
= resolve_refdup("HEAD", 0, &head_oid
, NULL
);
1076 die(_("Failed to resolve HEAD as a valid ref."));
1078 for (i
= 0; i
< needs_pushing
.nr
; i
++)
1079 submodule_push_check(needs_pushing
.items
[i
].string
,
1084 /* Actually push the submodules */
1085 for (i
= 0; i
< needs_pushing
.nr
; i
++) {
1086 const char *path
= needs_pushing
.items
[i
].string
;
1087 fprintf(stderr
, "Pushing submodule '%s'\n", path
);
1088 if (!push_submodule(path
, remote
, rs
,
1089 push_options
, dry_run
)) {
1090 fprintf(stderr
, "Unable to push submodule '%s'\n", path
);
1095 string_list_clear(&needs_pushing
, 0);
1100 static int append_oid_to_array(const char *ref
, const struct object_id
*oid
,
1101 int flags
, void *data
)
1103 struct oid_array
*array
= data
;
1104 oid_array_append(array
, oid
);
1108 void check_for_new_submodule_commits(struct object_id
*oid
)
1110 if (!initialized_fetch_ref_tips
) {
1111 for_each_ref(append_oid_to_array
, &ref_tips_before_fetch
);
1112 initialized_fetch_ref_tips
= 1;
1115 oid_array_append(&ref_tips_after_fetch
, oid
);
1118 static void calculate_changed_submodule_paths(struct index_state
*istate
)
1120 struct argv_array argv
= ARGV_ARRAY_INIT
;
1121 struct string_list changed_submodules
= STRING_LIST_INIT_DUP
;
1122 const struct string_list_item
*name
;
1124 /* No need to check if there are no submodules configured */
1125 if (!submodule_from_path(the_repository
, NULL
, NULL
))
1128 argv_array_push(&argv
, "--"); /* argv[0] program name */
1129 oid_array_for_each_unique(&ref_tips_after_fetch
,
1130 append_oid_to_argv
, &argv
);
1131 argv_array_push(&argv
, "--not");
1132 oid_array_for_each_unique(&ref_tips_before_fetch
,
1133 append_oid_to_argv
, &argv
);
1136 * Collect all submodules (whether checked out or not) for which new
1137 * commits have been recorded upstream in "changed_submodule_names".
1139 collect_changed_submodules(istate
, &changed_submodules
, &argv
);
1141 for_each_string_list_item(name
, &changed_submodules
) {
1142 struct oid_array
*commits
= name
->util
;
1143 const struct submodule
*submodule
;
1144 const char *path
= NULL
;
1146 submodule
= submodule_from_name(the_repository
, &null_oid
, name
->string
);
1148 path
= submodule
->path
;
1150 path
= default_name_or_path(name
->string
);
1155 if (!submodule_has_commits(path
, commits
))
1156 string_list_append(&changed_submodule_names
, name
->string
);
1159 free_submodules_oids(&changed_submodules
);
1160 argv_array_clear(&argv
);
1161 oid_array_clear(&ref_tips_before_fetch
);
1162 oid_array_clear(&ref_tips_after_fetch
);
1163 initialized_fetch_ref_tips
= 0;
1166 int submodule_touches_in_range(struct index_state
*istate
,
1167 struct object_id
*excl_oid
,
1168 struct object_id
*incl_oid
)
1170 struct string_list subs
= STRING_LIST_INIT_DUP
;
1171 struct argv_array args
= ARGV_ARRAY_INIT
;
1174 /* No need to check if there are no submodules configured */
1175 if (!submodule_from_path(the_repository
, NULL
, NULL
))
1178 argv_array_push(&args
, "--"); /* args[0] program name */
1179 argv_array_push(&args
, oid_to_hex(incl_oid
));
1180 if (!is_null_oid(excl_oid
)) {
1181 argv_array_push(&args
, "--not");
1182 argv_array_push(&args
, oid_to_hex(excl_oid
));
1185 collect_changed_submodules(istate
, &subs
, &args
);
1188 argv_array_clear(&args
);
1190 free_submodules_oids(&subs
);
1194 struct submodule_parallel_fetch
{
1196 struct argv_array args
;
1197 struct repository
*r
;
1199 int command_line_option
;
1204 #define SPF_INIT {0, ARGV_ARRAY_INIT, NULL, NULL, 0, 0, 0, 0}
1206 static int get_fetch_recurse_config(const struct submodule
*submodule
,
1207 struct submodule_parallel_fetch
*spf
)
1209 if (spf
->command_line_option
!= RECURSE_SUBMODULES_DEFAULT
)
1210 return spf
->command_line_option
;
1216 int fetch_recurse
= submodule
->fetch_recurse
;
1217 key
= xstrfmt("submodule.%s.fetchRecurseSubmodules", submodule
->name
);
1218 if (!repo_config_get_string_const(spf
->r
, key
, &value
)) {
1219 fetch_recurse
= parse_fetch_recurse_submodules_arg(key
, value
);
1223 if (fetch_recurse
!= RECURSE_SUBMODULES_NONE
)
1224 /* local config overrules everything except commandline */
1225 return fetch_recurse
;
1228 return spf
->default_option
;
1231 static int get_next_submodule(struct child_process
*cp
,
1232 struct strbuf
*err
, void *data
, void **task_cb
)
1235 struct submodule_parallel_fetch
*spf
= data
;
1237 for (; spf
->count
< spf
->r
->index
->cache_nr
; spf
->count
++) {
1238 struct strbuf submodule_path
= STRBUF_INIT
;
1239 struct strbuf submodule_git_dir
= STRBUF_INIT
;
1240 struct strbuf submodule_prefix
= STRBUF_INIT
;
1241 const struct cache_entry
*ce
= spf
->r
->index
->cache
[spf
->count
];
1242 const char *git_dir
, *default_argv
;
1243 const struct submodule
*submodule
;
1244 struct submodule default_submodule
= SUBMODULE_INIT
;
1246 if (!S_ISGITLINK(ce
->ce_mode
))
1249 submodule
= submodule_from_path(spf
->r
, &null_oid
, ce
->name
);
1251 const char *name
= default_name_or_path(ce
->name
);
1253 default_submodule
.path
= default_submodule
.name
= name
;
1254 submodule
= &default_submodule
;
1258 switch (get_fetch_recurse_config(submodule
, spf
))
1261 case RECURSE_SUBMODULES_DEFAULT
:
1262 case RECURSE_SUBMODULES_ON_DEMAND
:
1263 if (!submodule
|| !unsorted_string_list_lookup(&changed_submodule_names
,
1266 default_argv
= "on-demand";
1268 case RECURSE_SUBMODULES_ON
:
1269 default_argv
= "yes";
1271 case RECURSE_SUBMODULES_OFF
:
1275 strbuf_repo_worktree_path(&submodule_path
, spf
->r
, "%s", ce
->name
);
1276 strbuf_addf(&submodule_git_dir
, "%s/.git", submodule_path
.buf
);
1277 strbuf_addf(&submodule_prefix
, "%s%s/", spf
->prefix
, ce
->name
);
1278 git_dir
= read_gitfile(submodule_git_dir
.buf
);
1280 git_dir
= submodule_git_dir
.buf
;
1281 if (is_directory(git_dir
)) {
1282 child_process_init(cp
);
1283 cp
->dir
= strbuf_detach(&submodule_path
, NULL
);
1284 prepare_submodule_repo_env(&cp
->env_array
);
1287 strbuf_addf(err
, "Fetching submodule %s%s\n",
1288 spf
->prefix
, ce
->name
);
1289 argv_array_init(&cp
->args
);
1290 argv_array_pushv(&cp
->args
, spf
->args
.argv
);
1291 argv_array_push(&cp
->args
, default_argv
);
1292 argv_array_push(&cp
->args
, "--submodule-prefix");
1293 argv_array_push(&cp
->args
, submodule_prefix
.buf
);
1296 strbuf_release(&submodule_path
);
1297 strbuf_release(&submodule_git_dir
);
1298 strbuf_release(&submodule_prefix
);
1307 static int fetch_start_failure(struct strbuf
*err
,
1308 void *cb
, void *task_cb
)
1310 struct submodule_parallel_fetch
*spf
= cb
;
1317 static int fetch_finish(int retvalue
, struct strbuf
*err
,
1318 void *cb
, void *task_cb
)
1320 struct submodule_parallel_fetch
*spf
= cb
;
1328 int fetch_populated_submodules(struct repository
*r
,
1329 const struct argv_array
*options
,
1330 const char *prefix
, int command_line_option
,
1332 int quiet
, int max_parallel_jobs
)
1335 struct submodule_parallel_fetch spf
= SPF_INIT
;
1338 spf
.command_line_option
= command_line_option
;
1339 spf
.default_option
= default_option
;
1341 spf
.prefix
= prefix
;
1346 if (repo_read_index(r
) < 0)
1347 die("index file corrupt");
1349 argv_array_push(&spf
.args
, "fetch");
1350 for (i
= 0; i
< options
->argc
; i
++)
1351 argv_array_push(&spf
.args
, options
->argv
[i
]);
1352 argv_array_push(&spf
.args
, "--recurse-submodules-default");
1353 /* default value, "--submodule-prefix" and its value are added later */
1355 calculate_changed_submodule_paths(r
->index
);
1356 run_processes_parallel(max_parallel_jobs
,
1358 fetch_start_failure
,
1362 argv_array_clear(&spf
.args
);
1364 string_list_clear(&changed_submodule_names
, 1);
1368 unsigned is_submodule_modified(const char *path
, int ignore_untracked
)
1370 struct child_process cp
= CHILD_PROCESS_INIT
;
1371 struct strbuf buf
= STRBUF_INIT
;
1373 unsigned dirty_submodule
= 0;
1374 const char *git_dir
;
1375 int ignore_cp_exit_code
= 0;
1377 strbuf_addf(&buf
, "%s/.git", path
);
1378 git_dir
= read_gitfile(buf
.buf
);
1381 if (!is_git_directory(git_dir
)) {
1382 if (is_directory(git_dir
))
1383 die(_("'%s' not recognized as a git repository"), git_dir
);
1384 strbuf_release(&buf
);
1385 /* The submodule is not checked out, so it is not modified */
1390 argv_array_pushl(&cp
.args
, "status", "--porcelain=2", NULL
);
1391 if (ignore_untracked
)
1392 argv_array_push(&cp
.args
, "-uno");
1394 prepare_submodule_repo_env(&cp
.env_array
);
1399 if (start_command(&cp
))
1400 die("Could not run 'git status --porcelain=2' in submodule %s", path
);
1402 fp
= xfdopen(cp
.out
, "r");
1403 while (strbuf_getwholeline(&buf
, fp
, '\n') != EOF
) {
1404 /* regular untracked files */
1405 if (buf
.buf
[0] == '?')
1406 dirty_submodule
|= DIRTY_SUBMODULE_UNTRACKED
;
1408 if (buf
.buf
[0] == 'u' ||
1409 buf
.buf
[0] == '1' ||
1410 buf
.buf
[0] == '2') {
1411 /* T = line type, XY = status, SSSS = submodule state */
1412 if (buf
.len
< strlen("T XY SSSS"))
1413 BUG("invalid status --porcelain=2 line %s",
1416 if (buf
.buf
[5] == 'S' && buf
.buf
[8] == 'U')
1417 /* nested untracked file */
1418 dirty_submodule
|= DIRTY_SUBMODULE_UNTRACKED
;
1420 if (buf
.buf
[0] == 'u' ||
1421 buf
.buf
[0] == '2' ||
1422 memcmp(buf
.buf
+ 5, "S..U", 4))
1424 dirty_submodule
|= DIRTY_SUBMODULE_MODIFIED
;
1427 if ((dirty_submodule
& DIRTY_SUBMODULE_MODIFIED
) &&
1428 ((dirty_submodule
& DIRTY_SUBMODULE_UNTRACKED
) ||
1429 ignore_untracked
)) {
1431 * We're not interested in any further information from
1432 * the child any more, neither output nor its exit code.
1434 ignore_cp_exit_code
= 1;
1440 if (finish_command(&cp
) && !ignore_cp_exit_code
)
1441 die("'git status --porcelain=2' failed in submodule %s", path
);
1443 strbuf_release(&buf
);
1444 return dirty_submodule
;
1447 int submodule_uses_gitfile(const char *path
)
1449 struct child_process cp
= CHILD_PROCESS_INIT
;
1450 const char *argv
[] = {
1458 struct strbuf buf
= STRBUF_INIT
;
1459 const char *git_dir
;
1461 strbuf_addf(&buf
, "%s/.git", path
);
1462 git_dir
= read_gitfile(buf
.buf
);
1464 strbuf_release(&buf
);
1467 strbuf_release(&buf
);
1469 /* Now test that all nested submodules use a gitfile too */
1471 prepare_submodule_repo_env(&cp
.env_array
);
1477 if (run_command(&cp
))
1484 * Check if it is a bad idea to remove a submodule, i.e. if we'd lose data
1487 * Return 1 if we'd lose data, return 0 if the removal is fine,
1488 * and negative values for errors.
1490 int bad_to_remove_submodule(const char *path
, unsigned flags
)
1493 struct child_process cp
= CHILD_PROCESS_INIT
;
1494 struct strbuf buf
= STRBUF_INIT
;
1497 if (!file_exists(path
) || is_empty_dir(path
))
1500 if (!submodule_uses_gitfile(path
))
1503 argv_array_pushl(&cp
.args
, "status", "--porcelain",
1504 "--ignore-submodules=none", NULL
);
1506 if (flags
& SUBMODULE_REMOVAL_IGNORE_UNTRACKED
)
1507 argv_array_push(&cp
.args
, "-uno");
1509 argv_array_push(&cp
.args
, "-uall");
1511 if (!(flags
& SUBMODULE_REMOVAL_IGNORE_IGNORED_UNTRACKED
))
1512 argv_array_push(&cp
.args
, "--ignored");
1514 prepare_submodule_repo_env(&cp
.env_array
);
1519 if (start_command(&cp
)) {
1520 if (flags
& SUBMODULE_REMOVAL_DIE_ON_ERROR
)
1521 die(_("could not start 'git status' in submodule '%s'"),
1527 len
= strbuf_read(&buf
, cp
.out
, 1024);
1532 if (finish_command(&cp
)) {
1533 if (flags
& SUBMODULE_REMOVAL_DIE_ON_ERROR
)
1534 die(_("could not run 'git status' in submodule '%s'"),
1539 strbuf_release(&buf
);
1543 static const char *get_super_prefix_or_empty(void)
1545 const char *s
= get_super_prefix();
1551 static int submodule_has_dirty_index(const struct submodule
*sub
)
1553 struct child_process cp
= CHILD_PROCESS_INIT
;
1555 prepare_submodule_repo_env(&cp
.env_array
);
1558 argv_array_pushl(&cp
.args
, "diff-index", "--quiet",
1559 "--cached", "HEAD", NULL
);
1563 if (start_command(&cp
))
1564 die("could not recurse into submodule '%s'", sub
->path
);
1566 return finish_command(&cp
);
1569 static void submodule_reset_index(const char *path
)
1571 struct child_process cp
= CHILD_PROCESS_INIT
;
1572 prepare_submodule_repo_env(&cp
.env_array
);
1578 argv_array_pushf(&cp
.args
, "--super-prefix=%s%s/",
1579 get_super_prefix_or_empty(), path
);
1580 argv_array_pushl(&cp
.args
, "read-tree", "-u", "--reset", NULL
);
1582 argv_array_push(&cp
.args
, empty_tree_oid_hex());
1584 if (run_command(&cp
))
1585 die("could not reset submodule index");
1589 * Moves a submodule at a given path from a given head to another new head.
1590 * For edge cases (a submodule coming into existence or removing a submodule)
1591 * pass NULL for old or new respectively.
1593 int submodule_move_head(const char *path
,
1594 const char *old_head
,
1595 const char *new_head
,
1599 struct child_process cp
= CHILD_PROCESS_INIT
;
1600 const struct submodule
*sub
;
1601 int *error_code_ptr
, error_code
;
1603 if (!is_submodule_active(the_repository
, path
))
1606 if (flags
& SUBMODULE_MOVE_HEAD_FORCE
)
1608 * Pass non NULL pointer to is_submodule_populated_gently
1609 * to prevent die()-ing. We'll use connect_work_tree_and_git_dir
1610 * to fixup the submodule in the force case later.
1612 error_code_ptr
= &error_code
;
1614 error_code_ptr
= NULL
;
1616 if (old_head
&& !is_submodule_populated_gently(path
, error_code_ptr
))
1619 sub
= submodule_from_path(the_repository
, &null_oid
, path
);
1622 BUG("could not get submodule information for '%s'", path
);
1624 if (old_head
&& !(flags
& SUBMODULE_MOVE_HEAD_FORCE
)) {
1625 /* Check if the submodule has a dirty index. */
1626 if (submodule_has_dirty_index(sub
))
1627 return error(_("submodule '%s' has dirty index"), path
);
1630 if (!(flags
& SUBMODULE_MOVE_HEAD_DRY_RUN
)) {
1632 if (!submodule_uses_gitfile(path
))
1633 absorb_git_dir_into_superproject("", path
,
1634 ABSORB_GITDIR_RECURSE_SUBMODULES
);
1636 char *gitdir
= xstrfmt("%s/modules/%s",
1637 get_git_common_dir(), sub
->name
);
1638 connect_work_tree_and_git_dir(path
, gitdir
, 0);
1641 /* make sure the index is clean as well */
1642 submodule_reset_index(path
);
1645 if (old_head
&& (flags
& SUBMODULE_MOVE_HEAD_FORCE
)) {
1646 char *gitdir
= xstrfmt("%s/modules/%s",
1647 get_git_common_dir(), sub
->name
);
1648 connect_work_tree_and_git_dir(path
, gitdir
, 1);
1653 prepare_submodule_repo_env(&cp
.env_array
);
1659 argv_array_pushf(&cp
.args
, "--super-prefix=%s%s/",
1660 get_super_prefix_or_empty(), path
);
1661 argv_array_pushl(&cp
.args
, "read-tree", "--recurse-submodules", NULL
);
1663 if (flags
& SUBMODULE_MOVE_HEAD_DRY_RUN
)
1664 argv_array_push(&cp
.args
, "-n");
1666 argv_array_push(&cp
.args
, "-u");
1668 if (flags
& SUBMODULE_MOVE_HEAD_FORCE
)
1669 argv_array_push(&cp
.args
, "--reset");
1671 argv_array_push(&cp
.args
, "-m");
1673 if (!(flags
& SUBMODULE_MOVE_HEAD_FORCE
))
1674 argv_array_push(&cp
.args
, old_head
? old_head
: empty_tree_oid_hex());
1676 argv_array_push(&cp
.args
, new_head
? new_head
: empty_tree_oid_hex());
1678 if (run_command(&cp
)) {
1679 ret
= error(_("Submodule '%s' could not be updated."), path
);
1683 if (!(flags
& SUBMODULE_MOVE_HEAD_DRY_RUN
)) {
1685 child_process_init(&cp
);
1686 /* also set the HEAD accordingly */
1691 prepare_submodule_repo_env(&cp
.env_array
);
1692 argv_array_pushl(&cp
.args
, "update-ref", "HEAD",
1693 "--no-deref", new_head
, NULL
);
1695 if (run_command(&cp
)) {
1700 struct strbuf sb
= STRBUF_INIT
;
1702 strbuf_addf(&sb
, "%s/.git", path
);
1703 unlink_or_warn(sb
.buf
);
1704 strbuf_release(&sb
);
1706 if (is_empty_dir(path
))
1707 rmdir_or_warn(path
);
1715 * Embeds a single submodules git directory into the superprojects git dir,
1718 static void relocate_single_git_dir_into_superproject(const char *prefix
,
1721 char *old_git_dir
= NULL
, *real_old_git_dir
= NULL
, *real_new_git_dir
= NULL
;
1722 const char *new_git_dir
;
1723 const struct submodule
*sub
;
1725 if (submodule_uses_worktrees(path
))
1726 die(_("relocate_gitdir for submodule '%s' with "
1727 "more than one worktree not supported"), path
);
1729 old_git_dir
= xstrfmt("%s/.git", path
);
1730 if (read_gitfile(old_git_dir
))
1731 /* If it is an actual gitfile, it doesn't need migration. */
1734 real_old_git_dir
= real_pathdup(old_git_dir
, 1);
1736 sub
= submodule_from_path(the_repository
, &null_oid
, path
);
1738 die(_("could not lookup name for submodule '%s'"), path
);
1740 new_git_dir
= git_path("modules/%s", sub
->name
);
1741 if (safe_create_leading_directories_const(new_git_dir
) < 0)
1742 die(_("could not create directory '%s'"), new_git_dir
);
1743 real_new_git_dir
= real_pathdup(new_git_dir
, 1);
1745 fprintf(stderr
, _("Migrating git directory of '%s%s' from\n'%s' to\n'%s'\n"),
1746 get_super_prefix_or_empty(), path
,
1747 real_old_git_dir
, real_new_git_dir
);
1749 relocate_gitdir(path
, real_old_git_dir
, real_new_git_dir
);
1752 free(real_old_git_dir
);
1753 free(real_new_git_dir
);
1757 * Migrate the git directory of the submodule given by path from
1758 * having its git directory within the working tree to the git dir nested
1759 * in its superprojects git dir under modules/.
1761 void absorb_git_dir_into_superproject(const char *prefix
,
1766 const char *sub_git_dir
;
1767 struct strbuf gitdir
= STRBUF_INIT
;
1768 strbuf_addf(&gitdir
, "%s/.git", path
);
1769 sub_git_dir
= resolve_gitdir_gently(gitdir
.buf
, &err_code
);
1771 /* Not populated? */
1773 const struct submodule
*sub
;
1775 if (err_code
== READ_GITFILE_ERR_STAT_FAILED
) {
1776 /* unpopulated as expected */
1777 strbuf_release(&gitdir
);
1781 if (err_code
!= READ_GITFILE_ERR_NOT_A_REPO
)
1782 /* We don't know what broke here. */
1783 read_gitfile_error_die(err_code
, path
, NULL
);
1786 * Maybe populated, but no git directory was found?
1787 * This can happen if the superproject is a submodule
1788 * itself and was just absorbed. The absorption of the
1789 * superproject did not rewrite the git file links yet,
1792 sub
= submodule_from_path(the_repository
, &null_oid
, path
);
1794 die(_("could not lookup name for submodule '%s'"), path
);
1795 connect_work_tree_and_git_dir(path
,
1796 git_path("modules/%s", sub
->name
), 0);
1798 /* Is it already absorbed into the superprojects git dir? */
1799 char *real_sub_git_dir
= real_pathdup(sub_git_dir
, 1);
1800 char *real_common_git_dir
= real_pathdup(get_git_common_dir(), 1);
1802 if (!starts_with(real_sub_git_dir
, real_common_git_dir
))
1803 relocate_single_git_dir_into_superproject(prefix
, path
);
1805 free(real_sub_git_dir
);
1806 free(real_common_git_dir
);
1808 strbuf_release(&gitdir
);
1810 if (flags
& ABSORB_GITDIR_RECURSE_SUBMODULES
) {
1811 struct child_process cp
= CHILD_PROCESS_INIT
;
1812 struct strbuf sb
= STRBUF_INIT
;
1814 if (flags
& ~ABSORB_GITDIR_RECURSE_SUBMODULES
)
1815 BUG("we don't know how to pass the flags down?");
1817 strbuf_addstr(&sb
, get_super_prefix_or_empty());
1818 strbuf_addstr(&sb
, path
);
1819 strbuf_addch(&sb
, '/');
1824 argv_array_pushl(&cp
.args
, "--super-prefix", sb
.buf
,
1825 "submodule--helper",
1826 "absorb-git-dirs", NULL
);
1827 prepare_submodule_repo_env(&cp
.env_array
);
1828 if (run_command(&cp
))
1829 die(_("could not recurse into submodule '%s'"), path
);
1831 strbuf_release(&sb
);
1835 const char *get_superproject_working_tree(void)
1837 struct child_process cp
= CHILD_PROCESS_INIT
;
1838 struct strbuf sb
= STRBUF_INIT
;
1839 const char *one_up
= real_path_if_valid("../");
1840 const char *cwd
= xgetcwd();
1841 const char *ret
= NULL
;
1842 const char *subpath
;
1846 if (!is_inside_work_tree())
1849 * We might have a superproject, but it is harder
1857 subpath
= relative_path(cwd
, one_up
, &sb
);
1859 prepare_submodule_repo_env(&cp
.env_array
);
1860 argv_array_pop(&cp
.env_array
);
1862 argv_array_pushl(&cp
.args
, "--literal-pathspecs", "-C", "..",
1863 "ls-files", "-z", "--stage", "--full-name", "--",
1872 if (start_command(&cp
))
1873 die(_("could not start ls-files in .."));
1875 len
= strbuf_read(&sb
, cp
.out
, PATH_MAX
);
1878 if (starts_with(sb
.buf
, "160000")) {
1880 int cwd_len
= strlen(cwd
);
1881 char *super_sub
, *super_wt
;
1884 * There is a superproject having this repo as a submodule.
1885 * The format is <mode> SP <hash> SP <stage> TAB <full name> \0,
1886 * We're only interested in the name after the tab.
1888 super_sub
= strchr(sb
.buf
, '\t') + 1;
1889 super_sub_len
= strlen(super_sub
);
1891 if (super_sub_len
> cwd_len
||
1892 strcmp(&cwd
[cwd_len
- super_sub_len
], super_sub
))
1893 BUG("returned path string doesn't match cwd?");
1895 super_wt
= xstrdup(cwd
);
1896 super_wt
[cwd_len
- super_sub_len
] = '\0';
1898 ret
= real_path(super_wt
);
1901 strbuf_release(&sb
);
1903 code
= finish_command(&cp
);
1906 /* '../' is not a git repository */
1908 if (code
== 0 && len
== 0)
1909 /* There is an unrelated git repository at '../' */
1912 die(_("ls-tree returned unexpected return code %d"), code
);
1918 * Put the gitdir for a submodule (given relative to the main
1919 * repository worktree) into `buf`, or return -1 on error.
1921 int submodule_to_gitdir(struct strbuf
*buf
, const char *submodule
)
1923 const struct submodule
*sub
;
1924 const char *git_dir
;
1928 strbuf_addstr(buf
, submodule
);
1929 strbuf_complete(buf
, '/');
1930 strbuf_addstr(buf
, ".git");
1932 git_dir
= read_gitfile(buf
->buf
);
1935 strbuf_addstr(buf
, git_dir
);
1937 if (!is_git_directory(buf
->buf
)) {
1938 sub
= submodule_from_path(the_repository
, &null_oid
, submodule
);
1944 strbuf_git_path(buf
, "%s/%s", "modules", sub
->name
);