← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/builtins.py

  • Committer: Andrew Bennetts
  • Date: 2010-08-03 13:31:06 UTC
  • mto: This revision was merged to the branch mainline in revision 5367.
  • Revision ID: andrew.bennetts@canonical.com-20100803133106-3djsura7rjuovvef
Reduce memory consumption of InventoryEntries by removing __slots__ entries for attributes that should never be set, e.g. symlink_target on files.

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,
68
75
from bzrlib.trace import mutter, note, warning, is_quiet, get_verbosity_level
69
76
 
70
77
 
 
78
@symbol_versioning.deprecated_function(symbol_versioning.deprecated_in((2, 3, 0)))
71
79
def tree_files(file_list, default_branch=u'.', canonicalize=True,
72
80
    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]))
 
81
    return internal_tree_files(file_list, default_branch, canonicalize,
 
82
        apply_view)
79
83
 
80
84
 
81
85
def tree_files_for_add(file_list):
82
 
    """Add handles files a bit differently so it a custom implementation."""
 
86
    """
 
87
    Return a tree and list of absolute paths from a file list.
 
88
 
 
89
    Similar to tree_files, but add handles files a bit differently, so it a
 
90
    custom implementation.  In particular, MutableTreeTree.smart_add expects
 
91
    absolute paths, which it immediately converts to relative paths.
 
92
    """
 
93
    # FIXME Would be nice to just return the relative paths like
 
94
    # internal_tree_files does, but there are a large number of unit tests
 
95
    # that assume the current interface to mutabletree.smart_add
83
96
    if file_list:
84
 
        tree = WorkingTree.open_containing(file_list[0])[0]
 
97
        tree, relpath = WorkingTree.open_containing(file_list[0])
85
98
        if tree.supports_views():
86
99
            view_files = tree.views.lookup_view()
87
100
            if view_files:
88
101
                for filename in file_list:
89
102
                    if not osutils.is_inside_any(view_files, filename):
90
103
                        raise errors.FileOutsideView(filename, view_files)
 
104
        file_list = file_list[:]
 
105
        file_list[0] = tree.abspath(relpath)
91
106
    else:
92
107
        tree = WorkingTree.open_containing(u'.')[0]
93
108
        if tree.supports_views():
95
110
            if view_files:
96
111
                file_list = view_files
97
112
                view_str = views.view_display_str(view_files)
98
 
                note("ignoring files outside view: %s" % view_str)
 
113
                note("Ignoring files outside view. View is %s" % view_str)
99
114
    return tree, file_list
100
115
 
101
116
 
110
125
 
111
126
 
112
127
def _get_one_revision_tree(command_name, revisions, branch=None, tree=None):
 
128
    """Get a revision tree. Not suitable for commands that change the tree.
 
129
    
 
130
    Specifically, the basis tree in dirstate trees is coupled to the dirstate
 
131
    and doing a commit/uncommit/pull will at best fail due to changing the
 
132
    basis revision data.
 
133
 
 
134
    If tree is passed in, it should be already locked, for lifetime management
 
135
    of the trees internal cached state.
 
136
    """
113
137
    if branch is None:
114
138
        branch = tree.branch
115
139
    if revisions is None:
125
149
 
126
150
# XXX: Bad function name; should possibly also be a class method of
127
151
# WorkingTree rather than a function.
 
152
@symbol_versioning.deprecated_function(symbol_versioning.deprecated_in((2, 3, 0)))
128
153
def internal_tree_files(file_list, default_branch=u'.', canonicalize=True,
129
154
    apply_view=True):
130
155
    """Convert command-line paths to a WorkingTree and relative paths.
131
156
 
 
157
    Deprecated: use WorkingTree.open_containing_paths instead.
 
158
 
132
159
    This is typically used for command-line processors that take one or
133
160
    more filenames, and infer the workingtree that contains them.
134
161
 
144
171
 
145
172
    :return: workingtree, [relative_paths]
146
173
    """
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
 
174
    return WorkingTree.open_containing_paths(
 
175
        file_list, default_directory='.',
 
176
        canonicalize=True,
 
177
        apply_view=True)
194
178
 
195
179
 
196
180
def _get_view_info_for_change_reporter(tree):
205
189
    return view_info
206
190
 
207
191
 
 
192
def _open_directory_or_containing_tree_or_branch(filename, directory):
 
193
    """Open the tree or branch containing the specified file, unless
 
194
    the --directory option is used to specify a different branch."""
 
195
    if directory is not None:
 
196
        return (None, Branch.open(directory), filename)
 
197
    return bzrdir.BzrDir.open_containing_tree_or_branch(filename)
 
198
 
 
199
 
208
200
# TODO: Make sure no commands unconditionally use the working directory as a
209
201
# branch.  If a filename argument is used, the first of them should be used to
210
202
# specify the branch.  (Perhaps this can be factored out into some kind of
212
204
# opens the branch?)
213
205
 
214
206
class cmd_status(Command):
215
 
    """Display status summary.
 
207
    __doc__ = """Display status summary.
216
208
 
217
209
    This reports on versioned and unknown files, reporting them
218
210
    grouped by state.  Possible states are:
238
230
    unknown
239
231
        Not versioned and not matching an ignore pattern.
240
232
 
 
233
    Additionally for directories, symlinks and files with an executable
 
234
    bit, Bazaar indicates their type using a trailing character: '/', '@'
 
235
    or '*' respectively.
 
236
 
241
237
    To see ignored files use 'bzr ignored'.  For details on the
242
238
    changes to file texts, use 'bzr diff'.
243
239
 
284
280
            raise errors.BzrCommandError('bzr status --revision takes exactly'
285
281
                                         ' one or two revision specifiers')
286
282
 
287
 
        tree, relfile_list = tree_files(file_list)
 
283
        tree, relfile_list = WorkingTree.open_containing_paths(file_list)
288
284
        # Avoid asking for specific files when that is not needed.
289
285
        if relfile_list == ['']:
290
286
            relfile_list = None
301
297
 
302
298
 
303
299
class cmd_cat_revision(Command):
304
 
    """Write out metadata for a revision.
 
300
    __doc__ = """Write out metadata for a revision.
305
301
 
306
302
    The revision to print can either be specified by a specific
307
303
    revision identifier, or you can use --revision.
309
305
 
310
306
    hidden = True
311
307
    takes_args = ['revision_id?']
312
 
    takes_options = ['revision']
 
308
    takes_options = ['directory', 'revision']
313
309
    # cat-revision is more for frontends so should be exact
314
310
    encoding = 'strict'
315
311
 
 
312
    def print_revision(self, revisions, revid):
 
313
        stream = revisions.get_record_stream([(revid,)], 'unordered', True)
 
314
        record = stream.next()
 
315
        if record.storage_kind == 'absent':
 
316
            raise errors.NoSuchRevision(revisions, revid)
 
317
        revtext = record.get_bytes_as('fulltext')
 
318
        self.outf.write(revtext.decode('utf-8'))
 
319
 
316
320
    @display_command
317
 
    def run(self, revision_id=None, revision=None):
 
321
    def run(self, revision_id=None, revision=None, directory=u'.'):
318
322
        if revision_id is not None and revision is not None:
319
323
            raise errors.BzrCommandError('You can only supply one of'
320
324
                                         ' revision_id or --revision')
321
325
        if revision_id is None and revision is None:
322
326
            raise errors.BzrCommandError('You must supply either'
323
327
                                         ' --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
 
 
 
328
        b = WorkingTree.open_containing(directory)[0].branch
 
329
 
 
330
        revisions = b.repository.revisions
 
331
        if revisions is None:
 
332
            raise errors.BzrCommandError('Repository %r does not support '
 
333
                'access to raw revision texts')
 
334
 
 
335
        b.repository.lock_read()
 
336
        try:
 
337
            # TODO: jam 20060112 should cat-revision always output utf-8?
 
338
            if revision_id is not None:
 
339
                revision_id = osutils.safe_revision_id(revision_id, warn=False)
 
340
                try:
 
341
                    self.print_revision(revisions, revision_id)
 
342
                except errors.NoSuchRevision:
 
343
                    msg = "The repository %s contains no revision %s." % (
 
344
                        b.repository.base, revision_id)
 
345
                    raise errors.BzrCommandError(msg)
 
346
            elif revision is not None:
 
347
                for rev in revision:
 
348
                    if rev is None:
 
349
                        raise errors.BzrCommandError(
 
350
                            'You cannot specify a NULL revision.')
 
351
                    rev_id = rev.as_revision_id(b)
 
352
                    self.print_revision(revisions, rev_id)
 
353
        finally:
 
354
            b.repository.unlock()
 
355
        
343
356
 
344
357
class cmd_dump_btree(Command):
345
 
    """Dump the contents of a btree index file to stdout.
 
358
    __doc__ = """Dump the contents of a btree index file to stdout.
346
359
 
347
360
    PATH is a btree index file, it can be any URL. This includes things like
348
361
    .bzr/repository/pack-names, or .bzr/repository/indices/a34b3a...ca4a4.iix
412
425
        for node in bt.iter_all_entries():
413
426
            # Node is made up of:
414
427
            # (index, key, value, [references])
415
 
            self.outf.write('%s\n' % (node[1:],))
 
428
            try:
 
429
                refs = node[3]
 
430
            except IndexError:
 
431
                refs_as_tuples = None
 
432
            else:
 
433
                refs_as_tuples = static_tuple.as_tuples(refs)
 
434
            as_tuple = (tuple(node[1]), node[2], refs_as_tuples)
 
435
            self.outf.write('%s\n' % (as_tuple,))
416
436
 
417
437
 
418
438
class cmd_remove_tree(Command):
419
 
    """Remove the working tree from a given branch/checkout.
 
439
    __doc__ = """Remove the working tree from a given branch/checkout.
420
440
 
421
441
    Since a lightweight checkout is little more than a working tree
422
442
    this will refuse to run against one.
424
444
    To re-create the working tree, use "bzr checkout".
425
445
    """
426
446
    _see_also = ['checkout', 'working-trees']
427
 
    takes_args = ['location?']
 
447
    takes_args = ['location*']
428
448
    takes_options = [
429
449
        Option('force',
430
450
               help='Remove the working tree even if it has '
431
 
                    'uncommitted changes.'),
 
451
                    'uncommitted or shelved changes.'),
432
452
        ]
433
453
 
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()
 
454
    def run(self, location_list, force=False):
 
455
        if not location_list:
 
456
            location_list=['.']
 
457
 
 
458
        for location in location_list:
 
459
            d = bzrdir.BzrDir.open(location)
 
460
            
 
461
            try:
 
462
                working = d.open_workingtree()
 
463
            except errors.NoWorkingTree:
 
464
                raise errors.BzrCommandError("No working tree to remove")
 
465
            except errors.NotLocalUrl:
 
466
                raise errors.BzrCommandError("You cannot remove the working tree"
 
467
                                             " of a remote path")
 
468
            if not force:
 
469
                if (working.has_changes()):
 
470
                    raise errors.UncommittedChanges(working)
 
471
                if working.get_shelf_manager().last_shelf() is not None:
 
472
                    raise errors.ShelvedChanges(working)
 
473
 
 
474
            if working.user_url != working.branch.user_url:
 
475
                raise errors.BzrCommandError("You cannot remove the working tree"
 
476
                                             " from a lightweight checkout")
 
477
 
 
478
            d.destroy_workingtree()
456
479
 
457
480
 
458
481
class cmd_revno(Command):
459
 
    """Show current revision number.
 
482
    __doc__ = """Show current revision number.
460
483
 
461
484
    This is equal to the number of revisions on this branch.
462
485
    """
463
486
 
464
487
    _see_also = ['info']
465
488
    takes_args = ['location?']
 
489
    takes_options = [
 
490
        Option('tree', help='Show revno of working tree'),
 
491
        ]
466
492
 
467
493
    @display_command
468
 
    def run(self, location=u'.'):
469
 
        self.outf.write(str(Branch.open_containing(location)[0].revno()))
470
 
        self.outf.write('\n')
 
494
    def run(self, tree=False, location=u'.'):
 
495
        if tree:
 
496
            try:
 
497
                wt = WorkingTree.open_containing(location)[0]
 
498
                self.add_cleanup(wt.lock_read().unlock)
 
499
            except (errors.NoWorkingTree, errors.NotLocalUrl):
 
500
                raise errors.NoWorkingTree(location)
 
501
            revid = wt.last_revision()
 
502
            try:
 
503
                revno_t = wt.branch.revision_id_to_dotted_revno(revid)
 
504
            except errors.NoSuchRevision:
 
505
                revno_t = ('???',)
 
506
            revno = ".".join(str(n) for n in revno_t)
 
507
        else:
 
508
            b = Branch.open_containing(location)[0]
 
509
            self.add_cleanup(b.lock_read().unlock)
 
510
            revno = b.revno()
 
511
        self.cleanup_now()
 
512
        self.outf.write(str(revno) + '\n')
471
513
 
472
514
 
473
515
class cmd_revision_info(Command):
474
 
    """Show revision number and revision id for a given revision identifier.
 
516
    __doc__ = """Show revision number and revision id for a given revision identifier.
475
517
    """
476
518
    hidden = True
477
519
    takes_args = ['revision_info*']
478
520
    takes_options = [
479
521
        'revision',
480
 
        Option('directory',
 
522
        custom_help('directory',
481
523
            help='Branch to examine, '
482
 
                 'rather than the one containing the working directory.',
483
 
            short_name='d',
484
 
            type=unicode,
485
 
            ),
 
524
                 'rather than the one containing the working directory.'),
 
525
        Option('tree', help='Show revno of working tree'),
486
526
        ]
487
527
 
488
528
    @display_command
489
 
    def run(self, revision=None, directory=u'.', revision_info_list=[]):
 
529
    def run(self, revision=None, directory=u'.', tree=False,
 
530
            revision_info_list=[]):
490
531
 
491
 
        revs = []
 
532
        try:
 
533
            wt = WorkingTree.open_containing(directory)[0]
 
534
            b = wt.branch
 
535
            self.add_cleanup(wt.lock_read().unlock)
 
536
        except (errors.NoWorkingTree, errors.NotLocalUrl):
 
537
            wt = None
 
538
            b = Branch.open_containing(directory)[0]
 
539
            self.add_cleanup(b.lock_read().unlock)
 
540
        revision_ids = []
492
541
        if revision is not None:
493
 
            revs.extend(revision)
 
542
            revision_ids.extend(rev.as_revision_id(b) for rev in revision)
494
543
        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)
 
544
            for rev_str in revision_info_list:
 
545
                rev_spec = RevisionSpec.from_string(rev_str)
 
546
                revision_ids.append(rev_spec.as_revision_id(b))
 
547
        # No arguments supplied, default to the last revision
 
548
        if len(revision_ids) == 0:
 
549
            if tree:
 
550
                if wt is None:
 
551
                    raise errors.NoWorkingTree(directory)
 
552
                revision_ids.append(wt.last_revision())
 
553
            else:
 
554
                revision_ids.append(b.last_revision())
 
555
 
 
556
        revinfos = []
 
557
        maxlen = 0
 
558
        for revision_id in revision_ids:
505
559
            try:
506
 
                revno = '%4d' % (b.revision_id_to_revno(revision_id))
 
560
                dotted_revno = b.revision_id_to_dotted_revno(revision_id)
 
561
                revno = '.'.join(str(i) for i in dotted_revno)
507
562
            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)
 
563
                revno = '???'
 
564
            maxlen = max(maxlen, len(revno))
 
565
            revinfos.append([revno, revision_id])
 
566
 
 
567
        self.cleanup_now()
 
568
        for ri in revinfos:
 
569
            self.outf.write('%*s %s\n' % (maxlen, ri[0], ri[1]))
511
570
 
512
571
 
513
572
class cmd_add(Command):
514
 
    """Add specified files or directories.
 
573
    __doc__ = """Add specified files or directories.
515
574
 
516
575
    In non-recursive mode, all the named items are added, regardless
517
576
    of whether they were previously ignored.  A warning is given if
543
602
    branches that will be merged later (without showing the two different
544
603
    adds as a conflict). It is also useful when merging another project
545
604
    into a subdirectory of this one.
 
605
    
 
606
    Any files matching patterns in the ignore list will not be added
 
607
    unless they are explicitly mentioned.
546
608
    """
547
609
    takes_args = ['file*']
548
610
    takes_options = [
556
618
               help='Lookup file ids from this tree.'),
557
619
        ]
558
620
    encoding_type = 'replace'
559
 
    _see_also = ['remove']
 
621
    _see_also = ['remove', 'ignore']
560
622
 
561
623
    def run(self, file_list, no_recurse=False, dry_run=False, verbose=False,
562
624
            file_ids_from=None):
579
641
                should_print=(not is_quiet()))
580
642
 
581
643
        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()
 
644
            self.add_cleanup(base_tree.lock_read().unlock)
 
645
        tree, file_list = tree_files_for_add(file_list)
 
646
        added, ignored = tree.smart_add(file_list, not
 
647
            no_recurse, action=action, save=not dry_run)
 
648
        self.cleanup_now()
591
649
        if len(ignored) > 0:
592
650
            if verbose:
593
651
                for glob in sorted(ignored.keys()):
594
652
                    for path in ignored[glob]:
