← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/builtins.py

  • Committer: Martin Pool
  • Date: 2010-07-16 15:20:17 UTC
  • mfrom: (5346.3.1 pathnotchild)
  • mto: This revision was merged to the branch mainline in revision 5351.
  • Revision ID: mbp@canonical.com-20100716152017-t4c73h9y1uoih7fb
PathNotChild should not give a traceback.

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
31
31
    bundle,
32
32
    btree_index,
33
33
    bzrdir,
 
34
    directory_service,
34
35
    delta,
35
36
    config,
36
37
    errors,
43
44
    reconfigure,
44
45
    rename_map,
45
46
    revision as _mod_revision,
 
47
    static_tuple,
46
48
    symbol_versioning,
 
49
    timestamp,
47
50
    transport,
48
 
    tree as _mod_tree,
49
51
    ui,
50
52
    urlutils,
51
53
    views,
52
54
    )
53
55
from bzrlib.branch import Branch
54
56
from bzrlib.conflicts import ConflictList
 
57
from bzrlib.transport import memory
55
58
from bzrlib.revisionspec import RevisionSpec, RevisionInfo
56
59
from bzrlib.smtp_connection import SMTPConnection
57
60
from bzrlib.workingtree import WorkingTree
58
61
""")
59
62
 
60
 
from bzrlib.commands import Command, display_command
 
63
from bzrlib.commands import (
 
64
    Command,
 
65
    builtin_command_registry,
 
66
    display_command,
 
67
    )
61
68
from bzrlib.option import (
62
69
    ListOption,
63
70
    Option,
70
77
 
71
78
def tree_files(file_list, default_branch=u'.', canonicalize=True,
72
79
    apply_view=True):
73
 
    try:
74
 
        return internal_tree_files(file_list, default_branch, canonicalize,
75
 
            apply_view)
76
 
    except errors.FileInWrongBranch, e:
77
 
        raise errors.BzrCommandError("%s is not in the same branch as %s" %
78
 
                                     (e.path, file_list[0]))
 
80
    return internal_tree_files(file_list, default_branch, canonicalize,
 
81
        apply_view)
79
82
 
80
83
 
81
84
def tree_files_for_add(file_list):
82
 
    """Add handles files a bit differently so it a custom implementation."""
 
85
    """
 
86
    Return a tree and list of absolute paths from a file list.
 
87
 
 
88
    Similar to tree_files, but add handles files a bit differently, so it a
 
89
    custom implementation.  In particular, MutableTreeTree.smart_add expects
 
90
    absolute paths, which it immediately converts to relative paths.
 
91
    """
 
92
    # FIXME Would be nice to just return the relative paths like
 
93
    # internal_tree_files does, but there are a large number of unit tests
 
94
    # that assume the current interface to mutabletree.smart_add
83
95
    if file_list:
84
 
        tree = WorkingTree.open_containing(file_list[0])[0]
 
96
        tree, relpath = WorkingTree.open_containing(file_list[0])
85
97
        if tree.supports_views():
86
98
            view_files = tree.views.lookup_view()
87
99
            if view_files:
88
100
                for filename in file_list:
89
101
                    if not osutils.is_inside_any(view_files, filename):
90
102
                        raise errors.FileOutsideView(filename, view_files)
 
103
        file_list = file_list[:]
 
104
        file_list[0] = tree.abspath(relpath)
91
105
    else:
92
106
        tree = WorkingTree.open_containing(u'.')[0]
93
107
        if tree.supports_views():
95
109
            if view_files:
96
110
                file_list = view_files
97
111
                view_str = views.view_display_str(view_files)
98
 
                note("ignoring files outside view: %s" % view_str)
 
112
                note("Ignoring files outside view. View is %s" % view_str)
99
113
    return tree, file_list
100
114
 
101
115
 
110
124
 
111
125
 
112
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
    """
113
136
    if branch is None:
114
137
        branch = tree.branch
115
138
    if revisions is None:
125
148
 
126
149
# XXX: Bad function name; should possibly also be a class method of
127
150
# WorkingTree rather than a function.
 
151
# @symbol_versioning.deprecated_function(symbol_versioning.deprecated_in((2, 3, 0)))
128
152
def internal_tree_files(file_list, default_branch=u'.', canonicalize=True,
129
153
    apply_view=True):
130
154
    """Convert command-line paths to a WorkingTree and relative paths.
131
155
 
 
156
    Deprecated: use WorkingTree.open_containing_paths instead.
 
157
 
132
158
    This is typically used for command-line processors that take one or
133
159
    more filenames, and infer the workingtree that contains them.
134
160
 
144
170
 
145
171
    :return: workingtree, [relative_paths]
146
172
    """
147
 
    if file_list is None or len(file_list) == 0:
148
 
        tree = WorkingTree.open_containing(default_branch)[0]
149
 
        if tree.supports_views() and apply_view:
150
 
            view_files = tree.views.lookup_view()
151
 
            if view_files:
152
 
                file_list = view_files
153
 
                view_str = views.view_display_str(view_files)
154
 
                note("ignoring files outside view: %s" % view_str)
155
 
        return tree, file_list
156
 
    tree = WorkingTree.open_containing(osutils.realpath(file_list[0]))[0]
157
 
    return tree, safe_relpath_files(tree, file_list, canonicalize,
158
 
        apply_view=apply_view)
159
 
 
160
 
 
161
 
def safe_relpath_files(tree, file_list, canonicalize=True, apply_view=True):
162
 
    """Convert file_list into a list of relpaths in tree.
163
 
 
164
 
    :param tree: A tree to operate on.
165
 
    :param file_list: A list of user provided paths or None.
166
 
    :param apply_view: if True and a view is set, apply it or check that
167
 
        specified files are within it
168
 
    :return: A list of relative paths.
169
 
    :raises errors.PathNotChild: When a provided path is in a different tree
170
 
        than tree.
171
 
    """
172
 
    if file_list is None:
173
 
        return None
174
 
    if tree.supports_views() and apply_view:
175
 
        view_files = tree.views.lookup_view()
176
 
    else:
177
 
        view_files = []
178
 
    new_list = []
179
 
    # tree.relpath exists as a "thunk" to osutils, but canonical_relpath
180
 
    # doesn't - fix that up here before we enter the loop.
181
 
    if canonicalize:
182
 
        fixer = lambda p: osutils.canonical_relpath(tree.basedir, p)
183
 
    else:
184
 
        fixer = tree.relpath
185
 
    for filename in file_list:
186
 
        try:
187
 
            relpath = fixer(osutils.dereference_path(filename))
188
 
            if  view_files and not osutils.is_inside_any(view_files, relpath):
189
 
                raise errors.FileOutsideView(filename, view_files)
190
 
            new_list.append(relpath)
191
 
        except errors.PathNotChild:
192
 
            raise errors.FileInWrongBranch(tree.branch, filename)
193
 
    return new_list
 
173
    return WorkingTree.open_containing_paths(
 
174
        file_list, default_directory='.',
 
175
        canonicalize=True,
 
176
        apply_view=True)
194
177
 
195
178
 
196
179
def _get_view_info_for_change_reporter(tree):
205
188
    return view_info
206
189
 
207
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
 
208
199
# TODO: Make sure no commands unconditionally use the working directory as a
209
200
# branch.  If a filename argument is used, the first of them should be used to
210
201
# specify the branch.  (Perhaps this can be factored out into some kind of
212
203
# opens the branch?)
213
204
 
214
205
class cmd_status(Command):
215
 
    """Display status summary.
 
206
    __doc__ = """Display status summary.
216
207
 
217
208
    This reports on versioned and unknown files, reporting them
218
209
    grouped by state.  Possible states are:
238
229
    unknown
239
230
        Not versioned and not matching an ignore pattern.
240
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
 
241
236
    To see ignored files use 'bzr ignored'.  For details on the
242
237
    changes to file texts, use 'bzr diff'.
243
238
 
301
296
 
302
297
 
303
298
class cmd_cat_revision(Command):
304
 
    """Write out metadata for a revision.
 
299
    __doc__ = """Write out metadata for a revision.
305
300
 
306
301
    The revision to print can either be specified by a specific
307
302
    revision identifier, or you can use --revision.
309
304
 
310
305
    hidden = True
311
306
    takes_args = ['revision_id?']
312
 
    takes_options = ['revision']
 
307
    takes_options = ['directory', 'revision']
313
308
    # cat-revision is more for frontends so should be exact
314
309
    encoding = 'strict'
315
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
 
316
319
    @display_command
317
 
    def run(self, revision_id=None, revision=None):
 
320
    def run(self, revision_id=None, revision=None, directory=u'.'):
318
321
        if revision_id is not None and revision is not None:
319
322
            raise errors.BzrCommandError('You can only supply one of'
320
323
                                         ' revision_id or --revision')
321
324
        if revision_id is None and revision is None:
322
325
            raise errors.BzrCommandError('You must supply either'
323
326
                                         ' --revision or a revision_id')
324
 
        b = WorkingTree.open_containing(u'.')[0].branch
325
 
 
326
 
        # TODO: jam 20060112 should cat-revision always output utf-8?
327
 
        if revision_id is not None:
328
 
            revision_id = osutils.safe_revision_id(revision_id, warn=False)
329
 
            try:
330
 
                self.outf.write(b.repository.get_revision_xml(revision_id).decode('utf-8'))
331
 
            except errors.NoSuchRevision:
332
 
                msg = "The repository %s contains no revision %s." % (b.repository.base,
333
 
                    revision_id)
334
 
                raise errors.BzrCommandError(msg)
335
 
        elif revision is not None:
336
 
            for rev in revision:
337
 
                if rev is None:
338
 
                    raise errors.BzrCommandError('You cannot specify a NULL'
339
 
                                                 ' revision.')
340
 
                rev_id = rev.as_revision_id(b)
341
 
                self.outf.write(b.repository.get_revision_xml(rev_id).decode('utf-8'))
342
 
 
 
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
        
343
355
 
344
356
class cmd_dump_btree(Command):
345
 
    """Dump the contents of a btree index file to stdout.
 
357
    __doc__ = """Dump the contents of a btree index file to stdout.
346
358
 
347
359
    PATH is a btree index file, it can be any URL. This includes things like
348
360
    .bzr/repository/pack-names, or .bzr/repository/indices/a34b3a...ca4a4.iix
412
424
        for node in bt.iter_all_entries():
413
425
            # Node is made up of:
414
426
            # (index, key, value, [references])
415
 
            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,))
416
435
 
417
436
 
418
437
class cmd_remove_tree(Command):
419
 
    """Remove the working tree from a given branch/checkout.
 
438
    __doc__ = """Remove the working tree from a given branch/checkout.
420
439
 
421
440
    Since a lightweight checkout is little more than a working tree
422
441
    this will refuse to run against one.
424
443
    To re-create the working tree, use "bzr checkout".
425
444
    """
426
445
    _see_also = ['checkout', 'working-trees']
427
 
    takes_args = ['location?']
 
446
    takes_args = ['location*']
428
447
    takes_options = [
429
448
        Option('force',
430
449
               help='Remove the working tree even if it has '
431
 
                    'uncommitted changes.'),
 
450
                    'uncommitted or shelved changes.'),
432
451
        ]
433
452
 
434
 
    def run(self, location='.', force=False):
435
 
        d = bzrdir.BzrDir.open(location)
436
 
 
437
 
        try:
438
 
            working = d.open_workingtree()
439
 
        except errors.NoWorkingTree:
440
 
            raise errors.BzrCommandError("No working tree to remove")
441
 
        except errors.NotLocalUrl:
442
 
            raise errors.BzrCommandError("You cannot remove the working tree of a "
443
 
                                         "remote path")
444
 
        if not force:
445
 
            changes = working.changes_from(working.basis_tree())
446
 
            if changes.has_changed():
447
 
                raise errors.UncommittedChanges(working)
448
 
 
449
 
        working_path = working.bzrdir.root_transport.base
450
 
        branch_path = working.branch.bzrdir.root_transport.base
451
 
        if working_path != branch_path:
452
 
            raise errors.BzrCommandError("You cannot remove the working tree from "
453
 
                                         "a lightweight checkout")
454
 
 
455
 
        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()
456
478
 
457
479
 
458
480
class cmd_revno(Command):
459
 
    """Show current revision number.
 
481
    __doc__ = """Show current revision number.
460
482
 
461
483
    This is equal to the number of revisions on this branch.
462
484
    """
463
485
 
464
486
    _see_also = ['info']
465
487
    takes_args = ['location?']
 
488
    takes_options = [
 
489
        Option('tree', help='Show revno of working tree'),
 
490
        ]
466
491
 
467
492
    @display_command
468
 
    def run(self, location=u'.'):
469
 
        self.outf.write(str(Branch.open_containing(location)[0].revno()))
470
 
        self.outf.write('\n')
 
493
    def run(self, tree=False, location=u'.'):
 
494
        if tree:
 
495
            try:
 
496
                wt = WorkingTree.open_containing(location)[0]
 
497
                self.add_cleanup(wt.lock_read().unlock)
 
498
            except (errors.NoWorkingTree, errors.NotLocalUrl):
 
499
                raise errors.NoWorkingTree(location)
 
500
            revid = wt.last_revision()
 
501
            try:
 
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)
 
506
        else:
 
507
            b = Branch.open_containing(location)[0]
 
508
            self.add_cleanup(b.lock_read().unlock)
 
509
            revno = b.revno()
 
510
        self.cleanup_now()
 
511
        self.outf.write(str(revno) + '\n')
471
512
 
472
513
 
473
514
class cmd_revision_info(Command):
474
 
    """Show revision number and revision id for a given revision identifier.
 
515
    __doc__ = """Show revision number and revision id for a given revision identifier.
475
516
    """
476
517
    hidden = True
477
518
    takes_args = ['revision_info*']
478
519
    takes_options = [
479
520
        'revision',
480
 
        Option('directory',
 
521
        custom_help('directory',
481
522
            help='Branch to examine, '
482
 
                 'rather than the one containing the working directory.',
483
 
            short_name='d',
484
 
            type=unicode,
485
 
            ),
 
523
                 'rather than the one containing the working directory.'),
 
524
        Option('tree', help='Show revno of working tree'),
486
525
        ]
487
526
 
488
527
    @display_command
489
 
    def run(self, revision=None, directory=u'.', revision_info_list=[]):
 
528
    def run(self, revision=None, directory=u'.', tree=False,
 
529
            revision_info_list=[]):
490
530
 
491
 
        revs = []
 
531
        try:
 
532
            wt = WorkingTree.open_containing(directory)[0]
 
533
            b = wt.branch
 
534
            self.add_cleanup(wt.lock_read().unlock)
 
535
        except (errors.NoWorkingTree, errors.NotLocalUrl):
 
536
            wt = None
 
537
            b = Branch.open_containing(directory)[0]
 
538
            self.add_cleanup(b.lock_read().unlock)
 
539
        revision_ids = []
492
540
        if revision is not None:
493
 
            revs.extend(revision)
 
541
            revision_ids.extend(rev.as_revision_id(b) for rev in revision)
494
542
        if revision_info_list is not None:
495
 
            for rev in revision_info_list:
496
 
                revs.append(RevisionSpec.from_string(rev))
497
 
 
498
 
        b = Branch.open_containing(directory)[0]
499
 
 
500
 
        if len(revs) == 0:
501
 
            revs.append(RevisionSpec.from_string('-1'))
502
 
 
503
 
        for rev in revs:
504
 
            revision_id = rev.as_revision_id(b)
 
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())
 
552
            else:
 
553
                revision_ids.append(b.last_revision())
 
554
 
 
555
        revinfos = []
 
556
        maxlen = 0
 
557
        for revision_id in revision_ids:
505
558
            try:
506
 
                revno = '%4d' % (b.revision_id_to_revno(revision_id))
 
559
                dotted_revno = b.revision_id_to_dotted_revno(revision_id)
 
560
                revno = '.'.join(str(i) for i in dotted_revno)
507
561
            except errors.NoSuchRevision:
508
 
                dotted_map = b.get_revision_id_to_revno_map()
509
 
                revno = '.'.join(str(i) for i in dotted_map[revision_id])
510
 
            print '%s %s' % (revno, revision_id)
 
562
                revno = '???'
 
563
            maxlen = max(maxlen, len(revno))
 
564
            revinfos.append([revno, revision_id])
 
565
 
 
566
        self.cleanup_now()
 
567
        for ri in revinfos:
 
568
            self.outf.write('%*s %s\n' % (maxlen, ri[0], ri[1]))
511
569
 
512
570
 
513
571
class cmd_add(Command):
514
 
    """Add specified files or directories.
 
572
    __doc__ = """Add specified files or directories.
515
573
 
516
574
    In non-recursive mode, all the named items are added, regardless
517
575
    of whether they were previously ignored.  A warning is given if
543
601
    branches that will be merged later (without showing the two different
544
602
    adds as a conflict). It is also useful when merging another project
545
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.
546
607
    """
547
608
    takes_args = ['file*']
548
609
    takes_options = [
556
617
               help='Lookup file ids from this tree.'),
557
618
        ]
558
619
    encoding_type = 'replace'
559
 
    _see_also = ['remove']
 
620
    _see_also = ['remove', 'ignore']
560
621
 
561
622
    def run(self, file_list, no_recurse=False, dry_run=False, verbose=False,
562
623
            file_ids_from=None):
579
640
                should_print=(not is_quiet()))
580
641
 
581
642
        if base_tree:
582
 
            base_tree.lock_read()
583
 
        try:
584
 
            file_list = self._maybe_expand_globs(file_list)
585
 
            tree, file_list = tree_files_for_add(file_list)
586
 
            added, ignored = tree.smart_add(file_list, not
587
 
                no_recurse, action=action, save=not dry_run)
588
 
        finally:
589
 
            if base_tree is not None:
590
 
                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()
591
648
        if len(ignored) > 0:
592
649
            if verbose:
593
650
                for glob in sorted(ignored.keys()):
594
651
                    for path in ignored[glob]:
595
652
                        self.outf.write("ignored %s matching \"%s\"\n"
596
653
                                        % (path, glob))
597
 
            else:
598
 
                match_len = 0
599
 
                for glob, paths in ignored.items():
600
 
                    match_len += len(paths)
601
 
                self.outf.write("ignored %d file(s).\n" % match_len)
602
 
            self.outf.write("If you wish to add some of these files,"
603
 
                            " please add them by name.\n")
604
654
 
605
655
 
606
656
class cmd_mkdir(Command):
607
 
    """Create a new versioned directory.
 
657
    __doc__ = """Create a new versioned directory.
608
658
 
609
659
    This is equivalent to creating the directory and then adding it.
610
660
    """
614
664
 
615
665
    def run(self, dir_list):
616
666
        for d in dir_list:
617
 
            os.mkdir(d)
618
667
            wt, dd = WorkingTree.open_containing(d)
619
 
            wt.add([dd])
620
 
            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)
621
676
 
622
677
 
623
678
class cmd_relpath(Command):
624
 
    """Show path of a file relative to root"""
 
679
    __doc__ = """Show path of a file relative to root"""
625
680
 
626
681
    takes_args = ['filename']
627
682
    hidden = True
636
691
 
637
692
 
638
693
class cmd_inventory(Command):
639
 
    """Show inventory of the current working copy or a revision.
 
694
    __doc__ = """Show inventory of the current working copy or a revision.
640
695
 
641
696
    It is possible to limit the output to a particular entry
642
697
    type using the --kind option.  For example: --kind file.
663
718
 
664
719
        revision = _get_one_revision('inventory', revision)
665
720
        work_tree, file_list = tree_files(file_list)
666
 
        work_tree.lock_read()
667
 
        try:
668
 
            if revision is not None:
669
 
                tree = revision.as_tree(work_tree.branch)
670
 
 
671
 
                extra_trees = [work_tree]
672
 
                tree.lock_read()
673
 
            else:
674
 
                tree = work_tree
675
 
                extra_trees = []
676
 
 
677
 
            if file_list is not None:
678
 
                file_ids = tree.paths2ids(file_list, trees=extra_trees,
679
 
                                          require_versioned=True)
680
 
                # find_ids_across_trees may include some paths that don't
681
 
                # exist in 'tree'.
682
 
                entries = sorted((tree.id2path(file_id), tree.inventory[file_id])
683
 
                                 for file_id in file_ids if file_id in tree)
684
 
            else:
685
 
                entries = tree.inventory.entries()
686
 
        finally:
687
 
            tree.unlock()
688
 
            if tree is not work_tree:
689
 
                work_tree.unlock()
690
 
 
 
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()
691
742
        for path, entry in entries:
692
743
            if kind and kind != entry.kind:
693
744
                continue
699
750
 
700
751
 
701
752
class cmd_mv(Command):
702
 
    """Move or rename a file.
 
753
    __doc__ = """Move or rename a file.
703
754
 
704
755
    :Usage:
705
756
        bzr mv OLDNAME NEWNAME
722
773
    takes_args = ['names*']
723
774
    takes_options = [Option("after", help="Move only the bzr identifier"
724
775
        " of the file, because the file has already been moved."),
 
776
        Option('auto', help='Automatically guess renames.'),
 
777
        Option('dry-run', help='Avoid making changes when guessing renames.'),
725
778
        ]
726
779
    aliases = ['move', 'rename']
727
780
    encoding_type = 'replace'
728
781
 
729
 
    def run(self, names_list, after=False):
 
782
    def run(self, names_list, after=False, auto=False, dry_run=False):
 
783
        if auto:
 
784
            return self.run_auto(names_list, after, dry_run)
 
785
        elif dry_run:
 
786
            raise errors.BzrCommandError('--dry-run requires --auto.')
730
787
        if names_list is None:
731
788
            names_list = []
732
 
 
733
789
        if len(names_list) < 2:
734
790
            raise errors.BzrCommandError("missing file argument")
735
791
        tree, rel_names = tree_files(names_list, canonicalize=False)
736
 
        tree.lock_write()
737
 
        try:
738
 
            self._run(tree, names_list, rel_names, after)
739
 
        finally:
740
 
            tree.unlock()
 
792
        self.add_cleanup(tree.lock_tree_write().unlock)
 
793
        self._run(tree, names_list, rel_names, after)
 
794
 
 
795
    def run_auto(self, names_list, after, dry_run):
 
796
        if names_list is not None and len(names_list) > 1:
 
797
            raise errors.BzrCommandError('Only one path may be specified to'
 
798
                                         ' --auto.')
 
799
        if after:
 
800
            raise errors.BzrCommandError('--after cannot be specified with'
 
801
                                         ' --auto.')
 
802
        work_tree, file_list = tree_files(names_list, default_branch='.')
 
803
        self.add_cleanup(work_tree.lock_tree_write().unlock)
 
804
        rename_map.RenameMap.guess_renames(work_tree, dry_run)
741
805
 
742
806
    def _run(self, tree, names_list, rel_names, after):
743
807
        into_existing = osutils.isdir(names_list[-1])
764
828
            # All entries reference existing inventory items, so fix them up
765
829
            # for cicp file-systems.
766
830
            rel_names = tree.get_canonical_inventory_paths(rel_names)
767
 
            for pair in tree.move(rel_names[:-1], rel_names[-1], after=after):
768
 
                self.outf.write("%s => %s\n" % pair)
 
831
            for src, dest in tree.move(rel_names[:-1], rel_names[-1], after=after):
 
832
                if not is_quiet():
 
833
                    self.outf.write("%s => %s\n" % (src, dest))
769
834
        else:
770
835
            if len(names_list) != 2:
771
836
                raise errors.BzrCommandError('to mv multiple files the'
815
880
            dest = osutils.pathjoin(dest_parent, dest_tail)
816
881
            mutter("attempting to move %s => %s", src, dest)
817
882
            tree.rename_one(src, dest, after=after)
818
 
            self.outf.write("%s => %s\n" % (src, dest))
 
883
            if not is_quiet():
 
884
                self.outf.write("%s => %s\n" % (src, dest))
819
885
 
820
886
 
821
887
class cmd_pull(Command):
822
 
    """Turn this branch into a mirror of another branch.
 
888
    __doc__ = """Turn this branch into a mirror of another branch.
823
889
 
824
 
    This command only works on branches that have not diverged.  Branches are
825
 
    considered diverged if the destination branch's most recent commit is one
826
 
    that has not been merged (directly or indirectly) into the parent.
 
890
    By default, this command only works on branches that have not diverged.
 
891
    Branches are considered diverged if the destination branch's most recent 
 
892
    commit is one that has not been merged (directly or indirectly) into the 
 
893
    parent.
827
894
 
828
895
    If branches have diverged, you can use 'bzr merge' to integrate the changes
829
896
    from one into the other.  Once one branch has merged, the other should
830
897
    be able to pull it again.
831
898
 
832
 
    If you want to forget your local changes and just update your branch to
833
 
    match the remote one, use pull --overwrite.
 
899
    If you want to replace your local changes and just want your branch to
 
900
    match the remote one, use pull --overwrite. This will work even if the two
 
901
    branches have diverged.
834
902
 
835
903
    If there is no default location set, the first pull will set it.  After
836
904
    that, you can omit the location to use the default.  To change the
846
914
    takes_options = ['remember', 'overwrite', 'revision',
847
915
        custom_help('verbose',
848
916
            help='Show logs of pulled revisions.'),
849
 
        Option('directory',
 
917
        custom_help('directory',
850
918
            help='Branch to pull into, '
851
 
                 'rather than the one containing the working directory.',
852
 
            short_name='d',
853
 
            type=unicode,
 
919
                 'rather than the one containing the working directory.'),
 
920
        Option('local',
 
921
            help="Perform a local pull in a bound "
 
922
                 "branch.  Local pulls are not applied to "
 
923
                 "the master branch."
854
924
            ),
855
925
        ]
856
926
    takes_args = ['location?']
858
928
 
859
929
    def run(self, location=None, remember=False, overwrite=False,
860
930
            revision=None, verbose=False,
861
 
            directory=None):
 
931
            directory=None, local=False):
862
932
        # FIXME: too much stuff is in the command class
863
933
        revision_id = None
864
934
        mergeable = None
867
937
        try:
868
938
            tree_to = WorkingTree.open_containing(directory)[0]
869
939
            branch_to = tree_to.branch
 
940
            self.add_cleanup(tree_to.lock_write().unlock)
870
941
        except errors.NoWorkingTree:
871
942
            tree_to = None
872
943
            branch_to = Branch.open_containing(directory)[0]
 
944
            self.add_cleanup(branch_to.lock_write().unlock)
 
945
 
 
946
        if local and not branch_to.get_bound_location():
 
947
            raise errors.LocalRequiresBoundBranch()
873
948
 
874
949
        possible_transports = []
875
950
        if location is not None:
903
978
        else:
904
979
            branch_from = Branch.open(location,
905
980
                possible_transports=possible_transports)
 
981
            self.add_cleanup(branch_from.lock_read().unlock)
906
982
 
907
983
            if branch_to.get_parent() is None or remember:
908
984
                branch_to.set_parent(branch_from.base)
910
986
        if revision is not None:
911
987
            revision_id = revision.as_revision_id(branch_from)
912
988
 
913
 
        branch_to.lock_write()
914
 
        try:
915
 
            if tree_to is not None:
916
 
                view_info = _get_view_info_for_change_reporter(tree_to)
917
 
                change_reporter = delta._ChangeReporter(
918
 
                    unversioned_filter=tree_to.is_ignored, view_info=view_info)
919
 
                result = tree_to.pull(branch_from, overwrite, revision_id,
920
 
                                      change_reporter,
921
 
                                      possible_transports=possible_transports)
922
 
            else:
923
 
                result = branch_to.pull(branch_from, overwrite, revision_id)
 
989
        if tree_to is not None:
 
990
            view_info = _get_view_info_for_change_reporter(tree_to)
 
991
            change_reporter = delta._ChangeReporter(
 
992
                unversioned_filter=tree_to.is_ignored,
 
993
                view_info=view_info)
 
994
            result = tree_to.pull(
 
995
                branch_from, overwrite, revision_id, change_reporter,
 
996
                possible_transports=possible_transports, local=local)
 
997
        else:
 
998
            result = branch_to.pull(
 
999
                branch_from, overwrite, revision_id, local=local)
924
1000
 
925
 
            result.report(self.outf)
926
 
            if verbose and result.old_revid != result.new_revid:
927
 
                log.show_branch_change(branch_to, self.outf, result.old_revno,
928
 
                                       result.old_revid)
929
 
        finally:
930
 
            branch_to.unlock()
 
1001
        result.report(self.outf)
 
1002
        if verbose and result.old_revid != result.new_revid:
 
1003
            log.show_branch_change(
 
1004
                branch_to, self.outf, result.old_revno,
 
1005
                result.old_revid)
931
1006
 
932
1007
 
933
1008
class cmd_push(Command):
934
 
    """Update a mirror of this branch.
 
