git-rebase: Clarify usage statement and copy it into the actual documentation.
I found a paper thin man page for git-rebase, but was quite happy to see something much more useful in the usage statement of the script when I went there to find out how this thing worked. Here it is cleaned up slightly and expanded a bit into the actual documentation. Signed-off-by: Carl Worth <cworth@cworth.org> Signed-off-by: Junio C Hamano <junkio@cox.net>
This commit is contained in:

committed by
Junio C Hamano

parent
6643688867
commit
69a60af5d0
@ -4,24 +4,28 @@
|
||||
#
|
||||
|
||||
USAGE='[--onto <newbase>] <upstream> [<branch>]'
|
||||
LONG_USAGE='If <branch> is specified, switch to that branch first. Then,
|
||||
extract commits in the current branch that are not in <upstream>,
|
||||
and reconstruct the current on top of <upstream>, discarding the original
|
||||
development history. If --onto <newbase> is specified, the history is
|
||||
reconstructed on top of <newbase>, instead of <upstream>. For example,
|
||||
while on "topic" branch:
|
||||
LONG_USAGE='git-rebase applies to <upstream> (or optionally to <newbase>) commits
|
||||
from <branch> that do not appear in <upstream>. When <branch> is not
|
||||
specified it defaults to the current branch (HEAD).
|
||||
|
||||
When git-rebase is complete, <branch> will be updated to point to the
|
||||
newly created line of commit objects, so the previous line will not be
|
||||
accessible unless there are other references to it already.
|
||||
|
||||
Assuming the following history:
|
||||
|
||||
A---B---C topic
|
||||
/
|
||||
D---E---F---G master
|
||||
|
||||
$ '"$0"' --onto master~1 master topic
|
||||
The result of the following command:
|
||||
|
||||
would rewrite the history to look like this:
|
||||
git-rebase --onto master~1 master topic
|
||||
|
||||
would be:
|
||||
|
||||
A'\''--B'\''--C'\'' topic
|
||||
/
|
||||
A'\''--B'\''--C'\'' topic
|
||||
/
|
||||
D---E---F---G master
|
||||
'
|
||||
|
||||
|
Reference in New Issue
Block a user