595
653
                        self.outf.write("ignored %s matching \"%s\"\n"
596
654
                                        % (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
655
 
605
656
 
606
657
class cmd_mkdir(Command):
607
 
    """Create a new versioned directory.
 
658
    __doc__ = """Create a new versioned directory.
608
659
 
609
660
    This is equivalent to creating the directory and then adding it.
610
661
    """
614
665
 
615
666
    def run(self, dir_list):
616
667
        for d in dir_list:
617
 
            os.mkdir(d)
618
668
            wt, dd = WorkingTree.open_containing(d)
619
 
            wt.add([dd])
620
 
            self.outf.write('added %s\n' % d)
 
669
            base = os.path.dirname(dd)
 
670
            id = wt.path2id(base)
 
671
            if id != None:
 
672
                os.mkdir(d)
 
673
                wt.add([dd])
 
674
                self.outf.write('added %s\n' % d)
 
675
            else:
 
676
                raise errors.NotVersionedError(path=base)
621
677
 
622
678
 
623
679
class cmd_relpath(Command):
624
 
    """Show path of a file relative to root"""
 
680
    __doc__ = """Show path of a file relative to root"""
625
681
 
626
682
    takes_args = ['filename']
627
683
    hidden = True
636
692
 
637
693
 
638
694
class cmd_inventory(Command):
639
 
    """Show inventory of the current working copy or a revision.
 
695
    __doc__ = """Show inventory of the current working copy or a revision.
640
696
 
641
697
    It is possible to limit the output to a particular entry
642
698
    type using the --kind option.  For example: --kind file.
662
718
            raise errors.BzrCommandError('invalid kind %r specified' % (kind,))
663
719
 
664
720
        revision = _get_one_revision('inventory', revision)
665
 
        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
        work_tree, file_list = WorkingTree.open_containing_paths(file_list)
 
722
        self.add_cleanup(work_tree.lock_read().unlock)
 
723
        if revision is not None:
 
724
            tree = revision.as_tree(work_tree.branch)
 
725
 
 
726
            extra_trees = [work_tree]
 
727
            self.add_cleanup(tree.lock_read().unlock)
 
728
        else:
 
729
            tree = work_tree
 
730
            extra_trees = []
 
731
 
 
732
        if file_list is not None:
 
733
            file_ids = tree.paths2ids(file_list, trees=extra_trees,
 
734
                                      require_versioned=True)
 
735
            # find_ids_across_trees may include some paths that don't
 
736
            # exist in 'tree'.
 
737
            entries = sorted((tree.id2path(file_id), tree.inventory[file_id])
 
738
                             for file_id in file_ids if file_id in tree)
 
739
        else:
 
740
            entries = tree.inventory.entries()
 
741
 
 
742
        self.cleanup_now()
691
743
        for path, entry in entries:
692
744
            if kind and kind != entry.kind:
693
745
                continue
699
751
 
700
752
 
701
753
class cmd_mv(Command):
702
 
    """Move or rename a file.
 
754
    __doc__ = """Move or rename a file.
703
755
 
704
756
    :Usage:
705
757
        bzr mv OLDNAME NEWNAME
722
774
    takes_args = ['names*']
723
775
    takes_options = [Option("after", help="Move only the bzr identifier"
724
776
        " of the file, because the file has already been moved."),
 
777
        Option('auto', help='Automatically guess renames.'),
 
778
        Option('dry-run', help='Avoid making changes when guessing renames.'),
725
779
        ]
726
780
    aliases = ['move', 'rename']
727
781
    encoding_type = 'replace'
728
782
 
729
 
    def run(self, names_list, after=False):
 
783
    def run(self, names_list, after=False, auto=False, dry_run=False):
 
784
        if auto:
 
785
            return self.run_auto(names_list, after, dry_run)
 
786
        elif dry_run:
 
787
            raise errors.BzrCommandError('--dry-run requires --auto.')
730
788
        if names_list is None:
731
789
            names_list = []
732
 
 
733
790
        if len(names_list) < 2:
734
791
            raise errors.BzrCommandError("missing file argument")
735
 
        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
        tree, rel_names = WorkingTree.open_containing_paths(names_list, canonicalize=False)
 
793
        self.add_cleanup(tree.lock_tree_write().unlock)
 
794
        self._run(tree, names_list, rel_names, after)
 
795
 
 
796
    def run_auto(self, names_list, after, dry_run):
 
797
        if names_list is not None and len(names_list) > 1:
 
798
            raise errors.BzrCommandError('Only one path may be specified to'
 
799
                                         ' --auto.')
 
800
        if after:
 
801
            raise errors.BzrCommandError('--after cannot be specified with'
 
802
                                         ' --auto.')
 
803
        work_tree, file_list = WorkingTree.open_containing_paths(
 
804
            names_list, default_directory='.')
 
805
        self.add_cleanup(work_tree.lock_tree_write().unlock)
 
806
        rename_map.RenameMap.guess_renames(work_tree, dry_run)
741
807
 
742
808
    def _run(self, tree, names_list, rel_names, after):
743
809
        into_existing = osutils.isdir(names_list[-1])
764
830
            # All entries reference existing inventory items, so fix them up
765
831
            # for cicp file-systems.
766
832
            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)
 
833
            for src, dest in tree.move(rel_names[:-1], rel_names[-1], after=after):
 
834
                if not is_quiet():
 
835
                    self.outf.write("%s => %s\n" % (src, dest))
769
836
        else:
770
837
            if len(names_list) != 2:
771
838
                raise errors.BzrCommandError('to mv multiple files the'
815
882
            dest = osutils.pathjoin(dest_parent, dest_tail)
816
883
            mutter("attempting to move %s => %s", src, dest)
817
884
            tree.rename_one(src, dest, after=after)
818
 
            self.outf.write("%s => %s\n" % (src, dest))
 
885
            if not is_quiet():
 
886
                self.outf.write("%s => %s\n" % (src, dest))
819
887
 
820
888
 
821
889
class cmd_pull(Command):
822
 
    """Turn this branch into a mirror of another branch.
 
890
    __doc__ = """Turn this branch into a mirror of another branch.
823
891
 
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.
 
892
    By default, this command only works on branches that have not diverged.
 
893
    Branches are considered diverged if the destination branch's most recent 
 
894
    commit is one that has not been merged (directly or indirectly) into the 
 
895
    parent.
827
896
 
828
897
    If branches have diverged, you can use 'bzr merge' to integrate the changes
829
898
    from one into the other.  Once one branch has merged, the other should
830
899
    be able to pull it again.
831
900
 
832
 
    If you want to forget your local changes and just update your branch to
833
 
    match the remote one, use pull --overwrite.
 
901
    If you want to replace your local changes and just want your branch to
 
902
    match the remote one, use pull --overwrite. This will work even if the two
 
903
    branches have diverged.
834
904
 
835
905
    If there is no default location set, the first pull will set it.  After
836
906
    that, you can omit the location to use the default.  To change the
846
916
    takes_options = ['remember', 'overwrite', 'revision',
847
917
        custom_help('verbose',
848
918
            help='Show logs of pulled revisions.'),
849
 
        Option('directory',
 
919
        custom_help('directory',
850
920
            help='Branch to pull into, '
851
 
                 'rather than the one containing the working directory.',
852
 
            short_name='d',
853
 
            type=unicode,
 
921
                 'rather than the one containing the working directory.'),
 
922
        Option('local',
 
923
            help="Perform a local pull in a bound "
 
924
                 "branch.  Local pulls are not applied to "
 
925
                 "the master branch."
854
926
            ),
855
927
        ]
856
928
    takes_args = ['location?']
858
930
 
859
931
    def run(self, location=None, remember=False, overwrite=False,
860
932
            revision=None, verbose=False,
861
 
            directory=None):
 
933
            directory=None, local=False):
862
934
        # FIXME: too much stuff is in the command class
863
935
        revision_id = None
864
936
        mergeable = None
867
939
        try:
868
940
            tree_to = WorkingTree.open_containing(directory)[0]
869
941
            branch_to = tree_to.branch
 
942
            self.add_cleanup(tree_to.lock_write().unlock)
870
943
        except errors.NoWorkingTree:
871
944
            tree_to = None
872
945
            branch_to = Branch.open_containing(directory)[0]
 
946
            self.add_cleanup(branch_to.lock_write().unlock)
 
947
 
 
948
        if local and not branch_to.get_bound_location():
 
949
            raise errors.LocalRequiresBoundBranch()
873
950
 
874
951
        possible_transports = []
875
952
        if location is not None:
903
980
        else:
904
981
            branch_from = Branch.open(location,
905
982
                possible_transports=possible_transports)
 
983
            self.add_cleanup(branch_from.lock_read().unlock)
906
984
 
907
985
            if branch_to.get_parent() is None or remember:
908
986
                branch_to.set_parent(branch_from.base)
910
988
        if revision is not None:
911
989
            revision_id = revision.as_revision_id(branch_from)
912
990
 
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)
 
991
        if tree_to is not None:
 
992
            view_info = _get_view_info_for_change_reporter(tree_to)
 
993
            change_reporter = delta._ChangeReporter(
 
994
                unversioned_filter=tree_to.is_ignored,
 
995
                view_info=view_info)
 
996
            result = tree_to.pull(
 
997
                branch_from, overwrite, revision_id, change_reporter,
 
998
                possible_transports=possible_transports, local=local)
 
999
        else:
 
1000
            result = branch_to.pull(
 
1001
                branch_from, overwrite, revision_id, local=local)
924
1002
 
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()
 
1003
        result.report(self.outf)
 
1004
        if verbose and result.old_revid != result.new_revid:
 
1005
            log.show_branch_change(
 
1006
                branch_to, self.outf, result.old_revno,
 
1007
                result.old_revid)
931
1008
 
932
1009
 
933
1010
class cmd_push(Command):
934
 
    """Update a mirror of this branch.
 
1011
    __doc__ = """Update a mirror of this branch.
935
1012
 
936
1013
    The target branch will not have its working tree populated because this
937
1014
    is both expensive, and is not supported on remote file systems.
961
1038
        Option('create-prefix',
962
1039
               help='Create the path leading up to the branch '
963
1040
                    'if it does not already exist.'),
964
 
        Option('directory',
 
1041
        custom_help('directory',
965
1042
            help='Branch to push from, '
966
 
                 'rather than the one containing the working directory.',
967
 
            short_name='d',
968
 
            type=unicode,
969
 
            ),
 
1043
                 'rather than the one containing the working directory.'),
970
1044
        Option('use-existing-dir',
971
1045
               help='By default push will fail if the target'
972
1046
                    ' directory exists, but does not already'
980
1054
                'for the commit history. Only the work not present in the '
981
1055
                'referenced branch is included in the branch created.',
982
1056
            type=unicode),
 
1057
        Option('strict',
 
1058
               help='Refuse to push if there are uncommitted changes in'
 
1059
               ' the working tree, --no-strict disables the check.'),
983
1060
        ]
984
1061
    takes_args = ['location?']
985
1062
    encoding_type = 'replace'
987
1064
    def run(self, location=None, remember=False, overwrite=False,
988
1065
        create_prefix=False, verbose=False, revision=None,
989
1066
        use_existing_dir=False, directory=None, stacked_on=None,
990
 
        stacked=False):
 
1067
        stacked=False, strict=None):
991
1068
        from bzrlib.push import _show_push_branch
992
1069
 
993
 
        # Get the source branch and revision_id
994
1070
        if directory is None:
995
1071
            directory = '.'
996
 
        br_from = Branch.open_containing(directory)[0]
 
1072
        # Get the source branch
 
1073
        (tree, br_from,
 
1074
         _unused) = bzrdir.BzrDir.open_containing_tree_or_branch(directory)
 
1075
        # Get the tip's revision_id
997
1076
        revision = _get_one_revision('push', revision)
998
1077
        if revision is not None:
999
1078
            revision_id = revision.in_history(br_from).rev_id
1000
1079
        else:
1001
 
            revision_id = br_from.last_revision()
1002
 
 
 
1080
            revision_id = None
 
1081
        if tree is not None and revision_id is None:
 
1082
            tree.check_changed_or_out_of_date(
 
1083
                strict, 'push_strict',
 
1084
                more_error='Use --no-strict to force the push.',
 
1085
                more_warning='Uncommitted changes will not be pushed.')
1003
1086
        # Get the stacked_on branch, if any
1004
1087
        if stacked_on is not None:
1005
1088
            stacked_on = urlutils.normalize_url(stacked_on)
1037
1120
 
1038
1121
 
1039
1122
class cmd_branch(Command):
1040
 
    """Create a new copy of a branch.
 
1123
    __doc__ = """Create a new branch that is a copy of an existing branch.
1041
1124
 
1042
1125
    If the TO_LOCATION is omitted, the last component of the FROM_LOCATION will
1043
1126
    be used.  In other words, "branch ../foo/bar" will attempt to create ./bar.
1052
1135
 
1053
1136
    _see_also = ['checkout']
1054
1137
    takes_args = ['from_location', 'to_location?']
1055
 
    takes_options = ['revision', Option('hardlink',
1056
 
        help='Hard-link working tree files where possible.'),
 
1138
    takes_options = ['revision',
 
1139
        Option('hardlink', help='Hard-link working tree files where possible.'),
 
1140
        Option('files-from', type=str,
 
1141
               help="Get file contents from this tree."),
1057
1142
        Option('no-tree',
1058
1143
            help="Create a branch without a working-tree."),
 
1144
        Option('switch',
 
1145
            help="Switch the checkout in the current directory "
 
1146
                 "to the new branch."),
1059
1147
        Option('stacked',
1060
1148
            help='Create a stacked branch referring to the source branch. '
1061
1149
                'The new branch will depend on the availability of the source '
1062
1150
                'branch for all operations.'),
1063
1151
        Option('standalone',
1064
1152
               help='Do not use a shared repository, even if available.'),
 
1153
        Option('use-existing-dir',
 
1154
               help='By default branch will fail if the target'
 
1155
                    ' directory exists, but does not already'
 
1156
                    ' have a control directory.  This flag will'
 
1157
                    ' allow branch to proceed.'),
 
1158
        Option('bind',
 
1159
            help="Bind new branch to from location."),
1065
1160
        ]
1066
1161
    aliases = ['get', 'clone']
1067
1162
 
1068
1163
    def run(self, from_location, to_location=None, revision=None,
1069
 
            hardlink=False, stacked=False, standalone=False, no_tree=False):
 
1164
            hardlink=False, stacked=False, standalone=False, no_tree=False,
 
1165
            use_existing_dir=False, switch=False, bind=False,
 
1166
            files_from=None):
 
1167
        from bzrlib import switch as _mod_switch
1070
1168
        from bzrlib.tag import _merge_tags_if_possible
1071
 
 
1072
1169
        accelerator_tree, br_from = bzrdir.BzrDir.open_tree_or_branch(
1073
1170
            from_location)
 
1171
        if not (hardlink or files_from):
 
1172
            # accelerator_tree is usually slower because you have to read N
 
1173
            # files (no readahead, lots of seeks, etc), but allow the user to
 
1174
            # explicitly request it
 
1175
            accelerator_tree = None
 
1176
        if files_from is not None and files_from != from_location:
 
1177
            accelerator_tree = WorkingTree.open(files_from)
1074
1178
        revision = _get_one_revision('branch', revision)
1075
 
        br_from.lock_read()
 
1179
        self.add_cleanup(br_from.lock_read().unlock)
 
1180
        if revision is not None:
 
1181
            revision_id = revision.as_revision_id(br_from)
 
1182
        else:
 
1183
            # FIXME - wt.last_revision, fallback to branch, fall back to
 
1184
            # None or perhaps NULL_REVISION to mean copy nothing
 
1185
            # RBC 20060209
 
1186
            revision_id = br_from.last_revision()
 
1187
        if to_location is None:
 
1188
            to_location = urlutils.derive_to_location(from_location)
 
1189
        to_transport = transport.get_transport(to_location)
1076
1190
        try:
1077
 
            if revision is not None:
1078
 
                revision_id = revision.as_revision_id(br_from)
 
1191
            to_transport.mkdir('.')
 
1192
        except errors.FileExists:
 
1193
            if not use_existing_dir:
 
1194
                raise errors.BzrCommandError('Target directory "%s" '
 
1195
                    'already exists.' % to_location)
1079
1196
            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()
 
1197
                try:
 
1198
                    bzrdir.BzrDir.open_from_transport(to_transport)
 
1199
                except errors.NotBranchError:
 
1200
                    pass
 
1201
                else:
 
1202
                    raise errors.AlreadyBranchError(to_location)
 
1203
        except errors.NoSuchFile:
 
1204
            raise errors.BzrCommandError('Parent of "%s" does not exist.'
 
1205
                                         % to_location)
 
1206
        try:
 
1207
            # preserve whatever source format we have.
 
1208
            dir = br_from.bzrdir.sprout(to_transport.base, revision_id,
 
1209
                                        possible_transports=[to_transport],
 
1210
                                        accelerator_tree=accelerator_tree,
 
1211
                                        hardlink=hardlink, stacked=stacked,
 
1212
                                        force_new_repo=standalone,
 
1213
                                        create_tree_if_local=not no_tree,
 
1214
                                        source_branch=br_from)
 
1215
            branch = dir.open_branch()
 
1216
        except errors.NoSuchRevision:
 
1217
            to_transport.delete_tree('.')
 
1218
            msg = "The branch %s has no revision %s." % (from_location,
 
1219
                revision)
 
1220
            raise errors.BzrCommandError(msg)
 
1221
        _merge_tags_if_possible(br_from, branch)
 
1222
        # If the source branch is stacked, the new branch may
 
1223
        # be stacked whether we asked for that explicitly or not.
 
1224
        # We therefore need a try/except here and not just 'if stacked:'
 
1225
        try:
 
1226
            note('Created new stacked branch referring to %s.' %
 
1227
                branch.get_stacked_on_url())
 
1228
        except (errors.NotStacked, errors.UnstackableBranchFormat,
 
1229
            errors.UnstackableRepositoryFormat), e:
 
1230
            note('Branched %d revision(s).' % branch.revno())
 
1231
        if bind:
 
1232
            # Bind to the parent
 
1233
            parent_branch = Branch.open(from_location)
 
1234
            branch.bind(parent_branch)
 
1235
            note('New branch bound to %s' % from_location)
 
1236
        if switch:
 
1237
            # Switch to the new branch
 
1238
            wt, _ = WorkingTree.open_containing('.')
 
1239
            _mod_switch.switch(wt.bzrdir, branch)
 
1240
            note('Switched to branch: %s',
 
1241
                urlutils.unescape_for_display(branch.base, 'utf-8'))
1122
1242
 
1123
1243
 
1124
1244
class cmd_checkout(Command):
1125
 
    """Create a new checkout of an existing branch.
 
1245
    __doc__ = """Create a new checkout of an existing branch.
1126
1246
 
1127
1247
    If BRANCH_LOCATION is omitted, checkout will reconstitute a working tree for
1128
1248
    the branch found in '.'. This is useful if you have removed the working tree
1167
1287
            to_location = branch_location
1168
1288
        accelerator_tree, source = bzrdir.BzrDir.open_tree_or_branch(
1169
1289
            branch_location)
 
1290
        if not (hardlink or files_from):
 
1291
            # accelerator_tree is usually slower because you have to read N
 
1292
            # files (no readahead, lots of seeks, etc), but allow the user to
 
1293
            # explicitly request it
 
1294
            accelerator_tree = None
1170
1295
        revision = _get_one_revision('checkout', revision)
1171
 
        if files_from is not None:
 
1296
        if files_from is not None and files_from != branch_location:
1172
1297
            accelerator_tree = WorkingTree.open(files_from)
1173
1298
        if revision is not None:
1174
1299
            revision_id = revision.as_revision_id(source)
1191
1316
 
1192
1317
 
1193
1318
class cmd_renames(Command):
1194
 
    """Show list of renamed files.
 
1319
    __doc__ = """Show list of renamed files.
1195
1320
    """
1196
1321
    # TODO: Option to show renames between two historical versions.
1197
1322
 
1202
1327
    @display_command
1203
1328
    def run(self, dir=u'.'):
1204
1329
        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()
 
1330
        self.add_cleanup(tree.lock_read().unlock)
 
1331
        new_inv = tree.inventory
 
1332
        old_tree = tree.basis_tree()
 
1333
        self.add_cleanup(old_tree.lock_read().unlock)
 
1334
        old_inv = old_tree.inventory
 
1335
        renames = []
 
1336
        iterator = tree.iter_changes(old_tree, include_unchanged=True)
 
1337
        for f, paths, c, v, p, n, k, e in iterator:
 
1338
            if paths[0] == paths[1]:
 
1339
                continue
 
1340
            if None in (paths):
 
1341
                continue
 
1342
            renames.append(paths)
 
1343
        renames.sort()
 
1344
        for old_name, new_name in renames:
 
1345
            self.outf.write("%s => %s\n" % (old_name, new_name))
1227
1346
 
1228
1347
 
1229
1348
class cmd_update(Command):
1230
 
    """Update a tree to have the latest code committed to its branch.
 
1349
    __doc__ = """Update a tree to have the latest code committed to its branch.
1231
1350
 
1232
1351
    This will perform a merge into the working tree, and may generate
1233
1352
    conflicts. If you have any local changes, you will still
1235
1354
 
1236
1355
    If you want to discard your local changes, you can just do a
1237
1356
    'bzr revert' instead of 'bzr commit' after the update.
 
1357
 
 
1358
    If the tree's branch is bound to a master branch, it will also update
 
1359
    the branch from the master.
1238
1360
    """
1239
1361
 
1240
1362
    _see_also = ['pull', 'working-trees', 'status-flags']
1241
1363
    takes_args = ['dir?']
 
1364
    takes_options = ['revision']
1242
1365
    aliases = ['up']
1243
1366
 
1244
 
    def run(self, dir='.'):
 
1367
    def run(self, dir='.', revision=None):
 
1368
        if revision is not None and len(revision) != 1:
 
1369
            raise errors.BzrCommandError(
 
1370
                        "bzr update --revision takes exactly one revision")
1245
1371
        tree = WorkingTree.open_containing(dir)[0]
 
1372
        branch = tree.branch
1246
1373
        possible_transports = []
1247
 
        master = tree.branch.get_master_branch(
 
1374
        master = branch.get_master_branch(
1248
1375
            possible_transports=possible_transports)
1249
1376
        if master is not None:
 
1377
            branch_location = master.base
1250
1378
            tree.lock_write()
1251
1379
        else:
 
1380
            branch_location = tree.branch.base
1252
1381
            tree.lock_tree_write()
 
1382
        self.add_cleanup(tree.unlock)
 
1383
        # get rid of the final '/' and be ready for display
 
1384
        branch_location = urlutils.unescape_for_display(
 
1385
            branch_location.rstrip('/'),
 
1386
            self.outf.encoding)
 
1387
        existing_pending_merges = tree.get_parent_ids()[1:]
 
1388
        if master is None:
 
1389
            old_tip = None
 
1390
        else:
 
1391
            # may need to fetch data into a heavyweight checkout
 
1392
            # XXX: this may take some time, maybe we should display a
 
1393
            # message
 
1394
            old_tip = branch.update(possible_transports)
 
1395
        if revision is not None:
 
1396
            revision_id = revision[0].as_revision_id(branch)
 
1397
        else:
 
1398
            revision_id = branch.last_revision()
 
1399
        if revision_id == _mod_revision.ensure_null(tree.last_revision()):
 
1400
            revno = branch.revision_id_to_dotted_revno(revision_id)
 
1401
            note("Tree is up to date at revision %s of branch %s" %
 
1402
                ('.'.join(map(str, revno)), branch_location))
 
1403
            return 0
 
1404
        view_info = _get_view_info_for_change_reporter(tree)
 
1405
        change_reporter = delta._ChangeReporter(
 
1406
            unversioned_filter=tree.is_ignored,
 
1407
            view_info=view_info)
1253
1408
        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
1409
            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()
 
1410
                change_reporter,
 
1411
                possible_transports=possible_transports,
 
1412
                revision=revision_id,
 
1413
                old_tip=old_tip)
 
1414
        except errors.NoSuchRevision, e:
 
1415
            raise errors.BzrCommandError(
 
1416
                                  "branch has no revision %s\n"
 
1417
                                  "bzr update --revision only works"
 
1418
                                  " for a revision in the branch history"
 
1419
                                  % (e.revision))
 
1420
        revno = tree.branch.revision_id_to_dotted_revno(
 
1421
            _mod_revision.ensure_null(tree.last_revision()))
 
1422
        note('Updated to revision %s of branch %s' %
 
1423
             ('.'.join(map(str, revno)), branch_location))
 
1424
        parent_ids = tree.get_parent_ids()
 
1425
        if parent_ids[1:] and parent_ids[1:] != existing_pending_merges:
 
1426
            note('Your local commits will now show as pending merges with '
 
1427
                 "'bzr status', and can be committed with 'bzr commit'.")
 
1428
        if conflicts != 0:
 
1429
            return 1
 
1430
        else:
 
1431
            return 0
1280
1432
 
1281
1433
 
1282
1434
class cmd_info(Command):
1283
 
    """Show information about a working tree, branch or repository.
 
1435
    __doc__ = """Show information about a working tree, branch or repository.
1284
1436
 
1285
1437
    This command will show all known locations and formats associated to the
1286
1438
    tree, branch or repository.
1301
1453
      basic statistics (like the number of files in the working tree and
1302
1454
      number of revisions in the branch and repository):
1303
1455
 
1304
 
        bzr -v info
 
1456
        bzr info -v
1305
1457
 
1306
1458
      Display the above together with number of committers to the branch:
1307
1459
 
1308
 
        bzr -vv info
 
1460
        bzr info -vv
1309
1461
    """
1310
1462
    _see_also = ['revno', 'working-trees', 'repositories']
1311
1463
    takes_args = ['location?']
1324
1476
 
1325
1477
 
1326
1478
class cmd_remove(Command):
1327
 
    """Remove files or directories.
 
1479
    __doc__ = """Remove files or directories.
1328
1480
 
1329
1481
    This makes bzr stop tracking changes to the specified files. bzr will delete
1330
1482
    them if they can easily be recovered using revert. If no options or
1339
1491
            title='Deletion Strategy', value_switches=True, enum_switch=False,
1340
1492
            safe='Only delete files if they can be'
1341
1493
                 ' safely recovered (default).',
1342
 
            keep="Don't delete any files.",
 
1494
            keep='Delete from bzr but leave the working copy.',
1343
1495
            force='Delete all the specified files, even if they can not be '
1344
1496
                'recovered and even if they are non-empty directories.')]
1345
1497
    aliases = ['rm', 'del']
1347
1499
 
1348
1500
    def run(self, file_list, verbose=False, new=False,
1349
1501
        file_deletion_strategy='safe'):
1350
 
        tree, file_list = tree_files(file_list)
 
1502
        tree, file_list = WorkingTree.open_containing_paths(file_list)
1351
1503
 
1352
1504
        if file_list is not None:
1353
1505
            file_list = [f for f in file_list]
1354
1506
 
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()
 
1507
        self.add_cleanup(tree.lock_write().unlock)
 
1508
        # Heuristics should probably all move into tree.remove_smart or
 
1509
        # some such?
 
1510
        if new:
 
1511
            added = tree.changes_from(tree.basis_tree(),
 
1512
                specific_files=file_list).added
 
1513
            file_list = sorted([f[0] for f in added], reverse=True)
 
1514
            if len(file_list) == 0:
 
1515
                raise errors.BzrCommandError('No matching files.')
 
1516
        elif file_list is None:
 
1517
            # missing files show up in iter_changes(basis) as
 
1518
            # versioned-with-no-kind.
 
1519
            missing = []
 
1520
            for change in tree.iter_changes(tree.basis_tree()):
 
1521
                # Find paths in the working tree that have no kind:
 
1522
                if change[1][1] is not None and change[6][1] is None:
 
1523
                    missing.append(change[1][1])
 
