2 #include "repository.h"
5 #include "parse-options.h"
10 #include "submodule-config.h"
11 #include "string-list.h"
12 #include "run-command.h"
20 #include "object-store.h"
23 #define OPT_QUIET (1 << 0)
24 #define OPT_CACHED (1 << 1)
25 #define OPT_RECURSIVE (1 << 2)
26 #define OPT_FORCE (1 << 3)
28 typedef void (*each_submodule_fn
)(const struct cache_entry
*list_item
,
31 static char *get_default_remote(void)
33 char *dest
= NULL
, *ret
;
34 struct strbuf sb
= STRBUF_INIT
;
35 const char *refname
= resolve_ref_unsafe("HEAD", 0, NULL
, NULL
);
38 die(_("No such ref: %s"), "HEAD");
41 if (!strcmp(refname
, "HEAD"))
42 return xstrdup("origin");
44 if (!skip_prefix(refname
, "refs/heads/", &refname
))
45 die(_("Expecting a full ref name, got %s"), refname
);
47 strbuf_addf(&sb
, "branch.%s.remote", refname
);
48 if (git_config_get_string(sb
.buf
, &dest
))
49 ret
= xstrdup("origin");
57 static int print_default_remote(int argc
, const char **argv
, const char *prefix
)
62 die(_("submodule--helper print-default-remote takes no arguments"));
64 remote
= get_default_remote();
66 printf("%s\n", remote
);
72 static int starts_with_dot_slash(const char *str
)
74 return str
[0] == '.' && is_dir_sep(str
[1]);
77 static int starts_with_dot_dot_slash(const char *str
)
79 return str
[0] == '.' && str
[1] == '.' && is_dir_sep(str
[2]);
83 * Returns 1 if it was the last chop before ':'.
85 static int chop_last_dir(char **remoteurl
, int is_relative
)
87 char *rfind
= find_last_dir_sep(*remoteurl
);
93 rfind
= strrchr(*remoteurl
, ':');
99 if (is_relative
|| !strcmp(".", *remoteurl
))
100 die(_("cannot strip one component off url '%s'"),
104 *remoteurl
= xstrdup(".");
109 * The `url` argument is the URL that navigates to the submodule origin
110 * repo. When relative, this URL is relative to the superproject origin
111 * URL repo. The `up_path` argument, if specified, is the relative
112 * path that navigates from the submodule working tree to the superproject
113 * working tree. Returns the origin URL of the submodule.
115 * Return either an absolute URL or filesystem path (if the superproject
116 * origin URL is an absolute URL or filesystem path, respectively) or a
117 * relative file system path (if the superproject origin URL is a relative
120 * When the output is a relative file system path, the path is either
121 * relative to the submodule working tree, if up_path is specified, or to
122 * the superproject working tree otherwise.
124 * NEEDSWORK: This works incorrectly on the domain and protocol part.
125 * remote_url url outcome expectation
126 * http://a.com/b ../c http://a.com/c as is
127 * http://a.com/b/ ../c http://a.com/c same as previous line, but
128 * ignore trailing slash in url
129 * http://a.com/b ../../c http://c error out
130 * http://a.com/b ../../../c http:/c error out
131 * http://a.com/b ../../../../c http:c error out
132 * http://a.com/b ../../../../../c .:c error out
133 * NEEDSWORK: Given how chop_last_dir() works, this function is broken
134 * when a local part has a colon in its path component, too.
136 static char *relative_url(const char *remote_url
,
143 char *remoteurl
= xstrdup(remote_url
);
144 struct strbuf sb
= STRBUF_INIT
;
145 size_t len
= strlen(remoteurl
);
147 if (is_dir_sep(remoteurl
[len
-1]))
148 remoteurl
[len
-1] = '\0';
150 if (!url_is_local_not_ssh(remoteurl
) || is_absolute_path(remoteurl
))
155 * Prepend a './' to ensure all relative
156 * remoteurls start with './' or '../'
158 if (!starts_with_dot_slash(remoteurl
) &&
159 !starts_with_dot_dot_slash(remoteurl
)) {
161 strbuf_addf(&sb
, "./%s", remoteurl
);
163 remoteurl
= strbuf_detach(&sb
, NULL
);
167 * When the url starts with '../', remove that and the
168 * last directory in remoteurl.
171 if (starts_with_dot_dot_slash(url
)) {
173 colonsep
|= chop_last_dir(&remoteurl
, is_relative
);
174 } else if (starts_with_dot_slash(url
))
180 strbuf_addf(&sb
, "%s%s%s", remoteurl
, colonsep
? ":" : "/", url
);
181 if (ends_with(url
, "/"))
182 strbuf_setlen(&sb
, sb
.len
- 1);
185 if (starts_with_dot_slash(sb
.buf
))
186 out
= xstrdup(sb
.buf
+ 2);
188 out
= xstrdup(sb
.buf
);
191 if (!up_path
|| !is_relative
)
194 strbuf_addf(&sb
, "%s%s", up_path
, out
);
196 return strbuf_detach(&sb
, NULL
);
199 static int resolve_relative_url(int argc
, const char **argv
, const char *prefix
)
201 char *remoteurl
= NULL
;
202 char *remote
= get_default_remote();
203 const char *up_path
= NULL
;
206 struct strbuf sb
= STRBUF_INIT
;
208 if (argc
!= 2 && argc
!= 3)
209 die("resolve-relative-url only accepts one or two arguments");
212 strbuf_addf(&sb
, "remote.%s.url", remote
);
215 if (git_config_get_string(sb
.buf
, &remoteurl
))
216 /* the repository is its own authoritative upstream */
217 remoteurl
= xgetcwd();
222 res
= relative_url(remoteurl
, url
, up_path
);
229 static int resolve_relative_url_test(int argc
, const char **argv
, const char *prefix
)
231 char *remoteurl
, *res
;
232 const char *up_path
, *url
;
235 die("resolve-relative-url-test only accepts three arguments: <up_path> <remoteurl> <url>");
238 remoteurl
= xstrdup(argv
[2]);
241 if (!strcmp(up_path
, "(null)"))
244 res
= relative_url(remoteurl
, url
, up_path
);
251 /* the result should be freed by the caller. */
252 static char *get_submodule_displaypath(const char *path
, const char *prefix
)
254 const char *super_prefix
= get_super_prefix();
256 if (prefix
&& super_prefix
) {
257 BUG("cannot have prefix '%s' and superprefix '%s'",
258 prefix
, super_prefix
);
260 struct strbuf sb
= STRBUF_INIT
;
261 char *displaypath
= xstrdup(relative_path(path
, prefix
, &sb
));
264 } else if (super_prefix
) {
265 return xstrfmt("%s%s", super_prefix
, path
);
267 return xstrdup(path
);
271 static char *compute_rev_name(const char *sub_path
, const char* object_id
)
273 struct strbuf sb
= STRBUF_INIT
;
276 static const char *describe_bare
[] = { NULL
};
278 static const char *describe_tags
[] = { "--tags", NULL
};
280 static const char *describe_contains
[] = { "--contains", NULL
};
282 static const char *describe_all_always
[] = { "--all", "--always", NULL
};
284 static const char **describe_argv
[] = { describe_bare
, describe_tags
,
286 describe_all_always
, NULL
};
288 for (d
= describe_argv
; *d
; d
++) {
289 struct child_process cp
= CHILD_PROCESS_INIT
;
290 prepare_submodule_repo_env(&cp
.env_array
);
295 argv_array_push(&cp
.args
, "describe");
296 argv_array_pushv(&cp
.args
, *d
);
297 argv_array_push(&cp
.args
, object_id
);
299 if (!capture_command(&cp
, &sb
, 0)) {
300 strbuf_strip_suffix(&sb
, "\n");
301 return strbuf_detach(&sb
, NULL
);
310 const struct cache_entry
**entries
;
313 #define MODULE_LIST_INIT { NULL, 0, 0 }
315 static int module_list_compute(int argc
, const char **argv
,
317 struct pathspec
*pathspec
,
318 struct module_list
*list
)
321 char *ps_matched
= NULL
;
322 parse_pathspec(pathspec
, 0,
323 PATHSPEC_PREFER_FULL
,
327 ps_matched
= xcalloc(pathspec
->nr
, 1);
329 if (read_cache() < 0)
330 die(_("index file corrupt"));
332 for (i
= 0; i
< active_nr
; i
++) {
333 const struct cache_entry
*ce
= active_cache
[i
];
335 if (!match_pathspec(&the_index
, pathspec
, ce
->name
, ce_namelen(ce
),
337 !S_ISGITLINK(ce
->ce_mode
))
340 ALLOC_GROW(list
->entries
, list
->nr
+ 1, list
->alloc
);
341 list
->entries
[list
->nr
++] = ce
;
342 while (i
+ 1 < active_nr
&&
343 !strcmp(ce
->name
, active_cache
[i
+ 1]->name
))
345 * Skip entries with the same name in different stages
346 * to make sure an entry is returned only once.
351 if (ps_matched
&& report_path_error(ps_matched
, pathspec
, prefix
))
359 static void module_list_active(struct module_list
*list
)
362 struct module_list active_modules
= MODULE_LIST_INIT
;
364 for (i
= 0; i
< list
->nr
; i
++) {
365 const struct cache_entry
*ce
= list
->entries
[i
];
367 if (!is_submodule_active(the_repository
, ce
->name
))
370 ALLOC_GROW(active_modules
.entries
,
371 active_modules
.nr
+ 1,
372 active_modules
.alloc
);
373 active_modules
.entries
[active_modules
.nr
++] = ce
;
377 *list
= active_modules
;
380 static char *get_up_path(const char *path
)
383 struct strbuf sb
= STRBUF_INIT
;
385 for (i
= count_slashes(path
); i
; i
--)
386 strbuf_addstr(&sb
, "../");
389 * Check if 'path' ends with slash or not
390 * for having the same output for dir/sub_dir
393 if (!is_dir_sep(path
[strlen(path
) - 1]))
394 strbuf_addstr(&sb
, "../");
396 return strbuf_detach(&sb
, NULL
);
399 static int module_list(int argc
, const char **argv
, const char *prefix
)
402 struct pathspec pathspec
;
403 struct module_list list
= MODULE_LIST_INIT
;
405 struct option module_list_options
[] = {
406 OPT_STRING(0, "prefix", &prefix
,
408 N_("alternative anchor for relative paths")),
412 const char *const git_submodule_helper_usage
[] = {
413 N_("git submodule--helper list [--prefix=<path>] [<path>...]"),
417 argc
= parse_options(argc
, argv
, prefix
, module_list_options
,
418 git_submodule_helper_usage
, 0);
420 if (module_list_compute(argc
, argv
, prefix
, &pathspec
, &list
) < 0)
423 for (i
= 0; i
< list
.nr
; i
++) {
424 const struct cache_entry
*ce
= list
.entries
[i
];
427 printf("%06o %s U\t", ce
->ce_mode
, sha1_to_hex(null_sha1
));
429 printf("%06o %s %d\t", ce
->ce_mode
,
430 oid_to_hex(&ce
->oid
), ce_stage(ce
));
432 fprintf(stdout
, "%s\n", ce
->name
);
437 static void for_each_listed_submodule(const struct module_list
*list
,
438 each_submodule_fn fn
, void *cb_data
)
441 for (i
= 0; i
< list
->nr
; i
++)
442 fn(list
->entries
[i
], cb_data
);
452 #define CB_FOREACH_INIT { 0 }
454 static void runcommand_in_submodule_cb(const struct cache_entry
*list_item
,
457 struct cb_foreach
*info
= cb_data
;
458 const char *path
= list_item
->name
;
459 const struct object_id
*ce_oid
= &list_item
->oid
;
461 const struct submodule
*sub
;
462 struct child_process cp
= CHILD_PROCESS_INIT
;
465 displaypath
= get_submodule_displaypath(path
, info
->prefix
);
467 sub
= submodule_from_path(the_repository
, &null_oid
, path
);
470 die(_("No url found for submodule path '%s' in .gitmodules"),
473 if (!is_submodule_populated_gently(path
, NULL
))
476 prepare_submodule_repo_env(&cp
.env_array
);
479 * For the purpose of executing <command> in the submodule,
480 * separate shell is used for the purpose of running the
487 * NEEDSWORK: the command currently has access to the variables $name,
488 * $sm_path, $displaypath, $sha1 and $toplevel only when the command
489 * contains a single argument. This is done for maintaining a faithful
490 * translation from shell script.
492 if (info
->argc
== 1) {
493 char *toplevel
= xgetcwd();
494 struct strbuf sb
= STRBUF_INIT
;
496 argv_array_pushf(&cp
.env_array
, "name=%s", sub
->name
);
497 argv_array_pushf(&cp
.env_array
, "sm_path=%s", path
);
498 argv_array_pushf(&cp
.env_array
, "displaypath=%s", displaypath
);
499 argv_array_pushf(&cp
.env_array
, "sha1=%s",
501 argv_array_pushf(&cp
.env_array
, "toplevel=%s", toplevel
);
504 * Since the path variable was accessible from the script
505 * before porting, it is also made available after porting.
506 * The environment variable "PATH" has a very special purpose
507 * on windows. And since environment variables are
508 * case-insensitive in windows, it interferes with the
509 * existing PATH variable. Hence, to avoid that, we expose
510 * path via the args argv_array and not via env_array.
512 sq_quote_buf(&sb
, path
);
513 argv_array_pushf(&cp
.args
, "path=%s; %s",
514 sb
.buf
, info
->argv
[0]);
518 argv_array_pushv(&cp
.args
, info
->argv
);
522 printf(_("Entering '%s'\n"), displaypath
);
524 if (info
->argv
[0] && run_command(&cp
))
525 die(_("run_command returned non-zero status for %s\n."),
528 if (info
->recursive
) {
529 struct child_process cpr
= CHILD_PROCESS_INIT
;
533 prepare_submodule_repo_env(&cpr
.env_array
);
535 argv_array_pushl(&cpr
.args
, "--super-prefix", NULL
);
536 argv_array_pushf(&cpr
.args
, "%s/", displaypath
);
537 argv_array_pushl(&cpr
.args
, "submodule--helper", "foreach", "--recursive",
541 argv_array_push(&cpr
.args
, "--quiet");
543 argv_array_pushv(&cpr
.args
, info
->argv
);
545 if (run_command(&cpr
))
546 die(_("run_command returned non-zero status while "
547 "recursing in the nested submodules of %s\n."),
555 static int module_foreach(int argc
, const char **argv
, const char *prefix
)
557 struct cb_foreach info
= CB_FOREACH_INIT
;
558 struct pathspec pathspec
;
559 struct module_list list
= MODULE_LIST_INIT
;
561 struct option module_foreach_options
[] = {
562 OPT__QUIET(&info
.quiet
, N_("Suppress output of entering each submodule command")),
563 OPT_BOOL(0, "recursive", &info
.recursive
,
564 N_("Recurse into nested submodules")),
568 const char *const git_submodule_helper_usage
[] = {
569 N_("git submodule--helper foreach [--quiet] [--recursive] <command>"),
573 argc
= parse_options(argc
, argv
, prefix
, module_foreach_options
,
574 git_submodule_helper_usage
, PARSE_OPT_KEEP_UNKNOWN
);
576 if (module_list_compute(0, NULL
, prefix
, &pathspec
, &list
) < 0)
581 info
.prefix
= prefix
;
583 for_each_listed_submodule(&list
, runcommand_in_submodule_cb
, &info
);
588 static char *compute_submodule_clone_url(const char *rel_url
)
590 char *remoteurl
, *relurl
;
591 char *remote
= get_default_remote();
592 struct strbuf remotesb
= STRBUF_INIT
;
594 strbuf_addf(&remotesb
, "remote.%s.url", remote
);
595 if (git_config_get_string(remotesb
.buf
, &remoteurl
)) {
596 warning(_("could not look up configuration '%s'. Assuming this repository is its own authoritative upstream."), remotesb
.buf
);
597 remoteurl
= xgetcwd();
599 relurl
= relative_url(remoteurl
, rel_url
, NULL
);
603 strbuf_release(&remotesb
);
613 #define INIT_CB_INIT { NULL, 0 }
615 static void init_submodule(const char *path
, const char *prefix
,
618 const struct submodule
*sub
;
619 struct strbuf sb
= STRBUF_INIT
;
620 char *upd
= NULL
, *url
= NULL
, *displaypath
;
622 displaypath
= get_submodule_displaypath(path
, prefix
);
624 sub
= submodule_from_path(the_repository
, &null_oid
, path
);
627 die(_("No url found for submodule path '%s' in .gitmodules"),
631 * NEEDSWORK: In a multi-working-tree world, this needs to be
632 * set in the per-worktree config.
634 * Set active flag for the submodule being initialized
636 if (!is_submodule_active(the_repository
, path
)) {
637 strbuf_addf(&sb
, "submodule.%s.active", sub
->name
);
638 git_config_set_gently(sb
.buf
, "true");
643 * Copy url setting when it is not set yet.
644 * To look up the url in .git/config, we must not fall back to
645 * .gitmodules, so look it up directly.
647 strbuf_addf(&sb
, "submodule.%s.url", sub
->name
);
648 if (git_config_get_string(sb
.buf
, &url
)) {
650 die(_("No url found for submodule path '%s' in .gitmodules"),
653 url
= xstrdup(sub
->url
);
655 /* Possibly a url relative to parent */
656 if (starts_with_dot_dot_slash(url
) ||
657 starts_with_dot_slash(url
)) {
659 url
= compute_submodule_clone_url(oldurl
);
663 if (git_config_set_gently(sb
.buf
, url
))
664 die(_("Failed to register url for submodule path '%s'"),
666 if (!(flags
& OPT_QUIET
))
668 _("Submodule '%s' (%s) registered for path '%s'\n"),
669 sub
->name
, url
, displaypath
);
673 /* Copy "update" setting when it is not set yet */
674 strbuf_addf(&sb
, "submodule.%s.update", sub
->name
);
675 if (git_config_get_string(sb
.buf
, &upd
) &&
676 sub
->update_strategy
.type
!= SM_UPDATE_UNSPECIFIED
) {
677 if (sub
->update_strategy
.type
== SM_UPDATE_COMMAND
) {
678 fprintf(stderr
, _("warning: command update mode suggested for submodule '%s'\n"),
680 upd
= xstrdup("none");
682 upd
= xstrdup(submodule_strategy_to_string(&sub
->update_strategy
));
684 if (git_config_set_gently(sb
.buf
, upd
))
685 die(_("Failed to register update mode for submodule path '%s'"), displaypath
);
693 static void init_submodule_cb(const struct cache_entry
*list_item
, void *cb_data
)
695 struct init_cb
*info
= cb_data
;
696 init_submodule(list_item
->name
, info
->prefix
, info
->flags
);
699 static int module_init(int argc
, const char **argv
, const char *prefix
)
701 struct init_cb info
= INIT_CB_INIT
;
702 struct pathspec pathspec
;
703 struct module_list list
= MODULE_LIST_INIT
;
706 struct option module_init_options
[] = {
707 OPT__QUIET(&quiet
, N_("Suppress output for initializing a submodule")),
711 const char *const git_submodule_helper_usage
[] = {
712 N_("git submodule--helper init [<path>]"),
716 argc
= parse_options(argc
, argv
, prefix
, module_init_options
,
717 git_submodule_helper_usage
, 0);
719 if (module_list_compute(argc
, argv
, prefix
, &pathspec
, &list
) < 0)
723 * If there are no path args and submodule.active is set then,
724 * by default, only initialize 'active' modules.
726 if (!argc
&& git_config_get_value_multi("submodule.active"))
727 module_list_active(&list
);
729 info
.prefix
= prefix
;
731 info
.flags
|= OPT_QUIET
;
733 for_each_listed_submodule(&list
, init_submodule_cb
, &info
);
743 #define STATUS_CB_INIT { NULL, 0 }
745 static void print_status(unsigned int flags
, char state
, const char *path
,
746 const struct object_id
*oid
, const char *displaypath
)
748 if (flags
& OPT_QUIET
)
751 printf("%c%s %s", state
, oid_to_hex(oid
), displaypath
);
753 if (state
== ' ' || state
== '+') {
754 const char *name
= compute_rev_name(path
, oid_to_hex(oid
));
757 printf(" (%s)", name
);
763 static int handle_submodule_head_ref(const char *refname
,
764 const struct object_id
*oid
, int flags
,
767 struct object_id
*output
= cb_data
;
774 static void status_submodule(const char *path
, const struct object_id
*ce_oid
,
775 unsigned int ce_flags
, const char *prefix
,
779 struct argv_array diff_files_args
= ARGV_ARRAY_INIT
;
781 int diff_files_result
;
783 if (!submodule_from_path(the_repository
, &null_oid
, path
))
784 die(_("no submodule mapping found in .gitmodules for path '%s'"),
787 displaypath
= get_submodule_displaypath(path
, prefix
);
789 if ((CE_STAGEMASK
& ce_flags
) >> CE_STAGESHIFT
) {
790 print_status(flags
, 'U', path
, &null_oid
, displaypath
);
794 if (!is_submodule_active(the_repository
, path
)) {
795 print_status(flags
, '-', path
, ce_oid
, displaypath
);
799 argv_array_pushl(&diff_files_args
, "diff-files",
800 "--ignore-submodules=dirty", "--quiet", "--",
803 git_config(git_diff_basic_config
, NULL
);
804 repo_init_revisions(the_repository
, &rev
, prefix
);
806 diff_files_args
.argc
= setup_revisions(diff_files_args
.argc
,
807 diff_files_args
.argv
,
809 diff_files_result
= run_diff_files(&rev
, 0);
811 if (!diff_result_code(&rev
.diffopt
, diff_files_result
)) {
812 print_status(flags
, ' ', path
, ce_oid
,
814 } else if (!(flags
& OPT_CACHED
)) {
815 struct object_id oid
;
816 struct ref_store
*refs
= get_submodule_ref_store(path
);
819 print_status(flags
, '-', path
, ce_oid
, displaypath
);
822 if (refs_head_ref(refs
, handle_submodule_head_ref
, &oid
))
823 die(_("could not resolve HEAD ref inside the "
824 "submodule '%s'"), path
);
826 print_status(flags
, '+', path
, &oid
, displaypath
);
828 print_status(flags
, '+', path
, ce_oid
, displaypath
);
831 if (flags
& OPT_RECURSIVE
) {
832 struct child_process cpr
= CHILD_PROCESS_INIT
;
836 prepare_submodule_repo_env(&cpr
.env_array
);
838 argv_array_push(&cpr
.args
, "--super-prefix");
839 argv_array_pushf(&cpr
.args
, "%s/", displaypath
);
840 argv_array_pushl(&cpr
.args
, "submodule--helper", "status",
841 "--recursive", NULL
);
843 if (flags
& OPT_CACHED
)
844 argv_array_push(&cpr
.args
, "--cached");
846 if (flags
& OPT_QUIET
)
847 argv_array_push(&cpr
.args
, "--quiet");
849 if (run_command(&cpr
))
850 die(_("failed to recurse into submodule '%s'"), path
);
854 argv_array_clear(&diff_files_args
);
858 static void status_submodule_cb(const struct cache_entry
*list_item
,
861 struct status_cb
*info
= cb_data
;
862 status_submodule(list_item
->name
, &list_item
->oid
, list_item
->ce_flags
,
863 info
->prefix
, info
->flags
);
866 static int module_status(int argc
, const char **argv
, const char *prefix
)
868 struct status_cb info
= STATUS_CB_INIT
;
869 struct pathspec pathspec
;
870 struct module_list list
= MODULE_LIST_INIT
;
873 struct option module_status_options
[] = {
874 OPT__QUIET(&quiet
, N_("Suppress submodule status output")),
875 OPT_BIT(0, "cached", &info
.flags
, N_("Use commit stored in the index instead of the one stored in the submodule HEAD"), OPT_CACHED
),
876 OPT_BIT(0, "recursive", &info
.flags
, N_("recurse into nested submodules"), OPT_RECURSIVE
),
880 const char *const git_submodule_helper_usage
[] = {
881 N_("git submodule status [--quiet] [--cached] [--recursive] [<path>...]"),
885 argc
= parse_options(argc
, argv
, prefix
, module_status_options
,
886 git_submodule_helper_usage
, 0);
888 if (module_list_compute(argc
, argv
, prefix
, &pathspec
, &list
) < 0)
891 info
.prefix
= prefix
;
893 info
.flags
|= OPT_QUIET
;
895 for_each_listed_submodule(&list
, status_submodule_cb
, &info
);
900 static int module_name(int argc
, const char **argv
, const char *prefix
)
902 const struct submodule
*sub
;
905 usage(_("git submodule--helper name <path>"));
907 sub
= submodule_from_path(the_repository
, &null_oid
, argv
[1]);
910 die(_("no submodule mapping found in .gitmodules for path '%s'"),
913 printf("%s\n", sub
->name
);
923 #define SYNC_CB_INIT { NULL, 0 }
925 static void sync_submodule(const char *path
, const char *prefix
,
928 const struct submodule
*sub
;
929 char *remote_key
= NULL
;
930 char *sub_origin_url
, *super_config_url
, *displaypath
;
931 struct strbuf sb
= STRBUF_INIT
;
932 struct child_process cp
= CHILD_PROCESS_INIT
;
933 char *sub_config_path
= NULL
;
935 if (!is_submodule_active(the_repository
, path
))
938 sub
= submodule_from_path(the_repository
, &null_oid
, path
);
940 if (sub
&& sub
->url
) {
941 if (starts_with_dot_dot_slash(sub
->url
) ||
942 starts_with_dot_slash(sub
->url
)) {
943 char *remote_url
, *up_path
;
944 char *remote
= get_default_remote();
945 strbuf_addf(&sb
, "remote.%s.url", remote
);
947 if (git_config_get_string(sb
.buf
, &remote_url
))
948 remote_url
= xgetcwd();
950 up_path
= get_up_path(path
);
951 sub_origin_url
= relative_url(remote_url
, sub
->url
, up_path
);
952 super_config_url
= relative_url(remote_url
, sub
->url
, NULL
);
958 sub_origin_url
= xstrdup(sub
->url
);
959 super_config_url
= xstrdup(sub
->url
);
962 sub_origin_url
= xstrdup("");
963 super_config_url
= xstrdup("");
966 displaypath
= get_submodule_displaypath(path
, prefix
);
968 if (!(flags
& OPT_QUIET
))
969 printf(_("Synchronizing submodule url for '%s'\n"),
973 strbuf_addf(&sb
, "submodule.%s.url", sub
->name
);
974 if (git_config_set_gently(sb
.buf
, super_config_url
))
975 die(_("failed to register url for submodule path '%s'"),
978 if (!is_submodule_populated_gently(path
, NULL
))
981 prepare_submodule_repo_env(&cp
.env_array
);
984 argv_array_pushl(&cp
.args
, "submodule--helper",
985 "print-default-remote", NULL
);
988 if (capture_command(&cp
, &sb
, 0))
989 die(_("failed to get the default remote for submodule '%s'"),
992 strbuf_strip_suffix(&sb
, "\n");
993 remote_key
= xstrfmt("remote.%s.url", sb
.buf
);
996 submodule_to_gitdir(&sb
, path
);
997 strbuf_addstr(&sb
, "/config");
999 if (git_config_set_in_file_gently(sb
.buf
, remote_key
, sub_origin_url
))
1000 die(_("failed to update remote for submodule '%s'"),
1003 if (flags
& OPT_RECURSIVE
) {
1004 struct child_process cpr
= CHILD_PROCESS_INIT
;
1008 prepare_submodule_repo_env(&cpr
.env_array
);
1010 argv_array_push(&cpr
.args
, "--super-prefix");
1011 argv_array_pushf(&cpr
.args
, "%s/", displaypath
);
1012 argv_array_pushl(&cpr
.args
, "submodule--helper", "sync",
1013 "--recursive", NULL
);
1015 if (flags
& OPT_QUIET
)
1016 argv_array_push(&cpr
.args
, "--quiet");
1018 if (run_command(&cpr
))
1019 die(_("failed to recurse into submodule '%s'"),
1024 free(super_config_url
);
1025 free(sub_origin_url
);
1026 strbuf_release(&sb
);
1029 free(sub_config_path
);
1032 static void sync_submodule_cb(const struct cache_entry
*list_item
, void *cb_data
)
1034 struct sync_cb
*info
= cb_data
;
1035 sync_submodule(list_item
->name
, info
->prefix
, info
->flags
);
1038 static int module_sync(int argc
, const char **argv
, const char *prefix
)
1040 struct sync_cb info
= SYNC_CB_INIT
;
1041 struct pathspec pathspec
;
1042 struct module_list list
= MODULE_LIST_INIT
;
1046 struct option module_sync_options
[] = {
1047 OPT__QUIET(&quiet
, N_("Suppress output of synchronizing submodule url")),
1048 OPT_BOOL(0, "recursive", &recursive
,
1049 N_("Recurse into nested submodules")),
1053 const char *const git_submodule_helper_usage
[] = {
1054 N_("git submodule--helper sync [--quiet] [--recursive] [<path>]"),
1058 argc
= parse_options(argc
, argv
, prefix
, module_sync_options
,
1059 git_submodule_helper_usage
, 0);
1061 if (module_list_compute(argc
, argv
, prefix
, &pathspec
, &list
) < 0)
1064 info
.prefix
= prefix
;
1066 info
.flags
|= OPT_QUIET
;
1068 info
.flags
|= OPT_RECURSIVE
;
1070 for_each_listed_submodule(&list
, sync_submodule_cb
, &info
);
1079 #define DEINIT_CB_INIT { NULL, 0 }
1081 static void deinit_submodule(const char *path
, const char *prefix
,
1084 const struct submodule
*sub
;
1085 char *displaypath
= NULL
;
1086 struct child_process cp_config
= CHILD_PROCESS_INIT
;
1087 struct strbuf sb_config
= STRBUF_INIT
;
1088 char *sub_git_dir
= xstrfmt("%s/.git", path
);
1090 sub
= submodule_from_path(the_repository
, &null_oid
, path
);
1092 if (!sub
|| !sub
->name
)
1095 displaypath
= get_submodule_displaypath(path
, prefix
);
1097 /* remove the submodule work tree (unless the user already did it) */
1098 if (is_directory(path
)) {
1099 struct strbuf sb_rm
= STRBUF_INIT
;
1103 * protect submodules containing a .git directory
1104 * NEEDSWORK: instead of dying, automatically call
1105 * absorbgitdirs and (possibly) warn.
1107 if (is_directory(sub_git_dir
))
1108 die(_("Submodule work tree '%s' contains a .git "
1109 "directory (use 'rm -rf' if you really want "
1110 "to remove it including all of its history)"),
1113 if (!(flags
& OPT_FORCE
)) {
1114 struct child_process cp_rm
= CHILD_PROCESS_INIT
;
1116 argv_array_pushl(&cp_rm
.args
, "rm", "-qn",
1119 if (run_command(&cp_rm
))
1120 die(_("Submodule work tree '%s' contains local "
1121 "modifications; use '-f' to discard them"),
1125 strbuf_addstr(&sb_rm
, path
);
1127 if (!remove_dir_recursively(&sb_rm
, 0))
1128 format
= _("Cleared directory '%s'\n");
1130 format
= _("Could not remove submodule work tree '%s'\n");
1132 if (!(flags
& OPT_QUIET
))
1133 printf(format
, displaypath
);
1135 strbuf_release(&sb_rm
);
1138 if (mkdir(path
, 0777))
1139 printf(_("could not create empty submodule directory %s"),
1142 cp_config
.git_cmd
= 1;
1143 argv_array_pushl(&cp_config
.args
, "config", "--get-regexp", NULL
);
1144 argv_array_pushf(&cp_config
.args
, "submodule.%s\\.", sub
->name
);
1146 /* remove the .git/config entries (unless the user already did it) */
1147 if (!capture_command(&cp_config
, &sb_config
, 0) && sb_config
.len
) {
1148 char *sub_key
= xstrfmt("submodule.%s", sub
->name
);
1150 * remove the whole section so we have a clean state when
1151 * the user later decides to init this submodule again
1153 git_config_rename_section_in_file(NULL
, sub_key
, NULL
);
1154 if (!(flags
& OPT_QUIET
))
1155 printf(_("Submodule '%s' (%s) unregistered for path '%s'\n"),
1156 sub
->name
, sub
->url
, displaypath
);
1163 strbuf_release(&sb_config
);
1166 static void deinit_submodule_cb(const struct cache_entry
*list_item
,
1169 struct deinit_cb
*info
= cb_data
;
1170 deinit_submodule(list_item
->name
, info
->prefix
, info
->flags
);
1173 static int module_deinit(int argc
, const char **argv
, const char *prefix
)
1175 struct deinit_cb info
= DEINIT_CB_INIT
;
1176 struct pathspec pathspec
;
1177 struct module_list list
= MODULE_LIST_INIT
;
1182 struct option module_deinit_options
[] = {
1183 OPT__QUIET(&quiet
, N_("Suppress submodule status output")),
1184 OPT__FORCE(&force
, N_("Remove submodule working trees even if they contain local changes"), 0),
1185 OPT_BOOL(0, "all", &all
, N_("Unregister all submodules")),
1189 const char *const git_submodule_helper_usage
[] = {
1190 N_("git submodule deinit [--quiet] [-f | --force] [--all | [--] [<path>...]]"),
1194 argc
= parse_options(argc
, argv
, prefix
, module_deinit_options
,
1195 git_submodule_helper_usage
, 0);
1198 error("pathspec and --all are incompatible");
1199 usage_with_options(git_submodule_helper_usage
,
1200 module_deinit_options
);
1204 die(_("Use '--all' if you really want to deinitialize all submodules"));
1206 if (module_list_compute(argc
, argv
, prefix
, &pathspec
, &list
) < 0)
1209 info
.prefix
= prefix
;
1211 info
.flags
|= OPT_QUIET
;
1213 info
.flags
|= OPT_FORCE
;
1215 for_each_listed_submodule(&list
, deinit_submodule_cb
, &info
);
1220 static int clone_submodule(const char *path
, const char *gitdir
, const char *url
,
1221 const char *depth
, struct string_list
*reference
, int dissociate
,
1222 int quiet
, int progress
)
1224 struct child_process cp
= CHILD_PROCESS_INIT
;
1226 argv_array_push(&cp
.args
, "clone");
1227 argv_array_push(&cp
.args
, "--no-checkout");
1229 argv_array_push(&cp
.args
, "--quiet");
1231 argv_array_push(&cp
.args
, "--progress");
1232 if (depth
&& *depth
)
1233 argv_array_pushl(&cp
.args
, "--depth", depth
, NULL
);
1234 if (reference
->nr
) {
1235 struct string_list_item
*item
;
1236 for_each_string_list_item(item
, reference
)
1237 argv_array_pushl(&cp
.args
, "--reference",
1238 item
->string
, NULL
);
1241 argv_array_push(&cp
.args
, "--dissociate");
1242 if (gitdir
&& *gitdir
)
1243 argv_array_pushl(&cp
.args
, "--separate-git-dir", gitdir
, NULL
);
1245 argv_array_push(&cp
.args
, "--");
1246 argv_array_push(&cp
.args
, url
);
1247 argv_array_push(&cp
.args
, path
);
1250 prepare_submodule_repo_env(&cp
.env_array
);
1253 return run_command(&cp
);
1256 struct submodule_alternate_setup
{
1257 const char *submodule_name
;
1258 enum SUBMODULE_ALTERNATE_ERROR_MODE
{
1259 SUBMODULE_ALTERNATE_ERROR_DIE
,
1260 SUBMODULE_ALTERNATE_ERROR_INFO
,
1261 SUBMODULE_ALTERNATE_ERROR_IGNORE
1263 struct string_list
*reference
;
1265 #define SUBMODULE_ALTERNATE_SETUP_INIT { NULL, \
1266 SUBMODULE_ALTERNATE_ERROR_IGNORE, NULL }
1268 static int add_possible_reference_from_superproject(
1269 struct alternate_object_database
*alt
, void *sas_cb
)
1271 struct submodule_alternate_setup
*sas
= sas_cb
;
1274 * If the alternate object store is another repository, try the
1275 * standard layout with .git/(modules/<name>)+/objects
1277 if (ends_with(alt
->path
, "/objects")) {
1279 struct strbuf sb
= STRBUF_INIT
;
1280 struct strbuf err
= STRBUF_INIT
;
1281 strbuf_add(&sb
, alt
->path
, strlen(alt
->path
) - strlen("objects"));
1284 * We need to end the new path with '/' to mark it as a dir,
1285 * otherwise a submodule name containing '/' will be broken
1286 * as the last part of a missing submodule reference would
1287 * be taken as a file name.
1289 strbuf_addf(&sb
, "modules/%s/", sas
->submodule_name
);
1291 sm_alternate
= compute_alternate_path(sb
.buf
, &err
);
1293 string_list_append(sas
->reference
, xstrdup(sb
.buf
));
1296 switch (sas
->error_mode
) {
1297 case SUBMODULE_ALTERNATE_ERROR_DIE
:
1298 die(_("submodule '%s' cannot add alternate: %s"),
1299 sas
->submodule_name
, err
.buf
);
1300 case SUBMODULE_ALTERNATE_ERROR_INFO
:
1301 fprintf(stderr
, _("submodule '%s' cannot add alternate: %s"),
1302 sas
->submodule_name
, err
.buf
);
1303 case SUBMODULE_ALTERNATE_ERROR_IGNORE
:
1307 strbuf_release(&sb
);
1313 static void prepare_possible_alternates(const char *sm_name
,
1314 struct string_list
*reference
)
1316 char *sm_alternate
= NULL
, *error_strategy
= NULL
;
1317 struct submodule_alternate_setup sas
= SUBMODULE_ALTERNATE_SETUP_INIT
;
1319 git_config_get_string("submodule.alternateLocation", &sm_alternate
);
1323 git_config_get_string("submodule.alternateErrorStrategy", &error_strategy
);
1325 if (!error_strategy
)
1326 error_strategy
= xstrdup("die");
1328 sas
.submodule_name
= sm_name
;
1329 sas
.reference
= reference
;
1330 if (!strcmp(error_strategy
, "die"))
1331 sas
.error_mode
= SUBMODULE_ALTERNATE_ERROR_DIE
;
1332 else if (!strcmp(error_strategy
, "info"))
1333 sas
.error_mode
= SUBMODULE_ALTERNATE_ERROR_INFO
;
1334 else if (!strcmp(error_strategy
, "ignore"))
1335 sas
.error_mode
= SUBMODULE_ALTERNATE_ERROR_IGNORE
;
1337 die(_("Value '%s' for submodule.alternateErrorStrategy is not recognized"), error_strategy
);
1339 if (!strcmp(sm_alternate
, "superproject"))
1340 foreach_alt_odb(add_possible_reference_from_superproject
, &sas
);
1341 else if (!strcmp(sm_alternate
, "no"))
1344 die(_("Value '%s' for submodule.alternateLocation is not recognized"), sm_alternate
);
1347 free(error_strategy
);
1350 static int module_clone(int argc
, const char **argv
, const char *prefix
)
1352 const char *name
= NULL
, *url
= NULL
, *depth
= NULL
;
1355 char *p
, *path
= NULL
, *sm_gitdir
;
1356 struct strbuf sb
= STRBUF_INIT
;
1357 struct string_list reference
= STRING_LIST_INIT_NODUP
;
1358 int dissociate
= 0, require_init
= 0;
1359 char *sm_alternate
= NULL
, *error_strategy
= NULL
;
1361 struct option module_clone_options
[] = {
1362 OPT_STRING(0, "prefix", &prefix
,
1364 N_("alternative anchor for relative paths")),
1365 OPT_STRING(0, "path", &path
,
1367 N_("where the new submodule will be cloned to")),
1368 OPT_STRING(0, "name", &name
,
1370 N_("name of the new submodule")),
1371 OPT_STRING(0, "url", &url
,
1373 N_("url where to clone the submodule from")),
1374 OPT_STRING_LIST(0, "reference", &reference
,
1376 N_("reference repository")),
1377 OPT_BOOL(0, "dissociate", &dissociate
,
1378 N_("use --reference only while cloning")),
1379 OPT_STRING(0, "depth", &depth
,
1381 N_("depth for shallow clones")),
1382 OPT__QUIET(&quiet
, "Suppress output for cloning a submodule"),
1383 OPT_BOOL(0, "progress", &progress
,
1384 N_("force cloning progress")),
1385 OPT_BOOL(0, "require-init", &require_init
,
1386 N_("disallow cloning into non-empty directory")),
1390 const char *const git_submodule_helper_usage
[] = {
1391 N_("git submodule--helper clone [--prefix=<path>] [--quiet] "
1392 "[--reference <repository>] [--name <name>] [--depth <depth>] "
1393 "--url <url> --path <path>"),
1397 argc
= parse_options(argc
, argv
, prefix
, module_clone_options
,
1398 git_submodule_helper_usage
, 0);
1400 if (argc
|| !url
|| !path
|| !*path
)
1401 usage_with_options(git_submodule_helper_usage
,
1402 module_clone_options
);
1404 strbuf_addf(&sb
, "%s/modules/%s", get_git_dir(), name
);
1405 sm_gitdir
= absolute_pathdup(sb
.buf
);
1408 if (!is_absolute_path(path
)) {
1409 strbuf_addf(&sb
, "%s/%s", get_git_work_tree(), path
);
1410 path
= strbuf_detach(&sb
, NULL
);
1412 path
= xstrdup(path
);
1414 if (validate_submodule_git_dir(sm_gitdir
, name
) < 0)
1415 die(_("refusing to create/use '%s' in another submodule's "
1416 "git dir"), sm_gitdir
);
1418 if (!file_exists(sm_gitdir
)) {
1419 if (safe_create_leading_directories_const(sm_gitdir
) < 0)
1420 die(_("could not create directory '%s'"), sm_gitdir
);
1422 prepare_possible_alternates(name
, &reference
);
1424 if (clone_submodule(path
, sm_gitdir
, url
, depth
, &reference
, dissociate
,
1426 die(_("clone of '%s' into submodule path '%s' failed"),
1429 if (require_init
&& !access(path
, X_OK
) && !is_empty_dir(path
))
1430 die(_("directory not empty: '%s'"), path
);
1431 if (safe_create_leading_directories_const(path
) < 0)
1432 die(_("could not create directory '%s'"), path
);
1433 strbuf_addf(&sb
, "%s/index", sm_gitdir
);
1434 unlink_or_warn(sb
.buf
);
1438 connect_work_tree_and_git_dir(path
, sm_gitdir
, 0);
1440 p
= git_pathdup_submodule(path
, "config");
1442 die(_("could not get submodule directory for '%s'"), path
);
1444 /* setup alternateLocation and alternateErrorStrategy in the cloned submodule if needed */
1445 git_config_get_string("submodule.alternateLocation", &sm_alternate
);
1447 git_config_set_in_file(p
, "submodule.alternateLocation",
1449 git_config_get_string("submodule.alternateErrorStrategy", &error_strategy
);
1451 git_config_set_in_file(p
, "submodule.alternateErrorStrategy",
1455 free(error_strategy
);
1457 strbuf_release(&sb
);
1464 static void determine_submodule_update_strategy(struct repository
*r
,
1468 struct submodule_update_strategy
*out
)
1470 const struct submodule
*sub
= submodule_from_path(r
, &null_oid
, path
);
1474 key
= xstrfmt("submodule.%s.update", sub
->name
);
1477 if (parse_submodule_update_strategy(update
, out
) < 0)
1478 die(_("Invalid update mode '%s' for submodule path '%s'"),
1480 } else if (!repo_config_get_string_const(r
, key
, &val
)) {
1481 if (parse_submodule_update_strategy(val
, out
) < 0)
1482 die(_("Invalid update mode '%s' configured for submodule path '%s'"),
1484 } else if (sub
->update_strategy
.type
!= SM_UPDATE_UNSPECIFIED
) {
1485 out
->type
= sub
->update_strategy
.type
;
1486 out
->command
= sub
->update_strategy
.command
;
1488 out
->type
= SM_UPDATE_CHECKOUT
;
1491 (out
->type
== SM_UPDATE_MERGE
||
1492 out
->type
== SM_UPDATE_REBASE
||
1493 out
->type
== SM_UPDATE_NONE
))
1494 out
->type
= SM_UPDATE_CHECKOUT
;
1499 static int module_update_module_mode(int argc
, const char **argv
, const char *prefix
)
1501 const char *path
, *update
= NULL
;
1503 struct submodule_update_strategy update_strategy
= { .type
= SM_UPDATE_CHECKOUT
};
1505 if (argc
< 3 || argc
> 4)
1506 die("submodule--helper update-module-clone expects <just-cloned> <path> [<update>]");
1508 just_cloned
= git_config_int("just_cloned", argv
[1]);
1514 determine_submodule_update_strategy(the_repository
,
1515 just_cloned
, path
, update
,
1517 fputs(submodule_strategy_to_string(&update_strategy
), stdout
);
1522 struct update_clone_data
{
1523 const struct submodule
*sub
;
1524 struct object_id oid
;
1525 unsigned just_cloned
;
1528 struct submodule_update_clone
{
1529 /* index into 'list', the list of submodules to look into for cloning */
1531 struct module_list list
;
1532 unsigned warn_if_uninitialized
: 1;
1534 /* update parameter passed via commandline */
1535 struct submodule_update_strategy update
;
1537 /* configuration parameters which are passed on to the children */
1540 int recommend_shallow
;
1541 struct string_list references
;
1543 unsigned require_init
;
1545 const char *recursive_prefix
;
1548 /* to be consumed by git-submodule.sh */
1549 struct update_clone_data
*update_clone
;
1550 int update_clone_nr
; int update_clone_alloc
;
1552 /* If we want to stop as fast as possible and return an error */
1553 unsigned quickstop
: 1;
1555 /* failed clones to be retried again */
1556 const struct cache_entry
**failed_clones
;
1557 int failed_clones_nr
, failed_clones_alloc
;
1561 #define SUBMODULE_UPDATE_CLONE_INIT {0, MODULE_LIST_INIT, 0, \
1562 SUBMODULE_UPDATE_STRATEGY_INIT, 0, 0, -1, STRING_LIST_INIT_DUP, 0, 0, \
1564 NULL, 0, 0, 0, NULL, 0, 0, 0}
1567 static void next_submodule_warn_missing(struct submodule_update_clone
*suc
,
1568 struct strbuf
*out
, const char *displaypath
)
1571 * Only mention uninitialized submodules when their
1572 * paths have been specified.
1574 if (suc
->warn_if_uninitialized
) {
1576 _("Submodule path '%s' not initialized"),
1578 strbuf_addch(out
, '\n');
1580 _("Maybe you want to use 'update --init'?"));
1581 strbuf_addch(out
, '\n');
1586 * Determine whether 'ce' needs to be cloned. If so, prepare the 'child' to
1587 * run the clone. Returns 1 if 'ce' needs to be cloned, 0 otherwise.
1589 static int prepare_to_clone_next_submodule(const struct cache_entry
*ce
,
1590 struct child_process
*child
,
1591 struct submodule_update_clone
*suc
,
1594 const struct submodule
*sub
= NULL
;
1595 const char *url
= NULL
;
1596 const char *update_string
;
1597 enum submodule_update_type update_type
;
1599 struct strbuf displaypath_sb
= STRBUF_INIT
;
1600 struct strbuf sb
= STRBUF_INIT
;
1601 const char *displaypath
= NULL
;
1602 int needs_cloning
= 0;
1603 int need_free_url
= 0;
1606 if (suc
->recursive_prefix
)
1607 strbuf_addf(&sb
, "%s/%s", suc
->recursive_prefix
, ce
->name
);
1609 strbuf_addstr(&sb
, ce
->name
);
1610 strbuf_addf(out
, _("Skipping unmerged submodule %s"), sb
.buf
);
1611 strbuf_addch(out
, '\n');
1615 sub
= submodule_from_path(the_repository
, &null_oid
, ce
->name
);
1617 if (suc
->recursive_prefix
)
1618 displaypath
= relative_path(suc
->recursive_prefix
,
1619 ce
->name
, &displaypath_sb
);
1621 displaypath
= ce
->name
;
1624 next_submodule_warn_missing(suc
, out
, displaypath
);
1628 key
= xstrfmt("submodule.%s.update", sub
->name
);
1629 if (!repo_config_get_string_const(the_repository
, key
, &update_string
)) {
1630 update_type
= parse_submodule_update_type(update_string
);
1632 update_type
= sub
->update_strategy
.type
;
1636 if (suc
->update
.type
== SM_UPDATE_NONE
1637 || (suc
->update
.type
== SM_UPDATE_UNSPECIFIED
1638 && update_type
== SM_UPDATE_NONE
)) {
1639 strbuf_addf(out
, _("Skipping submodule '%s'"), displaypath
);
1640 strbuf_addch(out
, '\n');
1644 /* Check if the submodule has been initialized. */
1645 if (!is_submodule_active(the_repository
, ce
->name
)) {
1646 next_submodule_warn_missing(suc
, out
, displaypath
);
1651 strbuf_addf(&sb
, "submodule.%s.url", sub
->name
);
1652 if (repo_config_get_string_const(the_repository
, sb
.buf
, &url
)) {
1653 if (starts_with_dot_slash(sub
->url
) ||
1654 starts_with_dot_dot_slash(sub
->url
)) {
1655 url
= compute_submodule_clone_url(sub
->url
);
1662 strbuf_addf(&sb
, "%s/.git", ce
->name
);
1663 needs_cloning
= !file_exists(sb
.buf
);
1665 ALLOC_GROW(suc
->update_clone
, suc
->update_clone_nr
+ 1,
1666 suc
->update_clone_alloc
);
1667 oidcpy(&suc
->update_clone
[suc
->update_clone_nr
].oid
, &ce
->oid
);
1668 suc
->update_clone
[suc
->update_clone_nr
].just_cloned
= needs_cloning
;
1669 suc
->update_clone
[suc
->update_clone_nr
].sub
= sub
;
1670 suc
->update_clone_nr
++;
1676 child
->no_stdin
= 1;
1677 child
->stdout_to_stderr
= 1;
1679 argv_array_push(&child
->args
, "submodule--helper");
1680 argv_array_push(&child
->args
, "clone");
1682 argv_array_push(&child
->args
, "--progress");
1684 argv_array_push(&child
->args
, "--quiet");
1686 argv_array_pushl(&child
->args
, "--prefix", suc
->prefix
, NULL
);
1687 if (suc
->recommend_shallow
&& sub
->recommend_shallow
== 1)
1688 argv_array_push(&child
->args
, "--depth=1");
1689 if (suc
->require_init
)
1690 argv_array_push(&child
->args
, "--require-init");
1691 argv_array_pushl(&child
->args
, "--path", sub
->path
, NULL
);
1692 argv_array_pushl(&child
->args
, "--name", sub
->name
, NULL
);
1693 argv_array_pushl(&child
->args
, "--url", url
, NULL
);
1694 if (suc
->references
.nr
) {
1695 struct string_list_item
*item
;
1696 for_each_string_list_item(item
, &suc
->references
)
1697 argv_array_pushl(&child
->args
, "--reference", item
->string
, NULL
);
1699 if (suc
->dissociate
)
1700 argv_array_push(&child
->args
, "--dissociate");
1702 argv_array_push(&child
->args
, suc
->depth
);
1705 strbuf_reset(&displaypath_sb
);
1710 return needs_cloning
;
1713 static int update_clone_get_next_task(struct child_process
*child
,
1718 struct submodule_update_clone
*suc
= suc_cb
;
1719 const struct cache_entry
*ce
;
1722 for (; suc
->current
< suc
->list
.nr
; suc
->current
++) {
1723 ce
= suc
->list
.entries
[suc
->current
];
1724 if (prepare_to_clone_next_submodule(ce
, child
, suc
, err
)) {
1725 int *p
= xmalloc(sizeof(*p
));
1734 * The loop above tried cloning each submodule once, now try the
1735 * stragglers again, which we can imagine as an extension of the
1738 index
= suc
->current
- suc
->list
.nr
;
1739 if (index
< suc
->failed_clones_nr
) {
1741 ce
= suc
->failed_clones
[index
];
1742 if (!prepare_to_clone_next_submodule(ce
, child
, suc
, err
)) {
1744 strbuf_addstr(err
, "BUG: submodule considered for "
1745 "cloning, doesn't need cloning "
1749 p
= xmalloc(sizeof(*p
));
1759 static int update_clone_start_failure(struct strbuf
*err
,
1763 struct submodule_update_clone
*suc
= suc_cb
;
1768 static int update_clone_task_finished(int result
,
1773 const struct cache_entry
*ce
;
1774 struct submodule_update_clone
*suc
= suc_cb
;
1776 int *idxP
= idx_task_cb
;
1783 if (idx
< suc
->list
.nr
) {
1784 ce
= suc
->list
.entries
[idx
];
1785 strbuf_addf(err
, _("Failed to clone '%s'. Retry scheduled"),
1787 strbuf_addch(err
, '\n');
1788 ALLOC_GROW(suc
->failed_clones
,
1789 suc
->failed_clones_nr
+ 1,
1790 suc
->failed_clones_alloc
);
1791 suc
->failed_clones
[suc
->failed_clones_nr
++] = ce
;
1794 idx
-= suc
->list
.nr
;
1795 ce
= suc
->failed_clones
[idx
];
1796 strbuf_addf(err
, _("Failed to clone '%s' a second time, aborting"),
1798 strbuf_addch(err
, '\n');
1806 static int git_update_clone_config(const char *var
, const char *value
,
1810 if (!strcmp(var
, "submodule.fetchjobs"))
1811 *max_jobs
= parse_submodule_fetchjobs(var
, value
);
1815 static void update_submodule(struct update_clone_data
*ucd
)
1817 fprintf(stdout
, "dummy %s %d\t%s\n",
1818 oid_to_hex(&ucd
->oid
),
1823 static int update_submodules(struct submodule_update_clone
*suc
)
1827 run_processes_parallel(suc
->max_jobs
,
1828 update_clone_get_next_task
,
1829 update_clone_start_failure
,
1830 update_clone_task_finished
,
1834 * We saved the output and put it out all at once now.
1836 * - the listener does not have to interleave their (checkout)
1837 * work with our fetching. The writes involved in a
1838 * checkout involve more straightforward sequential I/O.
1839 * - the listener can avoid doing any work if fetching failed.
1844 for (i
= 0; i
< suc
->update_clone_nr
; i
++)
1845 update_submodule(&suc
->update_clone
[i
]);
1850 static int update_clone(int argc
, const char **argv
, const char *prefix
)
1852 const char *update
= NULL
;
1853 struct pathspec pathspec
;
1854 struct submodule_update_clone suc
= SUBMODULE_UPDATE_CLONE_INIT
;
1856 struct option module_update_clone_options
[] = {
1857 OPT_STRING(0, "prefix", &prefix
,
1859 N_("path into the working tree")),
1860 OPT_STRING(0, "recursive-prefix", &suc
.recursive_prefix
,
1862 N_("path into the working tree, across nested "
1863 "submodule boundaries")),
1864 OPT_STRING(0, "update", &update
,
1866 N_("rebase, merge, checkout or none")),
1867 OPT_STRING_LIST(0, "reference", &suc
.references
, N_("repo"),
1868 N_("reference repository")),
1869 OPT_BOOL(0, "dissociate", &suc
.dissociate
,
1870 N_("use --reference only while cloning")),
1871 OPT_STRING(0, "depth", &suc
.depth
, "<depth>",
1872 N_("Create a shallow clone truncated to the "
1873 "specified number of revisions")),
1874 OPT_INTEGER('j', "jobs", &suc
.max_jobs
,
1875 N_("parallel jobs")),
1876 OPT_BOOL(0, "recommend-shallow", &suc
.recommend_shallow
,
1877 N_("whether the initial clone should follow the shallow recommendation")),
1878 OPT__QUIET(&suc
.quiet
, N_("don't print cloning progress")),
1879 OPT_BOOL(0, "progress", &suc
.progress
,
1880 N_("force cloning progress")),
1881 OPT_BOOL(0, "require-init", &suc
.require_init
,
1882 N_("disallow cloning into non-empty directory")),
1886 const char *const git_submodule_helper_usage
[] = {
1887 N_("git submodule--helper update_clone [--prefix=<path>] [<path>...]"),
1890 suc
.prefix
= prefix
;
1892 update_clone_config_from_gitmodules(&suc
.max_jobs
);
1893 git_config(git_update_clone_config
, &suc
.max_jobs
);
1895 argc
= parse_options(argc
, argv
, prefix
, module_update_clone_options
,
1896 git_submodule_helper_usage
, 0);
1899 if (parse_submodule_update_strategy(update
, &suc
.update
) < 0)
1900 die(_("bad value for update parameter"));
1902 if (module_list_compute(argc
, argv
, prefix
, &pathspec
, &suc
.list
) < 0)
1906 suc
.warn_if_uninitialized
= 1;
1908 return update_submodules(&suc
);
1911 static int resolve_relative_path(int argc
, const char **argv
, const char *prefix
)
1913 struct strbuf sb
= STRBUF_INIT
;
1915 die("submodule--helper relative-path takes exactly 2 arguments, got %d", argc
);
1917 printf("%s", relative_path(argv
[1], argv
[2], &sb
));
1918 strbuf_release(&sb
);
1922 static const char *remote_submodule_branch(const char *path
)
1924 const struct submodule
*sub
;
1925 const char *branch
= NULL
;
1928 sub
= submodule_from_path(the_repository
, &null_oid
, path
);
1932 key
= xstrfmt("submodule.%s.branch", sub
->name
);
1933 if (repo_config_get_string_const(the_repository
, key
, &branch
))
1934 branch
= sub
->branch
;
1940 if (!strcmp(branch
, ".")) {
1941 const char *refname
= resolve_ref_unsafe("HEAD", 0, NULL
, NULL
);
1944 die(_("No such ref: %s"), "HEAD");
1947 if (!strcmp(refname
, "HEAD"))
1948 die(_("Submodule (%s) branch configured to inherit "
1949 "branch from superproject, but the superproject "
1950 "is not on any branch"), sub
->name
);
1952 if (!skip_prefix(refname
, "refs/heads/", &refname
))
1953 die(_("Expecting a full ref name, got %s"), refname
);
1960 static int resolve_remote_submodule_branch(int argc
, const char **argv
,
1964 struct strbuf sb
= STRBUF_INIT
;
1966 die("submodule--helper remote-branch takes exactly one arguments, got %d", argc
);
1968 ret
= remote_submodule_branch(argv
[1]);
1970 die("submodule %s doesn't exist", argv
[1]);
1973 strbuf_release(&sb
);
1977 static int push_check(int argc
, const char **argv
, const char *prefix
)
1979 struct remote
*remote
;
1980 const char *superproject_head
;
1982 int detached_head
= 0;
1983 struct object_id head_oid
;
1986 die("submodule--helper push-check requires at least 2 arguments");
1989 * superproject's resolved head ref.
1990 * if HEAD then the superproject is in a detached head state, otherwise
1991 * it will be the resolved head ref.
1993 superproject_head
= argv
[1];
1996 /* Get the submodule's head ref and determine if it is detached */
1997 head
= resolve_refdup("HEAD", 0, &head_oid
, NULL
);
1999 die(_("Failed to resolve HEAD as a valid ref."));
2000 if (!strcmp(head
, "HEAD"))
2004 * The remote must be configured.
2005 * This is to avoid pushing to the exact same URL as the parent.
2007 remote
= pushremote_get(argv
[1]);
2008 if (!remote
|| remote
->origin
== REMOTE_UNCONFIGURED
)
2009 die("remote '%s' not configured", argv
[1]);
2011 /* Check the refspec */
2014 struct ref
*local_refs
= get_local_heads();
2015 struct refspec refspec
= REFSPEC_INIT_PUSH
;
2017 refspec_appendn(&refspec
, argv
+ 2, argc
- 2);
2019 for (i
= 0; i
< refspec
.nr
; i
++) {
2020 const struct refspec_item
*rs
= &refspec
.items
[i
];
2022 if (rs
->pattern
|| rs
->matching
)
2025 /* LHS must match a single ref */
2026 switch (count_refspec_match(rs
->src
, local_refs
, NULL
)) {
2031 * If LHS matches 'HEAD' then we need to ensure
2032 * that it matches the same named branch
2033 * checked out in the superproject.
2035 if (!strcmp(rs
->src
, "HEAD")) {
2036 if (!detached_head
&&
2037 !strcmp(head
, superproject_head
))
2039 die("HEAD does not match the named branch in the superproject");
2043 die("src refspec '%s' must name a ref",
2047 refspec_clear(&refspec
);
2054 static int ensure_core_worktree(int argc
, const char **argv
, const char *prefix
)
2056 const struct submodule
*sub
;
2059 struct repository subrepo
;
2062 BUG("submodule--helper connect-gitdir-workingtree <name> <path>");
2066 sub
= submodule_from_path(the_repository
, &null_oid
, path
);
2068 BUG("We could get the submodule handle before?");
2070 if (repo_submodule_init(&subrepo
, the_repository
, path
))
2071 die(_("could not get a repository handle for submodule '%s'"), path
);
2073 if (!repo_config_get_string(&subrepo
, "core.worktree", &cw
)) {
2074 char *cfg_file
, *abs_path
;
2075 const char *rel_path
;
2076 struct strbuf sb
= STRBUF_INIT
;
2078 cfg_file
= repo_git_path(&subrepo
, "config");
2080 abs_path
= absolute_pathdup(path
);
2081 rel_path
= relative_path(abs_path
, subrepo
.gitdir
, &sb
);
2083 git_config_set_in_file(cfg_file
, "core.worktree", rel_path
);
2087 strbuf_release(&sb
);
2093 static int absorb_git_dirs(int argc
, const char **argv
, const char *prefix
)
2096 struct pathspec pathspec
;
2097 struct module_list list
= MODULE_LIST_INIT
;
2098 unsigned flags
= ABSORB_GITDIR_RECURSE_SUBMODULES
;
2100 struct option embed_gitdir_options
[] = {
2101 OPT_STRING(0, "prefix", &prefix
,
2103 N_("path into the working tree")),
2104 OPT_BIT(0, "--recursive", &flags
, N_("recurse into submodules"),
2105 ABSORB_GITDIR_RECURSE_SUBMODULES
),
2109 const char *const git_submodule_helper_usage
[] = {
2110 N_("git submodule--helper embed-git-dir [<path>...]"),
2114 argc
= parse_options(argc
, argv
, prefix
, embed_gitdir_options
,
2115 git_submodule_helper_usage
, 0);
2117 if (module_list_compute(argc
, argv
, prefix
, &pathspec
, &list
) < 0)
2120 for (i
= 0; i
< list
.nr
; i
++)
2121 absorb_git_dir_into_superproject(prefix
,
2122 list
.entries
[i
]->name
, flags
);
2127 static int is_active(int argc
, const char **argv
, const char *prefix
)
2130 die("submodule--helper is-active takes exactly 1 argument");
2132 return !is_submodule_active(the_repository
, argv
[1]);
2136 * Exit non-zero if any of the submodule names given on the command line is
2137 * invalid. If no names are given, filter stdin to print only valid names
2138 * (which is primarily intended for testing).
2140 static int check_name(int argc
, const char **argv
, const char *prefix
)
2144 if (check_submodule_name(*argv
) < 0)
2148 struct strbuf buf
= STRBUF_INIT
;
2149 while (strbuf_getline(&buf
, stdin
) != EOF
) {
2150 if (!check_submodule_name(buf
.buf
))
2151 printf("%s\n", buf
.buf
);
2153 strbuf_release(&buf
);
2158 static int module_config(int argc
, const char **argv
, const char *prefix
)
2164 struct option module_config_options
[] = {
2165 OPT_CMDMODE(0, "check-writeable", &command
,
2166 N_("check if it is safe to write to the .gitmodules file"),
2170 const char *const git_submodule_helper_usage
[] = {
2171 N_("git submodule--helper config name [value]"),
2172 N_("git submodule--helper config --check-writeable"),
2176 argc
= parse_options(argc
, argv
, prefix
, module_config_options
,
2177 git_submodule_helper_usage
, PARSE_OPT_KEEP_ARGV0
);
2179 if (argc
== 1 && command
== CHECK_WRITEABLE
)
2180 return is_writing_gitmodules_ok() ? 0 : -1;
2182 /* Equivalent to ACTION_GET in builtin/config.c */
2184 return print_config_from_gitmodules(the_repository
, argv
[1]);
2186 /* Equivalent to ACTION_SET in builtin/config.c */
2188 if (!is_writing_gitmodules_ok())
2189 die(_("please make sure that the .gitmodules file is in the working tree"));
2191 return config_set_in_gitmodules_file_gently(argv
[1], argv
[2]);
2194 usage_with_options(git_submodule_helper_usage
, module_config_options
);
2197 #define SUPPORT_SUPER_PREFIX (1<<0)
2201 int (*fn
)(int, const char **, const char *);
2205 static struct cmd_struct commands
[] = {
2206 {"list", module_list
, 0},
2207 {"name", module_name
, 0},
2208 {"clone", module_clone
, 0},
2209 {"update-module-mode", module_update_module_mode
, 0},
2210 {"update-clone", update_clone
, 0},
2211 {"ensure-core-worktree", ensure_core_worktree
, 0},
2212 {"relative-path", resolve_relative_path
, 0},
2213 {"resolve-relative-url", resolve_relative_url
, 0},
2214 {"resolve-relative-url-test", resolve_relative_url_test
, 0},
2215 {"foreach", module_foreach
, SUPPORT_SUPER_PREFIX
},
2216 {"init", module_init
, SUPPORT_SUPER_PREFIX
},
2217 {"status", module_status
, SUPPORT_SUPER_PREFIX
},
2218 {"print-default-remote", print_default_remote
, 0},
2219 {"sync", module_sync
, SUPPORT_SUPER_PREFIX
},
2220 {"deinit", module_deinit
, 0},
2221 {"remote-branch", resolve_remote_submodule_branch
, 0},
2222 {"push-check", push_check
, 0},
2223 {"absorb-git-dirs", absorb_git_dirs
, SUPPORT_SUPER_PREFIX
},
2224 {"is-active", is_active
, 0},
2225 {"check-name", check_name
, 0},
2226 {"config", module_config
, 0},
2229 int cmd_submodule__helper(int argc
, const char **argv
, const char *prefix
)
2232 if (argc
< 2 || !strcmp(argv
[1], "-h"))
2233 usage("git submodule--helper <command>");
2235 for (i
= 0; i
< ARRAY_SIZE(commands
); i
++) {
2236 if (!strcmp(argv
[1], commands
[i
].cmd
)) {
2237 if (get_super_prefix() &&
2238 !(commands
[i
].option
& SUPPORT_SUPER_PREFIX
))
2239 die(_("%s doesn't support --super-prefix"),
2241 return commands
[i
].fn(argc
- 1, argv
+ 1, prefix
);
2245 die(_("'%s' is not a valid submodule--helper "
2246 "subcommand"), argv
[1]);