aboutsummaryrefslogtreecommitdiffstats
path: root/Documentation/ref-storage-format.txt
diff options
context:
space:
mode:
authorPatrick Steinhardt <ps@pks.im>2023-12-29 08:26:47 +0100
committerJunio C Hamano <gitster@pobox.com>2024-01-02 09:24:48 -0800
commitd7497a42b05bb810afeb6acc8c9447b77b1f075d (patch)
treed85a5958ddbb8ca218831a6a8af38e347343fbfd /Documentation/ref-storage-format.txt
parent58be32fff9d191ef8312a2c2c2f9deaf5d221c69 (diff)
downloadgit-d7497a42b05bb810afeb6acc8c9447b77b1f075d.tar.gz
setup: introduce "extensions.refStorage" extension
Introduce a new "extensions.refStorage" extension that allows us to specify the ref storage format used by a repository. For now, the only supported format is the "files" format, but this list will likely soon be extended to also support the upcoming "reftable" format. There have been discussions on the Git mailing list in the past around how exactly this extension should look like. One alternative [1] that was discussed was whether it would make sense to model the extension in such a way that backends are arbitrarily stackable. This would allow for a combined value of e.g. "loose,packed-refs" or "loose,reftable", which indicates that new refs would be written via "loose" files backend and compressed into "packed-refs" or "reftable" backends, respectively. It is arguable though whether this flexibility and the complexity that it brings with it is really required for now. It is not foreseeable that there will be a proliferation of backends in the near-term future, and the current set of existing formats and formats which are on the horizon can easily be configured with the much simpler proposal where we have a single value, only. Furthermore, if we ever see that we indeed want to gain the ability to arbitrarily stack the ref formats, then we can adapt the current extension rather easily. Given that Git clients will refuse any unknown value for the "extensions.refStorage" extension they would also know to ignore a stacked "loose,packed-refs" in the future. So let's stick with the easy proposal for the time being and wire up the extension. [1]: <pull.1408.git.1667846164.gitgitgadget@gmail.com> Signed-off-by: Patrick Steinhardt <ps@pks.im> Signed-off-by: Junio C Hamano <gitster@pobox.com>
Diffstat (limited to 'Documentation/ref-storage-format.txt')
-rw-r--r--Documentation/ref-storage-format.txt1
1 files changed, 1 insertions, 0 deletions
diff --git a/Documentation/ref-storage-format.txt b/Documentation/ref-storage-format.txt
new file mode 100644
index 0000000000..1a65cac468
--- /dev/null
+++ b/Documentation/ref-storage-format.txt
@@ -0,0 +1 @@
+* `files` for loose files with packed-refs. This is the default.