1524
            file_list = sorted(missing, reverse=True)
 
1525
            file_deletion_strategy = 'keep'
 
1526
        tree.remove(file_list, verbose=verbose, to_file=self.outf,
 
1527
            keep_files=file_deletion_strategy=='keep',
 
1528
            force=file_deletion_strategy=='force')
1380
1529
 
1381
1530
 
1382
1531
class cmd_file_id(Command):
1383
 
    """Print file_id of a particular file or directory.
 
1532
    __doc__ = """Print file_id of a particular file or directory.
1384
1533
 
1385
1534
    The file_id is assigned when the file is first added and remains the
1386
1535
    same through all revisions where the file exists, even when it is
1402
1551
 
1403
1552
 
1404
1553
class cmd_file_path(Command):
1405
 
    """Print path of file_ids to a file or directory.
 
1554
    __doc__ = """Print path of file_ids to a file or directory.
1406
1555
 
1407
1556
    This prints one line for each directory down to the target,
1408
1557
    starting at the branch root.
1424
1573
 
1425
1574
 
1426
1575
class cmd_reconcile(Command):
1427
 
    """Reconcile bzr metadata in a branch.
 
1576
    __doc__ = """Reconcile bzr metadata in a branch.
1428
1577
 
1429
1578
    This can correct data mismatches that may have been caused by
1430
1579
    previous ghost operations or bzr upgrades. You should only
1452
1601
 
1453
1602
 
1454
1603
class cmd_revision_history(Command):
1455
 
    """Display the list of revision ids on a branch."""
 
1604
    __doc__ = """Display the list of revision ids on a branch."""
1456
1605
 
1457
1606
    _see_also = ['log']
1458
1607
    takes_args = ['location?']
1468
1617
 
1469
1618
 
1470
1619
class cmd_ancestry(Command):
1471
 
    """List all revisions merged into this branch."""
 
1620
    __doc__ = """List all revisions merged into this branch."""
1472
1621
 
1473
1622
    _see_also = ['log', 'revision-history']
1474
1623
    takes_args = ['location?']
1493
1642
 
1494
1643
 
1495
1644
class cmd_init(Command):
1496
 
    """Make a directory into a versioned branch.
 
1645
    __doc__ = """Make a directory into a versioned branch.
1497
1646
 
1498
1647
    Use this to create an empty branch, or before importing an
1499
1648
    existing project.
1527
1676
                lazy_registry=('bzrlib.bzrdir', 'format_registry'),
1528
1677
                converter=lambda name: bzrdir.format_registry.make_bzrdir(name),
1529
1678
                value_switches=True,
1530
 
                title="Branch Format",
 
1679
                title="Branch format",
1531
1680
                ),
1532
1681
         Option('append-revisions-only',
1533
1682
                help='Never change revnos or the existing log.'
1556
1705
                    "\nYou may supply --create-prefix to create all"
1557
1706
                    " leading parent directories."
1558
1707
                    % location)
1559
 
            _create_prefix(to_transport)
 
1708
            to_transport.create_prefix()
1560
1709
 
1561
1710
        try:
1562
1711
            a_bzrdir = bzrdir.BzrDir.open_from_transport(to_transport)
1580
1729
                branch.set_append_revisions_only(True)
1581
1730
            except errors.UpgradeRequired:
1582
1731
                raise errors.BzrCommandError('This branch format cannot be set'
1583
 
                    ' to append-revisions-only.  Try --experimental-branch6')
 
1732
                    ' to append-revisions-only.  Try --default.')
1584
1733
        if not is_quiet():
1585
1734
            from bzrlib.info import describe_layout, describe_format
1586
1735
            try:
1602
1751
 
1603
1752
 
1604
1753
class cmd_init_repository(Command):
1605
 
    """Create a shared repository to hold branches.
 
1754
    __doc__ = """Create a shared repository for branches to share storage space.
1606
1755
 
1607
1756
    New branches created under the repository directory will store their
1608
 
    revisions in the repository, not in the branch directory.
 
1757
    revisions in the repository, not in the branch directory.  For branches
 
1758
    with shared history, this reduces the amount of storage needed and 
 
1759
    speeds up the creation of new branches.
1609
1760
 
1610
 
    If the --no-trees option is used then the branches in the repository
1611
 
    will not have working trees by default.
 
1761
    If the --no-trees option is given then the branches in the repository
 
1762
    will not have working trees by default.  They will still exist as 
 
1763
    directories on disk, but they will not have separate copies of the 
 
1764
    files at a certain revision.  This can be useful for repositories that
 
1765
    store branches which are interacted with through checkouts or remote
 
1766
    branches, such as on a server.
1612
1767
 
1613
1768
    :Examples:
1614
 
        Create a shared repositories holding just branches::
 
1769
        Create a shared repository holding just branches::
1615
1770
 
1616
1771
            bzr init-repo --no-trees repo
1617
1772
            bzr init repo/trunk
1656
1811
 
1657
1812
 
1658
1813
class cmd_diff(Command):
1659
 
    """Show differences in the working tree, between revisions or branches.
 
1814
    __doc__ = """Show differences in the working tree, between revisions or branches.
1660
1815
 
1661
1816
    If no arguments are given, all changes for the current tree are listed.
1662
1817
    If files are given, only the changes in those files are listed.
1683
1838
 
1684
1839
            bzr diff -r1
1685
1840
 
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
 
1841
        Difference between revision 3 and revision 1::
 
1842
 
 
1843
            bzr diff -r1..3
 
1844
 
 
1845
        Difference between revision 3 and revision 1 for branch xxx::
 
1846
 
 
1847
            bzr diff -r1..3 xxx
 
1848
 
 
1849
        To see the changes introduced in revision X::
 
1850
        
 
1851
            bzr diff -cX
 
1852
 
 
1853
        Note that in the case of a merge, the -c option shows the changes
 
1854
        compared to the left hand parent. To see the changes against
 
1855
        another parent, use::
 
1856
 
 
1857
            bzr diff -r<chosen_parent>..X
 
1858
 
 
1859
        The changes introduced by revision 2 (equivalent to -r1..2)::
 
1860
 
 
1861
            bzr diff -c2
1693
1862
 
1694
1863
        Show just the differences for file NEWS::
1695
1864
 
1715
1884
    takes_args = ['file*']
1716
1885
    takes_options = [
1717
1886
        Option('diff-options', type=str,
1718
 
               help='Pass these options to the external diff program.'),
 
1887
               help='Pass these options to the diff program.'),
1719
1888
        Option('prefix', type=str,
1720
1889
               short_name='p',
1721
1890
               help='Set prefixes added to old and new filenames, as '
1734
1903
            help='Use this command to compare files.',
1735
1904
            type=unicode,
1736
1905
            ),
 
1906
        RegistryOption('format',
 
1907
            help='Diff format to use.',
 
1908
            lazy_registry=('bzrlib.diff', 'format_registry'),
 
1909
            value_switches=False, title='Diff format'),
1737
1910
        ]
1738
1911
    aliases = ['di', 'dif']
1739
1912
    encoding_type = 'exact'
1740
1913
 
1741
1914
    @display_command
1742
1915
    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
 
1916
            prefix=None, old=None, new=None, using=None, format=None):
 
1917
        from bzrlib.diff import (get_trees_and_branches_to_diff_locked,
 
1918
            show_diff_trees)
1745
1919
 
1746
1920
        if (prefix is None) or (prefix == '0'):
1747
1921
            # diff -p0 format
1757
1931
                '--prefix expects two values separated by a colon'
1758
1932
                ' (eg "old/:new/")')
1759
1933
 
 
1934
        if using is not None and diff_options is not None:
 
1935
            raise errors.BzrCommandError(
 
1936
            '--diff-options and --using are mutually exclusive.')
 
1937
 
1760
1938
        if revision and len(revision) > 2:
1761
1939
            raise errors.BzrCommandError('bzr diff --revision takes exactly'
1762
1940
                                         ' one or two revision specifiers')
1763
1941
 
1764
 
        old_tree, new_tree, specific_files, extra_trees = \
1765
 
                _get_trees_to_diff(file_list, revision, old, new,
1766
 
                apply_view=True)
 
1942
        if using is not None and format is not None:
 
1943
            raise errors.BzrCommandError('--using and --format are mutually '
 
1944
                'exclusive.')
 
1945
 
 
1946
        (old_tree, new_tree,
 
1947
         old_branch, new_branch,
 
1948
         specific_files, extra_trees) = get_trees_and_branches_to_diff_locked(
 
1949
            file_list, revision, old, new, self.add_cleanup, apply_view=True)
 
1950
        # GNU diff on Windows uses ANSI encoding for filenames
 
1951
        path_encoding = osutils.get_diff_header_encoding()
1767
1952
        return show_diff_trees(old_tree, new_tree, sys.stdout,
1768
1953
                               specific_files=specific_files,
1769
1954
                               external_diff_options=diff_options,
1770
1955
                               old_label=old_label, new_label=new_label,
1771
 
                               extra_trees=extra_trees, using=using)
 
1956
                               extra_trees=extra_trees,
 
1957
                               path_encoding=path_encoding,
 
1958
                               using=using,
 
1959
                               format_cls=format)
1772
1960
 
1773
1961
 
1774
1962
class cmd_deleted(Command):
1775
 
    """List files deleted in the working tree.
 
1963
    __doc__ = """List files deleted in the working tree.
1776
1964
    """
1777
1965
    # TODO: Show files deleted since a previous revision, or
1778
1966
    # between two revisions.
1781
1969
    # level of effort but possibly much less IO.  (Or possibly not,
1782
1970
    # if the directories are very large...)
1783
1971
    _see_also = ['status', 'ls']
1784
 
    takes_options = ['show-ids']
 
1972
    takes_options = ['directory', 'show-ids']
1785
1973
 
1786
1974
    @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()
 
1975
    def run(self, show_ids=False, directory=u'.'):
 
1976
        tree = WorkingTree.open_containing(directory)[0]
 
1977
        self.add_cleanup(tree.lock_read().unlock)
 
1978
        old = tree.basis_tree()
 
1979
        self.add_cleanup(old.lock_read().unlock)
 
1980
        for path, ie in old.inventory.iter_entries():
 
1981
            if not tree.has_id(ie.file_id):
 
1982
                self.outf.write(path)
 
1983
                if show_ids:
 
1984
                    self.outf.write(' ')
 
1985
                    self.outf.write(ie.file_id)
 
1986
                self.outf.write('\n')
1805
1987
 
1806
1988
 
1807
1989
class cmd_modified(Command):
1808
 
    """List files modified in working tree.
 
1990
    __doc__ = """List files modified in working tree.
1809
1991
    """
1810
1992
 
1811
1993
    hidden = True
1812
1994
    _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
 
            ]
 
1995
    takes_options = ['directory', 'null']
1818
1996
 
1819
1997
    @display_command
1820
 
    def run(self, null=False):
1821
 
        tree = WorkingTree.open_containing(u'.')[0]
 
1998
    def run(self, null=False, directory=u'.'):
 
1999
        tree = WorkingTree.open_containing(directory)[0]
1822
2000
        td = tree.changes_from(tree.basis_tree())
1823
2001
        for path, id, kind, text_modified, meta_modified in td.modified:
1824
2002
            if null:
1828
2006
 
1829
2007
 
1830
2008
class cmd_added(Command):
1831
 
    """List files added in working tree.
 
2009
    __doc__ = """List files added in working tree.
1832
2010
    """
1833
2011
 
1834
2012
    hidden = True
1835
2013
    _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
 
            ]
 
2014
    takes_options = ['directory', 'null']
1841
2015
 
1842
2016
    @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()
 
2017
    def run(self, null=False, directory=u'.'):
 
2018
        wt = WorkingTree.open_containing(directory)[0]
 
2019
        self.add_cleanup(wt.lock_read().unlock)
 
2020
        basis = wt.basis_tree()
 
2021
        self.add_cleanup(basis.lock_read().unlock)
 
2022
        basis_inv = basis.inventory
 
2023
        inv = wt.inventory
 
2024
        for file_id in inv:
 
2025
            if file_id in basis_inv:
 
2026
                continue
 
2027
            if inv.is_root(file_id) and len(basis_inv) == 0:
 
2028
                continue
 
2029
            path = inv.id2path(file_id)
 
2030
            if not os.access(osutils.pathjoin(wt.basedir, path), os.F_OK):
 
2031
                continue
 
2032
            if null:
 
2033
                self.outf.write(path + '\0')
 
2034
            else:
 
2035
                self.outf.write(osutils.quotefn(path) + '\n')
1868
2036
 
1869
2037
 
1870
2038
class cmd_root(Command):
1871
 
    """Show the tree root directory.
 
2039
    __doc__ = """Show the tree root directory.
1872
2040
 
1873
2041
    The root is the nearest enclosing directory with a .bzr control
1874
2042
    directory."""
1898
2066
 
1899
2067
 
1900
2068
class cmd_log(Command):
1901
 
    """Show historical log for a branch or subset of a branch.
 
2069
    __doc__ = """Show historical log for a branch or subset of a branch.
1902
2070
 
1903
2071
    log is bzr's default tool for exploring the history of a branch.
1904
2072
    The branch to use is taken from the first parameter. If no parameters
1933
2101
        --show-ids  display revision-ids (and file-ids), not just revnos
1934
2102
 
1935
2103
      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.
 
2104
      log format. If the -n option is not used, the standard log formats show
 
2105
      just the top level (mainline).
1939
2106
 
1940
2107
      Status summaries are shown using status flags like A, M, etc. To see
1941
2108
      the changes explained using words like ``added`` and ``modified``
2016
2183
    :Tips & tricks:
2017
2184
 
2018
2185
      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.
 
2186
      line tools: you may prefer qlog or viz from qbzr or bzr-gtk, the
 
2187
      bzr-explorer shell, or the Loggerhead web interface.  See the Plugin
 
2188
      Guide <http://doc.bazaar.canonical.com/plugins/en/> and
 
2189
      <http://wiki.bazaar.canonical.com/IDEIntegration>.  
2026
2190
 
2027
2191
      You may find it useful to add the aliases below to ``bazaar.conf``::
2028
2192
 
2029
2193
        [ALIASES]
2030
 
        tip = log -r-1 -n1
 
2194
        tip = log -r-1
2031
2195
        top = log -l10 --line
2032
 
        show = log -v -p -n1 --long
 
2196
        show = log -v -p
2033
2197
 
2034
2198
      ``bzr tip`` will then show the latest revision while ``bzr top``
2035
2199
      will show the last 10 mainline revisions. To see the details of a
2036
2200
      particular revision X,  ``bzr show -rX``.
2037
2201
 
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
 
2202
      If you are interested in looking deeper into a particular merge X,
 
2203
      use ``bzr log -n0 -rX``.
2045
2204
 
2046
2205
      ``bzr log -v`` on a branch with lots of history is currently
2047
2206
      very slow. A fix for this issue is currently under development.
2055
2214
 
2056
2215
      When exploring non-mainline history on large projects with deep
2057
2216
      history, the performance of log can be greatly improved by installing
2058
 
      the revnocache plugin. This plugin buffers historical information
 
2217
      the historycache plugin. This plugin buffers historical information
2059
2218
      trading disk space for faster speed.
2060
2219
    """
2061
2220
    takes_args = ['file*']
2074
2233
                   help='Show just the specified revision.'
2075
2234
                   ' See also "help revisionspec".'),
2076
2235
            'log-format',
 
2236
            RegistryOption('authors',
 
2237
                'What names to list as authors - first, all or committer.',
 
2238
                title='Authors',
 
2239
                lazy_registry=('bzrlib.log', 'author_list_registry'),
 
2240
            ),
2077
2241
            Option('levels',
2078
2242
                   short_name='n',
2079
2243
                   help='Number of levels to display - 0 for all, 1 for flat.',
2092
2256
            Option('show-diff',
2093
2257
                   short_name='p',
2094
2258
                   help='Show changes made in each revision as a patch.'),
 
2259
            Option('include-merges',
 
2260
                   help='Show merged revisions like --levels 0 does.'),
 
2261
            Option('exclude-common-ancestry',
 
2262
                   help='Display only the revisions that are not part'
 
2263
                   ' of both ancestries (require -rX..Y)'
 
2264
                   )
2095
2265
            ]
2096
2266
    encoding_type = 'replace'
2097
2267
 
2106
2276
            levels=None,
2107
2277
            message=None,
2108
2278
            limit=None,
2109
 
            show_diff=False):
 
2279
            show_diff=False,
 
2280
            include_merges=False,
 
2281
            authors=None,
 
2282
            exclude_common_ancestry=False,
 
2283
            ):
2110
2284
        from bzrlib.log import (
2111
2285
            Logger,
2112
2286
            make_log_request_dict,
2113
2287
            _get_info_for_log_files,
2114
2288
            )
2115
2289
        direction = (forward and 'forward') or 'reverse'
 
2290
        if (exclude_common_ancestry
 
2291
            and (revision is None or len(revision) != 2)):
 
2292
            raise errors.BzrCommandError(
 
2293
                '--exclude-common-ancestry requires -r with two revisions')
 
2294
        if include_merges:
 
2295
            if levels is None:
 
2296
                levels = 0
 
2297
            else:
 
2298
                raise errors.BzrCommandError(
 
2299
                    '--levels and --include-merges are mutually exclusive')
2116
2300
 
2117
2301
        if change is not None:
2118
2302
            if len(change) > 1:
2127
2311
        filter_by_dir = False
2128
2312
        if file_list:
2129
2313
            # 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)
 
2314
            b, file_info_list, rev1, rev2 = _get_info_for_log_files(
 
2315
                revision, file_list, self.add_cleanup)
2132
2316
            for relpath, file_id, kind in file_info_list:
2133
2317
                if file_id is None:
2134
2318
                    raise errors.BzrCommandError(
2152
2336
                location = '.'
2153
2337
            dir, relpath = bzrdir.BzrDir.open_containing(location)
2154
2338
            b = dir.open_branch()
 
2339
            self.add_cleanup(b.lock_read().unlock)
2155
2340
            rev1, rev2 = _get_revision_range(revision, b, self.name())
2156
2341
 
2157
2342
        # Decide on the type of delta & diff filtering to use
2167
2352
        else:
2168
2353
            diff_type = 'full'
2169
2354
 
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()
 
2355
        # Build the log formatter
 
2356
        if log_format is None:
 
2357
            log_format = log.log_formatter_registry.get_default(b)
 
2358
        # Make a non-encoding output to include the diffs - bug 328007
 
2359
        unencoded_output = ui.ui_factory.make_output_stream(encoding_type='exact')
 
2360
        lf = log_format(show_ids=show_ids, to_file=self.outf,
 
2361
                        to_exact_file=unencoded_output,
 
2362
                        show_timezone=timezone,
 
2363
                        delta_format=get_verbosity_level(),
 
2364
                        levels=levels,
 
2365
                        show_advice=levels is None,
 
2366
                        author_list_handler=authors)
 
2367
 
 
2368
        # Choose the algorithm for doing the logging. It's annoying
 
2369
        # having multiple code paths like this but necessary until
 
2370
        # the underlying repository format is faster at generating
 
2371
        # deltas or can provide everything we need from the indices.
 
2372
        # The default algorithm - match-using-deltas - works for
 
2373
        # multiple files and directories and is faster for small
 
2374
        # amounts of history (200 revisions say). However, it's too
 
2375
        # slow for logging a single file in a repository with deep
 
2376
        # history, i.e. > 10K revisions. In the spirit of "do no
 
2377
        # evil when adding features", we continue to use the
 
2378
        # original algorithm - per-file-graph - for the "single
 
2379
        # file that isn't a directory without showing a delta" case.
 
2380
        partial_history = revision and b.repository._format.supports_chks
 
2381
        match_using_deltas = (len(file_ids) != 1 or filter_by_dir
 
2382
            or delta_type or partial_history)
 
2383
 
 
2384
        # Build the LogRequest and execute it
 
2385
        if len(file_ids) == 0:
 
2386
            file_ids = None
 
2387
        rqst = make_log_request_dict(
 
2388
            direction=direction, specific_fileids=file_ids,
 
2389
            start_revision=rev1, end_revision=rev2, limit=limit,
 
2390
            message_search=message, delta_type=delta_type,
 
2391
            diff_type=diff_type, _match_using_deltas=match_using_deltas,
 
2392
            exclude_common_ancestry=exclude_common_ancestry,
 
2393
            )
 
2394
        Logger(b, rqst).show(lf)
2206
2395
 
2207
2396
 
2208
2397
def _get_revision_range(revisionspec_list, branch, command_name):
2226
2415
            raise errors.BzrCommandError(
2227
2416
                "bzr %s doesn't accept two revisions in different"
2228
2417
                " branches." % command_name)
2229
 
        rev1 = start_spec.in_history(branch)
 
2418
        if start_spec.spec is None:
 
2419
            # Avoid loading all the history.
 
2420
            rev1 = RevisionInfo(branch, None, None)
 
2421
        else:
 
2422
            rev1 = start_spec.in_history(branch)
2230
2423
        # Avoid loading all of history when we know a missing
2231
2424
        # end of range means the last revision ...
2232
2425
        if end_spec.spec is None:
2261
2454
 
2262
2455
 
2263
2456
class cmd_touching_revisions(Command):
2264
 
    """Return revision-ids which affected a particular file.
 
2457
    __doc__ = """Return revision-ids which affected a particular file.
2265
2458
 
2266
2459
    A more user-friendly interface is "bzr log FILE".
2267
2460
    """
2272
2465
    @display_command
2273
2466
    def run(self, filename):
2274
2467
        tree, relpath = WorkingTree.open_containing(filename)
 
2468
        file_id = tree.path2id(relpath)
2275
2469
        b = tree.branch
2276
 
        file_id = tree.path2id(relpath)
2277
 
        for revno, revision_id, what in log.find_touching_revisions(b, file_id):
 
2470
        self.add_cleanup(b.lock_read().unlock)
 
2471
        touching_revs = log.find_touching_revisions(b, file_id)
 
2472
        for revno, revision_id, what in touching_revs:
2278
2473
            self.outf.write("%6d %s\n" % (revno, what))
2279
2474
 
2280
2475
 
2281
2476
class cmd_ls(Command):
2282
 
    """List files in a tree.
 
2477
    __doc__ = """List files in a tree.
