This instance will be upgraded to Heptapod 0.27.1 on 2021-12-02 at 15:00 UTC+1 (a few minutes of down time)

Commit 504f722e authored by Pierre-Yves David's avatar Pierre-Yves David
Browse files

README: more update to prepare for pypi upload

 * mention the evolve.serveronly extension,

 * remove help related to topic into a different README file.
parent fc94c1909c18
...@@ -20,6 +20,7 @@ include hgext3rd/evolve/*.py ...@@ -20,6 +20,7 @@ include hgext3rd/evolve/*.py
include hgext3rd/topic/*.py include hgext3rd/topic/*.py
include MANIFEST.in include MANIFEST.in
include README include README
include README-topic
include setup.py include setup.py
include tests/*.py include tests/*.py
include tests/*.sh include tests/*.sh
......
...@@ -8,7 +8,9 @@ Evolve Extension ...@@ -8,7 +8,9 @@ Evolve Extension
This package supplies the ``evolve`` extension for Mercurial, This package supplies the ``evolve`` extension for Mercurial,
**The full implementation of the changeset evolution concept is still in **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. 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 extensions: This extensions:
...@@ -19,7 +21,10 @@ This extensions: ...@@ -19,7 +21,10 @@ This extensions:
* issues several warning messages when troubles from some mutable appears in * issues several warning messages when troubles from some mutable appears in
your repository, your repository,
* provides a ``hg evolve`` command to deal with such "troubles". issues. * provides a ``hg evolve`` command to deal with such "troubles".
* improves performance of obsolescence markers exchanges and discovery during
push and pull.
Documentation Documentation
------------- -------------
...@@ -62,37 +67,25 @@ Then just enable it in you hgrc:: ...@@ -62,37 +67,25 @@ Then just enable it in you hgrc::
Documentation lives in ``doc/``. Documentation lives in ``doc/``.
Topic Extension Server Only Version
================ ===================
This packages also provides the ``topic`` extensions. 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.
Enable
------
The topic extensions is included in the evolve package. See the install instruction for evolve. 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
Then enable it in you configuration:: 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: $ hg config --edit # adds the two line below:
[extensions] [extensions]
topics = evolve.serveronly =
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.
How to Contribute How to Contribute
================= =================
Bugs are to be reported on the mercurial's bug tracker (component: evolution): Bugs are to be reported on the mercurial's bug tracker (component: `evolution`_):
https://bz.mercurial-scm.org/buglist.cgi?component=evolution&query_format=advanced&resolution=---
.. _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. Please Please use the patchbomb extension to send email to mercurial devel. Please
make sure to use the evolve-ext flag when doing so. You can use a command like make sure to use the evolve-ext flag when doing so. You can use a command like
...@@ -100,9 +93,9 @@ this:: ...@@ -100,9 +93,9 @@ this::
$ hg email --to mercurial-devel@mercurial-scm.org --flag evolve-ext --rev '<your patches>' $ hg email --to mercurial-devel@mercurial-scm.org --flag evolve-ext --rev '<your patches>'
See also For guidelines on the patch description, see the `official Mercurial guideline`_.
https://mercurial-scm.org/wiki/ContributingChanges#Patch_descriptions
for guidelines on the patch description. .. _`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 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, add a feature. To run the tests, you need a working copy of Mercurial,
...@@ -113,8 +106,7 @@ say in $HGSRC:: ...@@ -113,8 +106,7 @@ say in $HGSRC::
(evolve's stable and default branches correspond to Mercurial's stable (evolve's stable and default branches correspond to Mercurial's stable
and default branches. So to test evolve from default, you need and default branches. So to test evolve from default, you need
Mercurial on default.) Mercurial on default.), Older version of Mercurial are supportd on their respective ``mercurial-x.y`` branches.
Changelog Changelog
========= =========
...@@ -125,7 +117,7 @@ Changelog ...@@ -125,7 +117,7 @@ Changelog
- drop compatibility for Mercurial < 3.8, - drop compatibility for Mercurial < 3.8,
- removed old (unpackaged) pushexperiment extension, - removed old (unpackaged) pushexperiment extension,
- move all extensions in the official 'hgext3rd' namespace package, - move all extensions in the official 'hgext3rd' namespace package,
- add the "topic" experimental extensions. - add the "topic" experimental extensions. See the README.topic file for details
- officially ship 'evolve.serveronly' extensions. That extensions contains - officially ship 'evolve.serveronly' extensions. That extensions contains
only the part related to exchange and is intended to be used by server. only the part related to exchange and is intended to be used by server.
......
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.
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment