Re: blameview and file contents

From: Junio C Hamano <junkio@cox.net>
Date: Jan 30, 2007, 08:30 UTC
Message-ID: <7vveio5332.fsf@assigned-by-dhcp.cox.net>
In-Reply-To: <20070130072910.GB32640@spearce.org>

"Shawn O. Pearce" <spearce@spearce.org> writes:

Show 16 quoted lines

> Aneesh Kumar <aneesh.kumar@gmail.com> wrote:
>> See i said that there should be a simple way. Can we get this
>> documented in git-cat-file man page
>
> Well, this isn't the git-cat-file man page, but we do suggest people
> use `git show HEAD:foo.c` to get foo.c from HEAD in an interactive
> setting.  The git-show manpage refers people to git-rev-parse,
> which has the following:
>
> 	* A suffix ':' followed by a path; this names the blob or tree
> 	  at the given path in the tree-ish object named by the part
> 	  before the colon.
> ...
> But if you submit a documentation update to git-cat-file's manpage
> that points off to the same section of git-rev-parse, folks may
> appreciate it.  :-)

My feeling is that adding "See SPECIFYING REVISIONS section" to Porcelain documentation is a very good idea, but unwanted baggage for plumbing descriptions if added everywhere. The target audience of the latter is supposed to know what "object name" is, so:

 <object>::
-	The sha1 identifier of the object.
+	The name of the object to show.

should be sufficient.