2283
2478
    """
2284
2479
 
2285
2480
    _see_also = ['status', 'cat']
2286
2481
    takes_args = ['path?']
2287
 
    # TODO: Take a revision or remote path and list that tree instead.
2288
2482
    takes_options = [
2289
2483
            'verbose',
2290
2484
            'revision',
2291
 
            Option('non-recursive',
2292
 
                   help='Don\'t recurse into subdirectories.'),
 
2485
            Option('recursive', short_name='R',
 
2486
                   help='Recurse into subdirectories.'),
2293
2487
            Option('from-root',
2294
2488
                   help='Print paths relative to the root of the branch.'),
2295
 
            Option('unknown', help='Print unknown files.'),
 
2489
            Option('unknown', short_name='u',
 
2490
                help='Print unknown files.'),
2296
2491
            Option('versioned', help='Print versioned files.',
2297
2492
                   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',
 
2493
            Option('ignored', short_name='i',
 
2494
                help='Print ignored files.'),
 
2495
            Option('kind', short_name='k',
2303
2496
                   help='List entries of a particular kind: file, directory, symlink.',
2304
2497
                   type=unicode),
 
2498
            'null',
2305
2499
            'show-ids',
 
2500
            'directory',
2306
2501
            ]
2307
2502
    @display_command
2308
2503
    def run(self, revision=None, verbose=False,
2309
 
            non_recursive=False, from_root=False,
 
2504
            recursive=False, from_root=False,
2310
2505
            unknown=False, versioned=False, ignored=False,
2311
 
            null=False, kind=None, show_ids=False, path=None):
 
2506
            null=False, kind=None, show_ids=False, path=None, directory=None):
2312
2507
 
2313
2508
        if kind and kind not in ('file', 'directory', 'symlink'):
2314
2509
            raise errors.BzrCommandError('invalid kind specified')
2321
2516
 
2322
2517
        if path is None:
2323
2518
            fs_path = '.'
2324
 
            prefix = ''
2325
2519
        else:
2326
2520
            if from_root:
2327
2521
                raise errors.BzrCommandError('cannot specify both --from-root'
2328
2522
                                             ' and PATH')
2329
2523
            fs_path = path
2330
 
            prefix = path
2331
 
        tree, branch, relpath = bzrdir.BzrDir.open_containing_tree_or_branch(
2332
 
            fs_path)
 
2524
        tree, branch, relpath = \
 
2525
            _open_directory_or_containing_tree_or_branch(fs_path, directory)
 
2526
 
 
2527
        # Calculate the prefix to use
 
2528
        prefix = None
2333
2529
        if from_root:
2334
 
            relpath = u''
2335
 
        elif relpath:
2336
 
            relpath += '/'
 
2530
            if relpath:
 
2531
                prefix = relpath + '/'
 
2532
        elif fs_path != '.' and not fs_path.endswith('/'):
 
2533
            prefix = fs_path + '/'
 
2534
 
2337
2535
        if revision is not None or tree is None:
2338
2536
            tree = _get_one_revision_tree('ls', revision, branch=branch)
2339
2537
 
2343
2541
            if view_files:
2344
2542
                apply_view = True
2345
2543
                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()
 
2544
                note("Ignoring files outside view. View is %s" % view_str)
 
2545
 
 
2546
        self.add_cleanup(tree.lock_read().unlock)
 
2547
        for fp, fc, fkind, fid, entry in tree.list_files(include_root=False,
 
2548
            from_dir=relpath, recursive=recursive):
 
2549
            # Apply additional masking
 
2550
            if not all and not selection[fc]:
 
2551
                continue
 
2552
            if kind is not None and fkind != kind:
 
2553
                continue
 
2554
            if apply_view:
 
2555
                try:
 
2556
                    if relpath:
 
2557
                        fullpath = osutils.pathjoin(relpath, fp)
 
2558
                    else:
 
2559
                        fullpath = fp
 
2560
                    views.check_path_in_view(tree, fullpath)
 
2561
                except errors.FileOutsideView:
 
2562
                    continue
 
2563
 
 
2564
            # Output the entry
 
2565
            if prefix:
 
2566
                fp = osutils.pathjoin(prefix, fp)
 
2567
            kindch = entry.kind_character()
 
2568
            outstring = fp + kindch
 
2569
            ui.ui_factory.clear_term()
 
2570
            if verbose:
 
2571
                outstring = '%-8s %s' % (fc, outstring)
 
2572
                if show_ids and fid is not None:
 
2573
                    outstring = "%-50s %s" % (outstring, fid)
 
2574
                self.outf.write(outstring + '\n')
 
2575
            elif null:
 
2576
                self.outf.write(fp + '\0')
 
2577
                if show_ids:
 
2578
                    if fid is not None:
 
2579
                        self.outf.write(fid)
 
2580
                    self.outf.write('\0')
 
2581
                self.outf.flush()
 
2582
            else:
 
2583
                if show_ids:
 
2584
                    if fid is not None:
 
2585
                        my_id = fid
 
2586
                    else:
 
2587
                        my_id = ''
 
2588
                    self.outf.write('%-50s %s\n' % (outstring, my_id))
 
2589
                else:
 
2590
                    self.outf.write(outstring + '\n')
2389
2591
 
2390
2592
 
2391
2593
class cmd_unknowns(Command):
2392
 
    """List unknown files.
 
2594
    __doc__ = """List unknown files.
2393
2595
    """
2394
2596
 
2395
2597
    hidden = True
2396
2598
    _see_also = ['ls']
 
2599
    takes_options = ['directory']
2397
2600
 
2398
2601
    @display_command
2399
 
    def run(self):
2400
 
        for f in WorkingTree.open_containing(u'.')[0].unknowns():
 
2602
    def run(self, directory=u'.'):
 
2603
        for f in WorkingTree.open_containing(directory)[0].unknowns():
2401
2604
            self.outf.write(osutils.quotefn(f) + '\n')
2402
2605
 
2403
2606
 
2404
2607
class cmd_ignore(Command):
2405
 
    """Ignore specified files or patterns.
 
2608
    __doc__ = """Ignore specified files or patterns.
2406
2609
 
2407
2610
    See ``bzr help patterns`` for details on the syntax of patterns.
2408
2611
 
 
2612
    If a .bzrignore file does not exist, the ignore command
 
2613
    will create one and add the specified files or patterns to the newly
 
2614
    created file. The ignore command will also automatically add the 
 
2615
    .bzrignore file to be versioned. Creating a .bzrignore file without
 
2616
    the use of the ignore command will require an explicit add command.
 
2617
 
2409
2618
    To remove patterns from the ignore list, edit the .bzrignore file.
2410
2619
    After adding, editing or deleting that file either indirectly by
2411
2620
    using this command or directly by using an editor, be sure to commit
2412
2621
    it.
 
2622
    
 
2623
    Bazaar also supports a global ignore file ~/.bazaar/ignore. On Windows
 
2624
    the global ignore file can be found in the application data directory as
 
2625
    C:\\Documents and Settings\\<user>\\Application Data\\Bazaar\\2.0\\ignore.
 
2626
    Global ignores are not touched by this command. The global ignore file
 
2627
    can be edited directly using an editor.
 
2628
 
 
2629
    Patterns prefixed with '!' are exceptions to ignore patterns and take
 
2630
    precedence over regular ignores.  Such exceptions are used to specify
 
2631
    files that should be versioned which would otherwise be ignored.
 
2632
    
 
2633
    Patterns prefixed with '!!' act as regular ignore patterns, but have
 
2634
    precedence over the '!' exception patterns.
2413
2635
 
2414
2636
    Note: ignore patterns containing shell wildcards must be quoted from
2415
2637
    the shell on Unix.
2419
2641
 
2420
2642
            bzr ignore ./Makefile
2421
2643
 
2422
 
        Ignore class files in all directories::
 
2644
        Ignore .class files in all directories...::
2423
2645
 
2424
2646
            bzr ignore "*.class"
2425
2647
 
 
2648
        ...but do not ignore "special.class"::
 
2649
 
 
2650
            bzr ignore "!special.class"
 
2651
 
2426
2652
        Ignore .o files under the lib directory::
2427
2653
 
2428
2654
            bzr ignore "lib/**/*.o"
2434
2660
        Ignore everything but the "debian" toplevel directory::
2435
2661
 
2436
2662
            bzr ignore "RE:(?!debian/).*"
 
2663
        
 
2664
        Ignore everything except the "local" toplevel directory,
 
2665
        but always ignore "*~" autosave files, even under local/::
 
2666
        
 
2667
            bzr ignore "*"
 
2668
            bzr ignore "!./local"
 
2669
            bzr ignore "!!*~"
2437
2670
    """
2438
2671
 
2439
2672
    _see_also = ['status', 'ignored', 'patterns']
2440
2673
    takes_args = ['name_pattern*']
2441
 
    takes_options = [
2442
 
        Option('old-default-rules',
2443
 
               help='Write out the ignore rules bzr < 0.9 always used.')
 
2674
    takes_options = ['directory',
 
2675
        Option('default-rules',
 
2676
               help='Display the default ignore rules that bzr uses.')
2444
2677
        ]
2445
2678
 
2446
 
    def run(self, name_pattern_list=None, old_default_rules=None):
 
2679
    def run(self, name_pattern_list=None, default_rules=None,
 
2680
            directory=u'.'):
2447
2681
        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
 
2682
        if default_rules is not None:
 
2683
            # dump the default rules and exit
 
2684
            for pattern in ignores.USER_DEFAULTS:
 
2685
                self.outf.write("%s\n" % pattern)
2452
2686
            return
2453
2687
        if not name_pattern_list:
2454
2688
            raise errors.BzrCommandError("ignore requires at least one "
2455
 
                                  "NAME_PATTERN or --old-default-rules")
 
2689
                "NAME_PATTERN or --default-rules.")
2456
2690
        name_pattern_list = [globbing.normalize_pattern(p)
2457
2691
                             for p in name_pattern_list]
 
2692
        bad_patterns = ''
 
2693
        for p in name_pattern_list:
 
2694
            if not globbing.Globster.is_pattern_valid(p):
 
2695
                bad_patterns += ('\n  %s' % p)
 
2696
        if bad_patterns:
 
2697
            msg = ('Invalid ignore pattern(s) found. %s' % bad_patterns)
 
2698
            ui.ui_factory.show_error(msg)
 
2699
            raise errors.InvalidPattern('')
2458
2700
        for name_pattern in name_pattern_list:
2459
2701
            if (name_pattern[0] == '/' or
2460
2702
                (len(name_pattern) > 1 and name_pattern[1] == ':')):
2461
2703
                raise errors.BzrCommandError(
2462
2704
                    "NAME_PATTERN should not be an absolute path")
2463
 
        tree, relpath = WorkingTree.open_containing(u'.')
 
2705
        tree, relpath = WorkingTree.open_containing(directory)
2464
2706
        ignores.tree_ignores_add_patterns(tree, name_pattern_list)
2465
2707
        ignored = globbing.Globster(name_pattern_list)
2466
2708
        matches = []
2467
 
        tree.lock_read()
 
2709
        self.add_cleanup(tree.lock_read().unlock)
2468
2710
        for entry in tree.list_files():
2469
2711
            id = entry[3]
2470
2712
            if id is not None:
2471
2713
                filename = entry[0]
2472
2714
                if ignored.match(filename):
2473
 
                    matches.append(filename.encode('utf-8'))
2474
 
        tree.unlock()
 
2715
                    matches.append(filename)
2475
2716
        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),)
 
2717
            self.outf.write("Warning: the following files are version controlled and"
 
2718
                  " match your ignore pattern:\n%s"
 
2719
                  "\nThese files will continue to be version controlled"
 
2720
                  " unless you 'bzr remove' them.\n" % ("\n".join(matches),))
2480
2721
 
2481
2722
 
2482
2723
class cmd_ignored(Command):
2483
 
    """List ignored files and the patterns that matched them.
 
2724
    __doc__ = """List ignored files and the patterns that matched them.
2484
2725
 
2485
2726
    List all the ignored files and the ignore pattern that caused the file to
2486
2727
    be ignored.
2492
2733
 
2493
2734
    encoding_type = 'replace'
2494
2735
    _see_also = ['ignore', 'ls']
 
2736
    takes_options = ['directory']
2495
2737
 
2496
2738
    @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()
 
2739
    def run(self, directory=u'.'):
 
2740
        tree = WorkingTree.open_containing(directory)[0]
 
2741
        self.add_cleanup(tree.lock_read().unlock)
 
2742
        for path, file_class, kind, file_id, entry in tree.list_files():
 
2743
            if file_class != 'I':
 
2744
                continue
 
2745
            ## XXX: Slightly inefficient since this was already calculated
 
2746
            pat = tree.is_ignored(path)
 
2747
            self.outf.write('%-50s %s\n' % (path, pat))
2509
2748
 
2510
2749
 
2511
2750
class cmd_lookup_revision(Command):
2512
 
    """Lookup the revision-id from a revision-number
 
2751
    __doc__ = """Lookup the revision-id from a revision-number
2513
2752
 
2514
2753
    :Examples:
2515
2754
        bzr lookup-revision 33
2516
2755
    """
2517
2756
    hidden = True
2518
2757
    takes_args = ['revno']
 
2758
    takes_options = ['directory']
2519
2759
 
2520
2760
    @display_command
2521
 
    def run(self, revno):
 
2761
    def run(self, revno, directory=u'.'):
2522
2762
        try:
2523
2763
            revno = int(revno)
2524
2764
        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)
 
2765
            raise errors.BzrCommandError("not a valid revision-number: %r"
 
2766
                                         % revno)
 
2767
        revid = WorkingTree.open_containing(directory)[0].branch.get_rev_id(revno)
 
2768
        self.outf.write("%s\n" % revid)
2528
2769
 
2529
2770
 
2530
2771
class cmd_export(Command):
2531
 
    """Export current or past revision to a destination directory or archive.
 
2772
    __doc__ = """Export current or past revision to a destination directory or archive.
2532
2773
 
2533
2774
    If no revision is specified this exports the last committed revision.
2534
2775
 
2556
2797
      =================       =========================
2557
2798
    """
2558
2799
    takes_args = ['dest', 'branch_or_subdir?']
2559
 
    takes_options = [
 
2800
    takes_options = ['directory',
2560
2801
        Option('format',
2561
2802
               help="Type of file to export to.",
2562
2803
               type=unicode),
2566
2807
        Option('root',
2567
2808
               type=str,
2568
2809
               help="Name of the root directory inside the exported file."),
 
2810
        Option('per-file-timestamps',
 
2811
               help='Set modification time of files to that of the last '
 
2812
                    'revision in which it was changed.'),
2569
2813
        ]
2570
2814
    def run(self, dest, branch_or_subdir=None, revision=None, format=None,
2571
 
        root=None, filters=False):
 
2815
        root=None, filters=False, per_file_timestamps=False, directory=u'.'):
2572
2816
        from bzrlib.export import export
2573
2817
 
2574
2818
        if branch_or_subdir is None:
2575
 
            tree = WorkingTree.open_containing(u'.')[0]
 
2819
            tree = WorkingTree.open_containing(directory)[0]
2576
2820
            b = tree.branch
2577
2821
            subdir = None
2578
2822
        else:
2581
2825
 
2582
2826
        rev_tree = _get_one_revision_tree('export', revision, branch=b, tree=tree)
2583
2827
        try:
2584
 
            export(rev_tree, dest, format, root, subdir, filtered=filters)
 
2828
            export(rev_tree, dest, format, root, subdir, filtered=filters,
 
2829
                   per_file_timestamps=per_file_timestamps)
2585
2830
        except errors.NoSuchExportFormat, e:
2586
2831
            raise errors.BzrCommandError('Unsupported export format: %s' % e.format)
2587
2832
 
2588
2833
 
2589
2834
class cmd_cat(Command):
2590
 
    """Write the contents of a file as of a given revision to standard output.
 
2835
    __doc__ = """Write the contents of a file as of a given revision to standard output.
2591
2836
 
2592
2837
    If no revision is nominated, the last revision is used.
2593
2838
 
2596
2841
    """
2597
2842
 
2598
2843
    _see_also = ['ls']
2599
 
    takes_options = [
 
2844
    takes_options = ['directory',
2600
2845
        Option('name-from-revision', help='The path name in the old tree.'),
2601
2846
        Option('filters', help='Apply content filters to display the '
2602
2847
                'convenience form.'),
2607
2852
 
2608
2853
    @display_command
2609
2854
    def run(self, filename, revision=None, name_from_revision=False,
2610
 
            filters=False):
 
2855
            filters=False, directory=None):
2611
2856
        if revision is not None and len(revision) != 1:
2612
2857
            raise errors.BzrCommandError("bzr cat --revision takes exactly"
2613
2858
                                         " one revision specifier")
2614
2859
        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()
 
2860
            _open_directory_or_containing_tree_or_branch(filename, directory)
 
2861
        self.add_cleanup(branch.lock_read().unlock)
 
2862
        return self._run(tree, branch, relpath, filename, revision,
 
2863
                         name_from_revision, filters)
2622
2864
 
2623
2865
    def _run(self, tree, b, relpath, filename, revision, name_from_revision,
2624
2866
        filtered):
2625
2867
        if tree is None:
2626
2868
            tree = b.basis_tree()
2627
2869
        rev_tree = _get_one_revision_tree('cat', revision, branch=b)
 
2870
        self.add_cleanup(rev_tree.lock_read().unlock)
2628
2871
 
2629
2872
        old_file_id = rev_tree.path2id(relpath)
2630
2873
 
2665
2908
            chunks = content.splitlines(True)
2666
2909
            content = filtered_output_bytes(chunks, filters,
2667
2910
                ContentFilterContext(relpath, rev_tree))
 
2911
            self.cleanup_now()
2668
2912
            self.outf.writelines(content)
2669
2913
        else:
 
2914
            self.cleanup_now()
2670
2915
            self.outf.write(content)
2671
2916
 
2672
2917
 
2673
2918
class cmd_local_time_offset(Command):
2674
 
    """Show the offset in seconds from GMT to local time."""
 
2919
    __doc__ = """Show the offset in seconds from GMT to local time."""
2675
2920
    hidden = True
2676
2921
    @display_command
2677
2922
    def run(self):
2678
 
        print osutils.local_time_offset()
 
2923
        self.outf.write("%s\n" % osutils.local_time_offset())
2679
2924
 
2680
2925
 
2681
2926
 
2682
2927
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.
 
2928
    __doc__ = """Commit changes into a new revision.
 
2929
 
 
2930
    An explanatory message needs to be given for each commit. This is
 
2931
    often done by using the --message option (getting the message from the
 
2932
    command line) or by using the --file option (getting the message from
 
2933
    a file). If neither of these options is given, an editor is opened for
 
2934
    the user to enter the message. To see the changed files in the
 
2935
    boilerplate text loaded into the editor, use the --show-diff option.
 
2936
 
 
2937
    By default, the entire tree is committed and the person doing the
 
2938
    commit is assumed to be the author. These defaults can be overridden
 
2939
    as explained below.
 
2940
 
 
2941
    :Selective commits:
 
2942
 
 
2943
      If selected files are specified, only changes to those files are
 
2944
      committed.  If a directory is specified then the directory and
 
2945
      everything within it is committed.
 
2946
  
 
2947
      When excludes are given, they take precedence over selected files.
 
2948
      For example, to commit only changes within foo, but not changes
 
2949
      within foo/bar::
 
2950
  
 
2951
        bzr commit foo -x foo/bar
 
2952
  
 
2953
      A selective commit after a merge is not yet supported.
 
2954
 
 
2955
    :Custom authors:
 
2956
 
 
2957
      If the author of the change is not the same person as the committer,
 
2958
      you can specify the author's name using the --author option. The
 
2959
      name should be in the same format as a committer-id, e.g.
 
2960
      "John Doe <jdoe@example.com>". If there is more than one author of
 
2961
      the change you can specify the option multiple times, once for each
 
2962
      author.
 
2963
  
 
2964
    :Checks:
 
2965
 
 
2966
      A common mistake is to forget to add a new file or directory before
 
2967
      running the commit command. The --strict option checks for unknown
 
2968
      files and aborts the commit if any are found. More advanced pre-commit
 
2969
      checks can be implemented by defining hooks. See ``bzr help hooks``
 
2970
      for details.
 
2971
 
 
2972
    :Things to note:
 
2973
 
 
2974
      If you accidentially commit the wrong changes or make a spelling
 
2975
      mistake in the commit message say, you can use the uncommit command
 
2976
      to undo it. See ``bzr help uncommit`` for details.
 
2977
 
 
2978
      Hooks can also be configured to run after a commit. This allows you
 
2979
      to trigger updates to external systems like bug trackers. The --fixes
 
2980
      option can be used to record the association between a revision and
 
2981
      one or more bugs. See ``bzr help bugs`` for details.
 
2982
 
 
2983
      A selective commit may fail in some cases where the committed
 
2984
      tree would be invalid. Consider::
 
2985
  
 
2986
        bzr init foo
 
2987
        mkdir foo/bar
 
2988
        bzr add foo/bar
 
2989
        bzr commit foo -m "committing foo"
 
2990
        bzr mv foo/bar foo/baz
 
2991
        mkdir foo/bar
 
2992
        bzr add foo/bar
 
2993
        bzr commit foo/bar -m "committing bar but not baz"
 
2994
  
 
2995
      In the example above, the last commit will fail by design. This gives
 
2996
      the user the opportunity to decide whether they want to commit the
 
2997
      rename at the same time, separately first, or not at all. (As a general
 
2998
      rule, when in doubt, Bazaar has a policy of Doing the Safe Thing.)
2721
2999
    """
2722
3000
    # TODO: Run hooks on tree to-be-committed, and after commit.
2723
3001
 
2728
3006
 
2729
3007
    # XXX: verbose currently does nothing
2730
3008
 
2731
 
    _see_also = ['bugs', 'uncommit']
 
3009
    _see_also = ['add', 'bugs', 'hooks', 'uncommit']
2732
3010
    takes_args = ['selected*']
2733
3011
    takes_options = [
2734
3012
            ListOption('exclude', type=str, short_name='x',
2746
3024
             Option('strict',
2747
3025
                    help="Refuse to commit if there are unknown "
2748
3026
                    "files in the working tree."),
 
3027
             Option('commit-time', type=str,
 
3028
                    help="Manually set a commit time using commit date "
 
3029
                    "format, e.g. '2009-10-10 08:00:00 +0100'."),
2749
3030
             ListOption('fixes', type=str,
2750
3031
                    help="Mark a bug as being fixed by this revision "
2751
3032
                         "(see \"bzr help bugs\")."),
2758
3039
                         "the master branch until a normal commit "
2759
3040
                         "is performed."
2760
3041
                    ),
2761
 
              Option('show-diff',
2762
 
                     help='When no message is supplied, show the diff along'
2763
 
                     ' with the status summary in the message editor.'),
 
3042
             Option('show-diff', short_name='p',
 
3043
                    help='When no message is supplied, show the diff along'
 
3044
                    ' with the status summary in the message editor.'),
2764
3045
             ]
2765
3046
    aliases = ['ci', 'checkin']
2766
3047
 
2785
3066
 
2786
3067
    def run(self, message=None, file=None, verbose=False, selected_list=None,
2787
3068
            unchanged=False, strict=False, local=False, fixes=None,
2788
 
            author=None, show_diff=False, exclude=None):
 
3069
            author=None, show_diff=False, exclude=None, commit_time=None):