1009
    __doc__ = """Update a mirror of this branch.
935
1010
 
936
1011
    The target branch will not have its working tree populated because this
937
1012
    is both expensive, and is not supported on remote file systems.
961
1036
        Option('create-prefix',
962
1037
               help='Create the path leading up to the branch '
963
1038
                    'if it does not already exist.'),
964
 
        Option('directory',
 
1039
        custom_help('directory',
965
1040
            help='Branch to push from, '
966
 
                 'rather than the one containing the working directory.',
967
 
            short_name='d',
968
 
            type=unicode,
969
 
            ),
 
1041
                 'rather than the one containing the working directory.'),
970
1042
        Option('use-existing-dir',
971
1043
               help='By default push will fail if the target'
972
1044
                    ' directory exists, but does not already'
980
1052
                'for the commit history. Only the work not present in the '
981
1053
                'referenced branch is included in the branch created.',
982
1054
            type=unicode),
 
1055
        Option('strict',
 
1056
               help='Refuse to push if there are uncommitted changes in'
 
1057
               ' the working tree, --no-strict disables the check.'),
983
1058
        ]
984
1059
    takes_args = ['location?']
985
1060
    encoding_type = 'replace'
987
1062
    def run(self, location=None, remember=False, overwrite=False,
988
1063
        create_prefix=False, verbose=False, revision=None,
989
1064
        use_existing_dir=False, directory=None, stacked_on=None,
990
 
        stacked=False):
 
1065
        stacked=False, strict=None):
991
1066
        from bzrlib.push import _show_push_branch
992
1067
 
993
 
        # Get the source branch and revision_id
994
1068
        if directory is None:
995
1069
            directory = '.'
996
 
        br_from = Branch.open_containing(directory)[0]
 
1070
        # Get the source branch
 
1071
        (tree, br_from,
 
1072
         _unused) = bzrdir.BzrDir.open_containing_tree_or_branch(directory)
 
1073
        # Get the tip's revision_id
997
1074
        revision = _get_one_revision('push', revision)
998
1075
        if revision is not None:
999
1076
            revision_id = revision.in_history(br_from).rev_id
1000
1077
        else:
1001
 
            revision_id = br_from.last_revision()
1002
 
 
 
1078
            revision_id = None
 
1079
        if tree is not None and revision_id is None:
 
1080
            tree.check_changed_or_out_of_date(
 
1081
                strict, 'push_strict',
 
1082
                more_error='Use --no-strict to force the push.',
 
1083
                more_warning='Uncommitted changes will not be pushed.')
1003
1084
        # Get the stacked_on branch, if any
1004
1085
        if stacked_on is not None:
1005
1086
            stacked_on = urlutils.normalize_url(stacked_on)
1037
1118
 
1038
1119
 
1039
1120
class cmd_branch(Command):
1040
 
    """Create a new copy of a branch.
 
1121
    __doc__ = """Create a new branch that is a copy of an existing branch.
1041
1122
 
1042
1123
    If the TO_LOCATION is omitted, the last component of the FROM_LOCATION will
1043
1124
    be used.  In other words, "branch ../foo/bar" will attempt to create ./bar.
1056
1137
        help='Hard-link working tree files where possible.'),
1057
1138
        Option('no-tree',
1058
1139
            help="Create a branch without a working-tree."),
 
1140
        Option('switch',
 
1141
            help="Switch the checkout in the current directory "
 
1142
                 "to the new branch."),
1059
1143
        Option('stacked',
1060
1144
            help='Create a stacked branch referring to the source branch. '
1061
1145
                'The new branch will depend on the availability of the source '
1062
1146
                'branch for all operations.'),
1063
1147
        Option('standalone',
1064
1148
               help='Do not use a shared repository, even if available.'),
 
1149
        Option('use-existing-dir',
 
1150
               help='By default branch will fail if the target'
 
1151
                    ' directory exists, but does not already'
 
1152
                    ' have a control directory.  This flag will'
 
1153
                    ' allow branch to proceed.'),
 
1154
        Option('bind',
 
1155
            help="Bind new branch to from location."),
1065
1156
        ]
1066
1157
    aliases = ['get', 'clone']
1067
1158
 
1068
1159
    def run(self, from_location, to_location=None, revision=None,
1069
 
            hardlink=False, stacked=False, standalone=False, no_tree=False):
 
1160
            hardlink=False, stacked=False, standalone=False, no_tree=False,
 
1161
            use_existing_dir=False, switch=False, bind=False):
 
1162
        from bzrlib import switch as _mod_switch
1070
1163
        from bzrlib.tag import _merge_tags_if_possible
1071
 
 
1072
1164
        accelerator_tree, br_from = bzrdir.BzrDir.open_tree_or_branch(
1073
1165
            from_location)
1074
1166
        revision = _get_one_revision('branch', revision)
1075
 
        br_from.lock_read()
 
1167
        self.add_cleanup(br_from.lock_read().unlock)
 
1168
        if revision is not None:
 
1169
            revision_id = revision.as_revision_id(br_from)
 
1170
        else:
 
1171
            # FIXME - wt.last_revision, fallback to branch, fall back to
 
1172
            # None or perhaps NULL_REVISION to mean copy nothing
 
1173
            # RBC 20060209
 
1174
            revision_id = br_from.last_revision()
 
1175
        if to_location is None:
 
1176
            to_location = urlutils.derive_to_location(from_location)
 
1177
        to_transport = transport.get_transport(to_location)
1076
1178
        try:
1077
 
            if revision is not None:
1078
 
                revision_id = revision.as_revision_id(br_from)
 
1179
            to_transport.mkdir('.')
 
1180
        except errors.FileExists:
 
1181
            if not use_existing_dir:
 
1182
                raise errors.BzrCommandError('Target directory "%s" '
 
1183
                    'already exists.' % to_location)
1079
1184
            else:
1080
 
                # FIXME - wt.last_revision, fallback to branch, fall back to
1081
 
                # None or perhaps NULL_REVISION to mean copy nothing
1082
 
                # RBC 20060209
1083
 
                revision_id = br_from.last_revision()
1084
 
            if to_location is None:
1085
 
                to_location = urlutils.derive_to_location(from_location)
1086
 
            to_transport = transport.get_transport(to_location)
1087
 
            try:
1088
 
                to_transport.mkdir('.')
1089
 
            except errors.FileExists:
1090
 
                raise errors.BzrCommandError('Target directory "%s" already'
1091
 
                                             ' exists.' % to_location)
1092
 
            except errors.NoSuchFile:
1093
 
                raise errors.BzrCommandError('Parent of "%s" does not exist.'
1094
 
                                             % to_location)
1095
 
            try:
1096
 
                # preserve whatever source format we have.
1097
 
                dir = br_from.bzrdir.sprout(to_transport.base, revision_id,
1098
 
                                            possible_transports=[to_transport],
1099
 
                                            accelerator_tree=accelerator_tree,
1100
 
                                            hardlink=hardlink, stacked=stacked,
1101
 
                                            force_new_repo=standalone,
1102
 
                                            create_tree_if_local=not no_tree,
1103
 
                                            source_branch=br_from)
1104
 
                branch = dir.open_branch()
1105
 
            except errors.NoSuchRevision:
1106
 
                to_transport.delete_tree('.')
1107
 
                msg = "The branch %s has no revision %s." % (from_location,
1108
 
                    revision)
1109
 
                raise errors.BzrCommandError(msg)
1110
 
            _merge_tags_if_possible(br_from, branch)
1111
 
            # If the source branch is stacked, the new branch may
1112
 
            # be stacked whether we asked for that explicitly or not.
1113
 
            # We therefore need a try/except here and not just 'if stacked:'
1114
 
            try:
1115
 
                note('Created new stacked branch referring to %s.' %
1116
 
                    branch.get_stacked_on_url())
1117
 
            except (errors.NotStacked, errors.UnstackableBranchFormat,
1118
 
                errors.UnstackableRepositoryFormat), e:
1119
 
                note('Branched %d revision(s).' % branch.revno())
1120
 
        finally:
1121
 
            br_from.unlock()
 
1185
                try:
 
1186
                    bzrdir.BzrDir.open_from_transport(to_transport)
 
1187
                except errors.NotBranchError:
 
1188
                    pass
 
1189
                else:
 
1190
                    raise errors.AlreadyBranchError(to_location)
 
1191
        except errors.NoSuchFile:
 
1192
            raise errors.BzrCommandError('Parent of "%s" does not exist.'
 
1193
                                         % to_location)
 
1194
        try:
 
1195
            # preserve whatever source format we have.
 
1196
            dir = br_from.bzrdir.sprout(to_transport.base, revision_id,
 
1197
                                        possible_transports=[to_transport],
 
1198
                                        accelerator_tree=accelerator_tree,
 
1199
                                        hardlink=hardlink, stacked=stacked,
 
1200
                                        force_new_repo=standalone,
 
1201
                                        create_tree_if_local=not no_tree,
 
1202
                                        source_branch=br_from)
 
1203
            branch = dir.open_branch()
 
1204
        except errors.NoSuchRevision:
 
1205
            to_transport.delete_tree('.')
 
1206
            msg = "The branch %s has no revision %s." % (from_location,
 
1207
                revision)
 
1208
            raise errors.BzrCommandError(msg)
 
1209
        _merge_tags_if_possible(br_from, branch)
 
1210
        # If the source branch is stacked, the new branch may
 
1211
        # be stacked whether we asked for that explicitly or not.
 
1212
        # We therefore need a try/except here and not just 'if stacked:'
 
1213
        try:
 
1214
            note('Created new stacked branch referring to %s.' %
 
1215
                branch.get_stacked_on_url())
 
1216
        except (errors.NotStacked, errors.UnstackableBranchFormat,
 
1217
            errors.UnstackableRepositoryFormat), e:
 
1218
            note('Branched %d revision(s).' % branch.revno())
 
1219
        if bind:
 
1220
            # Bind to the parent
 
1221
            parent_branch = Branch.open(from_location)
 
1222
            branch.bind(parent_branch)
 
1223
            note('New branch bound to %s' % from_location)
 
1224
        if switch:
 
1225
            # Switch to the new branch
 
1226
            wt, _ = WorkingTree.open_containing('.')
 
1227
            _mod_switch.switch(wt.bzrdir, branch)
 
1228
            note('Switched to branch: %s',
 
1229
                urlutils.unescape_for_display(branch.base, 'utf-8'))
1122
1230
 
1123
1231
 
1124
1232
class cmd_checkout(Command):
1125
 
    """Create a new checkout of an existing branch.
 
1233
    __doc__ = """Create a new checkout of an existing branch.
1126
1234
 
1127
1235
    If BRANCH_LOCATION is omitted, checkout will reconstitute a working tree for
1128
1236
    the branch found in '.'. This is useful if you have removed the working tree
1191
1299
 
1192
1300
 
1193
1301
class cmd_renames(Command):
1194
 
    """Show list of renamed files.
 
1302
    __doc__ = """Show list of renamed files.
1195
1303
    """
1196
1304
    # TODO: Option to show renames between two historical versions.
1197
1305
 
1202
1310
    @display_command
1203
1311
    def run(self, dir=u'.'):
1204
1312
        tree = WorkingTree.open_containing(dir)[0]
1205
 
        tree.lock_read()
1206
 
        try:
1207
 
            new_inv = tree.inventory
1208
 
            old_tree = tree.basis_tree()
1209
 
            old_tree.lock_read()
1210
 
            try:
1211
 
                old_inv = old_tree.inventory
1212
 
                renames = []
1213
 
                iterator = tree.iter_changes(old_tree, include_unchanged=True)
1214
 
                for f, paths, c, v, p, n, k, e in iterator:
1215
 
                    if paths[0] == paths[1]:
1216
 
                        continue
1217
 
                    if None in (paths):
1218
 
                        continue
1219
 
                    renames.append(paths)
1220
 
                renames.sort()
1221
 
                for old_name, new_name in renames:
1222
 
                    self.outf.write("%s => %s\n" % (old_name, new_name))
1223
 
            finally:
1224
 
                old_tree.unlock()
1225
 
        finally:
1226
 
            tree.unlock()
 
1313
        self.add_cleanup(tree.lock_read().unlock)
 
1314
        new_inv = tree.inventory
 
1315
        old_tree = tree.basis_tree()
 
1316
        self.add_cleanup(old_tree.lock_read().unlock)
 
1317
        old_inv = old_tree.inventory
 
1318
        renames = []
 
1319
        iterator = tree.iter_changes(old_tree, include_unchanged=True)
 
1320
        for f, paths, c, v, p, n, k, e in iterator:
 
1321
            if paths[0] == paths[1]:
 
1322
                continue
 
1323
            if None in (paths):
 
1324
                continue
 
1325
            renames.append(paths)
 
1326
        renames.sort()
 
1327
        for old_name, new_name in renames:
 
1328
            self.outf.write("%s => %s\n" % (old_name, new_name))
1227
1329
 
1228
1330
 
1229
1331
class cmd_update(Command):
1230
 
    """Update a tree to have the latest code committed to its branch.
 
1332
    __doc__ = """Update a tree to have the latest code committed to its branch.
1231
1333
 
1232
1334
    This will perform a merge into the working tree, and may generate
1233
1335
    conflicts. If you have any local changes, you will still
1235
1337
 
1236
1338
    If you want to discard your local changes, you can just do a
1237
1339
    'bzr revert' instead of 'bzr commit' after the update.
 
1340
 
 
1341
    If the tree's branch is bound to a master branch, it will also update
 
1342
    the branch from the master.
1238
1343
    """
1239
1344
 
1240
1345
    _see_also = ['pull', 'working-trees', 'status-flags']
1241
1346
    takes_args = ['dir?']
 
1347
    takes_options = ['revision']
1242
1348
    aliases = ['up']
1243
1349
 
1244
 
    def run(self, dir='.'):
 
1350
    def run(self, dir='.', revision=None):
 
1351
        if revision is not None and len(revision) != 1:
 
1352
            raise errors.BzrCommandError(
 
1353
                        "bzr update --revision takes exactly one revision")
1245
1354
        tree = WorkingTree.open_containing(dir)[0]
 
1355
        branch = tree.branch
1246
1356
        possible_transports = []
1247
 
        master = tree.branch.get_master_branch(
 
1357
        master = branch.get_master_branch(
1248
1358
            possible_transports=possible_transports)
1249
1359
        if master is not None:
 
1360
            branch_location = master.base
1250
1361
            tree.lock_write()
1251
1362
        else:
 
1363
            branch_location = tree.branch.base
1252
1364
            tree.lock_tree_write()
 
1365
        self.add_cleanup(tree.unlock)
 
1366
        # get rid of the final '/' and be ready for display
 
1367
        branch_location = urlutils.unescape_for_display(
 
1368
            branch_location.rstrip('/'),
 
1369
            self.outf.encoding)
 
1370
        existing_pending_merges = tree.get_parent_ids()[1:]
 
1371
        if master is None:
 
1372
            old_tip = None
 
1373
        else:
 
1374
            # may need to fetch data into a heavyweight checkout
 
1375
            # XXX: this may take some time, maybe we should display a
 
1376
            # message
 
1377
            old_tip = branch.update(possible_transports)
 
1378
        if revision is not None:
 
1379
            revision_id = revision[0].as_revision_id(branch)
 
1380
        else:
 
1381
            revision_id = branch.last_revision()
 
1382
        if revision_id == _mod_revision.ensure_null(tree.last_revision()):
 
1383
            revno = branch.revision_id_to_dotted_revno(revision_id)
 
1384
            note("Tree is up to date at revision %s of branch %s" %
 
1385
                ('.'.join(map(str, revno)), branch_location))
 
1386
            return 0
 
1387
        view_info = _get_view_info_for_change_reporter(tree)
 
1388
        change_reporter = delta._ChangeReporter(
 
1389
            unversioned_filter=tree.is_ignored,
 
1390
            view_info=view_info)
1253
1391
        try:
1254
 
            existing_pending_merges = tree.get_parent_ids()[1:]
1255
 
            last_rev = _mod_revision.ensure_null(tree.last_revision())
1256
 
            if last_rev == _mod_revision.ensure_null(
1257
 
                tree.branch.last_revision()):
1258
 
                # may be up to date, check master too.
1259
 
                if master is None or last_rev == _mod_revision.ensure_null(
1260
 
                    master.last_revision()):
1261
 
                    revno = tree.branch.revision_id_to_revno(last_rev)
1262
 
                    note("Tree is up to date at revision %d." % (revno,))
1263
 
                    return 0
1264
 
            view_info = _get_view_info_for_change_reporter(tree)
1265
1392
            conflicts = tree.update(
1266
 
                delta._ChangeReporter(unversioned_filter=tree.is_ignored,
1267
 
                view_info=view_info), possible_transports=possible_transports)
1268
 
            revno = tree.branch.revision_id_to_revno(
1269
 
                _mod_revision.ensure_null(tree.last_revision()))
1270
 
            note('Updated to revision %d.' % (revno,))
1271
 
            if tree.get_parent_ids()[1:] != existing_pending_merges:
1272
 
                note('Your local commits will now show as pending merges with '
1273
 
                     "'bzr status', and can be committed with 'bzr commit'.")
1274
 
            if conflicts != 0:
1275
 
                return 1
1276
 
            else:
1277
 
                return 0
1278
 
        finally:
1279
 
            tree.unlock()
 
1393
                change_reporter,
 
1394
                possible_transports=possible_transports,
 
1395
                revision=revision_id,
 
1396
                old_tip=old_tip)
 
1397
        except errors.NoSuchRevision, e:
 
1398
            raise errors.BzrCommandError(
 
1399
                                  "branch has no revision %s\n"
 
1400
                                  "bzr update --revision only works"
 
1401
                                  " for a revision in the branch history"
 
1402
                                  % (e.revision))
 
1403
        revno = tree.branch.revision_id_to_dotted_revno(
 
1404
            _mod_revision.ensure_null(tree.last_revision()))
 
1405
        note('Updated to revision %s of branch %s' %
 
1406
             ('.'.join(map(str, revno)), branch_location))
 
1407
        parent_ids = tree.get_parent_ids()
 
1408
        if parent_ids[1:] and parent_ids[1:] != existing_pending_merges:
 
1409
            note('Your local commits will now show as pending merges with '
 
1410
                 "'bzr status', and can be committed with 'bzr commit'.")
 
1411
        if conflicts != 0:
 
1412
            return 1
 
1413
        else:
 
1414
            return 0
1280
1415
 
1281
1416
 
1282
1417
class cmd_info(Command):
1283
 
    """Show information about a working tree, branch or repository.
 
1418
    __doc__ = """Show information about a working tree, branch or repository.
1284
1419
 
1285
1420
    This command will show all known locations and formats associated to the
1286
1421
    tree, branch or repository.
1301
1436
      basic statistics (like the number of files in the working tree and
1302
1437
      number of revisions in the branch and repository):
1303
1438
 
1304
 
        bzr -v info
 
1439
        bzr info -v
1305
1440
 
1306
1441
      Display the above together with number of committers to the branch:
1307
1442
 
1308
 
        bzr -vv info
 
1443
        bzr info -vv
1309
1444
    """
1310
1445
    _see_also = ['revno', 'working-trees', 'repositories']
1311
1446
    takes_args = ['location?']
1324
1459
 
1325
1460
 
1326
1461
class cmd_remove(Command):
1327
 
    """Remove files or directories.
 
1462
    __doc__ = """Remove files or directories.
1328
1463
 
1329
1464
    This makes bzr stop tracking changes to the specified files. bzr will delete
1330
1465
    them if they can easily be recovered using revert. If no options or
1339
1474
            title='Deletion Strategy', value_switches=True, enum_switch=False,
1340
1475
            safe='Only delete files if they can be'
1341
1476
                 ' safely recovered (default).',
1342
 
            keep="Don't delete any files.",
 
1477
            keep='Delete from bzr but leave the working copy.',
1343
1478
            force='Delete all the specified files, even if they can not be '
1344
1479
                'recovered and even if they are non-empty directories.')]
1345
1480
    aliases = ['rm', 'del']
1352
1487
        if file_list is not None:
1353
1488
            file_list = [f for f in file_list]
1354
1489
 
1355
 
        tree.lock_write()
1356
 
        try:
1357
 
            # Heuristics should probably all move into tree.remove_smart or
1358
 
            # some such?
1359
 
            if new:
1360
 
                added = tree.changes_from(tree.basis_tree(),
1361
 
                    specific_files=file_list).added
1362
 
                file_list = sorted([f[0] for f in added], reverse=True)
1363
 
                if len(file_list) == 0:
1364
 
                    raise errors.BzrCommandError('No matching files.')
1365
 
            elif file_list is None:
1366
 
                # missing files show up in iter_changes(basis) as
1367
 
                # versioned-with-no-kind.
1368
 
                missing = []
1369
 
                for change in tree.iter_changes(tree.basis_tree()):
1370
 
                    # Find paths in the working tree that have no kind:
1371
 
                    if change[1][1] is not None and change[6][1] is None:
1372
 
                        missing.append(change[1][1])
1373
 
                file_list = sorted(missing, reverse=True)
1374
 
                file_deletion_strategy = 'keep'
1375
 
            tree.remove(file_list, verbose=verbose, to_file=self.outf,
1376
 
                keep_files=file_deletion_strategy=='keep',
1377
 
                force=file_deletion_strategy=='force')
1378
 
        finally:
1379
 
            tree.unlock()
 
1490
        self.add_cleanup(tree.lock_write().unlock)
 
1491
        # Heuristics should probably all move into tree.remove_smart or
 
1492
        # some such?
 
1493
        if new:
 
1494
            added = tree.changes_from(tree.basis_tree(),
 
1495
                specific_files=file_list).added
 
1496
            file_list = sorted([f[0] for f in added], reverse=True)
 
1497
            if len(file_list) == 0:
 
1498
                raise errors.BzrCommandError('No matching files.')
 
1499
        elif file_list is None:
 
1500
            # missing files show up in iter_changes(basis) as
 
1501
            # versioned-with-no-kind.
 
1502
            missing = []
 
1503
            for change in tree.iter_changes(tree.basis_tree()):
 
1504
                # Find paths in the working tree that have no kind:
 
1505
                if change[1][1] is not None and change[6][1] is None:
 
1506
                    missing.append(change[1][1])
 
1507
            file_list = sorted(missing, reverse=True)
 
1508
            file_deletion_strategy = 'keep'
 
1509
        tree.remove(file_list, verbose=verbose, to_file=self.outf,
 
1510
            keep_files=file_deletion_strategy=='keep',
 
1511
            force=file_deletion_strategy=='force')
1380
1512
 
1381
1513
 
1382
1514
class cmd_file_id(Command):
1383
 
    """Print file_id of a particular file or directory.
 
1515
    __doc__ = """Print file_id of a particular file or directory.
1384
1516
 
1385
1517
    The file_id is assigned when the file is first added and remains the
1386
1518
    same through all revisions where the file exists, even when it is
1402
1534
 
1403
1535
 
1404
1536
class cmd_file_path(Command):
1405
 
    """Print path of file_ids to a file or directory.
 
1537
    __doc__ = """Print path of file_ids to a file or directory.
1406
1538
 
1407
1539
    This prints one line for each directory down to the target,
1408
1540
    starting at the branch root.
1424
1556
 
1425
1557
 
1426
1558
class cmd_reconcile(Command):
1427
 
    """Reconcile bzr metadata in a branch.
 
1559
    __doc__ = """Reconcile bzr metadata in a branch.
1428
1560
 
1429
1561
    This can correct data mismatches that may have been caused by
1430
1562
    previous ghost operations or bzr upgrades. You should only
1452
1584
 
1453
1585
 
1454
1586
class cmd_revision_history(Command):
1455
 
    """Display the list of revision ids on a branch."""
 
1587
    __doc__ = """Display the list of revision ids on a branch."""
1456
1588
 
1457
1589
    _see_also = ['log']
1458
1590
    takes_args = ['location?']
1468
1600
 
1469
1601
 
1470
1602
class cmd_ancestry(Command):
1471
 
    """List all revisions merged into this branch."""
 
1603
    __doc__ = """List all revisions merged into this branch."""
1472
1604
 
1473
1605
    _see_also = ['log', 'revision-history']
1474
1606
    takes_args = ['location?']
1493
1625
 
1494
1626
 
1495
1627
class cmd_init(Command):
1496
 
    """Make a directory into a versioned branch.
 
1628
    __doc__ = """Make a directory into a versioned branch.
1497
1629
 
1498
1630
    Use this to create an empty branch, or before importing an
1499
1631
    existing project.
1527
1659
                lazy_registry=('bzrlib.bzrdir', 'format_registry'),
1528
1660
                converter=lambda name: bzrdir.format_registry.make_bzrdir(name),
1529
1661
                value_switches=True,
1530
 
                title="Branch Format",
 
1662
                title="Branch format",
1531
1663
                ),
1532
1664
         Option('append-revisions-only',
1533
1665
                help='Never change revnos or the existing log.'
1556
1688
                    "\nYou may supply --create-prefix to create all"
1557
1689
                    " leading parent directories."
1558
1690
                    % location)
1559
 
            _create_prefix(to_transport)
 
1691
            to_transport.create_prefix()
1560
1692
 
1561
1693
        try:
1562
1694
            a_bzrdir = bzrdir.BzrDir.open_from_transport(to_transport)
1580
1712
                branch.set_append_revisions_only(True)
1581
1713
            except errors.UpgradeRequired:
1582
1714
                raise errors.BzrCommandError('This branch format cannot be set'
1583
 
                    ' to append-revisions-only.  Try --experimental-branch6')
 
1715
                    ' to append-revisions-only.  Try --default.')
1584
1716
        if not is_quiet():
1585
1717
            from bzrlib.info import describe_layout, describe_format
1586
1718
            try:
1602
1734
 
1603
1735
 
1604
1736
class cmd_init_repository(Command):
1605
 
    """Create a shared repository to hold branches.
 
1737
    __doc__ = """Create a shared repository for branches to share storage space.
1606
1738
 
1607
1739
    New branches created under the repository directory will store their
1608
 
    revisions in the repository, not in the branch directory.
 
1740
    revisions in the repository, not in the branch directory.  For branches
 
1741
    with shared history, this reduces the amount of storage needed and 
 
1742
    speeds up the creation of new branches.
1609
1743
 
1610
 
    If the --no-trees option is used then the branches in the repository
1611
 
    will not have working trees by default.
 
1744
    If the --no-trees option is given then the branches in the repository
 
1745
    will not have working trees by default.  They will still exist as 
 
1746
    directories on disk, but they will not have separate copies of the 
 
1747
    files at a certain revision.  This can be useful for repositories that
 
1748
    store branches which are interacted with through checkouts or remote
 
1749
    branches, such as on a server.
1612
1750
 
1613
1751
    :Examples:
1614
 
        Create a shared repositories holding just branches::
 
1752
        Create a shared repository holding just branches::
1615
1753
 
1616
1754
            bzr init-repo --no-trees repo
1617
1755
            bzr init repo/trunk
1656
1794
 
1657
1795
 
1658
1796
class cmd_diff(Command):
1659
 
    """Show differences in the working tree, between revisions or branches.
 
1797
    __doc__ = """Show differences in the working tree, between revisions or branches.
1660
1798
 
1661
1799
    If no arguments are given, all changes for the current tree are listed.
1662
1800
    If files are given, only the changes in those files are listed.
1683
1821
 
1684
1822
            bzr diff -r1
1685
1823
 
1686
 
        Difference between revision 2 and revision 1::
1687
 
 
1688
 
            bzr diff -r1..2
1689
 
 
1690
 
        Difference between revision 2 and revision 1 for branch xxx::
1691
 
 
1692
 
            bzr diff -r1..2 xxx
 
1824
        Difference between revision 3 and revision 1::
 
1825
 
 
1826
            bzr diff -r1..3
 
1827
 
 
1828
        Difference between revision 3 and revision 1 for branch xxx::
 
1829
 
 
1830
            bzr diff -r1..3 xxx
 
1831
 
 
1832
        To see the changes introduced in revision X::
 
1833
        
 
1834
            bzr diff -cX
 
1835
 
 
1836
        Note that in the case of a merge, the -c option shows the changes
 
1837
        compared to the left hand parent. To see the changes against
 
1838
        another parent, use::
 
