← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/builtins.py

  • Committer: John Arbash Meinel
  • Date: 2010-08-30 21:23:49 UTC
  • mto: This revision was merged to the branch mainline in revision 5398.
  • Revision ID: john@arbash-meinel.com-20100830212349-figt9yz2cic6hy68
Remove the 'false' invocation.

Show diffs side-by-side

added added

removed removed

Lines of Context:
bzrlib/builtins.py
1
 
# Copyright (C) 2004, 2005, 2006, 2007, 2008, 2009 Canonical Ltd
 
1
# Copyright (C) 2005-2010 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
20
20
 
21
21
from bzrlib.lazy_import import lazy_import
22
22
lazy_import(globals(), """
23
 
import codecs
24
23
import cStringIO
25
24
import sys
26
25
import time
31
30
    bundle,
32
31
    btree_index,
33
32
    bzrdir,
 
33
    directory_service,
34
34
    delta,
35
 
    config,
 
35
    config as _mod_config,
36
36
    errors,
37
37
    globbing,
38
38
    hooks,
43
43
    reconfigure,
44
44
    rename_map,
45
45
    revision as _mod_revision,
 
46
    static_tuple,
46
47
    symbol_versioning,
 
48
    timestamp,
47
49
    transport,
48
50
    ui,
49
51
    urlutils,
51
53
    )
52
54
from bzrlib.branch import Branch
53
55
from bzrlib.conflicts import ConflictList
 
56
from bzrlib.transport import memory
54
57
from bzrlib.revisionspec import RevisionSpec, RevisionInfo
55
58
from bzrlib.smtp_connection import SMTPConnection
56
59
from bzrlib.workingtree import WorkingTree
57
60
""")
58
61
 
59
 
from bzrlib.commands import Command, display_command
 
62
from bzrlib.commands import (
 
63
    Command,
 
64
    builtin_command_registry,
 
65
    display_command,
 
66
    )
60
67
from bzrlib.option import (
61
68
    ListOption,
62
69
    Option,
67
74
from bzrlib.trace import mutter, note, warning, is_quiet, get_verbosity_level
68
75
 
69
76
 
 
77
@symbol_versioning.deprecated_function(symbol_versioning.deprecated_in((2, 3, 0)))
70
78
def tree_files(file_list, default_branch=u'.', canonicalize=True,
71
79
    apply_view=True):
72
 
    try:
73
 
        return internal_tree_files(file_list, default_branch, canonicalize,
74
 
            apply_view)
75
 
    except errors.FileInWrongBranch, e:
76
 
        raise errors.BzrCommandError("%s is not in the same branch as %s" %
77
 
                                     (e.path, file_list[0]))
 
80
    return internal_tree_files(file_list, default_branch, canonicalize,
 
81
        apply_view)
78
82
 
79
83
 
80
84
def tree_files_for_add(file_list):
120
124
 
121
125
 
122
126
def _get_one_revision_tree(command_name, revisions, branch=None, tree=None):
 
127
    """Get a revision tree. Not suitable for commands that change the tree.
 
128
    
 
129
    Specifically, the basis tree in dirstate trees is coupled to the dirstate
 
130
    and doing a commit/uncommit/pull will at best fail due to changing the
 
131
    basis revision data.
 
132
 
 
133
    If tree is passed in, it should be already locked, for lifetime management
 
134
    of the trees internal cached state.
 
135
    """
123
136
    if branch is None:
124
137
        branch = tree.branch
125
138
    if revisions is None:
135
148
 
136
149
# XXX: Bad function name; should possibly also be a class method of
137
150
# WorkingTree rather than a function.
 
151
@symbol_versioning.deprecated_function(symbol_versioning.deprecated_in((2, 3, 0)))
138
152
def internal_tree_files(file_list, default_branch=u'.', canonicalize=True,
139
153
    apply_view=True):
140
154
    """Convert command-line paths to a WorkingTree and relative paths.
141
155
 
 
156
    Deprecated: use WorkingTree.open_containing_paths instead.
 
157
 
142
158
    This is typically used for command-line processors that take one or
143
159
    more filenames, and infer the workingtree that contains them.
144
160
 
154
170
 
155
171
    :return: workingtree, [relative_paths]
156
172
    """
157
 
    if file_list is None or len(file_list) == 0:
158
 
        tree = WorkingTree.open_containing(default_branch)[0]
159
 
        if tree.supports_views() and apply_view:
160
 
            view_files = tree.views.lookup_view()
161
 
            if view_files:
162
 
                file_list = view_files
163
 
                view_str = views.view_display_str(view_files)
164
 
                note("Ignoring files outside view. View is %s" % view_str)
165
 
        return tree, file_list
166
 
    tree = WorkingTree.open_containing(osutils.realpath(file_list[0]))[0]
167
 
    return tree, safe_relpath_files(tree, file_list, canonicalize,
168
 
        apply_view=apply_view)
169
 
 
170
 
 
171
 
def safe_relpath_files(tree, file_list, canonicalize=True, apply_view=True):
172
 
    """Convert file_list into a list of relpaths in tree.
173
 
 
174
 
    :param tree: A tree to operate on.
175
 
    :param file_list: A list of user provided paths or None.
176
 
    :param apply_view: if True and a view is set, apply it or check that
177
 
        specified files are within it
178
 
    :return: A list of relative paths.
179
 
    :raises errors.PathNotChild: When a provided path is in a different tree
180
 
        than tree.
181
 
    """
182
 
    if file_list is None:
183
 
        return None
184
 
    if tree.supports_views() and apply_view:
185
 
        view_files = tree.views.lookup_view()
186
 
    else:
187
 
        view_files = []
188
 
    new_list = []
189
 
    # tree.relpath exists as a "thunk" to osutils, but canonical_relpath
190
 
    # doesn't - fix that up here before we enter the loop.
191
 
    if canonicalize:
192
 
        fixer = lambda p: osutils.canonical_relpath(tree.basedir, p)
193
 
    else:
194
 
        fixer = tree.relpath
195
 
    for filename in file_list:
196
 
        try:
197
 
            relpath = fixer(osutils.dereference_path(filename))
198
 
            if  view_files and not osutils.is_inside_any(view_files, relpath):
199
 
                raise errors.FileOutsideView(filename, view_files)
200
 
            new_list.append(relpath)
201
 
        except errors.PathNotChild:
202
 
            raise errors.FileInWrongBranch(tree.branch, filename)
203
 
    return new_list
 
173
    return WorkingTree.open_containing_paths(
 
174
        file_list, default_directory='.',
 
175
        canonicalize=True,
 
176
        apply_view=True)
204
177
 
205
178
 
206
179
def _get_view_info_for_change_reporter(tree):
215
188
    return view_info
216
189
 
217
190
 
 
191
def _open_directory_or_containing_tree_or_branch(filename, directory):
 
192
    """Open the tree or branch containing the specified file, unless
 
193
    the --directory option is used to specify a different branch."""
 
194
    if directory is not None:
 
195
        return (None, Branch.open(directory), filename)
 
196
    return bzrdir.BzrDir.open_containing_tree_or_branch(filename)
 
197
 
 
198
 
218
199
# TODO: Make sure no commands unconditionally use the working directory as a
219
200
# branch.  If a filename argument is used, the first of them should be used to
220
201
# specify the branch.  (Perhaps this can be factored out into some kind of
222
203
# opens the branch?)
223
204
 
224
205
class cmd_status(Command):
225
 
    """Display status summary.
 
206
    __doc__ = """Display status summary.
226
207
 
227
208
    This reports on versioned and unknown files, reporting them
228
209
    grouped by state.  Possible states are:
248
229
    unknown
249
230
        Not versioned and not matching an ignore pattern.
250
231
 
 
232
    Additionally for directories, symlinks and files with an executable
 
233
    bit, Bazaar indicates their type using a trailing character: '/', '@'
 
234
    or '*' respectively.
 
235
 
251
236
    To see ignored files use 'bzr ignored'.  For details on the
252
237
    changes to file texts, use 'bzr diff'.
253
238
 
294
279
            raise errors.BzrCommandError('bzr status --revision takes exactly'
295
280
                                         ' one or two revision specifiers')
296
281
 
297
 
        tree, relfile_list = tree_files(file_list)
 
282
        tree, relfile_list = WorkingTree.open_containing_paths(file_list)
298
283
        # Avoid asking for specific files when that is not needed.
299
284
        if relfile_list == ['']:
300
285
            relfile_list = None
311
296
 
312
297
 
313
298
class cmd_cat_revision(Command):
314
 
    """Write out metadata for a revision.
 
299
    __doc__ = """Write out metadata for a revision.
315
300
 
316
301
    The revision to print can either be specified by a specific
317
302
    revision identifier, or you can use --revision.
319
304
 
320
305
    hidden = True
321
306
    takes_args = ['revision_id?']
322
 
    takes_options = ['revision']
 
307
    takes_options = ['directory', 'revision']
323
308
    # cat-revision is more for frontends so should be exact
324
309
    encoding = 'strict'
325
310
 
 
311
    def print_revision(self, revisions, revid):
 
312
        stream = revisions.get_record_stream([(revid,)], 'unordered', True)
 
313
        record = stream.next()
 
314
        if record.storage_kind == 'absent':
 
315
            raise errors.NoSuchRevision(revisions, revid)
 
316
        revtext = record.get_bytes_as('fulltext')
 
317
        self.outf.write(revtext.decode('utf-8'))
 
318
 
326
319
    @display_command
327
 
    def run(self, revision_id=None, revision=None):
 
320
    def run(self, revision_id=None, revision=None, directory=u'.'):
328
321
        if revision_id is not None and revision is not None:
329
322
            raise errors.BzrCommandError('You can only supply one of'
330
323
                                         ' revision_id or --revision')
331
324
        if revision_id is None and revision is None:
332
325
            raise errors.BzrCommandError('You must supply either'
333
326
                                         ' --revision or a revision_id')
334
 
        b = WorkingTree.open_containing(u'.')[0].branch
335
 
 
336
 
        # TODO: jam 20060112 should cat-revision always output utf-8?
337
 
        if revision_id is not None:
338
 
            revision_id = osutils.safe_revision_id(revision_id, warn=False)
339
 
            try:
340
 
                self.outf.write(b.repository.get_revision_xml(revision_id).decode('utf-8'))
341
 
            except errors.NoSuchRevision:
342
 
                msg = "The repository %s contains no revision %s." % (b.repository.base,
343
 
                    revision_id)
344
 
                raise errors.BzrCommandError(msg)
345
 
        elif revision is not None:
346
 
            for rev in revision:
347
 
                if rev is None:
348
 
                    raise errors.BzrCommandError('You cannot specify a NULL'
349
 
                                                 ' revision.')
350
 
                rev_id = rev.as_revision_id(b)
351
 
                self.outf.write(b.repository.get_revision_xml(rev_id).decode('utf-8'))
352
 
 
 
327
        b = WorkingTree.open_containing(directory)[0].branch
 
328
 
 
329
        revisions = b.repository.revisions
 
330
        if revisions is None:
 
331
            raise errors.BzrCommandError('Repository %r does not support '
 
332
                'access to raw revision texts')
 
333
 
 
334
        b.repository.lock_read()
 
335
        try:
 
336
            # TODO: jam 20060112 should cat-revision always output utf-8?
 
337
            if revision_id is not None:
 
338
                revision_id = osutils.safe_revision_id(revision_id, warn=False)
 
339
                try:
 
340
                    self.print_revision(revisions, revision_id)
 
341
                except errors.NoSuchRevision:
 
342
                    msg = "The repository %s contains no revision %s." % (
 
343
                        b.repository.base, revision_id)
 
344
                    raise errors.BzrCommandError(msg)
 
345
            elif revision is not None:
 
346
                for rev in revision:
 
347
                    if rev is None:
 
348
                        raise errors.BzrCommandError(
 
349
                            'You cannot specify a NULL revision.')
 
350
                    rev_id = rev.as_revision_id(b)
 
351
                    self.print_revision(revisions, rev_id)
 
352
        finally:
 
353
            b.repository.unlock()
 
354
        
353
355
 
354
356
class cmd_dump_btree(Command):
355
 
    """Dump the contents of a btree index file to stdout.
 
357
    __doc__ = """Dump the contents of a btree index file to stdout.
356
358
 
357
359
    PATH is a btree index file, it can be any URL. This includes things like
358
360
    .bzr/repository/pack-names, or .bzr/repository/indices/a34b3a...ca4a4.iix
422
424
        for node in bt.iter_all_entries():
423
425
            # Node is made up of:
424
426
            # (index, key, value, [references])
425
 
            self.outf.write('%s\n' % (node[1:],))
 
427
            try:
 
428
                refs = node[3]
 
429
            except IndexError:
 
430
                refs_as_tuples = None
 
431
            else:
 
432
                refs_as_tuples = static_tuple.as_tuples(refs)
 
433
            as_tuple = (tuple(node[1]), node[2], refs_as_tuples)
 
434
            self.outf.write('%s\n' % (as_tuple,))
426
435
 
427
436
 
428
437
class cmd_remove_tree(Command):
429
 
    """Remove the working tree from a given branch/checkout.
 
438
    __doc__ = """Remove the working tree from a given branch/checkout.
430
439
 
431
440
    Since a lightweight checkout is little more than a working tree
432
441
    this will refuse to run against one.
434
443
    To re-create the working tree, use "bzr checkout".
435
444
    """
436
445
    _see_also = ['checkout', 'working-trees']
437
 
    takes_args = ['location?']
 
446
    takes_args = ['location*']
438
447
    takes_options = [
439
448
        Option('force',
440
449
               help='Remove the working tree even if it has '
441
 
                    'uncommitted changes.'),
 
450
                    'uncommitted or shelved changes.'),
442
451
        ]
443
452
 
444
 
    def run(self, location='.', force=False):
445
 
        d = bzrdir.BzrDir.open(location)
446
 
 
447
 
        try:
448
 
            working = d.open_workingtree()
449
 
        except errors.NoWorkingTree:
450
 
            raise errors.BzrCommandError("No working tree to remove")
451
 
        except errors.NotLocalUrl:
452
 
            raise errors.BzrCommandError("You cannot remove the working tree"
453
 
                                         " of a remote path")
454
 
        if not force:
455
 
            # XXX: What about pending merges ? -- vila 20090629
456
 
            if working.has_changes(working.basis_tree()):
457
 
                raise errors.UncommittedChanges(working)
458
 
 
459
 
        working_path = working.bzrdir.root_transport.base
460
 
        branch_path = working.branch.bzrdir.root_transport.base
461
 
        if working_path != branch_path:
462
 
            raise errors.BzrCommandError("You cannot remove the working tree"
463
 
                                         " from a lightweight checkout")
464
 
 
465
 
        d.destroy_workingtree()
 
453
    def run(self, location_list, force=False):
 
454
        if not location_list:
 
455
            location_list=['.']
 
456
 
 
457
        for location in location_list:
 
458
            d = bzrdir.BzrDir.open(location)
 
459
            
 
460
            try:
 
461
                working = d.open_workingtree()
 
462
            except errors.NoWorkingTree:
 
463
                raise errors.BzrCommandError("No working tree to remove")
 
464
            except errors.NotLocalUrl:
 
465
                raise errors.BzrCommandError("You cannot remove the working tree"
 
466
                                             " of a remote path")
 
467
            if not force:
 
468
                if (working.has_changes()):
 
469
                    raise errors.UncommittedChanges(working)
 
470
                if working.get_shelf_manager().last_shelf() is not None:
 
471
                    raise errors.ShelvedChanges(working)
 
472
 
 
473
            if working.user_url != working.branch.user_url:
 
474
                raise errors.BzrCommandError("You cannot remove the working tree"
 
475
                                             " from a lightweight checkout")
 
476
 
 
477
            d.destroy_workingtree()
466
478
 
467
479
 
468
480
class cmd_revno(Command):
469
 
    """Show current revision number.
 
481
    __doc__ = """Show current revision number.
470
482
 
471
483
    This is equal to the number of revisions on this branch.
472
484
    """
482
494
        if tree:
483
495
            try:
484
496
                wt = WorkingTree.open_containing(location)[0]
485
 
                wt.lock_read()
 
497
                self.add_cleanup(wt.lock_read().unlock)
486
498
            except (errors.NoWorkingTree, errors.NotLocalUrl):
487
499
                raise errors.NoWorkingTree(location)
 
500
            revid = wt.last_revision()
488
501
            try:
489
 
                revid = wt.last_revision()
490
 
                try:
491
 
                    revno_t = wt.branch.revision_id_to_dotted_revno(revid)
492
 
                except errors.NoSuchRevision:
493
 
                    revno_t = ('???',)
494
 
                revno = ".".join(str(n) for n in revno_t)
495
 
            finally:
496
 
                wt.unlock()
 
502
                revno_t = wt.branch.revision_id_to_dotted_revno(revid)
 
503
            except errors.NoSuchRevision:
 
504
                revno_t = ('???',)
 
505
            revno = ".".join(str(n) for n in revno_t)
497
506
        else:
498
507
            b = Branch.open_containing(location)[0]
499
 
            b.lock_read()
500
 
            try:
501
 
                revno = b.revno()
502
 
            finally:
503
 
                b.unlock()
504
 
 
 
508
            self.add_cleanup(b.lock_read().unlock)
 
509
            revno = b.revno()
 
510
        self.cleanup_now()
505
511
        self.outf.write(str(revno) + '\n')
506
512
 
507
513
 
508
514
class cmd_revision_info(Command):
509
 
    """Show revision number and revision id for a given revision identifier.
 
515
    __doc__ = """Show revision number and revision id for a given revision identifier.
510
516
    """
511
517
    hidden = True
512
518
    takes_args = ['revision_info*']
513
519
    takes_options = [
514
520
        'revision',
515
 
        Option('directory',
 
521
        custom_help('directory',
516
522
            help='Branch to examine, '
517
 
                 'rather than the one containing the working directory.',
518
 
            short_name='d',
519
 
            type=unicode,
520
 
            ),
 
523
                 'rather than the one containing the working directory.'),
521
524
        Option('tree', help='Show revno of working tree'),
522
525
        ]
523
526
 
528
531
        try:
529
532
            wt = WorkingTree.open_containing(directory)[0]
530
533
            b = wt.branch
531
 
            wt.lock_read()
 
534
            self.add_cleanup(wt.lock_read().unlock)
532
535
        except (errors.NoWorkingTree, errors.NotLocalUrl):
533
536
            wt = None
534
537
            b = Branch.open_containing(directory)[0]
535
 
            b.lock_read()
536
 
        try:
537
 
            revision_ids = []
538
 
            if revision is not None:
539
 
                revision_ids.extend(rev.as_revision_id(b) for rev in revision)
540
 
            if revision_info_list is not None:
541
 
                for rev_str in revision_info_list:
542
 
                    rev_spec = RevisionSpec.from_string(rev_str)
543
 
                    revision_ids.append(rev_spec.as_revision_id(b))
544
 
            # No arguments supplied, default to the last revision
545
 
            if len(revision_ids) == 0:
546
 
                if tree:
547
 
                    if wt is None:
548
 
                        raise errors.NoWorkingTree(directory)
549
 
                    revision_ids.append(wt.last_revision())
550
 
                else:
551
 
                    revision_ids.append(b.last_revision())
552
 
 
553
 
            revinfos = []
554
 
            maxlen = 0
555
 
            for revision_id in revision_ids:
556
 
                try:
557
 
                    dotted_revno = b.revision_id_to_dotted_revno(revision_id)
558
 
                    revno = '.'.join(str(i) for i in dotted_revno)
559
 
                except errors.NoSuchRevision:
560
 
                    revno = '???'
561
 
                maxlen = max(maxlen, len(revno))
562
 
                revinfos.append([revno, revision_id])
563
 
        finally:
564
 
            if wt is None:
565
 
                b.unlock()
 
538
            self.add_cleanup(b.lock_read().unlock)
 
539
        revision_ids = []
 
540
        if revision is not None:
 
541
            revision_ids.extend(rev.as_revision_id(b) for rev in revision)
 
542
        if revision_info_list is not None:
 
543
            for rev_str in revision_info_list:
 
544
                rev_spec = RevisionSpec.from_string(rev_str)
 
545
                revision_ids.append(rev_spec.as_revision_id(b))
 
546
        # No arguments supplied, default to the last revision
 
547
        if len(revision_ids) == 0:
 
548
            if tree:
 
549
                if wt is None:
 
550
                    raise errors.NoWorkingTree(directory)
 
551
                revision_ids.append(wt.last_revision())
566
552
            else:
567
 
                wt.unlock()
568
 
 
 
553
                revision_ids.append(b.last_revision())
 
554
 
 
555
        revinfos = []
 
556
        maxlen = 0
 
557
        for revision_id in revision_ids:
 
558
            try:
 
559
                dotted_revno = b.revision_id_to_dotted_revno(revision_id)
 
560
                revno = '.'.join(str(i) for i in dotted_revno)
 
561
            except errors.NoSuchRevision:
 
562
                revno = '???'
 
563
            maxlen = max(maxlen, len(revno))
 
564
            revinfos.append([revno, revision_id])
 
565
 
 
566
        self.cleanup_now()
569
567
        for ri in revinfos:
570
568
            self.outf.write('%*s %s\n' % (maxlen, ri[0], ri[1]))
571
569
 
572
570
 
573
571
class cmd_add(Command):
574
 
    """Add specified files or directories.
 
572
    __doc__ = """Add specified files or directories.
575
573
 
576
574
    In non-recursive mode, all the named items are added, regardless
577
575
    of whether they were previously ignored.  A warning is given if
603
601
    branches that will be merged later (without showing the two different
604
602
    adds as a conflict). It is also useful when merging another project
605
603
    into a subdirectory of this one.
 
604
    
 
605
    Any files matching patterns in the ignore list will not be added
 
606
    unless they are explicitly mentioned.
606
607
    """
607
608
    takes_args = ['file*']
608
609
    takes_options = [
616
617
               help='Lookup file ids from this tree.'),
617
618
        ]
618
619
    encoding_type = 'replace'
619
 
    _see_also = ['remove']
 
620
    _see_also = ['remove', 'ignore']
620
621
 
621
622
    def run(self, file_list, no_recurse=False, dry_run=False, verbose=False,
622
623
            file_ids_from=None):
639
640
                should_print=(not is_quiet()))
640
641
 
641
642
        if base_tree:
642
 
            base_tree.lock_read()
643
 
        try:
644
 
            file_list = self._maybe_expand_globs(file_list)
645
 
            tree, file_list = tree_files_for_add(file_list)
646
 
            added, ignored = tree.smart_add(file_list, not
647
 
                no_recurse, action=action, save=not dry_run)
648
 
        finally:
649
 
            if base_tree is not None:
650
 
                base_tree.unlock()
 
643
            self.add_cleanup(base_tree.lock_read().unlock)
 
644
        tree, file_list = tree_files_for_add(file_list)
 
645
        added, ignored = tree.smart_add(file_list, not
 
646
            no_recurse, action=action, save=not dry_run)
 
647
        self.cleanup_now()
651
648
        if len(ignored) > 0:
652
649
            if verbose:
653
650
                for glob in sorted(ignored.keys()):
654
651
                    for path in ignored[glob]:
655
652
                        self.outf.write("ignored %s matching \"%s\"\n"
656
653
                                        % (path, glob))
657
 
            else:
658
 
                match_len = 0
659
 
                for glob, paths in ignored.items():
660
 
                    match_len += len(paths)
661
 
                self.outf.write("ignored %d file(s).\n" % match_len)
662
 
            self.outf.write("If you wish to add ignored files, "
663
 
                            "please add them explicitly by name. "
664
 
                            "(\"bzr ignored\" gives a list)\n")
665
654
 
666
655
 
667
656
class cmd_mkdir(Command):
668
 
    """Create a new versioned directory.
 
657
    __doc__ = """Create a new versioned directory.
669
658
 
670
659
    This is equivalent to creating the directory and then adding it.
671
660
    """
675
664
 
676
665
    def run(self, dir_list):
677
666
        for d in dir_list:
678
 
            os.mkdir(d)
679
667
            wt, dd = WorkingTree.open_containing(d)
680
 
            wt.add([dd])
681
 
            self.outf.write('added %s\n' % d)
 
668
            base = os.path.dirname(dd)
 
669
            id = wt.path2id(base)
 
670
            if id != None:
 
671
                os.mkdir(d)
 
672
                wt.add([dd])
 
673
                self.outf.write('added %s\n' % d)
 
674
            else:
 
675
                raise errors.NotVersionedError(path=base)
682
676
 
683
677
 
684
678
class cmd_relpath(Command):
685
 
    """Show path of a file relative to root"""
 
679
    __doc__ = """Show path of a file relative to root"""
686
680
 
687
681
    takes_args = ['filename']
688
682
    hidden = True
697
691
 
698
692
 
699
693
class cmd_inventory(Command):
700
 
    """Show inventory of the current working copy or a revision.
 
694
    __doc__ = """Show inventory of the current working copy or a revision.
701
695
 
702
696
    It is possible to limit the output to a particular entry
703
697
    type using the --kind option.  For example: --kind file.
723
717
            raise errors.BzrCommandError('invalid kind %r specified' % (kind,))
724
718
 
725
719
        revision = _get_one_revision('inventory', revision)
726
 
        work_tree, file_list = tree_files(file_list)
727
 
        work_tree.lock_read()
728
 
        try:
729
 
            if revision is not None:
730
 
                tree = revision.as_tree(work_tree.branch)
731
 
 
732
 
                extra_trees = [work_tree]
733
 
                tree.lock_read()
734
 
            else:
735
 
                tree = work_tree
736
 
                extra_trees = []
737
 
 
738
 
            if file_list is not None:
739
 
                file_ids = tree.paths2ids(file_list, trees=extra_trees,
740
 
                                          require_versioned=True)
741
 
                # find_ids_across_trees may include some paths that don't
742
 
                # exist in 'tree'.
743
 
                entries = sorted((tree.id2path(file_id), tree.inventory[file_id])
744
 
                                 for file_id in file_ids if file_id in tree)
745
 
            else:
746
 
                entries = tree.inventory.entries()
747
 
        finally:
748
 
            tree.unlock()
749
 
            if tree is not work_tree:
750
 
                work_tree.unlock()
751
 
 
 
720
        work_tree, file_list = WorkingTree.open_containing_paths(file_list)
 
721
        self.add_cleanup(work_tree.lock_read().unlock)
 
722
        if revision is not None:
 
723
            tree = revision.as_tree(work_tree.branch)
 
724
 
 
725
            extra_trees = [work_tree]
 
726
            self.add_cleanup(tree.lock_read().unlock)
 
727
        else:
 
728
            tree = work_tree
 
729
            extra_trees = []
 
730
 
 
731
        if file_list is not None:
 
732
            file_ids = tree.paths2ids(file_list, trees=extra_trees,
 
733
                                      require_versioned=True)
 
734
            # find_ids_across_trees may include some paths that don't
 
735
            # exist in 'tree'.
 
736
            entries = sorted((tree.id2path(file_id), tree.inventory[file_id])
 
737
                             for file_id in file_ids if file_id in tree)
 
738
        else:
 
739
            entries = tree.inventory.entries()
 
740
 
 
741
        self.cleanup_now()
752
742
        for path, entry in entries:
753
743
            if kind and kind != entry.kind:
754
744
                continue
760
750
 
761
751
 
762
752
class cmd_mv(Command):
763
 
    """Move or rename a file.
 