2789
3070
        from bzrlib.errors import (
2790
3071
            PointlessCommit,
2791
3072
            ConflictsInTree,
2797
3078
            make_commit_message_template_encoded
2798
3079
        )
2799
3080
 
 
3081
        commit_stamp = offset = None
 
3082
        if commit_time is not None:
 
3083
            try:
 
3084
                commit_stamp, offset = timestamp.parse_patch_date(commit_time)
 
3085
            except ValueError, e:
 
3086
                raise errors.BzrCommandError(
 
3087
                    "Could not parse --commit-time: " + str(e))
 
3088
 
2800
3089
        # TODO: Need a blackbox test for invoking the external editor; may be
2801
3090
        # slightly problematic to run this cross-platform.
2802
3091
 
2805
3094
 
2806
3095
        properties = {}
2807
3096
 
2808
 
        tree, selected_list = tree_files(selected_list)
 
3097
        tree, selected_list = WorkingTree.open_containing_paths(selected_list)
2809
3098
        if selected_list == ['']:
2810
3099
            # workaround - commit of root of tree should be exactly the same
2811
3100
            # as just default commit in that tree, and succeed even though
2822
3111
        if local and not tree.branch.get_bound_location():
2823
3112
            raise errors.LocalRequiresBoundBranch()
2824
3113
 
 
3114
        if message is not None:
 
3115
            try:
 
3116
                file_exists = osutils.lexists(message)
 
3117
            except UnicodeError:
 
3118
                # The commit message contains unicode characters that can't be
 
3119
                # represented in the filesystem encoding, so that can't be a
 
3120
                # file.
 
3121
                file_exists = False
 
3122
            if file_exists:
 
3123
                warning_msg = (
 
3124
                    'The commit message is a file name: "%(f)s".\n'
 
3125
                    '(use --file "%(f)s" to take commit message from that file)'
 
3126
                    % { 'f': message })
 
3127
                ui.ui_factory.show_warning(warning_msg)
 
3128
            if '\r' in message:
 
3129
                message = message.replace('\r\n', '\n')
 
3130
                message = message.replace('\r', '\n')
 
3131
            if file:
 
3132
                raise errors.BzrCommandError(
 
3133
                    "please specify either --message or --file")
 
3134
 
2825
3135
        def get_message(commit_obj):
2826
3136
            """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,
 
3137
            if file:
 
3138
                f = codecs.open(file, 'rt', osutils.get_user_encoding())
 
3139
                try:
 
3140
                    my_message = f.read()
 
3141
                finally:
 
3142
                    f.close()
 
3143
            elif message is not None:
 
3144
                my_message = message
 
3145
            else:
 
3146
                # No message supplied: make one up.
 
3147
                # text is the status of the tree
 
3148
                text = make_commit_message_template_encoded(tree,
2830
3149
                        selected_list, diff=show_diff,
2831
3150
                        output_encoding=osutils.get_user_encoding())
 
3151
                # start_message is the template generated from hooks
 
3152
                # XXX: Warning - looks like hooks return unicode,
 
3153
                # make_commit_message_template_encoded returns user encoding.
 
3154
                # We probably want to be using edit_commit_message instead to
 
3155
                # avoid this.
2832
3156
                start_message = generate_commit_message_template(commit_obj)
2833
 
                my_message = edit_commit_message_encoded(t,
 
3157
                my_message = edit_commit_message_encoded(text,
2834
3158
                    start_message=start_message)
2835
3159
                if my_message is None:
2836
3160
                    raise errors.BzrCommandError("please specify a commit"
2837
3161
                        " 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
3162
            if my_message == "":
2845
3163
                raise errors.BzrCommandError("empty commit message specified")
2846
3164
            return my_message
2847
3165
 
 
3166
        # The API permits a commit with a filter of [] to mean 'select nothing'
 
3167
        # but the command line should not do that.
 
3168
        if not selected_list:
 
3169
            selected_list = None
2848
3170
        try:
2849
3171
            tree.commit(message_callback=get_message,
2850
3172
                        specific_files=selected_list,
2851
3173
                        allow_pointless=unchanged, strict=strict, local=local,
2852
3174
                        reporter=None, verbose=verbose, revprops=properties,
2853
 
                        authors=author,
2854
 
                        exclude=safe_relpath_files(tree, exclude))
 
3175
                        authors=author, timestamp=commit_stamp,
 
3176
                        timezone=offset,
 
3177
                        exclude=tree.safe_relpath_files(exclude))
2855
3178
        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")
 
3179
            raise errors.BzrCommandError("No changes to commit."
 
3180
                              " Use --unchanged to commit anyhow.")
2860
3181
        except ConflictsInTree:
2861
3182
            raise errors.BzrCommandError('Conflicts detected in working '
2862
3183
                'tree.  Use "bzr conflicts" to list, "bzr resolve FILE" to'
2865
3186
            raise errors.BzrCommandError("Commit refused because there are"
2866
3187
                              " unknown files in the working tree.")
2867
3188
        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.')
 
3189
            e.extra_help = ("\n"
 
3190
                'To commit to master branch, run update and then commit.\n'
 
3191
                'You can also pass --local to commit to continue working '
 
3192
                'disconnected.')
 
3193
            raise
2872
3194
 
2873
3195
 
2874
3196
class cmd_check(Command):
2875
 
    """Validate working tree structure, branch consistency and repository history.
 
3197
    __doc__ = """Validate working tree structure, branch consistency and repository history.
2876
3198
 
2877
3199
    This command checks various invariants about branch and repository storage
2878
3200
    to detect data corruption or bzr bugs.
2880
3202
    The working tree and branch checks will only give output if a problem is
2881
3203
    detected. The output fields of the repository check are:
2882
3204
 
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.
 
3205
    revisions
 
3206
        This is just the number of revisions checked.  It doesn't
 
3207
        indicate a problem.
 
3208
 
 
3209
    versionedfiles
 
3210
        This is just the number of versionedfiles checked.  It
 
3211
        doesn't indicate a problem.
 
3212
 
 
3213
    unreferenced ancestors
 
3214
        Texts that are ancestors of other texts, but
 
3215
        are not properly referenced by the revision ancestry.  This is a
 
3216
        subtle problem that Bazaar can work around.
 
3217
 
 
3218
    unique file texts
 
3219
        This is the total number of unique file contents
 
3220
        seen in the checked revisions.  It does not indicate a problem.
 
3221
 
 
3222
    repeated file texts
 
3223
        This is the total number of repeated texts seen
 
3224
        in the checked revisions.  Texts can be repeated when their file
 
3225
        entries are modified, but the file contents are not.  It does not
 
3226
        indicate a problem.
2896
3227
 
2897
3228
    If no restrictions are specified, all Bazaar data that is found at the given
2898
3229
    location will be checked.
2933
3264
 
2934
3265
 
2935
3266
class cmd_upgrade(Command):
2936
 
    """Upgrade branch storage to current format.
 
3267
    __doc__ = """Upgrade branch storage to current format.
2937
3268
 
2938
3269
    The check command or bzr developers may sometimes advise you to run
2939
3270
    this command. When the default format has changed you may also be warned
2953
3284
 
2954
3285
    def run(self, url='.', format=None):
2955
3286
        from bzrlib.upgrade import upgrade
2956
 
        if format is None:
2957
 
            format = bzrdir.format_registry.make_bzrdir('default')
2958
3287
        upgrade(url, format)
2959
3288
 
2960
3289
 
2961
3290
class cmd_whoami(Command):
2962
 
    """Show or set bzr user id.
 
3291
    __doc__ = """Show or set bzr user id.
2963
3292
 
2964
3293
    :Examples:
2965
3294
        Show the email of the current user::
2970
3299
 
2971
3300
            bzr whoami "Frank Chu <fchu@example.com>"
2972
3301
    """
2973
 
    takes_options = [ Option('email',
 
3302
    takes_options = [ 'directory',
 
3303
                      Option('email',
2974
3304
                             help='Display email address only.'),
2975
3305
                      Option('branch',
2976
3306
                             help='Set identity for the current branch instead of '
2980
3310
    encoding_type = 'replace'
2981
3311
 
2982
3312
    @display_command
2983
 
    def run(self, email=False, branch=False, name=None):
 
3313
    def run(self, email=False, branch=False, name=None, directory=None):
2984
3314
        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()
 
3315
            if directory is None:
 
3316
                # use branch if we're inside one; otherwise global config
 
3317
                try:
 
3318
                    c = Branch.open_containing(u'.')[0].get_config()
 
3319
                except errors.NotBranchError:
 
3320
                    c = config.GlobalConfig()
 
3321
            else:
 
3322
                c = Branch.open(directory).get_config()
2990
3323
            if email:
2991
3324
                self.outf.write(c.user_email() + '\n')
2992
3325
            else:
3002
3335
 
3003
3336
        # use global config unless --branch given
3004
3337
        if branch:
3005
 
            c = Branch.open_containing('.')[0].get_config()
 
3338
            if directory is None:
 
3339
                c = Branch.open_containing(u'.')[0].get_config()
 
3340
            else:
 
3341
                c = Branch.open(directory).get_config()
3006
3342
        else:
3007
3343
            c = config.GlobalConfig()
3008
3344
        c.set_user_option('email', name)
3009
3345
 
3010
3346
 
3011
3347
class cmd_nick(Command):
3012
 
    """Print or set the branch nickname.
 
3348
    __doc__ = """Print or set the branch nickname.
3013
3349
 
3014
3350
    If unset, the tree root directory name is used as the nickname.
3015
3351
    To print the current nickname, execute with no argument.
3020
3356
 
3021
3357
    _see_also = ['info']
3022
3358
    takes_args = ['nickname?']
3023
 
    def run(self, nickname=None):
3024
 
        branch = Branch.open_containing(u'.')[0]
 
3359
    takes_options = ['directory']
 
3360
    def run(self, nickname=None, directory=u'.'):
 
3361
        branch = Branch.open_containing(directory)[0]
3025
3362
        if nickname is None:
3026
3363
            self.printme(branch)
3027
3364
        else:
3029
3366
 
3030
3367
    @display_command
3031
3368
    def printme(self, branch):
3032
 
        print branch.nick
 
3369
        self.outf.write('%s\n' % branch.nick)
3033
3370
 
3034
3371
 
3035
3372
class cmd_alias(Command):
3036
 
    """Set/unset and display aliases.
 
3373
    __doc__ = """Set/unset and display aliases.
3037
3374
 
3038
3375
    :Examples:
3039
3376
        Show the current aliases::
3103
3440
 
3104
3441
 
3105
3442
class cmd_selftest(Command):
3106
 
    """Run internal test suite.
 
3443
    __doc__ = """Run internal test suite.
3107
3444
 
3108
3445
    If arguments are given, they are regular expressions that say which tests
3109
3446
    should run.  Tests matching any expression are run, and other tests are
3136
3473
    Tests that need working space on disk use a common temporary directory,
3137
3474
    typically inside $TMPDIR or /tmp.
3138
3475
 
 
3476
    If you set BZR_TEST_PDB=1 when running selftest, failing tests will drop
 
3477
    into a pdb postmortem session.
 
3478
 
3139
3479
    :Examples:
3140
3480
        Run only tests relating to 'ignore'::
3141
3481
 
3150
3490
    def get_transport_type(typestring):
3151
3491
        """Parse and return a transport specifier."""
3152
3492
        if typestring == "sftp":
3153
 
            from bzrlib.transport.sftp import SFTPAbsoluteServer
3154
 
            return SFTPAbsoluteServer
 
3493
            from bzrlib.tests import stub_sftp
 
3494
            return stub_sftp.SFTPAbsoluteServer
3155
3495
        if typestring == "memory":
3156
 
            from bzrlib.transport.memory import MemoryServer
3157
 
            return MemoryServer
 
3496
            from bzrlib.tests import test_server
 
3497
            return memory.MemoryServer
3158
3498
        if typestring == "fakenfs":
3159
 
            from bzrlib.transport.fakenfs import FakeNFSServer
3160
 
            return FakeNFSServer
 
3499
            from bzrlib.tests import test_server
 
3500
            return test_server.FakeNFSServer
3161
3501
        msg = "No known transport type %s. Supported types are: sftp\n" %\
3162
3502
            (typestring)
3163
3503
        raise errors.BzrCommandError(msg)
3174
3514
                                 'throughout the test suite.',
3175
3515
                            type=get_transport_type),
3176
3516
                     Option('benchmark',
3177
 
                            help='Run the benchmarks rather than selftests.'),
 
3517
                            help='Run the benchmarks rather than selftests.',
 
3518
                            hidden=True),
3178
3519
                     Option('lsprof-timed',
3179
3520
                            help='Generate lsprof output for benchmarked'
3180
3521
                                 ' sections of code.'),
3181
 
                     Option('cache-dir', type=str,
3182
 
                            help='Cache intermediate benchmark output in this '
3183
 
                                 'directory.'),
 
3522
                     Option('lsprof-tests',
 
3523
                            help='Generate lsprof output for each test.'),
3184
3524
                     Option('first',
3185
3525
                            help='Run all tests, but run specified tests first.',
3186
3526
                            short_name='f',
3187
3527
                            ),
3188
3528
                     Option('list-only',
3189
3529
                            help='List the tests instead of running them.'),
 
3530
                     RegistryOption('parallel',
 
3531
                        help="Run the test suite in parallel.",
 
3532
                        lazy_registry=('bzrlib.tests', 'parallel_registry'),
 
3533
                        value_switches=False,
 
3534
                        ),
3190
3535
                     Option('randomize', type=str, argname="SEED",
3191
3536
                            help='Randomize the order of tests using the given'
3192
3537
                                 ' seed or "now" for the current time.'),
3215
3560
 
3216
3561
    def run(self, testspecs_list=None, verbose=False, one=False,
3217
3562
            transport=None, benchmark=None,
3218
 
            lsprof_timed=None, cache_dir=None,
 
3563
            lsprof_timed=None,
3219
3564
            first=False, list_only=False,
3220
3565
            randomize=None, exclude=None, strict=False,
3221
 
            load_list=None, debugflag=None, starting_with=None, subunit=False):
 
3566
            load_list=None, debugflag=None, starting_with=None, subunit=False,
 
3567
            parallel=None, lsprof_tests=False):
3222
3568
        from bzrlib.tests import selftest
3223
 
        import bzrlib.benchmarks as benchmarks
3224
 
        from bzrlib.benchmarks import tree_creator
3225
3569
 
3226
3570
        # Make deprecation warnings visible, unless -Werror is set
3227
3571
        symbol_versioning.activate_deprecation_warnings(override=False)
3228
3572
 
3229
 
        if cache_dir is not None:
3230
 
            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
3573
        if testspecs_list is not None:
3240
3574
            pattern = '|'.join(testspecs_list)
3241
3575
        else:
3247
3581
                raise errors.BzrCommandError("subunit not available. subunit "
3248
3582
                    "needs to be installed to use --subunit.")
3249
3583
            self.additional_selftest_args['runner_class'] = SubUnitBzrRunner
 
3584
            # On Windows, disable automatic conversion of '\n' to '\r\n' in
 
3585
            # stdout, which would corrupt the subunit stream. 
 
3586
            # FIXME: This has been fixed in subunit trunk (>0.0.5) so the
 
3587
            # following code can be deleted when it's sufficiently deployed
 
3588
            # -- vila/mgz 20100514
 
3589
            if (sys.platform == "win32"
 
3590
                and getattr(sys.stdout, 'fileno', None) is not None):
 
3591
                import msvcrt
 
3592
                msvcrt.setmode(sys.stdout.fileno(), os.O_BINARY)
 
3593
        if parallel:
 
3594
            self.additional_selftest_args.setdefault(
 
3595
                'suite_decorators', []).append(parallel)
3250
3596
        if benchmark:
3251
 
            test_suite_factory = benchmarks.test_suite
3252
 
            # Unless user explicitly asks for quiet, be verbose in benchmarks
3253
 
            verbose = not is_quiet()
3254
 
            # TODO: should possibly lock the history file...
3255
 
            benchfile = open(".perf_history", "at", buffering=1)
3256
 
        else:
3257
 
            test_suite_factory = None
3258
 
            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')
 
3597
            raise errors.BzrCommandError(
 
3598
                "--benchmark is no longer supported from bzr 2.2; "
 
3599
                "use bzr-usertest instead")
 
3600
        test_suite_factory = None
 
3601
        selftest_kwargs = {"verbose": verbose,
 
3602
                          "pattern": pattern,
 
3603
                          "stop_on_failure": one,
 
3604
                          "transport": transport,
 
3605
                          "test_suite_factory": test_suite_factory,
 
3606
                          "lsprof_timed": lsprof_timed,
 
3607
                          "lsprof_tests": lsprof_tests,
 
3608
                          "matching_tests_first": first,
 
3609
                          "list_only": list_only,
 
3610
                          "random_seed": randomize,
 
3611
                          "exclude_pattern": exclude,
 
3612
                          "strict": strict,
 
3613
                          "load_list": load_list,
 
3614
                          "debug_flags": debugflag,
 
3615
                          "starting_with": starting_with
 
3616
                          }
 
3617
        selftest_kwargs.update(self.additional_selftest_args)
 
3618
        result = selftest(**selftest_kwargs)
3285
3619
        return int(not result)
3286
3620
 
3287
3621
 
3288
3622
class cmd_version(Command):
3289
 
    """Show version of bzr."""
 
3623
    __doc__ = """Show version of bzr."""
3290
3624
 
3291
3625
    encoding_type = 'replace'
3292
3626
    takes_options = [
3303
3637
 
3304
3638
 
3305
3639
class cmd_rocks(Command):
3306
 
    """Statement of optimism."""
 
3640
    __doc__ = """Statement of optimism."""
3307
3641
 
3308
3642
    hidden = True
3309
3643
 
3310
3644
    @display_command
3311
3645
    def run(self):
3312
 
        print "It sure does!"
 
3646
        self.outf.write("It sure does!\n")
3313
3647
 
3314
3648
 
3315
3649
class cmd_find_merge_base(Command):
3316
 
    """Find and print a base revision for merging two branches."""
 
3650
    __doc__ = """Find and print a base revision for merging two branches."""
3317
3651
    # TODO: Options to specify revisions on either side, as if
3318
3652
    #       merging only part of the history.
3319
3653
    takes_args = ['branch', 'other']
3325
3659
 
3326
3660
        branch1 = Branch.open_containing(branch)[0]
3327
3661
        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()
 
3662
        self.add_cleanup(branch1.lock_read().unlock)
 
3663
        self.add_cleanup(branch2.lock_read().unlock)
 
3664
        last1 = ensure_null(branch1.last_revision())
 
3665
        last2 = ensure_null(branch2.last_revision())
 
3666
 
 
3667
        graph = branch1.repository.get_graph(branch2.repository)
 
3668
        base_rev_id = graph.find_unique_lca(last1, last2)
 
3669
 
 
3670
        self.outf.write('merge base is revision %s\n' % base_rev_id)
3343
3671
 
3344
3672
 
3345
3673
class cmd_merge(Command):
3346
 
    """Perform a three-way merge.
 
3674
    __doc__ = """Perform a three-way merge.
3347
3675
 
3348
3676
    The source of the merge can be specified either in the form of a branch,
3349
3677
    or in the form of a path to a file containing a merge directive generated
3378
3706
    committed to record the result of the merge.
3379
3707
 
3380
3708
    merge refuses to run if there are any uncommitted changes, unless
3381
 
    --force is given.
 
3709
    --force is given. The --force option can also be used to create a
 
3710
    merge revision which has more than two parents.
 
3711
 
 
3712
    If one would like to merge changes from the working tree of the other
 
3713
    branch without merging any committed revisions, the --uncommitted option
 
3714
    can be given.
 
3715
 
 
3716
    To select only some changes to merge, use "merge -i", which will prompt
 
3717
    you to apply each diff hunk and file change, similar to "shelve".
3382
3718
 
3383
3719
    :Examples:
3384
3720
        To merge the latest revision from bzr.dev::
3393
3729
 
3394
3730
            bzr merge -r 81..82 ../bzr.dev
3395
3731
 
3396
 
        To apply a merge directive contained in in /tmp/merge:
 
3732
        To apply a merge directive contained in /tmp/merge::
3397
3733
 
3398
3734
            bzr merge /tmp/merge
 
3735
 
 
3736
        To create a merge revision with three parents from two branches
 
3737
        feature1a and feature1b:
 
3738
 
 
3739
            bzr merge ../feature1a
 
3740
            bzr merge ../feature1b --force
 
3741
            bzr commit -m 'revision with three parents'
3399
3742
    """
3400
3743
 
3401
3744
    encoding_type = 'exact'
3417
3760
                ' completely merged into the source, pull from the'
3418
3761
                ' source rather than merging.  When this happens,'
3419
3762
                ' you do not need to commit the result.'),
3420
 
        Option('directory',
 
3763
        custom_help('directory',
3421
3764
               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.')
 
3765
                    'rather than the one containing the working directory.'),
 
3766
        Option('preview', help='Instead of merging, show a diff of the'
 
3767
               ' merge.'),
 
3768
        Option('interactive', help='Select changes interactively.',
 
3769
            short_name='i')
3427
3770
    ]
3428
3771
 
3429
3772
    def run(self, location=None, revision=None, force=False,
3431
3774
            uncommitted=False, pull=False,
3432
3775
            directory=None,
3433
3776
            preview=False,
 
3777
            interactive=False,
3434
3778
            ):
3435
3779
        if merge_type is None:
3436
3780
            merge_type = _mod_merge.Merge3Merger
3442
3786
        verified = 'inapplicable'
3443
3787
        tree = WorkingTree.open_containing(directory)[0]
3444
3788
 
3445
 
        # die as quickly as possible if there are uncommitted changes
3446
3789
        try:
3447
3790
            basis_tree = tree.revision_tree(tree.last_revision())
3448
3791
        except errors.NoSuchRevision:
3449
3792
            basis_tree = tree.basis_tree()
 
3793
 
 
3794
        # die as quickly as possible if there are uncommitted changes
3450
3795
        if not force:
3451
 
            changes = tree.changes_from(basis_tree)
3452
 
            if changes.has_changed():
 
3796
            if tree.has_changes():
3453
3797
                raise errors.UncommittedChanges(tree)
3454
3798
 
3455
3799
        view_info = _get_view_info_for_change_reporter(tree)
3456
3800
        change_reporter = delta._ChangeReporter(
3457
3801
            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.')
 
3802
        pb = ui.ui_factory.nested_progress_bar()
 
3803
        self.add_cleanup(pb.finished)
 
3804
        self.add_cleanup(tree.lock_write().unlock)
 
3805
        if location is not None:
 
3806
            try:
 
3807
                mergeable = bundle.read_mergeable_from_url(location,
 
3808
                    possible_transports=possible_transports)
 
3809
            except errors.NotABundle:
 
3810
                mergeable = None
 
3811
            else:
 
3812
                if uncommitted:
 
3813
                    raise errors.BzrCommandError('Cannot use --uncommitted'
 
3814
                        ' with bundles or merge directives.')
 
3815
 
 
3816
                if revision is not None:
 
3817
                    raise errors.BzrCommandError(
 
3818
                        'Cannot use -r with merge directives or bundles')
 
3819
                merger, verified = _mod_merge.Merger.from_mergeable(tree,
 
3820
                   mergeable, None)
 
3821
 
 
3822
        if merger is None and uncommitted:
 
3823
            if revision is not None and len(revision) > 0:
 
3824
                raise errors.BzrCommandError('Cannot use --uncommitted and'
 
3825
                    ' --revision at the same time.')
 
3826
            merger = self.get_merger_from_uncommitted(tree, location, None)
 
3827
            allow_pending = False
 
3828
 
 
3829
        if merger is None:
 
3830
            merger, allow_pending = self._get_merger_from_branch(tree,
 
3831
                location, revision, remember, possible_transports, None)
 
3832
 
 
3833
        merger.merge_type = merge_type
 
3834
        merger.reprocess = reprocess
 
3835
        merger.show_base = show_base
 
3836
        self.sanity_check_merger(merger)
 
3837
        if (merger.base_rev_id == merger.other_rev_id and
 
3838
            merger.other_rev_id is not None):
 
3839
            note('Nothing to do.')
 
3840
            return 0
 
3841
        if pull:
 
3842
            if merger.interesting_files is not None:
 
3843
                raise errors.BzrCommandError('Cannot pull individual files')
 
3844
            if (merger.base_rev_id == tree.last_revision()):
 
3845
                result = tree.pull(merger.other_branch, False,
 
3846
                                   merger.other_rev_id)
 
3847
                result.report(self.outf)
3504
3848
                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()
 
3849
        if merger.this_basis is None:
 
3850
            raise errors.BzrCommandError(
 
3851
                "This branch has no commits."
 
3852
                " (perhaps you would prefer 'bzr pull')")
 
3853
        if preview:
 
3854
            return self._do_preview(merger)
 
3855
        elif interactive:
 
3856
            return self._do_interactive(merger)
 
3857
        else:
 
3858
            return self._do_merge(merger, change_reporter, allow_pending,
 
3859
                                  verified)
 
3860
 
 
3861
    def _get_preview(self, merger):
 
3862
        tree_merger = merger.make_merger()
 
3863
        tt = tree_merger.make_preview_transform()
 
3864
        self.add_cleanup(tt.finalize)
 
3865
        result_tree = tt.get_preview_tree()
 
3866
        return result_tree
3522
3867
 
3523
3868
    def _do_preview(self, merger):
3524
3869
        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()
 
3870
        result_tree = self._get_preview(merger)
 
3871
        path_encoding = osutils.get_diff_header_encoding()
 
3872
        show_diff_trees(merger.this_tree, result_tree, self.outf,
 
3873
                        old_label='', new_label='',
 
3874
                        path_encoding=path_encoding)
3533
3875
 
3534
3876
    def _do_merge(self, merger, change_reporter, allow_pending, verified):
3535
3877
        merger.change_reporter = change_reporter
3543
3885
        else:
3544
3886
            return 0
3545
3887
 
 
3888
    def _do_interactive(self, merger):
 
3889
        """Perform an interactive merge.
 
3890
 
 
3891
        This works by generating a preview tree of the merge, then using
 
3892
        Shelver to selectively remove the differences between the working tree
 
3893
        and the preview tree.
 
3894
        """
 
3895
        from bzrlib import shelf_ui
 
3896
        result_tree = self._get_preview(merger)
 
3897
        writer = bzrlib.option.diff_writer_registry.get()
 
3898
        shelver = shelf_ui.Shelver(merger.this_tree, result_tree, destroy=True,
 
3899
                                   reporter=shelf_ui.ApplyReporter(),
 
3900
                                   diff_writer=writer(sys.stdout))
 
3901
        try:
 
3902
            shelver.run()
 
3903
        finally:
 
3904
            shelver.finalize()
 
3905
 
3546
3906
    def sanity_check_merger(self, merger):
3547
3907
        if (merger.show_base and
3548
3908
            not merger.merge_type is _mod_merge.Merge3Merger):
3583
3943
            base_branch, base_path = Branch.open_containing(base_loc,
3584
3944
                possible_transports)
3585
3945
        # Find the revision ids
3586
 
        if revision is None or len(revision) < 1 or revision[-1] is None:
 
3946
        other_revision_id = None
 
3947
        base_revision_id = None
 
3948
        if revision is not None:
 
3949
            if len(revision) >= 1:
 
3950
                other_revision_id = revision[-1].as_revision_id(other_branch)
 
3951
            if len(revision) == 2:
 
3952
                base_revision_id = revision[0].as_revision_id(base_branch)
 
3953
        if other_revision_id is None:
3587
3954
            other_revision_id = _mod_revision.ensure_null(
3588
3955
                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
3956
        # Remember where we merge from
3597
3957
        if ((remember or tree.branch.get_submit_branch() is None) and
3598
3958
             user_location is not None):
3607
3967
            allow_pending = True
3608
3968
        return merger, allow_pending
3609
3969
 
 
3970
    def get_merger_from_uncommitted(self, tree, location, pb):
 
3971
        """Get a merger for uncommitted changes.
 
3972
 
 
3973
        :param tree: The tree the merger should apply to.
 
3974
        :param location: The location containing uncommitted changes.
 
3975
        :param pb: The progress bar to use for showing progress.
 
3976
        """
 
3977
        location = self._select_branch_location(tree, location)[0]
 
3978
        other_tree, other_path = WorkingTree.open_containing(location)
 
3979
        merger = _mod_merge.Merger.from_uncommitted(tree, other_tree, pb)
 
3980
        if other_path != '':
 
3981
            merger.interesting_files = [other_path]
 
3982
        return merger
 
3983
 
3610
3984
    def _select_branch_location(self, tree, user_location, revision=None,
3611
3985
                                index=None):
3612
3986
        """Select a branch location, according to possible inputs.
3656
4030
 
3657
4031
 
3658
4032
class cmd_remerge(Command):
3659
 
    """Redo a merge.
 
4033
    __doc__ = """Redo a merge.
3660
4034
 
3661
4035
    Use this if you want to try a different merge technique while resolving
3662
4036
    conflicts.  Some merge techniques are better than others, and remerge
3687
4061
 
3688
4062
    def run(self, file_list=None, merge_type=None, show_base=False,
3689
4063
            reprocess=False):
 
4064
        from bzrlib.conflicts import restore
3690
4065
        if merge_type is None:
3691
4066
            merge_type = _mod_merge.Merge3Merger
3692
 
        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
 
4067
        tree, file_list = WorkingTree.open_containing_paths(file_list)
 
4068
        self.add_cleanup(tree.lock_write().unlock)
 
4069
        parents = tree.get_parent_ids()
 
4070
        if len(parents) != 2:
 
4071
            raise errors.BzrCommandError("Sorry, remerge only works after normal"
 
4072
                                         " merges.  Not cherrypicking or"
 
4073
                                         " multi-merges.")
 
4074
        repository = tree.branch.repository
 
4075
        interesting_ids = None
 
4076
        new_conflicts = []
 
4077
        conflicts = tree.conflicts()
 
4078
        if file_list is not None:
 
4079
            interesting_ids = set()
 
4080
            for filename in file_list:
 
4081
                file_id = tree.path2id(filename)
 
4082
                if file_id is None:
 
4083
                    raise errors.NotVersionedError(filename)
 
4084
                interesting_ids.add(file_id)
 
4085
                if tree.kind(file_id) != "directory":
 
4086
                    continue
3713
4087
 
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])
 
