Merge branch 'ar/submodule-add'
Rewrite of "git submodule" in C continues. * ar/submodule-add: submodule: drop unused sm_name parameter from show_fetch_remotes() submodule--helper: introduce add-clone subcommand submodule--helper: refactor module_clone() submodule: prefix die messages with 'fatal' t7400: test failure to add submodule in tracked path
This commit is contained in:
Junio C Hamano
@ -1657,45 +1657,20 @@ static int module_deinit(int argc, const char **argv, const char *prefix)
|
||||
return 0;
|
||||
}
|
||||
|
||||
static int clone_submodule(const char *path, const char *gitdir, const char *url,
|
||||
const char *depth, struct string_list *reference, int dissociate,
|
||||
int quiet, int progress, int single_branch)
|
||||
{
|
||||
struct child_process cp = CHILD_PROCESS_INIT;
|
||||
|
||||
strvec_push(&cp.args, "clone");
|
||||
strvec_push(&cp.args, "--no-checkout");
|
||||
if (quiet)
|
||||
strvec_push(&cp.args, "--quiet");
|
||||
if (progress)
|
||||
strvec_push(&cp.args, "--progress");
|
||||
if (depth && *depth)
|
||||
strvec_pushl(&cp.args, "--depth", depth, NULL);
|
||||
if (reference->nr) {
|
||||
struct string_list_item *item;
|
||||
for_each_string_list_item(item, reference)
|
||||
strvec_pushl(&cp.args, "--reference",
|
||||
item->string, NULL);
|
||||
}
|
||||
if (dissociate)
|
||||
strvec_push(&cp.args, "--dissociate");
|
||||
if (gitdir && *gitdir)
|
||||
strvec_pushl(&cp.args, "--separate-git-dir", gitdir, NULL);
|
||||
if (single_branch >= 0)
|
||||
strvec_push(&cp.args, single_branch ?
|
||||
"--single-branch" :
|
||||
"--no-single-branch");
|
||||
|
||||
strvec_push(&cp.args, "--");
|
||||
strvec_push(&cp.args, url);
|
||||
strvec_push(&cp.args, path);
|
||||
|
||||
cp.git_cmd = 1;
|
||||
prepare_submodule_repo_env(&cp.env_array);
|
||||
cp.no_stdin = 1;
|
||||
|
||||
return run_command(&cp);
|
||||
}
|
||||
struct module_clone_data {
|
||||
const char *prefix;
|
||||
const char *path;
|
||||
const char *name;
|
||||
const char *url;
|
||||
const char *depth;
|
||||
struct string_list reference;
|
||||
unsigned int quiet: 1;
|
||||
unsigned int progress: 1;
|
||||
unsigned int dissociate: 1;
|
||||
unsigned int require_init: 1;
|
||||
int single_branch;
|
||||
};
|
||||
#define MODULE_CLONE_DATA_INIT { .reference = STRING_LIST_INIT_NODUP, .single_branch = -1 }
|
||||
|
||||
struct submodule_alternate_setup {
|
||||
const char *submodule_name;
|
||||
@ -1801,37 +1776,128 @@ static void prepare_possible_alternates(const char *sm_name,
|
||||
free(error_strategy);
|
||||
}
|
||||
|
||||
static int clone_submodule(struct module_clone_data *clone_data)
|
||||
{
|
||||
char *p, *sm_gitdir;
|
||||
char *sm_alternate = NULL, *error_strategy = NULL;
|
||||
struct strbuf sb = STRBUF_INIT;
|
||||
struct child_process cp = CHILD_PROCESS_INIT;
|
||||
|
||||
strbuf_addf(&sb, "%s/modules/%s", get_git_dir(), clone_data->name);
|
||||
sm_gitdir = absolute_pathdup(sb.buf);
|
||||
strbuf_reset(&sb);
|
||||
|
||||
if (!is_absolute_path(clone_data->path)) {
|
||||
strbuf_addf(&sb, "%s/%s", get_git_work_tree(), clone_data->path);
|
||||
clone_data->path = strbuf_detach(&sb, NULL);
|
||||
} else {
|
||||
clone_data->path = xstrdup(clone_data->path);
|
||||
}
|
||||
|
||||
if (validate_submodule_git_dir(sm_gitdir, clone_data->name) < 0)
|
||||
die(_("refusing to create/use '%s' in another submodule's "
|
||||
"git dir"), sm_gitdir);
|
||||
|
||||
if (!file_exists(sm_gitdir)) {
|
||||
if (safe_create_leading_directories_const(sm_gitdir) < 0)
|
||||
die(_("could not create directory '%s'"), sm_gitdir);
|
||||
|
||||
prepare_possible_alternates(clone_data->name, &clone_data->reference);
|
||||
|
||||
strvec_push(&cp.args, "clone");
|
||||
strvec_push(&cp.args, "--no-checkout");
|
||||
if (clone_data->quiet)
|
||||
strvec_push(&cp.args, "--quiet");
|
||||
if (clone_data->progress)
|
||||
strvec_push(&cp.args, "--progress");
|
||||
if (clone_data->depth && *(clone_data->depth))
|
||||
strvec_pushl(&cp.args, "--depth", clone_data->depth, NULL);
|
||||
if (clone_data->reference.nr) {
|
||||
struct string_list_item *item;
|
||||
for_each_string_list_item(item, &clone_data->reference)
|
||||
strvec_pushl(&cp.args, "--reference",
|
||||
item->string, NULL);
|
||||
}
|
||||
if (clone_data->dissociate)
|
||||
strvec_push(&cp.args, "--dissociate");
|
||||
if (sm_gitdir && *sm_gitdir)
|
||||
strvec_pushl(&cp.args, "--separate-git-dir", sm_gitdir, NULL);
|
||||
if (clone_data->single_branch >= 0)
|
||||
strvec_push(&cp.args, clone_data->single_branch ?
|
||||
"--single-branch" :
|
||||
"--no-single-branch");
|
||||
|
||||
strvec_push(&cp.args, "--");
|
||||
strvec_push(&cp.args, clone_data->url);
|
||||
strvec_push(&cp.args, clone_data->path);
|
||||
|
||||
cp.git_cmd = 1;
|
||||
prepare_submodule_repo_env(&cp.env_array);
|
||||
cp.no_stdin = 1;
|
||||
|
||||
if(run_command(&cp))
|
||||
die(_("clone of '%s' into submodule path '%s' failed"),
|
||||
clone_data->url, clone_data->path);
|
||||
} else {
|
||||
if (clone_data->require_init && !access(clone_data->path, X_OK) &&
|
||||
!is_empty_dir(clone_data->path))
|
||||
die(_("directory not empty: '%s'"), clone_data->path);
|
||||
if (safe_create_leading_directories_const(clone_data->path) < 0)
|
||||
die(_("could not create directory '%s'"), clone_data->path);
|
||||
strbuf_addf(&sb, "%s/index", sm_gitdir);
|
||||
unlink_or_warn(sb.buf);
|
||||
strbuf_reset(&sb);
|
||||
}
|
||||
|
||||
connect_work_tree_and_git_dir(clone_data->path, sm_gitdir, 0);
|
||||
|
||||
p = git_pathdup_submodule(clone_data->path, "config");
|
||||
if (!p)
|
||||
die(_("could not get submodule directory for '%s'"), clone_data->path);
|
||||
|
||||
/* setup alternateLocation and alternateErrorStrategy in the cloned submodule if needed */
|
||||
git_config_get_string("submodule.alternateLocation", &sm_alternate);
|
||||
if (sm_alternate)
|
||||
git_config_set_in_file(p, "submodule.alternateLocation",
|
||||
sm_alternate);
|
||||
git_config_get_string("submodule.alternateErrorStrategy", &error_strategy);
|
||||
if (error_strategy)
|
||||
git_config_set_in_file(p, "submodule.alternateErrorStrategy",
|
||||
error_strategy);
|
||||
|
||||
free(sm_alternate);
|
||||
free(error_strategy);
|
||||
|
||||
strbuf_release(&sb);
|
||||
free(sm_gitdir);
|
||||
free(p);
|
||||
return 0;
|
||||
}
|
||||
|
||||
static int module_clone(int argc, const char **argv, const char *prefix)
|
||||
{
|
||||
const char *name = NULL, *url = NULL, *depth = NULL;
|
||||
int quiet = 0;
|
||||
int progress = 0;
|
||||
char *p, *path = NULL, *sm_gitdir;
|
||||
struct strbuf sb = STRBUF_INIT;
|
||||
struct string_list reference = STRING_LIST_INIT_NODUP;
|
||||
int dissociate = 0, require_init = 0;
|
||||
char *sm_alternate = NULL, *error_strategy = NULL;
|
||||
int single_branch = -1;
|
||||
int dissociate = 0, quiet = 0, progress = 0, require_init = 0;
|
||||
struct module_clone_data clone_data = MODULE_CLONE_DATA_INIT;
|
||||
|
||||
struct option module_clone_options[] = {
|
||||
OPT_STRING(0, "prefix", &prefix,
|
||||
OPT_STRING(0, "prefix", &clone_data.prefix,
|
||||
N_("path"),
|
||||
N_("alternative anchor for relative paths")),
|
||||
OPT_STRING(0, "path", &path,
|
||||
OPT_STRING(0, "path", &clone_data.path,
|
||||
N_("path"),
|
||||
N_("where the new submodule will be cloned to")),
|
||||
OPT_STRING(0, "name", &name,
|
||||
OPT_STRING(0, "name", &clone_data.name,
|
||||
N_("string"),
|
||||
N_("name of the new submodule")),
|
||||
OPT_STRING(0, "url", &url,
|
||||
OPT_STRING(0, "url", &clone_data.url,
|
||||
N_("string"),
|
||||
N_("url where to clone the submodule from")),
|
||||
OPT_STRING_LIST(0, "reference", &reference,
|
||||
OPT_STRING_LIST(0, "reference", &clone_data.reference,
|
||||
N_("repo"),
|
||||
N_("reference repository")),
|
||||
OPT_BOOL(0, "dissociate", &dissociate,
|
||||
N_("use --reference only while cloning")),
|
||||
OPT_STRING(0, "depth", &depth,
|
||||
OPT_STRING(0, "depth", &clone_data.depth,
|
||||
N_("string"),
|
||||
N_("depth for shallow clones")),
|
||||
OPT__QUIET(&quiet, "Suppress output for cloning a submodule"),
|
||||
@ -1839,7 +1905,7 @@ static int module_clone(int argc, const char **argv, const char *prefix)
|
||||
N_("force cloning progress")),
|
||||
OPT_BOOL(0, "require-init", &require_init,
|
||||
N_("disallow cloning into non-empty directory")),
|
||||
OPT_BOOL(0, "single-branch", &single_branch,
|
||||
OPT_BOOL(0, "single-branch", &clone_data.single_branch,
|
||||
N_("clone only one branch, HEAD or --branch")),
|
||||
OPT_END()
|
||||
};
|
||||
@ -1855,67 +1921,16 @@ static int module_clone(int argc, const char **argv, const char *prefix)
|
||||
argc = parse_options(argc, argv, prefix, module_clone_options,
|
||||
git_submodule_helper_usage, 0);
|
||||
|
||||
if (argc || !url || !path || !*path)
|
||||
clone_data.dissociate = !!dissociate;
|
||||
clone_data.quiet = !!quiet;
|
||||
clone_data.progress = !!progress;
|
||||
clone_data.require_init = !!require_init;
|
||||
|
||||
if (argc || !clone_data.url || !clone_data.path || !*(clone_data.path))
|
||||
usage_with_options(git_submodule_helper_usage,
|
||||
module_clone_options);
|
||||
|
||||
strbuf_addf(&sb, "%s/modules/%s", get_git_dir(), name);
|
||||
sm_gitdir = absolute_pathdup(sb.buf);
|
||||
strbuf_reset(&sb);
|
||||
|
||||
if (!is_absolute_path(path)) {
|
||||
strbuf_addf(&sb, "%s/%s", get_git_work_tree(), path);
|
||||
path = strbuf_detach(&sb, NULL);
|
||||
} else
|
||||
path = xstrdup(path);
|
||||
|
||||
if (validate_submodule_git_dir(sm_gitdir, name) < 0)
|
||||
die(_("refusing to create/use '%s' in another submodule's "
|
||||
"git dir"), sm_gitdir);
|
||||
|
||||
if (!file_exists(sm_gitdir)) {
|
||||
if (safe_create_leading_directories_const(sm_gitdir) < 0)
|
||||
die(_("could not create directory '%s'"), sm_gitdir);
|
||||
|
||||
prepare_possible_alternates(name, &reference);
|
||||
|
||||
if (clone_submodule(path, sm_gitdir, url, depth, &reference, dissociate,
|
||||
quiet, progress, single_branch))
|
||||
die(_("clone of '%s' into submodule path '%s' failed"),
|
||||
url, path);
|
||||
} else {
|
||||
if (require_init && !access(path, X_OK) && !is_empty_dir(path))
|
||||
die(_("directory not empty: '%s'"), path);
|
||||
if (safe_create_leading_directories_const(path) < 0)
|
||||
die(_("could not create directory '%s'"), path);
|
||||
strbuf_addf(&sb, "%s/index", sm_gitdir);
|
||||
unlink_or_warn(sb.buf);
|
||||
strbuf_reset(&sb);
|
||||
}
|
||||
|
||||
connect_work_tree_and_git_dir(path, sm_gitdir, 0);
|
||||
|
||||
p = git_pathdup_submodule(path, "config");
|
||||
if (!p)
|
||||
die(_("could not get submodule directory for '%s'"), path);
|
||||
|
||||
/* setup alternateLocation and alternateErrorStrategy in the cloned submodule if needed */
|
||||
git_config_get_string("submodule.alternateLocation", &sm_alternate);
|
||||
if (sm_alternate)
|
||||
git_config_set_in_file(p, "submodule.alternateLocation",
|
||||
sm_alternate);
|
||||
git_config_get_string("submodule.alternateErrorStrategy", &error_strategy);
|
||||
if (error_strategy)
|
||||
git_config_set_in_file(p, "submodule.alternateErrorStrategy",
|
||||
error_strategy);
|
||||
|
||||
free(sm_alternate);
|
||||
free(error_strategy);
|
||||
|
||||
strbuf_release(&sb);
|
||||
free(sm_gitdir);
|
||||
free(path);
|
||||
free(p);
|
||||
clone_submodule(&clone_data);
|
||||
return 0;
|
||||
}
|
||||
|
||||
@ -2744,6 +2759,181 @@ static int module_set_branch(int argc, const char **argv, const char *prefix)
|
||||
return !!ret;
|
||||
}
|
||||
|
||||
struct add_data {
|
||||
const char *prefix;
|
||||
const char *branch;
|
||||
const char *reference_path;
|
||||
const char *sm_path;
|
||||
const char *sm_name;
|
||||
const char *repo;
|
||||
const char *realrepo;
|
||||
int depth;
|
||||
unsigned int force: 1;
|
||||
unsigned int quiet: 1;
|
||||
unsigned int progress: 1;
|
||||
unsigned int dissociate: 1;
|
||||
};
|
||||
#define ADD_DATA_INIT { .depth = -1 }
|
||||
|
||||
static void show_fetch_remotes(FILE *output, const char *git_dir_path)
|
||||
{
|
||||
struct child_process cp_remote = CHILD_PROCESS_INIT;
|
||||
struct strbuf sb_remote_out = STRBUF_INIT;
|
||||
|
||||
cp_remote.git_cmd = 1;
|
||||
strvec_pushf(&cp_remote.env_array,
|
||||
"GIT_DIR=%s", git_dir_path);
|
||||
strvec_push(&cp_remote.env_array, "GIT_WORK_TREE=.");
|
||||
strvec_pushl(&cp_remote.args, "remote", "-v", NULL);
|
||||
if (!capture_command(&cp_remote, &sb_remote_out, 0)) {
|
||||
char *next_line;
|
||||
char *line = sb_remote_out.buf;
|
||||
while ((next_line = strchr(line, '\n')) != NULL) {
|
||||
size_t len = next_line - line;
|
||||
if (strip_suffix_mem(line, &len, " (fetch)"))
|
||||
fprintf(output, " %.*s\n", (int)len, line);
|
||||
line = next_line + 1;
|
||||
}
|
||||
}
|
||||
|
||||
strbuf_release(&sb_remote_out);
|
||||
}
|
||||
|
||||
static int add_submodule(const struct add_data *add_data)
|
||||
{
|
||||
char *submod_gitdir_path;
|
||||
struct module_clone_data clone_data = MODULE_CLONE_DATA_INIT;
|
||||
|
||||
/* perhaps the path already exists and is already a git repo, else clone it */
|
||||
if (is_directory(add_data->sm_path)) {
|
||||
struct strbuf sm_path = STRBUF_INIT;
|
||||
strbuf_addstr(&sm_path, add_data->sm_path);
|
||||
submod_gitdir_path = xstrfmt("%s/.git", add_data->sm_path);
|
||||
if (is_nonbare_repository_dir(&sm_path))
|
||||
printf(_("Adding existing repo at '%s' to the index\n"),
|
||||
add_data->sm_path);
|
||||
else
|
||||
die(_("'%s' already exists and is not a valid git repo"),
|
||||
add_data->sm_path);
|
||||
strbuf_release(&sm_path);
|
||||
free(submod_gitdir_path);
|
||||
} else {
|
||||
struct child_process cp = CHILD_PROCESS_INIT;
|
||||
submod_gitdir_path = xstrfmt(".git/modules/%s", add_data->sm_name);
|
||||
|
||||
if (is_directory(submod_gitdir_path)) {
|
||||
if (!add_data->force) {
|
||||
fprintf(stderr, _("A git directory for '%s' is found "
|
||||
"locally with remote(s):"),
|
||||
add_data->sm_name);
|
||||
show_fetch_remotes(stderr, submod_gitdir_path);
|
||||
free(submod_gitdir_path);
|
||||
die(_("If you want to reuse this local git "
|
||||
"directory instead of cloning again from\n"
|
||||
" %s\n"
|
||||
"use the '--force' option. If the local git "
|
||||
"directory is not the correct repo\n"
|
||||
"or if you are unsure what this means, choose "
|
||||
"another name with the '--name' option.\n"),
|
||||
add_data->realrepo);
|
||||
} else {
|
||||
printf(_("Reactivating local git directory for "
|
||||
"submodule '%s'\n"), add_data->sm_name);
|
||||
}
|
||||
}
|
||||
free(submod_gitdir_path);
|
||||
|
||||
clone_data.prefix = add_data->prefix;
|
||||
clone_data.path = add_data->sm_path;
|
||||
clone_data.name = add_data->sm_name;
|
||||
clone_data.url = add_data->realrepo;
|
||||
clone_data.quiet = add_data->quiet;
|
||||
clone_data.progress = add_data->progress;
|
||||
if (add_data->reference_path)
|
||||
string_list_append(&clone_data.reference,
|
||||
xstrdup(add_data->reference_path));
|
||||
clone_data.dissociate = add_data->dissociate;
|
||||
if (add_data->depth >= 0)
|
||||
clone_data.depth = xstrfmt("%d", add_data->depth);
|
||||
|
||||
if (clone_submodule(&clone_data))
|
||||
return -1;
|
||||
|
||||
prepare_submodule_repo_env(&cp.env_array);
|
||||
cp.git_cmd = 1;
|
||||
cp.dir = add_data->sm_path;
|
||||
strvec_pushl(&cp.args, "checkout", "-f", "-q", NULL);
|
||||
|
||||
if (add_data->branch) {
|
||||
strvec_pushl(&cp.args, "-B", add_data->branch, NULL);
|
||||
strvec_pushf(&cp.args, "origin/%s", add_data->branch);
|
||||
}
|
||||
|
||||
if (run_command(&cp))
|
||||
die(_("unable to checkout submodule '%s'"), add_data->sm_path);
|
||||
}
|
||||
return 0;
|
||||
}
|
||||
|
||||
static int add_clone(int argc, const char **argv, const char *prefix)
|
||||
{
|
||||
int force = 0, quiet = 0, dissociate = 0, progress = 0;
|
||||
struct add_data add_data = ADD_DATA_INIT;
|
||||
|
||||
struct option options[] = {
|
||||
OPT_STRING('b', "branch", &add_data.branch,
|
||||
N_("branch"),
|
||||
N_("branch of repository to checkout on cloning")),
|
||||
OPT_STRING(0, "prefix", &prefix,
|
||||
N_("path"),
|
||||
N_("alternative anchor for relative paths")),
|
||||
OPT_STRING(0, "path", &add_data.sm_path,
|
||||
N_("path"),
|
||||
N_("where the new submodule will be cloned to")),
|
||||
OPT_STRING(0, "name", &add_data.sm_name,
|
||||
N_("string"),
|
||||
N_("name of the new submodule")),
|
||||
OPT_STRING(0, "url", &add_data.realrepo,
|
||||
N_("string"),
|
||||
N_("url where to clone the submodule from")),
|
||||
OPT_STRING(0, "reference", &add_data.reference_path,
|
||||
N_("repo"),
|
||||
N_("reference repository")),
|
||||
OPT_BOOL(0, "dissociate", &dissociate,
|
||||
N_("use --reference only while cloning")),
|
||||
OPT_INTEGER(0, "depth", &add_data.depth,
|
||||
N_("depth for shallow clones")),
|
||||
OPT_BOOL(0, "progress", &progress,
|
||||
N_("force cloning progress")),
|
||||
OPT__FORCE(&force, N_("allow adding an otherwise ignored submodule path"),
|
||||
PARSE_OPT_NOCOMPLETE),
|
||||
OPT__QUIET(&quiet, "suppress output for cloning a submodule"),
|
||||
OPT_END()
|
||||
};
|
||||
|
||||
const char *const usage[] = {
|
||||
N_("git submodule--helper add-clone [<options>...] "
|
||||
"--url <url> --path <path> --name <name>"),
|
||||
NULL
|
||||
};
|
||||
|
||||
argc = parse_options(argc, argv, prefix, options, usage, 0);
|
||||
|
||||
if (argc != 0)
|
||||
usage_with_options(usage, options);
|
||||
|
||||
add_data.prefix = prefix;
|
||||
add_data.progress = !!progress;
|
||||
add_data.dissociate = !!dissociate;
|
||||
add_data.force = !!force;
|
||||
add_data.quiet = !!quiet;
|
||||
|
||||
if (add_submodule(&add_data))
|
||||
return 1;
|
||||
|
||||
return 0;
|
||||
}
|
||||
|
||||
#define SUPPORT_SUPER_PREFIX (1<<0)
|
||||
|
||||
struct cmd_struct {
|
||||
@ -2756,6 +2946,7 @@ static struct cmd_struct commands[] = {
|
||||
{"list", module_list, 0},
|
||||
{"name", module_name, 0},
|
||||
{"clone", module_clone, 0},
|
||||
{"add-clone", add_clone, 0},
|
||||
{"update-module-mode", module_update_module_mode, 0},
|
||||
{"update-clone", update_clone, 0},
|
||||
{"ensure-core-worktree", ensure_core_worktree, 0},
|
||||
|
||||
Reference in New Issue
Block a user