753
    __doc__ = """Move or rename a file.
764
754
 
765
755
    :Usage:
766
756
        bzr mv OLDNAME NEWNAME
798
788
            names_list = []
799
789
        if len(names_list) < 2:
800
790
            raise errors.BzrCommandError("missing file argument")
801
 
        tree, rel_names = tree_files(names_list, canonicalize=False)
802
 
        tree.lock_tree_write()
803
 
        try:
804
 
            self._run(tree, names_list, rel_names, after)
805
 
        finally:
806
 
            tree.unlock()
 
791
        tree, rel_names = WorkingTree.open_containing_paths(names_list, canonicalize=False)
 
792
        self.add_cleanup(tree.lock_tree_write().unlock)
 
793
        self._run(tree, names_list, rel_names, after)
807
794
 
808
795
    def run_auto(self, names_list, after, dry_run):
809
796
        if names_list is not None and len(names_list) > 1:
812
799
        if after:
813
800
            raise errors.BzrCommandError('--after cannot be specified with'
814
801
                                         ' --auto.')
815
 
        work_tree, file_list = tree_files(names_list, default_branch='.')
816
 
        work_tree.lock_tree_write()
817
 
        try:
818
 
            rename_map.RenameMap.guess_renames(work_tree, dry_run)
819
 
        finally:
820
 
            work_tree.unlock()
 
802
        work_tree, file_list = WorkingTree.open_containing_paths(
 
803
            names_list, default_directory='.')
 
804
        self.add_cleanup(work_tree.lock_tree_write().unlock)
 
805
        rename_map.RenameMap.guess_renames(work_tree, dry_run)
821
806
 
822
807
    def _run(self, tree, names_list, rel_names, after):
823
808
        into_existing = osutils.isdir(names_list[-1])
844
829
            # All entries reference existing inventory items, so fix them up
845
830
            # for cicp file-systems.
846
831
            rel_names = tree.get_canonical_inventory_paths(rel_names)
847
 
            for pair in tree.move(rel_names[:-1], rel_names[-1], after=after):
848
 
                self.outf.write("%s => %s\n" % pair)
 
832
            for src, dest in tree.move(rel_names[:-1], rel_names[-1], after=after):
 
833
                if not is_quiet():
 
834
                    self.outf.write("%s => %s\n" % (src, dest))
849
835
        else:
850
836
            if len(names_list) != 2:
851
837
                raise errors.BzrCommandError('to mv multiple files the'
895
881
            dest = osutils.pathjoin(dest_parent, dest_tail)
896
882
            mutter("attempting to move %s => %s", src, dest)
897
883
            tree.rename_one(src, dest, after=after)
898
 
            self.outf.write("%s => %s\n" % (src, dest))
 
884
            if not is_quiet():
 
885
                self.outf.write("%s => %s\n" % (src, dest))
899
886
 
900
887
 
901
888
class cmd_pull(Command):
902
 
    """Turn this branch into a mirror of another branch.
 
889
    __doc__ = """Turn this branch into a mirror of another branch.
903
890
 
904
 
    This command only works on branches that have not diverged.  Branches are
905
 
    considered diverged if the destination branch's most recent commit is one
906
 
    that has not been merged (directly or indirectly) into the parent.
 
891
    By default, this command only works on branches that have not diverged.
 
892
    Branches are considered diverged if the destination branch's most recent 
 
893
    commit is one that has not been merged (directly or indirectly) into the 
 
894
    parent.
907
895
 
908
896
    If branches have diverged, you can use 'bzr merge' to integrate the changes
909
897
    from one into the other.  Once one branch has merged, the other should
910
898
    be able to pull it again.
911
899
 
912
 
    If you want to forget your local changes and just update your branch to
913
 
    match the remote one, use pull --overwrite.
 
900
    If you want to replace your local changes and just want your branch to
 
901
    match the remote one, use pull --overwrite. This will work even if the two
 
902
    branches have diverged.
914
903
 
915
904
    If there is no default location set, the first pull will set it.  After
916
905
    that, you can omit the location to use the default.  To change the
926
915
    takes_options = ['remember', 'overwrite', 'revision',
927
916
        custom_help('verbose',
928
917
            help='Show logs of pulled revisions.'),
929
 
        Option('directory',
 
918
        custom_help('directory',
930
919
            help='Branch to pull into, '
931
 
                 'rather than the one containing the working directory.',
932
 
            short_name='d',
933
 
            type=unicode,
934
 
            ),
 
920
                 'rather than the one containing the working directory.'),
935
921
        Option('local',
936
922
            help="Perform a local pull in a bound "
937
923
                 "branch.  Local pulls are not applied to "
952
938
        try:
953
939
            tree_to = WorkingTree.open_containing(directory)[0]
954
940
            branch_to = tree_to.branch
 
941
            self.add_cleanup(tree_to.lock_write().unlock)
955
942
        except errors.NoWorkingTree:
956
943
            tree_to = None
957
944
            branch_to = Branch.open_containing(directory)[0]
958
 
        
 
945
            self.add_cleanup(branch_to.lock_write().unlock)
 
946
 
959
947
        if local and not branch_to.get_bound_location():
960
948
            raise errors.LocalRequiresBoundBranch()
961
949
 
991
979
        else:
992
980
            branch_from = Branch.open(location,
993
981
                possible_transports=possible_transports)
 
982
            self.add_cleanup(branch_from.lock_read().unlock)
994
983
 
995
984
            if branch_to.get_parent() is None or remember:
996
985
                branch_to.set_parent(branch_from.base)
997
986
 
998
 
        if branch_from is not branch_to:
999
 
            branch_from.lock_read()
1000
 
        try:
1001
 
            if revision is not None:
1002
 
                revision_id = revision.as_revision_id(branch_from)
1003
 
 
1004
 
            branch_to.lock_write()
1005
 
            try:
1006
 
                if tree_to is not None:
1007
 
                    view_info = _get_view_info_for_change_reporter(tree_to)
1008
 
                    change_reporter = delta._ChangeReporter(
1009
 
                        unversioned_filter=tree_to.is_ignored,
1010
 
                        view_info=view_info)
1011
 
                    result = tree_to.pull(
1012
 
                        branch_from, overwrite, revision_id, change_reporter,
1013
 
                        possible_transports=possible_transports, local=local)
1014
 
                else:
1015
 
                    result = branch_to.pull(
1016
 
                        branch_from, overwrite, revision_id, local=local)
1017
 
 
1018
 
                result.report(self.outf)
1019
 
                if verbose and result.old_revid != result.new_revid:
1020
 
                    log.show_branch_change(
1021
 
                        branch_to, self.outf, result.old_revno,
1022
 
                        result.old_revid)
1023
 
            finally:
1024
 
                branch_to.unlock()
1025
 
        finally:
1026
 
            if branch_from is not branch_to:
1027
 
                branch_from.unlock()
 
987
        if revision is not None:
 
988
            revision_id = revision.as_revision_id(branch_from)
 
989
 
 
990
        if tree_to is not None:
 
991
            view_info = _get_view_info_for_change_reporter(tree_to)
 
992
            change_reporter = delta._ChangeReporter(
 
993
                unversioned_filter=tree_to.is_ignored,
 
994
                view_info=view_info)
 
995
            result = tree_to.pull(
 
996
                branch_from, overwrite, revision_id, change_reporter,
 
997
                possible_transports=possible_transports, local=local)
 
998
        else:
 
999
            result = branch_to.pull(
 
1000
                branch_from, overwrite, revision_id, local=local)
 
1001
 
 
1002
        result.report(self.outf)
 
1003
        if verbose and result.old_revid != result.new_revid:
 
1004
            log.show_branch_change(
 
1005
                branch_to, self.outf, result.old_revno,
 
1006
                result.old_revid)
1028
1007
 
1029
1008
 
1030
1009
class cmd_push(Command):
1031
 
    """Update a mirror of this branch.
 
1010
    __doc__ = """Update a mirror of this branch.
1032
1011
 
1033
1012
    The target branch will not have its working tree populated because this
1034
1013
    is both expensive, and is not supported on remote file systems.
1058
1037
        Option('create-prefix',
1059
1038
               help='Create the path leading up to the branch '
1060
1039
                    'if it does not already exist.'),
1061
 
        Option('directory',
 
1040
        custom_help('directory',
1062
1041
            help='Branch to push from, '
1063
 
                 'rather than the one containing the working directory.',
1064
 
            short_name='d',
1065
 
            type=unicode,
1066
 
            ),
 
1042
                 'rather than the one containing the working directory.'),
1067
1043
        Option('use-existing-dir',
1068
1044
               help='By default push will fail if the target'
1069
1045
                    ' directory exists, but does not already'
1095
1071
        # Get the source branch
1096
1072
        (tree, br_from,
1097
1073
         _unused) = bzrdir.BzrDir.open_containing_tree_or_branch(directory)
1098
 
        if strict is None:
1099
 
            strict = br_from.get_config().get_user_option_as_bool('push_strict')
1100
 
        if strict is None: strict = True # default value
1101
1074
        # Get the tip's revision_id
1102
1075
        revision = _get_one_revision('push', revision)
1103
1076
        if revision is not None:
1104
1077
            revision_id = revision.in_history(br_from).rev_id
1105
1078
        else:
1106
1079
            revision_id = None
1107
 
        if strict and tree is not None and revision_id is None:
1108
 
            if (tree.has_changes(tree.basis_tree())
1109
 
                or len(tree.get_parent_ids()) > 1):
1110
 
                raise errors.UncommittedChanges(
1111
 
                    tree, more='Use --no-strict to force the push.')
1112
 
            if tree.last_revision() != tree.branch.last_revision():
1113
 
                # The tree has lost sync with its branch, there is little
1114
 
                # chance that the user is aware of it but he can still force
1115
 
                # the push with --no-strict
1116
 
                raise errors.OutOfDateTree(
1117
 
                    tree, more='Use --no-strict to force the push.')
1118
 
 
 
1080
        if tree is not None and revision_id is None:
 
1081
            tree.check_changed_or_out_of_date(
 
1082
                strict, 'push_strict',
 
1083
                more_error='Use --no-strict to force the push.',
 
1084
                more_warning='Uncommitted changes will not be pushed.')
1119
1085
        # Get the stacked_on branch, if any
1120
1086
        if stacked_on is not None:
1121
1087
            stacked_on = urlutils.normalize_url(stacked_on)
1153
1119
 
1154
1120
 
1155
1121
class cmd_branch(Command):
1156
 
    """Create a new branch that is a copy of an existing branch.
 
1122
    __doc__ = """Create a new branch that is a copy of an existing branch.
1157
1123
 
1158
1124
    If the TO_LOCATION is omitted, the last component of the FROM_LOCATION will
1159
1125
    be used.  In other words, "branch ../foo/bar" will attempt to create ./bar.
1168
1134
 
1169
1135
    _see_also = ['checkout']
1170
1136
    takes_args = ['from_location', 'to_location?']
1171
 
    takes_options = ['revision', Option('hardlink',
1172
 
        help='Hard-link working tree files where possible.'),
 
1137
    takes_options = ['revision',
 
1138
        Option('hardlink', help='Hard-link working tree files where possible.'),
 
1139
        Option('files-from', type=str,
 
1140
               help="Get file contents from this tree."),
1173
1141
        Option('no-tree',
1174
1142
            help="Create a branch without a working-tree."),
 
1143
        Option('switch',
 
1144
            help="Switch the checkout in the current directory "
 
1145
                 "to the new branch."),
1175
1146
        Option('stacked',
1176
1147
            help='Create a stacked branch referring to the source branch. '
1177
1148
                'The new branch will depend on the availability of the source '
1183
1154
                    ' directory exists, but does not already'
1184
1155
                    ' have a control directory.  This flag will'
1185
1156
                    ' allow branch to proceed.'),
 
1157
        Option('bind',
 
1158
            help="Bind new branch to from location."),
1186
1159
        ]
1187
1160
    aliases = ['get', 'clone']
1188
1161
 
1189
1162
    def run(self, from_location, to_location=None, revision=None,
1190
1163
            hardlink=False, stacked=False, standalone=False, no_tree=False,
1191
 
            use_existing_dir=False):
 
1164
            use_existing_dir=False, switch=False, bind=False,
 
1165
            files_from=None):
 
1166
        from bzrlib import switch as _mod_switch
1192
1167
        from bzrlib.tag import _merge_tags_if_possible
1193
 
 
1194
1168
        accelerator_tree, br_from = bzrdir.BzrDir.open_tree_or_branch(
1195
1169
            from_location)
1196
 
        if (accelerator_tree is not None and
1197
 
            accelerator_tree.supports_content_filtering()):
 
1170
        if not (hardlink or files_from):
 
1171
            # accelerator_tree is usually slower because you have to read N
 
1172
            # files (no readahead, lots of seeks, etc), but allow the user to
 
1173
            # explicitly request it
1198
1174
            accelerator_tree = None
 
1175
        if files_from is not None and files_from != from_location:
 
1176
            accelerator_tree = WorkingTree.open(files_from)
1199
1177
        revision = _get_one_revision('branch', revision)
1200
 
        br_from.lock_read()
 
1178
        self.add_cleanup(br_from.lock_read().unlock)
 
1179
        if revision is not None:
 
1180
            revision_id = revision.as_revision_id(br_from)
 
1181
        else:
 
1182
            # FIXME - wt.last_revision, fallback to branch, fall back to
 
1183
            # None or perhaps NULL_REVISION to mean copy nothing
 
1184
            # RBC 20060209
 
1185
            revision_id = br_from.last_revision()
 
1186
        if to_location is None:
 
1187
            to_location = urlutils.derive_to_location(from_location)
 
1188
        to_transport = transport.get_transport(to_location)
1201
1189
        try:
1202
 
            if revision is not None:
1203
 
                revision_id = revision.as_revision_id(br_from)
 
1190
            to_transport.mkdir('.')
 
1191
        except errors.FileExists:
 
1192
            if not use_existing_dir:
 
1193
                raise errors.BzrCommandError('Target directory "%s" '
 
1194
                    'already exists.' % to_location)
1204
1195
            else:
1205
 
                # FIXME - wt.last_revision, fallback to branch, fall back to
1206
 
                # None or perhaps NULL_REVISION to mean copy nothing
1207
 
                # RBC 20060209
1208
 
                revision_id = br_from.last_revision()
1209
 
            if to_location is None:
1210
 
                to_location = urlutils.derive_to_location(from_location)
1211
 
            to_transport = transport.get_transport(to_location)
1212
 
            try:
1213
 
                to_transport.mkdir('.')
1214
 
            except errors.FileExists:
1215
 
                if not use_existing_dir:
1216
 
                    raise errors.BzrCommandError('Target directory "%s" '
1217
 
                        'already exists.' % to_location)
 
1196
                try:
 
1197
                    bzrdir.BzrDir.open_from_transport(to_transport)
 
1198
                except errors.NotBranchError:
 
1199
                    pass
1218
1200
                else:
1219
 
                    try:
1220
 
                        bzrdir.BzrDir.open_from_transport(to_transport)
1221
 
                    except errors.NotBranchError:
1222
 
                        pass
1223
 
                    else:
1224
 
                        raise errors.AlreadyBranchError(to_location)
1225
 
            except errors.NoSuchFile:
1226
 
                raise errors.BzrCommandError('Parent of "%s" does not exist.'
1227
 
                                             % to_location)
1228
 
            try:
1229
 
                # preserve whatever source format we have.
1230
 
                dir = br_from.bzrdir.sprout(to_transport.base, revision_id,
1231
 
                                            possible_transports=[to_transport],
1232
 
                                            accelerator_tree=accelerator_tree,
1233
 
                                            hardlink=hardlink, stacked=stacked,
1234
 
                                            force_new_repo=standalone,
1235
 
                                            create_tree_if_local=not no_tree,
1236
 
                                            source_branch=br_from)
1237
 
                branch = dir.open_branch()
1238
 
            except errors.NoSuchRevision:
1239
 
                to_transport.delete_tree('.')
1240
 
                msg = "The branch %s has no revision %s." % (from_location,
1241
 
                    revision)
1242
 
                raise errors.BzrCommandError(msg)
1243
 
            _merge_tags_if_possible(br_from, branch)
1244
 
            # If the source branch is stacked, the new branch may
1245
 
            # be stacked whether we asked for that explicitly or not.
1246
 
            # We therefore need a try/except here and not just 'if stacked:'
1247
 
            try:
1248
 
                note('Created new stacked branch referring to %s.' %
1249
 
                    branch.get_stacked_on_url())
1250
 
            except (errors.NotStacked, errors.UnstackableBranchFormat,
1251
 
                errors.UnstackableRepositoryFormat), e:
1252
 
                note('Branched %d revision(s).' % branch.revno())
1253
 
        finally:
1254
 
            br_from.unlock()
 
1201
                    raise errors.AlreadyBranchError(to_location)
 
1202
        except errors.NoSuchFile:
 
1203
            raise errors.BzrCommandError('Parent of "%s" does not exist.'
 
1204
                                         % to_location)
 
1205
        try:
 
1206
            # preserve whatever source format we have.
 
1207
            dir = br_from.bzrdir.sprout(to_transport.base, revision_id,
 
1208
                                        possible_transports=[to_transport],
 
1209
                                        accelerator_tree=accelerator_tree,
 
1210
                                        hardlink=hardlink, stacked=stacked,
 
1211
                                        force_new_repo=standalone,
 
1212
                                        create_tree_if_local=not no_tree,
 
1213
                                        source_branch=br_from)
 
1214
            branch = dir.open_branch()
 
1215
        except errors.NoSuchRevision:
 
1216
            to_transport.delete_tree('.')
 
1217
            msg = "The branch %s has no revision %s." % (from_location,
 
1218
                revision)
 
1219
            raise errors.BzrCommandError(msg)
 
1220
        _merge_tags_if_possible(br_from, branch)
 
1221
        # If the source branch is stacked, the new branch may
 
1222
        # be stacked whether we asked for that explicitly or not.
 
1223
        # We therefore need a try/except here and not just 'if stacked:'
 
1224
        try:
 
1225
            note('Created new stacked branch referring to %s.' %
 
1226
                branch.get_stacked_on_url())
 
1227
        except (errors.NotStacked, errors.UnstackableBranchFormat,
 
1228
            errors.UnstackableRepositoryFormat), e:
 
1229
            note('Branched %d revision(s).' % branch.revno())
 
1230
        if bind:
 
1231
            # Bind to the parent
 
1232
            parent_branch = Branch.open(from_location)
 
1233
            branch.bind(parent_branch)
 
1234
            note('New branch bound to %s' % from_location)
 
1235
        if switch:
 
1236
            # Switch to the new branch
 
1237
            wt, _ = WorkingTree.open_containing('.')
 
1238
            _mod_switch.switch(wt.bzrdir, branch)
 
1239
            note('Switched to branch: %s',
 
1240
                urlutils.unescape_for_display(branch.base, 'utf-8'))
1255
1241
 
1256
1242
 
1257
1243
class cmd_checkout(Command):
1258
 
    """Create a new checkout of an existing branch.
 
1244
    __doc__ = """Create a new checkout of an existing branch.
1259
1245
 
1260
1246
    If BRANCH_LOCATION is omitted, checkout will reconstitute a working tree for
1261
1247
    the branch found in '.'. This is useful if you have removed the working tree
1300
1286
            to_location = branch_location
1301
1287
        accelerator_tree, source = bzrdir.BzrDir.open_tree_or_branch(
1302
1288
            branch_location)
 
1289
        if not (hardlink or files_from):
 
1290
            # accelerator_tree is usually slower because you have to read N
 
1291
            # files (no readahead, lots of seeks, etc), but allow the user to
 
1292
            # explicitly request it
 
1293
            accelerator_tree = None
1303
1294
        revision = _get_one_revision('checkout', revision)
1304
 
        if files_from is not None:
 
1295
        if files_from is not None and files_from != branch_location:
1305
1296
            accelerator_tree = WorkingTree.open(files_from)
1306
1297
        if revision is not None:
1307
1298
            revision_id = revision.as_revision_id(source)
1324
1315
 
1325
1316
 
1326
1317
class cmd_renames(Command):
1327
 
    """Show list of renamed files.
 
1318
    __doc__ = """Show list of renamed files.
1328
1319
    """
1329
1320
    # TODO: Option to show renames between two historical versions.
1330
1321
 
1335
1326
    @display_command
1336
1327
    def run(self, dir=u'.'):
1337
1328
        tree = WorkingTree.open_containing(dir)[0]
1338
 
        tree.lock_read()
1339
 
        try:
1340
 
            new_inv = tree.inventory
1341
 
            old_tree = tree.basis_tree()
1342
 
            old_tree.lock_read()
1343
 
            try:
1344
 
                old_inv = old_tree.inventory
1345
 
                renames = []
1346
 
                iterator = tree.iter_changes(old_tree, include_unchanged=True)
1347
 
                for f, paths, c, v, p, n, k, e in iterator:
1348
 
                    if paths[0] == paths[1]:
1349
 
                        continue
1350
 
                    if None in (paths):
1351
 
                        continue
1352
 
                    renames.append(paths)
1353
 
                renames.sort()
1354
 
                for old_name, new_name in renames:
1355
 
                    self.outf.write("%s => %s\n" % (old_name, new_name))
1356
 
            finally:
1357
 
                old_tree.unlock()
1358
 
        finally:
1359
 
            tree.unlock()
 
1329
        self.add_cleanup(tree.lock_read().unlock)
 
1330
        new_inv = tree.inventory
 
1331
        old_tree = tree.basis_tree()
 
1332
        self.add_cleanup(old_tree.lock_read().unlock)
 
1333
        old_inv = old_tree.inventory
 
1334
        renames = []
 
1335
        iterator = tree.iter_changes(old_tree, include_unchanged=True)
 
1336
        for f, paths, c, v, p, n, k, e in iterator:
 
1337
            if paths[0] == paths[1]:
 
1338
                continue
 
1339
            if None in (paths):
 
1340
                continue
 
1341
            renames.append(paths)
 
1342
        renames.sort()
 
1343
        for old_name, new_name in renames:
 
1344
            self.outf.write("%s => %s\n" % (old_name, new_name))
1360
1345
 
1361
1346
 
1362
1347
class cmd_update(Command):
1363
 
    """Update a tree to have the latest code committed to its branch.
 
1348
    __doc__ = """Update a tree to have the latest code committed to its branch.
1364
1349
 
1365
1350
    This will perform a merge into the working tree, and may generate
1366
1351
    conflicts. If you have any local changes, you will still
1368
1353
 
1369
1354
    If you want to discard your local changes, you can just do a
1370
1355
    'bzr revert' instead of 'bzr commit' after the update.
 
1356
 
 
1357
    If the tree's branch is bound to a master branch, it will also update
 
1358
    the branch from the master.