4088
                for name, ie in tree.inventory.iter_entries(file_id):
 
4089
                    interesting_ids.add(ie.file_id)
 
4090
            new_conflicts = conflicts.select_conflicts(tree, file_list)[0]
 
4091
        else:
 
4092
            # Remerge only supports resolving contents conflicts
 
4093
            allowed_conflicts = ('text conflict', 'contents conflict')
 
4094
            restore_files = [c.path for c in conflicts
 
4095
                             if c.typestring in allowed_conflicts]
 
4096
        _mod_merge.transform_tree(tree, tree.basis_tree(), interesting_ids)
 
4097
        tree.set_conflicts(ConflictList(new_conflicts))
 
4098
        if file_list is not None:
 
4099
            restore_files = file_list
 
4100
        for filename in restore_files:
3738
4101
            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()
 
4102
                restore(tree.abspath(filename))
 
4103
            except errors.NotConflicted:
 
4104
                pass
 
4105
        # Disable pending merges, because the file texts we are remerging
 
4106
        # have not had those merges performed.  If we use the wrong parents
 
4107
        # list, we imply that the working tree text has seen and rejected
 
4108
        # all the changes from the other tree, when in fact those changes
 
4109
        # have not yet been seen.
 
4110
        tree.set_parent_ids(parents[:1])
 
4111
        try:
 
4112
            merger = _mod_merge.Merger.from_revision_ids(None, tree, parents[1])
 
4113
            merger.interesting_ids = interesting_ids
 
4114
            merger.merge_type = merge_type
 
4115
            merger.show_base = show_base
 
4116
            merger.reprocess = reprocess
 
4117
            conflicts = merger.do_merge()
3749
4118
        finally:
3750
 
            tree.unlock()
 
4119
            tree.set_parent_ids(parents)
3751
4120
        if conflicts > 0:
3752
4121
            return 1
3753
4122
        else:
3755
4124
 
3756
4125
 
3757
4126
class cmd_revert(Command):
3758
 
    """Revert files to a previous revision.
 
4127
    __doc__ = """Revert files to a previous revision.
3759
4128
 
3760
4129
    Giving a list of files will revert only those files.  Otherwise, all files
3761
4130
    will be reverted.  If the revision is not specified with '--revision', the
3775
4144
    name.  If you name a directory, all the contents of that directory will be
3776
4145
    reverted.
3777
4146
 
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.
 
4147
    If you have newly added files since the target revision, they will be
 
4148
    removed.  If the files to be removed have been changed, backups will be
 
4149
    created as above.  Directories containing unknown files will not be
 
4150
    deleted.
3781
4151
 
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
 
4152
    The working tree contains a list of revisions that have been merged but
 
4153
    not yet committed. These revisions will be included as additional parents
 
4154
    of the next commit.  Normally, using revert clears that list as well as
 
4155
    reverting the files.  If any files are specified, revert leaves the list
 
4156
    of uncommitted merges alone and reverts only the files.  Use ``bzr revert
 
4157
    .`` in the tree root to revert all files but keep the recorded merges,
 
4158
    and ``bzr revert --forget-merges`` to clear the pending merge list without
3788
4159
    reverting any files.
 
4160
 
 
4161
    Using "bzr revert --forget-merges", it is possible to apply all of the
 
4162
    changes from a branch in a single revision.  To do this, perform the merge
 
4163
    as desired.  Then doing revert with the "--forget-merges" option will keep
 
4164
    the content of the tree as it was, but it will clear the list of pending
 
4165
    merges.  The next commit will then contain all of the changes that are
 
4166
    present in the other branch, but without any other parent revisions.
 
4167
    Because this technique forgets where these changes originated, it may
 
4168
    cause additional conflicts on later merges involving the same source and
 
4169
    target branches.
3789
4170
    """
3790
4171
 
3791
4172
    _see_also = ['cat', 'export']
3799
4180
 
3800
4181
    def run(self, revision=None, no_backup=False, file_list=None,
3801
4182
            forget_merges=None):
3802
 
        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()
 
4183
        tree, file_list = WorkingTree.open_containing_paths(file_list)
 
4184
        self.add_cleanup(tree.lock_tree_write().unlock)
 
4185
        if forget_merges:
 
4186
            tree.set_parent_ids(tree.get_parent_ids()[:1])
 
4187
        else:
 
4188
            self._revert_tree_to_revision(tree, revision, file_list, no_backup)
3811
4189
 
3812
4190
    @staticmethod
3813
4191
    def _revert_tree_to_revision(tree, revision, file_list, no_backup):
3814
4192
        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()
 
4193
        tree.revert(file_list, rev_tree, not no_backup, None,
 
4194
            report_changes=True)
3821
4195
 
3822
4196
 
3823
4197
class cmd_assert_fail(Command):
3824
 
    """Test reporting of assertion failures"""
 
4198
    __doc__ = """Test reporting of assertion failures"""
3825
4199
    # intended just for use in testing
3826
4200
 
3827
4201
    hidden = True
3831
4205
 
3832
4206
 
3833
4207
class cmd_help(Command):
3834
 
    """Show help on a command or other topic.
 
4208
    __doc__ = """Show help on a command or other topic.
3835
4209
    """
3836
4210
 
3837
4211
    _see_also = ['topics']
3850
4224
 
3851
4225
 
3852
4226
class cmd_shell_complete(Command):
3853
 
    """Show appropriate completions for context.
 
4227
    __doc__ = """Show appropriate completions for context.
3854
4228
 
3855
4229
    For a list of all available commands, say 'bzr shell-complete'.
3856
4230
    """
3865
4239
 
3866
4240
 
3867
4241
class cmd_missing(Command):
3868
 
    """Show unmerged/unpulled revisions between two branches.
 
4242
    __doc__ = """Show unmerged/unpulled revisions between two branches.
3869
4243
 
3870
4244
    OTHER_BRANCH may be local or remote.
3871
4245
 
3872
4246
    To filter on a range of revisions, you can use the command -r begin..end
3873
4247
    -r revision requests a specific revision, -r ..end or -r begin.. are
3874
4248
    also valid.
 
4249
            
 
4250
    :Exit values:
 
4251
        1 - some missing revisions
 
4252
        0 - no missing revisions
3875
4253
 
3876
4254
    :Examples:
3877
4255
 
3898
4276
    _see_also = ['merge', 'pull']
3899
4277
    takes_args = ['other_branch?']
3900
4278
    takes_options = [
 
4279
        'directory',
3901
4280
        Option('reverse', 'Reverse the order of revisions.'),
3902
4281
        Option('mine-only',
3903
4282
               'Display changes in the local branch only.'),
3915
4294
            type=_parse_revision_str,
3916
4295
            help='Filter on local branch revisions (inclusive). '
3917
4296
                'See "help revisionspec" for details.'),
3918
 
        Option('include-merges', 'Show merged revisions.'),
 
4297
        Option('include-merges',
 
4298
               'Show all revisions in addition to the mainline ones.'),
3919
4299
        ]
3920
4300
    encoding_type = 'replace'
3921
4301
 
3924
4304
            theirs_only=False,
3925
4305
            log_format=None, long=False, short=False, line=False,
3926
4306
            show_ids=False, verbose=False, this=False, other=False,
3927
 
            include_merges=False, revision=None, my_revision=None):
 
4307
            include_merges=False, revision=None, my_revision=None,
 
4308
            directory=u'.'):
3928
4309
        from bzrlib.missing import find_unmerged, iter_log_revisions
3929
4310
        def message(s):
3930
4311
            if not is_quiet():
3943
4324
        elif theirs_only:
3944
4325
            restrict = 'remote'
3945
4326
 
3946
 
        local_branch = Branch.open_containing(u".")[0]
 
4327
        local_branch = Branch.open_containing(directory)[0]
 
4328
        self.add_cleanup(local_branch.lock_read().unlock)
 
4329
 
3947
4330
        parent = local_branch.get_parent()
3948
4331
        if other_branch is None:
3949
4332
            other_branch = parent
3958
4341
        remote_branch = Branch.open(other_branch)
3959
4342
        if remote_branch.base == local_branch.base:
3960
4343
            remote_branch = local_branch
 
4344
        else:
 
4345
            self.add_cleanup(remote_branch.lock_read().unlock)
3961
4346
 
3962
4347
        local_revid_range = _revision_range_to_revid_range(
3963
4348
            _get_revision_range(my_revision, local_branch,
3967
4352
            _get_revision_range(revision,
3968
4353
                remote_branch, self.name()))
3969
4354
 
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()
 
4355
        local_extra, remote_extra = find_unmerged(
 
4356
            local_branch, remote_branch, restrict,
 
4357
            backward=not reverse,
 
4358
            include_merges=include_merges,
 
4359
            local_revid_range=local_revid_range,
 
4360
            remote_revid_range=remote_revid_range)
 
4361
 
 
4362
        if log_format is None:
 
4363
            registry = log.log_formatter_registry
 
4364
            log_format = registry.get_default(local_branch)
 
4365
        lf = log_format(to_file=self.outf,
 
4366
                        show_ids=show_ids,
 
4367
                        show_timezone='original')
 
4368
 
 
4369
        status_code = 0
 
4370
        if local_extra and not theirs_only:
 
4371
            message("You have %d extra revision(s):\n" %
 
4372
                len(local_extra))
 
4373
            for revision in iter_log_revisions(local_extra,
 
4374
                                local_branch.repository,
 
4375
                                verbose):
 
4376
                lf.log_revision(revision)
 
4377
            printed_local = True
 
4378
            status_code = 1
 
4379
        else:
 
4380
            printed_local = False
 
4381
 
 
4382
        if remote_extra and not mine_only:
 
4383
            if printed_local is True:
 
4384
                message("\n\n\n")
 
4385
            message("You are missing %d revision(s):\n" %
 
4386
                len(remote_extra))
 
4387
            for revision in iter_log_revisions(remote_extra,
 
4388
                                remote_branch.repository,
 
4389
                                verbose):
 
4390
                lf.log_revision(revision)
 
4391
            status_code = 1
 
4392
 
 
4393
        if mine_only and not local_extra:
 
4394
            # We checked local, and found nothing extra
 
4395
            message('This branch is up to date.\n')
 
4396
        elif theirs_only and not remote_extra:
 
4397
            # We checked remote, and found nothing extra
 
4398
            message('Other branch is up to date.\n')
 
4399
        elif not (mine_only or theirs_only or local_extra or
 
4400
                  remote_extra):
 
4401
            # We checked both branches, and neither one had extra
 
4402
            # revisions
 
4403
            message("Branches are up to date.\n")
 
4404
        self.cleanup_now()
4027
4405
        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()
 
4406
            self.add_cleanup(local_branch.lock_write().unlock)
 
4407
            # handle race conditions - a parent might be set while we run.
 
4408
            if local_branch.get_parent() is None:
 
4409
                local_branch.set_parent(remote_branch.base)
4035
4410
        return status_code
4036
4411
 
4037
4412
 
4038
4413
class cmd_pack(Command):
4039
 
    """Compress the data within a repository."""
 
4414
    __doc__ = """Compress the data within a repository.
 
4415
 
 
4416
    This operation compresses the data within a bazaar repository. As
 
4417
    bazaar supports automatic packing of repository, this operation is
 
4418
    normally not required to be done manually.
 
4419
 
 
4420
    During the pack operation, bazaar takes a backup of existing repository
 
4421
    data, i.e. pack files. This backup is eventually removed by bazaar
 
4422
    automatically when it is safe to do so. To save disk space by removing
 
4423
    the backed up pack files, the --clean-obsolete-packs option may be
 
4424
    used.
 
4425
 
 
4426
    Warning: If you use --clean-obsolete-packs and your machine crashes
 
4427
    during or immediately after repacking, you may be left with a state
 
4428
    where the deletion has been written to disk but the new packs have not
 
4429
    been. In this case the repository may be unusable.
 
4430
    """
4040
4431
 
4041
4432
    _see_also = ['repositories']
4042
4433
    takes_args = ['branch_or_repo?']
 
4434
    takes_options = [
 
4435
        Option('clean-obsolete-packs', 'Delete obsolete packs to save disk space.'),
 
4436
        ]
4043
4437
 
4044
 
    def run(self, branch_or_repo='.'):
 
4438
    def run(self, branch_or_repo='.', clean_obsolete_packs=False):
4045
4439
        dir = bzrdir.BzrDir.open_containing(branch_or_repo)[0]
4046
4440
        try:
4047
4441
            branch = dir.open_branch()
4048
4442
            repository = branch.repository
4049
4443
        except errors.NotBranchError:
4050
4444
            repository = dir.open_repository()
4051
 
        repository.pack()
 
4445
        repository.pack(clean_obsolete_packs=clean_obsolete_packs)
4052
4446
 
4053
4447
 
4054
4448
class cmd_plugins(Command):
4055
 
    """List the installed plugins.
 
4449
    __doc__ = """List the installed plugins.
4056
4450
 
4057
4451
    This command displays the list of installed plugins including
4058
4452
    version of plugin and a short description of each.
4065
4459
    adding new commands, providing additional network transports and
4066
4460
    customizing log output.
4067
4461
 
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.
 
4462
    See the Bazaar Plugin Guide <http://doc.bazaar.canonical.com/plugins/en/>
 
4463
    for further information on plugins including where to find them and how to
 
4464
    install them. Instructions are also provided there on how to write new
 
4465
    plugins using the Python programming language.
4072
4466
    """
4073
4467
    takes_options = ['verbose']
4074
4468
 
4089
4483
                doc = '(no description)'
4090
4484
            result.append((name_ver, doc, plugin.path()))
4091
4485
        for name_ver, doc, path in sorted(result):
4092
 
            print name_ver
4093
 
            print '   ', doc
 
4486
            self.outf.write("%s\n" % name_ver)
 
4487
            self.outf.write("   %s\n" % doc)
4094
4488
            if verbose:
4095
 
                print '   ', path
4096
 
            print
 
4489
                self.outf.write("   %s\n" % path)
 
4490
            self.outf.write("\n")
4097
4491
 
4098
4492
 
4099
4493
class cmd_testament(Command):
4100
 
    """Show testament (signing-form) of a revision."""
 
