revert: rewrite help summary
authorMatt Mackall <mpm@selenic.com>
Mon, 06 Jun 2011 17:38:32 -0500
changeset 14540 944d9088da96
parent 14539 558ec14ba6be
child 14541 07ee46a2ece3
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.
mercurial/commands.py
tests/test-globalopts.t
tests/test-help.t
--- a/mercurial/commands.py	Sat Jun 04 20:19:30 2011 +0900
+++ b/mercurial/commands.py	Mon Jun 06 17:38:32 2011 -0500
@@ -4086,7 +4086,7 @@
     ] + 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.
--- a/tests/test-globalopts.t	Sat Jun 04 20:19:30 2011 +0900
+++ b/tests/test-globalopts.t	Mon Jun 06 17:38:32 2011 -0500
@@ -316,7 +316,7 @@
    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 @@
    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
--- a/tests/test-help.t	Sat Jun 04 20:19:30 2011 +0900
+++ b/tests/test-help.t	Mon Jun 06 17:38:32 2011 -0500
@@ -86,7 +86,7 @@
    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 @@
    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 @@
    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