aboutsummaryrefslogtreecommitdiff
path: root/Documentation
diff options
context:
space:
mode:
authorJeff King <peff@peff.net>2015-06-23 06:54:11 -0400
committerJunio C Hamano <gitster@pobox.com>2015-06-24 17:09:35 -0700
commit067fbd4105c5aa8260a73cc6961854be0e93fa03 (patch)
tree302bb72cb8414580c24bd4d896bc4879e31b8a66 /Documentation
parent00a09d57eb8a041e6a6b0470c53533719c049bab (diff)
downloadgit-067fbd4105c5aa8260a73cc6961854be0e93fa03.tar.gz
git-067fbd4105c5aa8260a73cc6961854be0e93fa03.tar.xz
introduce "preciousObjects" repository extension
If this extension is used in a repository, then no operations should run which may drop objects from the object storage. This can be useful if you are sharing that storage with other repositories whose refs you cannot see. For instance, if you do: $ git clone -s parent child $ git -C parent config extensions.preciousObjects true $ git -C parent config core.repositoryformatversion 1 you now have additional safety when running git in the parent repository. Prunes and repacks will bail with an error, and `git gc` will skip those operations (it will continue to pack refs and do other non-object operations). Older versions of git, when run in the repository, will fail on every operation. Note that we do not set the preciousObjects extension by default when doing a "clone -s", as doing so breaks backwards compatibility. It is a decision the user should make explicitly. Signed-off-by: Jeff King <peff@peff.net> Signed-off-by: Junio C Hamano <gitster@pobox.com>
Diffstat (limited to 'Documentation')
-rw-r--r--Documentation/technical/repository-version.txt7
1 files changed, 7 insertions, 0 deletions
diff --git a/Documentation/technical/repository-version.txt b/Documentation/technical/repository-version.txt
index 3d7106d93..00ad37986 100644
--- a/Documentation/technical/repository-version.txt
+++ b/Documentation/technical/repository-version.txt
@@ -79,3 +79,10 @@ The defined extensions are:
This extension does not change git's behavior at all. It is useful only
for testing format-1 compatibility.
+
+`preciousObjects`
+~~~~~~~~~~~~~~~~~
+
+When the config key `extensions.preciousObjects` is set to `true`,
+objects in the repository MUST NOT be deleted (e.g., by `git-prune` or
+`git repack -d`).