RE: [PATCH] docs: document caveats of rev-list's object-name output

From: Baumann, Moritz <moritz.baumann@sap.com>
Date: Mar 30, 2023, 10:32 UTC
Message-ID: <AS1PR02MB81854CDA4768A8DB3C51FCCA948E9@AS1PR02MB8185.eurprd02.prod.outlook.com>
In-Reply-To: <20230328182650.GC18558@coredump.intra.peff.net>

Show 7 quoted lines

> > > Those names are really just intended as hints for pack-objects. I
> > > suspect the documentation could be more clear about these limitations.
> >
> > That would indeed be great and would have likely prevented the obvious
> > misconceptions on my side.
>
> Here's what I came up with.

Thanks, this is one half of what I would have needed to read.

Show 5 quoted lines

> I also considered adding a specific "if you want the names of each file
> in a range of commits, pipe to diff-tree" example. But it seemed like it
> would clutter up this section. It might be OK as a stand-alone in the
> EXAMPLES section, but should probably be done as a separate patch if
> anyone is interested.

That would be the other half. Since e.g. GitHub's own "best practice" examples do not use this pattern [0], I would assume that I'm not the only one who didn't know about it.

[0] https://github.com/github/platform-samples/blob/master/pre-receive-hooks/block_file_extensions.sh