Differences between revisions 1 and 13 (spanning 12 versions)
Revision 1 as of 2011-09-06 17:07:44
Size: 1138
Comment: Very basic first draft about the evolution concept
Revision 13 as of 2012-10-29 19:38:04
Size: 5267
Editor: mpm
Comment:
Deletions are marked like this. Additions are marked like this.
Line 2: Line 2:
= Changeset Evolution Plan =
/!\ This page is intended for developers
Line 5: Line 3:
Proposition for safe rewriting of mercurial history. This will have a close relationship with StatesPlan = Changesets Evolution Concept =
Line 7: Line 5:
<<TableOfContents>>

/!\ this feature is experimental and only partially implement in core

Changesets evolution allows for safe rewriting of mercurial history. This has a close relationship with [[Phases]]

 * Presentation of the concept: http://hg-lab.logilab.org/doc/mutable-history/html/

 * Related experimental extension (usable): http://bitbucket.org/marmoute/mutable-history/overview
Line 10: Line 17:
* Store and explicit relation between new and old version of rewritten changeset.

* This relation should *not* be part of the changeset (should not alter the hash).

* People must be able to collaborate on evolving changeset
 * Store and explicit obsolescence marker between new and old version of rewritten changeset.
 * This marker are *not* be part of the changeset (should not alter the hash).
 * People are able to collaborate on evolving changeset
Line 19: Line 23:
* Save delta in a real changeset.  * Store final delta in a real and autonomous changeset.
 * This Obsolescence marker are exchangeable without rewritten changeset.
 * Easily allow other extension to manipulate such relation (and to hook on such operation)
Line 21: Line 27:
* This relation should be exchangeable without rewritten changeset. == handled situation ==
Line 23: Line 29:
* Easily allow other extension to manipulate such relation (and to hook on such operation)  * Rewriting content of a changeset,
 * delete/kill a changeset.
 * split a single changeset in multiple one,
 * collapse multiple changeset in single one,
 * change changeset order,
 * adding (eg pulling) a changeset evolution that conflict with another one.
 * adding (or adding in general ) new changesets on a one which already evolved (or evolving a changeset that have descendant)
Line 25: Line 37:
== Situation that should be handled ==
Line 27: Line 38:
* Rewriting content of a changeset, == Changeset Obsolescence ==
Line 29: Line 40:
* delete/kill a changeset. Obsolescence markers make it possible to mark changesets that have been
deleted or superset in a new version of the changeset.
Line 31: Line 43:
* split a single changeset in multiple one, Unlike the previous way of handling such changes, by stripping the old
changesets from the repository, obsolescence markers can be propagated
between repositories. This allows for a safe and simple way of exchanging
mutable history and altering it after the fact. Changeset phases are
respected, such that only draft and secret changesets can be altered (see
:hg:`hg phases` for details).
Line 33: Line 50:
* collapse multiple changeset in single one, Obsolescence is tracked using "obsolete markers", a piece of metadata
tracking which changesets have been made obsolete, potential successors for
a given changeset, the moment the changeset was marked as obsolete, and the
user who performed the rewriting operation. The markers are stored
separately from standard changeset data can be exchanged without any of the
precursor changesets, preventing unnecessary exchange of obsolescence data.
Line 35: Line 57:
* change changeset order, The complete set of obsolescence markers describes a history of changeset
modifications that is orthogonal to the repository history of file
modifications. This changeset history allows for detection and automatic
resolution of edge cases arising from multiple users rewriting the same part
of history concurrently.
Line 37: Line 63:
* adding (eg pulling) a changeset evolution that conflict with another one. == Current feature status ==
Line 39: Line 65:
* adding (or adding in general ) new changesets on a one which already evolved (or evolving a changeset that have descendant) This feature is still at an early stage of development. While several core
behaviors have been adjusted to take obsolescence markers into account, some
parts of Mercurial are still unaware of the new concept.

We do not recommend using this feature with version 2.4 of Mercurial unless you are an experienced user aware of the limitation of the current implementation.


== State of the concept in version 2.4 ==

Commit --amend, rebase and histedit can now create obsolescence marker instead of stripping. This behavior is disable by default. You need to explicitly enable Obsolescence support to get this behavior.

Some part of Mercurial comply with obsolescence marker, enforcing behavior as
outlined below:

Changesets marked as obsolete are:

    * hidden from log,
    * excluded from push, pull, clone,
    * selected by the 'obsolete()' revset.

In some situation you may have non-obsolete changesets descending from
obsolete changesets. Such changesets are said to be "unstable":

    * push will refuse to push them without --force,
    * the 'unstable()' revset will select them,
    * their obsolete ancestors are displayed by log.

In some other situation you may have successors for changeset who are now [[immutable||Phases]]. In such case the obsolescence marker does not apply and the unlucky successors are said to be "bumped":

    * push will refuse to push them without --force,
    * the 'bumped()' revset will select them,


