git/list[1] front-page[2] threads[3] people[4] search[5] about
 

[PATCH v7 24/33] init: allow alternate ref strorage to be set for new repos

From
David Turner <dturner@twopensource.com>
Date
Mar 1, 2016, 00:52 UTC
Message-ID
<1456793586-22082-25-git-send-email-dturner@twopensource.com>
In-Reply-To
<1456793586-22082-1-git-send-email-dturner@twopensource.com>

git init learns a new argument --ref-storage. Presently, only "files" is supported, but later we will add other storage backends.

When this argument is used, the repository's extensions.refStorage configuration value is set (as well as core.repositoryformatversion), and the ref storage backend's initdb function is used to set up the ref database.

Signed-off-by: David Turner <dturner@twopensource.com>
Signed-off-by: SZEDER Gábor <szeder@ira.uka.de>
Signed-off-by: Junio C Hamano <gitster@pobox.com>
---
 Documentation/git-init-db.txt          |  2 +-
 Documentation/git-init.txt             |  7 +++++-
 builtin/init-db.c                      | 44 +++++++++++++++++++++++++++-------
 cache.h                                |  2 ++
 contrib/completion/git-completion.bash |  3 ++-
 path.c                                 | 29 ++++++++++++++++++++--
 refs.c                                 |  2 ++
 refs.h                                 |  5 ++++
 setup.c                                | 12 ++++++++++
 t/t0001-init.sh                        | 25 +++++++++++++++++++
 10 files changed, 118 insertions(+), 13 deletions(-)
diff --git a/Documentation/git-init-db.txt b/Documentation/git-init-db.txt
index 648a6cd..d03fb69 100644
--- a/Documentation/git-init-db.txt
+++ b/Documentation/git-init-db.txt
@@ -9,7 +9,7 @@ git-init-db - Creates an empty Git repository
 SYNOPSIS
 --------
 [verse]
-'git init-db' [-q | --quiet] [--bare] [--template=<template_directory>] [--separate-git-dir <git dir>] [--shared[=<permissions>]]
+'git init-db' [-q | --quiet] [--bare] [--template=<template_directory>] [--separate-git-dir <git dir>] [--shared[=<permissions>]] [--ref-storage=<name>]
 
 
 DESCRIPTION
diff --git a/Documentation/git-init.txt b/Documentation/git-init.txt
index 8174d27..93f8d0c 100644
--- a/Documentation/git-init.txt
+++ b/Documentation/git-init.txt
@@ -12,7 +12,7 @@ SYNOPSIS
 'git init' [-q | --quiet] [--bare] [--template=<template_directory>]
 	  [--separate-git-dir <git dir>]
 	  [--shared[=<permissions>]] [directory]
-
+	  [--ref-storage=<name>]
 
 DESCRIPTION
 -----------
@@ -113,6 +113,11 @@ does not exist, it will be created.
 
 --
 
+--ref-storage=<name>::
+Type of refs storage backend. Default is to use the original "files"
+storage, which stores ref data in files in `$GIT_DIR/refs` and
+`$GIT_DIR/packed-refs`.
+
 TEMPLATE DIRECTORY
 ------------------
 
diff --git a/builtin/init-db.c b/builtin/init-db.c
index e6d4e86..af7fe04 100644
--- a/builtin/init-db.c
+++ b/builtin/init-db.c
@@ -23,6 +23,7 @@ static int init_is_bare_repository = 0;
 static int init_shared_repository = -1;
 static const char *init_db_template_dir;
 static const char *git_link;
+static char *requested_ref_storage_backend;
 
 static void copy_templates_1(struct strbuf *path, struct strbuf *template,
 			     DIR *dir)
@@ -178,6 +179,7 @@ static int create_default_files(const char *template_path)
 	int reinit;
 	int filemode;
 	struct strbuf err = STRBUF_INIT;
+	int repo_version = 0;
 
 	/* Just look for `init.templatedir` */
 	git_config(git_init_db_config, NULL);
