/brz/remove-bazaar

To get this branch, use:
bzr branch http://gegoxaren.bato24.eu/bzr/brz/remove-bazaar

« back to all changes in this revision

Viewing changes to bzrlib/push.py

  • Committer: mernst at mit
  • Date: 2008-10-16 10:57:16 UTC
  • mto: This revision was merged to the branch mainline in revision 3799.
  • Revision ID: mernst@csail.mit.edu-20081016105716-v8x8n5t2pf7f6uds
Improved documentation of stacked and lightweight branches

These patches improve the User Guide's documentation of stacked and
lightweight branches.

Section "1.2.6 Putting the concepts together" should mention stacked
branches and the difference between them and lightweight branches.  It
should also contain links to further details of the common scenarios.

Section "5.3.4 Getting a lightweight checkout" should mention stacked
branches as an option, and should link to all the options, not just some of
them.  It should also clarify that lightweight only applies to checkouts,
not to arbitrary branches.

Show diffs side-by-side

added added

removed removed

Lines of Context:
bzrlib/push.py
 
1
# Copyright (C) 2008 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
"""UI helper for the push command."""
 
18
 
 
19
from bzrlib import builtins, bzrdir, errors, transport
 
20
from bzrlib.trace import note, warning
 
21
 
 
22
 
 
23
def _show_push_branch(br_from, revision_id, location, to_file, verbose=False,
 
24
    overwrite=False, remember=False, stacked_on=None, create_prefix=False,
 
25
    use_existing_dir=False):
 
26
    """Push a branch to a location.
 
27
 
 
28
    :param br_from: the source branch
 
29
    :param revision_id: the revision-id to push up to
 
30
    :param location: the url of the destination
 
31
    :param to_file: the output stream
 
32
    :param verbose: if True, display more output than normal
 
33
    :param overwrite: if False, a current branch at the destination may not
 
34
        have diverged from the source, otherwise the push fails
 
35
    :param remember: if True, store the location as the push location for
 
36
        the source branch
 
37
    :param stacked_on: the url of the branch, if any, to stack on;
 
38
        if set, only the revisions not in that branch are pushed
 
39
    :param create_prefix: if True, create the necessary parent directories
 
40
        at the destination if they don't already exist
 
41
    :param use_existing_dir: if True, proceed even if the destination
 
42
        directory exists without a current .bzr directory in it
 
43
    """
 
44
    to_transport = transport.get_transport(location)
 
45
    br_to = repository_to = dir_to = None
 
46
    try:
 
47
        dir_to = bzrdir.BzrDir.open_from_transport(to_transport)
 
48
    except errors.NotBranchError:
 
49
        pass # Didn't find anything
 
50
    else:
 
51
        # If we can open a branch, use its direct repository, otherwise see
 
52
        # if there is a repository without a branch.
 
53
        try:
 
54
            br_to = dir_to.open_branch()
 
55
        except errors.NotBranchError:
 
56
            # Didn't find a branch, can we find a repository?
 
57
            try:
 
58
                repository_to = dir_to.find_repository()
 
59
            except errors.NoRepositoryPresent:
 
60
                pass
 
61
        else:
 
62
            # Found a branch, so we must have found a repository
 
63
            repository_to = br_to.repository
 
64
 
 
65
    push_result = None
 
66
    if verbose:
 
67
        old_rh = []
 
68
    if dir_to is None:
 
69
        # The destination doesn't exist; create it.
 
70
        # XXX: Refactor the create_prefix/no_create_prefix code into a
 
71
        #      common helper function
 
72
 
 
73
        def make_directory(transport):
 
74
            transport.mkdir('.')
 
75
            return transport
 
76
 
 
77
        def redirected(redirected_transport, e, redirection_notice):
 
78
            return transport.get_transport(e.get_target_url())
 
79
 
 
80
        try:
 
81
            to_transport = transport.do_catching_redirections(
 
82
                make_directory, to_transport, redirected)
 
83
        except errors.FileExists:
 
84
            if not use_existing_dir:
 
85
                raise errors.BzrCommandError("Target directory %s"
 
86
                     " already exists, but does not have a valid .bzr"
 
87
                     " directory. Supply --use-existing-dir to push"
 
88
                     " there anyway." % location)
 
89
        except errors.NoSuchFile:
 
90
            if not create_prefix:
 
91
                raise errors.BzrCommandError("Parent directory of %s"
 
92
                    " does not exist."
 
93
                    "\nYou may supply --create-prefix to create all"
 
94
                    " leading parent directories."
 
95
                    % location)
 