1371
1359
    """
1372
1360
 
1373
1361
    _see_also = ['pull', 'working-trees', 'status-flags']
1374
1362
    takes_args = ['dir?']
 
1363
    takes_options = ['revision']
1375
1364
    aliases = ['up']
1376
1365
 
1377
 
    def run(self, dir='.'):
 
1366
    def run(self, dir='.', revision=None):
 
1367
        if revision is not None and len(revision) != 1:
 
1368
            raise errors.BzrCommandError(
 
1369
                        "bzr update --revision takes exactly one revision")
1378
1370
        tree = WorkingTree.open_containing(dir)[0]
 
1371
        branch = tree.branch
1379
1372
        possible_transports = []
1380
 
        master = tree.branch.get_master_branch(
 
1373
        master = branch.get_master_branch(
1381
1374
            possible_transports=possible_transports)
1382
1375
        if master is not None:
 
1376
            branch_location = master.base
1383
1377
            tree.lock_write()
1384
1378
        else:
 
1379
            branch_location = tree.branch.base
1385
1380
            tree.lock_tree_write()
 
1381
        self.add_cleanup(tree.unlock)
 
1382
        # get rid of the final '/' and be ready for display
 
1383
        branch_location = urlutils.unescape_for_display(
 
1384
            branch_location.rstrip('/'),
 
1385
            self.outf.encoding)
 
1386
        existing_pending_merges = tree.get_parent_ids()[1:]
 
1387
        if master is None:
 
1388
            old_tip = None
 
1389
        else:
 
1390
            # may need to fetch data into a heavyweight checkout
 
1391
            # XXX: this may take some time, maybe we should display a
 
1392
            # message
 
1393
            old_tip = branch.update(possible_transports)
 
1394
        if revision is not None:
 
1395
            revision_id = revision[0].as_revision_id(branch)
 
1396
        else:
 
1397
            revision_id = branch.last_revision()
 
1398
        if revision_id == _mod_revision.ensure_null(tree.last_revision()):
 
1399
            revno = branch.revision_id_to_dotted_revno(revision_id)
 
1400
            note("Tree is up to date at revision %s of branch %s" %
 
1401
                ('.'.join(map(str, revno)), branch_location))
 
1402
            return 0
 
1403
        view_info = _get_view_info_for_change_reporter(tree)
 
1404
        change_reporter = delta._ChangeReporter(
 
1405
            unversioned_filter=tree.is_ignored,
 
1406
            view_info=view_info)
1386
1407
        try:
1387
 
            existing_pending_merges = tree.get_parent_ids()[1:]
1388
 
            last_rev = _mod_revision.ensure_null(tree.last_revision())
1389
 
            if last_rev == _mod_revision.ensure_null(
1390
 
                tree.branch.last_revision()):
1391
 
                # may be up to date, check master too.
1392
 
                if master is None or last_rev == _mod_revision.ensure_null(
1393
 
                    master.last_revision()):
1394
 
                    revno = tree.branch.revision_id_to_revno(last_rev)
1395
 
                    note("Tree is up to date at revision %d." % (revno,))
1396
 
                    return 0
1397
 
            view_info = _get_view_info_for_change_reporter(tree)
1398
1408
            conflicts = tree.update(
1399
 
                delta._ChangeReporter(unversioned_filter=tree.is_ignored,
1400
 
                view_info=view_info), possible_transports=possible_transports)
1401
 
            revno = tree.branch.revision_id_to_revno(
1402
 
                _mod_revision.ensure_null(tree.last_revision()))
1403
 
            note('Updated to revision %d.' % (revno,))
1404
 
            if tree.get_parent_ids()[1:] != existing_pending_merges:
1405
 
                note('Your local commits will now show as pending merges with '
1406
 
                     "'bzr status', and can be committed with 'bzr commit'.")
1407
 
            if conflicts != 0:
1408
 
                return 1
1409
 
            else:
1410
 
                return 0
1411
 
        finally:
1412
 
            tree.unlock()
 
1409
                change_reporter,
 
1410
                possible_transports=possible_transports,
 
1411
                revision=revision_id,
 
1412
                old_tip=old_tip)
 
1413
        except errors.NoSuchRevision, e:
 
1414
            raise errors.BzrCommandError(
 
1415
                                  "branch has no revision %s\n"
 
1416
                                  "bzr update --revision only works"
 
1417
                                  " for a revision in the branch history"
 
1418
                                  % (e.revision))
 
1419
        revno = tree.branch.revision_id_to_dotted_revno(
 
1420
            _mod_revision.ensure_null(tree.last_revision()))
 
1421
        note('Updated to revision %s of branch %s' %
 
1422
             ('.'.join(map(str, revno)), branch_location))
 
1423
        parent_ids = tree.get_parent_ids()
 
1424
        if parent_ids[1:] and parent_ids[1:] != existing_pending_merges:
 
1425
            note('Your local commits will now show as pending merges with '
 
1426
                 "'bzr status', and can be committed with 'bzr commit'.")
 
1427
        if conflicts != 0:
 
1428
            return 1
 
1429
        else:
 
1430
            return 0
1413
1431
 
1414
1432
 
1415
1433
class cmd_info(Command):
1416
 
    """Show information about a working tree, branch or repository.
 
1434
    __doc__ = """Show information about a working tree, branch or repository.
1417
1435
 
1418
1436
    This command will show all known locations and formats associated to the
1419
1437
    tree, branch or repository.
1457
1475
 
1458
1476
 
1459
1477
class cmd_remove(Command):
1460
 
    """Remove files or directories.
 
1478
    __doc__ = """Remove files or directories.
1461
1479
 
1462
 
    This makes bzr stop tracking changes to the specified files. bzr will delete
1463
 
    them if they can easily be recovered using revert. If no options or
1464
 
    parameters are given bzr will scan for files that are being tracked by bzr
1465
 
    but missing in your tree and stop tracking them for you.
 
1480
    This makes Bazaar stop tracking changes to the specified files. Bazaar will
 
1481
    delete them if they can easily be recovered using revert otherwise they
 
1482
    will be backed up (adding an extention of the form .~#~). If no options or
 
1483
    parameters are given Bazaar will scan for files that are being tracked by
 
1484
    Bazaar but missing in your tree and stop tracking them for you.
1466
1485
    """
1467
1486
    takes_args = ['file*']
1468
1487
    takes_options = ['verbose',
1470
1489
        RegistryOption.from_kwargs('file-deletion-strategy',
1471
1490
            'The file deletion mode to be used.',
1472
1491
            title='Deletion Strategy', value_switches=True, enum_switch=False,
1473
 
            safe='Only delete files if they can be'
1474
 
                 ' safely recovered (default).',
1475
 
            keep="Don't delete any files.",
 
1492
            safe='Backup changed files (default).',
 
1493
            keep='Delete from bzr but leave the working copy.',
1476
1494
            force='Delete all the specified files, even if they can not be '
1477
1495
                'recovered and even if they are non-empty directories.')]
1478
1496
    aliases = ['rm', 'del']
1480
1498
 
1481
1499
    def run(self, file_list, verbose=False, new=False,
1482
1500
        file_deletion_strategy='safe'):
1483
 
        tree, file_list = tree_files(file_list)
 
1501
        tree, file_list = WorkingTree.open_containing_paths(file_list)
1484
1502
 
1485
1503
        if file_list is not None:
1486
1504
            file_list = [f for f in file_list]
1487
1505
 
1488
 
        tree.lock_write()
1489
 
        try:
1490
 
            # Heuristics should probably all move into tree.remove_smart or
1491
 
            # some such?
1492
 
            if new:
1493
 
                added = tree.changes_from(tree.basis_tree(),
1494
 
                    specific_files=file_list).added
1495
 
                file_list = sorted([f[0] for f in added], reverse=True)
1496
 
                if len(file_list) == 0:
1497
 
                    raise errors.BzrCommandError('No matching files.')
1498
 
            elif file_list is None:
1499
 
                # missing files show up in iter_changes(basis) as
1500
 
                # versioned-with-no-kind.
1501
 
                missing = []
1502
 
                for change in tree.iter_changes(tree.basis_tree()):
1503
 
                    # Find paths in the working tree that have no kind:
1504
 
                    if change[1][1] is not None and change[6][1] is None:
1505
 
                        missing.append(change[1][1])
1506
 
                file_list = sorted(missing, reverse=True)
1507
 
                file_deletion_strategy = 'keep'
1508
 
            tree.remove(file_list, verbose=verbose, to_file=self.outf,
1509
 
                keep_files=file_deletion_strategy=='keep',
1510
 
                force=file_deletion_strategy=='force')
1511
 
        finally:
1512
 
            tree.unlock()
 
1506
        self.add_cleanup(tree.lock_write().unlock)
 
1507
        # Heuristics should probably all move into tree.remove_smart or
 
1508
        # some such?
 
1509
        if new:
 
1510
            added = tree.changes_from(tree.basis_tree(),
 
1511
                specific_files=file_list).added
 
1512
            file_list = sorted([f[0] for f in added], reverse=True)
 
1513
            if len(file_list) == 0:
 
1514
                raise errors.BzrCommandError('No matching files.')
 
1515
        elif file_list is None:
 
1516
            # missing files show up in iter_changes(basis) as
 
1517
            # versioned-with-no-kind.
 
1518
            missing = []
 
1519
            for change in tree.iter_changes(tree.basis_tree()):
 
1520
                # Find paths in the working tree that have no kind:
 
1521
                if change[1][1] is not None and change[6][1] is None:
 
1522
                    missing.append(change[1][1])
 
1523
            file_list = sorted(missing, reverse=True)
 
1524
            file_deletion_strategy = 'keep'
 
1525
        tree.remove(file_list, verbose=verbose, to_file=self.outf,
 
1526
            keep_files=file_deletion_strategy=='keep',
 
1527
            force=file_deletion_strategy=='force')
1513
1528
 
1514
1529
 
1515
1530
class cmd_file_id(Command):
1516
 
    """Print file_id of a particular file or directory.
 
1531
    __doc__ = """Print file_id of a particular file or directory.
1517
1532
 
1518
1533
    The file_id is assigned when the file is first added and remains the
1519
1534
    same through all revisions where the file exists, even when it is
1535
1550
 
1536
1551
 
1537
1552
class cmd_file_path(Command):
1538
 
    """Print path of file_ids to a file or directory.
 
1553
    __doc__ = """Print path of file_ids to a file or directory.
1539
1554
 
1540
1555
    This prints one line for each directory down to the target,
1541
1556
    starting at the branch root.
1557
1572
 
1558
1573
 
1559
1574
class cmd_reconcile(Command):
1560
 
    """Reconcile bzr metadata in a branch.
 
1575
    __doc__ = """Reconcile bzr metadata in a branch.
1561
1576
 
1562
1577
    This can correct data mismatches that may have been caused by
1563
1578
    previous ghost operations or bzr upgrades. You should only
1577
1592
 
1578
1593
    _see_also = ['check']
1579
1594
    takes_args = ['branch?']
 
1595
    takes_options = [
 
1596
        Option('canonicalize-chks',
 
1597
               help='Make sure CHKs are in canonical form (repairs '
 
1598
                    'bug 522637).',
 
1599
               hidden=True),
 
1600
        ]
1580
1601
 
1581
 
    def run(self, branch="."):
 
1602
    def run(self, branch=".", canonicalize_chks=False):
1582
1603
        from bzrlib.reconcile import reconcile
1583
1604
        dir = bzrdir.BzrDir.open(branch)
1584
 
        reconcile(dir)
 
1605
        reconcile(dir, canonicalize_chks=canonicalize_chks)
1585
1606
 
1586
1607
 
1587
1608
class cmd_revision_history(Command):
1588
 
    """Display the list of revision ids on a branch."""
 
1609
    __doc__ = """Display the list of revision ids on a branch."""
1589
1610
 
1590
1611
    _see_also = ['log']
1591
1612
    takes_args = ['location?']
1601
1622
 
1602
1623
 
1603
1624
class cmd_ancestry(Command):
1604
 
    """List all revisions merged into this branch."""
 
1625
    __doc__ = """List all revisions merged into this branch."""
1605
1626
 
1606
1627
    _see_also = ['log', 'revision-history']
1607
1628
    takes_args = ['location?']
1626
1647
 
1627
1648
 
1628
1649
class cmd_init(Command):
1629
 
    """Make a directory into a versioned branch.
 
1650
    __doc__ = """Make a directory into a versioned branch.
1630
1651
 
1631
1652
    Use this to create an empty branch, or before importing an
1632
1653
    existing project.
1660
1681
                lazy_registry=('bzrlib.bzrdir', 'format_registry'),
1661
1682
                converter=lambda name: bzrdir.format_registry.make_bzrdir(name),
1662
1683
                value_switches=True,
1663
 
                title="Branch Format",
 
1684
                title="Branch format",
1664
1685
                ),
