← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/builtins.py

  • Committer: Patch Queue Manager
  • Date: 2012-04-10 10:26:46 UTC
  • mfrom: (6519.1.2 responsefile-readline)
  • Revision ID: pqm@pqm.ubuntu.com-20120410102646-rv7zpi85e168o1k4
(jelmer) Implement ResponseFile.readline. (Jelmer Vernooij)

Show diffs side-by-side

added added

removed removed

Lines of Context:
bzrlib/builtins.py
1
 
# Copyright (C) 2004, 2005, 2006, 2007 Canonical Ltd
 
1
# Copyright (C) 2005-2012 Canonical Ltd
2
2
#
3
3
# This program is free software; you can redistribute it and/or modify
4
4
# it under the terms of the GNU General Public License as published by
12
12
#
13
13
# You should have received a copy of the GNU General Public License
14
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
 
15
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
16
16
 
17
17
"""builtin bzr commands"""
18
18
 
 
19
from __future__ import absolute_import
 
20
 
19
21
import os
20
 
from StringIO import StringIO
21
 
 
22
 
from bzrlib.lazy_import import lazy_import
23
 
lazy_import(globals(), """
24
 
import codecs
 
22
 
 
23
import bzrlib.bzrdir
 
24
 
 
25
from bzrlib import lazy_import
 
26
lazy_import.lazy_import(globals(), """
 
27
import cStringIO
25
28
import errno
26
29
import sys
27
 
import tempfile
28
30
import time
29
31
 
30
32
import bzrlib
31
33
from bzrlib import (
32
 
    branch,
33
34
    bugtracker,
34
35
    bundle,
35
 
    bzrdir,
 
36
    btree_index,
 
37
    controldir,
 
38
    directory_service,
36
39
    delta,
37
 
    config,
 
40
    config as _mod_config,
38
41
    errors,
39
42
    globbing,
40
 
    ignores,
 
43
    hooks,
41
44
    log,
42
45
    merge as _mod_merge,
43
46
    merge_directive,
44
47
    osutils,
45
 
    registry,
46
 
    repository,
47
 
    revisionspec,
48
 
    symbol_versioning,
 
48
    reconfigure,
 
49
    rename_map,
 
50
    revision as _mod_revision,
 
51
    static_tuple,
 
52
    timestamp,
49
53
    transport,
50
 
    tree as _mod_tree,
51
54
    ui,
52
55
    urlutils,
 
56
    views,
 
57
    gpg,
53
58
    )
54
59
from bzrlib.branch import Branch
55
 
from bzrlib.bundle.apply_bundle import install_bundle, merge_bundle
56
60
from bzrlib.conflicts import ConflictList
57
 
from bzrlib.revisionspec import RevisionSpec
 
61
from bzrlib.transport import memory
 
62
from bzrlib.revisionspec import RevisionSpec, RevisionInfo
58
63
from bzrlib.smtp_connection import SMTPConnection
59
64
from bzrlib.workingtree import WorkingTree
 
65
from bzrlib.i18n import gettext, ngettext
60
66
""")
61
67
 
62
 
from bzrlib.commands import Command, display_command
63
 
from bzrlib.option import ListOption, Option, RegistryOption
64
 
from bzrlib.progress import DummyProgress, ProgressPhase
65
 
from bzrlib.trace import mutter, note, log_error, warning, is_quiet, info
66
 
 
67
 
 
68
 
def tree_files(file_list, default_branch=u'.'):
69
 
    try:
70
 
        return internal_tree_files(file_list, default_branch)
71
 
    except errors.FileInWrongBranch, e:
72
 
        raise errors.BzrCommandError("%s is not in the same branch as %s" %
73
 
                                     (e.path, file_list[0]))
74
 
 
75
 
 
76
 
# XXX: Bad function name; should possibly also be a class method of
77
 
# WorkingTree rather than a function.
78
 
def internal_tree_files(file_list, default_branch=u'.'):
79
 
    """Convert command-line paths to a WorkingTree and relative paths.
80
 
 
81
 
    This is typically used for command-line processors that take one or
82
 
    more filenames, and infer the workingtree that contains them.
83
 
 
84
 
    The filenames given are not required to exist.
85
 
 
86
 
    :param file_list: Filenames to convert.  
87
 
 
88
 
    :param default_branch: Fallback tree path to use if file_list is empty or
89
 
        None.
90
 
 
91
 
    :return: workingtree, [relative_paths]
92
 
    """
93
 
    if file_list is None or len(file_list) == 0:
94
 
        return WorkingTree.open_containing(default_branch)[0], file_list
95
 
    tree = WorkingTree.open_containing(osutils.realpath(file_list[0]))[0]
96
 
    new_list = []
97
 
    for filename in file_list:
98
 
        try:
99
 
            new_list.append(tree.relpath(osutils.dereference_path(filename)))
100
 
        except errors.PathNotChild:
101
 
            raise errors.FileInWrongBranch(tree.branch, filename)
102
 
    return tree, new_list
103
 
 
104
 
 
105
 
@symbol_versioning.deprecated_function(symbol_versioning.zero_fifteen)
106
 
def get_format_type(typestring):
107
 
    """Parse and return a format specifier."""
108
 
    # Have to use BzrDirMetaFormat1 directly, so that
109
 
    # RepositoryFormat.set_default_format works
110
 
    if typestring == "default":
111
 
        return bzrdir.BzrDirMetaFormat1()
112
 
    try:
113
 
        return bzrdir.format_registry.make_bzrdir(typestring)
114
 
    except KeyError:
115
 
        msg = 'Unknown bzr format "%s". See "bzr help formats".' % typestring
116
 
        raise errors.BzrCommandError(msg)
 
68
from bzrlib.commands import (
 
69
    Command,
 
70
    builtin_command_registry,
 
71
    display_command,
 
72
    )
 
73
from bzrlib.option import (
 
74
    ListOption,
 
75
    Option,
 
76
    RegistryOption,
 
77
    custom_help,
 
78
    _parse_revision_str,
 
79
    )
 
80
from bzrlib.trace import mutter, note, warning, is_quiet, get_verbosity_level
 
81
from bzrlib import (
 
82
    symbol_versioning,
 
83
    )
 
84
 
 
85
 
 
86
def _get_branch_location(control_dir, possible_transports=None):
 
87
    """Return location of branch for this control dir."""
 
88
    try:
 
89
        target = control_dir.get_branch_reference()
 
90
    except errors.NotBranchError:
 
91
        return control_dir.root_transport.base
 
92
    if target is not None:
 
93
        return target
 
94
    this_branch = control_dir.open_branch(
 
95
        possible_transports=possible_transports)
 
96
    # This may be a heavy checkout, where we want the master branch
 
97
    master_location = this_branch.get_bound_location()
 
98
    if master_location is not None:
 
99
        return master_location
 
100
    # If not, use a local sibling
 
101
    return this_branch.base
 
102
 
 
103
 
 
104
def _is_colocated(control_dir, possible_transports=None):
 
105
    """Check if the branch in control_dir is colocated.
 
106
 
 
107
    :param control_dir: Control directory
 
108
    :return: Tuple with boolean indicating whether the branch is colocated
 
109
        and the full URL to the actual branch
 
110
    """
 
111
    # This path is meant to be relative to the existing branch
 
112
    this_url = _get_branch_location(control_dir,
 
113
        possible_transports=possible_transports)
 
114
    # Perhaps the target control dir supports colocated branches?
 
115
    try:
 
116
        root = controldir.ControlDir.open(this_url,
 
117
            possible_transports=possible_transports)
 
118
    except errors.NotBranchError:
 
119
        return (False, this_url)
 
120
    else:
 
121
        try:
 
122
            wt = control_dir.open_workingtree()
 
123
        except (errors.NoWorkingTree, errors.NotLocalUrl):
 
124
            return (False, this_url)
 
125
        else:
 
126
            return (
 
127
                root._format.colocated_branches and
 
128
                control_dir.control_url == root.control_url,
 
129
                this_url)
 
130
 
 
131
 
 
132
def lookup_new_sibling_branch(control_dir, location, possible_transports=None):
 
133
    """Lookup the location for a new sibling branch.
 
134
 
 
135
    :param control_dir: Control directory to find sibling branches from
 
136
    :param location: Name of the new branch
 
137
    :return: Full location to the new branch
 
138
    """
 
139
    location = directory_service.directories.dereference(location)
 
140
    if '/' not in location and '\\' not in location:
 
141
        (colocated, this_url) = _is_colocated(control_dir, possible_transports)
 
142
 
 
143
        if colocated:
 
144
            return urlutils.join_segment_parameters(this_url,
 
145
                {"branch": urlutils.escape(location)})
 
146
        else:
 
147
            return urlutils.join(this_url, '..', urlutils.escape(location))
 
148
    return location
 
149
 
 
150
 
 
151
def open_sibling_branch(control_dir, location, possible_transports=None):
 
152
    """Open a branch, possibly a sibling of another.
 
153
 
 
154
    :param control_dir: Control directory relative to which to lookup the
 
155
        location.
 
156
    :param location: Location to look up
 
157
    :return: branch to open
 
158
    """
 
159
    try:
 
160
        # Perhaps it's a colocated branch?
 
161
        return control_dir.open_branch(location, 
 
162
            possible_transports=possible_transports)
 
163
    except (errors.NotBranchError, errors.NoColocatedBranchSupport):
 
164
        this_url = _get_branch_location(control_dir)
 
165
        return Branch.open(
 
166
            urlutils.join(
 
167
                this_url, '..', urlutils.escape(location)))
 
168
 
 
169
 
 
170
def open_nearby_branch(near=None, location=None, possible_transports=None):
 
171
    """Open a nearby branch.
 
172
 
 
173
    :param near: Optional location of container from which to open branch
 
174
    :param location: Location of the branch
 
175
    :return: Branch instance
 
176
    """
 
177
    if near is None:
 
178
        if location is None:
 
179
            location = "."
 
180
        try:
 
181
            return Branch.open(location,
 
182
                possible_transports=possible_transports)
 
183
        except errors.NotBranchError:
 
184
            near = "."
 
185
    cdir = controldir.ControlDir.open(near,
 
186
        possible_transports=possible_transports)
 
187
    return open_sibling_branch(cdir, location,
 
188
        possible_transports=possible_transports)
 
189
 
 
190
 
 
191
def iter_sibling_branches(control_dir, possible_transports=None):
 
192
    """Iterate over the siblings of a branch.
 
193
 
 
194
    :param control_dir: Control directory for which to look up the siblings
 
195
    :return: Iterator over tuples with branch name and branch object
 
196
    """
 
197
    seen_urls = set()
 
198
    try:
 
199
        reference = control_dir.get_branch_reference()
 
200
    except errors.NotBranchError:
 
201
        # There is no active branch, just return the colocated branches.
 
202
        for name, branch in control_dir.get_branches().iteritems():
 
203
            yield name, branch
 
204
        return
 
205
    if reference is not None:
 
206
        ref_branch = Branch.open(reference,
 
207
            possible_transports=possible_transports)
 
208
    else:
 
209
        ref_branch = None
 
210
    if ref_branch is None or ref_branch.name:
 
211
        if ref_branch is not None:
 
212
            control_dir = ref_branch.bzrdir
 
213
        for name, branch in control_dir.get_branches().iteritems():
 
214
            yield name, branch
 
215
    else:
 
216
        repo = ref_branch.bzrdir.find_repository()
 
217
        for branch in repo.find_branches(using=True):
 
218
            name = urlutils.relative_url(repo.user_url,
 
219
                branch.user_url).rstrip("/")
 
220
            yield name, branch
 
221
 
 
222
 
 
223
def tree_files_for_add(file_list):
 
224
    """
 
225
    Return a tree and list of absolute paths from a file list.
 
226
 
 
227
    Similar to tree_files, but add handles files a bit differently, so it a
 
228
    custom implementation.  In particular, MutableTreeTree.smart_add expects
 
229
    absolute paths, which it immediately converts to relative paths.
 
230
    """
 
231
    # FIXME Would be nice to just return the relative paths like
 
232
    # internal_tree_files does, but there are a large number of unit tests
 
233
    # that assume the current interface to mutabletree.smart_add
 
234
    if file_list:
 
235
        tree, relpath = WorkingTree.open_containing(file_list[0])
 
236
        if tree.supports_views():
 
237
            view_files = tree.views.lookup_view()
 
238
            if view_files:
 
239
                for filename in file_list:
 
240
                    if not osutils.is_inside_any(view_files, filename):
 
241
                        raise errors.FileOutsideView(filename, view_files)
 
242
        file_list = file_list[:]
 
243
        file_list[0] = tree.abspath(relpath)
 
244
    else:
 
245
        tree = WorkingTree.open_containing(u'.')[0]
 
246
        if tree.supports_views():
 
247
            view_files = tree.views.lookup_view()
 
248
            if view_files:
 
249
                file_list = view_files
 
250
                view_str = views.view_display_str(view_files)
 
251
                note(gettext("Ignoring files outside view. View is %s") % view_str)
 
252
    return tree, file_list
 
253
 
 
254
 
 
255
def _get_one_revision(command_name, revisions):
 
256
    if revisions is None:
 
257
        return None
 
258
    if len(revisions) != 1:
 
259
        raise errors.BzrCommandError(gettext(
 
260
            'bzr %s --revision takes exactly one revision identifier') % (
 
261
                command_name,))
 
262
    return revisions[0]
 
263
 
 
264
 
 
265
def _get_one_revision_tree(command_name, revisions, branch=None, tree=None):
 
266
    """Get a revision tree. Not suitable for commands that change the tree.
 
267
    
 
268
    Specifically, the basis tree in dirstate trees is coupled to the dirstate
 
269
    and doing a commit/uncommit/pull will at best fail due to changing the
 
270
    basis revision data.
 
271
 
 
272
    If tree is passed in, it should be already locked, for lifetime management
 
273
    of the trees internal cached state.
 
274
    """
 
275
    if branch is None:
 
276
        branch = tree.branch
 
277
    if revisions is None:
 
278
        if tree is not None:
 
279
            rev_tree = tree.basis_tree()
 
280
        else:
 
281
            rev_tree = branch.basis_tree()
 
282
    else:
 
283
        revision = _get_one_revision(command_name, revisions)
 
284
        rev_tree = revision.as_tree(branch)
 
285
    return rev_tree
 
286
 
 
287
 
 
288
def _get_view_info_for_change_reporter(tree):
 
289
    """Get the view information from a tree for change reporting."""
 
290
    view_info = None
 
291
    try:
 
292
        current_view = tree.views.get_view_info()[0]
 
293
        if current_view is not None:
 
294
            view_info = (current_view, tree.views.lookup_view())
 
295
    except errors.ViewsNotSupported:
 
296
        pass
 
297
    return view_info
 
298
 
 
299
 
 
300
def _open_directory_or_containing_tree_or_branch(filename, directory):
 
301
    """Open the tree or branch containing the specified file, unless
 
302
    the --directory option is used to specify a different branch."""
 
303
    if directory is not None:
 
304
        return (None, Branch.open(directory), filename)
 
305
    return controldir.ControlDir.open_containing_tree_or_branch(filename)
117
306
 
118
307
 
119
308
# TODO: Make sure no commands unconditionally use the working directory as a
123
312
# opens the branch?)
124
313
 
125
314
class cmd_status(Command):
126
 
    """Display status summary.
 
315
    __doc__ = """Display status summary.
127
316
 
128
317
    This reports on versioned and unknown files, reporting them
129
318
    grouped by state.  Possible states are:
149
338
    unknown
150
339
        Not versioned and not matching an ignore pattern.
151
340
 
 
341
    Additionally for directories, symlinks and files with a changed
 
342
    executable bit, Bazaar indicates their type using a trailing
 
343
    character: '/', '@' or '*' respectively. These decorations can be
 
344
    disabled using the '--no-classify' option.
 
345
 
152
346
    To see ignored files use 'bzr ignored'.  For details on the
153
347
    changes to file texts, use 'bzr diff'.
154
 
    
155
 
    --short gives a status flags for each item, similar to the SVN's status
156
 
    command.
 
348
 
 
349
    Note that --short or -S gives status flags for each item, similar
 
350
    to Subversion's status command. To get output similar to svn -q,
 
351
    use bzr status -SV.
157
352
 
158
353
    If no arguments are specified, the status of the entire working
159
354
    directory is shown.  Otherwise, only the status of the specified
160
355
    files or directories is reported.  If a directory is given, status
161
356
    is reported for everything inside that directory.
162
357
 
163
 
    If a revision argument is given, the status is calculated against
164
 
    that revision, or between two revisions if two are provided.
 
358
    Before merges are committed, the pending merge tip revisions are
 
359
    shown. To see all pending merge revisions, use the -v option.
 
360
    To skip the display of pending merge information altogether, use
 
361
    the no-pending option or specify a file/directory.
 
362
 
 
363
    To compare the working directory to a specific revision, pass a
 
364
    single revision to the revision argument.
 
365
 
 
366
    To see which files have changed in a specific revision, or between
 
367
    two revisions, pass a revision range to the revision argument.
 
368
    This will produce the same results as calling 'bzr diff --summarize'.
165
369
    """
166
 
    
167
 
    # TODO: --no-recurse, --recurse options
168
 
    
 
370
 
 
371
    # TODO: --no-recurse/-N, --recurse options
 
372
 
169
373
    takes_args = ['file*']
170
 
    takes_options = ['show-ids', 'revision',
171
 
                     Option('short', help='Give short SVN-style status lines'),
172
 
                     Option('versioned', help='Only show versioned files')]
 
374
    takes_options = ['show-ids', 'revision', 'change', 'verbose',
 
375
                     Option('short', help='Use short status indicators.',
 
376
                            short_name='S'),
 
377
                     Option('versioned', help='Only show versioned files.',
 
378
                            short_name='V'),
 
379
                     Option('no-pending', help='Don\'t show pending merges.',
 
380
                           ),
 
381
                     Option('no-classify',
 
382
                            help='Do not mark object type using indicator.',
 
383
                           ),
 
384
                     ]
173
385
    aliases = ['st', 'stat']
174
386
 
175
387
    encoding_type = 'replace'
176
388
    _see_also = ['diff', 'revert', 'status-flags']
177
 
    
 
389
 
178
390
    @display_command
179
391
    def run(self, show_ids=False, file_list=None, revision=None, short=False,
180
 
            versioned=False):
 
392
            versioned=False, no_pending=False, verbose=False,
 
393
            no_classify=False):
181
394
        from bzrlib.status import show_tree_status
182
395
 
183
 
        tree, file_list = tree_files(file_list)
184
 
            
 
396
        if revision and len(revision) > 2:
 
397
            raise errors.BzrCommandError(gettext('bzr status --revision takes exactly'
 
398
                                         ' one or two revision specifiers'))
 
399
 
 
400
        tree, relfile_list = WorkingTree.open_containing_paths(file_list)
 
401
        # Avoid asking for specific files when that is not needed.
 
402
        if relfile_list == ['']:
 
403
            relfile_list = None
 
404
            # Don't disable pending merges for full trees other than '.'.
 
405
            if file_list == ['.']:
 
406
                no_pending = True
 
407
        # A specific path within a tree was given.
 
408
        elif relfile_list is not None:
 
409
            no_pending = True
185
410
        show_tree_status(tree, show_ids=show_ids,
186
 
                         specific_files=file_list, revision=revision,
187
 
                         to_file=self.outf, short=short, versioned=versioned)
 
411
                         specific_files=relfile_list, revision=revision,
 
412
                         to_file=self.outf, short=short, versioned=versioned,
 
413
                         show_pending=(not no_pending), verbose=verbose,
 
414
                         classify=not no_classify)
188
415
 
189
416
 
190
417
class cmd_cat_revision(Command):
191
 
    """Write out metadata for a revision.
192
 
    
 
418
    __doc__ = """Write out metadata for a revision.
 
419
 
193
420
    The revision to print can either be specified by a specific
194
421
    revision identifier, or you can use --revision.
195
422
    """
196
423
 
197
424
    hidden = True
198
425
    takes_args = ['revision_id?']
199
 
    takes_options = ['revision']
 
426
    takes_options = ['directory', 'revision']
200
427
    # cat-revision is more for frontends so should be exact
201
428
    encoding = 'strict'
202
 
    
 
429
 
 
430
    def print_revision(self, revisions, revid):
 
431
        stream = revisions.get_record_stream([(revid,)], 'unordered', True)
 
432
        record = stream.next()
 
433
        if record.storage_kind == 'absent':
 
434
            raise errors.NoSuchRevision(revisions, revid)
 
435
        revtext = record.get_bytes_as('fulltext')
 
436
        self.outf.write(revtext.decode('utf-8'))
 
437
 
203
438
    @display_command
204
 
    def run(self, revision_id=None, revision=None):
205
 
 
206
 
        revision_id = osutils.safe_revision_id(revision_id, warn=False)
 
439
    def run(self, revision_id=None, revision=None, directory=u'.'):
207
440
        if revision_id is not None and revision is not None:
208
 
            raise errors.BzrCommandError('You can only supply one of'
209
 
                                         ' revision_id or --revision')
 
441
            raise errors.BzrCommandError(gettext('You can only supply one of'
 
442
                                         ' revision_id or --revision'))
210
443
        if revision_id is None and revision is None:
211
 
            raise errors.BzrCommandError('You must supply either'
212
 
                                         ' --revision or a revision_id')
213
 
        b = WorkingTree.open_containing(u'.')[0].branch
214
 
 
215
 
        # TODO: jam 20060112 should cat-revision always output utf-8?
216
 
        if revision_id is not None:
217
 
            self.outf.write(b.repository.get_revision_xml(revision_id).decode('utf-8'))
218
 
        elif revision is not None:
219
 
            for rev in revision:
220
 
                if rev is None:
221
 
                    raise errors.BzrCommandError('You cannot specify a NULL'
222
 
                                                 ' revision.')
223
 
                revno, rev_id = rev.in_history(b)
224
 
                self.outf.write(b.repository.get_revision_xml(rev_id).decode('utf-8'))
225
 
    
 
444
            raise errors.BzrCommandError(gettext('You must supply either'
 
445
                                         ' --revision or a revision_id'))
 
446
 
 
447
        b = controldir.ControlDir.open_containing_tree_or_branch(directory)[1]
 
448
 
 
449
        revisions = b.repository.revisions
 
450
        if revisions is None:
 
451
            raise errors.BzrCommandError(gettext('Repository %r does not support '
 
452
                'access to raw revision texts'))
 
453
 
 
454
        b.repository.lock_read()
 
455
        try:
 
456
            # TODO: jam 20060112 should cat-revision always output utf-8?
 
457
            if revision_id is not None:
 
458
                revision_id = osutils.safe_revision_id(revision_id, warn=False)
 
459
                try:
 
460
                    self.print_revision(revisions, revision_id)
 
461
                except errors.NoSuchRevision:
 
462
                    msg = gettext("The repository {0} contains no revision {1}.").format(
 
463
                        b.repository.base, revision_id)
 
464
                    raise errors.BzrCommandError(msg)
 
465
            elif revision is not None:
 
466
                for rev in revision:
 
467
                    if rev is None:
 
468
                        raise errors.BzrCommandError(
 
469
                            gettext('You cannot specify a NULL revision.'))
 
470
                    rev_id = rev.as_revision_id(b)
 
471
                    self.print_revision(revisions, rev_id)
 
472
        finally:
 
473
            b.repository.unlock()
 
474
        
 
475
 
 
476
class cmd_dump_btree(Command):
 
477
    __doc__ = """Dump the contents of a btree index file to stdout.
 
478
 
 
479
    PATH is a btree index file, it can be any URL. This includes things like
 
480
    .bzr/repository/pack-names, or .bzr/repository/indices/a34b3a...ca4a4.iix
 
481
 
 
482
    By default, the tuples stored in the index file will be displayed. With
 
483
    --raw, we will uncompress the pages, but otherwise display the raw bytes
 
484
    stored in the index.
 
485
    """
 
486
 
 
487
    # TODO: Do we want to dump the internal nodes as well?
 
488
    # TODO: It would be nice to be able to dump the un-parsed information,
 
489
    #       rather than only going through iter_all_entries. However, this is
 
490
    #       good enough for a start
 
491
    hidden = True
 
492
    encoding_type = 'exact'
 
493
    takes_args = ['path']
 
494
    takes_options = [Option('raw', help='Write the uncompressed bytes out,'
 
495
                                        ' rather than the parsed tuples.'),
 
496
                    ]
 
497
 
 
498
    def run(self, path, raw=False):
 
499
        dirname, basename = osutils.split(path)
 
500
        t = transport.get_transport(dirname)
 
501
        if raw:
 
502
            self._dump_raw_bytes(t, basename)
 
503
        else:
 
504
            self._dump_entries(t, basename)
 
505
 
 
506
    def _get_index_and_bytes(self, trans, basename):
 
507
        """Create a BTreeGraphIndex and raw bytes."""
 
508
        bt = btree_index.BTreeGraphIndex(trans, basename, None)
 
509
        bytes = trans.get_bytes(basename)
 
510
        bt._file = cStringIO.StringIO(bytes)
 
511
        bt._size = len(bytes)
 
512
        return bt, bytes
 
513
 
 
514
    def _dump_raw_bytes(self, trans, basename):
 
515
        import zlib
 
516
 
 
517
        # We need to parse at least the root node.
 
518
        # This is because the first page of every row starts with an
 
519
        # uncompressed header.
 
520
        bt, bytes = self._get_index_and_bytes(trans, basename)
 
521
        for page_idx, page_start in enumerate(xrange(0, len(bytes),
 
522
                                                     btree_index._PAGE_SIZE)):
 
523
            page_end = min(page_start + btree_index._PAGE_SIZE, len(bytes))
 
524
            page_bytes = bytes[page_start:page_end]
 
525
            if page_idx == 0:
 
526
                self.outf.write('Root node:\n')
 
527
                header_end, data = bt._parse_header_from_bytes(page_bytes)
 
528
                self.outf.write(page_bytes[:header_end])
 
529
                page_bytes = data
 
530
            self.outf.write('\nPage %d\n' % (page_idx,))
 
531
            if len(page_bytes) == 0:
 
532
                self.outf.write('(empty)\n');
 
533
            else:
 
534
                decomp_bytes = zlib.decompress(page_bytes)
 
535
                self.outf.write(decomp_bytes)
 
536
                self.outf.write('\n')
 
537
 
 
538
    def _dump_entries(self, trans, basename):
 
539
        try:
 
540
            st = trans.stat(basename)
 
541
        except errors.TransportNotPossible:
 
542
            # We can't stat, so we'll fake it because we have to do the 'get()'
 
543
            # anyway.
 
544
            bt, _ = self._get_index_and_bytes(trans, basename)
 
545
        else:
 
546
            bt = btree_index.BTreeGraphIndex(trans, basename, st.st_size)
 
547
        for node in bt.iter_all_entries():
 
548
            # Node is made up of:
 
549
            # (index, key, value, [references])
 
550
            try:
 
551
                refs = node[3]
 
552
            except IndexError:
 
553
                refs_as_tuples = None
 
554
            else:
 
555
                refs_as_tuples = static_tuple.as_tuples(refs)
 
556
            as_tuple = (tuple(node[1]), node[2], refs_as_tuples)
 
557
            self.outf.write('%s\n' % (as_tuple,))
 
558
 
226
559
 
227
560
class cmd_remove_tree(Command):
228
 
    """Remove the working tree from a given branch/checkout.
 
561
    __doc__ = """Remove the working tree from a given branch/checkout.
229
562
 
230
563
    Since a lightweight checkout is little more than a working tree
231
564
    this will refuse to run against one.
233
566
    To re-create the working tree, use "bzr checkout".
234
567
    """
235
568
    _see_also = ['checkout', 'working-trees']
236
 
 
237
 
    takes_args = ['location?']
238
 
 
239
 
    def run(self, location='.'):
240
 
        d = bzrdir.BzrDir.open(location)
241
 
        
 
569
    takes_args = ['location*']
 
570
    takes_options = [
 
571
        Option('force',
 
572
               help='Remove the working tree even if it has '
 
573
                    'uncommitted or shelved changes.'),
 
574
        ]
 
575
 
 
576
    def run(self, location_list, force=False):
 
577
        if not location_list:
 
578
            location_list=['.']
 
579
 
 
580
        for location in location_list:
 
581
            d = controldir.ControlDir.open(location)
 
582
 
 
583
            try:
 
584
                working = d.open_workingtree()
 
585
            except errors.NoWorkingTree:
 
586
                raise errors.BzrCommandError(gettext("No working tree to remove"))
 
587
            except errors.NotLocalUrl:
 
588
                raise errors.BzrCommandError(gettext("You cannot remove the working tree"
 
589
                                             " of a remote path"))
 
590
            if not force:
 
591
                if (working.has_changes()):
 
592
                    raise errors.UncommittedChanges(working)
 
593
                if working.get_shelf_manager().last_shelf() is not None:
 
594
                    raise errors.ShelvedChanges(working)
 
595
 
 
596
            if working.user_url != working.branch.user_url:
 
597
                raise errors.BzrCommandError(gettext("You cannot remove the working tree"
 
598
                                             " from a lightweight checkout"))
 
599
 
 
600
            d.destroy_workingtree()
 
601
 
 
602
 
 
603
class cmd_repair_workingtree(Command):
 
604
    __doc__ = """Reset the working tree state file.
 
605
 
 
606
    This is not meant to be used normally, but more as a way to recover from
 
607
    filesystem corruption, etc. This rebuilds the working inventory back to a
 
608
    'known good' state. Any new modifications (adding a file, renaming, etc)
 
609
    will be lost, though modified files will still be detected as such.
 
610
 
 
611
    Most users will want something more like "bzr revert" or "bzr update"
 
612
    unless the state file has become corrupted.
 
613
 
 
614
    By default this attempts to recover the current state by looking at the
 
615
    headers of the state file. If the state file is too corrupted to even do
 
616
    that, you can supply --revision to force the state of the tree.
 
617
    """
 
618
 
 
619
    takes_options = ['revision', 'directory',
 
620
        Option('force',
 
621
               help='Reset the tree even if it doesn\'t appear to be'
 
622
                    ' corrupted.'),
 
623
    ]
 
624
    hidden = True
 
625
 
 
626
    def run(self, revision=None, directory='.', force=False):
 
627
        tree, _ = WorkingTree.open_containing(directory)
 
628
        self.add_cleanup(tree.lock_tree_write().unlock)
 
629
        if not force:
 
630
            try:
 
631
                tree.check_state()
 
632
            except errors.BzrError:
 
633
                pass # There seems to be a real error here, so we'll reset
 
634
            else:
 
635
                # Refuse
 
636
                raise errors.BzrCommandError(gettext(
 
637
                    'The tree does not appear to be corrupt. You probably'
 
638
                    ' want "bzr revert" instead. Use "--force" if you are'
 
639
                    ' sure you want to reset the working tree.'))
 
640
        if revision is None:
 
641
            revision_ids = None
 
642
        else:
 
643
            revision_ids = [r.as_revision_id(tree.branch) for r in revision]
242
644
        try:
243
 
            working = d.open_workingtree()
244
 
        except errors.NoWorkingTree:
245
 
            raise errors.BzrCommandError("No working tree to remove")
246
 
        except errors.NotLocalUrl:
247
 
            raise errors.BzrCommandError("You cannot remove the working tree of a "
248
 
                                         "remote path")
249
 
        
250
 
        working_path = working.bzrdir.root_transport.base
251
 
        branch_path = working.branch.bzrdir.root_transport.base
252
 
        if working_path != branch_path:
253
 
            raise errors.BzrCommandError("You cannot remove the working tree from "
254
 
                                         "a lightweight checkout")
255
 
        
256
 
        d.destroy_workingtree()
257
 
        
 
645
            tree.reset_state(revision_ids)
 
646
        except errors.BzrError, e:
 
647
            if revision_ids is None:
 
648
                extra = (gettext(', the header appears corrupt, try passing -r -1'
 
649
                         ' to set the state to the last commit'))
 
650
            else:
 
651
                extra = ''
 
652
            raise errors.BzrCommandError(gettext('failed to reset the tree state{0}').format(extra))
 
653
 
258
654
 
259
655
class cmd_revno(Command):
260
 
    """Show current revision number.
 
656
    __doc__ = """Show current revision number.
261
657
 
262
658
    This is equal to the number of revisions on this branch.
263
659
    """
264
660
 
265
661
    _see_also = ['info']
266
662
    takes_args = ['location?']
 
663
    takes_options = [
 
664
        Option('tree', help='Show revno of working tree.'),
 
665
        'revision',
 
666
        ]
267
667
 
268
668
    @display_command
269
 
    def run(self, location=u'.'):
270
 
        self.outf.write(str(Branch.open_containing(location)[0].revno()))
271
 
        self.outf.write('\n')
 
669
    def run(self, tree=False, location=u'.', revision=None):
 
670
        if revision is not None and tree:
 
671
            raise errors.BzrCommandError(gettext("--tree and --revision can "
 
672
                "not be used together"))
 
673
 
 
674
        if tree:
 
675
            try:
 
676
                wt = WorkingTree.open_containing(location)[0]
 
677
                self.add_cleanup(wt.lock_read().unlock)
 
678
            except (errors.NoWorkingTree, errors.NotLocalUrl):
 
679
                raise errors.NoWorkingTree(location)
 
680
            b = wt.branch
 
681
            revid = wt.last_revision()
 
682
        else:
 
683
            b = Branch.open_containing(location)[0]
 
684
            self.add_cleanup(b.lock_read().unlock)
 
685
            if revision:
 
686
                if len(revision) != 1:
 
687
                    raise errors.BzrCommandError(gettext(
 
688
                        "Tags can only be placed on a single revision, "
 
689
                        "not on a range"))
 
690
                revid = revision[0].as_revision_id(b)
 
691
            else:
 
692
                revid = b.last_revision()
 
693
        try:
 
694
            revno_t = b.revision_id_to_dotted_revno(revid)
 
695
        except errors.NoSuchRevision:
 
696
            revno_t = ('???',)
 
697
        revno = ".".join(str(n) for n in revno_t)
 
698
        self.cleanup_now()
 
699
        self.outf.write(revno + '\n')
272
700
 
273
701
 
274
702
class cmd_revision_info(Command):
275
 
    """Show revision number and revision id for a given revision identifier.
 
703
    __doc__ = """Show revision number and revision id for a given revision identifier.
276
704
    """
277
705
    hidden = True
278
706
    takes_args = ['revision_info*']
279
 
    takes_options = ['revision']
 
707
    takes_options = [
 
708
        'revision',
 
709
        custom_help('directory',
 
710
            help='Branch to examine, '
 
711
                 'rather than the one containing the working directory.'),
 
712
        Option('tree', help='Show revno of working tree.'),
 
713
        ]
280
714
 
281
715
    @display_command
282
 
    def run(self, revision=None, revision_info_list=[]):
 
716
    def run(self, revision=None, directory=u'.', tree=False,
 
717
            revision_info_list=[]):
283
718
 
284
 
        revs = []
 
719
        try:
 
720
            wt = WorkingTree.open_containing(directory)[0]
 
721
            b = wt.branch
 
722
            self.add_cleanup(wt.lock_read().unlock)
 
723
        except (errors.NoWorkingTree, errors.NotLocalUrl):
 
724
            wt = None
 
725
            b = Branch.open_containing(directory)[0]
 
726
            self.add_cleanup(b.lock_read().unlock)
 
727
        revision_ids = []
285
728
        if revision is not None:
286
 
            revs.extend(revision)
 
729
            revision_ids.extend(rev.as_revision_id(b) for rev in revision)
287
730
        if revision_info_list is not None:
288
 
            for rev in revision_info_list:
289
 
                revs.append(RevisionSpec.from_string(rev))
290
 
 
291
 
        b = Branch.open_containing(u'.')[0]
292
 
 
293
 
        if len(revs) == 0:
294
 
            revs.append(RevisionSpec.from_string('-1'))
295
 
 
296
 
        for rev in revs:
297
 
            revinfo = rev.in_history(b)
298
 
            if revinfo.revno is None:
299
 
                dotted_map = b.get_revision_id_to_revno_map()
300
 
                revno = '.'.join(str(i) for i in dotted_map[revinfo.rev_id])
301
 
                print '%s %s' % (revno, revinfo.rev_id)
 
731
            for rev_str in revision_info_list:
 
732
                rev_spec = RevisionSpec.from_string(rev_str)
 
733
                revision_ids.append(rev_spec.as_revision_id(b))
 
734
        # No arguments supplied, default to the last revision
 
735
        if len(revision_ids) == 0:
 
736
            if tree:
 
737
                if wt is None:
 
738
                    raise errors.NoWorkingTree(directory)
 
739
                revision_ids.append(wt.last_revision())
302
740
            else:
303
 
                print '%4d %s' % (revinfo.revno, revinfo.rev_id)
304
 
 
305
 
    
 
741
                revision_ids.append(b.last_revision())
 
742
 
 
743
        revinfos = []
 
744
        maxlen = 0
 
745
        for revision_id in revision_ids:
 
746
            try:
 
747
                dotted_revno = b.revision_id_to_dotted_revno(revision_id)
 
748
                revno = '.'.join(str(i) for i in dotted_revno)
 
749
            except errors.NoSuchRevision:
 
750
                revno = '???'
 
751
            maxlen = max(maxlen, len(revno))
 
752
            revinfos.append([revno, revision_id])
 
753
 
 
754
        self.cleanup_now()
 
755
        for ri in revinfos:
 
756
            self.outf.write('%*s %s\n' % (maxlen, ri[0], ri[1]))
 
757
 
 
758
 
306
759
class cmd_add(Command):
307
 
    """Add specified files or directories.
 
760
    __doc__ = """Add specified files or directories.
308
761
 
309
762
    In non-recursive mode, all the named items are added, regardless
310
763
    of whether they were previously ignored.  A warning is given if
318
771
    are added.  This search proceeds recursively into versioned
319
772
    directories.  If no names are given '.' is assumed.
320
773
 
 
774
    A warning will be printed when nested trees are encountered,
 
775
    unless they are explicitly ignored.
 
776
 
321
777
    Therefore simply saying 'bzr add' will version all files that
322
778
    are currently unknown.
323
779
 
326
782
    you should never need to explicitly add a directory, they'll just
327
783
    get added when you add a file in the directory.
328
784
 
329
 
    --dry-run will show which files would be added, but not actually 
 
785
    --dry-run will show which files would be added, but not actually
330
786
    add them.
331
787
 
332
788
    --file-ids-from will try to use the file ids from the supplied path.
336
792
    branches that will be merged later (without showing the two different
337
793
    adds as a conflict). It is also useful when merging another project
338
794
    into a subdirectory of this one.
 
795
    
 
796
    Any files matching patterns in the ignore list will not be added
 
797
    unless they are explicitly mentioned.
 
798
    
 
799
    In recursive mode, files larger than the configuration option 
 
800
    add.maximum_file_size will be skipped. Named items are never skipped due
 
801
    to file size.
339
802
    """
340
803
    takes_args = ['file*']
341
 
    takes_options = ['no-recurse', 'dry-run', 'verbose',
342
 
                     Option('file-ids-from', type=unicode,
343
 
                            help='Lookup file ids from here')]
 
804
    takes_options = [
 
805
        Option('no-recurse',
 
806
               help="Don't recursively add the contents of directories.",
 
807
               short_name='N'),
 
808
        Option('dry-run',
 
809
               help="Show what would be done, but don't actually do anything."),
 
810
        'verbose',
 
811
        Option('file-ids-from',
 
812
               type=unicode,
 
813
               help='Lookup file ids from this tree.'),
 
814
        ]
344
815
    encoding_type = 'replace'
345
 
    _see_also = ['remove']
 
816
    _see_also = ['remove', 'ignore']
346
817
 
347
818
    def run(self, file_list, no_recurse=False, dry_run=False, verbose=False,
348
819
            file_ids_from=None):
361
832
            action = bzrlib.add.AddFromBaseAction(base_tree, base_path,
362
833
                          to_file=self.outf, should_print=(not is_quiet()))
363
834
        else:
364
 
            action = bzrlib.add.AddAction(to_file=self.outf,
 
835
            action = bzrlib.add.AddWithSkipLargeAction(to_file=self.outf,
365
836
                should_print=(not is_quiet()))
366
837
 
367
838
        if base_tree:
368
 
            base_tree.lock_read()
369
 
        try:
370
 
            file_list = self._maybe_expand_globs(file_list)
371
 
            if file_list:
372
 
                tree = WorkingTree.open_containing(file_list[0])[0]
373
 
            else:
374
 
                tree = WorkingTree.open_containing(u'.')[0]
375
 
            added, ignored = tree.smart_add(file_list, not
376
 
                no_recurse, action=action, save=not dry_run)
377
 
        finally:
378
 
            if base_tree is not None:
379
 
                base_tree.unlock()
 
839
            self.add_cleanup(base_tree.lock_read().unlock)
 
840
        tree, file_list = tree_files_for_add(file_list)
 
841
        added, ignored = tree.smart_add(file_list, not
 
842
            no_recurse, action=action, save=not dry_run)
 
843
        self.cleanup_now()
380
844
        if len(ignored) > 0:
381
845
            if verbose:
382
846
                for glob in sorted(ignored.keys()):
383
847
                    for path in ignored[glob]:
384
 
                        self.outf.write("ignored %s matching \"%s\"\n" 
385
 
                                        % (path, glob))
386
 
            else:
387
 
                match_len = 0
388
 
                for glob, paths in ignored.items():
389
 
                    match_len += len(paths)
390
 
                self.outf.write("ignored %d file(s).\n" % match_len)
391
 
            self.outf.write("If you wish to add some of these files,"
392
 
                            " please add them by name.\n")
 
848
                        self.outf.write(
 
849
                         gettext("ignored {0} matching \"{1}\"\n").format(
 
850
                         path, glob))
393
851
 
394
852
 
395
853
class cmd_mkdir(Command):
396
 
    """Create a new versioned directory.
 
854
    __doc__ = """Create a new versioned directory.
397
855
 
398
856
    This is equivalent to creating the directory and then adding it.
399
857
    """
400
858
 
401
859
    takes_args = ['dir+']
 
860
    takes_options = [
 
861
        Option(
 
862
            'parents',
 
863
            help='No error if existing, make parent directories as needed.',
 
864
            short_name='p'
 
865
            )
 
866
        ]
402
867
    encoding_type = 'replace'
403
868
 
404
 
    def run(self, dir_list):
405
 
        for d in dir_list:
406
 
            os.mkdir(d)
407
 
            wt, dd = WorkingTree.open_containing(d)
408
 
            wt.add([dd])
409
 
            self.outf.write('added %s\n' % d)
 
869
    @classmethod
 
870
    def add_file_with_parents(cls, wt, relpath):
 
871
        if wt.path2id(relpath) is not None:
 
872
            return
 
873
        cls.add_file_with_parents(wt, osutils.dirname(relpath))
 
874
        wt.add([relpath])
 
875
 
 
876
    @classmethod
 
877
    def add_file_single(cls, wt, relpath):
 
878
        wt.add([relpath])
 
879
 
 
880
    def run(self, dir_list, parents=False):
 
881
        if parents:
 
882
            add_file = self.add_file_with_parents
 
883
        else:
 
884
            add_file = self.add_file_single
 
885
        for dir in dir_list:
 
886
            wt, relpath = WorkingTree.open_containing(dir)
 
887
            if parents:
 
888
                try:
 
889
                    os.makedirs(dir)
 
890
                except OSError, e:
 
891
                    if e.errno != errno.EEXIST:
 
892
                        raise
 
893
            else:
 
894
                os.mkdir(dir)
 
895
            add_file(wt, relpath)
 
896
            if not is_quiet():
 
897
                self.outf.write(gettext('added %s\n') % dir)
410
898
 
411
899
 
412
900
class cmd_relpath(Command):
413
 
    """Show path of a file relative to root"""
 
901
    __doc__ = """Show path of a file relative to root"""
414
902
 
415
903
    takes_args = ['filename']
416
904
    hidden = True
417
 
    
 
905
 
418
906
    @display_command
419
907
    def run(self, filename):
420
908
        # TODO: jam 20050106 Can relpath return a munged path if
425
913
 
426
914
 
427
915
class cmd_inventory(Command):
428
 
    """Show inventory of the current working copy or a revision.
 
916
    __doc__ = """Show inventory of the current working copy or a revision.
429
917
 
430
918
    It is possible to limit the output to a particular entry
431
919
    type using the --kind option.  For example: --kind file.
436
924
 
437
925
    hidden = True
438
926
    _see_also = ['ls']
439
 
    takes_options = ['revision', 'show-ids', 'kind']
 
927
    takes_options = [
 
928
        'revision',
 
929
        'show-ids',
 
930
        Option('kind',
 
931
               help='List entries of a particular kind: file, directory, symlink.',
 
932
               type=unicode),
 
933
        ]
440
934
    takes_args = ['file*']
441
935
 
442
936
    @display_command
443
937
    def run(self, revision=None, show_ids=False, kind=None, file_list=None):
444
938
        if kind and kind not in ['file', 'directory', 'symlink']:
445
 
            raise errors.BzrCommandError('invalid kind specified')
446
 
 
447
 
        work_tree, file_list = tree_files(file_list)
448
 
        work_tree.lock_read()
449
 
        try:
450
 
            if revision is not None:
451
 
                if len(revision) > 1:
452
 
                    raise errors.BzrCommandError(
453
 
                        'bzr inventory --revision takes exactly one revision'
454
 
                        ' identifier')
455
 
                revision_id = revision[0].in_history(work_tree.branch).rev_id
456
 
                tree = work_tree.branch.repository.revision_tree(revision_id)
457
 
 
458
 
                extra_trees = [work_tree]
459
 
                tree.lock_read()
460
 
            else:
461
 
                tree = work_tree
462
 
                extra_trees = []
463
 
 
464
 
            if file_list is not None:
465
 
                file_ids = tree.paths2ids(file_list, trees=extra_trees,
466
 
                                          require_versioned=True)
467
 
                # find_ids_across_trees may include some paths that don't
468
 
                # exist in 'tree'.
469
 
                entries = sorted((tree.id2path(file_id), tree.inventory[file_id])
470
 
                                 for file_id in file_ids if file_id in tree)
471
 
            else:
472
 
                entries = tree.inventory.entries()
473
 
        finally:
474
 
            tree.unlock()
475
 
            if tree is not work_tree:
476
 
                work_tree.unlock()
477
 
 
478
 
        for path, entry in entries:
 
939
            raise errors.BzrCommandError(gettext('invalid kind %r specified') % (kind,))
 
940
 
 
941
        revision = _get_one_revision('inventory', revision)
 
942
        work_tree, file_list = WorkingTree.open_containing_paths(file_list)
 
943
        self.add_cleanup(work_tree.lock_read().unlock)
 
944
        if revision is not None:
 
945
            tree = revision.as_tree(work_tree.branch)
 
946
 
 
947
            extra_trees = [work_tree]
 
948
            self.add_cleanup(tree.lock_read().unlock)
 
949
        else:
 
950
            tree = work_tree
 
951
            extra_trees = []
 
952
 
 
953
        self.add_cleanup(tree.lock_read().unlock)
 
954
        if file_list is not None:
 
955
            file_ids = tree.paths2ids(file_list, trees=extra_trees,
 
956
                                      require_versioned=True)
 
957
            # find_ids_across_trees may include some paths that don't
 
958
            # exist in 'tree'.
 
959
            entries = tree.iter_entries_by_dir(specific_file_ids=file_ids)
 
960
        else:
 
961
            entries = tree.iter_entries_by_dir()
 
962
 
 
963
        for path, entry in sorted(entries):
479
964
            if kind and kind != entry.kind:
480
965
                continue
 
966
            if path == "":
 
967
                continue
481
968
            if show_ids:
482
969
                self.outf.write('%-50s %s\n' % (path, entry.file_id))
483
970
            else:
486
973
 
487
974
 
488
975
class cmd_mv(Command):
489
 
    """Move or rename a file.
 
976
    __doc__ = """Move or rename a file.
490
977
 
491
 
    usage:
 
978
    :Usage:
492
979
        bzr mv OLDNAME NEWNAME
 
980
 
493
981
        bzr mv SOURCE... DESTINATION
494
982
 
495
983
    If the last argument is a versioned directory, all the other names
506
994
    """
507
995
 
508
996
    takes_args = ['names*']
509
 
    takes_options = [Option("after", help="move only the bzr identifier"
510
 
        " of the file (file has already been moved). Use this flag if"
511
 
        " bzr is not able to detect this itself.")]
 
997
    takes_options = [Option("after", help="Move only the bzr identifier"
 
998
        " of the file, because the file has already been moved."),
 
999
        Option('auto', help='Automatically guess renames.'),
 
1000
        Option('dry-run', help='Avoid making changes when guessing renames.'),
 
1001
        ]
512
1002
    aliases = ['move', 'rename']
513
1003
    encoding_type = 'replace'
514
1004
 
515
 
    def run(self, names_list, after=False):
 
1005
    def run(self, names_list, after=False, auto=False, dry_run=False):
 
1006
        if auto:
 
1007
            return self.run_auto(names_list, after, dry_run)
 
1008
        elif dry_run:
 
1009
            raise errors.BzrCommandError(gettext('--dry-run requires --auto.'))
516
1010
        if names_list is None:
517
1011
            names_list = []
518
 
 
519
1012
        if len(names_list) < 2:
520
 
            raise errors.BzrCommandError("missing file argument")
521
 
        tree, rel_names = tree_files(names_list)
522
 
        
523
 
        if os.path.isdir(names_list[-1]):
 
1013
            raise errors.BzrCommandError(gettext("missing file argument"))
 
1014
        tree, rel_names = WorkingTree.open_containing_paths(names_list, canonicalize=False)
 
1015
        for file_name in rel_names[0:-1]:
 
1016
            if file_name == '':
 
1017
                raise errors.BzrCommandError(gettext("can not move root of branch"))
 
1018
        self.add_cleanup(tree.lock_tree_write().unlock)
 
1019
        self._run(tree, names_list, rel_names, after)
 
1020
 
 
1021
    def run_auto(self, names_list, after, dry_run):
 
1022
        if names_list is not None and len(names_list) > 1:
 
1023
            raise errors.BzrCommandError(gettext('Only one path may be specified to'
 
1024
                                         ' --auto.'))
 
1025
        if after:
 
1026
            raise errors.BzrCommandError(gettext('--after cannot be specified with'
 
1027
                                         ' --auto.'))
 
1028
        work_tree, file_list = WorkingTree.open_containing_paths(
 
1029
            names_list, default_directory='.')
 
1030
        self.add_cleanup(work_tree.lock_tree_write().unlock)
 
1031
        rename_map.RenameMap.guess_renames(work_tree, dry_run)
 
1032
 
 
1033
    def _run(self, tree, names_list, rel_names, after):
 
1034
        into_existing = osutils.isdir(names_list[-1])
 
1035
        if into_existing and len(names_list) == 2:
 
1036
            # special cases:
 
1037
            # a. case-insensitive filesystem and change case of dir
 
1038
            # b. move directory after the fact (if the source used to be
 
1039
            #    a directory, but now doesn't exist in the working tree
 
1040
            #    and the target is an existing directory, just rename it)
 
1041
            if (not tree.case_sensitive
 
1042
                and rel_names[0].lower() == rel_names[1].lower()):
 
1043
                into_existing = False
 
1044
            else:
 
1045
                # 'fix' the case of a potential 'from'
 
1046
                from_id = tree.path2id(
 
1047
                            tree.get_canonical_inventory_path(rel_names[0]))
 
1048
                if (not osutils.lexists(names_list[0]) and
 
1049
                    from_id and tree.stored_kind(from_id) == "directory"):
 
1050
                    into_existing = False
 
1051
        # move/rename
 
1052
        if into_existing:
524
1053
            # move into existing directory
525
 
            for pair in tree.move(rel_names[:-1], rel_names[-1], after=after):
526
 
                self.outf.write("%s => %s\n" % pair)
 
1054
            # All entries reference existing inventory items, so fix them up
 
1055
            # for cicp file-systems.
 
1056
            rel_names = tree.get_canonical_inventory_paths(rel_names)
 
1057
            for src, dest in tree.move(rel_names[:-1], rel_names[-1], after=after):
 
1058
                if not is_quiet():
 
1059
                    self.outf.write("%s => %s\n" % (src, dest))
527
1060
        else:
528
1061
            if len(names_list) != 2:
529
 
                raise errors.BzrCommandError('to mv multiple files the'
 
1062
                raise errors.BzrCommandError(gettext('to mv multiple files the'
530
1063
                                             ' destination must be a versioned'
531
 
                                             ' directory')
532
 
            tree.rename_one(rel_names[0], rel_names[1], after=after)
533
 
            self.outf.write("%s => %s\n" % (rel_names[0], rel_names[1]))
534
 
            
535
 
    
 
1064
                                             ' directory'))
 
1065
 
 
1066
            # for cicp file-systems: the src references an existing inventory
 
1067
            # item:
 
1068
            src = tree.get_canonical_inventory_path(rel_names[0])
 
1069
            # Find the canonical version of the destination:  In all cases, the
 
1070
            # parent of the target must be in the inventory, so we fetch the
 
1071
            # canonical version from there (we do not always *use* the
 
1072
            # canonicalized tail portion - we may be attempting to rename the
 
1073
            # case of the tail)
 
1074
            canon_dest = tree.get_canonical_inventory_path(rel_names[1])
 
1075
            dest_parent = osutils.dirname(canon_dest)
 
1076
            spec_tail = osutils.basename(rel_names[1])
 
1077
            # For a CICP file-system, we need to avoid creating 2 inventory
 
1078
            # entries that differ only by case.  So regardless of the case
 
1079
            # we *want* to use (ie, specified by the user or the file-system),
 
1080
            # we must always choose to use the case of any existing inventory
 
1081
            # items.  The only exception to this is when we are attempting a
 
1082
            # case-only rename (ie, canonical versions of src and dest are
 
1083
            # the same)
 
1084
            dest_id = tree.path2id(canon_dest)
 
1085
            if dest_id is None or tree.path2id(src) == dest_id:
 
1086
                # No existing item we care about, so work out what case we
 
1087
                # are actually going to use.
 
1088
                if after:
 
1089
                    # If 'after' is specified, the tail must refer to a file on disk.
 
1090
                    if dest_parent:
 
1091
                        dest_parent_fq = osutils.pathjoin(tree.basedir, dest_parent)
 
1092
                    else:
 
1093
                        # pathjoin with an empty tail adds a slash, which breaks
 
1094
                        # relpath :(
 
1095
                        dest_parent_fq = tree.basedir
 
1096
 
 
1097
                    dest_tail = osutils.canonical_relpath(
 
1098
                                    dest_parent_fq,
 
1099
                                    osutils.pathjoin(dest_parent_fq, spec_tail))
 
1100
                else:
 
1101
                    # not 'after', so case as specified is used
 
1102
                    dest_tail = spec_tail
 
1103
            else:
 
1104
                # Use the existing item so 'mv' fails with AlreadyVersioned.
 
1105
                dest_tail = os.path.basename(canon_dest)
 
1106
            dest = osutils.pathjoin(dest_parent, dest_tail)
 
1107
            mutter("attempting to move %s => %s", src, dest)
 
1108
            tree.rename_one(src, dest, after=after)
 
1109
            if not is_quiet():
 
1110
                self.outf.write("%s => %s\n" % (src, dest))
 
1111
 
 
1112
 
536
1113
class cmd_pull(Command):
537
 
    """Turn this branch into a mirror of another branch.
 
1114
    __doc__ = """Turn this branch into a mirror of another branch.
538
1115
 
539
 
    This command only works on branches that have not diverged.  Branches are
540
 
    considered diverged if the destination branch's most recent commit is one
541
 
    that has not been merged (directly or indirectly) into the parent.
 
1116
    By default, this command only works on branches that have not diverged.
 
1117
    Branches are considered diverged if the destination branch's most recent 
 
1118
    commit is one that has not been merged (directly or indirectly) into the 
 
1119
    parent.
542
1120
 
543
1121
    If branches have diverged, you can use 'bzr merge' to integrate the changes
544
1122
    from one into the other.  Once one branch has merged, the other should
545
1123
    be able to pull it again.
546
1124
 
547
 
    If you want to forget your local changes and just update your branch to
548
 
    match the remote one, use pull --overwrite.
549
 
 
550
 
    If there is no default location set, the first pull will set it.  After
551
 
    that, you can omit the location to use the default.  To change the
552
 
    default, use --remember. The value will only be saved if the remote
553
 
    location can be accessed.
 
1125
    If you want to replace your local changes and just want your branch to
 
1126
    match the remote one, use pull --overwrite. This will work even if the two
 
1127
    branches have diverged.
 
1128
 
 
1129
    If there is no default location set, the first pull will set it (use
 
1130
    --no-remember to avoid setting it). After that, you can omit the
 
1131
    location to use the default.  To change the default, use --remember. The
 
1132
    value will only be saved if the remote location can be accessed.
 
1133
 
 
1134
    The --verbose option will display the revisions pulled using the log_format
 
1135
    configuration option. You can use a different format by overriding it with
 
1136
    -Olog_format=<other_format>.
 
1137
 
 
1138
    Note: The location can be specified either in the form of a branch,
 
1139
    or in the form of a path to a file containing a merge directive generated
 
1140
    with bzr send.
554
1141
    """
555
1142
 
556
 
    _see_also = ['push', 'update', 'status-flags']
557
 
    takes_options = ['remember', 'overwrite', 'revision', 'verbose',
558
 
        Option('directory',
559
 
            help='branch to pull into, '
560
 
                 'rather than the one containing the working directory',
561
 
            short_name='d',
562
 
            type=unicode,
 
1143
    _see_also = ['push', 'update', 'status-flags', 'send']
 
1144
    takes_options = ['remember', 'overwrite', 'revision',
 
1145
        custom_help('verbose',
 
1146
            help='Show logs of pulled revisions.'),
 
1147
        custom_help('directory',
 
1148
            help='Branch to pull into, '
 
1149
                 'rather than the one containing the working directory.'),
 
1150
        Option('local',
 
1151
            help="Perform a local pull in a bound "
 
1152
                 "branch.  Local pulls are not applied to "
 
1153
                 "the master branch."
563
1154
            ),
 
1155
        Option('show-base',
 
1156
            help="Show base revision text in conflicts.")
564
1157
        ]
565
1158
    takes_args = ['location?']
566
1159
    encoding_type = 'replace'
567
1160
 
568
 
    def run(self, location=None, remember=False, overwrite=False,
 
1161
    def run(self, location=None, remember=None, overwrite=False,
569
1162
            revision=None, verbose=False,
570
 
            directory=None):
571
 
        from bzrlib.tag import _merge_tags_if_possible
 
1163
            directory=None, local=False,
 
1164
            show_base=False):
572
1165
        # FIXME: too much stuff is in the command class
573
1166
        revision_id = None
574
1167
        mergeable = None
577
1170
        try:
578
1171
            tree_to = WorkingTree.open_containing(directory)[0]
579
1172
            branch_to = tree_to.branch
 
1173
            self.add_cleanup(tree_to.lock_write().unlock)
580
1174
        except errors.NoWorkingTree:
581
1175
            tree_to = None
582
1176
            branch_to = Branch.open_containing(directory)[0]
583
 
 
584
 
        reader = None
 
1177
            self.add_cleanup(branch_to.lock_write().unlock)
 
1178
 
 
1179
        if tree_to is None and show_base:
 
1180
            raise errors.BzrCommandError(gettext("Need working tree for --show-base."))
 
1181
 
 
1182
        if local and not branch_to.get_bound_location():
 
1183
            raise errors.LocalRequiresBoundBranch()
 
1184
 
 
1185
        possible_transports = []
585
1186
        if location is not None:
586
1187
            try:
587
 
                mergeable = bundle.read_mergeable_from_url(
588
 
                    location)
 
1188
                mergeable = bundle.read_mergeable_from_url(location,
 
1189
                    possible_transports=possible_transports)
589
1190
            except errors.NotABundle:
590
 
                pass # Continue on considering this url a Branch
 
1191
                mergeable = None
591
1192
 
592
1193
        stored_loc = branch_to.get_parent()
593
1194
        if location is None:
594
1195
            if stored_loc is None:
595
 
                raise errors.BzrCommandError("No pull location known or"
596
 
                                             " specified.")
 
1196
                raise errors.BzrCommandError(gettext("No pull location known or"
 
1197
                                             " specified."))
597
1198
            else:
598
1199
                display_url = urlutils.unescape_for_display(stored_loc,
599
1200
                        self.outf.encoding)
600
 
                self.outf.write("Using saved location: %s\n" % display_url)
 
1201
                if not is_quiet():
 
1202
                    self.outf.write(gettext("Using saved parent location: %s\n") % display_url)
601
1203
                location = stored_loc
602
1204
 
 
1205
        revision = _get_one_revision('pull', revision)
603
1206
        if mergeable is not None:
604
1207
            if revision is not None:
605
 
                raise errors.BzrCommandError(
606
 
                    'Cannot use -r with merge directives or bundles')
607
 
            revision_id = mergeable.install_revisions(branch_to.repository)
 
1208
                raise errors.BzrCommandError(gettext(
 
1209
                    'Cannot use -r with merge directives or bundles'))
 
1210
            mergeable.install_revisions(branch_to.repository)
 
1211
            base_revision_id, revision_id, verified = \
 
1212
                mergeable.get_merge_request(branch_to.repository)
608
1213
            branch_from = branch_to
609
1214
        else:
610
 
            branch_from = Branch.open(location)
611
 
 
612
 
            if branch_to.get_parent() is None or remember:
 
1215
            branch_from = Branch.open(location,
 
1216
                possible_transports=possible_transports)
 
1217
            self.add_cleanup(branch_from.lock_read().unlock)
 
1218
            # Remembers if asked explicitly or no previous location is set
 
1219
            if (remember
 
1220
                or (remember is None and branch_to.get_parent() is None)):
 
1221
                # FIXME: This shouldn't be done before the pull
 
1222
                # succeeds... -- vila 2012-01-02
613
1223
                branch_to.set_parent(branch_from.base)
614
1224
 
615
1225
        if revision is not None:
616
 
            if len(revision) == 1:
617
 
                revision_id = revision[0].in_history(branch_from).rev_id
618
 
            else:
619
 
                raise errors.BzrCommandError(
620
 
                    'bzr pull --revision takes one value.')
 
1226
            revision_id = revision.as_revision_id(branch_from)
621
1227
 
622
 
        old_rh = branch_to.revision_history()
623
1228
        if tree_to is not None:
624
 
            result = tree_to.pull(branch_from, overwrite, revision_id,
625
 
                delta._ChangeReporter(unversioned_filter=tree_to.is_ignored))
 
1229
            view_info = _get_view_info_for_change_reporter(tree_to)
 
1230
            change_reporter = delta._ChangeReporter(
 
1231
                unversioned_filter=tree_to.is_ignored,
 
1232
                view_info=view_info)
 
1233
            result = tree_to.pull(
 
1234
                branch_from, overwrite, revision_id, change_reporter,
 
1235
                local=local, show_base=show_base)
626
1236
        else:
627
 
            result = branch_to.pull(branch_from, overwrite, revision_id)
 
1237
            result = branch_to.pull(
 
1238
                branch_from, overwrite, revision_id, local=local)
628
1239
 
629
1240
        result.report(self.outf)
630
 
        if verbose:
631
 
            from bzrlib.log import show_changed_revisions
632
 
            new_rh = branch_to.revision_history()
633
 
            show_changed_revisions(branch_to, old_rh, new_rh,
634
 
                                   to_file=self.outf)
 
1241
        if verbose and result.old_revid != result.new_revid:
 
1242
            log.show_branch_change(
 
1243
                branch_to, self.outf, result.old_revno,
 
1244
                result.old_revid)
 
1245
        if getattr(result, 'tag_conflicts', None):
 
1246
            return 1
 
1247
        else:
 
1248
            return 0
635
1249
 
636
1250
 
637
1251
class cmd_push(Command):
638
 
    """Update a mirror of this branch.
639
 
    
 
1252
    __doc__ = """Update a mirror of this branch.
 
1253
 
640
1254
    The target branch will not have its working tree populated because this
641
1255
    is both expensive, and is not supported on remote file systems.
642
 
    
 
1256
 
643
1257
    Some smart servers or protocols *may* put the working tree in place in
644
1258
    the future.
645
1259
 
649
1263
 
650
1264
    If branches have diverged, you can use 'bzr push --overwrite' to replace
651
1265
    the other branch completely, discarding its unmerged changes.
652
 
    
 
1266
 
653
1267
    If you want to ensure you have the different changes in the other branch,
654
1268
    do a merge (see bzr help merge) from the other branch, and commit that.
655
1269
    After that you will be able to do a push without '--overwrite'.
656
1270
 
657
 
    If there is no default push location set, the first push will set it.
658
 
    After that, you can omit the location to use the default.  To change the
659
 
    default, use --remember. The value will only be saved if the remote
660
 
    location can be accessed.
 
1271
    If there is no default push location set, the first push will set it (use
 
1272
    --no-remember to avoid setting it).  After that, you can omit the
 
1273
    location to use the default.  To change the default, use --remember. The
 
1274
    value will only be saved if the remote location can be accessed.
 
1275
 
 
1276
    The --verbose option will display the revisions pushed using the log_format
 
1277
    configuration option. You can use a different format by overriding it with
 
1278
    -Olog_format=<other_format>.
661
1279
    """
662
1280
 
663
1281
    _see_also = ['pull', 'update', 'working-trees']
664
 
    takes_options = ['remember', 'overwrite', 'verbose',
 
1282
    takes_options = ['remember', 'overwrite', 'verbose', 'revision',
665
1283
        Option('create-prefix',
666
1284
               help='Create the path leading up to the branch '
667
 
                    'if it does not already exist'),
668
 
        Option('directory',
669
 
            help='branch to push from, '
670
 
                 'rather than the one containing the working directory',
671
 
            short_name='d',
672
 
            type=unicode,
673
 
            ),
 
1285
                    'if it does not already exist.'),
 
1286
        custom_help('directory',
 
1287
            help='Branch to push from, '
 
1288
                 'rather than the one containing the working directory.'),
674
1289
        Option('use-existing-dir',
675
1290
               help='By default push will fail if the target'
676
1291
                    ' directory exists, but does not already'
677
 
                    ' have a control directory. This flag will'
 
1292
                    ' have a control directory.  This flag will'
678
1293
                    ' allow push to proceed.'),
 
1294
        Option('stacked',
 
1295
            help='Create a stacked branch that references the public location '
 
1296
                'of the parent branch.'),
 
1297
        Option('stacked-on',
 
1298
            help='Create a stacked branch that refers to another branch '
 
1299
                'for the commit history. Only the work not present in the '
 
1300
                'referenced branch is included in the branch created.',
 
1301
            type=unicode),
 
1302
        Option('strict',
 
1303
               help='Refuse to push if there are uncommitted changes in'
 
1304
               ' the working tree, --no-strict disables the check.'),
 
1305
        Option('no-tree',
 
1306
               help="Don't populate the working tree, even for protocols"
 
1307
               " that support it."),
679
1308
        ]
680
1309
    takes_args = ['location?']
681
1310
    encoding_type = 'replace'
682
1311
 
683
 
    def run(self, location=None, remember=False, overwrite=False,
684
 
            create_prefix=False, verbose=False,
685
 
            use_existing_dir=False,
686
 
            directory=None):
687
 
        # FIXME: Way too big!  Put this into a function called from the
688
 
        # command.
 
1312
    def run(self, location=None, remember=None, overwrite=False,
 
1313
        create_prefix=False, verbose=False, revision=None,
 
1314
        use_existing_dir=False, directory=None, stacked_on=None,
 
1315
        stacked=False, strict=None, no_tree=False):
 
1316
        from bzrlib.push import _show_push_branch
 
1317
 
689
1318
        if directory is None:
690
1319
            directory = '.'
691
 
        br_from = Branch.open_containing(directory)[0]
692
 
        stored_loc = br_from.get_push_location()
 
1320
        # Get the source branch
 
1321
        (tree, br_from,
 
1322
         _unused) = controldir.ControlDir.open_containing_tree_or_branch(directory)
 
1323
        # Get the tip's revision_id
 
1324
        revision = _get_one_revision('push', revision)
 
1325
        if revision is not None:
 
1326
            revision_id = revision.in_history(br_from).rev_id
 
1327
        else:
 
1328
            revision_id = None
 
1329
        if tree is not None and revision_id is None:
 
1330
            tree.check_changed_or_out_of_date(
 
1331
                strict, 'push_strict',
 
1332
                more_error='Use --no-strict to force the push.',
 
1333
                more_warning='Uncommitted changes will not be pushed.')
 
1334
        # Get the stacked_on branch, if any
 
1335
        if stacked_on is not None:
 
1336
            stacked_on = urlutils.normalize_url(stacked_on)
 
1337
        elif stacked:
 
1338
            parent_url = br_from.get_parent()
 
1339
            if parent_url:
 
1340
                parent = Branch.open(parent_url)
 
1341
                stacked_on = parent.get_public_branch()
 
1342
                if not stacked_on:
 
1343
                    # I considered excluding non-http url's here, thus forcing
 
1344
                    # 'public' branches only, but that only works for some
 
1345
                    # users, so it's best to just depend on the user spotting an
 
1346
                    # error by the feedback given to them. RBC 20080227.
 
1347
                    stacked_on = parent_url
 
1348
            if not stacked_on:
 
1349
                raise errors.BzrCommandError(gettext(
 
1350
                    "Could not determine branch to refer to."))
 
1351
 
 
1352
        # Get the destination location
693
1353
        if location is None:
 
1354
            stored_loc = br_from.get_push_location()
694
1355
            if stored_loc is None:
695
 
                raise errors.BzrCommandError("No push location known or specified.")
 
1356
                parent_loc = br_from.get_parent()
 
1357
                if parent_loc:
 
1358
                    raise errors.BzrCommandError(gettext(
 
1359
                        "No push location known or specified. To push to the "
 
1360
                        "parent branch (at %s), use 'bzr push :parent'." %
 
1361
                        urlutils.unescape_for_display(parent_loc,
 
1362
                            self.outf.encoding)))
 
1363
                else:
 
1364
                    raise errors.BzrCommandError(gettext(
 
1365
                        "No push location known or specified."))
696
1366
            else:
697
1367
                display_url = urlutils.unescape_for_display(stored_loc,
698
1368
                        self.outf.encoding)
699
 
                self.outf.write("Using saved location: %s\n" % display_url)
 
1369
                note(gettext("Using saved push location: %s") % display_url)
700
1370
                location = stored_loc
701
1371
 
702
 
        to_transport = transport.get_transport(location)
703
 
 
704
 
        br_to = repository_to = dir_to = None
705
 
        try:
706
 
            dir_to = bzrdir.BzrDir.open_from_transport(to_transport)
707
 
        except errors.NotBranchError:
708
 
            pass # Didn't find anything
709
 
        else:
710
 
            # If we can open a branch, use its direct repository, otherwise see
711
 
            # if there is a repository without a branch.
712
 
            try:
713
 
                br_to = dir_to.open_branch()
714
 
            except errors.NotBranchError:
715
 
                # Didn't find a branch, can we find a repository?
716
 
                try:
717
 
                    repository_to = dir_to.find_repository()
718
 
                except errors.NoRepositoryPresent:
719
 
                    pass
720
 
            else:
721
 
                # Found a branch, so we must have found a repository
722
 
                repository_to = br_to.repository
723
 
        push_result = None
724
 
        old_rh = []
725
 
        if dir_to is None:
726
 
            # The destination doesn't exist; create it.
727
 
            # XXX: Refactor the create_prefix/no_create_prefix code into a
728
 
            #      common helper function
729
 
            try:
730
 
                to_transport.mkdir('.')
731
 
            except errors.FileExists:
732
 
                if not use_existing_dir:
733
 
                    raise errors.BzrCommandError("Target directory %s"
734
 
                         " already exists, but does not have a valid .bzr"
735
 
                         " directory. Supply --use-existing-dir to push"
736
 
                         " there anyway." % location)
737
 
            except errors.NoSuchFile:
738
 
                if not create_prefix:
739
 
                    raise errors.BzrCommandError("Parent directory of %s"
740
 
                        " does not exist."
741
 
                        "\nYou may supply --create-prefix to create all"
742
 
                        " leading parent directories."
743
 
                        % location)
744
 
 
745
 
                _create_prefix(to_transport)
746
 
 
747
 
            # Now the target directory exists, but doesn't have a .bzr
748
 
            # directory. So we need to create it, along with any work to create
749
 
            # all of the dependent branches, etc.
750
 
            dir_to = br_from.bzrdir.clone_on_transport(to_transport,
751
 
                revision_id=br_from.last_revision())
752
 
            br_to = dir_to.open_branch()
753
 
            # TODO: Some more useful message about what was copied
754
 
            note('Created new branch.')
755
 
            # We successfully created the target, remember it
756
 
            if br_from.get_push_location() is None or remember:
757
 
                br_from.set_push_location(br_to.base)
758
 
        elif repository_to is None:
759
 
            # we have a bzrdir but no branch or repository
760
 
            # XXX: Figure out what to do other than complain.
761
 
            raise errors.BzrCommandError("At %s you have a valid .bzr control"
762
 
                " directory, but not a branch or repository. This is an"
763
 
                " unsupported configuration. Please move the target directory"
764
 
                " out of the way and try again."
765
 
                % location)
766
 
        elif br_to is None:
767
 
            # We have a repository but no branch, copy the revisions, and then
768
 
            # create a branch.
769
 
            last_revision_id = br_from.last_revision()
770
 
            repository_to.fetch(br_from.repository,
771
 
                                revision_id=last_revision_id)
772
 
            br_to = br_from.clone(dir_to, revision_id=last_revision_id)
773
 
            note('Created new branch.')
774
 
            if br_from.get_push_location() is None or remember:
775
 
                br_from.set_push_location(br_to.base)
776
 
        else: # We have a valid to branch
777
 
            # We were able to connect to the remote location, so remember it
778
 
            # we don't need to successfully push because of possible divergence.
779
 
            if br_from.get_push_location() is None or remember:
780
 
                br_from.set_push_location(br_to.base)
781
 
            old_rh = br_to.revision_history()
782
 
            try:
783
 
                try:
784
 
                    tree_to = dir_to.open_workingtree()
785
 
                except errors.NotLocalUrl:
786
 
                    warning("This transport does not update the working " 
787
 
                            "tree of: %s. See 'bzr help working-trees' for "
788
 
                            "more information." % br_to.base)
789
 
                    push_result = br_from.push(br_to, overwrite)
790
 
                except errors.NoWorkingTree:
791
 
                    push_result = br_from.push(br_to, overwrite)
792
 
                else:
793
 
                    tree_to.lock_write()
794
 
                    try:
795
 
                        push_result = br_from.push(tree_to.branch, overwrite)
796
 
                        tree_to.update()
797
 
                    finally:
798
 
                        tree_to.unlock()
799
 
            except errors.DivergedBranches:
800
 
                raise errors.BzrCommandError('These branches have diverged.'
801
 
                                        '  Try using "merge" and then "push".')
802
 
        if push_result is not None:
803
 
            push_result.report(self.outf)
804
 
        elif verbose:
805
 
            new_rh = br_to.revision_history()
806
 
            if old_rh != new_rh:
807
 
                # Something changed
808
 
                from bzrlib.log import show_changed_revisions
809
 
                show_changed_revisions(br_to, old_rh, new_rh,
810
 
                                       to_file=self.outf)
811
 
        else:
812
 
            # we probably did a clone rather than a push, so a message was
813
 
            # emitted above
814
 
            pass
 
1372
        _show_push_branch(br_from, revision_id, location, self.outf,
 
1373
            verbose=verbose, overwrite=overwrite, remember=remember,
 
1374
            stacked_on=stacked_on, create_prefix=create_prefix,
 
1375
            use_existing_dir=use_existing_dir, no_tree=no_tree)
815
1376
 
816
1377
 
817
1378
class cmd_branch(Command):
818
 
    """Create a new copy of a branch.
 
1379
    __doc__ = """Create a new branch that is a copy of an existing branch.
819
1380
 
820
1381
    If the TO_LOCATION is omitted, the last component of the FROM_LOCATION will
821
1382
    be used.  In other words, "branch ../foo/bar" will attempt to create ./bar.
826
1387
 
827
1388
    To retrieve the branch as of a particular revision, supply the --revision
828
1389
    parameter, as in "branch foo/bar -r 5".
 
1390
 
 
1391
    The synonyms 'clone' and 'get' for this command are deprecated.
829
1392
    """
830
1393
 
831
1394
    _see_also = ['checkout']
832
1395
    takes_args = ['from_location', 'to_location?']
833
 
    takes_options = ['revision']
 
1396
    takes_options = ['revision',
 
1397
        Option('hardlink', help='Hard-link working tree files where possible.'),
 
1398
        Option('files-from', type=str,
 
1399
               help="Get file contents from this tree."),
 
1400
        Option('no-tree',
 
1401
            help="Create a branch without a working-tree."),
 
1402
        Option('switch',
 
1403
            help="Switch the checkout in the current directory "
 
1404
                 "to the new branch."),
 
1405
        Option('stacked',
 
1406
            help='Create a stacked branch referring to the source branch. '
 
1407
                'The new branch will depend on the availability of the source '
 
1408
                'branch for all operations.'),
 
1409
        Option('standalone',
 
1410
               help='Do not use a shared repository, even if available.'),
 
1411
        Option('use-existing-dir',
 
1412
               help='By default branch will fail if the target'
 
1413
                    ' directory exists, but does not already'
 
1414
                    ' have a control directory.  This flag will'
 
1415
                    ' allow branch to proceed.'),
 
1416
        Option('bind',
 
1417
            help="Bind new branch to from location."),
 
1418
        ]
834
1419
    aliases = ['get', 'clone']
835
1420
 
836
 
    def run(self, from_location, to_location=None, revision=None):
 
1421
    def run(self, from_location, to_location=None, revision=None,
 
1422
            hardlink=False, stacked=False, standalone=False, no_tree=False,
 
1423
            use_existing_dir=False, switch=False, bind=False,
 
1424
            files_from=None):
 
1425
        from bzrlib import switch as _mod_switch
837
1426
        from bzrlib.tag import _merge_tags_if_possible
838
 
        if revision is None:
839
 
            revision = [None]
840
 
        elif len(revision) > 1:
841
 
            raise errors.BzrCommandError(
842
 
                'bzr branch --revision takes exactly 1 revision value')
843
 
 
844
 
        br_from = Branch.open(from_location)
845
 
        br_from.lock_read()
846
 
        try:
847
 
            if len(revision) == 1 and revision[0] is not None:
848
 
                revision_id = revision[0].in_history(br_from)[1]
849
 
            else:
850
 
                # FIXME - wt.last_revision, fallback to branch, fall back to
851
 
                # None or perhaps NULL_REVISION to mean copy nothing
852
 
                # RBC 20060209
853
 
                revision_id = br_from.last_revision()
854
 
            if to_location is None:
 
1427
        if self.invoked_as in ['get', 'clone']:
 
1428
            ui.ui_factory.show_user_warning(
 
1429
                'deprecated_command',
 
1430
                deprecated_name=self.invoked_as,
 
1431
                recommended_name='branch',
 
1432
                deprecated_in_version='2.4')
 
1433
        accelerator_tree, br_from = controldir.ControlDir.open_tree_or_branch(
 
1434
            from_location)
 
1435
        if not (hardlink or files_from):
 
1436
            # accelerator_tree is usually slower because you have to read N
 
1437
            # files (no readahead, lots of seeks, etc), but allow the user to
 
1438
            # explicitly request it
 
1439
            accelerator_tree = None
 
1440
        if files_from is not None and files_from != from_location:
 
1441
            accelerator_tree = WorkingTree.open(files_from)
 
1442
        revision = _get_one_revision('branch', revision)
 
1443
        self.add_cleanup(br_from.lock_read().unlock)
 
1444
        if revision is not None:
 
1445
            revision_id = revision.as_revision_id(br_from)
 
1446
        else:
 
1447
            # FIXME - wt.last_revision, fallback to branch, fall back to
 
1448
            # None or perhaps NULL_REVISION to mean copy nothing
 
1449
            # RBC 20060209
 
1450
            revision_id = br_from.last_revision()
 
1451
        if to_location is None:
 
1452
            to_location = getattr(br_from, "name", None)
 
1453
            if not to_location:
855
1454
                to_location = urlutils.derive_to_location(from_location)
856
 
                name = None
 
1455
        to_transport = transport.get_transport(to_location)
 
1456
        try:
 
1457
            to_transport.mkdir('.')
 
1458
        except errors.FileExists:
 
1459
            try:
 
1460
                to_dir = controldir.ControlDir.open_from_transport(
 
1461
                    to_transport)
 
1462
            except errors.NotBranchError:
 
1463
                if not use_existing_dir:
 
1464
                    raise errors.BzrCommandError(gettext('Target directory "%s" '
 
1465
                        'already exists.') % to_location)
 
1466
                else:
 
1467
                    to_dir = None
857
1468
            else:
858
 
                name = os.path.basename(to_location) + '\n'
859
 
 
860
 
            to_transport = transport.get_transport(to_location)
861
 
            try:
862
 
                to_transport.mkdir('.')
863
 
            except errors.FileExists:
864
 
                raise errors.BzrCommandError('Target directory "%s" already'
865
 
                                             ' exists.' % to_location)
866
 
            except errors.NoSuchFile:
867
 
                raise errors.BzrCommandError('Parent of "%s" does not exist.'
868
 
                                             % to_location)
 
1469
                try:
 
1470
                    to_dir.open_branch()
 
1471
                except errors.NotBranchError:
 
1472
                    pass
 
1473
                else:
 
1474
                    raise errors.AlreadyBranchError(to_location)
 
1475
        except errors.NoSuchFile:
 
1476
            raise errors.BzrCommandError(gettext('Parent of "%s" does not exist.')
 
1477
                                         % to_location)
 
1478
        else:
 
1479
            to_dir = None
 
1480
        if to_dir is None:
869
1481
            try:
870
1482
                # preserve whatever source format we have.
871
 
                dir = br_from.bzrdir.sprout(to_transport.base, revision_id)
872
 
                branch = dir.open_branch()
 
1483
                to_dir = br_from.bzrdir.sprout(to_transport.base, revision_id,
 
1484
                                            possible_transports=[to_transport],
 
1485
                                            accelerator_tree=accelerator_tree,
 
1486
                                            hardlink=hardlink, stacked=stacked,
 
1487
                                            force_new_repo=standalone,
 
1488
                                            create_tree_if_local=not no_tree,
 
1489
                                            source_branch=br_from)
 
1490
                branch = to_dir.open_branch(
 
1491
                    possible_transports=[
 
1492
                        br_from.bzrdir.root_transport, to_transport])
873
1493
            except errors.NoSuchRevision:
874
1494
                to_transport.delete_tree('.')
875
 
                msg = "The branch %s has no revision %s." % (from_location, revision[0])
 
1495
                msg = gettext("The branch {0} has no revision {1}.").format(
 
1496
                    from_location, revision)
876
1497
                raise errors.BzrCommandError(msg)
877
 
            if name:
878
 
                branch.control_files.put_utf8('branch-name', name)
879
 
            _merge_tags_if_possible(br_from, branch)
880
 
            note('Branched %d revision(s).' % branch.revno())
881
 
        finally:
882
 
            br_from.unlock()
 
1498
        else:
 
1499
            try:
 
1500
                to_repo = to_dir.open_repository()
 
1501
            except errors.NoRepositoryPresent:
 
1502
                to_repo = to_dir.create_repository()
 
1503
            to_repo.fetch(br_from.repository, revision_id=revision_id)
 
1504
            branch = br_from.sprout(to_dir, revision_id=revision_id)
 
1505
        _merge_tags_if_possible(br_from, branch)
 
1506
        # If the source branch is stacked, the new branch may
 
1507
        # be stacked whether we asked for that explicitly or not.
 
1508
        # We therefore need a try/except here and not just 'if stacked:'
 
1509
        try:
 
1510
            note(gettext('Created new stacked branch referring to %s.') %
 
1511
                branch.get_stacked_on_url())
 
1512
        except (errors.NotStacked, errors.UnstackableBranchFormat,
 
1513
            errors.UnstackableRepositoryFormat), e:
 
1514
            note(ngettext('Branched %d revision.', 'Branched %d revisions.', branch.revno()) % branch.revno())
 
1515
        if bind:
 
1516
            # Bind to the parent
 
1517
            parent_branch = Branch.open(from_location)
 
1518
            branch.bind(parent_branch)
 
1519
            note(gettext('New branch bound to %s') % from_location)
 
1520
        if switch:
 
1521
            # Switch to the new branch
 
1522
            wt, _ = WorkingTree.open_containing('.')
 
1523
            _mod_switch.switch(wt.bzrdir, branch)
 
1524
            note(gettext('Switched to branch: %s'),
 
1525
                urlutils.unescape_for_display(branch.base, 'utf-8'))
 
1526
 
 
1527
 
 
1528
class cmd_branches(Command):
 
1529
    __doc__ = """List the branches available at the current location.
 
1530
 
 
1531
    This command will print the names of all the branches at the current
 
1532
    location.
 
1533
    """
 
1534
 
 
1535
    takes_args = ['location?']
 
1536
    takes_options = [
 
1537
                  Option('recursive', short_name='R',
 
1538
                         help='Recursively scan for branches rather than '
 
1539
                              'just looking in the specified location.')]
 
1540
 
 
1541
    def run(self, location=".", recursive=False):
 
1542
        if recursive:
 
1543
            t = transport.get_transport(location)
 
1544
            if not t.listable():
 
1545
                raise errors.BzrCommandError(
 
1546
                    "Can't scan this type of location.")
 
1547
            for b in controldir.ControlDir.find_branches(t):
 
1548
                self.outf.write("%s\n" % urlutils.unescape_for_display(
 
1549
                    urlutils.relative_url(t.base, b.base),
 
1550
                    self.outf.encoding).rstrip("/"))
 
1551
        else:
 
1552
            dir = controldir.ControlDir.open_containing(location)[0]
 
1553
            try:
 
1554
                active_branch = dir.open_branch(name="")
 
1555
            except errors.NotBranchError:
 
1556
                active_branch = None
 
1557
            names = {}
 
1558
            for name, branch in iter_sibling_branches(dir):
 
1559
                if name == "":
 
1560
                    continue
 
1561
                active = (active_branch is not None and
 
1562
                          active_branch.base == branch.base)
 
1563
                names[name] = active
 
1564
            # Only mention the current branch explicitly if it's not
 
1565
            # one of the colocated branches
 
1566
            if not any(names.values()) and active_branch is not None:
 
1567
                self.outf.write("* %s\n" % gettext("(default)"))
 
1568
            for name in sorted(names.keys()):
 
1569
                active = names[name]
 
1570
                if active:
 
1571
                    prefix = "*"
 
1572
                else:
 
1573
                    prefix = " "
 
1574
                self.outf.write("%s %s\n" % (
 
1575
                    prefix, name.encode(self.outf.encoding)))
883
1576
 
884
1577
 
885
1578
class cmd_checkout(Command):
886
 
    """Create a new checkout of an existing branch.
 
1579
    __doc__ = """Create a new checkout of an existing branch.
887
1580
 
888
1581
    If BRANCH_LOCATION is omitted, checkout will reconstitute a working tree for
889
1582
    the branch found in '.'. This is useful if you have removed the working tree
890
1583
    or if it was never created - i.e. if you pushed the branch to its current
891
1584
    location using SFTP.
892
 
    
 
1585
 
893
1586
    If the TO_LOCATION is omitted, the last component of the BRANCH_LOCATION will
894
1587
    be used.  In other words, "checkout ../foo/bar" will attempt to create ./bar.
895
1588
    If the BRANCH_LOCATION has no / or path separator embedded, the TO_LOCATION
907
1600
    takes_args = ['branch_location?', 'to_location?']
908
1601
    takes_options = ['revision',
909
1602
                     Option('lightweight',
910
 
                            help="perform a lightweight checkout. Lightweight "
 
1603
                            help="Perform a lightweight checkout.  Lightweight "
911
1604
                                 "checkouts depend on access to the branch for "
912
 
                                 "every operation. Normal checkouts can perform "
 
1605
                                 "every operation.  Normal checkouts can perform "
913
1606
                                 "common operations like diff and status without "
914
1607
                                 "such access, and also support local commits."
915
1608
                            ),
 
1609
                     Option('files-from', type=str,
 
1610
                            help="Get file contents from this tree."),
 
1611
                     Option('hardlink',
 
1612
                            help='Hard-link working tree files where possible.'
 
1613
                            ),
916
1614
                     ]
917
1615
    aliases = ['co']
918
1616
 
919
1617
    def run(self, branch_location=None, to_location=None, revision=None,
920
 
            lightweight=False):
921
 
        if revision is None:
922
 
            revision = [None]
923
 
        elif len(revision) > 1:
924
 
            raise errors.BzrCommandError(
925
 
                'bzr checkout --revision takes exactly 1 revision value')
 
1618
            lightweight=False, files_from=None, hardlink=False):
926
1619
        if branch_location is None:
927
1620
            branch_location = osutils.getcwd()
928
1621
            to_location = branch_location
929
 
        source = Branch.open(branch_location)
930
 
        if len(revision) == 1 and revision[0] is not None:
931
 
            revision_id = revision[0].in_history(source)[1]
 
1622
        accelerator_tree, source = controldir.ControlDir.open_tree_or_branch(
 
1623
            branch_location)
 
1624
        if not (hardlink or files_from):
 
1625
            # accelerator_tree is usually slower because you have to read N
 
1626
            # files (no readahead, lots of seeks, etc), but allow the user to
 
1627
            # explicitly request it
 
1628
            accelerator_tree = None
 
1629
        revision = _get_one_revision('checkout', revision)
 
1630
        if files_from is not None and files_from != branch_location:
 
1631
            accelerator_tree = WorkingTree.open(files_from)
 
1632
        if revision is not None:
 
1633
            revision_id = revision.as_revision_id(source)
932
1634
        else:
933
1635
            revision_id = None
934
1636
        if to_location is None:
935
1637
            to_location = urlutils.derive_to_location(branch_location)
936
 
        # if the source and to_location are the same, 
 
1638
        # if the source and to_location are the same,
937
1639
        # and there is no working tree,
938
1640
        # then reconstitute a branch
939
1641
        if (osutils.abspath(to_location) ==
941
1643
            try:
942
1644
                source.bzrdir.open_workingtree()
943
1645
            except errors.NoWorkingTree:
944
 
                source.bzrdir.create_workingtree()
 
1646
                source.bzrdir.create_workingtree(revision_id)
945
1647
                return
946
 
        try:
947
 
            os.mkdir(to_location)
948
 
        except OSError, e:
949
 
            if e.errno == errno.EEXIST:
950
 
                raise errors.BzrCommandError('Target directory "%s" already'
951
 
                                             ' exists.' % to_location)
952
 
            if e.errno == errno.ENOENT:
953
 
                raise errors.BzrCommandError('Parent of "%s" does not exist.'
954
 
                                             % to_location)
955
 
            else:
956
 
                raise
957
 
        source.create_checkout(to_location, revision_id, lightweight)
 
1648
        source.create_checkout(to_location, revision_id, lightweight,
 
1649
                               accelerator_tree, hardlink)
958
1650
 
959
1651
 
960
1652
class cmd_renames(Command):
961
 
    """Show list of renamed files.
 
1653
    __doc__ = """Show list of renamed files.
962
1654
    """
963
1655
    # TODO: Option to show renames between two historical versions.
964
1656
 
969
1661
    @display_command
970
1662
    def run(self, dir=u'.'):
971
1663
        tree = WorkingTree.open_containing(dir)[0]
972
 
        tree.lock_read()
973
 
        try:
974
 
            new_inv = tree.inventory
975
 
            old_tree = tree.basis_tree()
976
 
            old_tree.lock_read()
977
 
            try:
978
 
                old_inv = old_tree.inventory
979
 
                renames = list(_mod_tree.find_renames(old_inv, new_inv))
980
 
                renames.sort()
981
 
                for old_name, new_name in renames:
982
 
                    self.outf.write("%s => %s\n" % (old_name, new_name))
983
 
            finally:
984
 
                old_tree.unlock()
985
 
        finally:
986
 
            tree.unlock()
 
1664
        self.add_cleanup(tree.lock_read().unlock)
 
1665
        old_tree = tree.basis_tree()
 
1666
        self.add_cleanup(old_tree.lock_read().unlock)
 
1667
        renames = []
 
1668
        iterator = tree.iter_changes(old_tree, include_unchanged=True)
 
1669
        for f, paths, c, v, p, n, k, e in iterator:
 
1670
            if paths[0] == paths[1]:
 
1671
                continue
 
1672
            if None in (paths):
 
1673
                continue
 
1674
            renames.append(paths)
 
1675
        renames.sort()
 
1676
        for old_name, new_name in renames:
 
1677
            self.outf.write("%s => %s\n" % (old_name, new_name))
987
1678
 
988
1679
 
989
1680
class cmd_update(Command):
990
 
    """Update a tree to have the latest code committed to its branch.
991
 
    
992
 
    This will perform a merge into the working tree, and may generate
993
 
    conflicts. If you have any local changes, you will still 
994
 
    need to commit them after the update for the update to be complete.
995
 
    
996
 
    If you want to discard your local changes, you can just do a 
997
 
    'bzr revert' instead of 'bzr commit' after the update.
 
1681
    __doc__ = """Update a working tree to a new revision.
 
1682
 
 
1683
    This will perform a merge of the destination revision (the tip of the
 
1684
    branch, or the specified revision) into the working tree, and then make
 
1685
    that revision the basis revision for the working tree.  
 
1686
 
 
1687
    You can use this to visit an older revision, or to update a working tree
 
1688
    that is out of date from its branch.
 
1689
    
 
1690
    If there are any uncommitted changes in the tree, they will be carried
 
1691
    across and remain as uncommitted changes after the update.  To discard
 
1692
    these changes, use 'bzr revert'.  The uncommitted changes may conflict
 
1693
    with the changes brought in by the change in basis revision.
 
1694
 
 
1695
    If the tree's branch is bound to a master branch, bzr will also update
 
1696
    the branch from the master.
 
1697
 
 
1698
    You cannot update just a single file or directory, because each Bazaar
 
1699
    working tree has just a single basis revision.  If you want to restore a
 
1700
    file that has been removed locally, use 'bzr revert' instead of 'bzr
 
1701
    update'.  If you want to restore a file to its state in a previous
 
1702
    revision, use 'bzr revert' with a '-r' option, or use 'bzr cat' to write
 
1703
    out the old content of that file to a new location.
 
1704
 
 
1705
    The 'dir' argument, if given, must be the location of the root of a
 
1706
    working tree to update.  By default, the working tree that contains the 
 
1707
    current working directory is used.
998
1708
    """
999
1709
 
1000
 
    _see_also = ['pull', 'working-trees']
 
1710
    _see_also = ['pull', 'working-trees', 'status-flags']
1001
1711
    takes_args = ['dir?']
 
1712
    takes_options = ['revision',
 
1713
                     Option('show-base',
 
1714
                            help="Show base revision text in conflicts."),
 
1715
                     ]
1002
1716
    aliases = ['up']
1003
1717
 
1004
 
    def run(self, dir='.'):
1005
 
        tree = WorkingTree.open_containing(dir)[0]
1006
 
        master = tree.branch.get_master_branch()
 
1718
    def run(self, dir=None, revision=None, show_base=None):
 
1719
        if revision is not None and len(revision) != 1:
 
1720
            raise errors.BzrCommandError(gettext(
 
1721
                "bzr update --revision takes exactly one revision"))
 
1722
        if dir is None:
 
1723
            tree = WorkingTree.open_containing('.')[0]
 
1724
        else:
 
1725
            tree, relpath = WorkingTree.open_containing(dir)
 
1726
            if relpath:
 
1727
                # See bug 557886.
 
1728
                raise errors.BzrCommandError(gettext(
 
1729
                    "bzr update can only update a whole tree, "
 
1730
                    "not a file or subdirectory"))
 
1731
        branch = tree.branch
 
1732
        possible_transports = []
 
1733
        master = branch.get_master_branch(
 
1734
            possible_transports=possible_transports)
1007
1735
        if master is not None:
 
1736
            branch_location = master.base
1008
1737
            tree.lock_write()
1009
1738
        else:
 
1739
            branch_location = tree.branch.base
1010
1740
            tree.lock_tree_write()
 
1741
        self.add_cleanup(tree.unlock)
 
1742
        # get rid of the final '/' and be ready for display
 
1743
        branch_location = urlutils.unescape_for_display(
 
1744
            branch_location.rstrip('/'),
 
1745
            self.outf.encoding)
 
1746
        existing_pending_merges = tree.get_parent_ids()[1:]
 
1747
        if master is None:
 
1748
            old_tip = None
 
1749
        else:
 
1750
            # may need to fetch data into a heavyweight checkout
 
1751
            # XXX: this may take some time, maybe we should display a
 
1752
            # message
 
1753
            old_tip = branch.update(possible_transports)
 
1754
        if revision is not None:
 
1755
            revision_id = revision[0].as_revision_id(branch)
 
1756
        else:
 
1757
            revision_id = branch.last_revision()
 
1758
        if revision_id == _mod_revision.ensure_null(tree.last_revision()):
 
1759
            revno = branch.revision_id_to_dotted_revno(revision_id)
 
1760
            note(gettext("Tree is up to date at revision {0} of branch {1}"
 
1761
                        ).format('.'.join(map(str, revno)), branch_location))
 
1762
            return 0
 
1763
        view_info = _get_view_info_for_change_reporter(tree)
 
1764
        change_reporter = delta._ChangeReporter(
 
1765
            unversioned_filter=tree.is_ignored,
 
1766
            view_info=view_info)
1011
1767
        try:
1012
 
            existing_pending_merges = tree.get_parent_ids()[1:]
1013
 
            last_rev = tree.last_revision()
1014
 
            if last_rev == tree.branch.last_revision():
1015
 
                # may be up to date, check master too.
1016
 
                master = tree.branch.get_master_branch()
1017
 
                if master is None or last_rev == master.last_revision():
1018
 
                    revno = tree.branch.revision_id_to_revno(last_rev)
1019
 
                    note("Tree is up to date at revision %d." % (revno,))
1020
 
                    return 0
1021
 
            conflicts = tree.update(delta._ChangeReporter(
1022
 
                                        unversioned_filter=tree.is_ignored))
1023
 
            revno = tree.branch.revision_id_to_revno(tree.last_revision())
1024
 
            note('Updated to revision %d.' % (revno,))
1025
 
            if tree.get_parent_ids()[1:] != existing_pending_merges:
1026
 
                note('Your local commits will now show as pending merges with '
1027
 
                     "'bzr status', and can be committed with 'bzr commit'.")
1028
 
            if conflicts != 0:
1029
 
                return 1
1030
 
            else:
1031
 
                return 0
1032
 
        finally:
1033
 
            tree.unlock()
 
1768
            conflicts = tree.update(
 
1769
                change_reporter,
 
1770
                possible_transports=possible_transports,
 
1771
                revision=revision_id,
 
1772
                old_tip=old_tip,
 
1773
                show_base=show_base)
 
1774
        except errors.NoSuchRevision, e:
 
1775
            raise errors.BzrCommandError(gettext(
 
1776
                                  "branch has no revision %s\n"
 
1777
                                  "bzr update --revision only works"
 
1778
                                  " for a revision in the branch history")
 
1779
                                  % (e.revision))
 
1780
        revno = tree.branch.revision_id_to_dotted_revno(
 
1781
            _mod_revision.ensure_null(tree.last_revision()))
 
1782
        note(gettext('Updated to revision {0} of branch {1}').format(
 
1783
             '.'.join(map(str, revno)), branch_location))
 
1784
        parent_ids = tree.get_parent_ids()
 
1785
        if parent_ids[1:] and parent_ids[1:] != existing_pending_merges:
 
1786
            note(gettext('Your local commits will now show as pending merges with '
 
1787
                 "'bzr status', and can be committed with 'bzr commit'."))
 
1788
        if conflicts != 0:
 
1789
            return 1
 
1790
        else:
 
1791
            return 0
1034
1792
 
1035
1793
 
1036
1794
class cmd_info(Command):
1037
 
    """Show information about a working tree, branch or repository.
 
1795
    __doc__ = """Show information about a working tree, branch or repository.
1038
1796
 
1039
1797
    This command will show all known locations and formats associated to the
1040
 
    tree, branch or repository.  Statistical information is included with
1041
 
    each report.
 
1798
    tree, branch or repository.
 
1799
 
 
1800
    In verbose mode, statistical information is included with each report.
 
1801
    To see extended statistic information, use a verbosity level of 2 or
 
1802
    higher by specifying the verbose option multiple times, e.g. -vv.
1042
1803
 
1043
1804
    Branches and working trees will also report any missing revisions.
 
1805
 
 
1806
    :Examples:
 
1807
 
 
1808
      Display information on the format and related locations:
 
1809
 
 
1810
        bzr info
 
1811
 
 
1812
      Display the above together with extended format information and
 
1813
      basic statistics (like the number of files in the working tree and
 
1814
      number of revisions in the branch and repository):
 
1815
 
 
1816
        bzr info -v
 
1817
 
 
1818
      Display the above together with number of committers to the branch:
 
1819
 
 
1820
        bzr info -vv
1044
1821
    """
1045
1822
    _see_also = ['revno', 'working-trees', 'repositories']
1046
1823
    takes_args = ['location?']
1047
1824
    takes_options = ['verbose']
 
1825
    encoding_type = 'replace'
1048
1826
 
1049
1827
    @display_command
1050
 
    def run(self, location=None, verbose=0):
 
1828
    def run(self, location=None, verbose=False):
 
1829
        if verbose:
 
1830
            noise_level = get_verbosity_level()
 
1831
        else:
 
1832
            noise_level = 0
1051
1833
        from bzrlib.info import show_bzrdir_info
1052
 
        show_bzrdir_info(bzrdir.BzrDir.open_containing(location)[0],
1053
 
                         verbose=verbose)
 
1834
        show_bzrdir_info(controldir.ControlDir.open_containing(location)[0],
 
1835
                         verbose=noise_level, outfile=self.outf)
1054
1836
 
1055
1837
 
1056
1838
class cmd_remove(Command):
1057
 
    """Remove files or directories.
1058
 
 
1059
 
    This makes bzr stop tracking changes to the specified files and
1060
 
    delete them if they can easily be recovered using revert.
1061
 
 
1062
 
    You can specify one or more files, and/or --new.  If you specify --new,
1063
 
    only 'added' files will be removed.  If you specify both, then new files
1064
 
    in the specified directories will be removed.  If the directories are
1065
 
    also new, they will also be removed.
 
1839
    __doc__ = """Remove files or directories.
 
1840
 
 
1841
    This makes Bazaar stop tracking changes to the specified files. Bazaar will
 
1842
    delete them if they can easily be recovered using revert otherwise they
 
1843
    will be backed up (adding an extension of the form .~#~). If no options or
 
1844
    parameters are given Bazaar will scan for files that are being tracked by
 
1845
    Bazaar but missing in your tree and stop tracking them for you.
1066
1846
    """
1067
1847
    takes_args = ['file*']
1068
1848
    takes_options = ['verbose',
1069
 
        Option('new', help='remove newly-added files'),
 
1849
        Option('new', help='Only remove files that have never been committed.'),
1070
1850
        RegistryOption.from_kwargs('file-deletion-strategy',
1071
 
            'The file deletion mode to be used',
 
1851
            'The file deletion mode to be used.',
1072
1852
            title='Deletion Strategy', value_switches=True, enum_switch=False,
1073
 
            safe='Only delete files if they can be'
1074
 
                 ' safely recovered (default).',
1075
 
            keep="Don't delete any files.",
 
1853
            safe='Backup changed files (default).',
 
1854
            keep='Delete from bzr but leave the working copy.',
 
1855
            no_backup='Don\'t backup changed files.',
1076
1856
            force='Delete all the specified files, even if they can not be '
1077
 
                'recovered and even if they are non-empty directories.')]
1078
 
    aliases = ['rm']
 
1857
                'recovered and even if they are non-empty directories. '
 
1858
                '(deprecated, use no-backup)')]
 
1859
    aliases = ['rm', 'del']
1079
1860
    encoding_type = 'replace'
1080
1861
 
1081
1862
    def run(self, file_list, verbose=False, new=False,
1082
1863
        file_deletion_strategy='safe'):
1083
 
        tree, file_list = tree_files(file_list)
 
1864
        if file_deletion_strategy == 'force':
 
1865
            note(gettext("(The --force option is deprecated, rather use --no-backup "
 
1866
                "in future.)"))
 
1867
            file_deletion_strategy = 'no-backup'
 
1868
 
 
1869
        tree, file_list = WorkingTree.open_containing_paths(file_list)
1084
1870
 
1085
1871
        if file_list is not None:
1086
 
            file_list = [f for f in file_list if f != '']
1087
 
        elif not new:
1088
 
            raise errors.BzrCommandError('Specify one or more files to'
1089
 
            ' remove, or use --new.')
 
1872
            file_list = [f for f in file_list]
1090
1873
 
 
1874
        self.add_cleanup(tree.lock_write().unlock)
 
1875
        # Heuristics should probably all move into tree.remove_smart or
 
1876
        # some such?
1091
1877
        if new:
1092
1878
            added = tree.changes_from(tree.basis_tree(),
1093
1879
                specific_files=file_list).added
1094
1880
            file_list = sorted([f[0] for f in added], reverse=True)
1095
1881
            if len(file_list) == 0:
1096
 
                raise errors.BzrCommandError('No matching files.')
 
1882
                raise errors.BzrCommandError(gettext('No matching files.'))
 
1883
        elif file_list is None:
 
1884
            # missing files show up in iter_changes(basis) as
 
1885
            # versioned-with-no-kind.
 
1886
            missing = []
 
1887
            for change in tree.iter_changes(tree.basis_tree()):
 
1888
                # Find paths in the working tree that have no kind:
 
1889
                if change[1][1] is not None and change[6][1] is None:
 
1890
                    missing.append(change[1][1])
 
1891
            file_list = sorted(missing, reverse=True)
 
1892
            file_deletion_strategy = 'keep'
1097
1893
        tree.remove(file_list, verbose=verbose, to_file=self.outf,
1098
1894
            keep_files=file_deletion_strategy=='keep',
1099
 
            force=file_deletion_strategy=='force')
 
1895
            force=(file_deletion_strategy=='no-backup'))
1100
1896
 
1101
1897
 
1102
1898
class cmd_file_id(Command):
1103
 
    """Print file_id of a particular file or directory.
 
1899
    __doc__ = """Print file_id of a particular file or directory.
1104
1900
 
1105
1901
    The file_id is assigned when the file is first added and remains the
1106
1902
    same through all revisions where the file exists, even when it is
1122
1918
 
1123
1919
 
1124
1920
class cmd_file_path(Command):
1125
 
    """Print path of file_ids to a file or directory.
 
1921
    __doc__ = """Print path of file_ids to a file or directory.
1126
1922
 
1127
1923
    This prints one line for each directory down to the target,
1128
1924
    starting at the branch root.
1144
1940
 
1145
1941
 
1146
1942
class cmd_reconcile(Command):
1147
 
    """Reconcile bzr metadata in a branch.
 
1943
    __doc__ = """Reconcile bzr metadata in a branch.
1148
1944
 
1149
1945
    This can correct data mismatches that may have been caused by
1150
1946
    previous ghost operations or bzr upgrades. You should only
1151
 
    need to run this command if 'bzr check' or a bzr developer 
 
1947
    need to run this command if 'bzr check' or a bzr developer
1152
1948
    advises you to run it.
1153
1949
 
1154
1950
    If a second branch is provided, cross-branch reconciliation is
1156
1952
    id which was not present in very early bzr versions is represented
1157
1953
    correctly in both branches.
1158
1954
 
1159
 
    At the same time it is run it may recompress data resulting in 
 
1955
    At the same time it is run it may recompress data resulting in
1160
1956
    a potential saving in disk space or performance gain.
1161
1957
 
1162
1958
    The branch *MUST* be on a listable system such as local disk or sftp.
1164
1960
 
1165
1961
    _see_also = ['check']
1166
1962
    takes_args = ['branch?']
 
1963
    takes_options = [
 
1964
        Option('canonicalize-chks',
 
1965
               help='Make sure CHKs are in canonical form (repairs '
 
1966
                    'bug 522637).',
 
1967
               hidden=True),
 
1968
        ]
1167
1969
 
1168
 
    def run(self, branch="."):
 
1970
    def run(self, branch=".", canonicalize_chks=False):
1169
1971
        from bzrlib.reconcile import reconcile
1170
 
        dir = bzrdir.BzrDir.open(branch)
1171
 
        reconcile(dir)
 
1972
        dir = controldir.ControlDir.open(branch)
 
1973
        reconcile(dir, canonicalize_chks=canonicalize_chks)
1172
1974
 
1173
1975
 
1174
1976
class cmd_revision_history(Command):
1175
 
    """Display the list of revision ids on a branch."""
 
1977
    __doc__ = """Display the list of revision ids on a branch."""
1176
1978
 
1177
1979
    _see_also = ['log']
1178
1980
    takes_args = ['location?']
1182
1984
    @display_command
1183
1985
    def run(self, location="."):
1184
1986
        branch = Branch.open_containing(location)[0]
1185
 
        for revid in branch.revision_history():
 
1987
        self.add_cleanup(branch.lock_read().unlock)
 
1988
        graph = branch.repository.get_graph()
 
1989
        history = list(graph.iter_lefthand_ancestry(branch.last_revision(),
 
1990
            [_mod_revision.NULL_REVISION]))
 
1991
        for revid in reversed(history):
1186
1992
            self.outf.write(revid)
1187
1993
            self.outf.write('\n')
1188
1994
 
1189
1995
 
1190
1996
class cmd_ancestry(Command):
1191
 
    """List all revisions merged into this branch."""
 
1997
    __doc__ = """List all revisions merged into this branch."""
1192
1998
 
1193
1999
    _see_also = ['log', 'revision-history']
1194
2000
    takes_args = ['location?']
1206
2012
            b = wt.branch
1207
2013
            last_revision = wt.last_revision()
1208
2014
 
1209
 
        revision_ids = b.repository.get_ancestry(last_revision)
1210
 
        assert revision_ids[0] is None
1211
 
        revision_ids.pop(0)
1212
 
        for revision_id in revision_ids:
 
2015
        self.add_cleanup(b.repository.lock_read().unlock)
 
2016
        graph = b.repository.get_graph()
 
2017
        revisions = [revid for revid, parents in
 
2018
            graph.iter_ancestry([last_revision])]
 
2019
        for revision_id in reversed(revisions):
 
2020
            if _mod_revision.is_null(revision_id):
 
2021
                continue
1213
2022
            self.outf.write(revision_id + '\n')
1214
2023
 
1215
2024
 
1216
2025
class cmd_init(Command):
1217
 
    """Make a directory into a versioned branch.
 
2026
    __doc__ = """Make a directory into a versioned branch.
1218
2027
 
1219
2028
    Use this to create an empty branch, or before importing an
1220
2029
    existing project.
1221
2030
 
1222
 
    If there is a repository in a parent directory of the location, then 
 
2031
    If there is a repository in a parent directory of the location, then
1223
2032
    the history of the branch will be stored in the repository.  Otherwise
1224
2033
    init creates a standalone branch which carries its own history
1225
2034
    in the .bzr directory.
1227
2036
    If there is already a branch at the location but it has no working tree,
1228
2037
    the tree can be populated with 'bzr checkout'.
1229
2038
 
1230
 
    Recipe for importing a tree of files:
 
2039
    Recipe for importing a tree of files::
 
2040
 
1231
2041
        cd ~/project
1232
2042
        bzr init
1233
2043
        bzr add .
1234
2044
        bzr status
1235
 
        bzr commit -m 'imported project'
 
2045
        bzr commit -m "imported project"
1236
2046
    """
1237
2047
 
1238
 
    _see_also = ['init-repo', 'branch', 'checkout']
 
2048
    _see_also = ['init-repository', 'branch', 'checkout']
1239
2049
    takes_args = ['location?']
1240
2050
    takes_options = [
1241
2051
        Option('create-prefix',
1242
2052
               help='Create the path leading up to the branch '
1243
 
                    'if it does not already exist'),
 
2053
                    'if it does not already exist.'),
1244
2054
         RegistryOption('format',
1245
2055
                help='Specify a format for this branch. '
1246
2056
                'See "help formats".',
1247
 
                registry=bzrdir.format_registry,
1248
 
                converter=bzrdir.format_registry.make_bzrdir,
 
2057
                lazy_registry=('bzrlib.controldir', 'format_registry'),
 
2058
                converter=lambda name: controldir.format_registry.make_bzrdir(name),
1249
2059
                value_switches=True,
1250
 
                title="Branch Format",
 
2060
                title="Branch format",
1251
2061
                ),
1252
2062
         Option('append-revisions-only',
1253
2063
                help='Never change revnos or the existing log.'
1254
 
                '  Append revisions to it only.')
 
2064
                '  Append revisions to it only.'),
 
2065
         Option('no-tree',
 
2066
                'Create a branch without a working tree.')
1255
2067
         ]
1256
2068
    def run(self, location=None, format=None, append_revisions_only=False,
1257
 
            create_prefix=False):
 
2069
            create_prefix=False, no_tree=False):
1258
2070
        if format is None:
1259
 
            format = bzrdir.format_registry.make_bzrdir('default')
 
2071
            format = controldir.format_registry.make_bzrdir('default')
1260
2072
        if location is None:
1261
2073
            location = u'.'
1262
2074
 
1271
2083
            to_transport.ensure_base()
1272
2084
        except errors.NoSuchFile:
1273
2085
            if not create_prefix:
1274
 
                raise errors.BzrCommandError("Parent directory of %s"
 
2086
                raise errors.BzrCommandError(gettext("Parent directory of %s"
1275
2087
                    " does not exist."
1276
2088
                    "\nYou may supply --create-prefix to create all"
1277
 
                    " leading parent directories."
 
2089
                    " leading parent directories.")
1278
2090
                    % location)
1279
 
            _create_prefix(to_transport)
 
2091
            to_transport.create_prefix()
1280
2092
 
1281
2093
        try:
1282
 
            existing_bzrdir = bzrdir.BzrDir.open(location)
 
2094
            a_bzrdir = controldir.ControlDir.open_from_transport(to_transport)
1283
2095
        except errors.NotBranchError:
1284
2096
            # really a NotBzrDir error...
1285
 
            branch = bzrdir.BzrDir.create_branch_convenience(to_transport.base,
1286
 
                                                             format=format)
 
2097
            create_branch = controldir.ControlDir.create_branch_convenience
 
2098
            if no_tree:
 
2099
                force_new_tree = False
 
2100
            else:
 
2101
                force_new_tree = None
 
2102
            branch = create_branch(to_transport.base, format=format,
 
2103
                                   possible_transports=[to_transport],
 
2104
                                   force_new_tree=force_new_tree)
 
2105
            a_bzrdir = branch.bzrdir
1287
2106
        else:
1288
2107
            from bzrlib.transport.local import LocalTransport
1289
 
            if existing_bzrdir.has_branch():
 
2108
            if a_bzrdir.has_branch():
1290
2109
                if (isinstance(to_transport, LocalTransport)
1291
 
                    and not existing_bzrdir.has_workingtree()):
 
2110
                    and not a_bzrdir.has_workingtree()):
1292
2111
                        raise errors.BranchExistsWithoutWorkingTree(location)
1293
2112
                raise errors.AlreadyBranchError(location)
1294
 
            else:
1295
 
                branch = existing_bzrdir.create_branch()
1296
 
                existing_bzrdir.create_workingtree()
 
2113
            branch = a_bzrdir.create_branch()
 
2114
            if not no_tree and not a_bzrdir.has_workingtree():
 
2115
                a_bzrdir.create_workingtree()
1297
2116
        if append_revisions_only:
1298
2117
            try:
1299
2118
                branch.set_append_revisions_only(True)
1300
2119
            except errors.UpgradeRequired:
1301
 
                raise errors.BzrCommandError('This branch format cannot be set'
1302
 
                    ' to append-revisions-only.  Try --experimental-branch6')
 
2120
                raise errors.BzrCommandError(gettext('This branch format cannot be set'
 
2121
                    ' to append-revisions-only.  Try --default.'))
 
2122
        if not is_quiet():
 
2123
            from bzrlib.info import describe_layout, describe_format
 
2124
            try:
 
2125
                tree = a_bzrdir.open_workingtree(recommend_upgrade=False)
 
2126
            except (errors.NoWorkingTree, errors.NotLocalUrl):
 
2127
                tree = None
 
2128
            repository = branch.repository
 
2129
            layout = describe_layout(repository, branch, tree).lower()
 
2130
            format = describe_format(a_bzrdir, repository, branch, tree)
 
2131
            self.outf.write(gettext("Created a {0} (format: {1})\n").format(
 
2132
                  layout, format))
 
2133
            if repository.is_shared():
 
2134
                #XXX: maybe this can be refactored into transport.path_or_url()
 
2135
                url = repository.bzrdir.root_transport.external_url()
 
2136
                try:
 
2137
                    url = urlutils.local_path_from_url(url)
 
2138
                except errors.InvalidURL:
 
2139
                    pass
 
2140
                self.outf.write(gettext("Using shared repository: %s\n") % url)
1303
2141
 
1304
2142
 
1305
2143
class cmd_init_repository(Command):
1306
 
    """Create a shared repository to hold branches.
 
2144
    __doc__ = """Create a shared repository for branches to share storage space.
1307
2145
 
1308
2146
    New branches created under the repository directory will store their
1309
 
    revisions in the repository, not in the branch directory.
1310
 
 
1311
 
    If the --no-trees option is used then the branches in the repository
1312
 
    will not have working trees by default.
1313
 
 
1314
 
    example:
1315
 
        bzr init-repo --no-trees repo
1316
 
        bzr init repo/trunk
1317
 
        bzr checkout --lightweight repo/trunk trunk-checkout
1318
 
        cd trunk-checkout
1319
 
        (add files here)
1320
 
 
1321
 
    See 'bzr help repositories' for more information.
 
2147
    revisions in the repository, not in the branch directory.  For branches
 
2148
    with shared history, this reduces the amount of storage needed and 
 
2149
    speeds up the creation of new branches.
 
2150
 
 
2151
    If the --no-trees option is given then the branches in the repository
 
2152
    will not have working trees by default.  They will still exist as 
 
2153
    directories on disk, but they will not have separate copies of the 
 
2154
    files at a certain revision.  This can be useful for repositories that
 
2155
    store branches which are interacted with through checkouts or remote
 
2156
    branches, such as on a server.
 
2157
 
 
2158
    :Examples:
 
2159
        Create a shared repository holding just branches::
 
2160
 
 
2161
            bzr init-repo --no-trees repo
 
2162
            bzr init repo/trunk
 
2163
 
 
2164
        Make a lightweight checkout elsewhere::
 
2165
 
 
2166
            bzr checkout --lightweight repo/trunk trunk-checkout
 
2167
            cd trunk-checkout
 
2168
            (add files here)
1322
2169
    """
1323
2170
 
1324
 
    _see_also = ['init', 'branch', 'checkout']
 
2171
    _see_also = ['init', 'branch', 'checkout', 'repositories']
1325
2172
    takes_args = ["location"]
1326
2173
    takes_options = [RegistryOption('format',
1327
2174
                            help='Specify a format for this repository. See'
1328
 
                                 ' "bzr help formats" for details',
1329
 
                            registry=bzrdir.format_registry,
1330
 
                            converter=bzrdir.format_registry.make_bzrdir,
 
2175
                                 ' "bzr help formats" for details.',
 
2176
                            lazy_registry=('bzrlib.controldir', 'format_registry'),
 
2177
                            converter=lambda name: controldir.format_registry.make_bzrdir(name),
1331
2178
                            value_switches=True, title='Repository format'),
1332
2179
                     Option('no-trees',
1333
2180
                             help='Branches in the repository will default to'
1334
 
                                  ' not having a working tree'),
 
2181
                                  ' not having a working tree.'),
1335
2182
                    ]
1336
2183
    aliases = ["init-repo"]
1337
2184
 
1338
2185
    def run(self, location, format=None, no_trees=False):
1339
2186
        if format is None:
1340
 
            format = bzrdir.format_registry.make_bzrdir('default')
 
2187
            format = controldir.format_registry.make_bzrdir('default')
1341
2188
 
1342
2189
        if location is None:
1343
2190
            location = '.'
1344
2191
 
1345
2192
        to_transport = transport.get_transport(location)
1346
 
        to_transport.ensure_base()
1347
2193
 
1348
 
        newdir = format.initialize_on_transport(to_transport)
1349
 
        repo = newdir.create_repository(shared=True)
1350
 
        repo.set_make_working_trees(not no_trees)
 
2194
        (repo, newdir, require_stacking, repository_policy) = (
 
2195
            format.initialize_on_transport_ex(to_transport,
 
2196
            create_prefix=True, make_working_trees=not no_trees,
 
2197
            shared_repo=True, force_new_repo=True,
 
2198
            use_existing_dir=True,
 
2199
            repo_format_name=format.repository_format.get_format_string()))
 
2200
        if not is_quiet():
 
2201
            from bzrlib.info import show_bzrdir_info
 
2202
            show_bzrdir_info(newdir, verbose=0, outfile=self.outf)
1351
2203
 
1352
2204
 
1353
2205
class cmd_diff(Command):
1354
 
    """Show differences in the working tree or between revisions.
1355
 
    
1356
 
    If files are listed, only the changes in those files are listed.
1357
 
    Otherwise, all changes for the tree are listed.
 
2206
    __doc__ = """Show differences in the working tree, between revisions or branches.
 
2207
 
 
2208
    If no arguments are given, all changes for the current tree are listed.
 
2209
    If files are given, only the changes in those files are listed.
 
2210
    Remote and multiple branches can be compared by using the --old and
 
2211
    --new options. If not provided, the default for both is derived from
 
2212
    the first argument, if any, or the current tree if no arguments are
 
2213
    given.
1358
2214
 
1359
2215
    "bzr diff -p1" is equivalent to "bzr diff --prefix old/:new/", and
1360
2216
    produces patches suitable for "patch -p1".
1361
2217
 
1362
 
    examples:
1363
 
        bzr diff
1364
 
            Shows the difference in the working tree versus the last commit
1365
 
        bzr diff -r1
1366
 
            Difference between the working tree and revision 1
1367
 
        bzr diff -r1..2
1368
 
            Difference between revision 2 and revision 1
1369
 
        bzr diff --prefix old/:new/
1370
 
            Same as 'bzr diff' but prefix paths with old/ and new/
1371
 
        bzr diff bzr.mine bzr.dev
1372
 
            Show the differences between the two working trees
1373
 
        bzr diff foo.c
1374
 
            Show just the differences for 'foo.c'
 
2218
    Note that when using the -r argument with a range of revisions, the
 
2219
    differences are computed between the two specified revisions.  That
 
2220
    is, the command does not show the changes introduced by the first 
 
2221
    revision in the range.  This differs from the interpretation of 
 
2222
    revision ranges used by "bzr log" which includes the first revision
 
2223
    in the range.
 
2224
 
 
2225
    :Exit values:
 
2226
        1 - changed
 
2227
        2 - unrepresentable changes
 
2228
        3 - error
 
2229
        0 - no change
 
2230
 
 
2231
    :Examples:
 
2232
        Shows the difference in the working tree versus the last commit::
 
2233
 
 
2234
            bzr diff
 
2235
 
 
2236
        Difference between the working tree and revision 1::
 
2237
 
 
2238
            bzr diff -r1
 
2239
 
 
2240
        Difference between revision 3 and revision 1::
 
2241
 
 
2242
            bzr diff -r1..3
 
2243
 
 
2244
        Difference between revision 3 and revision 1 for branch xxx::
 
2245
 
 
2246
            bzr diff -r1..3 xxx
 
2247
 
 
2248
        The changes introduced by revision 2 (equivalent to -r1..2)::
 
2249
 
 
2250
            bzr diff -c2
 
2251
 
 
2252
        To see the changes introduced by revision X::
 
2253
        
 
2254
            bzr diff -cX
 
2255
 
 
2256
        Note that in the case of a merge, the -c option shows the changes
 
2257
        compared to the left hand parent. To see the changes against
 
2258
        another parent, use::
 
2259
 
 
2260
            bzr diff -r<chosen_parent>..X
 
2261
 
 
2262
        The changes between the current revision and the previous revision
 
2263
        (equivalent to -c-1 and -r-2..-1)
 
2264
 
 
2265
            bzr diff -r-2..
 
2266
 
 
2267
        Show just the differences for file NEWS::
 
2268
 
 
2269
            bzr diff NEWS
 
2270
 
 
2271
        Show the differences in working tree xxx for file NEWS::
 
2272
 
 
2273
            bzr diff xxx/NEWS
 
2274
 
 
2275
        Show the differences from branch xxx to this working tree:
 
2276
 
 
2277
            bzr diff --old xxx
 
2278
 
 
2279
        Show the differences between two branches for file NEWS::
 
2280
 
 
2281
            bzr diff --old xxx --new yyy NEWS
 
2282
 
 
2283
        Same as 'bzr diff' but prefix paths with old/ and new/::
 
2284
 
 
2285
            bzr diff --prefix old/:new/
 
2286
            
 
2287
        Show the differences using a custom diff program with options::
 
2288
        
 
2289
            bzr diff --using /usr/bin/diff --diff-options -wu
1375
2290
    """
1376
 
    # TODO: Option to use external diff command; could be GNU diff, wdiff,
1377
 
    #       or a graphical diff.
1378
 
 
1379
 
    # TODO: Python difflib is not exactly the same as unidiff; should
1380
 
    #       either fix it up or prefer to use an external diff.
1381
 
 
1382
 
    # TODO: Selected-file diff is inefficient and doesn't show you
1383
 
    #       deleted files.
1384
 
 
1385
 
    # TODO: This probably handles non-Unix newlines poorly.
1386
 
 
1387
2291
    _see_also = ['status']
1388
2292
    takes_args = ['file*']
1389
 
    takes_options = ['revision', 'diff-options',
 
2293
    takes_options = [
 
2294
        Option('diff-options', type=str,
 
2295
               help='Pass these options to the external diff program.'),
1390
2296
        Option('prefix', type=str,
1391
2297
               short_name='p',
1392
 
               help='Set prefixes to added to old and new filenames, as '
1393
 
                    'two values separated by a colon. (eg "old/:new/")'),
 
2298
               help='Set prefixes added to old and new filenames, as '
 
2299
                    'two values separated by a colon. (eg "old/:new/").'),
 
2300
        Option('old',
 
2301
            help='Branch/tree to compare from.',
 
2302
            type=unicode,
 
2303
            ),
 
2304
        Option('new',
 
2305
            help='Branch/tree to compare to.',
 
2306
            type=unicode,
 
2307
            ),
 
2308
        'revision',
 
2309
        'change',
 
2310
        Option('using',
 
2311
            help='Use this command to compare files.',
 
2312
            type=unicode,
 
2313
            ),
 
2314
        RegistryOption('format',
 
2315
            short_name='F',
 
2316
            help='Diff format to use.',
 
2317
            lazy_registry=('bzrlib.diff', 'format_registry'),
 
2318
            title='Diff format'),
1394
2319
        ]
1395
2320
    aliases = ['di', 'dif']
1396
2321
    encoding_type = 'exact'
1397
2322
 
1398
2323
    @display_command
1399
2324
    def run(self, revision=None, file_list=None, diff_options=None,
1400
 
            prefix=None):
1401
 
        from bzrlib.diff import diff_cmd_helper, show_diff_trees
 
2325
            prefix=None, old=None, new=None, using=None, format=None):
 
2326
        from bzrlib.diff import (get_trees_and_branches_to_diff_locked,
 
2327
            show_diff_trees)
1402
2328
 
1403
2329
        if (prefix is None) or (prefix == '0'):
1404
2330
            # diff -p0 format
1410
2336
        elif ':' in prefix:
1411
2337
            old_label, new_label = prefix.split(":")
1412
2338
        else:
1413
 
            raise errors.BzrCommandError(
 
2339
            raise errors.BzrCommandError(gettext(
1414
2340
                '--prefix expects two values separated by a colon'
1415
 
                ' (eg "old/:new/")')
 
2341
                ' (eg "old/:new/")'))
1416
2342
 
1417
2343
        if revision and len(revision) > 2:
1418
 
            raise errors.BzrCommandError('bzr diff --revision takes exactly'
1419
 
                                         ' one or two revision specifiers')
1420
 
 
1421
 
        try:
1422
 
            tree1, file_list = internal_tree_files(file_list)
1423
 
            tree2 = None
1424
 
            b = None
1425
 
            b2 = None
1426
 
        except errors.FileInWrongBranch:
1427
 
            if len(file_list) != 2:
1428
 
                raise errors.BzrCommandError("Files are in different branches")
1429
 
 
1430
 
            tree1, file1 = WorkingTree.open_containing(file_list[0])
1431
 
            tree2, file2 = WorkingTree.open_containing(file_list[1])
1432
 
            if file1 != "" or file2 != "":
1433
 
                # FIXME diff those two files. rbc 20051123
1434
 
                raise errors.BzrCommandError("Files are in different branches")
1435
 
            file_list = None
1436
 
        except errors.NotBranchError:
1437
 
            if (revision is not None and len(revision) == 2
1438
 
                and not revision[0].needs_branch()
1439
 
                and not revision[1].needs_branch()):
1440
 
                # If both revision specs include a branch, we can
1441
 
                # diff them without needing a local working tree
1442
 
                tree1, tree2 = None, None
1443
 
            else:
1444
 
                raise
1445
 
 
1446
 
        if tree2 is not None:
1447
 
            if revision is not None:
1448
 
                # FIXME: but there should be a clean way to diff between
1449
 
                # non-default versions of two trees, it's not hard to do
1450
 
                # internally...
1451
 
                raise errors.BzrCommandError(
1452
 
                        "Sorry, diffing arbitrary revisions across branches "
1453
 
                        "is not implemented yet")
1454
 
            return show_diff_trees(tree1, tree2, sys.stdout, 
1455
 
                                   specific_files=file_list,
1456
 
                                   external_diff_options=diff_options,
1457
 
                                   old_label=old_label, new_label=new_label)
1458
 
 
1459
 
        return diff_cmd_helper(tree1, file_list, diff_options,
1460
 
                               revision_specs=revision,
1461
 
                               old_label=old_label, new_label=new_label)
 
2344
            raise errors.BzrCommandError(gettext('bzr diff --revision takes exactly'
 
2345
                                         ' one or two revision specifiers'))
 
2346
 
 
2347
        if using is not None and format is not None:
 
2348
            raise errors.BzrCommandError(gettext(
 
2349
                '{0} and {1} are mutually exclusive').format(
 
2350
                '--using', '--format'))
 
2351
 
 
2352
        (old_tree, new_tree,
 
2353
         old_branch, new_branch,
 
2354
         specific_files, extra_trees) = get_trees_and_branches_to_diff_locked(
 
2355
            file_list, revision, old, new, self.add_cleanup, apply_view=True)
 
2356
        # GNU diff on Windows uses ANSI encoding for filenames
 
2357
        path_encoding = osutils.get_diff_header_encoding()
 
2358
        return show_diff_trees(old_tree, new_tree, sys.stdout,
 
2359
                               specific_files=specific_files,
 
2360
                               external_diff_options=diff_options,
 
2361
                               old_label=old_label, new_label=new_label,
 
2362
                               extra_trees=extra_trees,
 
2363
                               path_encoding=path_encoding,
 
2364
                               using=using,
 
2365
                               format_cls=format)
1462
2366
 
1463
2367
 
1464
2368
class cmd_deleted(Command):
1465
 
    """List files deleted in the working tree.
 
2369
    __doc__ = """List files deleted in the working tree.
1466
2370
    """
1467
2371
    # TODO: Show files deleted since a previous revision, or
1468
2372
    # between two revisions.
1471
2375
    # level of effort but possibly much less IO.  (Or possibly not,
1472
2376
    # if the directories are very large...)
1473
2377
    _see_also = ['status', 'ls']
1474
 
    takes_options = ['show-ids']
 
2378
    takes_options = ['directory', 'show-ids']
1475
2379
 
1476
2380
    @display_command
1477
 
    def run(self, show_ids=False):
1478
 
        tree = WorkingTree.open_containing(u'.')[0]
1479
 
        tree.lock_read()
1480
 
        try:
1481
 
            old = tree.basis_tree()
1482
 
            old.lock_read()
1483
 
            try:
1484
 
                for path, ie in old.inventory.iter_entries():
1485
 
                    if not tree.has_id(ie.file_id):
1486
 
                        self.outf.write(path)
1487
 
                        if show_ids:
1488
 
                            self.outf.write(' ')
1489
 
                            self.outf.write(ie.file_id)
1490
 
                        self.outf.write('\n')
1491
 
            finally:
1492
 
                old.unlock()
1493
 
        finally:
1494
 
            tree.unlock()
 
2381
    def run(self, show_ids=False, directory=u'.'):
 
2382
        tree = WorkingTree.open_containing(directory)[0]
 
2383
        self.add_cleanup(tree.lock_read().unlock)
 
2384
        old = tree.basis_tree()
 
2385
        self.add_cleanup(old.lock_read().unlock)
 
2386
        for path, ie in old.iter_entries_by_dir():
 
2387
            if not tree.has_id(ie.file_id):
 
2388
                self.outf.write(path)
 
2389
                if show_ids:
 
2390
                    self.outf.write(' ')
 
2391
                    self.outf.write(ie.file_id)
 
2392
                self.outf.write('\n')
1495
2393
 
1496
2394
 
1497
2395
class cmd_modified(Command):
1498
 
    """List files modified in working tree.
 
2396
    __doc__ = """List files modified in working tree.
1499
2397
    """
1500
2398
 
1501
2399
    hidden = True
1502
2400
    _see_also = ['status', 'ls']
 
2401
    takes_options = ['directory', 'null']
1503
2402
 
1504
2403
    @display_command
1505
 
    def run(self):
1506
 
        tree = WorkingTree.open_containing(u'.')[0]
 
2404
    def run(self, null=False, directory=u'.'):
 
2405
        tree = WorkingTree.open_containing(directory)[0]
 
2406
        self.add_cleanup(tree.lock_read().unlock)
1507
2407
        td = tree.changes_from(tree.basis_tree())
 
2408
        self.cleanup_now()
1508
2409
        for path, id, kind, text_modified, meta_modified in td.modified:
1509
 
            self.outf.write(path + '\n')
 
2410
            if null:
 
2411
                self.outf.write(path + '\0')
 
2412
            else:
 
2413
                self.outf.write(osutils.quotefn(path) + '\n')
1510
2414
 
1511
2415
 
1512
2416
class cmd_added(Command):
1513
 
    """List files added in working tree.
 
2417
    __doc__ = """List files added in working tree.
1514
2418
    """
1515
2419
 
1516
2420
    hidden = True
1517
2421
    _see_also = ['status', 'ls']
 
2422
    takes_options = ['directory', 'null']
1518
2423
 
1519
2424
    @display_command
1520
 
    def run(self):
1521
 
        wt = WorkingTree.open_containing(u'.')[0]
1522
 
        wt.lock_read()
1523
 
        try:
1524
 
            basis = wt.basis_tree()
1525
 
            basis.lock_read()
1526
 
            try:
1527
 
                basis_inv = basis.inventory
1528
 
                inv = wt.inventory
1529
 
                for file_id in inv:
1530
 
                    if file_id in basis_inv:
1531
 
                        continue
1532
 
                    if inv.is_root(file_id) and len(basis_inv) == 0:
1533
 
                        continue
1534
 
                    path = inv.id2path(file_id)
1535
 
                    if not os.access(osutils.abspath(path), os.F_OK):
1536
 
                        continue
1537
 
                    self.outf.write(path + '\n')
1538
 
            finally:
1539
 
                basis.unlock()
1540
 
        finally:
1541
 
            wt.unlock()
 
2425
    def run(self, null=False, directory=u'.'):
 
2426
        wt = WorkingTree.open_containing(directory)[0]
 
2427
        self.add_cleanup(wt.lock_read().unlock)
 
2428
        basis = wt.basis_tree()
 
2429
        self.add_cleanup(basis.lock_read().unlock)
 
2430
        root_id = wt.get_root_id()
 
2431
        for file_id in wt.all_file_ids():
 
2432
            if basis.has_id(file_id):
 
2433
                continue
 
2434
            if root_id == file_id:
 
2435
                continue
 
2436
            path = wt.id2path(file_id)
 
2437
            if not os.access(osutils.pathjoin(wt.basedir, path), os.F_OK):
 
2438
                continue
 
2439
            if null:
 
2440
                self.outf.write(path + '\0')
 
2441
            else:
 
2442
                self.outf.write(osutils.quotefn(path) + '\n')
1542
2443
 
1543
2444
 
1544
2445
class cmd_root(Command):
1545
 
    """Show the tree root directory.
 
2446
    __doc__ = """Show the tree root directory.
1546
2447
 
1547
2448
    The root is the nearest enclosing directory with a .bzr control
1548
2449
    directory."""
1559
2460
    try:
1560
2461
        return int(limitstring)
1561
2462
    except ValueError:
1562
 
        msg = "The limit argument must be an integer."
 
2463
        msg = gettext("The limit argument must be an integer.")
 
2464
        raise errors.BzrCommandError(msg)
 
2465
 
 
2466
 
 
2467
def _parse_levels(s):
 
2468
    try:
 
2469
        return int(s)
 
2470
    except ValueError:
 
2471
        msg = gettext("The levels argument must be an integer.")
1563
2472
        raise errors.BzrCommandError(msg)
1564
2473
 
1565
2474
 
1566
2475
class cmd_log(Command):
1567
 
    """Show log of a branch, file, or directory.
1568
 
 
1569
 
    By default show the log of the branch containing the working directory.
1570
 
 
1571
 
    To request a range of logs, you can use the command -r begin..end
1572
 
    -r revision requests a specific revision, -r ..end or -r begin.. are
1573
 
    also valid.
1574
 
 
1575
 
    examples:
1576
 
        bzr log
1577
 
        bzr log foo.c
1578
 
        bzr log -r -10.. http://server/branch
 
2476
    __doc__ = """Show historical log for a branch or subset of a branch.
 
2477
 
 
2478
    log is bzr's default tool for exploring the history of a branch.
 
2479
    The branch to use is taken from the first parameter. If no parameters
 
2480
    are given, the branch containing the working directory is logged.
 
2481
    Here are some simple examples::
 
2482
 
 
2483
      bzr log                       log the current branch
 
2484
      bzr log foo.py                log a file in its branch
 
2485
      bzr log http://server/branch  log a branch on a server
 
2486
 
 
2487
    The filtering, ordering and information shown for each revision can
 
2488
    be controlled as explained below. By default, all revisions are
 
2489
    shown sorted (topologically) so that newer revisions appear before
 
2490
    older ones and descendants always appear before ancestors. If displayed,
 
2491
    merged revisions are shown indented under the revision in which they
 
2492
    were merged.
 
2493
 
 
2494
    :Output control:
 
2495
 
 
2496
      The log format controls how information about each revision is
 
2497
      displayed. The standard log formats are called ``long``, ``short``
 
2498
      and ``line``. The default is long. See ``bzr help log-formats``
 
2499
      for more details on log formats.
 
2500
 
 
2501
      The following options can be used to control what information is
 
2502
      displayed::
 
2503
 
 
2504
        -l N        display a maximum of N revisions
 
2505
        -n N        display N levels of revisions (0 for all, 1 for collapsed)
 
2506
        -v          display a status summary (delta) for each revision
 
2507
        -p          display a diff (patch) for each revision
 
2508
        --show-ids  display revision-ids (and file-ids), not just revnos
 
2509
 
 
2510
      Note that the default number of levels to display is a function of the
 
2511
      log format. If the -n option is not used, the standard log formats show
 
2512
      just the top level (mainline).
 
2513
 
 
2514
      Status summaries are shown using status flags like A, M, etc. To see
 
2515
      the changes explained using words like ``added`` and ``modified``
 
2516
      instead, use the -vv option.
 
2517
 
 
2518
    :Ordering control:
 
2519
 
 
2520
      To display revisions from oldest to newest, use the --forward option.
 
2521
      In most cases, using this option will have little impact on the total
 
2522
      time taken to produce a log, though --forward does not incrementally
 
2523
      display revisions like --reverse does when it can.
 
2524
 
 
2525
    :Revision filtering:
 
2526
 
 
2527
      The -r option can be used to specify what revision or range of revisions
 
2528
      to filter against. The various forms are shown below::
 
2529
 
 
2530
        -rX      display revision X
 
2531
        -rX..    display revision X and later
 
2532
        -r..Y    display up to and including revision Y
 
2533
        -rX..Y   display from X to Y inclusive
 
2534
 
 
2535
      See ``bzr help revisionspec`` for details on how to specify X and Y.
 
2536
      Some common examples are given below::
 
2537
 
 
2538
        -r-1                show just the tip
 
2539
        -r-10..             show the last 10 mainline revisions
 
2540
        -rsubmit:..         show what's new on this branch
 
2541
        -rancestor:path..   show changes since the common ancestor of this
 
2542
                            branch and the one at location path
 
2543
        -rdate:yesterday..  show changes since yesterday
 
2544
 
 
2545
      When logging a range of revisions using -rX..Y, log starts at
 
2546
      revision Y and searches back in history through the primary
 
2547
      ("left-hand") parents until it finds X. When logging just the
 
2548
      top level (using -n1), an error is reported if X is not found
 
2549
      along the way. If multi-level logging is used (-n0), X may be
 
2550
      a nested merge revision and the log will be truncated accordingly.
 
2551
 
 
2552
    :Path filtering:
 
2553
 
 
2554
      If parameters are given and the first one is not a branch, the log
 
2555
      will be filtered to show only those revisions that changed the
 
2556
      nominated files or directories.
 
2557
 
 
2558
      Filenames are interpreted within their historical context. To log a
 
2559
      deleted file, specify a revision range so that the file existed at
 
2560
      the end or start of the range.
 
2561
 
 
2562
      Historical context is also important when interpreting pathnames of
 
2563
      renamed files/directories. Consider the following example:
 
2564
 
 
2565
      * revision 1: add tutorial.txt
 
2566
      * revision 2: modify tutorial.txt
 
2567
      * revision 3: rename tutorial.txt to guide.txt; add tutorial.txt
 
2568
 
 
2569
      In this case:
 
2570
 
 
2571
      * ``bzr log guide.txt`` will log the file added in revision 1
 
2572
 
 
2573
      * ``bzr log tutorial.txt`` will log the new file added in revision 3
 
2574
 
 
2575
      * ``bzr log -r2 -p tutorial.txt`` will show the changes made to
 
2576
        the original file in revision 2.
 
2577
 
 
2578
      * ``bzr log -r2 -p guide.txt`` will display an error message as there
 
2579
        was no file called guide.txt in revision 2.
 
2580
 
 
2581
      Renames are always followed by log. By design, there is no need to
 
2582
      explicitly ask for this (and no way to stop logging a file back
 
2583
      until it was last renamed).
 
2584
 
 
2585
    :Other filtering:
 
2586
 
 
2587
      The --match option can be used for finding revisions that match a
 
2588
      regular expression in a commit message, committer, author or bug.
 
2589
      Specifying the option several times will match any of the supplied
 
2590
      expressions. --match-author, --match-bugs, --match-committer and
 
2591
      --match-message can be used to only match a specific field.
 
2592
 
 
2593
    :Tips & tricks:
 
2594
 
 
2595
      GUI tools and IDEs are often better at exploring history than command
 
2596
      line tools: you may prefer qlog or viz from qbzr or bzr-gtk, the
 
2597
      bzr-explorer shell, or the Loggerhead web interface.  See the Plugin
 
2598
      Guide <http://doc.bazaar.canonical.com/plugins/en/> and
 
2599
      <http://wiki.bazaar.canonical.com/IDEIntegration>.  
 
2600
 
 
2601
      You may find it useful to add the aliases below to ``bazaar.conf``::
 
2602
 
 
2603
        [ALIASES]
 
2604
        tip = log -r-1
 
2605
        top = log -l10 --line
 
2606
        show = log -v -p
 
2607
 
 
2608
      ``bzr tip`` will then show the latest revision while ``bzr top``
 
2609
      will show the last 10 mainline revisions. To see the details of a
 
2610
      particular revision X,  ``bzr show -rX``.
 
2611
 
 
2612
      If you are interested in looking deeper into a particular merge X,
 
2613
      use ``bzr log -n0 -rX``.
 
2614
 
 
2615
      ``bzr log -v`` on a branch with lots of history is currently
 
2616
      very slow. A fix for this issue is currently under development.
 
2617
      With or without that fix, it is recommended that a revision range
 
2618
      be given when using the -v option.
 
2619
 
 
2620
      bzr has a generic full-text matching plugin, bzr-search, that can be
 
2621
      used to find revisions matching user names, commit messages, etc.
 
2622
      Among other features, this plugin can find all revisions containing
 
2623
      a list of words but not others.
 
2624
 
 
2625
      When exploring non-mainline history on large projects with deep
 
2626
      history, the performance of log can be greatly improved by installing
 
2627
      the historycache plugin. This plugin buffers historical information
 
2628
      trading disk space for faster speed.
1579
2629
    """
1580
 
 
1581
 
    # TODO: Make --revision support uuid: and hash: [future tag:] notation.
1582
 
 
1583
 
    takes_args = ['location?']
1584
 
    takes_options = [Option('forward', 
1585
 
                            help='show from oldest to newest'),
1586
 
                     'timezone', 
1587
 
                     Option('verbose', 
1588
 
                             short_name='v',
1589
 
                             help='show files changed in each revision'),
1590
 
                     'show-ids', 'revision',
1591
 
                     'log-format',
1592
 
                     Option('message',
1593
 
                            short_name='m',
1594
 
                            help='show revisions whose message matches this regexp',
1595
 
                            type=str),
1596
 
                     Option('limit', 
1597
 
                            help='limit the output to the first N revisions',
1598
 
                            type=_parse_limit),
1599
 
                     ]
 
2630
    takes_args = ['file*']
 
2631
    _see_also = ['log-formats', 'revisionspec']
 
2632
    takes_options = [
 
2633
            Option('forward',
 
2634
                   help='Show from oldest to newest.'),
 
2635
            'timezone',
 
2636
            custom_help('verbose',
 
2637
                   help='Show files changed in each revision.'),
 
2638
            'show-ids',
 
2639
            'revision',
 
2640
            Option('change',
 
2641
                   type=bzrlib.option._parse_revision_str,
 
2642
                   short_name='c',
 
2643
                   help='Show just the specified revision.'
 
2644
                   ' See also "help revisionspec".'),
 
2645
            'log-format',
 
2646
            RegistryOption('authors',
 
2647
                'What names to list as authors - first, all or committer.',
 
2648
                title='Authors',
 
2649
                lazy_registry=('bzrlib.log', 'author_list_registry'),
 
2650
            ),
 
2651
            Option('levels',
 
2652
                   short_name='n',
 
2653
                   help='Number of levels to display - 0 for all, 1 for flat.',
 
2654
                   argname='N',
 
2655
                   type=_parse_levels),
 
2656
            Option('message',
 
2657
                   help='Show revisions whose message matches this '
 
2658
                        'regular expression.',
 
2659
                   type=str,
 
2660
                   hidden=True),
 
2661
            Option('limit',
 
2662
                   short_name='l',
 
2663
                   help='Limit the output to the first N revisions.',
 
2664
                   argname='N',
 
2665
                   type=_parse_limit),
 
2666
            Option('show-diff',
 
2667
                   short_name='p',
 
2668
                   help='Show changes made in each revision as a patch.'),
 
2669
            Option('include-merged',
 
2670
                   help='Show merged revisions like --levels 0 does.'),
 
2671
            Option('include-merges', hidden=True,
 
2672
                   help='Historical alias for --include-merged.'),
 
2673
            Option('omit-merges',
 
2674
                   help='Do not report commits with more than one parent.'),
 
2675
            Option('exclude-common-ancestry',
 
2676
                   help='Display only the revisions that are not part'
 
2677
                   ' of both ancestries (require -rX..Y).'
 
2678
                   ),
 
2679
            Option('signatures',
 
2680
                   help='Show digital signature validity.'),
 
2681
            ListOption('match',
 
2682
                short_name='m',
 
2683
                help='Show revisions whose properties match this '
 
2684
                'expression.',
 
2685
                type=str),
 
2686
            ListOption('match-message',
 
2687
                   help='Show revisions whose message matches this '
 
2688
                   'expression.',
 
2689
                type=str),
 
2690
            ListOption('match-committer',
 
2691
                   help='Show revisions whose committer matches this '
 
2692
                   'expression.',
 
2693
                type=str),
 
2694
            ListOption('match-author',
 
2695
                   help='Show revisions whose authors match this '
 
2696
                   'expression.',
 
2697
                type=str),
 
2698
            ListOption('match-bugs',
 
2699
                   help='Show revisions whose bugs match this '
 
2700
                   'expression.',
 
2701
                type=str)
 
2702
            ]
1600
2703
    encoding_type = 'replace'
1601
2704
 
1602
2705
    @display_command
1603
 
    def run(self, location=None, timezone='original',
 
2706
    def run(self, file_list=None, timezone='original',
1604
2707
            verbose=False,
1605
2708
            show_ids=False,
1606
2709
            forward=False,
1607
2710
            revision=None,
 
2711
            change=None,
1608
2712
            log_format=None,
 
2713
            levels=None,
1609
2714
            message=None,
1610
 
            limit=None):
1611
 
        from bzrlib.log import show_log
1612
 
        assert message is None or isinstance(message, basestring), \
1613
 
            "invalid message argument %r" % message
 
2715
            limit=None,
 
2716
            show_diff=False,
 
2717
            include_merged=None,
 
2718
            authors=None,
 
2719
            exclude_common_ancestry=False,
 
2720
            signatures=False,
 
2721
            match=None,
 
2722
            match_message=None,
 
2723
            match_committer=None,
 
2724
            match_author=None,
 
2725
            match_bugs=None,
 
2726
            omit_merges=False,
 
2727
            include_merges=symbol_versioning.DEPRECATED_PARAMETER,
 
2728
            ):
 
2729
        from bzrlib.log import (
 
2730
            Logger,
 
2731
            make_log_request_dict,
 
2732
            _get_info_for_log_files,
 
2733
            )
1614
2734
        direction = (forward and 'forward') or 'reverse'
1615
 
        
1616
 
        # log everything
1617
 
        file_id = None
1618
 
        if location:
1619
 
            # find the file id to log:
1620
 
 
1621
 
            tree, b, fp = bzrdir.BzrDir.open_containing_tree_or_branch(
1622
 
                location)
1623
 
            if fp != '':
1624
 
                if tree is None:
1625
 
                    tree = b.basis_tree()
1626
 
                file_id = tree.path2id(fp)
 
2735
        if symbol_versioning.deprecated_passed(include_merges):
 
2736
            ui.ui_factory.show_user_warning(
 
2737
                'deprecated_command_option',
 
2738
                deprecated_name='--include-merges',
 
2739
                recommended_name='--include-merged',
 
2740
                deprecated_in_version='2.5',
 
2741
                command=self.invoked_as)
 
2742
            if include_merged is None:
 
2743
                include_merged = include_merges
 
2744
            else:
 
2745
                raise errors.BzrCommandError(gettext(
 
2746
                    '{0} and {1} are mutually exclusive').format(
 
2747
                    '--include-merges', '--include-merged'))
 
2748
        if include_merged is None:
 
2749
            include_merged = False
 
2750
        if (exclude_common_ancestry
 
2751
            and (revision is None or len(revision) != 2)):
 
2752
            raise errors.BzrCommandError(gettext(
 
2753
                '--exclude-common-ancestry requires -r with two revisions'))
 
2754
        if include_merged:
 
2755
            if levels is None:
 
2756
                levels = 0
 
2757
            else:
 
2758
                raise errors.BzrCommandError(gettext(
 
2759
                    '{0} and {1} are mutually exclusive').format(
 
2760
                    '--levels', '--include-merged'))
 
2761
 
 
2762
        if change is not None:
 
2763
            if len(change) > 1:
 
2764
                raise errors.RangeInChangeOption()
 
2765
            if revision is not None:
 
2766
                raise errors.BzrCommandError(gettext(
 
2767
                    '{0} and {1} are mutually exclusive').format(
 
2768
                    '--revision', '--change'))
 
2769
            else:
 
2770
                revision = change
 
2771
 
 
2772
        file_ids = []
 
2773
        filter_by_dir = False
 
2774
        if file_list:
 
2775
            # find the file ids to log and check for directory filtering
 
2776
            b, file_info_list, rev1, rev2 = _get_info_for_log_files(
 
2777
                revision, file_list, self.add_cleanup)
 
2778
            for relpath, file_id, kind in file_info_list:
1627
2779
                if file_id is None:
1628
 
                    raise errors.BzrCommandError(
1629
 
                        "Path does not have any revision history: %s" %
1630
 
                        location)
 
2780
                    raise errors.BzrCommandError(gettext(
 
2781
                        "Path unknown at end or start of revision range: %s") %
 
2782
                        relpath)
 
2783
                # If the relpath is the top of the tree, we log everything
 
2784
                if relpath == '':
 
2785
                    file_ids = []
 
2786
                    break
 
2787
                else:
 
2788
                    file_ids.append(file_id)
 
2789
                filter_by_dir = filter_by_dir or (
 
2790
                    kind in ['directory', 'tree-reference'])
1631
2791
        else:
1632
 
            # local dir only
1633
 
            # FIXME ? log the current subdir only RBC 20060203 
 
2792
            # log everything
 
2793
            # FIXME ? log the current subdir only RBC 20060203
1634
2794
            if revision is not None \
1635
2795
                    and len(revision) > 0 and revision[0].get_branch():
1636
2796
                location = revision[0].get_branch()
1637
2797
            else:
1638
2798
                location = '.'
1639
 
            dir, relpath = bzrdir.BzrDir.open_containing(location)
 
2799
            dir, relpath = controldir.ControlDir.open_containing(location)
1640
2800
            b = dir.open_branch()
1641
 
 
1642
 
        b.lock_read()
1643
 
        try:
1644
 
            if revision is None:
1645
 
                rev1 = None
1646
 
                rev2 = None
1647
 
            elif len(revision) == 1:
1648
 
                rev1 = rev2 = revision[0].in_history(b)
1649
 
            elif len(revision) == 2:
1650
 
                if revision[1].get_branch() != revision[0].get_branch():
1651
 
                    # b is taken from revision[0].get_branch(), and
1652
 
                    # show_log will use its revision_history. Having
1653
 
                    # different branches will lead to weird behaviors.
1654
 
                    raise errors.BzrCommandError(
1655
 
                        "Log doesn't accept two revisions in different"
1656
 
                        " branches.")
1657
 
                rev1 = revision[0].in_history(b)
1658
 
                rev2 = revision[1].in_history(b)
1659
 
            else:
1660
 
                raise errors.BzrCommandError(
1661
 
                    'bzr log --revision takes one or two values.')
1662
 
 
1663
 
            if log_format is None:
1664
 
                log_format = log.log_formatter_registry.get_default(b)
1665
 
 
1666
 
            lf = log_format(show_ids=show_ids, to_file=self.outf,
1667
 
                            show_timezone=timezone)
1668
 
 
1669
 
            show_log(b,
1670
 
                     lf,
1671
 
                     file_id,
1672
 
                     verbose=verbose,
1673
 
                     direction=direction,
1674
 
                     start_revision=rev1,
1675
 
                     end_revision=rev2,
1676
 
                     search=message,
1677
 
                     limit=limit)
1678
 
        finally:
1679
 
            b.unlock()
1680
 
 
 
2801
            self.add_cleanup(b.lock_read().unlock)
 
2802
            rev1, rev2 = _get_revision_range(revision, b, self.name())
 
2803
 
 
2804
        if b.get_config_stack().get('validate_signatures_in_log'):
 
2805
            signatures = True
 
2806
 
 
2807
        if signatures:
 
2808
            if not gpg.GPGStrategy.verify_signatures_available():
 
2809
                raise errors.GpgmeNotInstalled(None)
 
2810
 
 
2811
        # Decide on the type of delta & diff filtering to use
 
2812
        # TODO: add an --all-files option to make this configurable & consistent
 
2813
        if not verbose:
 
2814
            delta_type = None
 
2815
        else:
 
2816
            delta_type = 'full'
 
2817
        if not show_diff:
 
2818
            diff_type = None
 
2819
        elif file_ids:
 
2820
            diff_type = 'partial'
 
2821
        else:
 
2822
            diff_type = 'full'
 
2823
 
 
2824
        # Build the log formatter
 
2825
        if log_format is None:
 
2826
            log_format = log.log_formatter_registry.get_default(b)
 
2827
        # Make a non-encoding output to include the diffs - bug 328007
 
2828
        unencoded_output = ui.ui_factory.make_output_stream(encoding_type='exact')
 
2829
        lf = log_format(show_ids=show_ids, to_file=self.outf,
 
2830
                        to_exact_file=unencoded_output,
 
2831
                        show_timezone=timezone,
 
2832
                        delta_format=get_verbosity_level(),
 
2833
                        levels=levels,
 
2834
                        show_advice=levels is None,
 
2835
                        author_list_handler=authors)
 
2836
 
 
2837
        # Choose the algorithm for doing the logging. It's annoying
 
2838
        # having multiple code paths like this but necessary until
 
2839
        # the underlying repository format is faster at generating
 
2840
        # deltas or can provide everything we need from the indices.
 
2841
        # The default algorithm - match-using-deltas - works for
 
2842
        # multiple files and directories and is faster for small
 
2843
        # amounts of history (200 revisions say). However, it's too
 
2844
        # slow for logging a single file in a repository with deep
 
2845
        # history, i.e. > 10K revisions. In the spirit of "do no
 
2846
        # evil when adding features", we continue to use the
 
2847
        # original algorithm - per-file-graph - for the "single
 
2848
        # file that isn't a directory without showing a delta" case.
 
2849
        partial_history = revision and b.repository._format.supports_chks
 
2850
        match_using_deltas = (len(file_ids) != 1 or filter_by_dir
 
2851
            or delta_type or partial_history)
 
2852
 
 
2853
        match_dict = {}
 
2854
        if match:
 
2855
            match_dict[''] = match
 
2856
        if match_message:
 
2857
            match_dict['message'] = match_message
 
2858
        if match_committer:
 
2859
            match_dict['committer'] = match_committer
 
2860
        if match_author:
 
2861
            match_dict['author'] = match_author
 
2862
        if match_bugs:
 
2863
            match_dict['bugs'] = match_bugs
 
2864
 
 
2865
        # Build the LogRequest and execute it
 
2866
        if len(file_ids) == 0:
 
2867
            file_ids = None
 
2868
        rqst = make_log_request_dict(
 
2869
            direction=direction, specific_fileids=file_ids,
 
2870
            start_revision=rev1, end_revision=rev2, limit=limit,
 
2871
            message_search=message, delta_type=delta_type,
 
2872
            diff_type=diff_type, _match_using_deltas=match_using_deltas,
 
2873
            exclude_common_ancestry=exclude_common_ancestry, match=match_dict,
 
2874
            signature=signatures, omit_merges=omit_merges,
 
2875
            )
 
2876
        Logger(b, rqst).show(lf)
 
2877
 
 
2878
 
 
2879
def _get_revision_range(revisionspec_list, branch, command_name):
 
2880
    """Take the input of a revision option and turn it into a revision range.
 
2881
 
 
2882
    It returns RevisionInfo objects which can be used to obtain the rev_id's
 
2883
    of the desired revisions. It does some user input validations.
 
2884
    """
 
2885
    if revisionspec_list is None:
 
2886
        rev1 = None
 
2887
        rev2 = None
 
2888
    elif len(revisionspec_list) == 1:
 
2889
        rev1 = rev2 = revisionspec_list[0].in_history(branch)
 
2890
    elif len(revisionspec_list) == 2:
 
2891
        start_spec = revisionspec_list[0]
 
2892
        end_spec = revisionspec_list[1]
 
2893
        if end_spec.get_branch() != start_spec.get_branch():
 
2894
            # b is taken from revision[0].get_branch(), and
 
2895
            # show_log will use its revision_history. Having
 
2896
            # different branches will lead to weird behaviors.
 
2897
            raise errors.BzrCommandError(gettext(
 
2898
                "bzr %s doesn't accept two revisions in different"
 
2899
                " branches.") % command_name)
 
2900
        if start_spec.spec is None:
 
2901
            # Avoid loading all the history.
 
2902
            rev1 = RevisionInfo(branch, None, None)
 
2903
        else:
 
2904
            rev1 = start_spec.in_history(branch)
 
2905
        # Avoid loading all of history when we know a missing
 
2906
        # end of range means the last revision ...
 
2907
        if end_spec.spec is None:
 
2908
            last_revno, last_revision_id = branch.last_revision_info()
 
2909
            rev2 = RevisionInfo(branch, last_revno, last_revision_id)
 
2910
        else:
 
2911
            rev2 = end_spec.in_history(branch)
 
2912
    else:
 
2913
        raise errors.BzrCommandError(gettext(
 
2914
            'bzr %s --revision takes one or two values.') % command_name)
 
2915
    return rev1, rev2
 
2916
 
 
2917
 
 
2918
def _revision_range_to_revid_range(revision_range):
 
2919
    rev_id1 = None
 
2920
    rev_id2 = None
 
2921
    if revision_range[0] is not None:
 
2922
        rev_id1 = revision_range[0].rev_id
 
2923
    if revision_range[1] is not None:
 
2924
        rev_id2 = revision_range[1].rev_id
 
2925
    return rev_id1, rev_id2
1681
2926
 
1682
2927
def get_log_format(long=False, short=False, line=False, default='long'):
1683
2928
    log_format = default
1691
2936
 
1692
2937
 
1693
2938
class cmd_touching_revisions(Command):
1694
 
    """Return revision-ids which affected a particular file.
 
2939
    __doc__ = """Return revision-ids which affected a particular file.
1695
2940
 
1696
2941
    A more user-friendly interface is "bzr log FILE".
1697
2942
    """
1702
2947
    @display_command
1703
2948
    def run(self, filename):
1704
2949
        tree, relpath = WorkingTree.open_containing(filename)
 
2950
        file_id = tree.path2id(relpath)
1705
2951
        b = tree.branch
1706
 
        file_id = tree.path2id(relpath)
1707
 
        for revno, revision_id, what in log.find_touching_revisions(b, file_id):
 
2952
        self.add_cleanup(b.lock_read().unlock)
 
2953
        touching_revs = log.find_touching_revisions(b, file_id)
 
2954
        for revno, revision_id, what in touching_revs:
1708
2955
            self.outf.write("%6d %s\n" % (revno, what))
1709
2956
 
1710
2957
 
1711
2958
class cmd_ls(Command):
1712
 
    """List files in a tree.
 
2959
    __doc__ = """List files in a tree.
1713
2960
    """
1714
2961
 
1715
2962
    _see_also = ['status', 'cat']
1716
2963
    takes_args = ['path?']
1717
 
    # TODO: Take a revision or remote path and list that tree instead.
1718
 
    takes_options = ['verbose', 'revision',
1719
 
                     Option('non-recursive',
1720
 
                            help='don\'t recurse into sub-directories'),
1721
 
                     Option('from-root',
1722
 
                            help='Print all paths from the root of the branch.'),
1723
 
                     Option('unknown', help='Print unknown files'),
1724
 
                     Option('versioned', help='Print versioned files'),
1725
 
                     Option('ignored', help='Print ignored files'),
1726
 
 
1727
 
                     Option('null', help='Null separate the files'),
1728
 
                     'kind', 'show-ids'
1729
 
                    ]
 
2964
    takes_options = [
 
2965
            'verbose',
 
2966
            'revision',
 
2967
            Option('recursive', short_name='R',
 
2968
                   help='Recurse into subdirectories.'),
 
2969
            Option('from-root',
 
2970
                   help='Print paths relative to the root of the branch.'),
 
2971
            Option('unknown', short_name='u',
 
2972
                help='Print unknown files.'),
 
2973
            Option('versioned', help='Print versioned files.',
 
2974
                   short_name='V'),
 
2975
            Option('ignored', short_name='i',
 
2976
                help='Print ignored files.'),
 
2977
            Option('kind', short_name='k',
 
2978
                   help='List entries of a particular kind: file, directory, symlink.',
 
2979
                   type=unicode),
 
2980
            'null',
 
2981
            'show-ids',
 
2982
            'directory',
 
2983
            ]
1730
2984
    @display_command
1731
 
    def run(self, revision=None, verbose=False, 
1732
 
            non_recursive=False, from_root=False,
 
2985
    def run(self, revision=None, verbose=False,
 
2986
            recursive=False, from_root=False,
1733
2987
            unknown=False, versioned=False, ignored=False,
1734
 
            null=False, kind=None, show_ids=False, path=None):
 
2988
            null=False, kind=None, show_ids=False, path=None, directory=None):
1735
2989
 
1736
2990
        if kind and kind not in ('file', 'directory', 'symlink'):
1737
 
            raise errors.BzrCommandError('invalid kind specified')
 
2991
            raise errors.BzrCommandError(gettext('invalid kind specified'))
1738
2992
 
1739
2993
        if verbose and null:
1740
 
            raise errors.BzrCommandError('Cannot set both --verbose and --null')
 
2994
            raise errors.BzrCommandError(gettext('Cannot set both --verbose and --null'))
1741
2995
        all = not (unknown or versioned or ignored)
1742
2996
 
1743
2997
        selection = {'I':ignored, '?':unknown, 'V':versioned}
1744
2998
 
1745
2999
        if path is None:
1746
3000
            fs_path = '.'
1747
 
            prefix = ''
1748
3001
        else:
1749
3002
            if from_root:
1750
 
                raise errors.BzrCommandError('cannot specify both --from-root'
1751
 
                                             ' and PATH')
 
3003
                raise errors.BzrCommandError(gettext('cannot specify both --from-root'
 
3004
                                             ' and PATH'))
1752
3005
            fs_path = path
1753
 
            prefix = path
1754
 
        tree, branch, relpath = bzrdir.BzrDir.open_containing_tree_or_branch(
1755
 
            fs_path)
 
3006
        tree, branch, relpath = \
 
3007
            _open_directory_or_containing_tree_or_branch(fs_path, directory)
 
3008
 
 
3009
        # Calculate the prefix to use
 
3010
        prefix = None
1756
3011
        if from_root:
1757
 
            relpath = u''
1758
 
        elif relpath:
1759
 
            relpath += '/'
1760
 
        if revision is not None:
1761
 
            tree = branch.repository.revision_tree(
1762
 
                revision[0].in_history(branch).rev_id)
1763
 
        elif tree is None:
1764
 
            tree = branch.basis_tree()
1765
 
 
1766
 
        tree.lock_read()
1767
 
        try:
1768
 
            for fp, fc, fkind, fid, entry in tree.list_files(include_root=False):
1769
 
                if fp.startswith(relpath):
1770
 
                    fp = osutils.pathjoin(prefix, fp[len(relpath):])
1771
 
                    if non_recursive and '/' in fp:
1772
 
                        continue
1773
 
                    if not all and not selection[fc]:
1774
 
                        continue
1775
 
                    if kind is not None and fkind != kind:
1776
 
                        continue
1777
 
                    if verbose:
1778
 
                        kindch = entry.kind_character()
1779
 
                        outstring = '%-8s %s%s' % (fc, fp, kindch)
1780
 
                        if show_ids and fid is not None:
1781
 
                            outstring = "%-50s %s" % (outstring, fid)
1782
 
                        self.outf.write(outstring + '\n')
1783
 
                    elif null:
1784
 
                        self.outf.write(fp + '\0')
1785
 
                        if show_ids:
1786
 
                            if fid is not None:
1787
 
                                self.outf.write(fid)
1788
 
                            self.outf.write('\0')
1789
 
                        self.outf.flush()
1790
 
                    else:
1791
 
                        if fid is not None:
1792
 
                            my_id = fid
1793
 
                        else:
1794
 
                            my_id = ''
1795
 
                        if show_ids:
1796
 
                            self.outf.write('%-50s %s\n' % (fp, my_id))
1797
 
                        else:
1798
 
                            self.outf.write(fp + '\n')
1799
 
        finally:
1800
 
            tree.unlock()
 
3012
            if relpath:
 
3013
                prefix = relpath + '/'
 
3014
        elif fs_path != '.' and not fs_path.endswith('/'):
 
3015
            prefix = fs_path + '/'
 
3016
 
 
3017
        if revision is not None or tree is None:
 
3018
            tree = _get_one_revision_tree('ls', revision, branch=branch)
 
3019
 
 
3020
        apply_view = False
 
3021
        if isinstance(tree, WorkingTree) and tree.supports_views():
 
3022
            view_files = tree.views.lookup_view()
 
3023
            if view_files:
 
3024
                apply_view = True
 
3025
                view_str = views.view_display_str(view_files)
 
3026
                note(gettext("Ignoring files outside view. View is %s") % view_str)
 
3027
 
 
3028
        self.add_cleanup(tree.lock_read().unlock)
 
3029
        for fp, fc, fkind, fid, entry in tree.list_files(include_root=False,
 
3030
            from_dir=relpath, recursive=recursive):
 
3031
            # Apply additional masking
 
3032
            if not all and not selection[fc]:
 
3033
                continue
 
3034
            if kind is not None and fkind != kind:
 
3035
                continue
 
3036
            if apply_view:
 
3037
                try:
 
3038
                    if relpath:
 
3039
                        fullpath = osutils.pathjoin(relpath, fp)
 
3040
                    else:
 
3041
                        fullpath = fp
 
3042
                    views.check_path_in_view(tree, fullpath)
 
3043
                except errors.FileOutsideView:
 
3044
                    continue
 
3045
 
 
3046
            # Output the entry
 
3047
            if prefix:
 
3048
                fp = osutils.pathjoin(prefix, fp)
 
3049
            kindch = entry.kind_character()
 
3050
            outstring = fp + kindch
 
3051
            ui.ui_factory.clear_term()
 
3052
            if verbose:
 
3053
                outstring = '%-8s %s' % (fc, outstring)
 
3054
                if show_ids and fid is not None:
 
3055
                    outstring = "%-50s %s" % (outstring, fid)
 
3056
                self.outf.write(outstring + '\n')
 
3057
            elif null:
 
3058
                self.outf.write(fp + '\0')
 
3059
                if show_ids:
 
3060
                    if fid is not None:
 
3061
                        self.outf.write(fid)
 
3062
                    self.outf.write('\0')
 
3063
                self.outf.flush()
 
3064
            else:
 
3065
                if show_ids:
 
3066
                    if fid is not None:
 
3067
                        my_id = fid
 
3068
                    else:
 
3069
                        my_id = ''
 
3070
                    self.outf.write('%-50s %s\n' % (outstring, my_id))
 
3071
                else:
 
3072
                    self.outf.write(outstring + '\n')
1801
3073
 
1802
3074
 
1803
3075
class cmd_unknowns(Command):
1804
 
    """List unknown files.
 
3076
    __doc__ = """List unknown files.
1805
3077
    """
1806
3078
 
1807
3079
    hidden = True
1808
3080
    _see_also = ['ls']
 
3081
    takes_options = ['directory']
1809
3082
 
1810
3083
    @display_command
1811
 
    def run(self):
1812
 
        for f in WorkingTree.open_containing(u'.')[0].unknowns():
 
3084
    def run(self, directory=u'.'):
 
3085
        for f in WorkingTree.open_containing(directory)[0].unknowns():
1813
3086
            self.outf.write(osutils.quotefn(f) + '\n')
1814
3087
 
1815
3088
 
1816
3089
class cmd_ignore(Command):
1817
 
    """Ignore specified files or patterns.
 
3090
    __doc__ = """Ignore specified files or patterns.
 
3091
 
 
3092
    See ``bzr help patterns`` for details on the syntax of patterns.
 
3093
 
 
3094
    If a .bzrignore file does not exist, the ignore command
 
3095
    will create one and add the specified files or patterns to the newly
 
3096
    created file. The ignore command will also automatically add the 
 
3097
    .bzrignore file to be versioned. Creating a .bzrignore file without
 
3098
    the use of the ignore command will require an explicit add command.
1818
3099
 
1819
3100
    To remove patterns from the ignore list, edit the .bzrignore file.
1820
 
 
1821
 
    Trailing slashes on patterns are ignored. 
1822
 
    If the pattern contains a slash or is a regular expression, it is compared 
1823
 
    to the whole path from the branch root.  Otherwise, it is compared to only
1824
 
    the last component of the path.  To match a file only in the root 
1825
 
    directory, prepend './'.
1826
 
 
1827
 
    Ignore patterns specifying absolute paths are not allowed.
1828
 
 
1829
 
    Ignore patterns may include globbing wildcards such as:
1830
 
      ? - Matches any single character except '/'
1831
 
      * - Matches 0 or more characters except '/'
1832
 
      /**/ - Matches 0 or more directories in a path
1833
 
      [a-z] - Matches a single character from within a group of characters
1834
 
 
1835
 
    Ignore patterns may also be Python regular expressions.  
1836
 
    Regular expression ignore patterns are identified by a 'RE:' prefix 
1837
 
    followed by the regular expression.  Regular expression ignore patterns
1838
 
    may not include named or numbered groups.
1839
 
 
1840
 
    Note: ignore patterns containing shell wildcards must be quoted from 
1841
 
    the shell on Unix.
1842
 
 
1843
 
    examples:
1844
 
        bzr ignore ./Makefile
1845
 
        bzr ignore '*.class'
1846
 
        bzr ignore 'lib/**/*.o'
1847
 
        bzr ignore 'RE:lib/.*\.o'
 
3101
    After adding, editing or deleting that file either indirectly by
 
3102
    using this command or directly by using an editor, be sure to commit
 
3103
    it.
 
3104
    
 
3105
    Bazaar also supports a global ignore file ~/.bazaar/ignore. On Windows
 
3106
    the global ignore file can be found in the application data directory as
 
3107
    C:\\Documents and Settings\\<user>\\Application Data\\Bazaar\\2.0\\ignore.
 
3108
    Global ignores are not touched by this command. The global ignore file
 
3109
    can be edited directly using an editor.
 
3110
 
 
3111
    Patterns prefixed with '!' are exceptions to ignore patterns and take
 
3112
    precedence over regular ignores.  Such exceptions are used to specify
 
3113
    files that should be versioned which would otherwise be ignored.
 
3114
    
 
3115
    Patterns prefixed with '!!' act as regular ignore patterns, but have
 
3116
    precedence over the '!' exception patterns.
 
3117
 
 
3118
    :Notes: 
 
3119
        
 
3120
    * Ignore patterns containing shell wildcards must be quoted from
 
3121
      the shell on Unix.
 
3122
 
 
3123
    * Ignore patterns starting with "#" act as comments in the ignore file.
 
3124
      To ignore patterns that begin with that character, use the "RE:" prefix.
 
3125
 
 
3126
    :Examples:
 
3127
        Ignore the top level Makefile::
 
3128
 
 
3129
            bzr ignore ./Makefile
 
3130
 
 
3131
        Ignore .class files in all directories...::
 
3132
 
 
3133
            bzr ignore "*.class"
 
3134
 
 
3135
        ...but do not ignore "special.class"::
 
3136
 
 
3137
            bzr ignore "!special.class"
 
3138
 
 
3139
        Ignore files whose name begins with the "#" character::
 
3140
 
 
3141
            bzr ignore "RE:^#"
 
3142
 
 
3143
        Ignore .o files under the lib directory::
 
3144
 
 
3145
            bzr ignore "lib/**/*.o"
 
3146
 
 
3147
        Ignore .o files under the lib directory::
 
3148
 
 
3149
            bzr ignore "RE:lib/.*\.o"
 
3150
 
 
3151
        Ignore everything but the "debian" toplevel directory::
 
3152
 
 
3153
            bzr ignore "RE:(?!debian/).*"
 
3154
        
 
3155
        Ignore everything except the "local" toplevel directory,
 
3156
        but always ignore autosave files ending in ~, even under local/::
 
3157
        
 
3158
            bzr ignore "*"
 
3159
            bzr ignore "!./local"
 
3160
            bzr ignore "!!*~"
1848
3161
    """
1849
3162
 
1850
 
    _see_also = ['status', 'ignored']
 
3163
    _see_also = ['status', 'ignored', 'patterns']
1851
3164
    takes_args = ['name_pattern*']
1852
 
    takes_options = [
1853
 
                     Option('old-default-rules',
1854
 
                            help='Out the ignore rules bzr < 0.9 always used.')
1855
 
                     ]
1856
 
    
1857
 
    def run(self, name_pattern_list=None, old_default_rules=None):
1858
 
        from bzrlib.atomicfile import AtomicFile
1859
 
        if old_default_rules is not None:
1860
 
            # dump the rules and exit
1861
 
            for pattern in ignores.OLD_DEFAULTS:
1862
 
                print pattern
 
3165
    takes_options = ['directory',
 
3166
        Option('default-rules',
 
3167
               help='Display the default ignore rules that bzr uses.')
 
3168
        ]
 
3169
 
 
3170
    def run(self, name_pattern_list=None, default_rules=None,
 
3171
            directory=u'.'):
 
3172
        from bzrlib import ignores
 
3173
        if default_rules is not None:
 
3174
            # dump the default rules and exit
 
3175
            for pattern in ignores.USER_DEFAULTS:
 
3176
                self.outf.write("%s\n" % pattern)
1863
3177
            return
1864
3178
        if not name_pattern_list:
1865
 
            raise errors.BzrCommandError("ignore requires at least one "
1866
 
                                  "NAME_PATTERN or --old-default-rules")
1867
 
        name_pattern_list = [globbing.normalize_pattern(p) 
 
3179
            raise errors.BzrCommandError(gettext("ignore requires at least one "
 
3180
                "NAME_PATTERN or --default-rules."))
 
3181
        name_pattern_list = [globbing.normalize_pattern(p)
1868
3182
                             for p in name_pattern_list]
 
3183
        bad_patterns = ''
 
3184
        bad_patterns_count = 0
 
3185
        for p in name_pattern_list:
 
3186
            if not globbing.Globster.is_pattern_valid(p):
 
3187
                bad_patterns_count += 1
 
3188
                bad_patterns += ('\n  %s' % p)
 
3189
        if bad_patterns:
 
3190
            msg = (ngettext('Invalid ignore pattern found. %s', 
 
3191
                            'Invalid ignore patterns found. %s',
 
3192
                            bad_patterns_count) % bad_patterns)
 
3193
            ui.ui_factory.show_error(msg)
 
3194
            raise errors.InvalidPattern('')
1869
3195
        for name_pattern in name_pattern_list:
1870
 
            if (name_pattern[0] == '/' or 
 
3196
            if (name_pattern[0] == '/' or
1871
3197
                (len(name_pattern) > 1 and name_pattern[1] == ':')):
1872
 
                raise errors.BzrCommandError(
1873
 
                    "NAME_PATTERN should not be an absolute path")
1874
 
        tree, relpath = WorkingTree.open_containing(u'.')
1875
 
        ifn = tree.abspath('.bzrignore')
1876
 
        if os.path.exists(ifn):
1877
 
            f = open(ifn, 'rt')
1878
 
            try:
1879
 
                igns = f.read().decode('utf-8')
1880
 
            finally:
1881
 
                f.close()
1882
 
        else:
1883
 
            igns = ''
1884
 
 
1885
 
        # TODO: If the file already uses crlf-style termination, maybe
1886
 
        # we should use that for the newly added lines?
1887
 
 
1888
 
        if igns and igns[-1] != '\n':
1889
 
            igns += '\n'
1890
 
        for name_pattern in name_pattern_list:
1891
 
            igns += name_pattern + '\n'
1892
 
 
1893
 
        f = AtomicFile(ifn, 'wb')
1894
 
        try:
1895
 
            f.write(igns.encode('utf-8'))
1896
 
            f.commit()
1897
 
        finally:
1898
 
            f.close()
1899
 
 
1900
 
        if not tree.path2id('.bzrignore'):
1901
 
            tree.add(['.bzrignore'])
 
3198
                raise errors.BzrCommandError(gettext(
 
3199
                    "NAME_PATTERN should not be an absolute path"))
 
3200
        tree, relpath = WorkingTree.open_containing(directory)
 
3201
        ignores.tree_ignores_add_patterns(tree, name_pattern_list)
 
3202
        ignored = globbing.Globster(name_pattern_list)
 
3203
        matches = []
 
3204
        self.add_cleanup(tree.lock_read().unlock)
 
3205
        for entry in tree.list_files():
 
3206
            id = entry[3]
 
3207
            if id is not None:
 
3208
                filename = entry[0]
 
3209
                if ignored.match(filename):
 
3210
                    matches.append(filename)
 
3211
        if len(matches) > 0:
 
3212
            self.outf.write(gettext("Warning: the following files are version "
 
3213
                  "controlled and match your ignore pattern:\n%s"
 
3214
                  "\nThese files will continue to be version controlled"
 
3215
                  " unless you 'bzr remove' them.\n") % ("\n".join(matches),))
1902
3216
 
1903
3217
 
1904
3218
class cmd_ignored(Command):
1905
 
    """List ignored files and the patterns that matched them.
 
3219
    __doc__ = """List ignored files and the patterns that matched them.
 
3220
 
 
3221
    List all the ignored files and the ignore pattern that caused the file to
 
3222
    be ignored.
 
3223
 
 
3224
    Alternatively, to list just the files::
 
3225
 
 
3226
        bzr ls --ignored
1906
3227
    """
1907
3228
 
1908
 
    _see_also = ['ignore']
 
3229
    encoding_type = 'replace'
 
3230
    _see_also = ['ignore', 'ls']
 
3231
    takes_options = ['directory']
 
3232
 
1909
3233
    @display_command
1910
 
    def run(self):
1911
 
        tree = WorkingTree.open_containing(u'.')[0]
1912
 
        tree.lock_read()
1913
 
        try:
1914
 
            for path, file_class, kind, file_id, entry in tree.list_files():
1915
 
                if file_class != 'I':
1916
 
                    continue
1917
 
                ## XXX: Slightly inefficient since this was already calculated
1918
 
                pat = tree.is_ignored(path)
1919
 
                print '%-50s %s' % (path, pat)
1920
 
        finally:
1921
 
            tree.unlock()
 
3234
    def run(self, directory=u'.'):
 
3235
        tree = WorkingTree.open_containing(directory)[0]
 
3236
        self.add_cleanup(tree.lock_read().unlock)
 
3237
        for path, file_class, kind, file_id, entry in tree.list_files():
 
3238
            if file_class != 'I':
 
3239
                continue
 
3240
            ## XXX: Slightly inefficient since this was already calculated
 
3241
            pat = tree.is_ignored(path)
 
3242
            self.outf.write('%-50s %s\n' % (path, pat))
1922
3243
 
1923
3244
 
1924
3245
class cmd_lookup_revision(Command):
1925
 
    """Lookup the revision-id from a revision-number
 
3246
    __doc__ = """Lookup the revision-id from a revision-number
1926
3247
 
1927
 
    example:
 
3248
    :Examples:
1928
3249
        bzr lookup-revision 33
1929
3250
    """
1930
3251
    hidden = True
1931
3252
    takes_args = ['revno']
1932
 
    
 
3253
    takes_options = ['directory']
 
3254
 
1933
3255
    @display_command
1934
 
    def run(self, revno):
 
3256
    def run(self, revno, directory=u'.'):
1935
3257
        try:
1936
3258
            revno = int(revno)
1937
3259
        except ValueError:
1938
 
            raise errors.BzrCommandError("not a valid revision-number: %r" % revno)
1939
 
 
1940
 
        print WorkingTree.open_containing(u'.')[0].branch.get_rev_id(revno)
 
3260
            raise errors.BzrCommandError(gettext("not a valid revision-number: %r")
 
3261
                                         % revno)
 
3262
        revid = WorkingTree.open_containing(directory)[0].branch.get_rev_id(revno)
 
3263
        self.outf.write("%s\n" % revid)
1941
3264
 
1942
3265
 
1943
3266
class cmd_export(Command):
1944
 
    """Export current or past revision to a destination directory or archive.
 
3267
    __doc__ = """Export current or past revision to a destination directory or archive.
1945
3268
 
1946
3269
    If no revision is specified this exports the last committed revision.
1947
3270
 
1958
3281
 
1959
3282
    Note: Export of tree with non-ASCII filenames to zip is not supported.
1960
3283
 
1961
 
     Supported formats       Autodetected by extension
1962
 
     -----------------       -------------------------
1963
 
         dir                            -
 
3284
      =================       =========================
 
3285
      Supported formats       Autodetected by extension
 
3286
      =================       =========================
 
3287
         dir                         (none)
1964
3288
         tar                          .tar
1965
3289
         tbz2                    .tar.bz2, .tbz2
1966
3290
         tgz                      .tar.gz, .tgz
1967
3291
         zip                          .zip
 
3292
      =================       =========================
1968
3293
    """
1969
 
    takes_args = ['dest', 'branch?']
1970
 
    takes_options = ['revision', 'format', 'root']
1971
 
    def run(self, dest, branch=None, revision=None, format=None, root=None):
 
3294
    encoding = 'exact'
 
3295
    takes_args = ['dest', 'branch_or_subdir?']
 
3296
    takes_options = ['directory',
 
3297
        Option('format',
 
3298
               help="Type of file to export to.",
 
3299
               type=unicode),
 
3300
        'revision',
 
3301
        Option('filters', help='Apply content filters to export the '
 
3302
                'convenient form.'),
 
3303
        Option('root',
 
3304
               type=str,
 
3305
               help="Name of the root directory inside the exported file."),
 
3306
        Option('per-file-timestamps',
 
3307
               help='Set modification time of files to that of the last '
 
3308
                    'revision in which it was changed.'),
 
3309
        Option('uncommitted',
 
3310
               help='Export the working tree contents rather than that of the '
 
3311
                    'last revision.'),
 
3312
        ]
 
3313
    def run(self, dest, branch_or_subdir=None, revision=None, format=None,
 
3314
        root=None, filters=False, per_file_timestamps=False, uncommitted=False,
 
3315
        directory=u'.'):
1972
3316
        from bzrlib.export import export
1973
3317
 
1974
 
        if branch is None:
1975
 
            tree = WorkingTree.open_containing(u'.')[0]
1976
 
            b = tree.branch
1977
 
        else:
1978
 
            b = Branch.open(branch)
1979
 
            
1980
 
        if revision is None:
1981
 
            # should be tree.last_revision  FIXME
1982
 
            rev_id = b.last_revision()
1983
 
        else:
1984
 
            if len(revision) != 1:
1985
 
                raise errors.BzrCommandError('bzr export --revision takes exactly 1 argument')
1986
 
            rev_id = revision[0].in_history(b).rev_id
1987
 
        t = b.repository.revision_tree(rev_id)
 
3318
        if branch_or_subdir is None:
 
3319
            branch_or_subdir = directory
 
3320
 
 
3321
        (tree, b, subdir) = controldir.ControlDir.open_containing_tree_or_branch(
 
3322
            branch_or_subdir)
 
3323
        if tree is not None:
 
3324
            self.add_cleanup(tree.lock_read().unlock)
 
3325
 
 
3326
        if uncommitted:
 
3327
            if tree is None:
 
3328
                raise errors.BzrCommandError(
 
3329
                    gettext("--uncommitted requires a working tree"))
 
3330
            export_tree = tree
 
3331
        else:
 
3332
            export_tree = _get_one_revision_tree('export', revision, branch=b, tree=tree)
1988
3333
        try:
1989
 
            export(t, dest, format, root)
 
3334
            export(export_tree, dest, format, root, subdir, filtered=filters,
 
3335
                   per_file_timestamps=per_file_timestamps)
1990
3336
        except errors.NoSuchExportFormat, e:
1991
 
            raise errors.BzrCommandError('Unsupported export format: %s' % e.format)
 
3337
            raise errors.BzrCommandError(
 
3338
                gettext('Unsupported export format: %s') % e.format)
1992
3339
 
1993
3340
 
1994
3341
class cmd_cat(Command):
1995
 
    """Write the contents of a file as of a given revision to standard output.
 
3342
    __doc__ = """Write the contents of a file as of a given revision to standard output.
1996
3343
 
1997
3344
    If no revision is nominated, the last revision is used.
1998
3345
 
1999
3346
    Note: Take care to redirect standard output when using this command on a
2000
 
    binary file. 
 
3347
    binary file.
2001
3348
    """
2002
3349
 
2003
3350
    _see_also = ['ls']
2004
 
    takes_options = ['revision', 'name-from-revision']
 
3351
    takes_options = ['directory',
 
3352
        Option('name-from-revision', help='The path name in the old tree.'),
 
3353
        Option('filters', help='Apply content filters to display the '
 
3354
                'convenience form.'),
 
3355
        'revision',
 
3356
        ]
2005
3357
    takes_args = ['filename']
2006
3358
    encoding_type = 'exact'
2007
3359
 
2008
3360
    @display_command
2009
 
    def run(self, filename, revision=None, name_from_revision=False):
 
3361
    def run(self, filename, revision=None, name_from_revision=False,
 
3362
            filters=False, directory=None):
2010
3363
        if revision is not None and len(revision) != 1:
2011
 
            raise errors.BzrCommandError("bzr cat --revision takes exactly"
2012
 
                                        " one number")
2013
 
 
2014
 
        tree = None
2015
 
        try:
2016
 
            tree, b, relpath = \
2017
 
                    bzrdir.BzrDir.open_containing_tree_or_branch(filename)
2018
 
        except errors.NotBranchError:
2019
 
            pass
2020
 
 
2021
 
        if revision is not None and revision[0].get_branch() is not None:
2022
 
            b = Branch.open(revision[0].get_branch())
 
3364
            raise errors.BzrCommandError(gettext("bzr cat --revision takes exactly"
 
3365
                                         " one revision specifier"))
 
3366
        tree, branch, relpath = \
 
3367
            _open_directory_or_containing_tree_or_branch(filename, directory)
 
3368
        self.add_cleanup(branch.lock_read().unlock)
 
3369
        return self._run(tree, branch, relpath, filename, revision,
 
3370
                         name_from_revision, filters)
 
3371
 
 
3372
    def _run(self, tree, b, relpath, filename, revision, name_from_revision,
 
3373
        filtered):
2023
3374
        if tree is None:
2024
3375
            tree = b.basis_tree()
2025
 
        if revision is None:
2026
 
            revision_id = b.last_revision()
2027
 
        else:
2028
 
            revision_id = revision[0].in_history(b).rev_id
 
3376
        rev_tree = _get_one_revision_tree('cat', revision, branch=b)
 
3377
        self.add_cleanup(rev_tree.lock_read().unlock)
2029
3378
 
2030
 
        cur_file_id = tree.path2id(relpath)
2031
 
        rev_tree = b.repository.revision_tree(revision_id)
2032
3379
        old_file_id = rev_tree.path2id(relpath)
2033
 
        
 
3380
 
 
3381
        # TODO: Split out this code to something that generically finds the
 
3382
        # best id for a path across one or more trees; it's like
 
3383
        # find_ids_across_trees but restricted to find just one. -- mbp
 
3384
        # 20110705.
2034
3385
        if name_from_revision:
 
3386
            # Try in revision if requested
2035
3387
            if old_file_id is None:
2036
 
                raise errors.BzrCommandError("%r is not present in revision %s"
2037
 
                                                % (filename, revision_id))
2038
 
            else:
2039
 
                rev_tree.print_file(old_file_id)
2040
 
        elif cur_file_id is not None:
2041
 
            rev_tree.print_file(cur_file_id)
2042
 
        elif old_file_id is not None:
2043
 
            rev_tree.print_file(old_file_id)
2044
 
        else:
2045
 
            raise errors.BzrCommandError("%r is not present in revision %s" %
2046
 
                                         (filename, revision_id))
 
3388
                raise errors.BzrCommandError(gettext(
 
3389
                    "{0!r} is not present in revision {1}").format(
 
3390
                        filename, rev_tree.get_revision_id()))
 
3391
            else:
 
3392
                actual_file_id = old_file_id
 
3393
        else:
 
3394
            cur_file_id = tree.path2id(relpath)
 
3395
            if cur_file_id is not None and rev_tree.has_id(cur_file_id):
 
3396
                actual_file_id = cur_file_id
 
3397
            elif old_file_id is not None:
 
3398
                actual_file_id = old_file_id
 
3399
            else:
 
3400
                raise errors.BzrCommandError(gettext(
 
3401
                    "{0!r} is not present in revision {1}").format(
 
3402
                        filename, rev_tree.get_revision_id()))
 
3403
        if filtered:
 
3404
            from bzrlib.filter_tree import ContentFilterTree
 
3405
            filter_tree = ContentFilterTree(rev_tree,
 
3406
                rev_tree._content_filter_stack)
 
3407
            content = filter_tree.get_file_text(actual_file_id)
 
3408
        else:
 
3409
            content = rev_tree.get_file_text(actual_file_id)
 
3410
        self.cleanup_now()
 
3411
        self.outf.write(content)
2047
3412
 
2048
3413
 
2049
3414
class cmd_local_time_offset(Command):
2050
 
    """Show the offset in seconds from GMT to local time."""
2051
 
    hidden = True    
 
3415
    __doc__ = """Show the offset in seconds from GMT to local time."""
 
3416
    hidden = True
2052
3417
    @display_command
2053
3418
    def run(self):
2054
 
        print osutils.local_time_offset()
 
3419
        self.outf.write("%s\n" % osutils.local_time_offset())
2055
3420
 
2056
3421
 
2057
3422
 
2058
3423
class cmd_commit(Command):
2059
 
    """Commit changes into a new revision.
2060
 
    
2061
 
    If no arguments are given, the entire tree is committed.
2062
 
 
2063
 
    If selected files are specified, only changes to those files are
2064
 
    committed.  If a directory is specified then the directory and everything 
2065
 
    within it is committed.
2066
 
 
2067
 
    A selected-file commit may fail in some cases where the committed
2068
 
    tree would be invalid. Consider::
2069
 
 
2070
 
      bzr init foo
2071
 
      mkdir foo/bar
2072
 
      bzr add foo/bar
2073
 
      bzr commit foo -m "committing foo"
2074
 
      bzr mv foo/bar foo/baz
2075
 
      mkdir foo/bar
2076
 
      bzr add foo/bar
2077
 
      bzr commit foo/bar -m "committing bar but not baz"
2078
 
 
2079
 
    In the example above, the last commit will fail by design. This gives
2080
 
    the user the opportunity to decide whether they want to commit the
2081
 
    rename at the same time, separately first, or not at all. (As a general
2082
 
    rule, when in doubt, Bazaar has a policy of Doing the Safe Thing.)
2083
 
 
2084
 
    Note: A selected-file commit after a merge is not yet supported.
 
3424
    __doc__ = """Commit changes into a new revision.
 
3425
 
 
3426
    An explanatory message needs to be given for each commit. This is
 
3427
    often done by using the --message option (getting the message from the
 
3428
    command line) or by using the --file option (getting the message from
 
3429
    a file). If neither of these options is given, an editor is opened for
 
3430
    the user to enter the message. To see the changed files in the
 
3431
    boilerplate text loaded into the editor, use the --show-diff option.
 
3432
 
 
3433
    By default, the entire tree is committed and the person doing the
 
3434
    commit is assumed to be the author. These defaults can be overridden
 
3435
    as explained below.
 
3436
 
 
3437
    :Selective commits:
 
3438
 
 
3439
      If selected files are specified, only changes to those files are
 
3440
      committed.  If a directory is specified then the directory and
 
3441
      everything within it is committed.
 
3442
  
 
3443
      When excludes are given, they take precedence over selected files.
 
3444
      For example, to commit only changes within foo, but not changes
 
3445
      within foo/bar::
 
3446
  
 
3447
        bzr commit foo -x foo/bar
 
3448
  
 
3449
      A selective commit after a merge is not yet supported.
 
3450
 
 
3451
    :Custom authors:
 
3452
 
 
3453
      If the author of the change is not the same person as the committer,
 
3454
      you can specify the author's name using the --author option. The
 
3455
      name should be in the same format as a committer-id, e.g.
 
3456
      "John Doe <jdoe@example.com>". If there is more than one author of
 
3457
      the change you can specify the option multiple times, once for each
 
3458
      author.
 
3459
  
 
3460
    :Checks:
 
3461
 
 
3462
      A common mistake is to forget to add a new file or directory before
 
3463
      running the commit command. The --strict option checks for unknown
 
3464
      files and aborts the commit if any are found. More advanced pre-commit
 
3465
      checks can be implemented by defining hooks. See ``bzr help hooks``
 
3466
      for details.
 
3467
 
 
3468
    :Things to note:
 
3469
 
 
3470
      If you accidentially commit the wrong changes or make a spelling
 
3471
      mistake in the commit message say, you can use the uncommit command
 
3472
      to undo it. See ``bzr help uncommit`` for details.
 
3473
 
 
3474
      Hooks can also be configured to run after a commit. This allows you
 
3475
      to trigger updates to external systems like bug trackers. The --fixes
 
3476
      option can be used to record the association between a revision and
 
3477
      one or more bugs. See ``bzr help bugs`` for details.
2085
3478
    """
2086
 
    # TODO: Run hooks on tree to-be-committed, and after commit.
2087
 
 
2088
 
    # TODO: Strict commit that fails if there are deleted files.
2089
 
    #       (what does "deleted files" mean ??)
2090
 
 
2091
 
    # TODO: Give better message for -s, --summary, used by tla people
2092
 
 
2093
 
    # XXX: verbose currently does nothing
2094
 
 
2095
 
    _see_also = ['bugs', 'uncommit']
 
3479
 
 
3480
    _see_also = ['add', 'bugs', 'hooks', 'uncommit']
2096
3481
    takes_args = ['selected*']
2097
 
    takes_options = ['message', 'verbose', 
2098
 
                     Option('unchanged',
2099
 
                            help='commit even if nothing has changed'),
2100
 
                     Option('file', type=str, 
2101
 
                            short_name='F',
2102
 
                            argname='msgfile',
2103
 
                            help='file containing commit message'),
2104
 
                     Option('strict',
2105
 
                            help="refuse to commit if there are unknown "
2106
 
                            "files in the working tree."),
2107
 
                     ListOption('fixes', type=str,
2108
 
                                help="mark a bug as being fixed by this "
2109
 
                                     "revision."),
2110
 
                     Option('local',
2111
 
                            help="perform a local only commit in a bound "
2112
 
                                 "branch. Such commits are not pushed to "
2113
 
                                 "the master branch until a normal commit "
2114
 
                                 "is performed."
2115
 
                            ),
2116
 
                     ]
 
3482
    takes_options = [
 
3483
            ListOption('exclude', type=str, short_name='x',
 
3484
                help="Do not consider changes made to a given path."),
 
3485
            Option('message', type=unicode,
 
3486
                   short_name='m',
 
3487
                   help="Description of the new revision."),
 
3488
            'verbose',
 
3489
             Option('unchanged',
 
3490
                    help='Commit even if nothing has changed.'),
 
3491
             Option('file', type=str,
 
3492
                    short_name='F',
 
3493
                    argname='msgfile',
 
3494
                    help='Take commit message from this file.'),
 
3495
             Option('strict',
 
3496
                    help="Refuse to commit if there are unknown "
 
3497
                    "files in the working tree."),
 
3498
             Option('commit-time', type=str,
 
3499
                    help="Manually set a commit time using commit date "
 
3500
                    "format, e.g. '2009-10-10 08:00:00 +0100'."),
 
3501
             ListOption('fixes', type=str,
 
3502
                    help="Mark a bug as being fixed by this revision "
 
3503
                         "(see \"bzr help bugs\")."),
 
3504
             ListOption('author', type=unicode,
 
3505
                    help="Set the author's name, if it's different "
 
3506
                         "from the committer."),
 
3507
             Option('local',
 
3508
                    help="Perform a local commit in a bound "
 
3509
                         "branch.  Local commits are not pushed to "
 
3510
                         "the master branch until a normal commit "
 
3511
                         "is performed."
 
3512
                    ),
 
3513
             Option('show-diff', short_name='p',
 
3514
                    help='When no message is supplied, show the diff along'
 
3515
                    ' with the status summary in the message editor.'),
 
3516
             Option('lossy', 
 
3517
                    help='When committing to a foreign version control '
 
3518
                    'system do not push data that can not be natively '
 
3519
                    'represented.'),
 
3520
             ]
2117
3521
    aliases = ['ci', 'checkin']
2118
3522
 
2119
 
    def _get_bug_fix_properties(self, fixes, branch):
2120
 
        properties = []
 
3523
    def _iter_bug_fix_urls(self, fixes, branch):
 
3524
        default_bugtracker  = None
2121
3525
        # Configure the properties for bug fixing attributes.
2122
3526
        for fixed_bug in fixes:
2123
3527
            tokens = fixed_bug.split(':')
2124
 
            if len(tokens) != 2:
2125
 
                raise errors.BzrCommandError(
2126
 
                    "Invalid bug %s. Must be in the form of 'tag:id'. "
2127
 
                    "Commit refused." % fixed_bug)
2128
 
            tag, bug_id = tokens
 
3528
            if len(tokens) == 1:
 
3529
                if default_bugtracker is None:
 
3530
                    branch_config = branch.get_config_stack()
 
3531
                    default_bugtracker = branch_config.get(
 
3532
                        "bugtracker")
 
3533
                if default_bugtracker is None:
 
3534
                    raise errors.BzrCommandError(gettext(
 
3535
                        "No tracker specified for bug %s. Use the form "
 
3536
                        "'tracker:id' or specify a default bug tracker "
 
3537
                        "using the `bugtracker` option.\nSee "
 
3538
                        "\"bzr help bugs\" for more information on this "
 
3539
                        "feature. Commit refused.") % fixed_bug)
 
3540
                tag = default_bugtracker
 
3541
                bug_id = tokens[0]
 
3542
            elif len(tokens) != 2:
 
3543
                raise errors.BzrCommandError(gettext(
 
3544
                    "Invalid bug %s. Must be in the form of 'tracker:id'. "
 
3545
                    "See \"bzr help bugs\" for more information on this "
 
3546
                    "feature.\nCommit refused.") % fixed_bug)
 
3547
            else:
 
3548
                tag, bug_id = tokens
2129
3549
            try:
2130
 
                bug_url = bugtracker.get_bug_url(tag, branch, bug_id)
 
3550
                yield bugtracker.get_bug_url(tag, branch, bug_id)
2131
3551
            except errors.UnknownBugTrackerAbbreviation:
2132
 
                raise errors.BzrCommandError(
2133
 
                    'Unrecognized bug %s. Commit refused.' % fixed_bug)
2134
 
            except errors.MalformedBugIdentifier:
2135
 
                raise errors.BzrCommandError(
2136
 
                    "Invalid bug identifier for %s. Commit refused."
2137
 
                    % fixed_bug)
2138
 
            properties.append('%s fixed' % bug_url)
2139
 
        return '\n'.join(properties)
2140
 
 
2141
 
    def run(self, message=None, file=None, verbose=True, selected_list=None,
2142
 
            unchanged=False, strict=False, local=False, fixes=None):
2143
 
        from bzrlib.commit import (NullCommitReporter, ReportCommitToLog)
2144
 
        from bzrlib.errors import (PointlessCommit, ConflictsInTree,
2145
 
                StrictCommitFailed)
2146
 
        from bzrlib.msgeditor import edit_commit_message, \
2147
 
                make_commit_message_template
2148
 
 
2149
 
        # TODO: Need a blackbox test for invoking the external editor; may be
2150
 
        # slightly problematic to run this cross-platform.
2151
 
 
2152
 
        # TODO: do more checks that the commit will succeed before 
2153
 
        # spending the user's valuable time typing a commit message.
 
3552
                raise errors.BzrCommandError(gettext(
 
3553
                    'Unrecognized bug %s. Commit refused.') % fixed_bug)
 
3554
            except errors.MalformedBugIdentifier, e:
 
3555
                raise errors.BzrCommandError(gettext(
 
3556
                    "%s\nCommit refused.") % (str(e),))
 
3557
 
 
3558
    def run(self, message=None, file=None, verbose=False, selected_list=None,
 
3559
            unchanged=False, strict=False, local=False, fixes=None,
 
3560
            author=None, show_diff=False, exclude=None, commit_time=None,
 
3561
            lossy=False):
 
3562
        from bzrlib.errors import (
 
3563
            PointlessCommit,
 
3564
            ConflictsInTree,
 
3565
            StrictCommitFailed
 
3566
        )
 
3567
        from bzrlib.msgeditor import (
 
3568
            edit_commit_message_encoded,
 
3569
            generate_commit_message_template,
 
3570
            make_commit_message_template_encoded,
 
3571
            set_commit_message,
 
3572
        )
 
3573
 
 
3574
        commit_stamp = offset = None
 
3575
        if commit_time is not None:
 
3576
            try:
 
3577
                commit_stamp, offset = timestamp.parse_patch_date(commit_time)
 
3578
            except ValueError, e:
 
3579
                raise errors.BzrCommandError(gettext(
 
3580
                    "Could not parse --commit-time: " + str(e)))
2154
3581
 
2155
3582
        properties = {}
2156
3583
 
2157
 
        tree, selected_list = tree_files(selected_list)
 
3584
        tree, selected_list = WorkingTree.open_containing_paths(selected_list)
2158
3585
        if selected_list == ['']:
2159
3586
            # workaround - commit of root of tree should be exactly the same
2160
3587
            # as just default commit in that tree, and succeed even though
2161
3588
            # selected-file merge commit is not done yet
2162
3589
            selected_list = []
2163
3590
 
2164
 
        bug_property = self._get_bug_fix_properties(fixes, tree.branch)
 
3591
        if fixes is None:
 
3592
            fixes = []
 
3593
        bug_property = bugtracker.encode_fixes_bug_urls(
 
3594
            self._iter_bug_fix_urls(fixes, tree.branch))
2165
3595
        if bug_property:
2166
3596
            properties['bugs'] = bug_property
2167
3597
 
2168
3598
        if local and not tree.branch.get_bound_location():
2169
3599
            raise errors.LocalRequiresBoundBranch()
2170
3600
 
 
3601
        if message is not None:
 
3602
            try:
 
3603
                file_exists = osutils.lexists(message)
 
3604
            except UnicodeError:
 
3605
                # The commit message contains unicode characters that can't be
 
3606
                # represented in the filesystem encoding, so that can't be a
 
3607
                # file.
 
3608
                file_exists = False
 
3609
            if file_exists:
 
3610
                warning_msg = (
 
3611
                    'The commit message is a file name: "%(f)s".\n'
 
3612
                    '(use --file "%(f)s" to take commit message from that file)'
 
3613
                    % { 'f': message })
 
3614
                ui.ui_factory.show_warning(warning_msg)
 
3615
            if '\r' in message:
 
3616
                message = message.replace('\r\n', '\n')
 
3617
                message = message.replace('\r', '\n')
 
3618
            if file:
 
3619
                raise errors.BzrCommandError(gettext(
 
3620
                    "please specify either --message or --file"))
 
3621
 
2171
3622
        def get_message(commit_obj):
2172
3623
            """Callback to get commit message"""
2173
 
            my_message = message
2174
 
            if my_message is None and not file:
2175
 
                template = make_commit_message_template(tree, selected_list)
2176
 
                my_message = edit_commit_message(template)
2177
 
                if my_message is None:
2178
 
                    raise errors.BzrCommandError("please specify a commit"
2179
 
                        " message with either --message or --file")
2180
 
            elif my_message and file:
2181
 
                raise errors.BzrCommandError(
2182
 
                    "please specify either --message or --file")
2183
3624
            if file:
2184
 
                my_message = codecs.open(file, 'rt', 
2185
 
                                         bzrlib.user_encoding).read()
2186
 
            if my_message == "":
2187
 
                raise errors.BzrCommandError("empty commit message specified")
 
3625
                f = open(file)
 
3626
                try:
 
3627
                    my_message = f.read().decode(osutils.get_user_encoding())
 
3628
                finally:
 
3629
                    f.close()
 
3630
            elif message is not None:
 
3631
                my_message = message
 
3632
            else:
 
3633
                # No message supplied: make one up.
 
3634
                # text is the status of the tree
 
3635
                text = make_commit_message_template_encoded(tree,
 
3636
                        selected_list, diff=show_diff,
 
3637
                        output_encoding=osutils.get_user_encoding())
 
3638
                # start_message is the template generated from hooks
 
3639
                # XXX: Warning - looks like hooks return unicode,
 
3640
                # make_commit_message_template_encoded returns user encoding.
 
3641
                # We probably want to be using edit_commit_message instead to
 
3642
                # avoid this.
 
3643
                my_message = set_commit_message(commit_obj)
 
3644
                if my_message is None:
 
3645
                    start_message = generate_commit_message_template(commit_obj)
 
3646
                    my_message = edit_commit_message_encoded(text,
 
3647
                        start_message=start_message)
 
3648
                if my_message is None:
 
3649
                    raise errors.BzrCommandError(gettext("please specify a commit"
 
3650
                        " message with either --message or --file"))
 
3651
                if my_message == "":
 
3652
                    raise errors.BzrCommandError(gettext("Empty commit message specified."
 
3653
                            " Please specify a commit message with either"
 
3654
                            " --message or --file or leave a blank message"
 
3655
                            " with --message \"\"."))
2188
3656
            return my_message
2189
3657
 
2190
 
        if verbose:
2191
 
            reporter = ReportCommitToLog()
2192
 
        else:
2193
 
            reporter = NullCommitReporter()
2194
 
 
 
3658
        # The API permits a commit with a filter of [] to mean 'select nothing'
 
3659
        # but the command line should not do that.
 
3660
        if not selected_list:
 
3661
            selected_list = None
2195
3662
        try:
2196
3663
            tree.commit(message_callback=get_message,
2197
3664
                        specific_files=selected_list,
2198
3665
                        allow_pointless=unchanged, strict=strict, local=local,
2199
 
                        reporter=reporter, revprops=properties)
 
3666
                        reporter=None, verbose=verbose, revprops=properties,
 
3667
                        authors=author, timestamp=commit_stamp,
 
3668
                        timezone=offset,
 
3669
                        exclude=tree.safe_relpath_files(exclude),
 
3670
                        lossy=lossy)
2200
3671
        except PointlessCommit:
2201
 
            # FIXME: This should really happen before the file is read in;
2202
 
            # perhaps prepare the commit; get the message; then actually commit
2203
 
            raise errors.BzrCommandError("no changes to commit."
2204
 
                              " use --unchanged to commit anyhow")
 
3672
            raise errors.BzrCommandError(gettext("No changes to commit."
 
3673
                " Please 'bzr add' the files you want to commit, or use"
 
3674
                " --unchanged to force an empty commit."))
2205
3675
        except ConflictsInTree:
2206
 
            raise errors.BzrCommandError('Conflicts detected in working '
 
3676
            raise errors.BzrCommandError(gettext('Conflicts detected in working '
2207
3677
                'tree.  Use "bzr conflicts" to list, "bzr resolve FILE" to'
2208
 
                ' resolve.')
 
3678
                ' resolve.'))
2209
3679
        except StrictCommitFailed:
2210
 
            raise errors.BzrCommandError("Commit refused because there are"
2211
 
                              " unknown files in the working tree.")
 
3680
            raise errors.BzrCommandError(gettext("Commit refused because there are"
 
3681
                              " unknown files in the working tree."))
2212
3682
        except errors.BoundBranchOutOfDate, e:
2213
 
            raise errors.BzrCommandError(str(e) + "\n"
2214
 
            'To commit to master branch, run update and then commit.\n'
2215
 
            'You can also pass --local to commit to continue working '
2216
 
            'disconnected.')
 
3683
            e.extra_help = (gettext("\n"
 
3684
                'To commit to master branch, run update and then commit.\n'
 
3685
                'You can also pass --local to commit to continue working '
 
3686
                'disconnected.'))
 
3687
            raise
2217
3688
 
2218
3689
 
2219
3690
class cmd_check(Command):
2220
 
    """Validate consistency of branch history.
2221
 
 
2222
 
    This command checks various invariants about the branch storage to
2223
 
    detect data corruption or bzr bugs.
 
3691
    __doc__ = """Validate working tree structure, branch consistency and repository history.
 
3692
 
 
3693
    This command checks various invariants about branch and repository storage
 
3694
    to detect data corruption or bzr bugs.
 
3695
 
 
3696
    The working tree and branch checks will only give output if a problem is
 
3697
    detected. The output fields of the repository check are:
 
3698
 
 
3699
    revisions
 
3700
        This is just the number of revisions checked.  It doesn't
 
3701
        indicate a problem.
 
3702
 
 
3703
    versionedfiles
 
3704
        This is just the number of versionedfiles checked.  It
 
3705
        doesn't indicate a problem.
 
3706
 
 
3707
    unreferenced ancestors
 
3708
        Texts that are ancestors of other texts, but
 
3709
        are not properly referenced by the revision ancestry.  This is a
 
3710
        subtle problem that Bazaar can work around.
 
3711
 
 
3712
    unique file texts
 
3713
        This is the total number of unique file contents
 
3714
        seen in the checked revisions.  It does not indicate a problem.
 
3715
 
 
3716
    repeated file texts
 
3717
        This is the total number of repeated texts seen
 
3718
        in the checked revisions.  Texts can be repeated when their file
 
3719
        entries are modified, but the file contents are not.  It does not
 
3720
        indicate a problem.
 
3721
 
 
3722
    If no restrictions are specified, all Bazaar data that is found at the given
 
3723
    location will be checked.
 
3724
 
 
3725
    :Examples:
 
3726
 
 
3727
        Check the tree and branch at 'foo'::
 
3728
 
 
3729
            bzr check --tree --branch foo
 
3730
 
 
3731
        Check only the repository at 'bar'::
 
3732
 
 
3733
            bzr check --repo bar
 
3734
 
 
3735
        Check everything at 'baz'::
 
3736
 
 
3737
            bzr check baz
2224
3738
    """
2225
3739
 
2226
3740
    _see_also = ['reconcile']
2227
 
    takes_args = ['branch?']
2228
 
    takes_options = ['verbose']
 
3741
    takes_args = ['path?']
 
3742
    takes_options = ['verbose',
 
3743
                     Option('branch', help="Check the branch related to the"
 
3744
                                           " current directory."),
 
3745
                     Option('repo', help="Check the repository related to the"
 
3746
                                         " current directory."),
 
3747
                     Option('tree', help="Check the working tree related to"
 
3748
                                         " the current directory.")]
2229
3749
 
2230
 
    def run(self, branch=None, verbose=False):
2231
 
        from bzrlib.check import check
2232
 
        if branch is None:
2233
 
            tree = WorkingTree.open_containing()[0]
2234
 
            branch = tree.branch
2235
 
        else:
2236
 
            branch = Branch.open(branch)
2237
 
        check(branch, verbose)
 
3750
    def run(self, path=None, verbose=False, branch=False, repo=False,
 
3751
            tree=False):
 
3752
        from bzrlib.check import check_dwim
 
3753
        if path is None:
 
3754
            path = '.'
 
3755
        if not branch and not repo and not tree:
 
3756
            branch = repo = tree = True
 
3757
        check_dwim(path, verbose, do_branch=branch, do_repo=repo, do_tree=tree)
2238
3758
 
2239
3759
 
2240
3760
class cmd_upgrade(Command):
2241
 
    """Upgrade branch storage to current format.
2242
 
 
2243
 
    The check command or bzr developers may sometimes advise you to run
2244
 
    this command. When the default format has changed you may also be warned
2245
 
    during other operations to upgrade.
 
3761
    __doc__ = """Upgrade a repository, branch or working tree to a newer format.
 
3762
 
 
3763
    When the default format has changed after a major new release of
 
3764
    Bazaar, you may be informed during certain operations that you
 
3765
    should upgrade. Upgrading to a newer format may improve performance
 
3766
    or make new features available. It may however limit interoperability
 
3767
    with older repositories or with older versions of Bazaar.
 
3768
 
 
3769
    If you wish to upgrade to a particular format rather than the
 
3770
    current default, that can be specified using the --format option.
 
3771
    As a consequence, you can use the upgrade command this way to
 
3772
    "downgrade" to an earlier format, though some conversions are
 
3773
    a one way process (e.g. changing from the 1.x default to the
 
3774
    2.x default) so downgrading is not always possible.
 
3775
 
 
3776
    A backup.bzr.~#~ directory is created at the start of the conversion
 
3777
    process (where # is a number). By default, this is left there on
 
3778
    completion. If the conversion fails, delete the new .bzr directory
 
3779
    and rename this one back in its place. Use the --clean option to ask
 
3780
    for the backup.bzr directory to be removed on successful conversion.
 
3781
    Alternatively, you can delete it by hand if everything looks good
 
3782
    afterwards.
 
3783
 
 
3784
    If the location given is a shared repository, dependent branches
 
3785
    are also converted provided the repository converts successfully.
 
3786
    If the conversion of a branch fails, remaining branches are still
 
3787
    tried.
 
3788
 
 
3789
    For more information on upgrades, see the Bazaar Upgrade Guide,
 
3790
    http://doc.bazaar.canonical.com/latest/en/upgrade-guide/.
2246
3791
    """
2247
3792
 
2248
 
    _see_also = ['check']
 
3793
    _see_also = ['check', 'reconcile', 'formats']
2249
3794
    takes_args = ['url?']
2250
3795
    takes_options = [
2251
 
                    RegistryOption('format',
2252
 
                        help='Upgrade to a specific format.  See "bzr help'
2253
 
                             ' formats" for details',
2254
 
                        registry=bzrdir.format_registry,
2255
 
                        converter=bzrdir.format_registry.make_bzrdir,
2256
 
                        value_switches=True, title='Branch format'),
2257
 
                    ]
 
3796
        RegistryOption('format',
 
3797
            help='Upgrade to a specific format.  See "bzr help'
 
3798
                 ' formats" for details.',
 
3799
            lazy_registry=('bzrlib.controldir', 'format_registry'),
 
3800
            converter=lambda name: controldir.format_registry.make_bzrdir(name),
 
3801
            value_switches=True, title='Branch format'),
 
3802
        Option('clean',
 
3803
            help='Remove the backup.bzr directory if successful.'),
 
3804
        Option('dry-run',
 
3805
            help="Show what would be done, but don't actually do anything."),
 
3806
    ]
2258
3807
 
2259
 
    def run(self, url='.', format=None):
 
3808
    def run(self, url='.', format=None, clean=False, dry_run=False):
2260
3809
        from bzrlib.upgrade import upgrade
2261
 
        if format is None:
2262
 
            format = bzrdir.format_registry.make_bzrdir('default')
2263
 
        upgrade(url, format)
 
3810
        exceptions = upgrade(url, format, clean_up=clean, dry_run=dry_run)
 
3811
        if exceptions:
 
3812
            if len(exceptions) == 1:
 
3813
                # Compatibility with historical behavior
 
3814
                raise exceptions[0]
 
3815
            else:
 
3816
                return 3
2264
3817
 
2265
3818
 
2266
3819
class cmd_whoami(Command):
2267
 
    """Show or set bzr user id.
2268
 
    
2269
 
    examples:
2270
 
        bzr whoami --email
2271
 
        bzr whoami 'Frank Chu <fchu@example.com>'
 
3820
    __doc__ = """Show or set bzr user id.
 
3821
 
 
3822
    :Examples:
 
3823
        Show the email of the current user::
 
3824
 
 
3825
            bzr whoami --email
 
3826
 
 
3827
        Set the current user::
 
3828
 
 
3829
            bzr whoami "Frank Chu <fchu@example.com>"
2272
3830
    """
2273
 
    takes_options = [ Option('email',
2274
 
                             help='display email address only'),
 
3831
    takes_options = [ 'directory',
 
3832
                      Option('email',
 
3833
                             help='Display email address only.'),
2275
3834
                      Option('branch',
2276
 
                             help='set identity for the current branch instead of '
2277
 
                                  'globally'),
 
3835
                             help='Set identity for the current branch instead of '
 
3836
                                  'globally.'),
2278
3837
                    ]
2279
3838
    takes_args = ['name?']
2280
3839
    encoding_type = 'replace'
2281
 
    
 
3840
 
2282
3841
    @display_command
2283
 
    def run(self, email=False, branch=False, name=None):
 
3842
    def run(self, email=False, branch=False, name=None, directory=None):
2284
3843
        if name is None:
2285
 
            # use branch if we're inside one; otherwise global config
2286
 
            try:
2287
 
                c = Branch.open_containing('.')[0].get_config()
2288
 
            except errors.NotBranchError:
2289
 
                c = config.GlobalConfig()
 
3844
            if directory is None:
 
3845
                # use branch if we're inside one; otherwise global config
 
3846
                try:
 
3847
                    c = Branch.open_containing(u'.')[0].get_config_stack()
 
3848
                except errors.NotBranchError:
 
3849
                    c = _mod_config.GlobalStack()
 
3850
            else:
 
3851
                c = Branch.open(directory).get_config_stack()
 
3852
            identity = c.get('email')
2290
3853
            if email:
2291
 
                self.outf.write(c.user_email() + '\n')
 
3854
                self.outf.write(_mod_config.extract_email_address(identity)
 
3855
                                + '\n')
2292
3856
            else:
2293
 
                self.outf.write(c.username() + '\n')
 
3857
                self.outf.write(identity + '\n')
2294
3858
            return
2295
3859
 
 
3860
        if email:
 
3861
            raise errors.BzrCommandError(gettext("--email can only be used to display existing "
 
3862
                                         "identity"))
 
3863
 
2296
3864
        # display a warning if an email address isn't included in the given name.
2297
3865
        try:
2298
 
            config.extract_email_address(name)
 
3866
            _mod_config.extract_email_address(name)
2299
3867
        except errors.NoEmailInUsername, e:
2300
3868
            warning('"%s" does not seem to contain an email address.  '
2301
3869
                    'This is allowed, but not recommended.', name)
2302
 
        
 
3870
 
2303
3871
        # use global config unless --branch given
2304
3872
        if branch:
2305
 
            c = Branch.open_containing('.')[0].get_config()
 
3873
            if directory is None:
 
3874
                c = Branch.open_containing(u'.')[0].get_config_stack()
 
3875
            else:
 
3876
                b = Branch.open(directory)
 
3877
                self.add_cleanup(b.lock_write().unlock)
 
3878
                c = b.get_config_stack()
2306
3879
        else:
2307
 
            c = config.GlobalConfig()
2308
 
        c.set_user_option('email', name)
 
3880
            c = _mod_config.GlobalStack()
 
3881
        c.set('email', name)
2309
3882
 
2310
3883
 
2311
3884
class cmd_nick(Command):
2312
 
    """Print or set the branch nickname.  
2313
 
 
2314
 
    If unset, the tree root directory name is used as the nickname
2315
 
    To print the current nickname, execute with no argument.  
 
3885
    __doc__ = """Print or set the branch nickname.
 
3886
 
 
3887
    If unset, the colocated branch name is used for colocated branches, and
 
3888
    the branch directory name is used for other branches.  To print the
 
3889
    current nickname, execute with no argument.
 
3890
 
 
3891
    Bound branches use the nickname of its master branch unless it is set
 
3892
    locally.
2316
3893
    """
2317
3894
 
2318
3895
    _see_also = ['info']
2319
3896
    takes_args = ['nickname?']
2320
 
    def run(self, nickname=None):
2321
 
        branch = Branch.open_containing(u'.')[0]
 
3897
    takes_options = ['directory']
 
3898
    def run(self, nickname=None, directory=u'.'):
 
3899
        branch = Branch.open_containing(directory)[0]
2322
3900
        if nickname is None:
2323
3901
            self.printme(branch)
2324
3902
        else:
2326
3904
 
2327
3905
    @display_command
2328
3906
    def printme(self, branch):
2329
 
        print branch.nick
 
3907
        self.outf.write('%s\n' % branch.nick)
 
3908
 
 
3909
 
 
3910
class cmd_alias(Command):
 
3911
    __doc__ = """Set/unset and display aliases.
 
3912
 
 
3913
    :Examples:
 
3914
        Show the current aliases::
 
3915
 
 
3916
            bzr alias
 
3917
 
 
3918
        Show the alias specified for 'll'::
 
3919
 
 
3920
            bzr alias ll
 
3921
 
 
3922
        Set an alias for 'll'::
 
3923
 
 
3924
            bzr alias ll="log --line -r-10..-1"
 
3925
 
 
3926
        To remove an alias for 'll'::
 
3927
 
 
3928
            bzr alias --remove ll
 
3929
 
 
3930
    """
 
3931
    takes_args = ['name?']
 
3932
    takes_options = [
 
3933
        Option('remove', help='Remove the alias.'),
 
3934
        ]
 
3935
 
 
3936
    def run(self, name=None, remove=False):
 
3937
        if remove:
 
3938
            self.remove_alias(name)
 
3939
        elif name is None:
 
3940
            self.print_aliases()
 
3941
        else:
 
3942
            equal_pos = name.find('=')
 
3943
            if equal_pos == -1:
 
3944
                self.print_alias(name)
 
3945
            else:
 
3946
                self.set_alias(name[:equal_pos], name[equal_pos+1:])
 
3947
 
 
3948
    def remove_alias(self, alias_name):
 
3949
        if alias_name is None:
 
3950
            raise errors.BzrCommandError(gettext(
 
3951
                'bzr alias --remove expects an alias to remove.'))
 
3952
        # If alias is not found, print something like:
 
3953
        # unalias: foo: not found
 
3954
        c = _mod_config.GlobalConfig()
 
3955
        c.unset_alias(alias_name)
 
3956
 
 
3957
    @display_command
 
3958
    def print_aliases(self):
 
3959
        """Print out the defined aliases in a similar format to bash."""
 
3960
        aliases = _mod_config.GlobalConfig().get_aliases()
 
3961
        for key, value in sorted(aliases.iteritems()):
 
3962
            self.outf.write('bzr alias %s="%s"\n' % (key, value))
 
3963
 
 
3964
    @display_command
 
3965
    def print_alias(self, alias_name):
 
3966
        from bzrlib.commands import get_alias
 
3967
        alias = get_alias(alias_name)
 
3968
        if alias is None:
 
3969
            self.outf.write("bzr alias: %s: not found\n" % alias_name)
 
3970
        else:
 
3971
            self.outf.write(
 
3972
                'bzr alias %s="%s"\n' % (alias_name, ' '.join(alias)))
 
3973
 
 
3974
    def set_alias(self, alias_name, alias_command):
 
3975
        """Save the alias in the global config."""
 
3976
        c = _mod_config.GlobalConfig()
 
3977
        c.set_alias(alias_name, alias_command)
2330
3978
 
2331
3979
 
2332
3980
class cmd_selftest(Command):
2333
 
    """Run internal test suite.
2334
 
    
 
3981
    __doc__ = """Run internal test suite.
 
3982
 
2335
3983
    If arguments are given, they are regular expressions that say which tests
2336
3984
    should run.  Tests matching any expression are run, and other tests are
2337
3985
    not run.
2360
4008
    modified by plugins will not be tested, and tests provided by plugins will
2361
4009
    not be run.
2362
4010
 
2363
 
    examples::
2364
 
        bzr selftest ignore
2365
 
            run only tests relating to 'ignore'
2366
 
        bzr --no-plugins selftest -v
2367
 
            disable plugins and list tests as they're run
2368
 
 
2369
 
    For each test, that needs actual disk access, bzr create their own
2370
 
    subdirectory in the temporary testing directory (testXXXX.tmp).
2371
 
    By default the name of such subdirectory is based on the name of the test.
2372
 
    If option '--numbered-dirs' is given, bzr will use sequent numbers
2373
 
    of running tests to create such subdirectories. This is default behavior
2374
 
    on Windows because of path length limitation.
 
4011
    Tests that need working space on disk use a common temporary directory,
 
4012
    typically inside $TMPDIR or /tmp.
 
4013
 
 
4014
    If you set BZR_TEST_PDB=1 when running selftest, failing tests will drop
 
4015
    into a pdb postmortem session.
 
4016
 
 
4017
    The --coverage=DIRNAME global option produces a report with covered code
 
4018
    indicated.
 
4019
 
 
4020
    :Examples:
 
4021
        Run only tests relating to 'ignore'::
 
4022
 
 
4023
            bzr selftest ignore
 
4024
 
 
4025
        Disable plugins and list tests as they're run::
 
4026
 
 
4027
            bzr --no-plugins selftest -v
2375
4028
    """
2376
4029
    # NB: this is used from the class without creating an instance, which is
2377
4030
    # why it does not have a self parameter.
2378
4031
    def get_transport_type(typestring):
2379
4032
        """Parse and return a transport specifier."""
2380
4033
        if typestring == "sftp":
2381
 
            from bzrlib.transport.sftp import SFTPAbsoluteServer
2382
 
            return SFTPAbsoluteServer
2383
 
        if typestring == "memory":
2384
 
            from bzrlib.transport.memory import MemoryServer
2385
 
            return MemoryServer
2386
 
        if typestring == "fakenfs":
2387
 
            from bzrlib.transport.fakenfs import FakeNFSServer
2388
 
            return FakeNFSServer
 
4034
            from bzrlib.tests import stub_sftp
 
4035
            return stub_sftp.SFTPAbsoluteServer
 
4036
        elif typestring == "memory":
 
4037
            from bzrlib.tests import test_server
 
4038
            return memory.MemoryServer
 
4039
        elif typestring == "fakenfs":
 
4040
            from bzrlib.tests import test_server
 
4041
            return test_server.FakeNFSServer
2389
4042
        msg = "No known transport type %s. Supported types are: sftp\n" %\
2390
4043
            (typestring)
2391
4044
        raise errors.BzrCommandError(msg)
2394
4047
    takes_args = ['testspecs*']
2395
4048
    takes_options = ['verbose',
2396
4049
                     Option('one',
2397
 
                             help='stop when one test fails',
 
4050
                             help='Stop when one test fails.',
2398
4051
                             short_name='1',
2399
4052
                             ),
2400
 
                     Option('keep-output',
2401
 
                            help='keep output directories when tests fail'),
2402
4053
                     Option('transport',
2403
4054
                            help='Use a different transport by default '
2404
4055
                                 'throughout the test suite.',
2405
4056
                            type=get_transport_type),
2406
 
                     Option('benchmark', help='run the bzr benchmarks.'),
 
4057
                     Option('benchmark',
 
4058
                            help='Run the benchmarks rather than selftests.',
 
4059
                            hidden=True),
2407
4060
                     Option('lsprof-timed',
2408
 
                            help='generate lsprof output for benchmarked'
 
4061
                            help='Generate lsprof output for benchmarked'
2409
4062
                                 ' sections of code.'),
2410
 
                     Option('cache-dir', type=str,
2411
 
                            help='a directory to cache intermediate'
2412
 
                                 ' benchmark steps'),
2413
 
                     Option('clean-output',
2414
 
                            help='clean temporary tests directories'
2415
 
                                 ' without running tests'),
 
4063
                     Option('lsprof-tests',
 
4064
                            help='Generate lsprof output for each test.'),
2416
4065
                     Option('first',
2417
 
                            help='run all tests, but run specified tests first',
 
4066
                            help='Run all tests, but run specified tests first.',
2418
4067
                            short_name='f',
2419
4068
                            ),
2420
 
                     Option('numbered-dirs',
2421
 
                            help='use numbered dirs for TestCaseInTempDir'),
2422
4069
                     Option('list-only',
2423
 
                            help='list the tests instead of running them'),
 
4070
                            help='List the tests instead of running them.'),
 
4071
                     RegistryOption('parallel',
 
4072
                        help="Run the test suite in parallel.",
 
4073
                        lazy_registry=('bzrlib.tests', 'parallel_registry'),
 
4074
                        value_switches=False,
 
4075
                        ),
2424
4076
                     Option('randomize', type=str, argname="SEED",
2425
 
                            help='randomize the order of tests using the given'
2426
 
                                 ' seed or "now" for the current time'),
2427
 
                     Option('exclude', type=str, argname="PATTERN",
2428
 
                            short_name='x',
2429
 
                            help='exclude tests that match this regular'
2430
 
                                 ' expression'),
 
4077
                            help='Randomize the order of tests using the given'
 
4078
                                 ' seed or "now" for the current time.'),
 
4079
                     ListOption('exclude', type=str, argname="PATTERN",
 
4080
                                short_name='x',
 
4081
                                help='Exclude tests that match this regular'
 
4082
                                ' expression.'),
 
4083
                     Option('subunit',
 
4084
                        help='Output test progress via subunit.'),
 
4085
                     Option('strict', help='Fail on missing dependencies or '
 
4086
                            'known failures.'),
 
4087
                     Option('load-list', type=str, argname='TESTLISTFILE',
 
4088
                            help='Load a test id list from a text file.'),
 
4089
                     ListOption('debugflag', type=str, short_name='E',
 
4090
                                help='Turn on a selftest debug flag.'),
 
4091
                     ListOption('starting-with', type=str, argname='TESTID',
 
4092
                                param_name='starting_with', short_name='s',
 
4093
                                help=
 
4094
                                'Load only the tests starting with TESTID.'),
 
4095
                     Option('sync',
 
4096
                            help="By default we disable fsync and fdatasync"
 
4097
                                 " while running the test suite.")
2431
4098
                     ]
2432
4099
    encoding_type = 'replace'
2433
4100
 
2434
 
    def run(self, testspecs_list=None, verbose=None, one=False,
2435
 
            keep_output=False, transport=None, benchmark=None,
2436
 
            lsprof_timed=None, cache_dir=None, clean_output=False,
2437
 
            first=False, numbered_dirs=None, list_only=False,
2438
 
            randomize=None, exclude=None):
2439
 
        import bzrlib.ui
2440
 
        from bzrlib.tests import selftest
2441
 
        import bzrlib.benchmarks as benchmarks
2442
 
        from bzrlib.benchmarks import tree_creator
2443
 
 
2444
 
        if clean_output:
2445
 
            from bzrlib.tests import clean_selftest_output
2446
 
            clean_selftest_output()
2447
 
            return 0
2448
 
        if keep_output:
2449
 
            warning("notice: selftest --keep-output "
2450
 
                    "is no longer supported; "
2451
 
                    "test output is always removed")
2452
 
 
2453
 
        if numbered_dirs is None and sys.platform == 'win32':
2454
 
            numbered_dirs = True
2455
 
 
2456
 
        if cache_dir is not None:
2457
 
            tree_creator.TreeCreator.CACHE_ROOT = osutils.abspath(cache_dir)
2458
 
        print '%10s: %s' % ('bzr', osutils.realpath(sys.argv[0]))
2459
 
        print '%10s: %s' % ('bzrlib', bzrlib.__path__[0])
2460
 
        print
 
4101
    def __init__(self):
 
4102
        Command.__init__(self)
 
4103
        self.additional_selftest_args = {}
 
4104
 
 
4105
    def run(self, testspecs_list=None, verbose=False, one=False,
 
4106
            transport=None, benchmark=None,
 
4107
            lsprof_timed=None,
 
4108
            first=False, list_only=False,
 
4109
            randomize=None, exclude=None, strict=False,
 
4110
            load_list=None, debugflag=None, starting_with=None, subunit=False,
 
4111
            parallel=None, lsprof_tests=False,
 
4112
            sync=False):
 
4113
 
 
4114
        # During selftest, disallow proxying, as it can cause severe
 
4115
        # performance penalties and is only needed for thread
 
4116
        # safety. The selftest command is assumed to not use threads
 
4117
        # too heavily. The call should be as early as possible, as
 
4118
        # error reporting for past duplicate imports won't have useful
 
4119
        # backtraces.
 
4120
        lazy_import.disallow_proxying()
 
4121
 
 
4122
        from bzrlib import tests
 
4123
 
2461
4124
        if testspecs_list is not None:
2462
4125
            pattern = '|'.join(testspecs_list)
2463
4126
        else:
2464
4127
            pattern = ".*"
 
4128
        if subunit:
 
4129
            try:
 
4130
                from bzrlib.tests import SubUnitBzrRunner
 
4131
            except ImportError:
 
4132
                raise errors.BzrCommandError(gettext("subunit not available. subunit "
 
4133
                    "needs to be installed to use --subunit."))
 
4134
            self.additional_selftest_args['runner_class'] = SubUnitBzrRunner
 
4135
            # On Windows, disable automatic conversion of '\n' to '\r\n' in
 
4136
            # stdout, which would corrupt the subunit stream. 
 
4137
            # FIXME: This has been fixed in subunit trunk (>0.0.5) so the
 
4138
            # following code can be deleted when it's sufficiently deployed
 
4139
            # -- vila/mgz 20100514
 
4140
            if (sys.platform == "win32"
 
4141
                and getattr(sys.stdout, 'fileno', None) is not None):
 
4142
                import msvcrt
 
4143
                msvcrt.setmode(sys.stdout.fileno(), os.O_BINARY)
 
4144
        if parallel:
 
4145
            self.additional_selftest_args.setdefault(
 
4146
                'suite_decorators', []).append(parallel)
2465
4147
        if benchmark:
2466
 
            test_suite_factory = benchmarks.test_suite
2467
 
            if verbose is None:
2468
 
                verbose = True
2469
 
            # TODO: should possibly lock the history file...
2470
 
            benchfile = open(".perf_history", "at", buffering=1)
 
4148
            raise errors.BzrCommandError(gettext(
 
4149
                "--benchmark is no longer supported from bzr 2.2; "
 
4150
                "use bzr-usertest instead"))
 
4151
        test_suite_factory = None
 
4152
        if not exclude:
 
4153
            exclude_pattern = None
2471
4154
        else:
2472
 
            test_suite_factory = None
2473
 
            if verbose is None:
2474
 
                verbose = False
2475
 
            benchfile = None
 
4155
            exclude_pattern = '(' + '|'.join(exclude) + ')'
 
4156
        if not sync:
 
4157
            self._disable_fsync()
 
4158
        selftest_kwargs = {"verbose": verbose,
 
4159
                          "pattern": pattern,
 
4160
                          "stop_on_failure": one,
 
4161
                          "transport": transport,
 
4162
                          "test_suite_factory": test_suite_factory,
 
4163
                          "lsprof_timed": lsprof_timed,
 
4164
                          "lsprof_tests": lsprof_tests,
 
4165
                          "matching_tests_first": first,
 
4166
                          "list_only": list_only,
 
4167
                          "random_seed": randomize,
 
4168
                          "exclude_pattern": exclude_pattern,
 
4169
                          "strict": strict,
 
4170
                          "load_list": load_list,
 
4171
                          "debug_flags": debugflag,
 
4172
                          "starting_with": starting_with
 
4173
                          }
 
4174
        selftest_kwargs.update(self.additional_selftest_args)
 
4175
 
 
4176
        # Make deprecation warnings visible, unless -Werror is set
 
4177
        cleanup = symbol_versioning.activate_deprecation_warnings(
 
4178
            override=False)
2476
4179
        try:
2477
 
            result = selftest(verbose=verbose, 
2478
 
                              pattern=pattern,
2479
 
                              stop_on_failure=one, 
2480
 
                              transport=transport,
2481
 
                              test_suite_factory=test_suite_factory,
2482
 
                              lsprof_timed=lsprof_timed,
2483
 
                              bench_history=benchfile,
2484
 
                              matching_tests_first=first,
2485
 
                              numbered_dirs=numbered_dirs,
2486
 
                              list_only=list_only,
2487
 
                              random_seed=randomize,
2488
 
                              exclude_pattern=exclude
2489
 
                              )
 
4180
            result = tests.selftest(**selftest_kwargs)
2490
4181
        finally:
2491
 
            if benchfile is not None:
2492
 
                benchfile.close()
2493
 
        if result:
2494
 
            info('tests passed')
2495
 
        else:
2496
 
            info('tests failed')
 
4182
            cleanup()
2497
4183
        return int(not result)
2498
4184
 
 
4185
    def _disable_fsync(self):
 
4186
        """Change the 'os' functionality to not synchronize."""
 
4187
        self._orig_fsync = getattr(os, 'fsync', None)
 
4188
        if self._orig_fsync is not None:
 
4189
            os.fsync = lambda filedes: None
 
4190
        self._orig_fdatasync = getattr(os, 'fdatasync', None)
 
4191
        if self._orig_fdatasync is not None:
 
4192
            os.fdatasync = lambda filedes: None
 
4193
 
2499
4194
 
2500
4195
class cmd_version(Command):
2501
 
    """Show version of bzr."""
 
4196
    __doc__ = """Show version of bzr."""
 
4197
 
 
4198
    encoding_type = 'replace'
 
4199
    takes_options = [
 
4200
        Option("short", help="Print just the version number."),
 
4201
        ]
2502
4202
 
2503
4203
    @display_command
2504
 
    def run(self):
 
4204
    def run(self, short=False):
2505
4205
        from bzrlib.version import show_version
2506
 
        show_version()
 
4206
        if short:
 
4207
            self.outf.write(bzrlib.version_string + '\n')
 
4208
        else:
 
4209
            show_version(to_file=self.outf)
2507
4210
 
2508
4211
 
2509
4212
class cmd_rocks(Command):
2510
 
    """Statement of optimism."""
 
4213
    __doc__ = """Statement of optimism."""
2511
4214
 
2512
4215
    hidden = True
2513
4216
 
2514
4217
    @display_command
2515
4218
    def run(self):
2516
 
        print "It sure does!"
 
4219
        self.outf.write(gettext("It sure does!\n"))
2517
4220
 
2518
4221
 
2519
4222
class cmd_find_merge_base(Command):
2520
 
    """Find and print a base revision for merging two branches."""
 
4223
    __doc__ = """Find and print a base revision for merging two branches."""
2521
4224
    # TODO: Options to specify revisions on either side, as if
2522
4225
    #       merging only part of the history.
2523
4226
    takes_args = ['branch', 'other']
2524
4227
    hidden = True
2525
 
    
 
4228
 
2526
4229
    @display_command
2527
4230
    def run(self, branch, other):
2528
 
        from bzrlib.revision import ensure_null, MultipleRevisionSources
2529
 
        
 
4231
        from bzrlib.revision import ensure_null
 
4232
 
2530
4233
        branch1 = Branch.open_containing(branch)[0]
2531
4234
        branch2 = Branch.open_containing(other)[0]
2532
 
 
 
4235
        self.add_cleanup(branch1.lock_read().unlock)
 
4236
        self.add_cleanup(branch2.lock_read().unlock)
2533
4237
        last1 = ensure_null(branch1.last_revision())
2534
4238
        last2 = ensure_null(branch2.last_revision())
2535
4239
 
2536
4240
        graph = branch1.repository.get_graph(branch2.repository)
2537
4241
        base_rev_id = graph.find_unique_lca(last1, last2)
2538
4242
 
2539
 
        print 'merge base is revision %s' % base_rev_id
 
4243
        self.outf.write(gettext('merge base is revision %s\n') % base_rev_id)
2540
4244
 
2541
4245
 
2542
4246
class cmd_merge(Command):
2543
 
    """Perform a three-way merge.
2544
 
    
2545
 
    The branch is the branch you will merge from.  By default, it will merge
2546
 
    the latest revision.  If you specify a revision, that revision will be
2547
 
    merged.  If you specify two revisions, the first will be used as a BASE,
2548
 
    and the second one as OTHER.  Revision numbers are always relative to the
2549
 
    specified branch.
2550
 
 
2551
 
    By default, bzr will try to merge in all new work from the other
2552
 
    branch, automatically determining an appropriate base.  If this
2553
 
    fails, you may need to give an explicit base.
2554
 
    
 
4247
    __doc__ = """Perform a three-way merge.
 
4248
 
 
4249
    The source of the merge can be specified either in the form of a branch,
 
4250
    or in the form of a path to a file containing a merge directive generated
 
4251
    with bzr send. If neither is specified, the default is the upstream branch
 
4252
    or the branch most recently merged using --remember.  The source of the
 
4253
    merge may also be specified in the form of a path to a file in another
 
4254
    branch:  in this case, only the modifications to that file are merged into
 
4255
    the current working tree.
 
4256
 
 
4257
    When merging from a branch, by default bzr will try to merge in all new
 
4258
    work from the other branch, automatically determining an appropriate base
 
4259
    revision.  If this fails, you may need to give an explicit base.
 
4260
 
 
4261
    To pick a different ending revision, pass "--revision OTHER".  bzr will
 
4262
    try to merge in all new work up to and including revision OTHER.
 
4263
 
 
4264
    If you specify two values, "--revision BASE..OTHER", only revisions BASE
 
4265
    through OTHER, excluding BASE but including OTHER, will be merged.  If this
 
4266
    causes some revisions to be skipped, i.e. if the destination branch does
 
4267
    not already contain revision BASE, such a merge is commonly referred to as
 
4268
    a "cherrypick". Unlike a normal merge, Bazaar does not currently track
 
4269
    cherrypicks. The changes look like a normal commit, and the history of the
 
4270
    changes from the other branch is not stored in the commit.
 
4271
 
 
4272
    Revision numbers are always relative to the source branch.
 
4273
 
2555
4274
    Merge will do its best to combine the changes in two branches, but there
2556
4275
    are some kinds of problems only a human can fix.  When it encounters those,
2557
4276
    it will mark a conflict.  A conflict means that you need to fix something,
2558
 
    before you should commit.
 
4277
    before you can commit.
2559
4278
 
2560
4279
    Use bzr resolve when you have fixed a problem.  See also bzr conflicts.
2561
4280
 
2562
 
    If there is no default branch set, the first merge will set it. After
2563
 
    that, you can omit the branch to use the default.  To change the
2564
 
    default, use --remember. The value will only be saved if the remote
2565
 
    location can be accessed.
 
4281
    If there is no default branch set, the first merge will set it (use
 
4282
    --no-remember to avoid setting it). After that, you can omit the branch
 
4283
    to use the default.  To change the default, use --remember. The value will
 
4284
    only be saved if the remote location can be accessed.
2566
4285
 
2567
4286
    The results of the merge are placed into the destination working
2568
4287
    directory, where they can be reviewed (with bzr diff), tested, and then
2569
4288
    committed to record the result of the merge.
2570
4289
 
2571
 
    Examples:
2572
 
 
2573
 
    To merge the latest revision from bzr.dev:
2574
 
        bzr merge ../bzr.dev
2575
 
 
2576
 
    To merge changes up to and including revision 82 from bzr.dev:
2577
 
        bzr merge -r 82 ../bzr.dev
2578
 
 
2579
 
    To merge the changes introduced by 82, without previous changes:
2580
 
        bzr merge -r 81..82 ../bzr.dev
2581
 
    
2582
4290
    merge refuses to run if there are any uncommitted changes, unless
2583
 
    --force is given.
 
4291
    --force is given.  If --force is given, then the changes from the source 
 
4292
    will be merged with the current working tree, including any uncommitted
 
4293
    changes in the tree.  The --force option can also be used to create a
 
4294
    merge revision which has more than two parents.
 
4295
 
 
4296
    If one would like to merge changes from the working tree of the other
 
4297
    branch without merging any committed revisions, the --uncommitted option
 
4298
    can be given.
 
4299
 
 
4300
    To select only some changes to merge, use "merge -i", which will prompt
 
4301
    you to apply each diff hunk and file change, similar to "shelve".
 
4302
 
 
4303
    :Examples:
 
4304
        To merge all new revisions from bzr.dev::
 
4305
 
 
4306
            bzr merge ../bzr.dev
 
4307
 
 
4308
        To merge changes up to and including revision 82 from bzr.dev::
 
4309
 
 
4310
            bzr merge -r 82 ../bzr.dev
 
4311
 
 
4312
        To merge the changes introduced by 82, without previous changes::
 
4313
 
 
4314
            bzr merge -r 81..82 ../bzr.dev
 
4315
 
 
4316
        To apply a merge directive contained in /tmp/merge::
 
4317
 
 
4318
            bzr merge /tmp/merge
 
4319
 
 
4320
        To create a merge revision with three parents from two branches
 
4321
        feature1a and feature1b:
 
4322
 
 
4323
            bzr merge ../feature1a
 
4324
            bzr merge ../feature1b --force
 
4325
            bzr commit -m 'revision with three parents'
2584
4326
    """
2585
4327
 
2586
 
    _see_also = ['update', 'remerge', 'status-flags']
2587
 
    takes_args = ['branch?']
2588
 
    takes_options = ['revision', 'force', 'merge-type', 'reprocess', 'remember',
 
4328
    encoding_type = 'exact'
 
4329
    _see_also = ['update', 'remerge', 'status-flags', 'send']
 
4330
    takes_args = ['location?']
 
4331
    takes_options = [
 
4332
        'change',
 
4333
        'revision',
 
4334
        Option('force',
 
4335
               help='Merge even if the destination tree has uncommitted changes.'),
 
4336
        'merge-type',
 
4337
        'reprocess',
 
4338
        'remember',
2589
4339
        Option('show-base', help="Show base revision text in "
2590
 
               "conflicts"),
 
4340
               "conflicts."),
2591
4341
        Option('uncommitted', help='Apply uncommitted changes'
2592
 
               ' from a working copy, instead of branch changes'),
 
4342
               ' from a working copy, instead of branch changes.'),
2593
4343
        Option('pull', help='If the destination is already'
2594
4344
                ' completely merged into the source, pull from the'
2595
 
                ' source rather than merging. When this happens,'
 
4345
                ' source rather than merging.  When this happens,'
2596
4346
                ' you do not need to commit the result.'),
2597
 
        Option('directory',
2598
 
            help='Branch to merge into, '
2599
 
                 'rather than the one containing the working directory',
2600
 
            short_name='d',
2601
 
            type=unicode,
2602
 
            ),
 
4347
        custom_help('directory',
 
4348
               help='Branch to merge into, '
 
4349
                    'rather than the one containing the working directory.'),
 
4350
        Option('preview', help='Instead of merging, show a diff of the'
 
4351
               ' merge.'),
 
4352
        Option('interactive', help='Select changes interactively.',
 
4353
            short_name='i')
2603
4354
    ]
2604
4355
 
2605
 
    def run(self, branch=None, revision=None, force=False, merge_type=None,
2606
 
            show_base=False, reprocess=False, remember=False,
 
4356
    def run(self, location=None, revision=None, force=False,
 
4357
            merge_type=None, show_base=False, reprocess=None, remember=None,
2607
4358
            uncommitted=False, pull=False,
2608
4359
            directory=None,
 
4360
            preview=False,
 
4361
            interactive=False,
2609
4362
            ):
2610
 
        from bzrlib.tag import _merge_tags_if_possible
2611
 
        other_revision_id = None
2612
4363
        if merge_type is None:
2613
4364
            merge_type = _mod_merge.Merge3Merger
2614
4365
 
2615
4366
        if directory is None: directory = u'.'
2616
 
        # XXX: jam 20070225 WorkingTree should be locked before you extract its
2617
 
        #      inventory. Because merge is a mutating operation, it really
2618
 
        #      should be a lock_write() for the whole cmd_merge operation.
2619
 
        #      However, cmd_merge open's its own tree in _merge_helper, which
2620
 
        #      means if we lock here, the later lock_write() will always block.
2621
 
        #      Either the merge helper code should be updated to take a tree,
2622
 
        #      (What about tree.merge_from_branch?)
 
4367
        possible_transports = []
 
4368
        merger = None
 
4369
        allow_pending = True
 
4370
        verified = 'inapplicable'
 
4371
 
2623
4372
        tree = WorkingTree.open_containing(directory)[0]
 
4373
        if tree.branch.revno() == 0:
 
4374
            raise errors.BzrCommandError(gettext('Merging into empty branches not currently supported, '
 
4375
                                         'https://bugs.launchpad.net/bzr/+bug/308562'))
 
4376
 
 
4377
        try:
 
4378
            basis_tree = tree.revision_tree(tree.last_revision())
 
4379
        except errors.NoSuchRevision:
 
4380
            basis_tree = tree.basis_tree()
 
4381
 
 
4382
        # die as quickly as possible if there are uncommitted changes
 
4383
        if not force:
 
4384
            if tree.has_changes():
 
4385
                raise errors.UncommittedChanges(tree)
 
4386
 
 
4387
        view_info = _get_view_info_for_change_reporter(tree)
2624
4388
        change_reporter = delta._ChangeReporter(
2625
 
            unversioned_filter=tree.is_ignored)
2626
 
 
2627
 
        if branch is not None:
 
4389
            unversioned_filter=tree.is_ignored, view_info=view_info)
 
4390
        pb = ui.ui_factory.nested_progress_bar()
 
4391
        self.add_cleanup(pb.finished)
 
4392
        self.add_cleanup(tree.lock_write().unlock)
 
4393
        if location is not None:
2628
4394
            try:
2629
 
                mergeable = bundle.read_mergeable_from_url(
2630
 
                    branch)
 
4395
                mergeable = bundle.read_mergeable_from_url(location,
 
4396
                    possible_transports=possible_transports)
2631
4397
            except errors.NotABundle:
2632
 
                pass # Continue on considering this url a Branch
 
4398
                mergeable = None
2633
4399
            else:
 
4400
                if uncommitted:
 
4401
                    raise errors.BzrCommandError(gettext('Cannot use --uncommitted'
 
4402
                        ' with bundles or merge directives.'))
 
4403
 
2634
4404
                if revision is not None:
2635
 
                    raise errors.BzrCommandError(
2636
 
                        'Cannot use -r with merge directives or bundles')
2637
 
                other_revision_id = mergeable.install_revisions(
2638
 
                    tree.branch.repository)
2639
 
                revision = [RevisionSpec.from_string(
2640
 
                    'revid:' + other_revision_id)]
2641
 
 
2642
 
        if revision is None \
2643
 
                or len(revision) < 1 or revision[0].needs_branch():
2644
 
            branch = self._get_remembered_parent(tree, branch, 'Merging from')
2645
 
 
2646
 
        if revision is None or len(revision) < 1:
2647
 
            if uncommitted:
2648
 
                base = [branch, -1]
2649
 
                other = [branch, None]
2650
 
            else:
2651
 
                base = [None, None]
2652
 
                other = [branch, -1]
2653
 
            other_branch, path = Branch.open_containing(branch)
2654
 
        else:
2655
 
            if uncommitted:
2656
 
                raise errors.BzrCommandError('Cannot use --uncommitted and'
2657
 
                                             ' --revision at the same time.')
2658
 
            branch = revision[0].get_branch() or branch
2659
 
            if len(revision) == 1:
2660
 
                base = [None, None]
2661
 
                if other_revision_id is not None:
2662
 
                    other_branch = None
2663
 
                    path = ""
2664
 
                    other = None
2665
 
                else:
2666
 
                    other_branch, path = Branch.open_containing(branch)
2667
 
                    revno = revision[0].in_history(other_branch).revno
2668
 
                    other = [branch, revno]
2669
 
            else:
2670
 
                assert len(revision) == 2
2671
 
                if None in revision:
2672
 
                    raise errors.BzrCommandError(
2673
 
                        "Merge doesn't permit empty revision specifier.")
2674
 
                base_branch, path = Branch.open_containing(branch)
2675
 
                branch1 = revision[1].get_branch() or branch
2676
 
                other_branch, path1 = Branch.open_containing(branch1)
2677
 
                if revision[0].get_branch() is not None:
2678
 
                    # then path was obtained from it, and is None.
2679
 
                    path = path1
2680
 
 
2681
 
                base = [branch, revision[0].in_history(base_branch).revno]
2682
 
                other = [branch1, revision[1].in_history(other_branch).revno]
2683
 
 
2684
 
        if ((tree.branch.get_parent() is None or remember) and
2685
 
            other_branch is not None):
2686
 
            tree.branch.set_parent(other_branch.base)
2687
 
 
2688
 
        # pull tags now... it's a bit inconsistent to do it ahead of copying
2689
 
        # the history but that's done inside the merge code
2690
 
        if other_branch is not None:
2691
 
            _merge_tags_if_possible(other_branch, tree.branch)
2692
 
 
2693
 
        if path != "":
2694
 
            interesting_files = [path]
2695
 
        else:
2696
 
            interesting_files = None
2697
 
        pb = ui.ui_factory.nested_progress_bar()
 
4405
                    raise errors.BzrCommandError(gettext(
 
4406
                        'Cannot use -r with merge directives or bundles'))
 
4407
                merger, verified = _mod_merge.Merger.from_mergeable(tree,
 
4408
                   mergeable, None)
 
4409
 
 
4410
        if merger is None and uncommitted:
 
4411
            if revision is not None and len(revision) > 0:
 
4412
                raise errors.BzrCommandError(gettext('Cannot use --uncommitted and'
 
4413
                    ' --revision at the same time.'))
 
4414
            merger = self.get_merger_from_uncommitted(tree, location, None)
 
4415
            allow_pending = False
 
4416
 
 
4417
        if merger is None:
 
4418
            merger, allow_pending = self._get_merger_from_branch(tree,
 
4419
                location, revision, remember, possible_transports, None)
 
4420
 
 
4421
        merger.merge_type = merge_type
 
4422
        merger.reprocess = reprocess
 
4423
        merger.show_base = show_base
 
4424
        self.sanity_check_merger(merger)
 
4425
        if (merger.base_rev_id == merger.other_rev_id and
 
4426
            merger.other_rev_id is not None):
 
4427
            # check if location is a nonexistent file (and not a branch) to
 
4428
            # disambiguate the 'Nothing to do'
 
4429
            if merger.interesting_files:
 
4430
                if not merger.other_tree.has_filename(
 
4431
                    merger.interesting_files[0]):
 
4432
                    note(gettext("merger: ") + str(merger))
 
4433
                    raise errors.PathsDoNotExist([location])
 
4434
            note(gettext('Nothing to do.'))
 
4435
            return 0
 
4436
        if pull and not preview:
 
4437
            if merger.interesting_files is not None:
 
4438
                raise errors.BzrCommandError(gettext('Cannot pull individual files'))
 
4439
            if (merger.base_rev_id == tree.last_revision()):
 
4440
                result = tree.pull(merger.other_branch, False,
 
4441
                                   merger.other_rev_id)
 
4442
                result.report(self.outf)
 
4443
                return 0
 
4444
        if merger.this_basis is None:
 
4445
            raise errors.BzrCommandError(gettext(
 
4446
                "This branch has no commits."
 
4447
                " (perhaps you would prefer 'bzr pull')"))
 
4448
        if preview:
 
4449
            return self._do_preview(merger)
 
4450
        elif interactive:
 
4451
            return self._do_interactive(merger)
 
4452
        else:
 
4453
            return self._do_merge(merger, change_reporter, allow_pending,
 
4454
                                  verified)
 
4455
 
 
4456
    def _get_preview(self, merger):
 
4457
        tree_merger = merger.make_merger()
 
4458
        tt = tree_merger.make_preview_transform()
 
4459
        self.add_cleanup(tt.finalize)
 
4460
        result_tree = tt.get_preview_tree()
 
4461
        return result_tree
 
4462
 
 
4463
    def _do_preview(self, merger):
 
4464
        from bzrlib.diff import show_diff_trees
 
4465
        result_tree = self._get_preview(merger)
 
4466
        path_encoding = osutils.get_diff_header_encoding()
 
4467
        show_diff_trees(merger.this_tree, result_tree, self.outf,
 
4468
                        old_label='', new_label='',
 
4469
                        path_encoding=path_encoding)
 
4470
 
 
4471
    def _do_merge(self, merger, change_reporter, allow_pending, verified):
 
4472
        merger.change_reporter = change_reporter
 
4473
        conflict_count = merger.do_merge()
 
4474
        if allow_pending:
 
4475
            merger.set_pending()
 
4476
        if verified == 'failed':
 
4477
            warning('Preview patch does not match changes')
 
4478
        if conflict_count != 0:
 
4479
            return 1
 
4480
        else:
 
4481
            return 0
 
4482
 
 
4483
    def _do_interactive(self, merger):
 
4484
        """Perform an interactive merge.
 
4485
 
 
4486
        This works by generating a preview tree of the merge, then using
 
4487
        Shelver to selectively remove the differences between the working tree
 
4488
        and the preview tree.
 
4489
        """
 
4490
        from bzrlib import shelf_ui
 
4491
        result_tree = self._get_preview(merger)
 
4492
        writer = bzrlib.option.diff_writer_registry.get()
 
4493
        shelver = shelf_ui.Shelver(merger.this_tree, result_tree, destroy=True,
 
4494
                                   reporter=shelf_ui.ApplyReporter(),
 
4495
                                   diff_writer=writer(sys.stdout))
2698
4496
        try:
2699
 
            try:
2700
 
                conflict_count = _merge_helper(
2701
 
                    other, base, other_rev_id=other_revision_id,
2702
 
                    check_clean=(not force),
2703
 
                    merge_type=merge_type,
2704
 
                    reprocess=reprocess,
2705
 
                    show_base=show_base,
2706
 
                    pull=pull,
2707
 
                    this_dir=directory,
2708
 
                    pb=pb, file_list=interesting_files,
2709
 
                    change_reporter=change_reporter)
2710
 
            finally:
2711
 
                pb.finished()
2712
 
            if conflict_count != 0:
2713
 
                return 1
 
4497
            shelver.run()
 
4498
        finally:
 
4499
            shelver.finalize()
 
4500
 
 
4501
    def sanity_check_merger(self, merger):
 
4502
        if (merger.show_base and
 
4503
            not merger.merge_type is _mod_merge.Merge3Merger):
 
4504
            raise errors.BzrCommandError(gettext("Show-base is not supported for this"
 
4505
                                         " merge type. %s") % merger.merge_type)
 
4506
        if merger.reprocess is None:
 
4507
            if merger.show_base:
 
4508
                merger.reprocess = False
2714
4509
            else:
2715
 
                return 0
2716
 
        except errors.AmbiguousBase, e:
2717
 
            m = ("sorry, bzr can't determine the right merge base yet\n"
2718
 
                 "candidates are:\n  "
2719
 
                 + "\n  ".join(e.bases)
2720
 
                 + "\n"
2721
 
                 "please specify an explicit base with -r,\n"
2722
 
                 "and (if you want) report this to the bzr developers\n")
2723
 
            log_error(m)
2724
 
 
2725
 
    # TODO: move up to common parent; this isn't merge-specific anymore. 
2726
 
    def _get_remembered_parent(self, tree, supplied_location, verb_string):
 
4510
                # Use reprocess if the merger supports it
 
4511
                merger.reprocess = merger.merge_type.supports_reprocess
 
4512
        if merger.reprocess and not merger.merge_type.supports_reprocess:
 
4513
            raise errors.BzrCommandError(gettext("Conflict reduction is not supported"
 
4514
                                         " for merge type %s.") %
 
4515
                                         merger.merge_type)
 
4516
        if merger.reprocess and merger.show_base:
 
4517
            raise errors.BzrCommandError(gettext("Cannot do conflict reduction and"
 
4518
                                         " show base."))
 
4519
 
 
4520
    def _get_merger_from_branch(self, tree, location, revision, remember,
 
4521
                                possible_transports, pb):
 
4522
        """Produce a merger from a location, assuming it refers to a branch."""
 
4523
        from bzrlib.tag import _merge_tags_if_possible
 
4524
        # find the branch locations
 
4525
        other_loc, user_location = self._select_branch_location(tree, location,
 
4526
            revision, -1)
 
4527
        if revision is not None and len(revision) == 2:
 
4528
            base_loc, _unused = self._select_branch_location(tree,
 
4529
                location, revision, 0)
 
4530
        else:
 
4531
            base_loc = other_loc
 
4532
        # Open the branches
 
4533
        other_branch, other_path = Branch.open_containing(other_loc,
 
4534
            possible_transports)
 
4535
        if base_loc == other_loc:
 
4536
            base_branch = other_branch
 
4537
        else:
 
4538
            base_branch, base_path = Branch.open_containing(base_loc,
 
4539
                possible_transports)
 
4540
        # Find the revision ids
 
4541
        other_revision_id = None
 
4542
        base_revision_id = None
 
4543
        if revision is not None:
 
4544
            if len(revision) >= 1:
 
4545
                other_revision_id = revision[-1].as_revision_id(other_branch)
 
4546
            if len(revision) == 2:
 
4547
                base_revision_id = revision[0].as_revision_id(base_branch)
 
4548
        if other_revision_id is None:
 
4549
            other_revision_id = _mod_revision.ensure_null(
 
4550
                other_branch.last_revision())
 
4551
        # Remember where we merge from. We need to remember if:
 
4552
        # - user specify a location (and we don't merge from the parent
 
4553
        #   branch)
 
4554
        # - user ask to remember or there is no previous location set to merge
 
4555
        #   from and user didn't ask to *not* remember
 
4556
        if (user_location is not None
 
4557
            and ((remember
 
4558
                  or (remember is None
 
4559
                      and tree.branch.get_submit_branch() is None)))):
 
4560
            tree.branch.set_submit_branch(other_branch.base)
 
4561
        # Merge tags (but don't set them in the master branch yet, the user
 
4562
        # might revert this merge).  Commit will propagate them.
 
4563
        _merge_tags_if_possible(other_branch, tree.branch, ignore_master=True)
 
4564
        merger = _mod_merge.Merger.from_revision_ids(pb, tree,
 
4565
            other_revision_id, base_revision_id, other_branch, base_branch)
 
4566
        if other_path != '':
 
4567
            allow_pending = False
 
4568
            merger.interesting_files = [other_path]
 
4569
        else:
 
4570
            allow_pending = True
 
4571
        return merger, allow_pending
 
4572
 
 
4573
    def get_merger_from_uncommitted(self, tree, location, pb):
 
4574
        """Get a merger for uncommitted changes.
 
4575
 
 
4576
        :param tree: The tree the merger should apply to.
 
4577
        :param location: The location containing uncommitted changes.
 
4578
        :param pb: The progress bar to use for showing progress.
 
4579
        """
 
4580
        location = self._select_branch_location(tree, location)[0]
 
4581
        other_tree, other_path = WorkingTree.open_containing(location)
 
4582
        merger = _mod_merge.Merger.from_uncommitted(tree, other_tree, pb)
 
4583
        if other_path != '':
 
4584
            merger.interesting_files = [other_path]
 
4585
        return merger
 
4586
 
 
4587
    def _select_branch_location(self, tree, user_location, revision=None,
 
4588
                                index=None):
 
4589
        """Select a branch location, according to possible inputs.
 
4590
 
 
4591
        If provided, branches from ``revision`` are preferred.  (Both
 
4592
        ``revision`` and ``index`` must be supplied.)
 
4593
 
 
4594
        Otherwise, the ``location`` parameter is used.  If it is None, then the
 
4595
        ``submit`` or ``parent`` location is used, and a note is printed.
 
4596
 
 
4597
        :param tree: The working tree to select a branch for merging into
 
4598
        :param location: The location entered by the user
 
4599
        :param revision: The revision parameter to the command
 
4600
        :param index: The index to use for the revision parameter.  Negative
 
4601
            indices are permitted.
 
4602
        :return: (selected_location, user_location).  The default location
 
4603
            will be the user-entered location.
 
4604
        """
 
4605
        if (revision is not None and index is not None
 
4606
            and revision[index] is not None):
 
4607
            branch = revision[index].get_branch()
 
4608
            if branch is not None:
 
4609
                return branch, branch
 
4610
        if user_location is None:
 
4611
            location = self._get_remembered(tree, 'Merging from')
 
4612
        else:
 
4613
            location = user_location
 
4614
        return location, user_location
 
4615
 
 
4616
    def _get_remembered(self, tree, verb_string):
2727
4617
        """Use tree.branch's parent if none was supplied.
2728
4618
 
2729
4619
        Report if the remembered location was used.
2730
4620
        """
2731
 
        if supplied_location is not None:
2732
 
            return supplied_location
2733
 
        stored_location = tree.branch.get_parent()
 
4621
        stored_location = tree.branch.get_submit_branch()
 
4622
        stored_location_type = "submit"
 
4623
        if stored_location is None:
 
4624
            stored_location = tree.branch.get_parent()
 
4625
            stored_location_type = "parent"
2734
4626
        mutter("%s", stored_location)
2735
4627
        if stored_location is None:
2736
 
            raise errors.BzrCommandError("No location specified or remembered")
2737
 
        display_url = urlutils.unescape_for_display(stored_location, self.outf.encoding)
2738
 
        self.outf.write("%s remembered location %s\n" % (verb_string, display_url))
 
4628
            raise errors.BzrCommandError(gettext("No location specified or remembered"))
 
4629
        display_url = urlutils.unescape_for_display(stored_location, 'utf-8')
 
4630
        note(gettext("{0} remembered {1} location {2}").format(verb_string,
 
4631
                stored_location_type, display_url))
2739
4632
        return stored_location
2740
4633
 
2741
4634
 
2742
4635
class cmd_remerge(Command):
2743
 
    """Redo a merge.
 
4636
    __doc__ = """Redo a merge.
2744
4637
 
2745
4638
    Use this if you want to try a different merge technique while resolving
2746
 
    conflicts.  Some merge techniques are better than others, and remerge 
 
4639
    conflicts.  Some merge techniques are better than others, and remerge
2747
4640
    lets you try different ones on different files.
2748
4641
 
2749
4642
    The options for remerge have the same meaning and defaults as the ones for
2750
4643
    merge.  The difference is that remerge can (only) be run when there is a
2751
4644
    pending merge, and it lets you specify particular files.
2752
4645
 
2753
 
    Examples:
2754
 
 
2755
 
    $ bzr remerge --show-base
 
4646
    :Examples:
2756
4647
        Re-do the merge of all conflicted files, and show the base text in
2757
 
        conflict regions, in addition to the usual THIS and OTHER texts.
2758
 
 
2759
 
    $ bzr remerge --merge-type weave --reprocess foobar
 
4648
        conflict regions, in addition to the usual THIS and OTHER texts::
 
4649
 
 
4650
            bzr remerge --show-base
 
4651
 
2760
4652
        Re-do the merge of "foobar", using the weave merge algorithm, with
2761
 
        additional processing to reduce the size of conflict regions.
 
4653
        additional processing to reduce the size of conflict regions::
 
4654
 
 
4655
            bzr remerge --merge-type weave --reprocess foobar
2762
4656
    """
2763
4657
    takes_args = ['file*']
2764
 
    takes_options = ['merge-type', 'reprocess',
2765
 
                     Option('show-base', help="Show base revision text in "
2766
 
                            "conflicts")]
 
4658
    takes_options = [
 
4659
            'merge-type',
 
4660
            'reprocess',
 
4661
            Option('show-base',
 
4662
                   help="Show base revision text in conflicts."),
 
4663
            ]
2767
4664
 
2768
4665
    def run(self, file_list=None, merge_type=None, show_base=False,
2769
4666
            reprocess=False):
 
4667
        from bzrlib.conflicts import restore
2770
4668
        if merge_type is None:
2771
4669
            merge_type = _mod_merge.Merge3Merger
2772
 
        tree, file_list = tree_files(file_list)
2773
 
        tree.lock_write()
 
4670
        tree, file_list = WorkingTree.open_containing_paths(file_list)
 
4671
        self.add_cleanup(tree.lock_write().unlock)
 
4672
        parents = tree.get_parent_ids()
 
4673
        if len(parents) != 2:
 
4674
            raise errors.BzrCommandError(gettext("Sorry, remerge only works after normal"
 
4675
                                         " merges.  Not cherrypicking or"
 
4676
                                         " multi-merges."))
 
4677
        repository = tree.branch.repository
 
4678
        interesting_ids = None
 
4679
        new_conflicts = []
 
4680
        conflicts = tree.conflicts()
 
4681
        if file_list is not None:
 
4682
            interesting_ids = set()
 
4683
            for filename in file_list:
 
4684
                file_id = tree.path2id(filename)
 
4685
                if file_id is None:
 
4686
                    raise errors.NotVersionedError(filename)
 
4687
                interesting_ids.add(file_id)
 
4688
                if tree.kind(file_id) != "directory":
 
4689
                    continue
 
4690
 
 
4691
                # FIXME: Support nested trees
 
4692
                for name, ie in tree.root_inventory.iter_entries(file_id):
 
4693
                    interesting_ids.add(ie.file_id)
 
4694
            new_conflicts = conflicts.select_conflicts(tree, file_list)[0]
 
4695
        else:
 
4696
            # Remerge only supports resolving contents conflicts
 
4697
            allowed_conflicts = ('text conflict', 'contents conflict')
 
4698
            restore_files = [c.path for c in conflicts
 
4699
                             if c.typestring in allowed_conflicts]
 
4700
        _mod_merge.transform_tree(tree, tree.basis_tree(), interesting_ids)
 
4701
        tree.set_conflicts(ConflictList(new_conflicts))
 
4702
        if file_list is not None:
 
4703
            restore_files = file_list
 
4704
        for filename in restore_files:
 
4705
            try:
 
4706
                restore(tree.abspath(filename))
 
4707
            except errors.NotConflicted:
 
4708
                pass
 
4709
        # Disable pending merges, because the file texts we are remerging
 
4710
        # have not had those merges performed.  If we use the wrong parents
 
4711
        # list, we imply that the working tree text has seen and rejected
 
4712
        # all the changes from the other tree, when in fact those changes
 
4713
        # have not yet been seen.
 
4714
        tree.set_parent_ids(parents[:1])
2774
4715
        try:
2775
 
            parents = tree.get_parent_ids()
2776
 
            if len(parents) != 2:
2777
 
                raise errors.BzrCommandError("Sorry, remerge only works after normal"
2778
 
                                             " merges.  Not cherrypicking or"
2779
 
                                             " multi-merges.")
2780
 
            repository = tree.branch.repository
2781
 
            graph = repository.get_graph()
2782
 
            base_revision = graph.find_unique_lca(parents[0], parents[1])
2783
 
            base_tree = repository.revision_tree(base_revision)
2784
 
            other_tree = repository.revision_tree(parents[1])
2785
 
            interesting_ids = None
2786
 
            new_conflicts = []
2787
 
            conflicts = tree.conflicts()
2788
 
            if file_list is not None:
2789
 
                interesting_ids = set()
2790
 
                for filename in file_list:
2791
 
                    file_id = tree.path2id(filename)
2792
 
                    if file_id is None:
2793
 
                        raise errors.NotVersionedError(filename)
2794
 
                    interesting_ids.add(file_id)
2795
 
                    if tree.kind(file_id) != "directory":
2796
 
                        continue
2797
 
                    
2798
 
                    for name, ie in tree.inventory.iter_entries(file_id):
2799
 
                        interesting_ids.add(ie.file_id)
2800
 
                new_conflicts = conflicts.select_conflicts(tree, file_list)[0]
2801
 
            else:
2802
 
                # Remerge only supports resolving contents conflicts
2803
 
                allowed_conflicts = ('text conflict', 'contents conflict')
2804
 
                restore_files = [c.path for c in conflicts
2805
 
                                 if c.typestring in allowed_conflicts]
2806
 
            _mod_merge.transform_tree(tree, tree.basis_tree(), interesting_ids)
2807
 
            tree.set_conflicts(ConflictList(new_conflicts))
2808
 
            if file_list is not None:
2809
 
                restore_files = file_list
2810
 
            for filename in restore_files:
2811
 
                try:
2812
 
                    restore(tree.abspath(filename))
2813
 
                except errors.NotConflicted:
2814
 
                    pass
2815
 
            conflicts = _mod_merge.merge_inner(
2816
 
                                      tree.branch, other_tree, base_tree,
2817
 
                                      this_tree=tree,
2818
 
                                      interesting_ids=interesting_ids,
2819
 
                                      other_rev_id=parents[1],
2820
 
                                      merge_type=merge_type,
2821
 
                                      show_base=show_base,
2822
 
                                      reprocess=reprocess)
 
4716
            merger = _mod_merge.Merger.from_revision_ids(None, tree, parents[1])
 
4717
            merger.interesting_ids = interesting_ids
 
4718
            merger.merge_type = merge_type
 
4719
            merger.show_base = show_base
 
4720
            merger.reprocess = reprocess
 
4721
            conflicts = merger.do_merge()
2823
4722
        finally:
2824
 
            tree.unlock()
 
4723
            tree.set_parent_ids(parents)
2825
4724
        if conflicts > 0:
2826
4725
            return 1
2827
4726
        else:
2829
4728
 
2830
4729
 
2831
4730
class cmd_revert(Command):
2832
 
    """Revert files to a previous revision.
 
4731
    __doc__ = """\
 
4732
    Set files in the working tree back to the contents of a previous revision.
2833
4733
 
2834
4734
    Giving a list of files will revert only those files.  Otherwise, all files
2835
4735
    will be reverted.  If the revision is not specified with '--revision', the
2836
 
    last committed revision is used.
 
4736
    working tree basis revision is used. A revert operation affects only the
 
4737
    working tree, not any revision history like the branch and repository or
 
4738
    the working tree basis revision.
2837
4739
 
2838
4740
    To remove only some changes, without reverting to a prior version, use
2839
 
    merge instead.  For example, "merge . --r-2..-3" will remove the changes
2840
 
    introduced by -2, without affecting the changes introduced by -1.  Or
2841
 
    to remove certain changes on a hunk-by-hunk basis, see the Shelf plugin.
2842
 
    
2843
 
    By default, any files that have been manually changed will be backed up
2844
 
    first.  (Files changed only by merge are not backed up.)  Backup files have
2845
 
    '.~#~' appended to their name, where # is a number.
 
4741
    merge instead.  For example, "merge . -r -2..-3" (don't forget the ".")
 
4742
    will remove the changes introduced by the second last commit (-2), without
 
4743
    affecting the changes introduced by the last commit (-1).  To remove
 
4744
    certain changes on a hunk-by-hunk basis, see the shelve command.
 
4745
    To update the branch to a specific revision or the latest revision and
 
4746
    update the working tree accordingly while preserving local changes, see the
 
4747
    update command.
 
4748
 
 
4749
    Uncommitted changes to files that are reverted will be discarded.
 
4750
    Howver, by default, any files that have been manually changed will be
 
4751
    backed up first.  (Files changed only by merge are not backed up.)  Backup
 
4752
    files have '.~#~' appended to their name, where # is a number.
2846
4753
 
2847
4754
    When you provide files, you can use their current pathname or the pathname
2848
4755
    from the target revision.  So you can use revert to "undelete" a file by
2849
4756
    name.  If you name a directory, all the contents of that directory will be
2850
4757
    reverted.
 
4758
 
 
4759
    If you have newly added files since the target revision, they will be
 
4760
    removed.  If the files to be removed have been changed, backups will be
 
4761
    created as above.  Directories containing unknown files will not be
 
4762
    deleted.
 
4763
 
 
4764
    The working tree contains a list of revisions that have been merged but
 
4765
    not yet committed. These revisions will be included as additional parents
 
4766
    of the next commit.  Normally, using revert clears that list as well as
 
4767
    reverting the files.  If any files are specified, revert leaves the list
 
4768
    of uncommitted merges alone and reverts only the files.  Use ``bzr revert
 
4769
    .`` in the tree root to revert all files but keep the recorded merges,
 
4770
    and ``bzr revert --forget-merges`` to clear the pending merge list without
 
4771
    reverting any files.
 
4772
 
 
4773
    Using "bzr revert --forget-merges", it is possible to apply all of the
 
4774
    changes from a branch in a single revision.  To do this, perform the merge
 
4775
    as desired.  Then doing revert with the "--forget-merges" option will keep
 
4776
    the content of the tree as it was, but it will clear the list of pending
 
4777
    merges.  The next commit will then contain all of the changes that are
 
4778
    present in the other branch, but without any other parent revisions.
 
4779
    Because this technique forgets where these changes originated, it may
 
4780
    cause additional conflicts on later merges involving the same source and
 
4781
    target branches.
2851
4782
    """
2852
4783
 
2853
 
    _see_also = ['cat', 'export']
2854
 
    takes_options = ['revision', 'no-backup']
 
4784
    _see_also = ['cat', 'export', 'merge', 'shelve']
 
4785
    takes_options = [
 
4786
        'revision',
 
4787
        Option('no-backup', "Do not save backups of reverted files."),
 
4788
        Option('forget-merges',
 
4789
               'Remove pending merge marker, without changing any files.'),
 
4790
        ]
2855
4791
    takes_args = ['file*']
2856
4792
 
2857
 
    def run(self, revision=None, no_backup=False, file_list=None):
2858
 
        if file_list is not None:
2859
 
            if len(file_list) == 0:
2860
 
                raise errors.BzrCommandError("No files specified")
2861
 
        else:
2862
 
            file_list = []
2863
 
        
2864
 
        tree, file_list = tree_files(file_list)
2865
 
        if revision is None:
2866
 
            # FIXME should be tree.last_revision
2867
 
            rev_id = tree.last_revision()
2868
 
        elif len(revision) != 1:
2869
 
            raise errors.BzrCommandError('bzr revert --revision takes exactly 1 argument')
2870
 
        else:
2871
 
            rev_id = revision[0].in_history(tree.branch).rev_id
2872
 
        pb = ui.ui_factory.nested_progress_bar()
2873
 
        try:
2874
 
            tree.revert(file_list, 
2875
 
                        tree.branch.repository.revision_tree(rev_id),
2876
 
                        not no_backup, pb, report_changes=True)
2877
 
        finally:
2878
 
            pb.finished()
 
4793
    def run(self, revision=None, no_backup=False, file_list=None,
 
4794
            forget_merges=None):
 
4795
        tree, file_list = WorkingTree.open_containing_paths(file_list)
 
4796
        self.add_cleanup(tree.lock_tree_write().unlock)
 
4797
        if forget_merges:
 
4798
            tree.set_parent_ids(tree.get_parent_ids()[:1])
 
4799
        else:
 
4800
            self._revert_tree_to_revision(tree, revision, file_list, no_backup)
 
4801
 
 
4802
    @staticmethod
 
4803
    def _revert_tree_to_revision(tree, revision, file_list, no_backup):
 
4804
        rev_tree = _get_one_revision_tree('revert', revision, tree=tree)
 
4805
        tree.revert(file_list, rev_tree, not no_backup, None,
 
4806
            report_changes=True)
2879
4807
 
2880
4808
 
2881
4809
class cmd_assert_fail(Command):
2882
 
    """Test reporting of assertion failures"""
 
4810
    __doc__ = """Test reporting of assertion failures"""
2883
4811
    # intended just for use in testing
2884
4812
 
2885
4813
    hidden = True
2889
4817
 
2890
4818
 
2891
4819
class cmd_help(Command):
2892
 
    """Show help on a command or other topic.
 
4820
    __doc__ = """Show help on a command or other topic.
2893
4821
    """
2894
4822
 
2895
4823
    _see_also = ['topics']
2896
 
    takes_options = [Option('long', 'show help on all commands')]
 
4824
    takes_options = [
 
4825
            Option('long', 'Show help on all commands.'),
 
4826
            ]
2897
4827
    takes_args = ['topic?']
2898
4828
    aliases = ['?', '--help', '-?', '-h']
2899
 
    
 
4829
 
2900
4830
    @display_command
2901
4831
    def run(self, topic=None, long=False):
2902
4832
        import bzrlib.help
2906
4836
 
2907
4837
 
2908
4838
class cmd_shell_complete(Command):
2909
 
    """Show appropriate completions for context.
 
4839
    __doc__ = """Show appropriate completions for context.
2910
4840
 
2911
4841
    For a list of all available commands, say 'bzr shell-complete'.
2912
4842
    """
2913
4843
    takes_args = ['context?']
2914
4844
    aliases = ['s-c']
2915
4845
    hidden = True
2916
 
    
 
4846
 
2917
4847
    @display_command
2918
4848
    def run(self, context=None):
2919
 
        import shellcomplete
 
4849
        from bzrlib import shellcomplete
2920
4850
        shellcomplete.shellcomplete(context)
2921
4851
 
2922
4852
 
2923
 
class cmd_fetch(Command):
2924
 
    """Copy in history from another branch but don't merge it.
2925
 
 
2926
 
    This is an internal method used for pull and merge.
2927
 
    """
2928
 
    hidden = True
2929
 
    takes_args = ['from_branch', 'to_branch']
2930
 
    def run(self, from_branch, to_branch):
2931
 
        from bzrlib.fetch import Fetcher
2932
 
        from_b = Branch.open(from_branch)
2933
 
        to_b = Branch.open(to_branch)
2934
 
        Fetcher(to_b, from_b)
2935
 
 
2936
 
 
2937
4853
class cmd_missing(Command):
2938
 
    """Show unmerged/unpulled revisions between two branches.
2939
 
    
 
4854
    __doc__ = """Show unmerged/unpulled revisions between two branches.
 
4855
 
2940
4856
    OTHER_BRANCH may be local or remote.
 
4857
 
 
4858
    To filter on a range of revisions, you can use the command -r begin..end
 
4859
    -r revision requests a specific revision, -r ..end or -r begin.. are
 
4860
    also valid.
 
4861
            
 
4862
    :Exit values:
 
4863
        1 - some missing revisions
 
4864
        0 - no missing revisions
 
4865
 
 
4866
    :Examples:
 
4867
 
 
4868
        Determine the missing revisions between this and the branch at the
 
4869
        remembered pull location::
 
4870
 
 
4871
            bzr missing
 
4872
 
 
4873
        Determine the missing revisions between this and another branch::
 
4874
 
 
4875
            bzr missing http://server/branch
 
4876
 
 
4877
        Determine the missing revisions up to a specific revision on the other
 
4878
        branch::
 
4879
 
 
4880
            bzr missing -r ..-10
 
4881
 
 
4882
        Determine the missing revisions up to a specific revision on this
 
4883
        branch::
 
4884
 
 
4885
            bzr missing --my-revision ..-10
2941
4886
    """
2942
4887
 
2943
4888
    _see_also = ['merge', 'pull']
2944
4889
    takes_args = ['other_branch?']
2945
 
    takes_options = [Option('reverse', 'Reverse the order of revisions'),
2946
 
                     Option('mine-only', 
2947
 
                            'Display changes in the local branch only'),
2948
 
                     Option('this' , 'same as --mine-only'),
2949
 
                     Option('theirs-only', 
2950
 
                            'Display changes in the remote branch only'),
2951
 
                     Option('other', 'same as --theirs-only'),
2952
 
                     'log-format',
2953
 
                     'show-ids',
2954
 
                     'verbose'
2955
 
                     ]
 
4890
    takes_options = [
 
4891
        'directory',
 
4892
        Option('reverse', 'Reverse the order of revisions.'),
 
4893
        Option('mine-only',
 
4894
               'Display changes in the local branch only.'),
 
4895
        Option('this' , 'Same as --mine-only.'),
 
4896
        Option('theirs-only',
 
4897
               'Display changes in the remote branch only.'),
 
4898
        Option('other', 'Same as --theirs-only.'),
 
4899
        'log-format',
 
4900
        'show-ids',
 
4901
        'verbose',
 
4902
        custom_help('revision',
 
4903
             help='Filter on other branch revisions (inclusive). '
 
4904
                'See "help revisionspec" for details.'),
 
4905
        Option('my-revision',
 
4906
            type=_parse_revision_str,
 
4907
            help='Filter on local branch revisions (inclusive). '
 
4908
                'See "help revisionspec" for details.'),
 
4909
        Option('include-merged',
 
4910
               'Show all revisions in addition to the mainline ones.'),
 
4911
        Option('include-merges', hidden=True,
 
4912
               help='Historical alias for --include-merged.'),
 
4913
        ]
2956
4914
    encoding_type = 'replace'
2957
4915
 
2958
4916
    @display_command
2959
4917
    def run(self, other_branch=None, reverse=False, mine_only=False,
2960
 
            theirs_only=False, log_format=None, long=False, short=False, line=False, 
2961
 
            show_ids=False, verbose=False, this=False, other=False):
 
4918
            theirs_only=False,
 
4919
            log_format=None, long=False, short=False, line=False,
 
4920
            show_ids=False, verbose=False, this=False, other=False,
 
4921
            include_merged=None, revision=None, my_revision=None,
 
4922
            directory=u'.',
 
4923
            include_merges=symbol_versioning.DEPRECATED_PARAMETER):
2962
4924
        from bzrlib.missing import find_unmerged, iter_log_revisions
2963
 
        from bzrlib.log import log_formatter
 
4925
        def message(s):
 
4926
            if not is_quiet():
 
4927
                self.outf.write(s)
2964
4928
 
 
4929
        if symbol_versioning.deprecated_passed(include_merges):
 
4930
            ui.ui_factory.show_user_warning(
 
4931
                'deprecated_command_option',
 
4932
                deprecated_name='--include-merges',
 
4933
                recommended_name='--include-merged',
 
4934
                deprecated_in_version='2.5',
 
4935
                command=self.invoked_as)
 
4936
            if include_merged is None:
 
4937
                include_merged = include_merges
 
4938
            else:
 
4939
                raise errors.BzrCommandError(gettext(
 
4940
                    '{0} and {1} are mutually exclusive').format(
 
4941
                    '--include-merges', '--include-merged'))
 
4942
        if include_merged is None:
 
4943
            include_merged = False
2965
4944
        if this:
2966
 
          mine_only = this
 
4945
            mine_only = this
2967
4946
        if other:
2968
 
          theirs_only = other
2969
 
 
2970
 
        local_branch = Branch.open_containing(u".")[0]
 
4947
            theirs_only = other
 
4948
        # TODO: We should probably check that we don't have mine-only and
 
4949
        #       theirs-only set, but it gets complicated because we also have
 
4950
        #       this and other which could be used.
 
4951
        restrict = 'all'
 
4952
        if mine_only:
 
4953
            restrict = 'local'
 
4954
        elif theirs_only:
 
4955
            restrict = 'remote'
 
4956
 
 
4957
        local_branch = Branch.open_containing(directory)[0]
 
4958
        self.add_cleanup(local_branch.lock_read().unlock)
 
4959
 
2971
4960
        parent = local_branch.get_parent()
2972
4961
        if other_branch is None:
2973
4962
            other_branch = parent
2974
4963
            if other_branch is None:
2975
 
                raise errors.BzrCommandError("No peer location known or specified.")
 
4964
                raise errors.BzrCommandError(gettext("No peer location known"
 
4965
                                             " or specified."))
2976
4966
            display_url = urlutils.unescape_for_display(parent,
2977
4967
                                                        self.outf.encoding)
2978
 
            print "Using last location: " + display_url
 
4968
            message(gettext("Using saved parent location: {0}\n").format(
 
4969
                    display_url))
2979
4970
 
2980
4971
        remote_branch = Branch.open(other_branch)
2981
4972
        if remote_branch.base == local_branch.base:
2982
4973
            remote_branch = local_branch
2983
 
        local_branch.lock_read()
2984
 
        try:
2985
 
            remote_branch.lock_read()
2986
 
            try:
2987
 
                local_extra, remote_extra = find_unmerged(local_branch, remote_branch)
2988
 
                if (log_format is None):
2989
 
                    log_format = log.log_formatter_registry.get_default(
2990
 
                        local_branch)
2991
 
                lf = log_format(to_file=self.outf,
2992
 
                                show_ids=show_ids,
2993
 
                                show_timezone='original')
2994
 
                if reverse is False:
2995
 
                    local_extra.reverse()
2996
 
                    remote_extra.reverse()
2997
 
                if local_extra and not theirs_only:
2998
 
                    print "You have %d extra revision(s):" % len(local_extra)
2999
 
                    for revision in iter_log_revisions(local_extra, 
3000
 
                                        local_branch.repository,
3001
 
                                        verbose):
3002
 
                        lf.log_revision(revision)
3003
 
                    printed_local = True
3004
 
                else:
3005
 
                    printed_local = False
3006
 
                if remote_extra and not mine_only:
3007
 
                    if printed_local is True:
3008
 
                        print "\n\n"
3009
 
                    print "You are missing %d revision(s):" % len(remote_extra)
3010
 
                    for revision in iter_log_revisions(remote_extra, 
3011
 
                                        remote_branch.repository, 
3012
 
                                        verbose):
3013
 
                        lf.log_revision(revision)
3014
 
                if not remote_extra and not local_extra:
3015
 
                    status_code = 0
3016
 
                    print "Branches are up to date."
3017
 
                else:
3018
 
                    status_code = 1
3019
 
            finally:
3020
 
                remote_branch.unlock()
3021
 
        finally:
3022
 
            local_branch.unlock()
 
4974
        else:
 
4975
            self.add_cleanup(remote_branch.lock_read().unlock)
 
4976
 
 
4977
        local_revid_range = _revision_range_to_revid_range(
 
4978
            _get_revision_range(my_revision, local_branch,
 
4979
                self.name()))
 
4980
 
 
4981
        remote_revid_range = _revision_range_to_revid_range(
 
4982
            _get_revision_range(revision,
 
4983
                remote_branch, self.name()))
 
4984
 
 
4985
        local_extra, remote_extra = find_unmerged(
 
4986
            local_branch, remote_branch, restrict,
 
4987
            backward=not reverse,
 
4988
            include_merged=include_merged,
 
4989
            local_revid_range=local_revid_range,
 
4990
            remote_revid_range=remote_revid_range)
 
4991
 
 
4992
        if log_format is None:
 
4993
            registry = log.log_formatter_registry
 
4994
            log_format = registry.get_default(local_branch)
 
4995
        lf = log_format(to_file=self.outf,
 
4996
                        show_ids=show_ids,
 
4997
                        show_timezone='original')
 
4998
 
 
4999
        status_code = 0
 
5000
        if local_extra and not theirs_only:
 
5001
            message(ngettext("You have %d extra revision:\n",
 
5002
                             "You have %d extra revisions:\n", 
 
5003
                             len(local_extra)) %
 
5004
                len(local_extra))
 
5005
            for revision in iter_log_revisions(local_extra,
 
5006
                                local_branch.repository,
 
5007
                                verbose):
 
5008
                lf.log_revision(revision)
 
5009
            printed_local = True
 
5010
            status_code = 1
 
5011
        else:
 
5012
            printed_local = False
 
5013
 
 
5014
        if remote_extra and not mine_only:
 
5015
            if printed_local is True:
 
5016
                message("\n\n\n")
 
5017
            message(ngettext("You are missing %d revision:\n",
 
5018
                             "You are missing %d revisions:\n",
 
5019
                             len(remote_extra)) %
 
5020
                len(remote_extra))
 
5021
            for revision in iter_log_revisions(remote_extra,
 
5022
                                remote_branch.repository,
 
5023
                                verbose):
 
5024
                lf.log_revision(revision)
 
5025
            status_code = 1
 
5026
 
 
5027
        if mine_only and not local_extra:
 
5028
            # We checked local, and found nothing extra
 
5029
            message(gettext('This branch has no new revisions.\n'))
 
5030
        elif theirs_only and not remote_extra:
 
5031
            # We checked remote, and found nothing extra
 
5032
            message(gettext('Other branch has no new revisions.\n'))
 
5033
        elif not (mine_only or theirs_only or local_extra or
 
5034
                  remote_extra):
 
5035
            # We checked both branches, and neither one had extra
 
5036
            # revisions
 
5037
            message(gettext("Branches are up to date.\n"))
 
5038
        self.cleanup_now()
3023
5039
        if not status_code and parent is None and other_branch is not None:
3024
 
            local_branch.lock_write()
3025
 
            try:
3026
 
                # handle race conditions - a parent might be set while we run.
3027
 
                if local_branch.get_parent() is None:
3028
 
                    local_branch.set_parent(remote_branch.base)
3029
 
            finally:
3030
 
                local_branch.unlock()
 
5040
            self.add_cleanup(local_branch.lock_write().unlock)
 
5041
            # handle race conditions - a parent might be set while we run.
 
5042
            if local_branch.get_parent() is None:
 
5043
                local_branch.set_parent(remote_branch.base)
3031
5044
        return status_code
3032
5045
 
3033
5046
 
 
5047
class cmd_pack(Command):
 
5048
    __doc__ = """Compress the data within a repository.
 
5049
 
 
5050
    This operation compresses the data within a bazaar repository. As
 
5051
    bazaar supports automatic packing of repository, this operation is
 
5052
    normally not required to be done manually.
 
5053
 
 
5054
    During the pack operation, bazaar takes a backup of existing repository
 
5055
    data, i.e. pack files. This backup is eventually removed by bazaar
 
5056
    automatically when it is safe to do so. To save disk space by removing
 
5057
    the backed up pack files, the --clean-obsolete-packs option may be
 
5058
    used.
 
5059
 
 
5060
    Warning: If you use --clean-obsolete-packs and your machine crashes
 
5061
    during or immediately after repacking, you may be left with a state
 
5062
    where the deletion has been written to disk but the new packs have not
 
5063
    been. In this case the repository may be unusable.
 
5064
    """
 
5065
 
 
5066
    _see_also = ['repositories']
 
5067
    takes_args = ['branch_or_repo?']
 
5068
    takes_options = [
 
5069
        Option('clean-obsolete-packs', 'Delete obsolete packs to save disk space.'),
 
5070
        ]
 
5071
 
 
5072
    def run(self, branch_or_repo='.', clean_obsolete_packs=False):
 
5073
        dir = controldir.ControlDir.open_containing(branch_or_repo)[0]
 
5074
        try:
 
5075
            branch = dir.open_branch()
 
5076
            repository = branch.repository
 
5077
        except errors.NotBranchError:
 
5078
            repository = dir.open_repository()
 
5079
        repository.pack(clean_obsolete_packs=clean_obsolete_packs)
 
5080
 
 
5081
 
3034
5082
class cmd_plugins(Command):
3035
 
    """List plugins"""
3036
 
    hidden = True
 
5083
    __doc__ = """List the installed plugins.
 
5084
 
 
5085
    This command displays the list of installed plugins including
 
5086
    version of plugin and a short description of each.
 
5087
 
 
5088
    --verbose shows the path where each plugin is located.
 
5089
 
 
5090
    A plugin is an external component for Bazaar that extends the
 
5091
    revision control system, by adding or replacing code in Bazaar.
 
5092
    Plugins can do a variety of things, including overriding commands,
 
5093
    adding new commands, providing additional network transports and
 
5094
    customizing log output.
 
5095
 
 
5096
    See the Bazaar Plugin Guide <http://doc.bazaar.canonical.com/plugins/en/>
 
5097
    for further information on plugins including where to find them and how to
 
5098
    install them. Instructions are also provided there on how to write new
 
5099
    plugins using the Python programming language.
 
5100
    """
 
5101
    takes_options = ['verbose']
 
5102
 
3037
5103
    @display_command
3038
 
    def run(self):
3039
 
        import bzrlib.plugin
3040
 
        from inspect import getdoc
3041
 
        for name, plugin in bzrlib.plugin.all_plugins().items():
3042
 
            if getattr(plugin, '__path__', None) is not None:
3043
 
                print plugin.__path__[0]
3044
 
            elif getattr(plugin, '__file__', None) is not None:
3045
 
                print plugin.__file__
3046
 
            else:
3047
 
                print repr(plugin)
3048
 
                
3049
 
            d = getdoc(plugin)
3050
 
            if d:
3051
 
                print '\t', d.split('\n')[0]
 
5104
    def run(self, verbose=False):
 
5105
        from bzrlib import plugin
 
5106
        # Don't give writelines a generator as some codecs don't like that
 
5107
        self.outf.writelines(
 
5108
            list(plugin.describe_plugins(show_paths=verbose)))
3052
5109
 
3053
5110
 
3054
5111
class cmd_testament(Command):
3055
 
    """Show testament (signing-form) of a revision."""
3056
 
    takes_options = ['revision',
3057
 
                     Option('long', help='Produce long-format testament'), 
3058
 
                     Option('strict', help='Produce a strict-format'
3059
 
                            ' testament')]
 
5112
    __doc__ = """Show testament (signing-form) of a revision."""
 
5113
    takes_options = [
 
5114
            'revision',
 
5115
            Option('long', help='Produce long-format testament.'),
 
5116
            Option('strict',
 
5117
                   help='Produce a strict-format testament.')]
3060
5118
    takes_args = ['branch?']
3061
5119
    @display_command
3062
5120
    def run(self, branch=u'.', revision=None, long=False, strict=False):
3065
5123
            testament_class = StrictTestament
3066
5124
        else:
3067
5125
            testament_class = Testament
3068
 
        b = WorkingTree.open_containing(branch)[0].branch
3069
 
        b.lock_read()
3070
 
        try:
3071
 
            if revision is None:
3072
 
                rev_id = b.last_revision()
3073
 
            else:
3074
 
                rev_id = revision[0].in_history(b).rev_id
3075
 
            t = testament_class.from_revision(b.repository, rev_id)
3076
 
            if long:
3077
 
                sys.stdout.writelines(t.as_text_lines())
3078
 
            else:
3079
 
                sys.stdout.write(t.as_short_text())
3080
 
        finally:
3081
 
            b.unlock()
 
5126
        if branch == '.':
 
5127
            b = Branch.open_containing(branch)[0]
 
5128
        else:
 
5129
            b = Branch.open(branch)
 
5130
        self.add_cleanup(b.lock_read().unlock)
 
5131
        if revision is None:
 
5132
            rev_id = b.last_revision()
 
5133
        else:
 
5134
            rev_id = revision[0].as_revision_id(b)
 
5135
        t = testament_class.from_revision(b.repository, rev_id)
 
5136
        if long:
 
5137
            sys.stdout.writelines(t.as_text_lines())
 
5138
        else:
 
5139
            sys.stdout.write(t.as_short_text())
3082
5140
 
3083
5141
 
3084
5142
class cmd_annotate(Command):
3085
 
    """Show the origin of each line in a file.
 
5143
    __doc__ = """Show the origin of each line in a file.
3086
5144
 
3087
5145
    This prints out the given file with an annotation on the left side
3088
5146
    indicating which revision, author and date introduced the change.
3089
5147
 
3090
 
    If the origin is the same for a run of consecutive lines, it is 
 
5148
    If the origin is the same for a run of consecutive lines, it is
3091
5149
    shown only at the top, unless the --all option is given.
3092
5150
    """
3093
5151
    # TODO: annotate directories; showing when each file was last changed
3094
 
    # TODO: if the working copy is modified, show annotations on that 
 
5152
    # TODO: if the working copy is modified, show annotations on that
3095
5153
    #       with new uncommitted lines marked
3096
5154
    aliases = ['ann', 'blame', 'praise']
3097
5155
    takes_args = ['filename']
3098
 
    takes_options = [Option('all', help='show annotations on all lines'),
3099
 
                     Option('long', help='show date in annotations'),
 
5156
    takes_options = [Option('all', help='Show annotations on all lines.'),
 
5157
                     Option('long', help='Show commit date in annotations.'),
3100
5158
                     'revision',
3101
5159
                     'show-ids',
 
5160
                     'directory',
3102
5161
                     ]
3103
5162
    encoding_type = 'exact'
3104
5163
 
3105
5164
    @display_command
3106
5165
    def run(self, filename, all=False, long=False, revision=None,
3107
 
            show_ids=False):
3108
 
        from bzrlib.annotate import annotate_file
3109
 
        tree, relpath = WorkingTree.open_containing(filename)
3110
 
        branch = tree.branch
3111
 
        branch.lock_read()
3112
 
        try:
3113
 
            if revision is None:
3114
 
                revision_id = branch.last_revision()
3115
 
            elif len(revision) != 1:
3116
 
                raise errors.BzrCommandError('bzr annotate --revision takes exactly 1 argument')
3117
 
            else:
3118
 
                revision_id = revision[0].in_history(branch).rev_id
 
5166
            show_ids=False, directory=None):
 
5167
        from bzrlib.annotate import (
 
5168
            annotate_file_tree,
 
5169
            )
 
5170
        wt, branch, relpath = \
 
5171
            _open_directory_or_containing_tree_or_branch(filename, directory)
 
5172
        if wt is not None:
 
5173
            self.add_cleanup(wt.lock_read().unlock)
 
5174
        else:
 
5175
            self.add_cleanup(branch.lock_read().unlock)
 
5176
        tree = _get_one_revision_tree('annotate', revision, branch=branch)
 
5177
        self.add_cleanup(tree.lock_read().unlock)
 
5178
        if wt is not None and revision is None:
 
5179
            file_id = wt.path2id(relpath)
 
5180
        else:
3119
5181
            file_id = tree.path2id(relpath)
3120
 
            if file_id is None:
3121
 
                raise errors.NotVersionedError(filename)
3122
 
            tree = branch.repository.revision_tree(revision_id)
3123
 
            file_version = tree.inventory[file_id].revision
3124
 
            annotate_file(branch, file_version, file_id, long, all, self.outf,
3125
 
                          show_ids=show_ids)
3126
 
        finally:
3127
 
            branch.unlock()
 
5182
        if file_id is None:
 
5183
            raise errors.NotVersionedError(filename)
 
5184
        if wt is not None and revision is None:
 
5185
            # If there is a tree and we're not annotating historical
 
5186
            # versions, annotate the working tree's content.
 
5187
            annotate_file_tree(wt, file_id, self.outf, long, all,
 
5188
                show_ids=show_ids)
 
5189
        else:
 
5190
            annotate_file_tree(tree, file_id, self.outf, long, all,
 
5191
                show_ids=show_ids, branch=branch)
3128
5192
 
3129
5193
 
3130
5194
class cmd_re_sign(Command):
3131
 
    """Create a digital signature for an existing revision."""
 
5195
    __doc__ = """Create a digital signature for an existing revision."""
3132
5196
    # TODO be able to replace existing ones.
3133
5197
 
3134
5198
    hidden = True # is this right ?
3135
5199
    takes_args = ['revision_id*']
3136
 
    takes_options = ['revision']
3137
 
    
3138
 
    def run(self, revision_id_list=None, revision=None):
3139
 
        import bzrlib.gpg as gpg
 
5200
    takes_options = ['directory', 'revision']
 
5201
 
 
5202
    def run(self, revision_id_list=None, revision=None, directory=u'.'):
3140
5203
        if revision_id_list is not None and revision is not None:
3141
 
            raise errors.BzrCommandError('You can only supply one of revision_id or --revision')
 
5204
            raise errors.BzrCommandError(gettext('You can only supply one of revision_id or --revision'))
3142
5205
        if revision_id_list is None and revision is None:
3143
 
            raise errors.BzrCommandError('You must supply either --revision or a revision_id')
3144
 
        b = WorkingTree.open_containing(u'.')[0].branch
3145
 
        gpg_strategy = gpg.GPGStrategy(b.get_config())
 
5206
            raise errors.BzrCommandError(gettext('You must supply either --revision or a revision_id'))
 
5207
        b = WorkingTree.open_containing(directory)[0].branch
 
5208
        self.add_cleanup(b.lock_write().unlock)
 
5209
        return self._run(b, revision_id_list, revision)
 
5210
 
 
5211
    def _run(self, b, revision_id_list, revision):
 
5212
        import bzrlib.gpg as gpg
 
5213
        gpg_strategy = gpg.GPGStrategy(b.get_config_stack())
3146
5214
        if revision_id_list is not None:
3147
 
            for revision_id in revision_id_list:
3148
 
                b.repository.sign_revision(revision_id, gpg_strategy)
 
5215
            b.repository.start_write_group()
 
5216
            try:
 
5217
                for revision_id in revision_id_list:
 
5218
                    b.repository.sign_revision(revision_id, gpg_strategy)
 
5219
            except:
 
5220
                b.repository.abort_write_group()
 
5221
                raise
 
5222
            else:
 
5223
                b.repository.commit_write_group()
3149
5224
        elif revision is not None:
3150
5225
            if len(revision) == 1:
3151
5226
                revno, rev_id = revision[0].in_history(b)
3152
 
                b.repository.sign_revision(rev_id, gpg_strategy)
 
5227
                b.repository.start_write_group()
 
5228
                try:
 
5229
                    b.repository.sign_revision(rev_id, gpg_strategy)
 
5230
                except:
 
5231
                    b.repository.abort_write_group()
 
5232
                    raise
 
5233
                else:
 
5234
                    b.repository.commit_write_group()
3153
5235
            elif len(revision) == 2:
3154
5236
                # are they both on rh- if so we can walk between them
3155
5237
                # might be nice to have a range helper for arbitrary
3159
5241
                if to_revid is None:
3160
5242
                    to_revno = b.revno()
3161
5243
                if from_revno is None or to_revno is None:
3162
 
                    raise errors.BzrCommandError('Cannot sign a range of non-revision-history revisions')
3163
 
                for revno in range(from_revno, to_revno + 1):
3164
 
                    b.repository.sign_revision(b.get_rev_id(revno), 
3165
 
                                               gpg_strategy)
 
5244
                    raise errors.BzrCommandError(gettext('Cannot sign a range of non-revision-history revisions'))
 
5245
                b.repository.start_write_group()
 
5246
                try:
 
5247
                    for revno in range(from_revno, to_revno + 1):
 
5248
                        b.repository.sign_revision(b.get_rev_id(revno),
 
5249
                                                   gpg_strategy)
 
5250
                except:
 
5251
                    b.repository.abort_write_group()
 
5252
                    raise
 
5253
                else:
 
5254
                    b.repository.commit_write_group()
3166
5255
            else:
3167
 
                raise errors.BzrCommandError('Please supply either one revision, or a range.')
 
5256
                raise errors.BzrCommandError(gettext('Please supply either one revision, or a range.'))
3168
5257
 
3169
5258
 
3170
5259
class cmd_bind(Command):
3171
 
    """Convert the current branch into a checkout of the supplied branch.
 
5260
    __doc__ = """Convert the current branch into a checkout of the supplied branch.
 
5261
    If no branch is supplied, rebind to the last bound location.
3172
5262
 
3173
5263
    Once converted into a checkout, commits must succeed on the master branch
3174
5264
    before they will be applied to the local branch.
 
5265
 
 
5266
    Bound branches use the nickname of its master branch unless it is set
 
5267
    locally, in which case binding will update the local nickname to be
 
5268
    that of the master.
3175
5269
    """
3176
5270
 
3177
5271
    _see_also = ['checkouts', 'unbind']
3178
5272
    takes_args = ['location?']
3179
 
    takes_options = []
 
5273
    takes_options = ['directory']
3180
5274
 
3181
 
    def run(self, location=None):
3182
 
        b, relpath = Branch.open_containing(u'.')
 
5275
    def run(self, location=None, directory=u'.'):
 
5276
        b, relpath = Branch.open_containing(directory)
3183
5277
        if location is None:
3184
5278
            try:
3185
5279
                location = b.get_old_bound_location()
3186
5280
            except errors.UpgradeRequired:
3187
 
                raise errors.BzrCommandError('No location supplied.  '
3188
 
                    'This format does not remember old locations.')
 
5281
                raise errors.BzrCommandError(gettext('No location supplied.  '
 
5282
                    'This format does not remember old locations.'))
3189
5283
            else:
3190
5284
                if location is None:
3191
 
                    raise errors.BzrCommandError('No location supplied and no '
3192
 
                        'previous location known')
 
5285
                    if b.get_bound_location() is not None:
 
5286
                        raise errors.BzrCommandError(
 
5287
                            gettext('Branch is already bound'))
 
5288
                    else:
 
5289
                        raise errors.BzrCommandError(
 
5290
                            gettext('No location supplied'
 
5291
                                    ' and no previous location known'))
3193
5292
        b_other = Branch.open(location)
3194
5293
        try:
3195
5294
            b.bind(b_other)
3196
5295
        except errors.DivergedBranches:
3197
 
            raise errors.BzrCommandError('These branches have diverged.'
3198
 
                                         ' Try merging, and then bind again.')
 
5296
            raise errors.BzrCommandError(gettext('These branches have diverged.'
 
5297
                                         ' Try merging, and then bind again.'))
 
5298
        if b.get_config().has_explicit_nickname():
 
5299
            b.nick = b_other.nick
3199
5300
 
3200
5301
 
3201
5302
class cmd_unbind(Command):
3202
 
    """Convert the current checkout into a regular branch.
 
5303
    __doc__ = """Convert the current checkout into a regular branch.
3203
5304
 
3204
5305
    After unbinding, the local branch is considered independent and subsequent
3205
5306
    commits will be local only.
3207
5308
 
3208
5309
    _see_also = ['checkouts', 'bind']
3209
5310
    takes_args = []
3210
 
    takes_options = []
 
5311
    takes_options = ['directory']
3211
5312
 
3212
 
    def run(self):
3213
 
        b, relpath = Branch.open_containing(u'.')
 
5313
    def run(self, directory=u'.'):
 
5314
        b, relpath = Branch.open_containing(directory)
3214
5315
        if not b.unbind():
3215
 
            raise errors.BzrCommandError('Local branch is not bound')
 
5316
            raise errors.BzrCommandError(gettext('Local branch is not bound'))
3216
5317
 
3217
5318
 
3218
5319
class cmd_uncommit(Command):
3219
 
    """Remove the last committed revision.
 
5320
    __doc__ = """Remove the last committed revision.
3220
5321
 
3221
5322
    --verbose will print out what is being removed.
3222
5323
    --dry-run will go through all the motions, but not actually
3223
5324
    remove anything.
3224
 
    
3225
 
    In the future, uncommit will create a revision bundle, which can then
3226
 
    be re-applied.
 
5325
 
 
5326
    If --revision is specified, uncommit revisions to leave the branch at the
 
5327
    specified revision.  For example, "bzr uncommit -r 15" will leave the
 
5328
    branch at revision 15.
 
5329
 
 
5330
    Uncommit leaves the working tree ready for a new commit.  The only change
 
5331
    it may make is to restore any pending merges that were present before
 
5332
    the commit.
3227
5333
    """
3228
5334
 
3229
5335
    # TODO: jam 20060108 Add an option to allow uncommit to remove
3232
5338
    # information in shared branches as well.
3233
5339
    _see_also = ['commit']
3234
5340
    takes_options = ['verbose', 'revision',
3235
 
                    Option('dry-run', help='Don\'t actually make changes'),
3236
 
                    Option('force', help='Say yes to all questions.')]
 
5341
                    Option('dry-run', help='Don\'t actually make changes.'),
 
5342
                    Option('force', help='Say yes to all questions.'),
 
5343
                    Option('keep-tags',
 
5344
                           help='Keep tags that point to removed revisions.'),
 
5345
                    Option('local',
 
5346
                           help="Only remove the commits from the local branch"
 
5347
                                " when in a checkout."
 
5348
                           ),
 
5349
                    ]
3237
5350
    takes_args = ['location?']
3238
5351
    aliases = []
3239
 
 
3240
 
    def run(self, location=None,
3241
 
            dry_run=False, verbose=False,
3242
 
            revision=None, force=False):
3243
 
        from bzrlib.log import log_formatter, show_log
3244
 
        import sys
3245
 
        from bzrlib.uncommit import uncommit
3246
 
 
 
5352
    encoding_type = 'replace'
 
5353
 
 
5354
    def run(self, location=None, dry_run=False, verbose=False,
 
5355
            revision=None, force=False, local=False, keep_tags=False):
3247
5356
        if location is None:
3248
5357
            location = u'.'
3249
 
        control, relpath = bzrdir.BzrDir.open_containing(location)
 
5358
        control, relpath = controldir.ControlDir.open_containing(location)
3250
5359
        try:
3251
5360
            tree = control.open_workingtree()
3252
5361
            b = tree.branch
3254
5363
            tree = None
3255
5364
            b = control.open_branch()
3256
5365
 
 
5366
        if tree is not None:
 
5367
            self.add_cleanup(tree.lock_write().unlock)
 
5368
        else:
 
5369
            self.add_cleanup(b.lock_write().unlock)
 
5370
        return self._run(b, tree, dry_run, verbose, revision, force,
 
5371
                         local, keep_tags)
 
5372
 
 
5373
    def _run(self, b, tree, dry_run, verbose, revision, force, local,
 
5374
             keep_tags):
 
5375
        from bzrlib.log import log_formatter, show_log
 
5376
        from bzrlib.uncommit import uncommit
 
5377
 
 
5378
        last_revno, last_rev_id = b.last_revision_info()
 
5379
 
3257
5380
        rev_id = None
3258
5381
        if revision is None:
3259
 
            revno = b.revno()
 
5382
            revno = last_revno
 
5383
            rev_id = last_rev_id
3260
5384
        else:
3261
5385
            # 'bzr uncommit -r 10' actually means uncommit
3262
5386
            # so that the final tree is at revno 10.
3263
5387
            # but bzrlib.uncommit.uncommit() actually uncommits
3264
5388
            # the revisions that are supplied.
3265
5389
            # So we need to offset it by one
3266
 
            revno = revision[0].in_history(b).revno+1
 
5390
            revno = revision[0].in_history(b).revno + 1
 
5391
            if revno <= last_revno:
 
5392
                rev_id = b.get_rev_id(revno)
3267
5393
 
3268
 
        if revno <= b.revno():
3269
 
            rev_id = b.get_rev_id(revno)
3270
 
        if rev_id is None:
3271
 
            self.outf.write('No revisions to uncommit.\n')
 
5394
        if rev_id is None or _mod_revision.is_null(rev_id):
 
5395
            self.outf.write(gettext('No revisions to uncommit.\n'))
3272
5396
            return 1
3273
5397
 
3274
5398
        lf = log_formatter('short',
3280
5404
                 verbose=False,
3281
5405
                 direction='forward',
3282
5406
                 start_revision=revno,
3283
 
                 end_revision=b.revno())
 
5407
                 end_revision=last_revno)
3284
5408
 
3285
5409
        if dry_run:
3286
 
            print 'Dry-run, pretending to remove the above revisions.'
3287
 
            if not force:
3288
 
                val = raw_input('Press <enter> to continue')
 
5410
            self.outf.write(gettext('Dry-run, pretending to remove'
 
5411
                            ' the above revisions.\n'))
3289
5412
        else:
3290
 
            print 'The above revision(s) will be removed.'
3291
 
            if not force:
3292
 
                val = raw_input('Are you sure [y/N]? ')
3293
 
                if val.lower() not in ('y', 'yes'):
3294
 
                    print 'Canceled'
3295
 
                    return 0
3296
 
 
 
5413
            self.outf.write(gettext('The above revision(s) will be removed.\n'))
 
5414
 
 
5415
        if not force:
 
5416
            if not ui.ui_factory.confirm_action(
 
5417
                    gettext(u'Uncommit these revisions'),
 
5418
                    'bzrlib.builtins.uncommit',
 
5419
                    {}):
 
5420
                self.outf.write(gettext('Canceled\n'))
 
5421
                return 0
 
5422
 
 
5423
        mutter('Uncommitting from {%s} to {%s}',
 
5424
               last_rev_id, rev_id)
3297
5425
        uncommit(b, tree=tree, dry_run=dry_run, verbose=verbose,
3298
 
                revno=revno)
 
5426
                 revno=revno, local=local, keep_tags=keep_tags)
 
5427
        self.outf.write(gettext('You can restore the old tip by running:\n'
 
5428
             '  bzr pull . -r revid:%s\n') % last_rev_id)
3299
5429
 
3300
5430
 
3301
5431
class cmd_break_lock(Command):
3302
 
    """Break a dead lock on a repository, branch or working directory.
 
5432
    __doc__ = """Break a dead lock.
 
5433
 
 
5434
    This command breaks a lock on a repository, branch, working directory or
 
5435
    config file.
3303
5436
 
3304
5437
    CAUTION: Locks should only be broken when you are sure that the process
3305
5438
    holding the lock has been stopped.
3306
5439
 
3307
 
    You can get information on what locks are open via the 'bzr info' command.
3308
 
    
3309
 
    example:
 
5440
    You can get information on what locks are open via the 'bzr info
 
5441
    [location]' command.
 
5442
 
 
5443
    :Examples:
3310
5444
        bzr break-lock
 
5445
        bzr break-lock bzr+ssh://example.com/bzr/foo
 
5446
        bzr break-lock --conf ~/.bazaar
3311
5447
    """
 
5448
 
3312
5449
    takes_args = ['location?']
 
5450
    takes_options = [
 
5451
        Option('config',
 
5452
               help='LOCATION is the directory where the config lock is.'),
 
5453
        Option('force',
 
5454
            help='Do not ask for confirmation before breaking the lock.'),
 
5455
        ]
3313
5456
 
3314
 
    def run(self, location=None, show=False):
 
5457
    def run(self, location=None, config=False, force=False):
3315
5458
        if location is None:
3316
5459
            location = u'.'
3317
 
        control, relpath = bzrdir.BzrDir.open_containing(location)
3318
 
        try:
3319
 
            control.break_lock()
3320
 
        except NotImplementedError:
3321
 
            pass
3322
 
        
 
5460
        if force:
 
5461
            ui.ui_factory = ui.ConfirmationUserInterfacePolicy(ui.ui_factory,
 
5462
                None,
 
5463
                {'bzrlib.lockdir.break': True})
 
5464
        if config:
 
5465
            conf = _mod_config.LockableConfig(file_name=location)
 
5466
            conf.break_lock()
 
5467
        else:
 
5468
            control, relpath = controldir.ControlDir.open_containing(location)
 
5469
            try:
 
5470
                control.break_lock()
 
5471
            except NotImplementedError:
 
5472
                pass
 
5473
 
3323
5474
 
3324
5475
class cmd_wait_until_signalled(Command):
3325
 
    """Test helper for test_start_and_stop_bzr_subprocess_send_signal.
 
5476
    __doc__ = """Test helper for test_start_and_stop_bzr_subprocess_send_signal.
3326
5477
 
3327
5478
    This just prints a line to signal when it is ready, then blocks on stdin.
3328
5479
    """
3336
5487
 
3337
5488
 
3338
5489
class cmd_serve(Command):
3339
 
    """Run the bzr server."""
 
5490
    __doc__ = """Run the bzr server."""
3340
5491
 
3341
5492
    aliases = ['server']
3342
5493
 
3343
5494
    takes_options = [
3344
5495
        Option('inet',
3345
 
               help='serve on stdin/out for use from inetd or sshd'),
 
5496
               help='Serve on stdin/out for use from inetd or sshd.'),
 
5497
        RegistryOption('protocol',
 
5498
               help="Protocol to serve.",
 
5499
               lazy_registry=('bzrlib.transport', 'transport_server_registry'),
 
5500
               value_switches=True),
 
5501
        Option('listen',
 
5502
               help='Listen for connections on nominated address.', type=str),
3346
5503
        Option('port',
3347
 
               help='listen for connections on nominated port of the form '
3348
 
                    '[hostname:]portnumber. Passing 0 as the port number will '
3349
 
                    'result in a dynamically allocated port. Default port is '
3350
 
                    '4155.',
3351
 
               type=str),
3352
 
        Option('directory',
3353
 
               help='serve contents of directory',
3354
 
               type=unicode),
 
5504
               help='Listen for connections on nominated port.  Passing 0 as '
 
5505
                    'the port number will result in a dynamically allocated '
 
5506
                    'port.  The default port depends on the protocol.',
 
5507
               type=int),
 
5508
        custom_help('directory',
 
5509
               help='Serve contents of this directory.'),
3355
5510
        Option('allow-writes',
3356
 
               help='By default the server is a readonly server. Supplying '
 
5511
               help='By default the server is a readonly server.  Supplying '
3357
5512
                    '--allow-writes enables write access to the contents of '
3358
 
                    'the served directory and below. '
 
5513
                    'the served directory and below.  Note that ``bzr serve`` '
 
5514
                    'does not perform authentication, so unless some form of '
 
5515
                    'external authentication is arranged supplying this '
 
5516
                    'option leads to global uncontrolled write access to your '
 
5517
                    'file system.'
3359
5518
                ),
 
5519
        Option('client-timeout', type=float,
 
5520
               help='Override the default idle client timeout (5min).'),
3360
5521
        ]
3361
5522
 
3362
 
    def run(self, port=None, inet=False, directory=None, allow_writes=False):
3363
 
        from bzrlib.smart import medium, server
3364
 
        from bzrlib.transport import get_transport
3365
 
        from bzrlib.transport.chroot import ChrootServer
3366
 
        from bzrlib.transport.remote import BZR_DEFAULT_PORT, BZR_DEFAULT_INTERFACE
 
5523
    def run(self, listen=None, port=None, inet=False, directory=None,
 
5524
            allow_writes=False, protocol=None, client_timeout=None):
 
5525
        from bzrlib import transport
3367
5526
        if directory is None:
3368
5527
            directory = os.getcwd()
3369
 
        url = urlutils.local_path_to_url(directory)
 
5528
        if protocol is None:
 
5529
            protocol = transport.transport_server_registry.get()
 
5530
        url = transport.location_to_url(directory)
3370
5531
        if not allow_writes:
3371
5532
            url = 'readonly+' + url
3372
 
        chroot_server = ChrootServer(get_transport(url))
3373
 
        chroot_server.setUp()
3374
 
        t = get_transport(chroot_server.get_url())
3375
 
        if inet:
3376
 
            smart_server = medium.SmartServerPipeStreamMedium(
3377
 
                sys.stdin, sys.stdout, t)
3378
 
        else:
3379
 
            host = BZR_DEFAULT_INTERFACE
3380
 
            if port is None:
3381
 
                port = BZR_DEFAULT_PORT
3382
 
            else:
3383
 
                if ':' in port:
3384
 
                    host, port = port.split(':')
3385
 
                port = int(port)
3386
 
            smart_server = server.SmartTCPServer(t, host=host, port=port)
3387
 
            print 'listening on port: ', smart_server.port
3388
 
            sys.stdout.flush()
3389
 
        # for the duration of this server, no UI output is permitted.
3390
 
        # note that this may cause problems with blackbox tests. This should
3391
 
        # be changed with care though, as we dont want to use bandwidth sending
3392
 
        # progress over stderr to smart server clients!
3393
 
        old_factory = ui.ui_factory
3394
 
        try:
3395
 
            ui.ui_factory = ui.SilentUIFactory()
3396
 
            smart_server.serve()
3397
 
        finally:
3398
 
            ui.ui_factory = old_factory
 
5533
        t = transport.get_transport_from_url(url)
 
5534
        protocol(t, listen, port, inet, client_timeout)
3399
5535
 
3400
5536
 
3401
5537
class cmd_join(Command):
3402
 
    """Combine a subtree into its containing tree.
3403
 
    
3404
 
    This command is for experimental use only.  It requires the target tree
3405
 
    to be in dirstate-with-subtree format, which cannot be converted into
3406
 
    earlier formats.
 
5538
    __doc__ = """Combine a tree into its containing tree.
 
5539
 
 
5540
    This command requires the target tree to be in a rich-root format.
3407
5541
 
3408
5542
    The TREE argument should be an independent tree, inside another tree, but
3409
5543
    not part of it.  (Such trees can be produced by "bzr split", but also by
3410
5544
    running "bzr branch" with the target inside a tree.)
3411
5545
 
3412
 
    The result is a combined tree, with the subtree no longer an independant
 
5546
    The result is a combined tree, with the subtree no longer an independent
3413
5547
    part.  This is marked as a merge of the subtree into the containing tree,
3414
5548
    and all history is preserved.
3415
 
 
3416
 
    If --reference is specified, the subtree retains its independence.  It can
3417
 
    be branched by itself, and can be part of multiple projects at the same
3418
 
    time.  But operations performed in the containing tree, such as commit
3419
 
    and merge, will recurse into the subtree.
3420
5549
    """
3421
5550
 
3422
5551
    _see_also = ['split']
3423
5552
    takes_args = ['tree']
3424
 
    takes_options = [Option('reference', 'join by reference')]
3425
 
    hidden = True
 
5553
    takes_options = [
 
5554
            Option('reference', help='Join by reference.', hidden=True),
 
5555
            ]
3426
5556
 
3427
5557
    def run(self, tree, reference=False):
3428
5558
        sub_tree = WorkingTree.open(tree)
3430
5560
        containing_tree = WorkingTree.open_containing(parent_dir)[0]
3431
5561
        repo = containing_tree.branch.repository
3432
5562
        if not repo.supports_rich_root():
3433
 
            raise errors.BzrCommandError(
 
5563
            raise errors.BzrCommandError(gettext(
3434
5564
                "Can't join trees because %s doesn't support rich root data.\n"
3435
 
                "You can use bzr upgrade on the repository."
 
5565
                "You can use bzr upgrade on the repository.")
3436
5566
                % (repo,))
3437
5567
        if reference:
3438
5568
            try:
3440
5570
            except errors.BadReferenceTarget, e:
3441
5571
                # XXX: Would be better to just raise a nicely printable
3442
5572
                # exception from the real origin.  Also below.  mbp 20070306
3443
 
                raise errors.BzrCommandError("Cannot join %s.  %s" %
3444
 
                                             (tree, e.reason))
 
5573
                raise errors.BzrCommandError(
 
5574
                       gettext("Cannot join {0}.  {1}").format(tree, e.reason))
3445
5575
        else:
3446
5576
            try:
3447
5577
                containing_tree.subsume(sub_tree)
3448
5578
            except errors.BadSubsumeSource, e:
3449
 
                raise errors.BzrCommandError("Cannot join %s.  %s" % 
3450
 
                                             (tree, e.reason))
 
5579
                raise errors.BzrCommandError(
 
5580
                       gettext("Cannot join {0}.  {1}").format(tree, e.reason))
3451
5581
 
3452
5582
 
3453
5583
class cmd_split(Command):
3454
 
    """Split a tree into two trees.
 
5584
    __doc__ = """Split a subdirectory of a tree into a separate tree.
3455
5585
 
3456
 
    This command is for experimental use only.  It requires the target tree
3457
 
    to be in dirstate-with-subtree format, which cannot be converted into
3458
 
    earlier formats.
 
5586
    This command will produce a target tree in a format that supports
 
5587
    rich roots, like 'rich-root' or 'rich-root-pack'.  These formats cannot be
 
5588
    converted into earlier formats like 'dirstate-tags'.
3459
5589
 
3460
5590
    The TREE argument should be a subdirectory of a working tree.  That
3461
5591
    subdirectory will be converted into an independent tree, with its own
3462
5592
    branch.  Commits in the top-level tree will not apply to the new subtree.
3463
 
    If you want that behavior, do "bzr join --reference TREE".
3464
5593
    """
3465
5594
 
3466
5595
    _see_also = ['join']
3467
5596
    takes_args = ['tree']
3468
5597
 
3469
 
    hidden = True
3470
 
 
3471
5598
    def run(self, tree):
3472
5599
        containing_tree, subdir = WorkingTree.open_containing(tree)
3473
5600
        sub_id = containing_tree.path2id(subdir)
3476
5603
        try:
3477
5604
            containing_tree.extract(sub_id)
3478
5605
        except errors.RootNotRich:
3479
 
            raise errors.UpgradeRequired(containing_tree.branch.base)
3480
 
 
 
5606
            raise errors.RichRootUpgradeRequired(containing_tree.branch.base)
3481
5607
 
3482
5608
 
3483
5609
class cmd_merge_directive(Command):
3484
 
    """Generate a merge directive for auto-merge tools.
 
5610
    __doc__ = """Generate a merge directive for auto-merge tools.
3485
5611
 
3486
5612
    A directive requests a merge to be performed, and also provides all the
3487
5613
    information necessary to do so.  This means it must either include a
3499
5625
 
3500
5626
    takes_args = ['submit_branch?', 'public_branch?']
3501
5627
 
 
5628
    hidden = True
 
5629
 
 
5630
    _see_also = ['send']
 
5631
 
3502
5632
    takes_options = [
 
5633
        'directory',
3503
5634
        RegistryOption.from_kwargs('patch-type',
3504
 
            'The type of patch to include in the directive',
3505
 
            title='Patch type', value_switches=True, enum_switch=False,
3506
 
            bundle='Bazaar revision bundle (default)',
3507
 
            diff='Normal unified diff',
3508
 
            plain='No patch, just directive'),
3509
 
        Option('sign', help='GPG-sign the directive'), 'revision',
 
5635
            'The type of patch to include in the directive.',
 
5636
            title='Patch type',
 
5637
            value_switches=True,
 
5638
            enum_switch=False,
 
5639
            bundle='Bazaar revision bundle (default).',
 
5640
            diff='Normal unified diff.',
 
5641
            plain='No patch, just directive.'),
 
5642
        Option('sign', help='GPG-sign the directive.'), 'revision',
3510
5643
        Option('mail-to', type=str,
3511
 
            help='Instead of printing the directive, email to this address'),
 
5644
            help='Instead of printing the directive, email to this address.'),
3512
5645
        Option('message', type=str, short_name='m',
3513
 
            help='Message to use when committing this merge')
 
5646
            help='Message to use when committing this merge.')
3514
5647
        ]
3515
5648
 
3516
5649
    encoding_type = 'exact'
3517
5650
 
3518
5651
    def run(self, submit_branch=None, public_branch=None, patch_type='bundle',
3519
 
            sign=False, revision=None, mail_to=None, message=None):
 
5652
            sign=False, revision=None, mail_to=None, message=None,
 
5653
            directory=u'.'):
3520
5654
        from bzrlib.revision import ensure_null, NULL_REVISION
3521
 
        if patch_type == 'plain':
3522
 
            patch_type = None
3523
 
        branch = Branch.open('.')
 
5655
        include_patch, include_bundle = {
 
5656
            'plain': (False, False),
 
5657
            'diff': (True, False),
 
5658
            'bundle': (True, True),
 
5659
            }[patch_type]
 
5660
        branch = Branch.open(directory)
3524
5661
        stored_submit_branch = branch.get_submit_branch()
3525
5662
        if submit_branch is None:
3526
5663
            submit_branch = stored_submit_branch
3530
5667
        if submit_branch is None:
3531
5668
            submit_branch = branch.get_parent()
3532
5669
        if submit_branch is None:
3533
 
            raise errors.BzrCommandError('No submit branch specified or known')
 
5670
            raise errors.BzrCommandError(gettext('No submit branch specified or known'))
3534
5671
 
3535
5672
        stored_public_branch = branch.get_public_branch()
3536
5673
        if public_branch is None:
3537
5674
            public_branch = stored_public_branch
3538
5675
        elif stored_public_branch is None:
 
5676
            # FIXME: Should be done only if we succeed ? -- vila 2012-01-03
3539
5677
            branch.set_public_branch(public_branch)
3540
 
        if patch_type != "bundle" and public_branch is None:
3541
 
            raise errors.BzrCommandError('No public branch specified or'
3542
 
                                         ' known')
 
5678
        if not include_bundle and public_branch is None:
 
5679
            raise errors.BzrCommandError(gettext('No public branch specified or'
 
5680
                                         ' known'))
 
5681
        base_revision_id = None
3543
5682
        if revision is not None:
3544
 
            if len(revision) != 1:
3545
 
                raise errors.BzrCommandError('bzr merge-directive takes '
3546
 
                    'exactly one revision identifier')
3547
 
            else:
3548
 
                revision_id = revision[0].in_history(branch).rev_id
 
5683
            if len(revision) > 2:
 
5684
                raise errors.BzrCommandError(gettext('bzr merge-directive takes '
 
5685
                    'at most two one revision identifiers'))
 
5686
            revision_id = revision[-1].as_revision_id(branch)
 
5687
            if len(revision) == 2:
 
5688
                base_revision_id = revision[0].as_revision_id(branch)
3549
5689
        else:
3550
5690
            revision_id = branch.last_revision()
3551
5691
        revision_id = ensure_null(revision_id)
3552
5692
        if revision_id == NULL_REVISION:
3553
 
            raise errors.BzrCommandError('No revisions to bundle.')
3554
 
        directive = merge_directive.MergeDirective.from_objects(
 
5693
            raise errors.BzrCommandError(gettext('No revisions to bundle.'))
 
5694
        directive = merge_directive.MergeDirective2.from_objects(
3555
5695
            branch.repository, revision_id, time.time(),
3556
5696
            osutils.local_time_offset(), submit_branch,
3557
 
            public_branch=public_branch, patch_type=patch_type,
3558
 
            message=message)
 
5697
            public_branch=public_branch, include_patch=include_patch,
 
5698
            include_bundle=include_bundle, message=message,
 
5699
            base_revision_id=base_revision_id)
3559
5700
        if mail_to is None:
3560
5701
            if sign:
3561
5702
                self.outf.write(directive.to_signed(branch))
3563
5704
                self.outf.writelines(directive.to_lines())
3564
5705
        else:
3565
5706
            message = directive.to_email(mail_to, branch, sign)
3566
 
            s = SMTPConnection(branch.get_config())
 
5707
            s = SMTPConnection(branch.get_config_stack())
3567
5708
            s.send_email(message)
3568
5709
 
3569
5710
 
 
5711
class cmd_send(Command):
 
5712
    __doc__ = """Mail or create a merge-directive for submitting changes.
 
5713
 
 
5714
    A merge directive provides many things needed for requesting merges:
 
5715
 
 
5716
    * A machine-readable description of the merge to perform
 
5717
 
 
5718
    * An optional patch that is a preview of the changes requested
 
5719
 
 
5720
    * An optional bundle of revision data, so that the changes can be applied
 
5721
      directly from the merge directive, without retrieving data from a
 
5722
      branch.
 
5723
 
 
5724
    `bzr send` creates a compact data set that, when applied using bzr
 
5725
    merge, has the same effect as merging from the source branch.  
 
5726
    
 
5727
    By default the merge directive is self-contained and can be applied to any
 
5728
    branch containing submit_branch in its ancestory without needing access to
 
5729
    the source branch.
 
5730
    
 
5731
    If --no-bundle is specified, then Bazaar doesn't send the contents of the
 
5732
    revisions, but only a structured request to merge from the
 
5733
    public_location.  In that case the public_branch is needed and it must be
 
5734
    up-to-date and accessible to the recipient.  The public_branch is always
 
5735
    included if known, so that people can check it later.
 
5736
 
 
5737
    The submit branch defaults to the parent of the source branch, but can be
 
5738
    overridden.  Both submit branch and public branch will be remembered in
 
5739
    branch.conf the first time they are used for a particular branch.  The
 
5740
    source branch defaults to that containing the working directory, but can
 
5741
    be changed using --from.
 
5742
 
 
5743
    Both the submit branch and the public branch follow the usual behavior with
 
5744
    respect to --remember: If there is no default location set, the first send
 
5745
    will set it (use --no-remember to avoid setting it). After that, you can
 
5746
    omit the location to use the default.  To change the default, use
 
5747
    --remember. The value will only be saved if the location can be accessed.
 
5748
 
 
5749
    In order to calculate those changes, bzr must analyse the submit branch.
 
5750
    Therefore it is most efficient for the submit branch to be a local mirror.
 
5751
    If a public location is known for the submit_branch, that location is used
 
5752
    in the merge directive.
 
5753
 
 
5754
    The default behaviour is to send the merge directive by mail, unless -o is
 
5755
    given, in which case it is sent to a file.
 
5756
 
 
5757
    Mail is sent using your preferred mail program.  This should be transparent
 
5758
    on Windows (it uses MAPI).  On Unix, it requires the xdg-email utility.
 
5759
    If the preferred client can't be found (or used), your editor will be used.
 
5760
 
 
5761
    To use a specific mail program, set the mail_client configuration option.
 
5762
    (For Thunderbird 1.5, this works around some bugs.)  Supported values for
 
5763
    specific clients are "claws", "evolution", "kmail", "mail.app" (MacOS X's
 
5764
    Mail.app), "mutt", and "thunderbird"; generic options are "default",
 
5765
    "editor", "emacsclient", "mapi", and "xdg-email".  Plugins may also add
 
5766
    supported clients.
 
5767
 
 
5768
    If mail is being sent, a to address is required.  This can be supplied
 
5769
    either on the commandline, by setting the submit_to configuration
 
5770
    option in the branch itself or the child_submit_to configuration option
 
5771
    in the submit branch.
 
5772
 
 
5773
    Two formats are currently supported: "4" uses revision bundle format 4 and
 
5774
    merge directive format 2.  It is significantly faster and smaller than
 
5775
    older formats.  It is compatible with Bazaar 0.19 and later.  It is the
 
5776
    default.  "0.9" uses revision bundle format 0.9 and merge directive
 
5777
    format 1.  It is compatible with Bazaar 0.12 - 0.18.
 
5778
 
 
5779
    The merge directives created by bzr send may be applied using bzr merge or
 
5780
    bzr pull by specifying a file containing a merge directive as the location.
 
5781
 
 
5782
    bzr send makes extensive use of public locations to map local locations into
 
5783
    URLs that can be used by other people.  See `bzr help configuration` to
 
5784
    set them, and use `bzr info` to display them.
 
5785
    """
 
5786
 
 
5787
    encoding_type = 'exact'
 
5788
 
 
5789
    _see_also = ['merge', 'pull']
 
5790
 
 
5791
    takes_args = ['submit_branch?', 'public_branch?']
 
5792
 
 
5793
    takes_options = [
 
5794
        Option('no-bundle',
 
5795
               help='Do not include a bundle in the merge directive.'),
 
5796
        Option('no-patch', help='Do not include a preview patch in the merge'
 
5797
               ' directive.'),
 
5798
        Option('remember',
 
5799
               help='Remember submit and public branch.'),
 
5800
        Option('from',
 
5801
               help='Branch to generate the submission from, '
 
5802
               'rather than the one containing the working directory.',
 
5803
               short_name='f',
 
5804
               type=unicode),
 
5805
        Option('output', short_name='o',
 
5806
               help='Write merge directive to this file or directory; '
 
5807
                    'use - for stdout.',
 
5808
               type=unicode),
 
5809
        Option('strict',
 
5810
               help='Refuse to send if there are uncommitted changes in'
 
5811
               ' the working tree, --no-strict disables the check.'),
 
5812
        Option('mail-to', help='Mail the request to this address.',
 
5813
               type=unicode),
 
5814
        'revision',
 
5815
        'message',
 
5816
        Option('body', help='Body for the email.', type=unicode),
 
5817
        RegistryOption('format',
 
5818
                       help='Use the specified output format.',
 
5819
                       lazy_registry=('bzrlib.send', 'format_registry')),
 
5820
        ]
 
5821
 
 
5822
    def run(self, submit_branch=None, public_branch=None, no_bundle=False,
 
5823
            no_patch=False, revision=None, remember=None, output=None,
 
5824
            format=None, mail_to=None, message=None, body=None,
 
5825
            strict=None, **kwargs):
 
5826
        from bzrlib.send import send
 
5827
        return send(submit_branch, revision, public_branch, remember,
 
5828
                    format, no_bundle, no_patch, output,
 
5829
                    kwargs.get('from', '.'), mail_to, message, body,
 
5830
                    self.outf,
 
5831
                    strict=strict)
 
5832
 
 
5833
 
 
5834
class cmd_bundle_revisions(cmd_send):
 
5835
    __doc__ = """Create a merge-directive for submitting changes.
 
5836
 
 
5837
    A merge directive provides many things needed for requesting merges:
 
5838
 
 
5839
    * A machine-readable description of the merge to perform
 
5840
 
 
5841
    * An optional patch that is a preview of the changes requested
 
5842
 
 
5843
    * An optional bundle of revision data, so that the changes can be applied
 
5844
      directly from the merge directive, without retrieving data from a
 
5845
      branch.
 
5846
 
 
5847
    If --no-bundle is specified, then public_branch is needed (and must be
 
5848
    up-to-date), so that the receiver can perform the merge using the
 
5849
    public_branch.  The public_branch is always included if known, so that
 
5850
    people can check it later.
 
5851
 
 
5852
    The submit branch defaults to the parent, but can be overridden.  Both
 
5853
    submit branch and public branch will be remembered if supplied.
 
5854
 
 
5855
    If a public_branch is known for the submit_branch, that public submit
 
5856
    branch is used in the merge instructions.  This means that a local mirror
 
5857
    can be used as your actual submit branch, once you have set public_branch
 
5858
    for that mirror.
 
5859
 
 
5860
    Two formats are currently supported: "4" uses revision bundle format 4 and
 
5861
    merge directive format 2.  It is significantly faster and smaller than
 
5862
    older formats.  It is compatible with Bazaar 0.19 and later.  It is the
 
5863
    default.  "0.9" uses revision bundle format 0.9 and merge directive
 
5864
    format 1.  It is compatible with Bazaar 0.12 - 0.18.
 
5865
    """
 
5866
 
 
5867
    takes_options = [
 
5868
        Option('no-bundle',
 
5869
               help='Do not include a bundle in the merge directive.'),
 
5870
        Option('no-patch', help='Do not include a preview patch in the merge'
 
5871
               ' directive.'),
 
5872
        Option('remember',
 
5873
               help='Remember submit and public branch.'),
 
5874
        Option('from',
 
5875
               help='Branch to generate the submission from, '
 
5876
               'rather than the one containing the working directory.',
 
5877
               short_name='f',
 
5878
               type=unicode),
 
5879
        Option('output', short_name='o', help='Write directive to this file.',
 
5880
               type=unicode),
 
5881
        Option('strict',
 
5882
               help='Refuse to bundle revisions if there are uncommitted'
 
5883
               ' changes in the working tree, --no-strict disables the check.'),
 
5884
        'revision',
 
5885
        RegistryOption('format',
 
5886
                       help='Use the specified output format.',
 
5887
                       lazy_registry=('bzrlib.send', 'format_registry')),
 
5888
        ]
 
5889
    aliases = ['bundle']
 
5890
 
 
5891
    _see_also = ['send', 'merge']
 
5892
 
 
5893
    hidden = True
 
5894
 
 
5895
    def run(self, submit_branch=None, public_branch=None, no_bundle=False,
 
5896
            no_patch=False, revision=None, remember=False, output=None,
 
5897
            format=None, strict=None, **kwargs):
 
5898
        if output is None:
 
5899
            output = '-'
 
5900
        from bzrlib.send import send
 
5901
        return send(submit_branch, revision, public_branch, remember,
 
5902
                         format, no_bundle, no_patch, output,
 
5903
                         kwargs.get('from', '.'), None, None, None,
 
5904
                         self.outf, strict=strict)
 
5905
 
 
5906
 
3570
5907
class cmd_tag(Command):
3571
 
    """Create a tag naming a revision.
3572
 
    
 
5908
    __doc__ = """Create, remove or modify a tag naming a revision.
 
5909
 
3573
5910
    Tags give human-meaningful names to revisions.  Commands that take a -r
3574
5911
    (--revision) option can be given -rtag:X, where X is any previously
3575
5912
    created tag.
3577
5914
    Tags are stored in the branch.  Tags are copied from one branch to another
3578
5915
    along when you branch, push, pull or merge.
3579
5916
 
3580
 
    It is an error to give a tag name that already exists unless you pass 
 
5917
    It is an error to give a tag name that already exists unless you pass
3581
5918
    --force, in which case the tag is moved to point to the new revision.
 
5919
 
 
5920
    To rename a tag (change the name but keep it on the same revsion), run ``bzr
 
5921
    tag new-name -r tag:old-name`` and then ``bzr tag --delete oldname``.
 
5922
 
 
5923
    If no tag name is specified it will be determined through the 
 
5924
    'automatic_tag_name' hook. This can e.g. be used to automatically tag
 
5925
    upstream releases by reading configure.ac. See ``bzr help hooks`` for
 
5926
    details.
3582
5927
    """
3583
5928
 
3584
5929
    _see_also = ['commit', 'tags']
3585
 
    takes_args = ['tag_name']
 
5930
    takes_args = ['tag_name?']
3586
5931
    takes_options = [
3587
5932
        Option('delete',
3588
5933
            help='Delete this tag rather than placing it.',
3589
5934
            ),
3590
 
        Option('directory',
3591
 
            help='Branch in which to place the tag.',
3592
 
            short_name='d',
3593
 
            type=unicode,
3594
 
            ),
 
5935
        custom_help('directory',
 
5936
            help='Branch in which to place the tag.'),
3595
5937
        Option('force',
3596
 
            help='Replace existing tags',
 
5938
            help='Replace existing tags.',
3597
5939
            ),
3598
5940
        'revision',
3599
5941
        ]
3600
5942
 
3601
 
    def run(self, tag_name,
 
5943
    def run(self, tag_name=None,
3602
5944
            delete=None,
3603
5945
            directory='.',
3604
5946
            force=None,
3605
5947
            revision=None,
3606
5948
            ):
3607
5949
        branch, relpath = Branch.open_containing(directory)
3608
 
        branch.lock_write()
3609
 
        try:
3610
 
            if delete:
3611
 
                branch.tags.delete_tag(tag_name)
3612
 
                self.outf.write('Deleted tag %s.\n' % tag_name)
3613
 
            else:
3614
 
                if revision:
3615
 
                    if len(revision) != 1:
3616
 
                        raise errors.BzrCommandError(
3617
 
                            "Tags can only be placed on a single revision, "
3618
 
                            "not on a range")
3619
 
                    revision_id = revision[0].in_history(branch).rev_id
3620
 
                else:
3621
 
                    revision_id = branch.last_revision()
3622
 
                if (not force) and branch.tags.has_tag(tag_name):
3623
 
                    raise errors.TagAlreadyExists(tag_name)
 
5950
        self.add_cleanup(branch.lock_write().unlock)
 
5951
        if delete:
 
5952
            if tag_name is None:
 
5953
                raise errors.BzrCommandError(gettext("No tag specified to delete."))
 
5954
            branch.tags.delete_tag(tag_name)
 
5955
            note(gettext('Deleted tag %s.') % tag_name)
 
5956
        else:
 
5957
            if revision:
 
5958
                if len(revision) != 1:
 
5959
                    raise errors.BzrCommandError(gettext(
 
5960
                        "Tags can only be placed on a single revision, "
 
5961
                        "not on a range"))
 
5962
                revision_id = revision[0].as_revision_id(branch)
 
5963
            else:
 
5964
                revision_id = branch.last_revision()
 
5965
            if tag_name is None:
 
5966
                tag_name = branch.automatic_tag_name(revision_id)
 
5967
                if tag_name is None:
 
5968
                    raise errors.BzrCommandError(gettext(
 
5969
                        "Please specify a tag name."))
 
5970
            try:
 
5971
                existing_target = branch.tags.lookup_tag(tag_name)
 
5972
            except errors.NoSuchTag:
 
5973
                existing_target = None
 
5974
            if not force and existing_target not in (None, revision_id):
 
5975
                raise errors.TagAlreadyExists(tag_name)
 
5976
            if existing_target == revision_id:
 
5977
                note(gettext('Tag %s already exists for that revision.') % tag_name)
 
5978
            else:
3624
5979
                branch.tags.set_tag(tag_name, revision_id)
3625
 
                self.outf.write('Created tag %s.\n' % tag_name)
3626
 
        finally:
3627
 
            branch.unlock()
 
5980
                if existing_target is None:
 
5981
                    note(gettext('Created tag %s.') % tag_name)
 
5982
                else:
 
5983
                    note(gettext('Updated tag %s.') % tag_name)
3628
5984
 
3629
5985
 
3630
5986
class cmd_tags(Command):
3631
 
    """List tags.
 
5987
    __doc__ = """List tags.
3632
5988
 
3633
 
    This tag shows a table of tag names and the revisions they reference.
 
5989
    This command shows a table of tag names and the revisions they reference.
3634
5990
    """
3635
5991
 
3636
5992
    _see_also = ['tag']
3637
5993
    takes_options = [
3638
 
        Option('directory',
3639
 
            help='Branch whose tags should be displayed',
3640
 
            short_name='d',
3641
 
            type=unicode,
 
5994
        custom_help('directory',
 
5995
            help='Branch whose tags should be displayed.'),
 
5996
        RegistryOption('sort',
 
5997
            'Sort tags by different criteria.', title='Sorting',
 
5998
            lazy_registry=('bzrlib.tag', 'tag_sort_methods')
3642
5999
            ),
 
6000
        'show-ids',
 
6001
        'revision',
3643
6002
    ]
3644
6003
 
3645
6004
    @display_command
3646
 
    def run(self,
3647
 
            directory='.',
 
6005
    def run(self, directory='.', sort=None, show_ids=False, revision=None):
 
6006
        from bzrlib.tag import tag_sort_methods
 
6007
        branch, relpath = Branch.open_containing(directory)
 
6008
 
 
6009
        tags = branch.tags.get_tag_dict().items()
 
6010
        if not tags:
 
6011
            return
 
6012
 
 
6013
        self.add_cleanup(branch.lock_read().unlock)
 
6014
        if revision:
 
6015
            # Restrict to the specified range
 
6016
            tags = self._tags_for_range(branch, revision)
 
6017
        if sort is None:
 
6018
            sort = tag_sort_methods.get()
 
6019
        sort(branch, tags)
 
6020
        if not show_ids:
 
6021
            # [ (tag, revid), ... ] -> [ (tag, dotted_revno), ... ]
 
6022
            for index, (tag, revid) in enumerate(tags):
 
6023
                try:
 
6024
                    revno = branch.revision_id_to_dotted_revno(revid)
 
6025
                    if isinstance(revno, tuple):
 
6026
                        revno = '.'.join(map(str, revno))
 
6027
                except (errors.NoSuchRevision,
 
6028
                        errors.GhostRevisionsHaveNoRevno,
 
6029
                        errors.UnsupportedOperation):
 
6030
                    # Bad tag data/merges can lead to tagged revisions
 
6031
                    # which are not in this branch. Fail gracefully ...
 
6032
                    revno = '?'
 
6033
                tags[index] = (tag, revno)
 
6034
        self.cleanup_now()
 
6035
        for tag, revspec in tags:
 
6036
            self.outf.write('%-20s %s\n' % (tag, revspec))
 
6037
 
 
6038
    def _tags_for_range(self, branch, revision):
 
6039
        range_valid = True
 
6040
        rev1, rev2 = _get_revision_range(revision, branch, self.name())
 
6041
        revid1, revid2 = rev1.rev_id, rev2.rev_id
 
6042
        # _get_revision_range will always set revid2 if it's not specified.
 
6043
        # If revid1 is None, it means we want to start from the branch
 
6044
        # origin which is always a valid ancestor. If revid1 == revid2, the
 
6045
        # ancestry check is useless.
 
6046
        if revid1 and revid1 != revid2:
 
6047
            # FIXME: We really want to use the same graph than
 
6048
            # branch.iter_merge_sorted_revisions below, but this is not
 
6049
            # easily available -- vila 2011-09-23
 
6050
            if branch.repository.get_graph().is_ancestor(revid2, revid1):
 
6051
                # We don't want to output anything in this case...
 
6052
                return []
 
6053
        # only show revisions between revid1 and revid2 (inclusive)
 
6054
        tagged_revids = branch.tags.get_reverse_tag_dict()
 
6055
        found = []
 
6056
        for r in branch.iter_merge_sorted_revisions(
 
6057
            start_revision_id=revid2, stop_revision_id=revid1,
 
6058
            stop_rule='include'):
 
6059
            revid_tags = tagged_revids.get(r[0], None)
 
6060
            if revid_tags:
 
6061
                found.extend([(tag, r[0]) for tag in revid_tags])
 
6062
        return found
 
6063
 
 
6064
 
 
6065
class cmd_reconfigure(Command):
 
6066
    __doc__ = """Reconfigure the type of a bzr directory.
 
6067
 
 
6068
    A target configuration must be specified.
 
6069
 
 
6070
    For checkouts, the bind-to location will be auto-detected if not specified.
 
6071
    The order of preference is
 
6072
    1. For a lightweight checkout, the current bound location.
 
6073
    2. For branches that used to be checkouts, the previously-bound location.
 
6074
    3. The push location.
 
6075
    4. The parent location.
 
6076
    If none of these is available, --bind-to must be specified.
 
6077
    """
 
6078
 
 
6079
    _see_also = ['branches', 'checkouts', 'standalone-trees', 'working-trees']
 
6080
    takes_args = ['location?']
 
6081
    takes_options = [
 
6082
        RegistryOption.from_kwargs(
 
6083
            'tree_type',
 
6084
            title='Tree type',
 
6085
            help='The relation between branch and tree.',
 
6086
            value_switches=True, enum_switch=False,
 
6087
            branch='Reconfigure to be an unbound branch with no working tree.',
 
6088
            tree='Reconfigure to be an unbound branch with a working tree.',
 
6089
            checkout='Reconfigure to be a bound branch with a working tree.',
 
6090
            lightweight_checkout='Reconfigure to be a lightweight'
 
6091
                ' checkout (with no local history).',
 
6092
            ),
 
6093
        RegistryOption.from_kwargs(
 
6094
            'repository_type',
 
6095
            title='Repository type',
 
6096
            help='Location fo the repository.',
 
6097
            value_switches=True, enum_switch=False,
 
6098
            standalone='Reconfigure to be a standalone branch '
 
6099
                '(i.e. stop using shared repository).',
 
6100
            use_shared='Reconfigure to use a shared repository.',
 
6101
            ),
 
6102
        RegistryOption.from_kwargs(
 
6103
            'repository_trees',
 
6104
            title='Trees in Repository',
 
6105
            help='Whether new branches in the repository have trees.',
 
6106
            value_switches=True, enum_switch=False,
 
6107
            with_trees='Reconfigure repository to create '
 
6108
                'working trees on branches by default.',
 
6109
            with_no_trees='Reconfigure repository to not create '
 
6110
                'working trees on branches by default.'
 
6111
            ),
 
6112
        Option('bind-to', help='Branch to bind checkout to.', type=str),
 
6113
        Option('force',
 
6114
            help='Perform reconfiguration even if local changes'
 
6115
            ' will be lost.'),
 
6116
        Option('stacked-on',
 
6117
            help='Reconfigure a branch to be stacked on another branch.',
 
6118
            type=unicode,
 
6119
            ),
 
6120
        Option('unstacked',
 
6121
            help='Reconfigure a branch to be unstacked.  This '
 
6122
                'may require copying substantial data into it.',
 
6123
            ),
 
6124
        ]
 
6125
 
 
6126
    def run(self, location=None, bind_to=None, force=False,
 
6127
            tree_type=None, repository_type=None, repository_trees=None,
 
6128
            stacked_on=None, unstacked=None):
 
6129
        directory = controldir.ControlDir.open(location)
 
6130
        if stacked_on and unstacked:
 
6131
            raise errors.BzrCommandError(gettext("Can't use both --stacked-on and --unstacked"))
 
6132
        elif stacked_on is not None:
 
6133
            reconfigure.ReconfigureStackedOn().apply(directory, stacked_on)
 
6134
        elif unstacked:
 
6135
            reconfigure.ReconfigureUnstacked().apply(directory)
 
6136
        # At the moment you can use --stacked-on and a different
 
6137
        # reconfiguration shape at the same time; there seems no good reason
 
6138
        # to ban it.
 
6139
        if (tree_type is None and
 
6140
            repository_type is None and
 
6141
            repository_trees is None):
 
6142
            if stacked_on or unstacked:
 
6143
                return
 
6144
            else:
 
6145
                raise errors.BzrCommandError(gettext('No target configuration '
 
6146
                    'specified'))
 
6147
        reconfiguration = None
 
6148
        if tree_type == 'branch':
 
6149
            reconfiguration = reconfigure.Reconfigure.to_branch(directory)
 
6150
        elif tree_type == 'tree':
 
6151
            reconfiguration = reconfigure.Reconfigure.to_tree(directory)
 
6152
        elif tree_type == 'checkout':
 
6153
            reconfiguration = reconfigure.Reconfigure.to_checkout(
 
6154
                directory, bind_to)
 
6155
        elif tree_type == 'lightweight-checkout':
 
6156
            reconfiguration = reconfigure.Reconfigure.to_lightweight_checkout(
 
6157
                directory, bind_to)
 
6158
        if reconfiguration:
 
6159
            reconfiguration.apply(force)
 
6160
            reconfiguration = None
 
6161
        if repository_type == 'use-shared':
 
6162
            reconfiguration = reconfigure.Reconfigure.to_use_shared(directory)
 
6163
        elif repository_type == 'standalone':
 
6164
            reconfiguration = reconfigure.Reconfigure.to_standalone(directory)
 
6165
        if reconfiguration:
 
6166
            reconfiguration.apply(force)
 
6167
            reconfiguration = None
 
6168
        if repository_trees == 'with-trees':
 
6169
            reconfiguration = reconfigure.Reconfigure.set_repository_trees(
 
6170
                directory, True)
 
6171
        elif repository_trees == 'with-no-trees':
 
6172
            reconfiguration = reconfigure.Reconfigure.set_repository_trees(
 
6173
                directory, False)
 
6174
        if reconfiguration:
 
6175
            reconfiguration.apply(force)
 
6176
            reconfiguration = None
 
6177
 
 
6178
 
 
6179
class cmd_switch(Command):
 
6180
    __doc__ = """Set the branch of a checkout and update.
 
6181
 
 
6182
    For lightweight checkouts, this changes the branch being referenced.
 
6183
    For heavyweight checkouts, this checks that there are no local commits
 
6184
    versus the current bound branch, then it makes the local branch a mirror
 
6185
    of the new location and binds to it.
 
6186
 
 
6187
    In both cases, the working tree is updated and uncommitted changes
 
6188
    are merged. The user can commit or revert these as they desire.
 
6189
 
 
6190
    Pending merges need to be committed or reverted before using switch.
 
6191
 
 
6192
    The path to the branch to switch to can be specified relative to the parent
 
6193
    directory of the current branch. For example, if you are currently in a
 
6194
    checkout of /path/to/branch, specifying 'newbranch' will find a branch at
 
6195
    /path/to/newbranch.
 
6196
 
 
6197
    Bound branches use the nickname of its master branch unless it is set
 
6198
    locally, in which case switching will update the local nickname to be
 
6199
    that of the master.
 
6200
    """
 
6201
 
 
6202
    takes_args = ['to_location?']
 
6203
    takes_options = ['directory',
 
6204
                     Option('force',
 
6205
                        help='Switch even if local commits will be lost.'),
 
6206
                     'revision',
 
6207
                     Option('create-branch', short_name='b',
 
6208
                        help='Create the target branch from this one before'
 
6209
                             ' switching to it.'),
 
6210
                    ]
 
6211
 
 
6212
    def run(self, to_location=None, force=False, create_branch=False,
 
6213
            revision=None, directory=u'.'):
 
6214
        from bzrlib import switch
 
6215
        tree_location = directory
 
6216
        revision = _get_one_revision('switch', revision)
 
6217
        possible_transports = []
 
6218
        control_dir = controldir.ControlDir.open_containing(tree_location,
 
6219
            possible_transports=possible_transports)[0]
 
6220
        if to_location is None:
 
6221
            if revision is None:
 
6222
                raise errors.BzrCommandError(gettext('You must supply either a'
 
6223
                                             ' revision or a location'))
 
6224
            to_location = tree_location
 
6225
        try:
 
6226
            branch = control_dir.open_branch(
 
6227
                possible_transports=possible_transports)
 
6228
            had_explicit_nick = branch.get_config().has_explicit_nickname()
 
6229
        except errors.NotBranchError:
 
6230
            branch = None
 
6231
            had_explicit_nick = False
 
6232
        if create_branch:
 
6233
            if branch is None:
 
6234
                raise errors.BzrCommandError(
 
6235
                    gettext('cannot create branch without source branch'))
 
6236
            to_location = lookup_new_sibling_branch(control_dir, to_location,
 
6237
                 possible_transports=possible_transports)
 
6238
            to_branch = branch.bzrdir.sprout(to_location,
 
6239
                 possible_transports=possible_transports,
 
6240
                 source_branch=branch).open_branch()
 
6241
        else:
 
6242
            try:
 
6243
                to_branch = Branch.open(to_location,
 
6244
                    possible_transports=possible_transports)
 
6245
            except errors.NotBranchError:
 
6246
                to_branch = open_sibling_branch(control_dir, to_location,
 
6247
                    possible_transports=possible_transports)
 
6248
        if revision is not None:
 
6249
            revision = revision.as_revision_id(to_branch)
 
6250
        switch.switch(control_dir, to_branch, force, revision_id=revision)
 
6251
        if had_explicit_nick:
 
6252
            branch = control_dir.open_branch() #get the new branch!
 
6253
            branch.nick = to_branch.nick
 
6254
        note(gettext('Switched to branch: %s'),
 
6255
            urlutils.unescape_for_display(to_branch.base, 'utf-8'))
 
6256
 
 
6257
 
 
6258
 
 
6259
class cmd_view(Command):
 
6260
    __doc__ = """Manage filtered views.
 
6261
 
 
6262
    Views provide a mask over the tree so that users can focus on
 
6263
    a subset of a tree when doing their work. After creating a view,
 
6264
    commands that support a list of files - status, diff, commit, etc -
 
6265
    effectively have that list of files implicitly given each time.
 
6266
    An explicit list of files can still be given but those files
 
6267
    must be within the current view.
 
6268
 
 
6269
    In most cases, a view has a short life-span: it is created to make
 
6270
    a selected change and is deleted once that change is committed.
 
6271
    At other times, you may wish to create one or more named views
 
6272
    and switch between them.
 
6273
 
 
6274
    To disable the current view without deleting it, you can switch to
 
6275
    the pseudo view called ``off``. This can be useful when you need
 
6276
    to see the whole tree for an operation or two (e.g. merge) but
 
6277
    want to switch back to your view after that.
 
6278
 
 
6279
    :Examples:
 
6280
      To define the current view::
 
6281
 
 
6282
        bzr view file1 dir1 ...
 
6283
 
 
6284
      To list the current view::
 
6285
 
 
6286
        bzr view
 
6287
 
 
6288
      To delete the current view::
 
6289
 
 
6290
        bzr view --delete
 
6291
 
 
6292
      To disable the current view without deleting it::
 
6293
 
 
6294
        bzr view --switch off
 
6295
 
 
6296
      To define a named view and switch to it::
 
6297
 
 
6298
        bzr view --name view-name file1 dir1 ...
 
6299
 
 
6300
      To list a named view::
 
6301
 
 
6302
        bzr view --name view-name
 
6303
 
 
6304
      To delete a named view::
 
6305
 
 
6306
        bzr view --name view-name --delete
 
6307
 
 
6308
      To switch to a named view::
 
6309
 
 
6310
        bzr view --switch view-name
 
6311
 
 
6312
      To list all views defined::
 
6313
 
 
6314
        bzr view --all
 
6315
 
 
6316
      To delete all views::
 
6317
 
 
6318
        bzr view --delete --all
 
6319
    """
 
6320
 
 
6321
    _see_also = []
 
6322
    takes_args = ['file*']
 
6323
    takes_options = [
 
6324
        Option('all',
 
6325
            help='Apply list or delete action to all views.',
 
6326
            ),
 
6327
        Option('delete',
 
6328
            help='Delete the view.',
 
6329
            ),
 
6330
        Option('name',
 
6331
            help='Name of the view to define, list or delete.',
 
6332
            type=unicode,
 
6333
            ),
 
6334
        Option('switch',
 
6335
            help='Name of the view to switch to.',
 
6336
            type=unicode,
 
6337
            ),
 
6338
        ]
 
6339
 
 
6340
    def run(self, file_list,
 
6341
            all=False,
 
6342
            delete=False,
 
6343
            name=None,
 
6344
            switch=None,
3648
6345
            ):
3649
 
        branch, relpath = Branch.open_containing(directory)
3650
 
        for tag_name, target in sorted(branch.tags.get_tag_dict().items()):
3651
 
            self.outf.write('%-20s %s\n' % (tag_name, target))
3652
 
 
3653
 
 
3654
 
# command-line interpretation helper for merge-related commands
3655
 
def _merge_helper(other_revision, base_revision,
3656
 
                  check_clean=True, ignore_zero=False,
3657
 
                  this_dir=None, backup_files=False,
3658
 
                  merge_type=None,
3659
 
                  file_list=None, show_base=False, reprocess=False,
3660
 
                  pull=False,
3661
 
                  pb=DummyProgress(),
3662
 
                  change_reporter=None,
3663
 
                  other_rev_id=None):
3664
 
    """Merge changes into a tree.
3665
 
 
3666
 
    base_revision
3667
 
        list(path, revno) Base for three-way merge.  
3668
 
        If [None, None] then a base will be automatically determined.
3669
 
    other_revision
3670
 
        list(path, revno) Other revision for three-way merge.
3671
 
    this_dir
3672
 
        Directory to merge changes into; '.' by default.
3673
 
    check_clean
3674
 
        If true, this_dir must have no uncommitted changes before the
3675
 
        merge begins.
3676
 
    ignore_zero - If true, suppress the "zero conflicts" message when 
3677
 
        there are no conflicts; should be set when doing something we expect
3678
 
        to complete perfectly.
3679
 
    file_list - If supplied, merge only changes to selected files.
3680
 
 
3681
 
    All available ancestors of other_revision and base_revision are
3682
 
    automatically pulled into the branch.
3683
 
 
3684
 
    The revno may be -1 to indicate the last revision on the branch, which is
3685
 
    the typical case.
3686
 
 
3687
 
    This function is intended for use from the command line; programmatic
3688
 
    clients might prefer to call merge.merge_inner(), which has less magic 
3689
 
    behavior.
3690
 
    """
3691
 
    # Loading it late, so that we don't always have to import bzrlib.merge
3692
 
    if merge_type is None:
3693
 
        merge_type = _mod_merge.Merge3Merger
3694
 
    if this_dir is None:
3695
 
        this_dir = u'.'
3696
 
    this_tree = WorkingTree.open_containing(this_dir)[0]
3697
 
    if show_base and not merge_type is _mod_merge.Merge3Merger:
3698
 
        raise errors.BzrCommandError("Show-base is not supported for this merge"
3699
 
                                     " type. %s" % merge_type)
3700
 
    if reprocess and not merge_type.supports_reprocess:
3701
 
        raise errors.BzrCommandError("Conflict reduction is not supported for merge"
3702
 
                                     " type %s." % merge_type)
3703
 
    if reprocess and show_base:
3704
 
        raise errors.BzrCommandError("Cannot do conflict reduction and show base.")
3705
 
    # TODO: jam 20070226 We should really lock these trees earlier. However, we
3706
 
    #       only want to take out a lock_tree_write() if we don't have to pull
3707
 
    #       any ancestry. But merge might fetch ancestry in the middle, in
3708
 
    #       which case we would need a lock_write().
3709
 
    #       Because we cannot upgrade locks, for now we live with the fact that
3710
 
    #       the tree will be locked multiple times during a merge. (Maybe
3711
 
    #       read-only some of the time, but it means things will get read
3712
 
    #       multiple times.)
3713
 
    try:
3714
 
        merger = _mod_merge.Merger(this_tree.branch, this_tree=this_tree,
3715
 
                                   pb=pb, change_reporter=change_reporter)
3716
 
        merger.pp = ProgressPhase("Merge phase", 5, pb)
3717
 
        merger.pp.next_phase()
3718
 
        merger.check_basis(check_clean)
3719
 
        if other_rev_id is not None:
3720
 
            merger.set_other_revision(other_rev_id, this_tree.branch)
 
6346
        tree, file_list = WorkingTree.open_containing_paths(file_list,
 
6347
            apply_view=False)
 
6348
        current_view, view_dict = tree.views.get_view_info()
 
6349
        if name is None:
 
6350
            name = current_view
 
6351
        if delete:
 
6352
            if file_list:
 
6353
                raise errors.BzrCommandError(gettext(
 
6354
                    "Both --delete and a file list specified"))
 
6355
            elif switch:
 
6356
                raise errors.BzrCommandError(gettext(
 
6357
                    "Both --delete and --switch specified"))
 
6358
            elif all:
 
6359
                tree.views.set_view_info(None, {})
 
6360
                self.outf.write(gettext("Deleted all views.\n"))
 
6361
            elif name is None:
 
6362
                raise errors.BzrCommandError(gettext("No current view to delete"))
 
6363
            else:
 
6364
                tree.views.delete_view(name)
 
6365
                self.outf.write(gettext("Deleted '%s' view.\n") % name)
 
6366
        elif switch:
 
6367
            if file_list:
 
6368
                raise errors.BzrCommandError(gettext(
 
6369
                    "Both --switch and a file list specified"))
 
6370
            elif all:
 
6371
                raise errors.BzrCommandError(gettext(
 
6372
                    "Both --switch and --all specified"))
 
6373
            elif switch == 'off':
 
6374
                if current_view is None:
 
6375
                    raise errors.BzrCommandError(gettext("No current view to disable"))
 
6376
                tree.views.set_view_info(None, view_dict)
 
6377
                self.outf.write(gettext("Disabled '%s' view.\n") % (current_view))
 
6378
            else:
 
6379
                tree.views.set_view_info(switch, view_dict)
 
6380
                view_str = views.view_display_str(tree.views.lookup_view())
 
6381
                self.outf.write(gettext("Using '{0}' view: {1}\n").format(switch, view_str))
 
6382
        elif all:
 
6383
            if view_dict:
 
6384
                self.outf.write(gettext('Views defined:\n'))
 
6385
                for view in sorted(view_dict):
 
6386
                    if view == current_view:
 
6387
                        active = "=>"
 
6388
                    else:
 
6389
                        active = "  "
 
6390
                    view_str = views.view_display_str(view_dict[view])
 
6391
                    self.outf.write('%s %-20s %s\n' % (active, view, view_str))
 
6392
            else:
 
6393
                self.outf.write(gettext('No views defined.\n'))
 
6394
        elif file_list:
 
6395
            if name is None:
 
6396
                # No name given and no current view set
 
6397
                name = 'my'
 
6398
            elif name == 'off':
 
6399
                raise errors.BzrCommandError(gettext(
 
6400
                    "Cannot change the 'off' pseudo view"))
 
6401
            tree.views.set_view(name, sorted(file_list))
 
6402
            view_str = views.view_display_str(tree.views.lookup_view())
 
6403
            self.outf.write(gettext("Using '{0}' view: {1}\n").format(name, view_str))
3721
6404
        else:
3722
 
            merger.set_other(other_revision)
3723
 
        merger.pp.next_phase()
3724
 
        merger.set_base(base_revision)
3725
 
        if merger.base_rev_id == merger.other_rev_id:
3726
 
            note('Nothing to do.')
3727
 
            return 0
3728
 
        if file_list is None:
3729
 
            if pull and merger.base_rev_id == merger.this_rev_id:
3730
 
                # FIXME: deduplicate with pull
3731
 
                result = merger.this_tree.pull(merger.this_branch,
3732
 
                        False, merger.other_rev_id)
3733
 
                if result.old_revid == result.new_revid:
3734
 
                    note('No revisions to pull.')
 
6405
            # list the files
 
6406
            if name is None:
 
6407
                # No name given and no current view set
 
6408
                self.outf.write(gettext('No current view.\n'))
 
6409
            else:
 
6410
                view_str = views.view_display_str(tree.views.lookup_view(name))
 
6411
                self.outf.write(gettext("'{0}' view is: {1}\n").format(name, view_str))
 
6412
 
 
6413
 
 
6414
class cmd_hooks(Command):
 
6415
    __doc__ = """Show hooks."""
 
6416
 
 
6417
    hidden = True
 
6418
 
 
6419
    def run(self):
 
6420
        for hook_key in sorted(hooks.known_hooks.keys()):
 
6421
            some_hooks = hooks.known_hooks_key_to_object(hook_key)
 
6422
            self.outf.write("%s:\n" % type(some_hooks).__name__)
 
6423
            for hook_name, hook_point in sorted(some_hooks.items()):
 
6424
                self.outf.write("  %s:\n" % (hook_name,))
 
6425
                found_hooks = list(hook_point)
 
6426
                if found_hooks:
 
6427
                    for hook in found_hooks:
 
6428
                        self.outf.write("    %s\n" %
 
6429
                                        (some_hooks.get_hook_name(hook),))
3735
6430
                else:
3736
 
                    note('Now on revision %d.' % result.new_revno)
3737
 
                return 0
3738
 
        merger.backup_files = backup_files
3739
 
        merger.merge_type = merge_type 
3740
 
        merger.set_interesting_files(file_list)
3741
 
        merger.show_base = show_base 
3742
 
        merger.reprocess = reprocess
3743
 
        conflicts = merger.do_merge()
3744
 
        if file_list is None:
3745
 
            merger.set_pending()
3746
 
    finally:
3747
 
        pb.clear()
3748
 
    return conflicts
3749
 
 
3750
 
 
3751
 
def _create_prefix(cur_transport):
3752
 
    needed = [cur_transport]
3753
 
    # Recurse upwards until we can create a directory successfully
3754
 
    while True:
3755
 
        new_transport = cur_transport.clone('..')
3756
 
        if new_transport.base == cur_transport.base:
3757
 
            raise errors.BzrCommandError("Failed to create path"
3758
 
                                         " prefix for %s."
3759
 
                                         % location)
3760
 
        try:
3761
 
            new_transport.mkdir('.')
3762
 
        except errors.NoSuchFile:
3763
 
            needed.append(new_transport)
3764
 
            cur_transport = new_transport
 
6431
                    self.outf.write(gettext("    <no hooks installed>\n"))
 
6432
 
 
6433
 
 
6434
class cmd_remove_branch(Command):
 
6435
    __doc__ = """Remove a branch.
 
6436
 
 
6437
    This will remove the branch from the specified location but 
 
6438
    will keep any working tree or repository in place.
 
6439
 
 
6440
    :Examples:
 
6441
 
 
6442
      Remove the branch at repo/trunk::
 
6443
 
 
6444
        bzr remove-branch repo/trunk
 
6445
 
 
6446
    """
 
6447
 
 
6448
    takes_args = ["location?"]
 
6449
 
 
6450
    takes_options = ['directory',
 
6451
        Option('force', help='Remove branch even if it is the active branch.')]
 
6452
 
 
6453
    aliases = ["rmbranch"]
 
6454
 
 
6455
    def run(self, directory=None, location=None, force=False):
 
6456
        br = open_nearby_branch(near=directory, location=location)
 
6457
        if not force and br.bzrdir.has_workingtree():
 
6458
            try:
 
6459
                active_branch = br.bzrdir.open_branch(name="")
 
6460
            except errors.NotBranchError:
 
6461
                active_branch = None
 
6462
            if (active_branch is not None and
 
6463
                br.control_url == active_branch.control_url):
 
6464
                raise errors.BzrCommandError(
 
6465
                    gettext("Branch is active. Use --force to remove it."))
 
6466
        br.bzrdir.destroy_branch(br.name)
 
6467
 
 
6468
 
 
6469
class cmd_shelve(Command):
 
6470
    __doc__ = """Temporarily set aside some changes from the current tree.
 
6471
 
 
6472
    Shelve allows you to temporarily put changes you've made "on the shelf",
 
6473
    ie. out of the way, until a later time when you can bring them back from
 
6474
    the shelf with the 'unshelve' command.  The changes are stored alongside
 
6475
    your working tree, and so they aren't propagated along with your branch nor
 
6476
    will they survive its deletion.
 
6477
 
 
6478
    If shelve --list is specified, previously-shelved changes are listed.
 
6479
 
 
6480
    Shelve is intended to help separate several sets of changes that have
 
6481
    been inappropriately mingled.  If you just want to get rid of all changes
 
6482
    and you don't need to restore them later, use revert.  If you want to
 
6483
    shelve all text changes at once, use shelve --all.
 
6484
 
 
6485
    If filenames are specified, only the changes to those files will be
 
6486
    shelved. Other files will be left untouched.
 
6487
 
 
6488
    If a revision is specified, changes since that revision will be shelved.
 
6489
 
 
6490
    You can put multiple items on the shelf, and by default, 'unshelve' will
 
6491
    restore the most recently shelved changes.
 
6492
 
 
6493
    For complicated changes, it is possible to edit the changes in a separate
 
6494
    editor program to decide what the file remaining in the working copy
 
6495
    should look like.  To do this, add the configuration option
 
6496
 
 
6497
        change_editor = PROGRAM @new_path @old_path
 
6498
 
 
6499
    where @new_path is replaced with the path of the new version of the 
 
6500
    file and @old_path is replaced with the path of the old version of 
 
6501
    the file.  The PROGRAM should save the new file with the desired 
 
6502
    contents of the file in the working tree.
 
6503
        
 
6504
    """
 
6505
 
 
6506
    takes_args = ['file*']
 
6507
 
 
6508
    takes_options = [
 
6509
        'directory',
 
6510
        'revision',
 
6511
        Option('all', help='Shelve all changes.'),
 
6512
        'message',
 
6513
        RegistryOption('writer', 'Method to use for writing diffs.',
 
6514
                       bzrlib.option.diff_writer_registry,
 
6515
                       value_switches=True, enum_switch=False),
 
6516
 
 
6517
        Option('list', help='List shelved changes.'),
 
6518
        Option('destroy',
 
6519
               help='Destroy removed changes instead of shelving them.'),
 
6520
    ]
 
6521
    _see_also = ['unshelve', 'configuration']
 
6522
 
 
6523
    def run(self, revision=None, all=False, file_list=None, message=None,
 
6524
            writer=None, list=False, destroy=False, directory=None):
 
6525
        if list:
 
6526
            return self.run_for_list(directory=directory)
 
6527
        from bzrlib.shelf_ui import Shelver
 
6528
        if writer is None:
 
6529
            writer = bzrlib.option.diff_writer_registry.get()
 
6530
        try:
 
6531
            shelver = Shelver.from_args(writer(sys.stdout), revision, all,
 
6532
                file_list, message, destroy=destroy, directory=directory)
 
6533
            try:
 
6534
                shelver.run()
 
6535
            finally:
 
6536
                shelver.finalize()
 
6537
        except errors.UserAbort:
 
6538
            return 0
 
6539
 
 
6540
    def run_for_list(self, directory=None):
 
6541
        if directory is None:
 
6542
            directory = u'.'
 
6543
        tree = WorkingTree.open_containing(directory)[0]
 
6544
        self.add_cleanup(tree.lock_read().unlock)
 
6545
        manager = tree.get_shelf_manager()
 
6546
        shelves = manager.active_shelves()
 
6547
        if len(shelves) == 0:
 
6548
            note(gettext('No shelved changes.'))
 
6549
            return 0
 
6550
        for shelf_id in reversed(shelves):
 
6551
            message = manager.get_metadata(shelf_id).get('message')
 
6552
            if message is None:
 
6553
                message = '<no message>'
 
6554
            self.outf.write('%3d: %s\n' % (shelf_id, message))
 
6555
        return 1
 
6556
 
 
6557
 
 
6558
class cmd_unshelve(Command):
 
6559
    __doc__ = """Restore shelved changes.
 
6560
 
 
6561
    By default, the most recently shelved changes are restored. However if you
 
6562
    specify a shelf by id those changes will be restored instead.  This works
 
6563
    best when the changes don't depend on each other.
 
6564
    """
 
6565
 
 
6566
    takes_args = ['shelf_id?']
 
6567
    takes_options = [
 
6568
        'directory',
 
6569
        RegistryOption.from_kwargs(
 
6570
            'action', help="The action to perform.",
 
6571
            enum_switch=False, value_switches=True,
 
6572
            apply="Apply changes and remove from the shelf.",
 
6573
            dry_run="Show changes, but do not apply or remove them.",
 
6574
            preview="Instead of unshelving the changes, show the diff that "
 
6575
                    "would result from unshelving.",
 
6576
            delete_only="Delete changes without applying them.",
 
6577
            keep="Apply changes but don't delete them.",
 
6578
        )
 
6579
    ]
 
6580
    _see_also = ['shelve']
 
6581
 
 
6582
    def run(self, shelf_id=None, action='apply', directory=u'.'):
 
6583
        from bzrlib.shelf_ui import Unshelver
 
6584
        unshelver = Unshelver.from_args(shelf_id, action, directory=directory)
 
6585
        try:
 
6586
            unshelver.run()
 
6587
        finally:
 
6588
            unshelver.tree.unlock()
 
6589
 
 
6590
 
 
6591
class cmd_clean_tree(Command):
 
6592
    __doc__ = """Remove unwanted files from working tree.
 
6593
 
 
6594
    By default, only unknown files, not ignored files, are deleted.  Versioned
 
6595
    files are never deleted.
 
6596
 
 
6597
    Another class is 'detritus', which includes files emitted by bzr during
 
6598
    normal operations and selftests.  (The value of these files decreases with
 
6599
    time.)
 
6600
 
 
6601
    If no options are specified, unknown files are deleted.  Otherwise, option
 
6602
    flags are respected, and may be combined.
 
6603
 
 
6604
    To check what clean-tree will do, use --dry-run.
 
6605
    """
 
6606
    takes_options = ['directory',
 
6607
                     Option('ignored', help='Delete all ignored files.'),
 
6608
                     Option('detritus', help='Delete conflict files, merge and revert'
 
6609
                            ' backups, and failed selftest dirs.'),
 
6610
                     Option('unknown',
 
6611
                            help='Delete files unknown to bzr (default).'),
 
6612
                     Option('dry-run', help='Show files to delete instead of'
 
6613
                            ' deleting them.'),
 
6614
                     Option('force', help='Do not prompt before deleting.')]
 
6615
    def run(self, unknown=False, ignored=False, detritus=False, dry_run=False,
 
6616
            force=False, directory=u'.'):
 
6617
        from bzrlib.clean_tree import clean_tree
 
6618
        if not (unknown or ignored or detritus):
 
6619
            unknown = True
 
6620
        if dry_run:
 
6621
            force = True
 
6622
        clean_tree(directory, unknown=unknown, ignored=ignored,
 
6623
                   detritus=detritus, dry_run=dry_run, no_prompt=force)
 
6624
 
 
6625
 
 
6626
class cmd_reference(Command):
 
6627
    __doc__ = """list, view and set branch locations for nested trees.
 
6628
 
 
6629
    If no arguments are provided, lists the branch locations for nested trees.
 
6630
    If one argument is provided, display the branch location for that tree.
 
6631
    If two arguments are provided, set the branch location for that tree.
 
6632
    """
 
6633
 
 
6634
    hidden = True
 
6635
 
 
6636
    takes_args = ['path?', 'location?']
 
6637
 
 
6638
    def run(self, path=None, location=None):
 
6639
        branchdir = '.'
 
6640
        if path is not None:
 
6641
            branchdir = path
 
6642
        tree, branch, relpath =(
 
6643
            controldir.ControlDir.open_containing_tree_or_branch(branchdir))
 
6644
        if path is not None:
 
6645
            path = relpath
 
6646
        if tree is None:
 
6647
            tree = branch.basis_tree()
 
6648
        if path is None:
 
6649
            info = branch._get_all_reference_info().iteritems()
 
6650
            self._display_reference_info(tree, branch, info)
3765
6651
        else:
3766
 
            break
3767
 
 
3768
 
    # Now we only need to create child directories
3769
 
    while needed:
3770
 
        cur_transport = needed.pop()
3771
 
        cur_transport.ensure_base()
3772
 
 
3773
 
# Compatibility
3774
 
merge = _merge_helper
3775
 
 
3776
 
 
3777
 
# these get imported and then picked up by the scan for cmd_*
3778
 
# TODO: Some more consistent way to split command definitions across files;
3779
 
# we do need to load at least some information about them to know of 
3780
 
# aliases.  ideally we would avoid loading the implementation until the
3781
 
# details were needed.
3782
 
from bzrlib.cmd_version_info import cmd_version_info
3783
 
from bzrlib.conflicts import cmd_resolve, cmd_conflicts, restore
3784
 
from bzrlib.bundle.commands import cmd_bundle_revisions
3785
 
from bzrlib.sign_my_commits import cmd_sign_my_commits
3786
 
from bzrlib.weave_commands import cmd_versionedfile_list, cmd_weave_join, \
3787
 
        cmd_weave_plan_merge, cmd_weave_merge_text
 
6652
            file_id = tree.path2id(path)
 
6653
            if file_id is None:
 
6654
                raise errors.NotVersionedError(path)
 
6655
            if location is None:
 
6656
                info = [(file_id, branch.get_reference_info(file_id))]
 
6657
                self._display_reference_info(tree, branch, info)
 
6658
            else:
 
6659
                branch.set_reference_info(file_id, path, location)
 
6660
 
 
6661
    def _display_reference_info(self, tree, branch, info):
 
6662
        ref_list = []
 
6663
        for file_id, (path, location) in info:
 
6664
            try:
 
6665
                path = tree.id2path(file_id)
 
6666
            except errors.NoSuchId:
 
6667
                pass
 
6668
            ref_list.append((path, location))
 
6669
        for path, location in sorted(ref_list):
 
6670
            self.outf.write('%s %s\n' % (path, location))
 
6671
 
 
6672
 
 
6673
class cmd_export_pot(Command):
 
6674
    __doc__ = """Export command helps and error messages in po format."""
 
6675
 
 
6676
    hidden = True
 
6677
    takes_options = [Option('plugin', 
 
6678
                            help='Export help text from named command '\
 
6679
                                 '(defaults to all built in commands).',
 
6680
                            type=str),
 
6681
                     Option('include-duplicates',
 
6682
                            help='Output multiple copies of the same msgid '
 
6683
                                 'string if it appears more than once.'),
 
6684
                            ]
 
6685
 
 
6686
    def run(self, plugin=None, include_duplicates=False):
 
6687
        from bzrlib.export_pot import export_pot
 
6688
        export_pot(self.outf, plugin, include_duplicates)
 
6689
 
 
6690
 
 
6691
def _register_lazy_builtins():
 
6692
    # register lazy builtins from other modules; called at startup and should
 
6693
    # be only called once.
 
6694
    for (name, aliases, module_name) in [
 
6695
        ('cmd_bundle_info', [], 'bzrlib.bundle.commands'),
 
6696
        ('cmd_config', [], 'bzrlib.config'),
 
6697
        ('cmd_dpush', [], 'bzrlib.foreign'),
 
6698
        ('cmd_version_info', [], 'bzrlib.cmd_version_info'),
 
6699
        ('cmd_resolve', ['resolved'], 'bzrlib.conflicts'),
 
6700
        ('cmd_conflicts', [], 'bzrlib.conflicts'),
 
6701
        ('cmd_sign_my_commits', [], 'bzrlib.commit_signature_commands'),
 
6702
        ('cmd_verify_signatures', [], 'bzrlib.commit_signature_commands'),
 
6703
        ('cmd_test_script', [], 'bzrlib.cmd_test_script'),
 
6704
        ]:
 
6705
        builtin_command_registry.register_lazy(name, aliases, module_name)