Re: [PATCH 2/3] [GSOC] ref-filter: support %(contents) for blob, tree

From: Junio C Hamano <gitster@pobox.com>
Date: May 25, 2021, 05:47 UTC
Message-ID: <xmqqa6ojgy9h.fsf@gitster.g>
In-Reply-To: <xmqqfsybh0bn.fsf@gitster.g>

Junio C Hamano <gitster@pobox.com> writes:

Show 6 quoted lines

> As I already said, I do not think %(contents) mixes well with this
> use for trees and blobs where you give the raw bytes, since
> %(contents) for commit and tag objects was never about the full byte
> sequence of the object.  It was to give the unstructured part meant
> for human consumption, stripping the structured "header" part of the
> object.

To extend on this point a bit (even though this is not all that urgent during the prerelease freeze), conceptually, the %(content) field is understood in the larger picture like this:

+--- (the whole thing) ----------------------------------------------+
|                                                                    |
| +--- "header" ---------------------------------------------------+ |
| | tree 678c03dca0a26afd746e8c8bb9e4aadc8bf479b1                  | |
| | parent 378c7c6ad48c4ccddf9b534616a0e86f28440bd3                | |
| | author Junio C Hamano <gitster@pobox.com> 1621675665 +0900     | |
| | committer Junio C Hamano <gitster@pobox.com> 1621675741 +0900  | |
| +----------------------------------------------------------------+ |
|                                                                    |
| +--- "contents" -------------------------------------------------+ |
| |                                                                | |
| | +--- "subject" ----------------------------------------------+ | |
| | | Git 2.32-rc1                                               | | |
| | +------------------------------------------------------------+ | |
| |                                                                | |
| | +--- "body" -------------------------------------------------+ | |
| | | Signed-off-by: Junio C Hamano <gitster@pobox.com>          | | |
| | +------------------------------------------------------------+ | |
| |                                                                | |
| +----------------------------------------------------------------+ |
|                                                                    |
+--------------------------------------------------------------------+

Even though %(header), when it is invented, would make perfect sense for commits and tags, it will never make sense for trees and blobs. Which means "contents", which is "the whole thing except for the header part", would not, either.

There is no %(placeholder) to ask for "the whole thing", and that is what you want to use for cat-file --batch if I am not mistaken, and adding one would be a good idea. There is no %(header) yet, either, but if somebody needs it for their scripts, it is clear where it fits in the picture.