Mercurial > evolve
changeset 5415:3be5dba88c49
readme: various small fixes to formatting and spelling
| author | Anton Shestakov <av6@dwimlabs.net> |
|---|---|
| date | Fri, 17 Jul 2020 09:36:14 +0800 |
| parents | 15b7c822cc46 |
| children | e2fb20dd0df7 |
| files | README.rst |
| diffstat | 1 files changed, 21 insertions(+), 21 deletions(-) [+] |
line wrap: on
line diff
--- a/README.rst Fri Jul 17 09:34:28 2020 +0800 +++ b/README.rst Fri Jul 17 09:36:14 2020 +0800 @@ -3,9 +3,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 progress.** Please subscribe to the `evolve-testers mailing list @@ -29,8 +29,8 @@ Documentation ------------- -We recommend reading the documentation first. An online version is -available here: +We recommend reading the documentation first. An online version is available +here: https://www.mercurial-scm.org/doc/evolution/ @@ -40,13 +40,13 @@ 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 -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] evolve = @@ -57,17 +57,18 @@ $ hg clone https://www.mercurial-scm.org/repo/evolve/ $ cd evolve + # optionally `hg update <target revision>` $ 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] evolve = Documentation lives in ``doc/``. -Server Only Setup +Server-only Setup ================= It is possible to enable a smaller subset of the extensions aimed at server @@ -75,7 +76,7 @@ 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 # add these two lines: [extensions] evolve.serveronly = @@ -96,7 +97,7 @@ 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. -Python 3 support +Python 3 Support ================ Mercurial announced beta support for Python 3 starting with its 5.0 release. @@ -112,7 +113,8 @@ .. _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=--- @@ -127,14 +129,13 @@ $ 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:: +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 @@ -164,10 +165,9 @@ expected test changes only, no code changes should happen there. 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 ==================== @@ -179,7 +179,7 @@ Then update both your global and repo config files:: - $ hg config -l # add the lines below + $ hg config --local --edit # add these lines: [extensions] formatsource =