← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/switch.py

  • Committer: Canonical.com Patch Queue Manager
  • Date: 2010-02-12 16:32:06 UTC
  • mfrom: (5031.2.2 checkouts-help)
  • Revision ID: pqm@pqm.ubuntu.com-20100212163206-uvs9ck67uqw2901y
(Matthew Fuller) Update docs for using 'switch' with a checkout

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., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
 
16
 
 
17
# Original author: David Allouche
 
18
 
 
19
from bzrlib import errors, merge, revision
 
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, force=False, quiet=False, revision_id=None):
 
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
    :param force: skip the check for local commits in a heavy checkout
 
31
    :param revision_id: revision ID to switch to.
 
32
    """
 
33
    _check_pending_merges(control_dir, force)
 
34
    try:
 
35
        source_repository = control_dir.open_branch().repository
 
36
    except errors.NotBranchError:
 
37
        source_repository = to_branch.repository
 
38
    _set_branch_location(control_dir, to_branch, force)
 
39
    tree = control_dir.open_workingtree()
 
40
    _update(tree, source_repository, quiet, revision_id)
 
41
 
 
42
 
 
43
def _check_pending_merges(control, force=False):
 
44
    """Check that there are no outstanding pending merges before switching.
 
45
 
 
46
    :param control: BzrDir of the branch to check
 
47
    """
 
48
    try:
 
49
        tree = control.open_workingtree()
 
50
    except errors.NotBranchError, ex:
 
51
        # Lightweight checkout and branch is no longer there
 
52
        if force:
 
53
            return
 
54
        else:
 
55
            raise ex
 
56
    # XXX: Should the tree be locked for get_parent_ids?
 
57
    existing_pending_merges = tree.get_parent_ids()[1:]
 
58
    if len(existing_pending_merges) > 0:
 
59
        raise errors.BzrCommandError('Pending merges must be '
 
60
            'committed or reverted before using switch.')
 
61
 
 
62
 
 
63
def _set_branch_location(control, to_branch, force=False):
 
64
    """Set location value of a branch reference.
 
65
 
 
66
    :param control: BzrDir of the checkout to change
 
67
    :param to_branch: branch that the checkout is to reference
 
68
    :param force: skip the check for local commits in a heavy checkout
 
69
    """
 
70
    branch_format = control.find_branch_format()
 
71
    if branch_format.get_reference(control) is not None:
 
72
        # Lightweight checkout: update the branch reference
 
73
        branch_format.set_reference(control, to_branch)
 
74
    else:
 
75
        b = control.open_branch()
 
76
        bound_branch = b.get_bound_location()
 
77
        if bound_branch is not None:
 
78
            # Heavyweight checkout: check all local commits
 
79
            # have been pushed to the current bound branch then
 
80
            # synchronise the local branch with the new remote branch
 
81
            # and bind to it
 
82
            possible_transports = []
 
83
            try:
 
84
                if not force and _any_local_commits(b, possible_transports):
 
85
                    raise errors.BzrCommandError(
 
86
                        'Cannot switch as local commits found in the checkout. '
 
87
                        'Commit these to the bound branch or use --force to '
 
88
                        'throw them away.')
 
89
            except errors.BoundBranchConnectionFailure, e:
 
90
                raise errors.BzrCommandError(
 
91
                        'Unable to connect to current master branch %(target)s: '
 
92
                        '%(error)s To switch anyway, use --force.' %
 
93
                        e.__dict__)
 
94
            b.set_bound_location(None)
 
95
            b.pull(to_branch, overwrite=True,
 
96
                possible_transports=possible_transports)
 
97
            b.set_bound_location(to_branch.base)
 
98
        else:
 
99
            raise errors.BzrCommandError('Cannot switch a branch, '
 
100
                'only a checkout.')
 
101
 
 
102
 
 
103
def _any_local_commits(this_branch, possible_transports):
 
104
    """Does this branch have any commits not in the master branch?"""
 
105
    last_rev = revision.ensure_null(this_branch.last_revision())
 
106
    if last_rev != revision.NULL_REVISION:
 
107
        other_branch = this_branch.get_master_branch(possible_transports)
 
108
        this_branch.lock_read()
 
109
        other_branch.lock_read()
 
110
        try:
 
111
            other_last_rev = other_branch.last_revision()
 
112
            graph = this_branch.repository.get_graph(
 
113
                other_branch.repository)
 
114
            if not graph.is_ancestor(last_rev, other_last_rev):
 
115
                return True
 
116
        finally:
 
117
            other_branch.unlock()
 
118
            this_branch.unlock()
 
119
    return False
 
120
 
 
121
 
 
122
def _update(tree, source_repository, quiet=False, revision_id=None):
 
123
    """Update a working tree to the latest revision of its branch.
 
124
 
 
125
    :param tree: the working tree
 
126
    :param source_repository: repository holding the revisions
 
127
    """
 
128
    tree.lock_tree_write()
 
129
    try:
 
130
        to_branch = tree.branch
 
131
        if revision_id is None:
 
132
            revision_id = to_branch.last_revision()
 
133
        if tree.last_revision() == revision_id:
 
134
            if not quiet:
 
135
                note("Tree is up to date at revision %d.", to_branch.revno())
 
136
            return
 
137
        base_tree = source_repository.revision_tree(tree.last_revision())
 
138
        merge.Merge3Merger(tree, tree, base_tree, to_branch.repository.revision_tree(revision_id))
 
139
        tree.set_last_revision(to_branch.last_revision())
 
140
        if not quiet:
 
141
            note('Updated to revision %d.' % to_branch.revno())
 
142
    finally:
 
143
        tree.unlock()