hgext3rd/evolve/__init__.py
changeset 2292 f026e85bd0b2
parent 2290 a36a8c6a09ac
child 2293 1659b42c28c2
--- a/hgext3rd/evolve/__init__.py	Sat Apr 29 05:44:07 2017 +0200
+++ b/hgext3rd/evolve/__init__.py	Sat Apr 29 05:35:01 2017 +0200
@@ -7,15 +7,32 @@
 # GNU General Public License version 2 or any later version.
 """extends Mercurial feature related to Changeset Evolution
 
-This extension provides several commands to mutate history and deal with
-resulting issues.
-
-It also:
-
-    - enables the "Changeset Obsolescence" feature of Mercurial,
-    - alters core commands and extensions that rewrite history to use
-      this feature,
-    - improves some aspect of the early implementation in Mercurial core
+This extension:
+
+- provides several commands to mutate history and deal with resulting issues,
+- enable the changeset-evolution feature for Mercurial,
+- improves some aspect of the early implementation in Mercurial core,
+
+Note that a version dedicated to server usage only (no local working copy) is
+available as 'evolve.serveronly'.
+
+While many feature related to changeset evolution are directly handled by core
+this extensions contains significant additions recommended to any user of
+changeset evolution.
+
+With the extensions various evolution events will display warning (new unstable
+changesets, obsolete working copy parent, improved error when accessing hidden
+revision, etc).
+
+In addition, the extension contains better discovery protocol for obsolescence
+markers. This means less obs-markers will have to be pushed and pulled around,
+speeding up such operation.
+
+Some improvement and bug fixes available in newer version of Mercurial are also
+backported to older version of Mercurial by this extension. Some older
+experimental protocol are also supported for a longer time in the extensions to
+help people transitioning. (The extensions is currently compatible down to
+Mercurial version 3.8).
 """