@@ -204,6 +206,32 @@ static int create_default_files(const char *template_path)
 	}
 
 	/*
+	 * Create the default symref from ".git/HEAD" to the "master"
+	 * branch, if it does not exist yet.
+	 */
+	path = git_path_buf(&buf, "HEAD");
+	reinit = (!access(path, R_OK)
+		  || readlink(path, junk, sizeof(junk)-1) != -1);
+	if (reinit) {
+		if (requested_ref_storage_backend &&
+		    strcmp(ref_storage_backend, requested_ref_storage_backend))
+			die(_("You can't change the refs storage type (was %s; you requested %s)"),
+			      ref_storage_backend,
+			      requested_ref_storage_backend);
+	}
+
+	if (requested_ref_storage_backend)
+		ref_storage_backend = requested_ref_storage_backend;
+	if (strcmp(ref_storage_backend, "files")) {
+		git_config_set("extensions.refStorage", ref_storage_backend);
+		git_config_set("core.repositoryformatversion", ref_storage_backend);
+		if (set_ref_storage_backend(ref_storage_backend))
+			die(_("Unknown ref storage backend %s"),
+			    ref_storage_backend);
+		repo_version = 1;
+	}
+
+	/*
 	 * We need to create a "refs" dir in any case so that older
 	 * versions of git can tell that this is a repository.
 	 */
@@ -212,13 +240,6 @@ static int create_default_files(const char *template_path)
 	if (refs_init_db(shared_repository, &err))
 		die("failed to set up refs db: %s", err.buf);
 
-	/*
-	 * Create the default symlink from ".git/HEAD" to the "master"
-	 * branch, if it does not exist yet.
-	 */
-	path = git_path_buf(&buf, "HEAD");
-	reinit = (!access(path, R_OK)
-		  || readlink(path, junk, sizeof(junk)-1) != -1);
 	if (!reinit) {
 		if (create_symref("HEAD", "refs/heads/master", NULL) < 0)
 			exit(1);
@@ -226,7 +247,7 @@ static int create_default_files(const char *template_path)
 
 	/* This forces creation of new config file */
 	xsnprintf(repo_version_string, sizeof(repo_version_string),
-		  "%d", GIT_REPO_VERSION);
+		  "%d", repo_version);
 	git_config_set("core.repositoryformatversion", repo_version_string);
 
 	/* Check filemode trustability */
@@ -474,11 +495,18 @@ int cmd_init_db(int argc, const char **argv, const char *prefix)
 		OPT_BIT('q', "quiet", &flags, N_("be quiet"), INIT_DB_QUIET),
 		OPT_STRING(0, "separate-git-dir", &real_git_dir, N_("gitdir"),
 			   N_("separate git dir from working tree")),
+		OPT_STRING(0, "ref-storage", &requested_ref_storage_backend,
+			   N_("name"), N_("name of backend type to use")),
 		OPT_END()
 	};
 
 	argc = parse_options(argc, argv, prefix, init_db_options, init_db_usage, 0);
 
+	if (requested_ref_storage_backend &&
+	    !ref_storage_backend_exists(requested_ref_storage_backend))
+		die(_("Unknown ref storage backend %s"),
+		    requested_ref_storage_backend);
+
 	if (real_git_dir && !is_absolute_path(real_git_dir))
 		real_git_dir = xstrdup(real_path(real_git_dir));
 
diff --git a/cache.h b/cache.h
index 7ceb760..3979a70 100644
--- a/cache.h
+++ b/cache.h
@@ -736,6 +736,8 @@ extern enum object_creation_mode object_creation_mode;
 
 extern char *notes_ref_name;
 
+extern const char *ref_storage_backend;
+
 extern int grafts_replace_parents;
 
 /*
diff --git a/contrib/completion/git-completion.bash b/contrib/completion/git-completion.bash
index e3918c8..850afd0 100644
--- a/contrib/completion/git-completion.bash
+++ b/contrib/completion/git-completion.bash
@@ -1362,7 +1362,8 @@ _git_init ()
 		return
 		;;
 	--*)
-		__gitcomp "--quiet --bare --template= --shared --shared="
+		__gitcomp "--quiet --bare --template= --shared --shared=
+			--ref-storage="
 		return
 		;;
 	esac
diff --git a/path.c b/path.c
index 8b7e168..2e67a2b 100644
--- a/path.c
+++ b/path.c
@@ -2,6 +2,7 @@
  * Utilities for paths and pathnames
  */
 #include "cache.h"
+#include "refs.h"
 #include "strbuf.h"
 #include "string-list.h"
 #include "dir.h"
@@ -511,8 +512,32 @@ int validate_headref(const char *path)
 	int fd;
 	ssize_t len;
 
