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 8b91847856b51fbe6727ad96e6d5e4d1fd00c815..6e92e4aa66674fa5fde90866c0f2ff9155270dc0 100644 (file)
--- a/Documentation/git-read-tree.txt
+++ b/Documentation/git-read-tree.txt
@@ -28,11 +28,14 @@ will be in unmerged state when "git-read-tree" returns.
 OPTIONS
 -------
 -m::
 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::
 
 --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
 
 -u::
        After a successful merge, update the files in the work


@@ -47,7 +50,6 @@ OPTIONS
        trees that are not directly related to the current
        working tree status into a temporary index file.
 
        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.
 
 <tree-ish#>::
        The id of the tree object(s) to be read/merged.