Obsolete changesets with no non-obsolete descendants are said to be
"extinct" and will appear when querying the "extinct()" revset.

Obsolescence markers will be exchanged between repositories that explicitly
assert support for the obsolescence feature (this can currently only be done
via an extension).

log --graph will display use 'x' instead of 'o' to display obsolete changesets.

Successors of a changeset are seen as valid destination for bookmarks.

== Experimental user ==

/!\ this feature is experimental do not try it unless you are an experimented user of Mercurial

A set of extension experimenting around the obsolescence concept is provided by Logilab. It has prototype implementation for most of the final feature. See its documentation for details:

http://hg-lab.logilab.org/doc/mutable-history/html/

== Older materials ==

Initial presentation at Copenhagen: http://public.octopoid.net/talk.pdf
First tutorial written by Parren: http://arrenbrecht.ch/mercurial/evolution/

Changesets Evolution Concept

/!\ this feature is experimental and only partially implement in core

Changesets evolution allows for safe rewriting of mercurial history. This has a close relationship with Phases

1. Core principle

  • Store and explicit obsolescence marker between new and old version of rewritten changeset.
  • This marker are *not* be part of the changeset (should not alter the hash).
  • People are able to collaborate on evolving changeset

2. Additional idea

  • Store final delta in a real and autonomous changeset.
  • This Obsolescence marker are exchangeable without rewritten changeset.
  • Easily allow other extension to manipulate such relation (and to hook on such operation)

3. handled situation

  • Rewriting content of a changeset,
  • delete/kill a changeset.
  • split a single changeset in multiple one,
  • collapse multiple changeset in single one,
  • change changeset order,
  • adding (eg pulling) a changeset evolution that conflict with another one.
  • adding (or adding in general ) new changesets on a one which already evolved (or evolving a changeset that have descendant)

4. Changeset Obsolescence

Obsolescence markers make it possible to mark changesets that have been deleted or superset in a new version of the changeset.

Unlike the previous way of handling such changes, by stripping the old changesets from the repository, obsolescence markers can be propagated between repositories. This allows for a safe and simple way of exchanging mutable history and altering it after the fact. Changeset phases are respected, such that only draft and secret changesets can be altered (see :hg:hg phases for details).

Obsolescence is tracked using "obsolete markers", a piece of metadata tracking which changesets have been made obsolete, potential successors for a given changeset, the moment the changeset was marked as obsolete, and the user who performed the rewriting operation. The markers are stored separately from standard changeset data can be exchanged without any of the precursor changesets, preventing unnecessary exchange of obsolescence data.

The complete set of obsolescence markers describes a history of changeset modifications that is orthogonal to the repository history of file modifications. This changeset history allows for detection and automatic resolution of edge cases arising from multiple users rewriting the same part of history concurrently.

5. Current feature status

This feature is still at an early stage of development. While several core behaviors have been adjusted to take obsolescence markers into account, some parts of Mercurial are still unaware of the new concept.

We do not recommend using this feature with version 2.4 of Mercurial unless you are an experienced user aware of the limitation of the current implementation.

6. State of the concept in version 2.4

Commit --amend, rebase and histedit can now create obsolescence marker instead of stripping. This behavior is disable by default. You need to explicitly enable Obsolescence support to get this behavior.

Some part of Mercurial comply with obsolescence marker, enforcing behavior as outlined below:

Changesets marked as obsolete are:

  • hidden from log,
  • excluded from push, pull, clone,
  • selected by the 'obsolete()' revset.

In some situation you may have non-obsolete changesets descending from obsolete changesets. Such changesets are said to be "unstable":

  • push will refuse to push them without --force,
  • the 'unstable()' revset will select them,
  • their obsolete ancestors are displayed by log.

In some other situation you may have successors for changeset who are now immutable. In such case the obsolescence marker does not apply and the unlucky successors are said to be "bumped":

  • push will refuse to push them without --force,
  • the 'bumped()' revset will select them,

Obsolete changesets with no non-obsolete descendants are said to be "extinct" and will appear when querying the "extinct()" revset.

Obsolescence markers will be exchanged between repositories that explicitly assert support for the obsolescence feature (this can currently only be done via an extension).

log --graph will display use 'x' instead of 'o' to display obsolete changesets.

Successors of a changeset are seen as valid destination for bookmarks.

7. Experimental user

/!\ this feature is experimental do not try it unless you are an experimented user of Mercurial

A set of extension experimenting around the obsolescence concept is provided by Logilab. It has prototype implementation for most of the final feature. See its documentation for details:

http://hg-lab.logilab.org/doc/mutable-history/html/

8. Older materials

Initial presentation at Copenhagen: http://public.octopoid.net/talk.pdf First tutorial written by Parren: http://arrenbrecht.ch/mercurial/evolution/

ChangesetEvolution (last edited 2022-08-14 21:06:00 by StephenRasku)