Re: [PATCH v2] Documentation/githooks: Explain pre-rebase parameters
On Sat, Feb 23, 2013 at 01:21:59PM -0800, Junio C Hamano wrote:
Show 14 quoted lines
> "W. Trevor King" <wking@tremily.us> writes:
>
> > +This hook is called by 'git rebase' and can be used to prevent a
> > +branch from getting rebased. The hook takes two parameters: the
> > +upstream the series was forked from and the branch being rebased. The
> > +second parameter will be missing when rebasing the current branch.
>
> takes one or two parameters?
>
> Other than that, looks good to me, but it took me two readings to
> notice where these two parameters are described. I have a feeling
> that a comma s/forked from and/forked from, and/; might make them a
> bit more spottable, but others may have better suggestions to make
> them stand out more.
How about:
The hook may be called with one or two parameters. The first
parameter is the upstream from which the series was forked. The
second parameter is the branch being rebased, and is not set when
rebasing the current branch.
--
This email may be signed or encrypted with GnuPG (http://www.gnupg.org).
For more information, see http://en.wikipedia.org/wiki/Pretty_Good_Privacy
W. Trevor King <wking@tremily.us>