From: Adrian Ratiu <adrian.ratiu@collabora.com>
To: Patrick Steinhardt <ps@pks.im>
Cc: git@vger.kernel.org, Junio C Hamano <gitster@pobox.com>,
"brian m . carlson" <sandals@crustytoothpaste.net>,
"Eric W . Biederman" <ebiederm@xmission.com>,
Axel Rasmussen <axelrasmussen@google.com>,
Emily Shaffer <emilyshaffer@google.com>,
Josh Steadmon <steadmon@google.com>
Subject: Re: [PATCH 3/3] object-file-convert: copy unknown commit headers unchanged
Date: Tue, 17 Nov 2026 17:27:42 +0200 [thread overview]
Message-ID: <87cxs3jx5d.fsf@collabora.com> (raw)
In-Reply-To: <avqypRLPLZZFNqRs@pks.im>
On Mon, 16 Nov 2026, Patrick Steinhardt <ps@pks.im> wrote:
> On Thu, Nov 12, 2026 at 09:57:40PM +0200, Adrian Ratiu wrote:
>> In a repo with extensions.compatObjectFormat, Git converts commits
>> to the compat format in two places which disagree about headers they
>> don't know:
>>
>> 1. When a commit is created with commit_tree_extended(), as
>> "git commit" does, convert_commit_extra_headers() copies unknown
>> headers unchanged.
>>
>> 2. When an existing commit object is converted (git hash-object -w)
>> or when it's read by its compat id, convert_commit_object() fails
>> on them instead.
>>
>> So git hash-object refuses such a commit, while git commit --amend
>
> s/git hash-object/git-hash-object(1)/
>
>> records a compat id for it that can't be read back:
>
> s/compat id/compat ID/
>
>> "Failed to convert object from sha256 to sha1".
>>
>> The rejection was added in 08a45903cb (object-file-convert: convert
>> commits that embed signed tags, 2023-10-01). Git can't know what an
>> unknown header holds. It might hold an object id that needs
>
> s/object id/object ID/
>
Ack on these and all the other ID / spacing fixes, will do them in v2.
>> converting, so convert_commit_object() rejects all of them.
>>
>> Some tools rely on such headers though. Jujutsu, for example, writes
>> a "change-id" header in every commit, so none of its commits can be
>> converted.
>>
>> Make convert_commit_object() copy unknown headers and their
>> continuation lines unchanged, just like convert_commit_extra_headers()
>> so both give the same compat object.
>>
>> The author, committer, encoding and gpgsig headers were already copied
>> the same, so their separate cases are no longer needed.
>>
>> A "tree", "parent" or "mergetag" line with nothing after the keyword
>> used to be rejected as unknown and is now copied as well. Such a
>> commit is malformed in both formats anyway.
>
> Hmm. I guess this here might raise some eyebrows. I guess it makes the
> code simpler, but I wonder what the benefit is of converting an object
> that is so obviously corrupt...
>
> ... yeah, after reading the code we'd have to introduce a bunch of extra
> logic to make this work as expected. As far as I can see though we _do_
> reject "tree " without trailing data, but we wouldn't reject "tree"
> without the trailing space.
I looked closer and v1 actually copies "tree " too, because of the
(bufptr + 5) < eol check, "tree \n" never reaches the tree branch. :)
I also found I made mergetag worse: a "mergetag " line with an empty
first line and the tag in continuation lines is also copied, so its
embedded object ID ends up unconverted in the compat object.
Git still treats that header as a mergetag ("git show" reports
"malformed mergetag") and "git commit --amend" refuses to convert it, so
v1 makes the two paths disagree again, just in the other direction.
I can fix this in v2 by changing the three checks to <=, so the
converter classifies headers same as read_commit_extra_header_lines(),
by the key before the first space.
So:
"tree ", "parent " and "mergetag " with an empty or bad value are
rejected, as before this series.
"tree", "parent" and "mergetag" without a space are not those headers as
far as Git is concerned, so they are copied like any unknown
header. That is also what --amend does with them.
I'll also add a test for the empty mergetag case.
>
> We could fix that by introducing a generic format check:
>
> - The line must have at least a single space separating key and value
> of the header.
>
> - The key must only contain characters of a specific set.
>
> Otherwise we might be too lenient and also accept data that doesn't even
> look close to an object header.
>
> But whether that's all worth it is a different question, as said. It's a
> corrupt commit anyway, and we cannot address the root cause of that
> corruption here anyway.
With the above I don't think we need it. A check only in the converter
would reject headers that read_commit_extra_header_lines() accepts and
"git commit --amend" keeps (e.g. bare "x-foo" line), so amend would
again record compat IDs that can't be read back.
If we need such rules, I think fsck is the better place (today it
doesn't look at any header after "committer"). It's a separate topic
though.
>> Alternatives considered:
>>
>> - Reject unknown headers in convert_commit_extra_headers() too.
>> Both paths would then agree, but commits from tools that add
>> their own headers could not be used in a compat repo.
>
> Yeah, that's certainly a direction we shouldn't go. There's way too many
> tools nowadays with widespread usage that write such unknown headers.
>
>> - Copy only headers known to hold no object ids. Every tool would
>> first need to get its headers added to that list.
>
> Agreed, that doesn't seem sensible, either. We don't want to be the
> gatekeeper of who is or who isn't allowed to have their own custom
> header.
>
> A third alternative could have been to try and recognize commit IDs
> automatically. E.g. if you see a 40-character hex string then we treat
> it as a commit ID. But I don't think that's sensible, either, as we
> shouldn't interpret what we don't know.
Agreed, unknown unknowns are such a pain.
>
> A bit of a side note, but I have been wondering multiple times already
> whether we should fix this gap by introducing a well-known object header
> prefix that tells us that the value of that header is indeed an object
> ID, for example something like "x-obj-foobar <oid>". That would make our
> commit graph extensible by third-party-tools without us having to
> understand what that tool even intends to do with that, and we would
> know to treat such object IDs as reachable.
>
> But that's of course a topic that is well outside the scope of this
> patch series.
Yes, I'm trying to keep this series small and just address the immediate
bugs / breakages, to avoid it balooning into 10+ patch series again. :)
prev parent reply other threads:[~2026-11-17 15:28 UTC|newest]
Thread overview: 10+ messages / expand[flat|nested] mbox.gz Atom feed top
2026-11-12 19:57 [PATCH 0/3] compatObjectFormat: fix a BUG(), wrong id and unknown headers Adrian Ratiu
2026-11-12 19:57 ` [PATCH 1/3] setup: reject compatObjectFormat == objectFormat Adrian Ratiu
2026-11-16 7:36 ` Patrick Steinhardt
2026-11-17 10:42 ` Adrian Ratiu
2026-11-12 19:57 ` [PATCH 2/3] rev-parse: die when --output-object-format cannot map an object Adrian Ratiu
2026-11-16 7:37 ` Patrick Steinhardt
2026-11-17 11:55 ` Adrian Ratiu
2026-11-12 19:57 ` [PATCH 3/3] object-file-convert: copy unknown commit headers unchanged Adrian Ratiu
2026-11-16 7:37 ` Patrick Steinhardt
2026-11-17 15:27 ` Adrian Ratiu [this message]
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
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=87cxs3jx5d.fsf@collabora.com \
--to=adrian.ratiu@collabora.com \
--cc=axelrasmussen@google.com \
--cc=ebiederm@xmission.com \
--cc=emilyshaffer@google.com \
--cc=git@vger.kernel.org \
--cc=gitster@pobox.com \
--cc=ps@pks.im \
--cc=sandals@crustytoothpaste.net \
--cc=steadmon@google.com \
/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.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox