[RFC/PATCH 2/2] Doc rebase: describe the priority of published work
Give details of the implied priority in the description section.
Signed-off-by: Philip Oakley <philipoakley@iee.org>
---
wording based on:
http://article.gmane.org/gmane.comp.version-control.git/222581
http://article.gmane.org/gmane.comp.version-control.git/223816
http://article.gmane.org/gmane.comp.version-control.git/217410
http://article.gmane.org/gmane.comp.version-control.git/222763
---
Documentation/git-rebase.txt | 6 ++++++
1 file changed, 6 insertions(+)
diff --git a/Documentation/git-rebase.txt b/Documentation/git-rebase.txt
index 87a8095..24d16ef 100644
--- a/Documentation/git-rebase.txt
+++ b/Documentation/git-rebase.txt
@@ -20,6 +20,12 @@ DESCRIPTION
by default, to the head of the branch's upstream, or onto a new base
if given.
+In its minimal form, having built locally on the (current) branch,
+use `git rebase` to catch up with its published upstream state to
+create a new linear history. Importantly, `git rebase` is a way to
+replay your work on top of the work of others. It is not about
+integrating other people's changes into your work.
+
If <branch> is specified, 'git rebase' will perform an automatic
`git checkout <branch>` before doing anything else. Otherwise
it remains on the current branch.
--
1.8.1.msysgit.1
Philip Oakley <philipoakley@iee.org>