From: "Ævar Arnfjörð Bjarmason" <avarab@gmail.com>
To: "brian m. carlson" <sandals@crustytoothpaste.net>
Cc: git@vger.kernel.org, Emily Shaffer <emilyshaffer@google.com>,
Johannes Schindelin <Johannes.Schindelin@gmx.de>,
Konstantin Ryabitsev <konstantin@linuxfoundation.org>,
Jason Pyeron <jpyeron@pdinc.us>
Subject: Re: [PATCH 4/4] docs: note that archives are not stable
Date: Sun, 28 Feb 2021 13:48:56 +0100 [thread overview]
Message-ID: <87h7lwl5mv.fsf@evledraar.gmail.com> (raw)
In-Reply-To: <20210227191813.96148-5-sandals@crustytoothpaste.net>
On Sat, Feb 27 2021, brian m. carlson wrote:
> 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.
Is "stable archive" a well-known term people would understand, or is
someone going to read this thinking they might extract different content
today than tomorrow ? :) I wonder how much if anything this means to
someone not privy to the recent thread[1] that prompted this patch.
Perhaps something like this instead:
The output of 'git archive' is guaranteed to be the same across
versions of git, but the archive itself is not guaranteed to be
bit-for-bit identical.
In practice the output of 'git archive' is relatively stable across
git versions, but has changed in the past, and most likely will in
the future.
Since the tar format provides multiple ways to encode the same
output (ordering, headers, padding etc.) you should not rely on
output being bit-for-bit identical across versions of git for
e.g. GPG signing a SHA-256 hash of an archive generated with one
version of git, and then expecting to be able to validate that GPG
signature with a freshly generated archive made with same arguments
on another version of git.
1. https://lore.kernel.org/git/20210122213954.7dlnnpngjoay3oia@chatter.i7.local/
next prev parent reply other threads:[~2021-02-28 12:50 UTC|newest]
Thread overview: 16+ messages / expand[flat|nested] mbox.gz Atom feed top
2021-02-27 19:18 [PATCH 0/4] Documentation updates to FAQ and git-archive brian m. carlson
2021-02-27 19:18 ` [PATCH 1/4] docs: add a question on syncing repositories to the FAQ brian m. carlson
2021-02-28 13:01 ` Ævar Arnfjörð Bjarmason
2021-03-15 20:40 ` brian m. carlson
2021-02-27 19:18 ` [PATCH 2/4] docs: add line ending configuration article to FAQ brian m. carlson
2021-02-27 19:18 ` [PATCH 3/4] docs: add a FAQ section on push and fetch problems brian m. carlson
2021-02-28 12:37 ` Ævar Arnfjörð Bjarmason
2021-02-28 18:07 ` brian m. carlson
2021-03-01 18:02 ` Junio C Hamano
2021-02-27 19:18 ` [PATCH 4/4] docs: note that archives are not stable brian m. carlson
2021-02-28 12:48 ` Ævar Arnfjörð Bjarmason [this message]
2021-02-28 18:19 ` brian m. carlson
2021-02-28 18:46 ` Ævar Arnfjörð Bjarmason
2021-03-01 18:15 ` Junio C Hamano
2021-03-03 0:36 ` brian m. carlson
2021-03-03 6:55 ` Junio C Hamano
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
List information: http://vger.kernel.org/majordomo-info.html
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=87h7lwl5mv.fsf@evledraar.gmail.com \
--to=avarab@gmail.com \
--cc=Johannes.Schindelin@gmx.de \
--cc=emilyshaffer@google.com \
--cc=git@vger.kernel.org \
--cc=jpyeron@pdinc.us \
--cc=konstantin@linuxfoundation.org \
--cc=sandals@crustytoothpaste.net \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
Code repositories for project(s) associated with this public inbox
https://80x24.org/mirrors/git.git
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for read-only IMAP folder(s) and NNTP newsgroup(s).