Re: [PATCH] Documentation/git-ls-tree.txt: Add a caveat about prefixing pathspec

From: Junio C Hamano <gitster@pobox.com>
Date: Jul 22, 2008, 00:32 UTC
Message-ID: <7vd4l6sqqz.fsf@gitster.siamese.dyndns.org>
In-Reply-To: <20080721210452.GP10151@machine.or.cz>

Petr Baudis <pasky@suse.cz> writes:

Show 12 quoted lines

>> 	commit.  E.g.
>> 
>> 		$ cd some/deep/path
>> 		$ git ls-tree --name-only -r HEAD~20
>> 
>> 	will list the files in some/deep/path (i.e. where you are) 20
>> 	commits ago, just like running "/bin/ls" there will give you the
>> 	list of files you have right now.
>
> Frankly, I think this is overdoing it. I'm all for being positive, but
> it is obvious why this is good thing when you inspect a root tree and
> there's no need to be too wordy about it...

I mildly disagree.

If the person had truly understood that, why do we even have this thread to begin with?

Description on *what* it does (i.e. "like what ls -a does in the current working directory" we have in the Description section) obviously was not good enough. It will be better understood if you describe *why* it does it that way at the same time.