README-topic
author Boris Feld <boris.feld@octobus.net>
Tue, 29 Aug 2017 16:42:40 +0200
changeset 2950 1b4c92621e23
parent 2099 47017b3086d4
permissions -rw-r--r--
doc: integrate graphviz graphs in tutorials Use the mercurial-graphviz extension (https://bitbucket.org/octobus/mercurial_graphviz) in tutorials in order to have some dot graphs in the tutorials .t files. In order to run the tests, export the GRAPHVIZ_EXTENSION variable which points to your copy of the extension. Please be aware that pygraphviz should be installed in your environment. That should be sufficient for generating dot graphs in text format. Then generate the doc as usual, the sphinx-graphviz extension (http://www .sphinx-doc.org/en/stable/ext/graphviz.html) has been added and it should handle the generation of the graphs. Please be aware that you need the dot binary installed in your system. Please refer to the extension documentation for more configuration.

Topic Extension
================

This packages also provides the ``topic`` experiment in an independent
extension. It implements a new experimental concept to provide lightweight
feature branches for the mutable parts of the history. The experiments is still
at an early stage and have significant usability and performance issues when
enabled.

How to Install
==============

The ``topic`` extension is included into the ``evolve` package, so the same instruction apply.

Using Pip
---------

You can install the latest version using pip::

    $ pip install --user hg-evolve

Then just enable it in you hgrc::

    $ hg config --edit # adds the two line below:
    [extensions]
    topic =

From Source
-----------

To install a local version from source::

    $ hg clone https://www.mercurial-scm.org/repo/evolve/
    $ cd evolve
    $ make install-home

Enable
------

The topic extensions is included in the evolve package. See the install instruction for evolve.

Then enable it in you configuration::

    $ hg config --edit # adds the two line below:
    [extensions]
    topic =

Documentation
-------------

* See 'hg help -e topic' for a generic help.
* See 'hg help topics' and 'hg help stack' for help on specific commands.
* See the 'tests/test-topic-tutorial.t' file for a quick tutorial.