|
Size: 1328
Comment: Branch Renaming Proposal
|
Size: 1465
Comment:
|
| Deletions are marked like this. | Additions are marked like this. |
| Line 1: | Line 1: |
| #pragma section-numbers 2 | ## page was renamed from BranchRenaming |
| Line 3: | Line 3: |
| = Branch Renaming = | = Mutable Branches = ''Author: Gideon Sireling |
| Line 5: | Line 6: |
| 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. | Repository: http://code.accursoft.com/mutable-branches/ |
| Line 7: | Line 8: |
| <<TableOfContents>> | Issue tracker: http://code.accursoft.com/mutable-branches/issues'' |
| Line 9: | Line 10: |
| == Visioning Branch Names == | == Overview == |
| Line 11: | Line 12: |
| 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. Renamings are tracked by a file in the working directory. == Installation == Clone the repository to your local hard drive, or simply download [[http://code.accursoft.com/mutable-branches/raw/tip/mutable-branches.py|mutable-branches.py]]. Then add the following to your mercurial.ini: {{{ [extensions] mutable-branches = path/to/mutable-branches.py }}} == 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. |
| Line 15: | Line 31: |
| If the user creates a local branch which they do not intend pushing, it can be recorded in .hg/localbranches. Mercurial should warn the user if they attempt to push a changeset whose branch name is recorded in localbranches, and tell them how to move it to .hgbranches. | If the user creates a local branch which they do not intend pushing, it can be recorded in `.hg/localbranches`. Local renamings override repository renamings. |
| Line 17: | Line 33: |
| == Backwards Compatibility == | == Future Development == |
| Line 19: | Line 35: |
| 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. == Forwards Compatibility == Future development could add other fields to .hgbranches, such as description or owner. |
Other fields could be added to `.hgbranches`, such as the branch's description or owner. |
| Line 26: | Line 37: |
| CategoryNewFeatures CategoryDeveloper | CategoryExtensionsByOthers |
Mutable Branches
Author: Gideon Sireling Repository: http://code.accursoft.com/mutable-branches/ Issue tracker: http://code.accursoft.com/mutable-branches/issues
1. Overview
The mutable-branches extension allows named branches to be renamed, without rewriting history. Renamings are tracked by a file in the working directory.
2. Installation
Clone the repository to your local hard drive, or simply download mutable-branches.py. Then add the following to your mercurial.ini:
[extensions] mutable-branches = path/to/mutable-branches.py
3. 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.
4. Local Branches
If the user creates a local branch which they do not intend pushing, it can be recorded in .hg/localbranches. Local renamings override repository renamings.
5. Future Development
Other fields could be added to .hgbranches, such as the branch's description or owner.