96
            builtins._create_prefix(to_transport)
 
97
        except errors.TooManyRedirections:
 
98
            raise errors.BzrCommandError("Too many redirections trying "
 
99
                                         "to make %s." % location)
 
100
 
 
101
        # Now the target directory exists, but doesn't have a .bzr
 
102
        # directory. So we need to create it, along with any work to create
 
103
        # all of the dependent branches, etc.
 
104
        dir_to = br_from.bzrdir.clone_on_transport(to_transport,
 
105
            revision_id=revision_id, stacked_on=stacked_on)
 
106
        br_to = dir_to.open_branch()
 
107
        # TODO: Some more useful message about what was copied
 
108
        try:
 
109
            finally_stacked_on = br_to.get_stacked_on_url()
 
110
        except (errors.UnstackableBranchFormat,
 
111
                errors.UnstackableRepositoryFormat,
 
112
                errors.NotStacked):
 
113
            finally_stacked_on = None
 
114
        if finally_stacked_on is not None:
 
115
            note('Created new stacked branch referring to %s.' %
 
116
                 finally_stacked_on)
 
117
        else:
 
118
            note('Created new branch.')
 
119
        # We successfully created the target, remember it
 
120
        if br_from.get_push_location() is None or remember:
 
121
            br_from.set_push_location(br_to.base)
 
122
    elif repository_to is None:
 
123
        # we have a bzrdir but no branch or repository
 
124
        # XXX: Figure out what to do other than complain.
 
125
        raise errors.BzrCommandError("At %s you have a valid .bzr control"
 
126
            " directory, but not a branch or repository. This is an"
 
127
            " unsupported configuration. Please move the target directory"
 
128
            " out of the way and try again."
 
129
            % location)
 
130
    elif br_to is None:
 
131
        # We have a repository but no branch, copy the revisions, and then
 
132
        # create a branch.
 
133
        if stacked_on is not None:
 
134
            warning("Ignoring request for a stacked branch as repository "
 
135
                    "already exists at the destination location.")
 
136
        repository_to.fetch(br_from.repository, revision_id=revision_id)
 
137
        br_to = br_from.clone(dir_to, revision_id=revision_id)
 
138
        note('Created new branch.')
 
139
        if br_from.get_push_location() is None or remember:
 
140
            br_from.set_push_location(br_to.base)
 
141
    else: # We have a valid to branch
 
142
        if stacked_on is not None:
 
143
            warning("Ignoring request for a stacked branch as branch "
 
144
                    "already exists at the destination location.")
 
145
        # We were able to connect to the remote location, so remember it.
 
146
        # (We don't need to successfully push because of possible divergence.)
 
147
        if br_from.get_push_location() is None or remember:
 
148
            br_from.set_push_location(br_to.base)
 
149
        if verbose:
 
150
            old_rh = br_to.revision_history()
 
151
        try:
 
152
            try:
 
153
                tree_to = dir_to.open_workingtree()
 
154
            except errors.NotLocalUrl:
 
155
                warning("This transport does not update the working " 
 
156
                        "tree of: %s. See 'bzr help working-trees' for "
 
157
                        "more information." % br_to.base)
 
158
                push_result = br_from.push(br_to, overwrite,
 
159
                                           stop_revision=revision_id)
 
160
            except errors.NoWorkingTree:
 
161
                push_result = br_from.push(br_to, overwrite,
 
162
                                           stop_revision=revision_id)
 
163
            else:
 
164
                tree_to.lock_write()
 
165
                try:
 
166
                    push_result = br_from.push(tree_to.branch, overwrite,
 
167
                                               stop_revision=revision_id)
 
168
                    tree_to.update()
 
169
                finally:
 
170
                    tree_to.unlock()
 
171
        except errors.DivergedBranches:
 
172
            raise errors.BzrCommandError('These branches have diverged.'
 
173
                                    '  Try using "merge" and then "push".')
 
174
    if push_result is not None:
 
175
        push_result.report(to_file)
 
176
    elif verbose:
 
177
        new_rh = br_to.revision_history()
 
178
        if old_rh != new_rh:
 
179
            # Something changed
 
180
            from bzrlib.log import show_changed_revisions
 
181
            show_changed_revisions(br_to, old_rh, new_rh,
 
182
                                   to_file=to_file)
 
183
    else:
 
184
        # we probably did a clone rather than a push, so a message was
 
185
        # emitted above
 
186
        pass