mirror of
https://github.com/git/git
synced 2024-08-28 12:09:19 +00:00
![Derrick Stolee](/assets/img/avatar_default.png)
When someone wants to clone a large repository, but plans to work using a sparse-checkout file, they either need to do a full checkout first and then reduce the patterns they included, or clone with --no-checkout, set up their patterns, and then run a checkout manually. This requires knowing a lot about the repo shape and how sparse-checkout works. Add a new '--sparse' option to 'git clone' that initializes the sparse-checkout file to include the following patterns: /* !/*/ These patterns include every file in the root directory, but no directories. This allows a repo to include files like a README or a bootstrapping script to grow enlistments from that point. During the 'git sparse-checkout init' call, we must first look to see if HEAD is valid, since 'git clone' does not have a valid HEAD at the point where it initializes the sparse-checkout. The following checkout within the clone command will create the HEAD ref and update the working directory correctly. Signed-off-by: Derrick Stolee <dstolee@microsoft.com> Signed-off-by: Junio C Hamano <gitster@pobox.com>
166 lines
3.5 KiB
C
166 lines
3.5 KiB
C
#include "builtin.h"
|
|
#include "config.h"
|
|
#include "dir.h"
|
|
#include "parse-options.h"
|
|
#include "pathspec.h"
|
|
#include "repository.h"
|
|
#include "run-command.h"
|
|
#include "strbuf.h"
|
|
|
|
static char const * const builtin_sparse_checkout_usage[] = {
|
|
N_("git sparse-checkout (init|list)"),
|
|
NULL
|
|
};
|
|
|
|
static char *get_sparse_checkout_filename(void)
|
|
{
|
|
return git_pathdup("info/sparse-checkout");
|
|
}
|
|
|
|
static void write_patterns_to_file(FILE *fp, struct pattern_list *pl)
|
|
{
|
|
int i;
|
|
|
|
for (i = 0; i < pl->nr; i++) {
|
|
struct path_pattern *p = pl->patterns[i];
|
|
|
|
if (p->flags & PATTERN_FLAG_NEGATIVE)
|
|
fprintf(fp, "!");
|
|
|
|
fprintf(fp, "%s", p->pattern);
|
|
|
|
if (p->flags & PATTERN_FLAG_MUSTBEDIR)
|
|
fprintf(fp, "/");
|
|
|
|
fprintf(fp, "\n");
|
|
}
|
|
}
|
|
|
|
static int sparse_checkout_list(int argc, const char **argv)
|
|
{
|
|
struct pattern_list pl;
|
|
char *sparse_filename;
|
|
int res;
|
|
|
|
memset(&pl, 0, sizeof(pl));
|
|
|
|
sparse_filename = get_sparse_checkout_filename();
|
|
res = add_patterns_from_file_to_list(sparse_filename, "", 0, &pl, NULL);
|
|
free(sparse_filename);
|
|
|
|
if (res < 0) {
|
|
warning(_("this worktree is not sparse (sparse-checkout file may not exist)"));
|
|
return 0;
|
|
}
|
|
|
|
write_patterns_to_file(stdout, &pl);
|
|
clear_pattern_list(&pl);
|
|
|
|
return 0;
|
|
}
|
|
|
|
static int update_working_directory(void)
|
|
{
|
|
struct argv_array argv = ARGV_ARRAY_INIT;
|
|
int result = 0;
|
|
argv_array_pushl(&argv, "read-tree", "-m", "-u", "HEAD", NULL);
|
|
|
|
if (run_command_v_opt(argv.argv, RUN_GIT_CMD)) {
|
|
error(_("failed to update index with new sparse-checkout paths"));
|
|
result = 1;
|
|
}
|
|
|
|
argv_array_clear(&argv);
|
|
return result;
|
|
}
|
|
|
|
enum sparse_checkout_mode {
|
|
MODE_NO_PATTERNS = 0,
|
|
MODE_ALL_PATTERNS = 1,
|
|
};
|
|
|
|
static int set_config(enum sparse_checkout_mode mode)
|
|
{
|
|
const char *config_path;
|
|
|
|
if (git_config_set_gently("extensions.worktreeConfig", "true")) {
|
|
error(_("failed to set extensions.worktreeConfig setting"));
|
|
return 1;
|
|
}
|
|
|
|
config_path = git_path("config.worktree");
|
|
git_config_set_in_file_gently(config_path,
|
|
"core.sparseCheckout",
|
|
mode ? "true" : NULL);
|
|
|
|
return 0;
|
|
}
|
|
|
|
static int sparse_checkout_init(int argc, const char **argv)
|
|
{
|
|
struct pattern_list pl;
|
|
char *sparse_filename;
|
|
FILE *fp;
|
|
int res;
|
|
struct object_id oid;
|
|
|
|
if (set_config(MODE_ALL_PATTERNS))
|
|
return 1;
|
|
|
|
memset(&pl, 0, sizeof(pl));
|
|
|
|
sparse_filename = get_sparse_checkout_filename();
|
|
res = add_patterns_from_file_to_list(sparse_filename, "", 0, &pl, NULL);
|
|
|
|
/* If we already have a sparse-checkout file, use it. */
|
|
if (res >= 0) {
|
|
free(sparse_filename);
|
|
goto reset_dir;
|
|
}
|
|
|
|
/* initial mode: all blobs at root */
|
|
fp = xfopen(sparse_filename, "w");
|
|
if (!fp)
|
|
die(_("failed to open '%s'"), sparse_filename);
|
|
|
|
free(sparse_filename);
|
|
fprintf(fp, "/*\n!/*/\n");
|
|
fclose(fp);
|
|
|
|
if (get_oid("HEAD", &oid)) {
|
|
/* assume we are in a fresh repo */
|
|
return 0;
|
|
}
|
|
|
|
reset_dir:
|
|
return update_working_directory();
|
|
}
|
|
|
|
int cmd_sparse_checkout(int argc, const char **argv, const char *prefix)
|
|
{
|
|
static struct option builtin_sparse_checkout_options[] = {
|
|
OPT_END(),
|
|
};
|
|
|
|
if (argc == 2 && !strcmp(argv[1], "-h"))
|
|
usage_with_options(builtin_sparse_checkout_usage,
|
|
builtin_sparse_checkout_options);
|
|
|
|
argc = parse_options(argc, argv, prefix,
|
|
builtin_sparse_checkout_options,
|
|
builtin_sparse_checkout_usage,
|
|
PARSE_OPT_STOP_AT_NON_OPTION);
|
|
|
|
git_config(git_default_config, NULL);
|
|
|
|
if (argc > 0) {
|
|
if (!strcmp(argv[0], "list"))
|
|
return sparse_checkout_list(argc, argv);
|
|
if (!strcmp(argv[0], "init"))
|
|
return sparse_checkout_init(argc, argv);
|
|
}
|
|
|
|
usage_with_options(builtin_sparse_checkout_usage,
|
|
builtin_sparse_checkout_options);
|
|
}
|