## page was renamed from BranchRenaming
#pragma section-numbers 2

= Mutable Branches =
'''This extension is not distributed with Mercurial.'''

''Author: Gideon Sireling''

Repository: https://github.com/accursoft/mutable-branches

<<TableOfContents>>

== Overview ==

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 [[https://raw.githubusercontent.com/accursoft/mutable-branches/master/mutable-branches.py|mutable-branches.py]]. Then add the following to your ''`mercurial.ini`'' or ''`.hgrc`'':

{{{
[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.

== 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.

== Future Development ==

Other fields could be added to `.hgbranches`, such as the branch's description or owner.
----
CategoryExtensionsByOthers