Re: [PATCH 3/3] hash-object doc: point to ls-files and rev-parse
- Date: Wed, 22 May 2019 01:15:23 -0400
- From: Jeff King <peff@xxxxxxxx>
- Subject: Re: [PATCH 3/3] hash-object doc: point to ls-files and rev-parse
On Mon, May 20, 2019 at 11:53:12PM +0200, Ævar Arnfjörð Bjarmason wrote:
> Amend the intro to note that it's better to ask the index about files
> already tracked by it.
> I've seen uses of this in the wild where the use-case was finding
> object IDs for files found in a freshly cloned repo, i.e. something
> like "git ls-files | git hash-object --stdin-paths".
This example left me scratching my head, because it seems like such a
bad way to accomplish the goal that I had trouble figuring out what the
goal was in the first place.
Of course I am pretty familiar with Git, so my mindset is not
necessarily the same as the average reader of the manpage. But the
suggested documentation really seems to me to be warning about a
convoluted use case that most people would not come up with in the first
And adding it in the introductory text means that people are more likely
to read and be confused by it, when they are really just looking to find
details on more mundane usage.
Or put another way: I could come up with a hundred bad ways to script
Git, but we are probably better off enumerating the _good_ ways to do
so, rather than listing the bad ways and leaving the user to figure out
So I'm mildly negative on this patch.