1665
1686
         Option('append-revisions-only',
1666
1687
                help='Never change revnos or the existing log.'
1735
1756
 
1736
1757
 
1737
1758
class cmd_init_repository(Command):
1738
 
    """Create a shared repository to hold branches.
 
1759
    __doc__ = """Create a shared repository for branches to share storage space.
1739
1760
 
1740
1761
    New branches created under the repository directory will store their
1741
 
    revisions in the repository, not in the branch directory.
 
1762
    revisions in the repository, not in the branch directory.  For branches
 
1763
    with shared history, this reduces the amount of storage needed and 
 
1764
    speeds up the creation of new branches.
1742
1765
 
1743
 
    If the --no-trees option is used then the branches in the repository
1744
 
    will not have working trees by default.
 
1766
    If the --no-trees option is given then the branches in the repository
 
1767
    will not have working trees by default.  They will still exist as 
 
1768
    directories on disk, but they will not have separate copies of the 
 
1769
    files at a certain revision.  This can be useful for repositories that
 
1770
    store branches which are interacted with through checkouts or remote
 
1771
    branches, such as on a server.
1745
1772
 
1746
1773
    :Examples:
1747
 
        Create a shared repositories holding just branches::
 
1774
        Create a shared repository holding just branches::
1748
1775
 
1749
1776
            bzr init-repo --no-trees repo
1750
1777
            bzr init repo/trunk
1789
1816
 
1790
1817
 
1791
1818
class cmd_diff(Command):
1792
 
    """Show differences in the working tree, between revisions or branches.
 
1819
    __doc__ = """Show differences in the working tree, between revisions or branches.
1793
1820
 
1794
1821
    If no arguments are given, all changes for the current tree are listed.
1795
1822
    If files are given, only the changes in those files are listed.
1816
1843
 
1817
1844
            bzr diff -r1
1818
1845
 
1819
 
        Difference between revision 2 and revision 1::
1820
 
 
1821
 
            bzr diff -r1..2
1822
 
 
1823
 
        Difference between revision 2 and revision 1 for branch xxx::
1824
 
 
1825
 
            bzr diff -r1..2 xxx
 
1846
        Difference between revision 3 and revision 1::
 
1847
 
 
1848
            bzr diff -r1..3
 
1849
 
 
1850
        Difference between revision 3 and revision 1 for branch xxx::
 
1851
 
 
1852
            bzr diff -r1..3 xxx
 
1853
 
 
1854
        To see the changes introduced in revision X::
 
1855
        
 
1856
            bzr diff -cX
 
1857
 
 
1858
        Note that in the case of a merge, the -c option shows the changes
 
1859
        compared to the left hand parent. To see the changes against
 
1860
        another parent, use::
 
1861
 
 
1862
            bzr diff -r<chosen_parent>..X
 
1863
 
 
1864
        The changes introduced by revision 2 (equivalent to -r1..2)::
 
1865
 
 
1866
            bzr diff -c2
1826
1867
 
1827
1868
        Show just the differences for file NEWS::
1828
1869
 
1843
1884
        Same as 'bzr diff' but prefix paths with old/ and new/::
1844
1885
 
1845
1886
            bzr diff --prefix old/:new/
 
1887
            
 
1888
        Show the differences using a custom diff program with options::
 
1889
        
 
1890
            bzr diff --using /usr/bin/diff --diff-options -wu
1846
1891
    """
1847
1892
    _see_also = ['status']
1848
1893
    takes_args = ['file*']
1867
1912
            help='Use this command to compare files.',
1868
1913
            type=unicode,
1869
1914
            ),
 
1915
        RegistryOption('format',
 
1916
            help='Diff format to use.',
 
1917
            lazy_registry=('bzrlib.diff', 'format_registry'),
 
1918
            value_switches=False, title='Diff format'),
1870
1919
        ]
1871
1920
    aliases = ['di', 'dif']
1872
1921
    encoding_type = 'exact'
1873
1922
 
1874
1923
    @display_command
1875
1924
    def run(self, revision=None, file_list=None, diff_options=None,
1876
 
            prefix=None, old=None, new=None, using=None):
1877
 
        from bzrlib.diff import _get_trees_to_diff, show_diff_trees
 
1925
            prefix=None, old=None, new=None, using=None, format=None):
 
1926
        from bzrlib.diff import (get_trees_and_branches_to_diff_locked,
 
1927
            show_diff_trees)
1878
1928
 
1879
1929
        if (prefix is None) or (prefix == '0'):
1880
1930
            # diff -p0 format
1894
1944
            raise errors.BzrCommandError('bzr diff --revision takes exactly'
1895
1945
                                         ' one or two revision specifiers')
1896
1946
 
1897
 
        old_tree, new_tree, specific_files, extra_trees = \
1898
 
                _get_trees_to_diff(file_list, revision, old, new,
1899
 
                apply_view=True)
 
1947
        if using is not None and format is not None:
 
1948
            raise errors.BzrCommandError('--using and --format are mutually '
 
1949
                'exclusive.')
 
1950
 
 
1951
        (old_tree, new_tree,
 
1952
         old_branch, new_branch,
 
1953
         specific_files, extra_trees) = get_trees_and_branches_to_diff_locked(
 
1954
            file_list, revision, old, new, self.add_cleanup, apply_view=True)
 
1955
        # GNU diff on Windows uses ANSI encoding for filenames
 
1956
        path_encoding = osutils.get_diff_header_encoding()
1900
1957
        return show_diff_trees(old_tree, new_tree, sys.stdout,
1901
1958
                               specific_files=specific_files,
1902
1959
                               external_diff_options=diff_options,
1903
1960
                               old_label=old_label, new_label=new_label,
1904
 
                               extra_trees=extra_trees, using=using)
 
1961
                               extra_trees=extra_trees,
 
1962
                               path_encoding=path_encoding,
 
1963
                               using=using,
 
1964
                               format_cls=format)
1905
1965
 
1906
1966
 
1907
1967
class cmd_deleted(Command):
1908
 
    """List files deleted in the working tree.
 
1968
    __doc__ = """List files deleted in the working tree.
1909
1969
    """
1910
1970
    # TODO: Show files deleted since a previous revision, or
1911
1971
    # between two revisions.
1914
1974
    # level of effort but possibly much less IO.  (Or possibly not,
1915
1975
    # if the directories are very large...)
1916
1976
    _see_also = ['status', 'ls']
1917
 
    takes_options = ['show-ids']
 
1977
    takes_options = ['directory', 'show-ids']
1918
1978
 
1919
1979
    @display_command
1920
 
    def run(self, show_ids=False):
1921
 
        tree = WorkingTree.open_containing(u'.')[0]
1922
 
        tree.lock_read()
1923
 
        try:
1924
 
            old = tree.basis_tree()
1925
 
            old.lock_read()
1926
 
            try:
1927
 
                for path, ie in old.inventory.iter_entries():
1928
 
                    if not tree.has_id(ie.file_id):
1929
 
                        self.outf.write(path)
1930
 
                        if show_ids:
1931
 
                            self.outf.write(' ')
1932
 
                            self.outf.write(ie.file_id)
1933
 
                        self.outf.write('\n')
1934
 
            finally:
1935
 
                old.unlock()
1936
 
        finally:
1937
 
            tree.unlock()
 
1980
    def run(self, show_ids=False, directory=u'.'):
 
1981
        tree = WorkingTree.open_containing(directory)[0]
 
1982
        self.add_cleanup(tree.lock_read().unlock)
 
1983
        old = tree.basis_tree()
 
1984
        self.add_cleanup(old.lock_read().unlock)
 
1985
        for path, ie in old.inventory.iter_entries():
 
1986
            if not tree.has_id(ie.file_id):
 
1987
                self.outf.write(path)
 
1988
                if show_ids:
 
1989
                    self.outf.write(' ')
 
1990
                    self.outf.write(ie.file_id)
 
1991
                self.outf.write('\n')
1938
1992
 
1939
1993
 
1940
1994
class cmd_modified(Command):
1941
 
    """List files modified in working tree.
 
1995
    __doc__ = """List files modified in working tree.
1942
1996
    """
1943
1997
 
1944
1998
    hidden = True
1945
1999
    _see_also = ['status', 'ls']
1946
 
    takes_options = [
1947
 
            Option('null',
1948
 
                   help='Write an ascii NUL (\\0) separator '
1949
 
                   'between files rather than a newline.')
1950
 
            ]
 
2000
    takes_options = ['directory', 'null']
1951
2001
 
1952
2002
    @display_command
1953
 
    def run(self, null=False):
1954
 
        tree = WorkingTree.open_containing(u'.')[0]
 
2003
    def run(self, null=False, directory=u'.'):
 
2004
        tree = WorkingTree.open_containing(directory)[0]
1955
2005
        td = tree.changes_from(tree.basis_tree())
1956
2006
        for path, id, kind, text_modified, meta_modified in td.modified:
1957
2007
            if null:
1961
2011
 
1962
2012
 
1963
2013
class cmd_added(Command):
1964
 
    """List files added in working tree.
 
2014
    __doc__ = """List files added in working tree.
1965
2015
    """
1966
2016
 
1967
2017
    hidden = True
1968
2018
    _see_also = ['status', 'ls']
1969
 
    takes_options = [
1970
 
            Option('null',
1971
 
                   help='Write an ascii NUL (\\0) separator '
1972
 
                   'between files rather than a newline.')
1973
 
            ]
 
2019
    takes_options = ['directory', 'null']
1974
2020
 
1975
2021
    @display_command
1976
 
    def run(self, null=False):
1977
 
        wt = WorkingTree.open_containing(u'.')[0]
1978
 
        wt.lock_read()
1979
 
        try:
1980
 
            basis = wt.basis_tree()
1981
 
            basis.lock_read()
1982
 
            try:
1983
 
                basis_inv = basis.inventory
1984
 
                inv = wt.inventory
1985
 
                for file_id in inv:
1986
 
                    if file_id in basis_inv:
1987
 
                        continue
1988
 
                    if inv.is_root(file_id) and len(basis_inv) == 0:
1989
 
                        continue
1990
 
                    path = inv.id2path(file_id)
1991
 
                    if not os.access(osutils.abspath(path), os.F_OK):
1992
 
                        continue
1993
 
                    if null:
1994
 
                        self.outf.write(path + '\0')
1995
 
                    else:
1996
 
                        self.outf.write(osutils.quotefn(path) + '\n')
1997
 
            finally:
1998
 
                basis.unlock()
1999
 
        finally:
2000
 
            wt.unlock()
 
2022
    def run(self, null=False, directory=u'.'):
 
2023
        wt = WorkingTree.open_containing(directory)[0]
 
2024
        self.add_cleanup(wt.lock_read().unlock)
 
2025
        basis = wt.basis_tree()
 
2026
        self.add_cleanup(basis.lock_read().unlock)
 
2027
        basis_inv = basis.inventory
 
2028
        inv = wt.inventory
 
2029
        for file_id in inv:
 
2030
            if file_id in basis_inv:
 
2031
                continue
 
2032
            if inv.is_root(file_id) and len(basis_inv) == 0:
 
2033
                continue
 
2034
            path = inv.id2path(file_id)
 
2035
            if not os.access(osutils.pathjoin(wt.basedir, path), os.F_OK):
 
2036
                continue
 
2037
            if null:
 
2038
                self.outf.write(path + '\0')
 
2039
            else:
 
2040
                self.outf.write(osutils.quotefn(path) + '\n')
2001
2041
 
2002
2042
 
2003
2043
class cmd_root(Command):
2004
 
    """Show the tree root directory.
 
2044
    __doc__ = """Show the tree root directory.
2005
2045
 
2006
2046
    The root is the nearest enclosing directory with a .bzr control
2007
2047
    directory."""
2031
2071
 
2032
2072
 
2033
2073
class cmd_log(Command):
2034
 
    """Show historical log for a branch or subset of a branch.
 
2074
    __doc__ = """Show historical log for a branch or subset of a branch.
2035
2075
 
2036
2076
    log is bzr's default tool for exploring the history of a branch.
2037
2077
    The branch to use is taken from the first parameter. If no parameters
2148
2188
    :Tips & tricks:
2149
2189
 
2150
2190
      GUI tools and IDEs are often better at exploring history than command
2151
 
      line tools. You may prefer qlog or glog from the QBzr and Bzr-Gtk packages
2152
 
      respectively for example. (TortoiseBzr uses qlog for displaying logs.) See
2153
 
      http://bazaar-vcs.org/BzrPlugins and http://bazaar-vcs.org/IDEIntegration.
2154
 
 
2155
 
      Web interfaces are often better at exploring history than command line
2156
 
      tools, particularly for branches on servers. You may prefer Loggerhead
2157
 
      or one of its alternatives. See http://bazaar-vcs.org/WebInterface.
 
2191
      line tools: you may prefer qlog or viz from qbzr or bzr-gtk, the
 
2192
      bzr-explorer shell, or the Loggerhead web interface.  See the Plugin
 
2193
      Guide <http://doc.bazaar.canonical.com/plugins/en/> and
 
2194
      <http://wiki.bazaar.canonical.com/IDEIntegration>.  
2158
2195
 
2159
2196
      You may find it useful to add the aliases below to ``bazaar.conf``::
2160
2197
 
2201
2238
                   help='Show just the specified revision.'
2202
2239
                   ' See also "help revisionspec".'),
2203
2240
            'log-format',
 
2241
            RegistryOption('authors',
 
2242
                'What names to list as authors - first, all or committer.',
 
2243
                title='Authors',
 
2244
                lazy_registry=('bzrlib.log', 'author_list_registry'),
 
2245
            ),
2204
2246
            Option('levels',
2205
2247
                   short_name='n',
2206
2248
                   help='Number of levels to display - 0 for all, 1 for flat.',
2221
2263
                   help='Show changes made in each revision as a patch.'),
2222
2264
            Option('include-merges',
2223
2265
                   help='Show merged revisions like --levels 0 does.'),
 
2266
            Option('exclude-common-ancestry',
 
2267
                   help='Display only the revisions that are not part'
 
2268
                   ' of both ancestries (require -rX..Y)'
 
2269
                   )
2224
2270
            ]
2225
2271
    encoding_type = 'replace'
2226
2272
 
2236
2282
            message=None,
2237
2283
            limit=None,
2238
2284
            show_diff=False,
2239
 
            include_merges=False):
 
2285
            include_merges=False,
 
2286
            authors=None,
 
2287
            exclude_common_ancestry=False,
 
2288
            ):
2240
2289
        from bzrlib.log import (
2241
2290
            Logger,
2242
2291
            make_log_request_dict,
2243
2292
            _get_info_for_log_files,
2244
2293
            )
2245
2294
        direction = (forward and 'forward') or 'reverse'
 
2295
        if (exclude_common_ancestry
 
2296
            and (revision is None or len(revision) != 2)):
 
2297
            raise errors.BzrCommandError(
 
2298
                '--exclude-common-ancestry requires -r with two revisions')
2246
2299
        if include_merges:
2247
2300
            if levels is None:
2248
2301
                levels = 0
2263
2316
        filter_by_dir = False
2264
2317
        if file_list:
2265
2318
            # find the file ids to log and check for directory filtering
2266
 
            b, file_info_list, rev1, rev2 = _get_info_for_log_files(revision,
2267
 
                file_list)
 
2319
            b, file_info_list, rev1, rev2 = _get_info_for_log_files(
 
2320
                revision, file_list, self.add_cleanup)
2268
2321
            for relpath, file_id, kind in file_info_list:
2269
2322
                if file_id is None:
2270
2323
                    raise errors.BzrCommandError(
2288
2341
                location = '.'
2289
2342
            dir, relpath = bzrdir.BzrDir.open_containing(location)
2290
2343
            b = dir.open_branch()
 
2344
            self.add_cleanup(b.lock_read().unlock)
2291
2345
            rev1, rev2 = _get_revision_range(revision, b, self.name())
2292
2346
 
2293
2347
        # Decide on the type of delta & diff filtering to use
2303
2357
        else:
2304
2358
            diff_type = 'full'
2305
2359
 
2306
 
        b.lock_read()
2307
 
        try:
2308
 
            # Build the log formatter
2309
 
            if log_format is None:
2310
 
                log_format = log.log_formatter_registry.get_default(b)
2311
 
            lf = log_format(show_ids=show_ids, to_file=self.outf,
2312
 
                            show_timezone=timezone,
2313
 
                            delta_format=get_verbosity_level(),
2314
 
                            levels=levels,
2315
 
                            show_advice=levels is None)
2316
 
 
2317
 
            # Choose the algorithm for doing the logging. It's annoying
2318
 
            # having multiple code paths like this but necessary until
2319
 
            # the underlying repository format is faster at generating
2320
 
            # deltas or can provide everything we need from the indices.
2321
 
            # The default algorithm - match-using-deltas - works for
2322
 
            # multiple files and directories and is faster for small
2323
 
            # amounts of history (200 revisions say). However, it's too
2324
 
            # slow for logging a single file in a repository with deep
2325
 
            # history, i.e. > 10K revisions. In the spirit of "do no
2326
 
            # evil when adding features", we continue to use the
2327
 
            # original algorithm - per-file-graph - for the "single
2328
 
            # file that isn't a directory without showing a delta" case.
2329
 
            partial_history = revision and b.repository._format.supports_chks
2330
 
            match_using_deltas = (len(file_ids) != 1 or filter_by_dir
2331
 
                or delta_type or partial_history)
2332
 
 
2333
 
            # Build the LogRequest and execute it
2334
 
            if len(file_ids) == 0:
2335
 
                file_ids = None
2336
 
            rqst = make_log_request_dict(
2337
 
                direction=direction, specific_fileids=file_ids,
2338
 
                start_revision=rev1, end_revision=rev2, limit=limit,
2339
 
                message_search=message, delta_type=delta_type,
2340
 
                diff_type=diff_type, _match_using_deltas=match_using_deltas)
2341
 
            Logger(b, rqst).show(lf)
2342
 
        finally:
2343
 
            b.unlock()
 
2360
        # Build the log formatter
 
2361
        if log_format is None:
 
2362
            log_format = log.log_formatter_registry.get_default(b)
 
2363
        # Make a non-encoding output to include the diffs - bug 328007
 
2364
        unencoded_output = ui.ui_factory.make_output_stream(encoding_type='exact')
 
2365
        lf = log_format(show_ids=show_ids, to_file=self.outf,
 
2366
                        to_exact_file=unencoded_output,
 
2367
                        show_timezone=timezone,
 
2368
                        delta_format=get_verbosity_level(),
 
2369
                        levels=levels,
 
2370
                        show_advice=levels is None,
 
2371
                        author_list_handler=authors)
 
2372
 
 
2373
        # Choose the algorithm for doing the logging. It's annoying
 
2374
        # having multiple code paths like this but necessary until
 
2375
        # the underlying repository format is faster at generating
 
2376
        # deltas or can provide everything we need from the indices.
 
2377
        # The default algorithm - match-using-deltas - works for
 
2378
        # multiple files and directories and is faster for small
 
2379
        # amounts of history (200 revisions say). However, it's too
 
2380
        # slow for logging a single file in a repository with deep
 
2381
        # history, i.e. > 10K revisions. In the spirit of "do no
 
2382
        # evil when adding features", we continue to use the
 
2383
        # original algorithm - per-file-graph - for the "single
 
2384
        # file that isn't a directory without showing a delta" case.
 
2385
        partial_history = revision and b.repository._format.supports_chks
 
2386
        match_using_deltas = (len(file_ids) != 1 or filter_by_dir
 
2387
            or delta_type or partial_history)
 
2388
 
 
2389
        # Build the LogRequest and execute it
 
2390
        if len(file_ids) == 0:
 
2391
            file_ids = None
 
2392
        rqst = make_log_request_dict(
 
2393
            direction=direction, specific_fileids=file_ids,
 
2394
            start_revision=rev1, end_revision=rev2, limit=limit,
 
2395
            message_search=message, delta_type=delta_type,
 
2396
            diff_type=diff_type, _match_using_deltas=match_using_deltas,
 
2397
            exclude_common_ancestry=exclude_common_ancestry,
 
2398
            )
 
2399
        Logger(b, rqst).show(lf)
2344
2400
 
2345
2401
 
2346
2402
def _get_revision_range(revisionspec_list, branch, command_name):
2364
2420
            raise errors.BzrCommandError(
2365
2421
                "bzr %s doesn't accept two revisions in different"
2366
2422
                " branches." % command_name)
2367
 
        rev1 = start_spec.in_history(branch)
 
2423
        if start_spec.spec is None:
 
2424
            # Avoid loading all the history.
 
2425
            rev1 = RevisionInfo(branch, None, None)
 
2426
        else:
 
2427
            rev1 = start_spec.in_history(branch)
2368
2428
        # Avoid loading all of history when we know a missing
2369
2429
        # end of range means the last revision ...
2370
2430
        if end_spec.spec is None:
2399
2459
 
2400
2460
 
2401
2461
class cmd_touching_revisions(Command):
2402
 
    """Return revision-ids which affected a particular file.
 
2462
    __doc__ = """Return revision-ids which affected a particular file.
2403
2463
 
2404
2464
    A more user-friendly interface is "bzr log FILE".
2405
2465
    """
2410
2470
    @display_command
2411
2471
    def run(self, filename):
2412
2472
        tree, relpath = WorkingTree.open_containing(filename)
 
2473
        file_id = tree.path2id(relpath)
2413
2474
        b = tree.branch
2414
 
        file_id = tree.path2id(relpath)
2415
 
        for revno, revision_id, what in log.find_touching_revisions(b, file_id):
 
2475
        self.add_cleanup(b.lock_read().unlock)
 
2476
        touching_revs = log.find_touching_revisions(b, file_id)
 
2477
        for revno, revision_id, what in touching_revs:
2416
2478
            self.outf.write("%6d %s\n" % (revno, what))
2417
2479
 
2418
2480
 
2419
2481
class cmd_ls(Command):
2420
 
    """List files in a tree.
 
2482
    __doc__ = """List files in a tree.
2421
2483
    """
2422
2484
 
2423
2485
    _see_also = ['status', 'cat']
2429
2491
                   help='Recurse into subdirectories.'),
2430
2492
            Option('from-root',
2431
2493
                   help='Print paths relative to the root of the branch.'),
2432
 
            Option('unknown', help='Print unknown files.'),
 
2494
            Option('unknown', short_name='u',
 
2495
                help='Print unknown files.'),
2433
2496
            Option('versioned', help='Print versioned files.',
2434
2497
                   short_name='V'),
2435
 
            Option('ignored', help='Print ignored files.'),
2436
 
            Option('null',
2437
 
                   help='Write an ascii NUL (\\0) separator '
2438
 
                   'between files rather than a newline.'),
2439
 
            Option('kind',
 
2498
            Option('ignored', short_name='i',
 
2499
                help='Print ignored files.'),
 
2500
            Option('kind', short_name='k',
2440
2501
                   help='List entries of a particular kind: file, directory, symlink.',
2441
2502
                   type=unicode),
 
2503
            'null',
2442
2504
            'show-ids',
 
2505
            'directory',
2443
2506
            ]
2444
2507
    @display_command
2445
2508
    def run(self, revision=None, verbose=False,
2446
2509
            recursive=False, from_root=False,
2447
2510
            unknown=False, versioned=False, ignored=False,
2448
 
            null=False, kind=None, show_ids=False, path=None):
 
2511
            null=False, kind=None, show_ids=False, path=None, directory=None):
2449
2512
 
2450
2513
        if kind and kind not in ('file', 'directory', 'symlink'):
2451
2514
            raise errors.BzrCommandError('invalid kind specified')
2463
2526
                raise errors.BzrCommandError('cannot specify both --from-root'
2464
2527
                                             ' and PATH')
2465
2528
            fs_path = path
2466
 
        tree, branch, relpath = bzrdir.BzrDir.open_containing_tree_or_branch(
2467
 
            fs_path)
 
2529
        tree, branch, relpath = \
 
2530
            _open_directory_or_containing_tree_or_branch(fs_path, directory)
2468
2531
 
2469
2532
        # Calculate the prefix to use
2470
2533
        prefix = None
2471
2534
        if from_root:
2472
2535
            if relpath:
2473
2536
                prefix = relpath + '/'
2474
 
        elif fs_path != '.':
 
2537
        elif fs_path != '.' and not fs_path.endswith('/'):
2475
2538
            prefix = fs_path + '/'
2476
2539
 
2477
2540
        if revision is not None or tree is None:
2485
2548
                view_str = views.view_display_str(view_files)
2486
2549
                note("Ignoring files outside view. View is %s" % view_str)
2487
2550
 
2488
 
        tree.lock_read()
2489
 
        try:
2490
 
            for fp, fc, fkind, fid, entry in tree.list_files(include_root=False,
2491
 
                from_dir=relpath, recursive=recursive):
2492
 
                # Apply additional masking
2493
 
                if not all and not selection[fc]:
2494
 
                    continue
2495
 
                if kind is not None and fkind != kind:
2496
 
                    continue
2497
 
                if apply_view:
2498
 
                    try:
2499
 
                        if relpath:
2500
 
                            fullpath = osutils.pathjoin(relpath, fp)
2501
 
                        else:
2502
 
                            fullpath = fp
2503
 
                        views.check_path_in_view(tree, fullpath)
2504
 
                    except errors.FileOutsideView:
2505
 
                        continue
 
2551
        self.add_cleanup(tree.lock_read().unlock)
 
2552
        for fp, fc, fkind, fid, entry in tree.list_files(include_root=False,
 
2553
            from_dir=relpath, recursive=recursive):
 
2554
            # Apply additional masking
 
2555
            if not all and not selection[fc]:
 
2556
                continue
 
2557
            if kind is not None and fkind != kind:
 
2558
                continue
 
2559
            if apply_view:
 
2560
                try:
 
2561
                    if relpath:
 
2562
                        fullpath = osutils.pathjoin(relpath, fp)
 
2563
                    else:
 
2564
                        fullpath = fp
 
2565
                    views.check_path_in_view(tree, fullpath)
 
2566
                except errors.FileOutsideView:
 
2567
                    continue
2506
2568
 
2507
 
                # Output the entry
2508
 
                if prefix:
2509
 
                    fp = osutils.pathjoin(prefix, fp)
2510
 
                kindch = entry.kind_character()
2511
 
                outstring = fp + kindch
2512
 
                ui.ui_factory.clear_term()
2513
 
                if verbose:
2514
 
                    outstring = '%-8s %s' % (fc, outstring)
2515
 
                    if show_ids and fid is not None:
2516
 
                        outstring = "%-50s %s" % (outstring, fid)
 
2569
            # Output the entry
 
2570
            if prefix:
 
2571
                fp = osutils.pathjoin(prefix, fp)
 
2572
            kindch = entry.kind_character()
 
2573
            outstring = fp + kindch
 
2574
            ui.ui_factory.clear_term()
 
2575
            if verbose:
 
2576
                outstring = '%-8s %s' % (fc, outstring)
 
2577
                if show_ids and fid is not None:
 
2578
                    outstring = "%-50s %s" % (outstring, fid)
 
2579
                self.outf.write(outstring + '\n')
 
2580
            elif null:
 
2581
                self.outf.write(fp + '\0')
 
2582
                if show_ids:
 
2583
                    if fid is not None:
 
2584
                        self.outf.write(fid)
 
2585
                    self.outf.write('\0')
 
2586
                self.outf.flush()
 
2587
            else:
 
2588
                if show_ids:
 
2589
                    if fid is not None:
 
2590
                        my_id = fid
 
2591
                    else:
 
2592
                        my_id = ''
 
2593
                    self.outf.write('%-50s %s\n' % (outstring, my_id))
 
2594
                else:
2517
2595
                    self.outf.write(outstring + '\n')
2518
 
                elif null:
2519
 
                    self.outf.write(fp + '\0')
2520
 
                    if show_ids:
2521
 
                        if fid is not None:
2522
 
                            self.outf.write(fid)
2523
 
                        self.outf.write('\0')
2524
 
                    self.outf.flush()
2525
 
                else:
2526
 
                    if show_ids:
2527
 
                        if fid is not None:
2528
 
                            my_id = fid
2529
 
                        else:
2530
 
                            my_id = ''
2531
 
                        self.outf.write('%-50s %s\n' % (outstring, my_id))
2532
 
                    else:
2533
 
                        self.outf.write(outstring + '\n')
2534
 
        finally:
2535
 
            tree.unlock()
2536
2596
 
2537
2597
 
2538
2598
class cmd_unknowns(Command):
2539
 
    """List unknown files.
 
2599
    __doc__ = """List unknown files.
2540
2600
    """
2541
2601
 
2542
2602
    hidden = True
2543
2603
    _see_also = ['ls']
 
2604
    takes_options = ['directory']
2544
2605
 
2545
2606
    @display_command
2546
 
    def run(self):
2547
 
        for f in WorkingTree.open_containing(u'.')[0].unknowns():
 
2607
    def run(self, directory=u'.'):
 
2608
        for f in WorkingTree.open_containing(directory)[0].unknowns():
2548
2609
            self.outf.write(osutils.quotefn(f) + '\n')
2549
2610
 
2550
2611
 
2551
2612
class cmd_ignore(Command):
2552
 
    """Ignore specified files or patterns.
 
2613
    __doc__ = """Ignore specified files or patterns.
2553
2614
 
2554
2615
    See ``bzr help patterns`` for details on the syntax of patterns.
2555
2616
 
 
2617
    If a .bzrignore file does not exist, the ignore command
 
2618
    will create one and add the specified files or patterns to the newly
 
2619
    created file. The ignore command will also automatically add the 
 
2620
    .bzrignore file to be versioned. Creating a .bzrignore file without
 
2621
    the use of the ignore command will require an explicit add command.
 
2622
 
2556
2623
    To remove patterns from the ignore list, edit the .bzrignore file.
2557
2624
    After adding, editing or deleting that file either indirectly by
2558
2625
    using this command or directly by using an editor, be sure to commit
2559
2626
    it.
 
2627
    
 
2628
    Bazaar also supports a global ignore file ~/.bazaar/ignore. On Windows
 
2629
    the global ignore file can be found in the application data directory as
 
2630
    C:\\Documents and Settings\\<user>\\Application Data\\Bazaar\\2.0\\ignore.
 
2631
    Global ignores are not touched by this command. The global ignore file
 
2632
    can be edited directly using an editor.
 
2633
 
 
2634
    Patterns prefixed with '!' are exceptions to ignore patterns and take
 
2635
    precedence over regular ignores.  Such exceptions are used to specify
 
2636
    files that should be versioned which would otherwise be ignored.
 
2637
    
 
2638
    Patterns prefixed with '!!' act as regular ignore patterns, but have
 
2639
    precedence over the '!' exception patterns.
2560
2640
 
2561
2641
    Note: ignore patterns containing shell wildcards must be quoted from
2562
2642
    the shell on Unix.
2566
2646
 
2567
2647
            bzr ignore ./Makefile
2568
2648
 
2569
 
        Ignore class files in all directories::
 
2649
        Ignore .class files in all directories...::
2570
2650
 
2571
2651
            bzr ignore "*.class"
2572
2652
 
 
2653
        ...but do not ignore "special.class"::
 
2654
 
 
2655
            bzr ignore "!special.class"
 
2656
 
2573
2657
        Ignore .o files under the lib directory::
2574
2658
 
2575
2659
            bzr ignore "lib/**/*.o"
2581
2665
        Ignore everything but the "debian" toplevel directory::
2582
2666
 
2583
2667
            bzr ignore "RE:(?!debian/).*"
 
2668
        
 
2669
        Ignore everything except the "local" toplevel directory,
 
2670
        but always ignore "*~" autosave files, even under local/::
 
2671
        
 
2672
            bzr ignore "*"
 
2673
            bzr ignore "!./local"
 
2674
            bzr ignore "!!*~"
2584
2675
    """
2585
2676
 
2586
2677
    _see_also = ['status', 'ignored', 'patterns']
2587
2678
    takes_args = ['name_pattern*']
2588
 
    takes_options = [
2589
 
        Option('old-default-rules',
2590
 
               help='Write out the ignore rules bzr < 0.9 always used.')
 
2679
    takes_options = ['directory',
 
2680
        Option('default-rules',
 
2681
               help='Display the default ignore rules that bzr uses.')
2591
2682
        ]
2592
2683
 
2593
 
    def run(self, name_pattern_list=None, old_default_rules=None):
 
2684
    def run(self, name_pattern_list=None, default_rules=None,
 
2685
            directory=u'.'):
2594
2686
        from bzrlib import ignores
2595
 
        if old_default_rules is not None:
2596
 
            # dump the rules and exit
2597
 
            for pattern in ignores.OLD_DEFAULTS:
2598
 
                print pattern
 
2687
        if default_rules is not None:
 
2688
            # dump the default rules and exit
 
2689
            for pattern in ignores.USER_DEFAULTS:
 
2690
                self.outf.write("%s\n" % pattern)
2599
2691
            return
2600
2692
        if not name_pattern_list:
2601
2693
            raise errors.BzrCommandError("ignore requires at least one "
2602
 
                                  "NAME_PATTERN or --old-default-rules")
 
2694
                "NAME_PATTERN or --default-rules.")
2603
2695
        name_pattern_list = [globbing.normalize_pattern(p)
2604
2696
                             for p in name_pattern_list]
 
2697
        bad_patterns = ''
 
2698
        for p in name_pattern_list:
 
2699
            if not globbing.Globster.is_pattern_valid(p):
 
2700
                bad_patterns += ('\n  %s' % p)
 
2701
        if bad_patterns:
 
2702
            msg = ('Invalid ignore pattern(s) found. %s' % bad_patterns)
 
2703
            ui.ui_factory.show_error(msg)
 
2704
            raise errors.InvalidPattern('')
2605
2705
        for name_pattern in name_pattern_list:
2606
2706
            if (name_pattern[0] == '/' or
2607
2707
                (len(name_pattern) > 1 and name_pattern[1] == ':')):
2608
2708
                raise errors.BzrCommandError(
2609
2709
                    "NAME_PATTERN should not be an absolute path")
2610
 
        tree, relpath = WorkingTree.open_containing(u'.')
 
2710
        tree, relpath = WorkingTree.open_containing(directory)
2611
2711
        ignores.tree_ignores_add_patterns(tree, name_pattern_list)
2612
2712
        ignored = globbing.Globster(name_pattern_list)
2613
2713
        matches = []
2614
 
        tree.lock_read()
 
2714
        self.add_cleanup(tree.lock_read().unlock)
2615
2715
        for entry in tree.list_files():
2616
2716
            id = entry[3]
2617
2717
            if id is not None:
2618
2718
                filename = entry[0]
2619
2719
                if ignored.match(filename):
2620
 
                    matches.append(filename.encode('utf-8'))
2621
 
        tree.unlock()
 
2720
                    matches.append(filename)
2622
2721
        if len(matches) > 0:
2623
 
            print "Warning: the following files are version controlled and" \
2624
 
                  " match your ignore pattern:\n%s" \
2625
 
                  "\nThese files will continue to be version controlled" \
2626
 
                  " unless you 'bzr remove' them." % ("\n".join(matches),)
 
2722
            self.outf.write("Warning: the following files are version controlled and"
 
2723
                  " match your ignore pattern:\n%s"
 
2724
                  "\nThese files will continue to be version controlled"
 
2725
                  " unless you 'bzr remove' them.\n" % ("\n".join(matches),))
2627
2726
 
2628
2727
 
2629
2728
class cmd_ignored(Command):
2630
 
    """List ignored files and the patterns that matched them.
 
2729
    __doc__ = """List ignored files and the patterns that matched them.
2631
2730
 
2632
2731
    List all the ignored files and the ignore pattern that caused the file to
2633
2732
    be ignored.
2639
2738
 
2640
2739
    encoding_type = 'replace'
2641
2740
    _see_also = ['ignore', 'ls']
 
2741
    takes_options = ['directory']
2642
2742
 
2643
2743
    @display_command
2644
 
    def run(self):
2645
 
        tree = WorkingTree.open_containing(u'.')[0]
2646
 
        tree.lock_read()
2647
 
        try:
2648
 
            for path, file_class, kind, file_id, entry in tree.list_files():
2649
 
                if file_class != 'I':
2650
 
                    continue
2651
 
                ## XXX: Slightly inefficient since this was already calculated
2652
 
                pat = tree.is_ignored(path)
2653
 
                self.outf.write('%-50s %s\n' % (path, pat))
2654
 
        finally:
2655
 
            tree.unlock()
 
2744
    def run(self, directory=u'.'):
 
2745
        tree = WorkingTree.open_containing(directory)[0]
 
2746
        self.add_cleanup(tree.lock_read().unlock)
 
2747
        for path, file_class, kind, file_id, entry in tree.list_files():
 
2748
            if file_class != 'I':
 
2749
                continue
 
2750
            ## XXX: Slightly inefficient since this was already calculated
 
2751
            pat = tree.is_ignored(path)
 
2752
            self.outf.write('%-50s %s\n' % (path, pat))
2656
2753
 
2657
2754
 
2658
2755
class cmd_lookup_revision(Command):
2659
 
    """Lookup the revision-id from a revision-number
 
2756
    __doc__ = """Lookup the revision-id from a revision-number
2660
2757
 
2661
2758
    :Examples:
2662
2759
        bzr lookup-revision 33
2663
2760
    """
2664
2761
    hidden = True
2665
2762
    takes_args = ['revno']
 
2763
    takes_options = ['directory']
2666
2764
 
2667
2765
    @display_command
2668
 
    def run(self, revno):
 
2766
    def run(self, revno, directory=u'.'):
2669
2767
        try:
2670
2768
            revno = int(revno)
2671
2769
        except ValueError:
2672
 
            raise errors.BzrCommandError("not a valid revision-number: %r" % revno)
2673
 
 
2674
 
        print WorkingTree.open_containing(u'.')[0].branch.get_rev_id(revno)
 
2770
            raise errors.BzrCommandError("not a valid revision-number: %r"
 
2771
                                         % revno)
 
2772
        revid = WorkingTree.open_containing(directory)[0].branch.get_rev_id(revno)
 
2773
        self.outf.write("%s\n" % revid)
2675
2774
 
2676
2775
 
2677
2776
class cmd_export(Command):
2678
 
    """Export current or past revision to a destination directory or archive.
 
2777
    __doc__ = """Export current or past revision to a destination directory or archive.
2679
2778
 
2680
2779
    If no revision is specified this exports the last committed revision.
2681
2780
 
2703
2802
      =================       =========================
2704
2803
    """
2705
2804
    takes_args = ['dest', 'branch_or_subdir?']
2706
 
    takes_options = [
 
2805
    takes_options = ['directory',
2707
2806
        Option('format',
2708
2807
               help="Type of file to export to.",
2709
2808
               type=unicode),
2713
2812
        Option('root',
2714
2813
               type=str,
2715
2814
               help="Name of the root directory inside the exported file."),
 
2815
        Option('per-file-timestamps',
 
2816
               help='Set modification time of files to that of the last '
 
2817
                    'revision in which it was changed.'),
2716
2818
        ]
2717
2819
    def run(self, dest, branch_or_subdir=None, revision=None, format=None,
2718
 
        root=None, filters=False):
 
2820
        root=None, filters=False, per_file_timestamps=False, directory=u'.'):
2719
2821
        from bzrlib.export import export
2720
2822
 
2721
2823
        if branch_or_subdir is None:
2722
 
            tree = WorkingTree.open_containing(u'.')[0]
 
2824
            tree = WorkingTree.open_containing(directory)[0]
2723
2825
            b = tree.branch
2724
2826
            subdir = None
2725
2827
        else:
2728
2830
 
2729
2831
        rev_tree = _get_one_revision_tree('export', revision, branch=b, tree=tree)
2730
2832
        try:
2731
 
            export(rev_tree, dest, format, root, subdir, filtered=filters)
 
2833
            export(rev_tree, dest, format, root, subdir, filtered=filters,
 
2834
                   per_file_timestamps=per_file_timestamps)
2732
2835
        except errors.NoSuchExportFormat, e:
2733
2836
            raise errors.BzrCommandError('Unsupported export format: %s' % e.format)
2734
2837
 
2735
2838
 
2736
2839
class cmd_cat(Command):
2737
 
    """Write the contents of a file as of a given revision to standard output.
 
2840
    __doc__ = """Write the contents of a file as of a given revision to standard output.
2738
2841
 
2739
2842
    If no revision is nominated, the last revision is used.
2740
2843
 
2743
2846
    """
2744
2847
 
2745
2848
    _see_also = ['ls']
2746
 
    takes_options = [
 
2849
    takes_options = ['directory',
2747
2850
        Option('name-from-revision', help='The path name in the old tree.'),
2748
2851
        Option('filters', help='Apply content filters to display the '
2749
2852
                'convenience form.'),
2754
2857
 
2755
2858
    @display_command
2756
2859
    def run(self, filename, revision=None, name_from_revision=False,
2757
 
            filters=False):
 
2860
            filters=False, directory=None):
2758
2861
        if revision is not None and len(revision) != 1:
2759
2862
            raise errors.BzrCommandError("bzr cat --revision takes exactly"
2760
2863
                                         " one revision specifier")
2761
2864
        tree, branch, relpath = \
2762
 
            bzrdir.BzrDir.open_containing_tree_or_branch(filename)
2763
 
        branch.lock_read()
2764
 
        try:
2765
 
            return self._run(tree, branch, relpath, filename, revision,
2766
 
                             name_from_revision, filters)
2767
 
        finally:
2768
 
            branch.unlock()
 
2865
            _open_directory_or_containing_tree_or_branch(filename, directory)
 
2866
        self.add_cleanup(branch.lock_read().unlock)
 
2867
        return self._run(tree, branch, relpath, filename, revision,
 
2868
                         name_from_revision, filters)
2769
2869
 
2770
2870
    def _run(self, tree, b, relpath, filename, revision, name_from_revision,
2771
2871
        filtered):
2772
2872
        if tree is None:
2773
2873
            tree = b.basis_tree()
2774
2874
        rev_tree = _get_one_revision_tree('cat', revision, branch=b)
 
2875
        self.add_cleanup(rev_tree.lock_read().unlock)
2775
2876
 
2776
2877
        old_file_id = rev_tree.path2id(relpath)
2777
2878
 
2812
2913
            chunks = content.splitlines(True)
2813
2914
            content = filtered_output_bytes(chunks, filters,
2814
2915
                ContentFilterContext(relpath, rev_tree))
 
2916
            self.cleanup_now()
2815
2917
            self.outf.writelines(content)
2816
2918
        else:
 
2919
            self.cleanup_now()
2817
2920
            self.outf.write(content)
2818
2921
 
2819
2922
 
2820
2923
class cmd_local_time_offset(Command):
2821
 
    """Show the offset in seconds from GMT to local time."""
 
2924
    __doc__ = """Show the offset in seconds from GMT to local time."""
2822
2925
    hidden = True
2823
2926
    @display_command
2824
2927
    def run(self):
2825
 
        print osutils.local_time_offset()
 
2928
        self.outf.write("%s\n" % osutils.local_time_offset())
2826
2929
 
2827
2930
 
2828
2931
 
2829
2932
class cmd_commit(Command):
2830
 
    """Commit changes into a new revision.
 
2933
    __doc__ = """Commit changes into a new revision.
2831
2934
 
2832
2935
    An explanatory message needs to be given for each commit. This is
2833
2936
    often done by using the --message option (getting the message from the
2926
3029
             Option('strict',
2927
3030
                    help="Refuse to commit if there are unknown "
2928
3031
                    "files in the working tree."),
 
3032
             Option('commit-time', type=str,
 
3033
                    help="Manually set a commit time using commit date "
 
3034
                    "format, e.g. '2009-10-10 08:00:00 +0100'."),
2929
3035
             ListOption('fixes', type=str,
2930
3036
                    help="Mark a bug as being fixed by this revision "
2931
3037
                         "(see \"bzr help bugs\")."),
2938
3044
                         "the master branch until a normal commit "
2939
3045
                         "is performed."
2940
3046
                    ),
2941
 
              Option('show-diff',
2942
 
                     help='When no message is supplied, show the diff along'
2943
 
                     ' with the status summary in the message editor.'),
 
3047
             Option('show-diff', short_name='p',
 
3048
                    help='When no message is supplied, show the diff along'
 
3049
                    ' with the status summary in the message editor.'),
2944
3050
             ]
2945
3051
    aliases = ['ci', 'checkin']
2946
3052
 
2965
3071
 
2966
3072
    def run(self, message=None, file=None, verbose=False, selected_list=None,
2967
3073
            unchanged=False, strict=False, local=False, fixes=None,
2968
 
            author=None, show_diff=False, exclude=None):
 
3074
            author=None, show_diff=False, exclude=None, commit_time=None):