1839
 
 
1840
            bzr diff -r<chosen_parent>..X
 
1841
 
 
1842
        The changes introduced by revision 2 (equivalent to -r1..2)::
 
1843
 
 
1844
            bzr diff -c2
1693
1845
 
1694
1846
        Show just the differences for file NEWS::
1695
1847
 
1734
1886
            help='Use this command to compare files.',
1735
1887
            type=unicode,
1736
1888
            ),
 
1889
        RegistryOption('format',
 
1890
            help='Diff format to use.',
 
1891
            lazy_registry=('bzrlib.diff', 'format_registry'),
 
1892
            value_switches=False, title='Diff format'),
1737
1893
        ]
1738
1894
    aliases = ['di', 'dif']
1739
1895
    encoding_type = 'exact'
1740
1896
 
1741
1897
    @display_command
1742
1898
    def run(self, revision=None, file_list=None, diff_options=None,
1743
 
            prefix=None, old=None, new=None, using=None):
1744
 
        from bzrlib.diff import _get_trees_to_diff, show_diff_trees
 
1899
            prefix=None, old=None, new=None, using=None, format=None):
 
1900
        from bzrlib.diff import (get_trees_and_branches_to_diff_locked,
 
1901
            show_diff_trees)
1745
1902
 
1746
1903
        if (prefix is None) or (prefix == '0'):
1747
1904
            # diff -p0 format
1761
1918
            raise errors.BzrCommandError('bzr diff --revision takes exactly'
1762
1919
                                         ' one or two revision specifiers')
1763
1920
 
1764
 
        old_tree, new_tree, specific_files, extra_trees = \
1765
 
                _get_trees_to_diff(file_list, revision, old, new,
1766
 
                apply_view=True)
 
1921
        if using is not None and format is not None:
 
1922
            raise errors.BzrCommandError('--using and --format are mutually '
 
1923
                'exclusive.')
 
1924
 
 
1925
        (old_tree, new_tree,
 
1926
         old_branch, new_branch,
 
1927
         specific_files, extra_trees) = get_trees_and_branches_to_diff_locked(
 
1928
            file_list, revision, old, new, self.add_cleanup, apply_view=True)
 
1929
        # GNU diff on Windows uses ANSI encoding for filenames
 
1930
        path_encoding = osutils.get_diff_header_encoding()
1767
1931
        return show_diff_trees(old_tree, new_tree, sys.stdout,
1768
1932
                               specific_files=specific_files,
1769
1933
                               external_diff_options=diff_options,
1770
1934
                               old_label=old_label, new_label=new_label,
1771
 
                               extra_trees=extra_trees, using=using)
 
1935
                               extra_trees=extra_trees,
 
1936
                               path_encoding=path_encoding,
 
1937
                               using=using,
 
1938
                               format_cls=format)
1772
1939
 
1773
1940
 
1774
1941
class cmd_deleted(Command):
1775
 
    """List files deleted in the working tree.
 
1942
    __doc__ = """List files deleted in the working tree.
1776
1943
    """
1777
1944
    # TODO: Show files deleted since a previous revision, or
1778
1945
    # between two revisions.
1781
1948
    # level of effort but possibly much less IO.  (Or possibly not,
1782
1949
    # if the directories are very large...)
1783
1950
    _see_also = ['status', 'ls']
1784
 
    takes_options = ['show-ids']
 
1951
    takes_options = ['directory', 'show-ids']
1785
1952
 
1786
1953
    @display_command
1787
 
    def run(self, show_ids=False):
1788
 
        tree = WorkingTree.open_containing(u'.')[0]
1789
 
        tree.lock_read()
1790
 
        try:
1791
 
            old = tree.basis_tree()
1792
 
            old.lock_read()
1793
 
            try:
1794
 
                for path, ie in old.inventory.iter_entries():
1795
 
                    if not tree.has_id(ie.file_id):
1796
 
                        self.outf.write(path)
1797
 
                        if show_ids:
1798
 
                            self.outf.write(' ')
1799
 
                            self.outf.write(ie.file_id)
1800
 
                        self.outf.write('\n')
1801
 
            finally:
1802
 
                old.unlock()
1803
 
        finally:
1804
 
            tree.unlock()
 
1954
    def run(self, show_ids=False, directory=u'.'):
 
1955
        tree = WorkingTree.open_containing(directory)[0]
 
1956
        self.add_cleanup(tree.lock_read().unlock)
 
1957
        old = tree.basis_tree()
 
1958
        self.add_cleanup(old.lock_read().unlock)
 
1959
        for path, ie in old.inventory.iter_entries():
 
1960
            if not tree.has_id(ie.file_id):
 
1961
                self.outf.write(path)
 
1962
                if show_ids:
 
1963
                    self.outf.write(' ')
 
1964
                    self.outf.write(ie.file_id)
 
1965
                self.outf.write('\n')
1805
1966
 
1806
1967
 
1807
1968
class cmd_modified(Command):
1808
 
    """List files modified in working tree.
 
1969
    __doc__ = """List files modified in working tree.
1809
1970
    """
1810
1971
 
1811
1972
    hidden = True
1812
1973
    _see_also = ['status', 'ls']
1813
 
    takes_options = [
1814
 
            Option('null',
1815
 
                   help='Write an ascii NUL (\\0) separator '
1816
 
                   'between files rather than a newline.')
1817
 
            ]
 
1974
    takes_options = ['directory', 'null']
1818
1975
 
1819
1976
    @display_command
1820
 
    def run(self, null=False):
1821
 
        tree = WorkingTree.open_containing(u'.')[0]
 
1977
    def run(self, null=False, directory=u'.'):
 
1978
        tree = WorkingTree.open_containing(directory)[0]
1822
1979
        td = tree.changes_from(tree.basis_tree())
1823
1980
        for path, id, kind, text_modified, meta_modified in td.modified:
1824
1981
            if null:
1828
1985
 
1829
1986
 
1830
1987
class cmd_added(Command):
1831
 
    """List files added in working tree.
 
1988
    __doc__ = """List files added in working tree.
1832
1989
    """
1833
1990
 
1834
1991
    hidden = True
1835
1992
    _see_also = ['status', 'ls']
1836
 
    takes_options = [
1837
 
            Option('null',
1838
 
                   help='Write an ascii NUL (\\0) separator '
1839
 
                   'between files rather than a newline.')
1840
 
            ]
 
1993
    takes_options = ['directory', 'null']
1841
1994
 
1842
1995
    @display_command
1843
 
    def run(self, null=False):
1844
 
        wt = WorkingTree.open_containing(u'.')[0]
1845
 
        wt.lock_read()
1846
 
        try:
1847
 
            basis = wt.basis_tree()
1848
 
            basis.lock_read()
1849
 
            try:
1850
 
                basis_inv = basis.inventory
1851
 
                inv = wt.inventory
1852
 
                for file_id in inv:
1853
 
                    if file_id in basis_inv:
1854
 
                        continue
1855
 
                    if inv.is_root(file_id) and len(basis_inv) == 0:
1856
 
                        continue
1857
 
                    path = inv.id2path(file_id)
1858
 
                    if not os.access(osutils.abspath(path), os.F_OK):
1859
 
                        continue
1860
 
                    if null:
1861
 
                        self.outf.write(path + '\0')
1862
 
                    else:
1863
 
                        self.outf.write(osutils.quotefn(path) + '\n')
1864
 
            finally:
1865
 
                basis.unlock()
1866
 
        finally:
1867
 
            wt.unlock()
 
1996
    def run(self, null=False, directory=u'.'):
 
1997
        wt = WorkingTree.open_containing(directory)[0]
 
1998
        self.add_cleanup(wt.lock_read().unlock)
 
1999
        basis = wt.basis_tree()
 
2000
        self.add_cleanup(basis.lock_read().unlock)
 
2001
        basis_inv = basis.inventory
 
2002
        inv = wt.inventory
 
2003
        for file_id in inv:
 
2004
            if file_id in basis_inv:
 
2005
                continue
 
2006
            if inv.is_root(file_id) and len(basis_inv) == 0:
 
2007
                continue
 
2008
            path = inv.id2path(file_id)
 
2009
            if not os.access(osutils.pathjoin(wt.basedir, path), os.F_OK):
 
2010
                continue
 
2011
            if null:
 
2012
                self.outf.write(path + '\0')
 
2013
            else:
 
2014
                self.outf.write(osutils.quotefn(path) + '\n')
1868
2015
 
1869
2016
 
1870
2017
class cmd_root(Command):
1871
 
    """Show the tree root directory.
 
2018
    __doc__ = """Show the tree root directory.
1872
2019
 
1873
2020
    The root is the nearest enclosing directory with a .bzr control
1874
2021
    directory."""
1898
2045
 
1899
2046
 
1900
2047
class cmd_log(Command):
1901
 
    """Show historical log for a branch or subset of a branch.
 
2048
    __doc__ = """Show historical log for a branch or subset of a branch.
1902
2049
 
1903
2050
    log is bzr's default tool for exploring the history of a branch.
1904
2051
    The branch to use is taken from the first parameter. If no parameters
1933
2080
        --show-ids  display revision-ids (and file-ids), not just revnos
1934
2081
 
1935
2082
      Note that the default number of levels to display is a function of the
1936
 
      log format. If the -n option is not used, ``short`` and ``line`` show
1937
 
      just the top level (mainline) while ``long`` shows all levels of merged
1938
 
      revisions.
 
2083
      log format. If the -n option is not used, the standard log formats show
 
2084
      just the top level (mainline).
1939
2085
 
1940
2086
      Status summaries are shown using status flags like A, M, etc. To see
1941
2087
      the changes explained using words like ``added`` and ``modified``
2016
2162
    :Tips & tricks:
2017
2163
 
2018
2164
      GUI tools and IDEs are often better at exploring history than command
2019
 
      line tools. You may prefer qlog or glog from the QBzr and Bzr-Gtk packages
2020
 
      respectively for example. (TortoiseBzr uses qlog for displaying logs.) See
2021
 
      http://bazaar-vcs.org/BzrPlugins and http://bazaar-vcs.org/IDEIntegration.
2022
 
 
2023
 
      Web interfaces are often better at exploring history than command line
2024
 
      tools, particularly for branches on servers. You may prefer Loggerhead
2025
 
      or one of its alternatives. See http://bazaar-vcs.org/WebInterface.
 
2165
      line tools: you may prefer qlog or viz from qbzr or bzr-gtk, the
 
2166
      bzr-explorer shell, or the Loggerhead web interface.  See the Plugin
 
2167
      Guide <http://doc.bazaar.canonical.com/plugins/en/> and
 
2168
      <http://wiki.bazaar.canonical.com/IDEIntegration>.  
2026
2169
 
2027
2170
      You may find it useful to add the aliases below to ``bazaar.conf``::
2028
2171
 
2029
2172
        [ALIASES]
2030
 
        tip = log -r-1 -n1
 
2173
        tip = log -r-1
2031
2174
        top = log -l10 --line
2032
 
        show = log -v -p -n1 --long
 
2175
        show = log -v -p
2033
2176
 
2034
2177
      ``bzr tip`` will then show the latest revision while ``bzr top``
2035
2178
      will show the last 10 mainline revisions. To see the details of a
2036
2179
      particular revision X,  ``bzr show -rX``.
2037
2180
 
2038
 
      As many GUI tools and Web interfaces do, you may prefer viewing
2039
 
      history collapsed initially. If you are interested in looking deeper
2040
 
      into a particular merge X, use ``bzr log -n0 -rX``. If you like
2041
 
      working this way, you may wish to either:
2042
 
 
2043
 
      * change your default log format to short (or line)
2044
 
      * add this alias: log = log -n1
 
2181
      If you are interested in looking deeper into a particular merge X,
 
2182
      use ``bzr log -n0 -rX``.
2045
2183
 
2046
2184
      ``bzr log -v`` on a branch with lots of history is currently
2047
2185
      very slow. A fix for this issue is currently under development.
2055
2193
 
2056
2194
      When exploring non-mainline history on large projects with deep
2057
2195
      history, the performance of log can be greatly improved by installing
2058
 
      the revnocache plugin. This plugin buffers historical information
 
2196
      the historycache plugin. This plugin buffers historical information
2059
2197
      trading disk space for faster speed.
2060
2198
    """
2061
2199
    takes_args = ['file*']
2074
2212
                   help='Show just the specified revision.'
2075
2213
                   ' See also "help revisionspec".'),
2076
2214
            'log-format',
 
2215
            RegistryOption('authors',
 
2216
                'What names to list as authors - first, all or committer.',
 
2217
                title='Authors',
 
2218
                lazy_registry=('bzrlib.log', 'author_list_registry'),
 
2219
            ),
2077
2220
            Option('levels',
2078
2221
                   short_name='n',
2079
2222
                   help='Number of levels to display - 0 for all, 1 for flat.',
2092
2235
            Option('show-diff',
2093
2236
                   short_name='p',
2094
2237
                   help='Show changes made in each revision as a patch.'),
 
2238
            Option('include-merges',
 
2239
                   help='Show merged revisions like --levels 0 does.'),
 
2240
            Option('exclude-common-ancestry',
 
2241
                   help='Display only the revisions that are not part'
 
2242
                   ' of both ancestries (require -rX..Y)'
 
2243
                   )
2095
2244
            ]
2096
2245
    encoding_type = 'replace'
2097
2246
 
2106
2255
            levels=None,
2107
2256
            message=None,
2108
2257
            limit=None,
2109
 
            show_diff=False):
 
2258
            show_diff=False,
 
2259
            include_merges=False,
 
2260
            authors=None,
 
2261
            exclude_common_ancestry=False,
 
2262
            ):
2110
2263
        from bzrlib.log import (
2111
2264
            Logger,
2112
2265
            make_log_request_dict,
2113
2266
            _get_info_for_log_files,
2114
2267
            )
2115
2268
        direction = (forward and 'forward') or 'reverse'
 
2269
        if (exclude_common_ancestry
 
2270
            and (revision is None or len(revision) != 2)):
 
2271
            raise errors.BzrCommandError(
 
2272
                '--exclude-common-ancestry requires -r with two revisions')
 
2273
        if include_merges:
 
2274
            if levels is None:
 
2275
                levels = 0
 
2276
            else:
 
2277
                raise errors.BzrCommandError(
 
2278
                    '--levels and --include-merges are mutually exclusive')
2116
2279
 
2117
2280
        if change is not None:
2118
2281
            if len(change) > 1:
2127
2290
        filter_by_dir = False
2128
2291
        if file_list:
2129
2292
            # find the file ids to log and check for directory filtering
2130
 
            b, file_info_list, rev1, rev2 = _get_info_for_log_files(revision,
2131
 
                file_list)
 
2293
            b, file_info_list, rev1, rev2 = _get_info_for_log_files(
 
2294
                revision, file_list, self.add_cleanup)
2132
2295
            for relpath, file_id, kind in file_info_list:
2133
2296
                if file_id is None:
2134
2297
                    raise errors.BzrCommandError(
2152
2315
                location = '.'
2153
2316
            dir, relpath = bzrdir.BzrDir.open_containing(location)
2154
2317
            b = dir.open_branch()
 
2318
            self.add_cleanup(b.lock_read().unlock)
2155
2319
            rev1, rev2 = _get_revision_range(revision, b, self.name())
2156
2320
 
2157
2321
        # Decide on the type of delta & diff filtering to use
2167
2331
        else:
2168
2332
            diff_type = 'full'
2169
2333
 
2170
 
        b.lock_read()
2171
 
        try:
2172
 
            # Build the log formatter
2173
 
            if log_format is None:
2174
 
                log_format = log.log_formatter_registry.get_default(b)
2175
 
            lf = log_format(show_ids=show_ids, to_file=self.outf,
2176
 
                            show_timezone=timezone,
2177
 
                            delta_format=get_verbosity_level(),
2178
 
                            levels=levels)
2179
 
 
2180
 
            # Choose the algorithm for doing the logging. It's annoying
2181
 
            # having multiple code paths like this but necessary until
2182
 
            # the underlying repository format is faster at generating
2183
 
            # deltas or can provide everything we need from the indices.
2184
 
            # The default algorithm - match-using-deltas - works for
2185
 
            # multiple files and directories and is faster for small
2186
 
            # amounts of history (200 revisions say). However, it's too
2187
 
            # slow for logging a single file in a repository with deep
2188
 
            # history, i.e. > 10K revisions. In the spirit of "do no
2189
 
            # evil when adding features", we continue to use the
2190
 
            # original algorithm - per-file-graph - for the "single
2191
 
            # file that isn't a directory without showing a delta" case.
2192
 
            match_using_deltas = (len(file_ids) != 1 or filter_by_dir
2193
 
                or delta_type)
2194
 
 
2195
 
            # Build the LogRequest and execute it
2196
 
            if len(file_ids) == 0:
2197
 
                file_ids = None
2198
 
            rqst = make_log_request_dict(
2199
 
                direction=direction, specific_fileids=file_ids,
2200
 
                start_revision=rev1, end_revision=rev2, limit=limit,
2201
 
                message_search=message, delta_type=delta_type,
2202
 
                diff_type=diff_type, _match_using_deltas=match_using_deltas)
2203
 
            Logger(b, rqst).show(lf)
2204
 
        finally:
2205
 
            b.unlock()
 
2334
        # Build the log formatter
 
2335
        if log_format is None:
 
2336
            log_format = log.log_formatter_registry.get_default(b)
 
2337
        # Make a non-encoding output to include the diffs - bug 328007
 
2338
        unencoded_output = ui.ui_factory.make_output_stream(encoding_type='exact')
 
2339
        lf = log_format(show_ids=show_ids, to_file=self.outf,
 
2340
                        to_exact_file=unencoded_output,
 
2341
                        show_timezone=timezone,
 
2342
                        delta_format=get_verbosity_level(),
 
2343
                        levels=levels,
 
2344
                        show_advice=levels is None,
 
2345
                        author_list_handler=authors)
 
2346
 
 
2347
        # Choose the algorithm for doing the logging. It's annoying
 
2348
        # having multiple code paths like this but necessary until
 
2349
        # the underlying repository format is faster at generating
 
2350
        # deltas or can provide everything we need from the indices.
 
2351
        # The default algorithm - match-using-deltas - works for
 
2352
        # multiple files and directories and is faster for small
 
2353
        # amounts of history (200 revisions say). However, it's too
 
2354
        # slow for logging a single file in a repository with deep
 
2355
        # history, i.e. > 10K revisions. In the spirit of "do no
 
2356
        # evil when adding features", we continue to use the
 
2357
        # original algorithm - per-file-graph - for the "single
 
2358
        # file that isn't a directory without showing a delta" case.
 
2359
        partial_history = revision and b.repository._format.supports_chks
 
2360
        match_using_deltas = (len(file_ids) != 1 or filter_by_dir
 
2361
            or delta_type or partial_history)
 
2362
 
 
2363
        # Build the LogRequest and execute it
 
2364
        if len(file_ids) == 0:
 
2365
            file_ids = None
 
2366
        rqst = make_log_request_dict(
 
2367
            direction=direction, specific_fileids=file_ids,
 
2368
            start_revision=rev1, end_revision=rev2, limit=limit,
 
2369
            message_search=message, delta_type=delta_type,
 
2370
            diff_type=diff_type, _match_using_deltas=match_using_deltas,
 
2371
            exclude_common_ancestry=exclude_common_ancestry,
 
2372
            )
 
2373
        Logger(b, rqst).show(lf)
2206
2374
 
2207
2375
 
2208
2376
def _get_revision_range(revisionspec_list, branch, command_name):
2226
2394
            raise errors.BzrCommandError(
2227
2395
                "bzr %s doesn't accept two revisions in different"
2228
2396
                " branches." % command_name)
2229
 
        rev1 = start_spec.in_history(branch)
 
2397
        if start_spec.spec is None:
 
2398
            # Avoid loading all the history.
 
2399
            rev1 = RevisionInfo(branch, None, None)
 
2400
        else:
 
2401
            rev1 = start_spec.in_history(branch)
2230
2402
        # Avoid loading all of history when we know a missing
2231
2403
        # end of range means the last revision ...
2232
2404
        if end_spec.spec is None:
2261
2433
 
2262
2434
 
2263
2435
class cmd_touching_revisions(Command):
2264
 
    """Return revision-ids which affected a particular file.
 
2436
    __doc__ = """Return revision-ids which affected a particular file.
2265
2437
 
2266
2438
    A more user-friendly interface is "bzr log FILE".
2267
2439
    """
2272
2444
    @display_command
2273
2445
    def run(self, filename):
2274
2446
        tree, relpath = WorkingTree.open_containing(filename)
 
2447
        file_id = tree.path2id(relpath)
2275
2448
        b = tree.branch
2276
 
        file_id = tree.path2id(relpath)
2277
 
        for revno, revision_id, what in log.find_touching_revisions(b, file_id):
 
2449
        self.add_cleanup(b.lock_read().unlock)
 
2450
        touching_revs = log.find_touching_revisions(b, file_id)
 
2451
        for revno, revision_id, what in touching_revs:
2278
2452
            self.outf.write("%6d %s\n" % (revno, what))
2279
2453
 
2280
2454
 
2281
2455
class cmd_ls(Command):
2282
 
    """List files in a tree.
 
2456
    __doc__ = """List files in a tree.
2283
2457
    """
2284
2458
 
2285
2459
    _see_also = ['status', 'cat']
2286
2460
    takes_args = ['path?']
2287
 
    # TODO: Take a revision or remote path and list that tree instead.
2288
2461
    takes_options = [
2289
2462
            'verbose',
2290
2463
            'revision',
2291
 
            Option('non-recursive',
2292
 
                   help='Don\'t recurse into subdirectories.'),
 
2464
            Option('recursive', short_name='R',
 
2465
                   help='Recurse into subdirectories.'),
2293
2466
            Option('from-root',
2294
2467
                   help='Print paths relative to the root of the branch.'),
2295
 
            Option('unknown', help='Print unknown files.'),
 
2468
            Option('unknown', short_name='u',
 
2469
                help='Print unknown files.'),
2296
2470
            Option('versioned', help='Print versioned files.',
2297
2471
                   short_name='V'),
2298
 
            Option('ignored', help='Print ignored files.'),
2299
 
            Option('null',
2300
 
                   help='Write an ascii NUL (\\0) separator '
2301
 
                   'between files rather than a newline.'),
2302
 
            Option('kind',
 
2472
            Option('ignored', short_name='i',
 
2473
                help='Print ignored files.'),
 
2474
            Option('kind', short_name='k',
2303
2475
                   help='List entries of a particular kind: file, directory, symlink.',
2304
2476
                   type=unicode),
 
2477
            'null',
2305
2478
            'show-ids',
 
2479
            'directory',
2306
2480
            ]
2307
2481
    @display_command
2308
2482
    def run(self, revision=None, verbose=False,
2309
 
            non_recursive=False, from_root=False,
 
2483
            recursive=False, from_root=False,
2310
2484
            unknown=False, versioned=False, ignored=False,
2311
 
            null=False, kind=None, show_ids=False, path=None):
 
2485
            null=False, kind=None, show_ids=False, path=None, directory=None):
2312
2486
 
2313
2487
        if kind and kind not in ('file', 'directory', 'symlink'):
2314
2488
            raise errors.BzrCommandError('invalid kind specified')
2321
2495
 
2322
2496
        if path is None:
2323
2497
            fs_path = '.'
2324
 
            prefix = ''
2325
2498
        else:
2326
2499
            if from_root:
2327
2500
                raise errors.BzrCommandError('cannot specify both --from-root'
2328
2501
                                             ' and PATH')
2329
2502
            fs_path = path
2330
 
            prefix = path
2331
 
        tree, branch, relpath = bzrdir.BzrDir.open_containing_tree_or_branch(
2332
 
            fs_path)
 
2503
        tree, branch, relpath = \
 
2504
            _open_directory_or_containing_tree_or_branch(fs_path, directory)
 
2505
 
 
2506
        # Calculate the prefix to use
 
2507
        prefix = None
2333
2508
        if from_root:
2334
 
            relpath = u''
2335
 
        elif relpath:
2336
 
            relpath += '/'
 
2509
            if relpath:
 
2510
                prefix = relpath + '/'
 
2511
        elif fs_path != '.' and not fs_path.endswith('/'):
 
2512
            prefix = fs_path + '/'
 
2513
 
2337
2514
        if revision is not None or tree is None:
2338
2515
            tree = _get_one_revision_tree('ls', revision, branch=branch)
2339
2516
 
2343
2520
            if view_files:
2344
2521
                apply_view = True
2345
2522
                view_str = views.view_display_str(view_files)
2346
 
                note("ignoring files outside view: %s" % view_str)
2347
 
 
2348
 
        tree.lock_read()
2349
 
        try:
2350
 
            for fp, fc, fkind, fid, entry in tree.list_files(include_root=False):
2351
 
                if fp.startswith(relpath):
2352
 
                    fp = osutils.pathjoin(prefix, fp[len(relpath):])
2353
 
                    if non_recursive and '/' in fp:
2354
 
                        continue
2355
 
                    if not all and not selection[fc]:
2356
 
                        continue
2357
 
                    if kind is not None and fkind != kind:
2358
 
                        continue
2359
 
                    if apply_view:
2360
 
                        try:
2361
 
                            views.check_path_in_view(tree, fp)
2362
 
                        except errors.FileOutsideView:
2363
 
                            continue
2364
 
                    kindch = entry.kind_character()
2365
 
                    outstring = fp + kindch
2366
 
                    if verbose:
2367
 
                        outstring = '%-8s %s' % (fc, outstring)
2368
 
                        if show_ids and fid is not None:
2369
 
                            outstring = "%-50s %s" % (outstring, fid)
2370
 
                        self.outf.write(outstring + '\n')
2371
 
                    elif null:
2372
 
                        self.outf.write(fp + '\0')
2373
 
                        if show_ids:
2374
 
                            if fid is not None:
2375
 
                                self.outf.write(fid)
2376
 
                            self.outf.write('\0')
2377
 
                        self.outf.flush()
2378
 
                    else:
2379
 
                        if fid is not None:
2380
 
                            my_id = fid
2381
 
                        else:
2382
 
                            my_id = ''
2383
 
                        if show_ids:
2384
 
                            self.outf.write('%-50s %s\n' % (outstring, my_id))
2385
 
                        else:
2386
 
                            self.outf.write(outstring + '\n')
2387
 
        finally:
2388
 
            tree.unlock()
 
2523
                note("Ignoring files outside view. View is %s" % view_str)
 
2524
 
 
2525
        self.add_cleanup(tree.lock_read().unlock)
 
2526
        for fp, fc, fkind, fid, entry in tree.list_files(include_root=False,
 
2527
            from_dir=relpath, recursive=recursive):
 
2528
            # Apply additional masking
 
2529
            if not all and not selection[fc]:
 
2530
                continue
 
2531
            if kind is not None and fkind != kind:
 
2532
                continue
 
2533
            if apply_view:
 
2534
                try:
 
2535
                    if relpath:
 
2536
                        fullpath = osutils.pathjoin(relpath, fp)
 
2537
                    else:
 
2538
                        fullpath = fp
 
2539
                    views.check_path_in_view(tree, fullpath)
 
2540
                except errors.FileOutsideView:
 
2541
                    continue
 
2542
 
 
2543
            # Output the entry
 
2544
            if prefix:
 
2545
                fp = osutils.pathjoin(prefix, fp)
 
2546
            kindch = entry.kind_character()
 
2547
            outstring = fp + kindch
 
2548
            ui.ui_factory.clear_term()
 
2549
            if verbose:
 
2550
                outstring = '%-8s %s' % (fc, outstring)
 
2551
                if show_ids and fid is not None:
 
2552
                    outstring = "%-50s %s" % (outstring, fid)
 
2553
                self.outf.write(outstring + '\n')
 
2554
            elif null:
 
2555
                self.outf.write(fp + '\0')
 
2556
                if show_ids:
 
2557
                    if fid is not None:
 
2558
                        self.outf.write(fid)
 
2559
                    self.outf.write('\0')
 
2560
                self.outf.flush()
 
2561
            else:
 
2562
                if show_ids:
 
2563
                    if fid is not None:
 
2564
                        my_id = fid
 
2565
                    else:
 
2566
                        my_id = ''
 
2567
                    self.outf.write('%-50s %s\n' % (outstring, my_id))
 
2568
                else:
 
2569
                    self.outf.write(outstring + '\n')
2389
2570
 
2390
2571
 
2391
2572
class cmd_unknowns(Command):
2392
 
    """List unknown files.
 
