Size: 1829
Comment:
|
Size: 1814
Comment:
|
Deletions are marked like this. | Additions are marked like this. |
Line 4: | Line 4: |
{X} This page describes a proposal that was rejected for core Mercurial. However, it may be implemented as a third party extension. | = Mutable Branches = '''This extension is not distributed with Mercurial. |
Line 6: | Line 7: |
= Mutable Branches = | This extension is currently under development, and not yet ready for use.''' |
Line 8: | Line 9: |
A recurring compliant against [[NamedBranches|named branches]] is that the name is permanent. This page describes a backward-compatible proposal to separate a branch's identity from its name. | ''Author: Gideon Sireling Repository: http://code.accursoft.com/mutable-branches/ Issue tracker: http://code.accursoft.com/mutable-branches/issues'' |
Line 12: | Line 17: |
== Visioning Branch Names == | == Overview == |
Line 14: | Line 19: |
An .hgbranches file in the working directory will keep a mapping of branch IDs to their names. When a new branch is created, the changeset's branch field will be set to a unique ID. An entry will then be made in .hgbranches, mapping the branch's ID to its name. | The mutable-branches extension allows [[NamedBranches|named branches]] to be renamed, without rewriting history. This is achieved by separating a branch's identity from its name. == Renaming Branches == To start renaming branches, create a file called `.hgbranches` in the root of the working directory, and check it in. Each line in `.hgbranches` consists of a space-delimited pair such as `oldBranch newBranch`. If the branch name contains spaces, it should be quoted. |
Line 20: | Line 29: |
If conflicting changes have been made to .hgbranches on different branches, or if it contains conflicting entries, this will be resolved by the same rules that apply to .hgtags. | If conflicting changes have been made to `.hgbranches` on different branches, or if it contains conflicting entries, this will be resolved by the same rules that apply to `.hgtags`. |
Line 24: | Line 33: |
If the user creates a local branch which they do not intend pushing, it can be recorded in .hg/localbranches. | If the user creates a local branch which they do not intend pushing, it can be recorded in `.hg/localbranches`. |
Line 28: | Line 37: |
If a branch ID is not recorded in .hgbranches or .hg/localbranches, the ID will be used as the branch name. Thus, existing branches can be used (and renamed) without any modifications. If the branch is renamed, older clients will continue to use the old name. | If a branch ID is not recorded in `.hgbranches` or `.hg/localbranches`, the ID will be used as the branch name. Thus, existing branches can be used (and renamed) without any modifications. If the branch is renamed, older clients will continue to use the old name. |
Line 32: | Line 41: |
Future development could add other fields to .hgbranches, such as description or owner. == Similar Implementations == The [[http://bitbucket.org/andre_felipe_dias/hg-ibranch|hg-ibranch]] extension implements a similar concept, but uses tip markers instead of .hgbranches. |
Future development could add other fields to `.hgbranches`, such as description or owner. |
Line 39: | Line 43: |
CategoryRejectedProposal | CategoryExtensionsByOthers |
Mutable Branches
This extension is not distributed with Mercurial. This extension is currently under development, and not yet ready for use.
Author: Gideon Sireling Repository: http://code.accursoft.com/mutable-branches/ Issue tracker: http://code.accursoft.com/mutable-branches/issues
Contents
1. Overview
The mutable-branches extension allows named branches to be renamed, without rewriting history. This is achieved by separating a branch's identity from its name.
2. Renaming Branches
To start renaming branches, create a file called .hgbranches in the root of the working directory, and check it in. Each line in .hgbranches consists of a space-delimited pair such as oldBranch newBranch. If the branch name contains spaces, it should be quoted.
There are no changes to Mercurial's UI, other than not scolding the user when they create a new branch.
3. Conflicts
If conflicting changes have been made to .hgbranches on different branches, or if it contains conflicting entries, this will be resolved by the same rules that apply to .hgtags.
4. Local Branches
If the user creates a local branch which they do not intend pushing, it can be recorded in .hg/localbranches.
5. Backwards Compatibility
If a branch ID is not recorded in .hgbranches or .hg/localbranches, the ID will be used as the branch name. Thus, existing branches can be used (and renamed) without any modifications. If the branch is renamed, older clients will continue to use the old name.
6. Forwards Compatibility
Future development could add other fields to .hgbranches, such as description or owner.