Documentation: warn prominently against merging with dirty trees
authorThomas Rast <trast@student.ethz.ch>
Thu, 7 Jan 2010 16:42:27 +0000 (17:42 +0100)
committerThomas Rast <trast@student.ethz.ch>
Sat, 9 Jan 2010 20:08:26 +0000 (21:08 +0100)
We do this for both git-merge and git-pull, so as to hopefully alert
(over)users of git-pull to the issue.

Signed-off-by: Thomas Rast <trast@student.ethz.ch>
Documentation/git-merge.txt
Documentation/git-pull.txt

index 48965870263c8cf1e72339994f1e171384b99eff..3277f4e26dae2ff346842bb1b698d20fd26a373f 100644 (file)
@@ -22,6 +22,10 @@ The second syntax (<msg> `HEAD` <commit>...) is supported for
 historical reasons.  Do not use it from the command line or in
 new scripts.  It is the same as `git merge -m <msg> <commit>...`.
 
+*Warning*: Running 'git-merge' with uncommitted changes is
+discouraged: while possible, it leaves you in a state that is hard to
+back out of in the case of a conflict.
+
 
 OPTIONS
 -------
index b93201158fa6fda914b6093af5911b7884328838..b3fa312d78695cea3a78ba02a8678415e5b0bb88 100644 (file)
@@ -24,6 +24,10 @@ when merging local branches into the current branch.
 Also note that options meant for 'git-pull' itself and underlying
 'git-merge' must be given before the options meant for 'git-fetch'.
 
+*Warning*: Running 'git-pull' (actually, the underlying 'git-merge')
+with uncommitted changes is discouraged: while possible, it leaves you
+in a state that is hard to back out of in the case of a conflict.
+
 OPTIONS
 -------