Commit 7fcc57ee authored by Anton Shestakov's avatar Anton Shestakov
Browse files

readme: various small fixes to formatting and spelling

parent 15b7c822cc46
...@@ -3,9 +3,9 @@ Mutable History For Mercurial ...@@ -3,9 +3,9 @@ Mutable History For Mercurial
============================= =============================
Evolve Extension 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 progress.** Please subscribe to the `evolve-testers mailing list
...@@ -29,8 +29,8 @@ This extension: ...@@ -29,8 +29,8 @@ This extension:
Documentation Documentation
------------- -------------
We recommend reading the documentation first. An online version is We recommend reading the documentation first. An online version is available
available here: here:
https://www.mercurial-scm.org/doc/evolution/ https://www.mercurial-scm.org/doc/evolution/
...@@ -40,13 +40,13 @@ How to Install ...@@ -40,13 +40,13 @@ How to Install
Using Pip Using Pip
--------- ---------
You can install the latest evolution version usin pip:: You can install the latest released version using pip::
$ pip install --user hg-evolve $ pip install --user hg-evolve
Then just enable it in you hgrc:: Then enable it in your hgrc::
$ hg config --edit # adds the two line below: $ hg config --edit # add these two lines:
[extensions] [extensions]
evolve = evolve =
...@@ -57,17 +57,18 @@ To install a local version from source:: ...@@ -57,17 +57,18 @@ To install a local version from source::
$ hg clone https://www.mercurial-scm.org/repo/evolve/ $ hg clone https://www.mercurial-scm.org/repo/evolve/
$ cd evolve $ cd evolve
# optionally `hg update <target revision>`
$ pip install --user . $ pip install --user .
Then just enable it in you hgrc:: Then enable it in your hgrc::
$ hg config --edit # adds the two line below: $ hg config --edit # add these two lines:
[extensions] [extensions]
evolve = evolve =
Documentation lives in ``doc/``. Documentation lives in ``doc/``.
Server Only Setup Server-only Setup
================= =================
It is possible to enable a smaller subset of the extensions aimed at server It is possible to enable a smaller subset of the extensions aimed at server
...@@ -75,7 +76,7 @@ serving repository. It skips the additions of the new commands and local UI ...@@ -75,7 +76,7 @@ serving repository. It skips the additions of the new commands and local UI
messages that might add performance overheads. To use the server only messages that might add performance overheads. To use the server only
extension, install the package and use:: extension, install the package and use::
$ hg config --edit # adds the two line below: $ hg config --edit # add these two lines:
[extensions] [extensions]
evolve.serveronly = evolve.serveronly =
...@@ -96,7 +97,7 @@ core. The maturation period helped us to get a clearer picture of what was ...@@ -96,7 +97,7 @@ core. The maturation period helped us to get a clearer picture of what was
needed. During the upstreaming process, we can use this clearer picture to needed. During the upstreaming process, we can use this clearer picture to
clean up the code and upgrade it to an appropriate quality for Mercurial core. clean up the code and upgrade it to an appropriate quality for Mercurial core.
Python 3 support Python 3 Support
================ ================
Mercurial announced beta support for Python 3 starting with its 5.0 release. Mercurial announced beta support for Python 3 starting with its 5.0 release.
...@@ -112,7 +113,8 @@ Discussion happens on the #hg-evolve IRC on freenode_. ...@@ -112,7 +113,8 @@ Discussion happens on the #hg-evolve IRC on freenode_.
.. _freenode: https://freenode.net/ .. _freenode: https://freenode.net/
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`_).
.. _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=---
...@@ -127,14 +129,13 @@ command like this:: ...@@ -127,14 +129,13 @@ command like 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>'
For guidelines on the patch description, see the `official Mercurial guideline`_. For guidelines on the patch description, see the `official Mercurial guideline`_.
.. _`official Mercurial guideline`: https://mercurial-scm.org/wiki/ContributingChanges#Patch_descriptions .. _`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
add a feature. To run the tests, you need a working copy of Mercurial, feature. To run the tests, you need a working copy of Mercurial, say in
say in $HGSRC:: $HGSRC::
$ cd tests $ cd tests
$ python $HGSRC/tests/run-tests.py $ python $HGSRC/tests/run-tests.py
...@@ -164,10 +165,9 @@ Mercurial. They are the "mercurial-x.y" branches. They are used to apply ...@@ -164,10 +165,9 @@ Mercurial. They are the "mercurial-x.y" branches. They are used to apply
expected test changes only, no code changes should happen there. expected test changes only, no code changes should happen there.
Test output changes from a changeset in core should add the following line to Test output changes from a changeset in core should add the following line to
their patch description: their patch description::
CORE-TEST-OUTPUT-UPDATE: <CORE-NODE-ID>
CORE-TEST-OUTPUT-UPDATE: <changeset hash>
Format-source config Format-source config
==================== ====================
...@@ -179,7 +179,7 @@ Follow the instructions for install here: ...@@ -179,7 +179,7 @@ Follow the instructions for install here:
Then update both your global and repo config files:: Then update both your global and repo config files::
$ hg config -l # add the lines below $ hg config --local --edit # add these lines:
[extensions] [extensions]
formatsource = formatsource =
......
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