← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/switch.py

  • Committer: Aaron Bentley
  • Date: 2007-12-12 15:17:13 UTC
  • mto: This revision was merged to the branch mainline in revision 3113.
  • Revision ID: abentley@panoramicfeedback.com-20071212151713-ox5n8rlx8m3nsspy
Add support for reconfiguring repositories into branches or trees

Show diffs side-by-side

added added

removed removed

Lines of Context:
bzrlib/switch.py
 
1
# Copyright (C) 2006, 2007 Canonical Ltd.
 
2
#
 
3
# This program is free software; you can redistribute it and/or modify
 
4
# it under the terms of the GNU General Public License as published by
 
5
# the Free Software Foundation; either version 2 of the License, or
 
6
# (at your option) any later version.
 
7
#
 
8
# This program is distributed in the hope that it will be useful,
 
9
# but WITHOUT ANY WARRANTY; without even the implied warranty of
 
10
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 
11
# GNU General Public License for more details.
 
12
#
 
13
# You should have received a copy of the GNU General Public License
 
14
# along with this program; if not, write to the Free Software
 
15
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
 
16
 
 
17
# Original author: David Allouche
 
18
 
 
19
from bzrlib import errors, merge
 
20
from bzrlib.branch import Branch, BranchFormat, BranchReferenceFormat
 
21
from bzrlib.bzrdir import BzrDir
 
22
from bzrlib.trace import note
 
23
 
 
24
 
 
25
def switch(control_dir, to_branch):
 
26
    """Switch the branch associated with a checkout.
 
27
 
 
28
    :param control_dir: BzrDir of the checkout to change
 
29
    :param to_branch: branch that the checkout is to reference
 
30
    """
 
31
    _check_switch_branch_format(control_dir)
 
32
    _check_pending_merges(control_dir)
 
33
    try:
 
34
        source_repository = control_dir.open_branch().repository
 
35
    except errors.NotBranchError:
 
36
        source_repository = to_branch.repository
 
37
    _set_branch_location(control_dir, to_branch)
 
38
    tree = control_dir.open_workingtree()
 
39
    _update(tree, source_repository)
 
40
 
 
41
 
 
42
def _check_switch_branch_format(control):
 
43
    """Check that the branch format supports the switch operation.
 
44
 
 
45
    Note: Only lightweight checkouts are currently supported.
 
46
    This may change in the future though.
 
47
 
 
48
    :param control: BzrDir of the branch to check
 
49
    """
 
50
    branch_format = BranchFormat.find_format(control)
 
51
    format_string = branch_format.get_format_string()
 
52
    if not format_string.startswith("Bazaar-NG Branch Reference Format "):
 
53
        raise errors.BzrCommandError(
 
54
            'The switch command can only be used on a lightweight checkout.\n'
 
55
            'Expected branch reference, found %s at %s' % (
 
56
            format_string.strip(), control.root_transport.base))
 
57
    if not format_string == BranchReferenceFormat().get_format_string():
 
58
        raise errors.BzrCommandError(
 
59
            'Unsupported: %r' % (format_string.strip(),))        
 
60
 
 
61
 
 
62
def _check_pending_merges(control):
 
63
    """Check that there are no outstanding pending merges before switching.
 
64
 
 
65
    :param control: BzrDir of the branch to check
 
66
    """
 
67
    try:
 
68
        tree = control.open_workingtree()
 
69
    except errors.NotBranchError:
 
70
        # old branch is gone
 
71
        return
 
72
    # XXX: Should the tree be locked for get_parent_ids?
 
73
    existing_pending_merges = tree.get_parent_ids()[1:]
 
74
    if len(existing_pending_merges) > 0:
 
75
        raise errors.BzrCommandError('Pending merges must be '
 
76
            'committed or reverted before using switch.')
 
77
 
 
78
 
 
79
def _set_branch_location(control, to_branch):
 
80
    """Set location value of a branch reference.
 
81
 
 
82
    :param control: BzrDir of the checkout to change
 
83
    :param to_branch: branch that the checkout is to reference
 
84
    """
 
85
    transport = control.get_branch_transport(None)
 
86
    location = transport.put_bytes('location', to_branch.base)
 
87
 
 
88
 
 
89
def _update(tree, source_repository):
 
90
    """Update a working tree to the latest revision of its branch.
 
91
 
 
92
    :param tree: the working tree
 
93
    :param source_repository: repository holding the revisions
 
94
    """
 
95
    tree.lock_tree_write()
 
96
    try:
 
97
        to_branch = tree.branch
 
98
        if tree.last_revision() == to_branch.last_revision():
 
99
            note("Tree is up to date at revision %d.", to_branch.revno())
 
100
            return
 
101
        base_tree = source_repository.revision_tree(tree.last_revision())
 
102
        merge.Merge3Merger(tree, tree, base_tree, to_branch.basis_tree())
 
103
        tree.set_last_revision(to_branch.last_revision())
 
104
        note('Updated to revision %d.' % to_branch.revno())
 
105
    finally:
 
106
        tree.unlock()