3 #include "parse-options.h"
9 #include "submodule-config.h"
10 #include "string-list.h"
11 #include "run-command.h"
16 static char *get_default_remote(void)
18 char *dest
= NULL
, *ret
;
19 unsigned char sha1
[20];
20 struct strbuf sb
= STRBUF_INIT
;
21 const char *refname
= resolve_ref_unsafe("HEAD", 0, sha1
, NULL
);
24 die(_("No such ref: %s"), "HEAD");
27 if (!strcmp(refname
, "HEAD"))
28 return xstrdup("origin");
30 if (!skip_prefix(refname
, "refs/heads/", &refname
))
31 die(_("Expecting a full ref name, got %s"), refname
);
33 strbuf_addf(&sb
, "branch.%s.remote", refname
);
34 if (git_config_get_string(sb
.buf
, &dest
))
35 ret
= xstrdup("origin");
43 static int starts_with_dot_slash(const char *str
)
45 return str
[0] == '.' && is_dir_sep(str
[1]);
48 static int starts_with_dot_dot_slash(const char *str
)
50 return str
[0] == '.' && str
[1] == '.' && is_dir_sep(str
[2]);
54 * Returns 1 if it was the last chop before ':'.
56 static int chop_last_dir(char **remoteurl
, int is_relative
)
58 char *rfind
= find_last_dir_sep(*remoteurl
);
64 rfind
= strrchr(*remoteurl
, ':');
70 if (is_relative
|| !strcmp(".", *remoteurl
))
71 die(_("cannot strip one component off url '%s'"),
75 *remoteurl
= xstrdup(".");
80 * The `url` argument is the URL that navigates to the submodule origin
81 * repo. When relative, this URL is relative to the superproject origin
82 * URL repo. The `up_path` argument, if specified, is the relative
83 * path that navigates from the submodule working tree to the superproject
84 * working tree. Returns the origin URL of the submodule.
86 * Return either an absolute URL or filesystem path (if the superproject
87 * origin URL is an absolute URL or filesystem path, respectively) or a
88 * relative file system path (if the superproject origin URL is a relative
91 * When the output is a relative file system path, the path is either
92 * relative to the submodule working tree, if up_path is specified, or to
93 * the superproject working tree otherwise.
95 * NEEDSWORK: This works incorrectly on the domain and protocol part.
96 * remote_url url outcome expectation
97 * http://a.com/b ../c http://a.com/c as is
98 * http://a.com/b ../../c http://c error out
99 * http://a.com/b ../../../c http:/c error out
100 * http://a.com/b ../../../../c http:c error out
101 * http://a.com/b ../../../../../c .:c error out
102 * NEEDSWORK: Given how chop_last_dir() works, this function is broken
103 * when a local part has a colon in its path component, too.
105 static char *relative_url(const char *remote_url
,
112 char *remoteurl
= xstrdup(remote_url
);
113 struct strbuf sb
= STRBUF_INIT
;
114 size_t len
= strlen(remoteurl
);
116 if (is_dir_sep(remoteurl
[len
]))
117 remoteurl
[len
] = '\0';
119 if (!url_is_local_not_ssh(remoteurl
) || is_absolute_path(remoteurl
))
124 * Prepend a './' to ensure all relative
125 * remoteurls start with './' or '../'
127 if (!starts_with_dot_slash(remoteurl
) &&
128 !starts_with_dot_dot_slash(remoteurl
)) {
130 strbuf_addf(&sb
, "./%s", remoteurl
);
132 remoteurl
= strbuf_detach(&sb
, NULL
);
136 * When the url starts with '../', remove that and the
137 * last directory in remoteurl.
140 if (starts_with_dot_dot_slash(url
)) {
142 colonsep
|= chop_last_dir(&remoteurl
, is_relative
);
143 } else if (starts_with_dot_slash(url
))
149 strbuf_addf(&sb
, "%s%s%s", remoteurl
, colonsep
? ":" : "/", url
);
152 if (starts_with_dot_slash(sb
.buf
))
153 out
= xstrdup(sb
.buf
+ 2);
155 out
= xstrdup(sb
.buf
);
158 if (!up_path
|| !is_relative
)
161 strbuf_addf(&sb
, "%s%s", up_path
, out
);
163 return strbuf_detach(&sb
, NULL
);
166 static int resolve_relative_url(int argc
, const char **argv
, const char *prefix
)
168 char *remoteurl
= NULL
;
169 char *remote
= get_default_remote();
170 const char *up_path
= NULL
;
173 struct strbuf sb
= STRBUF_INIT
;
175 if (argc
!= 2 && argc
!= 3)
176 die("resolve-relative-url only accepts one or two arguments");
179 strbuf_addf(&sb
, "remote.%s.url", remote
);
182 if (git_config_get_string(sb
.buf
, &remoteurl
))
183 /* the repository is its own authoritative upstream */
184 remoteurl
= xgetcwd();
189 res
= relative_url(remoteurl
, url
, up_path
);
196 static int resolve_relative_url_test(int argc
, const char **argv
, const char *prefix
)
198 char *remoteurl
, *res
;
199 const char *up_path
, *url
;
202 die("resolve-relative-url-test only accepts three arguments: <up_path> <remoteurl> <url>");
205 remoteurl
= xstrdup(argv
[2]);
208 if (!strcmp(up_path
, "(null)"))
211 res
= relative_url(remoteurl
, url
, up_path
);
219 const struct cache_entry
**entries
;
222 #define MODULE_LIST_INIT { NULL, 0, 0 }
224 static int module_list_compute(int argc
, const char **argv
,
226 struct pathspec
*pathspec
,
227 struct module_list
*list
)
230 char *ps_matched
= NULL
;
231 parse_pathspec(pathspec
, 0,
232 PATHSPEC_PREFER_FULL
|
233 PATHSPEC_STRIP_SUBMODULE_SLASH_CHEAP
,
237 ps_matched
= xcalloc(pathspec
->nr
, 1);
239 if (read_cache() < 0)
240 die(_("index file corrupt"));
242 for (i
= 0; i
< active_nr
; i
++) {
243 const struct cache_entry
*ce
= active_cache
[i
];
245 if (!match_pathspec(pathspec
, ce
->name
, ce_namelen(ce
),
247 !S_ISGITLINK(ce
->ce_mode
))
250 ALLOC_GROW(list
->entries
, list
->nr
+ 1, list
->alloc
);
251 list
->entries
[list
->nr
++] = ce
;
252 while (i
+ 1 < active_nr
&&
253 !strcmp(ce
->name
, active_cache
[i
+ 1]->name
))
255 * Skip entries with the same name in different stages
256 * to make sure an entry is returned only once.
261 if (ps_matched
&& report_path_error(ps_matched
, pathspec
, prefix
))
269 static int module_list(int argc
, const char **argv
, const char *prefix
)
272 struct pathspec pathspec
;
273 struct module_list list
= MODULE_LIST_INIT
;
275 struct option module_list_options
[] = {
276 OPT_STRING(0, "prefix", &prefix
,
278 N_("alternative anchor for relative paths")),
282 const char *const git_submodule_helper_usage
[] = {
283 N_("git submodule--helper list [--prefix=<path>] [<path>...]"),
287 argc
= parse_options(argc
, argv
, prefix
, module_list_options
,
288 git_submodule_helper_usage
, 0);
290 if (module_list_compute(argc
, argv
, prefix
, &pathspec
, &list
) < 0)
293 for (i
= 0; i
< list
.nr
; i
++) {
294 const struct cache_entry
*ce
= list
.entries
[i
];
297 printf("%06o %s U\t", ce
->ce_mode
, sha1_to_hex(null_sha1
));
299 printf("%06o %s %d\t", ce
->ce_mode
,
300 oid_to_hex(&ce
->oid
), ce_stage(ce
));
302 utf8_fprintf(stdout
, "%s\n", ce
->name
);
307 static void init_submodule(const char *path
, const char *prefix
, int quiet
)
309 const struct submodule
*sub
;
310 struct strbuf sb
= STRBUF_INIT
;
311 char *upd
= NULL
, *url
= NULL
, *displaypath
;
313 /* Only loads from .gitmodules, no overlay with .git/config */
317 strbuf_addf(&sb
, "%s%s", prefix
, path
);
318 displaypath
= strbuf_detach(&sb
, NULL
);
320 displaypath
= xstrdup(path
);
322 sub
= submodule_from_path(null_sha1
, path
);
325 die(_("No url found for submodule path '%s' in .gitmodules"),
329 * Copy url setting when it is not set yet.
330 * To look up the url in .git/config, we must not fall back to
331 * .gitmodules, so look it up directly.
334 strbuf_addf(&sb
, "submodule.%s.url", sub
->name
);
335 if (git_config_get_string(sb
.buf
, &url
)) {
336 url
= xstrdup(sub
->url
);
339 die(_("No url found for submodule path '%s' in .gitmodules"),
342 /* Possibly a url relative to parent */
343 if (starts_with_dot_dot_slash(url
) ||
344 starts_with_dot_slash(url
)) {
345 char *remoteurl
, *relurl
;
346 char *remote
= get_default_remote();
347 struct strbuf remotesb
= STRBUF_INIT
;
348 strbuf_addf(&remotesb
, "remote.%s.url", remote
);
351 if (git_config_get_string(remotesb
.buf
, &remoteurl
))
353 * The repository is its own
354 * authoritative upstream
356 remoteurl
= xgetcwd();
357 relurl
= relative_url(remoteurl
, url
, NULL
);
358 strbuf_release(&remotesb
);
364 if (git_config_set_gently(sb
.buf
, url
))
365 die(_("Failed to register url for submodule path '%s'"),
369 _("Submodule '%s' (%s) registered for path '%s'\n"),
370 sub
->name
, url
, displaypath
);
373 /* Copy "update" setting when it is not set yet */
375 strbuf_addf(&sb
, "submodule.%s.update", sub
->name
);
376 if (git_config_get_string(sb
.buf
, &upd
) &&
377 sub
->update_strategy
.type
!= SM_UPDATE_UNSPECIFIED
) {
378 if (sub
->update_strategy
.type
== SM_UPDATE_COMMAND
) {
379 fprintf(stderr
, _("warning: command update mode suggested for submodule '%s'\n"),
381 upd
= xstrdup("none");
383 upd
= xstrdup(submodule_strategy_to_string(&sub
->update_strategy
));
385 if (git_config_set_gently(sb
.buf
, upd
))
386 die(_("Failed to register update mode for submodule path '%s'"), displaypath
);
394 static int module_init(int argc
, const char **argv
, const char *prefix
)
396 struct pathspec pathspec
;
397 struct module_list list
= MODULE_LIST_INIT
;
401 struct option module_init_options
[] = {
402 OPT_STRING(0, "prefix", &prefix
,
404 N_("alternative anchor for relative paths")),
405 OPT__QUIET(&quiet
, N_("Suppress output for initializing a submodule")),
409 const char *const git_submodule_helper_usage
[] = {
410 N_("git submodule--helper init [<path>]"),
414 argc
= parse_options(argc
, argv
, prefix
, module_init_options
,
415 git_submodule_helper_usage
, 0);
417 if (module_list_compute(argc
, argv
, prefix
, &pathspec
, &list
) < 0)
420 for (i
= 0; i
< list
.nr
; i
++)
421 init_submodule(list
.entries
[i
]->name
, prefix
, quiet
);
426 static int module_name(int argc
, const char **argv
, const char *prefix
)
428 const struct submodule
*sub
;
431 usage(_("git submodule--helper name <path>"));
434 sub
= submodule_from_path(null_sha1
, argv
[1]);
437 die(_("no submodule mapping found in .gitmodules for path '%s'"),
440 printf("%s\n", sub
->name
);
445 static int clone_submodule(const char *path
, const char *gitdir
, const char *url
,
446 const char *depth
, struct string_list
*reference
,
447 int quiet
, int progress
)
449 struct child_process cp
= CHILD_PROCESS_INIT
;
451 argv_array_push(&cp
.args
, "clone");
452 argv_array_push(&cp
.args
, "--no-checkout");
454 argv_array_push(&cp
.args
, "--quiet");
456 argv_array_push(&cp
.args
, "--progress");
458 argv_array_pushl(&cp
.args
, "--depth", depth
, NULL
);
460 struct string_list_item
*item
;
461 for_each_string_list_item(item
, reference
)
462 argv_array_pushl(&cp
.args
, "--reference",
465 if (gitdir
&& *gitdir
)
466 argv_array_pushl(&cp
.args
, "--separate-git-dir", gitdir
, NULL
);
468 argv_array_push(&cp
.args
, url
);
469 argv_array_push(&cp
.args
, path
);
472 prepare_submodule_repo_env(&cp
.env_array
);
475 return run_command(&cp
);
478 struct submodule_alternate_setup
{
479 const char *submodule_name
;
480 enum SUBMODULE_ALTERNATE_ERROR_MODE
{
481 SUBMODULE_ALTERNATE_ERROR_DIE
,
482 SUBMODULE_ALTERNATE_ERROR_INFO
,
483 SUBMODULE_ALTERNATE_ERROR_IGNORE
485 struct string_list
*reference
;
487 #define SUBMODULE_ALTERNATE_SETUP_INIT { NULL, \
488 SUBMODULE_ALTERNATE_ERROR_IGNORE, NULL }
490 static int add_possible_reference_from_superproject(
491 struct alternate_object_database
*alt
, void *sas_cb
)
493 struct submodule_alternate_setup
*sas
= sas_cb
;
496 * If the alternate object store is another repository, try the
497 * standard layout with .git/modules/<name>/objects
499 if (ends_with(alt
->path
, ".git/objects")) {
501 struct strbuf sb
= STRBUF_INIT
;
502 struct strbuf err
= STRBUF_INIT
;
503 strbuf_add(&sb
, alt
->path
, strlen(alt
->path
) - strlen("objects"));
506 * We need to end the new path with '/' to mark it as a dir,
507 * otherwise a submodule name containing '/' will be broken
508 * as the last part of a missing submodule reference would
509 * be taken as a file name.
511 strbuf_addf(&sb
, "modules/%s/", sas
->submodule_name
);
513 sm_alternate
= compute_alternate_path(sb
.buf
, &err
);
515 string_list_append(sas
->reference
, xstrdup(sb
.buf
));
518 switch (sas
->error_mode
) {
519 case SUBMODULE_ALTERNATE_ERROR_DIE
:
520 die(_("submodule '%s' cannot add alternate: %s"),
521 sas
->submodule_name
, err
.buf
);
522 case SUBMODULE_ALTERNATE_ERROR_INFO
:
523 fprintf(stderr
, _("submodule '%s' cannot add alternate: %s"),
524 sas
->submodule_name
, err
.buf
);
525 case SUBMODULE_ALTERNATE_ERROR_IGNORE
:
535 static void prepare_possible_alternates(const char *sm_name
,
536 struct string_list
*reference
)
538 char *sm_alternate
= NULL
, *error_strategy
= NULL
;
539 struct submodule_alternate_setup sas
= SUBMODULE_ALTERNATE_SETUP_INIT
;
541 git_config_get_string("submodule.alternateLocation", &sm_alternate
);
545 git_config_get_string("submodule.alternateErrorStrategy", &error_strategy
);
548 error_strategy
= xstrdup("die");
550 sas
.submodule_name
= sm_name
;
551 sas
.reference
= reference
;
552 if (!strcmp(error_strategy
, "die"))
553 sas
.error_mode
= SUBMODULE_ALTERNATE_ERROR_DIE
;
554 else if (!strcmp(error_strategy
, "info"))
555 sas
.error_mode
= SUBMODULE_ALTERNATE_ERROR_INFO
;
556 else if (!strcmp(error_strategy
, "ignore"))
557 sas
.error_mode
= SUBMODULE_ALTERNATE_ERROR_IGNORE
;
559 die(_("Value '%s' for submodule.alternateErrorStrategy is not recognized"), error_strategy
);
561 if (!strcmp(sm_alternate
, "superproject"))
562 foreach_alt_odb(add_possible_reference_from_superproject
, &sas
);
563 else if (!strcmp(sm_alternate
, "no"))
566 die(_("Value '%s' for submodule.alternateLocation is not recognized"), sm_alternate
);
569 free(error_strategy
);
572 static int module_clone(int argc
, const char **argv
, const char *prefix
)
574 const char *name
= NULL
, *url
= NULL
, *depth
= NULL
;
577 FILE *submodule_dot_git
;
578 char *p
, *path
= NULL
, *sm_gitdir
;
579 struct strbuf rel_path
= STRBUF_INIT
;
580 struct strbuf sb
= STRBUF_INIT
;
581 struct string_list reference
= STRING_LIST_INIT_NODUP
;
583 struct option module_clone_options
[] = {
584 OPT_STRING(0, "prefix", &prefix
,
586 N_("alternative anchor for relative paths")),
587 OPT_STRING(0, "path", &path
,
589 N_("where the new submodule will be cloned to")),
590 OPT_STRING(0, "name", &name
,
592 N_("name of the new submodule")),
593 OPT_STRING(0, "url", &url
,
595 N_("url where to clone the submodule from")),
596 OPT_STRING_LIST(0, "reference", &reference
,
598 N_("reference repository")),
599 OPT_STRING(0, "depth", &depth
,
601 N_("depth for shallow clones")),
602 OPT__QUIET(&quiet
, "Suppress output for cloning a submodule"),
603 OPT_BOOL(0, "progress", &progress
,
604 N_("force cloning progress")),
608 const char *const git_submodule_helper_usage
[] = {
609 N_("git submodule--helper clone [--prefix=<path>] [--quiet] "
610 "[--reference <repository>] [--name <name>] [--depth <depth>] "
611 "--url <url> --path <path>"),
615 argc
= parse_options(argc
, argv
, prefix
, module_clone_options
,
616 git_submodule_helper_usage
, 0);
618 if (argc
|| !url
|| !path
|| !*path
)
619 usage_with_options(git_submodule_helper_usage
,
620 module_clone_options
);
622 strbuf_addf(&sb
, "%s/modules/%s", get_git_dir(), name
);
623 sm_gitdir
= xstrdup(absolute_path(sb
.buf
));
626 if (!is_absolute_path(path
)) {
627 strbuf_addf(&sb
, "%s/%s", get_git_work_tree(), path
);
628 path
= strbuf_detach(&sb
, NULL
);
630 path
= xstrdup(path
);
632 if (!file_exists(sm_gitdir
)) {
633 if (safe_create_leading_directories_const(sm_gitdir
) < 0)
634 die(_("could not create directory '%s'"), sm_gitdir
);
636 prepare_possible_alternates(name
, &reference
);
638 if (clone_submodule(path
, sm_gitdir
, url
, depth
, &reference
,
640 die(_("clone of '%s' into submodule path '%s' failed"),
643 if (safe_create_leading_directories_const(path
) < 0)
644 die(_("could not create directory '%s'"), path
);
645 strbuf_addf(&sb
, "%s/index", sm_gitdir
);
646 unlink_or_warn(sb
.buf
);
650 /* Write a .git file in the submodule to redirect to the superproject. */
651 strbuf_addf(&sb
, "%s/.git", path
);
652 if (safe_create_leading_directories_const(sb
.buf
) < 0)
653 die(_("could not create leading directories of '%s'"), sb
.buf
);
654 submodule_dot_git
= fopen(sb
.buf
, "w");
655 if (!submodule_dot_git
)
656 die_errno(_("cannot open file '%s'"), sb
.buf
);
658 fprintf_or_die(submodule_dot_git
, "gitdir: %s\n",
659 relative_path(sm_gitdir
, path
, &rel_path
));
660 if (fclose(submodule_dot_git
))
661 die(_("could not close file %s"), sb
.buf
);
663 strbuf_reset(&rel_path
);
665 /* Redirect the worktree of the submodule in the superproject's config */
666 p
= git_pathdup_submodule(path
, "config");
668 die(_("could not get submodule directory for '%s'"), path
);
669 git_config_set_in_file(p
, "core.worktree",
670 relative_path(path
, sm_gitdir
, &rel_path
));
672 strbuf_release(&rel_path
);
679 struct submodule_update_clone
{
680 /* index into 'list', the list of submodules to look into for cloning */
682 struct module_list list
;
683 unsigned warn_if_uninitialized
: 1;
685 /* update parameter passed via commandline */
686 struct submodule_update_strategy update
;
688 /* configuration parameters which are passed on to the children */
691 int recommend_shallow
;
692 struct string_list references
;
694 const char *recursive_prefix
;
697 /* Machine-readable status lines to be consumed by git-submodule.sh */
698 struct string_list projectlines
;
700 /* If we want to stop as fast as possible and return an error */
701 unsigned quickstop
: 1;
703 /* failed clones to be retried again */
704 const struct cache_entry
**failed_clones
;
705 int failed_clones_nr
, failed_clones_alloc
;
707 #define SUBMODULE_UPDATE_CLONE_INIT {0, MODULE_LIST_INIT, 0, \
708 SUBMODULE_UPDATE_STRATEGY_INIT, 0, 0, -1, STRING_LIST_INIT_DUP, \
710 STRING_LIST_INIT_DUP, 0, NULL, 0, 0}
713 static void next_submodule_warn_missing(struct submodule_update_clone
*suc
,
714 struct strbuf
*out
, const char *displaypath
)
717 * Only mention uninitialized submodules when their
718 * paths have been specified.
720 if (suc
->warn_if_uninitialized
) {
722 _("Submodule path '%s' not initialized"),
724 strbuf_addch(out
, '\n');
726 _("Maybe you want to use 'update --init'?"));
727 strbuf_addch(out
, '\n');
732 * Determine whether 'ce' needs to be cloned. If so, prepare the 'child' to
733 * run the clone. Returns 1 if 'ce' needs to be cloned, 0 otherwise.
735 static int prepare_to_clone_next_submodule(const struct cache_entry
*ce
,
736 struct child_process
*child
,
737 struct submodule_update_clone
*suc
,
740 const struct submodule
*sub
= NULL
;
741 struct strbuf displaypath_sb
= STRBUF_INIT
;
742 struct strbuf sb
= STRBUF_INIT
;
743 const char *displaypath
= NULL
;
745 int needs_cloning
= 0;
748 if (suc
->recursive_prefix
)
749 strbuf_addf(&sb
, "%s/%s", suc
->recursive_prefix
, ce
->name
);
751 strbuf_addf(&sb
, "%s", ce
->name
);
752 strbuf_addf(out
, _("Skipping unmerged submodule %s"), sb
.buf
);
753 strbuf_addch(out
, '\n');
757 sub
= submodule_from_path(null_sha1
, ce
->name
);
759 if (suc
->recursive_prefix
)
760 displaypath
= relative_path(suc
->recursive_prefix
,
761 ce
->name
, &displaypath_sb
);
763 displaypath
= ce
->name
;
766 next_submodule_warn_missing(suc
, out
, displaypath
);
770 if (suc
->update
.type
== SM_UPDATE_NONE
771 || (suc
->update
.type
== SM_UPDATE_UNSPECIFIED
772 && sub
->update_strategy
.type
== SM_UPDATE_NONE
)) {
773 strbuf_addf(out
, _("Skipping submodule '%s'"), displaypath
);
774 strbuf_addch(out
, '\n');
779 * Looking up the url in .git/config.
780 * We must not fall back to .gitmodules as we only want
781 * to process configured submodules.
784 strbuf_addf(&sb
, "submodule.%s.url", sub
->name
);
785 git_config_get_string(sb
.buf
, &url
);
787 next_submodule_warn_missing(suc
, out
, displaypath
);
792 strbuf_addf(&sb
, "%s/.git", ce
->name
);
793 needs_cloning
= !file_exists(sb
.buf
);
796 strbuf_addf(&sb
, "%06o %s %d %d\t%s\n", ce
->ce_mode
,
797 oid_to_hex(&ce
->oid
), ce_stage(ce
),
798 needs_cloning
, ce
->name
);
799 string_list_append(&suc
->projectlines
, sb
.buf
);
806 child
->stdout_to_stderr
= 1;
808 argv_array_push(&child
->args
, "submodule--helper");
809 argv_array_push(&child
->args
, "clone");
811 argv_array_push(&child
->args
, "--progress");
813 argv_array_push(&child
->args
, "--quiet");
815 argv_array_pushl(&child
->args
, "--prefix", suc
->prefix
, NULL
);
816 if (suc
->recommend_shallow
&& sub
->recommend_shallow
== 1)
817 argv_array_push(&child
->args
, "--depth=1");
818 argv_array_pushl(&child
->args
, "--path", sub
->path
, NULL
);
819 argv_array_pushl(&child
->args
, "--name", sub
->name
, NULL
);
820 argv_array_pushl(&child
->args
, "--url", url
, NULL
);
821 if (suc
->references
.nr
) {
822 struct string_list_item
*item
;
823 for_each_string_list_item(item
, &suc
->references
)
824 argv_array_pushl(&child
->args
, "--reference", item
->string
, NULL
);
827 argv_array_push(&child
->args
, suc
->depth
);
831 strbuf_reset(&displaypath_sb
);
834 return needs_cloning
;
837 static int update_clone_get_next_task(struct child_process
*child
,
842 struct submodule_update_clone
*suc
= suc_cb
;
843 const struct cache_entry
*ce
;
846 for (; suc
->current
< suc
->list
.nr
; suc
->current
++) {
847 ce
= suc
->list
.entries
[suc
->current
];
848 if (prepare_to_clone_next_submodule(ce
, child
, suc
, err
)) {
849 int *p
= xmalloc(sizeof(*p
));
858 * The loop above tried cloning each submodule once, now try the
859 * stragglers again, which we can imagine as an extension of the
862 index
= suc
->current
- suc
->list
.nr
;
863 if (index
< suc
->failed_clones_nr
) {
865 ce
= suc
->failed_clones
[index
];
866 if (!prepare_to_clone_next_submodule(ce
, child
, suc
, err
)) {
868 strbuf_addstr(err
, "BUG: submodule considered for "
869 "cloning, doesn't need cloning "
873 p
= xmalloc(sizeof(*p
));
883 static int update_clone_start_failure(struct strbuf
*err
,
887 struct submodule_update_clone
*suc
= suc_cb
;
892 static int update_clone_task_finished(int result
,
897 const struct cache_entry
*ce
;
898 struct submodule_update_clone
*suc
= suc_cb
;
900 int *idxP
= *(int**)idx_task_cb
;
907 if (idx
< suc
->list
.nr
) {
908 ce
= suc
->list
.entries
[idx
];
909 strbuf_addf(err
, _("Failed to clone '%s'. Retry scheduled"),
911 strbuf_addch(err
, '\n');
912 ALLOC_GROW(suc
->failed_clones
,
913 suc
->failed_clones_nr
+ 1,
914 suc
->failed_clones_alloc
);
915 suc
->failed_clones
[suc
->failed_clones_nr
++] = ce
;
919 ce
= suc
->failed_clones
[idx
];
920 strbuf_addf(err
, _("Failed to clone '%s' a second time, aborting"),
922 strbuf_addch(err
, '\n');
930 static int update_clone(int argc
, const char **argv
, const char *prefix
)
932 const char *update
= NULL
;
934 struct string_list_item
*item
;
935 struct pathspec pathspec
;
936 struct submodule_update_clone suc
= SUBMODULE_UPDATE_CLONE_INIT
;
938 struct option module_update_clone_options
[] = {
939 OPT_STRING(0, "prefix", &prefix
,
941 N_("path into the working tree")),
942 OPT_STRING(0, "recursive-prefix", &suc
.recursive_prefix
,
944 N_("path into the working tree, across nested "
945 "submodule boundaries")),
946 OPT_STRING(0, "update", &update
,
948 N_("rebase, merge, checkout or none")),
949 OPT_STRING_LIST(0, "reference", &suc
.references
, N_("repo"),
950 N_("reference repository")),
951 OPT_STRING(0, "depth", &suc
.depth
, "<depth>",
952 N_("Create a shallow clone truncated to the "
953 "specified number of revisions")),
954 OPT_INTEGER('j', "jobs", &max_jobs
,
955 N_("parallel jobs")),
956 OPT_BOOL(0, "recommend-shallow", &suc
.recommend_shallow
,
957 N_("whether the initial clone should follow the shallow recommendation")),
958 OPT__QUIET(&suc
.quiet
, N_("don't print cloning progress")),
959 OPT_BOOL(0, "progress", &suc
.progress
,
960 N_("force cloning progress")),
964 const char *const git_submodule_helper_usage
[] = {
965 N_("git submodule--helper update_clone [--prefix=<path>] [<path>...]"),
970 argc
= parse_options(argc
, argv
, prefix
, module_update_clone_options
,
971 git_submodule_helper_usage
, 0);
974 if (parse_submodule_update_strategy(update
, &suc
.update
) < 0)
975 die(_("bad value for update parameter"));
977 if (module_list_compute(argc
, argv
, prefix
, &pathspec
, &suc
.list
) < 0)
981 suc
.warn_if_uninitialized
= 1;
983 /* Overlay the parsed .gitmodules file with .git/config */
985 git_config(submodule_config
, NULL
);
988 max_jobs
= parallel_submodules();
990 run_processes_parallel(max_jobs
,
991 update_clone_get_next_task
,
992 update_clone_start_failure
,
993 update_clone_task_finished
,
997 * We saved the output and put it out all at once now.
999 * - the listener does not have to interleave their (checkout)
1000 * work with our fetching. The writes involved in a
1001 * checkout involve more straightforward sequential I/O.
1002 * - the listener can avoid doing any work if fetching failed.
1007 for_each_string_list_item(item
, &suc
.projectlines
)
1008 utf8_fprintf(stdout
, "%s", item
->string
);
1013 static int resolve_relative_path(int argc
, const char **argv
, const char *prefix
)
1015 struct strbuf sb
= STRBUF_INIT
;
1017 die("submodule--helper relative-path takes exactly 2 arguments, got %d", argc
);
1019 printf("%s", relative_path(argv
[1], argv
[2], &sb
));
1020 strbuf_release(&sb
);
1024 static const char *remote_submodule_branch(const char *path
)
1026 const struct submodule
*sub
;
1027 gitmodules_config();
1028 git_config(submodule_config
, NULL
);
1030 sub
= submodule_from_path(null_sha1
, path
);
1037 if (!strcmp(sub
->branch
, ".")) {
1038 unsigned char sha1
[20];
1039 const char *refname
= resolve_ref_unsafe("HEAD", 0, sha1
, NULL
);
1042 die(_("No such ref: %s"), "HEAD");
1045 if (!strcmp(refname
, "HEAD"))
1046 die(_("Submodule (%s) branch configured to inherit "
1047 "branch from superproject, but the superproject "
1048 "is not on any branch"), sub
->name
);
1050 if (!skip_prefix(refname
, "refs/heads/", &refname
))
1051 die(_("Expecting a full ref name, got %s"), refname
);
1058 static int resolve_remote_submodule_branch(int argc
, const char **argv
,
1062 struct strbuf sb
= STRBUF_INIT
;
1064 die("submodule--helper remote-branch takes exactly one arguments, got %d", argc
);
1066 ret
= remote_submodule_branch(argv
[1]);
1068 die("submodule %s doesn't exist", argv
[1]);
1071 strbuf_release(&sb
);
1077 int (*fn
)(int, const char **, const char *);
1080 static struct cmd_struct commands
[] = {
1081 {"list", module_list
},
1082 {"name", module_name
},
1083 {"clone", module_clone
},
1084 {"update-clone", update_clone
},
1085 {"relative-path", resolve_relative_path
},
1086 {"resolve-relative-url", resolve_relative_url
},
1087 {"resolve-relative-url-test", resolve_relative_url_test
},
1088 {"init", module_init
},
1089 {"remote-branch", resolve_remote_submodule_branch
}
1092 int cmd_submodule__helper(int argc
, const char **argv
, const char *prefix
)
1096 die(_("submodule--helper subcommand must be "
1097 "called with a subcommand"));
1099 for (i
= 0; i
< ARRAY_SIZE(commands
); i
++)
1100 if (!strcmp(argv
[1], commands
[i
].cmd
))
1101 return commands
[i
].fn(argc
- 1, argv
+ 1, prefix
);
1103 die(_("'%s' is not a valid submodule--helper "
1104 "subcommand"), argv
[1]);