docs/index.rst
author Pierre-Yves David <pierre-yves.david@logilab.fr>
Wed, 21 Mar 2012 19:09:24 +0100
changeset 163 92b073d13f2d
parent 161 4e3f25ba5401
child 164 c81d286c4a5b
permissions -rw-r--r--
more doc update

========================================
Safe Mutable History
========================================


Here are various Materials on planned improvement to mercurial regarding
rewriting mutable history.

The effort is splitted in two part:

 * The **obsolete marker** concept aiming to provide and alternative to strip to
   get ride of changesets.

 * A mercurial extension: **evolve** that rewrite using *obsolete marker*
   under the hood.


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



.. toctree::
   :maxdepth: 1

   tutorial
   evolve-faq
   from-mq

A new UI to replace MQ
=================================

for dev and advanced user


.. toctree::
   :maxdepth: 1

   obs-concept
   glossary
   obs-implementation


Big flasshy warning on current remaining issue