2969
3075
        from bzrlib.errors import (
2970
3076
            PointlessCommit,
2971
3077
            ConflictsInTree,
2977
3083
            make_commit_message_template_encoded
2978
3084
        )
2979
3085
 
 
3086
        commit_stamp = offset = None
 
3087
        if commit_time is not None:
 
3088
            try:
 
3089
                commit_stamp, offset = timestamp.parse_patch_date(commit_time)
 
3090
            except ValueError, e:
 
3091
                raise errors.BzrCommandError(
 
3092
                    "Could not parse --commit-time: " + str(e))
 
3093
 
2980
3094
        # TODO: Need a blackbox test for invoking the external editor; may be
2981
3095
        # slightly problematic to run this cross-platform.
2982
3096
 
2985
3099
 
2986
3100
        properties = {}
2987
3101
 
2988
 
        tree, selected_list = tree_files(selected_list)
 
3102
        tree, selected_list = WorkingTree.open_containing_paths(selected_list)
2989
3103
        if selected_list == ['']:
2990
3104
            # workaround - commit of root of tree should be exactly the same
2991
3105
            # as just default commit in that tree, and succeed even though
3002
3116
        if local and not tree.branch.get_bound_location():
3003
3117
            raise errors.LocalRequiresBoundBranch()
3004
3118
 
 
3119
        if message is not None:
 
3120
            try:
 
3121
                file_exists = osutils.lexists(message)
 
3122
            except UnicodeError:
 
3123
                # The commit message contains unicode characters that can't be
 
3124
                # represented in the filesystem encoding, so that can't be a
 
3125
                # file.
 
3126
                file_exists = False
 
3127
            if file_exists:
 
3128
                warning_msg = (
 
3129
                    'The commit message is a file name: "%(f)s".\n'
 
3130
                    '(use --file "%(f)s" to take commit message from that file)'
 
3131
                    % { 'f': message })
 
3132
                ui.ui_factory.show_warning(warning_msg)
 
3133
            if '\r' in message:
 
3134
                message = message.replace('\r\n', '\n')
 
3135
                message = message.replace('\r', '\n')
 
3136
            if file:
 
3137
                raise errors.BzrCommandError(
 
3138
                    "please specify either --message or --file")
 
3139
 
3005
3140
        def get_message(commit_obj):
3006
3141
            """Callback to get commit message"""
3007
 
            my_message = message
3008
 
            if my_message is None and not file:
3009
 
                t = make_commit_message_template_encoded(tree,
 
3142
            if file:
 
3143
                f = open(file)
 
3144
                try:
 
3145
                    my_message = f.read().decode(osutils.get_user_encoding())
 
3146
                finally:
 
3147
                    f.close()
 
3148
            elif message is not None:
 
3149
                my_message = message
 
3150
            else:
 
3151
                # No message supplied: make one up.
 
3152
                # text is the status of the tree
 
3153
                text = make_commit_message_template_encoded(tree,
3010
3154
                        selected_list, diff=show_diff,
3011
3155
                        output_encoding=osutils.get_user_encoding())
 
3156
                # start_message is the template generated from hooks
 
3157
                # XXX: Warning - looks like hooks return unicode,
 
3158
                # make_commit_message_template_encoded returns user encoding.
 
3159
                # We probably want to be using edit_commit_message instead to
 
3160
                # avoid this.
3012
3161
                start_message = generate_commit_message_template(commit_obj)
3013
 
                my_message = edit_commit_message_encoded(t,
 
3162
                my_message = edit_commit_message_encoded(text,
3014
3163
                    start_message=start_message)
3015
3164
                if my_message is None:
3016
3165
                    raise errors.BzrCommandError("please specify a commit"
3017
3166
                        " message with either --message or --file")
3018
 
            elif my_message and file:
3019
 
                raise errors.BzrCommandError(
3020
 
                    "please specify either --message or --file")
3021
 
            if file:
3022
 
                my_message = codecs.open(file, 'rt',
3023
 
                                         osutils.get_user_encoding()).read()
3024
3167
            if my_message == "":
3025
3168
                raise errors.BzrCommandError("empty commit message specified")
3026
3169
            return my_message
3027
3170
 
 
3171
        # The API permits a commit with a filter of [] to mean 'select nothing'
 
3172
        # but the command line should not do that.
 
3173
        if not selected_list:
 
3174
            selected_list = None
3028
3175
        try:
3029
3176
            tree.commit(message_callback=get_message,
3030
3177
                        specific_files=selected_list,
3031
3178
                        allow_pointless=unchanged, strict=strict, local=local,
3032
3179
                        reporter=None, verbose=verbose, revprops=properties,
3033
 
                        authors=author,
3034
 
                        exclude=safe_relpath_files(tree, exclude))
 
3180
                        authors=author, timestamp=commit_stamp,
 
3181
                        timezone=offset,
 
3182
                        exclude=tree.safe_relpath_files(exclude))
3035
3183
        except PointlessCommit:
3036
 
            # FIXME: This should really happen before the file is read in;
3037
 
            # perhaps prepare the commit; get the message; then actually commit
3038
3184
            raise errors.BzrCommandError("No changes to commit."
3039
3185
                              " Use --unchanged to commit anyhow.")
3040
3186
        except ConflictsInTree:
3045
3191
            raise errors.BzrCommandError("Commit refused because there are"
3046
3192
                              " unknown files in the working tree.")
3047
3193
        except errors.BoundBranchOutOfDate, e:
3048
 
            raise errors.BzrCommandError(str(e) + "\n"
3049
 
            'To commit to master branch, run update and then commit.\n'
3050
 
            'You can also pass --local to commit to continue working '
3051
 
            'disconnected.')
 
3194
            e.extra_help = ("\n"
 
3195
                'To commit to master branch, run update and then commit.\n'
 
3196
                'You can also pass --local to commit to continue working '
 
3197
                'disconnected.')
 
3198
            raise
3052
3199
 
3053
3200
 
3054
3201
class cmd_check(Command):
3055
 
    """Validate working tree structure, branch consistency and repository history.
 
3202
    __doc__ = """Validate working tree structure, branch consistency and repository history.
3056
3203
 
3057
3204
    This command checks various invariants about branch and repository storage
3058
3205
    to detect data corruption or bzr bugs.
3122
3269
 
3123
3270
 
3124
3271
class cmd_upgrade(Command):
3125
 
    """Upgrade branch storage to current format.
 
3272
    __doc__ = """Upgrade branch storage to current format.
3126
3273
 
3127
3274
    The check command or bzr developers may sometimes advise you to run
3128
3275
    this command. When the default format has changed you may also be warned
3146
3293
 
3147
3294
 
3148
3295
class cmd_whoami(Command):
3149
 
    """Show or set bzr user id.
 
3296
    __doc__ = """Show or set bzr user id.
3150
3297
 
3151
3298
    :Examples:
3152
3299
        Show the email of the current user::
3157
3304
 
3158
3305
            bzr whoami "Frank Chu <fchu@example.com>"
3159
3306
    """
3160
 
    takes_options = [ Option('email',
 
3307
    takes_options = [ 'directory',
 
3308
                      Option('email',
3161
3309
                             help='Display email address only.'),
3162
3310
                      Option('branch',
3163
3311
                             help='Set identity for the current branch instead of '
3167
3315
    encoding_type = 'replace'
3168
3316
 
3169
3317
    @display_command
3170
 
    def run(self, email=False, branch=False, name=None):
 
3318
    def run(self, email=False, branch=False, name=None, directory=None):
3171
3319
        if name is None:
3172
 
            # use branch if we're inside one; otherwise global config
3173
 
            try:
3174
 
                c = Branch.open_containing('.')[0].get_config()
3175
 
            except errors.NotBranchError:
3176
 
                c = config.GlobalConfig()
 
3320
            if directory is None:
 
3321
                # use branch if we're inside one; otherwise global config
 
3322
                try:
 
3323
                    c = Branch.open_containing(u'.')[0].get_config()
 
3324
                except errors.NotBranchError:
 
3325
                    c = _mod_config.GlobalConfig()
 
3326
            else:
 
3327
                c = Branch.open(directory).get_config()
3177
3328
            if email:
3178
3329
                self.outf.write(c.user_email() + '\n')
3179
3330
            else:
3182
3333
 
3183
3334
        # display a warning if an email address isn't included in the given name.
3184
3335
        try:
3185
 
            config.extract_email_address(name)
 
3336
            _mod_config.extract_email_address(name)
3186
3337
        except errors.NoEmailInUsername, e:
3187
3338
            warning('"%s" does not seem to contain an email address.  '
3188
3339
                    'This is allowed, but not recommended.', name)
3189
3340
 
3190
3341
        # use global config unless --branch given
3191
3342
        if branch:
3192
 
            c = Branch.open_containing('.')[0].get_config()
 
3343
            if directory is None:
 
3344
                c = Branch.open_containing(u'.')[0].get_config()
 
3345
            else:
 
3346
                c = Branch.open(directory).get_config()
3193
3347
        else:
3194
 
            c = config.GlobalConfig()
 
3348
            c = _mod_config.GlobalConfig()
3195
3349
        c.set_user_option('email', name)
3196
3350
 
3197
3351
 
3198
3352
class cmd_nick(Command):
3199
 
    """Print or set the branch nickname.
 
3353
    __doc__ = """Print or set the branch nickname.
3200
3354
 
3201
3355
    If unset, the tree root directory name is used as the nickname.
3202
3356
    To print the current nickname, execute with no argument.
3207
3361
 
3208
3362
    _see_also = ['info']
3209
3363
    takes_args = ['nickname?']
3210
 
    def run(self, nickname=None):
3211
 
        branch = Branch.open_containing(u'.')[0]
 
3364
    takes_options = ['directory']
 
3365
    def run(self, nickname=None, directory=u'.'):
 
3366
        branch = Branch.open_containing(directory)[0]
3212
3367
        if nickname is None:
3213
3368
            self.printme(branch)
3214
3369
        else:
3216
3371
 
3217
3372
    @display_command
3218
3373
    def printme(self, branch):
3219
 
        print branch.nick
 
3374
        self.outf.write('%s\n' % branch.nick)
3220
3375
 
3221
3376
 
3222
3377
class cmd_alias(Command):
3223
 
    """Set/unset and display aliases.
 
3378
    __doc__ = """Set/unset and display aliases.
3224
3379
 
3225
3380
    :Examples:
3226
3381
        Show the current aliases::
3263
3418
                'bzr alias --remove expects an alias to remove.')
3264
3419
        # If alias is not found, print something like:
3265
3420
        # unalias: foo: not found
3266
 
        c = config.GlobalConfig()
 
3421
        c = _mod_config.GlobalConfig()
3267
3422
        c.unset_alias(alias_name)
3268
3423
 
3269
3424
    @display_command
3270
3425
    def print_aliases(self):
3271
3426
        """Print out the defined aliases in a similar format to bash."""
3272
 
        aliases = config.GlobalConfig().get_aliases()
 
3427
        aliases = _mod_config.GlobalConfig().get_aliases()
3273
3428
        for key, value in sorted(aliases.iteritems()):
3274
3429
            self.outf.write('bzr alias %s="%s"\n' % (key, value))
3275
3430
 
3285
3440
 
3286
3441
    def set_alias(self, alias_name, alias_command):
3287
3442
        """Save the alias in the global config."""
3288
 
        c = config.GlobalConfig()
 
3443
        c = _mod_config.GlobalConfig()
3289
3444
        c.set_alias(alias_name, alias_command)
3290
3445
 
3291
3446
 
3292
3447
class cmd_selftest(Command):
3293
 
    """Run internal test suite.
 
3448
    __doc__ = """Run internal test suite.
3294
3449
 
3295
3450
    If arguments are given, they are regular expressions that say which tests
3296
3451
    should run.  Tests matching any expression are run, and other tests are
3323
3478
    Tests that need working space on disk use a common temporary directory,
3324
3479
    typically inside $TMPDIR or /tmp.
3325
3480
 
 
3481
    If you set BZR_TEST_PDB=1 when running selftest, failing tests will drop
 
3482
    into a pdb postmortem session.
 
3483
 
3326
3484
    :Examples:
3327
3485
        Run only tests relating to 'ignore'::
3328
3486
 
3337
3495
    def get_transport_type(typestring):
3338
3496
        """Parse and return a transport specifier."""
3339
3497
        if typestring == "sftp":
3340
 
            from bzrlib.transport.sftp import SFTPAbsoluteServer
3341
 
            return SFTPAbsoluteServer
 
3498
            from bzrlib.tests import stub_sftp
 
3499
            return stub_sftp.SFTPAbsoluteServer
3342
3500
        if typestring == "memory":
3343
 
            from bzrlib.transport.memory import MemoryServer
3344
 
            return MemoryServer
 
3501
            from bzrlib.tests import test_server
 
3502
            return memory.MemoryServer
3345
3503
        if typestring == "fakenfs":
3346
 
            from bzrlib.transport.fakenfs import FakeNFSServer
3347
 
            return FakeNFSServer
 
3504
            from bzrlib.tests import test_server
 
3505
            return test_server.FakeNFSServer
3348
3506
        msg = "No known transport type %s. Supported types are: sftp\n" %\
3349
3507
            (typestring)
3350
3508
        raise errors.BzrCommandError(msg)
3361
3519
                                 'throughout the test suite.',
3362
3520
                            type=get_transport_type),
3363
3521
                     Option('benchmark',
3364
 
                            help='Run the benchmarks rather than selftests.'),
 
3522
                            help='Run the benchmarks rather than selftests.',
 
3523
                            hidden=True),
3365
3524
                     Option('lsprof-timed',
3366
3525
                            help='Generate lsprof output for benchmarked'
3367
3526
                                 ' sections of code.'),
3368
 
                     Option('cache-dir', type=str,
3369
 
                            help='Cache intermediate benchmark output in this '
3370
 
                                 'directory.'),
 
3527
                     Option('lsprof-tests',
 
3528
                            help='Generate lsprof output for each test.'),
3371
3529
                     Option('first',
3372
3530
                            help='Run all tests, but run specified tests first.',
3373
3531
                            short_name='f',
3407
3565
 
3408
3566
    def run(self, testspecs_list=None, verbose=False, one=False,
3409
3567
            transport=None, benchmark=None,
3410
 
            lsprof_timed=None, cache_dir=None,
 
3568
            lsprof_timed=None,
3411
3569
            first=False, list_only=False,
3412
3570
            randomize=None, exclude=None, strict=False,
3413
3571
            load_list=None, debugflag=None, starting_with=None, subunit=False,
3414
 
            parallel=None):
3415
 
        from bzrlib.tests import selftest
3416
 
        import bzrlib.benchmarks as benchmarks
3417
 
        from bzrlib.benchmarks import tree_creator
 
3572
            parallel=None, lsprof_tests=False):
 
3573
        from bzrlib import tests
3418
3574
 
3419
3575
        # Make deprecation warnings visible, unless -Werror is set
3420
3576
        symbol_versioning.activate_deprecation_warnings(override=False)
3421
3577
 
3422
 
        if cache_dir is not None:
3423
 
            tree_creator.TreeCreator.CACHE_ROOT = osutils.abspath(cache_dir)
3424
3578
        if testspecs_list is not None:
3425
3579
            pattern = '|'.join(testspecs_list)
3426
3580
        else:
3432
3586
                raise errors.BzrCommandError("subunit not available. subunit "
3433
3587
                    "needs to be installed to use --subunit.")
3434
3588
            self.additional_selftest_args['runner_class'] = SubUnitBzrRunner
 
3589
            # On Windows, disable automatic conversion of '\n' to '\r\n' in
 
3590
            # stdout, which would corrupt the subunit stream. 
 
3591
            # FIXME: This has been fixed in subunit trunk (>0.0.5) so the
 
3592
            # following code can be deleted when it's sufficiently deployed
 
3593
            # -- vila/mgz 20100514
 
3594
            if (sys.platform == "win32"
 
3595
                and getattr(sys.stdout, 'fileno', None) is not None):
 
3596
                import msvcrt
 
3597
                msvcrt.setmode(sys.stdout.fileno(), os.O_BINARY)
3435
3598
        if parallel:
3436
3599
            self.additional_selftest_args.setdefault(
3437
3600
                'suite_decorators', []).append(parallel)
3438
3601
        if benchmark:
3439
 
            test_suite_factory = benchmarks.test_suite
3440
 
            # Unless user explicitly asks for quiet, be verbose in benchmarks
3441
 
            verbose = not is_quiet()
3442
 
            # TODO: should possibly lock the history file...
3443
 
            benchfile = open(".perf_history", "at", buffering=1)
3444
 
        else:
3445
 
            test_suite_factory = None
3446
 
            benchfile = None
3447
 
        try:
3448
 
            selftest_kwargs = {"verbose": verbose,
3449
 
                              "pattern": pattern,
3450
 
                              "stop_on_failure": one,
3451
 
                              "transport": transport,
3452
 
                              "test_suite_factory": test_suite_factory,
3453
 
                              "lsprof_timed": lsprof_timed,
3454
 
                              "bench_history": benchfile,
3455
 
                              "matching_tests_first": first,
3456
 
                              "list_only": list_only,
3457
 
                              "random_seed": randomize,
3458
 
                              "exclude_pattern": exclude,
3459
 
                              "strict": strict,
3460
 
                              "load_list": load_list,
3461
 
                              "debug_flags": debugflag,
3462
 
                              "starting_with": starting_with
3463
 
                              }
3464
 
            selftest_kwargs.update(self.additional_selftest_args)
3465
 
            result = selftest(**selftest_kwargs)
3466
 
        finally:
3467
 
            if benchfile is not None:
3468
 
                benchfile.close()
 
3602
            raise errors.BzrCommandError(
 
3603
                "--benchmark is no longer supported from bzr 2.2; "
 
3604
                "use bzr-usertest instead")
 
3605
        test_suite_factory = None
 
3606
        selftest_kwargs = {"verbose": verbose,
 
3607
                          "pattern": pattern,
 
3608
                          "stop_on_failure": one,
 
3609
                          "transport": transport,
 
3610
                          "test_suite_factory": test_suite_factory,
 
3611
                          "lsprof_timed": lsprof_timed,
 
3612
                          "lsprof_tests": lsprof_tests,
 
3613
                          "matching_tests_first": first,
 
3614
                          "list_only": list_only,
 
3615
                          "random_seed": randomize,
 
3616
                          "exclude_pattern": exclude,
 
3617
                          "strict": strict,
 
3618
                          "load_list": load_list,
 
3619
                          "debug_flags": debugflag,
 
3620
                          "starting_with": starting_with
 
3621
                          }
 
3622
        selftest_kwargs.update(self.additional_selftest_args)
 
3623
        result = tests.selftest(**selftest_kwargs)
3469
3624
        return int(not result)
3470
3625
 
3471
3626
 
3472
3627
class cmd_version(Command):
3473
 
    """Show version of bzr."""
 
3628
    __doc__ = """Show version of bzr."""
3474
3629
 
3475
3630
    encoding_type = 'replace'
3476
3631
    takes_options = [
3487
3642
 
3488
3643
 
3489
3644
class cmd_rocks(Command):
3490
 
    """Statement of optimism."""
 
3645
    __doc__ = """Statement of optimism."""
3491
3646
 
3492
3647
    hidden = True
3493
3648
 
3494
3649
    @display_command
3495
3650
    def run(self):
3496
 
        print "It sure does!"
 
3651
        self.outf.write("It sure does!\n")
3497
3652
 
3498
3653
 
3499
3654
class cmd_find_merge_base(Command):
3500
 
    """Find and print a base revision for merging two branches."""
 
3655
    __doc__ = """Find and print a base revision for merging two branches."""
3501
3656
    # TODO: Options to specify revisions on either side, as if
3502
3657
    #       merging only part of the history.
3503
3658
    takes_args = ['branch', 'other']
3509
3664
 
3510
3665
        branch1 = Branch.open_containing(branch)[0]
3511
3666
        branch2 = Branch.open_containing(other)[0]
3512
 
        branch1.lock_read()
3513
 
        try:
3514
 
            branch2.lock_read()
3515
 
            try:
3516
 
                last1 = ensure_null(branch1.last_revision())
3517
 
                last2 = ensure_null(branch2.last_revision())
3518
 
 
3519
 
                graph = branch1.repository.get_graph(branch2.repository)
3520
 
                base_rev_id = graph.find_unique_lca(last1, last2)
3521
 
 
3522
 
                print 'merge base is revision %s' % base_rev_id
3523
 
            finally:
3524
 
                branch2.unlock()
3525
 
        finally:
3526
 
            branch1.unlock()
 
3667
        self.add_cleanup(branch1.lock_read().unlock)
 
3668
        self.add_cleanup(branch2.lock_read().unlock)
 
3669
        last1 = ensure_null(branch1.last_revision())
 
3670
        last2 = ensure_null(branch2.last_revision())
 
3671
 
 
3672
        graph = branch1.repository.get_graph(branch2.repository)
 
3673
        base_rev_id = graph.find_unique_lca(last1, last2)
 
3674
 
 
3675
        self.outf.write('merge base is revision %s\n' % base_rev_id)
3527
3676
 
3528
3677
 
3529
3678
class cmd_merge(Command):
3530
 
    """Perform a three-way merge.
 
3679
    __doc__ = """Perform a three-way merge.
3531
3680
 
3532
3681
    The source of the merge can be specified either in the form of a branch,
3533
3682
    or in the form of a path to a file containing a merge directive generated
3562
3711
    committed to record the result of the merge.
3563
3712
 
3564
3713
    merge refuses to run if there are any uncommitted changes, unless
3565
 
    --force is given.
 
3714
    --force is given. The --force option can also be used to create a
 
3715
    merge revision which has more than two parents.
 
3716
 
 
3717
    If one would like to merge changes from the working tree of the other
 
3718
    branch without merging any committed revisions, the --uncommitted option
 
3719
    can be given.
3566
3720
 
3567
3721
    To select only some changes to merge, use "merge -i", which will prompt
3568
3722
    you to apply each diff hunk and file change, similar to "shelve".
3580
3734
 
3581
3735
            bzr merge -r 81..82 ../bzr.dev
3582
3736
 
3583
 
        To apply a merge directive contained in /tmp/merge:
 
3737
        To apply a merge directive contained in /tmp/merge::
3584
3738
 
3585
3739
            bzr merge /tmp/merge
 
3740
 
 
3741
        To create a merge revision with three parents from two branches
 
3742
        feature1a and feature1b:
 
3743
 
 
3744
            bzr merge ../feature1a
 
3745
            bzr merge ../feature1b --force
 
3746
            bzr commit -m 'revision with three parents'
3586
3747
    """
3587
3748
 
3588
3749
    encoding_type = 'exact'
3604
3765
                ' completely merged into the source, pull from the'
3605
3766
                ' source rather than merging.  When this happens,'
3606
3767
                ' you do not need to commit the result.'),
3607
 
        Option('directory',
 
3768
        custom_help('directory',
3608
3769
               help='Branch to merge into, '
3609
 
                    'rather than the one containing the working directory.',
3610
 
               short_name='d',
3611
 
               type=unicode,
3612
 
               ),
 
3770
                    'rather than the one containing the working directory.'),
3613
3771
        Option('preview', help='Instead of merging, show a diff of the'
3614
3772
               ' merge.'),
