# HG changeset patch
# User Matt Mackall <mpm@selenic.com>
# Date 2011-06-06 22:38:32
# Node ID 944d9088da96c9c1e6c71f97f7eb77737cc28941
# Parent  558ec14ba6be7e71ce3b1f53daa820e041fff1d9

revert: rewrite help summary

New users have a tendency to mistake 'revert' as the command to use to
check out old revisions. They also occasionally mistake revert for a
generalized undo (compare rollback).

This version intentionally aims to avoid mentioning 'earlier' and thus
intentionally no longer alludes to the (secondary) -r behavior (which
in fact is not actually limited to 'earlier').

Instead, we mention checkout state, to convey that we can
restore things to the way they were when checked out.

diff --git a/mercurial/commands.py b/mercurial/commands.py
--- a/mercurial/commands.py
+++ b/mercurial/commands.py
@@ -4086,7 +4086,7 @@ def resolve(ui, repo, *pats, **opts):
     ] + walkopts + dryrunopts,
     _('[OPTION]... [-r REV] [NAME]...'))
 def revert(ui, repo, *pats, **opts):
-    """restore individual files or directories to an earlier state
+    """restore files to their checkout state
 
     .. note::
        This command is most likely not what you are looking for.
diff --git a/tests/test-globalopts.t b/tests/test-globalopts.t
--- a/tests/test-globalopts.t
+++ b/tests/test-globalopts.t
@@ -316,7 +316,7 @@ Testing -h/--help:
    remove       remove the specified files on the next commit
    rename       rename files; equivalent of copy + remove
    resolve      redo merges or set/view the merge status of files
-   revert       restore individual files or directories to an earlier state
+   revert       restore files to their checkout state
    rollback     roll back the last transaction (dangerous)
    root         print the root (top) of the current working directory
    serve        start stand-alone webserver
@@ -396,7 +396,7 @@ Testing -h/--help:
    remove       remove the specified files on the next commit
    rename       rename files; equivalent of copy + remove
    resolve      redo merges or set/view the merge status of files
-   revert       restore individual files or directories to an earlier state
+   revert       restore files to their checkout state
    rollback     roll back the last transaction (dangerous)
    root         print the root (top) of the current working directory
    serve        start stand-alone webserver
diff --git a/tests/test-help.t b/tests/test-help.t
--- a/tests/test-help.t
+++ b/tests/test-help.t
@@ -86,7 +86,7 @@ Short help:
    remove       remove the specified files on the next commit
    rename       rename files; equivalent of copy + remove
    resolve      redo merges or set/view the merge status of files
-   revert       restore individual files or directories to an earlier state
+   revert       restore files to their checkout state
    rollback     roll back the last transaction (dangerous)
    root         print the root (top) of the current working directory
    serve        start stand-alone webserver
@@ -160,7 +160,7 @@ Short help:
    remove       remove the specified files on the next commit
    rename       rename files; equivalent of copy + remove
    resolve      redo merges or set/view the merge status of files
-   revert       restore individual files or directories to an earlier state
+   revert       restore files to their checkout state
    rollback     roll back the last transaction (dangerous)
    root         print the root (top) of the current working directory
    serve        start stand-alone webserver
@@ -673,7 +673,7 @@ Test that default list of commands omits
    remove       remove the specified files on the next commit
    rename       rename files; equivalent of copy + remove
    resolve      redo merges or set/view the merge status of files
-   revert       restore individual files or directories to an earlier state
+   revert       restore files to their checkout state
    rollback     roll back the last transaction (dangerous)
    root         print the root (top) of the current working directory
    serve        start stand-alone webserver