?  search:
summary | log | graphiclog1 | graphiclog2 | commit | commitdiff | tree | refs | edit | fork
blame | history | raw | HEAD
l10n: bg.po: Updated Bulgarian translation (5195t)
[git.git] / builtin / submodule--helper.c
blobc5d3fc3817f5990fec156496839ec29686e4b9e6
1 #define USE_THE_INDEX_COMPATIBILITY_MACROS
2 #include "builtin.h"
3 #include "repository.h"
4 #include "cache.h"
5 #include "config.h"
6 #include "parse-options.h"
7 #include "quote.h"
8 #include "pathspec.h"
9 #include "dir.h"
10 #include "submodule.h"
11 #include "submodule-config.h"
12 #include "string-list.h"
13 #include "run-command.h"
14 #include "remote.h"
15 #include "refs.h"
16 #include "refspec.h"
17 #include "connect.h"
18 #include "revision.h"
19 #include "diffcore.h"
20 #include "diff.h"
21 #include "object-store.h"
22 #include "advice.h"
23
24 #define OPT_QUIET (1 << 0)
25 #define OPT_CACHED (1 << 1)
26 #define OPT_RECURSIVE (1 << 2)
27 #define OPT_FORCE (1 << 3)
28
29 typedef void (*each_submodule_fn)(const struct cache_entry *list_item,
30 void *cb_data);
31
32 static char *get_default_remote(void)
33 {
34 char *dest = NULL, *ret;
35 struct strbuf sb = STRBUF_INIT;
36 const char *refname = resolve_ref_unsafe("HEAD", 0, NULL, NULL);
37
38 if (!refname)
39 die(_("No such ref: %s"), "HEAD");
40
41 /* detached HEAD */
42 if (!strcmp(refname, "HEAD"))
43 return xstrdup("origin");
44
45 if (!skip_prefix(refname, "refs/heads/", &refname))
46 die(_("Expecting a full ref name, got %s"), refname);
47
48 strbuf_addf(&sb, "branch.%s.remote", refname);
49 if (git_config_get_string(sb.buf, &dest))
50 ret = xstrdup("origin");
51 else
52 ret = dest;
53
54 strbuf_release(&sb);
55 return ret;
56 }
57
58 static int print_default_remote(int argc, const char **argv, const char *prefix)
59 {
60 char *remote;
61
62 if (argc != 1)
63 die(_("submodule--helper print-default-remote takes no arguments"));
64
65 remote = get_default_remote();
66 if (remote)
67 printf("%s\n", remote);
68
69 free(remote);
70 return 0;
71 }
72
73 static int starts_with_dot_slash(const char *str)
74 {
75 return str[0] == '.' && is_dir_sep(str[1]);
76 }
77
78 static int starts_with_dot_dot_slash(const char *str)
79 {
80 return str[0] == '.' && str[1] == '.' && is_dir_sep(str[2]);
81 }
82
83 /*
84 * Returns 1 if it was the last chop before ':'.
85 */
86 static int chop_last_dir(char **remoteurl, int is_relative)
87 {
88 char *rfind = find_last_dir_sep(*remoteurl);
89 if (rfind) {
90 *rfind = '\0';
91 return 0;
92 }
93
94 rfind = strrchr(*remoteurl, ':');
95 if (rfind) {
96 *rfind = '\0';
97 return 1;
98 }
99
100 if (is_relative || !strcmp(".", *remoteurl))
101 die(_("cannot strip one component off url '%s'"),
102 *remoteurl);
103
104 free(*remoteurl);
105 *remoteurl = xstrdup(".");
106 return 0;
107 }
108
109 /*
110 * The `url` argument is the URL that navigates to the submodule origin
111 * repo. When relative, this URL is relative to the superproject origin
112 * URL repo. The `up_path` argument, if specified, is the relative
113 * path that navigates from the submodule working tree to the superproject
114 * working tree. Returns the origin URL of the submodule.
115 *
116 * Return either an absolute URL or filesystem path (if the superproject
117 * origin URL is an absolute URL or filesystem path, respectively) or a
118 * relative file system path (if the superproject origin URL is a relative
119 * file system path).
120 *
121 * When the output is a relative file system path, the path is either
122 * relative to the submodule working tree, if up_path is specified, or to
123 * the superproject working tree otherwise.
124 *
125 * NEEDSWORK: This works incorrectly on the domain and protocol part.
126 * remote_url url outcome expectation
127 * http://a.com/b ../c http://a.com/c as is
128 * http://a.com/b/ ../c http://a.com/c same as previous line, but
129 * ignore trailing slash in url
130 * http://a.com/b ../../c http://c error out
131 * http://a.com/b ../../../c http:/c error out
132 * http://a.com/b ../../../../c http:c error out
133 * http://a.com/b ../../../../../c .:c error out
134 * NEEDSWORK: Given how chop_last_dir() works, this function is broken
135 * when a local part has a colon in its path component, too.
136 */
137 static char *relative_url(const char *remote_url,
138 const char *url,
139 const char *up_path)
140 {
141 int is_relative = 0;
142 int colonsep = 0;
143 char *out;
144 char *remoteurl = xstrdup(remote_url);
145 struct strbuf sb = STRBUF_INIT;
146 size_t len = strlen(remoteurl);
147
148 if (is_dir_sep(remoteurl[len-1]))
149 remoteurl[len-1] = '\0';
150
151 if (!url_is_local_not_ssh(remoteurl) || is_absolute_path(remoteurl))
152 is_relative = 0;
153 else {
154 is_relative = 1;
155 /*
156 * Prepend a './' to ensure all relative
157 * remoteurls start with './' or '../'
158 */
159 if (!starts_with_dot_slash(remoteurl) &&
160 !starts_with_dot_dot_slash(remoteurl)) {
161 strbuf_reset(&sb);
162 strbuf_addf(&sb, "./%s", remoteurl);
163 free(remoteurl);
164 remoteurl = strbuf_detach(&sb, NULL);
165 }
166 }
167 /*
168 * When the url starts with '../', remove that and the
169 * last directory in remoteurl.
170 */
171 while (url) {
172 if (starts_with_dot_dot_slash(url)) {
173 url += 3;
174 colonsep |= chop_last_dir(&remoteurl, is_relative);
175 } else if (starts_with_dot_slash(url))
176 url += 2;
177 else
178 break;
179 }
180 strbuf_reset(&sb);
181 strbuf_addf(&sb, "%s%s%s", remoteurl, colonsep ? ":" : "/", url);
182 if (ends_with(url, "/"))
183 strbuf_setlen(&sb, sb.len - 1);
184 free(remoteurl);
185
186 if (starts_with_dot_slash(sb.buf))
187 out = xstrdup(sb.buf + 2);
188 else
189 out = xstrdup(sb.buf);
190
191 if (!up_path || !is_relative) {
192 strbuf_release(&sb);
193 return out;
194 }
195
196 strbuf_reset(&sb);
197 strbuf_addf(&sb, "%s%s", up_path, out);
198 free(out);
199 return strbuf_detach(&sb, NULL);
200 }
201
202 static char *resolve_relative_url(const char *rel_url, const char *up_path, int quiet)
203 {
204 char *remoteurl, *resolved_url;
205 char *remote = get_default_remote();
206 struct strbuf remotesb = STRBUF_INIT;
207
208 strbuf_addf(&remotesb, "remote.%s.url", remote);
209 if (git_config_get_string(remotesb.buf, &remoteurl)) {
210 if (!quiet)
211 warning(_("could not look up configuration '%s'. "
212 "Assuming this repository is its own "
213 "authoritative upstream."),
214 remotesb.buf);
215 remoteurl = xgetcwd();
216 }
217 resolved_url = relative_url(remoteurl, rel_url, up_path);
218
219 free(remote);
220 free(remoteurl);
221 strbuf_release(&remotesb);
222
223 return resolved_url;
224 }
225
226 static int resolve_relative_url_test(int argc, const char **argv, const char *prefix)
227 {
228 char *remoteurl, *res;
229 const char *up_path, *url;
230
231 if (argc != 4)
232 die("resolve-relative-url-test only accepts three arguments: <up_path> <remoteurl> <url>");
233
234 up_path = argv[1];
235 remoteurl = xstrdup(argv[2]);
236 url = argv[3];
237
238 if (!strcmp(up_path, "(null)"))
239 up_path = NULL;
240
241 res = relative_url(remoteurl, url, up_path);
242 puts(res);
243 free(res);
244 free(remoteurl);
245 return 0;
246 }
247
248 /* the result should be freed by the caller. */
249 static char *get_submodule_displaypath(const char *path, const char *prefix)
250 {
251 const char *super_prefix = get_super_prefix();
252
253 if (prefix && super_prefix) {
254 BUG("cannot have prefix '%s' and superprefix '%s'",
255 prefix, super_prefix);
256 } else if (prefix) {
257 struct strbuf sb = STRBUF_INIT;
258 char *displaypath = xstrdup(relative_path(path, prefix, &sb));
259 strbuf_release(&sb);
260 return displaypath;
261 } else if (super_prefix) {
262 return xstrfmt("%s%s", super_prefix, path);
263 } else {
264 return xstrdup(path);
265 }
266 }
267
268 static char *compute_rev_name(const char *sub_path, const char* object_id)
269 {
270 struct strbuf sb = STRBUF_INIT;
271 const char ***d;
272
273 static const char *describe_bare[] = { NULL };
274
275 static const char *describe_tags[] = { "--tags", NULL };
276
277 static const char *describe_contains[] = { "--contains", NULL };
278
279 static const char *describe_all_always[] = { "--all", "--always", NULL };
280
281 static const char **describe_argv[] = { describe_bare, describe_tags,
282 describe_contains,
283 describe_all_always, NULL };
284
285 for (d = describe_argv; *d; d++) {
286 struct child_process cp = CHILD_PROCESS_INIT;
287 prepare_submodule_repo_env(&cp.env_array);
288 cp.dir = sub_path;
289 cp.git_cmd = 1;
290 cp.no_stderr = 1;
291
292 strvec_push(&cp.args, "describe");
293 strvec_pushv(&cp.args, *d);
294 strvec_push(&cp.args, object_id);
295
296 if (!capture_command(&cp, &sb, 0)) {
297 strbuf_strip_suffix(&sb, "\n");
298 return strbuf_detach(&sb, NULL);
299 }
300 }
301
302 strbuf_release(&sb);
303 return NULL;
304 }
305
306 struct module_list {
307 const struct cache_entry **entries;
308 int alloc, nr;
309 };
310 #define MODULE_LIST_INIT { 0 }
311
312 static int module_list_compute(int argc, const char **argv,
313 const char *prefix,
314 struct pathspec *pathspec,
315 struct module_list *list)
316 {
317 int i, result = 0;
318 char *ps_matched = NULL;
319 parse_pathspec(pathspec, 0,
320 PATHSPEC_PREFER_FULL,
321 prefix, argv);
322
323 if (pathspec->nr)
324 ps_matched = xcalloc(pathspec->nr, 1);
325
326 if (read_cache() < 0)
327 die(_("index file corrupt"));
328
329 for (i = 0; i < active_nr; i++) {
330 const struct cache_entry *ce = active_cache[i];
331
332 if (!match_pathspec(&the_index, pathspec, ce->name, ce_namelen(ce),
333 0, ps_matched, 1) ||
334 !S_ISGITLINK(ce->ce_mode))
335 continue;
336
337 ALLOC_GROW(list->entries, list->nr + 1, list->alloc);
338 list->entries[list->nr++] = ce;
339 while (i + 1 < active_nr &&
340 !strcmp(ce->name, active_cache[i + 1]->name))
341 /*
342 * Skip entries with the same name in different stages
343 * to make sure an entry is returned only once.
344 */
345 i++;
346 }
347
348 if (ps_matched && report_path_error(ps_matched, pathspec))
349 result = -1;
350
351 free(ps_matched);
352
353 return result;
354 }
355
356 static void module_list_active(struct module_list *list)
357 {
358 int i;
359 struct module_list active_modules = MODULE_LIST_INIT;
360
361 for (i = 0; i < list->nr; i++) {
362 const struct cache_entry *ce = list->entries[i];
363
364 if (!is_submodule_active(the_repository, ce->name))
365 continue;
366
367 ALLOC_GROW(active_modules.entries,
368 active_modules.nr + 1,
369 active_modules.alloc);
370 active_modules.entries[active_modules.nr++] = ce;
371 }
372
373 free(list->entries);
374 *list = active_modules;
375 }
376
377 static char *get_up_path(const char *path)
378 {
379 int i;
380 struct strbuf sb = STRBUF_INIT;
381
382 for (i = count_slashes(path); i; i--)
383 strbuf_addstr(&sb, "../");
384
385 /*
386 * Check if 'path' ends with slash or not
387 * for having the same output for dir/sub_dir
388 * and dir/sub_dir/
389 */
390 if (!is_dir_sep(path[strlen(path) - 1]))
391 strbuf_addstr(&sb, "../");
392
393 return strbuf_detach(&sb, NULL);
394 }
395
396 static int module_list(int argc, const char **argv, const char *prefix)
397 {
398 int i;
399 struct pathspec pathspec;
400 struct module_list list = MODULE_LIST_INIT;
401
402 struct option module_list_options[] = {
403 OPT_STRING(0, "prefix", &prefix,
404 N_("path"),
405 N_("alternative anchor for relative paths")),
406 OPT_END()
407 };
408
409 const char *const git_submodule_helper_usage[] = {
410 N_("git submodule--helper list [--prefix=<path>] [<path>...]"),
411 NULL
412 };
413
414 argc = parse_options(argc, argv, prefix, module_list_options,
415 git_submodule_helper_usage, 0);
416
417 if (module_list_compute(argc, argv, prefix, &pathspec, &list) < 0)
418 return 1;
419
420 for (i = 0; i < list.nr; i++) {
421 const struct cache_entry *ce = list.entries[i];
422
423 if (ce_stage(ce))
424 printf("%06o %s U\t", ce->ce_mode,
425 oid_to_hex(null_oid()));
426 else
427 printf("%06o %s %d\t", ce->ce_mode,
428 oid_to_hex(&ce->oid), ce_stage(ce));
429
430 fprintf(stdout, "%s\n", ce->name);
431 }
432 return 0;
433 }
434
435 static void for_each_listed_submodule(const struct module_list *list,
436 each_submodule_fn fn, void *cb_data)
437 {
438 int i;
439 for (i = 0; i < list->nr; i++)
440 fn(list->entries[i], cb_data);
441 }
442
443 struct foreach_cb {
444 int argc;
445 const char **argv;
446 const char *prefix;
447 int quiet;
448 int recursive;
449 };
450 #define FOREACH_CB_INIT { 0 }
451
452 static void runcommand_in_submodule_cb(const struct cache_entry *list_item,
453 void *cb_data)
454 {
455 struct foreach_cb *info = cb_data;
456 const char *path = list_item->name;
457 const struct object_id *ce_oid = &list_item->oid;
458
459 const struct submodule *sub;
460 struct child_process cp = CHILD_PROCESS_INIT;
461 char *displaypath;
462
463 displaypath = get_submodule_displaypath(path, info->prefix);
464
465 sub = submodule_from_path(the_repository, null_oid(), path);
466
467 if (!sub)
468 die(_("No url found for submodule path '%s' in .gitmodules"),
469 displaypath);
470
471 if (!is_submodule_populated_gently(path, NULL))
472 goto cleanup;
473
474 prepare_submodule_repo_env(&cp.env_array);
475
476 /*
477 * For the purpose of executing <command> in the submodule,
478 * separate shell is used for the purpose of running the
479 * child process.
480 */
481 cp.use_shell = 1;
482 cp.dir = path;
483
484 /*
485 * NEEDSWORK: the command currently has access to the variables $name,
486 * $sm_path, $displaypath, $sha1 and $toplevel only when the command
487 * contains a single argument. This is done for maintaining a faithful
488 * translation from shell script.
489 */
490 if (info->argc == 1) {
491 char *toplevel = xgetcwd();
492 struct strbuf sb = STRBUF_INIT;
493
494 strvec_pushf(&cp.env_array, "name=%s", sub->name);
495 strvec_pushf(&cp.env_array, "sm_path=%s", path);
496 strvec_pushf(&cp.env_array, "displaypath=%s", displaypath);
497 strvec_pushf(&cp.env_array, "sha1=%s",
498 oid_to_hex(ce_oid));
499 strvec_pushf(&cp.env_array, "toplevel=%s", toplevel);
500
501 /*
502 * Since the path variable was accessible from the script
503 * before porting, it is also made available after porting.
504 * The environment variable "PATH" has a very special purpose
505 * on windows. And since environment variables are
506 * case-insensitive in windows, it interferes with the
507 * existing PATH variable. Hence, to avoid that, we expose
508 * path via the args strvec and not via env_array.
509 */
510 sq_quote_buf(&sb, path);
511 strvec_pushf(&cp.args, "path=%s; %s",
512 sb.buf, info->argv[0]);
513 strbuf_release(&sb);
514 free(toplevel);
515 } else {
516 strvec_pushv(&cp.args, info->argv);
517 }
518
519 if (!info->quiet)
520 printf(_("Entering '%s'\n"), displaypath);
521
522 if (info->argv[0] && run_command(&cp))
523 die(_("run_command returned non-zero status for %s\n."),
524 displaypath);
525
526 if (info->recursive) {
527 struct child_process cpr = CHILD_PROCESS_INIT;
528
529 cpr.git_cmd = 1;
530 cpr.dir = path;
531 prepare_submodule_repo_env(&cpr.env_array);
532
533 strvec_pushl(&cpr.args, "--super-prefix", NULL);
534 strvec_pushf(&cpr.args, "%s/", displaypath);
535 strvec_pushl(&cpr.args, "submodule--helper", "foreach", "--recursive",
536 NULL);
537
538 if (info->quiet)
539 strvec_push(&cpr.args, "--quiet");
540
541 strvec_push(&cpr.args, "--");
542 strvec_pushv(&cpr.args, info->argv);
543
544 if (run_command(&cpr))
545 die(_("run_command returned non-zero status while "
546 "recursing in the nested submodules of %s\n."),
547 displaypath);
548 }
549
550 cleanup:
551 free(displaypath);
552 }
553
554 static int module_foreach(int argc, const char **argv, const char *prefix)
555 {
556 struct foreach_cb info = FOREACH_CB_INIT;
557 struct pathspec pathspec;
558 struct module_list list = MODULE_LIST_INIT;
559
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")),
564 OPT_END()
565 };
566
567 const char *const git_submodule_helper_usage[] = {
568 N_("git submodule--helper foreach [--quiet] [--recursive] [--] <command>"),
569 NULL
570 };
571
572 argc = parse_options(argc, argv, prefix, module_foreach_options,
573 git_submodule_helper_usage, 0);
574
575 if (module_list_compute(0, NULL, prefix, &pathspec, &list) < 0)
576 return 1;
577
578 info.argc = argc;
579 info.argv = argv;
580 info.prefix = prefix;
581
582 for_each_listed_submodule(&list, runcommand_in_submodule_cb, &info);
583
584 return 0;
585 }
586
587 struct init_cb {
588 const char *prefix;
589 unsigned int flags;
590 };
591 #define INIT_CB_INIT { 0 }
592
593 static void init_submodule(const char *path, const char *prefix,
594 unsigned int flags)
595 {
596 const struct submodule *sub;
597 struct strbuf sb = STRBUF_INIT;
598 char *upd = NULL, *url = NULL, *displaypath;
599
600 displaypath = get_submodule_displaypath(path, prefix);
601
602 sub = submodule_from_path(the_repository, null_oid(), path);
603
604 if (!sub)
605 die(_("No url found for submodule path '%s' in .gitmodules"),
606 displaypath);
607
608 /*
609 * NEEDSWORK: In a multi-working-tree world, this needs to be
610 * set in the per-worktree config.
611 *
612 * Set active flag for the submodule being initialized
613 */
614 if (!is_submodule_active(the_repository, path)) {
615 strbuf_addf(&sb, "submodule.%s.active", sub->name);
616 git_config_set_gently(sb.buf, "true");
617 strbuf_reset(&sb);
618 }
619
620 /*
621 * Copy url setting when it is not set yet.
622 * To look up the url in .git/config, we must not fall back to
623 * .gitmodules, so look it up directly.
624 */
625 strbuf_addf(&sb, "submodule.%s.url", sub->name);
626 if (git_config_get_string(sb.buf, &url)) {
627 if (!sub->url)
628 die(_("No url found for submodule path '%s' in .gitmodules"),
629 displaypath);
630
631 url = xstrdup(sub->url);
632
633 /* Possibly a url relative to parent */
634 if (starts_with_dot_dot_slash(url) ||
635 starts_with_dot_slash(url)) {
636 char *oldurl = url;
637 url = resolve_relative_url(oldurl, NULL, 0);
638 free(oldurl);
639 }
640
641 if (git_config_set_gently(sb.buf, url))
642 die(_("Failed to register url for submodule path '%s'"),
643 displaypath);
644 if (!(flags & OPT_QUIET))
645 fprintf(stderr,
646 _("Submodule '%s' (%s) registered for path '%s'\n"),
647 sub->name, url, displaypath);
648 }
649 strbuf_reset(&sb);
650
651 /* Copy "update" setting when it is not set yet */
652 strbuf_addf(&sb, "submodule.%s.update", sub->name);
653 if (git_config_get_string(sb.buf, &upd) &&
654 sub->update_strategy.type != SM_UPDATE_UNSPECIFIED) {
655 if (sub->update_strategy.type == SM_UPDATE_COMMAND) {
656 fprintf(stderr, _("warning: command update mode suggested for submodule '%s'\n"),
657 sub->name);
658 upd = xstrdup("none");
659 } else
660 upd = xstrdup(submodule_strategy_to_string(&sub->update_strategy));
661
662 if (git_config_set_gently(sb.buf, upd))
663 die(_("Failed to register update mode for submodule path '%s'"), displaypath);
664 }
665 strbuf_release(&sb);
666 free(displaypath);
667 free(url);
668 free(upd);
669 }
670
671 static void init_submodule_cb(const struct cache_entry *list_item, void *cb_data)
672 {
673 struct init_cb *info = cb_data;
674 init_submodule(list_item->name, info->prefix, info->flags);
675 }
676
677 static int module_init(int argc, const char **argv, const char *prefix)
678 {
679 struct init_cb info = INIT_CB_INIT;
680 struct pathspec pathspec;
681 struct module_list list = MODULE_LIST_INIT;
682 int quiet = 0;
683
684 struct option module_init_options[] = {
685 OPT__QUIET(&quiet, N_("suppress output for initializing a submodule")),
686 OPT_END()
687 };
688
689 const char *const git_submodule_helper_usage[] = {
690 N_("git submodule--helper init [<options>] [<path>]"),
691 NULL
692 };
693
694 argc = parse_options(argc, argv, prefix, module_init_options,
695 git_submodule_helper_usage, 0);
696
697 if (module_list_compute(argc, argv, prefix, &pathspec, &list) < 0)
698 return 1;
699
700 /*
701 * If there are no path args and submodule.active is set then,
702 * by default, only initialize 'active' modules.
703 */
704 if (!argc && git_config_get_value_multi("submodule.active"))
705 module_list_active(&list);
706
707 info.prefix = prefix;
708 if (quiet)
709 info.flags |= OPT_QUIET;
710
711 for_each_listed_submodule(&list, init_submodule_cb, &info);
712
713 return 0;
714 }
715
716 struct status_cb {
717 const char *prefix;
718 unsigned int flags;
719 };
720 #define STATUS_CB_INIT { 0 }
721
722 static void print_status(unsigned int flags, char state, const char *path,
723 const struct object_id *oid, const char *displaypath)
724 {
725 if (flags & OPT_QUIET)
726 return;
727
728 printf("%c%s %s", state, oid_to_hex(oid), displaypath);
729
730 if (state == ' ' || state == '+') {
731 const char *name = compute_rev_name(path, oid_to_hex(oid));
732
733 if (name)
734 printf(" (%s)", name);
735 }
736
737 printf("\n");
738 }
739
740 static int handle_submodule_head_ref(const char *refname,
741 const struct object_id *oid, int flags,
742 void *cb_data)
743 {
744 struct object_id *output = cb_data;
745 if (oid)
746 oidcpy(output, oid);
747
748 return 0;
749 }
750
751 static void status_submodule(const char *path, const struct object_id *ce_oid,
752 unsigned int ce_flags, const char *prefix,
753 unsigned int flags)
754 {
755 char *displaypath;
756 struct strvec diff_files_args = STRVEC_INIT;
757 struct rev_info rev;
758 int diff_files_result;
759 struct strbuf buf = STRBUF_INIT;
760 const char *git_dir;
761
762 if (!submodule_from_path(the_repository, null_oid(), path))
763 die(_("no submodule mapping found in .gitmodules for path '%s'"),
764 path);
765
766 displaypath = get_submodule_displaypath(path, prefix);
767
768 if ((CE_STAGEMASK & ce_flags) >> CE_STAGESHIFT) {
769 print_status(flags, 'U', path, null_oid(), displaypath);
770 goto cleanup;
771 }
772
773 strbuf_addf(&buf, "%s/.git", path);
774 git_dir = read_gitfile(buf.buf);
775 if (!git_dir)
776 git_dir = buf.buf;
777
778 if (!is_submodule_active(the_repository, path) ||
779 !is_git_directory(git_dir)) {
780 print_status(flags, '-', path, ce_oid, displaypath);
781 strbuf_release(&buf);
782 goto cleanup;
783 }
784 strbuf_release(&buf);
785
786 strvec_pushl(&diff_files_args, "diff-files",
787 "--ignore-submodules=dirty", "--quiet", "--",
788 path, NULL);
789
790 git_config(git_diff_basic_config, NULL);
791
792 repo_init_revisions(the_repository, &rev, NULL);
793 rev.abbrev = 0;
794 diff_files_args.nr = setup_revisions(diff_files_args.nr,
795 diff_files_args.v,
796 &rev, NULL);
797 diff_files_result = run_diff_files(&rev, 0);
798
799 if (!diff_result_code(&rev.diffopt, diff_files_result)) {
800 print_status(flags, ' ', path, ce_oid,
801 displaypath);
802 } else if (!(flags & OPT_CACHED)) {
803 struct object_id oid;
804 struct ref_store *refs = get_submodule_ref_store(path);
805
806 if (!refs) {
807 print_status(flags, '-', path, ce_oid, displaypath);
808 goto cleanup;
809 }
810 if (refs_head_ref(refs, handle_submodule_head_ref, &oid))
811 die(_("could not resolve HEAD ref inside the "
812 "submodule '%s'"), path);
813
814 print_status(flags, '+', path, &oid, displaypath);
815 } else {
816 print_status(flags, '+', path, ce_oid, displaypath);
817 }
818
819 if (flags & OPT_RECURSIVE) {
820 struct child_process cpr = CHILD_PROCESS_INIT;
821
822 cpr.git_cmd = 1;
823 cpr.dir = path;
824 prepare_submodule_repo_env(&cpr.env_array);
825
826 strvec_push(&cpr.args, "--super-prefix");
827 strvec_pushf(&cpr.args, "%s/", displaypath);
828 strvec_pushl(&cpr.args, "submodule--helper", "status",
829 "--recursive", NULL);
830
831 if (flags & OPT_CACHED)
832 strvec_push(&cpr.args, "--cached");
833
834 if (flags & OPT_QUIET)
835 strvec_push(&cpr.args, "--quiet");
836
837 if (run_command(&cpr))
838 die(_("failed to recurse into submodule '%s'"), path);
839 }
840
841 cleanup:
842 strvec_clear(&diff_files_args);
843 free(displaypath);
844 }
845
846 static void status_submodule_cb(const struct cache_entry *list_item,
847 void *cb_data)
848 {
849 struct status_cb *info = cb_data;
850 status_submodule(list_item->name, &list_item->oid, list_item->ce_flags,
851 info->prefix, info->flags);
852 }
853
854 static int module_status(int argc, const char **argv, const char *prefix)
855 {
856 struct status_cb info = STATUS_CB_INIT;
857 struct pathspec pathspec;
858 struct module_list list = MODULE_LIST_INIT;
859 int quiet = 0;
860
861 struct option module_status_options[] = {
862 OPT__QUIET(&quiet, N_("suppress submodule status output")),
863 OPT_BIT(0, "cached", &info.flags, N_("use commit stored in the index instead of the one stored in the submodule HEAD"), OPT_CACHED),
864 OPT_BIT(0, "recursive", &info.flags, N_("recurse into nested submodules"), OPT_RECURSIVE),
865 OPT_END()
866 };
867
868 const char *const git_submodule_helper_usage[] = {
869 N_("git submodule status [--quiet] [--cached] [--recursive] [<path>...]"),
870 NULL
871 };
872
873 argc = parse_options(argc, argv, prefix, module_status_options,
874 git_submodule_helper_usage, 0);
875
876 if (module_list_compute(argc, argv, prefix, &pathspec, &list) < 0)
877 return 1;
878
879 info.prefix = prefix;
880 if (quiet)
881 info.flags |= OPT_QUIET;
882
883 for_each_listed_submodule(&list, status_submodule_cb, &info);
884
885 return 0;
886 }
887
888 static int module_name(int argc, const char **argv, const char *prefix)
889 {
890 const struct submodule *sub;
891
892 if (argc != 2)
893 usage(_("git submodule--helper name <path>"));
894
895 sub = submodule_from_path(the_repository, null_oid(), argv[1]);
896
897 if (!sub)
898 die(_("no submodule mapping found in .gitmodules for path '%s'"),
899 argv[1]);
900
901 printf("%s\n", sub->name);
902
903 return 0;
904 }
905
906 struct module_cb {
907 unsigned int mod_src;
908 unsigned int mod_dst;
909 struct object_id oid_src;
910 struct object_id oid_dst;
911 char status;
912 const char *sm_path;
913 };
914 #define MODULE_CB_INIT { 0 }
915
916 struct module_cb_list {
917 struct module_cb **entries;
918 int alloc, nr;
919 };
920 #define MODULE_CB_LIST_INIT { 0 }
921
922 struct summary_cb {
923 int argc;
924 const char **argv;
925 const char *prefix;
926 unsigned int cached: 1;
927 unsigned int for_status: 1;
928 unsigned int files: 1;
929 int summary_limit;
930 };
931 #define SUMMARY_CB_INIT { 0 }
932
933 enum diff_cmd {
934 DIFF_INDEX,
935 DIFF_FILES
936 };
937
938 static char *verify_submodule_committish(const char *sm_path,
939 const char *committish)
940 {
941 struct child_process cp_rev_parse = CHILD_PROCESS_INIT;
942 struct strbuf result = STRBUF_INIT;
943
944 cp_rev_parse.git_cmd = 1;
945 cp_rev_parse.dir = sm_path;
946 prepare_submodule_repo_env(&cp_rev_parse.env_array);
947 strvec_pushl(&cp_rev_parse.args, "rev-parse", "-q", "--short", NULL);
948 strvec_pushf(&cp_rev_parse.args, "%s^0", committish);
949 strvec_push(&cp_rev_parse.args, "--");
950
951 if (capture_command(&cp_rev_parse, &result, 0))
952 return NULL;
953
954 strbuf_trim_trailing_newline(&result);
955 return strbuf_detach(&result, NULL);
956 }
957
958 static void print_submodule_summary(struct summary_cb *info, char *errmsg,
959 int total_commits, const char *displaypath,
960 const char *src_abbrev, const char *dst_abbrev,
961 struct module_cb *p)
962 {
963 if (p->status == 'T') {
964 if (S_ISGITLINK(p->mod_dst))
965 printf(_("* %s %s(blob)->%s(submodule)"),
966 displaypath, src_abbrev, dst_abbrev);
967 else
968 printf(_("* %s %s(submodule)->%s(blob)"),
969 displaypath, src_abbrev, dst_abbrev);
970 } else {
971 printf("* %s %s...%s",
972 displaypath, src_abbrev, dst_abbrev);
973 }
974
975 if (total_commits < 0)
976 printf(":\n");
977 else
978 printf(" (%d):\n", total_commits);
979
980 if (errmsg) {
981 printf(_("%s"), errmsg);
982 } else if (total_commits > 0) {
983 struct child_process cp_log = CHILD_PROCESS_INIT;
984
985 cp_log.git_cmd = 1;
986 cp_log.dir = p->sm_path;
987 prepare_submodule_repo_env(&cp_log.env_array);
988 strvec_pushl(&cp_log.args, "log", NULL);
989
990 if (S_ISGITLINK(p->mod_src) && S_ISGITLINK(p->mod_dst)) {
991 if (info->summary_limit > 0)
992 strvec_pushf(&cp_log.args, "-%d",
993 info->summary_limit);
994
995 strvec_pushl(&cp_log.args, "--pretty= %m %s",
996 "--first-parent", NULL);
997 strvec_pushf(&cp_log.args, "%s...%s",
998 src_abbrev, dst_abbrev);
999 } else if (S_ISGITLINK(p->mod_dst)) {
1000 strvec_pushl(&cp_log.args, "--pretty= > %s",
1001 "-1", dst_abbrev, NULL);
1002 } else {
1003 strvec_pushl(&cp_log.args, "--pretty= < %s",
1004 "-1", src_abbrev, NULL);
1005 }
1006 run_command(&cp_log);
1007 }
1008 printf("\n");
1009 }
1010
1011 static void generate_submodule_summary(struct summary_cb *info,
1012 struct module_cb *p)
1013 {
1014 char *displaypath, *src_abbrev = NULL, *dst_abbrev;
1015 int missing_src = 0, missing_dst = 0;
1016 char *errmsg = NULL;
1017 int total_commits = -1;
1018
1019 if (!info->cached && oideq(&p->oid_dst, null_oid())) {
1020 if (S_ISGITLINK(p->mod_dst)) {
1021 struct ref_store *refs = get_submodule_ref_store(p->sm_path);
1022 if (refs)
1023 refs_head_ref(refs, handle_submodule_head_ref, &p->oid_dst);
1024 } else if (S_ISLNK(p->mod_dst) || S_ISREG(p->mod_dst)) {
1025 struct stat st;
1026 int fd = open(p->sm_path, O_RDONLY);
1027
1028 if (fd < 0 || fstat(fd, &st) < 0 ||
1029 index_fd(&the_index, &p->oid_dst, fd, &st, OBJ_BLOB,
1030 p->sm_path, 0))
1031 error(_("couldn't hash object from '%s'"), p->sm_path);
1032 } else {
1033 /* for a submodule removal (mode:0000000), don't warn */
1034 if (p->mod_dst)
1035 warning(_("unexpected mode %o\n"), p->mod_dst);
1036 }
1037 }
1038
1039 if (S_ISGITLINK(p->mod_src)) {
1040 if (p->status != 'D')
1041 src_abbrev = verify_submodule_committish(p->sm_path,
1042 oid_to_hex(&p->oid_src));
1043 if (!src_abbrev) {
1044 missing_src = 1;
1045 /*
1046 * As `rev-parse` failed, we fallback to getting
1047 * the abbreviated hash using oid_src. We do
1048 * this as we might still need the abbreviated
1049 * hash in cases like a submodule type change, etc.
1050 */
1051 src_abbrev = xstrndup(oid_to_hex(&p->oid_src), 7);
1052 }
1053 } else {
1054 /*
1055 * The source does not point to a submodule.
1056 * So, we fallback to getting the abbreviation using
1057 * oid_src as we might still need the abbreviated
1058 * hash in cases like submodule add, etc.
1059 */
1060 src_abbrev = xstrndup(oid_to_hex(&p->oid_src), 7);
1061 }
1062
1063 if (S_ISGITLINK(p->mod_dst)) {
1064 dst_abbrev = verify_submodule_committish(p->sm_path,
1065 oid_to_hex(&p->oid_dst));
1066 if (!dst_abbrev) {
1067 missing_dst = 1;
1068 /*
1069 * As `rev-parse` failed, we fallback to getting
1070 * the abbreviated hash using oid_dst. We do
1071 * this as we might still need the abbreviated
1072 * hash in cases like a submodule type change, etc.
1073 */
1074 dst_abbrev = xstrndup(oid_to_hex(&p->oid_dst), 7);
1075 }
1076 } else {
1077 /*
1078 * The destination does not point to a submodule.
1079 * So, we fallback to getting the abbreviation using
1080 * oid_dst as we might still need the abbreviated
1081 * hash in cases like a submodule removal, etc.
1082 */
1083 dst_abbrev = xstrndup(oid_to_hex(&p->oid_dst), 7);
1084 }
1085
1086 displaypath = get_submodule_displaypath(p->sm_path, info->prefix);
1087
1088 if (!missing_src && !missing_dst) {
1089 struct child_process cp_rev_list = CHILD_PROCESS_INIT;
1090 struct strbuf sb_rev_list = STRBUF_INIT;
1091
1092 strvec_pushl(&cp_rev_list.args, "rev-list",
1093 "--first-parent", "--count", NULL);
1094 if (S_ISGITLINK(p->mod_src) && S_ISGITLINK(p->mod_dst))
1095 strvec_pushf(&cp_rev_list.args, "%s...%s",
1096 src_abbrev, dst_abbrev);
1097 else
1098 strvec_push(&cp_rev_list.args, S_ISGITLINK(p->mod_src) ?
1099 src_abbrev : dst_abbrev);
1100 strvec_push(&cp_rev_list.args, "--");
1101
1102 cp_rev_list.git_cmd = 1;
1103 cp_rev_list.dir = p->sm_path;
1104 prepare_submodule_repo_env(&cp_rev_list.env_array);
1105
1106 if (!capture_command(&cp_rev_list, &sb_rev_list, 0))
1107 total_commits = atoi(sb_rev_list.buf);
1108
1109 strbuf_release(&sb_rev_list);
1110 } else {
1111 /*
1112 * Don't give error msg for modification whose dst is not
1113 * submodule, i.e., deleted or changed to blob
1114 */
1115 if (S_ISGITLINK(p->mod_dst)) {
1116 struct strbuf errmsg_str = STRBUF_INIT;
1117 if (missing_src && missing_dst) {
1118 strbuf_addf(&errmsg_str, " Warn: %s doesn't contain commits %s and %s\n",
1119 displaypath, oid_to_hex(&p->oid_src),
1120 oid_to_hex(&p->oid_dst));
1121 } else {
1122 strbuf_addf(&errmsg_str, " Warn: %s doesn't contain commit %s\n",
1123 displaypath, missing_src ?
1124 oid_to_hex(&p->oid_src) :
1125 oid_to_hex(&p->oid_dst));
1126 }
1127 errmsg = strbuf_detach(&errmsg_str, NULL);
1128 }
1129 }
1130
1131 print_submodule_summary(info, errmsg, total_commits,
1132 displaypath, src_abbrev,
1133 dst_abbrev, p);
1134
1135 free(displaypath);
1136 free(src_abbrev);
1137 free(dst_abbrev);
1138 }
1139
1140 static void prepare_submodule_summary(struct summary_cb *info,
1141 struct module_cb_list *list)
1142 {
1143 int i;
1144 for (i = 0; i < list->nr; i++) {
1145 const struct submodule *sub;
1146 struct module_cb *p = list->entries[i];
1147 struct strbuf sm_gitdir = STRBUF_INIT;
1148
1149 if (p->status == 'D' || p->status == 'T') {
1150 generate_submodule_summary(info, p);
1151 continue;
1152 }
1153
1154 if (info->for_status && p->status != 'A' &&
1155 (sub = submodule_from_path(the_repository,
1156 null_oid(), p->sm_path))) {
1157 char *config_key = NULL;
1158 const char *value;
1159 int ignore_all = 0;
1160
1161 config_key = xstrfmt("submodule.%s.ignore",
1162 sub->name);
1163 if (!git_config_get_string_tmp(config_key, &value))
1164 ignore_all = !strcmp(value, "all");
1165 else if (sub->ignore)
1166 ignore_all = !strcmp(sub->ignore, "all");
1167
1168 free(config_key);
1169 if (ignore_all)
1170 continue;
1171 }
1172
1173 /* Also show added or modified modules which are checked out */
1174 strbuf_addstr(&sm_gitdir, p->sm_path);
1175 if (is_nonbare_repository_dir(&sm_gitdir))
1176 generate_submodule_summary(info, p);
1177 strbuf_release(&sm_gitdir);
1178 }
1179 }
1180
1181 static void submodule_summary_callback(struct diff_queue_struct *q,
1182 struct diff_options *options,
1183 void *data)
1184 {
1185 int i;
1186 struct module_cb_list *list = data;
1187 for (i = 0; i < q->nr; i++) {
1188 struct diff_filepair *p = q->queue[i];
1189 struct module_cb *temp;
1190
1191 if (!S_ISGITLINK(p->one->mode) && !S_ISGITLINK(p->two->mode))
1192 continue;
1193 temp = (struct module_cb*)malloc(sizeof(struct module_cb));
1194 temp->mod_src = p->one->mode;
1195 temp->mod_dst = p->two->mode;
1196 temp->oid_src = p->one->oid;
1197 temp->oid_dst = p->two->oid;
1198 temp->status = p->status;
1199 temp->sm_path = xstrdup(p->one->path);
1200
1201 ALLOC_GROW(list->entries, list->nr + 1, list->alloc);
1202 list->entries[list->nr++] = temp;
1203 }
1204 }
1205
1206 static const char *get_diff_cmd(enum diff_cmd diff_cmd)
1207 {
1208 switch (diff_cmd) {
1209 case DIFF_INDEX: return "diff-index";
1210 case DIFF_FILES: return "diff-files";
1211 default: BUG("bad diff_cmd value %d", diff_cmd);
1212 }
1213 }
1214
1215 static int compute_summary_module_list(struct object_id *head_oid,
1216 struct summary_cb *info,
1217 enum diff_cmd diff_cmd)
1218 {
1219 struct strvec diff_args = STRVEC_INIT;
1220 struct rev_info rev;
1221 struct module_cb_list list = MODULE_CB_LIST_INIT;
1222
1223 strvec_push(&diff_args, get_diff_cmd(diff_cmd));
1224 if (info->cached)
1225 strvec_push(&diff_args, "--cached");
1226 strvec_pushl(&diff_args, "--ignore-submodules=dirty", "--raw", NULL);
1227 if (head_oid)
1228 strvec_push(&diff_args, oid_to_hex(head_oid));
1229 strvec_push(&diff_args, "--");
1230 if (info->argc)
1231 strvec_pushv(&diff_args, info->argv);
1232
1233 git_config(git_diff_basic_config, NULL);
1234 init_revisions(&rev, info->prefix);
1235 rev.abbrev = 0;
1236 precompose_argv_prefix(diff_args.nr, diff_args.v, NULL);
1237 setup_revisions(diff_args.nr, diff_args.v, &rev, NULL);
1238 rev.diffopt.output_format = DIFF_FORMAT_NO_OUTPUT | DIFF_FORMAT_CALLBACK;
1239 rev.diffopt.format_callback = submodule_summary_callback;
1240 rev.diffopt.format_callback_data = &list;
1241
1242 if (!info->cached) {
1243 if (diff_cmd == DIFF_INDEX)
1244 setup_work_tree();
1245 if (read_cache_preload(&rev.diffopt.pathspec) < 0) {
1246 perror("read_cache_preload");
1247 return -1;
1248 }
1249 } else if (read_cache() < 0) {
1250 perror("read_cache");
1251 return -1;
1252 }
1253
1254 if (diff_cmd == DIFF_INDEX)
1255 run_diff_index(&rev, info->cached);
1256 else
1257 run_diff_files(&rev, 0);
1258 prepare_submodule_summary(info, &list);
1259 strvec_clear(&diff_args);
1260 return 0;
1261 }
1262
1263 static int module_summary(int argc, const char **argv, const char *prefix)
1264 {
1265 struct summary_cb info = SUMMARY_CB_INIT;
1266 int cached = 0;
1267 int for_status = 0;
1268 int files = 0;
1269 int summary_limit = -1;
1270 enum diff_cmd diff_cmd = DIFF_INDEX;
1271 struct object_id head_oid;
1272 int ret;
1273
1274 struct option module_summary_options[] = {
1275 OPT_BOOL(0, "cached", &cached,
1276 N_("use the commit stored in the index instead of the submodule HEAD")),
1277 OPT_BOOL(0, "files", &files,
1278 N_("compare the commit in the index with that in the submodule HEAD")),
1279 OPT_BOOL(0, "for-status", &for_status,
1280 N_("skip submodules with 'ignore_config' value set to 'all'")),
1281 OPT_INTEGER('n', "summary-limit", &summary_limit,
1282 N_("limit the summary size")),
1283 OPT_END()
1284 };
1285
1286 const char *const git_submodule_helper_usage[] = {
1287 N_("git submodule--helper summary [<options>] [<commit>] [--] [<path>]"),
1288 NULL
1289 };
1290
1291 argc = parse_options(argc, argv, prefix, module_summary_options,
1292 git_submodule_helper_usage, 0);
1293
1294 if (!summary_limit)
1295 return 0;
1296
1297 if (!get_oid(argc ? argv[0] : "HEAD", &head_oid)) {
1298 if (argc) {
1299 argv++;
1300 argc--;
1301 }
1302 } else if (!argc || !strcmp(argv[0], "HEAD")) {
1303 /* before the first commit: compare with an empty tree */
1304 oidcpy(&head_oid, the_hash_algo->empty_tree);
1305 if (argc) {
1306 argv++;
1307 argc--;
1308 }
1309 } else {
1310 if (get_oid("HEAD", &head_oid))
1311 die(_("could not fetch a revision for HEAD"));
1312 }
1313
1314 if (files) {
1315 if (cached)
1316 die(_("options '%s' and '%s' cannot be used together"), "--cached", "--files");
1317 diff_cmd = DIFF_FILES;
1318 }
1319
1320 info.argc = argc;
1321 info.argv = argv;
1322 info.prefix = prefix;
1323 info.cached = !!cached;
1324 info.files = !!files;
1325 info.for_status = !!for_status;
1326 info.summary_limit = summary_limit;
1327
1328 ret = compute_summary_module_list((diff_cmd == DIFF_INDEX) ? &head_oid : NULL,
1329 &info, diff_cmd);
1330 return ret;
1331 }
1332
1333 struct sync_cb {
1334 const char *prefix;
1335 unsigned int flags;
1336 };
1337 #define SYNC_CB_INIT { 0 }
1338
1339 static void sync_submodule(const char *path, const char *prefix,
1340 unsigned int flags)
1341 {
1342 const struct submodule *sub;
1343 char *remote_key = NULL;
1344 char *sub_origin_url, *super_config_url, *displaypath;
1345 struct strbuf sb = STRBUF_INIT;
1346 struct child_process cp = CHILD_PROCESS_INIT;
1347 char *sub_config_path = NULL;
1348
1349 if (!is_submodule_active(the_repository, path))
1350 return;
1351
1352 sub = submodule_from_path(the_repository, null_oid(), path);
1353
1354 if (sub && sub->url) {
1355 if (starts_with_dot_dot_slash(sub->url) ||
1356 starts_with_dot_slash(sub->url)) {
1357 char *up_path = get_up_path(path);
1358 sub_origin_url = resolve_relative_url(sub->url, up_path, 1);
1359 super_config_url = resolve_relative_url(sub->url, NULL, 1);
1360 free(up_path);
1361 } else {
1362 sub_origin_url = xstrdup(sub->url);
1363 super_config_url = xstrdup(sub->url);
1364 }
1365 } else {
1366 sub_origin_url = xstrdup("");
1367 super_config_url = xstrdup("");
1368 }
1369
1370 displaypath = get_submodule_displaypath(path, prefix);
1371
1372 if (!(flags & OPT_QUIET))
1373 printf(_("Synchronizing submodule url for '%s'\n"),
1374 displaypath);
1375
1376 strbuf_reset(&sb);
1377 strbuf_addf(&sb, "submodule.%s.url", sub->name);
1378 if (git_config_set_gently(sb.buf, super_config_url))
1379 die(_("failed to register url for submodule path '%s'"),
1380 displaypath);
1381
1382 if (!is_submodule_populated_gently(path, NULL))
1383 goto cleanup;
1384
1385 prepare_submodule_repo_env(&cp.env_array);
1386 cp.git_cmd = 1;
1387 cp.dir = path;
1388 strvec_pushl(&cp.args, "submodule--helper",
1389 "print-default-remote", NULL);
1390
1391 strbuf_reset(&sb);
1392 if (capture_command(&cp, &sb, 0))
1393 die(_("failed to get the default remote for submodule '%s'"),
1394 path);
1395
1396 strbuf_strip_suffix(&sb, "\n");
1397 remote_key = xstrfmt("remote.%s.url", sb.buf);
1398
1399 strbuf_reset(&sb);
1400 submodule_to_gitdir(&sb, path);
1401 strbuf_addstr(&sb, "/config");
1402
1403 if (git_config_set_in_file_gently(sb.buf, remote_key, sub_origin_url))
1404 die(_("failed to update remote for submodule '%s'"),
1405 path);
1406
1407 if (flags & OPT_RECURSIVE) {
1408 struct child_process cpr = CHILD_PROCESS_INIT;
1409
1410 cpr.git_cmd = 1;
1411 cpr.dir = path;
1412 prepare_submodule_repo_env(&cpr.env_array);
1413
1414 strvec_push(&cpr.args, "--super-prefix");
1415 strvec_pushf(&cpr.args, "%s/", displaypath);
1416 strvec_pushl(&cpr.args, "submodule--helper", "sync",
1417 "--recursive", NULL);
1418
1419 if (flags & OPT_QUIET)
1420 strvec_push(&cpr.args, "--quiet");
1421
1422 if (run_command(&cpr))
1423 die(_("failed to recurse into submodule '%s'"),
1424 path);
1425 }
1426
1427 cleanup:
1428 free(super_config_url);
1429 free(sub_origin_url);
1430 strbuf_release(&sb);
1431 free(remote_key);
1432 free(displaypath);
1433 free(sub_config_path);
1434 }
1435
1436 static void sync_submodule_cb(const struct cache_entry *list_item, void *cb_data)
1437 {
1438 struct sync_cb *info = cb_data;
1439 sync_submodule(list_item->name, info->prefix, info->flags);
1440 }
1441
1442 static int module_sync(int argc, const char **argv, const char *prefix)
1443 {
1444 struct sync_cb info = SYNC_CB_INIT;
1445 struct pathspec pathspec;
1446 struct module_list list = MODULE_LIST_INIT;
1447 int quiet = 0;
1448 int recursive = 0;
1449
1450 struct option module_sync_options[] = {
1451 OPT__QUIET(&quiet, N_("suppress output of synchronizing submodule url")),
1452 OPT_BOOL(0, "recursive", &recursive,
1453 N_("recurse into nested submodules")),
1454 OPT_END()
1455 };
1456
1457 const char *const git_submodule_helper_usage[] = {
1458 N_("git submodule--helper sync [--quiet] [--recursive] [<path>]"),
1459 NULL
1460 };
1461
1462 argc = parse_options(argc, argv, prefix, module_sync_options,
1463 git_submodule_helper_usage, 0);
1464
1465 if (module_list_compute(argc, argv, prefix, &pathspec, &list) < 0)
1466 return 1;
1467
1468 info.prefix = prefix;
1469 if (quiet)
1470 info.flags |= OPT_QUIET;
1471 if (recursive)
1472 info.flags |= OPT_RECURSIVE;
1473
1474 for_each_listed_submodule(&list, sync_submodule_cb, &info);
1475
1476 return 0;
1477 }
1478
1479 struct deinit_cb {
1480 const char *prefix;
1481 unsigned int flags;
1482 };
1483 #define DEINIT_CB_INIT { 0 }
1484
1485 static void deinit_submodule(const char *path, const char *prefix,
1486 unsigned int flags)
1487 {
1488 const struct submodule *sub;
1489 char *displaypath = NULL;
1490 struct child_process cp_config = CHILD_PROCESS_INIT;
1491 struct strbuf sb_config = STRBUF_INIT;
1492 char *sub_git_dir = xstrfmt("%s/.git", path);
1493
1494 sub = submodule_from_path(the_repository, null_oid(), path);
1495
1496 if (!sub || !sub->name)
1497 goto cleanup;
1498
1499 displaypath = get_submodule_displaypath(path, prefix);
1500
1501 /* remove the submodule work tree (unless the user already did it) */
1502 if (is_directory(path)) {
1503 struct strbuf sb_rm = STRBUF_INIT;
1504 const char *format;
1505
1506 if (is_directory(sub_git_dir)) {
1507 if (!(flags & OPT_QUIET))
1508 warning(_("Submodule work tree '%s' contains a .git "
1509 "directory. This will be replaced with a "
1510 ".git file by using absorbgitdirs."),
1511 displaypath);
1512
1513 absorb_git_dir_into_superproject(path,
1514 ABSORB_GITDIR_RECURSE_SUBMODULES);
1515
1516 }
1517
1518 if (!(flags & OPT_FORCE)) {
1519 struct child_process cp_rm = CHILD_PROCESS_INIT;
1520 cp_rm.git_cmd = 1;
1521 strvec_pushl(&cp_rm.args, "rm", "-qn",
1522 path, NULL);
1523
1524 if (run_command(&cp_rm))
1525 die(_("Submodule work tree '%s' contains local "
1526 "modifications; use '-f' to discard them"),
1527 displaypath);
1528 }
1529
1530 strbuf_addstr(&sb_rm, path);
1531
1532 if (!remove_dir_recursively(&sb_rm, 0))
1533 format = _("Cleared directory '%s'\n");
1534 else
1535 format = _("Could not remove submodule work tree '%s'\n");
1536
1537 if (!(flags & OPT_QUIET))
1538 printf(format, displaypath);
1539
1540 submodule_unset_core_worktree(sub);
1541
1542 strbuf_release(&sb_rm);
1543 }
1544
1545 if (mkdir(path, 0777))
1546 printf(_("could not create empty submodule directory %s"),
1547 displaypath);
1548
1549 cp_config.git_cmd = 1;
1550 strvec_pushl(&cp_config.args, "config", "--get-regexp", NULL);
1551 strvec_pushf(&cp_config.args, "submodule.%s\\.", sub->name);
1552
1553 /* remove the .git/config entries (unless the user already did it) */
1554 if (!capture_command(&cp_config, &sb_config, 0) && sb_config.len) {
1555 char *sub_key = xstrfmt("submodule.%s", sub->name);
1556 /*
1557 * remove the whole section so we have a clean state when
1558 * the user later decides to init this submodule again
1559 */
1560 git_config_rename_section_in_file(NULL, sub_key, NULL);
1561 if (!(flags & OPT_QUIET))
1562 printf(_("Submodule '%s' (%s) unregistered for path '%s'\n"),
1563 sub->name, sub->url, displaypath);
1564 free(sub_key);
1565 }
1566
1567 cleanup:
1568 free(displaypath);
1569 free(sub_git_dir);
1570 strbuf_release(&sb_config);
1571 }
1572
1573 static void deinit_submodule_cb(const struct cache_entry *list_item,
1574 void *cb_data)
1575 {
1576 struct deinit_cb *info = cb_data;
1577 deinit_submodule(list_item->name, info->prefix, info->flags);
1578 }
1579
1580 static int module_deinit(int argc, const char **argv, const char *prefix)
1581 {
1582 struct deinit_cb info = DEINIT_CB_INIT;
1583 struct pathspec pathspec;
1584 struct module_list list = MODULE_LIST_INIT;
1585 int quiet = 0;
1586 int force = 0;
1587 int all = 0;
1588
1589 struct option module_deinit_options[] = {
1590 OPT__QUIET(&quiet, N_("suppress submodule status output")),
1591 OPT__FORCE(&force, N_("remove submodule working trees even if they contain local changes"), 0),
1592 OPT_BOOL(0, "all", &all, N_("unregister all submodules")),
1593 OPT_END()
1594 };
1595
1596 const char *const git_submodule_helper_usage[] = {
1597 N_("git submodule deinit [--quiet] [-f | --force] [--all | [--] [<path>...]]"),
1598 NULL
1599 };
1600
1601 argc = parse_options(argc, argv, prefix, module_deinit_options,
1602 git_submodule_helper_usage, 0);
1603
1604 if (all && argc) {
1605 error("pathspec and --all are incompatible");
1606 usage_with_options(git_submodule_helper_usage,
1607 module_deinit_options);
1608 }
1609
1610 if (!argc && !all)
1611 die(_("Use '--all' if you really want to deinitialize all submodules"));
1612
1613 if (module_list_compute(argc, argv, prefix, &pathspec, &list) < 0)
1614 return 1;
1615
1616 info.prefix = prefix;
1617 if (quiet)
1618 info.flags |= OPT_QUIET;
1619 if (force)
1620 info.flags |= OPT_FORCE;
1621
1622 for_each_listed_submodule(&list, deinit_submodule_cb, &info);
1623
1624 return 0;
1625 }
1626
1627 struct module_clone_data {
1628 const char *prefix;
1629 const char *path;
1630 const char *name;
1631 const char *url;
1632 const char *depth;
1633 struct string_list reference;
1634 unsigned int quiet: 1;
1635 unsigned int progress: 1;
1636 unsigned int dissociate: 1;
1637 unsigned int require_init: 1;
1638 int single_branch;
1639 };
1640 #define MODULE_CLONE_DATA_INIT { .reference = STRING_LIST_INIT_NODUP, .single_branch = -1 }
1641
1642 struct submodule_alternate_setup {
1643 const char *submodule_name;
1644 enum SUBMODULE_ALTERNATE_ERROR_MODE {
1645 SUBMODULE_ALTERNATE_ERROR_DIE,
1646 SUBMODULE_ALTERNATE_ERROR_INFO,
1647 SUBMODULE_ALTERNATE_ERROR_IGNORE
1648 } error_mode;
1649 struct string_list *reference;
1650 };
1651 #define SUBMODULE_ALTERNATE_SETUP_INIT { \
1652 .error_mode = SUBMODULE_ALTERNATE_ERROR_IGNORE, \
1653 }
1654
1655 static const char alternate_error_advice[] = N_(
1656 "An alternate computed from a superproject's alternate is invalid.\n"
1657 "To allow Git to clone without an alternate in such a case, set\n"
1658 "submodule.alternateErrorStrategy to 'info' or, equivalently, clone with\n"
1659 "'--reference-if-able' instead of '--reference'."
1660 );
1661
1662 static int add_possible_reference_from_superproject(
1663 struct object_directory *odb, void *sas_cb)
1664 {
1665 struct submodule_alternate_setup *sas = sas_cb;
1666 size_t len;
1667
1668 /*
1669 * If the alternate object store is another repository, try the
1670 * standard layout with .git/(modules/<name>)+/objects
1671 */
1672 if (strip_suffix(odb->path, "/objects", &len)) {
1673 struct repository alternate;
1674 char *sm_alternate;
1675 struct strbuf sb = STRBUF_INIT;
1676 struct strbuf err = STRBUF_INIT;
1677 strbuf_add(&sb, odb->path, len);
1678
1679 repo_init(&alternate, sb.buf, NULL);
1680
1681 /*
1682 * We need to end the new path with '/' to mark it as a dir,
1683 * otherwise a submodule name containing '/' will be broken
1684 * as the last part of a missing submodule reference would
1685 * be taken as a file name.
1686 */
1687 strbuf_reset(&sb);
1688 submodule_name_to_gitdir(&sb, &alternate, sas->submodule_name);
1689 strbuf_addch(&sb, '/');
1690 repo_clear(&alternate);
1691
1692 sm_alternate = compute_alternate_path(sb.buf, &err);
1693 if (sm_alternate) {
1694 string_list_append(sas->reference, xstrdup(sb.buf));
1695 free(sm_alternate);
1696 } else {
1697 switch (sas->error_mode) {
1698 case SUBMODULE_ALTERNATE_ERROR_DIE:
1699 if (advice_enabled(ADVICE_SUBMODULE_ALTERNATE_ERROR_STRATEGY_DIE))
1700 advise(_(alternate_error_advice));
1701 die(_("submodule '%s' cannot add alternate: %s"),
1702 sas->submodule_name, err.buf);
1703 case SUBMODULE_ALTERNATE_ERROR_INFO:
1704 fprintf_ln(stderr, _("submodule '%s' cannot add alternate: %s"),
1705 sas->submodule_name, err.buf);
1706 case SUBMODULE_ALTERNATE_ERROR_IGNORE:
1707 ; /* nothing */
1708 }
1709 }
1710 strbuf_release(&sb);
1711 }
1712
1713 return 0;
1714 }
1715
1716 static void prepare_possible_alternates(const char *sm_name,
1717 struct string_list *reference)
1718 {
1719 char *sm_alternate = NULL, *error_strategy = NULL;
1720 struct submodule_alternate_setup sas = SUBMODULE_ALTERNATE_SETUP_INIT;
1721
1722 git_config_get_string("submodule.alternateLocation", &sm_alternate);
1723 if (!sm_alternate)
1724 return;
1725
1726 git_config_get_string("submodule.alternateErrorStrategy", &error_strategy);
1727
1728 if (!error_strategy)
1729 error_strategy = xstrdup("die");
1730
1731 sas.submodule_name = sm_name;
1732 sas.reference = reference;
1733 if (!strcmp(error_strategy, "die"))
1734 sas.error_mode = SUBMODULE_ALTERNATE_ERROR_DIE;
1735 else if (!strcmp(error_strategy, "info"))
1736 sas.error_mode = SUBMODULE_ALTERNATE_ERROR_INFO;
1737 else if (!strcmp(error_strategy, "ignore"))
1738 sas.error_mode = SUBMODULE_ALTERNATE_ERROR_IGNORE;
1739 else
1740 die(_("Value '%s' for submodule.alternateErrorStrategy is not recognized"), error_strategy);
1741
1742 if (!strcmp(sm_alternate, "superproject"))
1743 foreach_alt_odb(add_possible_reference_from_superproject, &sas);
1744 else if (!strcmp(sm_alternate, "no"))
1745 ; /* do nothing */
1746 else
1747 die(_("Value '%s' for submodule.alternateLocation is not recognized"), sm_alternate);
1748
1749 free(sm_alternate);
1750 free(error_strategy);
1751 }
1752
1753 static int clone_submodule(struct module_clone_data *clone_data)
1754 {
1755 char *p, *sm_gitdir;
1756 char *sm_alternate = NULL, *error_strategy = NULL;
1757 struct strbuf sb = STRBUF_INIT;
1758 struct child_process cp = CHILD_PROCESS_INIT;
1759
1760 submodule_name_to_gitdir(&sb, the_repository, clone_data->name);
1761 sm_gitdir = absolute_pathdup(sb.buf);
1762 strbuf_reset(&sb);
1763
1764 if (!is_absolute_path(clone_data->path)) {
1765 strbuf_addf(&sb, "%s/%s", get_git_work_tree(), clone_data->path);
1766 clone_data->path = strbuf_detach(&sb, NULL);
1767 } else {
1768 clone_data->path = xstrdup(clone_data->path);
1769 }
1770
1771 if (validate_submodule_git_dir(sm_gitdir, clone_data->name) < 0)
1772 die(_("refusing to create/use '%s' in another submodule's "
1773 "git dir"), sm_gitdir);
1774
1775 if (!file_exists(sm_gitdir)) {
1776 if (safe_create_leading_directories_const(sm_gitdir) < 0)
1777 die(_("could not create directory '%s'"), sm_gitdir);
1778
1779 prepare_possible_alternates(clone_data->name, &clone_data->reference);
1780
1781 strvec_push(&cp.args, "clone");
1782 strvec_push(&cp.args, "--no-checkout");
1783 if (clone_data->quiet)
1784 strvec_push(&cp.args, "--quiet");
1785 if (clone_data->progress)
1786 strvec_push(&cp.args, "--progress");
1787 if (clone_data->depth && *(clone_data->depth))
1788 strvec_pushl(&cp.args, "--depth", clone_data->depth, NULL);
1789 if (clone_data->reference.nr) {
1790 struct string_list_item *item;
1791 for_each_string_list_item(item, &clone_data->reference)
1792 strvec_pushl(&cp.args, "--reference",
1793 item->string, NULL);
1794 }
1795 if (clone_data->dissociate)
1796 strvec_push(&cp.args, "--dissociate");
1797 if (sm_gitdir && *sm_gitdir)
1798 strvec_pushl(&cp.args, "--separate-git-dir", sm_gitdir, NULL);
1799 if (clone_data->single_branch >= 0)
1800 strvec_push(&cp.args, clone_data->single_branch ?
1801 "--single-branch" :
1802 "--no-single-branch");
1803
1804 strvec_push(&cp.args, "--");
1805 strvec_push(&cp.args, clone_data->url);
1806 strvec_push(&cp.args, clone_data->path);
1807
1808 cp.git_cmd = 1;
1809 prepare_submodule_repo_env(&cp.env_array);
1810 cp.no_stdin = 1;
1811
1812 if(run_command(&cp))
1813 die(_("clone of '%s' into submodule path '%s' failed"),
1814 clone_data->url, clone_data->path);
1815 } else {
1816 if (clone_data->require_init && !access(clone_data->path, X_OK) &&
1817 !is_empty_dir(clone_data->path))
1818 die(_("directory not empty: '%s'"), clone_data->path);
1819 if (safe_create_leading_directories_const(clone_data->path) < 0)
1820 die(_("could not create directory '%s'"), clone_data->path);
1821 strbuf_addf(&sb, "%s/index", sm_gitdir);
1822 unlink_or_warn(sb.buf);
1823 strbuf_reset(&sb);
1824 }
1825
1826 connect_work_tree_and_git_dir(clone_data->path, sm_gitdir, 0);
1827
1828 p = git_pathdup_submodule(clone_data->path, "config");
1829 if (!p)
1830 die(_("could not get submodule directory for '%s'"), clone_data->path);
1831
1832 /* setup alternateLocation and alternateErrorStrategy in the cloned submodule if needed */
1833 git_config_get_string("submodule.alternateLocation", &sm_alternate);
1834 if (sm_alternate)
1835 git_config_set_in_file(p, "submodule.alternateLocation",
1836 sm_alternate);
1837 git_config_get_string("submodule.alternateErrorStrategy", &error_strategy);
1838 if (error_strategy)
1839 git_config_set_in_file(p, "submodule.alternateErrorStrategy",
1840 error_strategy);
1841
1842 free(sm_alternate);
1843 free(error_strategy);
1844
1845 strbuf_release(&sb);
1846 free(sm_gitdir);
1847 free(p);
1848 return 0;
1849 }
1850
1851 static int module_clone(int argc, const char **argv, const char *prefix)
1852 {
1853 int dissociate = 0, quiet = 0, progress = 0, require_init = 0;
1854 struct module_clone_data clone_data = MODULE_CLONE_DATA_INIT;
1855
1856 struct option module_clone_options[] = {
1857 OPT_STRING(0, "prefix", &clone_data.prefix,
1858 N_("path"),
1859 N_("alternative anchor for relative paths")),
1860 OPT_STRING(0, "path", &clone_data.path,
1861 N_("path"),
1862 N_("where the new submodule will be cloned to")),
1863 OPT_STRING(0, "name", &clone_data.name,
1864 N_("string"),
1865 N_("name of the new submodule")),
1866 OPT_STRING(0, "url", &clone_data.url,
1867 N_("string"),
1868 N_("url where to clone the submodule from")),
1869 OPT_STRING_LIST(0, "reference", &clone_data.reference,
1870 N_("repo"),
1871 N_("reference repository")),
1872 OPT_BOOL(0, "dissociate", &dissociate,
1873 N_("use --reference only while cloning")),
1874 OPT_STRING(0, "depth", &clone_data.depth,
1875 N_("string"),
1876 N_("depth for shallow clones")),
1877 OPT__QUIET(&quiet, "Suppress output for cloning a submodule"),
1878 OPT_BOOL(0, "progress", &progress,
1879 N_("force cloning progress")),
1880 OPT_BOOL(0, "require-init", &require_init,
1881 N_("disallow cloning into non-empty directory")),
1882 OPT_BOOL(0, "single-branch", &clone_data.single_branch,
1883 N_("clone only one branch, HEAD or --branch")),
1884 OPT_END()
1885 };
1886
1887 const char *const git_submodule_helper_usage[] = {
1888 N_("git submodule--helper clone [--prefix=<path>] [--quiet] "
1889 "[--reference <repository>] [--name <name>] [--depth <depth>] "
1890 "[--single-branch] "
1891 "--url <url> --path <path>"),
1892 NULL
1893 };
1894
1895 argc = parse_options(argc, argv, prefix, module_clone_options,
1896 git_submodule_helper_usage, 0);
1897
1898 clone_data.dissociate = !!dissociate;
1899 clone_data.quiet = !!quiet;
1900 clone_data.progress = !!progress;
1901 clone_data.require_init = !!require_init;
1902
1903 if (argc || !clone_data.url || !clone_data.path || !*(clone_data.path))
1904 usage_with_options(git_submodule_helper_usage,
1905 module_clone_options);
1906
1907 clone_submodule(&clone_data);
1908 return 0;
1909 }
1910
1911 static void determine_submodule_update_strategy(struct repository *r,
1912 int just_cloned,
1913 const char *path,
1914 const char *update,
1915 struct submodule_update_strategy *out)
1916 {
1917 const struct submodule *sub = submodule_from_path(r, null_oid(), path);
1918 char *key;
1919 const char *val;
1920
1921 key = xstrfmt("submodule.%s.update", sub->name);
1922
1923 if (update) {
1924 if (parse_submodule_update_strategy(update, out) < 0)
1925 die(_("Invalid update mode '%s' for submodule path '%s'"),
1926 update, path);
1927 } else if (!repo_config_get_string_tmp(r, key, &val)) {
1928 if (parse_submodule_update_strategy(val, out) < 0)
1929 die(_("Invalid update mode '%s' configured for submodule path '%s'"),
1930 val, path);
1931 } else if (sub->update_strategy.type != SM_UPDATE_UNSPECIFIED) {
1932 if (sub->update_strategy.type == SM_UPDATE_COMMAND)
1933 BUG("how did we read update = !command from .gitmodules?");
1934 out->type = sub->update_strategy.type;
1935 out->command = sub->update_strategy.command;
1936 } else
1937 out->type = SM_UPDATE_CHECKOUT;
1938
1939 if (just_cloned &&
1940 (out->type == SM_UPDATE_MERGE ||
1941 out->type == SM_UPDATE_REBASE ||
1942 out->type == SM_UPDATE_NONE))
1943 out->type = SM_UPDATE_CHECKOUT;
1944
1945 free(key);
1946 }
1947
1948 static int module_update_module_mode(int argc, const char **argv, const char *prefix)
1949 {
1950 const char *path, *update = NULL;
1951 int just_cloned;
1952 struct submodule_update_strategy update_strategy = { .type = SM_UPDATE_CHECKOUT };
1953
1954 if (argc < 3 || argc > 4)
1955 die("submodule--helper update-module-clone expects <just-cloned> <path> [<update>]");
1956
1957 just_cloned = git_config_int("just_cloned", argv[1]);
1958 path = argv[2];
1959
1960 if (argc == 4)
1961 update = argv[3];
1962
1963 determine_submodule_update_strategy(the_repository,
1964 just_cloned, path, update,
1965 &update_strategy);
1966 fputs(submodule_strategy_to_string(&update_strategy), stdout);
1967
1968 return 0;
1969 }
1970
1971 struct update_clone_data {
1972 const struct submodule *sub;
1973 struct object_id oid;
1974 unsigned just_cloned;
1975 };
1976
1977 struct submodule_update_clone {
1978 /* index into 'list', the list of submodules to look into for cloning */
1979 int current;
1980 struct module_list list;
1981 unsigned warn_if_uninitialized : 1;
1982
1983 /* update parameter passed via commandline */
1984 struct submodule_update_strategy update;
1985
1986 /* configuration parameters which are passed on to the children */
1987 int progress;
1988 int quiet;
1989 int recommend_shallow;
1990 struct string_list references;
1991 int dissociate;
1992 unsigned require_init;
1993 const char *depth;
1994 const char *recursive_prefix;
1995 const char *prefix;
1996 int single_branch;
1997
1998 /* to be consumed by git-submodule.sh */
1999 struct update_clone_data *update_clone;
2000 int update_clone_nr; int update_clone_alloc;
2001
2002 /* If we want to stop as fast as possible and return an error */
2003 unsigned quickstop : 1;
2004
2005 /* failed clones to be retried again */
2006 const struct cache_entry **failed_clones;
2007 int failed_clones_nr, failed_clones_alloc;
2008
2009 int max_jobs;
2010 };
2011 #define SUBMODULE_UPDATE_CLONE_INIT { \
2012 .list = MODULE_LIST_INIT, \
2013 .update = SUBMODULE_UPDATE_STRATEGY_INIT, \
2014 .recommend_shallow = -1, \
2015 .references = STRING_LIST_INIT_DUP, \
2016 .single_branch = -1, \
2017 .max_jobs = 1, \
2018 }
2019
2020 struct update_data {
2021 const char *recursive_prefix;
2022 const char *sm_path;
2023 const char *displaypath;
2024 struct object_id oid;
2025 struct object_id suboid;
2026 struct submodule_update_strategy update_strategy;
2027 int depth;
2028 unsigned int force: 1;
2029 unsigned int quiet: 1;
2030 unsigned int nofetch: 1;
2031 unsigned int just_cloned: 1;
2032 };
2033 #define UPDATE_DATA_INIT { .update_strategy = SUBMODULE_UPDATE_STRATEGY_INIT }
2034
2035 static void next_submodule_warn_missing(struct submodule_update_clone *suc,
2036 struct strbuf *out, const char *displaypath)
2037 {
2038 /*
2039 * Only mention uninitialized submodules when their
2040 * paths have been specified.
2041 */
2042 if (suc->warn_if_uninitialized) {
2043 strbuf_addf(out,
2044 _("Submodule path '%s' not initialized"),
2045 displaypath);
2046 strbuf_addch(out, '\n');
2047 strbuf_addstr(out,
2048 _("Maybe you want to use 'update --init'?"));
2049 strbuf_addch(out, '\n');
2050 }
2051 }
2052
2053 /**
2054 * Determine whether 'ce' needs to be cloned. If so, prepare the 'child' to
2055 * run the clone. Returns 1 if 'ce' needs to be cloned, 0 otherwise.
2056 */
2057 static int prepare_to_clone_next_submodule(const struct cache_entry *ce,
2058 struct child_process *child,
2059 struct submodule_update_clone *suc,
2060 struct strbuf *out)
2061 {
2062 const struct submodule *sub = NULL;
2063 const char *url = NULL;
2064 const char *update_string;
2065 enum submodule_update_type update_type;
2066 char *key;
2067 struct strbuf displaypath_sb = STRBUF_INIT;
2068 struct strbuf sb = STRBUF_INIT;
2069 const char *displaypath = NULL;
2070 int needs_cloning = 0;
2071 int need_free_url = 0;
2072
2073 if (ce_stage(ce)) {
2074 if (suc->recursive_prefix)
2075 strbuf_addf(&sb, "%s/%s", suc->recursive_prefix, ce->name);
2076 else
2077 strbuf_addstr(&sb, ce->name);
2078 strbuf_addf(out, _("Skipping unmerged submodule %s"), sb.buf);
2079 strbuf_addch(out, '\n');
2080 goto cleanup;
2081 }
2082
2083 sub = submodule_from_path(the_repository, null_oid(), ce->name);
2084
2085 if (suc->recursive_prefix)
2086 displaypath = relative_path(suc->recursive_prefix,
2087 ce->name, &displaypath_sb);
2088 else
2089 displaypath = ce->name;
2090
2091 if (!sub) {
2092 next_submodule_warn_missing(suc, out, displaypath);
2093 goto cleanup;
2094 }
2095
2096 key = xstrfmt("submodule.%s.update", sub->name);
2097 if (!repo_config_get_string_tmp(the_repository, key, &update_string)) {
2098 update_type = parse_submodule_update_type(update_string);
2099 } else {
2100 update_type = sub->update_strategy.type;
2101 }
2102 free(key);
2103
2104 if (suc->update.type == SM_UPDATE_NONE
2105 || (suc->update.type == SM_UPDATE_UNSPECIFIED
2106 && update_type == SM_UPDATE_NONE)) {
2107 strbuf_addf(out, _("Skipping submodule '%s'"), displaypath);
2108 strbuf_addch(out, '\n');
2109 goto cleanup;
2110 }
2111
2112 /* Check if the submodule has been initialized. */
2113 if (!is_submodule_active(the_repository, ce->name)) {
2114 next_submodule_warn_missing(suc, out, displaypath);
2115 goto cleanup;
2116 }
2117
2118 strbuf_reset(&sb);
2119 strbuf_addf(&sb, "submodule.%s.url", sub->name);
2120 if (repo_config_get_string_tmp(the_repository, sb.buf, &url)) {
2121 if (starts_with_dot_slash(sub->url) ||
2122 starts_with_dot_dot_slash(sub->url)) {
2123 url = resolve_relative_url(sub->url, NULL, 0);
2124 need_free_url = 1;
2125 } else
2126 url = sub->url;
2127 }
2128
2129 strbuf_reset(&sb);
2130 strbuf_addf(&sb, "%s/.git", ce->name);
2131 needs_cloning = !file_exists(sb.buf);
2132
2133 ALLOC_GROW(suc->update_clone, suc->update_clone_nr + 1,
2134 suc->update_clone_alloc);
2135 oidcpy(&suc->update_clone[suc->update_clone_nr].oid, &ce->oid);
2136 suc->update_clone[suc->update_clone_nr].just_cloned = needs_cloning;
2137 suc->update_clone[suc->update_clone_nr].sub = sub;
2138 suc->update_clone_nr++;
2139
2140 if (!needs_cloning)
2141 goto cleanup;
2142
2143 child->git_cmd = 1;
2144 child->no_stdin = 1;
2145 child->stdout_to_stderr = 1;
2146 child->err = -1;
2147 strvec_push(&child->args, "submodule--helper");
2148 strvec_push(&child->args, "clone");
2149 if (suc->progress)
2150 strvec_push(&child->args, "--progress");
2151 if (suc->quiet)
2152 strvec_push(&child->args, "--quiet");
2153 if (suc->prefix)
2154 strvec_pushl(&child->args, "--prefix", suc->prefix, NULL);
2155 if (suc->recommend_shallow && sub->recommend_shallow == 1)
2156 strvec_push(&child->args, "--depth=1");
2157 if (suc->require_init)
2158 strvec_push(&child->args, "--require-init");
2159 strvec_pushl(&child->args, "--path", sub->path, NULL);
2160 strvec_pushl(&child->args, "--name", sub->name, NULL);
2161 strvec_pushl(&child->args, "--url", url, NULL);
2162 if (suc->references.nr) {
2163 struct string_list_item *item;
2164 for_each_string_list_item(item, &suc->references)
2165 strvec_pushl(&child->args, "--reference", item->string, NULL);
2166 }
2167 if (suc->dissociate)
2168 strvec_push(&child->args, "--dissociate");
2169 if (suc->depth)
2170 strvec_push(&child->args, suc->depth);
2171 if (suc->single_branch >= 0)
2172 strvec_push(&child->args, suc->single_branch ?
2173 "--single-branch" :
2174 "--no-single-branch");
2175
2176 cleanup:
2177 strbuf_release(&displaypath_sb);
2178 strbuf_release(&sb);
2179 if (need_free_url)
2180 free((void*)url);
2181
2182 return needs_cloning;
2183 }
2184
2185 static int update_clone_get_next_task(struct child_process *child,
2186 struct strbuf *err,
2187 void *suc_cb,
2188 void **idx_task_cb)
2189 {
2190 struct submodule_update_clone *suc = suc_cb;
2191 const struct cache_entry *ce;
2192 int index;
2193
2194 for (; suc->current < suc->list.nr; suc->current++) {
2195 ce = suc->list.entries[suc->current];
2196 if (prepare_to_clone_next_submodule(ce, child, suc, err)) {
2197 int *p = xmalloc(sizeof(*p));
2198 *p = suc->current;
2199 *idx_task_cb = p;
2200 suc->current++;
2201 return 1;
2202 }
2203 }
2204
2205 /*
2206 * The loop above tried cloning each submodule once, now try the
2207 * stragglers again, which we can imagine as an extension of the
2208 * entry list.
2209 */
2210 index = suc->current - suc->list.nr;
2211 if (index < suc->failed_clones_nr) {
2212 int *p;
2213 ce = suc->failed_clones[index];
2214 if (!prepare_to_clone_next_submodule(ce, child, suc, err)) {
2215 suc->current ++;
2216 strbuf_addstr(err, "BUG: submodule considered for "
2217 "cloning, doesn't need cloning "
2218 "any more?\n");
2219 return 0;
2220 }
2221 p = xmalloc(sizeof(*p));
2222 *p = suc->current;
2223 *idx_task_cb = p;
2224 suc->current ++;
2225 return 1;
2226 }
2227
2228 return 0;
2229 }
2230
2231 static int update_clone_start_failure(struct strbuf *err,
2232 void *suc_cb,
2233 void *idx_task_cb)
2234 {
2235 struct submodule_update_clone *suc = suc_cb;
2236 suc->quickstop = 1;
2237 return 1;
2238 }
2239
2240 static int update_clone_task_finished(int result,
2241 struct strbuf *err,
2242 void *suc_cb,
2243 void *idx_task_cb)
2244 {
2245 const struct cache_entry *ce;
2246 struct submodule_update_clone *suc = suc_cb;
2247
2248 int *idxP = idx_task_cb;
2249 int idx = *idxP;
2250 free(idxP);
2251
2252 if (!result)
2253 return 0;
2254
2255 if (idx < suc->list.nr) {
2256 ce = suc->list.entries[idx];
2257 strbuf_addf(err, _("Failed to clone '%s'. Retry scheduled"),
2258 ce->name);
2259 strbuf_addch(err, '\n');
2260 ALLOC_GROW(suc->failed_clones,
2261 suc->failed_clones_nr + 1,
2262 suc->failed_clones_alloc);
2263 suc->failed_clones[suc->failed_clones_nr++] = ce;
2264 return 0;
2265 } else {
2266 idx -= suc->list.nr;
2267 ce = suc->failed_clones[idx];
2268 strbuf_addf(err, _("Failed to clone '%s' a second time, aborting"),
2269 ce->name);
2270 strbuf_addch(err, '\n');
2271 suc->quickstop = 1;
2272 return 1;
2273 }
2274
2275 return 0;
2276 }
2277
2278 static int git_update_clone_config(const char *var, const char *value,
2279 void *cb)
2280 {
2281 int *max_jobs = cb;
2282 if (!strcmp(var, "submodule.fetchjobs"))
2283 *max_jobs = parse_submodule_fetchjobs(var, value);
2284 return 0;
2285 }
2286
2287 static int is_tip_reachable(const char *path, struct object_id *oid)
2288 {
2289 struct child_process cp = CHILD_PROCESS_INIT;
2290 struct strbuf rev = STRBUF_INIT;
2291 char *hex = oid_to_hex(oid);
2292
2293 cp.git_cmd = 1;
2294 cp.dir = xstrdup(path);
2295 cp.no_stderr = 1;
2296 strvec_pushl(&cp.args, "rev-list", "-n", "1", hex, "--not", "--all", NULL);
2297
2298 prepare_submodule_repo_env(&cp.env_array);
2299
2300 if (capture_command(&cp, &rev, GIT_MAX_HEXSZ + 1) || rev.len)
2301 return 0;
2302
2303 return 1;
2304 }
2305
2306 static int fetch_in_submodule(const char *module_path, int depth, int quiet, struct object_id *oid)
2307 {
2308 struct child_process cp = CHILD_PROCESS_INIT;
2309
2310 prepare_submodule_repo_env(&cp.env_array);
2311 cp.git_cmd = 1;
2312 cp.dir = xstrdup(module_path);
2313
2314 strvec_push(&cp.args, "fetch");
2315 if (quiet)
2316 strvec_push(&cp.args, "--quiet");
2317 if (depth)
2318 strvec_pushf(&cp.args, "--depth=%d", depth);
2319 if (oid) {
2320 char *hex = oid_to_hex(oid);
2321 char *remote = get_default_remote();
2322 strvec_pushl(&cp.args, remote, hex, NULL);
2323 }
2324
2325 return run_command(&cp);
2326 }
2327
2328 static int run_update_command(struct update_data *ud, int subforce)
2329 {
2330 struct strvec args = STRVEC_INIT;
2331 struct strvec child_env = STRVEC_INIT;
2332 char *oid = oid_to_hex(&ud->oid);
2333 int must_die_on_failure = 0;
2334 int git_cmd;
2335
2336 switch (ud->update_strategy.type) {
2337 case SM_UPDATE_CHECKOUT:
2338 git_cmd = 1;
2339 strvec_pushl(&args, "checkout", "-q", NULL);
2340 if (subforce)
2341 strvec_push(&args, "-f");
2342 break;
2343 case SM_UPDATE_REBASE:
2344 git_cmd = 1;
2345 strvec_push(&args, "rebase");
2346 if (ud->quiet)
2347 strvec_push(&args, "--quiet");
2348 must_die_on_failure = 1;
2349 break;
2350 case SM_UPDATE_MERGE:
2351 git_cmd = 1;
2352 strvec_push(&args, "merge");
2353 if (ud->quiet)
2354 strvec_push(&args, "--quiet");
2355 must_die_on_failure = 1;
2356 break;
2357 case SM_UPDATE_COMMAND:
2358 git_cmd = 0;
2359 strvec_push(&args, ud->update_strategy.command);
2360 must_die_on_failure = 1;
2361 break;
2362 default:
2363 BUG("unexpected update strategy type: %s",
2364 submodule_strategy_to_string(&ud->update_strategy));
2365 }
2366 strvec_push(&args, oid);
2367
2368 prepare_submodule_repo_env(&child_env);
2369 if (run_command_v_opt_cd_env(args.v, git_cmd ? RUN_GIT_CMD : RUN_USING_SHELL,
2370 ud->sm_path, child_env.v)) {
2371 switch (ud->update_strategy.type) {
2372 case SM_UPDATE_CHECKOUT:
2373 printf(_("Unable to checkout '%s' in submodule path '%s'"),
2374 oid, ud->displaypath);
2375 break;
2376 case SM_UPDATE_REBASE:
2377 printf(_("Unable to rebase '%s' in submodule path '%s'"),
2378 oid, ud->displaypath);
2379 break;
2380 case SM_UPDATE_MERGE:
2381 printf(_("Unable to merge '%s' in submodule path '%s'"),
2382 oid, ud->displaypath);
2383 break;
2384 case SM_UPDATE_COMMAND:
2385 printf(_("Execution of '%s %s' failed in submodule path '%s'"),
2386 ud->update_strategy.command, oid, ud->displaypath);
2387 break;
2388 default:
2389 BUG("unexpected update strategy type: %s",
2390 submodule_strategy_to_string(&ud->update_strategy));
2391 }
2392 /*
2393 * NEEDSWORK: We are currently printing to stdout with error
2394 * return so that the shell caller handles the error output
2395 * properly. Once we start handling the error messages within
2396 * C, we should use die() instead.
2397 */
2398 if (must_die_on_failure)
2399 return 2;
2400 /*
2401 * This signifies to the caller in shell that the command
2402 * failed without dying
2403 */
2404 return 1;
2405 }
2406
2407 switch (ud->update_strategy.type) {
2408 case SM_UPDATE_CHECKOUT:
2409 printf(_("Submodule path '%s': checked out '%s'\n"),
2410 ud->displaypath, oid);
2411 break;
2412 case SM_UPDATE_REBASE:
2413 printf(_("Submodule path '%s': rebased into '%s'\n"),
2414 ud->displaypath, oid);
2415 break;
2416 case SM_UPDATE_MERGE:
2417 printf(_("Submodule path '%s': merged in '%s'\n"),
2418 ud->displaypath, oid);
2419 break;
2420 case SM_UPDATE_COMMAND:
2421 printf(_("Submodule path '%s': '%s %s'\n"),
2422 ud->displaypath, ud->update_strategy.command, oid);
2423 break;
2424 default:
2425 BUG("unexpected update strategy type: %s",
2426 submodule_strategy_to_string(&ud->update_strategy));
2427 }
2428
2429 return 0;
2430 }
2431
2432 static int do_run_update_procedure(struct update_data *ud)
2433 {
2434 int subforce = is_null_oid(&ud->suboid) || ud->force;
2435
2436 if (!ud->nofetch) {
2437 /*
2438 * Run fetch only if `oid` isn't present or it
2439 * is not reachable from a ref.
2440 */
2441 if (!is_tip_reachable(ud->sm_path, &ud->oid) &&
2442 fetch_in_submodule(ud->sm_path, ud->depth, ud->quiet, NULL) &&
2443 !ud->quiet)
2444 fprintf_ln(stderr,
2445 _("Unable to fetch in submodule path '%s'; "
2446 "trying to directly fetch %s:"),
2447 ud->displaypath, oid_to_hex(&ud->oid));
2448 /*
2449 * Now we tried the usual fetch, but `oid` may
2450 * not be reachable from any of the refs.
2451 */
2452 if (!is_tip_reachable(ud->sm_path, &ud->oid) &&
2453 fetch_in_submodule(ud->sm_path, ud->depth, ud->quiet, &ud->oid))
2454 die(_("Fetched in submodule path '%s', but it did not "
2455 "contain %s. Direct fetching of that commit failed."),
2456 ud->displaypath, oid_to_hex(&ud->oid));
2457 }
2458
2459 return run_update_command(ud, subforce);
2460 }
2461
2462 static void update_submodule(struct update_clone_data *ucd)
2463 {
2464 fprintf(stdout, "dummy %s %d\t%s\n",
2465 oid_to_hex(&ucd->oid),
2466 ucd->just_cloned,
2467 ucd->sub->path);
2468 }
2469
2470 static int update_submodules(struct submodule_update_clone *suc)
2471 {
2472 int i;
2473
2474 run_processes_parallel_tr2(suc->max_jobs, update_clone_get_next_task,
2475 update_clone_start_failure,
2476 update_clone_task_finished, suc, "submodule",
2477 "parallel/update");
2478
2479 /*
2480 * We saved the output and put it out all at once now.
2481 * That means:
2482 * - the listener does not have to interleave their (checkout)
2483 * work with our fetching. The writes involved in a
2484 * checkout involve more straightforward sequential I/O.
2485 * - the listener can avoid doing any work if fetching failed.
2486 */
2487 if (suc->quickstop)
2488 return 1;
2489
2490 for (i = 0; i < suc->update_clone_nr; i++)
2491 update_submodule(&suc->update_clone[i]);
2492
2493 return 0;
2494 }
2495
2496 static int update_clone(int argc, const char **argv, const char *prefix)
2497 {
2498 const char *update = NULL;
2499 struct pathspec pathspec;
2500 struct submodule_update_clone suc = SUBMODULE_UPDATE_CLONE_INIT;
2501
2502 struct option module_update_clone_options[] = {
2503 OPT_STRING(0, "prefix", &prefix,
2504 N_("path"),
2505 N_("path into the working tree")),
2506 OPT_STRING(0, "recursive-prefix", &suc.recursive_prefix,
2507 N_("path"),
2508 N_("path into the working tree, across nested "
2509 "submodule boundaries")),
2510 OPT_STRING(0, "update", &update,
2511 N_("string"),
2512 N_("rebase, merge, checkout or none")),
2513 OPT_STRING_LIST(0, "reference", &suc.references, N_("repo"),
2514 N_("reference repository")),
2515 OPT_BOOL(0, "dissociate", &suc.dissociate,
2516 N_("use --reference only while cloning")),
2517 OPT_STRING(0, "depth", &suc.depth, "<depth>",
2518 N_("create a shallow clone truncated to the "
2519 "specified number of revisions")),
2520 OPT_INTEGER('j', "jobs", &suc.max_jobs,
2521 N_("parallel jobs")),
2522 OPT_BOOL(0, "recommend-shallow", &suc.recommend_shallow,
2523 N_("whether the initial clone should follow the shallow recommendation")),
2524 OPT__QUIET(&suc.quiet, N_("don't print cloning progress")),
2525 OPT_BOOL(0, "progress", &suc.progress,
2526 N_("force cloning progress")),
2527 OPT_BOOL(0, "require-init", &suc.require_init,
2528 N_("disallow cloning into non-empty directory")),
2529 OPT_BOOL(0, "single-branch", &suc.single_branch,
2530 N_("clone only one branch, HEAD or --branch")),
2531 OPT_END()
2532 };
2533
2534 const char *const git_submodule_helper_usage[] = {
2535 N_("git submodule--helper update-clone [--prefix=<path>] [<path>...]"),
2536 NULL
2537 };
2538 suc.prefix = prefix;
2539
2540 update_clone_config_from_gitmodules(&suc.max_jobs);
2541 git_config(git_update_clone_config, &suc.max_jobs);
2542
2543 argc = parse_options(argc, argv, prefix, module_update_clone_options,
2544 git_submodule_helper_usage, 0);
2545
2546 if (update)
2547 if (parse_submodule_update_strategy(update, &suc.update) < 0)
2548 die(_("bad value for update parameter"));
2549
2550 if (module_list_compute(argc, argv, prefix, &pathspec, &suc.list) < 0)
2551 return 1;
2552
2553 if (pathspec.nr)
2554 suc.warn_if_uninitialized = 1;
2555
2556 return update_submodules(&suc);
2557 }
2558
2559 static int run_update_procedure(int argc, const char **argv, const char *prefix)
2560 {
2561 int force = 0, quiet = 0, nofetch = 0, just_cloned = 0;
2562 char *prefixed_path, *update = NULL;
2563 struct update_data update_data = UPDATE_DATA_INIT;
2564
2565 struct option options[] = {
2566 OPT__QUIET(&quiet, N_("suppress output for update by rebase or merge")),
2567 OPT__FORCE(&force, N_("force checkout updates"), 0),
2568 OPT_BOOL('N', "no-fetch", &nofetch,
2569 N_("don't fetch new objects from the remote site")),
2570 OPT_BOOL(0, "just-cloned", &just_cloned,
2571 N_("overrides update mode in case the repository is a fresh clone")),
2572 OPT_INTEGER(0, "depth", &update_data.depth, N_("depth for shallow fetch")),
2573 OPT_STRING(0, "prefix", &prefix,
2574 N_("path"),
2575 N_("path into the working tree")),
2576 OPT_STRING(0, "update", &update,
2577 N_("string"),
2578 N_("rebase, merge, checkout or none")),
2579 OPT_STRING(0, "recursive-prefix", &update_data.recursive_prefix, N_("path"),
2580 N_("path into the working tree, across nested "
2581 "submodule boundaries")),
2582 OPT_CALLBACK_F(0, "oid", &update_data.oid, N_("sha1"),
2583 N_("SHA1 expected by superproject"), PARSE_OPT_NONEG,
2584 parse_opt_object_id),
2585 OPT_CALLBACK_F(0, "suboid", &update_data.suboid, N_("subsha1"),
2586 N_("SHA1 of submodule's HEAD"), PARSE_OPT_NONEG,
2587 parse_opt_object_id),
2588 OPT_END()
2589 };
2590
2591 const char *const usage[] = {
2592 N_("git submodule--helper run-update-procedure [<options>] <path>"),
2593 NULL
2594 };
2595
2596 argc = parse_options(argc, argv, prefix, options, usage, 0);
2597
2598 if (argc != 1)
2599 usage_with_options(usage, options);
2600
2601 update_data.force = !!force;
2602 update_data.quiet = !!quiet;
2603 update_data.nofetch = !!nofetch;
2604 update_data.just_cloned = !!just_cloned;
2605 update_data.sm_path = argv[0];
2606
2607 if (update_data.recursive_prefix)
2608 prefixed_path = xstrfmt("%s%s", update_data.recursive_prefix, update_data.sm_path);
2609 else
2610 prefixed_path = xstrdup(update_data.sm_path);
2611
2612 update_data.displaypath = get_submodule_displaypath(prefixed_path, prefix);
2613
2614 determine_submodule_update_strategy(the_repository, update_data.just_cloned,
2615 update_data.sm_path, update,
2616 &update_data.update_strategy);
2617
2618 free(prefixed_path);
2619
2620 if (!oideq(&update_data.oid, &update_data.suboid) || update_data.force)
2621 return do_run_update_procedure(&update_data);
2622
2623 return 3;
2624 }
2625
2626 static int resolve_relative_path(int argc, const char **argv, const char *prefix)
2627 {
2628 struct strbuf sb = STRBUF_INIT;
2629 if (argc != 3)
2630 die("submodule--helper relative-path takes exactly 2 arguments, got %d", argc);
2631
2632 printf("%s", relative_path(argv[1], argv[2], &sb));
2633 strbuf_release(&sb);
2634 return 0;
2635 }
2636
2637 static const char *remote_submodule_branch(const char *path)
2638 {
2639 const struct submodule *sub;
2640 const char *branch = NULL;
2641 char *key;
2642
2643 sub = submodule_from_path(the_repository, null_oid(), path);
2644 if (!sub)
2645 return NULL;
2646
2647 key = xstrfmt("submodule.%s.branch", sub->name);
2648 if (repo_config_get_string_tmp(the_repository, key, &branch))
2649 branch = sub->branch;
2650 free(key);
2651
2652 if (!branch)
2653 return "HEAD";
2654
2655 if (!strcmp(branch, ".")) {
2656 const char *refname = resolve_ref_unsafe("HEAD", 0, NULL, NULL);
2657
2658 if (!refname)
2659 die(_("No such ref: %s"), "HEAD");
2660
2661 /* detached HEAD */
2662 if (!strcmp(refname, "HEAD"))
2663 die(_("Submodule (%s) branch configured to inherit "
2664 "branch from superproject, but the superproject "
2665 "is not on any branch"), sub->name);
2666
2667 if (!skip_prefix(refname, "refs/heads/", &refname))
2668 die(_("Expecting a full ref name, got %s"), refname);
2669 return refname;
2670 }
2671
2672 return branch;
2673 }
2674
2675 static int resolve_remote_submodule_branch(int argc, const char **argv,
2676 const char *prefix)
2677 {
2678 const char *ret;
2679 struct strbuf sb = STRBUF_INIT;
2680 if (argc != 2)
2681 die("submodule--helper remote-branch takes exactly one arguments, got %d", argc);
2682
2683 ret = remote_submodule_branch(argv[1]);
2684 if (!ret)
2685 die("submodule %s doesn't exist", argv[1]);
2686
2687 printf("%s", ret);
2688 strbuf_release(&sb);
2689 return 0;
2690 }
2691
2692 static int push_check(int argc, const char **argv, const char *prefix)
2693 {
2694 struct remote *remote;
2695 const char *superproject_head;
2696 char *head;
2697 int detached_head = 0;
2698 struct object_id head_oid;
2699
2700 if (argc < 3)
2701 die("submodule--helper push-check requires at least 2 arguments");
2702
2703 /*
2704 * superproject's resolved head ref.
2705 * if HEAD then the superproject is in a detached head state, otherwise
2706 * it will be the resolved head ref.
2707 */
2708 superproject_head = argv[1];
2709 argv++;
2710 argc--;
2711 /* Get the submodule's head ref and determine if it is detached */
2712 head = resolve_refdup("HEAD", 0, &head_oid, NULL);
2713 if (!head)
2714 die(_("Failed to resolve HEAD as a valid ref."));
2715 if (!strcmp(head, "HEAD"))
2716 detached_head = 1;
2717
2718 /*
2719 * The remote must be configured.
2720 * This is to avoid pushing to the exact same URL as the parent.
2721 */
2722 remote = pushremote_get(argv[1]);
2723 if (!remote || remote->origin == REMOTE_UNCONFIGURED)
2724 die("remote '%s' not configured", argv[1]);
2725
2726 /* Check the refspec */
2727 if (argc > 2) {
2728 int i;
2729 struct ref *local_refs = get_local_heads();
2730 struct refspec refspec = REFSPEC_INIT_PUSH;
2731
2732 refspec_appendn(&refspec, argv + 2, argc - 2);
2733
2734 for (i = 0; i < refspec.nr; i++) {
2735 const struct refspec_item *rs = &refspec.items[i];
2736
2737 if (rs->pattern || rs->matching)
2738 continue;
2739
2740 /* LHS must match a single ref */
2741 switch (count_refspec_match(rs->src, local_refs, NULL)) {
2742 case 1:
2743 break;
2744 case 0:
2745 /*
2746 * If LHS matches 'HEAD' then we need to ensure
2747 * that it matches the same named branch
2748 * checked out in the superproject.
2749 */
2750 if (!strcmp(rs->src, "HEAD")) {
2751 if (!detached_head &&
2752 !strcmp(head, superproject_head))
2753 break;
2754 die("HEAD does not match the named branch in the superproject");
2755 }
2756 /* fallthrough */
2757 default:
2758 die("src refspec '%s' must name a ref",
2759 rs->src);
2760 }
2761 }
2762 refspec_clear(&refspec);
2763 }
2764 free(head);
2765
2766 return 0;
2767 }
2768
2769 static int ensure_core_worktree(int argc, const char **argv, const char *prefix)
2770 {
2771 const char *path;
2772 const char *cw;
2773 struct repository subrepo;
2774
2775 if (argc != 2)
2776 BUG("submodule--helper ensure-core-worktree <path>");
2777
2778 path = argv[1];
2779
2780 if (repo_submodule_init(&subrepo, the_repository, path, null_oid()))
2781 die(_("could not get a repository handle for submodule '%s'"), path);
2782
2783 if (!repo_config_get_string_tmp(&subrepo, "core.worktree", &cw)) {
2784 char *cfg_file, *abs_path;
2785 const char *rel_path;
2786 struct strbuf sb = STRBUF_INIT;
2787
2788 cfg_file = repo_git_path(&subrepo, "config");
2789
2790 abs_path = absolute_pathdup(path);
2791 rel_path = relative_path(abs_path, subrepo.gitdir, &sb);
2792
2793 git_config_set_in_file(cfg_file, "core.worktree", rel_path);
2794
2795 free(cfg_file);
2796 free(abs_path);
2797 strbuf_release(&sb);
2798 }
2799
2800 return 0;
2801 }
2802
2803 static int absorb_git_dirs(int argc, const char **argv, const char *prefix)
2804 {
2805 int i;
2806 struct pathspec pathspec;
2807 struct module_list list = MODULE_LIST_INIT;
2808 unsigned flags = ABSORB_GITDIR_RECURSE_SUBMODULES;
2809
2810 struct option embed_gitdir_options[] = {
2811 OPT_STRING(0, "prefix", &prefix,
2812 N_("path"),
2813 N_("path into the working tree")),
2814 OPT_BIT(0, "--recursive", &flags, N_("recurse into submodules"),
2815 ABSORB_GITDIR_RECURSE_SUBMODULES),
2816 OPT_END()
2817 };
2818
2819 const char *const git_submodule_helper_usage[] = {
2820 N_("git submodule--helper absorb-git-dirs [<options>] [<path>...]"),
2821 NULL
2822 };
2823
2824 argc = parse_options(argc, argv, prefix, embed_gitdir_options,
2825 git_submodule_helper_usage, 0);
2826
2827 if (module_list_compute(argc, argv, prefix, &pathspec, &list) < 0)
2828 return 1;
2829
2830 for (i = 0; i < list.nr; i++)
2831 absorb_git_dir_into_superproject(list.entries[i]->name, flags);
2832
2833 return 0;
2834 }
2835
2836 static int is_active(int argc, const char **argv, const char *prefix)
2837 {
2838 if (argc != 2)
2839 die("submodule--helper is-active takes exactly 1 argument");
2840
2841 return !is_submodule_active(the_repository, argv[1]);
2842 }
2843
2844 /*
2845 * Exit non-zero if any of the submodule names given on the command line is
2846 * invalid. If no names are given, filter stdin to print only valid names
2847 * (which is primarily intended for testing).
2848 */
2849 static int check_name(int argc, const char **argv, const char *prefix)
2850 {
2851 if (argc > 1) {
2852 while (*++argv) {
2853 if (check_submodule_name(*argv) < 0)
2854 return 1;
2855 }
2856 } else {
2857 struct strbuf buf = STRBUF_INIT;
2858 while (strbuf_getline(&buf, stdin) != EOF) {
2859 if (!check_submodule_name(buf.buf))
2860 printf("%s\n", buf.buf);
2861 }
2862 strbuf_release(&buf);
2863 }
2864 return 0;
2865 }
2866
2867 static int module_config(int argc, const char **argv, const char *prefix)
2868 {
2869 enum {
2870 CHECK_WRITEABLE = 1,
2871 DO_UNSET = 2
2872 } command = 0;
2873
2874 struct option module_config_options[] = {
2875 OPT_CMDMODE(0, "check-writeable", &command,
2876 N_("check if it is safe to write to the .gitmodules file"),
2877 CHECK_WRITEABLE),
2878 OPT_CMDMODE(0, "unset", &command,
2879 N_("unset the config in the .gitmodules file"),
2880 DO_UNSET),
2881 OPT_END()
2882 };
2883 const char *const git_submodule_helper_usage[] = {
2884 N_("git submodule--helper config <name> [<value>]"),
2885 N_("git submodule--helper config --unset <name>"),
2886 N_("git submodule--helper config --check-writeable"),
2887 NULL
2888 };
2889
2890 argc = parse_options(argc, argv, prefix, module_config_options,
2891 git_submodule_helper_usage, PARSE_OPT_KEEP_ARGV0);
2892
2893 if (argc == 1 && command == CHECK_WRITEABLE)
2894 return is_writing_gitmodules_ok() ? 0 : -1;
2895
2896 /* Equivalent to ACTION_GET in builtin/config.c */
2897 if (argc == 2 && command != DO_UNSET)
2898 return print_config_from_gitmodules(the_repository, argv[1]);
2899
2900 /* Equivalent to ACTION_SET in builtin/config.c */
2901 if (argc == 3 || (argc == 2 && command == DO_UNSET)) {
2902 const char *value = (argc == 3) ? argv[2] : NULL;
2903
2904 if (!is_writing_gitmodules_ok())
2905 die(_("please make sure that the .gitmodules file is in the working tree"));
2906
2907 return config_set_in_gitmodules_file_gently(argv[1], value);
2908 }
2909
2910 usage_with_options(git_submodule_helper_usage, module_config_options);
2911 }
2912
2913 static int module_set_url(int argc, const char **argv, const char *prefix)
2914 {
2915 int quiet = 0;
2916 const char *newurl;
2917 const char *path;
2918 char *config_name;
2919
2920 struct option options[] = {
2921 OPT__QUIET(&quiet, N_("suppress output for setting url of a submodule")),
2922 OPT_END()
2923 };
2924 const char *const usage[] = {
2925 N_("git submodule--helper set-url [--quiet] <path> <newurl>"),
2926 NULL
2927 };
2928
2929 argc = parse_options(argc, argv, prefix, options, usage, 0);
2930
2931 if (argc != 2 || !(path = argv[0]) || !(newurl = argv[1]))
2932 usage_with_options(usage, options);
2933
2934 config_name = xstrfmt("submodule.%s.url", path);
2935
2936 config_set_in_gitmodules_file_gently(config_name, newurl);
2937 sync_submodule(path, prefix, quiet ? OPT_QUIET : 0);
2938
2939 free(config_name);
2940
2941 return 0;
2942 }
2943
2944 static int module_set_branch(int argc, const char **argv, const char *prefix)
2945 {
2946 int opt_default = 0, ret;
2947 const char *opt_branch = NULL;
2948 const char *path;
2949 char *config_name;
2950
2951 /*
2952 * We accept the `quiet` option for uniformity across subcommands,
2953 * though there is nothing to make less verbose in this subcommand.
2954 */
2955 struct option options[] = {
2956 OPT_NOOP_NOARG('q', "quiet"),
2957 OPT_BOOL('d', "default", &opt_default,
2958 N_("set the default tracking branch to master")),
2959 OPT_STRING('b', "branch", &opt_branch, N_("branch"),
2960 N_("set the default tracking branch")),
2961 OPT_END()
2962 };
2963 const char *const usage[] = {
2964 N_("git submodule--helper set-branch [-q|--quiet] (-d|--default) <path>"),
2965 N_("git submodule--helper set-branch [-q|--quiet] (-b|--branch) <branch> <path>"),
2966 NULL
2967 };
2968
2969 argc = parse_options(argc, argv, prefix, options, usage, 0);
2970
2971 if (!opt_branch && !opt_default)
2972 die(_("--branch or --default required"));
2973
2974 if (opt_branch && opt_default)
2975 die(_("options '%s' and '%s' cannot be used together"), "--branch", "--default");
2976
2977 if (argc != 1 || !(path = argv[0]))
2978 usage_with_options(usage, options);
2979
2980 config_name = xstrfmt("submodule.%s.branch", path);
2981 ret = config_set_in_gitmodules_file_gently(config_name, opt_branch);
2982
2983 free(config_name);
2984 return !!ret;
2985 }
2986
2987 struct add_data {
2988 const char *prefix;
2989 const char *branch;
2990 const char *reference_path;
2991 char *sm_path;
2992 const char *sm_name;
2993 const char *repo;
2994 const char *realrepo;
2995 int depth;
2996 unsigned int force: 1;
2997 unsigned int quiet: 1;
2998 unsigned int progress: 1;
2999 unsigned int dissociate: 1;
3000 };
3001 #define ADD_DATA_INIT { .depth = -1 }
3002
3003 static void append_fetch_remotes(struct strbuf *msg, const char *git_dir_path)
3004 {
3005 struct child_process cp_remote = CHILD_PROCESS_INIT;
3006 struct strbuf sb_remote_out = STRBUF_INIT;
3007
3008 cp_remote.git_cmd = 1;
3009 strvec_pushf(&cp_remote.env_array,
3010 "GIT_DIR=%s", git_dir_path);
3011 strvec_push(&cp_remote.env_array, "GIT_WORK_TREE=.");
3012 strvec_pushl(&cp_remote.args, "remote", "-v", NULL);
3013 if (!capture_command(&cp_remote, &sb_remote_out, 0)) {
3014 char *next_line;
3015 char *line = sb_remote_out.buf;
3016 while ((next_line = strchr(line, '\n')) != NULL) {
3017 size_t len = next_line - line;
3018 if (strip_suffix_mem(line, &len, " (fetch)"))
3019 strbuf_addf(msg, " %.*s\n", (int)len, line);
3020 line = next_line + 1;
3021 }
3022 }
3023
3024 strbuf_release(&sb_remote_out);
3025 }
3026
3027 static int add_submodule(const struct add_data *add_data)
3028 {
3029 char *submod_gitdir_path;
3030 struct module_clone_data clone_data = MODULE_CLONE_DATA_INIT;
3031
3032 /* perhaps the path already exists and is already a git repo, else clone it */
3033 if (is_directory(add_data->sm_path)) {
3034 struct strbuf sm_path = STRBUF_INIT;
3035 strbuf_addstr(&sm_path, add_data->sm_path);
3036 submod_gitdir_path = xstrfmt("%s/.git", add_data->sm_path);
3037 if (is_nonbare_repository_dir(&sm_path))
3038 printf(_("Adding existing repo at '%s' to the index\n"),
3039 add_data->sm_path);
3040 else
3041 die(_("'%s' already exists and is not a valid git repo"),
3042 add_data->sm_path);
3043 strbuf_release(&sm_path);
3044 free(submod_gitdir_path);
3045 } else {
3046 struct child_process cp = CHILD_PROCESS_INIT;
3047 submod_gitdir_path = xstrfmt(".git/modules/%s", add_data->sm_name);
3048
3049 if (is_directory(submod_gitdir_path)) {
3050 if (!add_data->force) {
3051 struct strbuf msg = STRBUF_INIT;
3052 char *die_msg;
3053
3054 strbuf_addf(&msg, _("A git directory for '%s' is found "
3055 "locally with remote(s):\n"),
3056 add_data->sm_name);
3057
3058 append_fetch_remotes(&msg, submod_gitdir_path);
3059 free(submod_gitdir_path);
3060
3061 strbuf_addf(&msg, _("If you want to reuse this local git "
3062 "directory instead of cloning again from\n"
3063 " %s\n"
3064 "use the '--force' option. If the local git "
3065 "directory is not the correct repo\n"
3066 "or you are unsure what this means choose "
3067 "another name with the '--name' option."),
3068 add_data->realrepo);
3069
3070 die_msg = strbuf_detach(&msg, NULL);
3071 die("%s", die_msg);
3072 } else {
3073 printf(_("Reactivating local git directory for "
3074 "submodule '%s'\n"), add_data->sm_name);
3075 }
3076 }
3077 free(submod_gitdir_path);
3078
3079 clone_data.prefix = add_data->prefix;
3080 clone_data.path = add_data->sm_path;
3081 clone_data.name = add_data->sm_name;
3082 clone_data.url = add_data->realrepo;
3083 clone_data.quiet = add_data->quiet;
3084 clone_data.progress = add_data->progress;
3085 if (add_data->reference_path)
3086 string_list_append(&clone_data.reference,
3087 xstrdup(add_data->reference_path));
3088 clone_data.dissociate = add_data->dissociate;
3089 if (add_data->depth >= 0)
3090 clone_data.depth = xstrfmt("%d", add_data->depth);
3091
3092 if (clone_submodule(&clone_data))
3093 return -1;
3094
3095 prepare_submodule_repo_env(&cp.env_array);
3096 cp.git_cmd = 1;
3097 cp.dir = add_data->sm_path;
3098 /*
3099 * NOTE: we only get here if add_data->force is true, so
3100 * passing --force to checkout is reasonable.
3101 */
3102 strvec_pushl(&cp.args, "checkout", "-f", "-q", NULL);
3103
3104 if (add_data->branch) {
3105 strvec_pushl(&cp.args, "-B", add_data->branch, NULL);
3106 strvec_pushf(&cp.args, "origin/%s", add_data->branch);
3107 }
3108
3109 if (run_command(&cp))
3110 die(_("unable to checkout submodule '%s'"), add_data->sm_path);
3111 }
3112 return 0;
3113 }
3114
3115 static int config_submodule_in_gitmodules(const char *name, const char *var, const char *value)
3116 {
3117 char *key;
3118 int ret;
3119
3120 if (!is_writing_gitmodules_ok())
3121 die(_("please make sure that the .gitmodules file is in the working tree"));
3122
3123 key = xstrfmt("submodule.%s.%s", name, var);
3124 ret = config_set_in_gitmodules_file_gently(key, value);
3125 free(key);
3126
3127 return ret;
3128 }
3129
3130 static void configure_added_submodule(struct add_data *add_data)
3131 {
3132 char *key;
3133 char *val = NULL;
3134 struct child_process add_submod = CHILD_PROCESS_INIT;
3135 struct child_process add_gitmodules = CHILD_PROCESS_INIT;
3136
3137 key = xstrfmt("submodule.%s.url", add_data->sm_name);
3138 git_config_set_gently(key, add_data->realrepo);
3139 free(key);
3140
3141 add_submod.git_cmd = 1;
3142 strvec_pushl(&add_submod.args, "add",
3143 "--no-warn-embedded-repo", NULL);
3144 if (add_data->force)
3145 strvec_push(&add_submod.args, "--force");
3146 strvec_pushl(&add_submod.args, "--", add_data->sm_path, NULL);
3147
3148 if (run_command(&add_submod))
3149 die(_("Failed to add submodule '%s'"), add_data->sm_path);
3150
3151 if (config_submodule_in_gitmodules(add_data->sm_name, "path", add_data->sm_path) ||
3152 config_submodule_in_gitmodules(add_data->sm_name, "url", add_data->repo))
3153 die(_("Failed to register submodule '%s'"), add_data->sm_path);
3154
3155 if (add_data->branch) {
3156 if (config_submodule_in_gitmodules(add_data->sm_name,
3157 "branch", add_data->branch))
3158 die(_("Failed to register submodule '%s'"), add_data->sm_path);
3159 }
3160
3161 add_gitmodules.git_cmd = 1;
3162 strvec_pushl(&add_gitmodules.args,
3163 "add", "--force", "--", ".gitmodules", NULL);
3164
3165 if (run_command(&add_gitmodules))
3166 die(_("Failed to register submodule '%s'"), add_data->sm_path);
3167
3168 /*
3169 * NEEDSWORK: In a multi-working-tree world this needs to be
3170 * set in the per-worktree config.
3171 */
3172 /*
3173 * NEEDSWORK: In the longer run, we need to get rid of this
3174 * pattern of querying "submodule.active" before calling
3175 * is_submodule_active(), since that function needs to find
3176 * out the value of "submodule.active" again anyway.
3177 */
3178 if (!git_config_get_string("submodule.active", &val) && val) {
3179 /*
3180 * If the submodule being added isn't already covered by the
3181 * current configured pathspec, set the submodule's active flag
3182 */
3183 if (!is_submodule_active(the_repository, add_data->sm_path)) {
3184 key = xstrfmt("submodule.%s.active", add_data->sm_name);
3185 git_config_set_gently(key, "true");
3186 free(key);
3187 }
3188 } else {
3189 key = xstrfmt("submodule.%s.active", add_data->sm_name);
3190 git_config_set_gently(key, "true");
3191 free(key);
3192 }
3193 }
3194
3195 static void die_on_index_match(const char *path, int force)
3196 {
3197 struct pathspec ps;
3198 const char *args[] = { path, NULL };
3199 parse_pathspec(&ps, 0, PATHSPEC_PREFER_CWD, NULL, args);
3200
3201 if (read_cache_preload(NULL) < 0)
3202 die(_("index file corrupt"));
3203
3204 if (ps.nr) {
3205 int i;
3206 char *ps_matched = xcalloc(ps.nr, 1);
3207
3208 /* TODO: audit for interaction with sparse-index. */
3209 ensure_full_index(&the_index);
3210
3211 /*
3212 * Since there is only one pathspec, we just need
3213 * need to check ps_matched[0] to know if a cache
3214 * entry matched.
3215 */
3216 for (i = 0; i < active_nr; i++) {
3217 ce_path_match(&the_index, active_cache[i], &ps,
3218 ps_matched);
3219
3220 if (ps_matched[0]) {
3221 if (!force)
3222 die(_("'%s' already exists in the index"),
3223 path);
3224 if (!S_ISGITLINK(active_cache[i]->ce_mode))
3225 die(_("'%s' already exists in the index "
3226 "and is not a submodule"), path);
3227 break;
3228 }
3229 }
3230 free(ps_matched);
3231 }
3232 clear_pathspec(&ps);
3233 }
3234
3235 static void die_on_repo_without_commits(const char *path)
3236 {
3237 struct strbuf sb = STRBUF_INIT;
3238 strbuf_addstr(&sb, path);
3239 if (is_nonbare_repository_dir(&sb)) {
3240 struct object_id oid;
3241 if (resolve_gitlink_ref(path, "HEAD", &oid) < 0)
3242 die(_("'%s' does not have a commit checked out"), path);
3243 }
3244 strbuf_release(&sb);
3245 }
3246
3247 static int module_add(int argc, const char **argv, const char *prefix)
3248 {
3249 int force = 0, quiet = 0, progress = 0, dissociate = 0;
3250 struct add_data add_data = ADD_DATA_INIT;
3251
3252 struct option options[] = {
3253 OPT_STRING('b', "branch", &add_data.branch, N_("branch"),
3254 N_("branch of repository to add as submodule")),
3255 OPT__FORCE(&force, N_("allow adding an otherwise ignored submodule path"),
3256 PARSE_OPT_NOCOMPLETE),
3257 OPT__QUIET(&quiet, N_("print only error messages")),
3258 OPT_BOOL(0, "progress", &progress, N_("force cloning progress")),
3259 OPT_STRING(0, "reference", &add_data.reference_path, N_("repository"),
3260 N_("reference repository")),
3261 OPT_BOOL(0, "dissociate", &dissociate, N_("borrow the objects from reference repositories")),
3262 OPT_STRING(0, "name", &add_data.sm_name, N_("name"),
3263 N_("sets the submodule’s name to the given string "
3264 "instead of defaulting to its path")),
3265 OPT_INTEGER(0, "depth", &add_data.depth, N_("depth for shallow clones")),
3266 OPT_END()
3267 };
3268
3269 const char *const usage[] = {
3270 N_("git submodule--helper add [<options>] [--] <repository> [<path>]"),
3271 NULL
3272 };
3273
3274 argc = parse_options(argc, argv, prefix, options, usage, 0);
3275
3276 if (!is_writing_gitmodules_ok())
3277 die(_("please make sure that the .gitmodules file is in the working tree"));
3278
3279 if (prefix && *prefix &&
3280 add_data.reference_path && !is_absolute_path(add_data.reference_path))
3281 add_data.reference_path = xstrfmt("%s%s", prefix, add_data.reference_path);
3282
3283 if (argc == 0 || argc > 2)
3284 usage_with_options(usage, options);
3285
3286 add_data.repo = argv[0];
3287 if (argc == 1)
3288 add_data.sm_path = git_url_basename(add_data.repo, 0, 0);
3289 else
3290 add_data.sm_path = xstrdup(argv[1]);
3291
3292 if (prefix && *prefix && !is_absolute_path(add_data.sm_path))
3293 add_data.sm_path = xstrfmt("%s%s", prefix, add_data.sm_path);
3294
3295 if (starts_with_dot_dot_slash(add_data.repo) ||
3296 starts_with_dot_slash(add_data.repo)) {
3297 if (prefix)
3298 die(_("Relative path can only be used from the toplevel "
3299 "of the working tree"));
3300
3301 /* dereference source url relative to parent's url */
3302 add_data.realrepo = resolve_relative_url(add_data.repo, NULL, 1);
3303 } else if (is_dir_sep(add_data.repo[0]) || strchr(add_data.repo, ':')) {
3304 add_data.realrepo = add_data.repo;
3305 } else {
3306 die(_("repo URL: '%s' must be absolute or begin with ./|../"),
3307 add_data.repo);
3308 }
3309
3310 /*
3311 * normalize path:
3312 * multiple //; leading ./; /./; /../;
3313 */
3314 normalize_path_copy(add_data.sm_path, add_data.sm_path);
3315 strip_dir_trailing_slashes(add_data.sm_path);
3316
3317 die_on_index_match(add_data.sm_path, force);
3318 die_on_repo_without_commits(add_data.sm_path);
3319
3320 if (!force) {
3321 int exit_code = -1;
3322 struct strbuf sb = STRBUF_INIT;
3323 struct child_process cp = CHILD_PROCESS_INIT;
3324 cp.git_cmd = 1;
3325 cp.no_stdout = 1;
3326 strvec_pushl(&cp.args, "add", "--dry-run", "--ignore-missing",
3327 "--no-warn-embedded-repo", add_data.sm_path, NULL);
3328 if ((exit_code = pipe_command(&cp, NULL, 0, NULL, 0, &sb, 0))) {
3329 strbuf_complete_line(&sb);
3330 fputs(sb.buf, stderr);
3331 free(add_data.sm_path);
3332 return exit_code;
3333 }
3334 strbuf_release(&sb);
3335 }
3336
3337 if(!add_data.sm_name)
3338 add_data.sm_name = add_data.sm_path;
3339
3340 if (check_submodule_name(add_data.sm_name))
3341 die(_("'%s' is not a valid submodule name"), add_data.sm_name);
3342
3343 add_data.prefix = prefix;
3344 add_data.force = !!force;
3345 add_data.quiet = !!quiet;
3346 add_data.progress = !!progress;
3347 add_data.dissociate = !!dissociate;
3348
3349 if (add_submodule(&add_data)) {
3350 free(add_data.sm_path);
3351 return 1;
3352 }
3353 configure_added_submodule(&add_data);
3354 free(add_data.sm_path);
3355
3356 return 0;
3357 }
3358
3359 #define SUPPORT_SUPER_PREFIX (1<<0)
3360
3361 struct cmd_struct {
3362 const char *cmd;
3363 int (*fn)(int, const char **, const char *);
3364 unsigned option;
3365 };
3366
3367 static struct cmd_struct commands[] = {
3368 {"list", module_list, 0},
3369 {"name", module_name, 0},
3370 {"clone", module_clone, 0},
3371 {"add", module_add, SUPPORT_SUPER_PREFIX},
3372 {"update-module-mode", module_update_module_mode, 0},
3373 {"update-clone", update_clone, 0},
3374 {"run-update-procedure", run_update_procedure, 0},
3375 {"ensure-core-worktree", ensure_core_worktree, 0},
3376 {"relative-path", resolve_relative_path, 0},
3377 {"resolve-relative-url-test", resolve_relative_url_test, 0},
3378 {"foreach", module_foreach, SUPPORT_SUPER_PREFIX},
3379 {"init", module_init, SUPPORT_SUPER_PREFIX},
3380 {"status", module_status, SUPPORT_SUPER_PREFIX},
3381 {"print-default-remote", print_default_remote, 0},
3382 {"sync", module_sync, SUPPORT_SUPER_PREFIX},
3383 {"deinit", module_deinit, 0},
3384 {"summary", module_summary, SUPPORT_SUPER_PREFIX},
3385 {"remote-branch", resolve_remote_submodule_branch, 0},
3386 {"push-check", push_check, 0},
3387 {"absorb-git-dirs", absorb_git_dirs, SUPPORT_SUPER_PREFIX},
3388 {"is-active", is_active, 0},
3389 {"check-name", check_name, 0},
3390 {"config", module_config, 0},
3391 {"set-url", module_set_url, 0},
3392 {"set-branch", module_set_branch, 0},
3393 };
3394
3395 int cmd_submodule__helper(int argc, const char **argv, const char *prefix)
3396 {
3397 int i;
3398 if (argc < 2 || !strcmp(argv[1], "-h"))
3399 usage("git submodule--helper <command>");
3400
3401 for (i = 0; i < ARRAY_SIZE(commands); i++) {
3402 if (!strcmp(argv[1], commands[i].cmd)) {
3403 if (get_super_prefix() &&
3404 !(commands[i].option & SUPPORT_SUPER_PREFIX))
3405 die(_("%s doesn't support --super-prefix"),
3406 commands[i].cmd);
3407 return commands[i].fn(argc - 1, argv + 1, prefix);
3408 }
3409 }
3410
3411 die(_("'%s' is not a valid submodule--helper "
3412 "subcommand"), argv[1]);
3413 }
The Best VCS Around