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"
22 #define OPT_QUIET (1 << 0)
23 #define OPT_CACHED (1 << 1)
24 #define OPT_RECURSIVE (1 << 2)
25 #define OPT_FORCE (1 << 3)
27 typedef void (*each_submodule_fn
)(const struct cache_entry
*list_item
,
30 static char *get_default_remote(void)
32 char *dest
= NULL
, *ret
;
33 struct strbuf sb
= STRBUF_INIT
;
34 const char *refname
= resolve_ref_unsafe("HEAD", 0, NULL
, NULL
);
37 die(_("No such ref: %s"), "HEAD");
40 if (!strcmp(refname
, "HEAD"))
41 return xstrdup("origin");
43 if (!skip_prefix(refname
, "refs/heads/", &refname
))
44 die(_("Expecting a full ref name, got %s"), refname
);
46 strbuf_addf(&sb
, "branch.%s.remote", refname
);
47 if (git_config_get_string(sb
.buf
, &dest
))
48 ret
= xstrdup("origin");
56 static int print_default_remote(int argc
, const char **argv
, const char *prefix
)
61 die(_("submodule--helper print-default-remote takes no arguments"));
63 remote
= get_default_remote();
65 printf("%s\n", remote
);
71 static int starts_with_dot_slash(const char *str
)
73 return str
[0] == '.' && is_dir_sep(str
[1]);
76 static int starts_with_dot_dot_slash(const char *str
)
78 return str
[0] == '.' && str
[1] == '.' && is_dir_sep(str
[2]);
82 * Returns 1 if it was the last chop before ':'.
84 static int chop_last_dir(char **remoteurl
, int is_relative
)
86 char *rfind
= find_last_dir_sep(*remoteurl
);
92 rfind
= strrchr(*remoteurl
, ':');
98 if (is_relative
|| !strcmp(".", *remoteurl
))
99 die(_("cannot strip one component off url '%s'"),
103 *remoteurl
= xstrdup(".");
108 * The `url` argument is the URL that navigates to the submodule origin
109 * repo. When relative, this URL is relative to the superproject origin
110 * URL repo. The `up_path` argument, if specified, is the relative
111 * path that navigates from the submodule working tree to the superproject
112 * working tree. Returns the origin URL of the submodule.
114 * Return either an absolute URL or filesystem path (if the superproject
115 * origin URL is an absolute URL or filesystem path, respectively) or a
116 * relative file system path (if the superproject origin URL is a relative
119 * When the output is a relative file system path, the path is either
120 * relative to the submodule working tree, if up_path is specified, or to
121 * the superproject working tree otherwise.
123 * NEEDSWORK: This works incorrectly on the domain and protocol part.
124 * remote_url url outcome expectation
125 * http://a.com/b ../c http://a.com/c as is
126 * http://a.com/b/ ../c http://a.com/c same as previous line, but
127 * ignore trailing slash in url
128 * http://a.com/b ../../c http://c error out
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 .:c error out
132 * NEEDSWORK: Given how chop_last_dir() works, this function is broken
133 * when a local part has a colon in its path component, too.
135 static char *relative_url(const char *remote_url
,
142 char *remoteurl
= xstrdup(remote_url
);
143 struct strbuf sb
= STRBUF_INIT
;
144 size_t len
= strlen(remoteurl
);
146 if (is_dir_sep(remoteurl
[len
-1]))
147 remoteurl
[len
-1] = '\0';
149 if (!url_is_local_not_ssh(remoteurl
) || is_absolute_path(remoteurl
))
154 * Prepend a './' to ensure all relative
155 * remoteurls start with './' or '../'
157 if (!starts_with_dot_slash(remoteurl
) &&
158 !starts_with_dot_dot_slash(remoteurl
)) {
160 strbuf_addf(&sb
, "./%s", remoteurl
);
162 remoteurl
= strbuf_detach(&sb
, NULL
);
166 * When the url starts with '../', remove that and the
167 * last directory in remoteurl.
170 if (starts_with_dot_dot_slash(url
)) {
172 colonsep
|= chop_last_dir(&remoteurl
, is_relative
);
173 } else if (starts_with_dot_slash(url
))
179 strbuf_addf(&sb
, "%s%s%s", remoteurl
, colonsep
? ":" : "/", url
);
180 if (ends_with(url
, "/"))
181 strbuf_setlen(&sb
, sb
.len
- 1);
184 if (starts_with_dot_slash(sb
.buf
))
185 out
= xstrdup(sb
.buf
+ 2);
187 out
= xstrdup(sb
.buf
);
190 if (!up_path
|| !is_relative
)
193 strbuf_addf(&sb
, "%s%s", up_path
, out
);
195 return strbuf_detach(&sb
, NULL
);
198 static int resolve_relative_url(int argc
, const char **argv
, const char *prefix
)
200 char *remoteurl
= NULL
;
201 char *remote
= get_default_remote();
202 const char *up_path
= NULL
;
205 struct strbuf sb
= STRBUF_INIT
;
207 if (argc
!= 2 && argc
!= 3)
208 die("resolve-relative-url only accepts one or two arguments");
211 strbuf_addf(&sb
, "remote.%s.url", remote
);
214 if (git_config_get_string(sb
.buf
, &remoteurl
))
215 /* the repository is its own authoritative upstream */
216 remoteurl
= xgetcwd();
221 res
= relative_url(remoteurl
, url
, up_path
);
228 static int resolve_relative_url_test(int argc
, const char **argv
, const char *prefix
)
230 char *remoteurl
, *res
;
231 const char *up_path
, *url
;
234 die("resolve-relative-url-test only accepts three arguments: <up_path> <remoteurl> <url>");
237 remoteurl
= xstrdup(argv
[2]);
240 if (!strcmp(up_path
, "(null)"))
243 res
= relative_url(remoteurl
, url
, up_path
);
250 /* the result should be freed by the caller. */
251 static char *get_submodule_displaypath(const char *path
, const char *prefix
)
253 const char *super_prefix
= get_super_prefix();
255 if (prefix
&& super_prefix
) {
256 BUG("cannot have prefix '%s' and superprefix '%s'",
257 prefix
, super_prefix
);
259 struct strbuf sb
= STRBUF_INIT
;
260 char *displaypath
= xstrdup(relative_path(path
, prefix
, &sb
));
263 } else if (super_prefix
) {
264 return xstrfmt("%s%s", super_prefix
, path
);
266 return xstrdup(path
);
270 static char *compute_rev_name(const char *sub_path
, const char* object_id
)
272 struct strbuf sb
= STRBUF_INIT
;
275 static const char *describe_bare
[] = { NULL
};
277 static const char *describe_tags
[] = { "--tags", NULL
};
279 static const char *describe_contains
[] = { "--contains", NULL
};
281 static const char *describe_all_always
[] = { "--all", "--always", NULL
};
283 static const char **describe_argv
[] = { describe_bare
, describe_tags
,
285 describe_all_always
, NULL
};
287 for (d
= describe_argv
; *d
; d
++) {
288 struct child_process cp
= CHILD_PROCESS_INIT
;
289 prepare_submodule_repo_env(&cp
.env_array
);
294 argv_array_push(&cp
.args
, "describe");
295 argv_array_pushv(&cp
.args
, *d
);
296 argv_array_push(&cp
.args
, object_id
);
298 if (!capture_command(&cp
, &sb
, 0)) {
299 strbuf_strip_suffix(&sb
, "\n");
300 return strbuf_detach(&sb
, NULL
);
309 const struct cache_entry
**entries
;
312 #define MODULE_LIST_INIT { NULL, 0, 0 }
314 static int module_list_compute(int argc
, const char **argv
,
316 struct pathspec
*pathspec
,
317 struct module_list
*list
)
320 char *ps_matched
= NULL
;
321 parse_pathspec(pathspec
, 0,
322 PATHSPEC_PREFER_FULL
,
326 ps_matched
= xcalloc(pathspec
->nr
, 1);
328 if (read_cache() < 0)
329 die(_("index file corrupt"));
331 for (i
= 0; i
< active_nr
; i
++) {
332 const struct cache_entry
*ce
= active_cache
[i
];
334 if (!match_pathspec(&the_index
, pathspec
, ce
->name
, ce_namelen(ce
),
336 !S_ISGITLINK(ce
->ce_mode
))
339 ALLOC_GROW(list
->entries
, list
->nr
+ 1, list
->alloc
);
340 list
->entries
[list
->nr
++] = ce
;
341 while (i
+ 1 < active_nr
&&
342 !strcmp(ce
->name
, active_cache
[i
+ 1]->name
))
344 * Skip entries with the same name in different stages
345 * to make sure an entry is returned only once.
350 if (ps_matched
&& report_path_error(ps_matched
, pathspec
, prefix
))
358 static void module_list_active(struct module_list
*list
)
361 struct module_list active_modules
= MODULE_LIST_INIT
;
363 for (i
= 0; i
< list
->nr
; i
++) {
364 const struct cache_entry
*ce
= list
->entries
[i
];
366 if (!is_submodule_active(the_repository
, ce
->name
))
369 ALLOC_GROW(active_modules
.entries
,
370 active_modules
.nr
+ 1,
371 active_modules
.alloc
);
372 active_modules
.entries
[active_modules
.nr
++] = ce
;
376 *list
= active_modules
;
379 static char *get_up_path(const char *path
)
382 struct strbuf sb
= STRBUF_INIT
;
384 for (i
= count_slashes(path
); i
; i
--)
385 strbuf_addstr(&sb
, "../");
388 * Check if 'path' ends with slash or not
389 * for having the same output for dir/sub_dir
392 if (!is_dir_sep(path
[strlen(path
) - 1]))
393 strbuf_addstr(&sb
, "../");
395 return strbuf_detach(&sb
, NULL
);
398 static int module_list(int argc
, const char **argv
, const char *prefix
)
401 struct pathspec pathspec
;
402 struct module_list list
= MODULE_LIST_INIT
;
404 struct option module_list_options
[] = {
405 OPT_STRING(0, "prefix", &prefix
,
407 N_("alternative anchor for relative paths")),
411 const char *const git_submodule_helper_usage
[] = {
412 N_("git submodule--helper list [--prefix=<path>] [<path>...]"),
416 argc
= parse_options(argc
, argv
, prefix
, module_list_options
,
417 git_submodule_helper_usage
, 0);
419 if (module_list_compute(argc
, argv
, prefix
, &pathspec
, &list
) < 0)
422 for (i
= 0; i
< list
.nr
; i
++) {
423 const struct cache_entry
*ce
= list
.entries
[i
];
426 printf("%06o %s U\t", ce
->ce_mode
, sha1_to_hex(null_sha1
));
428 printf("%06o %s %d\t", ce
->ce_mode
,
429 oid_to_hex(&ce
->oid
), ce_stage(ce
));
431 fprintf(stdout
, "%s\n", ce
->name
);
436 static void for_each_listed_submodule(const struct module_list
*list
,
437 each_submodule_fn fn
, void *cb_data
)
440 for (i
= 0; i
< list
->nr
; i
++)
441 fn(list
->entries
[i
], cb_data
);
451 #define CB_FOREACH_INIT { 0 }
453 static void runcommand_in_submodule_cb(const struct cache_entry
*list_item
,
456 struct cb_foreach
*info
= cb_data
;
457 const char *path
= list_item
->name
;
458 const struct object_id
*ce_oid
= &list_item
->oid
;
460 const struct submodule
*sub
;
461 struct child_process cp
= CHILD_PROCESS_INIT
;
464 displaypath
= get_submodule_displaypath(path
, info
->prefix
);
466 sub
= submodule_from_path(the_repository
, &null_oid
, path
);
469 die(_("No url found for submodule path '%s' in .gitmodules"),
472 if (!is_submodule_populated_gently(path
, NULL
))
475 prepare_submodule_repo_env(&cp
.env_array
);
478 * For the purpose of executing <command> in the submodule,
479 * separate shell is used for the purpose of running the
486 * NEEDSWORK: the command currently has access to the variables $name,
487 * $sm_path, $displaypath, $sha1 and $toplevel only when the command
488 * contains a single argument. This is done for maintaining a faithful
489 * translation from shell script.
491 if (info
->argc
== 1) {
492 char *toplevel
= xgetcwd();
493 struct strbuf sb
= STRBUF_INIT
;
495 argv_array_pushf(&cp
.env_array
, "name=%s", sub
->name
);
496 argv_array_pushf(&cp
.env_array
, "sm_path=%s", path
);
497 argv_array_pushf(&cp
.env_array
, "displaypath=%s", displaypath
);
498 argv_array_pushf(&cp
.env_array
, "sha1=%s",
500 argv_array_pushf(&cp
.env_array
, "toplevel=%s", toplevel
);
503 * Since the path variable was accessible from the script
504 * before porting, it is also made available after porting.
505 * The environment variable "PATH" has a very special purpose
506 * on windows. And since environment variables are
507 * case-insensitive in windows, it interferes with the
508 * existing PATH variable. Hence, to avoid that, we expose
509 * path via the args argv_array and not via env_array.
511 sq_quote_buf(&sb
, path
);
512 argv_array_pushf(&cp
.args
, "path=%s; %s",
513 sb
.buf
, info
->argv
[0]);
517 argv_array_pushv(&cp
.args
, info
->argv
);
521 printf(_("Entering '%s'\n"), displaypath
);
523 if (info
->argv
[0] && run_command(&cp
))
524 die(_("run_command returned non-zero status for %s\n."),
527 if (info
->recursive
) {
528 struct child_process cpr
= CHILD_PROCESS_INIT
;
532 prepare_submodule_repo_env(&cpr
.env_array
);
534 argv_array_pushl(&cpr
.args
, "--super-prefix", NULL
);
535 argv_array_pushf(&cpr
.args
, "%s/", displaypath
);
536 argv_array_pushl(&cpr
.args
, "submodule--helper", "foreach", "--recursive",
540 argv_array_push(&cpr
.args
, "--quiet");
542 argv_array_pushv(&cpr
.args
, info
->argv
);
544 if (run_command(&cpr
))
545 die(_("run_command returned non-zero status while "
546 "recursing in the nested submodules of %s\n."),
554 static int module_foreach(int argc
, const char **argv
, const char *prefix
)
556 struct cb_foreach info
= CB_FOREACH_INIT
;
557 struct pathspec pathspec
;
558 struct module_list list
= MODULE_LIST_INIT
;
560 struct option module_foreach_options
[] = {
561 OPT__QUIET(&info
.quiet
, N_("Suppress output of entering each submodule command")),
562 OPT_BOOL(0, "recursive", &info
.recursive
,
563 N_("Recurse into nested submodules")),
567 const char *const git_submodule_helper_usage
[] = {
568 N_("git submodule--helper foreach [--quiet] [--recursive] <command>"),
572 argc
= parse_options(argc
, argv
, prefix
, module_foreach_options
,
573 git_submodule_helper_usage
, PARSE_OPT_KEEP_UNKNOWN
);
575 if (module_list_compute(0, NULL
, prefix
, &pathspec
, &list
) < 0)
580 info
.prefix
= prefix
;
582 for_each_listed_submodule(&list
, runcommand_in_submodule_cb
, &info
);
587 static char *compute_submodule_clone_url(const char *rel_url
)
589 char *remoteurl
, *relurl
;
590 char *remote
= get_default_remote();
591 struct strbuf remotesb
= STRBUF_INIT
;
593 strbuf_addf(&remotesb
, "remote.%s.url", remote
);
594 if (git_config_get_string(remotesb
.buf
, &remoteurl
)) {
595 warning(_("could not look up configuration '%s'. Assuming this repository is its own authoritative upstream."), remotesb
.buf
);
596 remoteurl
= xgetcwd();
598 relurl
= relative_url(remoteurl
, rel_url
, NULL
);
602 strbuf_release(&remotesb
);
612 #define INIT_CB_INIT { NULL, 0 }
614 static void init_submodule(const char *path
, const char *prefix
,
617 const struct submodule
*sub
;
618 struct strbuf sb
= STRBUF_INIT
;
619 char *upd
= NULL
, *url
= NULL
, *displaypath
;
621 displaypath
= get_submodule_displaypath(path
, prefix
);
623 sub
= submodule_from_path(the_repository
, &null_oid
, path
);
626 die(_("No url found for submodule path '%s' in .gitmodules"),
630 * NEEDSWORK: In a multi-working-tree world, this needs to be
631 * set in the per-worktree config.
633 * Set active flag for the submodule being initialized
635 if (!is_submodule_active(the_repository
, path
)) {
636 strbuf_addf(&sb
, "submodule.%s.active", sub
->name
);
637 git_config_set_gently(sb
.buf
, "true");
642 * Copy url setting when it is not set yet.
643 * To look up the url in .git/config, we must not fall back to
644 * .gitmodules, so look it up directly.
646 strbuf_addf(&sb
, "submodule.%s.url", sub
->name
);
647 if (git_config_get_string(sb
.buf
, &url
)) {
649 die(_("No url found for submodule path '%s' in .gitmodules"),
652 url
= xstrdup(sub
->url
);
654 /* Possibly a url relative to parent */
655 if (starts_with_dot_dot_slash(url
) ||
656 starts_with_dot_slash(url
)) {
658 url
= compute_submodule_clone_url(oldurl
);
662 if (git_config_set_gently(sb
.buf
, url
))
663 die(_("Failed to register url for submodule path '%s'"),
665 if (!(flags
& OPT_QUIET
))
667 _("Submodule '%s' (%s) registered for path '%s'\n"),
668 sub
->name
, url
, displaypath
);
672 /* Copy "update" setting when it is not set yet */
673 strbuf_addf(&sb
, "submodule.%s.update", sub
->name
);
674 if (git_config_get_string(sb
.buf
, &upd
) &&
675 sub
->update_strategy
.type
!= SM_UPDATE_UNSPECIFIED
) {
676 if (sub
->update_strategy
.type
== SM_UPDATE_COMMAND
) {
677 fprintf(stderr
, _("warning: command update mode suggested for submodule '%s'\n"),
679 upd
= xstrdup("none");
681 upd
= xstrdup(submodule_strategy_to_string(&sub
->update_strategy
));
683 if (git_config_set_gently(sb
.buf
, upd
))
684 die(_("Failed to register update mode for submodule path '%s'"), displaypath
);
692 static void init_submodule_cb(const struct cache_entry
*list_item
, void *cb_data
)
694 struct init_cb
*info
= cb_data
;
695 init_submodule(list_item
->name
, info
->prefix
, info
->flags
);
698 static int module_init(int argc
, const char **argv
, const char *prefix
)
700 struct init_cb info
= INIT_CB_INIT
;
701 struct pathspec pathspec
;
702 struct module_list list
= MODULE_LIST_INIT
;
705 struct option module_init_options
[] = {
706 OPT__QUIET(&quiet
, N_("Suppress output for initializing a submodule")),
710 const char *const git_submodule_helper_usage
[] = {
711 N_("git submodule--helper init [<path>]"),
715 argc
= parse_options(argc
, argv
, prefix
, module_init_options
,
716 git_submodule_helper_usage
, 0);
718 if (module_list_compute(argc
, argv
, prefix
, &pathspec
, &list
) < 0)
722 * If there are no path args and submodule.active is set then,
723 * by default, only initialize 'active' modules.
725 if (!argc
&& git_config_get_value_multi("submodule.active"))
726 module_list_active(&list
);
728 info
.prefix
= prefix
;
730 info
.flags
|= OPT_QUIET
;
732 for_each_listed_submodule(&list
, init_submodule_cb
, &info
);
742 #define STATUS_CB_INIT { NULL, 0 }
744 static void print_status(unsigned int flags
, char state
, const char *path
,
745 const struct object_id
*oid
, const char *displaypath
)
747 if (flags
& OPT_QUIET
)
750 printf("%c%s %s", state
, oid_to_hex(oid
), displaypath
);
752 if (state
== ' ' || state
== '+') {
753 const char *name
= compute_rev_name(path
, oid_to_hex(oid
));
756 printf(" (%s)", name
);
762 static int handle_submodule_head_ref(const char *refname
,
763 const struct object_id
*oid
, int flags
,
766 struct object_id
*output
= cb_data
;
773 static void status_submodule(const char *path
, const struct object_id
*ce_oid
,
774 unsigned int ce_flags
, const char *prefix
,
778 struct argv_array diff_files_args
= ARGV_ARRAY_INIT
;
780 int diff_files_result
;
782 if (!submodule_from_path(the_repository
, &null_oid
, path
))
783 die(_("no submodule mapping found in .gitmodules for path '%s'"),
786 displaypath
= get_submodule_displaypath(path
, prefix
);
788 if ((CE_STAGEMASK
& ce_flags
) >> CE_STAGESHIFT
) {
789 print_status(flags
, 'U', path
, &null_oid
, displaypath
);
793 if (!is_submodule_active(the_repository
, path
)) {
794 print_status(flags
, '-', path
, ce_oid
, displaypath
);
798 argv_array_pushl(&diff_files_args
, "diff-files",
799 "--ignore-submodules=dirty", "--quiet", "--",
802 git_config(git_diff_basic_config
, NULL
);
803 repo_init_revisions(the_repository
, &rev
, prefix
);
805 diff_files_args
.argc
= setup_revisions(diff_files_args
.argc
,
806 diff_files_args
.argv
,
808 diff_files_result
= run_diff_files(&rev
, 0);
810 if (!diff_result_code(&rev
.diffopt
, diff_files_result
)) {
811 print_status(flags
, ' ', path
, ce_oid
,
813 } else if (!(flags
& OPT_CACHED
)) {
814 struct object_id oid
;
815 struct ref_store
*refs
= get_submodule_ref_store(path
);
818 print_status(flags
, '-', path
, ce_oid
, displaypath
);
821 if (refs_head_ref(refs
, handle_submodule_head_ref
, &oid
))
822 die(_("could not resolve HEAD ref inside the "
823 "submodule '%s'"), path
);
825 print_status(flags
, '+', path
, &oid
, displaypath
);
827 print_status(flags
, '+', path
, ce_oid
, displaypath
);
830 if (flags
& OPT_RECURSIVE
) {
831 struct child_process cpr
= CHILD_PROCESS_INIT
;
835 prepare_submodule_repo_env(&cpr
.env_array
);
837 argv_array_push(&cpr
.args
, "--super-prefix");
838 argv_array_pushf(&cpr
.args
, "%s/", displaypath
);
839 argv_array_pushl(&cpr
.args
, "submodule--helper", "status",
840 "--recursive", NULL
);
842 if (flags
& OPT_CACHED
)
843 argv_array_push(&cpr
.args
, "--cached");
845 if (flags
& OPT_QUIET
)
846 argv_array_push(&cpr
.args
, "--quiet");
848 if (run_command(&cpr
))
849 die(_("failed to recurse into submodule '%s'"), path
);
853 argv_array_clear(&diff_files_args
);
857 static void status_submodule_cb(const struct cache_entry
*list_item
,
860 struct status_cb
*info
= cb_data
;
861 status_submodule(list_item
->name
, &list_item
->oid
, list_item
->ce_flags
,
862 info
->prefix
, info
->flags
);
865 static int module_status(int argc
, const char **argv
, const char *prefix
)
867 struct status_cb info
= STATUS_CB_INIT
;
868 struct pathspec pathspec
;
869 struct module_list list
= MODULE_LIST_INIT
;
872 struct option module_status_options
[] = {
873 OPT__QUIET(&quiet
, N_("Suppress submodule status output")),
874 OPT_BIT(0, "cached", &info
.flags
, N_("Use commit stored in the index instead of the one stored in the submodule HEAD"), OPT_CACHED
),
875 OPT_BIT(0, "recursive", &info
.flags
, N_("recurse into nested submodules"), OPT_RECURSIVE
),
879 const char *const git_submodule_helper_usage
[] = {
880 N_("git submodule status [--quiet] [--cached] [--recursive] [<path>...]"),
884 argc
= parse_options(argc
, argv
, prefix
, module_status_options
,
885 git_submodule_helper_usage
, 0);
887 if (module_list_compute(argc
, argv
, prefix
, &pathspec
, &list
) < 0)
890 info
.prefix
= prefix
;
892 info
.flags
|= OPT_QUIET
;
894 for_each_listed_submodule(&list
, status_submodule_cb
, &info
);
899 static int module_name(int argc
, const char **argv
, const char *prefix
)
901 const struct submodule
*sub
;
904 usage(_("git submodule--helper name <path>"));
906 sub
= submodule_from_path(the_repository
, &null_oid
, argv
[1]);
909 die(_("no submodule mapping found in .gitmodules for path '%s'"),
912 printf("%s\n", sub
->name
);
922 #define SYNC_CB_INIT { NULL, 0 }
924 static void sync_submodule(const char *path
, const char *prefix
,
927 const struct submodule
*sub
;
928 char *remote_key
= NULL
;
929 char *sub_origin_url
, *super_config_url
, *displaypath
;
930 struct strbuf sb
= STRBUF_INIT
;
931 struct child_process cp
= CHILD_PROCESS_INIT
;
932 char *sub_config_path
= NULL
;
934 if (!is_submodule_active(the_repository
, path
))
937 sub
= submodule_from_path(the_repository
, &null_oid
, path
);
939 if (sub
&& sub
->url
) {
940 if (starts_with_dot_dot_slash(sub
->url
) ||
941 starts_with_dot_slash(sub
->url
)) {
942 char *remote_url
, *up_path
;
943 char *remote
= get_default_remote();
944 strbuf_addf(&sb
, "remote.%s.url", remote
);
946 if (git_config_get_string(sb
.buf
, &remote_url
))
947 remote_url
= xgetcwd();
949 up_path
= get_up_path(path
);
950 sub_origin_url
= relative_url(remote_url
, sub
->url
, up_path
);
951 super_config_url
= relative_url(remote_url
, sub
->url
, NULL
);
957 sub_origin_url
= xstrdup(sub
->url
);
958 super_config_url
= xstrdup(sub
->url
);
961 sub_origin_url
= xstrdup("");
962 super_config_url
= xstrdup("");
965 displaypath
= get_submodule_displaypath(path
, prefix
);
967 if (!(flags
& OPT_QUIET
))
968 printf(_("Synchronizing submodule url for '%s'\n"),
972 strbuf_addf(&sb
, "submodule.%s.url", sub
->name
);
973 if (git_config_set_gently(sb
.buf
, super_config_url
))
974 die(_("failed to register url for submodule path '%s'"),
977 if (!is_submodule_populated_gently(path
, NULL
))
980 prepare_submodule_repo_env(&cp
.env_array
);
983 argv_array_pushl(&cp
.args
, "submodule--helper",
984 "print-default-remote", NULL
);
987 if (capture_command(&cp
, &sb
, 0))
988 die(_("failed to get the default remote for submodule '%s'"),
991 strbuf_strip_suffix(&sb
, "\n");
992 remote_key
= xstrfmt("remote.%s.url", sb
.buf
);
995 submodule_to_gitdir(&sb
, path
);
996 strbuf_addstr(&sb
, "/config");
998 if (git_config_set_in_file_gently(sb
.buf
, remote_key
, sub_origin_url
))
999 die(_("failed to update remote for submodule '%s'"),
1002 if (flags
& OPT_RECURSIVE
) {
1003 struct child_process cpr
= CHILD_PROCESS_INIT
;
1007 prepare_submodule_repo_env(&cpr
.env_array
);
1009 argv_array_push(&cpr
.args
, "--super-prefix");
1010 argv_array_pushf(&cpr
.args
, "%s/", displaypath
);
1011 argv_array_pushl(&cpr
.args
, "submodule--helper", "sync",
1012 "--recursive", NULL
);
1014 if (flags
& OPT_QUIET
)
1015 argv_array_push(&cpr
.args
, "--quiet");
1017 if (run_command(&cpr
))
1018 die(_("failed to recurse into submodule '%s'"),
1023 free(super_config_url
);
1024 free(sub_origin_url
);
1025 strbuf_release(&sb
);
1028 free(sub_config_path
);
1031 static void sync_submodule_cb(const struct cache_entry
*list_item
, void *cb_data
)
1033 struct sync_cb
*info
= cb_data
;
1034 sync_submodule(list_item
->name
, info
->prefix
, info
->flags
);
1037 static int module_sync(int argc
, const char **argv
, const char *prefix
)
1039 struct sync_cb info
= SYNC_CB_INIT
;
1040 struct pathspec pathspec
;
1041 struct module_list list
= MODULE_LIST_INIT
;
1045 struct option module_sync_options
[] = {
1046 OPT__QUIET(&quiet
, N_("Suppress output of synchronizing submodule url")),
1047 OPT_BOOL(0, "recursive", &recursive
,
1048 N_("Recurse into nested submodules")),
1052 const char *const git_submodule_helper_usage
[] = {
1053 N_("git submodule--helper sync [--quiet] [--recursive] [<path>]"),
1057 argc
= parse_options(argc
, argv
, prefix
, module_sync_options
,
1058 git_submodule_helper_usage
, 0);
1060 if (module_list_compute(argc
, argv
, prefix
, &pathspec
, &list
) < 0)
1063 info
.prefix
= prefix
;
1065 info
.flags
|= OPT_QUIET
;
1067 info
.flags
|= OPT_RECURSIVE
;
1069 for_each_listed_submodule(&list
, sync_submodule_cb
, &info
);
1078 #define DEINIT_CB_INIT { NULL, 0 }
1080 static void deinit_submodule(const char *path
, const char *prefix
,
1083 const struct submodule
*sub
;
1084 char *displaypath
= NULL
;
1085 struct child_process cp_config
= CHILD_PROCESS_INIT
;
1086 struct strbuf sb_config
= STRBUF_INIT
;
1087 char *sub_git_dir
= xstrfmt("%s/.git", path
);
1089 sub
= submodule_from_path(the_repository
, &null_oid
, path
);
1091 if (!sub
|| !sub
->name
)
1094 displaypath
= get_submodule_displaypath(path
, prefix
);
1096 /* remove the submodule work tree (unless the user already did it) */
1097 if (is_directory(path
)) {
1098 struct strbuf sb_rm
= STRBUF_INIT
;
1102 * protect submodules containing a .git directory
1103 * NEEDSWORK: instead of dying, automatically call
1104 * absorbgitdirs and (possibly) warn.
1106 if (is_directory(sub_git_dir
))
1107 die(_("Submodule work tree '%s' contains a .git "
1108 "directory (use 'rm -rf' if you really want "
1109 "to remove it including all of its history)"),
1112 if (!(flags
& OPT_FORCE
)) {
1113 struct child_process cp_rm
= CHILD_PROCESS_INIT
;
1115 argv_array_pushl(&cp_rm
.args
, "rm", "-qn",
1118 if (run_command(&cp_rm
))
1119 die(_("Submodule work tree '%s' contains local "
1120 "modifications; use '-f' to discard them"),
1124 strbuf_addstr(&sb_rm
, path
);
1126 if (!remove_dir_recursively(&sb_rm
, 0))
1127 format
= _("Cleared directory '%s'\n");
1129 format
= _("Could not remove submodule work tree '%s'\n");
1131 if (!(flags
& OPT_QUIET
))
1132 printf(format
, displaypath
);
1134 strbuf_release(&sb_rm
);
1137 if (mkdir(path
, 0777))
1138 printf(_("could not create empty submodule directory %s"),
1141 cp_config
.git_cmd
= 1;
1142 argv_array_pushl(&cp_config
.args
, "config", "--get-regexp", NULL
);
1143 argv_array_pushf(&cp_config
.args
, "submodule.%s\\.", sub
->name
);
1145 /* remove the .git/config entries (unless the user already did it) */
1146 if (!capture_command(&cp_config
, &sb_config
, 0) && sb_config
.len
) {
1147 char *sub_key
= xstrfmt("submodule.%s", sub
->name
);
1149 * remove the whole section so we have a clean state when
1150 * the user later decides to init this submodule again
1152 git_config_rename_section_in_file(NULL
, sub_key
, NULL
);
1153 if (!(flags
& OPT_QUIET
))
1154 printf(_("Submodule '%s' (%s) unregistered for path '%s'\n"),
1155 sub
->name
, sub
->url
, displaypath
);
1162 strbuf_release(&sb_config
);
1165 static void deinit_submodule_cb(const struct cache_entry
*list_item
,
1168 struct deinit_cb
*info
= cb_data
;
1169 deinit_submodule(list_item
->name
, info
->prefix
, info
->flags
);
1172 static int module_deinit(int argc
, const char **argv
, const char *prefix
)
1174 struct deinit_cb info
= DEINIT_CB_INIT
;
1175 struct pathspec pathspec
;
1176 struct module_list list
= MODULE_LIST_INIT
;
1181 struct option module_deinit_options
[] = {
1182 OPT__QUIET(&quiet
, N_("Suppress submodule status output")),
1183 OPT__FORCE(&force
, N_("Remove submodule working trees even if they contain local changes"), 0),
1184 OPT_BOOL(0, "all", &all
, N_("Unregister all submodules")),
1188 const char *const git_submodule_helper_usage
[] = {
1189 N_("git submodule deinit [--quiet] [-f | --force] [--all | [--] [<path>...]]"),
1193 argc
= parse_options(argc
, argv
, prefix
, module_deinit_options
,
1194 git_submodule_helper_usage
, 0);
1197 error("pathspec and --all are incompatible");
1198 usage_with_options(git_submodule_helper_usage
,
1199 module_deinit_options
);
1203 die(_("Use '--all' if you really want to deinitialize all submodules"));
1205 if (module_list_compute(argc
, argv
, prefix
, &pathspec
, &list
) < 0)
1208 info
.prefix
= prefix
;
1210 info
.flags
|= OPT_QUIET
;
1212 info
.flags
|= OPT_FORCE
;
1214 for_each_listed_submodule(&list
, deinit_submodule_cb
, &info
);
1219 static int clone_submodule(const char *path
, const char *gitdir
, const char *url
,
1220 const char *depth
, struct string_list
*reference
, int dissociate
,
1221 int quiet
, int progress
)
1223 struct child_process cp
= CHILD_PROCESS_INIT
;
1225 argv_array_push(&cp
.args
, "clone");
1226 argv_array_push(&cp
.args
, "--no-checkout");
1228 argv_array_push(&cp
.args
, "--quiet");
1230 argv_array_push(&cp
.args
, "--progress");
1231 if (depth
&& *depth
)
1232 argv_array_pushl(&cp
.args
, "--depth", depth
, NULL
);
1233 if (reference
->nr
) {
1234 struct string_list_item
*item
;
1235 for_each_string_list_item(item
, reference
)
1236 argv_array_pushl(&cp
.args
, "--reference",
1237 item
->string
, NULL
);
1240 argv_array_push(&cp
.args
, "--dissociate");
1241 if (gitdir
&& *gitdir
)
1242 argv_array_pushl(&cp
.args
, "--separate-git-dir", gitdir
, NULL
);
1244 argv_array_push(&cp
.args
, "--");
1245 argv_array_push(&cp
.args
, url
);
1246 argv_array_push(&cp
.args
, path
);
1249 prepare_submodule_repo_env(&cp
.env_array
);
1252 return run_command(&cp
);
1255 struct submodule_alternate_setup
{
1256 const char *submodule_name
;
1257 enum SUBMODULE_ALTERNATE_ERROR_MODE
{
1258 SUBMODULE_ALTERNATE_ERROR_DIE
,
1259 SUBMODULE_ALTERNATE_ERROR_INFO
,
1260 SUBMODULE_ALTERNATE_ERROR_IGNORE
1262 struct string_list
*reference
;
1264 #define SUBMODULE_ALTERNATE_SETUP_INIT { NULL, \
1265 SUBMODULE_ALTERNATE_ERROR_IGNORE, NULL }
1267 static int add_possible_reference_from_superproject(
1268 struct object_directory
*odb
, void *sas_cb
)
1270 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 (strip_suffix(odb
->path
, "/objects", &len
)) {
1279 struct strbuf sb
= STRBUF_INIT
;
1280 struct strbuf err
= STRBUF_INIT
;
1281 strbuf_add(&sb
, odb
->path
, len
);
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
;
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")),
1388 const char *const git_submodule_helper_usage
[] = {
1389 N_("git submodule--helper clone [--prefix=<path>] [--quiet] "
1390 "[--reference <repository>] [--name <name>] [--depth <depth>] "
1391 "--url <url> --path <path>"),
1395 argc
= parse_options(argc
, argv
, prefix
, module_clone_options
,
1396 git_submodule_helper_usage
, 0);
1398 if (argc
|| !url
|| !path
|| !*path
)
1399 usage_with_options(git_submodule_helper_usage
,
1400 module_clone_options
);
1402 strbuf_addf(&sb
, "%s/modules/%s", get_git_dir(), name
);
1403 sm_gitdir
= absolute_pathdup(sb
.buf
);
1406 if (!is_absolute_path(path
)) {
1407 strbuf_addf(&sb
, "%s/%s", get_git_work_tree(), path
);
1408 path
= strbuf_detach(&sb
, NULL
);
1410 path
= xstrdup(path
);
1412 if (!file_exists(sm_gitdir
)) {
1413 if (safe_create_leading_directories_const(sm_gitdir
) < 0)
1414 die(_("could not create directory '%s'"), sm_gitdir
);
1416 prepare_possible_alternates(name
, &reference
);
1418 if (clone_submodule(path
, sm_gitdir
, url
, depth
, &reference
, dissociate
,
1420 die(_("clone of '%s' into submodule path '%s' failed"),
1423 if (safe_create_leading_directories_const(path
) < 0)
1424 die(_("could not create directory '%s'"), path
);
1425 strbuf_addf(&sb
, "%s/index", sm_gitdir
);
1426 unlink_or_warn(sb
.buf
);
1430 connect_work_tree_and_git_dir(path
, sm_gitdir
, 0);
1432 p
= git_pathdup_submodule(path
, "config");
1434 die(_("could not get submodule directory for '%s'"), path
);
1436 /* setup alternateLocation and alternateErrorStrategy in the cloned submodule if needed */
1437 git_config_get_string("submodule.alternateLocation", &sm_alternate
);
1439 git_config_set_in_file(p
, "submodule.alternateLocation",
1441 git_config_get_string("submodule.alternateErrorStrategy", &error_strategy
);
1443 git_config_set_in_file(p
, "submodule.alternateErrorStrategy",
1447 free(error_strategy
);
1449 strbuf_release(&sb
);
1456 static void determine_submodule_update_strategy(struct repository
*r
,
1460 struct submodule_update_strategy
*out
)
1462 const struct submodule
*sub
= submodule_from_path(r
, &null_oid
, path
);
1466 key
= xstrfmt("submodule.%s.update", sub
->name
);
1469 if (parse_submodule_update_strategy(update
, out
) < 0)
1470 die(_("Invalid update mode '%s' for submodule path '%s'"),
1472 } else if (!repo_config_get_string_const(r
, key
, &val
)) {
1473 if (parse_submodule_update_strategy(val
, out
) < 0)
1474 die(_("Invalid update mode '%s' configured for submodule path '%s'"),
1476 } else if (sub
->update_strategy
.type
!= SM_UPDATE_UNSPECIFIED
) {
1477 out
->type
= sub
->update_strategy
.type
;
1478 out
->command
= sub
->update_strategy
.command
;
1480 out
->type
= SM_UPDATE_CHECKOUT
;
1483 (out
->type
== SM_UPDATE_MERGE
||
1484 out
->type
== SM_UPDATE_REBASE
||
1485 out
->type
== SM_UPDATE_NONE
))
1486 out
->type
= SM_UPDATE_CHECKOUT
;
1491 static int module_update_module_mode(int argc
, const char **argv
, const char *prefix
)
1493 const char *path
, *update
= NULL
;
1495 struct submodule_update_strategy update_strategy
= { .type
= SM_UPDATE_CHECKOUT
};
1497 if (argc
< 3 || argc
> 4)
1498 die("submodule--helper update-module-clone expects <just-cloned> <path> [<update>]");
1500 just_cloned
= git_config_int("just_cloned", argv
[1]);
1506 determine_submodule_update_strategy(the_repository
,
1507 just_cloned
, path
, update
,
1509 fputs(submodule_strategy_to_string(&update_strategy
), stdout
);
1514 struct update_clone_data
{
1515 const struct submodule
*sub
;
1516 struct object_id oid
;
1517 unsigned just_cloned
;
1520 struct submodule_update_clone
{
1521 /* index into 'list', the list of submodules to look into for cloning */
1523 struct module_list list
;
1524 unsigned warn_if_uninitialized
: 1;
1526 /* update parameter passed via commandline */
1527 struct submodule_update_strategy update
;
1529 /* configuration parameters which are passed on to the children */
1532 int recommend_shallow
;
1533 struct string_list references
;
1536 const char *recursive_prefix
;
1539 /* to be consumed by git-submodule.sh */
1540 struct update_clone_data
*update_clone
;
1541 int update_clone_nr
; int update_clone_alloc
;
1543 /* If we want to stop as fast as possible and return an error */
1544 unsigned quickstop
: 1;
1546 /* failed clones to be retried again */
1547 const struct cache_entry
**failed_clones
;
1548 int failed_clones_nr
, failed_clones_alloc
;
1552 #define SUBMODULE_UPDATE_CLONE_INIT {0, MODULE_LIST_INIT, 0, \
1553 SUBMODULE_UPDATE_STRATEGY_INIT, 0, 0, -1, STRING_LIST_INIT_DUP, 0, \
1555 NULL, 0, 0, 0, NULL, 0, 0, 1}
1558 static void next_submodule_warn_missing(struct submodule_update_clone
*suc
,
1559 struct strbuf
*out
, const char *displaypath
)
1562 * Only mention uninitialized submodules when their
1563 * paths have been specified.
1565 if (suc
->warn_if_uninitialized
) {
1567 _("Submodule path '%s' not initialized"),
1569 strbuf_addch(out
, '\n');
1571 _("Maybe you want to use 'update --init'?"));
1572 strbuf_addch(out
, '\n');
1577 * Determine whether 'ce' needs to be cloned. If so, prepare the 'child' to
1578 * run the clone. Returns 1 if 'ce' needs to be cloned, 0 otherwise.
1580 static int prepare_to_clone_next_submodule(const struct cache_entry
*ce
,
1581 struct child_process
*child
,
1582 struct submodule_update_clone
*suc
,
1585 const struct submodule
*sub
= NULL
;
1586 const char *url
= NULL
;
1587 const char *update_string
;
1588 enum submodule_update_type update_type
;
1590 struct strbuf displaypath_sb
= STRBUF_INIT
;
1591 struct strbuf sb
= STRBUF_INIT
;
1592 const char *displaypath
= NULL
;
1593 int needs_cloning
= 0;
1594 int need_free_url
= 0;
1597 if (suc
->recursive_prefix
)
1598 strbuf_addf(&sb
, "%s/%s", suc
->recursive_prefix
, ce
->name
);
1600 strbuf_addstr(&sb
, ce
->name
);
1601 strbuf_addf(out
, _("Skipping unmerged submodule %s"), sb
.buf
);
1602 strbuf_addch(out
, '\n');
1606 sub
= submodule_from_path(the_repository
, &null_oid
, ce
->name
);
1608 if (suc
->recursive_prefix
)
1609 displaypath
= relative_path(suc
->recursive_prefix
,
1610 ce
->name
, &displaypath_sb
);
1612 displaypath
= ce
->name
;
1615 next_submodule_warn_missing(suc
, out
, displaypath
);
1619 key
= xstrfmt("submodule.%s.update", sub
->name
);
1620 if (!repo_config_get_string_const(the_repository
, key
, &update_string
)) {
1621 update_type
= parse_submodule_update_type(update_string
);
1623 update_type
= sub
->update_strategy
.type
;
1627 if (suc
->update
.type
== SM_UPDATE_NONE
1628 || (suc
->update
.type
== SM_UPDATE_UNSPECIFIED
1629 && update_type
== SM_UPDATE_NONE
)) {
1630 strbuf_addf(out
, _("Skipping submodule '%s'"), displaypath
);
1631 strbuf_addch(out
, '\n');
1635 /* Check if the submodule has been initialized. */
1636 if (!is_submodule_active(the_repository
, ce
->name
)) {
1637 next_submodule_warn_missing(suc
, out
, displaypath
);
1642 strbuf_addf(&sb
, "submodule.%s.url", sub
->name
);
1643 if (repo_config_get_string_const(the_repository
, sb
.buf
, &url
)) {
1644 if (starts_with_dot_slash(sub
->url
) ||
1645 starts_with_dot_dot_slash(sub
->url
)) {
1646 url
= compute_submodule_clone_url(sub
->url
);
1653 strbuf_addf(&sb
, "%s/.git", ce
->name
);
1654 needs_cloning
= !file_exists(sb
.buf
);
1656 ALLOC_GROW(suc
->update_clone
, suc
->update_clone_nr
+ 1,
1657 suc
->update_clone_alloc
);
1658 oidcpy(&suc
->update_clone
[suc
->update_clone_nr
].oid
, &ce
->oid
);
1659 suc
->update_clone
[suc
->update_clone_nr
].just_cloned
= needs_cloning
;
1660 suc
->update_clone
[suc
->update_clone_nr
].sub
= sub
;
1661 suc
->update_clone_nr
++;
1667 child
->no_stdin
= 1;
1668 child
->stdout_to_stderr
= 1;
1670 argv_array_push(&child
->args
, "submodule--helper");
1671 argv_array_push(&child
->args
, "clone");
1673 argv_array_push(&child
->args
, "--progress");
1675 argv_array_push(&child
->args
, "--quiet");
1677 argv_array_pushl(&child
->args
, "--prefix", suc
->prefix
, NULL
);
1678 if (suc
->recommend_shallow
&& sub
->recommend_shallow
== 1)
1679 argv_array_push(&child
->args
, "--depth=1");
1680 argv_array_pushl(&child
->args
, "--path", sub
->path
, NULL
);
1681 argv_array_pushl(&child
->args
, "--name", sub
->name
, NULL
);
1682 argv_array_pushl(&child
->args
, "--url", url
, NULL
);
1683 if (suc
->references
.nr
) {
1684 struct string_list_item
*item
;
1685 for_each_string_list_item(item
, &suc
->references
)
1686 argv_array_pushl(&child
->args
, "--reference", item
->string
, NULL
);
1688 if (suc
->dissociate
)
1689 argv_array_push(&child
->args
, "--dissociate");
1691 argv_array_push(&child
->args
, suc
->depth
);
1694 strbuf_reset(&displaypath_sb
);
1699 return needs_cloning
;
1702 static int update_clone_get_next_task(struct child_process
*child
,
1707 struct submodule_update_clone
*suc
= suc_cb
;
1708 const struct cache_entry
*ce
;
1711 for (; suc
->current
< suc
->list
.nr
; suc
->current
++) {
1712 ce
= suc
->list
.entries
[suc
->current
];
1713 if (prepare_to_clone_next_submodule(ce
, child
, suc
, err
)) {
1714 int *p
= xmalloc(sizeof(*p
));
1723 * The loop above tried cloning each submodule once, now try the
1724 * stragglers again, which we can imagine as an extension of the
1727 index
= suc
->current
- suc
->list
.nr
;
1728 if (index
< suc
->failed_clones_nr
) {
1730 ce
= suc
->failed_clones
[index
];
1731 if (!prepare_to_clone_next_submodule(ce
, child
, suc
, err
)) {
1733 strbuf_addstr(err
, "BUG: submodule considered for "
1734 "cloning, doesn't need cloning "
1738 p
= xmalloc(sizeof(*p
));
1748 static int update_clone_start_failure(struct strbuf
*err
,
1752 struct submodule_update_clone
*suc
= suc_cb
;
1757 static int update_clone_task_finished(int result
,
1762 const struct cache_entry
*ce
;
1763 struct submodule_update_clone
*suc
= suc_cb
;
1765 int *idxP
= idx_task_cb
;
1772 if (idx
< suc
->list
.nr
) {
1773 ce
= suc
->list
.entries
[idx
];
1774 strbuf_addf(err
, _("Failed to clone '%s'. Retry scheduled"),
1776 strbuf_addch(err
, '\n');
1777 ALLOC_GROW(suc
->failed_clones
,
1778 suc
->failed_clones_nr
+ 1,
1779 suc
->failed_clones_alloc
);
1780 suc
->failed_clones
[suc
->failed_clones_nr
++] = ce
;
1783 idx
-= suc
->list
.nr
;
1784 ce
= suc
->failed_clones
[idx
];
1785 strbuf_addf(err
, _("Failed to clone '%s' a second time, aborting"),
1787 strbuf_addch(err
, '\n');
1795 static int git_update_clone_config(const char *var
, const char *value
,
1799 if (!strcmp(var
, "submodule.fetchjobs"))
1800 *max_jobs
= parse_submodule_fetchjobs(var
, value
);
1804 static void update_submodule(struct update_clone_data
*ucd
)
1806 fprintf(stdout
, "dummy %s %d\t%s\n",
1807 oid_to_hex(&ucd
->oid
),
1812 static int update_submodules(struct submodule_update_clone
*suc
)
1816 run_processes_parallel(suc
->max_jobs
,
1817 update_clone_get_next_task
,
1818 update_clone_start_failure
,
1819 update_clone_task_finished
,
1823 * We saved the output and put it out all at once now.
1825 * - the listener does not have to interleave their (checkout)
1826 * work with our fetching. The writes involved in a
1827 * checkout involve more straightforward sequential I/O.
1828 * - the listener can avoid doing any work if fetching failed.
1833 for (i
= 0; i
< suc
->update_clone_nr
; i
++)
1834 update_submodule(&suc
->update_clone
[i
]);
1839 static int update_clone(int argc
, const char **argv
, const char *prefix
)
1841 const char *update
= NULL
;
1842 struct pathspec pathspec
;
1843 struct submodule_update_clone suc
= SUBMODULE_UPDATE_CLONE_INIT
;
1845 struct option module_update_clone_options
[] = {
1846 OPT_STRING(0, "prefix", &prefix
,
1848 N_("path into the working tree")),
1849 OPT_STRING(0, "recursive-prefix", &suc
.recursive_prefix
,
1851 N_("path into the working tree, across nested "
1852 "submodule boundaries")),
1853 OPT_STRING(0, "update", &update
,
1855 N_("rebase, merge, checkout or none")),
1856 OPT_STRING_LIST(0, "reference", &suc
.references
, N_("repo"),
1857 N_("reference repository")),
1858 OPT_BOOL(0, "dissociate", &suc
.dissociate
,
1859 N_("use --reference only while cloning")),
1860 OPT_STRING(0, "depth", &suc
.depth
, "<depth>",
1861 N_("Create a shallow clone truncated to the "
1862 "specified number of revisions")),
1863 OPT_INTEGER('j', "jobs", &suc
.max_jobs
,
1864 N_("parallel jobs")),
1865 OPT_BOOL(0, "recommend-shallow", &suc
.recommend_shallow
,
1866 N_("whether the initial clone should follow the shallow recommendation")),
1867 OPT__QUIET(&suc
.quiet
, N_("don't print cloning progress")),
1868 OPT_BOOL(0, "progress", &suc
.progress
,
1869 N_("force cloning progress")),
1873 const char *const git_submodule_helper_usage
[] = {
1874 N_("git submodule--helper update_clone [--prefix=<path>] [<path>...]"),
1877 suc
.prefix
= prefix
;
1879 update_clone_config_from_gitmodules(&suc
.max_jobs
);
1880 git_config(git_update_clone_config
, &suc
.max_jobs
);
1882 argc
= parse_options(argc
, argv
, prefix
, module_update_clone_options
,
1883 git_submodule_helper_usage
, 0);
1886 if (parse_submodule_update_strategy(update
, &suc
.update
) < 0)
1887 die(_("bad value for update parameter"));
1889 if (module_list_compute(argc
, argv
, prefix
, &pathspec
, &suc
.list
) < 0)
1893 suc
.warn_if_uninitialized
= 1;
1895 return update_submodules(&suc
);
1898 static int resolve_relative_path(int argc
, const char **argv
, const char *prefix
)
1900 struct strbuf sb
= STRBUF_INIT
;
1902 die("submodule--helper relative-path takes exactly 2 arguments, got %d", argc
);
1904 printf("%s", relative_path(argv
[1], argv
[2], &sb
));
1905 strbuf_release(&sb
);
1909 static const char *remote_submodule_branch(const char *path
)
1911 const struct submodule
*sub
;
1912 const char *branch
= NULL
;
1915 sub
= submodule_from_path(the_repository
, &null_oid
, path
);
1919 key
= xstrfmt("submodule.%s.branch", sub
->name
);
1920 if (repo_config_get_string_const(the_repository
, key
, &branch
))
1921 branch
= sub
->branch
;
1927 if (!strcmp(branch
, ".")) {
1928 const char *refname
= resolve_ref_unsafe("HEAD", 0, NULL
, NULL
);
1931 die(_("No such ref: %s"), "HEAD");
1934 if (!strcmp(refname
, "HEAD"))
1935 die(_("Submodule (%s) branch configured to inherit "
1936 "branch from superproject, but the superproject "
1937 "is not on any branch"), sub
->name
);
1939 if (!skip_prefix(refname
, "refs/heads/", &refname
))
1940 die(_("Expecting a full ref name, got %s"), refname
);
1947 static int resolve_remote_submodule_branch(int argc
, const char **argv
,
1951 struct strbuf sb
= STRBUF_INIT
;
1953 die("submodule--helper remote-branch takes exactly one arguments, got %d", argc
);
1955 ret
= remote_submodule_branch(argv
[1]);
1957 die("submodule %s doesn't exist", argv
[1]);
1960 strbuf_release(&sb
);
1964 static int push_check(int argc
, const char **argv
, const char *prefix
)
1966 struct remote
*remote
;
1967 const char *superproject_head
;
1969 int detached_head
= 0;
1970 struct object_id head_oid
;
1973 die("submodule--helper push-check requires at least 2 arguments");
1976 * superproject's resolved head ref.
1977 * if HEAD then the superproject is in a detached head state, otherwise
1978 * it will be the resolved head ref.
1980 superproject_head
= argv
[1];
1983 /* Get the submodule's head ref and determine if it is detached */
1984 head
= resolve_refdup("HEAD", 0, &head_oid
, NULL
);
1986 die(_("Failed to resolve HEAD as a valid ref."));
1987 if (!strcmp(head
, "HEAD"))
1991 * The remote must be configured.
1992 * This is to avoid pushing to the exact same URL as the parent.
1994 remote
= pushremote_get(argv
[1]);
1995 if (!remote
|| remote
->origin
== REMOTE_UNCONFIGURED
)
1996 die("remote '%s' not configured", argv
[1]);
1998 /* Check the refspec */
2001 struct ref
*local_refs
= get_local_heads();
2002 struct refspec refspec
= REFSPEC_INIT_PUSH
;
2004 refspec_appendn(&refspec
, argv
+ 2, argc
- 2);
2006 for (i
= 0; i
< refspec
.nr
; i
++) {
2007 const struct refspec_item
*rs
= &refspec
.items
[i
];
2009 if (rs
->pattern
|| rs
->matching
)
2012 /* LHS must match a single ref */
2013 switch (count_refspec_match(rs
->src
, local_refs
, NULL
)) {
2018 * If LHS matches 'HEAD' then we need to ensure
2019 * that it matches the same named branch
2020 * checked out in the superproject.
2022 if (!strcmp(rs
->src
, "HEAD")) {
2023 if (!detached_head
&&
2024 !strcmp(head
, superproject_head
))
2026 die("HEAD does not match the named branch in the superproject");
2030 die("src refspec '%s' must name a ref",
2034 refspec_clear(&refspec
);
2041 static int ensure_core_worktree(int argc
, const char **argv
, const char *prefix
)
2043 const struct submodule
*sub
;
2046 struct repository subrepo
;
2049 BUG("submodule--helper connect-gitdir-workingtree <name> <path>");
2053 sub
= submodule_from_path(the_repository
, &null_oid
, path
);
2055 BUG("We could get the submodule handle before?");
2057 if (repo_submodule_init(&subrepo
, the_repository
, path
))
2058 die(_("could not get a repository handle for submodule '%s'"), path
);
2060 if (!repo_config_get_string(&subrepo
, "core.worktree", &cw
)) {
2061 char *cfg_file
, *abs_path
;
2062 const char *rel_path
;
2063 struct strbuf sb
= STRBUF_INIT
;
2065 cfg_file
= repo_git_path(&subrepo
, "config");
2067 abs_path
= absolute_pathdup(path
);
2068 rel_path
= relative_path(abs_path
, subrepo
.gitdir
, &sb
);
2070 git_config_set_in_file(cfg_file
, "core.worktree", rel_path
);
2074 strbuf_release(&sb
);
2080 static int absorb_git_dirs(int argc
, const char **argv
, const char *prefix
)
2083 struct pathspec pathspec
;
2084 struct module_list list
= MODULE_LIST_INIT
;
2085 unsigned flags
= ABSORB_GITDIR_RECURSE_SUBMODULES
;
2087 struct option embed_gitdir_options
[] = {
2088 OPT_STRING(0, "prefix", &prefix
,
2090 N_("path into the working tree")),
2091 OPT_BIT(0, "--recursive", &flags
, N_("recurse into submodules"),
2092 ABSORB_GITDIR_RECURSE_SUBMODULES
),
2096 const char *const git_submodule_helper_usage
[] = {
2097 N_("git submodule--helper embed-git-dir [<path>...]"),
2101 argc
= parse_options(argc
, argv
, prefix
, embed_gitdir_options
,
2102 git_submodule_helper_usage
, 0);
2104 if (module_list_compute(argc
, argv
, prefix
, &pathspec
, &list
) < 0)
2107 for (i
= 0; i
< list
.nr
; i
++)
2108 absorb_git_dir_into_superproject(prefix
,
2109 list
.entries
[i
]->name
, flags
);
2114 static int is_active(int argc
, const char **argv
, const char *prefix
)
2117 die("submodule--helper is-active takes exactly 1 argument");
2119 return !is_submodule_active(the_repository
, argv
[1]);
2123 * Exit non-zero if any of the submodule names given on the command line is
2124 * invalid. If no names are given, filter stdin to print only valid names
2125 * (which is primarily intended for testing).
2127 static int check_name(int argc
, const char **argv
, const char *prefix
)
2131 if (check_submodule_name(*argv
) < 0)
2135 struct strbuf buf
= STRBUF_INIT
;
2136 while (strbuf_getline(&buf
, stdin
) != EOF
) {
2137 if (!check_submodule_name(buf
.buf
))
2138 printf("%s\n", buf
.buf
);
2140 strbuf_release(&buf
);
2145 static int module_config(int argc
, const char **argv
, const char *prefix
)
2151 struct option module_config_options
[] = {
2152 OPT_CMDMODE(0, "check-writeable", &command
,
2153 N_("check if it is safe to write to the .gitmodules file"),
2157 const char *const git_submodule_helper_usage
[] = {
2158 N_("git submodule--helper config name [value]"),
2159 N_("git submodule--helper config --check-writeable"),
2163 argc
= parse_options(argc
, argv
, prefix
, module_config_options
,
2164 git_submodule_helper_usage
, PARSE_OPT_KEEP_ARGV0
);
2166 if (argc
== 1 && command
== CHECK_WRITEABLE
)
2167 return is_writing_gitmodules_ok() ? 0 : -1;
2169 /* Equivalent to ACTION_GET in builtin/config.c */
2171 return print_config_from_gitmodules(the_repository
, argv
[1]);
2173 /* Equivalent to ACTION_SET in builtin/config.c */
2175 if (!is_writing_gitmodules_ok())
2176 die(_("please make sure that the .gitmodules file is in the working tree"));
2178 return config_set_in_gitmodules_file_gently(argv
[1], argv
[2]);
2181 usage_with_options(git_submodule_helper_usage
, module_config_options
);
2184 #define SUPPORT_SUPER_PREFIX (1<<0)
2188 int (*fn
)(int, const char **, const char *);
2192 static struct cmd_struct commands
[] = {
2193 {"list", module_list
, 0},
2194 {"name", module_name
, 0},
2195 {"clone", module_clone
, 0},
2196 {"update-module-mode", module_update_module_mode
, 0},
2197 {"update-clone", update_clone
, 0},
2198 {"ensure-core-worktree", ensure_core_worktree
, 0},
2199 {"relative-path", resolve_relative_path
, 0},
2200 {"resolve-relative-url", resolve_relative_url
, 0},
2201 {"resolve-relative-url-test", resolve_relative_url_test
, 0},
2202 {"foreach", module_foreach
, SUPPORT_SUPER_PREFIX
},
2203 {"init", module_init
, SUPPORT_SUPER_PREFIX
},
2204 {"status", module_status
, SUPPORT_SUPER_PREFIX
},
2205 {"print-default-remote", print_default_remote
, 0},
2206 {"sync", module_sync
, SUPPORT_SUPER_PREFIX
},
2207 {"deinit", module_deinit
, 0},
2208 {"remote-branch", resolve_remote_submodule_branch
, 0},
2209 {"push-check", push_check
, 0},
2210 {"absorb-git-dirs", absorb_git_dirs
, SUPPORT_SUPER_PREFIX
},
2211 {"is-active", is_active
, 0},
2212 {"check-name", check_name
, 0},
2213 {"config", module_config
, 0},
2216 int cmd_submodule__helper(int argc
, const char **argv
, const char *prefix
)
2219 if (argc
< 2 || !strcmp(argv
[1], "-h"))
2220 usage("git submodule--helper <command>");
2222 for (i
= 0; i
< ARRAY_SIZE(commands
); i
++) {
2223 if (!strcmp(argv
[1], commands
[i
].cmd
)) {
2224 if (get_super_prefix() &&
2225 !(commands
[i
].option
& SUPPORT_SUPER_PREFIX
))
2226 die(_("%s doesn't support --super-prefix"),
2228 return commands
[i
].fn(argc
- 1, argv
+ 1, prefix
);
2232 die(_("'%s' is not a valid submodule--helper "
2233 "subcommand"), argv
[1]);