49
Bazaar URLs need to have some way to specify a colocated branch other
50
than the current HEAD. Several options have been discussed, each with
51
its own advantages and disadvantages: This was discussed on the mailing
52
list, most notably the use of a ";branch=NAME" suffix as well as a special
53
separation character (+, =, etc), but no final conclusion was reached.
55
https://lists.ubuntu.com/archives/bazaar/2008q4/050105.html
44
Bazaar URLs need to have some way to address colocated branches in
45
directories that contain multiple branches.
47
Per RFC3986 we have picked the comma (",") to allow the specification of
48
colocated branch names. Comma's in path names would have to be
49
urlencoded at first to avoid ambiguity, though perhaps it would be
50
possible to support heuristics later when interpreting user-specified URLs.
52
An example URL would be:
54
bzr://bazaar.launchpad.net/~jelmer/bzr/bzr.dev,colo-urls
56
The segment after the comma will initially be interpreted as a colocated
57
branch name but we would like to keep the option to allow
58
key=value style specifications in the future and DWIM for segments that
59
do not contain an =. Following the RFC the comma would be interpreted within
60
the scope of a path segment. In other words, in the URL:
62
git://git.debian.org/pkg-python-debian/python-debian.git,unstable/README
64
unstable is interpreted as the colocated branch living in the python-debian.git
65
control directory; README is a path inside of the branch.
67
Control directories will also have the notion of an "active" branch. This is
68
the branch that is being used by a working tree, if present and the branch
69
that will be used if no explicit colocated branch is specified. The
70
active branch support makes it easier to deal with existing bzrdirs and
71
is useful when accessing foreign control directories that have the concept
74
A new command 'bzr rmbranch' needs to be added to make it possible to
75
remove colocated branches, as this won't be possible by simple
76
directory removal, at least not of a user-visible directory.
60
BzrDir should support a BzrDir.supports_colocated_branches() call as well as
61
BzrDir.colocated_branches property that contains a colocated branch container,
62
that can be used to add / remove colocated branches as well as change the
63
currently active colocated branch.
67
class ColocatedBranchContainer(object):
69
def get_active_branch_name(self):
70
"""Returns the name of the currently active branch.
72
This can be None if no branch is currently active.
75
def get_active_branch(self):
76
"""Returns the currently active branches' Branch object."""
78
def get_branch(self, name):
79
"""Returns the Branch object for the specified branch."""
81
def available_branches(self):
82
"""Returns a set with the names of the available branches."""
84
def set_active_branch(self, name):
85
"""Set the currently active branch."""
87
def destroy_branch(self, name):
88
"""Destroy the specified branch.
90
This will remove the branch from disk."""
92
If the particular BzrDir implementation doesn't support colocated
93
branches, it can just return a dummy container that just contains a
96
Looms can of course return a container with all their threads.
98
BzrDir.find_branches() should take into account the colocated branches
99
when iterating over its branches.
81
BzrDirFormat will need a supports_colocated_branches property that
82
indicates whether a format supports the creation, removal and accessing of
85
Several methods on BzrDir will need to be updated to take an option branch_name
86
parameter. If this parameter is not specified or None, the active branch
89
The methods that will have to be extended are:
91
* BzrDir.open_branch()
92
* BzrDir.create_branch()
93
* BzrDir.destroy_branch()
94
* BzrDir.get_branch_transport()
96
* BranchFormat.initialise()
99
A new BzrDir.list_branches() method will return all colocated branches
100
present in a control directory.
102
Any URL interpreting methods (e.g. Branch.open) will need to be updated
103
to extract a colocated branch name and need to pass that into the
106
Existing callers of BzrDir.{create,open,destroy}_branch() need to
107
be updated to pass in branch names and optionally be changed to use
108
BzrDir.list_branches().
added
removed
doc/developers/colocated-branches.txt
