summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorbrian m. carlson <sandals@crustytoothpaste.net>2021-01-23 20:30:44 +0000
committerbrian m. carlson <sandals@crustytoothpaste.net>2021-02-27 18:23:40 +0000
commit7652da8fdb82eb4cde2375a85ebd70bcc47de5f8 (patch)
tree91c1861fee8296c9d2a9c952fe162a559d00264c
parent988ac0a33f42c91d6f35aaa8a95a95acdad63364 (diff)
docs: note that archives are not stabledocs-updates
We have in the past told users on the list that git archive does not necessarily produce stable archives, but we've never explicitly documented this. Unfortunately, we've had people in the past who have relied on the relative stability of our archives to their detriment and then had breakage occur. Let's tell people that we don't guarantee stable archives so that they can make good choices about how they structure their tooling and don't end up with problems if we need to change archives later. Signed-off-by: brian m. carlson <sandals@crustytoothpaste.net>
-rw-r--r--Documentation/git-archive.txt3
1 files changed, 3 insertions, 0 deletions
diff --git a/Documentation/git-archive.txt b/Documentation/git-archive.txt
index 9f8172828d..1f126cbdcc 100644
--- a/Documentation/git-archive.txt
+++ b/Documentation/git-archive.txt
@@ -30,6 +30,9 @@ extended pax header if the tar format is used; it can be extracted
using 'git get-tar-commit-id'. In ZIP files it is stored as a file
comment.
+The output of 'git archive' is not guaranteed to be stable and may change
+between versions.
+
OPTIONS
-------