README-topic
author Pierre-Yves David <pierre-yves.david@octobus.net>
Thu, 22 Jun 2017 10:13:29 +0200
changeset 2653 13313d0cab71
parent 2099 47017b3086d4
permissions -rw-r--r--
topicmap: massive rework Massively rework the way we build and use topicmap. This bring massive performance benefit. Topic map use to be a fully independant thing that we would switch on and off globaly. The caching on disk was broken so the performance were atrocious. Intead, now the topic are inherited from the 'immutable' map. We gave up on storing them on disk for now since the mutable set is usually small enough. The activation is done by hacking new "filter" on the repository and detection when they are one. This is hacky but core is hard to wrap here. Overall this whole wrapping is really scary and we should massage core API to help it.

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.