[PATCH] Documentation: warn against merging in a dirty tree

From: Thomas Rast <trast@student.ethz.ch>
Date: Sep 15, 2008, 22:49 UTC
Message-ID: <1221518994-26111-2-git-send-email-trast@student.ethz.ch>
In-Reply-To: <1221518994-26111-1-git-send-email-trast@student.ethz.ch>

Merging in a dirty tree is usually a bad idea because you need to reset --hard to abort; but the docs didn't say anything about it.

Signed-off-by: Thomas Rast <trast@student.ethz.ch>

---
 Documentation/git-merge.txt |    5 +++++
 1 files changed, 5 insertions(+), 0 deletions(-)

diff --git a/Documentation/git-merge.txt b/Documentation/git-merge.txt
index 685e1fe..3798e16 100644
--- a/Documentation/git-merge.txt
+++ b/Documentation/git-merge.txt
@@ -22,6 +22,11 @@ The second syntax (<msg> `HEAD` <remote>) 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> <remote>`.
 
+NOTE: Usually it is a bad idea to merge with a dirty tree or index.
+      If you get conflicts and want to abort (instead of resolving),
+      you need to `git reset \--hard` which loses the uncommitted
+      changes.
+
 
 OPTIONS
 -------

-- 
tg: (1293c95..) t/doc-merge-reset (depends on: origin/master)