4494
    __doc__ = """Show testament (signing-form) of a revision."""
4101
4495
    takes_options = [
4102
4496
            'revision',
4103
4497
            Option('long', help='Produce long-format testament.'),
4115
4509
            b = Branch.open_containing(branch)[0]
4116
4510
        else:
4117
4511
            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()
 
4512
        self.add_cleanup(b.lock_read().unlock)
 
4513
        if revision is None:
 
4514
            rev_id = b.last_revision()
 
4515
        else:
 
4516
            rev_id = revision[0].as_revision_id(b)
 
4517
        t = testament_class.from_revision(b.repository, rev_id)
 
4518
        if long:
 
4519
            sys.stdout.writelines(t.as_text_lines())
 
4520
        else:
 
4521
            sys.stdout.write(t.as_short_text())
4131
4522
 
4132
4523
 
4133
4524
class cmd_annotate(Command):
4134
 
    """Show the origin of each line in a file.
 
4525
    __doc__ = """Show the origin of each line in a file.
4135
4526
 
4136
4527
    This prints out the given file with an annotation on the left side
4137
4528
    indicating which revision, author and date introduced the change.
4148
4539
                     Option('long', help='Show commit date in annotations.'),
4149
4540
                     'revision',
4150
4541
                     'show-ids',
 
4542
                     'directory',
4151
4543
                     ]
4152
4544
    encoding_type = 'exact'
4153
4545
 
4154
4546
    @display_command
4155
4547
    def run(self, filename, all=False, long=False, revision=None,
4156
 
            show_ids=False):
 
4548
            show_ids=False, directory=None):
4157
4549
        from bzrlib.annotate import annotate_file, annotate_file_tree
4158
4550
        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()
 
4551
            _open_directory_or_containing_tree_or_branch(filename, directory)
 
4552
        if wt is not None:
 
4553
            self.add_cleanup(wt.lock_read().unlock)
 
4554
        else:
 
4555
            self.add_cleanup(branch.lock_read().unlock)
 
4556
        tree = _get_one_revision_tree('annotate', revision, branch=branch)
 
4557
        self.add_cleanup(tree.lock_read().unlock)
 
4558
        if wt is not None:
 
4559
            file_id = wt.path2id(relpath)
 
4560
        else:
 
4561
            file_id = tree.path2id(relpath)
 
4562
        if file_id is None:
 
4563
            raise errors.NotVersionedError(filename)
 
4564
        file_version = tree.inventory[file_id].revision
 
4565
        if wt is not None and revision is None:
 
4566
            # If there is a tree and we're not annotating historical
 
4567
            # versions, annotate the working tree's content.
 
4568
            annotate_file_tree(wt, file_id, self.outf, long, all,
 
4569
                show_ids=show_ids)
 
4570
        else:
 
4571
            annotate_file(branch, file_version, file_id, long, all, self.outf,
 
4572
                          show_ids=show_ids)
4186
4573
 
4187
4574
 
4188
4575
class cmd_re_sign(Command):
4189
 
    """Create a digital signature for an existing revision."""
 
4576
    __doc__ = """Create a digital signature for an existing revision."""
4190
4577
    # TODO be able to replace existing ones.
4191
4578
 
4192
4579
    hidden = True # is this right ?
4193
4580
    takes_args = ['revision_id*']
4194
 
    takes_options = ['revision']
 
4581
    takes_options = ['directory', 'revision']
4195
4582
 
4196
 
    def run(self, revision_id_list=None, revision=None):
 
4583
    def run(self, revision_id_list=None, revision=None, directory=u'.'):
4197
4584
        if revision_id_list is not None and revision is not None:
4198
4585
            raise errors.BzrCommandError('You can only supply one of revision_id or --revision')
4199
4586
        if revision_id_list is None and revision is None:
4200
4587
            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()
 
4588
        b = WorkingTree.open_containing(directory)[0].branch
 
4589
        self.add_cleanup(b.lock_write().unlock)
 
4590
        return self._run(b, revision_id_list, revision)
4207
4591
 
4208
4592
    def _run(self, b, revision_id_list, revision):
4209
4593
        import bzrlib.gpg as gpg
4254
4638
 
4255
4639
 
4256
4640
class cmd_bind(Command):
4257
 
    """Convert the current branch into a checkout of the supplied branch.
 
4641
    __doc__ = """Convert the current branch into a checkout of the supplied branch.
 
4642
    If no branch is supplied, rebind to the last bound location.
4258
4643
 
4259
4644
    Once converted into a checkout, commits must succeed on the master branch
4260
4645
    before they will be applied to the local branch.
4261
4646
 
4262
4647
    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
 
4648
    locally, in which case binding will update the local nickname to be
4264
4649
    that of the master.
4265
4650
    """
4266
4651
 
4267
4652
    _see_also = ['checkouts', 'unbind']
4268
4653
    takes_args = ['location?']
4269
 
    takes_options = []
 
4654
    takes_options = ['directory']
4270
4655
 
4271
 
    def run(self, location=None):
4272
 
        b, relpath = Branch.open_containing(u'.')
 
4656
    def run(self, location=None, directory=u'.'):
 
4657
        b, relpath = Branch.open_containing(directory)
4273
4658
        if location is None:
4274
4659
            try:
4275
4660
                location = b.get_old_bound_location()
4278
4663
                    'This format does not remember old locations.')
4279
4664
            else:
4280
4665
                if location is None:
4281
 
                    raise errors.BzrCommandError('No location supplied and no '
4282
 
                        'previous location known')
 
4666
                    if b.get_bound_location() is not None:
 
4667
                        raise errors.BzrCommandError('Branch is already bound')
 
4668
                    else:
 
4669
                        raise errors.BzrCommandError('No location supplied '
 
4670
                            'and no previous location known')
4283
4671
        b_other = Branch.open(location)
4284
4672
        try:
4285
4673
            b.bind(b_other)
4291
4679
 
4292
4680
 
4293
4681
class cmd_unbind(Command):
4294
 
    """Convert the current checkout into a regular branch.
 
4682
    __doc__ = """Convert the current checkout into a regular branch.
4295
4683
 
4296
4684
    After unbinding, the local branch is considered independent and subsequent
4297
4685
    commits will be local only.
4299
4687
 
4300
4688
    _see_also = ['checkouts', 'bind']
4301
4689
    takes_args = []
4302
 
    takes_options = []
 
4690
    takes_options = ['directory']
4303
4691
 
4304
 
    def run(self):
4305
 
        b, relpath = Branch.open_containing(u'.')
 
4692
    def run(self, directory=u'.'):
 
4693
        b, relpath = Branch.open_containing(directory)
4306
4694
        if not b.unbind():
4307
4695
            raise errors.BzrCommandError('Local branch is not bound')
4308
4696
 
4309
4697
 
4310
4698
class cmd_uncommit(Command):
4311
 
    """Remove the last committed revision.
 
4699
    __doc__ = """Remove the last committed revision.
4312
4700
 
4313
4701
    --verbose will print out what is being removed.
4314
4702
    --dry-run will go through all the motions, but not actually
4354
4742
            b = control.open_branch()
4355
4743
 
4356
4744
        if tree is not None:
4357
 
            tree.lock_write()
 
4745
            self.add_cleanup(tree.lock_write().unlock)
4358
4746
        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()
 
4747
            self.add_cleanup(b.lock_write().unlock)
 
4748
        return self._run(b, tree, dry_run, verbose, revision, force, local=local)
4368
4749
 
4369
4750
    def _run(self, b, tree, dry_run, verbose, revision, force, local=False):
4370
4751
        from bzrlib.log import log_formatter, show_log
4402
4783
                 end_revision=last_revno)
4403
4784
 
4404
4785
        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')
 
4786
            self.outf.write('Dry-run, pretending to remove'
 
4787
                            ' the above revisions.\n')
4408
4788
        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
 
4789
            self.outf.write('The above revision(s) will be removed.\n')
 
4790
 
 
4791
        if not force:
 
4792
            if not ui.ui_factory.get_boolean('Are you sure'):
 
4793
                self.outf.write('Canceled')
 
4794
                return 0
4415
4795
 
4416
4796
        mutter('Uncommitting from {%s} to {%s}',
4417
4797
               last_rev_id, rev_id)
4418
4798
        uncommit(b, tree=tree, dry_run=dry_run, verbose=verbose,
4419
4799
                 revno=revno, local=local)
4420
 
        note('You can restore the old tip by running:\n'
4421
 
             '  bzr pull . -r revid:%s', last_rev_id)
 
4800
        self.outf.write('You can restore the old tip by running:\n'
 
4801
             '  bzr pull . -r revid:%s\n' % last_rev_id)
4422
4802
 
4423
4803
 
4424
4804
class cmd_break_lock(Command):
4425
 
    """Break a dead lock on a repository, branch or working directory.
 
4805
    __doc__ = """Break a dead lock on a repository, branch or working directory.
4426
4806
 
4427
4807
    CAUTION: Locks should only be broken when you are sure that the process
4428
4808
    holding the lock has been stopped.
4429
4809
 
4430
 
    You can get information on what locks are open via the 'bzr info' command.
 
4810
    You can get information on what locks are open via the 'bzr info
 
4811
    [location]' command.
4431
4812
 
4432
4813
    :Examples:
4433
4814
        bzr break-lock
 
4815
        bzr break-lock bzr+ssh://example.com/bzr/foo
4434
4816
    """
4435
4817
    takes_args = ['location?']
4436
4818
 
4445
4827
 
4446
4828
 
4447
4829
class cmd_wait_until_signalled(Command):
4448
 
    """Test helper for test_start_and_stop_bzr_subprocess_send_signal.
 
4830
    __doc__ = """Test helper for test_start_and_stop_bzr_subprocess_send_signal.
4449
4831
 
4450
4832
    This just prints a line to signal when it is ready, then blocks on stdin.
4451
4833
    """
4459
4841
 
4460
4842
 
4461
4843
class cmd_serve(Command):
4462
 
    """Run the bzr server."""
 
4844
    __doc__ = """Run the bzr server."""
4463
4845
 
4464
4846
    aliases = ['server']
4465
4847
 
4466
4848
    takes_options = [
4467
4849
        Option('inet',
4468
4850
               help='Serve on stdin/out for use from inetd or sshd.'),
 
4851
        RegistryOption('protocol',
 
4852
               help="Protocol to serve.",
 
4853
               lazy_registry=('bzrlib.transport', 'transport_server_registry'),
 
4854
               value_switches=True),
4469
4855
        Option('port',
4470
4856
               help='Listen for connections on nominated port of the form '
4471
4857
                    '[hostname:]portnumber.  Passing 0 as the port number will '
4472
 
                    'result in a dynamically allocated port.  The default port is '
4473
 
                    '4155.',
 
4858
                    'result in a dynamically allocated port.  The default port '
 
4859
                    'depends on the protocol.',
4474
4860
               type=str),
4475
 
        Option('directory',
4476
 
               help='Serve contents of this directory.',
4477
 
               type=unicode),
 
4861
        custom_help('directory',
 
4862
               help='Serve contents of this directory.'),
4478
4863
        Option('allow-writes',
4479
4864
               help='By default the server is a readonly server.  Supplying '
4480
4865
                    '--allow-writes enables write access to the contents of '
4481
 
                    'the served directory and below.'
 
4866
                    'the served directory and below.  Note that ``bzr serve`` '
 
4867
                    'does not perform authentication, so unless some form of '
 
4868
                    'external authentication is arranged supplying this '
 
4869
                    'option leads to global uncontrolled write access to your '
 
4870
                    'file system.'
4482
4871
                ),
4483
4872
        ]
4484
4873
 
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
4874
    def get_host_and_port(self, port):
4503
4875
        """Return the host and port to run the smart server on.
4504
4876
 
4505
 
        If 'port' is None, the default host (`medium.BZR_DEFAULT_INTERFACE`)
4506
 
        and port (`medium.BZR_DEFAULT_PORT`) will be used.
 
4877
        If 'port' is None, None will be returned for the host and port.
4507
4878
 
4508
4879
        If 'port' has a colon in it, the string before the colon will be
4509
4880
        interpreted as the host.
4512
4883
        :return: A tuple of (host, port), where 'host' is a host name or IP,
4513
4884
            and port is an integer TCP/IP port.
4514
4885
        """
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:
 
4886
        host = None
 
4887
        if port is not None:
4520
4888
            if ':' in port:
4521
4889
                host, port = port.split(':')
4522
4890
            port = int(port)
4523
4891
        return host, port
4524
4892
 
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
 
4893
    def run(self, port=None, inet=False, directory=None, allow_writes=False,
 
4894
            protocol=None):
 
4895
        from bzrlib import transport
4551
4896
        if directory is None:
4552
4897
            directory = os.getcwd()
 
4898
        if protocol is None:
 
4899
            protocol = transport.transport_server_registry.get()
 
4900
        host, port = self.get_host_and_port(port)
4553
4901
        url = urlutils.local_path_to_url(directory)
4554
4902
        if not allow_writes:
4555
4903
            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)
 
4904
        t = transport.get_transport(url)
 
4905
        protocol(t, host, port, inet)
4561
4906
 
4562
4907
 
4563
4908
class cmd_join(Command):
4564
 
    """Combine a subtree into its containing tree.
 
4909
    __doc__ = """Combine a tree into its containing tree.
4565
4910
 
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.
 
4911
    This command requires the target tree to be in a rich-root format.
4569
4912
 
4570
4913
    The TREE argument should be an independent tree, inside another tree, but
4571
4914
    not part of it.  (Such trees can be produced by "bzr split", but also by
4574
4917
    The result is a combined tree, with the subtree no longer an independant
4575
4918
    part.  This is marked as a merge of the subtree into the containing tree,
4576
4919
    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
4920
    """
4583
4921
 
4584
4922
    _see_also = ['split']
4585
4923
    takes_args = ['tree']
4586
4924
    takes_options = [
4587
 
            Option('reference', help='Join by reference.'),
 
4925
            Option('reference', help='Join by reference.', hidden=True),
4588
4926
            ]
4589
 
    hidden = True
4590
4927
 
4591
4928
    def run(self, tree, reference=False):
4592
4929
        sub_tree = WorkingTree.open(tree)
4615
4952
 
4616
4953
 
4617
4954
class cmd_split(Command):
4618
 
    """Split a subdirectory of a tree into a separate tree.
 
4955
    __doc__ = """Split a subdirectory of a tree into a separate tree.
4619
4956
 
4620
4957
    This command will produce a target tree in a format that supports
4621
4958
    rich roots, like 'rich-root' or 'rich-root-pack'.  These formats cannot be
4626
4963
    branch.  Commits in the top-level tree will not apply to the new subtree.
4627
4964
    """
4628
4965
 
4629
 
    # join is not un-hidden yet
4630
 
    #_see_also = ['join']
 
4966
    _see_also = ['join']
4631
4967
    takes_args = ['tree']
4632
4968
 
4633
4969
    def run(self, tree):
4638
4974
        try:
4639
4975
            containing_tree.extract(sub_id)
4640
4976
        except errors.RootNotRich:
4641
 
            raise errors.UpgradeRequired(containing_tree.branch.base)
 
4977
            raise errors.RichRootUpgradeRequired(containing_tree.branch.base)
4642
4978
 
4643
4979
 
4644
4980
class cmd_merge_directive(Command):
4645
 
    """Generate a merge directive for auto-merge tools.
 
4981
    __doc__ = """Generate a merge directive for auto-merge tools.
4646
4982
 
4647
4983
    A directive requests a merge to be performed, and also provides all the
4648
4984
    information necessary to do so.  This means it must either include a
4665
5001
    _see_also = ['send']
4666
5002
 
4667
5003
    takes_options = [
 
5004
        'directory',
4668
5005
        RegistryOption.from_kwargs('patch-type',
4669
5006
            'The type of patch to include in the directive.',
4670
5007
            title='Patch type',
4683
5020
    encoding_type = 'exact'
4684
5021
 
4685
5022
    def run(self, submit_branch=None, public_branch=None, patch_type='bundle',
4686
 
            sign=False, revision=None, mail_to=None, message=None):
 
5023
            sign=False, revision=None, mail_to=None, message=None,
 
5024
            directory=u'.'):
4687
5025
        from bzrlib.revision import ensure_null, NULL_REVISION
4688
5026
        include_patch, include_bundle = {
4689
5027
            'plain': (False, False),
4690
5028
            'diff': (True, False),
4691
5029
            'bundle': (True, True),
4692
5030
            }[patch_type]
4693
 
        branch = Branch.open('.')
 
5031
        branch = Branch.open(directory)
4694
5032
        stored_submit_branch = branch.get_submit_branch()
4695
5033
        if submit_branch is None:
4696
5034
            submit_branch = stored_submit_branch
4741
5079
 
4742
5080
 
4743
5081
class cmd_send(Command):
4744
 
    """Mail or create a merge-directive for submitting changes.
 
5082
    __doc__ = """Mail or create a merge-directive for submitting changes.
4745
5083
 
4746
5084
    A merge directive provides many things needed for requesting merges:
4747
5085
 
4753
5091
      directly from the merge directive, without retrieving data from a
4754
5092
      branch.
4755
5093
 
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.
 
5094
    `bzr send` creates a compact data set that, when applied using bzr
 
5095
    merge, has the same effect as merging from the source branch.  
 
5096
    
 
5097
    By default the merge directive is self-contained and can be applied to any
 
5098
    branch containing submit_branch in its ancestory without needing access to
 
5099
    the source branch.
 
5100
    
 
5101
    If --no-bundle is specified, then Bazaar doesn't send the contents of the
 
5102
    revisions, but only a structured request to merge from the
 
5103
    public_location.  In that case the public_branch is needed and it must be
 
5104
    up-to-date and accessible to the recipient.  The public_branch is always
 
5105
    included if known, so that people can check it later.
 
5106
 
 
5107
    The submit branch defaults to the parent of the source branch, but can be
 
5108
    overridden.  Both submit branch and public branch will be remembered in
 
5109
    branch.conf the first time they are used for a particular branch.  The
 
5110
    source branch defaults to that containing the working directory, but can
 
5111
    be changed using --from.
 
5112
 
 
5113
    In order to calculate those changes, bzr must analyse the submit branch.
 
5114
    Therefore it is most efficient for the submit branch to be a local mirror.
 
5115
    If a public location is known for the submit_branch, that location is used
 
5116
    in the merge directive.
 
5117
 
 
5118
    The default behaviour is to send the merge directive by mail, unless -o is
 
5119
    given, in which case it is sent to a file.
4768
5120
 
4769
5121
    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.
 
5122
    on Windows (it uses MAPI).  On Unix, it requires the xdg-email utility.
4771
5123
    If the preferred client can't be found (or used), your editor will be used.
4772
5124
 
4773
5125
    To use a specific mail program, set the mail_client configuration option.
4774
5126
    (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.
 
5127
    specific clients are "claws", "evolution", "kmail", "mail.app" (MacOS X's
 
5128
    Mail.app), "mutt", and "thunderbird"; generic options are "default",
 
5129
    "editor", "emacsclient", "mapi", and "xdg-email".  Plugins may also add
 
5130
    supported clients.
4778
5131
 
4779
5132
    If mail is being sent, a to address is required.  This can be supplied
4780
5133
    either on the commandline, by setting the submit_to configuration
4789
5142
 
4790
5143
    The merge directives created by bzr send may be applied using bzr merge or
4791
5144
    bzr pull by specifying a file containing a merge directive as the location.
 
5145
 
 
5146
    bzr send makes extensive use of public locations to map local locations into
 
5147
    URLs that can be used by other people.  See `bzr help configuration` to
 
5148
    set them, and use `bzr info` to display them.
4792
5149
    """
4793
5150
 
4794
5151
    encoding_type = 'exact'
4810
5167
               short_name='f',
4811
5168
               type=unicode),
4812
5169
        Option('output', short_name='o',
4813
 
               help='Write merge directive to this file; '
 
5170
               help='Write merge directive to this file or directory; '
4814
5171
                    'use - for stdout.',
4815
5172
               type=unicode),
 
5173
        Option('strict',
 
5174
               help='Refuse to send if there are uncommitted changes in'
 
5175
               ' the working tree, --no-strict disables the check.'),
4816
5176
        Option('mail-to', help='Mail the request to this address.',
4817
5177
               type=unicode),
4818
5178
        'revision',
4819
5179
        'message',
4820
5180
        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',})
 
5181
        RegistryOption('format',
 
5182
                       help='Use the specified output format.',
 
5183
                       lazy_registry=('bzrlib.send', 'format_registry')),
4825
5184
        ]
4826
5185
 
4827
5186
    def run(self, submit_branch=None, public_branch=None, no_bundle=False,
4828
5187
            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()
 
5188
            format=None, mail_to=None, message=None, body=None,
 
5189
            strict=None, **kwargs):
 
5190
        from bzrlib.send import send
 
5191
        return send(submit_branch, revision, public_branch, remember,
 
5192
                    format, no_bundle, no_patch, output,
 
5193
                    kwargs.get('from', '.'), mail_to, message, body,
 
5194
                    self.outf,
 
5195
                    strict=strict)
4946
5196
 
4947
5197
 
4948
5198
class cmd_bundle_revisions(cmd_send):
4949
 
 
4950
 
    """Create a merge-directive for submitting changes.
 
5199
    __doc__ = """Create a merge-directive for submitting changes.
4951
5200
 
4952
5201
    A merge directive provides many things needed for requesting merges:
4953
5202
 
4993
5242
               type=unicode),
4994
5243
        Option('output', short_name='o', help='Write directive to this file.',
4995
5244
               type=unicode),
 
5245
        Option('strict',
 
5246
               help='Refuse to bundle revisions if there are uncommitted'
 
5247
               ' changes in the working tree, --no-strict disables the check.'),
4996
5248
        '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',})
 
5249
        RegistryOption('format',
 
5250
                       help='Use the specified output format.',
 
5251
                       lazy_registry=('bzrlib.send', 'format_registry')),
5001
5252
        ]
5002
5253
    aliases = ['bundle']
5003
5254
 
5007
5258
 
5008
5259
    def run(self, submit_branch=None, public_branch=None, no_bundle=False,
5009
5260
            no_patch=False, revision=None, remember=False, output=None,
5010
 
            format='4', **kwargs):
 
5261
            format=None, strict=None, **kwargs):
5011
5262
        if output is None:
5012
5263
            output = '-'
5013
 
        return self._run(submit_branch, revision, public_branch, remember,
 
5264
        from bzrlib.send import send
 
5265
        return send(submit_branch, revision, public_branch, remember,
5014
5266
                         format, no_bundle, no_patch, output,
5015
 
                         kwargs.get('from', '.'), None, None, None)
 
5267
                         kwargs.get('from', '.'), None, None, None,
 
5268
                         self.outf, strict=strict)