-	if (lstat(path, &st) < 0)
-		return -1;
+	if (lstat(path, &st) < 0) {
+		int backend_type_set;
+		struct strbuf config_path = STRBUF_INIT;
+		char *pathdup = xstrdup(path);
+		char *git_dir = dirname(pathdup);
+		char *storage = NULL;
+
+		strbuf_addf(&config_path, "%s/%s", git_dir, "config");
+		free(pathdup);
+
+		if (git_config_from_file(ref_storage_backend_config,
+					 config_path.buf, &storage)) {
+			strbuf_release(&config_path);
+			return -1;
+		}
+
+		backend_type_set = !!storage;
+		free((void *)storage);
+		strbuf_release(&config_path);
+		/*
+		 * Alternate backends are assumed to keep HEAD
+		 * in a valid state, so there's no need to do
+		 * further validation.
+		 */
+		return backend_type_set ? 0 : -1;
+	}
 
 	/* Make sure it is a "refs/.." symlink */
 	if (S_ISLNK(st.st_mode)) {
diff --git a/refs.c b/refs.c
index 6c05881..a18cb4d 100644
--- a/refs.c
+++ b/refs.c
@@ -23,6 +23,8 @@ static struct ref_storage_be *the_refs_backend = &refs_be_files;
  */
 static struct ref_storage_be *refs_backends = &refs_be_files;
 
+const char *ref_storage_backend = "files";
+
 static struct ref_storage_be *find_ref_storage_backend(const char *name)
 {
 	struct ref_storage_be *be;
diff --git a/refs.h b/refs.h
index 13ce2a0..09486b2 100644
--- a/refs.h
+++ b/refs.h
@@ -512,6 +512,11 @@ extern int reflog_expire(const char *refname, const unsigned char *sha1,
 			 void *policy_cb_data);
 
 /*
+ * Read the refdb storage backend name out of the config file
+ */
+int ref_storage_backend_config(const char *var, const char *value, void *ptr);
+
+/*
  * Switch to an alternate ref storage backend.
  */
 int set_ref_storage_backend(const char *name);
diff --git a/setup.c b/setup.c
index de1a2a7..bd3a2cf 100644
--- a/setup.c
+++ b/setup.c
@@ -1,5 +1,6 @@
 #include "cache.h"
 #include "dir.h"
+#include "refs.h"
 #include "string-list.h"
 
 static int inside_git_dir = -1;
@@ -261,6 +262,15 @@ int get_common_dir_noenv(struct strbuf *sb, const char *gitdir)
 	return ret;
 }
 
+int ref_storage_backend_config(const char *var, const char *value, void *ptr)
+{
+	const char **cdata = ptr;
+
+	if (!strcmp(var, "extensions.refstorage"))
+		return git_config_string(cdata, var, value);
+	return 0;
+}
+
 /*
  * Test if it looks like we're at a git directory.
  * We want to see:
@@ -388,6 +398,8 @@ static int check_repo_format(const char *var, const char *value, void *cb)
 			;
 		else if (!strcmp(ext, "preciousobjects"))
 			repository_format_precious_objects = git_config_bool(var, value);
+		else if (!strcmp(ext, "refstorage"))
+			ref_storage_backend = xstrdup(value);
 		else
 			string_list_append(&unknown_extensions, ext);
 	}
diff --git a/t/t0001-init.sh b/t/t0001-init.sh
index 295aa59..31c8279 100755
--- a/t/t0001-init.sh
+++ b/t/t0001-init.sh
@@ -174,6 +174,31 @@ test_expect_success 'reinit' '
 	test_i18ncmp again/empty again/err2
 '
 
+test_expect_success 'init with bogus storage backend fails' '
+
+	(
+		mkdir again2 &&
+		cd again2 &&
+		test_must_fail git init --ref-storage=test >out2 2>err2 &&
+		test_i18ngrep "Unknown ref storage backend test" err2
+	)
+'
+
+test_expect_failure 'reinit with changed storage backend fails' '
+
+	(
+		mkdir again3 &&
+		cd again3 &&
+		git init >out1 2>err1 &&
+		git init --ref-storage=test >out2 2>err2
+	) &&
+	test_i18ngrep "Initialized empty" again3/out1 &&
+	test_i18ngrep "Reinitialized existing" again3/out2 &&
+	>again3/empty &&
+	test_i18ncmp again3/empty again3/err1 &&
+	test_i18ncmp again3/empty again3/err2
+'
+
 test_expect_success 'init with --template' '
 	mkdir template-source &&
 	echo content >template-source/file &&

-- 
2.4.2.767.g62658d5-twtrsrc
Previous: David TurnerNext: David Turner
Message 39 of 57 in “refs backend”
  1. 00/33 refs backendDavid Turner, Mar 1, 2016
  2. 01/33 setup: call setup_git_directory_gently before accessing refsDavid Turner, Mar 1, 2016
  3. Jeff KingMar 1, 2016
  4. David TurnerMar 1, 2016
  5. David TurnerMar 2, 2016
  6. Jeff KingMar 2, 2016
  7. 02/33 refs: move head_ref{,_submodule} to the common codeDavid Turner, Mar 1, 2016
  8. 03/33 refs: move for_each_*ref* functions into common codeDavid Turner, Mar 1, 2016
  9. 04/33 files-backend: break out ref readingDavid Turner, Mar 1, 2016
  10. Michael HaggertyMar 20, 2016
  11. Michael HaggertyMar 22, 2016
  12. Michael HaggertyMar 23, 2016
  13. 05/33 refs: move resolve_ref_unsafe into common codeDavid Turner, Mar 1, 2016
  14. 06/33 refs: add a backend method structure with transaction functionsDavid Turner, Mar 1, 2016
  15. 07/33 refs: add methods for misc ref operationsDavid Turner, Mar 1, 2016
  16. 08/33 refs: add method for do_for_each_refDavid Turner, Mar 1, 2016
  17. 09/33 refs: reduce the visibility of do_for_each_ref()David Turner, Mar 1, 2016
  18. Michael HaggertyMar 24, 2016
  19. David TurnerMar 24, 2016
  20. 10/33 refs: add do_for_each_per_worktree_refDavid Turner, Mar 1, 2016
  21. 11/33 refs: add methods for reflogDavid Turner, Mar 1, 2016
  22. 12/33 refs: add method for initial ref transaction commitDavid Turner, Mar 1, 2016
  23. 13/33 refs: add method for delete_refsDavid Turner, Mar 1, 2016
  24. 14/33 refs: add methods to init refs dbDavid Turner, Mar 1, 2016
  25. Michael HaggertyMar 24, 2016
  26. David TurnerMar 24, 2016
  27. 15/33 refs: add method to rename refsDavid Turner, Mar 1, 2016
  28. 16/33 refs: handle non-normal ref renamesDavid Turner, Mar 1, 2016
  29. 17/33 refs: make lock genericDavid Turner, Mar 1, 2016
  30. Michael HaggertyMar 24, 2016
  31. 18/33 refs: move duplicate check to common codeDavid Turner, Mar 1, 2016
  32. 19/33 refs: allow log-only updatesDavid Turner, Mar 1, 2016
  33. Michael HaggertyApr 21, 2016
  34. David TurnerApr 25, 2016
  35. 20/33 refs: don't dereference on renameDavid Turner, Mar 1, 2016
  36. 21/33 refs: on symref reflog expire, lock symref not referrentDavid Turner, Mar 1, 2016
  37. 22/33 refs: resolve symbolic refs firstDavid Turner, Mar 1, 2016
  38. 23/33 refs: always handle non-normal refs in files backendDavid Turner, Mar 1, 2016
  39. 24/33 init: allow alternate ref strorage to be set for new reposDavid Turner, Mar 1, 2016
  40. 25/33 refs: check submodules' ref storage configDavid Turner, Mar 1, 2016
  41. 26/33 clone: allow ref storage backend to be set for cloneDavid Turner, Mar 1, 2016
  42. 27/33 svn: learn ref-storage argumentDavid Turner, Mar 1, 2016
  43. 28/33 refs: register ref storage backendsDavid Turner, Mar 1, 2016
  44. 29/33 setup: configure ref storage on setupDavid Turner, Mar 1, 2016
  45. Jeff KingMar 1, 2016
  46. Jeff KingMar 1, 2016
  47. Ramsay JonesMar 1, 2016
  48. David TurnerMar 1, 2016
  49. 30/33 refs: break out resolve_ref_unsafe_submoduleDavid Turner, Mar 1, 2016
  50. Ramsay JonesMar 1, 2016
  51. David TurnerMar 1, 2016
  52. 31/33 refs: add LMDB refs storage backendDavid Turner, Mar 1, 2016
  53. Duy NguyenMar 1, 2016
  54. David TurnerMar 1, 2016
  55. Duy NguyenMar 1, 2016
  56. 32/33 refs: tests for lmdb backendDavid Turner, Mar 1, 2016
  57. 33/33 tests: add ref-storage argumentDavid Turner, Mar 1, 2016

Read the whole thread, see it on lore, or plain text.

$ cat FOOTERMessages come from the public archive at lore.kernel.org/git, fetched every hour. The front page is chosen and written each morning by an AI editor and can be wrong; the threads themselves are the record. About and API. For agents: an MCP server at https://gitlist.dev/mcp, and any thread, story or person page as Markdown by adding .md to its URL (or sending Accept: text/markdown). Details in /llms.txt.