document revert command more accurately.
authorVadim Gelfer <vadim.gelfer@gmail.com>
Mon, 02 Jan 2006 14:31:25 -0800
changeset 1608 722fd16f6f8c
parent 1607 d72d27ee72b9
child 1609 c50bddfbc812
document revert command more accurately. this fixes issue 87.
doc/hg.1.txt
--- a/doc/hg.1.txt	Thu Dec 29 14:59:19 2005 -0600
+++ b/doc/hg.1.txt	Mon Jan 02 14:31:25 2006 -0800
@@ -497,9 +497,18 @@
     aliases: mv
 
 revert [names ...]::
-    Revert any uncommitted modifications made to the named files or
-    directories.  This restores the contents of the affected files to
-    an unmodified state.
+    The revert command has two modes of operation.
+
+    In its default mode, it reverts any uncommitted modifications made
+    to the named files or directories.  This restores the contents of
+    the affected files to an unmodified state.
+
+    Using the -r option, it reverts the given files or directories to
+    their state as of an earlier revision.  This can be helpful to "roll
+    back" some or all of a change that should not have been committed.
+
+    Revert modifies the working directory.  It does not commit any
+    changes, or change the parent of the current working directory.
 
     If a file has been deleted, it is recreated.  If the executable
     mode of a file was changed, it is reset.