2573
    __doc__ = """List unknown files.
2393
2574
    """
2394
2575
 
2395
2576
    hidden = True
2396
2577
    _see_also = ['ls']
 
2578
    takes_options = ['directory']
2397
2579
 
2398
2580
    @display_command
2399
 
    def run(self):
2400
 
        for f in WorkingTree.open_containing(u'.')[0].unknowns():
 
2581
    def run(self, directory=u'.'):
 
2582
        for f in WorkingTree.open_containing(directory)[0].unknowns():
2401
2583
            self.outf.write(osutils.quotefn(f) + '\n')
2402
2584
 
2403
2585
 
2404
2586
class cmd_ignore(Command):
2405
 
    """Ignore specified files or patterns.
 
2587
    __doc__ = """Ignore specified files or patterns.
2406
2588
 
2407
2589
    See ``bzr help patterns`` for details on the syntax of patterns.
2408
2590
 
 
2591
    If a .bzrignore file does not exist, the ignore command
 
2592
    will create one and add the specified files or patterns to the newly
 
2593
    created file. The ignore command will also automatically add the 
 
2594
    .bzrignore file to be versioned. Creating a .bzrignore file without
 
2595
    the use of the ignore command will require an explicit add command.
 
2596
 
2409
2597
    To remove patterns from the ignore list, edit the .bzrignore file.
2410
2598
    After adding, editing or deleting that file either indirectly by
2411
2599
    using this command or directly by using an editor, be sure to commit
2412
2600
    it.
 
2601
    
 
2602
    Bazaar also supports a global ignore file ~/.bazaar/ignore. On Windows
 
2603
    the global ignore file can be found in the application data directory as
 
2604
    C:\\Documents and Settings\\<user>\\Application Data\\Bazaar\\2.0\\ignore.
 
2605
    Global ignores are not touched by this command. The global ignore file
 
2606
    can be edited directly using an editor.
 
2607
 
 
2608
    Patterns prefixed with '!' are exceptions to ignore patterns and take
 
2609
    precedence over regular ignores.  Such exceptions are used to specify
 
2610
    files that should be versioned which would otherwise be ignored.
 
2611
    
 
2612
    Patterns prefixed with '!!' act as regular ignore patterns, but have
 
2613
    precedence over the '!' exception patterns.
2413
2614
 
2414
2615
    Note: ignore patterns containing shell wildcards must be quoted from
2415
2616
    the shell on Unix.
2419
2620
 
2420
2621
            bzr ignore ./Makefile
2421
2622
 
2422
 
        Ignore class files in all directories::
 
2623
        Ignore .class files in all directories...::
2423
2624
 
2424
2625
            bzr ignore "*.class"
2425
2626
 
 
2627
        ...but do not ignore "special.class"::
 
2628
 
 
2629
            bzr ignore "!special.class"
 
2630
 
2426
2631
        Ignore .o files under the lib directory::
2427
2632
 
2428
2633
            bzr ignore "lib/**/*.o"
2434
2639
        Ignore everything but the "debian" toplevel directory::
2435
2640
 
2436
2641
            bzr ignore "RE:(?!debian/).*"
 
2642
        
 
2643
        Ignore everything except the "local" toplevel directory,
 
2644
        but always ignore "*~" autosave files, even under local/::
 
2645
        
 
2646
            bzr ignore "*"
 
2647
            bzr ignore "!./local"
 
2648
            bzr ignore "!!*~"
2437
2649
    """
2438
2650
 
2439
2651
    _see_also = ['status', 'ignored', 'patterns']
2440
2652
    takes_args = ['name_pattern*']
2441
 
    takes_options = [
2442
 
        Option('old-default-rules',
2443
 
               help='Write out the ignore rules bzr < 0.9 always used.')
 
2653
    takes_options = ['directory',
 
2654
        Option('default-rules',
 
2655
               help='Display the default ignore rules that bzr uses.')
2444
2656
        ]
2445
2657
 
2446
 
    def run(self, name_pattern_list=None, old_default_rules=None):
 
2658
    def run(self, name_pattern_list=None, default_rules=None,
 
2659
            directory=u'.'):
2447
2660
        from bzrlib import ignores
2448
 
        if old_default_rules is not None:
2449
 
            # dump the rules and exit
2450
 
            for pattern in ignores.OLD_DEFAULTS:
2451
 
                print pattern
 
2661
        if default_rules is not None:
 
2662
            # dump the default rules and exit
 
2663
            for pattern in ignores.USER_DEFAULTS:
 
2664
                self.outf.write("%s\n" % pattern)
2452
2665
            return
2453
2666
        if not name_pattern_list:
2454
2667
            raise errors.BzrCommandError("ignore requires at least one "
2455
 
                                  "NAME_PATTERN or --old-default-rules")
 
2668
                "NAME_PATTERN or --default-rules.")
2456
2669
        name_pattern_list = [globbing.normalize_pattern(p)
2457
2670
                             for p in name_pattern_list]
2458
2671
        for name_pattern in name_pattern_list:
2460
2673
                (len(name_pattern) > 1 and name_pattern[1] == ':')):
2461
2674
                raise errors.BzrCommandError(
2462
2675
                    "NAME_PATTERN should not be an absolute path")
2463
 
        tree, relpath = WorkingTree.open_containing(u'.')
 
2676
        tree, relpath = WorkingTree.open_containing(directory)
2464
2677
        ignores.tree_ignores_add_patterns(tree, name_pattern_list)
2465
2678
        ignored = globbing.Globster(name_pattern_list)
2466
2679
        matches = []
2467
 
        tree.lock_read()
 
2680
        self.add_cleanup(tree.lock_read().unlock)
2468
2681
        for entry in tree.list_files():
2469
2682
            id = entry[3]
2470
2683
            if id is not None:
2471
2684
                filename = entry[0]
2472
2685
                if ignored.match(filename):
2473
 
                    matches.append(filename.encode('utf-8'))
2474
 
        tree.unlock()
 
2686
                    matches.append(filename)
2475
2687
        if len(matches) > 0:
2476
 
            print "Warning: the following files are version controlled and" \
2477
 
                  " match your ignore pattern:\n%s" \
2478
 
                  "\nThese files will continue to be version controlled" \
2479
 
                  " unless you 'bzr remove' them." % ("\n".join(matches),)
 
2688
            self.outf.write("Warning: the following files are version controlled and"
 
2689
                  " match your ignore pattern:\n%s"
 
2690
                  "\nThese files will continue to be version controlled"
 
2691
                  " unless you 'bzr remove' them.\n" % ("\n".join(matches),))
2480
2692
 
2481
2693
 
2482
2694
class cmd_ignored(Command):
2483
 
    """List ignored files and the patterns that matched them.
 
2695
    __doc__ = """List ignored files and the patterns that matched them.
2484
2696
 
2485
2697
    List all the ignored files and the ignore pattern that caused the file to
2486
2698
    be ignored.
2492
2704
 
2493
2705
    encoding_type = 'replace'
2494
2706
    _see_also = ['ignore', 'ls']
 
2707
    takes_options = ['directory']
2495
2708
 
2496
2709
    @display_command
2497
 
    def run(self):
2498
 
        tree = WorkingTree.open_containing(u'.')[0]
2499
 
        tree.lock_read()
2500
 
        try:
2501
 
            for path, file_class, kind, file_id, entry in tree.list_files():
2502
 
                if file_class != 'I':
2503
 
                    continue
2504
 
                ## XXX: Slightly inefficient since this was already calculated
2505
 
                pat = tree.is_ignored(path)
2506
 
                self.outf.write('%-50s %s\n' % (path, pat))
2507
 
        finally:
2508
 
            tree.unlock()
 
2710
    def run(self, directory=u'.'):
 
2711
        tree = WorkingTree.open_containing(directory)[0]
 
2712
        self.add_cleanup(tree.lock_read().unlock)
 
2713
        for path, file_class, kind, file_id, entry in tree.list_files():
 
2714
            if file_class != 'I':
 
2715
                continue
 
2716
            ## XXX: Slightly inefficient since this was already calculated
 
2717
            pat = tree.is_ignored(path)
 
2718
            self.outf.write('%-50s %s\n' % (path, pat))
2509
2719
 
2510
2720
 
2511
2721
class cmd_lookup_revision(Command):
2512
 
    """Lookup the revision-id from a revision-number
 
2722
    __doc__ = """Lookup the revision-id from a revision-number
2513
2723
 
2514
2724
    :Examples:
2515
2725
        bzr lookup-revision 33
2516
2726
    """
2517
2727
    hidden = True
2518
2728
    takes_args = ['revno']
 
2729
    takes_options = ['directory']
2519
2730
 
2520
2731
    @display_command
2521
 
    def run(self, revno):
 
2732
    def run(self, revno, directory=u'.'):
2522
2733
        try:
2523
2734
            revno = int(revno)
2524
2735
        except ValueError:
2525
 
            raise errors.BzrCommandError("not a valid revision-number: %r" % revno)
2526
 
 
2527
 
        print WorkingTree.open_containing(u'.')[0].branch.get_rev_id(revno)
 
2736
            raise errors.BzrCommandError("not a valid revision-number: %r"
 
2737
                                         % revno)
 
2738
        revid = WorkingTree.open_containing(directory)[0].branch.get_rev_id(revno)
 
2739
        self.outf.write("%s\n" % revid)
2528
2740
 
2529
2741
 
2530
2742
class cmd_export(Command):
2531
 
    """Export current or past revision to a destination directory or archive.
 
2743
    __doc__ = """Export current or past revision to a destination directory or archive.
2532
2744
 
2533
2745
    If no revision is specified this exports the last committed revision.
2534
2746
 
2556
2768
      =================       =========================
2557
2769
    """
2558
2770
    takes_args = ['dest', 'branch_or_subdir?']
2559
 
    takes_options = [
 
2771
    takes_options = ['directory',
2560
2772
        Option('format',
2561
2773
               help="Type of file to export to.",
2562
2774
               type=unicode),
2566
2778
        Option('root',
2567
2779
               type=str,
2568
2780
               help="Name of the root directory inside the exported file."),
 
2781
        Option('per-file-timestamps',
 
2782
               help='Set modification time of files to that of the last '
 
2783
                    'revision in which it was changed.'),
2569
2784
        ]
2570
2785
    def run(self, dest, branch_or_subdir=None, revision=None, format=None,
2571
 
        root=None, filters=False):
 
2786
        root=None, filters=False, per_file_timestamps=False, directory=u'.'):
2572
2787
        from bzrlib.export import export
2573
2788
 
2574
2789
        if branch_or_subdir is None:
2575
 
            tree = WorkingTree.open_containing(u'.')[0]
 
2790
            tree = WorkingTree.open_containing(directory)[0]
2576
2791
            b = tree.branch
2577
2792
            subdir = None
2578
2793
        else:
2581
2796
 
2582
2797
        rev_tree = _get_one_revision_tree('export', revision, branch=b, tree=tree)
2583
2798
        try:
2584
 
            export(rev_tree, dest, format, root, subdir, filtered=filters)
 
2799
            export(rev_tree, dest, format, root, subdir, filtered=filters,
 
2800
                   per_file_timestamps=per_file_timestamps)
2585
2801
        except errors.NoSuchExportFormat, e:
2586
2802
            raise errors.BzrCommandError('Unsupported export format: %s' % e.format)
2587
2803
 
2588
2804
 
2589
2805
class cmd_cat(Command):
2590
 
    """Write the contents of a file as of a given revision to standard output.
 
2806
    __doc__ = """Write the contents of a file as of a given revision to standard output.
2591
2807
 
2592
2808
    If no revision is nominated, the last revision is used.
2593
2809
 
2596
2812
    """
2597
2813
 
2598
2814
    _see_also = ['ls']
