[PATCH 4/4] docs: note that archives are not stable

From: brian m. carlson <sandals@crustytoothpaste.net>
Date: Feb 27, 2021, 19:18 UTC
Message-ID: <20210227191813.96148-5-sandals@crustytoothpaste.net>
In-Reply-To: <20210227191813.96148-1-sandals@crustytoothpaste.net>

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>
---
 Documentation/git-archive.txt | 3 +++
 1 file changed, 3 insertions(+)

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
 -------