1 #define USE_THE_INDEX_VARIABLE
5 #include "environment.h"
8 #include "repository.h"
11 #include "parse-options.h"
16 #include "submodule.h"
17 #include "submodule-config.h"
18 #include "string-list.h"
19 #include "run-command.h"
27 #include "object-file.h"
28 #include "object-name.h"
29 #include "object-store.h"
32 #include "list-objects-filter-options.h"
34 #define OPT_QUIET (1 << 0)
35 #define OPT_CACHED (1 << 1)
36 #define OPT_RECURSIVE (1 << 2)
37 #define OPT_FORCE (1 << 3)
39 typedef void (*each_submodule_fn
)(const struct cache_entry
*list_item
,
42 static int repo_get_default_remote(struct repository
*repo
, char **default_remote
)
45 struct strbuf sb
= STRBUF_INIT
;
46 struct ref_store
*store
= get_main_ref_store(repo
);
47 const char *refname
= refs_resolve_ref_unsafe(store
, "HEAD", 0, NULL
,
51 return die_message(_("No such ref: %s"), "HEAD");
54 if (!strcmp(refname
, "HEAD")) {
55 *default_remote
= xstrdup("origin");
59 if (!skip_prefix(refname
, "refs/heads/", &refname
))
60 return die_message(_("Expecting a full ref name, got %s"),
63 strbuf_addf(&sb
, "branch.%s.remote", refname
);
64 if (repo_config_get_string(repo
, sb
.buf
, &dest
))
65 *default_remote
= xstrdup("origin");
67 *default_remote
= dest
;
73 static int get_default_remote_submodule(const char *module_path
, char **default_remote
)
75 struct repository subrepo
;
78 if (repo_submodule_init(&subrepo
, the_repository
, module_path
,
80 return die_message(_("could not get a repository handle for submodule '%s'"),
82 ret
= repo_get_default_remote(&subrepo
, default_remote
);
88 static char *get_default_remote(void)
91 int code
= repo_get_default_remote(the_repository
, &default_remote
);
96 return default_remote
;
99 static char *resolve_relative_url(const char *rel_url
, const char *up_path
, int quiet
)
101 char *remoteurl
, *resolved_url
;
102 char *remote
= get_default_remote();
103 struct strbuf remotesb
= STRBUF_INIT
;
105 strbuf_addf(&remotesb
, "remote.%s.url", remote
);
106 if (git_config_get_string(remotesb
.buf
, &remoteurl
)) {
108 warning(_("could not look up configuration '%s'. "
109 "Assuming this repository is its own "
110 "authoritative upstream."),
112 remoteurl
= xgetcwd();
114 resolved_url
= relative_url(remoteurl
, rel_url
, up_path
);
118 strbuf_release(&remotesb
);
123 /* the result should be freed by the caller. */
124 static char *get_submodule_displaypath(const char *path
, const char *prefix
,
125 const char *super_prefix
)
127 if (prefix
&& super_prefix
) {
128 BUG("cannot have prefix '%s' and superprefix '%s'",
129 prefix
, super_prefix
);
131 struct strbuf sb
= STRBUF_INIT
;
132 char *displaypath
= xstrdup(relative_path(path
, prefix
, &sb
));
135 } else if (super_prefix
) {
136 return xstrfmt("%s%s", super_prefix
, path
);
138 return xstrdup(path
);
142 static char *compute_rev_name(const char *sub_path
, const char* object_id
)
144 struct strbuf sb
= STRBUF_INIT
;
147 static const char *describe_bare
[] = { NULL
};
149 static const char *describe_tags
[] = { "--tags", NULL
};
151 static const char *describe_contains
[] = { "--contains", NULL
};
153 static const char *describe_all_always
[] = { "--all", "--always", NULL
};
155 static const char **describe_argv
[] = { describe_bare
, describe_tags
,
157 describe_all_always
, NULL
};
159 for (d
= describe_argv
; *d
; d
++) {
160 struct child_process cp
= CHILD_PROCESS_INIT
;
161 prepare_submodule_repo_env(&cp
.env
);
166 strvec_push(&cp
.args
, "describe");
167 strvec_pushv(&cp
.args
, *d
);
168 strvec_push(&cp
.args
, object_id
);
170 if (!capture_command(&cp
, &sb
, 0)) {
171 strbuf_strip_suffix(&sb
, "\n");
172 return strbuf_detach(&sb
, NULL
);
181 const struct cache_entry
**entries
;
184 #define MODULE_LIST_INIT { 0 }
186 static void module_list_release(struct module_list
*ml
)
191 static int module_list_compute(const char **argv
,
193 struct pathspec
*pathspec
,
194 struct module_list
*list
)
197 char *ps_matched
= NULL
;
199 parse_pathspec(pathspec
, 0,
200 PATHSPEC_PREFER_FULL
,
204 ps_matched
= xcalloc(pathspec
->nr
, 1);
206 if (repo_read_index(the_repository
) < 0)
207 die(_("index file corrupt"));
209 for (i
= 0; i
< the_index
.cache_nr
; i
++) {
210 const struct cache_entry
*ce
= the_index
.cache
[i
];
212 if (!match_pathspec(&the_index
, pathspec
, ce
->name
, ce_namelen(ce
),
214 !S_ISGITLINK(ce
->ce_mode
))
217 ALLOC_GROW(list
->entries
, list
->nr
+ 1, list
->alloc
);
218 list
->entries
[list
->nr
++] = ce
;
219 while (i
+ 1 < the_index
.cache_nr
&&
220 !strcmp(ce
->name
, the_index
.cache
[i
+ 1]->name
))
222 * Skip entries with the same name in different stages
223 * to make sure an entry is returned only once.
228 if (ps_matched
&& report_path_error(ps_matched
, pathspec
))
236 static void module_list_active(struct module_list
*list
)
239 struct module_list active_modules
= MODULE_LIST_INIT
;
241 for (i
= 0; i
< list
->nr
; i
++) {
242 const struct cache_entry
*ce
= list
->entries
[i
];
244 if (!is_submodule_active(the_repository
, ce
->name
))
247 ALLOC_GROW(active_modules
.entries
,
248 active_modules
.nr
+ 1,
249 active_modules
.alloc
);
250 active_modules
.entries
[active_modules
.nr
++] = ce
;
253 module_list_release(list
);
254 *list
= active_modules
;
257 static char *get_up_path(const char *path
)
260 struct strbuf sb
= STRBUF_INIT
;
262 for (i
= count_slashes(path
); i
; i
--)
263 strbuf_addstr(&sb
, "../");
266 * Check if 'path' ends with slash or not
267 * for having the same output for dir/sub_dir
270 if (!is_dir_sep(path
[strlen(path
) - 1]))
271 strbuf_addstr(&sb
, "../");
273 return strbuf_detach(&sb
, NULL
);
276 static void for_each_listed_submodule(const struct module_list
*list
,
277 each_submodule_fn fn
, void *cb_data
)
281 for (i
= 0; i
< list
->nr
; i
++)
282 fn(list
->entries
[i
], cb_data
);
289 const char *super_prefix
;
293 #define FOREACH_CB_INIT { 0 }
295 static void runcommand_in_submodule_cb(const struct cache_entry
*list_item
,
298 struct foreach_cb
*info
= cb_data
;
299 const char *path
= list_item
->name
;
300 const struct object_id
*ce_oid
= &list_item
->oid
;
301 const struct submodule
*sub
;
302 struct child_process cp
= CHILD_PROCESS_INIT
;
305 displaypath
= get_submodule_displaypath(path
, info
->prefix
,
308 sub
= submodule_from_path(the_repository
, null_oid(), path
);
311 die(_("No url found for submodule path '%s' in .gitmodules"),
314 if (!is_submodule_populated_gently(path
, NULL
))
317 prepare_submodule_repo_env(&cp
.env
);
320 * For the purpose of executing <command> in the submodule,
321 * separate shell is used for the purpose of running the
328 * NEEDSWORK: the command currently has access to the variables $name,
329 * $sm_path, $displaypath, $sha1 and $toplevel only when the command
330 * contains a single argument. This is done for maintaining a faithful
331 * translation from shell script.
333 if (info
->argc
== 1) {
334 char *toplevel
= xgetcwd();
335 struct strbuf sb
= STRBUF_INIT
;
337 strvec_pushf(&cp
.env
, "name=%s", sub
->name
);
338 strvec_pushf(&cp
.env
, "sm_path=%s", path
);
339 strvec_pushf(&cp
.env
, "displaypath=%s", displaypath
);
340 strvec_pushf(&cp
.env
, "sha1=%s",
342 strvec_pushf(&cp
.env
, "toplevel=%s", toplevel
);
345 * Since the path variable was accessible from the script
346 * before porting, it is also made available after porting.
347 * The environment variable "PATH" has a very special purpose
348 * on windows. And since environment variables are
349 * case-insensitive in windows, it interferes with the
350 * existing PATH variable. Hence, to avoid that, we expose
351 * path via the args strvec and not via env.
353 sq_quote_buf(&sb
, path
);
354 strvec_pushf(&cp
.args
, "path=%s; %s",
355 sb
.buf
, info
->argv
[0]);
359 strvec_pushv(&cp
.args
, info
->argv
);
363 printf(_("Entering '%s'\n"), displaypath
);
365 if (info
->argv
[0] && run_command(&cp
))
366 die(_("run_command returned non-zero status for %s\n."),
369 if (info
->recursive
) {
370 struct child_process cpr
= CHILD_PROCESS_INIT
;
374 prepare_submodule_repo_env(&cpr
.env
);
376 strvec_pushl(&cpr
.args
, "submodule--helper", "foreach", "--recursive",
378 strvec_pushl(&cpr
.args
, "--super-prefix", NULL
);
379 strvec_pushf(&cpr
.args
, "%s/", displaypath
);
382 strvec_push(&cpr
.args
, "--quiet");
384 strvec_push(&cpr
.args
, "--");
385 strvec_pushv(&cpr
.args
, info
->argv
);
387 if (run_command(&cpr
))
388 die(_("run_command returned non-zero status while "
389 "recursing in the nested submodules of %s\n."),
397 static int module_foreach(int argc
, const char **argv
, const char *prefix
)
399 struct foreach_cb info
= FOREACH_CB_INIT
;
400 struct pathspec pathspec
= { 0 };
401 struct module_list list
= MODULE_LIST_INIT
;
402 struct option module_foreach_options
[] = {
403 OPT__SUPER_PREFIX(&info
.super_prefix
),
404 OPT__QUIET(&info
.quiet
, N_("suppress output of entering each submodule command")),
405 OPT_BOOL(0, "recursive", &info
.recursive
,
406 N_("recurse into nested submodules")),
409 const char *const git_submodule_helper_usage
[] = {
410 N_("git submodule foreach [--quiet] [--recursive] [--] <command>"),
415 argc
= parse_options(argc
, argv
, prefix
, module_foreach_options
,
416 git_submodule_helper_usage
, 0);
418 if (module_list_compute(NULL
, prefix
, &pathspec
, &list
) < 0)
423 info
.prefix
= prefix
;
425 for_each_listed_submodule(&list
, runcommand_in_submodule_cb
, &info
);
429 module_list_release(&list
);
430 clear_pathspec(&pathspec
);
434 static int starts_with_dot_slash(const char *const path
)
436 return path_match_flags(path
, PATH_MATCH_STARTS_WITH_DOT_SLASH
|
437 PATH_MATCH_XPLATFORM
);
440 static int starts_with_dot_dot_slash(const char *const path
)
442 return path_match_flags(path
, PATH_MATCH_STARTS_WITH_DOT_DOT_SLASH
|
443 PATH_MATCH_XPLATFORM
);
448 const char *super_prefix
;
451 #define INIT_CB_INIT { 0 }
453 static void init_submodule(const char *path
, const char *prefix
,
454 const char *super_prefix
,
457 const struct submodule
*sub
;
458 struct strbuf sb
= STRBUF_INIT
;
460 char *url
= NULL
, *displaypath
;
462 displaypath
= get_submodule_displaypath(path
, prefix
, super_prefix
);
464 sub
= submodule_from_path(the_repository
, null_oid(), path
);
467 die(_("No url found for submodule path '%s' in .gitmodules"),
471 * NEEDSWORK: In a multi-working-tree world, this needs to be
472 * set in the per-worktree config.
474 * Set active flag for the submodule being initialized
476 if (!is_submodule_active(the_repository
, path
)) {
477 strbuf_addf(&sb
, "submodule.%s.active", sub
->name
);
478 git_config_set_gently(sb
.buf
, "true");
483 * Copy url setting when it is not set yet.
484 * To look up the url in .git/config, we must not fall back to
485 * .gitmodules, so look it up directly.
487 strbuf_addf(&sb
, "submodule.%s.url", sub
->name
);
488 if (git_config_get_string(sb
.buf
, &url
)) {
490 die(_("No url found for submodule path '%s' in .gitmodules"),
493 url
= xstrdup(sub
->url
);
495 /* Possibly a url relative to parent */
496 if (starts_with_dot_dot_slash(url
) ||
497 starts_with_dot_slash(url
)) {
500 url
= resolve_relative_url(oldurl
, NULL
, 0);
504 if (git_config_set_gently(sb
.buf
, url
))
505 die(_("Failed to register url for submodule path '%s'"),
507 if (!(flags
& OPT_QUIET
))
509 _("Submodule '%s' (%s) registered for path '%s'\n"),
510 sub
->name
, url
, displaypath
);
514 /* Copy "update" setting when it is not set yet */
515 strbuf_addf(&sb
, "submodule.%s.update", sub
->name
);
516 if (git_config_get_string_tmp(sb
.buf
, &upd
) &&
517 sub
->update_strategy
.type
!= SM_UPDATE_UNSPECIFIED
) {
518 if (sub
->update_strategy
.type
== SM_UPDATE_COMMAND
) {
519 fprintf(stderr
, _("warning: command update mode suggested for submodule '%s'\n"),
523 upd
= submodule_update_type_to_string(sub
->update_strategy
.type
);
526 if (git_config_set_gently(sb
.buf
, upd
))
527 die(_("Failed to register update mode for submodule path '%s'"), displaypath
);
534 static void init_submodule_cb(const struct cache_entry
*list_item
, void *cb_data
)
536 struct init_cb
*info
= cb_data
;
538 init_submodule(list_item
->name
, info
->prefix
, info
->super_prefix
,
542 static int module_init(int argc
, const char **argv
, const char *prefix
)
544 struct init_cb info
= INIT_CB_INIT
;
545 struct pathspec pathspec
= { 0 };
546 struct module_list list
= MODULE_LIST_INIT
;
548 struct option module_init_options
[] = {
549 OPT__QUIET(&quiet
, N_("suppress output for initializing a submodule")),
552 const char *const git_submodule_helper_usage
[] = {
553 N_("git submodule init [<options>] [<path>]"),
558 argc
= parse_options(argc
, argv
, prefix
, module_init_options
,
559 git_submodule_helper_usage
, 0);
561 if (module_list_compute(argv
, prefix
, &pathspec
, &list
) < 0)
565 * If there are no path args and submodule.active is set then,
566 * by default, only initialize 'active' modules.
568 if (!argc
&& !git_config_get("submodule.active"))
569 module_list_active(&list
);
571 info
.prefix
= prefix
;
573 info
.flags
|= OPT_QUIET
;
575 for_each_listed_submodule(&list
, init_submodule_cb
, &info
);
579 module_list_release(&list
);
580 clear_pathspec(&pathspec
);
586 const char *super_prefix
;
589 #define STATUS_CB_INIT { 0 }
591 static void print_status(unsigned int flags
, char state
, const char *path
,
592 const struct object_id
*oid
, const char *displaypath
)
594 if (flags
& OPT_QUIET
)
597 printf("%c%s %s", state
, oid_to_hex(oid
), displaypath
);
599 if (state
== ' ' || state
== '+') {
600 char *name
= compute_rev_name(path
, oid_to_hex(oid
));
603 printf(" (%s)", name
);
610 static int handle_submodule_head_ref(const char *refname UNUSED
,
611 const struct object_id
*oid
,
615 struct object_id
*output
= cb_data
;
623 static void status_submodule(const char *path
, const struct object_id
*ce_oid
,
624 unsigned int ce_flags
, const char *prefix
,
625 const char *super_prefix
, unsigned int flags
)
628 struct strvec diff_files_args
= STRVEC_INIT
;
629 struct rev_info rev
= REV_INFO_INIT
;
630 int diff_files_result
;
631 struct strbuf buf
= STRBUF_INIT
;
633 struct setup_revision_opt opt
= {
634 .free_removed_argv_elements
= 1,
637 if (!submodule_from_path(the_repository
, null_oid(), path
))
638 die(_("no submodule mapping found in .gitmodules for path '%s'"),
641 displaypath
= get_submodule_displaypath(path
, prefix
, super_prefix
);
643 if ((CE_STAGEMASK
& ce_flags
) >> CE_STAGESHIFT
) {
644 print_status(flags
, 'U', path
, null_oid(), displaypath
);
648 strbuf_addf(&buf
, "%s/.git", path
);
649 git_dir
= read_gitfile(buf
.buf
);
653 if (!is_submodule_active(the_repository
, path
) ||
654 !is_git_directory(git_dir
)) {
655 print_status(flags
, '-', path
, ce_oid
, displaypath
);
656 strbuf_release(&buf
);
659 strbuf_release(&buf
);
661 strvec_pushl(&diff_files_args
, "diff-files",
662 "--ignore-submodules=dirty", "--quiet", "--",
665 git_config(git_diff_basic_config
, NULL
);
667 repo_init_revisions(the_repository
, &rev
, NULL
);
669 setup_revisions(diff_files_args
.nr
, diff_files_args
.v
, &rev
, &opt
);
670 diff_files_result
= run_diff_files(&rev
, 0);
672 if (!diff_result_code(&rev
.diffopt
, diff_files_result
)) {
673 print_status(flags
, ' ', path
, ce_oid
,
675 } else if (!(flags
& OPT_CACHED
)) {
676 struct object_id oid
;
677 struct ref_store
*refs
= get_submodule_ref_store(path
);
680 print_status(flags
, '-', path
, ce_oid
, displaypath
);
683 if (refs_head_ref(refs
, handle_submodule_head_ref
, &oid
))
684 die(_("could not resolve HEAD ref inside the "
685 "submodule '%s'"), path
);
687 print_status(flags
, '+', path
, &oid
, displaypath
);
689 print_status(flags
, '+', path
, ce_oid
, displaypath
);
692 if (flags
& OPT_RECURSIVE
) {
693 struct child_process cpr
= CHILD_PROCESS_INIT
;
697 prepare_submodule_repo_env(&cpr
.env
);
699 strvec_pushl(&cpr
.args
, "submodule--helper", "status",
700 "--recursive", NULL
);
701 strvec_push(&cpr
.args
, "--super-prefix");
702 strvec_pushf(&cpr
.args
, "%s/", displaypath
);
704 if (flags
& OPT_CACHED
)
705 strvec_push(&cpr
.args
, "--cached");
707 if (flags
& OPT_QUIET
)
708 strvec_push(&cpr
.args
, "--quiet");
710 if (run_command(&cpr
))
711 die(_("failed to recurse into submodule '%s'"), path
);
715 strvec_clear(&diff_files_args
);
717 release_revisions(&rev
);
720 static void status_submodule_cb(const struct cache_entry
*list_item
,
723 struct status_cb
*info
= cb_data
;
725 status_submodule(list_item
->name
, &list_item
->oid
, list_item
->ce_flags
,
726 info
->prefix
, info
->super_prefix
, info
->flags
);
729 static int module_status(int argc
, const char **argv
, const char *prefix
)
731 struct status_cb info
= STATUS_CB_INIT
;
732 struct pathspec pathspec
= { 0 };
733 struct module_list list
= MODULE_LIST_INIT
;
735 struct option module_status_options
[] = {
736 OPT__SUPER_PREFIX(&info
.super_prefix
),
737 OPT__QUIET(&quiet
, N_("suppress submodule status output")),
738 OPT_BIT(0, "cached", &info
.flags
, N_("use commit stored in the index instead of the one stored in the submodule HEAD"), OPT_CACHED
),
739 OPT_BIT(0, "recursive", &info
.flags
, N_("recurse into nested submodules"), OPT_RECURSIVE
),
742 const char *const git_submodule_helper_usage
[] = {
743 N_("git submodule status [--quiet] [--cached] [--recursive] [<path>...]"),
748 argc
= parse_options(argc
, argv
, prefix
, module_status_options
,
749 git_submodule_helper_usage
, 0);
751 if (module_list_compute(argv
, prefix
, &pathspec
, &list
) < 0)
754 info
.prefix
= prefix
;
756 info
.flags
|= OPT_QUIET
;
758 for_each_listed_submodule(&list
, status_submodule_cb
, &info
);
762 module_list_release(&list
);
763 clear_pathspec(&pathspec
);
768 unsigned int mod_src
;
769 unsigned int mod_dst
;
770 struct object_id oid_src
;
771 struct object_id oid_dst
;
775 #define MODULE_CB_INIT { 0 }
777 static void module_cb_release(struct module_cb
*mcb
)
782 struct module_cb_list
{
783 struct module_cb
**entries
;
786 #define MODULE_CB_LIST_INIT { 0 }
788 static void module_cb_list_release(struct module_cb_list
*mcbl
)
792 for (i
= 0; i
< mcbl
->nr
; i
++) {
793 struct module_cb
*mcb
= mcbl
->entries
[i
];
795 module_cb_release(mcb
);
805 const char *super_prefix
;
806 unsigned int cached
: 1;
807 unsigned int for_status
: 1;
808 unsigned int files
: 1;
811 #define SUMMARY_CB_INIT { 0 }
818 static char *verify_submodule_committish(const char *sm_path
,
819 const char *committish
)
821 struct child_process cp_rev_parse
= CHILD_PROCESS_INIT
;
822 struct strbuf result
= STRBUF_INIT
;
824 cp_rev_parse
.git_cmd
= 1;
825 cp_rev_parse
.dir
= sm_path
;
826 prepare_submodule_repo_env(&cp_rev_parse
.env
);
827 strvec_pushl(&cp_rev_parse
.args
, "rev-parse", "-q", "--short", NULL
);
828 strvec_pushf(&cp_rev_parse
.args
, "%s^0", committish
);
829 strvec_push(&cp_rev_parse
.args
, "--");
831 if (capture_command(&cp_rev_parse
, &result
, 0))
834 strbuf_trim_trailing_newline(&result
);
835 return strbuf_detach(&result
, NULL
);
838 static void print_submodule_summary(struct summary_cb
*info
, const char *errmsg
,
839 int total_commits
, const char *displaypath
,
840 const char *src_abbrev
, const char *dst_abbrev
,
843 if (p
->status
== 'T') {
844 if (S_ISGITLINK(p
->mod_dst
))
845 printf(_("* %s %s(blob)->%s(submodule)"),
846 displaypath
, src_abbrev
, dst_abbrev
);
848 printf(_("* %s %s(submodule)->%s(blob)"),
849 displaypath
, src_abbrev
, dst_abbrev
);
851 printf("* %s %s...%s",
852 displaypath
, src_abbrev
, dst_abbrev
);
855 if (total_commits
< 0)
858 printf(" (%d):\n", total_commits
);
861 printf(_("%s"), errmsg
);
862 } else if (total_commits
> 0) {
863 struct child_process cp_log
= CHILD_PROCESS_INIT
;
866 cp_log
.dir
= p
->sm_path
;
867 prepare_submodule_repo_env(&cp_log
.env
);
868 strvec_pushl(&cp_log
.args
, "log", NULL
);
870 if (S_ISGITLINK(p
->mod_src
) && S_ISGITLINK(p
->mod_dst
)) {
871 if (info
->summary_limit
> 0)
872 strvec_pushf(&cp_log
.args
, "-%d",
873 info
->summary_limit
);
875 strvec_pushl(&cp_log
.args
, "--pretty= %m %s",
876 "--first-parent", NULL
);
877 strvec_pushf(&cp_log
.args
, "%s...%s",
878 src_abbrev
, dst_abbrev
);
879 } else if (S_ISGITLINK(p
->mod_dst
)) {
880 strvec_pushl(&cp_log
.args
, "--pretty= > %s",
881 "-1", dst_abbrev
, NULL
);
883 strvec_pushl(&cp_log
.args
, "--pretty= < %s",
884 "-1", src_abbrev
, NULL
);
886 run_command(&cp_log
);
891 static void generate_submodule_summary(struct summary_cb
*info
,
894 char *displaypath
, *src_abbrev
= NULL
, *dst_abbrev
;
895 int missing_src
= 0, missing_dst
= 0;
896 struct strbuf errmsg
= STRBUF_INIT
;
897 int total_commits
= -1;
899 if (!info
->cached
&& oideq(&p
->oid_dst
, null_oid())) {
900 if (S_ISGITLINK(p
->mod_dst
)) {
901 struct ref_store
*refs
= get_submodule_ref_store(p
->sm_path
);
904 refs_head_ref(refs
, handle_submodule_head_ref
, &p
->oid_dst
);
905 } else if (S_ISLNK(p
->mod_dst
) || S_ISREG(p
->mod_dst
)) {
907 int fd
= open(p
->sm_path
, O_RDONLY
);
909 if (fd
< 0 || fstat(fd
, &st
) < 0 ||
910 index_fd(&the_index
, &p
->oid_dst
, fd
, &st
, OBJ_BLOB
,
912 error(_("couldn't hash object from '%s'"), p
->sm_path
);
914 /* for a submodule removal (mode:0000000), don't warn */
916 warning(_("unexpected mode %o\n"), p
->mod_dst
);
920 if (S_ISGITLINK(p
->mod_src
)) {
921 if (p
->status
!= 'D')
922 src_abbrev
= verify_submodule_committish(p
->sm_path
,
923 oid_to_hex(&p
->oid_src
));
927 * As `rev-parse` failed, we fallback to getting
928 * the abbreviated hash using oid_src. We do
929 * this as we might still need the abbreviated
930 * hash in cases like a submodule type change, etc.
932 src_abbrev
= xstrndup(oid_to_hex(&p
->oid_src
), 7);
936 * The source does not point to a submodule.
937 * So, we fallback to getting the abbreviation using
938 * oid_src as we might still need the abbreviated
939 * hash in cases like submodule add, etc.
941 src_abbrev
= xstrndup(oid_to_hex(&p
->oid_src
), 7);
944 if (S_ISGITLINK(p
->mod_dst
)) {
945 dst_abbrev
= verify_submodule_committish(p
->sm_path
,
946 oid_to_hex(&p
->oid_dst
));
950 * As `rev-parse` failed, we fallback to getting
951 * the abbreviated hash using oid_dst. We do
952 * this as we might still need the abbreviated
953 * hash in cases like a submodule type change, etc.
955 dst_abbrev
= xstrndup(oid_to_hex(&p
->oid_dst
), 7);
959 * The destination does not point to a submodule.
960 * So, we fallback to getting the abbreviation using
961 * oid_dst as we might still need the abbreviated
962 * hash in cases like a submodule removal, etc.
964 dst_abbrev
= xstrndup(oid_to_hex(&p
->oid_dst
), 7);
967 displaypath
= get_submodule_displaypath(p
->sm_path
, info
->prefix
,
970 if (!missing_src
&& !missing_dst
) {
971 struct child_process cp_rev_list
= CHILD_PROCESS_INIT
;
972 struct strbuf sb_rev_list
= STRBUF_INIT
;
974 strvec_pushl(&cp_rev_list
.args
, "rev-list",
975 "--first-parent", "--count", NULL
);
976 if (S_ISGITLINK(p
->mod_src
) && S_ISGITLINK(p
->mod_dst
))
977 strvec_pushf(&cp_rev_list
.args
, "%s...%s",
978 src_abbrev
, dst_abbrev
);
980 strvec_push(&cp_rev_list
.args
, S_ISGITLINK(p
->mod_src
) ?
981 src_abbrev
: dst_abbrev
);
982 strvec_push(&cp_rev_list
.args
, "--");
984 cp_rev_list
.git_cmd
= 1;
985 cp_rev_list
.dir
= p
->sm_path
;
986 prepare_submodule_repo_env(&cp_rev_list
.env
);
988 if (!capture_command(&cp_rev_list
, &sb_rev_list
, 0))
989 total_commits
= atoi(sb_rev_list
.buf
);
991 strbuf_release(&sb_rev_list
);
994 * Don't give error msg for modification whose dst is not
995 * submodule, i.e., deleted or changed to blob
997 if (S_ISGITLINK(p
->mod_dst
)) {
998 if (missing_src
&& missing_dst
) {
999 strbuf_addf(&errmsg
, " Warn: %s doesn't contain commits %s and %s\n",
1000 displaypath
, oid_to_hex(&p
->oid_src
),
1001 oid_to_hex(&p
->oid_dst
));
1003 strbuf_addf(&errmsg
, " Warn: %s doesn't contain commit %s\n",
1004 displaypath
, missing_src
?
1005 oid_to_hex(&p
->oid_src
) :
1006 oid_to_hex(&p
->oid_dst
));
1011 print_submodule_summary(info
, errmsg
.len
? errmsg
.buf
: NULL
,
1012 total_commits
, displaypath
, src_abbrev
,
1018 strbuf_release(&errmsg
);
1021 static void prepare_submodule_summary(struct summary_cb
*info
,
1022 struct module_cb_list
*list
)
1025 for (i
= 0; i
< list
->nr
; i
++) {
1026 const struct submodule
*sub
;
1027 struct module_cb
*p
= list
->entries
[i
];
1028 struct strbuf sm_gitdir
= STRBUF_INIT
;
1030 if (p
->status
== 'D' || p
->status
== 'T') {
1031 generate_submodule_summary(info
, p
);
1035 if (info
->for_status
&& p
->status
!= 'A' &&
1036 (sub
= submodule_from_path(the_repository
,
1037 null_oid(), p
->sm_path
))) {
1038 char *config_key
= NULL
;
1042 config_key
= xstrfmt("submodule.%s.ignore",
1044 if (!git_config_get_string_tmp(config_key
, &value
))
1045 ignore_all
= !strcmp(value
, "all");
1046 else if (sub
->ignore
)
1047 ignore_all
= !strcmp(sub
->ignore
, "all");
1054 /* Also show added or modified modules which are checked out */
1055 strbuf_addstr(&sm_gitdir
, p
->sm_path
);
1056 if (is_nonbare_repository_dir(&sm_gitdir
))
1057 generate_submodule_summary(info
, p
);
1058 strbuf_release(&sm_gitdir
);
1062 static void submodule_summary_callback(struct diff_queue_struct
*q
,
1063 struct diff_options
*options UNUSED
,
1067 struct module_cb_list
*list
= data
;
1068 for (i
= 0; i
< q
->nr
; i
++) {
1069 struct diff_filepair
*p
= q
->queue
[i
];
1070 struct module_cb
*temp
;
1072 if (!S_ISGITLINK(p
->one
->mode
) && !S_ISGITLINK(p
->two
->mode
))
1074 temp
= (struct module_cb
*)malloc(sizeof(struct module_cb
));
1075 temp
->mod_src
= p
->one
->mode
;
1076 temp
->mod_dst
= p
->two
->mode
;
1077 temp
->oid_src
= p
->one
->oid
;
1078 temp
->oid_dst
= p
->two
->oid
;
1079 temp
->status
= p
->status
;
1080 temp
->sm_path
= xstrdup(p
->one
->path
);
1082 ALLOC_GROW(list
->entries
, list
->nr
+ 1, list
->alloc
);
1083 list
->entries
[list
->nr
++] = temp
;
1087 static const char *get_diff_cmd(enum diff_cmd diff_cmd
)
1090 case DIFF_INDEX
: return "diff-index";
1091 case DIFF_FILES
: return "diff-files";
1092 default: BUG("bad diff_cmd value %d", diff_cmd
);
1096 static int compute_summary_module_list(struct object_id
*head_oid
,
1097 struct summary_cb
*info
,
1098 enum diff_cmd diff_cmd
)
1100 struct strvec diff_args
= STRVEC_INIT
;
1101 struct rev_info rev
;
1102 struct setup_revision_opt opt
= {
1103 .free_removed_argv_elements
= 1,
1105 struct module_cb_list list
= MODULE_CB_LIST_INIT
;
1108 strvec_push(&diff_args
, get_diff_cmd(diff_cmd
));
1110 strvec_push(&diff_args
, "--cached");
1111 strvec_pushl(&diff_args
, "--ignore-submodules=dirty", "--raw", NULL
);
1113 strvec_push(&diff_args
, oid_to_hex(head_oid
));
1114 strvec_push(&diff_args
, "--");
1116 strvec_pushv(&diff_args
, info
->argv
);
1118 git_config(git_diff_basic_config
, NULL
);
1119 repo_init_revisions(the_repository
, &rev
, info
->prefix
);
1121 precompose_argv_prefix(diff_args
.nr
, diff_args
.v
, NULL
);
1122 setup_revisions(diff_args
.nr
, diff_args
.v
, &rev
, &opt
);
1123 rev
.diffopt
.output_format
= DIFF_FORMAT_NO_OUTPUT
| DIFF_FORMAT_CALLBACK
;
1124 rev
.diffopt
.format_callback
= submodule_summary_callback
;
1125 rev
.diffopt
.format_callback_data
= &list
;
1127 if (!info
->cached
) {
1128 if (diff_cmd
== DIFF_INDEX
)
1130 if (repo_read_index_preload(the_repository
, &rev
.diffopt
.pathspec
, 0) < 0) {
1131 perror("repo_read_index_preload");
1135 } else if (repo_read_index(the_repository
) < 0) {
1136 perror("repo_read_cache");
1141 if (diff_cmd
== DIFF_INDEX
)
1142 run_diff_index(&rev
, info
->cached
);
1144 run_diff_files(&rev
, 0);
1145 prepare_submodule_summary(info
, &list
);
1147 strvec_clear(&diff_args
);
1148 release_revisions(&rev
);
1149 module_cb_list_release(&list
);
1153 static int module_summary(int argc
, const char **argv
, const char *prefix
)
1155 struct summary_cb info
= SUMMARY_CB_INIT
;
1159 int summary_limit
= -1;
1160 enum diff_cmd diff_cmd
= DIFF_INDEX
;
1161 struct object_id head_oid
;
1163 struct option module_summary_options
[] = {
1164 OPT_BOOL(0, "cached", &cached
,
1165 N_("use the commit stored in the index instead of the submodule HEAD")),
1166 OPT_BOOL(0, "files", &files
,
1167 N_("compare the commit in the index with that in the submodule HEAD")),
1168 OPT_BOOL(0, "for-status", &for_status
,
1169 N_("skip submodules with 'ignore_config' value set to 'all'")),
1170 OPT_INTEGER('n', "summary-limit", &summary_limit
,
1171 N_("limit the summary size")),
1174 const char *const git_submodule_helper_usage
[] = {
1175 N_("git submodule summary [<options>] [<commit>] [--] [<path>]"),
1179 argc
= parse_options(argc
, argv
, prefix
, module_summary_options
,
1180 git_submodule_helper_usage
, 0);
1185 if (!repo_get_oid(the_repository
, argc
? argv
[0] : "HEAD", &head_oid
)) {
1190 } else if (!argc
|| !strcmp(argv
[0], "HEAD")) {
1191 /* before the first commit: compare with an empty tree */
1192 oidcpy(&head_oid
, the_hash_algo
->empty_tree
);
1198 if (repo_get_oid(the_repository
, "HEAD", &head_oid
))
1199 die(_("could not fetch a revision for HEAD"));
1204 die(_("options '%s' and '%s' cannot be used together"), "--cached", "--files");
1205 diff_cmd
= DIFF_FILES
;
1210 info
.prefix
= prefix
;
1211 info
.cached
= !!cached
;
1212 info
.files
= !!files
;
1213 info
.for_status
= !!for_status
;
1214 info
.summary_limit
= summary_limit
;
1216 ret
= compute_summary_module_list((diff_cmd
== DIFF_INDEX
) ? &head_oid
: NULL
,
1223 const char *super_prefix
;
1226 #define SYNC_CB_INIT { 0 }
1228 static void sync_submodule(const char *path
, const char *prefix
,
1229 const char *super_prefix
, unsigned int flags
)
1231 const struct submodule
*sub
;
1232 char *remote_key
= NULL
;
1233 char *sub_origin_url
, *super_config_url
, *displaypath
, *default_remote
;
1234 struct strbuf sb
= STRBUF_INIT
;
1235 char *sub_config_path
= NULL
;
1238 if (!is_submodule_active(the_repository
, path
))
1241 sub
= submodule_from_path(the_repository
, null_oid(), path
);
1243 if (sub
&& sub
->url
) {
1244 if (starts_with_dot_dot_slash(sub
->url
) ||
1245 starts_with_dot_slash(sub
->url
)) {
1246 char *up_path
= get_up_path(path
);
1248 sub_origin_url
= resolve_relative_url(sub
->url
, up_path
, 1);
1249 super_config_url
= resolve_relative_url(sub
->url
, NULL
, 1);
1252 sub_origin_url
= xstrdup(sub
->url
);
1253 super_config_url
= xstrdup(sub
->url
);
1256 sub_origin_url
= xstrdup("");
1257 super_config_url
= xstrdup("");
1260 displaypath
= get_submodule_displaypath(path
, prefix
, super_prefix
);
1262 if (!(flags
& OPT_QUIET
))
1263 printf(_("Synchronizing submodule url for '%s'\n"),
1267 strbuf_addf(&sb
, "submodule.%s.url", sub
->name
);
1268 if (git_config_set_gently(sb
.buf
, super_config_url
))
1269 die(_("failed to register url for submodule path '%s'"),
1272 if (!is_submodule_populated_gently(path
, NULL
))
1276 code
= get_default_remote_submodule(path
, &default_remote
);
1280 remote_key
= xstrfmt("remote.%s.url", default_remote
);
1281 free(default_remote
);
1283 submodule_to_gitdir(&sb
, path
);
1284 strbuf_addstr(&sb
, "/config");
1286 if (git_config_set_in_file_gently(sb
.buf
, remote_key
, sub_origin_url
))
1287 die(_("failed to update remote for submodule '%s'"),
1290 if (flags
& OPT_RECURSIVE
) {
1291 struct child_process cpr
= CHILD_PROCESS_INIT
;
1295 prepare_submodule_repo_env(&cpr
.env
);
1297 strvec_pushl(&cpr
.args
, "submodule--helper", "sync",
1298 "--recursive", NULL
);
1299 strvec_push(&cpr
.args
, "--super-prefix");
1300 strvec_pushf(&cpr
.args
, "%s/", displaypath
);
1303 if (flags
& OPT_QUIET
)
1304 strvec_push(&cpr
.args
, "--quiet");
1306 if (run_command(&cpr
))
1307 die(_("failed to recurse into submodule '%s'"),
1312 free(super_config_url
);
1313 free(sub_origin_url
);
1314 strbuf_release(&sb
);
1317 free(sub_config_path
);
1320 static void sync_submodule_cb(const struct cache_entry
*list_item
, void *cb_data
)
1322 struct sync_cb
*info
= cb_data
;
1324 sync_submodule(list_item
->name
, info
->prefix
, info
->super_prefix
,
1328 static int module_sync(int argc
, const char **argv
, const char *prefix
)
1330 struct sync_cb info
= SYNC_CB_INIT
;
1331 struct pathspec pathspec
= { 0 };
1332 struct module_list list
= MODULE_LIST_INIT
;
1335 struct option module_sync_options
[] = {
1336 OPT__SUPER_PREFIX(&info
.super_prefix
),
1337 OPT__QUIET(&quiet
, N_("suppress output of synchronizing submodule url")),
1338 OPT_BOOL(0, "recursive", &recursive
,
1339 N_("recurse into nested submodules")),
1342 const char *const git_submodule_helper_usage
[] = {
1343 N_("git submodule sync [--quiet] [--recursive] [<path>]"),
1348 argc
= parse_options(argc
, argv
, prefix
, module_sync_options
,
1349 git_submodule_helper_usage
, 0);
1351 if (module_list_compute(argv
, prefix
, &pathspec
, &list
) < 0)
1354 info
.prefix
= prefix
;
1356 info
.flags
|= OPT_QUIET
;
1358 info
.flags
|= OPT_RECURSIVE
;
1360 for_each_listed_submodule(&list
, sync_submodule_cb
, &info
);
1364 module_list_release(&list
);
1365 clear_pathspec(&pathspec
);
1373 #define DEINIT_CB_INIT { 0 }
1375 static void deinit_submodule(const char *path
, const char *prefix
,
1378 const struct submodule
*sub
;
1379 char *displaypath
= NULL
;
1380 struct child_process cp_config
= CHILD_PROCESS_INIT
;
1381 struct strbuf sb_config
= STRBUF_INIT
;
1382 char *sub_git_dir
= xstrfmt("%s/.git", path
);
1384 sub
= submodule_from_path(the_repository
, null_oid(), path
);
1386 if (!sub
|| !sub
->name
)
1389 displaypath
= get_submodule_displaypath(path
, prefix
, NULL
);
1391 /* remove the submodule work tree (unless the user already did it) */
1392 if (is_directory(path
)) {
1393 struct strbuf sb_rm
= STRBUF_INIT
;
1396 if (is_directory(sub_git_dir
)) {
1397 if (!(flags
& OPT_QUIET
))
1398 warning(_("Submodule work tree '%s' contains a .git "
1399 "directory. This will be replaced with a "
1400 ".git file by using absorbgitdirs."),
1403 absorb_git_dir_into_superproject(path
, NULL
);
1407 if (!(flags
& OPT_FORCE
)) {
1408 struct child_process cp_rm
= CHILD_PROCESS_INIT
;
1411 strvec_pushl(&cp_rm
.args
, "rm", "-qn",
1414 if (run_command(&cp_rm
))
1415 die(_("Submodule work tree '%s' contains local "
1416 "modifications; use '-f' to discard them"),
1420 strbuf_addstr(&sb_rm
, path
);
1422 if (!remove_dir_recursively(&sb_rm
, 0))
1423 format
= _("Cleared directory '%s'\n");
1425 format
= _("Could not remove submodule work tree '%s'\n");
1427 if (!(flags
& OPT_QUIET
))
1428 printf(format
, displaypath
);
1430 submodule_unset_core_worktree(sub
);
1432 strbuf_release(&sb_rm
);
1435 if (mkdir(path
, 0777))
1436 printf(_("could not create empty submodule directory %s"),
1439 cp_config
.git_cmd
= 1;
1440 strvec_pushl(&cp_config
.args
, "config", "--get-regexp", NULL
);
1441 strvec_pushf(&cp_config
.args
, "submodule.%s\\.", sub
->name
);
1443 /* remove the .git/config entries (unless the user already did it) */
1444 if (!capture_command(&cp_config
, &sb_config
, 0) && sb_config
.len
) {
1445 char *sub_key
= xstrfmt("submodule.%s", sub
->name
);
1448 * remove the whole section so we have a clean state when
1449 * the user later decides to init this submodule again
1451 git_config_rename_section_in_file(NULL
, sub_key
, NULL
);
1452 if (!(flags
& OPT_QUIET
))
1453 printf(_("Submodule '%s' (%s) unregistered for path '%s'\n"),
1454 sub
->name
, sub
->url
, displaypath
);
1461 strbuf_release(&sb_config
);
1464 static void deinit_submodule_cb(const struct cache_entry
*list_item
,
1467 struct deinit_cb
*info
= cb_data
;
1468 deinit_submodule(list_item
->name
, info
->prefix
, info
->flags
);
1471 static int module_deinit(int argc
, const char **argv
, const char *prefix
)
1473 struct deinit_cb info
= DEINIT_CB_INIT
;
1474 struct pathspec pathspec
= { 0 };
1475 struct module_list list
= MODULE_LIST_INIT
;
1479 struct option module_deinit_options
[] = {
1480 OPT__QUIET(&quiet
, N_("suppress submodule status output")),
1481 OPT__FORCE(&force
, N_("remove submodule working trees even if they contain local changes"), 0),
1482 OPT_BOOL(0, "all", &all
, N_("unregister all submodules")),
1485 const char *const git_submodule_helper_usage
[] = {
1486 N_("git submodule deinit [--quiet] [-f | --force] [--all | [--] [<path>...]]"),
1491 argc
= parse_options(argc
, argv
, prefix
, module_deinit_options
,
1492 git_submodule_helper_usage
, 0);
1495 error("pathspec and --all are incompatible");
1496 usage_with_options(git_submodule_helper_usage
,
1497 module_deinit_options
);
1501 die(_("Use '--all' if you really want to deinitialize all submodules"));
1503 if (module_list_compute(argv
, prefix
, &pathspec
, &list
) < 0)
1506 info
.prefix
= prefix
;
1508 info
.flags
|= OPT_QUIET
;
1510 info
.flags
|= OPT_FORCE
;
1512 for_each_listed_submodule(&list
, deinit_submodule_cb
, &info
);
1516 module_list_release(&list
);
1517 clear_pathspec(&pathspec
);
1521 struct module_clone_data
{
1527 struct list_objects_filter_options
*filter_options
;
1528 unsigned int quiet
: 1;
1529 unsigned int progress
: 1;
1530 unsigned int dissociate
: 1;
1531 unsigned int require_init
: 1;
1534 #define MODULE_CLONE_DATA_INIT { \
1535 .single_branch = -1, \
1538 struct submodule_alternate_setup
{
1539 const char *submodule_name
;
1540 enum SUBMODULE_ALTERNATE_ERROR_MODE
{
1541 SUBMODULE_ALTERNATE_ERROR_DIE
,
1542 SUBMODULE_ALTERNATE_ERROR_INFO
,
1543 SUBMODULE_ALTERNATE_ERROR_IGNORE
1545 struct string_list
*reference
;
1547 #define SUBMODULE_ALTERNATE_SETUP_INIT { \
1548 .error_mode = SUBMODULE_ALTERNATE_ERROR_IGNORE, \
1551 static const char alternate_error_advice
[] = N_(
1552 "An alternate computed from a superproject's alternate is invalid.\n"
1553 "To allow Git to clone without an alternate in such a case, set\n"
1554 "submodule.alternateErrorStrategy to 'info' or, equivalently, clone with\n"
1555 "'--reference-if-able' instead of '--reference'."
1558 static int add_possible_reference_from_superproject(
1559 struct object_directory
*odb
, void *sas_cb
)
1561 struct submodule_alternate_setup
*sas
= sas_cb
;
1565 * If the alternate object store is another repository, try the
1566 * standard layout with .git/(modules/<name>)+/objects
1568 if (strip_suffix(odb
->path
, "/objects", &len
)) {
1569 struct repository alternate
;
1571 struct strbuf sb
= STRBUF_INIT
;
1572 struct strbuf err
= STRBUF_INIT
;
1573 strbuf_add(&sb
, odb
->path
, len
);
1575 if (repo_init(&alternate
, sb
.buf
, NULL
) < 0)
1576 die(_("could not get a repository handle for gitdir '%s'"),
1580 * We need to end the new path with '/' to mark it as a dir,
1581 * otherwise a submodule name containing '/' will be broken
1582 * as the last part of a missing submodule reference would
1583 * be taken as a file name.
1586 submodule_name_to_gitdir(&sb
, &alternate
, sas
->submodule_name
);
1587 strbuf_addch(&sb
, '/');
1588 repo_clear(&alternate
);
1590 sm_alternate
= compute_alternate_path(sb
.buf
, &err
);
1592 char *p
= strbuf_detach(&sb
, NULL
);
1594 string_list_append(sas
->reference
, p
)->util
= p
;
1597 switch (sas
->error_mode
) {
1598 case SUBMODULE_ALTERNATE_ERROR_DIE
:
1599 if (advice_enabled(ADVICE_SUBMODULE_ALTERNATE_ERROR_STRATEGY_DIE
))
1600 advise(_(alternate_error_advice
));
1601 die(_("submodule '%s' cannot add alternate: %s"),
1602 sas
->submodule_name
, err
.buf
);
1603 case SUBMODULE_ALTERNATE_ERROR_INFO
:
1604 fprintf_ln(stderr
, _("submodule '%s' cannot add alternate: %s"),
1605 sas
->submodule_name
, err
.buf
);
1606 case SUBMODULE_ALTERNATE_ERROR_IGNORE
:
1610 strbuf_release(&sb
);
1616 static void prepare_possible_alternates(const char *sm_name
,
1617 struct string_list
*reference
)
1619 char *sm_alternate
= NULL
, *error_strategy
= NULL
;
1620 struct submodule_alternate_setup sas
= SUBMODULE_ALTERNATE_SETUP_INIT
;
1622 git_config_get_string("submodule.alternateLocation", &sm_alternate
);
1626 git_config_get_string("submodule.alternateErrorStrategy", &error_strategy
);
1628 if (!error_strategy
)
1629 error_strategy
= xstrdup("die");
1631 sas
.submodule_name
= sm_name
;
1632 sas
.reference
= reference
;
1633 if (!strcmp(error_strategy
, "die"))
1634 sas
.error_mode
= SUBMODULE_ALTERNATE_ERROR_DIE
;
1635 else if (!strcmp(error_strategy
, "info"))
1636 sas
.error_mode
= SUBMODULE_ALTERNATE_ERROR_INFO
;
1637 else if (!strcmp(error_strategy
, "ignore"))
1638 sas
.error_mode
= SUBMODULE_ALTERNATE_ERROR_IGNORE
;
1640 die(_("Value '%s' for submodule.alternateErrorStrategy is not recognized"), error_strategy
);
1642 if (!strcmp(sm_alternate
, "superproject"))
1643 foreach_alt_odb(add_possible_reference_from_superproject
, &sas
);
1644 else if (!strcmp(sm_alternate
, "no"))
1647 die(_("Value '%s' for submodule.alternateLocation is not recognized"), sm_alternate
);
1650 free(error_strategy
);
1653 static char *clone_submodule_sm_gitdir(const char *name
)
1655 struct strbuf sb
= STRBUF_INIT
;
1658 submodule_name_to_gitdir(&sb
, the_repository
, name
);
1659 sm_gitdir
= absolute_pathdup(sb
.buf
);
1660 strbuf_release(&sb
);
1665 static int clone_submodule(const struct module_clone_data
*clone_data
,
1666 struct string_list
*reference
)
1669 char *sm_gitdir
= clone_submodule_sm_gitdir(clone_data
->name
);
1670 char *sm_alternate
= NULL
, *error_strategy
= NULL
;
1671 struct child_process cp
= CHILD_PROCESS_INIT
;
1672 const char *clone_data_path
= clone_data
->path
;
1673 char *to_free
= NULL
;
1675 if (!is_absolute_path(clone_data
->path
))
1676 clone_data_path
= to_free
= xstrfmt("%s/%s", get_git_work_tree(),
1679 if (validate_submodule_git_dir(sm_gitdir
, clone_data
->name
) < 0)
1680 die(_("refusing to create/use '%s' in another submodule's "
1681 "git dir"), sm_gitdir
);
1683 if (!file_exists(sm_gitdir
)) {
1684 if (safe_create_leading_directories_const(sm_gitdir
) < 0)
1685 die(_("could not create directory '%s'"), sm_gitdir
);
1687 prepare_possible_alternates(clone_data
->name
, reference
);
1689 strvec_push(&cp
.args
, "clone");
1690 strvec_push(&cp
.args
, "--no-checkout");
1691 if (clone_data
->quiet
)
1692 strvec_push(&cp
.args
, "--quiet");
1693 if (clone_data
->progress
)
1694 strvec_push(&cp
.args
, "--progress");
1695 if (clone_data
->depth
&& *(clone_data
->depth
))
1696 strvec_pushl(&cp
.args
, "--depth", clone_data
->depth
, NULL
);
1697 if (reference
->nr
) {
1698 struct string_list_item
*item
;
1700 for_each_string_list_item(item
, reference
)
1701 strvec_pushl(&cp
.args
, "--reference",
1702 item
->string
, NULL
);
1704 if (clone_data
->dissociate
)
1705 strvec_push(&cp
.args
, "--dissociate");
1706 if (sm_gitdir
&& *sm_gitdir
)
1707 strvec_pushl(&cp
.args
, "--separate-git-dir", sm_gitdir
, NULL
);
1708 if (clone_data
->filter_options
&& clone_data
->filter_options
->choice
)
1709 strvec_pushf(&cp
.args
, "--filter=%s",
1710 expand_list_objects_filter_spec(
1711 clone_data
->filter_options
));
1712 if (clone_data
->single_branch
>= 0)
1713 strvec_push(&cp
.args
, clone_data
->single_branch
?
1715 "--no-single-branch");
1717 strvec_push(&cp
.args
, "--");
1718 strvec_push(&cp
.args
, clone_data
->url
);
1719 strvec_push(&cp
.args
, clone_data_path
);
1722 prepare_submodule_repo_env(&cp
.env
);
1725 if(run_command(&cp
))
1726 die(_("clone of '%s' into submodule path '%s' failed"),
1727 clone_data
->url
, clone_data_path
);
1731 if (clone_data
->require_init
&& !access(clone_data_path
, X_OK
) &&
1732 !is_empty_dir(clone_data_path
))
1733 die(_("directory not empty: '%s'"), clone_data_path
);
1734 if (safe_create_leading_directories_const(clone_data_path
) < 0)
1735 die(_("could not create directory '%s'"), clone_data_path
);
1736 path
= xstrfmt("%s/index", sm_gitdir
);
1737 unlink_or_warn(path
);
1741 connect_work_tree_and_git_dir(clone_data_path
, sm_gitdir
, 0);
1743 p
= git_pathdup_submodule(clone_data_path
, "config");
1745 die(_("could not get submodule directory for '%s'"), clone_data_path
);
1747 /* setup alternateLocation and alternateErrorStrategy in the cloned submodule if needed */
1748 git_config_get_string("submodule.alternateLocation", &sm_alternate
);
1750 git_config_set_in_file(p
, "submodule.alternateLocation",
1752 git_config_get_string("submodule.alternateErrorStrategy", &error_strategy
);
1754 git_config_set_in_file(p
, "submodule.alternateErrorStrategy",
1758 free(error_strategy
);
1766 static int module_clone(int argc
, const char **argv
, const char *prefix
)
1768 int dissociate
= 0, quiet
= 0, progress
= 0, require_init
= 0;
1769 struct module_clone_data clone_data
= MODULE_CLONE_DATA_INIT
;
1770 struct string_list reference
= STRING_LIST_INIT_NODUP
;
1771 struct list_objects_filter_options filter_options
=
1772 LIST_OBJECTS_FILTER_INIT
;
1774 struct option module_clone_options
[] = {
1775 OPT_STRING(0, "prefix", &clone_data
.prefix
,
1777 N_("alternative anchor for relative paths")),
1778 OPT_STRING(0, "path", &clone_data
.path
,
1780 N_("where the new submodule will be cloned to")),
1781 OPT_STRING(0, "name", &clone_data
.name
,
1783 N_("name of the new submodule")),
1784 OPT_STRING(0, "url", &clone_data
.url
,
1786 N_("url where to clone the submodule from")),
1787 OPT_STRING_LIST(0, "reference", &reference
,
1789 N_("reference repository")),
1790 OPT_BOOL(0, "dissociate", &dissociate
,
1791 N_("use --reference only while cloning")),
1792 OPT_STRING(0, "depth", &clone_data
.depth
,
1794 N_("depth for shallow clones")),
1795 OPT__QUIET(&quiet
, "suppress output for cloning a submodule"),
1796 OPT_BOOL(0, "progress", &progress
,
1797 N_("force cloning progress")),
1798 OPT_BOOL(0, "require-init", &require_init
,
1799 N_("disallow cloning into non-empty directory")),
1800 OPT_BOOL(0, "single-branch", &clone_data
.single_branch
,
1801 N_("clone only one branch, HEAD or --branch")),
1802 OPT_PARSE_LIST_OBJECTS_FILTER(&filter_options
),
1805 const char *const git_submodule_helper_usage
[] = {
1806 N_("git submodule--helper clone [--prefix=<path>] [--quiet] "
1807 "[--reference <repository>] [--name <name>] [--depth <depth>] "
1808 "[--single-branch] [--filter <filter-spec>] "
1809 "--url <url> --path <path>"),
1813 argc
= parse_options(argc
, argv
, prefix
, module_clone_options
,
1814 git_submodule_helper_usage
, 0);
1816 clone_data
.dissociate
= !!dissociate
;
1817 clone_data
.quiet
= !!quiet
;
1818 clone_data
.progress
= !!progress
;
1819 clone_data
.require_init
= !!require_init
;
1820 clone_data
.filter_options
= &filter_options
;
1822 if (argc
|| !clone_data
.url
|| !clone_data
.path
|| !*(clone_data
.path
))
1823 usage_with_options(git_submodule_helper_usage
,
1824 module_clone_options
);
1826 clone_submodule(&clone_data
, &reference
);
1827 list_objects_filter_release(&filter_options
);
1828 string_list_clear(&reference
, 1);
1832 static int determine_submodule_update_strategy(struct repository
*r
,
1835 enum submodule_update_type update
,
1836 struct submodule_update_strategy
*out
)
1838 const struct submodule
*sub
= submodule_from_path(r
, null_oid(), path
);
1843 key
= xstrfmt("submodule.%s.update", sub
->name
);
1847 } else if (!repo_config_get_string_tmp(r
, key
, &val
)) {
1848 if (parse_submodule_update_strategy(val
, out
) < 0) {
1849 ret
= die_message(_("Invalid update mode '%s' configured for submodule path '%s'"),
1853 } else if (sub
->update_strategy
.type
!= SM_UPDATE_UNSPECIFIED
) {
1854 if (sub
->update_strategy
.type
== SM_UPDATE_COMMAND
)
1855 BUG("how did we read update = !command from .gitmodules?");
1856 out
->type
= sub
->update_strategy
.type
;
1857 out
->command
= sub
->update_strategy
.command
;
1859 out
->type
= SM_UPDATE_CHECKOUT
;
1862 (out
->type
== SM_UPDATE_MERGE
||
1863 out
->type
== SM_UPDATE_REBASE
||
1864 out
->type
== SM_UPDATE_NONE
))
1865 out
->type
= SM_UPDATE_CHECKOUT
;
1873 struct update_clone_data
{
1874 const struct submodule
*sub
;
1875 struct object_id oid
;
1876 unsigned just_cloned
;
1879 struct submodule_update_clone
{
1880 /* index into 'update_data.list', the list of submodules to look into for cloning */
1883 /* configuration parameters which are passed on to the children */
1884 const struct update_data
*update_data
;
1886 /* to be consumed by update_submodule() */
1887 struct update_clone_data
*update_clone
;
1888 int update_clone_nr
; int update_clone_alloc
;
1890 /* If we want to stop as fast as possible and return an error */
1891 unsigned quickstop
: 1;
1893 /* failed clones to be retried again */
1894 const struct cache_entry
**failed_clones
;
1895 int failed_clones_nr
, failed_clones_alloc
;
1897 #define SUBMODULE_UPDATE_CLONE_INIT { 0 }
1899 static void submodule_update_clone_release(struct submodule_update_clone
*suc
)
1901 free(suc
->update_clone
);
1902 free(suc
->failed_clones
);
1905 struct update_data
{
1907 const char *super_prefix
;
1909 enum submodule_update_type update_default
;
1910 struct object_id suboid
;
1911 struct string_list references
;
1912 struct submodule_update_strategy update_strategy
;
1913 struct list_objects_filter_options
*filter_options
;
1914 struct module_list list
;
1918 int recommend_shallow
;
1919 unsigned int require_init
;
1922 unsigned int nofetch
;
1923 unsigned int remote
;
1924 unsigned int progress
;
1925 unsigned int dissociate
;
1927 unsigned int warn_if_uninitialized
;
1928 unsigned int recursive
;
1930 /* copied over from update_clone_data */
1931 struct object_id oid
;
1932 unsigned int just_cloned
;
1933 const char *sm_path
;
1935 #define UPDATE_DATA_INIT { \
1936 .update_strategy = SUBMODULE_UPDATE_STRATEGY_INIT, \
1937 .list = MODULE_LIST_INIT, \
1938 .recommend_shallow = -1, \
1939 .references = STRING_LIST_INIT_DUP, \
1940 .single_branch = -1, \
1944 static void update_data_release(struct update_data
*ud
)
1946 free(ud
->displaypath
);
1947 module_list_release(&ud
->list
);
1950 static void next_submodule_warn_missing(struct submodule_update_clone
*suc
,
1951 struct strbuf
*out
, const char *displaypath
)
1954 * Only mention uninitialized submodules when their
1955 * paths have been specified.
1957 if (suc
->update_data
->warn_if_uninitialized
) {
1959 _("Submodule path '%s' not initialized"),
1961 strbuf_addch(out
, '\n');
1963 _("Maybe you want to use 'update --init'?"));
1964 strbuf_addch(out
, '\n');
1969 * Determine whether 'ce' needs to be cloned. If so, prepare the 'child' to
1970 * run the clone. Returns 1 if 'ce' needs to be cloned, 0 otherwise.
1972 static int prepare_to_clone_next_submodule(const struct cache_entry
*ce
,
1973 struct child_process
*child
,
1974 struct submodule_update_clone
*suc
,
1977 const struct submodule
*sub
= NULL
;
1978 const char *url
= NULL
;
1979 const char *update_string
;
1980 enum submodule_update_type update_type
;
1982 const struct update_data
*ud
= suc
->update_data
;
1983 char *displaypath
= get_submodule_displaypath(ce
->name
, ud
->prefix
,
1985 struct strbuf sb
= STRBUF_INIT
;
1986 int needs_cloning
= 0;
1987 int need_free_url
= 0;
1990 strbuf_addf(out
, _("Skipping unmerged submodule %s"), displaypath
);
1991 strbuf_addch(out
, '\n');
1995 sub
= submodule_from_path(the_repository
, null_oid(), ce
->name
);
1998 next_submodule_warn_missing(suc
, out
, displaypath
);
2002 key
= xstrfmt("submodule.%s.update", sub
->name
);
2003 if (!repo_config_get_string_tmp(the_repository
, key
, &update_string
)) {
2004 update_type
= parse_submodule_update_type(update_string
);
2006 update_type
= sub
->update_strategy
.type
;
2010 if (suc
->update_data
->update_strategy
.type
== SM_UPDATE_NONE
2011 || (suc
->update_data
->update_strategy
.type
== SM_UPDATE_UNSPECIFIED
2012 && update_type
== SM_UPDATE_NONE
)) {
2013 strbuf_addf(out
, _("Skipping submodule '%s'"), displaypath
);
2014 strbuf_addch(out
, '\n');
2018 /* Check if the submodule has been initialized. */
2019 if (!is_submodule_active(the_repository
, ce
->name
)) {
2020 next_submodule_warn_missing(suc
, out
, displaypath
);
2025 strbuf_addf(&sb
, "submodule.%s.url", sub
->name
);
2026 if (repo_config_get_string_tmp(the_repository
, sb
.buf
, &url
)) {
2027 if (starts_with_dot_slash(sub
->url
) ||
2028 starts_with_dot_dot_slash(sub
->url
)) {
2029 url
= resolve_relative_url(sub
->url
, NULL
, 0);
2036 strbuf_addf(&sb
, "%s/.git", ce
->name
);
2037 needs_cloning
= !file_exists(sb
.buf
);
2039 ALLOC_GROW(suc
->update_clone
, suc
->update_clone_nr
+ 1,
2040 suc
->update_clone_alloc
);
2041 oidcpy(&suc
->update_clone
[suc
->update_clone_nr
].oid
, &ce
->oid
);
2042 suc
->update_clone
[suc
->update_clone_nr
].just_cloned
= needs_cloning
;
2043 suc
->update_clone
[suc
->update_clone_nr
].sub
= sub
;
2044 suc
->update_clone_nr
++;
2050 child
->no_stdin
= 1;
2051 child
->stdout_to_stderr
= 1;
2053 strvec_push(&child
->args
, "submodule--helper");
2054 strvec_push(&child
->args
, "clone");
2055 if (suc
->update_data
->progress
)
2056 strvec_push(&child
->args
, "--progress");
2057 if (suc
->update_data
->quiet
)
2058 strvec_push(&child
->args
, "--quiet");
2059 if (suc
->update_data
->prefix
)
2060 strvec_pushl(&child
->args
, "--prefix", suc
->update_data
->prefix
, NULL
);
2061 if (suc
->update_data
->recommend_shallow
&& sub
->recommend_shallow
== 1)
2062 strvec_push(&child
->args
, "--depth=1");
2063 else if (suc
->update_data
->depth
)
2064 strvec_pushf(&child
->args
, "--depth=%d", suc
->update_data
->depth
);
2065 if (suc
->update_data
->filter_options
&& suc
->update_data
->filter_options
->choice
)
2066 strvec_pushf(&child
->args
, "--filter=%s",
2067 expand_list_objects_filter_spec(suc
->update_data
->filter_options
));
2068 if (suc
->update_data
->require_init
)
2069 strvec_push(&child
->args
, "--require-init");
2070 strvec_pushl(&child
->args
, "--path", sub
->path
, NULL
);
2071 strvec_pushl(&child
->args
, "--name", sub
->name
, NULL
);
2072 strvec_pushl(&child
->args
, "--url", url
, NULL
);
2073 if (suc
->update_data
->references
.nr
) {
2074 struct string_list_item
*item
;
2076 for_each_string_list_item(item
, &suc
->update_data
->references
)
2077 strvec_pushl(&child
->args
, "--reference", item
->string
, NULL
);
2079 if (suc
->update_data
->dissociate
)
2080 strvec_push(&child
->args
, "--dissociate");
2081 if (suc
->update_data
->single_branch
>= 0)
2082 strvec_push(&child
->args
, suc
->update_data
->single_branch
?
2084 "--no-single-branch");
2088 strbuf_release(&sb
);
2092 return needs_cloning
;
2095 static int update_clone_get_next_task(struct child_process
*child
,
2100 struct submodule_update_clone
*suc
= suc_cb
;
2101 const struct cache_entry
*ce
;
2104 for (; suc
->current
< suc
->update_data
->list
.nr
; suc
->current
++) {
2105 ce
= suc
->update_data
->list
.entries
[suc
->current
];
2106 if (prepare_to_clone_next_submodule(ce
, child
, suc
, err
)) {
2107 int *p
= xmalloc(sizeof(*p
));
2117 * The loop above tried cloning each submodule once, now try the
2118 * stragglers again, which we can imagine as an extension of the
2121 index
= suc
->current
- suc
->update_data
->list
.nr
;
2122 if (index
< suc
->failed_clones_nr
) {
2125 ce
= suc
->failed_clones
[index
];
2126 if (!prepare_to_clone_next_submodule(ce
, child
, suc
, err
)) {
2128 strbuf_addstr(err
, "BUG: submodule considered for "
2129 "cloning, doesn't need cloning "
2133 p
= xmalloc(sizeof(*p
));
2143 static int update_clone_start_failure(struct strbuf
*err UNUSED
,
2145 void *idx_task_cb UNUSED
)
2147 struct submodule_update_clone
*suc
= suc_cb
;
2153 static int update_clone_task_finished(int result
,
2158 const struct cache_entry
*ce
;
2159 struct submodule_update_clone
*suc
= suc_cb
;
2160 int *idxP
= idx_task_cb
;
2168 if (idx
< suc
->update_data
->list
.nr
) {
2169 ce
= suc
->update_data
->list
.entries
[idx
];
2170 strbuf_addf(err
, _("Failed to clone '%s'. Retry scheduled"),
2172 strbuf_addch(err
, '\n');
2173 ALLOC_GROW(suc
->failed_clones
,
2174 suc
->failed_clones_nr
+ 1,
2175 suc
->failed_clones_alloc
);
2176 suc
->failed_clones
[suc
->failed_clones_nr
++] = ce
;
2179 idx
-= suc
->update_data
->list
.nr
;
2180 ce
= suc
->failed_clones
[idx
];
2181 strbuf_addf(err
, _("Failed to clone '%s' a second time, aborting"),
2183 strbuf_addch(err
, '\n');
2191 static int git_update_clone_config(const char *var
, const char *value
,
2196 if (!strcmp(var
, "submodule.fetchjobs"))
2197 *max_jobs
= parse_submodule_fetchjobs(var
, value
);
2201 static int is_tip_reachable(const char *path
, const struct object_id
*oid
)
2203 struct child_process cp
= CHILD_PROCESS_INIT
;
2204 struct strbuf rev
= STRBUF_INIT
;
2205 char *hex
= oid_to_hex(oid
);
2210 strvec_pushl(&cp
.args
, "rev-list", "-n", "1", hex
, "--not", "--all", NULL
);
2212 prepare_submodule_repo_env(&cp
.env
);
2214 if (capture_command(&cp
, &rev
, GIT_MAX_HEXSZ
+ 1) || rev
.len
)
2220 static int fetch_in_submodule(const char *module_path
, int depth
, int quiet
,
2221 const struct object_id
*oid
)
2223 struct child_process cp
= CHILD_PROCESS_INIT
;
2225 prepare_submodule_repo_env(&cp
.env
);
2227 cp
.dir
= module_path
;
2229 strvec_push(&cp
.args
, "fetch");
2231 strvec_push(&cp
.args
, "--quiet");
2233 strvec_pushf(&cp
.args
, "--depth=%d", depth
);
2235 char *hex
= oid_to_hex(oid
);
2236 char *remote
= get_default_remote();
2238 strvec_pushl(&cp
.args
, remote
, hex
, NULL
);
2242 return run_command(&cp
);
2245 static int run_update_command(const struct update_data
*ud
, int subforce
)
2247 struct child_process cp
= CHILD_PROCESS_INIT
;
2248 char *oid
= oid_to_hex(&ud
->oid
);
2251 switch (ud
->update_strategy
.type
) {
2252 case SM_UPDATE_CHECKOUT
:
2254 strvec_pushl(&cp
.args
, "checkout", "-q", NULL
);
2256 strvec_push(&cp
.args
, "-f");
2258 case SM_UPDATE_REBASE
:
2260 strvec_push(&cp
.args
, "rebase");
2262 strvec_push(&cp
.args
, "--quiet");
2264 case SM_UPDATE_MERGE
:
2266 strvec_push(&cp
.args
, "merge");
2268 strvec_push(&cp
.args
, "--quiet");
2270 case SM_UPDATE_COMMAND
:
2272 strvec_push(&cp
.args
, ud
->update_strategy
.command
);
2275 BUG("unexpected update strategy type: %d",
2276 ud
->update_strategy
.type
);
2278 strvec_push(&cp
.args
, oid
);
2280 cp
.dir
= ud
->sm_path
;
2281 prepare_submodule_repo_env(&cp
.env
);
2282 if ((ret
= run_command(&cp
))) {
2283 switch (ud
->update_strategy
.type
) {
2284 case SM_UPDATE_CHECKOUT
:
2285 die_message(_("Unable to checkout '%s' in submodule path '%s'"),
2286 oid
, ud
->displaypath
);
2287 /* No "ret" assignment, use "git checkout"'s */
2289 case SM_UPDATE_REBASE
:
2290 ret
= die_message(_("Unable to rebase '%s' in submodule path '%s'"),
2291 oid
, ud
->displaypath
);
2293 case SM_UPDATE_MERGE
:
2294 ret
= die_message(_("Unable to merge '%s' in submodule path '%s'"),
2295 oid
, ud
->displaypath
);
2297 case SM_UPDATE_COMMAND
:
2298 ret
= die_message(_("Execution of '%s %s' failed in submodule path '%s'"),
2299 ud
->update_strategy
.command
, oid
, ud
->displaypath
);
2302 BUG("unexpected update strategy type: %d",
2303 ud
->update_strategy
.type
);
2312 switch (ud
->update_strategy
.type
) {
2313 case SM_UPDATE_CHECKOUT
:
2314 printf(_("Submodule path '%s': checked out '%s'\n"),
2315 ud
->displaypath
, oid
);
2317 case SM_UPDATE_REBASE
:
2318 printf(_("Submodule path '%s': rebased into '%s'\n"),
2319 ud
->displaypath
, oid
);
2321 case SM_UPDATE_MERGE
:
2322 printf(_("Submodule path '%s': merged in '%s'\n"),
2323 ud
->displaypath
, oid
);
2325 case SM_UPDATE_COMMAND
:
2326 printf(_("Submodule path '%s': '%s %s'\n"),
2327 ud
->displaypath
, ud
->update_strategy
.command
, oid
);
2330 BUG("unexpected update strategy type: %d",
2331 ud
->update_strategy
.type
);
2337 static int run_update_procedure(const struct update_data
*ud
)
2339 int subforce
= is_null_oid(&ud
->suboid
) || ud
->force
;
2343 * Run fetch only if `oid` isn't present or it
2344 * is not reachable from a ref.
2346 if (!is_tip_reachable(ud
->sm_path
, &ud
->oid
) &&
2347 fetch_in_submodule(ud
->sm_path
, ud
->depth
, ud
->quiet
, NULL
) &&
2350 _("Unable to fetch in submodule path '%s'; "
2351 "trying to directly fetch %s:"),
2352 ud
->displaypath
, oid_to_hex(&ud
->oid
));
2354 * Now we tried the usual fetch, but `oid` may
2355 * not be reachable from any of the refs.
2357 if (!is_tip_reachable(ud
->sm_path
, &ud
->oid
) &&
2358 fetch_in_submodule(ud
->sm_path
, ud
->depth
, ud
->quiet
, &ud
->oid
))
2359 return die_message(_("Fetched in submodule path '%s', but it did not "
2360 "contain %s. Direct fetching of that commit failed."),
2361 ud
->displaypath
, oid_to_hex(&ud
->oid
));
2364 return run_update_command(ud
, subforce
);
2367 static int remote_submodule_branch(const char *path
, const char **branch
)
2369 const struct submodule
*sub
;
2373 sub
= submodule_from_path(the_repository
, null_oid(), path
);
2375 return die_message(_("could not initialize submodule at path '%s'"),
2378 key
= xstrfmt("submodule.%s.branch", sub
->name
);
2379 if (repo_config_get_string_tmp(the_repository
, key
, branch
))
2380 *branch
= sub
->branch
;
2388 if (!strcmp(*branch
, ".")) {
2389 const char *refname
= resolve_ref_unsafe("HEAD", 0, NULL
, NULL
);
2392 return die_message(_("No such ref: %s"), "HEAD");
2395 if (!strcmp(refname
, "HEAD"))
2396 return die_message(_("Submodule (%s) branch configured to inherit "
2397 "branch from superproject, but the superproject "
2398 "is not on any branch"), sub
->name
);
2400 if (!skip_prefix(refname
, "refs/heads/", &refname
))
2401 return die_message(_("Expecting a full ref name, got %s"),
2408 /* Our "branch" is coming from repo_config_get_string_tmp() */
2412 static int ensure_core_worktree(const char *path
)
2415 struct repository subrepo
;
2417 if (repo_submodule_init(&subrepo
, the_repository
, path
, null_oid()))
2418 return die_message(_("could not get a repository handle for submodule '%s'"),
2421 if (!repo_config_get_string_tmp(&subrepo
, "core.worktree", &cw
)) {
2422 char *cfg_file
, *abs_path
;
2423 const char *rel_path
;
2424 struct strbuf sb
= STRBUF_INIT
;
2426 cfg_file
= repo_git_path(&subrepo
, "config");
2428 abs_path
= absolute_pathdup(path
);
2429 rel_path
= relative_path(abs_path
, subrepo
.gitdir
, &sb
);
2431 git_config_set_in_file(cfg_file
, "core.worktree", rel_path
);
2435 strbuf_release(&sb
);
2438 repo_clear(&subrepo
);
2442 static const char *submodule_update_type_to_label(enum submodule_update_type type
)
2445 case SM_UPDATE_CHECKOUT
:
2447 case SM_UPDATE_MERGE
:
2449 case SM_UPDATE_REBASE
:
2451 case SM_UPDATE_UNSPECIFIED
:
2452 case SM_UPDATE_NONE
:
2453 case SM_UPDATE_COMMAND
:
2456 BUG("unreachable with type %d", type
);
2459 static void update_data_to_args(const struct update_data
*update_data
,
2460 struct strvec
*args
)
2462 enum submodule_update_type update_type
= update_data
->update_default
;
2464 strvec_pushl(args
, "submodule--helper", "update", "--recursive", NULL
);
2465 if (update_data
->displaypath
) {
2466 strvec_push(args
, "--super-prefix");
2467 strvec_pushf(args
, "%s/", update_data
->displaypath
);
2469 strvec_pushf(args
, "--jobs=%d", update_data
->max_jobs
);
2470 if (update_data
->quiet
)
2471 strvec_push(args
, "--quiet");
2472 if (update_data
->force
)
2473 strvec_push(args
, "--force");
2474 if (update_data
->init
)
2475 strvec_push(args
, "--init");
2476 if (update_data
->remote
)
2477 strvec_push(args
, "--remote");
2478 if (update_data
->nofetch
)
2479 strvec_push(args
, "--no-fetch");
2480 if (update_data
->dissociate
)
2481 strvec_push(args
, "--dissociate");
2482 if (update_data
->progress
)
2483 strvec_push(args
, "--progress");
2484 if (update_data
->require_init
)
2485 strvec_push(args
, "--require-init");
2486 if (update_data
->depth
)
2487 strvec_pushf(args
, "--depth=%d", update_data
->depth
);
2488 if (update_type
!= SM_UPDATE_UNSPECIFIED
)
2489 strvec_pushf(args
, "--%s",
2490 submodule_update_type_to_label(update_type
));
2492 if (update_data
->references
.nr
) {
2493 struct string_list_item
*item
;
2495 for_each_string_list_item(item
, &update_data
->references
)
2496 strvec_pushl(args
, "--reference", item
->string
, NULL
);
2498 if (update_data
->filter_options
&& update_data
->filter_options
->choice
)
2499 strvec_pushf(args
, "--filter=%s",
2500 expand_list_objects_filter_spec(
2501 update_data
->filter_options
));
2502 if (update_data
->recommend_shallow
== 0)
2503 strvec_push(args
, "--no-recommend-shallow");
2504 else if (update_data
->recommend_shallow
== 1)
2505 strvec_push(args
, "--recommend-shallow");
2506 if (update_data
->single_branch
>= 0)
2507 strvec_push(args
, update_data
->single_branch
?
2509 "--no-single-branch");
2512 static int update_submodule(struct update_data
*update_data
)
2516 ret
= determine_submodule_update_strategy(the_repository
,
2517 update_data
->just_cloned
,
2518 update_data
->sm_path
,
2519 update_data
->update_default
,
2520 &update_data
->update_strategy
);
2524 if (update_data
->just_cloned
)
2525 oidcpy(&update_data
->suboid
, null_oid());
2526 else if (resolve_gitlink_ref(update_data
->sm_path
, "HEAD", &update_data
->suboid
))
2527 return die_message(_("Unable to find current revision in submodule path '%s'"),
2528 update_data
->displaypath
);
2530 if (update_data
->remote
) {
2536 code
= get_default_remote_submodule(update_data
->sm_path
, &remote_name
);
2539 code
= remote_submodule_branch(update_data
->sm_path
, &branch
);
2542 remote_ref
= xstrfmt("refs/remotes/%s/%s", remote_name
, branch
);
2546 if (!update_data
->nofetch
) {
2547 if (fetch_in_submodule(update_data
->sm_path
, update_data
->depth
,
2549 return die_message(_("Unable to fetch in submodule path '%s'"),
2550 update_data
->sm_path
);
2553 if (resolve_gitlink_ref(update_data
->sm_path
, remote_ref
, &update_data
->oid
))
2554 return die_message(_("Unable to find %s revision in submodule path '%s'"),
2555 remote_ref
, update_data
->sm_path
);
2560 if (!oideq(&update_data
->oid
, &update_data
->suboid
) || update_data
->force
) {
2561 ret
= run_update_procedure(update_data
);
2566 if (update_data
->recursive
) {
2567 struct child_process cp
= CHILD_PROCESS_INIT
;
2568 struct update_data next
= *update_data
;
2571 oidcpy(&next
.oid
, null_oid());
2572 oidcpy(&next
.suboid
, null_oid());
2574 cp
.dir
= update_data
->sm_path
;
2576 prepare_submodule_repo_env(&cp
.env
);
2577 update_data_to_args(&next
, &cp
.args
);
2579 ret
= run_command(&cp
);
2581 die_message(_("Failed to recurse into submodule path '%s'"),
2582 update_data
->displaypath
);
2589 static int update_submodules(struct update_data
*update_data
)
2592 struct submodule_update_clone suc
= SUBMODULE_UPDATE_CLONE_INIT
;
2593 const struct run_process_parallel_opts opts
= {
2594 .tr2_category
= "submodule",
2595 .tr2_label
= "parallel/update",
2597 .processes
= update_data
->max_jobs
,
2599 .get_next_task
= update_clone_get_next_task
,
2600 .start_failure
= update_clone_start_failure
,
2601 .task_finished
= update_clone_task_finished
,
2605 suc
.update_data
= update_data
;
2606 run_processes_parallel(&opts
);
2609 * We saved the output and put it out all at once now.
2611 * - the listener does not have to interleave their (checkout)
2612 * work with our fetching. The writes involved in a
2613 * checkout involve more straightforward sequential I/O.
2614 * - the listener can avoid doing any work if fetching failed.
2616 if (suc
.quickstop
) {
2621 for (i
= 0; i
< suc
.update_clone_nr
; i
++) {
2622 struct update_clone_data ucd
= suc
.update_clone
[i
];
2625 oidcpy(&update_data
->oid
, &ucd
.oid
);
2626 update_data
->just_cloned
= ucd
.just_cloned
;
2627 update_data
->sm_path
= ucd
.sub
->path
;
2629 code
= ensure_core_worktree(update_data
->sm_path
);
2633 update_data
->displaypath
= get_submodule_displaypath(
2634 update_data
->sm_path
, update_data
->prefix
,
2635 update_data
->super_prefix
);
2636 code
= update_submodule(update_data
);
2637 FREE_AND_NULL(update_data
->displaypath
);
2647 submodule_update_clone_release(&suc
);
2648 string_list_clear(&update_data
->references
, 0);
2652 static int module_update(int argc
, const char **argv
, const char *prefix
)
2654 struct pathspec pathspec
= { 0 };
2655 struct pathspec pathspec2
= { 0 };
2656 struct update_data opt
= UPDATE_DATA_INIT
;
2657 struct list_objects_filter_options filter_options
=
2658 LIST_OBJECTS_FILTER_INIT
;
2660 struct option module_update_options
[] = {
2661 OPT__SUPER_PREFIX(&opt
.super_prefix
),
2662 OPT__FORCE(&opt
.force
, N_("force checkout updates"), 0),
2663 OPT_BOOL(0, "init", &opt
.init
,
2664 N_("initialize uninitialized submodules before update")),
2665 OPT_BOOL(0, "remote", &opt
.remote
,
2666 N_("use SHA-1 of submodule's remote tracking branch")),
2667 OPT_BOOL(0, "recursive", &opt
.recursive
,
2668 N_("traverse submodules recursively")),
2669 OPT_BOOL('N', "no-fetch", &opt
.nofetch
,
2670 N_("don't fetch new objects from the remote site")),
2671 OPT_SET_INT(0, "checkout", &opt
.update_default
,
2672 N_("use the 'checkout' update strategy (default)"),
2673 SM_UPDATE_CHECKOUT
),
2674 OPT_SET_INT('m', "merge", &opt
.update_default
,
2675 N_("use the 'merge' update strategy"),
2677 OPT_SET_INT('r', "rebase", &opt
.update_default
,
2678 N_("use the 'rebase' update strategy"),
2680 OPT_STRING_LIST(0, "reference", &opt
.references
, N_("repo"),
2681 N_("reference repository")),
2682 OPT_BOOL(0, "dissociate", &opt
.dissociate
,
2683 N_("use --reference only while cloning")),
2684 OPT_INTEGER(0, "depth", &opt
.depth
,
2685 N_("create a shallow clone truncated to the "
2686 "specified number of revisions")),
2687 OPT_INTEGER('j', "jobs", &opt
.max_jobs
,
2688 N_("parallel jobs")),
2689 OPT_BOOL(0, "recommend-shallow", &opt
.recommend_shallow
,
2690 N_("whether the initial clone should follow the shallow recommendation")),
2691 OPT__QUIET(&opt
.quiet
, N_("don't print cloning progress")),
2692 OPT_BOOL(0, "progress", &opt
.progress
,
2693 N_("force cloning progress")),
2694 OPT_BOOL(0, "require-init", &opt
.require_init
,
2695 N_("disallow cloning into non-empty directory, implies --init")),
2696 OPT_BOOL(0, "single-branch", &opt
.single_branch
,
2697 N_("clone only one branch, HEAD or --branch")),
2698 OPT_PARSE_LIST_OBJECTS_FILTER(&filter_options
),
2701 const char *const git_submodule_helper_usage
[] = {
2702 N_("git submodule [--quiet] update"
2703 " [--init [--filter=<filter-spec>]] [--remote]"
2704 " [-N|--no-fetch] [-f|--force]"
2705 " [--checkout|--merge|--rebase]"
2706 " [--[no-]recommend-shallow] [--reference <repository>]"
2707 " [--recursive] [--[no-]single-branch] [--] [<path>...]"),
2711 update_clone_config_from_gitmodules(&opt
.max_jobs
);
2712 git_config(git_update_clone_config
, &opt
.max_jobs
);
2714 argc
= parse_options(argc
, argv
, prefix
, module_update_options
,
2715 git_submodule_helper_usage
, 0);
2717 if (opt
.require_init
)
2720 if (filter_options
.choice
&& !opt
.init
) {
2721 usage_with_options(git_submodule_helper_usage
,
2722 module_update_options
);
2725 opt
.filter_options
= &filter_options
;
2726 opt
.prefix
= prefix
;
2728 if (opt
.update_default
)
2729 opt
.update_strategy
.type
= opt
.update_default
;
2731 if (module_list_compute(argv
, prefix
, &pathspec
, &opt
.list
) < 0) {
2737 opt
.warn_if_uninitialized
= 1;
2740 struct module_list list
= MODULE_LIST_INIT
;
2741 struct init_cb info
= INIT_CB_INIT
;
2743 if (module_list_compute(argv
, opt
.prefix
,
2744 &pathspec2
, &list
) < 0) {
2745 module_list_release(&list
);
2751 * If there are no path args and submodule.active is set then,
2752 * by default, only initialize 'active' modules.
2754 if (!argc
&& !git_config_get("submodule.active"))
2755 module_list_active(&list
);
2757 info
.prefix
= opt
.prefix
;
2758 info
.super_prefix
= opt
.super_prefix
;
2760 info
.flags
|= OPT_QUIET
;
2762 for_each_listed_submodule(&list
, init_submodule_cb
, &info
);
2763 module_list_release(&list
);
2766 ret
= update_submodules(&opt
);
2768 update_data_release(&opt
);
2769 list_objects_filter_release(&filter_options
);
2770 clear_pathspec(&pathspec
);
2771 clear_pathspec(&pathspec2
);
2775 static int push_check(int argc
, const char **argv
, const char *prefix UNUSED
)
2777 struct remote
*remote
;
2778 const char *superproject_head
;
2780 int detached_head
= 0;
2781 struct object_id head_oid
;
2784 die("submodule--helper push-check requires at least 2 arguments");
2787 * superproject's resolved head ref.
2788 * if HEAD then the superproject is in a detached head state, otherwise
2789 * it will be the resolved head ref.
2791 superproject_head
= argv
[1];
2794 /* Get the submodule's head ref and determine if it is detached */
2795 head
= resolve_refdup("HEAD", 0, &head_oid
, NULL
);
2797 die(_("Failed to resolve HEAD as a valid ref."));
2798 if (!strcmp(head
, "HEAD"))
2802 * The remote must be configured.
2803 * This is to avoid pushing to the exact same URL as the parent.
2805 remote
= pushremote_get(argv
[1]);
2806 if (!remote
|| remote
->origin
== REMOTE_UNCONFIGURED
)
2807 die("remote '%s' not configured", argv
[1]);
2809 /* Check the refspec */
2812 struct ref
*local_refs
= get_local_heads();
2813 struct refspec refspec
= REFSPEC_INIT_PUSH
;
2815 refspec_appendn(&refspec
, argv
+ 2, argc
- 2);
2817 for (i
= 0; i
< refspec
.nr
; i
++) {
2818 const struct refspec_item
*rs
= &refspec
.items
[i
];
2820 if (rs
->pattern
|| rs
->matching
)
2823 /* LHS must match a single ref */
2824 switch (count_refspec_match(rs
->src
, local_refs
, NULL
)) {
2829 * If LHS matches 'HEAD' then we need to ensure
2830 * that it matches the same named branch
2831 * checked out in the superproject.
2833 if (!strcmp(rs
->src
, "HEAD")) {
2834 if (!detached_head
&&
2835 !strcmp(head
, superproject_head
))
2837 die("HEAD does not match the named branch in the superproject");
2841 die("src refspec '%s' must name a ref",
2845 refspec_clear(&refspec
);
2852 static int absorb_git_dirs(int argc
, const char **argv
, const char *prefix
)
2855 struct pathspec pathspec
= { 0 };
2856 struct module_list list
= MODULE_LIST_INIT
;
2857 const char *super_prefix
= NULL
;
2858 struct option embed_gitdir_options
[] = {
2859 OPT__SUPER_PREFIX(&super_prefix
),
2862 const char *const git_submodule_helper_usage
[] = {
2863 N_("git submodule absorbgitdirs [<options>] [<path>...]"),
2868 argc
= parse_options(argc
, argv
, prefix
, embed_gitdir_options
,
2869 git_submodule_helper_usage
, 0);
2871 if (module_list_compute(argv
, prefix
, &pathspec
, &list
) < 0)
2874 for (i
= 0; i
< list
.nr
; i
++)
2875 absorb_git_dir_into_superproject(list
.entries
[i
]->name
,
2880 clear_pathspec(&pathspec
);
2881 module_list_release(&list
);
2885 static int module_set_url(int argc
, const char **argv
, const char *prefix
)
2891 struct option options
[] = {
2892 OPT__QUIET(&quiet
, N_("suppress output for setting url of a submodule")),
2895 const char *const usage
[] = {
2896 N_("git submodule set-url [--quiet] <path> <newurl>"),
2900 argc
= parse_options(argc
, argv
, prefix
, options
, usage
, 0);
2902 if (argc
!= 2 || !(path
= argv
[0]) || !(newurl
= argv
[1]))
2903 usage_with_options(usage
, options
);
2905 config_name
= xstrfmt("submodule.%s.url", path
);
2907 config_set_in_gitmodules_file_gently(config_name
, newurl
);
2908 sync_submodule(path
, prefix
, NULL
, quiet
? OPT_QUIET
: 0);
2915 static int module_set_branch(int argc
, const char **argv
, const char *prefix
)
2917 int opt_default
= 0, ret
;
2918 const char *opt_branch
= NULL
;
2921 struct option options
[] = {
2923 * We accept the `quiet` option for uniformity across subcommands,
2924 * though there is nothing to make less verbose in this subcommand.
2926 OPT_NOOP_NOARG('q', "quiet"),
2928 OPT_BOOL('d', "default", &opt_default
,
2929 N_("set the default tracking branch to master")),
2930 OPT_STRING('b', "branch", &opt_branch
, N_("branch"),
2931 N_("set the default tracking branch")),
2934 const char *const usage
[] = {
2935 N_("git submodule set-branch [-q|--quiet] (-d|--default) <path>"),
2936 N_("git submodule set-branch [-q|--quiet] (-b|--branch) <branch> <path>"),
2940 argc
= parse_options(argc
, argv
, prefix
, options
, usage
, 0);
2942 if (!opt_branch
&& !opt_default
)
2943 die(_("--branch or --default required"));
2945 if (opt_branch
&& opt_default
)
2946 die(_("options '%s' and '%s' cannot be used together"), "--branch", "--default");
2948 if (argc
!= 1 || !(path
= argv
[0]))
2949 usage_with_options(usage
, options
);
2951 config_name
= xstrfmt("submodule.%s.branch", path
);
2952 ret
= config_set_in_gitmodules_file_gently(config_name
, opt_branch
);
2958 static int module_create_branch(int argc
, const char **argv
, const char *prefix
)
2960 enum branch_track track
;
2961 int quiet
= 0, force
= 0, reflog
= 0, dry_run
= 0;
2962 struct option options
[] = {
2963 OPT__QUIET(&quiet
, N_("print only error messages")),
2964 OPT__FORCE(&force
, N_("force creation"), 0),
2965 OPT_BOOL(0, "create-reflog", &reflog
,
2966 N_("create the branch's reflog")),
2967 OPT_CALLBACK_F('t', "track", &track
, "(direct|inherit)",
2968 N_("set branch tracking configuration"),
2970 parse_opt_tracking_mode
),
2971 OPT__DRY_RUN(&dry_run
,
2972 N_("show whether the branch would be created")),
2975 const char *const usage
[] = {
2976 N_("git submodule--helper create-branch [-f|--force] [--create-reflog] [-q|--quiet] [-t|--track] [-n|--dry-run] <name> <start-oid> <start-name>"),
2980 git_config(git_default_config
, NULL
);
2981 track
= git_branch_track
;
2982 argc
= parse_options(argc
, argv
, prefix
, options
, usage
, 0);
2985 usage_with_options(usage
, options
);
2987 if (!quiet
&& !dry_run
)
2988 printf_ln(_("creating branch '%s'"), argv
[0]);
2990 create_branches_recursively(the_repository
, argv
[0], argv
[1], argv
[2],
2991 force
, reflog
, quiet
, track
, dry_run
);
2998 const char *reference_path
;
3000 const char *sm_name
;
3002 const char *realrepo
;
3004 unsigned int force
: 1;
3005 unsigned int quiet
: 1;
3006 unsigned int progress
: 1;
3007 unsigned int dissociate
: 1;
3009 #define ADD_DATA_INIT { .depth = -1 }
3011 static void append_fetch_remotes(struct strbuf
*msg
, const char *git_dir_path
)
3013 struct child_process cp_remote
= CHILD_PROCESS_INIT
;
3014 struct strbuf sb_remote_out
= STRBUF_INIT
;
3016 cp_remote
.git_cmd
= 1;
3017 strvec_pushf(&cp_remote
.env
,
3018 "GIT_DIR=%s", git_dir_path
);
3019 strvec_push(&cp_remote
.env
, "GIT_WORK_TREE=.");
3020 strvec_pushl(&cp_remote
.args
, "remote", "-v", NULL
);
3021 if (!capture_command(&cp_remote
, &sb_remote_out
, 0)) {
3023 char *line
= sb_remote_out
.buf
;
3025 while ((next_line
= strchr(line
, '\n')) != NULL
) {
3026 size_t len
= next_line
- line
;
3028 if (strip_suffix_mem(line
, &len
, " (fetch)"))
3029 strbuf_addf(msg
, " %.*s\n", (int)len
, line
);
3030 line
= next_line
+ 1;
3034 strbuf_release(&sb_remote_out
);
3037 static int add_submodule(const struct add_data
*add_data
)
3039 char *submod_gitdir_path
;
3040 struct module_clone_data clone_data
= MODULE_CLONE_DATA_INIT
;
3041 struct string_list reference
= STRING_LIST_INIT_NODUP
;
3044 /* perhaps the path already exists and is already a git repo, else clone it */
3045 if (is_directory(add_data
->sm_path
)) {
3046 struct strbuf sm_path
= STRBUF_INIT
;
3047 strbuf_addstr(&sm_path
, add_data
->sm_path
);
3048 submod_gitdir_path
= xstrfmt("%s/.git", add_data
->sm_path
);
3049 if (is_nonbare_repository_dir(&sm_path
))
3050 printf(_("Adding existing repo at '%s' to the index\n"),
3053 die(_("'%s' already exists and is not a valid git repo"),
3055 strbuf_release(&sm_path
);
3056 free(submod_gitdir_path
);
3058 struct child_process cp
= CHILD_PROCESS_INIT
;
3060 submod_gitdir_path
= xstrfmt(".git/modules/%s", add_data
->sm_name
);
3062 if (is_directory(submod_gitdir_path
)) {
3063 if (!add_data
->force
) {
3064 struct strbuf msg
= STRBUF_INIT
;
3067 strbuf_addf(&msg
, _("A git directory for '%s' is found "
3068 "locally with remote(s):\n"),
3071 append_fetch_remotes(&msg
, submod_gitdir_path
);
3072 free(submod_gitdir_path
);
3074 strbuf_addf(&msg
, _("If you want to reuse this local git "
3075 "directory instead of cloning again from\n"
3077 "use the '--force' option. If the local git "
3078 "directory is not the correct repo\n"
3079 "or you are unsure what this means choose "
3080 "another name with the '--name' option."),
3081 add_data
->realrepo
);
3083 die_msg
= strbuf_detach(&msg
, NULL
);
3086 printf(_("Reactivating local git directory for "
3087 "submodule '%s'\n"), add_data
->sm_name
);
3090 free(submod_gitdir_path
);
3092 clone_data
.prefix
= add_data
->prefix
;
3093 clone_data
.path
= add_data
->sm_path
;
3094 clone_data
.name
= add_data
->sm_name
;
3095 clone_data
.url
= add_data
->realrepo
;
3096 clone_data
.quiet
= add_data
->quiet
;
3097 clone_data
.progress
= add_data
->progress
;
3098 if (add_data
->reference_path
) {
3099 char *p
= xstrdup(add_data
->reference_path
);
3101 string_list_append(&reference
, p
)->util
= p
;
3103 clone_data
.dissociate
= add_data
->dissociate
;
3104 if (add_data
->depth
>= 0)
3105 clone_data
.depth
= xstrfmt("%d", add_data
->depth
);
3107 if (clone_submodule(&clone_data
, &reference
))
3110 prepare_submodule_repo_env(&cp
.env
);
3112 cp
.dir
= add_data
->sm_path
;
3114 * NOTE: we only get here if add_data->force is true, so
3115 * passing --force to checkout is reasonable.
3117 strvec_pushl(&cp
.args
, "checkout", "-f", "-q", NULL
);
3119 if (add_data
->branch
) {
3120 strvec_pushl(&cp
.args
, "-B", add_data
->branch
, NULL
);
3121 strvec_pushf(&cp
.args
, "origin/%s", add_data
->branch
);
3124 if (run_command(&cp
))
3125 die(_("unable to checkout submodule '%s'"), add_data
->sm_path
);
3129 string_list_clear(&reference
, 1);
3133 static int config_submodule_in_gitmodules(const char *name
, const char *var
, const char *value
)
3138 if (!is_writing_gitmodules_ok())
3139 die(_("please make sure that the .gitmodules file is in the working tree"));
3141 key
= xstrfmt("submodule.%s.%s", name
, var
);
3142 ret
= config_set_in_gitmodules_file_gently(key
, value
);
3148 static void configure_added_submodule(struct add_data
*add_data
)
3151 struct child_process add_submod
= CHILD_PROCESS_INIT
;
3152 struct child_process add_gitmodules
= CHILD_PROCESS_INIT
;
3154 key
= xstrfmt("submodule.%s.url", add_data
->sm_name
);
3155 git_config_set_gently(key
, add_data
->realrepo
);
3158 add_submod
.git_cmd
= 1;
3159 strvec_pushl(&add_submod
.args
, "add",
3160 "--no-warn-embedded-repo", NULL
);
3161 if (add_data
->force
)
3162 strvec_push(&add_submod
.args
, "--force");
3163 strvec_pushl(&add_submod
.args
, "--", add_data
->sm_path
, NULL
);
3165 if (run_command(&add_submod
))
3166 die(_("Failed to add submodule '%s'"), add_data
->sm_path
);
3168 if (config_submodule_in_gitmodules(add_data
->sm_name
, "path", add_data
->sm_path
) ||
3169 config_submodule_in_gitmodules(add_data
->sm_name
, "url", add_data
->repo
))
3170 die(_("Failed to register submodule '%s'"), add_data
->sm_path
);
3172 if (add_data
->branch
) {
3173 if (config_submodule_in_gitmodules(add_data
->sm_name
,
3174 "branch", add_data
->branch
))
3175 die(_("Failed to register submodule '%s'"), add_data
->sm_path
);
3178 add_gitmodules
.git_cmd
= 1;
3179 strvec_pushl(&add_gitmodules
.args
,
3180 "add", "--force", "--", ".gitmodules", NULL
);
3182 if (run_command(&add_gitmodules
))
3183 die(_("Failed to register submodule '%s'"), add_data
->sm_path
);
3186 * NEEDSWORK: In a multi-working-tree world this needs to be
3187 * set in the per-worktree config.
3190 * NEEDSWORK: In the longer run, we need to get rid of this
3191 * pattern of querying "submodule.active" before calling
3192 * is_submodule_active(), since that function needs to find
3193 * out the value of "submodule.active" again anyway.
3195 if (!git_config_get("submodule.active")) {
3197 * If the submodule being added isn't already covered by the
3198 * current configured pathspec, set the submodule's active flag
3200 if (!is_submodule_active(the_repository
, add_data
->sm_path
)) {
3201 key
= xstrfmt("submodule.%s.active", add_data
->sm_name
);
3202 git_config_set_gently(key
, "true");
3206 key
= xstrfmt("submodule.%s.active", add_data
->sm_name
);
3207 git_config_set_gently(key
, "true");
3212 static void die_on_index_match(const char *path
, int force
)
3215 const char *args
[] = { path
, NULL
};
3216 parse_pathspec(&ps
, 0, PATHSPEC_PREFER_CWD
, NULL
, args
);
3218 if (repo_read_index_preload(the_repository
, NULL
, 0) < 0)
3219 die(_("index file corrupt"));
3223 char *ps_matched
= xcalloc(ps
.nr
, 1);
3225 /* TODO: audit for interaction with sparse-index. */
3226 ensure_full_index(&the_index
);
3229 * Since there is only one pathspec, we just need to
3230 * check ps_matched[0] to know if a cache entry matched.
3232 for (i
= 0; i
< the_index
.cache_nr
; i
++) {
3233 ce_path_match(&the_index
, the_index
.cache
[i
], &ps
,
3236 if (ps_matched
[0]) {
3238 die(_("'%s' already exists in the index"),
3240 if (!S_ISGITLINK(the_index
.cache
[i
]->ce_mode
))
3241 die(_("'%s' already exists in the index "
3242 "and is not a submodule"), path
);
3248 clear_pathspec(&ps
);
3251 static void die_on_repo_without_commits(const char *path
)
3253 struct strbuf sb
= STRBUF_INIT
;
3254 strbuf_addstr(&sb
, path
);
3255 if (is_nonbare_repository_dir(&sb
)) {
3256 struct object_id oid
;
3257 if (resolve_gitlink_ref(path
, "HEAD", &oid
) < 0)
3258 die(_("'%s' does not have a commit checked out"), path
);
3260 strbuf_release(&sb
);
3263 static int module_add(int argc
, const char **argv
, const char *prefix
)
3265 int force
= 0, quiet
= 0, progress
= 0, dissociate
= 0;
3266 struct add_data add_data
= ADD_DATA_INIT
;
3267 char *to_free
= NULL
;
3268 struct option options
[] = {
3269 OPT_STRING('b', "branch", &add_data
.branch
, N_("branch"),
3270 N_("branch of repository to add as submodule")),
3271 OPT__FORCE(&force
, N_("allow adding an otherwise ignored submodule path"),
3272 PARSE_OPT_NOCOMPLETE
),
3273 OPT__QUIET(&quiet
, N_("print only error messages")),
3274 OPT_BOOL(0, "progress", &progress
, N_("force cloning progress")),
3275 OPT_STRING(0, "reference", &add_data
.reference_path
, N_("repository"),
3276 N_("reference repository")),
3277 OPT_BOOL(0, "dissociate", &dissociate
, N_("borrow the objects from reference repositories")),
3278 OPT_STRING(0, "name", &add_data
.sm_name
, N_("name"),
3279 N_("sets the submodule's name to the given string "
3280 "instead of defaulting to its path")),
3281 OPT_INTEGER(0, "depth", &add_data
.depth
, N_("depth for shallow clones")),
3284 const char *const usage
[] = {
3285 N_("git submodule add [<options>] [--] <repository> [<path>]"),
3288 struct strbuf sb
= STRBUF_INIT
;
3291 argc
= parse_options(argc
, argv
, prefix
, options
, usage
, 0);
3293 if (!is_writing_gitmodules_ok())
3294 die(_("please make sure that the .gitmodules file is in the working tree"));
3296 if (prefix
&& *prefix
&&
3297 add_data
.reference_path
&& !is_absolute_path(add_data
.reference_path
))
3298 add_data
.reference_path
= xstrfmt("%s%s", prefix
, add_data
.reference_path
);
3300 if (argc
== 0 || argc
> 2)
3301 usage_with_options(usage
, options
);
3303 add_data
.repo
= argv
[0];
3305 add_data
.sm_path
= git_url_basename(add_data
.repo
, 0, 0);
3307 add_data
.sm_path
= xstrdup(argv
[1]);
3309 if (prefix
&& *prefix
&& !is_absolute_path(add_data
.sm_path
)) {
3310 char *sm_path
= add_data
.sm_path
;
3312 add_data
.sm_path
= xstrfmt("%s%s", prefix
, sm_path
);
3316 if (starts_with_dot_dot_slash(add_data
.repo
) ||
3317 starts_with_dot_slash(add_data
.repo
)) {
3319 die(_("Relative path can only be used from the toplevel "
3320 "of the working tree"));
3322 /* dereference source url relative to parent's url */
3323 to_free
= resolve_relative_url(add_data
.repo
, NULL
, 1);
3324 add_data
.realrepo
= to_free
;
3325 } else if (is_dir_sep(add_data
.repo
[0]) || strchr(add_data
.repo
, ':')) {
3326 add_data
.realrepo
= add_data
.repo
;
3328 die(_("repo URL: '%s' must be absolute or begin with ./|../"),
3334 * multiple //; leading ./; /./; /../;
3336 normalize_path_copy(add_data
.sm_path
, add_data
.sm_path
);
3337 strip_dir_trailing_slashes(add_data
.sm_path
);
3339 die_on_index_match(add_data
.sm_path
, force
);
3340 die_on_repo_without_commits(add_data
.sm_path
);
3343 struct child_process cp
= CHILD_PROCESS_INIT
;
3347 strvec_pushl(&cp
.args
, "add", "--dry-run", "--ignore-missing",
3348 "--no-warn-embedded-repo", add_data
.sm_path
, NULL
);
3349 if ((ret
= pipe_command(&cp
, NULL
, 0, NULL
, 0, &sb
, 0))) {
3350 strbuf_complete_line(&sb
);
3351 fputs(sb
.buf
, stderr
);
3356 if(!add_data
.sm_name
)
3357 add_data
.sm_name
= add_data
.sm_path
;
3359 if (check_submodule_name(add_data
.sm_name
))
3360 die(_("'%s' is not a valid submodule name"), add_data
.sm_name
);
3362 add_data
.prefix
= prefix
;
3363 add_data
.force
= !!force
;
3364 add_data
.quiet
= !!quiet
;
3365 add_data
.progress
= !!progress
;
3366 add_data
.dissociate
= !!dissociate
;
3368 if (add_submodule(&add_data
))
3370 configure_added_submodule(&add_data
);
3374 free(add_data
.sm_path
);
3376 strbuf_release(&sb
);
3381 int cmd_submodule__helper(int argc
, const char **argv
, const char *prefix
)
3383 parse_opt_subcommand_fn
*fn
= NULL
;
3384 const char *const usage
[] = {
3385 N_("git submodule--helper <command>"),
3388 struct option options
[] = {
3389 OPT_SUBCOMMAND("clone", &fn
, module_clone
),
3390 OPT_SUBCOMMAND("add", &fn
, module_add
),
3391 OPT_SUBCOMMAND("update", &fn
, module_update
),
3392 OPT_SUBCOMMAND("foreach", &fn
, module_foreach
),
3393 OPT_SUBCOMMAND("init", &fn
, module_init
),
3394 OPT_SUBCOMMAND("status", &fn
, module_status
),
3395 OPT_SUBCOMMAND("sync", &fn
, module_sync
),
3396 OPT_SUBCOMMAND("deinit", &fn
, module_deinit
),
3397 OPT_SUBCOMMAND("summary", &fn
, module_summary
),
3398 OPT_SUBCOMMAND("push-check", &fn
, push_check
),
3399 OPT_SUBCOMMAND("absorbgitdirs", &fn
, absorb_git_dirs
),
3400 OPT_SUBCOMMAND("set-url", &fn
, module_set_url
),
3401 OPT_SUBCOMMAND("set-branch", &fn
, module_set_branch
),
3402 OPT_SUBCOMMAND("create-branch", &fn
, module_create_branch
),
3405 argc
= parse_options(argc
, argv
, prefix
, options
, usage
, 0);
3407 return fn(argc
, argv
, prefix
);