1 #define USE_THE_INDEX_COMPATIBILITY_MACROS
3 #include "repository.h"
6 #include "parse-options.h"
10 #include "submodule.h"
11 #include "submodule-config.h"
12 #include "string-list.h"
13 #include "run-command.h"
21 #include "object-store.h"
25 #define OPT_QUIET (1 << 0)
26 #define OPT_CACHED (1 << 1)
27 #define OPT_RECURSIVE (1 << 2)
28 #define OPT_FORCE (1 << 3)
30 typedef void (*each_submodule_fn
)(const struct cache_entry
*list_item
,
33 static char *get_default_remote(void)
35 char *dest
= NULL
, *ret
;
36 struct strbuf sb
= STRBUF_INIT
;
37 const char *refname
= resolve_ref_unsafe("HEAD", 0, NULL
, NULL
);
40 die(_("No such ref: %s"), "HEAD");
43 if (!strcmp(refname
, "HEAD"))
44 return xstrdup("origin");
46 if (!skip_prefix(refname
, "refs/heads/", &refname
))
47 die(_("Expecting a full ref name, got %s"), refname
);
49 strbuf_addf(&sb
, "branch.%s.remote", refname
);
50 if (git_config_get_string(sb
.buf
, &dest
))
51 ret
= xstrdup("origin");
59 static int print_default_remote(int argc
, const char **argv
, const char *prefix
)
64 die(_("submodule--helper print-default-remote takes no arguments"));
66 remote
= get_default_remote();
68 printf("%s\n", remote
);
74 static int starts_with_dot_slash(const char *str
)
76 return str
[0] == '.' && is_dir_sep(str
[1]);
79 static int starts_with_dot_dot_slash(const char *str
)
81 return str
[0] == '.' && str
[1] == '.' && is_dir_sep(str
[2]);
85 * Returns 1 if it was the last chop before ':'.
87 static int chop_last_dir(char **remoteurl
, int is_relative
)
89 char *rfind
= find_last_dir_sep(*remoteurl
);
95 rfind
= strrchr(*remoteurl
, ':');
101 if (is_relative
|| !strcmp(".", *remoteurl
))
102 die(_("cannot strip one component off url '%s'"),
106 *remoteurl
= xstrdup(".");
111 * The `url` argument is the URL that navigates to the submodule origin
112 * repo. When relative, this URL is relative to the superproject origin
113 * URL repo. The `up_path` argument, if specified, is the relative
114 * path that navigates from the submodule working tree to the superproject
115 * working tree. Returns the origin URL of the submodule.
117 * Return either an absolute URL or filesystem path (if the superproject
118 * origin URL is an absolute URL or filesystem path, respectively) or a
119 * relative file system path (if the superproject origin URL is a relative
122 * When the output is a relative file system path, the path is either
123 * relative to the submodule working tree, if up_path is specified, or to
124 * the superproject working tree otherwise.
126 * NEEDSWORK: This works incorrectly on the domain and protocol part.
127 * remote_url url outcome expectation
128 * http://a.com/b ../c http://a.com/c as is
129 * http://a.com/b/ ../c http://a.com/c same as previous line, but
130 * ignore trailing slash in url
131 * http://a.com/b ../../c http://c error out
132 * http://a.com/b ../../../c http:/c error out
133 * http://a.com/b ../../../../c http:c error out
134 * http://a.com/b ../../../../../c .:c error out
135 * NEEDSWORK: Given how chop_last_dir() works, this function is broken
136 * when a local part has a colon in its path component, too.
138 static char *relative_url(const char *remote_url
,
145 char *remoteurl
= xstrdup(remote_url
);
146 struct strbuf sb
= STRBUF_INIT
;
147 size_t len
= strlen(remoteurl
);
149 if (is_dir_sep(remoteurl
[len
-1]))
150 remoteurl
[len
-1] = '\0';
152 if (!url_is_local_not_ssh(remoteurl
) || is_absolute_path(remoteurl
))
157 * Prepend a './' to ensure all relative
158 * remoteurls start with './' or '../'
160 if (!starts_with_dot_slash(remoteurl
) &&
161 !starts_with_dot_dot_slash(remoteurl
)) {
163 strbuf_addf(&sb
, "./%s", remoteurl
);
165 remoteurl
= strbuf_detach(&sb
, NULL
);
169 * When the url starts with '../', remove that and the
170 * last directory in remoteurl.
173 if (starts_with_dot_dot_slash(url
)) {
175 colonsep
|= chop_last_dir(&remoteurl
, is_relative
);
176 } else if (starts_with_dot_slash(url
))
182 strbuf_addf(&sb
, "%s%s%s", remoteurl
, colonsep
? ":" : "/", url
);
183 if (ends_with(url
, "/"))
184 strbuf_setlen(&sb
, sb
.len
- 1);
187 if (starts_with_dot_slash(sb
.buf
))
188 out
= xstrdup(sb
.buf
+ 2);
190 out
= xstrdup(sb
.buf
);
193 if (!up_path
|| !is_relative
)
196 strbuf_addf(&sb
, "%s%s", up_path
, out
);
198 return strbuf_detach(&sb
, NULL
);
201 static int resolve_relative_url(int argc
, const char **argv
, const char *prefix
)
203 char *remoteurl
= NULL
;
204 char *remote
= get_default_remote();
205 const char *up_path
= NULL
;
208 struct strbuf sb
= STRBUF_INIT
;
210 if (argc
!= 2 && argc
!= 3)
211 die("resolve-relative-url only accepts one or two arguments");
214 strbuf_addf(&sb
, "remote.%s.url", remote
);
217 if (git_config_get_string(sb
.buf
, &remoteurl
))
218 /* the repository is its own authoritative upstream */
219 remoteurl
= xgetcwd();
224 res
= relative_url(remoteurl
, url
, up_path
);
231 static int resolve_relative_url_test(int argc
, const char **argv
, const char *prefix
)
233 char *remoteurl
, *res
;
234 const char *up_path
, *url
;
237 die("resolve-relative-url-test only accepts three arguments: <up_path> <remoteurl> <url>");
240 remoteurl
= xstrdup(argv
[2]);
243 if (!strcmp(up_path
, "(null)"))
246 res
= relative_url(remoteurl
, url
, up_path
);
253 /* the result should be freed by the caller. */
254 static char *get_submodule_displaypath(const char *path
, const char *prefix
)
256 const char *super_prefix
= get_super_prefix();
258 if (prefix
&& super_prefix
) {
259 BUG("cannot have prefix '%s' and superprefix '%s'",
260 prefix
, super_prefix
);
262 struct strbuf sb
= STRBUF_INIT
;
263 char *displaypath
= xstrdup(relative_path(path
, prefix
, &sb
));
266 } else if (super_prefix
) {
267 return xstrfmt("%s%s", super_prefix
, path
);
269 return xstrdup(path
);
273 static char *compute_rev_name(const char *sub_path
, const char* object_id
)
275 struct strbuf sb
= STRBUF_INIT
;
278 static const char *describe_bare
[] = { NULL
};
280 static const char *describe_tags
[] = { "--tags", NULL
};
282 static const char *describe_contains
[] = { "--contains", NULL
};
284 static const char *describe_all_always
[] = { "--all", "--always", NULL
};
286 static const char **describe_argv
[] = { describe_bare
, describe_tags
,
288 describe_all_always
, NULL
};
290 for (d
= describe_argv
; *d
; d
++) {
291 struct child_process cp
= CHILD_PROCESS_INIT
;
292 prepare_submodule_repo_env(&cp
.env_array
);
297 argv_array_push(&cp
.args
, "describe");
298 argv_array_pushv(&cp
.args
, *d
);
299 argv_array_push(&cp
.args
, object_id
);
301 if (!capture_command(&cp
, &sb
, 0)) {
302 strbuf_strip_suffix(&sb
, "\n");
303 return strbuf_detach(&sb
, NULL
);
312 const struct cache_entry
**entries
;
315 #define MODULE_LIST_INIT { NULL, 0, 0 }
317 static int module_list_compute(int argc
, const char **argv
,
319 struct pathspec
*pathspec
,
320 struct module_list
*list
)
323 char *ps_matched
= NULL
;
324 parse_pathspec(pathspec
, 0,
325 PATHSPEC_PREFER_FULL
,
329 ps_matched
= xcalloc(pathspec
->nr
, 1);
331 if (read_cache() < 0)
332 die(_("index file corrupt"));
334 for (i
= 0; i
< active_nr
; i
++) {
335 const struct cache_entry
*ce
= active_cache
[i
];
337 if (!match_pathspec(&the_index
, pathspec
, ce
->name
, ce_namelen(ce
),
339 !S_ISGITLINK(ce
->ce_mode
))
342 ALLOC_GROW(list
->entries
, list
->nr
+ 1, list
->alloc
);
343 list
->entries
[list
->nr
++] = ce
;
344 while (i
+ 1 < active_nr
&&
345 !strcmp(ce
->name
, active_cache
[i
+ 1]->name
))
347 * Skip entries with the same name in different stages
348 * to make sure an entry is returned only once.
353 if (ps_matched
&& report_path_error(ps_matched
, pathspec
))
361 static void module_list_active(struct module_list
*list
)
364 struct module_list active_modules
= MODULE_LIST_INIT
;
366 for (i
= 0; i
< list
->nr
; i
++) {
367 const struct cache_entry
*ce
= list
->entries
[i
];
369 if (!is_submodule_active(the_repository
, ce
->name
))
372 ALLOC_GROW(active_modules
.entries
,
373 active_modules
.nr
+ 1,
374 active_modules
.alloc
);
375 active_modules
.entries
[active_modules
.nr
++] = ce
;
379 *list
= active_modules
;
382 static char *get_up_path(const char *path
)
385 struct strbuf sb
= STRBUF_INIT
;
387 for (i
= count_slashes(path
); i
; i
--)
388 strbuf_addstr(&sb
, "../");
391 * Check if 'path' ends with slash or not
392 * for having the same output for dir/sub_dir
395 if (!is_dir_sep(path
[strlen(path
) - 1]))
396 strbuf_addstr(&sb
, "../");
398 return strbuf_detach(&sb
, NULL
);
401 static int module_list(int argc
, const char **argv
, const char *prefix
)
404 struct pathspec pathspec
;
405 struct module_list list
= MODULE_LIST_INIT
;
407 struct option module_list_options
[] = {
408 OPT_STRING(0, "prefix", &prefix
,
410 N_("alternative anchor for relative paths")),
414 const char *const git_submodule_helper_usage
[] = {
415 N_("git submodule--helper list [--prefix=<path>] [<path>...]"),
419 argc
= parse_options(argc
, argv
, prefix
, module_list_options
,
420 git_submodule_helper_usage
, 0);
422 if (module_list_compute(argc
, argv
, prefix
, &pathspec
, &list
) < 0)
425 for (i
= 0; i
< list
.nr
; i
++) {
426 const struct cache_entry
*ce
= list
.entries
[i
];
429 printf("%06o %s U\t", ce
->ce_mode
, oid_to_hex(&null_oid
));
431 printf("%06o %s %d\t", ce
->ce_mode
,
432 oid_to_hex(&ce
->oid
), ce_stage(ce
));
434 fprintf(stdout
, "%s\n", ce
->name
);
439 static void for_each_listed_submodule(const struct module_list
*list
,
440 each_submodule_fn fn
, void *cb_data
)
443 for (i
= 0; i
< list
->nr
; i
++)
444 fn(list
->entries
[i
], cb_data
);
454 #define CB_FOREACH_INIT { 0 }
456 static void runcommand_in_submodule_cb(const struct cache_entry
*list_item
,
459 struct cb_foreach
*info
= cb_data
;
460 const char *path
= list_item
->name
;
461 const struct object_id
*ce_oid
= &list_item
->oid
;
463 const struct submodule
*sub
;
464 struct child_process cp
= CHILD_PROCESS_INIT
;
467 displaypath
= get_submodule_displaypath(path
, info
->prefix
);
469 sub
= submodule_from_path(the_repository
, &null_oid
, path
);
472 die(_("No url found for submodule path '%s' in .gitmodules"),
475 if (!is_submodule_populated_gently(path
, NULL
))
478 prepare_submodule_repo_env(&cp
.env_array
);
481 * For the purpose of executing <command> in the submodule,
482 * separate shell is used for the purpose of running the
489 * NEEDSWORK: the command currently has access to the variables $name,
490 * $sm_path, $displaypath, $sha1 and $toplevel only when the command
491 * contains a single argument. This is done for maintaining a faithful
492 * translation from shell script.
494 if (info
->argc
== 1) {
495 char *toplevel
= xgetcwd();
496 struct strbuf sb
= STRBUF_INIT
;
498 argv_array_pushf(&cp
.env_array
, "name=%s", sub
->name
);
499 argv_array_pushf(&cp
.env_array
, "sm_path=%s", path
);
500 argv_array_pushf(&cp
.env_array
, "displaypath=%s", displaypath
);
501 argv_array_pushf(&cp
.env_array
, "sha1=%s",
503 argv_array_pushf(&cp
.env_array
, "toplevel=%s", toplevel
);
506 * Since the path variable was accessible from the script
507 * before porting, it is also made available after porting.
508 * The environment variable "PATH" has a very special purpose
509 * on windows. And since environment variables are
510 * case-insensitive in windows, it interferes with the
511 * existing PATH variable. Hence, to avoid that, we expose
512 * path via the args argv_array and not via env_array.
514 sq_quote_buf(&sb
, path
);
515 argv_array_pushf(&cp
.args
, "path=%s; %s",
516 sb
.buf
, info
->argv
[0]);
520 argv_array_pushv(&cp
.args
, info
->argv
);
524 printf(_("Entering '%s'\n"), displaypath
);
526 if (info
->argv
[0] && run_command(&cp
))
527 die(_("run_command returned non-zero status for %s\n."),
530 if (info
->recursive
) {
531 struct child_process cpr
= CHILD_PROCESS_INIT
;
535 prepare_submodule_repo_env(&cpr
.env_array
);
537 argv_array_pushl(&cpr
.args
, "--super-prefix", NULL
);
538 argv_array_pushf(&cpr
.args
, "%s/", displaypath
);
539 argv_array_pushl(&cpr
.args
, "submodule--helper", "foreach", "--recursive",
543 argv_array_push(&cpr
.args
, "--quiet");
545 argv_array_push(&cpr
.args
, "--");
546 argv_array_pushv(&cpr
.args
, info
->argv
);
548 if (run_command(&cpr
))
549 die(_("run_command returned non-zero status while "
550 "recursing in the nested submodules of %s\n."),
558 static int module_foreach(int argc
, const char **argv
, const char *prefix
)
560 struct cb_foreach info
= CB_FOREACH_INIT
;
561 struct pathspec pathspec
;
562 struct module_list list
= MODULE_LIST_INIT
;
564 struct option module_foreach_options
[] = {
565 OPT__QUIET(&info
.quiet
, N_("Suppress output of entering each submodule command")),
566 OPT_BOOL(0, "recursive", &info
.recursive
,
567 N_("Recurse into nested submodules")),
571 const char *const git_submodule_helper_usage
[] = {
572 N_("git submodule--helper foreach [--quiet] [--recursive] [--] <command>"),
576 argc
= parse_options(argc
, argv
, prefix
, module_foreach_options
,
577 git_submodule_helper_usage
, 0);
579 if (module_list_compute(0, NULL
, prefix
, &pathspec
, &list
) < 0)
584 info
.prefix
= prefix
;
586 for_each_listed_submodule(&list
, runcommand_in_submodule_cb
, &info
);
591 static char *compute_submodule_clone_url(const char *rel_url
)
593 char *remoteurl
, *relurl
;
594 char *remote
= get_default_remote();
595 struct strbuf remotesb
= STRBUF_INIT
;
597 strbuf_addf(&remotesb
, "remote.%s.url", remote
);
598 if (git_config_get_string(remotesb
.buf
, &remoteurl
)) {
599 warning(_("could not look up configuration '%s'. Assuming this repository is its own authoritative upstream."), remotesb
.buf
);
600 remoteurl
= xgetcwd();
602 relurl
= relative_url(remoteurl
, rel_url
, NULL
);
606 strbuf_release(&remotesb
);
616 #define INIT_CB_INIT { NULL, 0 }
618 static void init_submodule(const char *path
, const char *prefix
,
621 const struct submodule
*sub
;
622 struct strbuf sb
= STRBUF_INIT
;
623 char *upd
= NULL
, *url
= NULL
, *displaypath
;
625 displaypath
= get_submodule_displaypath(path
, prefix
);
627 sub
= submodule_from_path(the_repository
, &null_oid
, path
);
630 die(_("No url found for submodule path '%s' in .gitmodules"),
634 * NEEDSWORK: In a multi-working-tree world, this needs to be
635 * set in the per-worktree config.
637 * Set active flag for the submodule being initialized
639 if (!is_submodule_active(the_repository
, path
)) {
640 strbuf_addf(&sb
, "submodule.%s.active", sub
->name
);
641 git_config_set_gently(sb
.buf
, "true");
646 * Copy url setting when it is not set yet.
647 * To look up the url in .git/config, we must not fall back to
648 * .gitmodules, so look it up directly.
650 strbuf_addf(&sb
, "submodule.%s.url", sub
->name
);
651 if (git_config_get_string(sb
.buf
, &url
)) {
653 die(_("No url found for submodule path '%s' in .gitmodules"),
656 url
= xstrdup(sub
->url
);
658 /* Possibly a url relative to parent */
659 if (starts_with_dot_dot_slash(url
) ||
660 starts_with_dot_slash(url
)) {
662 url
= compute_submodule_clone_url(oldurl
);
666 if (git_config_set_gently(sb
.buf
, url
))
667 die(_("Failed to register url for submodule path '%s'"),
669 if (!(flags
& OPT_QUIET
))
671 _("Submodule '%s' (%s) registered for path '%s'\n"),
672 sub
->name
, url
, displaypath
);
676 /* Copy "update" setting when it is not set yet */
677 strbuf_addf(&sb
, "submodule.%s.update", sub
->name
);
678 if (git_config_get_string(sb
.buf
, &upd
) &&
679 sub
->update_strategy
.type
!= SM_UPDATE_UNSPECIFIED
) {
680 if (sub
->update_strategy
.type
== SM_UPDATE_COMMAND
) {
681 fprintf(stderr
, _("warning: command update mode suggested for submodule '%s'\n"),
683 upd
= xstrdup("none");
685 upd
= xstrdup(submodule_strategy_to_string(&sub
->update_strategy
));
687 if (git_config_set_gently(sb
.buf
, upd
))
688 die(_("Failed to register update mode for submodule path '%s'"), displaypath
);
696 static void init_submodule_cb(const struct cache_entry
*list_item
, void *cb_data
)
698 struct init_cb
*info
= cb_data
;
699 init_submodule(list_item
->name
, info
->prefix
, info
->flags
);
702 static int module_init(int argc
, const char **argv
, const char *prefix
)
704 struct init_cb info
= INIT_CB_INIT
;
705 struct pathspec pathspec
;
706 struct module_list list
= MODULE_LIST_INIT
;
709 struct option module_init_options
[] = {
710 OPT__QUIET(&quiet
, N_("Suppress output for initializing a submodule")),
714 const char *const git_submodule_helper_usage
[] = {
715 N_("git submodule--helper init [<options>] [<path>]"),
719 argc
= parse_options(argc
, argv
, prefix
, module_init_options
,
720 git_submodule_helper_usage
, 0);
722 if (module_list_compute(argc
, argv
, prefix
, &pathspec
, &list
) < 0)
726 * If there are no path args and submodule.active is set then,
727 * by default, only initialize 'active' modules.
729 if (!argc
&& git_config_get_value_multi("submodule.active"))
730 module_list_active(&list
);
732 info
.prefix
= prefix
;
734 info
.flags
|= OPT_QUIET
;
736 for_each_listed_submodule(&list
, init_submodule_cb
, &info
);
746 #define STATUS_CB_INIT { NULL, 0 }
748 static void print_status(unsigned int flags
, char state
, const char *path
,
749 const struct object_id
*oid
, const char *displaypath
)
751 if (flags
& OPT_QUIET
)
754 printf("%c%s %s", state
, oid_to_hex(oid
), displaypath
);
756 if (state
== ' ' || state
== '+') {
757 const char *name
= compute_rev_name(path
, oid_to_hex(oid
));
760 printf(" (%s)", name
);
766 static int handle_submodule_head_ref(const char *refname
,
767 const struct object_id
*oid
, int flags
,
770 struct object_id
*output
= cb_data
;
777 static void status_submodule(const char *path
, const struct object_id
*ce_oid
,
778 unsigned int ce_flags
, const char *prefix
,
782 struct argv_array diff_files_args
= ARGV_ARRAY_INIT
;
784 int diff_files_result
;
786 if (!submodule_from_path(the_repository
, &null_oid
, path
))
787 die(_("no submodule mapping found in .gitmodules for path '%s'"),
790 displaypath
= get_submodule_displaypath(path
, prefix
);
792 if ((CE_STAGEMASK
& ce_flags
) >> CE_STAGESHIFT
) {
793 print_status(flags
, 'U', path
, &null_oid
, displaypath
);
797 if (!is_submodule_active(the_repository
, path
)) {
798 print_status(flags
, '-', path
, ce_oid
, displaypath
);
802 argv_array_pushl(&diff_files_args
, "diff-files",
803 "--ignore-submodules=dirty", "--quiet", "--",
806 git_config(git_diff_basic_config
, NULL
);
808 repo_init_revisions(the_repository
, &rev
, NULL
);
810 diff_files_args
.argc
= setup_revisions(diff_files_args
.argc
,
811 diff_files_args
.argv
,
813 diff_files_result
= run_diff_files(&rev
, 0);
815 if (!diff_result_code(&rev
.diffopt
, diff_files_result
)) {
816 print_status(flags
, ' ', path
, ce_oid
,
818 } else if (!(flags
& OPT_CACHED
)) {
819 struct object_id oid
;
820 struct ref_store
*refs
= get_submodule_ref_store(path
);
823 print_status(flags
, '-', path
, ce_oid
, displaypath
);
826 if (refs_head_ref(refs
, handle_submodule_head_ref
, &oid
))
827 die(_("could not resolve HEAD ref inside the "
828 "submodule '%s'"), path
);
830 print_status(flags
, '+', path
, &oid
, displaypath
);
832 print_status(flags
, '+', path
, ce_oid
, displaypath
);
835 if (flags
& OPT_RECURSIVE
) {
836 struct child_process cpr
= CHILD_PROCESS_INIT
;
840 prepare_submodule_repo_env(&cpr
.env_array
);
842 argv_array_push(&cpr
.args
, "--super-prefix");
843 argv_array_pushf(&cpr
.args
, "%s/", displaypath
);
844 argv_array_pushl(&cpr
.args
, "submodule--helper", "status",
845 "--recursive", NULL
);
847 if (flags
& OPT_CACHED
)
848 argv_array_push(&cpr
.args
, "--cached");
850 if (flags
& OPT_QUIET
)
851 argv_array_push(&cpr
.args
, "--quiet");
853 if (run_command(&cpr
))
854 die(_("failed to recurse into submodule '%s'"), path
);
858 argv_array_clear(&diff_files_args
);
862 static void status_submodule_cb(const struct cache_entry
*list_item
,
865 struct status_cb
*info
= cb_data
;
866 status_submodule(list_item
->name
, &list_item
->oid
, list_item
->ce_flags
,
867 info
->prefix
, info
->flags
);
870 static int module_status(int argc
, const char **argv
, const char *prefix
)
872 struct status_cb info
= STATUS_CB_INIT
;
873 struct pathspec pathspec
;
874 struct module_list list
= MODULE_LIST_INIT
;
877 struct option module_status_options
[] = {
878 OPT__QUIET(&quiet
, N_("Suppress submodule status output")),
879 OPT_BIT(0, "cached", &info
.flags
, N_("Use commit stored in the index instead of the one stored in the submodule HEAD"), OPT_CACHED
),
880 OPT_BIT(0, "recursive", &info
.flags
, N_("recurse into nested submodules"), OPT_RECURSIVE
),
884 const char *const git_submodule_helper_usage
[] = {
885 N_("git submodule status [--quiet] [--cached] [--recursive] [<path>...]"),
889 argc
= parse_options(argc
, argv
, prefix
, module_status_options
,
890 git_submodule_helper_usage
, 0);
892 if (module_list_compute(argc
, argv
, prefix
, &pathspec
, &list
) < 0)
895 info
.prefix
= prefix
;
897 info
.flags
|= OPT_QUIET
;
899 for_each_listed_submodule(&list
, status_submodule_cb
, &info
);
904 static int module_name(int argc
, const char **argv
, const char *prefix
)
906 const struct submodule
*sub
;
909 usage(_("git submodule--helper name <path>"));
911 sub
= submodule_from_path(the_repository
, &null_oid
, argv
[1]);
914 die(_("no submodule mapping found in .gitmodules for path '%s'"),
917 printf("%s\n", sub
->name
);
927 #define SYNC_CB_INIT { NULL, 0 }
929 static void sync_submodule(const char *path
, const char *prefix
,
932 const struct submodule
*sub
;
933 char *remote_key
= NULL
;
934 char *sub_origin_url
, *super_config_url
, *displaypath
;
935 struct strbuf sb
= STRBUF_INIT
;
936 struct child_process cp
= CHILD_PROCESS_INIT
;
937 char *sub_config_path
= NULL
;
939 if (!is_submodule_active(the_repository
, path
))
942 sub
= submodule_from_path(the_repository
, &null_oid
, path
);
944 if (sub
&& sub
->url
) {
945 if (starts_with_dot_dot_slash(sub
->url
) ||
946 starts_with_dot_slash(sub
->url
)) {
947 char *remote_url
, *up_path
;
948 char *remote
= get_default_remote();
949 strbuf_addf(&sb
, "remote.%s.url", remote
);
951 if (git_config_get_string(sb
.buf
, &remote_url
))
952 remote_url
= xgetcwd();
954 up_path
= get_up_path(path
);
955 sub_origin_url
= relative_url(remote_url
, sub
->url
, up_path
);
956 super_config_url
= relative_url(remote_url
, sub
->url
, NULL
);
962 sub_origin_url
= xstrdup(sub
->url
);
963 super_config_url
= xstrdup(sub
->url
);
966 sub_origin_url
= xstrdup("");
967 super_config_url
= xstrdup("");
970 displaypath
= get_submodule_displaypath(path
, prefix
);
972 if (!(flags
& OPT_QUIET
))
973 printf(_("Synchronizing submodule url for '%s'\n"),
977 strbuf_addf(&sb
, "submodule.%s.url", sub
->name
);
978 if (git_config_set_gently(sb
.buf
, super_config_url
))
979 die(_("failed to register url for submodule path '%s'"),
982 if (!is_submodule_populated_gently(path
, NULL
))
985 prepare_submodule_repo_env(&cp
.env_array
);
988 argv_array_pushl(&cp
.args
, "submodule--helper",
989 "print-default-remote", NULL
);
992 if (capture_command(&cp
, &sb
, 0))
993 die(_("failed to get the default remote for submodule '%s'"),
996 strbuf_strip_suffix(&sb
, "\n");
997 remote_key
= xstrfmt("remote.%s.url", sb
.buf
);
1000 submodule_to_gitdir(&sb
, path
);
1001 strbuf_addstr(&sb
, "/config");
1003 if (git_config_set_in_file_gently(sb
.buf
, remote_key
, sub_origin_url
))
1004 die(_("failed to update remote for submodule '%s'"),
1007 if (flags
& OPT_RECURSIVE
) {
1008 struct child_process cpr
= CHILD_PROCESS_INIT
;
1012 prepare_submodule_repo_env(&cpr
.env_array
);
1014 argv_array_push(&cpr
.args
, "--super-prefix");
1015 argv_array_pushf(&cpr
.args
, "%s/", displaypath
);
1016 argv_array_pushl(&cpr
.args
, "submodule--helper", "sync",
1017 "--recursive", NULL
);
1019 if (flags
& OPT_QUIET
)
1020 argv_array_push(&cpr
.args
, "--quiet");
1022 if (run_command(&cpr
))
1023 die(_("failed to recurse into submodule '%s'"),
1028 free(super_config_url
);
1029 free(sub_origin_url
);
1030 strbuf_release(&sb
);
1033 free(sub_config_path
);
1036 static void sync_submodule_cb(const struct cache_entry
*list_item
, void *cb_data
)
1038 struct sync_cb
*info
= cb_data
;
1039 sync_submodule(list_item
->name
, info
->prefix
, info
->flags
);
1042 static int module_sync(int argc
, const char **argv
, const char *prefix
)
1044 struct sync_cb info
= SYNC_CB_INIT
;
1045 struct pathspec pathspec
;
1046 struct module_list list
= MODULE_LIST_INIT
;
1050 struct option module_sync_options
[] = {
1051 OPT__QUIET(&quiet
, N_("Suppress output of synchronizing submodule url")),
1052 OPT_BOOL(0, "recursive", &recursive
,
1053 N_("Recurse into nested submodules")),
1057 const char *const git_submodule_helper_usage
[] = {
1058 N_("git submodule--helper sync [--quiet] [--recursive] [<path>]"),
1062 argc
= parse_options(argc
, argv
, prefix
, module_sync_options
,
1063 git_submodule_helper_usage
, 0);
1065 if (module_list_compute(argc
, argv
, prefix
, &pathspec
, &list
) < 0)
1068 info
.prefix
= prefix
;
1070 info
.flags
|= OPT_QUIET
;
1072 info
.flags
|= OPT_RECURSIVE
;
1074 for_each_listed_submodule(&list
, sync_submodule_cb
, &info
);
1083 #define DEINIT_CB_INIT { NULL, 0 }
1085 static void deinit_submodule(const char *path
, const char *prefix
,
1088 const struct submodule
*sub
;
1089 char *displaypath
= NULL
;
1090 struct child_process cp_config
= CHILD_PROCESS_INIT
;
1091 struct strbuf sb_config
= STRBUF_INIT
;
1092 char *sub_git_dir
= xstrfmt("%s/.git", path
);
1094 sub
= submodule_from_path(the_repository
, &null_oid
, path
);
1096 if (!sub
|| !sub
->name
)
1099 displaypath
= get_submodule_displaypath(path
, prefix
);
1101 /* remove the submodule work tree (unless the user already did it) */
1102 if (is_directory(path
)) {
1103 struct strbuf sb_rm
= STRBUF_INIT
;
1107 * protect submodules containing a .git directory
1108 * NEEDSWORK: instead of dying, automatically call
1109 * absorbgitdirs and (possibly) warn.
1111 if (is_directory(sub_git_dir
))
1112 die(_("Submodule work tree '%s' contains a .git "
1113 "directory (use 'rm -rf' if you really want "
1114 "to remove it including all of its history)"),
1117 if (!(flags
& OPT_FORCE
)) {
1118 struct child_process cp_rm
= CHILD_PROCESS_INIT
;
1120 argv_array_pushl(&cp_rm
.args
, "rm", "-qn",
1123 if (run_command(&cp_rm
))
1124 die(_("Submodule work tree '%s' contains local "
1125 "modifications; use '-f' to discard them"),
1129 strbuf_addstr(&sb_rm
, path
);
1131 if (!remove_dir_recursively(&sb_rm
, 0))
1132 format
= _("Cleared directory '%s'\n");
1134 format
= _("Could not remove submodule work tree '%s'\n");
1136 if (!(flags
& OPT_QUIET
))
1137 printf(format
, displaypath
);
1139 submodule_unset_core_worktree(sub
);
1141 strbuf_release(&sb_rm
);
1144 if (mkdir(path
, 0777))
1145 printf(_("could not create empty submodule directory %s"),
1148 cp_config
.git_cmd
= 1;
1149 argv_array_pushl(&cp_config
.args
, "config", "--get-regexp", NULL
);
1150 argv_array_pushf(&cp_config
.args
, "submodule.%s\\.", sub
->name
);
1152 /* remove the .git/config entries (unless the user already did it) */
1153 if (!capture_command(&cp_config
, &sb_config
, 0) && sb_config
.len
) {
1154 char *sub_key
= xstrfmt("submodule.%s", sub
->name
);
1156 * remove the whole section so we have a clean state when
1157 * the user later decides to init this submodule again
1159 git_config_rename_section_in_file(NULL
, sub_key
, NULL
);
1160 if (!(flags
& OPT_QUIET
))
1161 printf(_("Submodule '%s' (%s) unregistered for path '%s'\n"),
1162 sub
->name
, sub
->url
, displaypath
);
1169 strbuf_release(&sb_config
);
1172 static void deinit_submodule_cb(const struct cache_entry
*list_item
,
1175 struct deinit_cb
*info
= cb_data
;
1176 deinit_submodule(list_item
->name
, info
->prefix
, info
->flags
);
1179 static int module_deinit(int argc
, const char **argv
, const char *prefix
)
1181 struct deinit_cb info
= DEINIT_CB_INIT
;
1182 struct pathspec pathspec
;
1183 struct module_list list
= MODULE_LIST_INIT
;
1188 struct option module_deinit_options
[] = {
1189 OPT__QUIET(&quiet
, N_("Suppress submodule status output")),
1190 OPT__FORCE(&force
, N_("Remove submodule working trees even if they contain local changes"), 0),
1191 OPT_BOOL(0, "all", &all
, N_("Unregister all submodules")),
1195 const char *const git_submodule_helper_usage
[] = {
1196 N_("git submodule deinit [--quiet] [-f | --force] [--all | [--] [<path>...]]"),
1200 argc
= parse_options(argc
, argv
, prefix
, module_deinit_options
,
1201 git_submodule_helper_usage
, 0);
1204 error("pathspec and --all are incompatible");
1205 usage_with_options(git_submodule_helper_usage
,
1206 module_deinit_options
);
1210 die(_("Use '--all' if you really want to deinitialize all submodules"));
1212 if (module_list_compute(argc
, argv
, prefix
, &pathspec
, &list
) < 0)
1215 info
.prefix
= prefix
;
1217 info
.flags
|= OPT_QUIET
;
1219 info
.flags
|= OPT_FORCE
;
1221 for_each_listed_submodule(&list
, deinit_submodule_cb
, &info
);
1226 static int clone_submodule(const char *path
, const char *gitdir
, const char *url
,
1227 const char *depth
, struct string_list
*reference
, int dissociate
,
1228 int quiet
, int progress
, int single_branch
)
1230 struct child_process cp
= CHILD_PROCESS_INIT
;
1232 argv_array_push(&cp
.args
, "clone");
1233 argv_array_push(&cp
.args
, "--no-checkout");
1235 argv_array_push(&cp
.args
, "--quiet");
1237 argv_array_push(&cp
.args
, "--progress");
1238 if (depth
&& *depth
)
1239 argv_array_pushl(&cp
.args
, "--depth", depth
, NULL
);
1240 if (reference
->nr
) {
1241 struct string_list_item
*item
;
1242 for_each_string_list_item(item
, reference
)
1243 argv_array_pushl(&cp
.args
, "--reference",
1244 item
->string
, NULL
);
1247 argv_array_push(&cp
.args
, "--dissociate");
1248 if (gitdir
&& *gitdir
)
1249 argv_array_pushl(&cp
.args
, "--separate-git-dir", gitdir
, NULL
);
1250 if (single_branch
>= 0)
1251 argv_array_push(&cp
.args
, single_branch
?
1253 "--no-single-branch");
1255 argv_array_push(&cp
.args
, "--");
1256 argv_array_push(&cp
.args
, url
);
1257 argv_array_push(&cp
.args
, path
);
1260 prepare_submodule_repo_env(&cp
.env_array
);
1263 return run_command(&cp
);
1266 struct submodule_alternate_setup
{
1267 const char *submodule_name
;
1268 enum SUBMODULE_ALTERNATE_ERROR_MODE
{
1269 SUBMODULE_ALTERNATE_ERROR_DIE
,
1270 SUBMODULE_ALTERNATE_ERROR_INFO
,
1271 SUBMODULE_ALTERNATE_ERROR_IGNORE
1273 struct string_list
*reference
;
1275 #define SUBMODULE_ALTERNATE_SETUP_INIT { NULL, \
1276 SUBMODULE_ALTERNATE_ERROR_IGNORE, NULL }
1278 static const char alternate_error_advice
[] = N_(
1279 "An alternate computed from a superproject's alternate is invalid.\n"
1280 "To allow Git to clone without an alternate in such a case, set\n"
1281 "submodule.alternateErrorStrategy to 'info' or, equivalently, clone with\n"
1282 "'--reference-if-able' instead of '--reference'."
1285 static int add_possible_reference_from_superproject(
1286 struct object_directory
*odb
, void *sas_cb
)
1288 struct submodule_alternate_setup
*sas
= sas_cb
;
1292 * If the alternate object store is another repository, try the
1293 * standard layout with .git/(modules/<name>)+/objects
1295 if (strip_suffix(odb
->path
, "/objects", &len
)) {
1297 struct strbuf sb
= STRBUF_INIT
;
1298 struct strbuf err
= STRBUF_INIT
;
1299 strbuf_add(&sb
, odb
->path
, len
);
1302 * We need to end the new path with '/' to mark it as a dir,
1303 * otherwise a submodule name containing '/' will be broken
1304 * as the last part of a missing submodule reference would
1305 * be taken as a file name.
1307 strbuf_addf(&sb
, "/modules/%s/", sas
->submodule_name
);
1309 sm_alternate
= compute_alternate_path(sb
.buf
, &err
);
1311 string_list_append(sas
->reference
, xstrdup(sb
.buf
));
1314 switch (sas
->error_mode
) {
1315 case SUBMODULE_ALTERNATE_ERROR_DIE
:
1316 if (advice_submodule_alternate_error_strategy_die
)
1317 advise(_(alternate_error_advice
));
1318 die(_("submodule '%s' cannot add alternate: %s"),
1319 sas
->submodule_name
, err
.buf
);
1320 case SUBMODULE_ALTERNATE_ERROR_INFO
:
1321 fprintf_ln(stderr
, _("submodule '%s' cannot add alternate: %s"),
1322 sas
->submodule_name
, err
.buf
);
1323 case SUBMODULE_ALTERNATE_ERROR_IGNORE
:
1327 strbuf_release(&sb
);
1333 static void prepare_possible_alternates(const char *sm_name
,
1334 struct string_list
*reference
)
1336 char *sm_alternate
= NULL
, *error_strategy
= NULL
;
1337 struct submodule_alternate_setup sas
= SUBMODULE_ALTERNATE_SETUP_INIT
;
1339 git_config_get_string("submodule.alternateLocation", &sm_alternate
);
1343 git_config_get_string("submodule.alternateErrorStrategy", &error_strategy
);
1345 if (!error_strategy
)
1346 error_strategy
= xstrdup("die");
1348 sas
.submodule_name
= sm_name
;
1349 sas
.reference
= reference
;
1350 if (!strcmp(error_strategy
, "die"))
1351 sas
.error_mode
= SUBMODULE_ALTERNATE_ERROR_DIE
;
1352 else if (!strcmp(error_strategy
, "info"))
1353 sas
.error_mode
= SUBMODULE_ALTERNATE_ERROR_INFO
;
1354 else if (!strcmp(error_strategy
, "ignore"))
1355 sas
.error_mode
= SUBMODULE_ALTERNATE_ERROR_IGNORE
;
1357 die(_("Value '%s' for submodule.alternateErrorStrategy is not recognized"), error_strategy
);
1359 if (!strcmp(sm_alternate
, "superproject"))
1360 foreach_alt_odb(add_possible_reference_from_superproject
, &sas
);
1361 else if (!strcmp(sm_alternate
, "no"))
1364 die(_("Value '%s' for submodule.alternateLocation is not recognized"), sm_alternate
);
1367 free(error_strategy
);
1370 static int module_clone(int argc
, const char **argv
, const char *prefix
)
1372 const char *name
= NULL
, *url
= NULL
, *depth
= NULL
;
1375 char *p
, *path
= NULL
, *sm_gitdir
;
1376 struct strbuf sb
= STRBUF_INIT
;
1377 struct string_list reference
= STRING_LIST_INIT_NODUP
;
1378 int dissociate
= 0, require_init
= 0;
1379 char *sm_alternate
= NULL
, *error_strategy
= NULL
;
1380 int single_branch
= -1;
1382 struct option module_clone_options
[] = {
1383 OPT_STRING(0, "prefix", &prefix
,
1385 N_("alternative anchor for relative paths")),
1386 OPT_STRING(0, "path", &path
,
1388 N_("where the new submodule will be cloned to")),
1389 OPT_STRING(0, "name", &name
,
1391 N_("name of the new submodule")),
1392 OPT_STRING(0, "url", &url
,
1394 N_("url where to clone the submodule from")),
1395 OPT_STRING_LIST(0, "reference", &reference
,
1397 N_("reference repository")),
1398 OPT_BOOL(0, "dissociate", &dissociate
,
1399 N_("use --reference only while cloning")),
1400 OPT_STRING(0, "depth", &depth
,
1402 N_("depth for shallow clones")),
1403 OPT__QUIET(&quiet
, "Suppress output for cloning a submodule"),
1404 OPT_BOOL(0, "progress", &progress
,
1405 N_("force cloning progress")),
1406 OPT_BOOL(0, "require-init", &require_init
,
1407 N_("disallow cloning into non-empty directory")),
1408 OPT_BOOL(0, "single-branch", &single_branch
,
1409 N_("clone only one branch, HEAD or --branch")),
1413 const char *const git_submodule_helper_usage
[] = {
1414 N_("git submodule--helper clone [--prefix=<path>] [--quiet] "
1415 "[--reference <repository>] [--name <name>] [--depth <depth>] "
1416 "[--single-branch] "
1417 "--url <url> --path <path>"),
1421 argc
= parse_options(argc
, argv
, prefix
, module_clone_options
,
1422 git_submodule_helper_usage
, 0);
1424 if (argc
|| !url
|| !path
|| !*path
)
1425 usage_with_options(git_submodule_helper_usage
,
1426 module_clone_options
);
1428 strbuf_addf(&sb
, "%s/modules/%s", get_git_dir(), name
);
1429 sm_gitdir
= absolute_pathdup(sb
.buf
);
1432 if (!is_absolute_path(path
)) {
1433 strbuf_addf(&sb
, "%s/%s", get_git_work_tree(), path
);
1434 path
= strbuf_detach(&sb
, NULL
);
1436 path
= xstrdup(path
);
1438 if (validate_submodule_git_dir(sm_gitdir
, name
) < 0)
1439 die(_("refusing to create/use '%s' in another submodule's "
1440 "git dir"), sm_gitdir
);
1442 if (!file_exists(sm_gitdir
)) {
1443 if (safe_create_leading_directories_const(sm_gitdir
) < 0)
1444 die(_("could not create directory '%s'"), sm_gitdir
);
1446 prepare_possible_alternates(name
, &reference
);
1448 if (clone_submodule(path
, sm_gitdir
, url
, depth
, &reference
, dissociate
,
1449 quiet
, progress
, single_branch
))
1450 die(_("clone of '%s' into submodule path '%s' failed"),
1453 if (require_init
&& !access(path
, X_OK
) && !is_empty_dir(path
))
1454 die(_("directory not empty: '%s'"), path
);
1455 if (safe_create_leading_directories_const(path
) < 0)
1456 die(_("could not create directory '%s'"), path
);
1457 strbuf_addf(&sb
, "%s/index", sm_gitdir
);
1458 unlink_or_warn(sb
.buf
);
1462 connect_work_tree_and_git_dir(path
, sm_gitdir
, 0);
1464 p
= git_pathdup_submodule(path
, "config");
1466 die(_("could not get submodule directory for '%s'"), path
);
1468 /* setup alternateLocation and alternateErrorStrategy in the cloned submodule if needed */
1469 git_config_get_string("submodule.alternateLocation", &sm_alternate
);
1471 git_config_set_in_file(p
, "submodule.alternateLocation",
1473 git_config_get_string("submodule.alternateErrorStrategy", &error_strategy
);
1475 git_config_set_in_file(p
, "submodule.alternateErrorStrategy",
1479 free(error_strategy
);
1481 strbuf_release(&sb
);
1488 static void determine_submodule_update_strategy(struct repository
*r
,
1492 struct submodule_update_strategy
*out
)
1494 const struct submodule
*sub
= submodule_from_path(r
, &null_oid
, path
);
1498 key
= xstrfmt("submodule.%s.update", sub
->name
);
1501 if (parse_submodule_update_strategy(update
, out
) < 0)
1502 die(_("Invalid update mode '%s' for submodule path '%s'"),
1504 } else if (!repo_config_get_string_const(r
, key
, &val
)) {
1505 if (parse_submodule_update_strategy(val
, out
) < 0)
1506 die(_("Invalid update mode '%s' configured for submodule path '%s'"),
1508 } else if (sub
->update_strategy
.type
!= SM_UPDATE_UNSPECIFIED
) {
1509 if (sub
->update_strategy
.type
== SM_UPDATE_COMMAND
)
1510 BUG("how did we read update = !command from .gitmodules?");
1511 out
->type
= sub
->update_strategy
.type
;
1512 out
->command
= sub
->update_strategy
.command
;
1514 out
->type
= SM_UPDATE_CHECKOUT
;
1517 (out
->type
== SM_UPDATE_MERGE
||
1518 out
->type
== SM_UPDATE_REBASE
||
1519 out
->type
== SM_UPDATE_NONE
))
1520 out
->type
= SM_UPDATE_CHECKOUT
;
1525 static int module_update_module_mode(int argc
, const char **argv
, const char *prefix
)
1527 const char *path
, *update
= NULL
;
1529 struct submodule_update_strategy update_strategy
= { .type
= SM_UPDATE_CHECKOUT
};
1531 if (argc
< 3 || argc
> 4)
1532 die("submodule--helper update-module-clone expects <just-cloned> <path> [<update>]");
1534 just_cloned
= git_config_int("just_cloned", argv
[1]);
1540 determine_submodule_update_strategy(the_repository
,
1541 just_cloned
, path
, update
,
1543 fputs(submodule_strategy_to_string(&update_strategy
), stdout
);
1548 struct update_clone_data
{
1549 const struct submodule
*sub
;
1550 struct object_id oid
;
1551 unsigned just_cloned
;
1554 struct submodule_update_clone
{
1555 /* index into 'list', the list of submodules to look into for cloning */
1557 struct module_list list
;
1558 unsigned warn_if_uninitialized
: 1;
1560 /* update parameter passed via commandline */
1561 struct submodule_update_strategy update
;
1563 /* configuration parameters which are passed on to the children */
1566 int recommend_shallow
;
1567 struct string_list references
;
1569 unsigned require_init
;
1571 const char *recursive_prefix
;
1575 /* to be consumed by git-submodule.sh */
1576 struct update_clone_data
*update_clone
;
1577 int update_clone_nr
; int update_clone_alloc
;
1579 /* If we want to stop as fast as possible and return an error */
1580 unsigned quickstop
: 1;
1582 /* failed clones to be retried again */
1583 const struct cache_entry
**failed_clones
;
1584 int failed_clones_nr
, failed_clones_alloc
;
1588 #define SUBMODULE_UPDATE_CLONE_INIT { \
1589 .list = MODULE_LIST_INIT, \
1590 .update = SUBMODULE_UPDATE_STRATEGY_INIT, \
1591 .recommend_shallow = -1, \
1592 .references = STRING_LIST_INIT_DUP, \
1593 .single_branch = -1, \
1598 static void next_submodule_warn_missing(struct submodule_update_clone
*suc
,
1599 struct strbuf
*out
, const char *displaypath
)
1602 * Only mention uninitialized submodules when their
1603 * paths have been specified.
1605 if (suc
->warn_if_uninitialized
) {
1607 _("Submodule path '%s' not initialized"),
1609 strbuf_addch(out
, '\n');
1611 _("Maybe you want to use 'update --init'?"));
1612 strbuf_addch(out
, '\n');
1617 * Determine whether 'ce' needs to be cloned. If so, prepare the 'child' to
1618 * run the clone. Returns 1 if 'ce' needs to be cloned, 0 otherwise.
1620 static int prepare_to_clone_next_submodule(const struct cache_entry
*ce
,
1621 struct child_process
*child
,
1622 struct submodule_update_clone
*suc
,
1625 const struct submodule
*sub
= NULL
;
1626 const char *url
= NULL
;
1627 const char *update_string
;
1628 enum submodule_update_type update_type
;
1630 struct strbuf displaypath_sb
= STRBUF_INIT
;
1631 struct strbuf sb
= STRBUF_INIT
;
1632 const char *displaypath
= NULL
;
1633 int needs_cloning
= 0;
1634 int need_free_url
= 0;
1637 if (suc
->recursive_prefix
)
1638 strbuf_addf(&sb
, "%s/%s", suc
->recursive_prefix
, ce
->name
);
1640 strbuf_addstr(&sb
, ce
->name
);
1641 strbuf_addf(out
, _("Skipping unmerged submodule %s"), sb
.buf
);
1642 strbuf_addch(out
, '\n');
1646 sub
= submodule_from_path(the_repository
, &null_oid
, ce
->name
);
1648 if (suc
->recursive_prefix
)
1649 displaypath
= relative_path(suc
->recursive_prefix
,
1650 ce
->name
, &displaypath_sb
);
1652 displaypath
= ce
->name
;
1655 next_submodule_warn_missing(suc
, out
, displaypath
);
1659 key
= xstrfmt("submodule.%s.update", sub
->name
);
1660 if (!repo_config_get_string_const(the_repository
, key
, &update_string
)) {
1661 update_type
= parse_submodule_update_type(update_string
);
1663 update_type
= sub
->update_strategy
.type
;
1667 if (suc
->update
.type
== SM_UPDATE_NONE
1668 || (suc
->update
.type
== SM_UPDATE_UNSPECIFIED
1669 && update_type
== SM_UPDATE_NONE
)) {
1670 strbuf_addf(out
, _("Skipping submodule '%s'"), displaypath
);
1671 strbuf_addch(out
, '\n');
1675 /* Check if the submodule has been initialized. */
1676 if (!is_submodule_active(the_repository
, ce
->name
)) {
1677 next_submodule_warn_missing(suc
, out
, displaypath
);
1682 strbuf_addf(&sb
, "submodule.%s.url", sub
->name
);
1683 if (repo_config_get_string_const(the_repository
, sb
.buf
, &url
)) {
1684 if (starts_with_dot_slash(sub
->url
) ||
1685 starts_with_dot_dot_slash(sub
->url
)) {
1686 url
= compute_submodule_clone_url(sub
->url
);
1693 strbuf_addf(&sb
, "%s/.git", ce
->name
);
1694 needs_cloning
= !file_exists(sb
.buf
);
1696 ALLOC_GROW(suc
->update_clone
, suc
->update_clone_nr
+ 1,
1697 suc
->update_clone_alloc
);
1698 oidcpy(&suc
->update_clone
[suc
->update_clone_nr
].oid
, &ce
->oid
);
1699 suc
->update_clone
[suc
->update_clone_nr
].just_cloned
= needs_cloning
;
1700 suc
->update_clone
[suc
->update_clone_nr
].sub
= sub
;
1701 suc
->update_clone_nr
++;
1707 child
->no_stdin
= 1;
1708 child
->stdout_to_stderr
= 1;
1710 argv_array_push(&child
->args
, "submodule--helper");
1711 argv_array_push(&child
->args
, "clone");
1713 argv_array_push(&child
->args
, "--progress");
1715 argv_array_push(&child
->args
, "--quiet");
1717 argv_array_pushl(&child
->args
, "--prefix", suc
->prefix
, NULL
);
1718 if (suc
->recommend_shallow
&& sub
->recommend_shallow
== 1)
1719 argv_array_push(&child
->args
, "--depth=1");
1720 if (suc
->require_init
)
1721 argv_array_push(&child
->args
, "--require-init");
1722 argv_array_pushl(&child
->args
, "--path", sub
->path
, NULL
);
1723 argv_array_pushl(&child
->args
, "--name", sub
->name
, NULL
);
1724 argv_array_pushl(&child
->args
, "--url", url
, NULL
);
1725 if (suc
->references
.nr
) {
1726 struct string_list_item
*item
;
1727 for_each_string_list_item(item
, &suc
->references
)
1728 argv_array_pushl(&child
->args
, "--reference", item
->string
, NULL
);
1730 if (suc
->dissociate
)
1731 argv_array_push(&child
->args
, "--dissociate");
1733 argv_array_push(&child
->args
, suc
->depth
);
1734 if (suc
->single_branch
>= 0)
1735 argv_array_push(&child
->args
, suc
->single_branch
?
1737 "--no-single-branch");
1740 strbuf_reset(&displaypath_sb
);
1745 return needs_cloning
;
1748 static int update_clone_get_next_task(struct child_process
*child
,
1753 struct submodule_update_clone
*suc
= suc_cb
;
1754 const struct cache_entry
*ce
;
1757 for (; suc
->current
< suc
->list
.nr
; suc
->current
++) {
1758 ce
= suc
->list
.entries
[suc
->current
];
1759 if (prepare_to_clone_next_submodule(ce
, child
, suc
, err
)) {
1760 int *p
= xmalloc(sizeof(*p
));
1769 * The loop above tried cloning each submodule once, now try the
1770 * stragglers again, which we can imagine as an extension of the
1773 index
= suc
->current
- suc
->list
.nr
;
1774 if (index
< suc
->failed_clones_nr
) {
1776 ce
= suc
->failed_clones
[index
];
1777 if (!prepare_to_clone_next_submodule(ce
, child
, suc
, err
)) {
1779 strbuf_addstr(err
, "BUG: submodule considered for "
1780 "cloning, doesn't need cloning "
1784 p
= xmalloc(sizeof(*p
));
1794 static int update_clone_start_failure(struct strbuf
*err
,
1798 struct submodule_update_clone
*suc
= suc_cb
;
1803 static int update_clone_task_finished(int result
,
1808 const struct cache_entry
*ce
;
1809 struct submodule_update_clone
*suc
= suc_cb
;
1811 int *idxP
= idx_task_cb
;
1818 if (idx
< suc
->list
.nr
) {
1819 ce
= suc
->list
.entries
[idx
];
1820 strbuf_addf(err
, _("Failed to clone '%s'. Retry scheduled"),
1822 strbuf_addch(err
, '\n');
1823 ALLOC_GROW(suc
->failed_clones
,
1824 suc
->failed_clones_nr
+ 1,
1825 suc
->failed_clones_alloc
);
1826 suc
->failed_clones
[suc
->failed_clones_nr
++] = ce
;
1829 idx
-= suc
->list
.nr
;
1830 ce
= suc
->failed_clones
[idx
];
1831 strbuf_addf(err
, _("Failed to clone '%s' a second time, aborting"),
1833 strbuf_addch(err
, '\n');
1841 static int git_update_clone_config(const char *var
, const char *value
,
1845 if (!strcmp(var
, "submodule.fetchjobs"))
1846 *max_jobs
= parse_submodule_fetchjobs(var
, value
);
1850 static void update_submodule(struct update_clone_data
*ucd
)
1852 fprintf(stdout
, "dummy %s %d\t%s\n",
1853 oid_to_hex(&ucd
->oid
),
1858 static int update_submodules(struct submodule_update_clone
*suc
)
1862 run_processes_parallel_tr2(suc
->max_jobs
, update_clone_get_next_task
,
1863 update_clone_start_failure
,
1864 update_clone_task_finished
, suc
, "submodule",
1868 * We saved the output and put it out all at once now.
1870 * - the listener does not have to interleave their (checkout)
1871 * work with our fetching. The writes involved in a
1872 * checkout involve more straightforward sequential I/O.
1873 * - the listener can avoid doing any work if fetching failed.
1878 for (i
= 0; i
< suc
->update_clone_nr
; i
++)
1879 update_submodule(&suc
->update_clone
[i
]);
1884 static int update_clone(int argc
, const char **argv
, const char *prefix
)
1886 const char *update
= NULL
;
1887 struct pathspec pathspec
;
1888 struct submodule_update_clone suc
= SUBMODULE_UPDATE_CLONE_INIT
;
1890 struct option module_update_clone_options
[] = {
1891 OPT_STRING(0, "prefix", &prefix
,
1893 N_("path into the working tree")),
1894 OPT_STRING(0, "recursive-prefix", &suc
.recursive_prefix
,
1896 N_("path into the working tree, across nested "
1897 "submodule boundaries")),
1898 OPT_STRING(0, "update", &update
,
1900 N_("rebase, merge, checkout or none")),
1901 OPT_STRING_LIST(0, "reference", &suc
.references
, N_("repo"),
1902 N_("reference repository")),
1903 OPT_BOOL(0, "dissociate", &suc
.dissociate
,
1904 N_("use --reference only while cloning")),
1905 OPT_STRING(0, "depth", &suc
.depth
, "<depth>",
1906 N_("Create a shallow clone truncated to the "
1907 "specified number of revisions")),
1908 OPT_INTEGER('j', "jobs", &suc
.max_jobs
,
1909 N_("parallel jobs")),
1910 OPT_BOOL(0, "recommend-shallow", &suc
.recommend_shallow
,
1911 N_("whether the initial clone should follow the shallow recommendation")),
1912 OPT__QUIET(&suc
.quiet
, N_("don't print cloning progress")),
1913 OPT_BOOL(0, "progress", &suc
.progress
,
1914 N_("force cloning progress")),
1915 OPT_BOOL(0, "require-init", &suc
.require_init
,
1916 N_("disallow cloning into non-empty directory")),
1917 OPT_BOOL(0, "single-branch", &suc
.single_branch
,
1918 N_("clone only one branch, HEAD or --branch")),
1922 const char *const git_submodule_helper_usage
[] = {
1923 N_("git submodule--helper update-clone [--prefix=<path>] [<path>...]"),
1926 suc
.prefix
= prefix
;
1928 update_clone_config_from_gitmodules(&suc
.max_jobs
);
1929 git_config(git_update_clone_config
, &suc
.max_jobs
);
1931 argc
= parse_options(argc
, argv
, prefix
, module_update_clone_options
,
1932 git_submodule_helper_usage
, 0);
1935 if (parse_submodule_update_strategy(update
, &suc
.update
) < 0)
1936 die(_("bad value for update parameter"));
1938 if (module_list_compute(argc
, argv
, prefix
, &pathspec
, &suc
.list
) < 0)
1942 suc
.warn_if_uninitialized
= 1;
1944 return update_submodules(&suc
);
1947 static int resolve_relative_path(int argc
, const char **argv
, const char *prefix
)
1949 struct strbuf sb
= STRBUF_INIT
;
1951 die("submodule--helper relative-path takes exactly 2 arguments, got %d", argc
);
1953 printf("%s", relative_path(argv
[1], argv
[2], &sb
));
1954 strbuf_release(&sb
);
1958 static const char *remote_submodule_branch(const char *path
)
1960 const struct submodule
*sub
;
1961 const char *branch
= NULL
;
1964 sub
= submodule_from_path(the_repository
, &null_oid
, path
);
1968 key
= xstrfmt("submodule.%s.branch", sub
->name
);
1969 if (repo_config_get_string_const(the_repository
, key
, &branch
))
1970 branch
= sub
->branch
;
1976 if (!strcmp(branch
, ".")) {
1977 const char *refname
= resolve_ref_unsafe("HEAD", 0, NULL
, NULL
);
1980 die(_("No such ref: %s"), "HEAD");
1983 if (!strcmp(refname
, "HEAD"))
1984 die(_("Submodule (%s) branch configured to inherit "
1985 "branch from superproject, but the superproject "
1986 "is not on any branch"), sub
->name
);
1988 if (!skip_prefix(refname
, "refs/heads/", &refname
))
1989 die(_("Expecting a full ref name, got %s"), refname
);
1996 static int resolve_remote_submodule_branch(int argc
, const char **argv
,
2000 struct strbuf sb
= STRBUF_INIT
;
2002 die("submodule--helper remote-branch takes exactly one arguments, got %d", argc
);
2004 ret
= remote_submodule_branch(argv
[1]);
2006 die("submodule %s doesn't exist", argv
[1]);
2009 strbuf_release(&sb
);
2013 static int push_check(int argc
, const char **argv
, const char *prefix
)
2015 struct remote
*remote
;
2016 const char *superproject_head
;
2018 int detached_head
= 0;
2019 struct object_id head_oid
;
2022 die("submodule--helper push-check requires at least 2 arguments");
2025 * superproject's resolved head ref.
2026 * if HEAD then the superproject is in a detached head state, otherwise
2027 * it will be the resolved head ref.
2029 superproject_head
= argv
[1];
2032 /* Get the submodule's head ref and determine if it is detached */
2033 head
= resolve_refdup("HEAD", 0, &head_oid
, NULL
);
2035 die(_("Failed to resolve HEAD as a valid ref."));
2036 if (!strcmp(head
, "HEAD"))
2040 * The remote must be configured.
2041 * This is to avoid pushing to the exact same URL as the parent.
2043 remote
= pushremote_get(argv
[1]);
2044 if (!remote
|| remote
->origin
== REMOTE_UNCONFIGURED
)
2045 die("remote '%s' not configured", argv
[1]);
2047 /* Check the refspec */
2050 struct ref
*local_refs
= get_local_heads();
2051 struct refspec refspec
= REFSPEC_INIT_PUSH
;
2053 refspec_appendn(&refspec
, argv
+ 2, argc
- 2);
2055 for (i
= 0; i
< refspec
.nr
; i
++) {
2056 const struct refspec_item
*rs
= &refspec
.items
[i
];
2058 if (rs
->pattern
|| rs
->matching
)
2061 /* LHS must match a single ref */
2062 switch (count_refspec_match(rs
->src
, local_refs
, NULL
)) {
2067 * If LHS matches 'HEAD' then we need to ensure
2068 * that it matches the same named branch
2069 * checked out in the superproject.
2071 if (!strcmp(rs
->src
, "HEAD")) {
2072 if (!detached_head
&&
2073 !strcmp(head
, superproject_head
))
2075 die("HEAD does not match the named branch in the superproject");
2079 die("src refspec '%s' must name a ref",
2083 refspec_clear(&refspec
);
2090 static int ensure_core_worktree(int argc
, const char **argv
, const char *prefix
)
2092 const struct submodule
*sub
;
2095 struct repository subrepo
;
2098 BUG("submodule--helper ensure-core-worktree <path>");
2102 sub
= submodule_from_path(the_repository
, &null_oid
, path
);
2104 BUG("We could get the submodule handle before?");
2106 if (repo_submodule_init(&subrepo
, the_repository
, sub
))
2107 die(_("could not get a repository handle for submodule '%s'"), path
);
2109 if (!repo_config_get_string(&subrepo
, "core.worktree", &cw
)) {
2110 char *cfg_file
, *abs_path
;
2111 const char *rel_path
;
2112 struct strbuf sb
= STRBUF_INIT
;
2114 cfg_file
= repo_git_path(&subrepo
, "config");
2116 abs_path
= absolute_pathdup(path
);
2117 rel_path
= relative_path(abs_path
, subrepo
.gitdir
, &sb
);
2119 git_config_set_in_file(cfg_file
, "core.worktree", rel_path
);
2123 strbuf_release(&sb
);
2129 static int absorb_git_dirs(int argc
, const char **argv
, const char *prefix
)
2132 struct pathspec pathspec
;
2133 struct module_list list
= MODULE_LIST_INIT
;
2134 unsigned flags
= ABSORB_GITDIR_RECURSE_SUBMODULES
;
2136 struct option embed_gitdir_options
[] = {
2137 OPT_STRING(0, "prefix", &prefix
,
2139 N_("path into the working tree")),
2140 OPT_BIT(0, "--recursive", &flags
, N_("recurse into submodules"),
2141 ABSORB_GITDIR_RECURSE_SUBMODULES
),
2145 const char *const git_submodule_helper_usage
[] = {
2146 N_("git submodule--helper absorb-git-dirs [<options>] [<path>...]"),
2150 argc
= parse_options(argc
, argv
, prefix
, embed_gitdir_options
,
2151 git_submodule_helper_usage
, 0);
2153 if (module_list_compute(argc
, argv
, prefix
, &pathspec
, &list
) < 0)
2156 for (i
= 0; i
< list
.nr
; i
++)
2157 absorb_git_dir_into_superproject(list
.entries
[i
]->name
, flags
);
2162 static int is_active(int argc
, const char **argv
, const char *prefix
)
2165 die("submodule--helper is-active takes exactly 1 argument");
2167 return !is_submodule_active(the_repository
, argv
[1]);
2171 * Exit non-zero if any of the submodule names given on the command line is
2172 * invalid. If no names are given, filter stdin to print only valid names
2173 * (which is primarily intended for testing).
2175 static int check_name(int argc
, const char **argv
, const char *prefix
)
2179 if (check_submodule_name(*argv
) < 0)
2183 struct strbuf buf
= STRBUF_INIT
;
2184 while (strbuf_getline(&buf
, stdin
) != EOF
) {
2185 if (!check_submodule_name(buf
.buf
))
2186 printf("%s\n", buf
.buf
);
2188 strbuf_release(&buf
);
2193 static int module_config(int argc
, const char **argv
, const char *prefix
)
2196 CHECK_WRITEABLE
= 1,
2200 struct option module_config_options
[] = {
2201 OPT_CMDMODE(0, "check-writeable", &command
,
2202 N_("check if it is safe to write to the .gitmodules file"),
2204 OPT_CMDMODE(0, "unset", &command
,
2205 N_("unset the config in the .gitmodules file"),
2209 const char *const git_submodule_helper_usage
[] = {
2210 N_("git submodule--helper config <name> [<value>]"),
2211 N_("git submodule--helper config --unset <name>"),
2212 N_("git submodule--helper config --check-writeable"),
2216 argc
= parse_options(argc
, argv
, prefix
, module_config_options
,
2217 git_submodule_helper_usage
, PARSE_OPT_KEEP_ARGV0
);
2219 if (argc
== 1 && command
== CHECK_WRITEABLE
)
2220 return is_writing_gitmodules_ok() ? 0 : -1;
2222 /* Equivalent to ACTION_GET in builtin/config.c */
2223 if (argc
== 2 && command
!= DO_UNSET
)
2224 return print_config_from_gitmodules(the_repository
, argv
[1]);
2226 /* Equivalent to ACTION_SET in builtin/config.c */
2227 if (argc
== 3 || (argc
== 2 && command
== DO_UNSET
)) {
2228 const char *value
= (argc
== 3) ? argv
[2] : NULL
;
2230 if (!is_writing_gitmodules_ok())
2231 die(_("please make sure that the .gitmodules file is in the working tree"));
2233 return config_set_in_gitmodules_file_gently(argv
[1], value
);
2236 usage_with_options(git_submodule_helper_usage
, module_config_options
);
2239 #define SUPPORT_SUPER_PREFIX (1<<0)
2243 int (*fn
)(int, const char **, const char *);
2247 static struct cmd_struct commands
[] = {
2248 {"list", module_list
, 0},
2249 {"name", module_name
, 0},
2250 {"clone", module_clone
, 0},
2251 {"update-module-mode", module_update_module_mode
, 0},
2252 {"update-clone", update_clone
, 0},
2253 {"ensure-core-worktree", ensure_core_worktree
, 0},
2254 {"relative-path", resolve_relative_path
, 0},
2255 {"resolve-relative-url", resolve_relative_url
, 0},
2256 {"resolve-relative-url-test", resolve_relative_url_test
, 0},
2257 {"foreach", module_foreach
, SUPPORT_SUPER_PREFIX
},
2258 {"init", module_init
, SUPPORT_SUPER_PREFIX
},
2259 {"status", module_status
, SUPPORT_SUPER_PREFIX
},
2260 {"print-default-remote", print_default_remote
, 0},
2261 {"sync", module_sync
, SUPPORT_SUPER_PREFIX
},
2262 {"deinit", module_deinit
, 0},
2263 {"remote-branch", resolve_remote_submodule_branch
, 0},
2264 {"push-check", push_check
, 0},
2265 {"absorb-git-dirs", absorb_git_dirs
, SUPPORT_SUPER_PREFIX
},
2266 {"is-active", is_active
, 0},
2267 {"check-name", check_name
, 0},
2268 {"config", module_config
, 0},
2271 int cmd_submodule__helper(int argc
, const char **argv
, const char *prefix
)
2274 if (argc
< 2 || !strcmp(argv
[1], "-h"))
2275 usage("git submodule--helper <command>");
2277 for (i
= 0; i
< ARRAY_SIZE(commands
); i
++) {
2278 if (!strcmp(argv
[1], commands
[i
].cmd
)) {
2279 if (get_super_prefix() &&
2280 !(commands
[i
].option
& SUPPORT_SUPER_PREFIX
))
2281 die(_("%s doesn't support --super-prefix"),
2283 return commands
[i
].fn(argc
- 1, argv
+ 1, prefix
);
2287 die(_("'%s' is not a valid submodule--helper "
2288 "subcommand"), argv
[1]);