documentation: clarify read-tree --reset
[jc: light edit applied on top of the original]
Signed-off-by: Junio C Hamano <junkio@cox.net>
diff --git a/Documentation/git-read-tree.txt b/Documentation/git-read-tree.txt
index 8b91847..6e92e4a 100644
--- a/Documentation/git-read-tree.txt
+++ b/Documentation/git-read-tree.txt
@@ -28,11 +28,14 @@
OPTIONS
-------
-m::
- Perform a merge, not just a read.
+ Perform a merge, not just a read. The command will
+ refuse to run if your index file has unmerged entries,
+ indicating that you have not finished previous merge you
+ started.
--reset::
-
- Same as -m except that unmerged entries will be silently ignored.
+ Same as -m, except that unmerged entries are discarded
+ instead of failing.
-u::
After a successful merge, update the files in the work
@@ -47,7 +50,6 @@
trees that are not directly related to the current
working tree status into a temporary index file.
-
<tree-ish#>::
The id of the tree object(s) to be read/merged.
