--- a/docs/index.rst Thu Jan 24 18:02:00 2013 -0500
+++ b/docs/index.rst Thu Jan 24 18:05:59 2013 -0500
@@ -9,7 +9,7 @@
Here are various materials on planned improvement to Mercurial regarding
rewriting history.
-First read about what challenge arise while rewriting history and how we plan to
+First, read about what challenges arise while rewriting history and how we plan to
solve them once and for all.
.. toctree::
@@ -20,10 +20,10 @@
The effort is split in two parts:
* The **obsolescence marker** concept aims to provide an alternative to ``strip``
- to get rid of changesets. This concept have been partially implemented since
+ to get rid of changesets. This concept has been partially implemented since
Mercurial 2.3.
- * The **evolve** mercurial extension rewrites history using obsolete
+ * The **evolve** Mercurial extension rewrites history using obsolete
*marker* under the hood.
The first and most important step is by far the **obsolescence marker**. However
@@ -34,35 +34,35 @@
====================================
Evolve is an experimental history rewriting extension that uses obsolete
-markers. It is inspired from MQ and pbranch but have multiple advantages over
+markers. It is inspired by MQ and pbranch but has multiple advantages over
them:
* Focus on your current work.
You can focus your work on a single changeset and take care of adapting
- descendent changeset later.
+ descendent changesets later.
* Handle **non-linear history with branches and merges**
-* Rely internally on **robust merge** mechanism of mercurial.
+* Rely internally on Mercurial's **robust merge** mechanism.
- Simple conflict are handled by real merge tools using appropriate ancestor.
- Conflict are much rarer and much more user friendly.
+ Simple conflicts are handled by real merge tools using the appropriate ancestor.
+ Conflicts are much rarer and much more user friendly.
* Mutable history **fully available all the time**.
- always use 'hg update' and forget about (un)applying patches to access the
+ Always use 'hg update' and forget about (un)applying patches to access the
mutable part of your history.
-* Use only **plain changeset** and forget about patches. Evole will create and
+* Use only **plain changesets** and forget about patches. Evolve will create and
exchange real changesets. Mutable history can be used in all usual operations:
pull, push, log, diff, etc.
-* Allow **sharing and collaboration** mutable history without fear of duplicate
+* Allow **sharing and collaboration** mutable history without fear of duplicates
(thanks to obsolete marker).
-* Cover all mq usage but guard.
+* Cover all MQ usage but guard.
.. warning:: The evolve extension and obsolete markers are at an experimental
stage. While using obsolete you willl likely be exposed to complex
@@ -70,15 +70,15 @@
non-power users to test this at this stage.
While numbered 1.0.0, the command line API of this version should
- **not** be regarded as *stable*, command behavior, name and
- options may change in future release or once integrated in
- mercurial. It is still an immature extension, a lot of
- features are still missing but there is no high risk of
+ **not** be regarded as *stable*: command behavior, name and
+ options may change in future releases or once integrated into
+ Mercurial. It is still an immature extension; a lot of
+ features are still missing but there is low risk of
repository corruption.
- Production ready version should hide such details to normal user.
+ Production-ready version should hide such details from normal users.
-The evolve extension requires mercurial 2.4 (older version supports 2.3 and 2.2)
+The evolve extension requires Mercurial 2.4 (older versions support 2.3 and 2.2)
To enable the evolve extension use::
@@ -93,7 +93,7 @@
---
-For more information see documents below:
+For more information see the documents below:
.. toctree::
:maxdepth: 1
@@ -108,27 +108,27 @@
Smart changeset deletion: Obsolete Marker
==========================================
-Obsolete marker is a powerful concept that allow mercurial to safely handle
+The obsolete marker is a powerful concept that allows Mercurial to safely handle
history rewriting operations. It is a new type of relation between Mercurial
-changesets that track the result of history rewriting operations.
+changesets that tracks the result of history rewriting operations.
-This concept is simple to define and provides a very solid base to:
+This concept is simple to define and provides a very solid base for:
-- Very fast history rewriting operations,
+- very fast history rewriting operations
-- auditable and reversible history rewriting process,
+- auditable and reversible history rewriting process
-- clean final history,
+- clean final history
-- share and collaborate on mutable parts of the history,
+- share and collaborate on mutable parts of the history
-- gracefully handle history rewriting conflicts,
+- gracefully handle history rewriting conflicts
-- allow various history rewriting UI to collaborate with a underlying common API.
+- allow various history rewriting UI to collaborate with a underlying common API
---
-For more information see documents below
+For more information, see the documents below
.. toctree::
:maxdepth: 1
@@ -138,22 +138,22 @@
obs-implementation
-Known limitation and bug
+Known limitations and bugs
=================================
-Here is a list of know issue that will be fixed later:
+Here is a list of known issues that will be fixed later:
-* you need to provide to `graft --continue -O` if you started you
+* You need to provide to `graft --continue -O` if you started you
graft using `-O`.
you to manually specify target all the time.
-* trying to exchange obsolete marker with a static http repo will crash.
+* Trying to exchange obsolete marker with a static http repo will crash.
* Extinct changesets are hidden using the *hidden* feature of mercurial only
supported by a few commands.
- Only ``hg log``, ``hgview`` and `hg glog` support it. ``hg head`` or other visual viewer don't.
+ Only ``hg log``, ``hgview`` and `hg glog` support it. Neither ``hg heads`` nor other visual viewers do.
-* hg heads show extinct changeset
+* hg heads shows extinct changesets.