3615
3773
        Option('interactive', help='Select changes interactively.',
3633
3791
        verified = 'inapplicable'
3634
3792
        tree = WorkingTree.open_containing(directory)[0]
3635
3793
 
3636
 
        # die as quickly as possible if there are uncommitted changes
3637
3794
        try:
3638
3795
            basis_tree = tree.revision_tree(tree.last_revision())
3639
3796
        except errors.NoSuchRevision:
3640
3797
            basis_tree = tree.basis_tree()
 
3798
 
 
3799
        # die as quickly as possible if there are uncommitted changes
3641
3800
        if not force:
3642
 
            if tree.has_changes(basis_tree):
 
3801
            if tree.has_changes():
3643
3802
                raise errors.UncommittedChanges(tree)
3644
3803
 
3645
3804
        view_info = _get_view_info_for_change_reporter(tree)
3646
3805
        change_reporter = delta._ChangeReporter(
3647
3806
            unversioned_filter=tree.is_ignored, view_info=view_info)
3648
 
        cleanups = []
3649
 
        try:
3650
 
            pb = ui.ui_factory.nested_progress_bar()
3651
 
            cleanups.append(pb.finished)
3652
 
            tree.lock_write()
3653
 
            cleanups.append(tree.unlock)
3654
 
            if location is not None:
3655
 
                try:
3656
 
                    mergeable = bundle.read_mergeable_from_url(location,
3657
 
                        possible_transports=possible_transports)
3658
 
                except errors.NotABundle:
3659
 
                    mergeable = None
3660
 
                else:
3661
 
                    if uncommitted:
3662
 
                        raise errors.BzrCommandError('Cannot use --uncommitted'
3663
 
                            ' with bundles or merge directives.')
3664
 
 
3665
 
                    if revision is not None:
3666
 
                        raise errors.BzrCommandError(
3667
 
                            'Cannot use -r with merge directives or bundles')
3668
 
                    merger, verified = _mod_merge.Merger.from_mergeable(tree,
3669
 
                       mergeable, pb)
3670
 
 
3671
 
            if merger is None and uncommitted:
3672
 
                if revision is not None and len(revision) > 0:
3673
 
                    raise errors.BzrCommandError('Cannot use --uncommitted and'
3674
 
                        ' --revision at the same time.')
3675
 
                merger = self.get_merger_from_uncommitted(tree, location, pb,
3676
 
                                                          cleanups)
3677
 
                allow_pending = False
3678
 
 
3679
 
            if merger is None:
3680
 
                merger, allow_pending = self._get_merger_from_branch(tree,
3681
 
                    location, revision, remember, possible_transports, pb)
3682
 
 
3683
 
            merger.merge_type = merge_type
3684
 
            merger.reprocess = reprocess
3685
 
            merger.show_base = show_base
3686
 
            self.sanity_check_merger(merger)
3687
 
            if (merger.base_rev_id == merger.other_rev_id and
3688
 
                merger.other_rev_id is not None):
3689
 
                note('Nothing to do.')
 
3807
        pb = ui.ui_factory.nested_progress_bar()
 
3808
        self.add_cleanup(pb.finished)
 
3809
        self.add_cleanup(tree.lock_write().unlock)
 
3810
        if location is not None:
 
3811
            try:
 
3812
                mergeable = bundle.read_mergeable_from_url(location,
 
3813
                    possible_transports=possible_transports)
 
3814
            except errors.NotABundle:
 
3815
                mergeable = None
 
3816
            else:
 
3817
                if uncommitted:
 
3818
                    raise errors.BzrCommandError('Cannot use --uncommitted'
 
3819
                        ' with bundles or merge directives.')
 
3820
 
 
3821
                if revision is not None:
 
3822
                    raise errors.BzrCommandError(
 
3823
                        'Cannot use -r with merge directives or bundles')
 
3824
                merger, verified = _mod_merge.Merger.from_mergeable(tree,
 
3825
                   mergeable, None)
 
3826
 
 
3827
        if merger is None and uncommitted:
 
3828
            if revision is not None and len(revision) > 0:
 
3829
                raise errors.BzrCommandError('Cannot use --uncommitted and'
 
3830
                    ' --revision at the same time.')
 
3831
            merger = self.get_merger_from_uncommitted(tree, location, None)
 
3832
            allow_pending = False
 
3833
 
 
3834
        if merger is None:
 
3835
            merger, allow_pending = self._get_merger_from_branch(tree,
 
3836
                location, revision, remember, possible_transports, None)
 
3837
 
 
3838
        merger.merge_type = merge_type
 
3839
        merger.reprocess = reprocess
 
3840
        merger.show_base = show_base
 
3841
        self.sanity_check_merger(merger)
 
3842
        if (merger.base_rev_id == merger.other_rev_id and
 
3843
            merger.other_rev_id is not None):
 
3844
            note('Nothing to do.')
 
3845
            return 0
 
3846
        if pull:
 
3847
            if merger.interesting_files is not None:
 
3848
                raise errors.BzrCommandError('Cannot pull individual files')
 
3849
            if (merger.base_rev_id == tree.last_revision()):
 
3850
                result = tree.pull(merger.other_branch, False,
 
3851
                                   merger.other_rev_id)
 
3852
                result.report(self.outf)
3690
3853
                return 0
3691
 
            if pull:
3692
 
                if merger.interesting_files is not None:
3693
 
                    raise errors.BzrCommandError('Cannot pull individual files')
3694
 
                if (merger.base_rev_id == tree.last_revision()):
3695
 
                    result = tree.pull(merger.other_branch, False,
3696
 
                                       merger.other_rev_id)
3697
 
                    result.report(self.outf)
3698
 
                    return 0
3699
 
            merger.check_basis(False)
3700
 
            if preview:
3701
 
                return self._do_preview(merger, cleanups)
3702
 
            elif interactive:
3703
 
                return self._do_interactive(merger, cleanups)
3704
 
            else:
3705
 
                return self._do_merge(merger, change_reporter, allow_pending,
3706
 
                                      verified)
3707
 
        finally:
3708
 
            for cleanup in reversed(cleanups):
3709
 
                cleanup()
 
3854
        if merger.this_basis is None:
 
3855
            raise errors.BzrCommandError(
 
3856
                "This branch has no commits."
 
3857
                " (perhaps you would prefer 'bzr pull')")
 
3858
        if preview:
 
3859
            return self._do_preview(merger)
 
3860
        elif interactive:
 
3861
            return self._do_interactive(merger)
 
3862
        else:
 
3863
            return self._do_merge(merger, change_reporter, allow_pending,
 
3864
                                  verified)
3710
3865
 
3711
 
    def _get_preview(self, merger, cleanups):
 
3866
    def _get_preview(self, merger):
3712
3867
        tree_merger = merger.make_merger()
3713
3868
        tt = tree_merger.make_preview_transform()
3714
 
        cleanups.append(tt.finalize)
 
3869
        self.add_cleanup(tt.finalize)
3715
3870
        result_tree = tt.get_preview_tree()
3716
3871
        return result_tree
3717
3872
 
3718
 
    def _do_preview(self, merger, cleanups):
 
3873
    def _do_preview(self, merger):
3719
3874
        from bzrlib.diff import show_diff_trees
3720
 
        result_tree = self._get_preview(merger, cleanups)
 
3875
        result_tree = self._get_preview(merger)
 
3876
        path_encoding = osutils.get_diff_header_encoding()
3721
3877
        show_diff_trees(merger.this_tree, result_tree, self.outf,
3722
 
                        old_label='', new_label='')
 
3878
                        old_label='', new_label='',
 
3879
                        path_encoding=path_encoding)
3723
3880
 
3724
3881
    def _do_merge(self, merger, change_reporter, allow_pending, verified):
3725
3882
        merger.change_reporter = change_reporter
3733
3890
        else:
3734
3891
            return 0
3735
3892
 
3736
 
    def _do_interactive(self, merger, cleanups):
 
3893
    def _do_interactive(self, merger):
3737
3894
        """Perform an interactive merge.
3738
3895
 
3739
3896
        This works by generating a preview tree of the merge, then using
3741
3898
        and the preview tree.
3742
3899
        """
3743
3900
        from bzrlib import shelf_ui
3744
 
        result_tree = self._get_preview(merger, cleanups)
 
3901
        result_tree = self._get_preview(merger)
3745
3902
        writer = bzrlib.option.diff_writer_registry.get()
3746
3903
        shelver = shelf_ui.Shelver(merger.this_tree, result_tree, destroy=True,
3747
3904
                                   reporter=shelf_ui.ApplyReporter(),
3748
3905
                                   diff_writer=writer(sys.stdout))
3749
 
        shelver.run()
 
3906
        try:
 
3907
            shelver.run()
 
3908
        finally:
 
3909
            shelver.finalize()
3750
3910
 
3751
3911
    def sanity_check_merger(self, merger):
3752
3912
        if (merger.show_base and
3812
3972
            allow_pending = True
3813
3973
        return merger, allow_pending
3814
3974
 
3815
 
    def get_merger_from_uncommitted(self, tree, location, pb, cleanups):
 
3975
    def get_merger_from_uncommitted(self, tree, location, pb):
3816
3976
        """Get a merger for uncommitted changes.
3817
3977
 
3818
3978
        :param tree: The tree the merger should apply to.
3819
3979
        :param location: The location containing uncommitted changes.
3820
3980
        :param pb: The progress bar to use for showing progress.
3821
 
        :param cleanups: A list of operations to perform to clean up the
3822
 
            temporary directories, unfinalized objects, etc.
3823
3981
        """
3824
3982
        location = self._select_branch_location(tree, location)[0]
3825
3983
        other_tree, other_path = WorkingTree.open_containing(location)
3877
4035
 
3878
4036
 
3879
4037
class cmd_remerge(Command):
3880
 
    """Redo a merge.
 
4038
    __doc__ = """Redo a merge.
3881
4039
 
3882
4040
    Use this if you want to try a different merge technique while resolving
3883
4041
    conflicts.  Some merge techniques are better than others, and remerge
3908
4066
 
3909
4067
    def run(self, file_list=None, merge_type=None, show_base=False,
3910
4068
            reprocess=False):
 
4069
        from bzrlib.conflicts import restore
3911
4070
        if merge_type is None:
3912
4071
            merge_type = _mod_merge.Merge3Merger
3913
 
        tree, file_list = tree_files(file_list)
3914
 
        tree.lock_write()
3915
 
        try:
3916
 
            parents = tree.get_parent_ids()
3917
 
            if len(parents) != 2:
3918
 
                raise errors.BzrCommandError("Sorry, remerge only works after normal"
3919
 
                                             " merges.  Not cherrypicking or"
3920
 
                                             " multi-merges.")
3921
 
            repository = tree.branch.repository
3922
 
            interesting_ids = None
3923
 
            new_conflicts = []
3924
 
            conflicts = tree.conflicts()
3925
 
            if file_list is not None:
3926
 
                interesting_ids = set()
3927
 
                for filename in file_list:
3928
 
                    file_id = tree.path2id(filename)
3929
 
                    if file_id is None:
3930
 
                        raise errors.NotVersionedError(filename)
3931
 
                    interesting_ids.add(file_id)
3932
 
                    if tree.kind(file_id) != "directory":
3933
 
                        continue
 
4072
        tree, file_list = WorkingTree.open_containing_paths(file_list)
 
4073
        self.add_cleanup(tree.lock_write().unlock)
 
4074
        parents = tree.get_parent_ids()
 
4075
        if len(parents) != 2:
 
4076
            raise errors.BzrCommandError("Sorry, remerge only works after normal"
 
4077
                                         " merges.  Not cherrypicking or"
 
4078
                                         " multi-merges.")
 
4079
        repository = tree.branch.repository
 
4080
        interesting_ids = None
 
4081
        new_conflicts = []
 
4082
        conflicts = tree.conflicts()
 
4083
        if file_list is not None:
 
4084
            interesting_ids = set()
 
4085
            for filename in file_list:
 
4086
                file_id = tree.path2id(filename)
 
4087
                if file_id is None:
 
4088
                    raise errors.NotVersionedError(filename)
 
4089
                interesting_ids.add(file_id)
 
4090
                if tree.kind(file_id) != "directory":
 
4091
                    continue
3934
4092
 
3935
 
                    for name, ie in tree.inventory.iter_entries(file_id):
3936
 
                        interesting_ids.add(ie.file_id)
3937
 
                new_conflicts = conflicts.select_conflicts(tree, file_list)[0]
3938
 
            else:
3939
 
                # Remerge only supports resolving contents conflicts
3940
 
                allowed_conflicts = ('text conflict', 'contents conflict')
3941
 
                restore_files = [c.path for c in conflicts
3942
 
                                 if c.typestring in allowed_conflicts]
3943
 
            _mod_merge.transform_tree(tree, tree.basis_tree(), interesting_ids)
3944
 
            tree.set_conflicts(ConflictList(new_conflicts))
3945
 
            if file_list is not None:
3946
 
                restore_files = file_list
3947
 
            for filename in restore_files:
3948
 
                try:
3949
 
                    restore(tree.abspath(filename))
3950
 
                except errors.NotConflicted:
3951
 
                    pass
3952
 
            # Disable pending merges, because the file texts we are remerging
3953
 
            # have not had those merges performed.  If we use the wrong parents
3954
 
            # list, we imply that the working tree text has seen and rejected
3955
 
            # all the changes from the other tree, when in fact those changes
3956
 
            # have not yet been seen.
3957
 
            pb = ui.ui_factory.nested_progress_bar()
3958
 
            tree.set_parent_ids(parents[:1])
 
4093
                for name, ie in tree.inventory.iter_entries(file_id):
 
4094
                    interesting_ids.add(ie.file_id)
 
4095
            new_conflicts = conflicts.select_conflicts(tree, file_list)[0]
 
4096
        else:
 
4097
            # Remerge only supports resolving contents conflicts
 
4098
            allowed_conflicts = ('text conflict', 'contents conflict')
 
4099
            restore_files = [c.path for c in conflicts
 
4100
                             if c.typestring in allowed_conflicts]
 
4101
        _mod_merge.transform_tree(tree, tree.basis_tree(), interesting_ids)
 
4102
        tree.set_conflicts(ConflictList(new_conflicts))
 
4103
        if file_list is not None:
 
4104
            restore_files = file_list
 
4105
        for filename in restore_files:
3959
4106
            try:
3960
 
                merger = _mod_merge.Merger.from_revision_ids(pb,
3961
 
                                                             tree, parents[1])
3962
 
                merger.interesting_ids = interesting_ids
3963
 
                merger.merge_type = merge_type
3964
 
                merger.show_base = show_base
3965
 
                merger.reprocess = reprocess
3966
 
                conflicts = merger.do_merge()
3967
 
            finally:
3968
 
                tree.set_parent_ids(parents)
3969
 
                pb.finished()
 
4107
                restore(tree.abspath(filename))
 
4108
            except errors.NotConflicted:
 
4109
                pass
 
4110
        # Disable pending merges, because the file texts we are remerging
 
4111
        # have not had those merges performed.  If we use the wrong parents
 
4112
        # list, we imply that the working tree text has seen and rejected
 
4113
        # all the changes from the other tree, when in fact those changes
 
4114
        # have not yet been seen.
 
4115
        tree.set_parent_ids(parents[:1])
 
4116
        try:
 
4117
            merger = _mod_merge.Merger.from_revision_ids(None, tree, parents[1])
 
4118
            merger.interesting_ids = interesting_ids
 
4119
            merger.merge_type = merge_type
 
4120
            merger.show_base = show_base
 
4121
            merger.reprocess = reprocess
 
4122
            conflicts = merger.do_merge()
3970
4123
        finally:
3971
 
            tree.unlock()
 
4124
            tree.set_parent_ids(parents)
3972
4125
        if conflicts > 0:
3973
4126
            return 1
3974
4127
        else:
3976
4129
 
3977
4130
 
3978
4131
class cmd_revert(Command):
3979
 
    """Revert files to a previous revision.
 
4132
    __doc__ = """Revert files to a previous revision.
3980
4133
 
3981
4134
    Giving a list of files will revert only those files.  Otherwise, all files
3982
4135
    will be reverted.  If the revision is not specified with '--revision', the
3996
4149
    name.  If you name a directory, all the contents of that directory will be
3997
4150
    reverted.
3998
4151
 
3999
 
    Any files that have been newly added since that revision will be deleted,
4000
 
    with a backup kept if appropriate.  Directories containing unknown files
4001
 
    will not be deleted.
 
4152
    If you have newly added files since the target revision, they will be
 
4153
    removed.  If the files to be removed have been changed, backups will be
 
4154
    created as above.  Directories containing unknown files will not be
 
4155
    deleted.
4002
4156
 
4003
 
    The working tree contains a list of pending merged revisions, which will
4004
 
    be included as parents in the next commit.  Normally, revert clears that
4005
 
    list as well as reverting the files.  If any files are specified, revert
4006
 
    leaves the pending merge list alone and reverts only the files.  Use "bzr
4007
 
    revert ." in the tree root to revert all files but keep the merge record,
4008
 
    and "bzr revert --forget-merges" to clear the pending merge list without
 
4157
    The working tree contains a list of revisions that have been merged but
 
4158
    not yet committed. These revisions will be included as additional parents
 
4159
    of the next commit.  Normally, using revert clears that list as well as
 
4160
    reverting the files.  If any files are specified, revert leaves the list
 
4161
    of uncommitted merges alone and reverts only the files.  Use ``bzr revert
 
4162
    .`` in the tree root to revert all files but keep the recorded merges,
 
4163
    and ``bzr revert --forget-merges`` to clear the pending merge list without
4009
4164
    reverting any files.
 
4165
 
 
4166
    Using "bzr revert --forget-merges", it is possible to apply all of the
 
4167
    changes from a branch in a single revision.  To do this, perform the merge
 
4168
    as desired.  Then doing revert with the "--forget-merges" option will keep
 
4169
    the content of the tree as it was, but it will clear the list of pending
 
4170
    merges.  The next commit will then contain all of the changes that are
 
4171
    present in the other branch, but without any other parent revisions.
 
4172
    Because this technique forgets where these changes originated, it may
 
4173
    cause additional conflicts on later merges involving the same source and
 
4174
    target branches.
4010
4175
    """
4011
4176
 
4012
4177
    _see_also = ['cat', 'export']
4020
4185
 
4021
4186
    def run(self, revision=None, no_backup=False, file_list=None,
4022
4187
            forget_merges=None):
4023
 
        tree, file_list = tree_files(file_list)
4024
 
        tree.lock_write()
4025
 
        try:
4026
 
            if forget_merges:
4027
 
                tree.set_parent_ids(tree.get_parent_ids()[:1])
4028
 
            else:
4029
 
                self._revert_tree_to_revision(tree, revision, file_list, no_backup)
4030
 
        finally:
4031
 
            tree.unlock()
 
4188
        tree, file_list = WorkingTree.open_containing_paths(file_list)
 
4189
        self.add_cleanup(tree.lock_tree_write().unlock)
 
4190
        if forget_merges:
 
4191
            tree.set_parent_ids(tree.get_parent_ids()[:1])
 
4192
        else:
 
4193
            self._revert_tree_to_revision(tree, revision, file_list, no_backup)
4032
4194
 
4033
4195
    @staticmethod
4034
4196
    def _revert_tree_to_revision(tree, revision, file_list, no_backup):
4035
4197
        rev_tree = _get_one_revision_tree('revert', revision, tree=tree)
4036
 
        pb = ui.ui_factory.nested_progress_bar()
4037
 
        try:
4038
 
            tree.revert(file_list, rev_tree, not no_backup, pb,
4039
 
                report_changes=True)
4040
 
        finally:
4041
 
            pb.finished()
 
4198
        tree.revert(file_list, rev_tree, not no_backup, None,
 
4199
            report_changes=True)
4042
4200
 
4043
4201
 
4044
4202
class cmd_assert_fail(Command):
4045
 
    """Test reporting of assertion failures"""
 
4203
    __doc__ = """Test reporting of assertion failures"""
4046
4204
    # intended just for use in testing
4047
4205
 
4048
4206
    hidden = True
4052
4210
 
4053
4211
 
4054
4212
class cmd_help(Command):
4055
 
    """Show help on a command or other topic.
 
4213
    __doc__ = """Show help on a command or other topic.
4056
4214
    """
4057
4215
 
4058
4216
    _see_also = ['topics']
4071
4229
 
4072
4230
 
4073
4231
class cmd_shell_complete(Command):
4074
 
    """Show appropriate completions for context.
 
4232
    __doc__ = """Show appropriate completions for context.
4075
4233
 
4076
4234
    For a list of all available commands, say 'bzr shell-complete'.
4077
4235
    """
4086
4244
 
4087
4245
 
4088
4246
class cmd_missing(Command):
4089
 
    """Show unmerged/unpulled revisions between two branches.
 
4247
    __doc__ = """Show unmerged/unpulled revisions between two branches.
4090
4248
 
4091
4249
    OTHER_BRANCH may be local or remote.
4092
4250
 
4093
4251
    To filter on a range of revisions, you can use the command -r begin..end
4094
4252
    -r revision requests a specific revision, -r ..end or -r begin.. are
4095
4253
    also valid.
 
4254
            
 
4255
    :Exit values:
 
4256
        1 - some missing revisions
 
4257
        0 - no missing revisions
4096
4258
 
4097
4259
    :Examples:
4098
4260
 
4119
4281
    _see_also = ['merge', 'pull']
4120
4282
    takes_args = ['other_branch?']
4121
4283
    takes_options = [
 
4284
        'directory',
4122
4285
        Option('reverse', 'Reverse the order of revisions.'),
4123
4286
        Option('mine-only',
4124
4287
               'Display changes in the local branch only.'),
4146
4309
            theirs_only=False,
4147
4310
            log_format=None, long=False, short=False, line=False,
4148
4311
            show_ids=False, verbose=False, this=False, other=False,
4149
 
            include_merges=False, revision=None, my_revision=None):
 
4312
            include_merges=False, revision=None, my_revision=None,
 
4313
            directory=u'.'):
4150
4314
        from bzrlib.missing import find_unmerged, iter_log_revisions
4151
4315
        def message(s):
4152
4316
            if not is_quiet():
4165
4329
        elif theirs_only:
4166
4330
            restrict = 'remote'
4167
4331
 
4168
 
        local_branch = Branch.open_containing(u".")[0]
 
4332
        local_branch = Branch.open_containing(directory)[0]
 
4333
        self.add_cleanup(local_branch.lock_read().unlock)
 
4334
 
4169
4335
        parent = local_branch.get_parent()
4170
4336
        if other_branch is None:
4171
4337
            other_branch = parent
4180
4346
        remote_branch = Branch.open(other_branch)
4181
4347
        if remote_branch.base == local_branch.base:
4182
4348
            remote_branch = local_branch
 
4349
        else:
 
4350
            self.add_cleanup(remote_branch.lock_read().unlock)
4183
4351
 
4184
4352
        local_revid_range = _revision_range_to_revid_range(
4185
4353
            _get_revision_range(my_revision, local_branch,
4189
4357
            _get_revision_range(revision,
4190
4358
                remote_branch, self.name()))
4191
4359
 
4192
 
        local_branch.lock_read()
4193
 
        try:
4194
 
            remote_branch.lock_read()
4195
 
            try:
4196
 
                local_extra, remote_extra = find_unmerged(
4197
 
                    local_branch, remote_branch, restrict,
4198
 
                    backward=not reverse,
4199
 
                    include_merges=include_merges,
4200
 
                    local_revid_range=local_revid_range,
4201
 
                    remote_revid_range=remote_revid_range)
4202
 
 
4203
 
                if log_format is None:
4204
 
                    registry = log.log_formatter_registry
4205
 
                    log_format = registry.get_default(local_branch)
4206
 
                lf = log_format(to_file=self.outf,
4207
 
                                show_ids=show_ids,
4208
 
                                show_timezone='original')
4209
 
 
4210
 
                status_code = 0
4211
 
                if local_extra and not theirs_only:
4212
 
                    message("You have %d extra revision(s):\n" %
4213
 
                        len(local_extra))
4214
 
                    for revision in iter_log_revisions(local_extra,
4215
 
                                        local_branch.repository,
4216
 
                                        verbose):
4217
 
                        lf.log_revision(revision)
4218
 
                    printed_local = True
4219
 
                    status_code = 1
4220
 
                else:
4221
 
                    printed_local = False
4222
 
 
4223
 
                if remote_extra and not mine_only:
4224
 
                    if printed_local is True:
4225
 
                        message("\n\n\n")
4226
 
                    message("You are missing %d revision(s):\n" %
4227
 
                        len(remote_extra))
4228
 
                    for revision in iter_log_revisions(remote_extra,
4229
 
                                        remote_branch.repository,
4230
 
                                        verbose):
4231
 
                        lf.log_revision(revision)
4232
 
                    status_code = 1
4233
 
 
4234
 
                if mine_only and not local_extra:
4235
 
                    # We checked local, and found nothing extra
4236
 
                    message('This branch is up to date.\n')
4237
 
                elif theirs_only and not remote_extra:
4238
 
                    # We checked remote, and found nothing extra
4239
 
                    message('Other branch is up to date.\n')
4240
 
                elif not (mine_only or theirs_only or local_extra or
4241
 
                          remote_extra):
4242
 
                    # We checked both branches, and neither one had extra
4243
 
                    # revisions
4244
 
                    message("Branches are up to date.\n")
4245
 
            finally:
4246
 
                remote_branch.unlock()
4247
 
        finally:
4248
 
            local_branch.unlock()
 
4360
        local_extra, remote_extra = find_unmerged(
 
4361
            local_branch, remote_branch, restrict,
 
4362
            backward=not reverse,
 
4363
            include_merges=include_merges,
 
4364
            local_revid_range=local_revid_range,
 
4365
            remote_revid_range=remote_revid_range)
 
4366
 
 
4367
        if log_format is None:
 
4368
            registry = log.log_formatter_registry
 
4369
            log_format = registry.get_default(local_branch)
 
4370
        lf = log_format(to_file=self.outf,
 
4371
                        show_ids=show_ids,
 
4372
                        show_timezone='original')
 
4373
 
 
4374
        status_code = 0
 
4375
        if local_extra and not theirs_only:
 
4376
            message("You have %d extra revision(s):\n" %
 
4377
                len(local_extra))
 
4378
            for revision in iter_log_revisions(local_extra,
 
4379
                                local_branch.repository,
 
4380
                                verbose):
 
4381
                lf.log_revision(revision)
 
4382
            printed_local = True
 
4383
            status_code = 1
 
4384
        else:
 
4385
            printed_local = False
 
4386
 
 
4387
        if remote_extra and not mine_only:
 
4388
            if printed_local is True:
 
4389
                message("\n\n\n")
 
4390
            message("You are missing %d revision(s):\n" %
 
4391
                len(remote_extra))
 
4392
            for revision in iter_log_revisions(remote_extra,
 
4393
                                remote_branch.repository,
 
4394
                                verbose):
 
4395
                lf.log_revision(revision)
 
4396
            status_code = 1
 
4397
 
 
4398
        if mine_only and not local_extra:
 
4399
            # We checked local, and found nothing extra
 
4400
            message('This branch is up to date.\n')
 
4401
        elif theirs_only and not remote_extra:
 
4402
            # We checked remote, and found nothing extra
 
4403
            message('Other branch is up to date.\n')
 
4404
        elif not (mine_only or theirs_only or local_extra or
 
4405
                  remote_extra):
 
4406
            # We checked both branches, and neither one had extra
 
4407
            # revisions
 
4408
            message("Branches are up to date.\n")
 
4409
        self.cleanup_now()
4249
4410
        if not status_code and parent is None and other_branch is not None:
4250
 
            local_branch.lock_write()
4251
 
            try:
4252
 
                # handle race conditions - a parent might be set while we run.
4253
 
                if local_branch.get_parent() is None:
4254
 
                    local_branch.set_parent(remote_branch.base)
4255
 
            finally:
4256
 
                local_branch.unlock()
 
4411
            self.add_cleanup(local_branch.lock_write().unlock)
 
4412
            # handle race conditions - a parent might be set while we run.
 
4413
            if local_branch.get_parent() is None:
 
4414
                local_branch.set_parent(remote_branch.base)
4257
4415
        return status_code
4258
4416
 
4259
4417
 
4260
4418
class cmd_pack(Command):
4261
 
    """Compress the data within a repository."""
 
4419
    __doc__ = """Compress the data within a repository.
 
4420
 
 
4421
    This operation compresses the data within a bazaar repository. As
 
4422
    bazaar supports automatic packing of repository, this operation is
 
4423
    normally not required to be done manually.
 
4424
 
 
4425
    During the pack operation, bazaar takes a backup of existing repository
 
4426
    data, i.e. pack files. This backup is eventually removed by bazaar
 
4427
    automatically when it is safe to do so. To save disk space by removing
 
4428
    the backed up pack files, the --clean-obsolete-packs option may be
 
4429
    used.
 
4430
 
 
4431
    Warning: If you use --clean-obsolete-packs and your machine crashes
 
4432
    during or immediately after repacking, you may be left with a state
 
4433
    where the deletion has been written to disk but the new packs have not
 
4434
    been. In this case the repository may be unusable.
 
4435
    """
4262
4436
 
4263
4437
    _see_also = ['repositories']
4264
4438
    takes_args = ['branch_or_repo?']
 
4439
    takes_options = [
 
4440
        Option('clean-obsolete-packs', 'Delete obsolete packs to save disk space.'),
 
4441
        ]
4265
4442
 
4266
 
    def run(self, branch_or_repo='.'):
 
4443
    def run(self, branch_or_repo='.', clean_obsolete_packs=False):
4267
4444
        dir = bzrdir.BzrDir.open_containing(branch_or_repo)[0]
4268
4445
        try:
4269
4446
            branch = dir.open_branch()
4270
4447
            repository = branch.repository
4271
4448
        except errors.NotBranchError:
4272
4449
            repository = dir.open_repository()
4273
 
        repository.pack()
 
4450
        repository.pack(clean_obsolete_packs=clean_obsolete_packs)
4274
4451
 
4275
4452
 
4276
4453
class cmd_plugins(Command):
4277
 
    """List the installed plugins.
 
4454
    __doc__ = """List the installed plugins.
4278
4455
 
4279
4456
    This command displays the list of installed plugins including
4280
4457
    version of plugin and a short description of each.
4287
4464
    adding new commands, providing additional network transports and
4288
4465
    customizing log output.
4289
4466
 
4290
 
    See the Bazaar web site, http://bazaar-vcs.org, for further
4291
 
    information on plugins including where to find them and how to
4292
 
    install them. Instructions are also provided there on how to
4293
 
    write new plugins using the Python programming language.
 
4467
    See the Bazaar Plugin Guide <http://doc.bazaar.canonical.com/plugins/en/>
 
4468
    for further information on plugins including where to find them and how to
 
4469
    install them. Instructions are also provided there on how to write new
 
4470
    plugins using the Python programming language.
4294
4471
    """
4295
4472
    takes_options = ['verbose']
4296
4473
 
4311
4488
                doc = '(no description)'
4312
4489
            result.append((name_ver, doc, plugin.path()))
4313
4490
        for name_ver, doc, path in sorted(result):
4314
 
            print name_ver
4315
 
            print '   ', doc
 
4491
            self.outf.write("%s\n" % name_ver)
 
4492
            self.outf.write("   %s\n" % doc)
4316
4493
            if verbose:
4317
 
                print '   ', path
4318
 
            print
 
4494
                self.outf.write("   %s\n" % path)
 
4495
            self.outf.write("\n")
4319
4496
 
4320
4497
 
4321
4498
class cmd_testament(Command):
4322
 
    """Show testament (signing-form) of a revision."""
 
4499
    __doc__ = """Show testament (signing-form) of a revision."""
4323
4500
    takes_options = [
4324
4501
            'revision',
4325
4502
            Option('long', help='Produce long-format testament.'),
4337
4514
            b = Branch.open_containing(branch)[0]
4338
4515
        else:
4339
4516
            b = Branch.open(branch)
4340
 
        b.lock_read()
4341
 
        try:
4342
 
            if revision is None:
4343
 
                rev_id = b.last_revision()
4344
 
            else:
4345
 
                rev_id = revision[0].as_revision_id(b)
4346
 
            t = testament_class.from_revision(b.repository, rev_id)
4347
 
            if long:
4348
 
                sys.stdout.writelines(t.as_text_lines())
4349
 
            else:
4350
 
                sys.stdout.write(t.as_short_text())
4351
 
        finally:
4352
 
            b.unlock()
 
4517
        self.add_cleanup(b.lock_read().unlock)
 
4518
        if revision is None:
 
4519
            rev_id = b.last_revision()
 
4520
        else:
 
4521
            rev_id = revision[0].as_revision_id(b)
 
4522
        t = testament_class.from_revision(b.repository, rev_id)
 
4523
        if long:
 
4524
            sys.stdout.writelines(t.as_text_lines())
 
4525
        else:
 
4526
            sys.stdout.write(t.as_short_text())
4353
4527
 
4354
4528
 
4355
4529
class cmd_annotate(Command):
4356
 
    """Show the origin of each line in a file.
 
4530
    __doc__ = """Show the origin of each line in a file.
4357
4531
 
4358
4532
    This prints out the given file with an annotation on the left side
4359
4533
    indicating which revision, author and date introduced the change.
4370
4544
                     Option('long', help='Show commit date in annotations.'),
4371
4545
                     'revision',
4372
4546
                     'show-ids',
 
4547
                     'directory',
4373
4548
                     ]
4374
4549
    encoding_type = 'exact'
4375
4550
 
4376
4551
    @display_command
4377
4552
    def run(self, filename, all=False, long=False, revision=None,
4378
 
            show_ids=False):
 
4553
            show_ids=False, directory=None):
