hg-evolve


Namehg-evolve JSON
Version 7.1.0 PyPI version JSON
download
home_pagehttps://www.mercurial-scm.org/doc/evolution/
SummaryFlexible evolution of Mercurial history.
upload_time2017-12-12 10:42:54
maintainer
docs_urlNone
authorPierre-Yves David
requires_python
licenseGPLv2+
keywords hg mercurial
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls.
            =============================
Mutable History For Mercurial
=============================

Evolve Extension
=================

This package supplies the ``evolve`` extension for Mercurial,

**The full implementation of the changeset evolution concept is still in
progress.**  Please subscribe to the `evolve-testers mailing list
<https://www.mercurial-scm.org/mailman/listinfo/evolve-testers>`_ to stay up to
date with changes.

This extension:

* enables the “changeset evolution” feature of Mercurial core,

* provides a set of commands to mutate your history,

* issues several warning messages when troubles from some mutable appears in
  your repository,

* provides an ``hg evolve`` command to deal with such "troubles",

* improves performance of obsolescence marker exchanges and discovery during
  push and pull.

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

We recommend reading the documentation first. An online version is
available here:

    https://www.mercurial-scm.org/doc/evolution/

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

Using Pip
---------

You can install the latest evolution version usin pip::

    $ pip install --user hg-evolve

Then just enable it in you hgrc::

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

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

To install a local version from source::

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

Then just enable it in you hgrc::

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

Documentation lives in ``doc/``.

Server Only Setup
=================

It is possible to enable a smaller subset of the extensions aimed at server
serving repository. It skips the additions of the new commands and local UI
messages that might add performance overheads. To use the server only
extension, install the package and use::

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


How to Contribute
=================

Bugs are to be reported on the mercurial's bug tracker (component: `evolution`_):

.. _evolution: https://bz.mercurial-scm.org/buglist.cgi?component=evolution&query_format=advanced&resolution=---

Please use the patchbomb extension to send email to `mercurial devel
<https://www.mercurial-scm.org/mailman/listinfo/mercurial-devel>`_. Please make
sure to use the evolve-ext flag when doing so. You can use a command like
this::

    $ hg email --to mercurial-devel@mercurial-scm.org --flag evolve-ext --rev '<your patches>'

For guidelines on the patch description, see the `official Mercurial guideline`_.

.. _`official Mercurial guideline`: https://mercurial-scm.org/wiki/ContributingChanges#Patch_descriptions

Please don't forget to update and run the tests when you fix a bug or
add a feature. To run the tests, you need a working copy of Mercurial,
say in $HGSRC::

    $ cd tests
    $ python $HGSRC/tests/run-tests.py

Branch policy
-------------

The evolve test are highly impacted by changes in core. To deal with this, we use named branches.

There are two main branches: "stable" and "default". Tests on these branch are
supposed to pass with the corresponding "default" and "stable" branch from core
Mercurial. The documentation is built from the tip of stable.

In addition, we have compatibility branches to check tests on older version of
Mercurial. They are the "mercurial-x.y" branches. They are used to apply
expected test change only, no code change should happen there.
            