5016
5269
 
5017
5270
 
5018
5271
class cmd_tag(Command):
5019
 
    """Create, remove or modify a tag naming a revision.
 
5272
    __doc__ = """Create, remove or modify a tag naming a revision.
5020
5273
 
5021
5274
    Tags give human-meaningful names to revisions.  Commands that take a -r
5022
5275
    (--revision) option can be given -rtag:X, where X is any previously
5030
5283
 
5031
5284
    To rename a tag (change the name but keep it on the same revsion), run ``bzr
5032
5285
    tag new-name -r tag:old-name`` and then ``bzr tag --delete oldname``.
 
5286
 
 
5287
    If no tag name is specified it will be determined through the 
 
5288
    'automatic_tag_name' hook. This can e.g. be used to automatically tag
 
5289
    upstream releases by reading configure.ac. See ``bzr help hooks`` for
 
5290
    details.
5033
5291
    """
5034
5292
 
5035
5293
    _see_also = ['commit', 'tags']
5036
 
    takes_args = ['tag_name']
 
5294
    takes_args = ['tag_name?']
5037
5295
    takes_options = [
5038
5296
        Option('delete',
5039
5297
            help='Delete this tag rather than placing it.',
5040
5298
            ),
5041
 
        Option('directory',
5042
 
            help='Branch in which to place the tag.',
5043
 
            short_name='d',
5044
 
            type=unicode,
5045
 
            ),
 
5299
        custom_help('directory',
 
5300
            help='Branch in which to place the tag.'),
5046
5301
        Option('force',
5047
5302
            help='Replace existing tags.',
5048
5303
            ),
5049
5304
        'revision',
5050
5305
        ]
5051
5306
 
5052
 
    def run(self, tag_name,
 
5307
    def run(self, tag_name=None,
5053
5308
            delete=None,
5054
5309
            directory='.',
5055
5310
            force=None,
5056
5311
            revision=None,
5057
5312
            ):
5058
5313
        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)
 
5314
        self.add_cleanup(branch.lock_write().unlock)
 
5315
        if delete:
 
5316
            if tag_name is None:
 
5317
                raise errors.BzrCommandError("No tag specified to delete.")
 
5318
            branch.tags.delete_tag(tag_name)
 
5319
            self.outf.write('Deleted tag %s.\n' % tag_name)
 
5320
        else:
 
5321
            if revision:
 
5322
                if len(revision) != 1:
 
5323
                    raise errors.BzrCommandError(
 
5324
                        "Tags can only be placed on a single revision, "
 
5325
                        "not on a range")
 
5326
                revision_id = revision[0].as_revision_id(branch)
5064
5327
            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()
 
5328
                revision_id = branch.last_revision()
 
5329
            if tag_name is None:
 
5330
                tag_name = branch.automatic_tag_name(revision_id)
 
5331
                if tag_name is None:
 
5332
                    raise errors.BzrCommandError(
 
5333
                        "Please specify a tag name.")
 
5334
            if (not force) and branch.tags.has_tag(tag_name):
 
5335
                raise errors.TagAlreadyExists(tag_name)
 
5336
            branch.tags.set_tag(tag_name, revision_id)
 
5337
            self.outf.write('Created tag %s.\n' % tag_name)
5079
5338
 
5080
5339
 
5081
5340
class cmd_tags(Command):
5082
 
    """List tags.
 
5341
    __doc__ = """List tags.
5083
5342
 
5084
5343
    This command shows a table of tag names and the revisions they reference.
5085
5344
    """
5086
5345
 
5087
5346
    _see_also = ['tag']
5088
5347
    takes_options = [
5089
 
        Option('directory',
5090
 
            help='Branch whose tags should be displayed.',
5091
 
            short_name='d',
5092
 
            type=unicode,
5093
 
            ),
 
5348
        custom_help('directory',
 
5349
            help='Branch whose tags should be displayed.'),
5094
5350
        RegistryOption.from_kwargs('sort',
5095
5351
            'Sort tags by different criteria.', title='Sorting',
5096
5352
            alpha='Sort tags lexicographically (default).',
5113
5369
        if not tags:
5114
5370
            return
5115
5371
 
 
5372
        self.add_cleanup(branch.lock_read().unlock)
5116
5373
        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()
 
5374
            graph = branch.repository.get_graph()
 
5375
            rev1, rev2 = _get_revision_range(revision, branch, self.name())
 
5376
            revid1, revid2 = rev1.rev_id, rev2.rev_id
 
5377
            # only show revisions between revid1 and revid2 (inclusive)
 
5378
            tags = [(tag, revid) for tag, revid in tags if
 
5379
                graph.is_between(revid, revid1, revid2)]
5127
5380
        if sort == 'alpha':
5128
5381
            tags.sort()
5129
5382
        elif sort == 'time':
5139
5392
            tags.sort(key=lambda x: timestamps[x[1]])
5140
5393
        if not show_ids:
5141
5394
            # [ (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 ]
 
5395
            for index, (tag, revid) in enumerate(tags):
 
5396
                try:
 
5397
                    revno = branch.revision_id_to_dotted_revno(revid)
 
5398
                    if isinstance(revno, tuple):
 
5399
                        revno = '.'.join(map(str, revno))
 
5400
                except errors.NoSuchRevision:
 
5401
                    # Bad tag data/merges can lead to tagged revisions
 
5402
                    # which are not in this branch. Fail gracefully ...
 
5403
                    revno = '?'
 
5404
                tags[index] = (tag, revno)
 
5405
        self.cleanup_now()
5145
5406
        for tag, revspec in tags:
5146
5407
            self.outf.write('%-20s %s\n' % (tag, revspec))
5147
5408
 
5148
5409
 
5149
5410
class cmd_reconfigure(Command):
5150
 
    """Reconfigure the type of a bzr directory.
 
5411
    __doc__ = """Reconfigure the type of a bzr directory.
5151
5412
 
5152
5413
    A target configuration must be specified.
5153
5414
 
5183
5444
            ),
5184
5445
        Option('bind-to', help='Branch to bind checkout to.', type=str),
5185
5446
        Option('force',
5186
 
               help='Perform reconfiguration even if local changes'
5187
 
               ' will be lost.')
 
5447
            help='Perform reconfiguration even if local changes'
 
5448
            ' will be lost.'),
 
5449
        Option('stacked-on',
 
5450
            help='Reconfigure a branch to be stacked on another branch.',
 
5451
            type=unicode,
 
5452
            ),
 
5453
        Option('unstacked',
 
5454
            help='Reconfigure a branch to be unstacked.  This '
 
5455
                'may require copying substantial data into it.',
 
5456
            ),
5188
5457
        ]
5189
5458
 
5190
 
    def run(self, location=None, target_type=None, bind_to=None, force=False):
 
5459
    def run(self, location=None, target_type=None, bind_to=None, force=False,
 
5460
            stacked_on=None,
 
5461
            unstacked=None):
5191
5462
        directory = bzrdir.BzrDir.open(location)
 
5463
        if stacked_on and unstacked:
 
5464
            raise BzrCommandError("Can't use both --stacked-on and --unstacked")
 
5465
        elif stacked_on is not None:
 
5466
            reconfigure.ReconfigureStackedOn().apply(directory, stacked_on)
 
5467
        elif unstacked:
 
5468
            reconfigure.ReconfigureUnstacked().apply(directory)
 
5469
        # At the moment you can use --stacked-on and a different
 
5470
        # reconfiguration shape at the same time; there seems no good reason
 
5471
        # to ban it.
5192
5472
        if target_type is None:
5193
 
            raise errors.BzrCommandError('No target configuration specified')
 
5473
            if stacked_on or unstacked:
 
5474
                return
 
5475
            else:
 
5476
                raise errors.BzrCommandError('No target configuration '
 
5477
                    'specified')
5194
5478
        elif target_type == 'branch':
5195
5479
            reconfiguration = reconfigure.Reconfigure.to_branch(directory)
5196
5480
        elif target_type == 'tree':
5215
5499
 
5216
5500
 
5217
5501
class cmd_switch(Command):
5218
 
    """Set the branch of a checkout and update.
 
5502
    __doc__ = """Set the branch of a checkout and update.
5219
5503
 
5220
5504
    For lightweight checkouts, this changes the branch being referenced.
5221
5505
    For heavyweight checkouts, this checks that there are no local commits
5233
5517
    /path/to/newbranch.
5234
5518
 
5235
5519
    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
 
5520
    locally, in which case switching will update the local nickname to be
5237
5521
    that of the master.
5238
5522
    """
5239
5523
 
5240
 
    takes_args = ['to_location']
5241
 
    takes_options = [Option('force',
5242
 
                        help='Switch even if local commits will be lost.')
5243
 
                     ]
 
5524
    takes_args = ['to_location?']
 
5525
    takes_options = ['directory',
 
5526
                     Option('force',
 
5527
                        help='Switch even if local commits will be lost.'),
 
5528
                     'revision',
 
5529
                     Option('create-branch', short_name='b',
 
5530
                        help='Create the target branch from this one before'
 
5531
                             ' switching to it.'),
 
5532
                    ]
5244
5533
 
5245
 
    def run(self, to_location, force=False):
 
5534
    def run(self, to_location=None, force=False, create_branch=False,
 
5535
            revision=None, directory=u'.'):
5246
5536
        from bzrlib import switch
5247
 
        tree_location = '.'
 
5537
        tree_location = directory
 
5538
        revision = _get_one_revision('switch', revision)
5248
5539
        control_dir = bzrdir.BzrDir.open_containing(tree_location)[0]
5249
 
        branch = control_dir.open_branch()
 
5540
        if to_location is None:
 
5541
            if revision is None:
 
5542
                raise errors.BzrCommandError('You must supply either a'
 
5543
                                             ' revision or a location')
 
5544
            to_location = tree_location
5250
5545
        try:
5251
 
            to_branch = Branch.open(to_location)
 
5546
            branch = control_dir.open_branch()
 
5547
            had_explicit_nick = branch.get_config().has_explicit_nickname()
5252
5548
        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():
 
5549
            branch = None
 
5550
            had_explicit_nick = False
 
5551
        if create_branch:
 
5552
            if branch is None:
 
5553
                raise errors.BzrCommandError('cannot create branch without'
 
5554
                                             ' source branch')
 
5555
            to_location = directory_service.directories.dereference(
 
5556
                              to_location)
 
5557
            if '/' not in to_location and '\\' not in to_location:
 
5558
                # This path is meant to be relative to the existing branch
 
5559
                this_url = self._get_branch_location(control_dir)
 
5560
                to_location = urlutils.join(this_url, '..', to_location)
 
5561
            to_branch = branch.bzrdir.sprout(to_location,
 
5562
                                 possible_transports=[branch.bzrdir.root_transport],
 
5563
                                 source_branch=branch).open_branch()
 
5564
        else:
 
5565
            try:
 
5566
                to_branch = Branch.open(to_location)
 
5567
            except errors.NotBranchError:
 
5568
                this_url = self._get_branch_location(control_dir)
 
5569
                to_branch = Branch.open(
 
5570
                    urlutils.join(this_url, '..', to_location))
 
5571
        if revision is not None:
 
5572
            revision = revision.as_revision_id(to_branch)
 
5573
        switch.switch(control_dir, to_branch, force, revision_id=revision)
 
5574
        if had_explicit_nick:
5263
5575
            branch = control_dir.open_branch() #get the new branch!
5264
5576
            branch.nick = to_branch.nick
5265
5577
        note('Switched to branch: %s',
5266
5578
            urlutils.unescape_for_display(to_branch.base, 'utf-8'))
5267
5579
 
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()
 
5580
    def _get_branch_location(self, control_dir):
 
5581
        """Return location of branch for this control dir."""
5279
5582
        try:
5280
 
            rename_map.RenameMap.guess_renames(work_tree)
5281
 
        finally:
5282
 
            work_tree.unlock()
 
5583
            this_branch = control_dir.open_branch()
 
5584
            # This may be a heavy checkout, where we want the master branch
 
5585
            master_location = this_branch.get_bound_location()
 
5586
            if master_location is not None:
 
5587
                return master_location
 
5588
            # If not, use a local sibling
 
5589
            return this_branch.base
 
5590
        except errors.NotBranchError:
 
5591
            format = control_dir.find_branch_format()
 
5592
            if getattr(format, 'get_reference', None) is not None:
 
5593
                return format.get_reference(control_dir)
 
5594
            else:
 
5595
                return control_dir.root_transport.base
5283
5596
 
5284
5597
 
5285
5598
class cmd_view(Command):
5286
 
    """Manage filtered views.
 
5599
    __doc__ = """Manage filtered views.
5287
5600
 
5288
5601
    Views provide a mask over the tree so that users can focus on
5289
5602
    a subset of a tree when doing their work. After creating a view,
5369
5682
            name=None,
5370
5683
            switch=None,
5371
5684
            ):
5372
 
        tree, file_list = tree_files(file_list, apply_view=False)
 
5685
        tree, file_list = WorkingTree.open_containing_paths(file_list,
 
5686
            apply_view=False)
5373
5687
        current_view, view_dict = tree.views.get_view_info()
5374
5688
        if name is None:
5375
5689
            name = current_view
5437
5751
 
5438
5752
 
5439
5753
class cmd_hooks(Command):
5440
 
    """Show hooks."""
 
5754
    __doc__ = """Show hooks."""
5441
5755
 
5442
5756
    hidden = True
5443
5757
 
5456
5770
                    self.outf.write("    <no hooks installed>\n")
5457
5771
 
5458
5772
 
 
5773
class cmd_remove_branch(Command):
 
5774
    __doc__ = """Remove a branch.
 
5775
 
 
5776
    This will remove the branch from the specified location but 
 
5777
    will keep any working tree or repository in place.
 
5778
 
 
5779
    :Examples:
 
5780
 
 
5781
      Remove the branch at repo/trunk::
 
5782
 
 
5783
        bzr remove-branch repo/trunk
 
5784
 
 
5785
    """
 
5786
 
 
5787
    takes_args = ["location?"]
 
5788
 
 
5789
    aliases = ["rmbranch"]
 
5790
 
 
5791
    def run(self, location=None):
 
5792
        if location is None:
 
5793
            location = "."
 
5794
        branch = Branch.open_containing(location)[0]
 
5795
        branch.bzrdir.destroy_branch()
 
5796
        
 
5797
 
5459
5798
class cmd_shelve(Command):
5460
 
    """Temporarily set aside some changes from the current tree.
 
5799
    __doc__ = """Temporarily set aside some changes from the current tree.
5461
5800
 
5462
5801
    Shelve allows you to temporarily put changes you've made "on the shelf",
5463
5802
    ie. out of the way, until a later time when you can bring them back from
5484
5823
    takes_args = ['file*']
5485
5824
 
5486
5825
    takes_options = [
 
5826
        'directory',
5487
5827
        'revision',
5488
5828
        Option('all', help='Shelve all changes.'),
5489
5829
        'message',
5498
5838
    _see_also = ['unshelve']
5499
5839
 
5500
5840
    def run(self, revision=None, all=False, file_list=None, message=None,
5501
 
            writer=None, list=False, destroy=False):
 
5841
            writer=None, list=False, destroy=False, directory=u'.'):
5502
5842
        if list:
5503
5843
            return self.run_for_list()
5504
5844
        from bzrlib.shelf_ui import Shelver
5505
5845
        if writer is None:
5506
5846
            writer = bzrlib.option.diff_writer_registry.get()
5507
5847
        try:
5508
 
            Shelver.from_args(writer(sys.stdout), revision, all, file_list,
5509
 
                              message, destroy=destroy).run()
 
5848
            shelver = Shelver.from_args(writer(sys.stdout), revision, all,
 
5849
                file_list, message, destroy=destroy, directory=directory)
 
5850
            try:
 
5851
                shelver.run()
 
5852
            finally:
 
5853
                shelver.finalize()
5510
5854
        except errors.UserAbort:
5511
5855
            return 0
5512
5856
 
5513
5857
    def run_for_list(self):
5514
5858
        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()
 
5859
        self.add_cleanup(tree.lock_read().unlock)
 
5860
        manager = tree.get_shelf_manager()
 
5861
        shelves = manager.active_shelves()
 
5862
        if len(shelves) == 0:
 
5863
            note('No shelved changes.')
 
5864
            return 0
 
5865
        for shelf_id in reversed(shelves):
 
5866
            message = manager.get_metadata(shelf_id).get('message')
 
5867
            if message is None:
 
5868
                message = '<no message>'
 
5869
            self.outf.write('%3d: %s\n' % (shelf_id, message))
 
5870
        return 1
5530
5871
 
5531
5872
 
5532
5873
class cmd_unshelve(Command):
5533
 
    """Restore shelved changes.
 
5874
    __doc__ = """Restore shelved changes.
5534
5875
 
5535
5876
    By default, the most recently shelved changes are restored. However if you
5536
5877
    specify a shelf by id those changes will be restored instead.  This works
5539
5880
 
5540
5881
    takes_args = ['shelf_id?']
5541
5882
    takes_options = [
 
5883
        'directory',
5542
5884
        RegistryOption.from_kwargs(
5543
5885
            'action', help="The action to perform.",
5544
5886
            enum_switch=False, value_switches=True,
5545
5887
            apply="Apply changes and remove from the shelf.",
5546
5888
            dry_run="Show changes, but do not apply or remove them.",
5547
 
            delete_only="Delete changes without applying them."
 
5889
            preview="Instead of unshelving the changes, show the diff that "
 
5890
                    "would result from unshelving.",
 
5891
            delete_only="Delete changes without applying them.",
 
5892
            keep="Apply changes but don't delete them.",
5548
5893
        )
5549
5894
    ]
5550
5895
    _see_also = ['shelve']
5551
5896
 
5552
 
    def run(self, shelf_id=None, action='apply'):
 
5897
    def run(self, shelf_id=None, action='apply', directory=u'.'):
5553
5898
        from bzrlib.shelf_ui import Unshelver
5554
 
        Unshelver.from_args(shelf_id, action).run()
 
5899
        unshelver = Unshelver.from_args(shelf_id, action, directory=directory)
 
5900
        try:
 
5901
            unshelver.run()
 
5902
        finally:
 
5903
            unshelver.tree.unlock()
5555
5904
 
5556
5905
 
5557
5906
class cmd_clean_tree(Command):
5558
 
    """Remove unwanted files from working tree.
 
5907
    __doc__ = """Remove unwanted files from working tree.
5559
5908
 
5560
5909
    By default, only unknown files, not ignored files, are deleted.  Versioned
5561
5910
    files are never deleted.
5569
5918
 
5570
5919
    To check what clean-tree will do, use --dry-run.
5571
5920
    """
5572
 
    takes_options = [Option('ignored', help='Delete all ignored files.'),
 
5921
    takes_options = ['directory',
 
5922
                     Option('ignored', help='Delete all ignored files.'),
5573
5923
                     Option('detritus', help='Delete conflict files, merge'
5574
5924
                            ' backups, and failed selftest dirs.'),
5575
5925
                     Option('unknown',
5578
5928
                            ' deleting them.'),
5579
5929
                     Option('force', help='Do not prompt before deleting.')]
5580
5930
    def run(self, unknown=False, ignored=False, detritus=False, dry_run=False,
5581
 
            force=False):
 
5931
            force=False, directory=u'.'):
5582
5932
        from bzrlib.clean_tree import clean_tree
5583
5933
        if not (unknown or ignored or detritus):
5584
5934
            unknown = True
5585
5935
        if dry_run:
5586
5936
            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
 
5937
        clean_tree(directory, unknown=unknown, ignored=ignored,
 
5938
                   detritus=detritus, dry_run=dry_run, no_prompt=force)
 
5939
 
 
5940
 
 
5941
class cmd_reference(Command):
 
5942
    __doc__ = """list, view and set branch locations for nested trees.
 
5943
 
 
5944
    If no arguments are provided, lists the branch locations for nested trees.
 
5945
    If one argument is provided, display the branch location for that tree.
 
5946
    If two arguments are provided, set the branch location for that tree.
 
5947
    """
 
5948
 
 
5949
    hidden = True
 
5950
 
 
5951
    takes_args = ['path?', 'location?']
 
5952
 
 
5953
    def run(self, path=None, location=None):
 
5954
        branchdir = '.'
 
5955
        if path is not None:
 
5956
            branchdir = path
 
5957
        tree, branch, relpath =(
 
5958
            bzrdir.BzrDir.open_containing_tree_or_branch(branchdir))
 
5959
        if path is not None:
 
5960
            path = relpath
 
5961
        if tree is None:
 
5962
            tree = branch.basis_tree()
 
5963
        if path is None:
 
5964
            info = branch._get_all_reference_info().iteritems()
 
5965
            self._display_reference_info(tree, branch, info)
5605
5966
        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
 
5967
            file_id = tree.path2id(path)
 
5968
            if file_id is None:
 
5969
                raise errors.NotVersionedError(path)
 
5970
            if location is None:
 
5971
                info = [(file_id, branch.get_reference_info(file_id))]
 
5972
                self._display_reference_info(tree, branch, info)
 
5973
            else:
 
5974
                branch.set_reference_info(file_id, path, location)
 
5975
 
 
5976
    def _display_reference_info(self, tree, branch, info):
 
5977
        ref_list = []
 
5978
        for file_id, (path, location) in info:
 
5979
            try:
 
5980
                path = tree.id2path(file_id)
 
5981
            except errors.NoSuchId:
 
5982
                pass
 
5983
            ref_list.append((path, location))
 
5984
        for path, location in sorted(ref_list):
 
5985
            self.outf.write('%s %s\n' % (path, location))
 
5986
 
 
5987
 
 
5988
def _register_lazy_builtins():
 
5989
    # register lazy builtins from other modules; called at startup and should
 
5990
    # be only called once.
 
5991
    for (name, aliases, module_name) in [
 
5992
        ('cmd_bundle_info', [], 'bzrlib.bundle.commands'),
 
5993
        ('cmd_dpush', [], 'bzrlib.foreign'),
 
5994
        ('cmd_version_info', [], 'bzrlib.cmd_version_info'),
 
5995
        ('cmd_resolve', ['resolved'], 'bzrlib.conflicts'),
 
5996
        ('cmd_conflicts', [], 'bzrlib.conflicts'),
 
5997
        ('cmd_sign_my_commits', [], 'bzrlib.sign_my_commits'),
 
5998
        ]:
 
5999
        builtin_command_registry.register_lazy(name, aliases, module_name)