diff hgext/evolve.py @ 1403:9a8ecfdfa866

evolve: refresh the documentation

Multiple behavior change are coming, a perfect timing to refresh the doc before
we rework it more.

--- a/hgext/evolve.py	Tue Jun 16 15:08:44 2015 -0700
+++ b/hgext/evolve.py	Fri Jun 19 13:57:16 2015 -0700
@@ -1341,18 +1341,24 @@
     ] + mergetoolopts,
     _('[OPTIONS]...'))
 def evolve(ui, repo, **opts):
-    """solve trouble in your repository
+    """solve troubles in your repository
 
     - rebase unstable changesets to make them stable again,
     - create proper diffs from bumped changesets,
-    - merge divergent changesets,
+    - fuse divergent changesets back together,
     - update to a successor if the working directory parent is
       obsolete
 
-    By default a single changeset is evolved for each invocation and only
-    troubled changesets that would evolve as a descendant of the current
-    working directory will be considered. See --all and --any options to change
-    this behavior.
+    If no argument are passed and the current working copy parent is obsolete,
+    :hg:`evolve` will update the working copy to the successors of this working
+    copy parent. If the working copy parent is not obsolete (and still no
+    argument passed) each invocation of :hg:`evolve` will evolve a single
+    unstable changeset, It will only select a changeset to be evolved if it
+    will result in a new children for the current working copy parent. The
+    working copy will be updated on the result (this last behavior will most
+    likely to change in the future).
+
+    See --all and --any options to change this behavior.
 
     - For unstable, this means taking the first which could be rebased as a
       child of the working directory parent revision or one of its descendants