Re: [PATCH] Document git-filter-branch

[Frank Lichtenheld <frank@lichtenheld.de>]

On Wed, Jul 04, 2007 at 12:17:05AM +0100, Johannes Schindelin wrote:
> Hi,
> 
> [if you comment on just a small portion of the text, could you please 
> quote only that? Thank you]
> 
> On Wed, 4 Jul 2007, Frank Lichtenheld wrote:
> 
> > General note: All the stuff in all uppercase should probably also
> > have some asciidoc emphasis.
> 
> I do not understand. I grepped through all the docs for uppercase words 
> emphasized in any way, and could not find one.

True. On the other hand it is used at least in the case of WARNING as
a means of emphasis and this should be reflected in the end result
as markup. So I still suggest changing it to *WARNING* or even
*Warning* if you don't want to double the emphasis.

> > On Tue, Jul 03, 2007 at 05:47:44PM +0100, Johannes Schindelin wrote:
> > > +the id of the commit being rewritten.  The author/committer environment
> > > +variables are set before the first filter is run.
> > 
> > Maybe give the actual names of the environment variables here?
> 
> If you think so:
> 
> 	Also, GIT_AUTHOR_NAME, GIT_AUTHOR_EMAIL, GIT_AUTHOR_DATE, 
> 	GIT_COMMITTER_NAME, GIT_COMMITTER_EMAIL, and GIT_COMMITTER_DATE is 
> 	set according to the current commit.

"are" set. And yeah, it doesn't look pretty. I still prefer having the
list somewhere in the text, though.

> > > +	Only regard the history, as seen by the given subdirectory. The
> >                               ^^^
> > Does this comma belong there?
> 
> This is my bad English. What I meant was this:
> 
>         Only ever look at the history, which touches the given 
> 	subdirectory.  The result will contain that directory as its 
> 	project root.

I'm still not sure there should be a comma in this sentence, but my
English grammar is a bit rusty.

Gruesse,
-- 
Frank Lichtenheld <frank@lichtenheld.de>
www: http://www.djpig.de/