Re: [RFC/PATCH 1/2] Doc rebase: Describe rebase as excluding merge commits
- From
Junio C Hamano <gitster@pobox.com>
- Date
- May 20, 2013, 04:43 UTC
- Message-ID
- <7v1u92xnuw.fsf@alter.siamese.dyndns.org>
- In-Reply-To
- <20130519180804.GE3362@elie.Belkin>
Jonathan Nieder <jrnieder@gmail.com> writes:
Show 6 quoted lines
> Philip Oakley wrote: > >> Describe rebase in the description section. > > It already does that. :) I think you mean "start with a summary", > which is a valuable improvement.
It indeed is a good idea to give the "high-level introduction" at the very beginning, but I do not think it should describe only one of the three major modes of "git rebase" (i.e. no -m, no -i), like the proposed patch text does. We should instead say what it is used for and why the user would want to use it that is common across these modes at a very high level.
Show 5 quoted lines
> DESCRIPTION > ----------- > <brief description of the purpose of the command, including some token > mention of *why* a user would want to use it (e.g., "so that the patches > apply cleanly to their new base").>
Exactly.