Mercurial > evolve
changeset 456:79aacd34bf1e
obsolete: simplify module docstring
| author | Patrick Mezard <patrick@mezard.eu> |
|---|---|
| date | Wed, 15 Aug 2012 15:38:55 +0200 |
| parents | f46a41006136 |
| children | 0fc4addd881c |
| files | hgext/obsolete.py |
| diffstat | 1 files changed, 8 insertions(+), 9 deletions(-) [+] |
line wrap: on
line diff
--- a/hgext/obsolete.py Wed Aug 08 16:51:45 2012 +0200 +++ b/hgext/obsolete.py Wed Aug 15 15:38:55 2012 +0200 @@ -10,19 +10,18 @@ General concept =============== -This extension introduces the *obsolete* concept. It adds a new *obsolete* -relation between two changesets. A relation ``<changeset B> obsolete <changeset -A>`` is set to denote that ``<changeset B>`` is new version of ``<changeset -A>``. +This extension introduces the *obsolete* concept. The relation +``<changeset B> obsoletes <changeset A>`` denotes that ``<changeset B>`` +is a new version of ``<changeset A>``. -The *obsolete* relation act as a **perpendicular history** to the standard -changeset history. Standard changeset history versions files. The *obsolete* -relation versions changesets. +The *obsolete* relations act as an history **orthogonal** to the regular +changesets history. Regular changesets history versions files. *Obsolete* +relations version changesets. :obsolete: a changeset that has been replaced by another one. :unstable: a changeset that is not obsolete but has an obsolete ancestor. -:suspended: an obsolete changeset with unstable descendant. -:extinct: an obsolete changeset without unstable descendant. +:suspended: an obsolete changeset with unstable descendants. +:extinct: an obsolete changeset without unstable descendants. (subject to garbage collection) Another name for unstable could be out of sync.