Raw data

            {
    "maintainer": "", 
    "docs_url": null, 
    "requires_python": "", 
    "maintainer_email": "", 
    "cheesecake_code_kwalitee_id": null, 
    "keywords": "hg mercurial", 
    "upload_time": "2017-12-12 10:42:54", 
    "author": "Pierre-Yves David", 
    "home_page": "https://www.mercurial-scm.org/doc/evolution/", 
    "download_url": "https://pypi.python.org/packages/a7/de/01c0878771bff9c54789f4ea6e5ff1c0748d5b97121b4ecda2a6c37e7fee/hg-evolve-7.1.0.tar.gz", 
    "platform": "", 
    "version": "7.1.0", 
    "cheesecake_documentation_id": null, 
    "description": "=============================\nMutable History For Mercurial\n=============================\n\nEvolve Extension\n=================\n\nThis package supplies the ``evolve`` extension for Mercurial,\n\n**The full implementation of the changeset evolution concept is still in\nprogress.**  Please subscribe to the `evolve-testers mailing list\n<https://www.mercurial-scm.org/mailman/listinfo/evolve-testers>`_ to stay up to\ndate with changes.\n\nThis extension:\n\n* enables the \u201cchangeset evolution\u201d feature of Mercurial core,\n\n* provides a set of commands to mutate your history,\n\n* issues several warning messages when troubles from some mutable appears in\n  your repository,\n\n* provides an ``hg evolve`` command to deal with such \"troubles\",\n\n* improves performance of obsolescence marker exchanges and discovery during\n  push and pull.\n\nDocumentation\n-------------\n\nWe recommend reading the documentation first. An online version is\navailable here:\n\n    https://www.mercurial-scm.org/doc/evolution/\n\nHow to Install\n==============\n\nUsing Pip\n---------\n\nYou can install the latest evolution version usin pip::\n\n    $ pip install --user hg-evolve\n\nThen just enable it in you hgrc::\n\n    $ hg config --edit # adds the two line below:\n    [extensions]\n    evolve =\n\nFrom Source\n-----------\n\nTo install a local version from source::\n\n    $ hg clone https://www.mercurial-scm.org/repo/evolve/\n    $ cd evolve\n    $ pip install --user .\n\nThen just enable it in you hgrc::\n\n    $ hg config --edit # adds the two line below:\n    [extensions]\n    evolve =\n\nDocumentation lives in ``doc/``.\n\nServer Only Setup\n=================\n\nIt is possible to enable a smaller subset of the extensions aimed at server\nserving repository. It skips the additions of the new commands and local UI\nmessages that might add performance overheads. To use the server only\nextension, install the package and use::\n\n    $ hg config --edit # adds the two line below:\n    [extensions]\n    evolve.serveronly =\n\n\nHow to Contribute\n=================\n\nBugs are to be reported on the mercurial's bug tracker (component: `evolution`_):\n\n.. _evolution: https://bz.mercurial-scm.org/buglist.cgi?component=evolution&query_format=advanced&resolution=---\n\nPlease use the patchbomb extension to send email to `mercurial devel\n<https://www.mercurial-scm.org/mailman/listinfo/mercurial-devel>`_. Please make\nsure to use the evolve-ext flag when doing so. You can use a command like\nthis::\n\n    $ hg email --to mercurial-devel@mercurial-scm.org --flag evolve-ext --rev '<your patches>'\n\nFor guidelines on the patch description, see the `official Mercurial guideline`_.\n\n.. _`official Mercurial guideline`: https://mercurial-scm.org/wiki/ContributingChanges#Patch_descriptions\n\nPlease don't forget to update and run the tests when you fix a bug or\nadd a feature. To run the tests, you need a working copy of Mercurial,\nsay in $HGSRC::\n\n    $ cd tests\n    $ python $HGSRC/tests/run-tests.py\n\nBranch policy\n-------------\n\nThe evolve test are highly impacted by changes in core. To deal with this, we use named branches.\n\nThere are two main branches: \"stable\" and \"default\". Tests on these branch are\nsupposed to pass with the corresponding \"default\" and \"stable\" branch from core\nMercurial. The documentation is built from the tip of stable.\n\nIn addition, we have compatibility branches to check tests on older version of\nMercurial. They are the \"mercurial-x.y\" branches. They are used to apply\nexpected test change only, no code change should happen there.", 
    "lcname": "hg-evolve", 
    "bugtrack_url": null, 
    "github": false, 
    "name": "hg-evolve", 
    "license": "GPLv2+", 
    "summary": "Flexible evolution of Mercurial history.", 
    "split_keywords": [
        "hg", 
        "mercurial"
    ], 
    "author_email": "pierre-yves.david@ens-lyon.org", 
    "urls": [
        {
            "has_sig": false, 
            "upload_time": "2017-12-12T10:42:54", 
            "comment_text": "", 
            "python_version": "source", 
            "url": "https://pypi.python.org/packages/a7/de/01c0878771bff9c54789f4ea6e5ff1c0748d5b97121b4ecda2a6c37e7fee/hg-evolve-7.1.0.tar.gz", 
            "md5_digest": "b529b14b65d064bf9f15303ca9ef1840", 
            "downloads": 0, 
            "filename": "hg-evolve-7.1.0.tar.gz", 
            "packagetype": "sdist", 
            "path": "a7/de/01c0878771bff9c54789f4ea6e5ff1c0748d5b97121b4ecda2a6c37e7fee/hg-evolve-7.1.0.tar.gz", 
            "size": 589991
        }
    ], 
    "_id": null, 
    "cheesecake_installability_id": null
}