4379
4554
        from bzrlib.annotate import annotate_file, annotate_file_tree
4380
4555
        wt, branch, relpath = \
4381
 
            bzrdir.BzrDir.open_containing_tree_or_branch(filename)
4382
 
        if wt is not None:
4383
 
            wt.lock_read()
4384
 
        else:
4385
 
            branch.lock_read()
4386
 
        try:
4387
 
            tree = _get_one_revision_tree('annotate', revision, branch=branch)
4388
 
            if wt is not None:
4389
 
                file_id = wt.path2id(relpath)
4390
 
            else:
4391
 
                file_id = tree.path2id(relpath)
4392
 
            if file_id is None:
4393
 
                raise errors.NotVersionedError(filename)
4394
 
            file_version = tree.inventory[file_id].revision
4395
 
            if wt is not None and revision is None:
4396
 
                # If there is a tree and we're not annotating historical
4397
 
                # versions, annotate the working tree's content.
4398
 
                annotate_file_tree(wt, file_id, self.outf, long, all,
4399
 
                    show_ids=show_ids)
4400
 
            else:
4401
 
                annotate_file(branch, file_version, file_id, long, all, self.outf,
4402
 
                              show_ids=show_ids)
4403
 
        finally:
4404
 
            if wt is not None:
4405
 
                wt.unlock()
4406
 
            else:
4407
 
                branch.unlock()
 
4556
            _open_directory_or_containing_tree_or_branch(filename, directory)
 
4557
        if wt is not None:
 
4558
            self.add_cleanup(wt.lock_read().unlock)
 
4559
        else:
 
4560
            self.add_cleanup(branch.lock_read().unlock)
 
4561
        tree = _get_one_revision_tree('annotate', revision, branch=branch)
 
4562
        self.add_cleanup(tree.lock_read().unlock)
 
4563
        if wt is not None:
 
4564
            file_id = wt.path2id(relpath)
 
4565
        else:
 
4566
            file_id = tree.path2id(relpath)
 
4567
        if file_id is None:
 
4568
            raise errors.NotVersionedError(filename)
 
4569
        file_version = tree.inventory[file_id].revision
 
4570
        if wt is not None and revision is None:
 
4571
            # If there is a tree and we're not annotating historical
 
4572
            # versions, annotate the working tree's content.
 
4573
            annotate_file_tree(wt, file_id, self.outf, long, all,
 
4574
                show_ids=show_ids)
 
4575
        else:
 
4576
            annotate_file(branch, file_version, file_id, long, all, self.outf,
 
4577
                          show_ids=show_ids)
4408
4578
 
4409
4579
 
4410
4580
class cmd_re_sign(Command):
4411
 
    """Create a digital signature for an existing revision."""
 
4581
    __doc__ = """Create a digital signature for an existing revision."""
4412
4582
    # TODO be able to replace existing ones.
4413
4583
 
4414
4584
    hidden = True # is this right ?
4415
4585
    takes_args = ['revision_id*']
4416
 
    takes_options = ['revision']
 
4586
    takes_options = ['directory', 'revision']
4417
4587
 
4418
 
    def run(self, revision_id_list=None, revision=None):
 
4588
    def run(self, revision_id_list=None, revision=None, directory=u'.'):
4419
4589
        if revision_id_list is not None and revision is not None:
4420
4590
            raise errors.BzrCommandError('You can only supply one of revision_id or --revision')
4421
4591
        if revision_id_list is None and revision is None:
4422
4592
            raise errors.BzrCommandError('You must supply either --revision or a revision_id')
4423
 
        b = WorkingTree.open_containing(u'.')[0].branch
4424
 
        b.lock_write()
4425
 
        try:
4426
 
            return self._run(b, revision_id_list, revision)
4427
 
        finally:
4428
 
            b.unlock()
 
4593
        b = WorkingTree.open_containing(directory)[0].branch
 
4594
        self.add_cleanup(b.lock_write().unlock)
 
4595
        return self._run(b, revision_id_list, revision)
4429
4596
 
4430
4597
    def _run(self, b, revision_id_list, revision):
4431
4598
        import bzrlib.gpg as gpg
4476
4643
 
4477
4644
 
4478
4645
class cmd_bind(Command):
4479
 
    """Convert the current branch into a checkout of the supplied branch.
 
4646
    __doc__ = """Convert the current branch into a checkout of the supplied branch.
 
4647
    If no branch is supplied, rebind to the last bound location.
4480
4648
 
4481
4649
    Once converted into a checkout, commits must succeed on the master branch
4482
4650
    before they will be applied to the local branch.
4483
4651
 
4484
4652
    Bound branches use the nickname of its master branch unless it is set
4485
 
    locally, in which case binding will update the the local nickname to be
 
4653
    locally, in which case binding will update the local nickname to be
4486
4654
    that of the master.
4487
4655
    """
4488
4656
 
4489
4657
    _see_also = ['checkouts', 'unbind']
4490
4658
    takes_args = ['location?']
4491
 
    takes_options = []
 
4659
    takes_options = ['directory']
4492
4660
 
4493
 
    def run(self, location=None):
4494
 
        b, relpath = Branch.open_containing(u'.')
 
4661
    def run(self, location=None, directory=u'.'):
 
4662
        b, relpath = Branch.open_containing(directory)
4495
4663
        if location is None:
4496
4664
            try:
4497
4665
                location = b.get_old_bound_location()
4500
4668
                    'This format does not remember old locations.')
4501
4669
            else:
4502
4670
                if location is None:
4503
 
                    raise errors.BzrCommandError('No location supplied and no '
4504
 
                        'previous location known')
 
4671
                    if b.get_bound_location() is not None:
 
4672
                        raise errors.BzrCommandError('Branch is already bound')
 
4673
                    else:
 
4674
                        raise errors.BzrCommandError('No location supplied '
 
4675
                            'and no previous location known')
4505
4676
        b_other = Branch.open(location)
4506
4677
        try:
4507
4678
            b.bind(b_other)
4513
4684
 
4514
4685
 
4515
4686
class cmd_unbind(Command):
4516
 
    """Convert the current checkout into a regular branch.
 
4687
    __doc__ = """Convert the current checkout into a regular branch.
4517
4688
 
4518
4689
    After unbinding, the local branch is considered independent and subsequent
4519
4690
    commits will be local only.
4521
4692
 
4522
4693
    _see_also = ['checkouts', 'bind']
4523
4694
    takes_args = []
4524
 
    takes_options = []
 
4695
    takes_options = ['directory']
4525
4696
 
4526
 
    def run(self):
4527
 
        b, relpath = Branch.open_containing(u'.')
 
4697
    def run(self, directory=u'.'):
 
4698
        b, relpath = Branch.open_containing(directory)
4528
4699
        if not b.unbind():
4529
4700
            raise errors.BzrCommandError('Local branch is not bound')
4530
4701
 
4531
4702
 
4532
4703
class cmd_uncommit(Command):
4533
 
    """Remove the last committed revision.
 
4704
    __doc__ = """Remove the last committed revision.
4534
4705
 
4535
4706
    --verbose will print out what is being removed.
4536
4707
    --dry-run will go through all the motions, but not actually
4576
4747
            b = control.open_branch()
4577
4748
 
4578
4749
        if tree is not None:
4579
 
            tree.lock_write()
 
4750
            self.add_cleanup(tree.lock_write().unlock)
4580
4751
        else:
4581
 
            b.lock_write()
4582
 
        try:
4583
 
            return self._run(b, tree, dry_run, verbose, revision, force,
4584
 
                             local=local)
4585
 
        finally:
4586
 
            if tree is not None:
4587
 
                tree.unlock()
4588
 
            else:
4589
 
                b.unlock()
 
4752
            self.add_cleanup(b.lock_write().unlock)
 
4753
        return self._run(b, tree, dry_run, verbose, revision, force, local=local)
4590
4754
 
4591
4755
    def _run(self, b, tree, dry_run, verbose, revision, force, local=False):
4592
4756
        from bzrlib.log import log_formatter, show_log
4624
4788
                 end_revision=last_revno)
4625
4789
 
4626
4790
        if dry_run:
4627
 
            print 'Dry-run, pretending to remove the above revisions.'
4628
 
            if not force:
4629
 
                val = raw_input('Press <enter> to continue')
 
4791
            self.outf.write('Dry-run, pretending to remove'
 
4792
                            ' the above revisions.\n')
4630
4793
        else:
4631
 
            print 'The above revision(s) will be removed.'
4632
 
            if not force:
4633
 
                val = raw_input('Are you sure [y/N]? ')
4634
 
                if val.lower() not in ('y', 'yes'):
4635
 
                    print 'Canceled'
4636
 
                    return 0
 
4794
            self.outf.write('The above revision(s) will be removed.\n')
 
4795
 
 
4796
        if not force:
 
4797
            if not ui.ui_factory.get_boolean('Are you sure'):
 
4798
                self.outf.write('Canceled')
 
4799
                return 0
4637
4800
 
4638
4801
        mutter('Uncommitting from {%s} to {%s}',
4639
4802
               last_rev_id, rev_id)
4640
4803
        uncommit(b, tree=tree, dry_run=dry_run, verbose=verbose,
4641
4804
                 revno=revno, local=local)
4642
 
        note('You can restore the old tip by running:\n'
4643
 
             '  bzr pull . -r revid:%s', last_rev_id)
 
4805
        self.outf.write('You can restore the old tip by running:\n'
 
4806
             '  bzr pull . -r revid:%s\n' % last_rev_id)
4644
4807
 
4645
4808
 
4646
4809
class cmd_break_lock(Command):
4647
 
    """Break a dead lock on a repository, branch or working directory.
 
4810
    __doc__ = """Break a dead lock.
 
4811
 
 
4812
    This command breaks a lock on a repository, branch, working directory or
 
4813
    config file.
4648
4814
 
4649
4815
    CAUTION: Locks should only be broken when you are sure that the process
4650
4816
    holding the lock has been stopped.
4651
4817
 
4652
 
    You can get information on what locks are open via the 'bzr info' command.
 
4818
    You can get information on what locks are open via the 'bzr info
 
4819
    [location]' command.
4653
4820
 
4654
4821
    :Examples:
4655
4822
        bzr break-lock
 
4823
        bzr break-lock bzr+ssh://example.com/bzr/foo
 
4824
        bzr break-lock --conf ~/.bazaar
4656
4825
    """
 
4826
 
4657
4827
    takes_args = ['location?']
 
4828
    takes_options = [
 
4829
        Option('config',
 
4830
               help='LOCATION is the directory where the config lock is.'),
 
4831
        ]
4658
4832
 
4659
 
    def run(self, location=None, show=False):
 
4833
    def run(self, location=None, config=False):
4660
4834
        if location is None:
4661
4835
            location = u'.'
4662
 
        control, relpath = bzrdir.BzrDir.open_containing(location)
4663
 
        try:
4664
 
            control.break_lock()
4665
 
        except NotImplementedError:
4666
 
            pass
 
4836
        if config:
 
4837
            conf = _mod_config.LockableConfig(file_name=location)
 
4838
            conf.break_lock()
 
4839
        else:
 
4840
            control, relpath = bzrdir.BzrDir.open_containing(location)
 
4841
            try:
 
4842
                control.break_lock()
 
4843
            except NotImplementedError:
 
4844
                pass
4667
4845
 
4668
4846
 
4669
4847
class cmd_wait_until_signalled(Command):
4670
 
    """Test helper for test_start_and_stop_bzr_subprocess_send_signal.
 
4848
    __doc__ = """Test helper for test_start_and_stop_bzr_subprocess_send_signal.
4671
4849
 
4672
4850
    This just prints a line to signal when it is ready, then blocks on stdin.
4673
4851
    """
4681
4859
 
4682
4860
 
4683
4861
class cmd_serve(Command):
4684
 
    """Run the bzr server."""
 
4862
    __doc__ = """Run the bzr server."""
4685
4863
 
4686
4864
    aliases = ['server']
4687
4865
 
4688
4866
    takes_options = [
4689
4867
        Option('inet',
4690
4868
               help='Serve on stdin/out for use from inetd or sshd.'),
4691
 
        RegistryOption('protocol', 
4692
 
               help="Protocol to serve.", 
 
4869
        RegistryOption('protocol',
 
4870
               help="Protocol to serve.",
4693
4871
               lazy_registry=('bzrlib.transport', 'transport_server_registry'),
4694
4872
               value_switches=True),
4695
4873
        Option('port',
4698
4876
                    'result in a dynamically allocated port.  The default port '
4699
4877
                    'depends on the protocol.',
4700
4878
               type=str),
4701
 
        Option('directory',
4702
 
               help='Serve contents of this directory.',
4703
 
               type=unicode),
 
4879
        custom_help('directory',
 
4880
               help='Serve contents of this directory.'),
4704
4881
        Option('allow-writes',
4705
4882
               help='By default the server is a readonly server.  Supplying '
4706
4883
                    '--allow-writes enables write access to the contents of '
4707
 
                    'the served directory and below.'
 
4884
                    'the served directory and below.  Note that ``bzr serve`` '
 
4885
                    'does not perform authentication, so unless some form of '
 
4886
                    'external authentication is arranged supplying this '
 
4887
                    'option leads to global uncontrolled write access to your '
 
4888
                    'file system.'
4708
4889
                ),
4709
4890
        ]
4710
4891
 
4729
4910
 
4730
4911
    def run(self, port=None, inet=False, directory=None, allow_writes=False,
4731
4912
            protocol=None):
4732
 
        from bzrlib.transport import get_transport, transport_server_registry
 
4913
        from bzrlib import transport
4733
4914
        if directory is None:
4734
4915
            directory = os.getcwd()
4735
4916
        if protocol is None:
4736
 
            protocol = transport_server_registry.get()
 
4917
            protocol = transport.transport_server_registry.get()
4737
4918
        host, port = self.get_host_and_port(port)
4738
4919
        url = urlutils.local_path_to_url(directory)
4739
4920
        if not allow_writes:
4740
4921
            url = 'readonly+' + url
4741
 
        transport = get_transport(url)
4742
 
        protocol(transport, host, port, inet)
 
4922
        t = transport.get_transport(url)
 
4923
        protocol(t, host, port, inet)
4743
4924
 
4744
4925
 
4745
4926
class cmd_join(Command):
4746
 
    """Combine a tree into its containing tree.
 
4927
    __doc__ = """Combine a tree into its containing tree.
4747
4928
 
4748
4929
    This command requires the target tree to be in a rich-root format.
4749
4930
 
4789
4970
 
4790
4971
 
4791
4972
class cmd_split(Command):
4792
 
    """Split a subdirectory of a tree into a separate tree.
 
4973
    __doc__ = """Split a subdirectory of a tree into a separate tree.
4793
4974
 
4794
4975
    This command will produce a target tree in a format that supports
4795
4976
    rich roots, like 'rich-root' or 'rich-root-pack'.  These formats cannot be
4815
4996
 
4816
4997
 
4817
4998
class cmd_merge_directive(Command):
4818
 
    """Generate a merge directive for auto-merge tools.
 
4999
    __doc__ = """Generate a merge directive for auto-merge tools.
4819
5000
 
4820
5001
    A directive requests a merge to be performed, and also provides all the
4821
5002
    information necessary to do so.  This means it must either include a
4838
5019
    _see_also = ['send']
4839
5020
 
4840
5021
    takes_options = [
 
5022
        'directory',
4841
5023
        RegistryOption.from_kwargs('patch-type',
4842
5024
            'The type of patch to include in the directive.',
4843
5025
            title='Patch type',
4856
5038
    encoding_type = 'exact'
4857
5039
 
4858
5040
    def run(self, submit_branch=None, public_branch=None, patch_type='bundle',
4859
 
            sign=False, revision=None, mail_to=None, message=None):
 
5041
            sign=False, revision=None, mail_to=None, message=None,
 
5042
            directory=u'.'):
4860
5043
        from bzrlib.revision import ensure_null, NULL_REVISION
4861
5044
        include_patch, include_bundle = {
4862
5045
            'plain': (False, False),
4863
5046
            'diff': (True, False),
4864
5047
            'bundle': (True, True),
4865
5048
            }[patch_type]
4866
 
        branch = Branch.open('.')
 
5049
        branch = Branch.open(directory)
4867
5050
        stored_submit_branch = branch.get_submit_branch()
4868
5051
        if submit_branch is None:
4869
5052
            submit_branch = stored_submit_branch
4914
5097
 
4915
5098
 
4916
5099
class cmd_send(Command):
4917
 
    """Mail or create a merge-directive for submitting changes.
 
5100
    __doc__ = """Mail or create a merge-directive for submitting changes.
4918
5101
 
4919
5102
    A merge directive provides many things needed for requesting merges:
4920
5103
 
4926
5109
      directly from the merge directive, without retrieving data from a
4927
5110
      branch.
4928
5111
 
4929
 
    If --no-bundle is specified, then public_branch is needed (and must be
4930
 
    up-to-date), so that the receiver can perform the merge using the
4931
 
    public_branch.  The public_branch is always included if known, so that
4932
 
    people can check it later.
4933
 
 
4934
 
    The submit branch defaults to the parent, but can be overridden.  Both
4935
 
    submit branch and public branch will be remembered if supplied.
4936
 
 
4937
 
    If a public_branch is known for the submit_branch, that public submit
4938
 
    branch is used in the merge instructions.  This means that a local mirror
4939
 
    can be used as your actual submit branch, once you have set public_branch
4940
 
    for that mirror.
 
5112
    `bzr send` creates a compact data set that, when applied using bzr
 
5113
    merge, has the same effect as merging from the source branch.  
 
5114
    
 
5115
    By default the merge directive is self-contained and can be applied to any
 
5116
    branch containing submit_branch in its ancestory without needing access to
 
5117
    the source branch.
 
5118
    
 
5119
    If --no-bundle is specified, then Bazaar doesn't send the contents of the
 
5120
    revisions, but only a structured request to merge from the
 
5121
    public_location.  In that case the public_branch is needed and it must be
 
5122
    up-to-date and accessible to the recipient.  The public_branch is always
 
5123
    included if known, so that people can check it later.
 
5124
 
 
5125
    The submit branch defaults to the parent of the source branch, but can be
 
5126
    overridden.  Both submit branch and public branch will be remembered in
 
5127
    branch.conf the first time they are used for a particular branch.  The
 
5128
    source branch defaults to that containing the working directory, but can
 
5129
    be changed using --from.
 
5130
 
 
5131
    In order to calculate those changes, bzr must analyse the submit branch.
 
5132
    Therefore it is most efficient for the submit branch to be a local mirror.
 
5133
    If a public location is known for the submit_branch, that location is used
 
5134
    in the merge directive.
 
5135
 
 
5136
    The default behaviour is to send the merge directive by mail, unless -o is
 
5137
    given, in which case it is sent to a file.
4941
5138
 
4942
5139
    Mail is sent using your preferred mail program.  This should be transparent
4943
 
    on Windows (it uses MAPI).  On Linux, it requires the xdg-email utility.
 
5140
    on Windows (it uses MAPI).  On Unix, it requires the xdg-email utility.
4944
5141
    If the preferred client can't be found (or used), your editor will be used.
4945
5142
 
4946
5143
    To use a specific mail program, set the mail_client configuration option.
4947
5144
    (For Thunderbird 1.5, this works around some bugs.)  Supported values for
4948
 
    specific clients are "claws", "evolution", "kmail", "mutt", and
4949
 
    "thunderbird"; generic options are "default", "editor", "emacsclient",
4950
 
    "mapi", and "xdg-email".  Plugins may also add supported clients.
 
5145
    specific clients are "claws", "evolution", "kmail", "mail.app" (MacOS X's
 
5146
    Mail.app), "mutt", and "thunderbird"; generic options are "default",
 
5147
    "editor", "emacsclient", "mapi", and "xdg-email".  Plugins may also add
 
5148
    supported clients.
4951
5149
 
4952
5150
    If mail is being sent, a to address is required.  This can be supplied
4953
5151
    either on the commandline, by setting the submit_to configuration
4962
5160
 
4963
5161
    The merge directives created by bzr send may be applied using bzr merge or
4964
5162
    bzr pull by specifying a file containing a merge directive as the location.
 
5163
 
 
5164
    bzr send makes extensive use of public locations to map local locations into
 
5165
    URLs that can be used by other people.  See `bzr help configuration` to
 
5166
    set them, and use `bzr info` to display them.
4965
5167
    """
