diff docs/index.rst @ 163:92b073d13f2d

more doc update
author Pierre-Yves David <pierre-yves.david@logilab.fr>
date Wed, 21 Mar 2012 19:09:24 +0100
parents 4e3f25ba5401
children c81d286c4a5b
line wrap: on
line diff
--- a/docs/index.rst	Wed Mar 21 12:11:43 2012 +0100
+++ b/docs/index.rst	Wed Mar 21 19:09:24 2012 +0100
@@ -8,35 +8,44 @@
 
 The effort is splitted in two part:
 
- * The **obsolete marker** concept that
- 
- 
- 
-    add an alternative to strip to remove changeset from a repository.
+ * The **obsolete marker** concept aiming to provide and alternative to strip to
+   get ride of changesets.
 
- * The changeset evolution UI
+ * A mercurial extension: **evolve** that rewrite using *obsolete marker*
+   under the hood.
+
 
-    to replace mq.
- 
- 
- adding in mercurial core an new concept of **obsolete marker** in mercurial
-   core,
+regarding mercurial internals, the first and most important step is the
+**obsolete marker**. However most user will never be directly exposed to the
+concept. For this reason document about changeset evolution are put first.
 
- * 
+
+Evolve: A robust alternative to MQ
+====================================
 
 
+* Using the obsolete marker concept, (see next section for advantage of the
+  obsolete marker)
 
+* provide a more robust alternative for mq covering any usage but guard.
+
+..warning:: The evolve extention and the obsolete marker are at an experimental
+            stage. While using obsolet you'll likely be exposed to complexe
+            implication of the **obsolete marker** concept. I do not recommend
+            non power user to test this at this stage.
+
+            Production ready version should hide such details to normal user.
+
+To enable the evolve extension use::
+
+    $ hg clone http://hg-dev.octopoid.net/hgwebdir.cgi/mutable-history/
+    $ mutable-history/enable.sh > ~/.hgrc
 
 
-Evolve: A new UI to replace MQ
-=================================
-
-For user
 
 .. toctree::
    :maxdepth: 1
 
-   evolve-intro
    tutorial
    evolve-faq
    from-mq