submodule: add --dissociate option to add/update commands
[git/debian.git] / builtin / submodule--helper.c
bloba85b30419e97da9e2421df6727a352c194cff8d7
1 #include "builtin.h"
2 #include "repository.h"
3 #include "cache.h"
4 #include "config.h"
5 #include "parse-options.h"
6 #include "quote.h"
7 #include "pathspec.h"
8 #include "dir.h"
9 #include "submodule.h"
10 #include "submodule-config.h"
11 #include "string-list.h"
12 #include "run-command.h"
13 #include "remote.h"
14 #include "refs.h"
15 #include "connect.h"
16 #include "revision.h"
17 #include "diffcore.h"
18 #include "diff.h"
20 #define OPT_QUIET (1 << 0)
21 #define OPT_CACHED (1 << 1)
22 #define OPT_RECURSIVE (1 << 2)
23 #define OPT_FORCE (1 << 3)
25 typedef void (*each_submodule_fn)(const struct cache_entry *list_item,
26 void *cb_data);
28 static char *get_default_remote(void)
30 char *dest = NULL, *ret;
31 struct strbuf sb = STRBUF_INIT;
32 const char *refname = resolve_ref_unsafe("HEAD", 0, NULL, NULL);
34 if (!refname)
35 die(_("No such ref: %s"), "HEAD");
37 /* detached HEAD */
38 if (!strcmp(refname, "HEAD"))
39 return xstrdup("origin");
41 if (!skip_prefix(refname, "refs/heads/", &refname))
42 die(_("Expecting a full ref name, got %s"), refname);
44 strbuf_addf(&sb, "branch.%s.remote", refname);
45 if (git_config_get_string(sb.buf, &dest))
46 ret = xstrdup("origin");
47 else
48 ret = dest;
50 strbuf_release(&sb);
51 return ret;
54 static int print_default_remote(int argc, const char **argv, const char *prefix)
56 const char *remote;
58 if (argc != 1)
59 die(_("submodule--helper print-default-remote takes no arguments"));
61 remote = get_default_remote();
62 if (remote)
63 printf("%s\n", remote);
65 return 0;
68 static int starts_with_dot_slash(const char *str)
70 return str[0] == '.' && is_dir_sep(str[1]);
73 static int starts_with_dot_dot_slash(const char *str)
75 return str[0] == '.' && str[1] == '.' && is_dir_sep(str[2]);
79 * Returns 1 if it was the last chop before ':'.
81 static int chop_last_dir(char **remoteurl, int is_relative)
83 char *rfind = find_last_dir_sep(*remoteurl);
84 if (rfind) {
85 *rfind = '\0';
86 return 0;
89 rfind = strrchr(*remoteurl, ':');
90 if (rfind) {
91 *rfind = '\0';
92 return 1;
95 if (is_relative || !strcmp(".", *remoteurl))
96 die(_("cannot strip one component off url '%s'"),
97 *remoteurl);
99 free(*remoteurl);
100 *remoteurl = xstrdup(".");
101 return 0;
105 * The `url` argument is the URL that navigates to the submodule origin
106 * repo. When relative, this URL is relative to the superproject origin
107 * URL repo. The `up_path` argument, if specified, is the relative
108 * path that navigates from the submodule working tree to the superproject
109 * working tree. Returns the origin URL of the submodule.
111 * Return either an absolute URL or filesystem path (if the superproject
112 * origin URL is an absolute URL or filesystem path, respectively) or a
113 * relative file system path (if the superproject origin URL is a relative
114 * file system path).
116 * When the output is a relative file system path, the path is either
117 * relative to the submodule working tree, if up_path is specified, or to
118 * the superproject working tree otherwise.
120 * NEEDSWORK: This works incorrectly on the domain and protocol part.
121 * remote_url url outcome expectation
122 * http://a.com/b ../c http://a.com/c as is
123 * http://a.com/b/ ../c http://a.com/c same as previous line, but
124 * ignore trailing slash in url
125 * http://a.com/b ../../c http://c error out
126 * http://a.com/b ../../../c http:/c error out
127 * http://a.com/b ../../../../c http:c error out
128 * http://a.com/b ../../../../../c .:c error out
129 * NEEDSWORK: Given how chop_last_dir() works, this function is broken
130 * when a local part has a colon in its path component, too.
132 static char *relative_url(const char *remote_url,
133 const char *url,
134 const char *up_path)
136 int is_relative = 0;
137 int colonsep = 0;
138 char *out;
139 char *remoteurl = xstrdup(remote_url);
140 struct strbuf sb = STRBUF_INIT;
141 size_t len = strlen(remoteurl);
143 if (is_dir_sep(remoteurl[len-1]))
144 remoteurl[len-1] = '\0';
146 if (!url_is_local_not_ssh(remoteurl) || is_absolute_path(remoteurl))
147 is_relative = 0;
148 else {
149 is_relative = 1;
151 * Prepend a './' to ensure all relative
152 * remoteurls start with './' or '../'
154 if (!starts_with_dot_slash(remoteurl) &&
155 !starts_with_dot_dot_slash(remoteurl)) {
156 strbuf_reset(&sb);
157 strbuf_addf(&sb, "./%s", remoteurl);
158 free(remoteurl);
159 remoteurl = strbuf_detach(&sb, NULL);
163 * When the url starts with '../', remove that and the
164 * last directory in remoteurl.
166 while (url) {
167 if (starts_with_dot_dot_slash(url)) {
168 url += 3;
169 colonsep |= chop_last_dir(&remoteurl, is_relative);
170 } else if (starts_with_dot_slash(url))
171 url += 2;
172 else
173 break;
175 strbuf_reset(&sb);
176 strbuf_addf(&sb, "%s%s%s", remoteurl, colonsep ? ":" : "/", url);
177 if (ends_with(url, "/"))
178 strbuf_setlen(&sb, sb.len - 1);
179 free(remoteurl);
181 if (starts_with_dot_slash(sb.buf))
182 out = xstrdup(sb.buf + 2);
183 else
184 out = xstrdup(sb.buf);
185 strbuf_reset(&sb);
187 if (!up_path || !is_relative)
188 return out;
190 strbuf_addf(&sb, "%s%s", up_path, out);
191 free(out);
192 return strbuf_detach(&sb, NULL);
195 static int resolve_relative_url(int argc, const char **argv, const char *prefix)
197 char *remoteurl = NULL;
198 char *remote = get_default_remote();
199 const char *up_path = NULL;
200 char *res;
201 const char *url;
202 struct strbuf sb = STRBUF_INIT;
204 if (argc != 2 && argc != 3)
205 die("resolve-relative-url only accepts one or two arguments");
207 url = argv[1];
208 strbuf_addf(&sb, "remote.%s.url", remote);
209 free(remote);
211 if (git_config_get_string(sb.buf, &remoteurl))
212 /* the repository is its own authoritative upstream */
213 remoteurl = xgetcwd();
215 if (argc == 3)
216 up_path = argv[2];
218 res = relative_url(remoteurl, url, up_path);
219 puts(res);
220 free(res);
221 free(remoteurl);
222 return 0;
225 static int resolve_relative_url_test(int argc, const char **argv, const char *prefix)
227 char *remoteurl, *res;
228 const char *up_path, *url;
230 if (argc != 4)
231 die("resolve-relative-url-test only accepts three arguments: <up_path> <remoteurl> <url>");
233 up_path = argv[1];
234 remoteurl = xstrdup(argv[2]);
235 url = argv[3];
237 if (!strcmp(up_path, "(null)"))
238 up_path = NULL;
240 res = relative_url(remoteurl, url, up_path);
241 puts(res);
242 free(res);
243 free(remoteurl);
244 return 0;
247 /* the result should be freed by the caller. */
248 static char *get_submodule_displaypath(const char *path, const char *prefix)
250 const char *super_prefix = get_super_prefix();
252 if (prefix && super_prefix) {
253 BUG("cannot have prefix '%s' and superprefix '%s'",
254 prefix, super_prefix);
255 } else if (prefix) {
256 struct strbuf sb = STRBUF_INIT;
257 char *displaypath = xstrdup(relative_path(path, prefix, &sb));
258 strbuf_release(&sb);
259 return displaypath;
260 } else if (super_prefix) {
261 return xstrfmt("%s%s", super_prefix, path);
262 } else {
263 return xstrdup(path);
267 static char *compute_rev_name(const char *sub_path, const char* object_id)
269 struct strbuf sb = STRBUF_INIT;
270 const char ***d;
272 static const char *describe_bare[] = { NULL };
274 static const char *describe_tags[] = { "--tags", NULL };
276 static const char *describe_contains[] = { "--contains", NULL };
278 static const char *describe_all_always[] = { "--all", "--always", NULL };
280 static const char **describe_argv[] = { describe_bare, describe_tags,
281 describe_contains,
282 describe_all_always, NULL };
284 for (d = describe_argv; *d; d++) {
285 struct child_process cp = CHILD_PROCESS_INIT;
286 prepare_submodule_repo_env(&cp.env_array);
287 cp.dir = sub_path;
288 cp.git_cmd = 1;
289 cp.no_stderr = 1;
291 argv_array_push(&cp.args, "describe");
292 argv_array_pushv(&cp.args, *d);
293 argv_array_push(&cp.args, object_id);
295 if (!capture_command(&cp, &sb, 0)) {
296 strbuf_strip_suffix(&sb, "\n");
297 return strbuf_detach(&sb, NULL);
301 strbuf_release(&sb);
302 return NULL;
305 struct module_list {
306 const struct cache_entry **entries;
307 int alloc, nr;
309 #define MODULE_LIST_INIT { NULL, 0, 0 }
311 static int module_list_compute(int argc, const char **argv,
312 const char *prefix,
313 struct pathspec *pathspec,
314 struct module_list *list)
316 int i, result = 0;
317 char *ps_matched = NULL;
318 parse_pathspec(pathspec, 0,
319 PATHSPEC_PREFER_FULL,
320 prefix, argv);
322 if (pathspec->nr)
323 ps_matched = xcalloc(pathspec->nr, 1);
325 if (read_cache() < 0)
326 die(_("index file corrupt"));
328 for (i = 0; i < active_nr; i++) {
329 const struct cache_entry *ce = active_cache[i];
331 if (!match_pathspec(pathspec, ce->name, ce_namelen(ce),
332 0, ps_matched, 1) ||
333 !S_ISGITLINK(ce->ce_mode))
334 continue;
336 ALLOC_GROW(list->entries, list->nr + 1, list->alloc);
337 list->entries[list->nr++] = ce;
338 while (i + 1 < active_nr &&
339 !strcmp(ce->name, active_cache[i + 1]->name))
341 * Skip entries with the same name in different stages
342 * to make sure an entry is returned only once.
344 i++;
347 if (ps_matched && report_path_error(ps_matched, pathspec, prefix))
348 result = -1;
350 free(ps_matched);
352 return result;
355 static void module_list_active(struct module_list *list)
357 int i;
358 struct module_list active_modules = MODULE_LIST_INIT;
360 for (i = 0; i < list->nr; i++) {
361 const struct cache_entry *ce = list->entries[i];
363 if (!is_submodule_active(the_repository, ce->name))
364 continue;
366 ALLOC_GROW(active_modules.entries,
367 active_modules.nr + 1,
368 active_modules.alloc);
369 active_modules.entries[active_modules.nr++] = ce;
372 free(list->entries);
373 *list = active_modules;
376 static char *get_up_path(const char *path)
378 int i;
379 struct strbuf sb = STRBUF_INIT;
381 for (i = count_slashes(path); i; i--)
382 strbuf_addstr(&sb, "../");
385 * Check if 'path' ends with slash or not
386 * for having the same output for dir/sub_dir
387 * and dir/sub_dir/
389 if (!is_dir_sep(path[strlen(path) - 1]))
390 strbuf_addstr(&sb, "../");
392 return strbuf_detach(&sb, NULL);
395 static int module_list(int argc, const char **argv, const char *prefix)
397 int i;
398 struct pathspec pathspec;
399 struct module_list list = MODULE_LIST_INIT;
401 struct option module_list_options[] = {
402 OPT_STRING(0, "prefix", &prefix,
403 N_("path"),
404 N_("alternative anchor for relative paths")),
405 OPT_END()
408 const char *const git_submodule_helper_usage[] = {
409 N_("git submodule--helper list [--prefix=<path>] [<path>...]"),
410 NULL
413 argc = parse_options(argc, argv, prefix, module_list_options,
414 git_submodule_helper_usage, 0);
416 if (module_list_compute(argc, argv, prefix, &pathspec, &list) < 0)
417 return 1;
419 for (i = 0; i < list.nr; i++) {
420 const struct cache_entry *ce = list.entries[i];
422 if (ce_stage(ce))
423 printf("%06o %s U\t", ce->ce_mode, sha1_to_hex(null_sha1));
424 else
425 printf("%06o %s %d\t", ce->ce_mode,
426 oid_to_hex(&ce->oid), ce_stage(ce));
428 fprintf(stdout, "%s\n", ce->name);
430 return 0;
433 static void for_each_listed_submodule(const struct module_list *list,
434 each_submodule_fn fn, void *cb_data)
436 int i;
437 for (i = 0; i < list->nr; i++)
438 fn(list->entries[i], cb_data);
441 struct init_cb {
442 const char *prefix;
443 unsigned int flags;
446 #define INIT_CB_INIT { NULL, 0 }
448 static void init_submodule(const char *path, const char *prefix,
449 unsigned int flags)
451 const struct submodule *sub;
452 struct strbuf sb = STRBUF_INIT;
453 char *upd = NULL, *url = NULL, *displaypath;
455 displaypath = get_submodule_displaypath(path, prefix);
457 sub = submodule_from_path(&null_oid, path);
459 if (!sub)
460 die(_("No url found for submodule path '%s' in .gitmodules"),
461 displaypath);
464 * NEEDSWORK: In a multi-working-tree world, this needs to be
465 * set in the per-worktree config.
467 * Set active flag for the submodule being initialized
469 if (!is_submodule_active(the_repository, path)) {
470 strbuf_addf(&sb, "submodule.%s.active", sub->name);
471 git_config_set_gently(sb.buf, "true");
472 strbuf_reset(&sb);
476 * Copy url setting when it is not set yet.
477 * To look up the url in .git/config, we must not fall back to
478 * .gitmodules, so look it up directly.
480 strbuf_addf(&sb, "submodule.%s.url", sub->name);
481 if (git_config_get_string(sb.buf, &url)) {
482 if (!sub->url)
483 die(_("No url found for submodule path '%s' in .gitmodules"),
484 displaypath);
486 url = xstrdup(sub->url);
488 /* Possibly a url relative to parent */
489 if (starts_with_dot_dot_slash(url) ||
490 starts_with_dot_slash(url)) {
491 char *remoteurl, *relurl;
492 char *remote = get_default_remote();
493 struct strbuf remotesb = STRBUF_INIT;
494 strbuf_addf(&remotesb, "remote.%s.url", remote);
495 free(remote);
497 if (git_config_get_string(remotesb.buf, &remoteurl)) {
498 warning(_("could not lookup configuration '%s'. Assuming this repository is its own authoritative upstream."), remotesb.buf);
499 remoteurl = xgetcwd();
501 relurl = relative_url(remoteurl, url, NULL);
502 strbuf_release(&remotesb);
503 free(remoteurl);
504 free(url);
505 url = relurl;
508 if (git_config_set_gently(sb.buf, url))
509 die(_("Failed to register url for submodule path '%s'"),
510 displaypath);
511 if (!(flags & OPT_QUIET))
512 fprintf(stderr,
513 _("Submodule '%s' (%s) registered for path '%s'\n"),
514 sub->name, url, displaypath);
516 strbuf_reset(&sb);
518 /* Copy "update" setting when it is not set yet */
519 strbuf_addf(&sb, "submodule.%s.update", sub->name);
520 if (git_config_get_string(sb.buf, &upd) &&
521 sub->update_strategy.type != SM_UPDATE_UNSPECIFIED) {
522 if (sub->update_strategy.type == SM_UPDATE_COMMAND) {
523 fprintf(stderr, _("warning: command update mode suggested for submodule '%s'\n"),
524 sub->name);
525 upd = xstrdup("none");
526 } else
527 upd = xstrdup(submodule_strategy_to_string(&sub->update_strategy));
529 if (git_config_set_gently(sb.buf, upd))
530 die(_("Failed to register update mode for submodule path '%s'"), displaypath);
532 strbuf_release(&sb);
533 free(displaypath);
534 free(url);
535 free(upd);
538 static void init_submodule_cb(const struct cache_entry *list_item, void *cb_data)
540 struct init_cb *info = cb_data;
541 init_submodule(list_item->name, info->prefix, info->flags);
544 static int module_init(int argc, const char **argv, const char *prefix)
546 struct init_cb info = INIT_CB_INIT;
547 struct pathspec pathspec;
548 struct module_list list = MODULE_LIST_INIT;
549 int quiet = 0;
551 struct option module_init_options[] = {
552 OPT__QUIET(&quiet, N_("Suppress output for initializing a submodule")),
553 OPT_END()
556 const char *const git_submodule_helper_usage[] = {
557 N_("git submodule--helper init [<path>]"),
558 NULL
561 argc = parse_options(argc, argv, prefix, module_init_options,
562 git_submodule_helper_usage, 0);
564 if (module_list_compute(argc, argv, prefix, &pathspec, &list) < 0)
565 return 1;
568 * If there are no path args and submodule.active is set then,
569 * by default, only initialize 'active' modules.
571 if (!argc && git_config_get_value_multi("submodule.active"))
572 module_list_active(&list);
574 info.prefix = prefix;
575 if (quiet)
576 info.flags |= OPT_QUIET;
578 for_each_listed_submodule(&list, init_submodule_cb, &info);
580 return 0;
583 struct status_cb {
584 const char *prefix;
585 unsigned int flags;
588 #define STATUS_CB_INIT { NULL, 0 }
590 static void print_status(unsigned int flags, char state, const char *path,
591 const struct object_id *oid, const char *displaypath)
593 if (flags & OPT_QUIET)
594 return;
596 printf("%c%s %s", state, oid_to_hex(oid), displaypath);
598 if (state == ' ' || state == '+')
599 printf(" (%s)", compute_rev_name(path, oid_to_hex(oid)));
601 printf("\n");
604 static int handle_submodule_head_ref(const char *refname,
605 const struct object_id *oid, int flags,
606 void *cb_data)
608 struct object_id *output = cb_data;
609 if (oid)
610 oidcpy(output, oid);
612 return 0;
615 static void status_submodule(const char *path, const struct object_id *ce_oid,
616 unsigned int ce_flags, const char *prefix,
617 unsigned int flags)
619 char *displaypath;
620 struct argv_array diff_files_args = ARGV_ARRAY_INIT;
621 struct rev_info rev;
622 int diff_files_result;
624 if (!submodule_from_path(&null_oid, path))
625 die(_("no submodule mapping found in .gitmodules for path '%s'"),
626 path);
628 displaypath = get_submodule_displaypath(path, prefix);
630 if ((CE_STAGEMASK & ce_flags) >> CE_STAGESHIFT) {
631 print_status(flags, 'U', path, &null_oid, displaypath);
632 goto cleanup;
635 if (!is_submodule_active(the_repository, path)) {
636 print_status(flags, '-', path, ce_oid, displaypath);
637 goto cleanup;
640 argv_array_pushl(&diff_files_args, "diff-files",
641 "--ignore-submodules=dirty", "--quiet", "--",
642 path, NULL);
644 git_config(git_diff_basic_config, NULL);
645 init_revisions(&rev, prefix);
646 rev.abbrev = 0;
647 diff_files_args.argc = setup_revisions(diff_files_args.argc,
648 diff_files_args.argv,
649 &rev, NULL);
650 diff_files_result = run_diff_files(&rev, 0);
652 if (!diff_result_code(&rev.diffopt, diff_files_result)) {
653 print_status(flags, ' ', path, ce_oid,
654 displaypath);
655 } else if (!(flags & OPT_CACHED)) {
656 struct object_id oid;
658 if (refs_head_ref(get_submodule_ref_store(path),
659 handle_submodule_head_ref, &oid))
660 die(_("could not resolve HEAD ref inside the "
661 "submodule '%s'"), path);
663 print_status(flags, '+', path, &oid, displaypath);
664 } else {
665 print_status(flags, '+', path, ce_oid, displaypath);
668 if (flags & OPT_RECURSIVE) {
669 struct child_process cpr = CHILD_PROCESS_INIT;
671 cpr.git_cmd = 1;
672 cpr.dir = path;
673 prepare_submodule_repo_env(&cpr.env_array);
675 argv_array_push(&cpr.args, "--super-prefix");
676 argv_array_pushf(&cpr.args, "%s/", displaypath);
677 argv_array_pushl(&cpr.args, "submodule--helper", "status",
678 "--recursive", NULL);
680 if (flags & OPT_CACHED)
681 argv_array_push(&cpr.args, "--cached");
683 if (flags & OPT_QUIET)
684 argv_array_push(&cpr.args, "--quiet");
686 if (run_command(&cpr))
687 die(_("failed to recurse into submodule '%s'"), path);
690 cleanup:
691 argv_array_clear(&diff_files_args);
692 free(displaypath);
695 static void status_submodule_cb(const struct cache_entry *list_item,
696 void *cb_data)
698 struct status_cb *info = cb_data;
699 status_submodule(list_item->name, &list_item->oid, list_item->ce_flags,
700 info->prefix, info->flags);
703 static int module_status(int argc, const char **argv, const char *prefix)
705 struct status_cb info = STATUS_CB_INIT;
706 struct pathspec pathspec;
707 struct module_list list = MODULE_LIST_INIT;
708 int quiet = 0;
710 struct option module_status_options[] = {
711 OPT__QUIET(&quiet, N_("Suppress submodule status output")),
712 OPT_BIT(0, "cached", &info.flags, N_("Use commit stored in the index instead of the one stored in the submodule HEAD"), OPT_CACHED),
713 OPT_BIT(0, "recursive", &info.flags, N_("recurse into nested submodules"), OPT_RECURSIVE),
714 OPT_END()
717 const char *const git_submodule_helper_usage[] = {
718 N_("git submodule status [--quiet] [--cached] [--recursive] [<path>...]"),
719 NULL
722 argc = parse_options(argc, argv, prefix, module_status_options,
723 git_submodule_helper_usage, 0);
725 if (module_list_compute(argc, argv, prefix, &pathspec, &list) < 0)
726 return 1;
728 info.prefix = prefix;
729 if (quiet)
730 info.flags |= OPT_QUIET;
732 for_each_listed_submodule(&list, status_submodule_cb, &info);
734 return 0;
737 static int module_name(int argc, const char **argv, const char *prefix)
739 const struct submodule *sub;
741 if (argc != 2)
742 usage(_("git submodule--helper name <path>"));
744 sub = submodule_from_path(&null_oid, argv[1]);
746 if (!sub)
747 die(_("no submodule mapping found in .gitmodules for path '%s'"),
748 argv[1]);
750 printf("%s\n", sub->name);
752 return 0;
755 struct sync_cb {
756 const char *prefix;
757 unsigned int flags;
760 #define SYNC_CB_INIT { NULL, 0 }
762 static void sync_submodule(const char *path, const char *prefix,
763 unsigned int flags)
765 const struct submodule *sub;
766 char *remote_key = NULL;
767 char *sub_origin_url, *super_config_url, *displaypath;
768 struct strbuf sb = STRBUF_INIT;
769 struct child_process cp = CHILD_PROCESS_INIT;
770 char *sub_config_path = NULL;
772 if (!is_submodule_active(the_repository, path))
773 return;
775 sub = submodule_from_path(&null_oid, path);
777 if (sub && sub->url) {
778 if (starts_with_dot_dot_slash(sub->url) ||
779 starts_with_dot_slash(sub->url)) {
780 char *remote_url, *up_path;
781 char *remote = get_default_remote();
782 strbuf_addf(&sb, "remote.%s.url", remote);
784 if (git_config_get_string(sb.buf, &remote_url))
785 remote_url = xgetcwd();
787 up_path = get_up_path(path);
788 sub_origin_url = relative_url(remote_url, sub->url, up_path);
789 super_config_url = relative_url(remote_url, sub->url, NULL);
791 free(remote);
792 free(up_path);
793 free(remote_url);
794 } else {
795 sub_origin_url = xstrdup(sub->url);
796 super_config_url = xstrdup(sub->url);
798 } else {
799 sub_origin_url = xstrdup("");
800 super_config_url = xstrdup("");
803 displaypath = get_submodule_displaypath(path, prefix);
805 if (!(flags & OPT_QUIET))
806 printf(_("Synchronizing submodule url for '%s'\n"),
807 displaypath);
809 strbuf_reset(&sb);
810 strbuf_addf(&sb, "submodule.%s.url", sub->name);
811 if (git_config_set_gently(sb.buf, super_config_url))
812 die(_("failed to register url for submodule path '%s'"),
813 displaypath);
815 if (!is_submodule_populated_gently(path, NULL))
816 goto cleanup;
818 prepare_submodule_repo_env(&cp.env_array);
819 cp.git_cmd = 1;
820 cp.dir = path;
821 argv_array_pushl(&cp.args, "submodule--helper",
822 "print-default-remote", NULL);
824 strbuf_reset(&sb);
825 if (capture_command(&cp, &sb, 0))
826 die(_("failed to get the default remote for submodule '%s'"),
827 path);
829 strbuf_strip_suffix(&sb, "\n");
830 remote_key = xstrfmt("remote.%s.url", sb.buf);
832 strbuf_reset(&sb);
833 submodule_to_gitdir(&sb, path);
834 strbuf_addstr(&sb, "/config");
836 if (git_config_set_in_file_gently(sb.buf, remote_key, sub_origin_url))
837 die(_("failed to update remote for submodule '%s'"),
838 path);
840 if (flags & OPT_RECURSIVE) {
841 struct child_process cpr = CHILD_PROCESS_INIT;
843 cpr.git_cmd = 1;
844 cpr.dir = path;
845 prepare_submodule_repo_env(&cpr.env_array);
847 argv_array_push(&cpr.args, "--super-prefix");
848 argv_array_pushf(&cpr.args, "%s/", displaypath);
849 argv_array_pushl(&cpr.args, "submodule--helper", "sync",
850 "--recursive", NULL);
852 if (flags & OPT_QUIET)
853 argv_array_push(&cpr.args, "--quiet");
855 if (run_command(&cpr))
856 die(_("failed to recurse into submodule '%s'"),
857 path);
860 cleanup:
861 free(super_config_url);
862 free(sub_origin_url);
863 strbuf_release(&sb);
864 free(remote_key);
865 free(displaypath);
866 free(sub_config_path);
869 static void sync_submodule_cb(const struct cache_entry *list_item, void *cb_data)
871 struct sync_cb *info = cb_data;
872 sync_submodule(list_item->name, info->prefix, info->flags);
876 static int module_sync(int argc, const char **argv, const char *prefix)
878 struct sync_cb info = SYNC_CB_INIT;
879 struct pathspec pathspec;
880 struct module_list list = MODULE_LIST_INIT;
881 int quiet = 0;
882 int recursive = 0;
884 struct option module_sync_options[] = {
885 OPT__QUIET(&quiet, N_("Suppress output of synchronizing submodule url")),
886 OPT_BOOL(0, "recursive", &recursive,
887 N_("Recurse into nested submodules")),
888 OPT_END()
891 const char *const git_submodule_helper_usage[] = {
892 N_("git submodule--helper sync [--quiet] [--recursive] [<path>]"),
893 NULL
896 argc = parse_options(argc, argv, prefix, module_sync_options,
897 git_submodule_helper_usage, 0);
899 if (module_list_compute(argc, argv, prefix, &pathspec, &list) < 0)
900 return 1;
902 info.prefix = prefix;
903 if (quiet)
904 info.flags |= OPT_QUIET;
905 if (recursive)
906 info.flags |= OPT_RECURSIVE;
908 for_each_listed_submodule(&list, sync_submodule_cb, &info);
910 return 0;
913 struct deinit_cb {
914 const char *prefix;
915 unsigned int flags;
917 #define DEINIT_CB_INIT { NULL, 0 }
919 static void deinit_submodule(const char *path, const char *prefix,
920 unsigned int flags)
922 const struct submodule *sub;
923 char *displaypath = NULL;
924 struct child_process cp_config = CHILD_PROCESS_INIT;
925 struct strbuf sb_config = STRBUF_INIT;
926 char *sub_git_dir = xstrfmt("%s/.git", path);
928 sub = submodule_from_path(&null_oid, path);
930 if (!sub || !sub->name)
931 goto cleanup;
933 displaypath = get_submodule_displaypath(path, prefix);
935 /* remove the submodule work tree (unless the user already did it) */
936 if (is_directory(path)) {
937 struct strbuf sb_rm = STRBUF_INIT;
938 const char *format;
941 * protect submodules containing a .git directory
942 * NEEDSWORK: instead of dying, automatically call
943 * absorbgitdirs and (possibly) warn.
945 if (is_directory(sub_git_dir))
946 die(_("Submodule work tree '%s' contains a .git "
947 "directory (use 'rm -rf' if you really want "
948 "to remove it including all of its history)"),
949 displaypath);
951 if (!(flags & OPT_FORCE)) {
952 struct child_process cp_rm = CHILD_PROCESS_INIT;
953 cp_rm.git_cmd = 1;
954 argv_array_pushl(&cp_rm.args, "rm", "-qn",
955 path, NULL);
957 if (run_command(&cp_rm))
958 die(_("Submodule work tree '%s' contains local "
959 "modifications; use '-f' to discard them"),
960 displaypath);
963 strbuf_addstr(&sb_rm, path);
965 if (!remove_dir_recursively(&sb_rm, 0))
966 format = _("Cleared directory '%s'\n");
967 else
968 format = _("Could not remove submodule work tree '%s'\n");
970 if (!(flags & OPT_QUIET))
971 printf(format, displaypath);
973 strbuf_release(&sb_rm);
976 if (mkdir(path, 0777))
977 printf(_("could not create empty submodule directory %s"),
978 displaypath);
980 cp_config.git_cmd = 1;
981 argv_array_pushl(&cp_config.args, "config", "--get-regexp", NULL);
982 argv_array_pushf(&cp_config.args, "submodule.%s\\.", sub->name);
984 /* remove the .git/config entries (unless the user already did it) */
985 if (!capture_command(&cp_config, &sb_config, 0) && sb_config.len) {
986 char *sub_key = xstrfmt("submodule.%s", sub->name);
988 * remove the whole section so we have a clean state when
989 * the user later decides to init this submodule again
991 git_config_rename_section_in_file(NULL, sub_key, NULL);
992 if (!(flags & OPT_QUIET))
993 printf(_("Submodule '%s' (%s) unregistered for path '%s'\n"),
994 sub->name, sub->url, displaypath);
995 free(sub_key);
998 cleanup:
999 free(displaypath);
1000 free(sub_git_dir);
1001 strbuf_release(&sb_config);
1004 static void deinit_submodule_cb(const struct cache_entry *list_item,
1005 void *cb_data)
1007 struct deinit_cb *info = cb_data;
1008 deinit_submodule(list_item->name, info->prefix, info->flags);
1011 static int module_deinit(int argc, const char **argv, const char *prefix)
1013 struct deinit_cb info = DEINIT_CB_INIT;
1014 struct pathspec pathspec;
1015 struct module_list list = MODULE_LIST_INIT;
1016 int quiet = 0;
1017 int force = 0;
1018 int all = 0;
1020 struct option module_deinit_options[] = {
1021 OPT__QUIET(&quiet, N_("Suppress submodule status output")),
1022 OPT__FORCE(&force, N_("Remove submodule working trees even if they contain local changes"), 0),
1023 OPT_BOOL(0, "all", &all, N_("Unregister all submodules")),
1024 OPT_END()
1027 const char *const git_submodule_helper_usage[] = {
1028 N_("git submodule deinit [--quiet] [-f | --force] [--all | [--] [<path>...]]"),
1029 NULL
1032 argc = parse_options(argc, argv, prefix, module_deinit_options,
1033 git_submodule_helper_usage, 0);
1035 if (all && argc) {
1036 error("pathspec and --all are incompatible");
1037 usage_with_options(git_submodule_helper_usage,
1038 module_deinit_options);
1041 if (!argc && !all)
1042 die(_("Use '--all' if you really want to deinitialize all submodules"));
1044 if (module_list_compute(argc, argv, prefix, &pathspec, &list) < 0)
1045 return 1;
1047 info.prefix = prefix;
1048 if (quiet)
1049 info.flags |= OPT_QUIET;
1050 if (force)
1051 info.flags |= OPT_FORCE;
1053 for_each_listed_submodule(&list, deinit_submodule_cb, &info);
1055 return 0;
1058 static int clone_submodule(const char *path, const char *gitdir, const char *url,
1059 const char *depth, struct string_list *reference, int dissociate,
1060 int quiet, int progress)
1062 struct child_process cp = CHILD_PROCESS_INIT;
1064 argv_array_push(&cp.args, "clone");
1065 argv_array_push(&cp.args, "--no-checkout");
1066 if (quiet)
1067 argv_array_push(&cp.args, "--quiet");
1068 if (progress)
1069 argv_array_push(&cp.args, "--progress");
1070 if (depth && *depth)
1071 argv_array_pushl(&cp.args, "--depth", depth, NULL);
1072 if (reference->nr) {
1073 struct string_list_item *item;
1074 for_each_string_list_item(item, reference)
1075 argv_array_pushl(&cp.args, "--reference",
1076 item->string, NULL);
1078 if (dissociate)
1079 argv_array_push(&cp.args, "--dissociate");
1080 if (gitdir && *gitdir)
1081 argv_array_pushl(&cp.args, "--separate-git-dir", gitdir, NULL);
1083 argv_array_push(&cp.args, url);
1084 argv_array_push(&cp.args, path);
1086 cp.git_cmd = 1;
1087 prepare_submodule_repo_env(&cp.env_array);
1088 cp.no_stdin = 1;
1090 return run_command(&cp);
1093 struct submodule_alternate_setup {
1094 const char *submodule_name;
1095 enum SUBMODULE_ALTERNATE_ERROR_MODE {
1096 SUBMODULE_ALTERNATE_ERROR_DIE,
1097 SUBMODULE_ALTERNATE_ERROR_INFO,
1098 SUBMODULE_ALTERNATE_ERROR_IGNORE
1099 } error_mode;
1100 struct string_list *reference;
1102 #define SUBMODULE_ALTERNATE_SETUP_INIT { NULL, \
1103 SUBMODULE_ALTERNATE_ERROR_IGNORE, NULL }
1105 static int add_possible_reference_from_superproject(
1106 struct alternate_object_database *alt, void *sas_cb)
1108 struct submodule_alternate_setup *sas = sas_cb;
1111 * If the alternate object store is another repository, try the
1112 * standard layout with .git/(modules/<name>)+/objects
1114 if (ends_with(alt->path, "/objects")) {
1115 char *sm_alternate;
1116 struct strbuf sb = STRBUF_INIT;
1117 struct strbuf err = STRBUF_INIT;
1118 strbuf_add(&sb, alt->path, strlen(alt->path) - strlen("objects"));
1121 * We need to end the new path with '/' to mark it as a dir,
1122 * otherwise a submodule name containing '/' will be broken
1123 * as the last part of a missing submodule reference would
1124 * be taken as a file name.
1126 strbuf_addf(&sb, "modules/%s/", sas->submodule_name);
1128 sm_alternate = compute_alternate_path(sb.buf, &err);
1129 if (sm_alternate) {
1130 string_list_append(sas->reference, xstrdup(sb.buf));
1131 free(sm_alternate);
1132 } else {
1133 switch (sas->error_mode) {
1134 case SUBMODULE_ALTERNATE_ERROR_DIE:
1135 die(_("submodule '%s' cannot add alternate: %s"),
1136 sas->submodule_name, err.buf);
1137 case SUBMODULE_ALTERNATE_ERROR_INFO:
1138 fprintf(stderr, _("submodule '%s' cannot add alternate: %s"),
1139 sas->submodule_name, err.buf);
1140 case SUBMODULE_ALTERNATE_ERROR_IGNORE:
1141 ; /* nothing */
1144 strbuf_release(&sb);
1147 return 0;
1150 static void prepare_possible_alternates(const char *sm_name,
1151 struct string_list *reference)
1153 char *sm_alternate = NULL, *error_strategy = NULL;
1154 struct submodule_alternate_setup sas = SUBMODULE_ALTERNATE_SETUP_INIT;
1156 git_config_get_string("submodule.alternateLocation", &sm_alternate);
1157 if (!sm_alternate)
1158 return;
1160 git_config_get_string("submodule.alternateErrorStrategy", &error_strategy);
1162 if (!error_strategy)
1163 error_strategy = xstrdup("die");
1165 sas.submodule_name = sm_name;
1166 sas.reference = reference;
1167 if (!strcmp(error_strategy, "die"))
1168 sas.error_mode = SUBMODULE_ALTERNATE_ERROR_DIE;
1169 else if (!strcmp(error_strategy, "info"))
1170 sas.error_mode = SUBMODULE_ALTERNATE_ERROR_INFO;
1171 else if (!strcmp(error_strategy, "ignore"))
1172 sas.error_mode = SUBMODULE_ALTERNATE_ERROR_IGNORE;
1173 else
1174 die(_("Value '%s' for submodule.alternateErrorStrategy is not recognized"), error_strategy);
1176 if (!strcmp(sm_alternate, "superproject"))
1177 foreach_alt_odb(add_possible_reference_from_superproject, &sas);
1178 else if (!strcmp(sm_alternate, "no"))
1179 ; /* do nothing */
1180 else
1181 die(_("Value '%s' for submodule.alternateLocation is not recognized"), sm_alternate);
1183 free(sm_alternate);
1184 free(error_strategy);
1187 static int module_clone(int argc, const char **argv, const char *prefix)
1189 const char *name = NULL, *url = NULL, *depth = NULL;
1190 int quiet = 0;
1191 int progress = 0;
1192 char *p, *path = NULL, *sm_gitdir;
1193 struct strbuf sb = STRBUF_INIT;
1194 struct string_list reference = STRING_LIST_INIT_NODUP;
1195 int dissociate = 0;
1196 char *sm_alternate = NULL, *error_strategy = NULL;
1198 struct option module_clone_options[] = {
1199 OPT_STRING(0, "prefix", &prefix,
1200 N_("path"),
1201 N_("alternative anchor for relative paths")),
1202 OPT_STRING(0, "path", &path,
1203 N_("path"),
1204 N_("where the new submodule will be cloned to")),
1205 OPT_STRING(0, "name", &name,
1206 N_("string"),
1207 N_("name of the new submodule")),
1208 OPT_STRING(0, "url", &url,
1209 N_("string"),
1210 N_("url where to clone the submodule from")),
1211 OPT_STRING_LIST(0, "reference", &reference,
1212 N_("repo"),
1213 N_("reference repository")),
1214 OPT_BOOL(0, "dissociate", &dissociate,
1215 N_("use --reference only while cloning")),
1216 OPT_STRING(0, "depth", &depth,
1217 N_("string"),
1218 N_("depth for shallow clones")),
1219 OPT__QUIET(&quiet, "Suppress output for cloning a submodule"),
1220 OPT_BOOL(0, "progress", &progress,
1221 N_("force cloning progress")),
1222 OPT_END()
1225 const char *const git_submodule_helper_usage[] = {
1226 N_("git submodule--helper clone [--prefix=<path>] [--quiet] "
1227 "[--reference <repository>] [--name <name>] [--depth <depth>] "
1228 "--url <url> --path <path>"),
1229 NULL
1232 argc = parse_options(argc, argv, prefix, module_clone_options,
1233 git_submodule_helper_usage, 0);
1235 if (argc || !url || !path || !*path)
1236 usage_with_options(git_submodule_helper_usage,
1237 module_clone_options);
1239 strbuf_addf(&sb, "%s/modules/%s", get_git_dir(), name);
1240 sm_gitdir = absolute_pathdup(sb.buf);
1241 strbuf_reset(&sb);
1243 if (!is_absolute_path(path)) {
1244 strbuf_addf(&sb, "%s/%s", get_git_work_tree(), path);
1245 path = strbuf_detach(&sb, NULL);
1246 } else
1247 path = xstrdup(path);
1249 if (!file_exists(sm_gitdir)) {
1250 if (safe_create_leading_directories_const(sm_gitdir) < 0)
1251 die(_("could not create directory '%s'"), sm_gitdir);
1253 prepare_possible_alternates(name, &reference);
1255 if (clone_submodule(path, sm_gitdir, url, depth, &reference, dissociate,
1256 quiet, progress))
1257 die(_("clone of '%s' into submodule path '%s' failed"),
1258 url, path);
1259 } else {
1260 if (safe_create_leading_directories_const(path) < 0)
1261 die(_("could not create directory '%s'"), path);
1262 strbuf_addf(&sb, "%s/index", sm_gitdir);
1263 unlink_or_warn(sb.buf);
1264 strbuf_reset(&sb);
1267 /* Connect module worktree and git dir */
1268 connect_work_tree_and_git_dir(path, sm_gitdir);
1270 p = git_pathdup_submodule(path, "config");
1271 if (!p)
1272 die(_("could not get submodule directory for '%s'"), path);
1274 /* setup alternateLocation and alternateErrorStrategy in the cloned submodule if needed */
1275 git_config_get_string("submodule.alternateLocation", &sm_alternate);
1276 if (sm_alternate)
1277 git_config_set_in_file(p, "submodule.alternateLocation",
1278 sm_alternate);
1279 git_config_get_string("submodule.alternateErrorStrategy", &error_strategy);
1280 if (error_strategy)
1281 git_config_set_in_file(p, "submodule.alternateErrorStrategy",
1282 error_strategy);
1284 free(sm_alternate);
1285 free(error_strategy);
1287 strbuf_release(&sb);
1288 free(sm_gitdir);
1289 free(path);
1290 free(p);
1291 return 0;
1294 struct submodule_update_clone {
1295 /* index into 'list', the list of submodules to look into for cloning */
1296 int current;
1297 struct module_list list;
1298 unsigned warn_if_uninitialized : 1;
1300 /* update parameter passed via commandline */
1301 struct submodule_update_strategy update;
1303 /* configuration parameters which are passed on to the children */
1304 int progress;
1305 int quiet;
1306 int recommend_shallow;
1307 struct string_list references;
1308 int dissociate;
1309 const char *depth;
1310 const char *recursive_prefix;
1311 const char *prefix;
1313 /* Machine-readable status lines to be consumed by git-submodule.sh */
1314 struct string_list projectlines;
1316 /* If we want to stop as fast as possible and return an error */
1317 unsigned quickstop : 1;
1319 /* failed clones to be retried again */
1320 const struct cache_entry **failed_clones;
1321 int failed_clones_nr, failed_clones_alloc;
1323 #define SUBMODULE_UPDATE_CLONE_INIT {0, MODULE_LIST_INIT, 0, \
1324 SUBMODULE_UPDATE_STRATEGY_INIT, 0, 0, -1, STRING_LIST_INIT_DUP, 0, \
1325 NULL, NULL, NULL, \
1326 STRING_LIST_INIT_DUP, 0, NULL, 0, 0}
1329 static void next_submodule_warn_missing(struct submodule_update_clone *suc,
1330 struct strbuf *out, const char *displaypath)
1333 * Only mention uninitialized submodules when their
1334 * paths have been specified.
1336 if (suc->warn_if_uninitialized) {
1337 strbuf_addf(out,
1338 _("Submodule path '%s' not initialized"),
1339 displaypath);
1340 strbuf_addch(out, '\n');
1341 strbuf_addstr(out,
1342 _("Maybe you want to use 'update --init'?"));
1343 strbuf_addch(out, '\n');
1348 * Determine whether 'ce' needs to be cloned. If so, prepare the 'child' to
1349 * run the clone. Returns 1 if 'ce' needs to be cloned, 0 otherwise.
1351 static int prepare_to_clone_next_submodule(const struct cache_entry *ce,
1352 struct child_process *child,
1353 struct submodule_update_clone *suc,
1354 struct strbuf *out)
1356 const struct submodule *sub = NULL;
1357 const char *url = NULL;
1358 const char *update_string;
1359 enum submodule_update_type update_type;
1360 char *key;
1361 struct strbuf displaypath_sb = STRBUF_INIT;
1362 struct strbuf sb = STRBUF_INIT;
1363 const char *displaypath = NULL;
1364 int needs_cloning = 0;
1366 if (ce_stage(ce)) {
1367 if (suc->recursive_prefix)
1368 strbuf_addf(&sb, "%s/%s", suc->recursive_prefix, ce->name);
1369 else
1370 strbuf_addstr(&sb, ce->name);
1371 strbuf_addf(out, _("Skipping unmerged submodule %s"), sb.buf);
1372 strbuf_addch(out, '\n');
1373 goto cleanup;
1376 sub = submodule_from_path(&null_oid, ce->name);
1378 if (suc->recursive_prefix)
1379 displaypath = relative_path(suc->recursive_prefix,
1380 ce->name, &displaypath_sb);
1381 else
1382 displaypath = ce->name;
1384 if (!sub) {
1385 next_submodule_warn_missing(suc, out, displaypath);
1386 goto cleanup;
1389 key = xstrfmt("submodule.%s.update", sub->name);
1390 if (!repo_config_get_string_const(the_repository, key, &update_string)) {
1391 update_type = parse_submodule_update_type(update_string);
1392 } else {
1393 update_type = sub->update_strategy.type;
1395 free(key);
1397 if (suc->update.type == SM_UPDATE_NONE
1398 || (suc->update.type == SM_UPDATE_UNSPECIFIED
1399 && update_type == SM_UPDATE_NONE)) {
1400 strbuf_addf(out, _("Skipping submodule '%s'"), displaypath);
1401 strbuf_addch(out, '\n');
1402 goto cleanup;
1405 /* Check if the submodule has been initialized. */
1406 if (!is_submodule_active(the_repository, ce->name)) {
1407 next_submodule_warn_missing(suc, out, displaypath);
1408 goto cleanup;
1411 strbuf_reset(&sb);
1412 strbuf_addf(&sb, "submodule.%s.url", sub->name);
1413 if (repo_config_get_string_const(the_repository, sb.buf, &url))
1414 url = sub->url;
1416 strbuf_reset(&sb);
1417 strbuf_addf(&sb, "%s/.git", ce->name);
1418 needs_cloning = !file_exists(sb.buf);
1420 strbuf_reset(&sb);
1421 strbuf_addf(&sb, "%06o %s %d %d\t%s\n", ce->ce_mode,
1422 oid_to_hex(&ce->oid), ce_stage(ce),
1423 needs_cloning, ce->name);
1424 string_list_append(&suc->projectlines, sb.buf);
1426 if (!needs_cloning)
1427 goto cleanup;
1429 child->git_cmd = 1;
1430 child->no_stdin = 1;
1431 child->stdout_to_stderr = 1;
1432 child->err = -1;
1433 argv_array_push(&child->args, "submodule--helper");
1434 argv_array_push(&child->args, "clone");
1435 if (suc->progress)
1436 argv_array_push(&child->args, "--progress");
1437 if (suc->quiet)
1438 argv_array_push(&child->args, "--quiet");
1439 if (suc->prefix)
1440 argv_array_pushl(&child->args, "--prefix", suc->prefix, NULL);
1441 if (suc->recommend_shallow && sub->recommend_shallow == 1)
1442 argv_array_push(&child->args, "--depth=1");
1443 argv_array_pushl(&child->args, "--path", sub->path, NULL);
1444 argv_array_pushl(&child->args, "--name", sub->name, NULL);
1445 argv_array_pushl(&child->args, "--url", url, NULL);
1446 if (suc->references.nr) {
1447 struct string_list_item *item;
1448 for_each_string_list_item(item, &suc->references)
1449 argv_array_pushl(&child->args, "--reference", item->string, NULL);
1451 if (suc->dissociate)
1452 argv_array_push(&child->args, "--dissociate");
1453 if (suc->depth)
1454 argv_array_push(&child->args, suc->depth);
1456 cleanup:
1457 strbuf_reset(&displaypath_sb);
1458 strbuf_reset(&sb);
1460 return needs_cloning;
1463 static int update_clone_get_next_task(struct child_process *child,
1464 struct strbuf *err,
1465 void *suc_cb,
1466 void **idx_task_cb)
1468 struct submodule_update_clone *suc = suc_cb;
1469 const struct cache_entry *ce;
1470 int index;
1472 for (; suc->current < suc->list.nr; suc->current++) {
1473 ce = suc->list.entries[suc->current];
1474 if (prepare_to_clone_next_submodule(ce, child, suc, err)) {
1475 int *p = xmalloc(sizeof(*p));
1476 *p = suc->current;
1477 *idx_task_cb = p;
1478 suc->current++;
1479 return 1;
1484 * The loop above tried cloning each submodule once, now try the
1485 * stragglers again, which we can imagine as an extension of the
1486 * entry list.
1488 index = suc->current - suc->list.nr;
1489 if (index < suc->failed_clones_nr) {
1490 int *p;
1491 ce = suc->failed_clones[index];
1492 if (!prepare_to_clone_next_submodule(ce, child, suc, err)) {
1493 suc->current ++;
1494 strbuf_addstr(err, "BUG: submodule considered for "
1495 "cloning, doesn't need cloning "
1496 "any more?\n");
1497 return 0;
1499 p = xmalloc(sizeof(*p));
1500 *p = suc->current;
1501 *idx_task_cb = p;
1502 suc->current ++;
1503 return 1;
1506 return 0;
1509 static int update_clone_start_failure(struct strbuf *err,
1510 void *suc_cb,
1511 void *idx_task_cb)
1513 struct submodule_update_clone *suc = suc_cb;
1514 suc->quickstop = 1;
1515 return 1;
1518 static int update_clone_task_finished(int result,
1519 struct strbuf *err,
1520 void *suc_cb,
1521 void *idx_task_cb)
1523 const struct cache_entry *ce;
1524 struct submodule_update_clone *suc = suc_cb;
1526 int *idxP = idx_task_cb;
1527 int idx = *idxP;
1528 free(idxP);
1530 if (!result)
1531 return 0;
1533 if (idx < suc->list.nr) {
1534 ce = suc->list.entries[idx];
1535 strbuf_addf(err, _("Failed to clone '%s'. Retry scheduled"),
1536 ce->name);
1537 strbuf_addch(err, '\n');
1538 ALLOC_GROW(suc->failed_clones,
1539 suc->failed_clones_nr + 1,
1540 suc->failed_clones_alloc);
1541 suc->failed_clones[suc->failed_clones_nr++] = ce;
1542 return 0;
1543 } else {
1544 idx -= suc->list.nr;
1545 ce = suc->failed_clones[idx];
1546 strbuf_addf(err, _("Failed to clone '%s' a second time, aborting"),
1547 ce->name);
1548 strbuf_addch(err, '\n');
1549 suc->quickstop = 1;
1550 return 1;
1553 return 0;
1556 static int gitmodules_update_clone_config(const char *var, const char *value,
1557 void *cb)
1559 int *max_jobs = cb;
1560 if (!strcmp(var, "submodule.fetchjobs"))
1561 *max_jobs = parse_submodule_fetchjobs(var, value);
1562 return 0;
1565 static int update_clone(int argc, const char **argv, const char *prefix)
1567 const char *update = NULL;
1568 int max_jobs = 1;
1569 struct string_list_item *item;
1570 struct pathspec pathspec;
1571 struct submodule_update_clone suc = SUBMODULE_UPDATE_CLONE_INIT;
1573 struct option module_update_clone_options[] = {
1574 OPT_STRING(0, "prefix", &prefix,
1575 N_("path"),
1576 N_("path into the working tree")),
1577 OPT_STRING(0, "recursive-prefix", &suc.recursive_prefix,
1578 N_("path"),
1579 N_("path into the working tree, across nested "
1580 "submodule boundaries")),
1581 OPT_STRING(0, "update", &update,
1582 N_("string"),
1583 N_("rebase, merge, checkout or none")),
1584 OPT_STRING_LIST(0, "reference", &suc.references, N_("repo"),
1585 N_("reference repository")),
1586 OPT_BOOL(0, "dissociate", &suc.dissociate,
1587 N_("use --reference only while cloning")),
1588 OPT_STRING(0, "depth", &suc.depth, "<depth>",
1589 N_("Create a shallow clone truncated to the "
1590 "specified number of revisions")),
1591 OPT_INTEGER('j', "jobs", &max_jobs,
1592 N_("parallel jobs")),
1593 OPT_BOOL(0, "recommend-shallow", &suc.recommend_shallow,
1594 N_("whether the initial clone should follow the shallow recommendation")),
1595 OPT__QUIET(&suc.quiet, N_("don't print cloning progress")),
1596 OPT_BOOL(0, "progress", &suc.progress,
1597 N_("force cloning progress")),
1598 OPT_END()
1601 const char *const git_submodule_helper_usage[] = {
1602 N_("git submodule--helper update_clone [--prefix=<path>] [<path>...]"),
1603 NULL
1605 suc.prefix = prefix;
1607 config_from_gitmodules(gitmodules_update_clone_config, &max_jobs);
1608 git_config(gitmodules_update_clone_config, &max_jobs);
1610 argc = parse_options(argc, argv, prefix, module_update_clone_options,
1611 git_submodule_helper_usage, 0);
1613 if (update)
1614 if (parse_submodule_update_strategy(update, &suc.update) < 0)
1615 die(_("bad value for update parameter"));
1617 if (module_list_compute(argc, argv, prefix, &pathspec, &suc.list) < 0)
1618 return 1;
1620 if (pathspec.nr)
1621 suc.warn_if_uninitialized = 1;
1623 run_processes_parallel(max_jobs,
1624 update_clone_get_next_task,
1625 update_clone_start_failure,
1626 update_clone_task_finished,
1627 &suc);
1630 * We saved the output and put it out all at once now.
1631 * That means:
1632 * - the listener does not have to interleave their (checkout)
1633 * work with our fetching. The writes involved in a
1634 * checkout involve more straightforward sequential I/O.
1635 * - the listener can avoid doing any work if fetching failed.
1637 if (suc.quickstop)
1638 return 1;
1640 for_each_string_list_item(item, &suc.projectlines)
1641 fprintf(stdout, "%s", item->string);
1643 return 0;
1646 static int resolve_relative_path(int argc, const char **argv, const char *prefix)
1648 struct strbuf sb = STRBUF_INIT;
1649 if (argc != 3)
1650 die("submodule--helper relative-path takes exactly 2 arguments, got %d", argc);
1652 printf("%s", relative_path(argv[1], argv[2], &sb));
1653 strbuf_release(&sb);
1654 return 0;
1657 static const char *remote_submodule_branch(const char *path)
1659 const struct submodule *sub;
1660 const char *branch = NULL;
1661 char *key;
1663 sub = submodule_from_path(&null_oid, path);
1664 if (!sub)
1665 return NULL;
1667 key = xstrfmt("submodule.%s.branch", sub->name);
1668 if (repo_config_get_string_const(the_repository, key, &branch))
1669 branch = sub->branch;
1670 free(key);
1672 if (!branch)
1673 return "master";
1675 if (!strcmp(branch, ".")) {
1676 const char *refname = resolve_ref_unsafe("HEAD", 0, NULL, NULL);
1678 if (!refname)
1679 die(_("No such ref: %s"), "HEAD");
1681 /* detached HEAD */
1682 if (!strcmp(refname, "HEAD"))
1683 die(_("Submodule (%s) branch configured to inherit "
1684 "branch from superproject, but the superproject "
1685 "is not on any branch"), sub->name);
1687 if (!skip_prefix(refname, "refs/heads/", &refname))
1688 die(_("Expecting a full ref name, got %s"), refname);
1689 return refname;
1692 return branch;
1695 static int resolve_remote_submodule_branch(int argc, const char **argv,
1696 const char *prefix)
1698 const char *ret;
1699 struct strbuf sb = STRBUF_INIT;
1700 if (argc != 2)
1701 die("submodule--helper remote-branch takes exactly one arguments, got %d", argc);
1703 ret = remote_submodule_branch(argv[1]);
1704 if (!ret)
1705 die("submodule %s doesn't exist", argv[1]);
1707 printf("%s", ret);
1708 strbuf_release(&sb);
1709 return 0;
1712 static int push_check(int argc, const char **argv, const char *prefix)
1714 struct remote *remote;
1715 const char *superproject_head;
1716 char *head;
1717 int detached_head = 0;
1718 struct object_id head_oid;
1720 if (argc < 3)
1721 die("submodule--helper push-check requires at least 2 arguments");
1724 * superproject's resolved head ref.
1725 * if HEAD then the superproject is in a detached head state, otherwise
1726 * it will be the resolved head ref.
1728 superproject_head = argv[1];
1729 argv++;
1730 argc--;
1731 /* Get the submodule's head ref and determine if it is detached */
1732 head = resolve_refdup("HEAD", 0, &head_oid, NULL);
1733 if (!head)
1734 die(_("Failed to resolve HEAD as a valid ref."));
1735 if (!strcmp(head, "HEAD"))
1736 detached_head = 1;
1739 * The remote must be configured.
1740 * This is to avoid pushing to the exact same URL as the parent.
1742 remote = pushremote_get(argv[1]);
1743 if (!remote || remote->origin == REMOTE_UNCONFIGURED)
1744 die("remote '%s' not configured", argv[1]);
1746 /* Check the refspec */
1747 if (argc > 2) {
1748 int i, refspec_nr = argc - 2;
1749 struct ref *local_refs = get_local_heads();
1750 struct refspec *refspec = parse_push_refspec(refspec_nr,
1751 argv + 2);
1753 for (i = 0; i < refspec_nr; i++) {
1754 struct refspec *rs = refspec + i;
1756 if (rs->pattern || rs->matching)
1757 continue;
1759 /* LHS must match a single ref */
1760 switch (count_refspec_match(rs->src, local_refs, NULL)) {
1761 case 1:
1762 break;
1763 case 0:
1765 * If LHS matches 'HEAD' then we need to ensure
1766 * that it matches the same named branch
1767 * checked out in the superproject.
1769 if (!strcmp(rs->src, "HEAD")) {
1770 if (!detached_head &&
1771 !strcmp(head, superproject_head))
1772 break;
1773 die("HEAD does not match the named branch in the superproject");
1775 /* fallthrough */
1776 default:
1777 die("src refspec '%s' must name a ref",
1778 rs->src);
1781 free_refspec(refspec_nr, refspec);
1783 free(head);
1785 return 0;
1788 static int absorb_git_dirs(int argc, const char **argv, const char *prefix)
1790 int i;
1791 struct pathspec pathspec;
1792 struct module_list list = MODULE_LIST_INIT;
1793 unsigned flags = ABSORB_GITDIR_RECURSE_SUBMODULES;
1795 struct option embed_gitdir_options[] = {
1796 OPT_STRING(0, "prefix", &prefix,
1797 N_("path"),
1798 N_("path into the working tree")),
1799 OPT_BIT(0, "--recursive", &flags, N_("recurse into submodules"),
1800 ABSORB_GITDIR_RECURSE_SUBMODULES),
1801 OPT_END()
1804 const char *const git_submodule_helper_usage[] = {
1805 N_("git submodule--helper embed-git-dir [<path>...]"),
1806 NULL
1809 argc = parse_options(argc, argv, prefix, embed_gitdir_options,
1810 git_submodule_helper_usage, 0);
1812 if (module_list_compute(argc, argv, prefix, &pathspec, &list) < 0)
1813 return 1;
1815 for (i = 0; i < list.nr; i++)
1816 absorb_git_dir_into_superproject(prefix,
1817 list.entries[i]->name, flags);
1819 return 0;
1822 static int is_active(int argc, const char **argv, const char *prefix)
1824 if (argc != 2)
1825 die("submodule--helper is-active takes exactly 1 argument");
1827 return !is_submodule_active(the_repository, argv[1]);
1830 #define SUPPORT_SUPER_PREFIX (1<<0)
1832 struct cmd_struct {
1833 const char *cmd;
1834 int (*fn)(int, const char **, const char *);
1835 unsigned option;
1838 static struct cmd_struct commands[] = {
1839 {"list", module_list, 0},
1840 {"name", module_name, 0},
1841 {"clone", module_clone, 0},
1842 {"update-clone", update_clone, 0},
1843 {"relative-path", resolve_relative_path, 0},
1844 {"resolve-relative-url", resolve_relative_url, 0},
1845 {"resolve-relative-url-test", resolve_relative_url_test, 0},
1846 {"init", module_init, SUPPORT_SUPER_PREFIX},
1847 {"status", module_status, SUPPORT_SUPER_PREFIX},
1848 {"print-default-remote", print_default_remote, 0},
1849 {"sync", module_sync, SUPPORT_SUPER_PREFIX},
1850 {"deinit", module_deinit, 0},
1851 {"remote-branch", resolve_remote_submodule_branch, 0},
1852 {"push-check", push_check, 0},
1853 {"absorb-git-dirs", absorb_git_dirs, SUPPORT_SUPER_PREFIX},
1854 {"is-active", is_active, 0},
1857 int cmd_submodule__helper(int argc, const char **argv, const char *prefix)
1859 int i;
1860 if (argc < 2 || !strcmp(argv[1], "-h"))
1861 usage("git submodule--helper <command>");
1863 for (i = 0; i < ARRAY_SIZE(commands); i++) {
1864 if (!strcmp(argv[1], commands[i].cmd)) {
1865 if (get_super_prefix() &&
1866 !(commands[i].option & SUPPORT_SUPER_PREFIX))
1867 die(_("%s doesn't support --super-prefix"),
1868 commands[i].cmd);
1869 return commands[i].fn(argc - 1, argv + 1, prefix);
1873 die(_("'%s' is not a valid submodule--helper "
1874 "subcommand"), argv[1]);