2599
 
    takes_options = [
 
2815
    takes_options = ['directory',
2600
2816
        Option('name-from-revision', help='The path name in the old tree.'),
2601
2817
        Option('filters', help='Apply content filters to display the '
2602
2818
                'convenience form.'),
2607
2823
 
2608
2824
    @display_command
2609
2825
    def run(self, filename, revision=None, name_from_revision=False,
2610
 
            filters=False):
 
2826
            filters=False, directory=None):
2611
2827
        if revision is not None and len(revision) != 1:
2612
2828
            raise errors.BzrCommandError("bzr cat --revision takes exactly"
2613
2829
                                         " one revision specifier")
2614
2830
        tree, branch, relpath = \
2615
 
            bzrdir.BzrDir.open_containing_tree_or_branch(filename)
2616
 
        branch.lock_read()
2617
 
        try:
2618
 
            return self._run(tree, branch, relpath, filename, revision,
2619
 
                             name_from_revision, filters)
2620
 
        finally:
2621
 
            branch.unlock()
 
2831
            _open_directory_or_containing_tree_or_branch(filename, directory)
 
2832
        self.add_cleanup(branch.lock_read().unlock)
 
2833
        return self._run(tree, branch, relpath, filename, revision,
 
2834
                         name_from_revision, filters)
2622
2835
 
2623
2836
    def _run(self, tree, b, relpath, filename, revision, name_from_revision,
2624
2837
        filtered):
2625
2838
        if tree is None:
2626
2839
            tree = b.basis_tree()
2627
2840
        rev_tree = _get_one_revision_tree('cat', revision, branch=b)
 
2841
        self.add_cleanup(rev_tree.lock_read().unlock)
2628
2842
 
2629
2843
        old_file_id = rev_tree.path2id(relpath)
2630
2844
 
2665
2879
            chunks = content.splitlines(True)
2666
2880
            content = filtered_output_bytes(chunks, filters,
2667
2881
                ContentFilterContext(relpath, rev_tree))
 
2882
            self.cleanup_now()
2668
2883
            self.outf.writelines(content)
2669
2884
        else:
 
2885
            self.cleanup_now()
2670
2886
            self.outf.write(content)
2671
2887
 
2672
2888
 
2673
2889
class cmd_local_time_offset(Command):
2674
 
    """Show the offset in seconds from GMT to local time."""
 
2890
    __doc__ = """Show the offset in seconds from GMT to local time."""
2675
2891
    hidden = True
2676
2892
    @display_command
2677
2893
    def run(self):
2678
 
        print osutils.local_time_offset()
 
2894
        self.outf.write("%s\n" % osutils.local_time_offset())
2679
2895
 
2680
2896
 
2681
2897
 
2682
2898
class cmd_commit(Command):
2683
 
    """Commit changes into a new revision.
2684
 
 
2685
 
    If no arguments are given, the entire tree is committed.
2686
 
 
2687
 
    If selected files are specified, only changes to those files are
2688
 
    committed.  If a directory is specified then the directory and everything
2689
 
    within it is committed.
2690
 
 
2691
 
    When excludes are given, they take precedence over selected files.
2692
 
    For example, too commit only changes within foo, but not changes within
2693
 
    foo/bar::
2694
 
 
2695
 
      bzr commit foo -x foo/bar
2696
 
 
2697
 
    If author of the change is not the same person as the committer, you can
2698
 
    specify the author's name using the --author option. The name should be
2699
 
    in the same format as a committer-id, e.g. "John Doe <jdoe@example.com>".
2700
 
    If there is more than one author of the change you can specify the option
2701
 
    multiple times, once for each author.
2702
 
 
2703
 
    A selected-file commit may fail in some cases where the committed
2704
 
    tree would be invalid. Consider::
2705
 
 
2706
 
      bzr init foo
2707
 
      mkdir foo/bar
2708
 
      bzr add foo/bar
2709
 
      bzr commit foo -m "committing foo"
2710
 
      bzr mv foo/bar foo/baz
2711
 
      mkdir foo/bar
2712
 
      bzr add foo/bar
2713
 
      bzr commit foo/bar -m "committing bar but not baz"
2714
 
 
2715
 
    In the example above, the last commit will fail by design. This gives
2716
 
    the user the opportunity to decide whether they want to commit the
2717
 
    rename at the same time, separately first, or not at all. (As a general
2718
 
    rule, when in doubt, Bazaar has a policy of Doing the Safe Thing.)
2719
 
 
2720
 
    Note: A selected-file commit after a merge is not yet supported.
 
2899
    __doc__ = """Commit changes into a new revision.
 
2900
 
 
2901
    An explanatory message needs to be given for each commit. This is
 
2902
    often done by using the --message option (getting the message from the
 
2903
    command line) or by using the --file option (getting the message from
 
2904
    a file). If neither of these options is given, an editor is opened for
 
2905
    the user to enter the message. To see the changed files in the
 
2906
    boilerplate text loaded into the editor, use the --show-diff option.
 
2907
 
 
2908
    By default, the entire tree is committed and the person doing the
 
2909
    commit is assumed to be the author. These defaults can be overridden
 
2910
    as explained below.
 
2911
 
 
2912
    :Selective commits:
 
2913
 
 
2914
      If selected files are specified, only changes to those files are
 
2915
      committed.  If a directory is specified then the directory and
 
2916
      everything within it is committed.
 
2917
  
 
2918
      When excludes are given, they take precedence over selected files.
 
2919
      For example, to commit only changes within foo, but not changes
 
2920
      within foo/bar::
 
2921
  
 
2922
        bzr commit foo -x foo/bar
 
2923
  
 
2924
      A selective commit after a merge is not yet supported.
 
2925
 
 
2926
    :Custom authors:
 
2927
 
 
2928
      If the author of the change is not the same person as the committer,
 
2929
      you can specify the author's name using the --author option. The
 
2930
      name should be in the same format as a committer-id, e.g.
 
2931
      "John Doe <jdoe@example.com>". If there is more than one author of
 
2932
      the change you can specify the option multiple times, once for each
 
2933
      author.
 
2934
  
 
2935
    :Checks:
 
2936
 
 
2937
      A common mistake is to forget to add a new file or directory before
 
2938
      running the commit command. The --strict option checks for unknown
 
2939
      files and aborts the commit if any are found. More advanced pre-commit
 
2940
      checks can be implemented by defining hooks. See ``bzr help hooks``
 
2941
      for details.
 
2942
 
 
2943
    :Things to note:
 
2944
 
 
2945
      If you accidentially commit the wrong changes or make a spelling
 
2946
      mistake in the commit message say, you can use the uncommit command
 
2947
      to undo it. See ``bzr help uncommit`` for details.
 
2948
 
 
2949
      Hooks can also be configured to run after a commit. This allows you
 
2950
      to trigger updates to external systems like bug trackers. The --fixes
 
2951
      option can be used to record the association between a revision and
 
2952
      one or more bugs. See ``bzr help bugs`` for details.
 
2953
 
 
2954
      A selective commit may fail in some cases where the committed
 
2955
      tree would be invalid. Consider::
 
2956
  
 
2957
        bzr init foo
 
2958
        mkdir foo/bar
 
2959
        bzr add foo/bar
 
2960
        bzr commit foo -m "committing foo"
 
2961
        bzr mv foo/bar foo/baz
 
2962
        mkdir foo/bar
 
2963
        bzr add foo/bar
 
2964
        bzr commit foo/bar -m "committing bar but not baz"
 
2965
  
 
2966
      In the example above, the last commit will fail by design. This gives
 
2967
      the user the opportunity to decide whether they want to commit the
 
2968
      rename at the same time, separately first, or not at all. (As a general
 
2969
      rule, when in doubt, Bazaar has a policy of Doing the Safe Thing.)
2721
2970
    """
2722
2971
    # TODO: Run hooks on tree to-be-committed, and after commit.
2723
2972
 
2728
2977
 
2729
2978
    # XXX: verbose currently does nothing
2730
2979
 
2731
 
    _see_also = ['bugs', 'uncommit']
 
2980
    _see_also = ['add', 'bugs', 'hooks', 'uncommit']
2732
2981
    takes_args = ['selected*']
2733
2982
    takes_options = [
2734
2983
            ListOption('exclude', type=str, short_name='x',
2746
2995
             Option('strict',
2747
2996
                    help="Refuse to commit if there are unknown "
2748
2997
                    "files in the working tree."),
 
2998
             Option('commit-time', type=str,
 
2999
                    help="Manually set a commit time using commit date "
 
3000
                    "format, e.g. '2009-10-10 08:00:00 +0100'."),
2749
3001
             ListOption('fixes', type=str,
2750
3002
                    help="Mark a bug as being fixed by this revision "
2751
3003
                         "(see \"bzr help bugs\")."),
2758
3010
                         "the master branch until a normal commit "
2759
3011
                         "is performed."
2760
3012
                    ),
2761
 
              Option('show-diff',
2762
 
                     help='When no message is supplied, show the diff along'
2763
 
                     ' with the status summary in the message editor.'),
 
3013
             Option('show-diff', short_name='p',
 
3014
                    help='When no message is supplied, show the diff along'
 
3015
                    ' with the status summary in the message editor.'),
2764
3016
             ]
2765
3017
    aliases = ['ci', 'checkin']
2766
3018
 
2785
3037
 
2786
3038
    def run(self, message=None, file=None, verbose=False, selected_list=None,
2787
3039
            unchanged=False, strict=False, local=False, fixes=None,
2788
 
            author=None, show_diff=False, exclude=None):
 
3040
            author=None, show_diff=False, exclude=None, commit_time=None):
2789
3041
        from bzrlib.errors import (
2790
3042
            PointlessCommit,
2791
3043
            ConflictsInTree,
2797
3049
            make_commit_message_template_encoded
2798
3050
        )
2799
3051
 
 
3052
        commit_stamp = offset = None
 
3053
        if commit_time is not None:
 
3054
            try:
 
3055
                commit_stamp, offset = timestamp.parse_patch_date(commit_time)
 
3056
            except ValueError, e:
 
3057
                raise errors.BzrCommandError(
 
3058
                    "Could not parse --commit-time: " + str(e))
 
3059
 
2800
3060
        # TODO: Need a blackbox test for invoking the external editor; may be
2801
3061
        # slightly problematic to run this cross-platform.
2802
3062
 
2822
3082
        if local and not tree.branch.get_bound_location():
2823
3083
            raise errors.LocalRequiresBoundBranch()
2824
3084
 
 
3085
        if message is not None:
 
3086
            try:
 
3087
                file_exists = osutils.lexists(message)
 
3088
            except UnicodeError:
 
3089
                # The commit message contains unicode characters that can't be
 
3090
                # represented in the filesystem encoding, so that can't be a
 
3091
                # file.
 
3092
                file_exists = False
 
3093
            if file_exists:
 
3094
                warning_msg = (
 
3095
                    'The commit message is a file name: "%(f)s".\n'
 
3096
                    '(use --file "%(f)s" to take commit message from that file)'
 
3097
                    % { 'f': message })
 
3098
                ui.ui_factory.show_warning(warning_msg)
 
3099
            if '\r' in message:
 
3100
                message = message.replace('\r\n', '\n')
 
3101
                message = message.replace('\r', '\n')
 
3102
            if file:
 
3103
                raise errors.BzrCommandError(
 
3104
                    "please specify either --message or --file")
 
3105
 
2825
3106
        def get_message(commit_obj):
2826
3107
            """Callback to get commit message"""
2827
 
            my_message = message
2828
 
            if my_message is None and not file:
2829
 
                t = make_commit_message_template_encoded(tree,
 
3108
            if file:
 
3109
                f = codecs.open(file, 'rt', osutils.get_user_encoding())
 
3110
                try:
 
3111
                    my_message = f.read()
 
3112
                finally:
 
3113
                    f.close()
 
3114
            elif message is not None:
 
3115
                my_message = message
 
3116
            else:
 
3117
                # No message supplied: make one up.
 
3118
                # text is the status of the tree
 
3119
                text = make_commit_message_template_encoded(tree,
2830
3120
                        selected_list, diff=show_diff,
2831
3121
                        output_encoding=osutils.get_user_encoding())
 
3122
                # start_message is the template generated from hooks
 
3123
                # XXX: Warning - looks like hooks return unicode,
 
3124
                # make_commit_message_template_encoded returns user encoding.
 
3125
                # We probably want to be using edit_commit_message instead to
 
3126
                # avoid this.
2832
3127
                start_message = generate_commit_message_template(commit_obj)
2833
 
                my_message = edit_commit_message_encoded(t,
 
3128
                my_message = edit_commit_message_encoded(text,
2834
3129
                    start_message=start_message)
2835
3130
                if my_message is None:
2836
3131
                    raise errors.BzrCommandError("please specify a commit"
2837
3132
                        " message with either --message or --file")
2838
 
            elif my_message and file:
2839
 
                raise errors.BzrCommandError(
2840
 
                    "please specify either --message or --file")
2841
 
            if file:
2842
 
                my_message = codecs.open(file, 'rt',
2843
 
                                         osutils.get_user_encoding()).read()
2844
3133
            if my_message == "":
2845
3134
                raise errors.BzrCommandError("empty commit message specified")
2846
3135
            return my_message
2847
3136
 
 
3137
        # The API permits a commit with a filter of [] to mean 'select nothing'
 
3138
        # but the command line should not do that.
 
3139
        if not selected_list:
 
3140
            selected_list = None
2848
3141
        try:
2849
3142
            tree.commit(message_callback=get_message,
2850
3143
                        specific_files=selected_list,
2851
3144
                        allow_pointless=unchanged, strict=strict, local=local,
2852
3145
                        reporter=None, verbose=verbose, revprops=properties,
2853
 
                        authors=author,
2854
 
                        exclude=safe_relpath_files(tree, exclude))
 
3146
                        authors=author, timestamp=commit_stamp,
 
3147
                        timezone=offset,
 
3148
                        exclude=tree.safe_relpath_files(exclude))
2855
3149
        except PointlessCommit:
2856
 
            # FIXME: This should really happen before the file is read in;
2857
 
            # perhaps prepare the commit; get the message; then actually commit
2858
 
            raise errors.BzrCommandError("no changes to commit."
2859
 
                              " use --unchanged to commit anyhow")
 
3150
            raise errors.BzrCommandError("No changes to commit."
 
3151
                              " Use --unchanged to commit anyhow.")
2860
3152
        except ConflictsInTree:
2861
3153
            raise errors.BzrCommandError('Conflicts detected in working '
2862
3154
                'tree.  Use "bzr conflicts" to list, "bzr resolve FILE" to'
2865
3157
            raise errors.BzrCommandError("Commit refused because there are"
2866
3158
                              " unknown files in the working tree.")
2867
3159
        except errors.BoundBranchOutOfDate, e:
2868
 
            raise errors.BzrCommandError(str(e) + "\n"
2869
 
            'To commit to master branch, run update and then commit.\n'
2870
 
            'You can also pass --local to commit to continue working '
2871
 
            'disconnected.')
 
3160
            e.extra_help = ("\n"
 
3161
                'To commit to master branch, run update and then commit.\n'
 
3162
                'You can also pass --local to commit to continue working '
 
3163
                'disconnected.')
 
3164
            raise
2872
3165
 
2873
3166
 
2874
3167
class cmd_check(Command):
2875
 
    """Validate working tree structure, branch consistency and repository history.
 
3168
    __doc__ = """Validate working tree structure, branch consistency and repository history.
2876
3169
 
2877
3170
    This command checks various invariants about branch and repository storage
2878
3171
    to detect data corruption or bzr bugs.
2880
3173
    The working tree and branch checks will only give output if a problem is
2881
3174
    detected. The output fields of the repository check are:
2882
3175
 
2883
 
        revisions: This is just the number of revisions checked.  It doesn't
2884
 
            indicate a problem.
2885
 
        versionedfiles: This is just the number of versionedfiles checked.  It
2886
 
            doesn't indicate a problem.
2887
 
        unreferenced ancestors: Texts that are ancestors of other texts, but
2888
 
            are not properly referenced by the revision ancestry.  This is a
2889
 
            subtle problem that Bazaar can work around.
2890
 
        unique file texts: This is the total number of unique file contents
2891
 
            seen in the checked revisions.  It does not indicate a problem.
2892
 
        repeated file texts: This is the total number of repeated texts seen
2893
 
            in the checked revisions.  Texts can be repeated when their file
2894
 
            entries are modified, but the file contents are not.  It does not
2895
 
            indicate a problem.
 
3176
    revisions
 
3177
        This is just the number of revisions checked.  It doesn't
 
3178
        indicate a problem.
 
3179
 
 
3180
    versionedfiles
 
3181
        This is just the number of versionedfiles checked.  It
 
3182
        doesn't indicate a problem.
 
3183
 
 
3184
    unreferenced ancestors
 
3185
        Texts that are ancestors of other texts, but
 
3186
        are not properly referenced by the revision ancestry.  This is a
 
3187
        subtle problem that Bazaar can work around.
 
3188
 
 
3189
    unique file texts
 
3190
        This is the total number of unique file contents
 
3191
        seen in the checked revisions.  It does not indicate a problem.
 
3192
 
 
3193
    repeated file texts
 
3194
        This is the total number of repeated texts seen
 
3195
        in the checked revisions.  Texts can be repeated when their file
 
3196
        entries are modified, but the file contents are not.  It does not
 
3197
        indicate a problem.
2896
3198
 
2897
3199
    If no restrictions are specified, all Bazaar data that is found at the given
2898
3200
    location will be checked.
2933
3235
 
2934
3236
 
2935
3237
class cmd_upgrade(Command):
2936
 
    """Upgrade branch storage to current format.
 
3238
    __doc__ = """Upgrade branch storage to current format.
2937
3239
 
2938
3240
    The check command or bzr developers may sometimes advise you to run
2939
3241
    this command. When the default format has changed you may also be warned
2953
3255
 
2954
3256
    def run(self, url='.', format=None):
2955
3257
        from bzrlib.upgrade import upgrade
2956
 
        if format is None:
2957
 
            format = bzrdir.format_registry.make_bzrdir('default')
2958
3258
        upgrade(url, format)
2959
3259
 
2960
3260
 
2961
3261
class cmd_whoami(Command):
2962
 
    """Show or set bzr user id.
 
3262
    __doc__ = """Show or set bzr user id.
2963
3263
 
2964
3264
    :Examples:
2965
3265
        Show the email of the current user::
2970
3270
 
2971
3271
            bzr whoami "Frank Chu <fchu@example.com>"
2972
3272
    """
2973
 
    takes_options = [ Option('email',
 
3273
    takes_options = [ 'directory',
 
3274
                      Option('email',
2974
3275
                             help='Display email address only.'),
2975
3276
                      Option('branch',
2976
3277
                             help='Set identity for the current branch instead of '
2980
3281
    encoding_type = 'replace'
2981
3282
 
2982
3283
    @display_command
2983
 
    def run(self, email=False, branch=False, name=None):
 
3284
    def run(self, email=False, branch=False, name=None, directory=None):
2984
3285
        if name is None:
2985
 
            # use branch if we're inside one; otherwise global config
2986
 
            try:
2987
 
                c = Branch.open_containing('.')[0].get_config()
2988
 
            except errors.NotBranchError:
2989
 
                c = config.GlobalConfig()
 
3286
            if directory is None:
 
3287
                # use branch if we're inside one; otherwise global config
 
3288
                try:
 
3289
                    c = Branch.open_containing(u'.')[0].get_config()
 
3290
                except errors.NotBranchError:
 
3291
                    c = config.GlobalConfig()
 
3292
            else:
 
3293
                c = Branch.open(directory).get_config()
2990
3294
            if email:
2991
3295
                self.outf.write(c.user_email() + '\n')
2992
3296
            else:
3002
3306
 
3003
3307
        # use global config unless --branch given
3004
3308
        if branch:
3005
 
            c = Branch.open_containing('.')[0].get_config()
 
3309
            if directory is None:
 
3310
                c = Branch.open_containing(u'.')[0].get_config()
 
3311
            else:
 
3312
                c = Branch.open(directory).get_config()
3006
3313
        else:
3007
3314
            c = config.GlobalConfig()
3008
3315
        c.set_user_option('email', name)
3009
3316
 
3010
3317
 
3011
3318
class cmd_nick(Command):
3012
 
    """Print or set the branch nickname.
 
3319
    __doc__ = """Print or set the branch nickname.
3013
3320
 
3014
3321
    If unset, the tree root directory name is used as the nickname.
3015
3322
    To print the current nickname, execute with no argument.
3020
3327
 
3021
3328
    _see_also = ['info']
3022
3329
    takes_args = ['nickname?']
3023
 
    def run(self, nickname=None):
3024
 
        branch = Branch.open_containing(u'.')[0]
 
3330
    takes_options = ['directory']
 
3331
    def run(self, nickname=None, directory=u'.'):
 
3332
        branch = Branch.open_containing(directory)[0]
3025
3333
        if nickname is None:
3026
3334
            self.printme(branch)
3027
3335
        else:
3029
3337
 
3030
3338
    @display_command
3031
3339
    def printme(self, branch):
3032
 
        print branch.nick
 
3340
        self.outf.write('%s\n' % branch.nick)
3033
3341
 
3034
3342
 
3035
3343
class cmd_alias(Command):
3036
 
    """Set/unset and display aliases.
 
3344
    __doc__ = """Set/unset and display aliases.
3037
3345
 
3038
3346
    :Examples:
3039
3347
        Show the current aliases::
3103
3411
 
3104
3412
 
3105
3413
class cmd_selftest(Command):
3106
 
    """Run internal test suite.
 
3414
    __doc__ = """Run internal test suite.
3107
3415
 
3108
3416
    If arguments are given, they are regular expressions that say which tests
3109
3417
    should run.  Tests matching any expression are run, and other tests are
3136
3444
    Tests that need working space on disk use a common temporary directory,
3137
3445
    typically inside $TMPDIR or /tmp.
3138
3446
 
 
3447
    If you set BZR_TEST_PDB=1 when running selftest, failing tests will drop
 
3448
    into a pdb postmortem session.
 
3449
 
3139
3450
    :Examples:
3140
3451
        Run only tests relating to 'ignore'::
3141
3452
 
3150
3461
    def get_transport_type(typestring):
3151
3462
        """Parse and return a transport specifier."""
3152
3463
        if typestring == "sftp":
3153
 
            from bzrlib.transport.sftp import SFTPAbsoluteServer
3154
 
            return SFTPAbsoluteServer
 
3464
            from bzrlib.tests import stub_sftp
 
3465
            return stub_sftp.SFTPAbsoluteServer
3155
3466
        if typestring == "memory":
3156
 
            from bzrlib.transport.memory import MemoryServer
3157
 
            return MemoryServer
 
3467
            from bzrlib.tests import test_server
 
3468
            return memory.MemoryServer
3158
3469
        if typestring == "fakenfs":
3159
 
            from bzrlib.transport.fakenfs import FakeNFSServer
3160
 
            return FakeNFSServer
 
3470
            from bzrlib.tests import test_server
 
3471
            return test_server.FakeNFSServer
3161
3472
        msg = "No known transport type %s. Supported types are: sftp\n" %\
3162
3473
            (typestring)
3163
3474
        raise errors.BzrCommandError(msg)
3178
3489
                     Option('lsprof-timed',
3179
3490
                            help='Generate lsprof output for benchmarked'
3180
3491
                                 ' sections of code.'),
 
3492
                     Option('lsprof-tests',
 
3493
                            help='Generate lsprof output for each test.'),
3181
3494
                     Option('cache-dir', type=str,
3182
3495
                            help='Cache intermediate benchmark output in this '
3183
3496
                                 'directory.'),
3187
3500
                            ),
3188
3501
                     Option('list-only',
3189
3502
                            help='List the tests instead of running them.'),
 
3503
                     RegistryOption('parallel',
 
3504
                        help="Run the test suite in parallel.",
 
3505
                        lazy_registry=('bzrlib.tests', 'parallel_registry'),
 
3506
                        value_switches=False,
 
3507
                        ),
3190
3508
                     Option('randomize', type=str, argname="SEED",
3191
3509
                            help='Randomize the order of tests using the given'
3192
3510
                                 ' seed or "now" for the current time.'),
3218
3536
            lsprof_timed=None, cache_dir=None,
3219
3537
            first=False, list_only=False,
3220
3538
            randomize=None, exclude=None, strict=False,
3221
 
            load_list=None, debugflag=None, starting_with=None, subunit=False):
 
3539
            load_list=None, debugflag=None, starting_with=None, subunit=False,
 
3540
            parallel=None, lsprof_tests=False):
3222
3541
        from bzrlib.tests import selftest
3223
3542
        import bzrlib.benchmarks as benchmarks
3224
3543
        from bzrlib.benchmarks import tree_creator
3228
3547
 
3229
3548
        if cache_dir is not None:
3230
3549
            tree_creator.TreeCreator.CACHE_ROOT = osutils.abspath(cache_dir)
3231
 
        if not list_only:
3232
 
            print 'testing: %s' % (osutils.realpath(sys.argv[0]),)
3233
 
            print '   %s (%s python%s)' % (
3234
 
                    bzrlib.__path__[0],
3235
 
                    bzrlib.version_string,
3236
 
                    bzrlib._format_version_tuple(sys.version_info),
3237
 
                    )
3238
 
        print
3239
3550
        if testspecs_list is not None:
3240
3551
            pattern = '|'.join(testspecs_list)
3241
3552
        else:
3247
3558
                raise errors.BzrCommandError("subunit not available. subunit "
3248
3559
                    "needs to be installed to use --subunit.")
3249
3560
            self.additional_selftest_args['runner_class'] = SubUnitBzrRunner
 
3561
            # On Windows, disable automatic conversion of '\n' to '\r\n' in
 
3562
            # stdout, which would corrupt the subunit stream. 
 
3563
            # FIXME: This has been fixed in subunit trunk (>0.0.5) so the
 
3564
            # following code can be deleted when it's sufficiently deployed
 
3565
            # -- vila/mgz 20100514
 
3566
            if (sys.platform == "win32"
 
3567
                and getattr(sys.stdout, 'fileno', None) is not None):
 
3568
                import msvcrt
 
3569
                msvcrt.setmode(sys.stdout.fileno(), os.O_BINARY)
 
3570
        if parallel:
 
3571
            self.additional_selftest_args.setdefault(
 
3572
                'suite_decorators', []).append(parallel)
3250
3573
        if benchmark:
3251
3574
            test_suite_factory = benchmarks.test_suite
3252
3575
            # Unless user explicitly asks for quiet, be verbose in benchmarks
3253
3576
            verbose = not is_quiet()
3254
3577
            # TODO: should possibly lock the history file...
3255
3578
            benchfile = open(".perf_history", "at", buffering=1)
 
3579
            self.add_cleanup(benchfile.close)
3256
3580
        else:
3257
3581
            test_suite_factory = None
3258
3582
            benchfile = None
3259
 
        try:
3260
 
            selftest_kwargs = {"verbose": verbose,
3261
 
                              "pattern": pattern,
3262
 
                              "stop_on_failure": one,
3263
 
                              "transport": transport,
3264
 
                              "test_suite_factory": test_suite_factory,
3265
 
                              "lsprof_timed": lsprof_timed,
3266
 
                              "bench_history": benchfile,
3267
 
                              "matching_tests_first": first,
3268
 
                              "list_only": list_only,
3269
 
                              "random_seed": randomize,
3270
 
                              "exclude_pattern": exclude,
3271
 
                              "strict": strict,
3272
 
                              "load_list": load_list,
3273
 
                              "debug_flags": debugflag,
3274
 
                              "starting_with": starting_with
3275
 
                              }
3276
 
            selftest_kwargs.update(self.additional_selftest_args)
3277
 
            result = selftest(**selftest_kwargs)
3278
 
        finally:
3279
 
            if benchfile is not None:
3280
 
                benchfile.close()
3281
 
        if result:
3282
 
            note('tests passed')
3283
 
        else:
3284
 
            note('tests failed')
 
3583
        selftest_kwargs = {"verbose": verbose,
 
3584
                          "pattern": pattern,
 
3585
                          "stop_on_failure": one,
 
3586
                          "transport": transport,
 
3587
                          "test_suite_factory": test_suite_factory,
 
3588
                          "lsprof_timed": lsprof_timed,
 
3589
                          "lsprof_tests": lsprof_tests,
 
3590
                          "bench_history": benchfile,
 
3591
                          "matching_tests_first": first,
 
3592
                          "list_only": list_only,
 
3593
                          "random_seed": randomize,
 
3594
                          "exclude_pattern": exclude,
 
3595
                          "strict": strict,
 
3596
                          "load_list": load_list,
 
3597
                          "debug_flags": debugflag,
 
3598
                          "starting_with": starting_with
 
3599
                          }
 
3600
        selftest_kwargs.update(self.additional_selftest_args)
 
3601
        result = selftest(**selftest_kwargs)
3285
3602
        return int(not result)
3286
3603
 
3287
3604
 
3288
3605
class cmd_version(Command):
3289
 
    """Show version of bzr."""
 
3606
    __doc__ = """Show version of bzr."""
3290
3607
 
3291
3608
    encoding_type = 'replace'
3292
3609
    takes_options = [
3303
3620
 
3304
3621
 
3305
3622
class cmd_rocks(Command):
3306
 
    """Statement of optimism."""
 
3623
    __doc__ = """Statement of optimism."""
3307
3624
 
3308
3625
    hidden = True
3309
3626
 
3310
3627
    @display_command
3311
3628
    def run(self):
3312
 
        print "It sure does!"
 
3629
        self.outf.write("It sure does!\n")
3313
3630
 
3314
3631
 
3315
3632
class cmd_find_merge_base(Command):
3316
 
    """Find and print a base revision for merging two branches."""
 
3633
    __doc__ = """Find and print a base revision for merging two branches."""
3317
3634
    # TODO: Options to specify revisions on either side, as if
3318
3635
    #       merging only part of the history.
3319
3636
    takes_args = ['branch', 'other']
3325
3642
 
3326
3643
        branch1 = Branch.open_containing(branch)[0]
3327
3644
        branch2 = Branch.open_containing(other)[0]
3328
 
        branch1.lock_read()
3329
 
        try:
3330
 
            branch2.lock_read()
3331
 
            try:
3332
 
                last1 = ensure_null(branch1.last_revision())
3333
 
                last2 = ensure_null(branch2.last_revision())
3334
 
 
3335
 
                graph = branch1.repository.get_graph(branch2.repository)
3336
 
                base_rev_id = graph.find_unique_lca(last1, last2)
3337
 
 
3338
 
                print 'merge base is revision %s' % base_rev_id
3339
 
            finally:
3340
 
                branch2.unlock()
3341
 
        finally:
3342
 
            branch1.unlock()
 
3645
        self.add_cleanup(branch1.lock_read().unlock)
 
3646
        self.add_cleanup(branch2.lock_read().unlock)
 
3647
        last1 = ensure_null(branch1.last_revision())
 
3648
        last2 = ensure_null(branch2.last_revision())
 
3649
 
 
3650
        graph = branch1.repository.get_graph(branch2.repository)
 
3651
        base_rev_id = graph.find_unique_lca(last1, last2)
 
3652
 
 
3653
        self.outf.write('merge base is revision %s\n' % base_rev_id)
3343
3654
 
3344
3655
 
3345
3656
class cmd_merge(Command):
3346
 
    """Perform a three-way merge.
 
3657
    __doc__ = """Perform a three-way merge.
3347
3658
 
3348
3659
    The source of the merge can be specified either in the form of a branch,
3349
3660
    or in the form of a path to a file containing a merge directive generated
3378
3689
    committed to record the result of the merge.
3379
3690
 
3380
3691
    merge refuses to run if there are any uncommitted changes, unless
3381
 
    --force is given.
 
3692
    --force is given. The --force option can also be used to create a
 
3693
    merge revision which has more than two parents.
 
3694
 
 
3695
    If one would like to merge changes from the working tree of the other
 
3696
    branch without merging any committed revisions, the --uncommitted option
 
3697
    can be given.
 
3698
 
 
3699
    To select only some changes to merge, use "merge -i", which will prompt
 
3700
    you to apply each diff hunk and file change, similar to "shelve".
3382
3701
 
3383
3702
    :Examples:
3384
3703
        To merge the latest revision from bzr.dev::
3393
3712
 
3394
3713
            bzr merge -r 81..82 ../bzr.dev
3395
3714
 
3396
 
        To apply a merge directive contained in in /tmp/merge:
 
3715
        To apply a merge directive contained in /tmp/merge::
3397
3716
 
3398
3717
            bzr merge /tmp/merge
 
3718
 
 
3719
        To create a merge revision with three parents from two branches
 
3720
        feature1a and feature1b:
 
3721
 
 
3722
            bzr merge ../feature1a
 
3723
            bzr merge ../feature1b --force
 
3724
            bzr commit -m 'revision with three parents'
3399
3725
    """
3400
3726
 
3401
3727
    encoding_type = 'exact'
3417
3743
                ' completely merged into the source, pull from the'
3418
3744
                ' source rather than merging.  When this happens,'
3419
3745
                ' you do not need to commit the result.'),
3420
 
        Option('directory',
 
3746
        custom_help('directory',
3421
3747
               help='Branch to merge into, '
3422
 
                    'rather than the one containing the working directory.',
3423
 
               short_name='d',
3424
 
               type=unicode,
3425
 
               ),
3426
 
        Option('preview', help='Instead of merging, show a diff of the merge.')
 
3748
                    'rather than the one containing the working directory.'),
 
3749
        Option('preview', help='Instead of merging, show a diff of the'
 
3750
               ' merge.'),
 
3751
        Option('interactive', help='Select changes interactively.',
 
3752
            short_name='i')
3427
3753
    ]
3428
3754
 
3429
3755
    def run(self, location=None, revision=None, force=False,
3431
3757
            uncommitted=False, pull=False,
3432
3758
            directory=None,
3433
3759
            preview=False,
 
3760
            interactive=False,
3434
3761
            ):
3435
3762
        if merge_type is None:
3436
3763
            merge_type = _mod_merge.Merge3Merger
3442
3769
        verified = 'inapplicable'
3443
3770
        tree = WorkingTree.open_containing(directory)[0]
3444
3771
 
3445
 
        # die as quickly as possible if there are uncommitted changes
3446
3772
        try:
3447
3773
            basis_tree = tree.revision_tree(tree.last_revision())
3448
3774
        except errors.NoSuchRevision:
3449
3775
            basis_tree = tree.basis_tree()
 
3776
 
 
3777
        # die as quickly as possible if there are uncommitted changes
3450
3778
        if not force:
3451
 
            changes = tree.changes_from(basis_tree)
3452
 
            if changes.has_changed():
 
3779
            if tree.has_changes():
3453
3780
                raise errors.UncommittedChanges(tree)
3454
3781
 
3455
3782
        view_info = _get_view_info_for_change_reporter(tree)
3456
3783
        change_reporter = delta._ChangeReporter(
3457
3784
            unversioned_filter=tree.is_ignored, view_info=view_info)
3458
 
        cleanups = []
3459
 
        try:
3460
 
            pb = ui.ui_factory.nested_progress_bar()
3461
 
            cleanups.append(pb.finished)
3462
 
            tree.lock_write()
3463
 
            cleanups.append(tree.unlock)
3464
 
            if location is not None:
3465
 
                try:
3466
 
                    mergeable = bundle.read_mergeable_from_url(location,
3467
 
                        possible_transports=possible_transports)
3468
 
                except errors.NotABundle:
3469
 
                    mergeable = None
3470
 
                else:
3471
 
                    if uncommitted:
3472
 
                        raise errors.BzrCommandError('Cannot use --uncommitted'
3473
 
                            ' with bundles or merge directives.')
3474
 
 
3475
 
                    if revision is not None:
3476
 
                        raise errors.BzrCommandError(
3477
 
                            'Cannot use -r with merge directives or bundles')
3478
 
                    merger, verified = _mod_merge.Merger.from_mergeable(tree,
3479
 
                       mergeable, pb)
3480
 
 
3481
 
            if merger is None and uncommitted:
3482
 
                if revision is not None and len(revision) > 0:
3483
 
                    raise errors.BzrCommandError('Cannot use --uncommitted and'
3484
 
                        ' --revision at the same time.')
3485
 
                location = self._select_branch_location(tree, location)[0]
3486
 
                other_tree, other_path = WorkingTree.open_containing(location)
3487
 
                merger = _mod_merge.Merger.from_uncommitted(tree, other_tree,
3488
 
                    pb)
3489
 
                allow_pending = False
3490
 
                if other_path != '':
3491
 
                    merger.interesting_files = [other_path]
3492
 
 
3493
 
            if merger is None:
3494
 
                merger, allow_pending = self._get_merger_from_branch(tree,
3495
 
                    location, revision, remember, possible_transports, pb)
3496
 
 
3497
 
            merger.merge_type = merge_type
3498
 
            merger.reprocess = reprocess
3499
 
            merger.show_base = show_base
3500
 
            self.sanity_check_merger(merger)
3501
 
            if (merger.base_rev_id == merger.other_rev_id and
3502
 
                merger.other_rev_id is not None):
3503
 
                note('Nothing to do.')
 
3785
        pb = ui.ui_factory.nested_progress_bar()
 
3786
        self.add_cleanup(pb.finished)
 
3787
        self.add_cleanup(tree.lock_write().unlock)
 
3788
        if location is not None:
 
3789
            try:
 
3790
                mergeable = bundle.read_mergeable_from_url(location,
 
3791
                    possible_transports=possible_transports)
 
3792
            except errors.NotABundle:
 
3793
                mergeable = None
 
3794
            else:
 
3795
                if uncommitted:
 
3796
                    raise errors.BzrCommandError('Cannot use --uncommitted'
 
3797
                        ' with bundles or merge directives.')
 
3798
 
 
3799
                if revision is not None:
 
3800
                    raise errors.BzrCommandError(
 
3801
                        'Cannot use -r with merge directives or bundles')
 
3802
                merger, verified = _mod_merge.Merger.from_mergeable(tree,
 
3803
                   mergeable, None)
 
3804
 
 
3805
        if merger is None and uncommitted:
 
3806
            if revision is not None and len(revision) > 0:
 
3807
                raise errors.BzrCommandError('Cannot use --uncommitted and'
 
3808
                    ' --revision at the same time.')
 
3809
            merger = self.get_merger_from_uncommitted(tree, location, None)
 
3810
            allow_pending = False
 
3811
 
 
3812
        if merger is None:
 
3813
            merger, allow_pending = self._get_merger_from_branch(tree,
 
3814
                location, revision, remember, possible_transports, None)
 
3815
 
 
3816
        merger.merge_type = merge_type
 
3817
        merger.reprocess = reprocess
 
3818
        merger.show_base = show_base
 
3819
        self.sanity_check_merger(merger)
 
3820
        if (merger.base_rev_id == merger.other_rev_id and
 
3821
            merger.other_rev_id is not None):
 
3822
            note('Nothing to do.')
 
3823
            return 0
 
3824
        if pull:
 
3825
            if merger.interesting_files is not None:
 
3826
                raise errors.BzrCommandError('Cannot pull individual files')
 
3827
            if (merger.base_rev_id == tree.last_revision()):
 
3828
                result = tree.pull(merger.other_branch, False,
 
3829
                                   merger.other_rev_id)
 
3830
                result.report(self.outf)
3504
3831
                return 0
3505
 
            if pull:
3506
 
                if merger.interesting_files is not None:
3507
 
                    raise errors.BzrCommandError('Cannot pull individual files')
3508
 
                if (merger.base_rev_id == tree.last_revision()):
3509
 
                    result = tree.pull(merger.other_branch, False,
3510
 
                                       merger.other_rev_id)
3511
 
                    result.report(self.outf)
3512
 
                    return 0
3513
 
            merger.check_basis(False)
3514
 
            if preview:
3515
 
                return self._do_preview(merger)
3516
 
            else:
3517
 
                return self._do_merge(merger, change_reporter, allow_pending,
3518
 
                                      verified)
3519
 
        finally:
3520
 
            for cleanup in reversed(cleanups):
3521
 
                cleanup()
 
3832
        if merger.this_basis is None:
 
3833
            raise errors.BzrCommandError(
 
3834
                "This branch has no commits."
 
3835
                " (perhaps you would prefer 'bzr pull')")
 
3836
        if preview:
 
3837
            return self._do_preview(merger)
 
3838
        elif interactive:
 
3839
            return self._do_interactive(merger)
 
3840
        else:
 
3841
            return self._do_merge(merger, change_reporter, allow_pending,
 
3842
                                  verified)
 
3843
 
 
3844
    def _get_preview(self, merger):
 
3845
        tree_merger = merger.make_merger()
 
3846
        tt = tree_merger.make_preview_transform()
 
3847
        self.add_cleanup(tt.finalize)
 
3848
        result_tree = tt.get_preview_tree()
 
3849
        return result_tree
3522
3850
 
3523
3851
    def _do_preview(self, merger):
3524
3852
        from bzrlib.diff import show_diff_trees
3525
 
        tree_merger = merger.make_merger()
3526
 
        tt = tree_merger.make_preview_transform()
3527
 
        try:
3528
 
            result_tree = tt.get_preview_tree()
3529
 
            show_diff_trees(merger.this_tree, result_tree, self.outf,
3530
 
                            old_label='', new_label='')
3531
 
        finally:
3532
 
            tt.finalize()
 
3853
        result_tree = self._get_preview(merger)
 
3854
        path_encoding = osutils.get_diff_header_encoding()
 
3855
        show_diff_trees(merger.this_tree, result_tree, self.outf,
 
3856
                        old_label='', new_label='',
 
3857
                        path_encoding=path_encoding)
3533
3858
 
3534
3859
    def _do_merge(self, merger, change_reporter, allow_pending, verified):
3535
3860
        merger.change_reporter = change_reporter
3543
3868
        else:
3544
3869
            return 0
3545
3870
 
 
3871
    def _do_interactive(self, merger):
 
3872
        """Perform an interactive merge.
 
3873
 
 
3874
        This works by generating a preview tree of the merge, then using
 
3875
        Shelver to selectively remove the differences between the working tree
 
3876
        and the preview tree.
 
3877
        """
 
3878
        from bzrlib import shelf_ui
 
3879
        result_tree = self._get_preview(merger)
 
3880
        writer = bzrlib.option.diff_writer_registry.get()
 
3881
        shelver = shelf_ui.Shelver(merger.this_tree, result_tree, destroy=True,
 
3882
                                   reporter=shelf_ui.ApplyReporter(),
 
3883
                                   diff_writer=writer(sys.stdout))
 
3884
        try:
 
3885
            shelver.run()
 
3886
        finally:
 
3887
            shelver.finalize()
 
3888
 
3546
3889
    def sanity_check_merger(self, merger):
3547
3890
        if (merger.show_base and
3548
3891
            not merger.merge_type is _mod_merge.Merge3Merger):
3583
3926
            base_branch, base_path = Branch.open_containing(base_loc,
3584
3927
                possible_transports)
3585
3928
        # Find the revision ids
3586
 
        if revision is None or len(revision) < 1 or revision[-1] is None:
 
3929
        other_revision_id = None
 
3930
        base_revision_id = None
 
3931
        if revision is not None:
 
3932
            if len(revision) >= 1:
 
3933
                other_revision_id = revision[-1].as_revision_id(other_branch)
 
3934
            if len(revision) == 2:
 
3935
                base_revision_id = revision[0].as_revision_id(base_branch)
 
3936
        if other_revision_id is None:
3587
3937
            other_revision_id = _mod_revision.ensure_null(
3588
3938
                other_branch.last_revision())
3589
 
        else:
3590
 
            other_revision_id = revision[-1].as_revision_id(other_branch)
3591
 
        if (revision is not None and len(revision) == 2
3592
 
            and revision[0] is not None):
3593
 
            base_revision_id = revision[0].as_revision_id(base_branch)
3594
 
        else:
3595
 
            base_revision_id = None
3596
3939
        # Remember where we merge from
3597
3940
        if ((remember or tree.branch.get_submit_branch() is None) and
3598
3941
             user_location is not None):
3607
3950
            allow_pending = True
3608
3951
        return merger, allow_pending
3609
3952
 
 
3953
    def get_merger_from_uncommitted(self, tree, location, pb):
 
3954
        """Get a merger for uncommitted changes.
 
3955
 
 
3956
        :param tree: The tree the merger should apply to.
 
3957
        :param location: The location containing uncommitted changes.
 
3958
        :param pb: The progress bar to use for showing progress.
 
3959
        """
 
3960
        location = self._select_branch_location(tree, location)[0]
 
3961
        other_tree, other_path = WorkingTree.open_containing(location)
 
3962
        merger = _mod_merge.Merger.from_uncommitted(tree, other_tree, pb)
 
3963
        if other_path != '':
 
3964
            merger.interesting_files = [other_path]
 
3965
        return merger
 
3966
 
3610
3967
    def _select_branch_location(self, tree, user_location, revision=None,
3611
3968
                                index=None):
3612
3969
        """Select a branch location, according to possible inputs.
3656
4013
 
3657
4014
 
3658
4015
class cmd_remerge(Command):
3659
 
    """Redo a merge.
 
4016
    __doc__ = """Redo a merge.
3660
4017
 
3661
4018
    Use this if you want to try a different merge technique while resolving
3662
4019
    conflicts.  Some merge techniques are better than others, and remerge
3687
4044
 
3688
4045
    def run(self, file_list=None, merge_type=None, show_base=False,
3689
4046
            reprocess=False):
 
4047
        from bzrlib.conflicts import restore
3690
4048
        if merge_type is None:
3691
4049
            merge_type = _mod_merge.Merge3Merger
3692
4050
        tree, file_list = tree_files(file_list)
3693
 
        tree.lock_write()
3694
 
        try:
3695
 
            parents = tree.get_parent_ids()
3696
 
            if len(parents) != 2:
3697
 
                raise errors.BzrCommandError("Sorry, remerge only works after normal"
3698
 
                                             " merges.  Not cherrypicking or"
3699
 
                                             " multi-merges.")
3700
 
            repository = tree.branch.repository
3701
 
            interesting_ids = None
3702
 
            new_conflicts = []
3703
 
            conflicts = tree.conflicts()
3704
 
            if file_list is not None:
3705
 
                interesting_ids = set()
3706
 
                for filename in file_list:
3707
 
                    file_id = tree.path2id(filename)
3708
 
                    if file_id is None:
3709
 
                        raise errors.NotVersionedError(filename)
3710
 
                    interesting_ids.add(file_id)
3711
 
                    if tree.kind(file_id) != "directory":
3712
 
                        continue
 
4051
        self.add_cleanup(tree.lock_write().unlock)
 
4052
        parents = tree.get_parent_ids()
 
4053
        if len(parents) != 2:
 
4054
            raise errors.BzrCommandError("Sorry, remerge only works after normal"
 
4055
                                         " merges.  Not cherrypicking or"
 
4056
                                         " multi-merges.")
 
4057
        repository = tree.branch.repository
 
4058
        interesting_ids = None
 
4059
        new_conflicts = []
 
4060
        conflicts = tree.conflicts()
 
4061
        if file_list is not None:
 
4062
            interesting_ids = set()
 
4063
            for filename in file_list:
 
4064
                file_id = tree.path2id(filename)
 
4065
                if file_id is None:
 
4066
                    raise errors.NotVersionedError(filename)
 
4067
                interesting_ids.add(file_id)
 
4068
                if tree.kind(file_id) != "directory":
 
4069
                    continue
3713
4070
 
3714
 
                    for name, ie in tree.inventory.iter_entries(file_id):
3715
 
                        interesting_ids.add(ie.file_id)
3716
 
                new_conflicts = conflicts.select_conflicts(tree, file_list)[0]
3717
 
            else:
3718
 
                # Remerge only supports resolving contents conflicts
3719
 
                allowed_conflicts = ('text conflict', 'contents conflict')
3720
 
                restore_files = [c.path for c in conflicts
3721
 
                                 if c.typestring in allowed_conflicts]
3722
 
            _mod_merge.transform_tree(tree, tree.basis_tree(), interesting_ids)
3723
 
            tree.set_conflicts(ConflictList(new_conflicts))
3724
 
            if file_list is not None:
3725
 
                restore_files = file_list
3726
 
            for filename in restore_files:
3727
 
                try:
3728
 
                    restore(tree.abspath(filename))
3729
 
                except errors.NotConflicted:
3730
 
                    pass
3731
 
            # Disable pending merges, because the file texts we are remerging
3732
 
            # have not had those merges performed.  If we use the wrong parents
3733
 
            # list, we imply that the working tree text has seen and rejected
3734
 
            # all the changes from the other tree, when in fact those changes
3735
 
            # have not yet been seen.
3736
 
            pb = ui.ui_factory.nested_progress_bar()
3737
 
            tree.set_parent_ids(parents[:1])
 
4071
                for name, ie in tree.inventory.iter_entries(file_id):
 
4072
                    interesting_ids.add(ie.file_id)
 
4073
            new_conflicts = conflicts.select_conflicts(tree, file_list)[0]
 
4074
        else:
 
4075
            # Remerge only supports resolving contents conflicts
 
4076
            allowed_conflicts = ('text conflict', 'contents conflict')
 
4077
            restore_files = [c.path for c in conflicts
 
4078
                             if c.typestring in allowed_conflicts]
 
4079
        _mod_merge.transform_tree(tree, tree.basis_tree(), interesting_ids)
 
4080
        tree.set_conflicts(ConflictList(new_conflicts))
 
4081
        if file_list is not None:
 
4082
            restore_files = file_list
 
4083
        for filename in restore_files:
3738
4084
            try:
3739
 
                merger = _mod_merge.Merger.from_revision_ids(pb,
3740
 
                                                             tree, parents[1])
3741
 
                merger.interesting_ids = interesting_ids
3742
 
                merger.merge_type = merge_type
3743
 
                merger.show_base = show_base
3744
 
                merger.reprocess = reprocess
3745
 
                conflicts = merger.do_merge()
3746
 
            finally:
3747
 
                tree.set_parent_ids(parents)
3748
 
                pb.finished()
 
4085
                restore(tree.abspath(filename))
 
4086
            except errors.NotConflicted:
 
4087
                pass
 
4088
        # Disable pending merges, because the file texts we are remerging
 
4089
        # have not had those merges performed.  If we use the wrong parents
 
4090
        # list, we imply that the working tree text has seen and rejected
 
4091
        # all the changes from the other tree, when in fact those changes
 
4092
        # have not yet been seen.
 
4093
        tree.set_parent_ids(parents[:1])
 
4094
        try:
 
4095
            merger = _mod_merge.Merger.from_revision_ids(None, tree, parents[1])
 
4096
            merger.interesting_ids = interesting_ids
 
4097
            merger.merge_type = merge_type
 
4098
            merger.show_base = show_base
 
4099
            merger.reprocess = reprocess
 
4100
            conflicts = merger.do_merge()
3749
4101
        finally:
3750
 
            tree.unlock()
 
4102
            tree.set_parent_ids(parents)
3751
4103
        if conflicts > 0:
3752
4104
            return 1
3753
4105
        else:
3755
4107
 
3756
4108
 
3757
4109
class cmd_revert(Command):
3758
 
    """Revert files to a previous revision.
 
4110
    __doc__ = """Revert files to a previous revision.
3759
4111
 
3760
4112
    Giving a list of files will revert only those files.  Otherwise, all files
3761
4113
    will be reverted.  If the revision is not specified with '--revision', the
3775
4127
    name.  If you name a directory, all the contents of that directory will be
3776
4128
    reverted.
3777
4129
 
3778
 
    Any files that have been newly added since that revision will be deleted,
3779
 
    with a backup kept if appropriate.  Directories containing unknown files
3780
 
    will not be deleted.
 
4130
    If you have newly added files since the target revision, they will be
 
4131
    removed.  If the files to be removed have been changed, backups will be
 
4132
    created as above.  Directories containing unknown files will not be
 
4133
    deleted.
3781
4134
 
3782
 
    The working tree contains a list of pending merged revisions, which will
3783
 
    be included as parents in the next commit.  Normally, revert clears that
3784
 
    list as well as reverting the files.  If any files are specified, revert
3785
 
    leaves the pending merge list alone and reverts only the files.  Use "bzr
3786
 
    revert ." in the tree root to revert all files but keep the merge record,
3787
 
    and "bzr revert --forget-merges" to clear the pending merge list without
 
4135
    The working tree contains a list of revisions that have been merged but
 
4136
    not yet committed. These revisions will be included as additional parents
 
4137
    of the next commit.  Normally, using revert clears that list as well as
 
4138
    reverting the files.  If any files are specified, revert leaves the list
 
4139
    of uncommitted merges alone and reverts only the files.  Use ``bzr revert
 
4140
    .`` in the tree root to revert all files but keep the recorded merges,
 
4141
    and ``bzr revert --forget-merges`` to clear the pending merge list without
3788
4142
    reverting any files.
 
4143
 
 
4144
    Using "bzr revert --forget-merges", it is possible to apply all of the
 
4145
    changes from a branch in a single revision.  To do this, perform the merge
 
4146
    as desired.  Then doing revert with the "--forget-merges" option will keep
 
4147
    the content of the tree as it was, but it will clear the list of pending
 
4148
    merges.  The next commit will then contain all of the changes that are
 
4149
    present in the other branch, but without any other parent revisions.
 
4150
    Because this technique forgets where these changes originated, it may
 
4151
    cause additional conflicts on later merges involving the same source and
 
4152
    target branches.
3789
4153
    """
3790
4154
 
3791
4155
    _see_also = ['cat', 'export']
3800
4164
    def run(self, revision=None, no_backup=False, file_list=None,
3801
4165
            forget_merges=None):
3802
4166
        tree, file_list = tree_files(file_list)
3803
 
        tree.lock_write()
3804
 
        try:
3805
 
            if forget_merges:
3806
 
                tree.set_parent_ids(tree.get_parent_ids()[:1])
3807
 
            else:
3808
 
                self._revert_tree_to_revision(tree, revision, file_list, no_backup)
3809
 
        finally:
3810
 
            tree.unlock()
 
4167
        self.add_cleanup(tree.lock_tree_write().unlock)
 
4168
        if forget_merges:
 
4169
            tree.set_parent_ids(tree.get_parent_ids()[:1])
 
4170
        else:
 
4171
            self._revert_tree_to_revision(tree, revision, file_list, no_backup)
3811
4172
 
3812
4173
    @staticmethod
3813
4174
    def _revert_tree_to_revision(tree, revision, file_list, no_backup):
3814
4175
        rev_tree = _get_one_revision_tree('revert', revision, tree=tree)
3815
 
        pb = ui.ui_factory.nested_progress_bar()
3816
 
        try:
3817
 
            tree.revert(file_list, rev_tree, not no_backup, pb,
3818
 
                report_changes=True)
3819
 
        finally:
3820
 
            pb.finished()
 
4176
        tree.revert(file_list, rev_tree, not no_backup, None,
 
4177
            report_changes=True)
3821
4178
 
3822
4179
 
3823
4180
class cmd_assert_fail(Command):
3824
 
    """Test reporting of assertion failures"""
 
4181
    __doc__ = """Test reporting of assertion failures"""
3825
4182
    # intended just for use in testing
3826
4183
 
3827
4184
    hidden = True
3831
4188
 
3832
4189
 
3833
4190
class cmd_help(Command):
3834
 
    """Show help on a command or other topic.
 
4191
    __doc__ = """Show help on a command or other topic.
3835
4192
    """
3836
4193
 
3837
4194
    _see_also = ['topics']
3850
4207
 
3851
4208
 
3852
4209
class cmd_shell_complete(Command):
3853
 
    """Show appropriate completions for context.
 
4210
    __doc__ = """Show appropriate completions for context.
3854
4211
 
3855
4212
    For a list of all available commands, say 'bzr shell-complete'.
3856
4213
    """
3865
4222
 
3866
4223
 
3867
4224
class cmd_missing(Command):
3868
 
    """Show unmerged/unpulled revisions between two branches.
 
4225
    __doc__ = """Show unmerged/unpulled revisions between two branches.
3869
4226
 
3870
4227
    OTHER_BRANCH may be local or remote.
3871
4228
 
3872
4229
    To filter on a range of revisions, you can use the command -r begin..end
3873
4230
    -r revision requests a specific revision, -r ..end or -r begin.. are
3874
4231
    also valid.
 
4232
            
 
4233
    :Exit values:
 
4234
        1 - some missing revisions
 
4235
        0 - no missing revisions
3875
4236
 
3876
4237
    :Examples:
3877
4238
 
3898
4259
    _see_also = ['merge', 'pull']
3899
4260
    takes_args = ['other_branch?']
3900
4261
    takes_options = [
 
4262
        'directory',
3901
4263
        Option('reverse', 'Reverse the order of revisions.'),
3902
4264
        Option('mine-only',
3903
4265
               'Display changes in the local branch only.'),
3915
4277
            type=_parse_revision_str,
3916
4278
            help='Filter on local branch revisions (inclusive). '
3917
4279
                'See "help revisionspec" for details.'),
3918
 
        Option('include-merges', 'Show merged revisions.'),
 
4280
        Option('include-merges',
 
4281
               'Show all revisions in addition to the mainline ones.'),
3919
4282
        ]
3920
4283
    encoding_type = 'replace'
3921
4284
 
3924
4287
            theirs_only=False,
3925
4288
            log_format=None, long=False, short=False, line=False,
3926
4289
            show_ids=False, verbose=False, this=False, other=False,
3927
 
            include_merges=False, revision=None, my_revision=None):
 
4290
            include_merges=False, revision=None, my_revision=None,
 
4291
            directory=u'.'):
3928
4292
        from bzrlib.missing import find_unmerged, iter_log_revisions
3929
4293
        def message(s):
3930
4294
            if not is_quiet():
3943
4307
        elif theirs_only:
3944
4308
            restrict = 'remote'
3945
4309
 
3946
 
        local_branch = Branch.open_containing(u".")[0]
 
4310
        local_branch = Branch.open_containing(directory)[0]
 
4311
        self.add_cleanup(local_branch.lock_read().unlock)
 
4312
 
3947
4313
        parent = local_branch.get_parent()
3948
4314
        if other_branch is None:
3949
4315
            other_branch = parent
3958
4324
        remote_branch = Branch.open(other_branch)
3959
4325
        if remote_branch.base == local_branch.base:
3960
4326
            remote_branch = local_branch
 
4327
        else:
 
4328
            self.add_cleanup(remote_branch.lock_read().unlock)
3961
4329
 
3962
4330
        local_revid_range = _revision_range_to_revid_range(
3963
4331
            _get_revision_range(my_revision, local_branch,
3967
4335
            _get_revision_range(revision,
3968
4336
                remote_branch, self.name()))
3969
4337
 
3970
 
        local_branch.lock_read()
3971
 
        try:
3972
 
            remote_branch.lock_read()
3973
 
            try:
3974
 
                local_extra, remote_extra = find_unmerged(
3975
 
                    local_branch, remote_branch, restrict,
3976
 
                    backward=not reverse,
3977
 
                    include_merges=include_merges,
3978
 
                    local_revid_range=local_revid_range,
3979
 
                    remote_revid_range=remote_revid_range)
3980
 
 
3981
 
                if log_format is None:
3982
 
                    registry = log.log_formatter_registry
3983
 
                    log_format = registry.get_default(local_branch)
3984
 
                lf = log_format(to_file=self.outf,
3985
 
                                show_ids=show_ids,
3986
 
                                show_timezone='original')
3987
 
 
3988
 
                status_code = 0
3989
 
                if local_extra and not theirs_only:
3990
 
                    message("You have %d extra revision(s):\n" %
3991
 
                        len(local_extra))
3992
 
                    for revision in iter_log_revisions(local_extra,
3993
 
                                        local_branch.repository,
3994
 
                                        verbose):
3995
 
                        lf.log_revision(revision)
3996
 
                    printed_local = True
3997
 
                    status_code = 1
3998
 
                else:
3999
 
                    printed_local = False
4000
 
 
4001
 
                if remote_extra and not mine_only:
4002
 
                    if printed_local is True:
4003
 
                        message("\n\n\n")
4004
 
                    message("You are missing %d revision(s):\n" %
4005
 
                        len(remote_extra))
4006
 
                    for revision in iter_log_revisions(remote_extra,
4007
 
                                        remote_branch.repository,
4008
 
                                        verbose):
4009
 
                        lf.log_revision(revision)
4010
 
                    status_code = 1
4011
 
 
4012
 
                if mine_only and not local_extra:
4013
 
                    # We checked local, and found nothing extra
4014
 
                    message('This branch is up to date.\n')
4015
 
                elif theirs_only and not remote_extra:
4016
 
                    # We checked remote, and found nothing extra
4017
 
                    message('Other branch is up to date.\n')
4018
 
                elif not (mine_only or theirs_only or local_extra or
4019
 
                          remote_extra):
4020
 
                    # We checked both branches, and neither one had extra
4021
 
                    # revisions
4022
 
                    message("Branches are up to date.\n")
4023
 
            finally:
4024
 
                remote_branch.unlock()
4025
 
        finally:
4026
 
            local_branch.unlock()
 
4338
        local_extra, remote_extra = find_unmerged(
 
4339
            local_branch, remote_branch, restrict,
 
4340
            backward=not reverse,
 
4341
            include_merges=include_merges,
 
4342
            local_revid_range=local_revid_range,
 
4343
            remote_revid_range=remote_revid_range)
 
4344
 
 
4345
        if log_format is None:
 
4346
            registry = log.log_formatter_registry
 
4347
            log_format = registry.get_default(local_branch)
 
4348
        lf = log_format(to_file=self.outf,
 
4349
                        show_ids=show_ids,
 
4350
                        show_timezone='original')
 
4351
 
 
4352
        status_code = 0
 
4353
        if local_extra and not theirs_only:
 
4354
            message("You have %d extra revision(s):\n" %
 
4355
                len(local_extra))
 
4356
            for revision in iter_log_revisions(local_extra,
 
4357
                                local_branch.repository,
 
4358
                                verbose):
 
4359
                lf.log_revision(revision)
 
4360
            printed_local = True
 
4361
            status_code = 1
 
4362
        else:
 
4363
            printed_local = False
 
4364
 
 
4365
        if remote_extra and not mine_only:
 
4366
            if printed_local is True:
 
4367
                message("\n\n\n")
 
4368
            message("You are missing %d revision(s):\n" %
 
4369
                len(remote_extra))
 
4370
            for revision in iter_log_revisions(remote_extra,
 
4371
                                remote_branch.repository,
 
4372
                                verbose):
 
4373
                lf.log_revision(revision)
 
4374
            status_code = 1
 
4375
 
 
4376
        if mine_only and not local_extra:
 
4377
            # We checked local, and found nothing extra
 
4378
            message('This branch is up to date.\n')
 
4379
        elif theirs_only and not remote_extra:
 
4380
            # We checked remote, and found nothing extra
 
4381
            message('Other branch is up to date.\n')
 
4382
        elif not (mine_only or theirs_only or local_extra or
 
4383
                  remote_extra):
 
4384
            # We checked both branches, and neither one had extra
 
4385
            # revisions
 
4386
            message("Branches are up to date.\n")
 
4387
        self.cleanup_now()
4027
4388
        if not status_code and parent is None and other_branch is not None:
4028
 
            local_branch.lock_write()
4029
 
            try:
4030
 
                # handle race conditions - a parent might be set while we run.
4031
 
                if local_branch.get_parent() is None:
4032
 
                    local_branch.set_parent(remote_branch.base)
4033
 
            finally:
4034
 
                local_branch.unlock()
 
4389
            self.add_cleanup(local_branch.lock_write().unlock)
 
4390
            # handle race conditions - a parent might be set while we run.
 
4391
            if local_branch.get_parent() is None:
 
4392
                local_branch.set_parent(remote_branch.base)
4035
4393
        return status_code
4036
4394
 
4037
4395
 
4038
4396
class cmd_pack(Command):
4039
 
    """Compress the data within a repository."""
 
4397
    __doc__ = """Compress the data within a repository.
 
4398
 
 
4399
    This operation compresses the data within a bazaar repository. As
 
4400
    bazaar supports automatic packing of repository, this operation is
 
4401
    normally not required to be done manually.
 
4402
 
 
4403
    During the pack operation, bazaar takes a backup of existing repository
 
4404
    data, i.e. pack files. This backup is eventually removed by bazaar
 
4405
    automatically when it is safe to do so. To save disk space by removing
 
4406
    the backed up pack files, the --clean-obsolete-packs option may be
 
4407
    used.
 
4408
 
 
4409
    Warning: If you use --clean-obsolete-packs and your machine crashes
 
4410
    during or immediately after repacking, you may be left with a state
 
4411
    where the deletion has been written to disk but the new packs have not
 
4412
    been. In this case the repository may be unusable.
 
4413
    """
4040
4414
 
4041
4415
    _see_also = ['repositories']
4042
4416
    takes_args = ['branch_or_repo?']
 
4417
    takes_options = [
 
4418
        Option('clean-obsolete-packs', 'Delete obsolete packs to save disk space.'),
 
4419
        ]
4043
4420
 
4044
 
    def run(self, branch_or_repo='.'):
 
4421
    def run(self, branch_or_repo='.', clean_obsolete_packs=False):
4045
4422
        dir = bzrdir.BzrDir.open_containing(branch_or_repo)[0]
4046
4423
        try:
4047
4424
            branch = dir.open_branch()
4048
4425
            repository = branch.repository
4049
4426
        except errors.NotBranchError:
4050
4427
            repository = dir.open_repository()
4051
 
        repository.pack()
 
4428
        repository.pack(clean_obsolete_packs=clean_obsolete_packs)
4052
4429
 
4053
4430
 
4054
4431
class cmd_plugins(Command):
4055
 
    """List the installed plugins.
 
4432
    __doc__ = """List the installed plugins.
4056
4433
 
4057
4434
    This command displays the list of installed plugins including
4058
4435
    version of plugin and a short description of each.
4065
4442
    adding new commands, providing additional network transports and
4066
4443
    customizing log output.
4067
4444
 
4068
 
    See the Bazaar web site, http://bazaar-vcs.org, for further
4069
 
    information on plugins including where to find them and how to
4070
 
    install them. Instructions are also provided there on how to
4071
 
    write new plugins using the Python programming language.
 
4445
    See the Bazaar Plugin Guide <http://doc.bazaar.canonical.com/plugins/en/>
 
4446
    for further information on plugins including where to find them and how to
 
4447
    install them. Instructions are also provided there on how to write new
 
4448
    plugins using the Python programming language.
4072
4449
    """
4073
4450
    takes_options = ['verbose']
4074
4451
 
4089
4466
                doc = '(no description)'
4090
4467
            result.append((name_ver, doc, plugin.path()))
4091
4468
        for name_ver, doc, path in sorted(result):
4092
 
            print name_ver
4093
 
            print '   ', doc
 
4469
            self.outf.write("%s\n" % name_ver)
 
4470
            self.outf.write("   %s\n" % doc)
4094
4471
            if verbose:
4095
 
                print '   ', path
4096
 
            print
 
4472
                self.outf.write("   %s\n" % path)
 
4473
            self.outf.write("\n")
4097
4474
 
4098
4475
 
4099
4476
class cmd_testament(Command):
4100
 
    """Show testament (signing-form) of a revision."""
 
4477
    __doc__ = """Show testament (signing-form) of a revision."""
4101
4478
    takes_options = [
4102
4479
            'revision',
4103
4480
            Option('long', help='Produce long-format testament.'),
4115
4492
            b = Branch.open_containing(branch)[0]
4116
4493
        else:
4117
4494
            b = Branch.open(branch)
4118
 
        b.lock_read()
4119
 
        try:
4120
 
            if revision is None:
4121
 
                rev_id = b.last_revision()
4122
 
            else:
4123
 
                rev_id = revision[0].as_revision_id(b)
4124
 
            t = testament_class.from_revision(b.repository, rev_id)
4125
 
            if long:
4126
 
                sys.stdout.writelines(t.as_text_lines())
4127
 
            else:
4128
 
                sys.stdout.write(t.as_short_text())
4129
 
        finally:
4130
 
            b.unlock()
 
4495
        self.add_cleanup(b.lock_read().unlock)
 
4496
        if revision is None:
 
4497
            rev_id = b.last_revision()
 
4498
        else:
 
4499
            rev_id = revision[0].as_revision_id(b)
 
4500
        t = testament_class.from_revision(b.repository, rev_id)
 
4501
        if long:
 
4502
            sys.stdout.writelines(t.as_text_lines())
 
4503
        else:
 
4504
            sys.stdout.write(t.as_short_text())
4131
4505
 
4132
4506
 
4133
4507
class cmd_annotate(Command):
4134
 
    """Show the origin of each line in a file.
 
4508
    __doc__ = """Show the origin of each line in a file.
4135
4509
 
4136
4510
    This prints out the given file with an annotation on the left side
4137
4511
    indicating which revision, author and date introduced the change.
4148
4522
                     Option('long', help='Show commit date in annotations.'),
4149
4523
                     'revision',
4150
4524
                     'show-ids',
 
4525
                     'directory',
4151
4526
                     ]
4152
4527
    encoding_type = 'exact'
4153
4528
 
4154
4529
    @display_command
4155
4530
    def run(self, filename, all=False, long=False, revision=None,
4156
 
            show_ids=False):
 
4531
            show_ids=False, directory=None):
4157
4532
        from bzrlib.annotate import annotate_file, annotate_file_tree
4158
4533
        wt, branch, relpath = \
4159
 
            bzrdir.BzrDir.open_containing_tree_or_branch(filename)
4160
 
        if wt is not None:
4161
 
            wt.lock_read()
4162
 
        else:
4163
 
            branch.lock_read()
4164
 
        try:
4165
 
            tree = _get_one_revision_tree('annotate', revision, branch=branch)
4166
 
            if wt is not None:
4167
 
                file_id = wt.path2id(relpath)
4168
 
            else:
4169
 
                file_id = tree.path2id(relpath)
4170
 
            if file_id is None:
4171
 
                raise errors.NotVersionedError(filename)
4172
 
            file_version = tree.inventory[file_id].revision
4173
 
            if wt is not None and revision is None:
4174
 
                # If there is a tree and we're not annotating historical
4175
 
                # versions, annotate the working tree's content.
4176
 
                annotate_file_tree(wt, file_id, self.outf, long, all,
4177
 
                    show_ids=show_ids)
4178
 
            else:
4179
 
                annotate_file(branch, file_version, file_id, long, all, self.outf,
4180
 
                              show_ids=show_ids)
4181
 
        finally:
4182
 
            if wt is not None:
4183
 
                wt.unlock()
4184
 
            else:
4185
 
                branch.unlock()
 
4534
            _open_directory_or_containing_tree_or_branch(filename, directory)
 
4535
        if wt is not None:
 
4536
            self.add_cleanup(wt.lock_read().unlock)
 
4537
        else:
 
4538
            self.add_cleanup(branch.lock_read().unlock)
 
4539
        tree = _get_one_revision_tree('annotate', revision, branch=branch)
 
4540
        self.add_cleanup(tree.lock_read().unlock)
 
4541
        if wt is not None:
 
4542
            file_id = wt.path2id(relpath)
 
4543
        else:
 
4544
            file_id = tree.path2id(relpath)
 
4545
        if file_id is None:
 
4546
            raise errors.NotVersionedError(filename)
 
4547
        file_version = tree.inventory[file_id].revision
 
4548
        if wt is not None and revision is None:
 
4549
            # If there is a tree and we're not annotating historical
 
4550
            # versions, annotate the working tree's content.
 
4551
            annotate_file_tree(wt, file_id, self.outf, long, all,
 
4552
                show_ids=show_ids)
 
4553
        else:
 
4554
            annotate_file(branch, file_version, file_id, long, all, self.outf,
 
4555
                          show_ids=show_ids)
4186
4556
 
4187
4557
 
4188
4558
class cmd_re_sign(Command):
4189
 
    """Create a digital signature for an existing revision."""
 
4559
    __doc__ = """Create a digital signature for an existing revision."""
4190
4560
    # TODO be able to replace existing ones.
4191
4561
 
4192
4562
    hidden = True # is this right ?
4193
4563
    takes_args = ['revision_id*']
4194
 
    takes_options = ['revision']
 
4564
    takes_options = ['directory', 'revision']
4195
4565
 
4196
 
    def run(self, revision_id_list=None, revision=None):
 
4566
    def run(self, revision_id_list=None, revision=None, directory=u'.'):
4197
4567
        if revision_id_list is not None and revision is not None:
4198
4568
            raise errors.BzrCommandError('You can only supply one of revision_id or --revision')
4199
4569
        if revision_id_list is None and revision is None:
4200
4570
            raise errors.BzrCommandError('You must supply either --revision or a revision_id')
4201
 
        b = WorkingTree.open_containing(u'.')[0].branch
4202
 
        b.lock_write()
4203
 
        try:
4204
 
            return self._run(b, revision_id_list, revision)
4205
 
        finally:
4206
 
            b.unlock()
 
4571
        b = WorkingTree.open_containing(directory)[0].branch
 
4572
        self.add_cleanup(b.lock_write().unlock)
 
4573
        return self._run(b, revision_id_list, revision)
4207
4574
 
4208
4575
    def _run(self, b, revision_id_list, revision):
4209
4576
        import bzrlib.gpg as gpg
4254
4621
 
4255
4622
 
4256
4623
class cmd_bind(Command):
4257
 
    """Convert the current branch into a checkout of the supplied branch.
 
4624
    __doc__ = """Convert the current branch into a checkout of the supplied branch.
 
4625
    If no branch is supplied, rebind to the last bound location.
4258
4626
 
4259
4627
    Once converted into a checkout, commits must succeed on the master branch
4260
4628
    before they will be applied to the local branch.
4261
4629
 
4262
4630
    Bound branches use the nickname of its master branch unless it is set
4263
 
    locally, in which case binding will update the the local nickname to be
 
4631
    locally, in which case binding will update the local nickname to be
4264
4632
    that of the master.
4265
4633
    """
4266
4634
 
4267
4635
    _see_also = ['checkouts', 'unbind']
4268
4636
    takes_args = ['location?']
4269
 
    takes_options = []
 
4637
    takes_options = ['directory']
4270
4638
 
4271
 
    def run(self, location=None):
4272
 
        b, relpath = Branch.open_containing(u'.')
 
4639
    def run(self, location=None, directory=u'.'):
 
4640
        b, relpath = Branch.open_containing(directory)
4273
4641
        if location is None:
4274
4642
            try:
4275
4643
                location = b.get_old_bound_location()
4278
4646
                    'This format does not remember old locations.')
4279
4647
            else:
4280
4648
                if location is None:
4281
 
                    raise errors.BzrCommandError('No location supplied and no '
4282
 
                        'previous location known')
 
4649
                    if b.get_bound_location() is not None:
 
4650
                        raise errors.BzrCommandError('Branch is already bound')
 
4651
                    else:
 
4652
                        raise errors.BzrCommandError('No location supplied '
 
4653
                            'and no previous location known')
4283
4654
        b_other = Branch.open(location)
4284
4655
        try:
4285
4656
            b.bind(b_other)
4291
4662
 
4292
4663
 
4293
4664
class cmd_unbind(Command):
4294
 
    """Convert the current checkout into a regular branch.
 
4665
    __doc__ = """Convert the current checkout into a regular branch.
4295
4666
 
4296
4667
    After unbinding, the local branch is considered independent and subsequent
4297
4668
    commits will be local only.
4299
4670
 
4300
4671
    _see_also = ['checkouts', 'bind']
4301
4672
    takes_args = []
4302
 
    takes_options = []
 
4673
    takes_options = ['directory']
4303
4674
 
4304
 
    def run(self):
4305
 
        b, relpath = Branch.open_containing(u'.')
 
4675
    def run(self, directory=u'.'):
 
4676
        b, relpath = Branch.open_containing(directory)
4306
4677
        if not b.unbind():
4307
4678
            raise errors.BzrCommandError('Local branch is not bound')
4308
4679
 
4309
4680
 
4310
4681
class cmd_uncommit(Command):
4311
 
    """Remove the last committed revision.
 
4682
    __doc__ = """Remove the last committed revision.
4312
4683
 
4313
4684
    --verbose will print out what is being removed.
4314
4685
    --dry-run will go through all the motions, but not actually
4354
4725
            b = control.open_branch()
4355
4726
 
4356
4727
        if tree is not None:
4357
 
            tree.lock_write()
 
4728
            self.add_cleanup(tree.lock_write().unlock)
4358
4729
        else:
4359
 
            b.lock_write()
4360
 
        try:
4361
 
            return self._run(b, tree, dry_run, verbose, revision, force,
4362
 
                             local=local)
4363
 
        finally:
4364
 
            if tree is not None:
4365
 
                tree.unlock()
4366
 
            else:
4367
 
                b.unlock()
 
4730
            self.add_cleanup(b.lock_write().unlock)
 
4731
        return self._run(b, tree, dry_run, verbose, revision, force, local=local)
4368
4732
 
4369
4733
    def _run(self, b, tree, dry_run, verbose, revision, force, local=False):
4370
4734
        from bzrlib.log import log_formatter, show_log
4402
4766
                 end_revision=last_revno)
4403
4767
 
4404
4768
        if dry_run:
4405
 
            print 'Dry-run, pretending to remove the above revisions.'
4406
 
            if not force:
4407
 
                val = raw_input('Press <enter> to continue')
 
4769
            self.outf.write('Dry-run, pretending to remove'
 
4770
                            ' the above revisions.\n')
4408
4771
        else:
4409
 
            print 'The above revision(s) will be removed.'
4410
 
            if not force:
4411
 
                val = raw_input('Are you sure [y/N]? ')
4412
 
                if val.lower() not in ('y', 'yes'):
4413
 
                    print 'Canceled'
4414
 
                    return 0
 
4772
            self.outf.write('The above revision(s) will be removed.\n')
 
4773
 
 
4774
        if not force:
 
4775
            if not ui.ui_factory.get_boolean('Are you sure'):
 
4776
                self.outf.write('Canceled')
 
4777
                return 0
4415
4778
 
4416
4779
        mutter('Uncommitting from {%s} to {%s}',
4417
4780
               last_rev_id, rev_id)
4418
4781
        uncommit(b, tree=tree, dry_run=dry_run, verbose=verbose,
4419
4782
                 revno=revno, local=local)
4420
 
        note('You can restore the old tip by running:\n'
4421
 
             '  bzr pull . -r revid:%s', last_rev_id)
 
4783
        self.outf.write('You can restore the old tip by running:\n'
 
4784
             '  bzr pull . -r revid:%s\n' % last_rev_id)
4422
4785
 
4423
4786
 
4424
4787
class cmd_break_lock(Command):
4425
 
    """Break a dead lock on a repository, branch or working directory.
 
4788
    __doc__ = """Break a dead lock on a repository, branch or working directory.
4426
4789
 
4427
4790
    CAUTION: Locks should only be broken when you are sure that the process
4428
4791
    holding the lock has been stopped.
4429
4792
 
4430
 
    You can get information on what locks are open via the 'bzr info' command.
 
4793
    You can get information on what locks are open via the 'bzr info
 
4794
    [location]' command.
4431
4795
 
4432
4796
    :Examples:
4433
4797
        bzr break-lock
 
4798
        bzr break-lock bzr+ssh://example.com/bzr/foo
4434
4799
    """
4435
4800
    takes_args = ['location?']
4436
4801
 
4445
4810
 
4446
4811
 
4447
4812
class cmd_wait_until_signalled(Command):
4448
 
    """Test helper for test_start_and_stop_bzr_subprocess_send_signal.
 
4813
    __doc__ = """Test helper for test_start_and_stop_bzr_subprocess_send_signal.
4449
4814
 
4450
4815
    This just prints a line to signal when it is ready, then blocks on stdin.
4451
4816
    """
4459
4824
 
4460
4825
 
4461
4826
class cmd_serve(Command):
4462
 
    """Run the bzr server."""
 
4827
    __doc__ = """Run the bzr server."""
4463
4828
 
4464
4829
    aliases = ['server']
4465
4830
 
4466
4831
    takes_options = [
4467
4832
        Option('inet',
4468
4833
               help='Serve on stdin/out for use from inetd or sshd.'),
 
4834
        RegistryOption('protocol',
 
4835
               help="Protocol to serve.",
 
4836
               lazy_registry=('bzrlib.transport', 'transport_server_registry'),
 
4837
               value_switches=True),
4469
4838
        Option('port',
4470
4839
               help='Listen for connections on nominated port of the form '
4471
4840
                    '[hostname:]portnumber.  Passing 0 as the port number will '
4472
 
                    'result in a dynamically allocated port.  The default port is '
4473
 
                    '4155.',
 
4841
                    'result in a dynamically allocated port.  The default port '
 
4842
                    'depends on the protocol.',
4474
4843
               type=str),
4475
 
        Option('directory',
4476
 
               help='Serve contents of this directory.',
4477
 
               type=unicode),
 
4844
        custom_help('directory',
 
4845
               help='Serve contents of this directory.'),
4478
4846
        Option('allow-writes',
4479
4847
               help='By default the server is a readonly server.  Supplying '
4480
4848
                    '--allow-writes enables write access to the contents of '
4481
 
                    'the served directory and below.'
 
4849
                    'the served directory and below.  Note that ``bzr serve`` '
 
4850
                    'does not perform authentication, so unless some form of '
 
4851
                    'external authentication is arranged supplying this '
 
4852
                    'option leads to global uncontrolled write access to your '
 
4853
                    'file system.'
4482
4854
                ),
4483
4855
        ]
4484
4856
 
4485
 
    def run_smart_server(self, smart_server):
4486
 
        """Run 'smart_server' forever, with no UI output at all."""
4487
 
        # For the duration of this server, no UI output is permitted. note
4488
 
        # that this may cause problems with blackbox tests. This should be
4489
 
        # changed with care though, as we dont want to use bandwidth sending
4490
 
        # progress over stderr to smart server clients!
4491
 
        from bzrlib import lockdir
4492
 
        old_factory = ui.ui_factory
4493
 
        old_lockdir_timeout = lockdir._DEFAULT_TIMEOUT_SECONDS
4494
 
        try:
4495
 
            ui.ui_factory = ui.SilentUIFactory()
4496
 
            lockdir._DEFAULT_TIMEOUT_SECONDS = 0
4497
 
            smart_server.serve()
4498
 
        finally:
4499
 
            ui.ui_factory = old_factory
4500
 
            lockdir._DEFAULT_TIMEOUT_SECONDS = old_lockdir_timeout
4501
 
 
4502
4857
    def get_host_and_port(self, port):
4503
4858
        """Return the host and port to run the smart server on.
4504
4859
 
4505
 
        If 'port' is None, the default host (`medium.BZR_DEFAULT_INTERFACE`)
4506
 
        and port (`medium.BZR_DEFAULT_PORT`) will be used.
 
4860
        If 'port' is None, None will be returned for the host and port.
4507
4861
 
4508
4862
        If 'port' has a colon in it, the string before the colon will be
4509
4863
        interpreted as the host.
4512
4866
        :return: A tuple of (host, port), where 'host' is a host name or IP,
4513
4867
            and port is an integer TCP/IP port.
4514
4868
        """
4515
 
        from bzrlib.smart import medium
4516
 
        host = medium.BZR_DEFAULT_INTERFACE
4517
 
        if port is None:
4518
 
            port = medium.BZR_DEFAULT_PORT
4519
 
        else:
 
4869
        host = None
 
4870
        if port is not None:
4520
4871
            if ':' in port:
4521
4872
                host, port = port.split(':')
4522
4873
            port = int(port)
4523
4874
        return host, port
4524
4875
 
4525
 
    def get_smart_server(self, transport, inet, port):
4526
 
        """Construct a smart server.
4527
 
 
4528
 
        :param transport: The base transport from which branches will be
4529
 
            served.
4530
 
        :param inet: If True, serve over stdin and stdout. Used for running
4531
 
            from inet.
4532
 
        :param port: The port to listen on. By default, it's `
4533
 
            medium.BZR_DEFAULT_PORT`. See `get_host_and_port` for more
4534
 
            information.
4535
 
        :return: A smart server.
4536
 
        """
4537
 
        from bzrlib.smart import medium, server
4538
 
        if inet:
4539
 
            smart_server = medium.SmartServerPipeStreamMedium(
4540
 
                sys.stdin, sys.stdout, transport)
4541
 
        else:
4542
 
            host, port = self.get_host_and_port(port)
4543
 
            smart_server = server.SmartTCPServer(
4544
 
                transport, host=host, port=port)
4545
 
            note('listening on port: %s' % smart_server.port)
4546
 
        return smart_server
4547
 
 
4548
 
    def run(self, port=None, inet=False, directory=None, allow_writes=False):
4549
 
        from bzrlib.transport import get_transport
4550
 
        from bzrlib.transport.chroot import ChrootServer
 
4876
    def run(self, port=None, inet=False, directory=None, allow_writes=False,
 
4877
            protocol=None):
 
4878
        from bzrlib import transport
4551
4879
        if directory is None:
4552
4880
            directory = os.getcwd()
 
4881
        if protocol is None:
 
4882
            protocol = transport.transport_server_registry.get()
 
4883
        host, port = self.get_host_and_port(port)
4553
4884
        url = urlutils.local_path_to_url(directory)
4554
4885
        if not allow_writes:
4555
4886
            url = 'readonly+' + url
4556
 
        chroot_server = ChrootServer(get_transport(url))
4557
 
        chroot_server.setUp()
4558
 
        t = get_transport(chroot_server.get_url())
4559
 
        smart_server = self.get_smart_server(t, inet, port)
4560
 
        self.run_smart_server(smart_server)
 
4887
        t = transport.get_transport(url)
 
4888
        protocol(t, host, port, inet)
4561
4889
 
4562
4890
 
4563
4891
class cmd_join(Command):
4564
 
    """Combine a subtree into its containing tree.
 
4892
    __doc__ = """Combine a tree into its containing tree.
4565
4893
 
4566
 
    This command is for experimental use only.  It requires the target tree
4567
 
    to be in dirstate-with-subtree format, which cannot be converted into
4568
 
    earlier formats.
 
4894
    This command requires the target tree to be in a rich-root format.
4569
4895
 
4570
4896
    The TREE argument should be an independent tree, inside another tree, but
4571
4897
    not part of it.  (Such trees can be produced by "bzr split", but also by
4574
4900
    The result is a combined tree, with the subtree no longer an independant
4575
4901
    part.  This is marked as a merge of the subtree into the containing tree,
4576
4902
    and all history is preserved.
4577
 
 
4578
 
    If --reference is specified, the subtree retains its independence.  It can
4579
 
    be branched by itself, and can be part of multiple projects at the same
4580
 
    time.  But operations performed in the containing tree, such as commit
4581
 
    and merge, will recurse into the subtree.
4582
4903
    """
4583
4904
 
4584
4905
    _see_also = ['split']
4585
4906
    takes_args = ['tree']
4586
4907
    takes_options = [
4587
 
            Option('reference', help='Join by reference.'),
 
4908
            Option('reference', help='Join by reference.', hidden=True),
4588
4909
            ]
4589
 
    hidden = True
4590
4910
 
4591
4911
    def run(self, tree, reference=False):
4592
4912
        sub_tree = WorkingTree.open(tree)
4615
4935
 
4616
4936
 
4617
4937
class cmd_split(Command):
4618
 
    """Split a subdirectory of a tree into a separate tree.
 
4938
    __doc__ = """Split a subdirectory of a tree into a separate tree.
4619
4939
 
4620
4940
    This command will produce a target tree in a format that supports
4621
4941
    rich roots, like 'rich-root' or 'rich-root-pack'.  These formats cannot be
4626
4946
    branch.  Commits in the top-level tree will not apply to the new subtree.
4627
4947
    """
4628
4948
 
4629
 
    # join is not un-hidden yet
4630
 
    #_see_also = ['join']
 
4949
    _see_also = ['join']
4631
4950
    takes_args = ['tree']
4632
4951
 
4633
4952
    def run(self, tree):
4638
4957
        try:
4639
4958
            containing_tree.extract(sub_id)
4640
4959
        except errors.RootNotRich:
4641
 
            raise errors.UpgradeRequired(containing_tree.branch.base)
 
4960
            raise errors.RichRootUpgradeRequired(containing_tree.branch.base)
4642
4961
 
4643
4962
 
4644
4963
class cmd_merge_directive(Command):
4645
 
    """Generate a merge directive for auto-merge tools.
 
4964
    __doc__ = """Generate a merge directive for auto-merge tools.
4646
4965
 
4647
4966
    A directive requests a merge to be performed, and also provides all the
4648
4967
    information necessary to do so.  This means it must either include a
4665
4984
    _see_also = ['send']
4666
4985
 
4667
4986
    takes_options = [
 
4987
        'directory',
4668
4988
        RegistryOption.from_kwargs('patch-type',
4669
4989
            'The type of patch to include in the directive.',
4670
4990
            title='Patch type',
4683
5003
    encoding_type = 'exact'
4684
5004
 
4685
5005
    def run(self, submit_branch=None, public_branch=None, patch_type='bundle',
4686
 
            sign=False, revision=None, mail_to=None, message=None):
 
5006
            sign=False, revision=None, mail_to=None, message=None,
 
5007
            directory=u'.'):
4687
5008
        from bzrlib.revision import ensure_null, NULL_REVISION
4688
5009
        include_patch, include_bundle = {
4689
5010
            'plain': (False, False),
4690
5011
            'diff': (True, False),
4691
5012
            'bundle': (True, True),
4692
5013
            }[patch_type]
4693
 
        branch = Branch.open('.')
 
5014
        branch = Branch.open(directory)
4694
5015
        stored_submit_branch = branch.get_submit_branch()
4695
5016
        if submit_branch is None:
4696
5017
            submit_branch = stored_submit_branch
4741
5062
 
4742
5063
 
4743
5064
class cmd_send(Command):
4744
 
    """Mail or create a merge-directive for submitting changes.
 
5065
    __doc__ = """Mail or create a merge-directive for submitting changes.
4745
5066
 
4746
5067
    A merge directive provides many things needed for requesting merges:
4747
5068
 
4753
5074
      directly from the merge directive, without retrieving data from a
4754
5075
      branch.
4755
5076
 
4756
 
    If --no-bundle is specified, then public_branch is needed (and must be
4757
 
    up-to-date), so that the receiver can perform the merge using the
4758
 
    public_branch.  The public_branch is always included if known, so that
4759
 
    people can check it later.
4760
 
 
4761
 
    The submit branch defaults to the parent, but can be overridden.  Both
4762
 
    submit branch and public branch will be remembered if supplied.
4763
 
 
4764
 
    If a public_branch is known for the submit_branch, that public submit
4765
 
    branch is used in the merge instructions.  This means that a local mirror
4766
 
    can be used as your actual submit branch, once you have set public_branch
4767
 
    for that mirror.
 
5077
    `bzr send` creates a compact data set that, when applied using bzr
 
5078
    merge, has the same effect as merging from the source branch.  
 
5079
    
 
5080
    By default the merge directive is self-contained and can be applied to any
 
5081
    branch containing submit_branch in its ancestory without needing access to
 
5082
    the source branch.
 
5083
    
 
5084
    If --no-bundle is specified, then Bazaar doesn't send the contents of the
 
5085
    revisions, but only a structured request to merge from the
 
5086
    public_location.  In that case the public_branch is needed and it must be
 
5087
    up-to-date and accessible to the recipient.  The public_branch is always
 
5088
    included if known, so that people can check it later.
 
5089
 
 
5090
    The submit branch defaults to the parent of the source branch, but can be
 
5091
    overridden.  Both submit branch and public branch will be remembered in
 
5092
    branch.conf the first time they are used for a particular branch.  The
 
5093
    source branch defaults to that containing the working directory, but can
 
5094
    be changed using --from.
 
5095
 
 
5096
    In order to calculate those changes, bzr must analyse the submit branch.
 
5097
    Therefore it is most efficient for the submit branch to be a local mirror.
 
5098
    If a public location is known for the submit_branch, that location is used
 
5099
    in the merge directive.
 
5100
 
 
5101
    The default behaviour is to send the merge directive by mail, unless -o is
 
5102
    given, in which case it is sent to a file.
4768
5103
 
4769
5104
    Mail is sent using your preferred mail program.  This should be transparent
4770
 
    on Windows (it uses MAPI).  On Linux, it requires the xdg-email utility.
 
5105
    on Windows (it uses MAPI).  On Unix, it requires the xdg-email utility.
4771
5106
    If the preferred client can't be found (or used), your editor will be used.
4772
5107
 
4773
5108
    To use a specific mail program, set the mail_client configuration option.
4774
5109
    (For Thunderbird 1.5, this works around some bugs.)  Supported values for
4775
 
    specific clients are "claws", "evolution", "kmail", "mutt", and
4776
 
    "thunderbird"; generic options are "default", "editor", "emacsclient",
4777
 
    "mapi", and "xdg-email".  Plugins may also add supported clients.
 
5110
    specific clients are "claws", "evolution", "kmail", "mail.app" (MacOS X's
 
5111
    Mail.app), "mutt", and "thunderbird"; generic options are "default",
 
5112
    "editor", "emacsclient", "mapi", and "xdg-email".  Plugins may also add
 
5113
    supported clients.
4778
5114
 
4779
5115
    If mail is being sent, a to address is required.  This can be supplied
4780
5116
    either on the commandline, by setting the submit_to configuration
4789
5125
 
4790
5126
    The merge directives created by bzr send may be applied using bzr merge or
4791
5127
    bzr pull by specifying a file containing a merge directive as the location.
 
5128
 
 
5129
    bzr send makes extensive use of public locations to map local locations into
 
5130
    URLs that can be used by other people.  See `bzr help configuration` to
 
5131
    set them, and use `bzr info` to display them.
4792
5132
    """
4793
5133
 
4794
5134
    encoding_type = 'exact'
4810
5150
               short_name='f',
4811
5151
               type=unicode),
4812
5152
        Option('output', short_name='o',
4813
 
               help='Write merge directive to this file; '
 
5153
               help='Write merge directive to this file or directory; '
4814
5154
                    'use - for stdout.',
4815
5155
               type=unicode),
 
5156
        Option('strict',
 
5157
               help='Refuse to send if there are uncommitted changes in'
 
5158
               ' the working tree, --no-strict disables the check.'),
4816
5159
        Option('mail-to', help='Mail the request to this address.',
4817
5160
               type=unicode),
4818
5161
        'revision',
4819
5162
        'message',
4820
5163
        Option('body', help='Body for the email.', type=unicode),
4821
 
        RegistryOption.from_kwargs('format',
4822
 
        'Use the specified output format.',
4823
 
        **{'4': 'Bundle format 4, Merge Directive 2 (default)',
4824
 
           '0.9': 'Bundle format 0.9, Merge Directive 1',})
 
5164
        RegistryOption('format',
 
5165
                       help='Use the specified output format.',
 
5166
                       lazy_registry=('bzrlib.send', 'format_registry')),
4825
5167
        ]
4826
5168
 
4827
5169
    def run(self, submit_branch=None, public_branch=None, no_bundle=False,
4828
5170
            no_patch=False, revision=None, remember=False, output=None,
4829
 
            format='4', mail_to=None, message=None, body=None, **kwargs):
4830
 
        return self._run(submit_branch, revision, public_branch, remember,
4831
 
                         format, no_bundle, no_patch, output,
4832
 
                         kwargs.get('from', '.'), mail_to, message, body)
4833
 
 
4834
 
    def _run(self, submit_branch, revision, public_branch, remember, format,
4835
 
             no_bundle, no_patch, output, from_, mail_to, message, body):
4836
 
        from bzrlib.revision import NULL_REVISION
4837
 
        branch = Branch.open_containing(from_)[0]
4838
 
        if output is None:
4839
 
            outfile = cStringIO.StringIO()
4840
 
        elif output == '-':
4841
 
            outfile = self.outf
4842
 
        else:
4843
 
            outfile = open(output, 'wb')
4844
 
        # we may need to write data into branch's repository to calculate
4845
 
        # the data to send.
4846
 
        branch.lock_write()
4847
 
        try:
4848
 
            if output is None:
4849
 
                config = branch.get_config()
4850
 
                if mail_to is None:
4851
 
                    mail_to = config.get_user_option('submit_to')
4852
 
                mail_client = config.get_mail_client()
4853
 
                if (not getattr(mail_client, 'supports_body', False)
4854
 
                    and body is not None):
4855
 
                    raise errors.BzrCommandError(
4856
 
                        'Mail client "%s" does not support specifying body' %
4857
 
                        mail_client.__class__.__name__)
4858
 
            if remember and submit_branch is None:
4859
 
                raise errors.BzrCommandError(
4860
 
                    '--remember requires a branch to be specified.')
4861
 
            stored_submit_branch = branch.get_submit_branch()
4862
 
            remembered_submit_branch = None
4863
 
            if submit_branch is None:
4864
 
                submit_branch = stored_submit_branch
4865
 
                remembered_submit_branch = "submit"
4866
 
            else:
4867
 
                if stored_submit_branch is None or remember:
4868
 
                    branch.set_submit_branch(submit_branch)
4869
 
            if submit_branch is None:
4870
 
                submit_branch = branch.get_parent()
4871
 
                remembered_submit_branch = "parent"
4872
 
            if submit_branch is None:
4873
 
                raise errors.BzrCommandError('No submit branch known or'
4874
 
                                             ' specified')
4875
 
            if remembered_submit_branch is not None:
4876
 
                note('Using saved %s location "%s" to determine what '
4877
 
                        'changes to submit.', remembered_submit_branch,
4878
 
                        submit_branch)
4879
 
 
4880
 
            if mail_to is None:
4881
 
                submit_config = Branch.open(submit_branch).get_config()
4882
 
                mail_to = submit_config.get_user_option("child_submit_to")
4883
 
 
4884
 
            stored_public_branch = branch.get_public_branch()
4885
 
            if public_branch is None:
4886
 
                public_branch = stored_public_branch
4887
 
            elif stored_public_branch is None or remember:
4888
 
                branch.set_public_branch(public_branch)
4889
 
            if no_bundle and public_branch is None:
4890
 
                raise errors.BzrCommandError('No public branch specified or'
4891
 
                                             ' known')
4892
 
            base_revision_id = None
4893
 
            revision_id = None
4894
 
            if revision is not None:
4895
 
                if len(revision) > 2:
4896
 
                    raise errors.BzrCommandError('bzr send takes '
4897
 
                        'at most two one revision identifiers')
4898
 
                revision_id = revision[-1].as_revision_id(branch)
4899
 
                if len(revision) == 2:
4900
 
                    base_revision_id = revision[0].as_revision_id(branch)
4901
 
            if revision_id is None:
4902
 
                revision_id = branch.last_revision()
4903
 
            if revision_id == NULL_REVISION:
4904
 
                raise errors.BzrCommandError('No revisions to submit.')
4905
 
            if format == '4':
4906
 
                directive = merge_directive.MergeDirective2.from_objects(
4907
 
                    branch.repository, revision_id, time.time(),
4908
 
                    osutils.local_time_offset(), submit_branch,
4909
 
                    public_branch=public_branch, include_patch=not no_patch,
4910
 
                    include_bundle=not no_bundle, message=message,
4911
 
                    base_revision_id=base_revision_id)
4912
 
            elif format == '0.9':
4913
 
                if not no_bundle:
4914
 
                    if not no_patch:
4915
 
                        patch_type = 'bundle'
4916
 
                    else:
4917
 
                        raise errors.BzrCommandError('Format 0.9 does not'
4918
 
                            ' permit bundle with no patch')
4919
 
                else:
4920
 
                    if not no_patch:
4921
 
                        patch_type = 'diff'
4922
 
                    else:
4923
 
                        patch_type = None
4924
 
                directive = merge_directive.MergeDirective.from_objects(
4925
 
                    branch.repository, revision_id, time.time(),
4926
 
                    osutils.local_time_offset(), submit_branch,
4927
 
                    public_branch=public_branch, patch_type=patch_type,
4928
 
                    message=message)
4929
 
 
4930
 
            outfile.writelines(directive.to_lines())
4931
 
            if output is None:
4932
 
                subject = '[MERGE] '
4933
 
                if message is not None:
4934
 
                    subject += message
4935
 
                else:
4936
 
                    revision = branch.repository.get_revision(revision_id)
4937
 
                    subject += revision.get_summary()
4938
 
                basename = directive.get_disk_name(branch)
4939
 
                mail_client.compose_merge_request(mail_to, subject,
4940
 
                                                  outfile.getvalue(),
4941
 
                                                  basename, body)
4942
 
        finally:
4943
 
            if output != '-':
4944
 
                outfile.close()
4945
 
            branch.unlock()
 
5171
            format=None, mail_to=None, message=None, body=None,
 
5172
            strict=None, **kwargs):
 
5173
        from bzrlib.send import send
 
5174
        return send(submit_branch, revision, public_branch, remember,
 
5175
                    format, no_bundle, no_patch, output,
 
5176
                    kwargs.get('from', '.'), mail_to, message, body,
 
5177
                    self.outf,
 
5178
                    strict=strict)
4946
5179
 
4947
5180
 
4948
5181
class cmd_bundle_revisions(cmd_send):
4949
 
 
4950
 
    """Create a merge-directive for submitting changes.
 
5182
    __doc__ = """Create a merge-directive for submitting changes.
4951
5183
 
4952
5184
    A merge directive provides many things needed for requesting merges:
4953
5185
 
4993
5225
               type=unicode),
4994
5226
        Option('output', short_name='o', help='Write directive to this file.',
4995
5227
               type=unicode),
 
5228
        Option('strict',
 
5229
               help='Refuse to bundle revisions if there are uncommitted'
 
5230
               ' changes in the working tree, --no-strict disables the check.'),
4996
5231
        'revision',
4997
 
        RegistryOption.from_kwargs('format',
4998
 
        'Use the specified output format.',
4999
 
        **{'4': 'Bundle format 4, Merge Directive 2 (default)',
5000
 
           '0.9': 'Bundle format 0.9, Merge Directive 1',})
 
5232
        RegistryOption('format',
 
5233
                       help='Use the specified output format.',
 
5234
                       lazy_registry=('bzrlib.send', 'format_registry')),
5001
5235
        ]
5002
5236
    aliases = ['bundle']
5003
5237
 
5007
5241
 
5008
5242
    def run(self, submit_branch=None, public_branch=None, no_bundle=False,
5009
5243
            no_patch=False, revision=None, remember=False, output=None,
5010
 
            format='4', **kwargs):
 
5244
            format=None, strict=None, **kwargs):
5011
5245
        if output is None:
5012
5246
            output = '-'
5013
 
        return self._run(submit_branch, revision, public_branch, remember,
 
5247
        from bzrlib.send import send
 
5248
        return send(submit_branch, revision, public_branch, remember,
5014
5249
                         format, no_bundle, no_patch, output,
5015
 
                         kwargs.get('from', '.'), None, None, None)
 
5250
                         kwargs.get('from', '.'), None, None, None,
 
5251
                         self.outf, strict=strict)
5016
5252
 
5017
5253
 
5018
5254
class cmd_tag(Command):
5019
 
    """Create, remove or modify a tag naming a revision.
 
5255
    __doc__ = """Create, remove or modify a tag naming a revision.
5020
5256
 
5021
5257
    Tags give human-meaningful names to revisions.  Commands that take a -r
5022
5258
    (--revision) option can be given -rtag:X, where X is any previously
5030
5266
 
5031
5267
    To rename a tag (change the name but keep it on the same revsion), run ``bzr
5032
5268
    tag new-name -r tag:old-name`` and then ``bzr tag --delete oldname``.
 
5269
 
 
5270
    If no tag name is specified it will be determined through the 
 
5271
    'automatic_tag_name' hook. This can e.g. be used to automatically tag
 
5272
    upstream releases by reading configure.ac. See ``bzr help hooks`` for
 
5273
    details.
5033
5274
    """
5034
5275
 
5035
5276
    _see_also = ['commit', 'tags']
5036
 
    takes_args = ['tag_name']
 
5277
    takes_args = ['tag_name?']
5037
5278
    takes_options = [
5038
5279
        Option('delete',
5039
5280
            help='Delete this tag rather than placing it.',
5040
5281
            ),
5041
 
        Option('directory',
5042
 
            help='Branch in which to place the tag.',
5043
 
            short_name='d',
5044
 
            type=unicode,
5045
 
            ),
 
5282
        custom_help('directory',
 
5283
            help='Branch in which to place the tag.'),
5046
5284
        Option('force',
5047
5285
            help='Replace existing tags.',
5048
5286
            ),
5049
5287
        'revision',
5050
5288
        ]
5051
5289
 
5052
 
    def run(self, tag_name,
 
5290
    def run(self, tag_name=None,
5053
5291
            delete=None,
5054
5292
            directory='.',
5055
5293
            force=None,
5056
5294
            revision=None,
5057
5295
            ):
5058
5296
        branch, relpath = Branch.open_containing(directory)
5059
 
        branch.lock_write()
5060
 
        try:
5061
 
            if delete:
5062
 
                branch.tags.delete_tag(tag_name)
5063
 
                self.outf.write('Deleted tag %s.\n' % tag_name)
 
5297
        self.add_cleanup(branch.lock_write().unlock)
 
5298
        if delete:
 
5299
            if tag_name is None:
 
5300
                raise errors.BzrCommandError("No tag specified to delete.")
 
5301
            branch.tags.delete_tag(tag_name)
 
5302
            self.outf.write('Deleted tag %s.\n' % tag_name)
 
5303
        else:
 
5304
            if revision:
 
5305
                if len(revision) != 1:
 
5306
                    raise errors.BzrCommandError(
 
5307
                        "Tags can only be placed on a single revision, "
 
5308
                        "not on a range")
 
5309
                revision_id = revision[0].as_revision_id(branch)
5064
5310
            else:
5065
 
                if revision:
5066
 
                    if len(revision) != 1:
5067
 
                        raise errors.BzrCommandError(
5068
 
                            "Tags can only be placed on a single revision, "
5069
 
                            "not on a range")
5070
 
                    revision_id = revision[0].as_revision_id(branch)
5071
 
                else:
5072
 
                    revision_id = branch.last_revision()
5073
 
                if (not force) and branch.tags.has_tag(tag_name):
5074
 
                    raise errors.TagAlreadyExists(tag_name)
5075
 
                branch.tags.set_tag(tag_name, revision_id)
5076
 
                self.outf.write('Created tag %s.\n' % tag_name)
5077
 
        finally:
5078
 
            branch.unlock()
 
5311
                revision_id = branch.last_revision()
 
5312
            if tag_name is None:
 
5313
                tag_name = branch.automatic_tag_name(revision_id)
 
5314
                if tag_name is None:
 
5315
                    raise errors.BzrCommandError(
 
5316
                        "Please specify a tag name.")
 
5317
            if (not force) and branch.tags.has_tag(tag_name):
 
5318
                raise errors.TagAlreadyExists(tag_name)
 
5319
            branch.tags.set_tag(tag_name, revision_id)
 
5320
            self.outf.write('Created tag %s.\n' % tag_name)
5079
5321
 
5080
5322
 
5081
5323
class cmd_tags(Command):
5082
 
    """List tags.
 
5324
    __doc__ = """List tags.
5083
5325
 
5084
5326
    This command shows a table of tag names and the revisions they reference.
5085
5327
    """
5086
5328
 
5087
5329
    _see_also = ['tag']
5088
5330
    takes_options = [
5089
 
        Option('directory',
5090
 
            help='Branch whose tags should be displayed.',
5091
 
            short_name='d',
5092
 
            type=unicode,
5093
 
            ),
 
5331
        custom_help('directory',
 
5332
            help='Branch whose tags should be displayed.'),
5094
5333
        RegistryOption.from_kwargs('sort',
5095
5334
            'Sort tags by different criteria.', title='Sorting',
5096
5335
            alpha='Sort tags lexicographically (default).',
5113
5352
        if not tags:
5114
5353
            return
5115
5354
 
 
5355
        self.add_cleanup(branch.lock_read().unlock)
5116
5356
        if revision:
5117
 
            branch.lock_read()
5118
 
            try:
5119
 
                graph = branch.repository.get_graph()
5120
 
                rev1, rev2 = _get_revision_range(revision, branch, self.name())
5121
 
                revid1, revid2 = rev1.rev_id, rev2.rev_id
5122
 
                # only show revisions between revid1 and revid2 (inclusive)
5123
 
                tags = [(tag, revid) for tag, revid in tags if
5124
 
                    graph.is_between(revid, revid1, revid2)]
5125
 
            finally:
5126
 
                branch.unlock()
 
5357
            graph = branch.repository.get_graph()
 
5358
            rev1, rev2 = _get_revision_range(revision, branch, self.name())
 
5359
            revid1, revid2 = rev1.rev_id, rev2.rev_id
 
5360
            # only show revisions between revid1 and revid2 (inclusive)
 
5361
            tags = [(tag, revid) for tag, revid in tags if
 
5362
                graph.is_between(revid, revid1, revid2)]
5127
5363
        if sort == 'alpha':
5128
5364
            tags.sort()
5129
5365
        elif sort == 'time':
5139
5375
            tags.sort(key=lambda x: timestamps[x[1]])
5140
5376
        if not show_ids:
5141
5377
            # [ (tag, revid), ... ] -> [ (tag, dotted_revno), ... ]
5142
 
            revno_map = branch.get_revision_id_to_revno_map()
5143
 
            tags = [ (tag, '.'.join(map(str, revno_map.get(revid, ('?',)))))
5144
 
                        for tag, revid in tags ]
 
5378
            for index, (tag, revid) in enumerate(tags):
 
5379
                try:
 
5380
                    revno = branch.revision_id_to_dotted_revno(revid)
 
5381
                    if isinstance(revno, tuple):
 
5382
                        revno = '.'.join(map(str, revno))
 
5383
                except errors.NoSuchRevision:
 
5384
                    # Bad tag data/merges can lead to tagged revisions
 
5385
                    # which are not in this branch. Fail gracefully ...
 
5386
                    revno = '?'
 
5387
                tags[index] = (tag, revno)
 
5388
        self.cleanup_now()
5145
5389
        for tag, revspec in tags:
5146
5390
            self.outf.write('%-20s %s\n' % (tag, revspec))
5147
5391
 
5148
5392
 
5149
5393
class cmd_reconfigure(Command):
5150
 
    """Reconfigure the type of a bzr directory.
 
5394
    __doc__ = """Reconfigure the type of a bzr directory.
5151
5395
 
5152
5396
    A target configuration must be specified.
5153
5397
 
5183
5427
            ),
5184
5428
        Option('bind-to', help='Branch to bind checkout to.', type=str),
5185
5429
        Option('force',
5186
 
               help='Perform reconfiguration even if local changes'
5187
 
               ' will be lost.')
 
5430
            help='Perform reconfiguration even if local changes'
 
5431
            ' will be lost.'),
 
5432
        Option('stacked-on',
 
5433
            help='Reconfigure a branch to be stacked on another branch.',
 
5434
            type=unicode,
 
5435
            ),
 
5436
        Option('unstacked',
 
5437
            help='Reconfigure a branch to be unstacked.  This '
 
5438
                'may require copying substantial data into it.',
 
5439
            ),
5188
5440
        ]
5189
5441
 
5190
 
    def run(self, location=None, target_type=None, bind_to=None, force=False):
 
5442
    def run(self, location=None, target_type=None, bind_to=None, force=False,
 
5443
            stacked_on=None,
 
5444
            unstacked=None):
5191
5445
        directory = bzrdir.BzrDir.open(location)
 
5446
        if stacked_on and unstacked:
 
5447
            raise BzrCommandError("Can't use both --stacked-on and --unstacked")
 
5448
        elif stacked_on is not None:
 
5449
            reconfigure.ReconfigureStackedOn().apply(directory, stacked_on)
 
5450
        elif unstacked:
 
5451
            reconfigure.ReconfigureUnstacked().apply(directory)
 
5452
        # At the moment you can use --stacked-on and a different
 
5453
        # reconfiguration shape at the same time; there seems no good reason
 
5454
        # to ban it.
5192
5455
        if target_type is None:
5193
 
            raise errors.BzrCommandError('No target configuration specified')
 
5456
            if stacked_on or unstacked:
 
5457
                return
 
5458
            else:
 
5459
                raise errors.BzrCommandError('No target configuration '
 
5460
                    'specified')
5194
5461
        elif target_type == 'branch':
5195
5462
            reconfiguration = reconfigure.Reconfigure.to_branch(directory)
5196
5463
        elif target_type == 'tree':
5215
5482
 
5216
5483
 
5217
5484
class cmd_switch(Command):
5218
 
    """Set the branch of a checkout and update.
 
5485
    __doc__ = """Set the branch of a checkout and update.
5219
5486
 
5220
5487
    For lightweight checkouts, this changes the branch being referenced.
5221
5488
    For heavyweight checkouts, this checks that there are no local commits
5233
5500
    /path/to/newbranch.
5234
5501
 
5235
5502
    Bound branches use the nickname of its master branch unless it is set
5236
 
    locally, in which case switching will update the the local nickname to be
 
5503
    locally, in which case switching will update the local nickname to be
5237
5504
    that of the master.
5238
5505
    """
5239
5506
 
5240
 
    takes_args = ['to_location']
5241
 
    takes_options = [Option('force',
5242
 
                        help='Switch even if local commits will be lost.')
5243
 
                     ]
 
5507
    takes_args = ['to_location?']
 
5508
    takes_options = ['directory',
 
5509
                     Option('force',
 
5510
                        help='Switch even if local commits will be lost.'),
 
5511
                     'revision',
 
5512
                     Option('create-branch', short_name='b',
 
5513
                        help='Create the target branch from this one before'
 
5514
                             ' switching to it.'),
 
5515
                    ]
5244
5516
 
5245
 
    def run(self, to_location, force=False):
 
5517
    def run(self, to_location=None, force=False, create_branch=False,
 
5518
            revision=None, directory=u'.'):
5246
5519
        from bzrlib import switch
5247
 
        tree_location = '.'
 
5520
        tree_location = directory
 
5521
        revision = _get_one_revision('switch', revision)
5248
5522
        control_dir = bzrdir.BzrDir.open_containing(tree_location)[0]
5249
 
        branch = control_dir.open_branch()
 
5523
        if to_location is None:
 
5524
            if revision is None:
 
5525
                raise errors.BzrCommandError('You must supply either a'
 
5526
                                             ' revision or a location')
 
5527
            to_location = tree_location
5250
5528
        try:
5251
 
            to_branch = Branch.open(to_location)
 
5529
            branch = control_dir.open_branch()
 
5530
            had_explicit_nick = branch.get_config().has_explicit_nickname()
5252
5531
        except errors.NotBranchError:
5253
 
            this_branch = control_dir.open_branch()
5254
 
            # This may be a heavy checkout, where we want the master branch
5255
 
            this_url = this_branch.get_bound_location()
5256
 
            # If not, use a local sibling
5257
 
            if this_url is None:
5258
 
                this_url = this_branch.base
5259
 
            to_branch = Branch.open(
5260
 
                urlutils.join(this_url, '..', to_location))
5261
 
        switch.switch(control_dir, to_branch, force)
5262
 
        if branch.get_config().has_explicit_nickname():
 
5532
            branch = None
 
5533
            had_explicit_nick = False
 
5534
        if create_branch:
 
5535
            if branch is None:
 
5536
                raise errors.BzrCommandError('cannot create branch without'
 
5537
                                             ' source branch')
 
5538
            to_location = directory_service.directories.dereference(
 
5539
                              to_location)
 
5540
            if '/' not in to_location and '\\' not in to_location:
 
5541
                # This path is meant to be relative to the existing branch
 
5542
                this_url = self._get_branch_location(control_dir)
 
5543
                to_location = urlutils.join(this_url, '..', to_location)
 
5544
            to_branch = branch.bzrdir.sprout(to_location,
 
5545
                                 possible_transports=[branch.bzrdir.root_transport],
 
5546
                                 source_branch=branch).open_branch()
 
5547
        else:
 
5548
            try:
 
5549
                to_branch = Branch.open(to_location)
 
5550
            except errors.NotBranchError:
 
5551
                this_url = self._get_branch_location(control_dir)
 
5552
                to_branch = Branch.open(
 
5553
                    urlutils.join(this_url, '..', to_location))
 
5554
        if revision is not None:
 
5555
            revision = revision.as_revision_id(to_branch)
 
5556
        switch.switch(control_dir, to_branch, force, revision_id=revision)
 
5557
        if had_explicit_nick:
5263
5558
            branch = control_dir.open_branch() #get the new branch!
5264
5559
            branch.nick = to_branch.nick
5265
5560
        note('Switched to branch: %s',
5266
5561
            urlutils.unescape_for_display(to_branch.base, 'utf-8'))
5267
5562
 
5268
 
 
5269
 
class cmd_guess_renames(Command):
5270
 
    """Guess which files have been have been renamed, based on their content.
5271
 
 
5272
 
    Only versioned files which have been deleted are candidates for rename
5273
 
    detection, and renames to ignored files will not be detected.
5274
 
    """
5275
 
 
5276
 
    def run(self):
5277
 
        work_tree, file_list = tree_files(None, default_branch='.')
5278
 
        work_tree.lock_write()
 
5563
    def _get_branch_location(self, control_dir):
 
5564
        """Return location of branch for this control dir."""
5279
5565
        try:
5280
 
            rename_map.RenameMap.guess_renames(work_tree)
5281
 
        finally:
5282
 
            work_tree.unlock()
 
5566
            this_branch = control_dir.open_branch()
 
5567
            # This may be a heavy checkout, where we want the master branch
 
5568
            master_location = this_branch.get_bound_location()
 
5569
            if master_location is not None:
 
5570
                return master_location
 
5571
            # If not, use a local sibling
 
5572
            return this_branch.base
 
5573
        except errors.NotBranchError:
 
5574
            format = control_dir.find_branch_format()
 
5575
            if getattr(format, 'get_reference', None) is not None:
 
5576
                return format.get_reference(control_dir)
 
5577
            else:
 
5578
                return control_dir.root_transport.base
5283
5579
 
5284
5580
 
5285
5581
class cmd_view(Command):
5286
 
    """Manage filtered views.
 
5582
    __doc__ = """Manage filtered views.
5287
5583
 
5288
5584
    Views provide a mask over the tree so that users can focus on
5289
5585
    a subset of a tree when doing their work. After creating a view,
5437
5733
 
5438
5734
 
5439
5735
class cmd_hooks(Command):
5440
 
    """Show hooks."""
 
5736
    __doc__ = """Show hooks."""
5441
5737
 
5442
5738
    hidden = True
5443
5739
 
5456
5752
                    self.outf.write("    <no hooks installed>\n")
5457
5753
 
5458
5754
 
 
5755
class cmd_remove_branch(Command):
 
5756
    __doc__ = """Remove a branch.
 
5757
 
 
5758
    This will remove the branch from the specified location but 
 
5759
    will keep any working tree or repository in place.
 
5760
 
 
5761
    :Examples:
 
5762
 
 
5763
      Remove the branch at repo/trunk::
 
5764
 
 
5765
        bzr remove-branch repo/trunk
 
5766
 
 
5767
    """
 
5768
 
 
5769
    takes_args = ["location?"]
 
5770
 
 
5771
    aliases = ["rmbranch"]
 
5772
 
 
5773
    def run(self, location=None):
 
5774
        if location is None:
 
5775
            location = "."
 
5776
        branch = Branch.open_containing(location)[0]
 
5777
        branch.bzrdir.destroy_branch()
 
5778
        
 
5779
 
5459
5780
class cmd_shelve(Command):
5460
 
    """Temporarily set aside some changes from the current tree.
 
5781
    __doc__ = """Temporarily set aside some changes from the current tree.
5461
5782
 
5462
5783
    Shelve allows you to temporarily put changes you've made "on the shelf",
5463
5784
    ie. out of the way, until a later time when you can bring them back from
5484
5805
    takes_args = ['file*']
5485
5806
 
5486
5807
    takes_options = [
 
5808
        'directory',
5487
5809
        'revision',
5488
5810
        Option('all', help='Shelve all changes.'),
5489
5811
        'message',
5498
5820
    _see_also = ['unshelve']
5499
5821
 
5500
5822
    def run(self, revision=None, all=False, file_list=None, message=None,
5501
 
            writer=None, list=False, destroy=False):
 
5823
            writer=None, list=False, destroy=False, directory=u'.'):
5502
5824
        if list:
5503
5825
            return self.run_for_list()
5504
5826
        from bzrlib.shelf_ui import Shelver
5505
5827
        if writer is None:
5506
5828
            writer = bzrlib.option.diff_writer_registry.get()
5507
5829
        try:
5508
 
            Shelver.from_args(writer(sys.stdout), revision, all, file_list,
5509
 
                              message, destroy=destroy).run()
 
5830
            shelver = Shelver.from_args(writer(sys.stdout), revision, all,
 
5831
                file_list, message, destroy=destroy, directory=directory)
 
5832
            try:
 
5833
                shelver.run()
 
5834
            finally:
 
5835
                shelver.finalize()
5510
5836
        except errors.UserAbort:
5511
5837
            return 0
5512
5838
 
5513
5839
    def run_for_list(self):
5514
5840
        tree = WorkingTree.open_containing('.')[0]
5515
 
        tree.lock_read()
5516
 
        try:
5517
 
            manager = tree.get_shelf_manager()
5518
 
            shelves = manager.active_shelves()
5519
 
            if len(shelves) == 0:
5520
 
                note('No shelved changes.')
5521
 
                return 0
5522
 
            for shelf_id in reversed(shelves):
5523
 
                message = manager.get_metadata(shelf_id).get('message')
5524
 
                if message is None:
5525
 
                    message = '<no message>'
5526
 
                self.outf.write('%3d: %s\n' % (shelf_id, message))
5527
 
            return 1
5528
 
        finally:
5529
 
            tree.unlock()
 
5841
        self.add_cleanup(tree.lock_read().unlock)
 
5842
        manager = tree.get_shelf_manager()
 
5843
        shelves = manager.active_shelves()
 
5844
        if len(shelves) == 0:
 
5845
            note('No shelved changes.')
 
5846
            return 0
 
5847
        for shelf_id in reversed(shelves):
 
5848
            message = manager.get_metadata(shelf_id).get('message')
 
5849
            if message is None:
 
5850
                message = '<no message>'
 
5851
            self.outf.write('%3d: %s\n' % (shelf_id, message))
 
5852
        return 1
5530
5853
 
5531
5854
 
5532
5855
class cmd_unshelve(Command):
5533
 
    """Restore shelved changes.
 
5856
    __doc__ = """Restore shelved changes.
5534
5857
 
5535
5858
    By default, the most recently shelved changes are restored. However if you
5536
5859
    specify a shelf by id those changes will be restored instead.  This works
5539
5862
 
5540
5863
    takes_args = ['shelf_id?']
5541
5864
    takes_options = [
 
5865
        'directory',
5542
5866
        RegistryOption.from_kwargs(
5543
5867
            'action', help="The action to perform.",
5544
5868
            enum_switch=False, value_switches=True,
5545
5869
            apply="Apply changes and remove from the shelf.",
5546
5870
            dry_run="Show changes, but do not apply or remove them.",
5547
 
            delete_only="Delete changes without applying them."
 
5871
            preview="Instead of unshelving the changes, show the diff that "
 
5872
                    "would result from unshelving.",
 
5873
            delete_only="Delete changes without applying them.",
 
5874
            keep="Apply changes but don't delete them.",
5548
5875
        )
5549
5876
    ]
5550
5877
    _see_also = ['shelve']
5551
5878
 
5552
 
    def run(self, shelf_id=None, action='apply'):
 
5879
    def run(self, shelf_id=None, action='apply', directory=u'.'):
5553
5880
        from bzrlib.shelf_ui import Unshelver
5554
 
        Unshelver.from_args(shelf_id, action).run()
 
5881
        unshelver = Unshelver.from_args(shelf_id, action, directory=directory)
 
5882
        try:
 
5883
            unshelver.run()
 
5884
        finally:
 
5885
            unshelver.tree.unlock()
5555
5886
 
5556
5887
 
5557
5888
class cmd_clean_tree(Command):
5558
 
    """Remove unwanted files from working tree.
 
5889
    __doc__ = """Remove unwanted files from working tree.
5559
5890
 
5560
5891
    By default, only unknown files, not ignored files, are deleted.  Versioned
5561
5892
    files are never deleted.
5569
5900
 
5570
5901
    To check what clean-tree will do, use --dry-run.
5571
5902
    """
5572
 
    takes_options = [Option('ignored', help='Delete all ignored files.'),
 
5903
    takes_options = ['directory',
 
5904
                     Option('ignored', help='Delete all ignored files.'),
5573
5905
                     Option('detritus', help='Delete conflict files, merge'
5574
5906
                            ' backups, and failed selftest dirs.'),
5575
5907
                     Option('unknown',
5578
5910
                            ' deleting them.'),
5579
5911
                     Option('force', help='Do not prompt before deleting.')]
5580
5912
    def run(self, unknown=False, ignored=False, detritus=False, dry_run=False,
5581
 
            force=False):
 
5913
            force=False, directory=u'.'):
5582
5914
        from bzrlib.clean_tree import clean_tree
5583
5915
        if not (unknown or ignored or detritus):
5584
5916
            unknown = True
5585
5917
        if dry_run:
5586
5918
            force = True
5587
 
        clean_tree('.', unknown=unknown, ignored=ignored, detritus=detritus,
5588
 
                   dry_run=dry_run, no_prompt=force)
5589
 
 
5590
 
 
5591
 
def _create_prefix(cur_transport):
5592
 
    needed = [cur_transport]
5593
 
    # Recurse upwards until we can create a directory successfully
5594
 
    while True:
5595
 
        new_transport = cur_transport.clone('..')
5596
 
        if new_transport.base == cur_transport.base:
5597
 
            raise errors.BzrCommandError(
5598
 
                "Failed to create path prefix for %s."
5599
 
                % cur_transport.base)
5600
 
        try:
5601
 
            new_transport.mkdir('.')
5602
 
        except errors.NoSuchFile:
5603
 
            needed.append(new_transport)
5604
 
            cur_transport = new_transport
 
5919
        clean_tree(directory, unknown=unknown, ignored=ignored,
 
5920
                   detritus=detritus, dry_run=dry_run, no_prompt=force)
 
5921
 
 
5922
 
 
5923
class cmd_reference(Command):
 
5924
    __doc__ = """list, view and set branch locations for nested trees.
 
5925
 
 
5926
    If no arguments are provided, lists the branch locations for nested trees.
 
5927
    If one argument is provided, display the branch location for that tree.
 
5928
    If two arguments are provided, set the branch location for that tree.
 
5929
    """
 
5930
 
 
5931
    hidden = True
 
5932
 
 
5933
    takes_args = ['path?', 'location?']
 
5934
 
 
5935
    def run(self, path=None, location=None):
 
5936
        branchdir = '.'
 
5937
        if path is not None:
 
5938
            branchdir = path
 
5939
        tree, branch, relpath =(
 
5940
            bzrdir.BzrDir.open_containing_tree_or_branch(branchdir))
 
5941
        if path is not None:
 
5942
            path = relpath
 
5943
        if tree is None:
 
5944
            tree = branch.basis_tree()
 
5945
        if path is None:
 
5946
            info = branch._get_all_reference_info().iteritems()
 
5947
            self._display_reference_info(tree, branch, info)
5605
5948
        else:
5606
 
            break
5607
 
    # Now we only need to create child directories
5608
 
    while needed:
5609
 
        cur_transport = needed.pop()
5610
 
        cur_transport.ensure_base()
5611
 
 
5612
 
 
5613
 
# these get imported and then picked up by the scan for cmd_*
5614
 
# TODO: Some more consistent way to split command definitions across files;
5615
 
# we do need to load at least some information about them to know of
5616
 
# aliases.  ideally we would avoid loading the implementation until the
5617
 
# details were needed.
5618
 
from bzrlib.cmd_version_info import cmd_version_info
5619
 
from bzrlib.conflicts import cmd_resolve, cmd_conflicts, restore
5620
 
from bzrlib.bundle.commands import (
5621
 
    cmd_bundle_info,
5622
 
    )
5623
 
from bzrlib.sign_my_commits import cmd_sign_my_commits
5624
 
from bzrlib.weave_commands import cmd_versionedfile_list, \
5625
 
        cmd_weave_plan_merge, cmd_weave_merge_text
 
5949
            file_id = tree.path2id(path)
 
5950
            if file_id is None:
 
5951
                raise errors.NotVersionedError(path)
 
5952
            if location is None:
 
5953
                info = [(file_id, branch.get_reference_info(file_id))]
 
5954
                self._display_reference_info(tree, branch, info)
 
5955
            else:
 
5956
                branch.set_reference_info(file_id, path, location)
 
5957
 
 
5958
    def _display_reference_info(self, tree, branch, info):
 
5959
        ref_list = []
 
5960
        for file_id, (path, location) in info:
 
5961
            try:
 
5962
                path = tree.id2path(file_id)
 
5963
            except errors.NoSuchId:
 
5964
                pass
 
5965
            ref_list.append((path, location))
 
5966
        for path, location in sorted(ref_list):
 
5967
            self.outf.write('%s %s\n' % (path, location))
 
5968
 
 
5969
 
 
5970
def _register_lazy_builtins():
 
5971
    # register lazy builtins from other modules; called at startup and should
 
5972
    # be only called once.
 
5973
    for (name, aliases, module_name) in [
 
5974
        ('cmd_bundle_info', [], 'bzrlib.bundle.commands'),
 
5975
        ('cmd_dpush', [], 'bzrlib.foreign'),
 
5976
        ('cmd_version_info', [], 'bzrlib.cmd_version_info'),
 
5977
        ('cmd_resolve', ['resolved'], 'bzrlib.conflicts'),
 
5978
        ('cmd_conflicts', [], 'bzrlib.conflicts'),
 
5979
        ('cmd_sign_my_commits', [], 'bzrlib.sign_my_commits'),
 
5980
        ]:
 
5981
        builtin_command_registry.register_lazy(name, aliases, module_name)