4966
5168
 
4967
5169
    encoding_type = 'exact'
4983
5185
               short_name='f',
4984
5186
               type=unicode),
4985
5187
        Option('output', short_name='o',
4986
 
               help='Write merge directive to this file; '
 
5188
               help='Write merge directive to this file or directory; '
4987
5189
                    'use - for stdout.',
4988
5190
               type=unicode),
4989
5191
        Option('strict',
5012
5214
 
5013
5215
 
5014
5216
class cmd_bundle_revisions(cmd_send):
5015
 
    """Create a merge-directive for submitting changes.
 
5217
    __doc__ = """Create a merge-directive for submitting changes.
5016
5218
 
5017
5219
    A merge directive provides many things needed for requesting merges:
5018
5220
 
5085
5287
 
5086
5288
 
5087
5289
class cmd_tag(Command):
5088
 
    """Create, remove or modify a tag naming a revision.
 
5290
    __doc__ = """Create, remove or modify a tag naming a revision.
5089
5291
 
5090
5292
    Tags give human-meaningful names to revisions.  Commands that take a -r
5091
5293
    (--revision) option can be given -rtag:X, where X is any previously
5099
5301
 
5100
5302
    To rename a tag (change the name but keep it on the same revsion), run ``bzr
5101
5303
    tag new-name -r tag:old-name`` and then ``bzr tag --delete oldname``.
 
5304
 
 
5305
    If no tag name is specified it will be determined through the 
 
5306
    'automatic_tag_name' hook. This can e.g. be used to automatically tag
 
5307
    upstream releases by reading configure.ac. See ``bzr help hooks`` for
 
5308
    details.
5102
5309
    """
5103
5310
 
5104
5311
    _see_also = ['commit', 'tags']
5105
 
    takes_args = ['tag_name']
 
5312
    takes_args = ['tag_name?']
5106
5313
    takes_options = [
5107
5314
        Option('delete',
5108
5315
            help='Delete this tag rather than placing it.',
5109
5316
            ),
5110
 
        Option('directory',
5111
 
            help='Branch in which to place the tag.',
5112
 
            short_name='d',
5113
 
            type=unicode,
5114
 
            ),
 
5317
        custom_help('directory',
 
5318
            help='Branch in which to place the tag.'),
5115
5319
        Option('force',
5116
5320
            help='Replace existing tags.',
5117
5321
            ),
5118
5322
        'revision',
5119
5323
        ]
5120
5324
 
5121
 
    def run(self, tag_name,
 
5325
    def run(self, tag_name=None,
5122
5326
            delete=None,
5123
5327
            directory='.',
5124
5328
            force=None,
5125
5329
            revision=None,
5126
5330
            ):
5127
5331
        branch, relpath = Branch.open_containing(directory)
5128
 
        branch.lock_write()
5129
 
        try:
5130
 
            if delete:
5131
 
                branch.tags.delete_tag(tag_name)
5132
 
                self.outf.write('Deleted tag %s.\n' % tag_name)
 
5332
        self.add_cleanup(branch.lock_write().unlock)
 
5333
        if delete:
 
5334
            if tag_name is None:
 
5335
                raise errors.BzrCommandError("No tag specified to delete.")
 
5336
            branch.tags.delete_tag(tag_name)
 
5337
            self.outf.write('Deleted tag %s.\n' % tag_name)
 
5338
        else:
 
5339
            if revision:
 
5340
                if len(revision) != 1:
 
5341
                    raise errors.BzrCommandError(
 
5342
                        "Tags can only be placed on a single revision, "
 
5343
                        "not on a range")
 
5344
                revision_id = revision[0].as_revision_id(branch)
5133
5345
            else:
5134
 
                if revision:
5135
 
                    if len(revision) != 1:
5136
 
                        raise errors.BzrCommandError(
5137
 
                            "Tags can only be placed on a single revision, "
5138
 
                            "not on a range")
5139
 
                    revision_id = revision[0].as_revision_id(branch)
5140
 
                else:
5141
 
                    revision_id = branch.last_revision()
5142
 
                if (not force) and branch.tags.has_tag(tag_name):
5143
 
                    raise errors.TagAlreadyExists(tag_name)
5144
 
                branch.tags.set_tag(tag_name, revision_id)
5145
 
                self.outf.write('Created tag %s.\n' % tag_name)
5146
 
        finally:
5147
 
            branch.unlock()
 
5346
                revision_id = branch.last_revision()
 
5347
            if tag_name is None:
 
5348
                tag_name = branch.automatic_tag_name(revision_id)
 
5349
                if tag_name is None:
 
5350
                    raise errors.BzrCommandError(
 
5351
                        "Please specify a tag name.")
 
5352
            if (not force) and branch.tags.has_tag(tag_name):
 
5353
                raise errors.TagAlreadyExists(tag_name)
 
5354
            branch.tags.set_tag(tag_name, revision_id)
 
5355
            self.outf.write('Created tag %s.\n' % tag_name)
5148
5356
 
5149
5357
 
5150
5358
class cmd_tags(Command):
5151
 
    """List tags.
 
5359
    __doc__ = """List tags.
5152
5360
 
5153
5361
    This command shows a table of tag names and the revisions they reference.
5154
5362
    """
5155
5363
 
5156
5364
    _see_also = ['tag']
5157
5365
    takes_options = [
5158
 
        Option('directory',
5159
 
            help='Branch whose tags should be displayed.',
5160
 
            short_name='d',
5161
 
            type=unicode,
5162
 
            ),
 
5366
        custom_help('directory',
 
5367
            help='Branch whose tags should be displayed.'),
5163
5368
        RegistryOption.from_kwargs('sort',
5164
5369
            'Sort tags by different criteria.', title='Sorting',
5165
5370
            alpha='Sort tags lexicographically (default).',
5182
5387
        if not tags:
5183
5388
            return
5184
5389
 
5185
 
        branch.lock_read()
5186
 
        try:
5187
 
            if revision:
5188
 
                graph = branch.repository.get_graph()
5189
 
                rev1, rev2 = _get_revision_range(revision, branch, self.name())
5190
 
                revid1, revid2 = rev1.rev_id, rev2.rev_id
5191
 
                # only show revisions between revid1 and revid2 (inclusive)
5192
 
                tags = [(tag, revid) for tag, revid in tags if
5193
 
                    graph.is_between(revid, revid1, revid2)]
5194
 
            if sort == 'alpha':
5195
 
                tags.sort()
5196
 
            elif sort == 'time':
5197
 
                timestamps = {}
5198
 
                for tag, revid in tags:
5199
 
                    try:
5200
 
                        revobj = branch.repository.get_revision(revid)
5201
 
                    except errors.NoSuchRevision:
5202
 
                        timestamp = sys.maxint # place them at the end
5203
 
                    else:
5204
 
                        timestamp = revobj.timestamp
5205
 
                    timestamps[revid] = timestamp
5206
 
                tags.sort(key=lambda x: timestamps[x[1]])
5207
 
            if not show_ids:
5208
 
                # [ (tag, revid), ... ] -> [ (tag, dotted_revno), ... ]
5209
 
                for index, (tag, revid) in enumerate(tags):
5210
 
                    try:
5211
 
                        revno = branch.revision_id_to_dotted_revno(revid)
5212
 
                        if isinstance(revno, tuple):
5213
 
                            revno = '.'.join(map(str, revno))
5214
 
                    except errors.NoSuchRevision:
5215
 
                        # Bad tag data/merges can lead to tagged revisions
5216
 
                        # which are not in this branch. Fail gracefully ...
5217
 
                        revno = '?'
5218
 
                    tags[index] = (tag, revno)
5219
 
        finally:
5220
 
            branch.unlock()
 
5390
        self.add_cleanup(branch.lock_read().unlock)
 
5391
        if revision:
 
5392
            graph = branch.repository.get_graph()
 
5393
            rev1, rev2 = _get_revision_range(revision, branch, self.name())
 
5394
            revid1, revid2 = rev1.rev_id, rev2.rev_id
 
5395
            # only show revisions between revid1 and revid2 (inclusive)
 
5396
            tags = [(tag, revid) for tag, revid in tags if
 
5397
                graph.is_between(revid, revid1, revid2)]
 
5398
        if sort == 'alpha':
 
5399
            tags.sort()
 
5400
        elif sort == 'time':
 
5401
            timestamps = {}
 
5402
            for tag, revid in tags:
 
5403
                try:
 
5404
                    revobj = branch.repository.get_revision(revid)
 
5405
                except errors.NoSuchRevision:
 
5406
                    timestamp = sys.maxint # place them at the end
 
5407
                else:
 
5408
                    timestamp = revobj.timestamp
 
5409
                timestamps[revid] = timestamp
 
5410
            tags.sort(key=lambda x: timestamps[x[1]])
 
5411
        if not show_ids:
 
5412
            # [ (tag, revid), ... ] -> [ (tag, dotted_revno), ... ]
 
5413
            for index, (tag, revid) in enumerate(tags):
 
5414
                try:
 
5415
                    revno = branch.revision_id_to_dotted_revno(revid)
 
5416
                    if isinstance(revno, tuple):
 
5417
                        revno = '.'.join(map(str, revno))
 
5418
                except errors.NoSuchRevision:
 
5419
                    # Bad tag data/merges can lead to tagged revisions
 
5420
                    # which are not in this branch. Fail gracefully ...
 
5421
                    revno = '?'
 
5422
                tags[index] = (tag, revno)
 
5423
        self.cleanup_now()
5221
5424
        for tag, revspec in tags:
5222
5425
            self.outf.write('%-20s %s\n' % (tag, revspec))
5223
5426
 
5224
5427
 
5225
5428
class cmd_reconfigure(Command):
5226
 
    """Reconfigure the type of a bzr directory.
 
5429
    __doc__ = """Reconfigure the type of a bzr directory.
5227
5430
 
5228
5431
    A target configuration must be specified.
5229
5432
 
5259
5462
            ),
5260
5463
        Option('bind-to', help='Branch to bind checkout to.', type=str),
5261
5464
        Option('force',
5262
 
               help='Perform reconfiguration even if local changes'
5263
 
               ' will be lost.')
 
5465
            help='Perform reconfiguration even if local changes'
 
5466
            ' will be lost.'),
 
5467
        Option('stacked-on',
 
5468
            help='Reconfigure a branch to be stacked on another branch.',
 
5469
            type=unicode,
 
5470
            ),
 
5471
        Option('unstacked',
 
5472
            help='Reconfigure a branch to be unstacked.  This '
 
5473
                'may require copying substantial data into it.',
 
5474
            ),
5264
5475
        ]
5265
5476
 
5266
 
    def run(self, location=None, target_type=None, bind_to=None, force=False):
 
5477
    def run(self, location=None, target_type=None, bind_to=None, force=False,
 
5478
            stacked_on=None,
 
5479
            unstacked=None):
5267
5480
        directory = bzrdir.BzrDir.open(location)
 
5481
        if stacked_on and unstacked:
 
5482
            raise BzrCommandError("Can't use both --stacked-on and --unstacked")
 
5483
        elif stacked_on is not None:
 
5484
            reconfigure.ReconfigureStackedOn().apply(directory, stacked_on)
 
5485
        elif unstacked:
 
5486
            reconfigure.ReconfigureUnstacked().apply(directory)
 
5487
        # At the moment you can use --stacked-on and a different
 
5488
        # reconfiguration shape at the same time; there seems no good reason
 
5489
        # to ban it.
5268
5490
        if target_type is None:
5269
 
            raise errors.BzrCommandError('No target configuration specified')
 
5491
            if stacked_on or unstacked:
 
5492
                return
 
5493
            else:
 
5494
                raise errors.BzrCommandError('No target configuration '
 
5495
                    'specified')
5270
5496
        elif target_type == 'branch':
5271
5497
            reconfiguration = reconfigure.Reconfigure.to_branch(directory)
5272
5498
        elif target_type == 'tree':
5291
5517
 
5292
5518
 
5293
5519
class cmd_switch(Command):
5294
 
    """Set the branch of a checkout and update.
 
5520
    __doc__ = """Set the branch of a checkout and update.
5295
5521
 
5296
5522
    For lightweight checkouts, this changes the branch being referenced.
5297
5523
    For heavyweight checkouts, this checks that there are no local commits
5309
5535
    /path/to/newbranch.
5310
5536
 
5311
5537
    Bound branches use the nickname of its master branch unless it is set
5312
 
    locally, in which case switching will update the the local nickname to be
 
5538
    locally, in which case switching will update the local nickname to be
5313
5539
    that of the master.
5314
5540
    """
5315
5541
 
5316
 
    takes_args = ['to_location']
5317
 
    takes_options = [Option('force',
 
5542
    takes_args = ['to_location?']
 
5543
    takes_options = ['directory',
 
5544
                     Option('force',
5318
5545
                        help='Switch even if local commits will be lost.'),
 
5546
                     'revision',
5319
5547
                     Option('create-branch', short_name='b',
5320
5548
                        help='Create the target branch from this one before'
5321
5549
                             ' switching to it.'),
5322
 
                     ]
 
5550
                    ]
5323
5551
 
5324
 
    def run(self, to_location, force=False, create_branch=False):
 
5552
    def run(self, to_location=None, force=False, create_branch=False,
 
5553
            revision=None, directory=u'.'):
5325
5554
        from bzrlib import switch
5326
 
        tree_location = '.'
 
5555
        tree_location = directory
 
5556
        revision = _get_one_revision('switch', revision)
5327
5557
        control_dir = bzrdir.BzrDir.open_containing(tree_location)[0]
 
5558
        if to_location is None:
 
5559
            if revision is None:
 
5560
                raise errors.BzrCommandError('You must supply either a'
 
5561
                                             ' revision or a location')
 
5562
            to_location = tree_location
5328
5563
        try:
5329
5564
            branch = control_dir.open_branch()
5330
5565
            had_explicit_nick = branch.get_config().has_explicit_nickname()
5335
5570
            if branch is None:
5336
5571
                raise errors.BzrCommandError('cannot create branch without'
5337
5572
                                             ' source branch')
 
5573
            to_location = directory_service.directories.dereference(
 
5574
                              to_location)
5338
5575
            if '/' not in to_location and '\\' not in to_location:
5339
5576
                # This path is meant to be relative to the existing branch
5340
5577
                this_url = self._get_branch_location(control_dir)
5342
5579
            to_branch = branch.bzrdir.sprout(to_location,
5343
5580
                                 possible_transports=[branch.bzrdir.root_transport],
5344
5581
                                 source_branch=branch).open_branch()
5345
 
            # try:
5346
 
            #     from_branch = control_dir.open_branch()
5347
 
            # except errors.NotBranchError:
5348
 
            #     raise BzrCommandError('Cannot create a branch from this'
5349
 
            #         ' location when we cannot open this branch')
5350
 
            # from_branch.bzrdir.sprout(
5351
 
            pass
5352
5582
        else:
5353
5583
            try:
5354
5584
                to_branch = Branch.open(to_location)
5356
5586
                this_url = self._get_branch_location(control_dir)
5357
5587
                to_branch = Branch.open(
5358
5588
                    urlutils.join(this_url, '..', to_location))
5359
 
        switch.switch(control_dir, to_branch, force)
 
5589
        if revision is not None:
 
5590
            revision = revision.as_revision_id(to_branch)
 
5591
        switch.switch(control_dir, to_branch, force, revision_id=revision)
5360
5592
        if had_explicit_nick:
5361
5593
            branch = control_dir.open_branch() #get the new branch!
5362
5594
            branch.nick = to_branch.nick
5382
5614
 
5383
5615
 
5384
5616
class cmd_view(Command):
5385
 
    """Manage filtered views.
 
5617
    __doc__ = """Manage filtered views.
5386
5618
 
5387
5619
    Views provide a mask over the tree so that users can focus on
5388
5620
    a subset of a tree when doing their work. After creating a view,
5468
5700
            name=None,
5469
5701
            switch=None,
5470
5702
            ):
5471
 
        tree, file_list = tree_files(file_list, apply_view=False)
 
5703
        tree, file_list = WorkingTree.open_containing_paths(file_list,
 
5704
            apply_view=False)
5472
5705
        current_view, view_dict = tree.views.get_view_info()
5473
5706
        if name is None:
5474
5707
            name = current_view
5536
5769
 
5537
5770
 
5538
5771
class cmd_hooks(Command):
5539
 
    """Show hooks."""
 
5772
    __doc__ = """Show hooks."""
5540
5773
 
5541
5774
    hidden = True
5542
5775
 
5555
5788
                    self.outf.write("    <no hooks installed>\n")
5556
5789
 
5557
5790
 
 
5791
class cmd_remove_branch(Command):
 
5792
    __doc__ = """Remove a branch.
 
5793
 
 
5794
    This will remove the branch from the specified location but 
 
5795
    will keep any working tree or repository in place.
 
5796
 
 
5797
    :Examples:
 
5798
 
 
5799
      Remove the branch at repo/trunk::
 
5800
 
 
5801
        bzr remove-branch repo/trunk
 
5802
 
 
5803
    """
 
5804
 
 
5805
    takes_args = ["location?"]
 
5806
 
 
5807
    aliases = ["rmbranch"]
 
5808
 
 
5809
    def run(self, location=None):
 
5810
        if location is None:
 
5811
            location = "."
 
5812
        branch = Branch.open_containing(location)[0]
 
5813
        branch.bzrdir.destroy_branch()
 
5814
        
 
5815
 
5558
5816
class cmd_shelve(Command):
5559
 
    """Temporarily set aside some changes from the current tree.
 
5817
    __doc__ = """Temporarily set aside some changes from the current tree.
5560
5818
 
5561
5819
    Shelve allows you to temporarily put changes you've made "on the shelf",
5562
5820
    ie. out of the way, until a later time when you can bring them back from
5583
5841
    takes_args = ['file*']
5584
5842
 
5585
5843
    takes_options = [
 
5844
        'directory',
5586
5845
        'revision',
5587
5846
        Option('all', help='Shelve all changes.'),
5588
5847
        'message',
5597
5856
    _see_also = ['unshelve']
5598
5857
 
5599
5858
    def run(self, revision=None, all=False, file_list=None, message=None,
5600
 
            writer=None, list=False, destroy=False):
 
5859
            writer=None, list=False, destroy=False, directory=u'.'):
5601
5860
        if list:
5602
5861
            return self.run_for_list()
5603
5862
        from bzrlib.shelf_ui import Shelver
5604
5863
        if writer is None:
5605
5864
            writer = bzrlib.option.diff_writer_registry.get()
5606
5865
        try:
5607
 
            Shelver.from_args(writer(sys.stdout), revision, all, file_list,
5608
 
                              message, destroy=destroy).run()
 
5866
            shelver = Shelver.from_args(writer(sys.stdout), revision, all,
 
5867
                file_list, message, destroy=destroy, directory=directory)
 
5868
            try:
 
5869
                shelver.run()
 
5870
            finally:
 
5871
                shelver.finalize()
5609
5872
        except errors.UserAbort:
5610
5873
            return 0
5611
5874
 
5612
5875
    def run_for_list(self):
5613
5876
        tree = WorkingTree.open_containing('.')[0]
5614
 
        tree.lock_read()
5615
 
        try:
5616
 
            manager = tree.get_shelf_manager()
5617
 
            shelves = manager.active_shelves()
5618
 
            if len(shelves) == 0:
5619
 
                note('No shelved changes.')
5620
 
                return 0
5621
 
            for shelf_id in reversed(shelves):
5622
 
                message = manager.get_metadata(shelf_id).get('message')
5623
 
                if message is None:
5624
 
                    message = '<no message>'
5625
 
                self.outf.write('%3d: %s\n' % (shelf_id, message))
5626
 
            return 1
5627
 
        finally:
5628
 
            tree.unlock()
 
5877
        self.add_cleanup(tree.lock_read().unlock)
 
5878
        manager = tree.get_shelf_manager()
 
5879
        shelves = manager.active_shelves()
 
5880
        if len(shelves) == 0:
 
5881
            note('No shelved changes.')
 
5882
            return 0
 
5883
        for shelf_id in reversed(shelves):
 
5884
            message = manager.get_metadata(shelf_id).get('message')
 
5885
            if message is None:
 
5886
                message = '<no message>'
 
5887
            self.outf.write('%3d: %s\n' % (shelf_id, message))
 
5888
        return 1
5629
5889
 
5630
5890
 
5631
5891
class cmd_unshelve(Command):
5632
 
    """Restore shelved changes.
 
5892
    __doc__ = """Restore shelved changes.
5633
5893
 
5634
5894
    By default, the most recently shelved changes are restored. However if you
5635
5895
    specify a shelf by id those changes will be restored instead.  This works
5638
5898
 
5639
5899
    takes_args = ['shelf_id?']
5640
5900
    takes_options = [
 
5901
        'directory',
5641
5902
        RegistryOption.from_kwargs(
5642
5903
            'action', help="The action to perform.",
5643
5904
            enum_switch=False, value_switches=True,
5644
5905
            apply="Apply changes and remove from the shelf.",
5645
5906
            dry_run="Show changes, but do not apply or remove them.",
5646
 
            delete_only="Delete changes without applying them."
 
5907
            preview="Instead of unshelving the changes, show the diff that "
 
5908
                    "would result from unshelving.",
 
5909
            delete_only="Delete changes without applying them.",
 
5910
            keep="Apply changes but don't delete them.",
5647
5911
        )
5648
5912
    ]
5649
5913
    _see_also = ['shelve']
5650
5914
 
5651
 
    def run(self, shelf_id=None, action='apply'):
 
5915
    def run(self, shelf_id=None, action='apply', directory=u'.'):
5652
5916
        from bzrlib.shelf_ui import Unshelver
5653
 
        Unshelver.from_args(shelf_id, action).run()
 
5917
        unshelver = Unshelver.from_args(shelf_id, action, directory=directory)
 
5918
        try:
 
5919
            unshelver.run()
 
5920
        finally:
 
5921
            unshelver.tree.unlock()
5654
5922
 
5655
5923
 
5656
5924
class cmd_clean_tree(Command):
5657
 
    """Remove unwanted files from working tree.
 
5925
    __doc__ = """Remove unwanted files from working tree.
5658
5926
 
5659
5927
    By default, only unknown files, not ignored files, are deleted.  Versioned
5660
5928
    files are never deleted.
5668
5936
 
5669
5937
    To check what clean-tree will do, use --dry-run.
5670
5938
    """
5671
 
    takes_options = [Option('ignored', help='Delete all ignored files.'),
 
5939
    takes_options = ['directory',
 
5940
                     Option('ignored', help='Delete all ignored files.'),
5672
5941
                     Option('detritus', help='Delete conflict files, merge'
5673
5942
                            ' backups, and failed selftest dirs.'),
5674
5943
                     Option('unknown',
5677
5946
                            ' deleting them.'),
5678
5947
                     Option('force', help='Do not prompt before deleting.')]
5679
5948
    def run(self, unknown=False, ignored=False, detritus=False, dry_run=False,
5680
 
            force=False):
 
5949
            force=False, directory=u'.'):
5681
5950
        from bzrlib.clean_tree import clean_tree
5682
5951
        if not (unknown or ignored or detritus):
5683
5952
            unknown = True
5684
5953
        if dry_run:
5685
5954
            force = True
5686
 
        clean_tree('.', unknown=unknown, ignored=ignored, detritus=detritus,
5687
 
                   dry_run=dry_run, no_prompt=force)
 
5955
        clean_tree(directory, unknown=unknown, ignored=ignored,
 
5956
                   detritus=detritus, dry_run=dry_run, no_prompt=force)
5688
5957
 
5689
5958
 
5690
5959
class cmd_reference(Command):
5691
 
    """list, view and set branch locations for nested trees.
 
5960
    __doc__ = """list, view and set branch locations for nested trees.
5692
5961
 
5693
5962
    If no arguments are provided, lists the branch locations for nested trees.
5694
5963
    If one argument is provided, display the branch location for that tree.
5734
6003
            self.outf.write('%s %s\n' % (path, location))
5735
6004
 
5736
6005
 
5737
 
# these get imported and then picked up by the scan for cmd_*
5738
 
# TODO: Some more consistent way to split command definitions across files;
5739
 
# we do need to load at least some information about them to know of
5740
 
# aliases.  ideally we would avoid loading the implementation until the
5741
 
# details were needed.
5742
 
from bzrlib.cmd_version_info import cmd_version_info
5743
 
from bzrlib.conflicts import cmd_resolve, cmd_conflicts, restore
5744
 
from bzrlib.bundle.commands import (
5745
 
    cmd_bundle_info,
5746
 
    )
5747
 
from bzrlib.foreign import cmd_dpush
5748
 
from bzrlib.sign_my_commits import cmd_sign_my_commits
5749
 
from bzrlib.weave_commands import cmd_versionedfile_list, \
5750
 
        cmd_weave_plan_merge, cmd_weave_merge_text
 
6006
def _register_lazy_builtins():
 
6007
    # register lazy builtins from other modules; called at startup and should
 
6008
    # be only called once.
 
6009
    for (name, aliases, module_name) in [
 
6010
        ('cmd_bundle_info', [], 'bzrlib.bundle.commands'),
 
6011
        ('cmd_dpush', [], 'bzrlib.foreign'),
 
6012
        ('cmd_version_info', [], 'bzrlib.cmd_version_info'),
 
6013
        ('cmd_resolve', ['resolved'], 'bzrlib.conflicts'),
 
6014
        ('cmd_conflicts', [], 'bzrlib.conflicts'),
 
6015
        ('cmd_sign_my_commits', [], 'bzrlib.sign_my_commits'),
 
6016
        ]:
 
6017
        builtin_command_registry.register_lazy(name, aliases, module_name)