← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/builtins.py

  • Committer: Martin Pool
  • Date: 2009-09-14 02:30:23 UTC
  • mto: This revision was merged to the branch mainline in revision 4693.
  • Revision ID: mbp@sourcefrog.net-20090914023023-ros0f3ndo04j3bww
https://launchpad.net/bugs/429151
Clearer docs about bzr help.  (Thanks to Naoki)

Show diffs side-by-side

added added

removed removed

Lines of Context:
bzrlib/builtins.py
1
 
# Copyright (C) 2005-2010 Canonical Ltd
 
1
# Copyright (C) 2004, 2005, 2006, 2007, 2008, 2009 Canonical Ltd
2
2
#
3
3
# This program is free software; you can redistribute it and/or modify
4
4
# it under the terms of the GNU General Public License as published by
20
20
 
21
21
from bzrlib.lazy_import import lazy_import
22
22
lazy_import(globals(), """
 
23
import codecs
23
24
import cStringIO
24
25
import sys
25
26
import time
30
31
    bundle,
31
32
    btree_index,
32
33
    bzrdir,
33
 
    directory_service,
34
34
    delta,
35
 
    config as _mod_config,
 
35
    config,
36
36
    errors,
37
37
    globbing,
38
38
    hooks,
43
43
    reconfigure,
44
44
    rename_map,
45
45
    revision as _mod_revision,
46
 
    static_tuple,
47
46
    symbol_versioning,
48
 
    timestamp,
49
47
    transport,
50
48
    ui,
51
49
    urlutils,
53
51
    )
54
52
from bzrlib.branch import Branch
55
53
from bzrlib.conflicts import ConflictList
56
 
from bzrlib.transport import memory
57
54
from bzrlib.revisionspec import RevisionSpec, RevisionInfo
58
55
from bzrlib.smtp_connection import SMTPConnection
59
56
from bzrlib.workingtree import WorkingTree
60
57
""")
61
58
 
62
 
from bzrlib.commands import (
63
 
    Command,
64
 
    builtin_command_registry,
65
 
    display_command,
66
 
    )
 
59
from bzrlib.commands import Command, display_command
67
60
from bzrlib.option import (
68
61
    ListOption,
69
62
    Option,
74
67
from bzrlib.trace import mutter, note, warning, is_quiet, get_verbosity_level
75
68
 
76
69
 
77
 
@symbol_versioning.deprecated_function(symbol_versioning.deprecated_in((2, 3, 0)))
78
70
def tree_files(file_list, default_branch=u'.', canonicalize=True,
79
71
    apply_view=True):
80
 
    return internal_tree_files(file_list, default_branch, canonicalize,
81
 
        apply_view)
 
72
    try:
 
73
        return internal_tree_files(file_list, default_branch, canonicalize,
 
74
            apply_view)
 
75
    except errors.FileInWrongBranch, e:
 
76
        raise errors.BzrCommandError("%s is not in the same branch as %s" %
 
77
                                     (e.path, file_list[0]))
82
78
 
83
79
 
84
80
def tree_files_for_add(file_list):
148
144
 
149
145
# XXX: Bad function name; should possibly also be a class method of
150
146
# WorkingTree rather than a function.
151
 
@symbol_versioning.deprecated_function(symbol_versioning.deprecated_in((2, 3, 0)))
152
147
def internal_tree_files(file_list, default_branch=u'.', canonicalize=True,
153
148
    apply_view=True):
154
149
    """Convert command-line paths to a WorkingTree and relative paths.
155
150
 
156
 
    Deprecated: use WorkingTree.open_containing_paths instead.
157
 
 
158
151
    This is typically used for command-line processors that take one or
159
152
    more filenames, and infer the workingtree that contains them.
160
153
 
170
163
 
171
164
    :return: workingtree, [relative_paths]
172
165
    """
173
 
    return WorkingTree.open_containing_paths(
174
 
        file_list, default_directory='.',
175
 
        canonicalize=True,
176
 
        apply_view=True)
 
166
    if file_list is None or len(file_list) == 0:
 
167
        tree = WorkingTree.open_containing(default_branch)[0]
 
168
        if tree.supports_views() and apply_view:
 
169
            view_files = tree.views.lookup_view()
 
170
            if view_files:
 
171
                file_list = view_files
 
172
                view_str = views.view_display_str(view_files)
 
173
                note("Ignoring files outside view. View is %s" % view_str)
 
174
        return tree, file_list
 
175
    tree = WorkingTree.open_containing(osutils.realpath(file_list[0]))[0]
 
176
    return tree, safe_relpath_files(tree, file_list, canonicalize,
 
177
        apply_view=apply_view)
 
178
 
 
179
 
 
180
def safe_relpath_files(tree, file_list, canonicalize=True, apply_view=True):
 
181
    """Convert file_list into a list of relpaths in tree.
 
182
 
 
183
    :param tree: A tree to operate on.
 
184
    :param file_list: A list of user provided paths or None.
 
185
    :param apply_view: if True and a view is set, apply it or check that
 
186
        specified files are within it
 
187
    :return: A list of relative paths.
 
188
    :raises errors.PathNotChild: When a provided path is in a different tree
 
189
        than tree.
 
190
    """
 
191
    if file_list is None:
 
192
        return None
 
193
    if tree.supports_views() and apply_view:
 
194
        view_files = tree.views.lookup_view()
 
195
    else:
 
196
        view_files = []
 
197
    new_list = []
 
198
    # tree.relpath exists as a "thunk" to osutils, but canonical_relpath
 
199
    # doesn't - fix that up here before we enter the loop.
 
200
    if canonicalize:
 
201
        fixer = lambda p: osutils.canonical_relpath(tree.basedir, p)
 
202
    else:
 
203
        fixer = tree.relpath
 
204
    for filename in file_list:
 
205
        try:
 
206
            relpath = fixer(osutils.dereference_path(filename))
 
207
            if  view_files and not osutils.is_inside_any(view_files, relpath):
 
208
                raise errors.FileOutsideView(filename, view_files)
 
209
            new_list.append(relpath)
 
210
        except errors.PathNotChild:
 
211
            raise errors.FileInWrongBranch(tree.branch, filename)
 
212
    return new_list
177
213
 
178
214
 
179
215
def _get_view_info_for_change_reporter(tree):
188
224
    return view_info
189
225
 
190
226
 
191
 
def _open_directory_or_containing_tree_or_branch(filename, directory):
192
 
    """Open the tree or branch containing the specified file, unless
193
 
    the --directory option is used to specify a different branch."""
194
 
    if directory is not None:
195
 
        return (None, Branch.open(directory), filename)
196
 
    return bzrdir.BzrDir.open_containing_tree_or_branch(filename)
197
 
 
198
 
 
199
227
# TODO: Make sure no commands unconditionally use the working directory as a
200
228
# branch.  If a filename argument is used, the first of them should be used to
201
229
# specify the branch.  (Perhaps this can be factored out into some kind of
203
231
# opens the branch?)
204
232
 
205
233
class cmd_status(Command):
206
 
    __doc__ = """Display status summary.
 
234
    """Display status summary.
207
235
 
208
236
    This reports on versioned and unknown files, reporting them
209
237
    grouped by state.  Possible states are:
229
257
    unknown
230
258
        Not versioned and not matching an ignore pattern.
231
259
 
232
 
    Additionally for directories, symlinks and files with an executable
233
 
    bit, Bazaar indicates their type using a trailing character: '/', '@'
234
 
    or '*' respectively.
235
 
 
236
260
    To see ignored files use 'bzr ignored'.  For details on the
237
261
    changes to file texts, use 'bzr diff'.
238
262
 
279
303
            raise errors.BzrCommandError('bzr status --revision takes exactly'
280
304
                                         ' one or two revision specifiers')
281
305
 
282
 
        tree, relfile_list = WorkingTree.open_containing_paths(file_list)
 
306
        tree, relfile_list = tree_files(file_list)
283
307
        # Avoid asking for specific files when that is not needed.
284
308
        if relfile_list == ['']:
285
309
            relfile_list = None
296
320
 
297
321
 
298
322
class cmd_cat_revision(Command):
299
 
    __doc__ = """Write out metadata for a revision.
 
323
    """Write out metadata for a revision.
300
324
 
301
325
    The revision to print can either be specified by a specific
302
326
    revision identifier, or you can use --revision.
304
328
 
305
329
    hidden = True
306
330
    takes_args = ['revision_id?']
307
 
    takes_options = ['directory', 'revision']
 
331
    takes_options = ['revision']
308
332
    # cat-revision is more for frontends so should be exact
309
333
    encoding = 'strict'
310
334
 
311
 
    def print_revision(self, revisions, revid):
312
 
        stream = revisions.get_record_stream([(revid,)], 'unordered', True)
313
 
        record = stream.next()
314
 
        if record.storage_kind == 'absent':
315
 
            raise errors.NoSuchRevision(revisions, revid)
316
 
        revtext = record.get_bytes_as('fulltext')
317
 
        self.outf.write(revtext.decode('utf-8'))
318
 
 
319
335
    @display_command
320
 
    def run(self, revision_id=None, revision=None, directory=u'.'):
 
336
    def run(self, revision_id=None, revision=None):
321
337
        if revision_id is not None and revision is not None:
322
338
            raise errors.BzrCommandError('You can only supply one of'
323
339
                                         ' revision_id or --revision')
324
340
        if revision_id is None and revision is None:
325
341
            raise errors.BzrCommandError('You must supply either'
326
342
                                         ' --revision or a revision_id')
327
 
        b = WorkingTree.open_containing(directory)[0].branch
328
 
 
329
 
        revisions = b.repository.revisions
330
 
        if revisions is None:
331
 
            raise errors.BzrCommandError('Repository %r does not support '
332
 
                'access to raw revision texts')
333
 
 
334
 
        b.repository.lock_read()
335
 
        try:
336
 
            # TODO: jam 20060112 should cat-revision always output utf-8?
337
 
            if revision_id is not None:
338
 
                revision_id = osutils.safe_revision_id(revision_id, warn=False)
339
 
                try:
340
 
                    self.print_revision(revisions, revision_id)
341
 
                except errors.NoSuchRevision:
342
 
                    msg = "The repository %s contains no revision %s." % (
343
 
                        b.repository.base, revision_id)
344
 
                    raise errors.BzrCommandError(msg)
345
 
            elif revision is not None:
346
 
                for rev in revision:
347
 
                    if rev is None:
348
 
                        raise errors.BzrCommandError(
349
 
                            'You cannot specify a NULL revision.')
350
 
                    rev_id = rev.as_revision_id(b)
351
 
                    self.print_revision(revisions, rev_id)
352
 
        finally:
353
 
            b.repository.unlock()
354
 
        
 
343
        b = WorkingTree.open_containing(u'.')[0].branch
 
344
 
 
345
        # TODO: jam 20060112 should cat-revision always output utf-8?
 
346
        if revision_id is not None:
 
347
            revision_id = osutils.safe_revision_id(revision_id, warn=False)
 
348
            try:
 
349
                self.outf.write(b.repository.get_revision_xml(revision_id).decode('utf-8'))
 
350
            except errors.NoSuchRevision:
 
351
                msg = "The repository %s contains no revision %s." % (b.repository.base,
 
352
                    revision_id)
 
353
                raise errors.BzrCommandError(msg)
 
354
        elif revision is not None:
 
355
            for rev in revision:
 
356
                if rev is None:
 
357
                    raise errors.BzrCommandError('You cannot specify a NULL'
 
358
                                                 ' revision.')
 
359
                rev_id = rev.as_revision_id(b)
 
360
                self.outf.write(b.repository.get_revision_xml(rev_id).decode('utf-8'))
 
361
 
355
362
 
356
363
class cmd_dump_btree(Command):
357
 
    __doc__ = """Dump the contents of a btree index file to stdout.
 
364
    """Dump the contents of a btree index file to stdout.
358
365
 
359
366
    PATH is a btree index file, it can be any URL. This includes things like
360
367
    .bzr/repository/pack-names, or .bzr/repository/indices/a34b3a...ca4a4.iix
424
431
        for node in bt.iter_all_entries():
425
432
            # Node is made up of:
426
433
            # (index, key, value, [references])
427
 
            try:
428
 
                refs = node[3]
429
 
            except IndexError:
430
 
                refs_as_tuples = None
431
 
            else:
432
 
                refs_as_tuples = static_tuple.as_tuples(refs)
433
 
            as_tuple = (tuple(node[1]), node[2], refs_as_tuples)
434
 
            self.outf.write('%s\n' % (as_tuple,))
 
434
            self.outf.write('%s\n' % (node[1:],))
435
435
 
436
436
 
437
437
class cmd_remove_tree(Command):
438
 
    __doc__ = """Remove the working tree from a given branch/checkout.
 
438
    """Remove the working tree from a given branch/checkout.
439
439
 
440
440
    Since a lightweight checkout is little more than a working tree
441
441
    this will refuse to run against one.
443
443
    To re-create the working tree, use "bzr checkout".
444
444
    """
445
445
    _see_also = ['checkout', 'working-trees']
446
 
    takes_args = ['location*']
 
446
    takes_args = ['location?']
447
447
    takes_options = [
448
448
        Option('force',
449
449
               help='Remove the working tree even if it has '
450
 
                    'uncommitted or shelved changes.'),
 
450
                    'uncommitted changes.'),
451
451
        ]
452
452
 
453
 
    def run(self, location_list, force=False):
454
 
        if not location_list:
455
 
            location_list=['.']
456
 
 
457
 
        for location in location_list:
458
 
            d = bzrdir.BzrDir.open(location)
459
 
            
460
 
            try:
461
 
                working = d.open_workingtree()
462
 
            except errors.NoWorkingTree:
463
 
                raise errors.BzrCommandError("No working tree to remove")
464
 
            except errors.NotLocalUrl:
465
 
                raise errors.BzrCommandError("You cannot remove the working tree"
466
 
                                             " of a remote path")
467
 
            if not force:
468
 
                if (working.has_changes()):
469
 
                    raise errors.UncommittedChanges(working)
470
 
                if working.get_shelf_manager().last_shelf() is not None:
471
 
                    raise errors.ShelvedChanges(working)
472
 
 
473
 
            if working.user_url != working.branch.user_url:
474
 
                raise errors.BzrCommandError("You cannot remove the working tree"
475
 
                                             " from a lightweight checkout")
476
 
 
477
 
            d.destroy_workingtree()
 
453
    def run(self, location='.', force=False):
 
454
        d = bzrdir.BzrDir.open(location)
 
455
 
 
456
        try:
 
457
            working = d.open_workingtree()
 
458
        except errors.NoWorkingTree:
 
459
            raise errors.BzrCommandError("No working tree to remove")
 
460
        except errors.NotLocalUrl:
 
461
            raise errors.BzrCommandError("You cannot remove the working tree"
 
462
                                         " of a remote path")
 
463
        if not force:
 
464
            # XXX: What about pending merges ? -- vila 20090629
 
465
            if working.has_changes(working.basis_tree()):
 
466
                raise errors.UncommittedChanges(working)
 
467
 
 
468
        working_path = working.bzrdir.root_transport.base
 
469
        branch_path = working.branch.bzrdir.root_transport.base
 
470
        if working_path != branch_path:
 
471
            raise errors.BzrCommandError("You cannot remove the working tree"
 
472
                                         " from a lightweight checkout")
 
473
 
 
474
        d.destroy_workingtree()
478
475
 
479
476
 
480
477
class cmd_revno(Command):
481
 
    __doc__ = """Show current revision number.
 
478
    """Show current revision number.
482
479
 
483
480
    This is equal to the number of revisions on this branch.
484
481
    """
494
491
        if tree:
495
492
            try:
496
493
                wt = WorkingTree.open_containing(location)[0]
497
 
                self.add_cleanup(wt.lock_read().unlock)
 
494
                wt.lock_read()
498
495
            except (errors.NoWorkingTree, errors.NotLocalUrl):
499
496
                raise errors.NoWorkingTree(location)
500
 
            revid = wt.last_revision()
501
497
            try:
502
 
                revno_t = wt.branch.revision_id_to_dotted_revno(revid)
503
 
            except errors.NoSuchRevision:
504
 
                revno_t = ('???',)
505
 
            revno = ".".join(str(n) for n in revno_t)
 
498
                revid = wt.last_revision()
 
499
                try:
 
500
                    revno_t = wt.branch.revision_id_to_dotted_revno(revid)
 
501
                except errors.NoSuchRevision:
 
502
                    revno_t = ('???',)
 
503
                revno = ".".join(str(n) for n in revno_t)
 
504
            finally:
 
505
                wt.unlock()
506
506
        else:
507
507
            b = Branch.open_containing(location)[0]
508
 
            self.add_cleanup(b.lock_read().unlock)
509
 
            revno = b.revno()
510
 
        self.cleanup_now()
 
508
            b.lock_read()
 
509
            try:
 
510
                revno = b.revno()
 
511
            finally:
 
512
                b.unlock()
 
513
 
511
514
        self.outf.write(str(revno) + '\n')
512
515
 
513
516
 
514
517
class cmd_revision_info(Command):
515
 
    __doc__ = """Show revision number and revision id for a given revision identifier.
 
518
    """Show revision number and revision id for a given revision identifier.
516
519
    """
517
520
    hidden = True
518
521
    takes_args = ['revision_info*']
519
522
    takes_options = [
520
523
        'revision',
521
 
        custom_help('directory',
 
524
        Option('directory',
522
525
            help='Branch to examine, '
523
 
                 'rather than the one containing the working directory.'),
 
526
                 'rather than the one containing the working directory.',
 
527
            short_name='d',
 
528
            type=unicode,
 
529
            ),
524
530
        Option('tree', help='Show revno of working tree'),
525
531
        ]
526
532
 
531
537
        try:
532
538
            wt = WorkingTree.open_containing(directory)[0]
533
539
            b = wt.branch
534
 
            self.add_cleanup(wt.lock_read().unlock)
 
540
            wt.lock_read()
535
541
        except (errors.NoWorkingTree, errors.NotLocalUrl):
536
542
            wt = None
537
543
            b = Branch.open_containing(directory)[0]
538
 
            self.add_cleanup(b.lock_read().unlock)
539
 
        revision_ids = []
540
 
        if revision is not None:
541
 
            revision_ids.extend(rev.as_revision_id(b) for rev in revision)
542
 
        if revision_info_list is not None:
543
 
            for rev_str in revision_info_list:
544
 
                rev_spec = RevisionSpec.from_string(rev_str)
545
 
                revision_ids.append(rev_spec.as_revision_id(b))
546
 
        # No arguments supplied, default to the last revision
547
 
        if len(revision_ids) == 0:
548
 
            if tree:
549
 
                if wt is None:
550
 
                    raise errors.NoWorkingTree(directory)
551
 
                revision_ids.append(wt.last_revision())
 
544
            b.lock_read()
 
545
        try:
 
546
            revision_ids = []
 
547
            if revision is not None:
 
548
                revision_ids.extend(rev.as_revision_id(b) for rev in revision)
 
549
            if revision_info_list is not None:
 
550
                for rev_str in revision_info_list:
 
551
                    rev_spec = RevisionSpec.from_string(rev_str)
 
552
                    revision_ids.append(rev_spec.as_revision_id(b))
 
553
            # No arguments supplied, default to the last revision
 
554
            if len(revision_ids) == 0:
 
555
                if tree:
 
556
                    if wt is None:
 
557
                        raise errors.NoWorkingTree(directory)
 
558
                    revision_ids.append(wt.last_revision())
 
559
                else:
 
560
                    revision_ids.append(b.last_revision())
 
561
 
 
562
            revinfos = []
 
563
            maxlen = 0
 
564
            for revision_id in revision_ids:
 
565
                try:
 
566
                    dotted_revno = b.revision_id_to_dotted_revno(revision_id)
 
567
                    revno = '.'.join(str(i) for i in dotted_revno)
 
568
                except errors.NoSuchRevision:
 
569
                    revno = '???'
 
570
                maxlen = max(maxlen, len(revno))
 
571
                revinfos.append([revno, revision_id])
 
572
        finally:
 
573
            if wt is None:
 
574
                b.unlock()
552
575
            else:
553
 
                revision_ids.append(b.last_revision())
554
 
 
555
 
        revinfos = []
556
 
        maxlen = 0
557
 
        for revision_id in revision_ids:
558
 
            try:
559
 
                dotted_revno = b.revision_id_to_dotted_revno(revision_id)
560
 
                revno = '.'.join(str(i) for i in dotted_revno)
561
 
            except errors.NoSuchRevision:
562
 
                revno = '???'
563
 
            maxlen = max(maxlen, len(revno))
564
 
            revinfos.append([revno, revision_id])
565
 
 
566
 
        self.cleanup_now()
 
576
                wt.unlock()
 
577
 
567
578
        for ri in revinfos:
568
579
            self.outf.write('%*s %s\n' % (maxlen, ri[0], ri[1]))
569
580
 
570
581
 
571
582
class cmd_add(Command):
572
 
    __doc__ = """Add specified files or directories.
 
583
    """Add specified files or directories.
573
584
 
574
585
    In non-recursive mode, all the named items are added, regardless
575
586
    of whether they were previously ignored.  A warning is given if
640
651
                should_print=(not is_quiet()))
641
652
 
642
653
        if base_tree:
643
 
            self.add_cleanup(base_tree.lock_read().unlock)
644
 
        tree, file_list = tree_files_for_add(file_list)
645
 
        added, ignored = tree.smart_add(file_list, not
646
 
            no_recurse, action=action, save=not dry_run)
647
 
        self.cleanup_now()
 
654
            base_tree.lock_read()
 
655
        try:
 
656
            file_list = self._maybe_expand_globs(file_list)
 
657
            tree, file_list = tree_files_for_add(file_list)
 
658
            added, ignored = tree.smart_add(file_list, not
 
659
                no_recurse, action=action, save=not dry_run)
 
660
        finally:
 
661
            if base_tree is not None:
 
662
                base_tree.unlock()
648
663
        if len(ignored) > 0:
649
664
            if verbose:
650
665
                for glob in sorted(ignored.keys()):
654
669
 
655
670
 
656
671
class cmd_mkdir(Command):
657
 
    __doc__ = """Create a new versioned directory.
 
672
    """Create a new versioned directory.
658
673
 
659
674
    This is equivalent to creating the directory and then adding it.
660
675
    """
664
679
 
665
680
    def run(self, dir_list):
666
681
        for d in dir_list:
 
682
            os.mkdir(d)
667
683
            wt, dd = WorkingTree.open_containing(d)
668
 
            base = os.path.dirname(dd)
669
 
            id = wt.path2id(base)
670
 
            if id != None:
671
 
                os.mkdir(d)
672
 
                wt.add([dd])
673
 
                self.outf.write('added %s\n' % d)
674
 
            else:
675
 
                raise errors.NotVersionedError(path=base)
 
684
            wt.add([dd])
 
685
            self.outf.write('added %s\n' % d)
676
686
 
677
687
 
678
688
class cmd_relpath(Command):
679
 
    __doc__ = """Show path of a file relative to root"""
 
689
    """Show path of a file relative to root"""
680
690
 
681
691
    takes_args = ['filename']
682
692
    hidden = True
691
701
 
692
702
 
693
703
class cmd_inventory(Command):
694
 
    __doc__ = """Show inventory of the current working copy or a revision.
 
704
    """Show inventory of the current working copy or a revision.
695
705
 
696
706
    It is possible to limit the output to a particular entry
697
707
    type using the --kind option.  For example: --kind file.
717
727
            raise errors.BzrCommandError('invalid kind %r specified' % (kind,))
718
728
 
719
729
        revision = _get_one_revision('inventory', revision)
720
 
        work_tree, file_list = WorkingTree.open_containing_paths(file_list)
721
 
        self.add_cleanup(work_tree.lock_read().unlock)
722
 
        if revision is not None:
723
 
            tree = revision.as_tree(work_tree.branch)
724
 
 
725
 
            extra_trees = [work_tree]
726
 
            self.add_cleanup(tree.lock_read().unlock)
727
 
        else:
728
 
            tree = work_tree
729
 
            extra_trees = []
730
 
 
731
 
        if file_list is not None:
732
 
            file_ids = tree.paths2ids(file_list, trees=extra_trees,
733
 
                                      require_versioned=True)
734
 
            # find_ids_across_trees may include some paths that don't
735
 
            # exist in 'tree'.
736
 
            entries = sorted((tree.id2path(file_id), tree.inventory[file_id])
737
 
                             for file_id in file_ids if file_id in tree)
738
 
        else:
739
 
            entries = tree.inventory.entries()
740
 
 
741
 
        self.cleanup_now()
 
730
        work_tree, file_list = tree_files(file_list)
 
731
        work_tree.lock_read()
 
732
        try:
 
733
            if revision is not None:
 
734
                tree = revision.as_tree(work_tree.branch)
 
735
 
 
736
                extra_trees = [work_tree]
 
737
                tree.lock_read()
 
738
            else:
 
739
                tree = work_tree
 
740
                extra_trees = []
 
741
 
 
742
            if file_list is not None:
 
743
                file_ids = tree.paths2ids(file_list, trees=extra_trees,
 
744
                                          require_versioned=True)
 
745
                # find_ids_across_trees may include some paths that don't
 
746
                # exist in 'tree'.
 
747
                entries = sorted((tree.id2path(file_id), tree.inventory[file_id])
 
748
                                 for file_id in file_ids if file_id in tree)
 
749
            else:
 
750
                entries = tree.inventory.entries()
 
751
        finally:
 
752
            tree.unlock()
 
753
            if tree is not work_tree:
 
754
                work_tree.unlock()
 
755
 
742
756
        for path, entry in entries:
743
757
            if kind and kind != entry.kind:
744
758
                continue
750
764
 
751
765
 
752
766
class cmd_mv(Command):
753
 
    __doc__ = """Move or rename a file.
 
767
    """Move or rename a file.
754
768
 
755
769
    :Usage:
756
770
        bzr mv OLDNAME NEWNAME
788
802
            names_list = []
789
803
        if len(names_list) < 2:
790
804
            raise errors.BzrCommandError("missing file argument")
791
 
        tree, rel_names = WorkingTree.open_containing_paths(names_list, canonicalize=False)
792
 
        self.add_cleanup(tree.lock_tree_write().unlock)
793
 
        self._run(tree, names_list, rel_names, after)
 
805
        tree, rel_names = tree_files(names_list, canonicalize=False)
 
806
        tree.lock_tree_write()
 
807
        try:
 
808
            self._run(tree, names_list, rel_names, after)
 
809
        finally:
 
810
            tree.unlock()
794
811
 
795
812
    def run_auto(self, names_list, after, dry_run):
796
813
        if names_list is not None and len(names_list) > 1:
799
816
        if after:
800
817
            raise errors.BzrCommandError('--after cannot be specified with'
801
818
                                         ' --auto.')
802
 
        work_tree, file_list = WorkingTree.open_containing_paths(
803
 
            names_list, default_directory='.')
804
 
        self.add_cleanup(work_tree.lock_tree_write().unlock)
805
 
        rename_map.RenameMap.guess_renames(work_tree, dry_run)
 
819
        work_tree, file_list = tree_files(names_list, default_branch='.')
 
820
        work_tree.lock_tree_write()
 
821
        try:
 
822
            rename_map.RenameMap.guess_renames(work_tree, dry_run)
 
823
        finally:
 
824
            work_tree.unlock()
806
825
 
807
826
    def _run(self, tree, names_list, rel_names, after):
808
827
        into_existing = osutils.isdir(names_list[-1])
829
848
            # All entries reference existing inventory items, so fix them up
830
849
            # for cicp file-systems.
831
850
            rel_names = tree.get_canonical_inventory_paths(rel_names)
832
 
            for src, dest in tree.move(rel_names[:-1], rel_names[-1], after=after):
833
 
                if not is_quiet():
834
 
                    self.outf.write("%s => %s\n" % (src, dest))
 
851
            for pair in tree.move(rel_names[:-1], rel_names[-1], after=after):
 
852
                self.outf.write("%s => %s\n" % pair)
835
853
        else:
836
854
            if len(names_list) != 2:
837
855
                raise errors.BzrCommandError('to mv multiple files the'
881
899
            dest = osutils.pathjoin(dest_parent, dest_tail)
882
900
            mutter("attempting to move %s => %s", src, dest)
883
901
            tree.rename_one(src, dest, after=after)
884
 
            if not is_quiet():
885
 
                self.outf.write("%s => %s\n" % (src, dest))
 
902
            self.outf.write("%s => %s\n" % (src, dest))
886
903
 
887
904
 
888
905
class cmd_pull(Command):
889
 
    __doc__ = """Turn this branch into a mirror of another branch.
 
906
    """Turn this branch into a mirror of another branch.
890
907
 
891
 
    By default, this command only works on branches that have not diverged.
892
 
    Branches are considered diverged if the destination branch's most recent 
893
 
    commit is one that has not been merged (directly or indirectly) into the 
894
 
    parent.
 
908
    This command only works on branches that have not diverged.  Branches are
 
909
    considered diverged if the destination branch's most recent commit is one
 
910
    that has not been merged (directly or indirectly) into the parent.
895
911
 
896
912
    If branches have diverged, you can use 'bzr merge' to integrate the changes
897
913
    from one into the other.  Once one branch has merged, the other should
898
914
    be able to pull it again.
899
915
 
900
 
    If you want to replace your local changes and just want your branch to
901
 
    match the remote one, use pull --overwrite. This will work even if the two
902
 
    branches have diverged.
 
916
    If you want to forget your local changes and just update your branch to
 
917
    match the remote one, use pull --overwrite.
903
918
 
904
919
    If there is no default location set, the first pull will set it.  After
905
920
    that, you can omit the location to use the default.  To change the
915
930
    takes_options = ['remember', 'overwrite', 'revision',
916
931
        custom_help('verbose',
917
932
            help='Show logs of pulled revisions.'),
918
 
        custom_help('directory',
 
933
        Option('directory',
919
934
            help='Branch to pull into, '
920
 
                 'rather than the one containing the working directory.'),
 
935
                 'rather than the one containing the working directory.',
 
936
            short_name='d',
 
937
            type=unicode,
 
938
            ),
921
939
        Option('local',
922
940
            help="Perform a local pull in a bound "
923
941
                 "branch.  Local pulls are not applied to "
938
956
        try:
939
957
            tree_to = WorkingTree.open_containing(directory)[0]
940
958
            branch_to = tree_to.branch
941
 
            self.add_cleanup(tree_to.lock_write().unlock)
942
959
        except errors.NoWorkingTree:
943
960
            tree_to = None
944
961
            branch_to = Branch.open_containing(directory)[0]
945
 
            self.add_cleanup(branch_to.lock_write().unlock)
946
 
 
 
962
        
947
963
        if local and not branch_to.get_bound_location():
948
964
            raise errors.LocalRequiresBoundBranch()
949
965
 
979
995
        else:
980
996
            branch_from = Branch.open(location,
981
997
                possible_transports=possible_transports)
982
 
            self.add_cleanup(branch_from.lock_read().unlock)
983
998
 
984
999
            if branch_to.get_parent() is None or remember:
985
1000
                branch_to.set_parent(branch_from.base)
986
1001
 
987
 
        if revision is not None:
988
 
            revision_id = revision.as_revision_id(branch_from)
989
 
 
990
 
        if tree_to is not None:
991
 
            view_info = _get_view_info_for_change_reporter(tree_to)
992
 
            change_reporter = delta._ChangeReporter(
993
 
                unversioned_filter=tree_to.is_ignored,
994
 
                view_info=view_info)
995
 
            result = tree_to.pull(
996
 
                branch_from, overwrite, revision_id, change_reporter,
997
 
                possible_transports=possible_transports, local=local)
998
 
        else:
999
 
            result = branch_to.pull(
1000
 
                branch_from, overwrite, revision_id, local=local)
1001
 
 
1002
 
        result.report(self.outf)
1003
 
        if verbose and result.old_revid != result.new_revid:
1004
 
            log.show_branch_change(
1005
 
                branch_to, self.outf, result.old_revno,
1006
 
                result.old_revid)
 
1002
        if branch_from is not branch_to:
 
1003
            branch_from.lock_read()
 
1004
        try:
 
1005
            if revision is not None:
 
1006
                revision_id = revision.as_revision_id(branch_from)
 
1007
 
 
1008
            branch_to.lock_write()
 
1009
            try:
 
1010
                if tree_to is not None:
 
1011
                    view_info = _get_view_info_for_change_reporter(tree_to)
 
1012
                    change_reporter = delta._ChangeReporter(
 
1013
                        unversioned_filter=tree_to.is_ignored,
 
1014
                        view_info=view_info)
 
1015
                    result = tree_to.pull(
 
1016
                        branch_from, overwrite, revision_id, change_reporter,
 
1017
                        possible_transports=possible_transports, local=local)
 
1018
                else:
 
1019
                    result = branch_to.pull(
 
1020
                        branch_from, overwrite, revision_id, local=local)
 
1021
 
 
1022
                result.report(self.outf)
 
1023
                if verbose and result.old_revid != result.new_revid:
 
1024
                    log.show_branch_change(
 
1025
                        branch_to, self.outf, result.old_revno,
 
1026
                        result.old_revid)
 
1027
            finally:
 
1028
                branch_to.unlock()
 
1029
        finally:
 
1030
            if branch_from is not branch_to:
 
1031
                branch_from.unlock()
1007
1032
 
1008
1033
 
1009
1034
class cmd_push(Command):
1010
 
    __doc__ = """Update a mirror of this branch.
 
1035
    """Update a mirror of this branch.
1011
1036
 
1012
1037
    The target branch will not have its working tree populated because this
1013
1038
    is both expensive, and is not supported on remote file systems.
1037
1062
        Option('create-prefix',
1038
1063
               help='Create the path leading up to the branch '
1039
1064
                    'if it does not already exist.'),
1040
 
        custom_help('directory',
 
1065
        Option('directory',
1041
1066
            help='Branch to push from, '
1042
 
                 'rather than the one containing the working directory.'),
 
1067
                 'rather than the one containing the working directory.',
 
1068
            short_name='d',
 
1069
            type=unicode,
 
1070
            ),
1043
1071
        Option('use-existing-dir',
1044
1072
               help='By default push will fail if the target'
1045
1073
                    ' directory exists, but does not already'
1071
1099
        # Get the source branch
1072
1100
        (tree, br_from,
1073
1101
         _unused) = bzrdir.BzrDir.open_containing_tree_or_branch(directory)
 
1102
        if strict is None:
 
1103
            strict = br_from.get_config().get_user_option_as_bool('push_strict')
 
1104
        if strict is None: strict = True # default value
1074
1105
        # Get the tip's revision_id
1075
1106
        revision = _get_one_revision('push', revision)
1076
1107
        if revision is not None:
1077
1108
            revision_id = revision.in_history(br_from).rev_id
1078
1109
        else:
1079
1110
            revision_id = None
1080
 
        if tree is not None and revision_id is None:
1081
 
            tree.check_changed_or_out_of_date(
1082
 
                strict, 'push_strict',
1083
 
                more_error='Use --no-strict to force the push.',
1084
 
                more_warning='Uncommitted changes will not be pushed.')
 
1111
        if strict and tree is not None and revision_id is None:
 
1112
            if (tree.has_changes(tree.basis_tree())
 
1113
                or len(tree.get_parent_ids()) > 1):
 
1114
                raise errors.UncommittedChanges(
 
1115
                    tree, more='Use --no-strict to force the push.')
 
1116
            if tree.last_revision() != tree.branch.last_revision():
 
1117
                # The tree has lost sync with its branch, there is little
 
1118
                # chance that the user is aware of it but he can still force
 
1119
                # the push with --no-strict
 
1120
                raise errors.OutOfDateTree(
 
1121
                    tree, more='Use --no-strict to force the push.')
 
1122
 
1085
1123
        # Get the stacked_on branch, if any
1086
1124
        if stacked_on is not None:
1087
1125
            stacked_on = urlutils.normalize_url(stacked_on)
1119
1157
 
1120
1158
 
1121
1159
class cmd_branch(Command):
1122
 
    __doc__ = """Create a new branch that is a copy of an existing branch.
 
1160
    """Create a new branch that is a copy of an existing branch.
1123
1161
 
1124
1162
    If the TO_LOCATION is omitted, the last component of the FROM_LOCATION will
1125
1163
    be used.  In other words, "branch ../foo/bar" will attempt to create ./bar.
1134
1172
 
1135
1173
    _see_also = ['checkout']
1136
1174
    takes_args = ['from_location', 'to_location?']
1137
 
    takes_options = ['revision',
1138
 
        Option('hardlink', help='Hard-link working tree files where possible.'),
1139
 
        Option('files-from', type=str,
1140
 
               help="Get file contents from this tree."),
 
1175
    takes_options = ['revision', Option('hardlink',
 
1176
        help='Hard-link working tree files where possible.'),
1141
1177
        Option('no-tree',
1142
1178
            help="Create a branch without a working-tree."),
1143
1179
        Option('switch',
1154
1190
                    ' directory exists, but does not already'
1155
1191
                    ' have a control directory.  This flag will'
1156
1192
                    ' allow branch to proceed.'),
1157
 
        Option('bind',
1158
 
            help="Bind new branch to from location."),
1159
1193
        ]
1160
1194
    aliases = ['get', 'clone']
1161
1195
 
1162
1196
    def run(self, from_location, to_location=None, revision=None,
1163
1197
            hardlink=False, stacked=False, standalone=False, no_tree=False,
1164
 
            use_existing_dir=False, switch=False, bind=False,
1165
 
            files_from=None):
 
1198
            use_existing_dir=False, switch=False):
1166
1199
        from bzrlib import switch as _mod_switch
1167
1200
        from bzrlib.tag import _merge_tags_if_possible
1168
1201
        accelerator_tree, br_from = bzrdir.BzrDir.open_tree_or_branch(
1169
1202
            from_location)
1170
 
        if not (hardlink or files_from):
1171
 
            # accelerator_tree is usually slower because you have to read N
1172
 
            # files (no readahead, lots of seeks, etc), but allow the user to
1173
 
            # explicitly request it
 
1203
        if (accelerator_tree is not None and
 
1204
            accelerator_tree.supports_content_filtering()):
1174
1205
            accelerator_tree = None
1175
 
        if files_from is not None and files_from != from_location:
1176
 
            accelerator_tree = WorkingTree.open(files_from)
1177
1206
        revision = _get_one_revision('branch', revision)
1178
 
        self.add_cleanup(br_from.lock_read().unlock)
1179
 
        if revision is not None:
1180
 
            revision_id = revision.as_revision_id(br_from)
1181
 
        else:
1182
 
            # FIXME - wt.last_revision, fallback to branch, fall back to
1183
 
            # None or perhaps NULL_REVISION to mean copy nothing
1184
 
            # RBC 20060209
1185
 
            revision_id = br_from.last_revision()
1186
 
        if to_location is None:
1187
 
            to_location = urlutils.derive_to_location(from_location)
1188
 
        to_transport = transport.get_transport(to_location)
 
1207
        br_from.lock_read()
1189
1208
        try:
1190
 
            to_transport.mkdir('.')
1191
 
        except errors.FileExists:
1192
 
            if not use_existing_dir:
1193
 
                raise errors.BzrCommandError('Target directory "%s" '
1194
 
                    'already exists.' % to_location)
 
1209
            if revision is not None:
 
1210
                revision_id = revision.as_revision_id(br_from)
1195
1211
            else:
1196
 
                try:
1197
 
                    bzrdir.BzrDir.open_from_transport(to_transport)
1198
 
                except errors.NotBranchError:
1199
 
                    pass
 
1212
                # FIXME - wt.last_revision, fallback to branch, fall back to
 
1213
                # None or perhaps NULL_REVISION to mean copy nothing
 
1214
                # RBC 20060209
 
1215
                revision_id = br_from.last_revision()
 
1216
            if to_location is None:
 
1217
                to_location = urlutils.derive_to_location(from_location)
 
1218
            to_transport = transport.get_transport(to_location)
 
1219
            try:
 
1220
                to_transport.mkdir('.')
 
1221
            except errors.FileExists:
 
1222
                if not use_existing_dir:
 
1223
                    raise errors.BzrCommandError('Target directory "%s" '
 
1224
                        'already exists.' % to_location)
1200
1225
                else:
1201
 
                    raise errors.AlreadyBranchError(to_location)
1202
 
        except errors.NoSuchFile:
1203
 
            raise errors.BzrCommandError('Parent of "%s" does not exist.'
1204
 
                                         % to_location)
1205
 
        try:
1206
 
            # preserve whatever source format we have.
1207
 
            dir = br_from.bzrdir.sprout(to_transport.base, revision_id,
1208
 
                                        possible_transports=[to_transport],
1209
 
                                        accelerator_tree=accelerator_tree,
1210
 
                                        hardlink=hardlink, stacked=stacked,
1211
 
                                        force_new_repo=standalone,
1212
 
                                        create_tree_if_local=not no_tree,
1213
 
                                        source_branch=br_from)
1214
 
            branch = dir.open_branch()
1215
 
        except errors.NoSuchRevision:
1216
 
            to_transport.delete_tree('.')
1217
 
            msg = "The branch %s has no revision %s." % (from_location,
1218
 
                revision)
1219
 
            raise errors.BzrCommandError(msg)
1220
 
        _merge_tags_if_possible(br_from, branch)
1221
 
        # If the source branch is stacked, the new branch may
1222
 
        # be stacked whether we asked for that explicitly or not.
1223
 
        # We therefore need a try/except here and not just 'if stacked:'
1224
 
        try:
1225
 
            note('Created new stacked branch referring to %s.' %
1226
 
                branch.get_stacked_on_url())
1227
 
        except (errors.NotStacked, errors.UnstackableBranchFormat,
1228
 
            errors.UnstackableRepositoryFormat), e:
1229
 
            note('Branched %d revision(s).' % branch.revno())
1230
 
        if bind:
1231
 
            # Bind to the parent
1232
 
            parent_branch = Branch.open(from_location)
1233
 
            branch.bind(parent_branch)
1234
 
            note('New branch bound to %s' % from_location)
1235
 
        if switch:
1236
 
            # Switch to the new branch
1237
 
            wt, _ = WorkingTree.open_containing('.')
1238
 
            _mod_switch.switch(wt.bzrdir, branch)
1239
 
            note('Switched to branch: %s',
1240
 
                urlutils.unescape_for_display(branch.base, 'utf-8'))
 
1226
                    try:
 
1227
                        bzrdir.BzrDir.open_from_transport(to_transport)
 
1228
                    except errors.NotBranchError:
 
1229
                        pass
 
1230
                    else:
 
1231
                        raise errors.AlreadyBranchError(to_location)
 
1232
            except errors.NoSuchFile:
 
1233
                raise errors.BzrCommandError('Parent of "%s" does not exist.'
 
1234
                                             % to_location)
 
1235
            try:
 
1236
                # preserve whatever source format we have.
 
1237
                dir = br_from.bzrdir.sprout(to_transport.base, revision_id,
 
1238
                                            possible_transports=[to_transport],
 
1239
                                            accelerator_tree=accelerator_tree,
 
1240
                                            hardlink=hardlink, stacked=stacked,
 
1241
                                            force_new_repo=standalone,
 
1242
                                            create_tree_if_local=not no_tree,
 
1243
                                            source_branch=br_from)
 
1244
                branch = dir.open_branch()
 
1245
            except errors.NoSuchRevision:
 
1246
                to_transport.delete_tree('.')
 
1247
                msg = "The branch %s has no revision %s." % (from_location,
 
1248
                    revision)
 
1249
                raise errors.BzrCommandError(msg)
 
1250
            _merge_tags_if_possible(br_from, branch)
 
1251
            # If the source branch is stacked, the new branch may
 
1252
            # be stacked whether we asked for that explicitly or not.
 
1253
            # We therefore need a try/except here and not just 'if stacked:'
 
1254
            try:
 
1255
                note('Created new stacked branch referring to %s.' %
 
1256
                    branch.get_stacked_on_url())
 
1257
            except (errors.NotStacked, errors.UnstackableBranchFormat,
 
1258
                errors.UnstackableRepositoryFormat), e:
 
1259
                note('Branched %d revision(s).' % branch.revno())
 
1260
            if switch:
 
1261
                # Switch to the new branch
 
1262
                wt, _ = WorkingTree.open_containing('.')
 
1263
                _mod_switch.switch(wt.bzrdir, branch)
 
1264
                note('Switched to branch: %s',
 
1265
                    urlutils.unescape_for_display(branch.base, 'utf-8'))
 
1266
        finally:
 
1267
            br_from.unlock()
1241
1268
 
1242
1269
 
1243
1270
class cmd_checkout(Command):
1244
 
    __doc__ = """Create a new checkout of an existing branch.
 
1271
    """Create a new checkout of an existing branch.
1245
1272
 
1246
1273
    If BRANCH_LOCATION is omitted, checkout will reconstitute a working tree for
1247
1274
    the branch found in '.'. This is useful if you have removed the working tree
1286
1313
            to_location = branch_location
1287
1314
        accelerator_tree, source = bzrdir.BzrDir.open_tree_or_branch(
1288
1315
            branch_location)
1289
 
        if not (hardlink or files_from):
1290
 
            # accelerator_tree is usually slower because you have to read N
1291
 
            # files (no readahead, lots of seeks, etc), but allow the user to
1292
 
            # explicitly request it
1293
 
            accelerator_tree = None
1294
1316
        revision = _get_one_revision('checkout', revision)
1295
 
        if files_from is not None and files_from != branch_location:
 
1317
        if files_from is not None:
1296
1318
            accelerator_tree = WorkingTree.open(files_from)
1297
1319
        if revision is not None:
1298
1320
            revision_id = revision.as_revision_id(source)
1315
1337
 
1316
1338
 
1317
1339
class cmd_renames(Command):
1318
 
    __doc__ = """Show list of renamed files.
 
1340
    """Show list of renamed files.
1319
1341
    """
1320
1342
    # TODO: Option to show renames between two historical versions.
1321
1343
 
1326
1348
    @display_command
1327
1349
    def run(self, dir=u'.'):
1328
1350
        tree = WorkingTree.open_containing(dir)[0]
1329
 
        self.add_cleanup(tree.lock_read().unlock)
1330
 
        new_inv = tree.inventory
1331
 
        old_tree = tree.basis_tree()
1332
 
        self.add_cleanup(old_tree.lock_read().unlock)
1333
 
        old_inv = old_tree.inventory
1334
 
        renames = []
1335
 
        iterator = tree.iter_changes(old_tree, include_unchanged=True)
1336
 
        for f, paths, c, v, p, n, k, e in iterator:
1337
 
            if paths[0] == paths[1]:
1338
 
                continue
1339
 
            if None in (paths):
1340
 
                continue
1341
 
            renames.append(paths)
1342
 
        renames.sort()
1343
 
        for old_name, new_name in renames:
1344
 
            self.outf.write("%s => %s\n" % (old_name, new_name))
 
1351
        tree.lock_read()
 
1352
        try:
 
1353
            new_inv = tree.inventory
 
1354
            old_tree = tree.basis_tree()
 
1355
            old_tree.lock_read()
 
1356
            try:
 
1357
                old_inv = old_tree.inventory
 
1358
                renames = []
 
1359
                iterator = tree.iter_changes(old_tree, include_unchanged=True)
 
1360
                for f, paths, c, v, p, n, k, e in iterator:
 
1361
                    if paths[0] == paths[1]:
 
1362
                        continue
 
1363
                    if None in (paths):
 
1364
                        continue
 
1365
                    renames.append(paths)
 
1366
                renames.sort()
 
1367
                for old_name, new_name in renames:
 
1368
                    self.outf.write("%s => %s\n" % (old_name, new_name))
 
1369
            finally:
 
1370
                old_tree.unlock()
 
1371
        finally:
 
1372
            tree.unlock()
1345
1373
 
1346
1374
 
1347
1375
class cmd_update(Command):
1348
 
    __doc__ = """Update a tree to have the latest code committed to its branch.
 
1376
    """Update a tree to have the latest code committed to its branch.
1349
1377
 
1350
1378
    This will perform a merge into the working tree, and may generate
1351
1379
    conflicts. If you have any local changes, you will still
1353
1381
 
1354
1382
    If you want to discard your local changes, you can just do a
1355
1383
    'bzr revert' instead of 'bzr commit' after the update.
1356
 
 
1357
 
    If you want to restore a file that has been removed locally, use
1358
 
    'bzr revert' instead of 'bzr update'.
1359
 
 
1360
 
    If the tree's branch is bound to a master branch, it will also update
1361
 
    the branch from the master.
1362
1384
    """
1363
1385
 
1364
1386
    _see_also = ['pull', 'working-trees', 'status-flags']
1365
1387
    takes_args = ['dir?']
1366
 
    takes_options = ['revision']
1367
1388
    aliases = ['up']
1368
1389
 
1369
 
    def run(self, dir='.', revision=None):
1370
 
        if revision is not None and len(revision) != 1:
1371
 
            raise errors.BzrCommandError(
1372
 
                        "bzr update --revision takes exactly one revision")
 
1390
    def run(self, dir='.'):
1373
1391
        tree = WorkingTree.open_containing(dir)[0]
1374
 
        branch = tree.branch
1375
1392
        possible_transports = []
1376
 
        master = branch.get_master_branch(
 
1393
        master = tree.branch.get_master_branch(
1377
1394
            possible_transports=possible_transports)
1378
1395
        if master is not None:
1379
 
            branch_location = master.base
1380
1396
            tree.lock_write()
1381
1397
        else:
1382
 
            branch_location = tree.branch.base
1383
1398
            tree.lock_tree_write()
1384
 
        self.add_cleanup(tree.unlock)
1385
 
        # get rid of the final '/' and be ready for display
1386
 
        branch_location = urlutils.unescape_for_display(
1387
 
            branch_location.rstrip('/'),
1388
 
            self.outf.encoding)
1389
 
        existing_pending_merges = tree.get_parent_ids()[1:]
1390
 
        if master is None:
1391
 
            old_tip = None
1392
 
        else:
1393
 
            # may need to fetch data into a heavyweight checkout
1394
 
            # XXX: this may take some time, maybe we should display a
1395
 
            # message
1396
 
            old_tip = branch.update(possible_transports)
1397
 
        if revision is not None:
1398
 
            revision_id = revision[0].as_revision_id(branch)
1399
 
        else:
1400
 
            revision_id = branch.last_revision()
1401
 
        if revision_id == _mod_revision.ensure_null(tree.last_revision()):
1402
 
            revno = branch.revision_id_to_dotted_revno(revision_id)
1403
 
            note("Tree is up to date at revision %s of branch %s" %
1404
 
                ('.'.join(map(str, revno)), branch_location))
1405
 
            return 0
1406
 
        view_info = _get_view_info_for_change_reporter(tree)
1407
 
        change_reporter = delta._ChangeReporter(
1408
 
            unversioned_filter=tree.is_ignored,
1409
 
            view_info=view_info)
1410
1399
        try:
 
1400
            existing_pending_merges = tree.get_parent_ids()[1:]
 
1401
            last_rev = _mod_revision.ensure_null(tree.last_revision())
 
1402
            if last_rev == _mod_revision.ensure_null(
 
1403
                tree.branch.last_revision()):
 
1404
                # may be up to date, check master too.
 
1405
                if master is None or last_rev == _mod_revision.ensure_null(
 
1406
                    master.last_revision()):
 
1407
                    revno = tree.branch.revision_id_to_revno(last_rev)
 
1408
                    note("Tree is up to date at revision %d." % (revno,))
 
1409
                    return 0
 
1410
            view_info = _get_view_info_for_change_reporter(tree)
1411
1411
            conflicts = tree.update(
1412
 
                change_reporter,
1413
 
                possible_transports=possible_transports,
1414
 
                revision=revision_id,
1415
 
                old_tip=old_tip)
1416
 
        except errors.NoSuchRevision, e:
1417
 
            raise errors.BzrCommandError(
1418
 
                                  "branch has no revision %s\n"
1419
 
                                  "bzr update --revision only works"
1420
 
                                  " for a revision in the branch history"
1421
 
                                  % (e.revision))
1422
 
        revno = tree.branch.revision_id_to_dotted_revno(
1423
 
            _mod_revision.ensure_null(tree.last_revision()))
1424
 
        note('Updated to revision %s of branch %s' %
1425
 
             ('.'.join(map(str, revno)), branch_location))
1426
 
        parent_ids = tree.get_parent_ids()
1427
 
        if parent_ids[1:] and parent_ids[1:] != existing_pending_merges:
1428
 
            note('Your local commits will now show as pending merges with '
1429
 
                 "'bzr status', and can be committed with 'bzr commit'.")
1430
 
        if conflicts != 0:
1431
 
            return 1
1432
 
        else:
1433
 
            return 0
 
1412
                delta._ChangeReporter(unversioned_filter=tree.is_ignored,
 
1413
                view_info=view_info), possible_transports=possible_transports)
 
1414
            revno = tree.branch.revision_id_to_revno(
 
1415
                _mod_revision.ensure_null(tree.last_revision()))
 
1416
            note('Updated to revision %d.' % (revno,))
 
1417
            if tree.get_parent_ids()[1:] != existing_pending_merges:
 
1418
                note('Your local commits will now show as pending merges with '
 
1419
                     "'bzr status', and can be committed with 'bzr commit'.")
 
1420
            if conflicts != 0:
 
1421
                return 1
 
1422
            else:
 
1423
                return 0
 
1424
        finally:
 
1425
            tree.unlock()
1434
1426
 
1435
1427
 
1436
1428
class cmd_info(Command):
1437
 
    __doc__ = """Show information about a working tree, branch or repository.
 
1429
    """Show information about a working tree, branch or repository.
1438
1430
 
1439
1431
    This command will show all known locations and formats associated to the
1440
1432
    tree, branch or repository.
1478
1470
 
1479
1471
 
1480
1472
class cmd_remove(Command):
1481
 
    __doc__ = """Remove files or directories.
 
1473
    """Remove files or directories.
1482
1474
 
1483
 
    This makes Bazaar stop tracking changes to the specified files. Bazaar will
1484
 
    delete them if they can easily be recovered using revert otherwise they
1485
 
    will be backed up (adding an extention of the form .~#~). If no options or
1486
 
    parameters are given Bazaar will scan for files that are being tracked by
1487
 
    Bazaar but missing in your tree and stop tracking them for you.
 
1475
    This makes bzr stop tracking changes to the specified files. bzr will delete
 
1476
    them if they can easily be recovered using revert. If no options or
 
1477
    parameters are given bzr will scan for files that are being tracked by bzr
 
1478
    but missing in your tree and stop tracking them for you.
1488
1479
    """
1489
1480
    takes_args = ['file*']
1490
1481
    takes_options = ['verbose',
1492
1483
        RegistryOption.from_kwargs('file-deletion-strategy',
1493
1484
            'The file deletion mode to be used.',
1494
1485
            title='Deletion Strategy', value_switches=True, enum_switch=False,
1495
 
            safe='Backup changed files (default).',
 
1486
            safe='Only delete files if they can be'
 
1487
                 ' safely recovered (default).',
1496
1488
            keep='Delete from bzr but leave the working copy.',
1497
1489
            force='Delete all the specified files, even if they can not be '
1498
1490
                'recovered and even if they are non-empty directories.')]
1501
1493
 
1502
1494
    def run(self, file_list, verbose=False, new=False,
1503
1495
        file_deletion_strategy='safe'):
1504
 
        tree, file_list = WorkingTree.open_containing_paths(file_list)
 
1496
        tree, file_list = tree_files(file_list)
1505
1497
 
1506
1498
        if file_list is not None:
1507
1499
            file_list = [f for f in file_list]
1508
1500
 
1509
 
        self.add_cleanup(tree.lock_write().unlock)
1510
 
        # Heuristics should probably all move into tree.remove_smart or
1511
 
        # some such?
1512
 
        if new:
1513
 
            added = tree.changes_from(tree.basis_tree(),
1514
 
                specific_files=file_list).added
1515
 
            file_list = sorted([f[0] for f in added], reverse=True)
1516
 
            if len(file_list) == 0:
1517
 
                raise errors.BzrCommandError('No matching files.')
1518
 
        elif file_list is None:
1519
 
            # missing files show up in iter_changes(basis) as
1520
 
            # versioned-with-no-kind.
1521
 
            missing = []
1522
 
            for change in tree.iter_changes(tree.basis_tree()):
1523
 
                # Find paths in the working tree that have no kind:
1524
 
                if change[1][1] is not None and change[6][1] is None:
1525
 
                    missing.append(change[1][1])
1526
 
            file_list = sorted(missing, reverse=True)
1527
 
            file_deletion_strategy = 'keep'
1528
 
        tree.remove(file_list, verbose=verbose, to_file=self.outf,
1529
 
            keep_files=file_deletion_strategy=='keep',
1530
 
            force=file_deletion_strategy=='force')
 
1501
        tree.lock_write()
 
1502
        try:
 
1503
            # Heuristics should probably all move into tree.remove_smart or
 
1504
            # some such?
 
1505
            if new:
 
1506
                added = tree.changes_from(tree.basis_tree(),
 
1507
                    specific_files=file_list).added
 
1508
                file_list = sorted([f[0] for f in added], reverse=True)
 
1509
                if len(file_list) == 0:
 
1510
                    raise errors.BzrCommandError('No matching files.')
 
1511
            elif file_list is None:
 
1512
                # missing files show up in iter_changes(basis) as
 
1513
                # versioned-with-no-kind.
 
1514
                missing = []
 
1515
                for change in tree.iter_changes(tree.basis_tree()):
 
1516
                    # Find paths in the working tree that have no kind:
 
1517
                    if change[1][1] is not None and change[6][1] is None:
 
1518
                        missing.append(change[1][1])
 
1519
                file_list = sorted(missing, reverse=True)
 
1520
                file_deletion_strategy = 'keep'
 
1521
            tree.remove(file_list, verbose=verbose, to_file=self.outf,
 
1522
                keep_files=file_deletion_strategy=='keep',
 
1523
                force=file_deletion_strategy=='force')
 
1524
        finally:
 
1525
            tree.unlock()
1531
1526
 
1532
1527
 
1533
1528
class cmd_file_id(Command):
1534
 
    __doc__ = """Print file_id of a particular file or directory.
 
1529
    """Print file_id of a particular file or directory.
1535
1530
 
1536
1531
    The file_id is assigned when the file is first added and remains the
1537
1532
    same through all revisions where the file exists, even when it is
1553
1548
 
1554
1549
 
1555
1550
class cmd_file_path(Command):
1556
 
    __doc__ = """Print path of file_ids to a file or directory.
 
1551
    """Print path of file_ids to a file or directory.
1557
1552
 
1558
1553
    This prints one line for each directory down to the target,
1559
1554
    starting at the branch root.
1575
1570
 
1576
1571
 
1577
1572
class cmd_reconcile(Command):
1578
 
    __doc__ = """Reconcile bzr metadata in a branch.
 
1573
    """Reconcile bzr metadata in a branch.
1579
1574
 
1580
1575
    This can correct data mismatches that may have been caused by
1581
1576
    previous ghost operations or bzr upgrades. You should only
1595
1590
 
1596
1591
    _see_also = ['check']
1597
1592
    takes_args = ['branch?']
1598
 
    takes_options = [
1599
 
        Option('canonicalize-chks',
1600
 
               help='Make sure CHKs are in canonical form (repairs '
1601
 
                    'bug 522637).',
1602
 
               hidden=True),
1603
 
        ]
1604
1593
 
1605
 
    def run(self, branch=".", canonicalize_chks=False):
 
1594
    def run(self, branch="."):
1606
1595
        from bzrlib.reconcile import reconcile
1607
1596
        dir = bzrdir.BzrDir.open(branch)
1608
 
        reconcile(dir, canonicalize_chks=canonicalize_chks)
 
1597
        reconcile(dir)
1609
1598
 
1610
1599
 
1611
1600
class cmd_revision_history(Command):
1612
 
    __doc__ = """Display the list of revision ids on a branch."""
 
1601
    """Display the list of revision ids on a branch."""
1613
1602
 
1614
1603
    _see_also = ['log']
1615
1604
    takes_args = ['location?']
1625
1614
 
1626
1615
 
1627
1616
class cmd_ancestry(Command):
1628
 
    __doc__ = """List all revisions merged into this branch."""
 
1617
    """List all revisions merged into this branch."""
1629
1618
 
1630
1619
    _see_also = ['log', 'revision-history']
1631
1620
    takes_args = ['location?']
1650
1639
 
1651
1640
 
1652
1641
class cmd_init(Command):
1653
 
    __doc__ = """Make a directory into a versioned branch.
 
1642
    """Make a directory into a versioned branch.
1654
1643
 
1655
1644
    Use this to create an empty branch, or before importing an
1656
1645
    existing project.
1684
1673
                lazy_registry=('bzrlib.bzrdir', 'format_registry'),
1685
1674
                converter=lambda name: bzrdir.format_registry.make_bzrdir(name),
1686
1675
                value_switches=True,
1687
 
                title="Branch format",
 
1676
                title="Branch Format",
1688
1677
                ),
1689
1678
         Option('append-revisions-only',
1690
1679
                help='Never change revnos or the existing log.'
1759
1748
 
1760
1749
 
1761
1750
class cmd_init_repository(Command):
1762
 
    __doc__ = """Create a shared repository for branches to share storage space.
 
1751
    """Create a shared repository to hold branches.
1763
1752
 
1764
1753
    New branches created under the repository directory will store their
1765
 
    revisions in the repository, not in the branch directory.  For branches
1766
 
    with shared history, this reduces the amount of storage needed and 
1767
 
    speeds up the creation of new branches.
 
1754
    revisions in the repository, not in the branch directory.
1768
1755
 
1769
 
    If the --no-trees option is given then the branches in the repository
1770
 
    will not have working trees by default.  They will still exist as 
1771
 
    directories on disk, but they will not have separate copies of the 
1772
 
    files at a certain revision.  This can be useful for repositories that
1773
 
    store branches which are interacted with through checkouts or remote
1774
 
    branches, such as on a server.
 
1756
    If the --no-trees option is used then the branches in the repository
 
1757
    will not have working trees by default.
1775
1758
 
1776
1759
    :Examples:
1777
 
        Create a shared repository holding just branches::
 
1760
        Create a shared repositories holding just branches::
1778
1761
 
1779
1762
            bzr init-repo --no-trees repo
1780
1763
            bzr init repo/trunk
1819
1802
 
1820
1803
 
1821
1804
class cmd_diff(Command):
1822
 
    __doc__ = """Show differences in the working tree, between revisions or branches.
 
1805
    """Show differences in the working tree, between revisions or branches.
1823
1806
 
1824
1807
    If no arguments are given, all changes for the current tree are listed.
1825
1808
    If files are given, only the changes in those files are listed.
1846
1829
 
1847
1830
            bzr diff -r1
1848
1831
 
1849
 
        Difference between revision 3 and revision 1::
1850
 
 
1851
 
            bzr diff -r1..3
1852
 
 
1853
 
        Difference between revision 3 and revision 1 for branch xxx::
1854
 
 
1855
 
            bzr diff -r1..3 xxx
1856
 
 
1857
 
        To see the changes introduced in revision X::
1858
 
        
1859
 
            bzr diff -cX
1860
 
 
1861
 
        Note that in the case of a merge, the -c option shows the changes
1862
 
        compared to the left hand parent. To see the changes against
1863
 
        another parent, use::
1864
 
 
1865
 
            bzr diff -r<chosen_parent>..X
1866
 
 
1867
 
        The changes introduced by revision 2 (equivalent to -r1..2)::
1868
 
 
1869
 
            bzr diff -c2
 
1832
        Difference between revision 2 and revision 1::
 
1833
 
 
1834
            bzr diff -r1..2
 
1835
 
 
1836
        Difference between revision 2 and revision 1 for branch xxx::
 
1837
 
 
1838
            bzr diff -r1..2 xxx
1870
1839
 
1871
1840
        Show just the differences for file NEWS::
1872
1841
 
1887
1856
        Same as 'bzr diff' but prefix paths with old/ and new/::
1888
1857
 
1889
1858
            bzr diff --prefix old/:new/
1890
 
            
1891
 
        Show the differences using a custom diff program with options::
1892
 
        
1893
 
            bzr diff --using /usr/bin/diff --diff-options -wu
1894
1859
    """
1895
1860
    _see_also = ['status']
1896
1861
    takes_args = ['file*']
1915
1880
            help='Use this command to compare files.',
1916
1881
            type=unicode,
1917
1882
            ),
1918
 
        RegistryOption('format',
1919
 
            help='Diff format to use.',
1920
 
            lazy_registry=('bzrlib.diff', 'format_registry'),
1921
 
            value_switches=False, title='Diff format'),
1922
1883
        ]
1923
1884
    aliases = ['di', 'dif']
1924
1885
    encoding_type = 'exact'
1925
1886
 
1926
1887
    @display_command
1927
1888
    def run(self, revision=None, file_list=None, diff_options=None,
1928
 
            prefix=None, old=None, new=None, using=None, format=None):
1929
 
        from bzrlib.diff import (get_trees_and_branches_to_diff_locked,
1930
 
            show_diff_trees)
 
1889
            prefix=None, old=None, new=None, using=None):
 
1890
        from bzrlib.diff import _get_trees_to_diff, show_diff_trees
1931
1891
 
1932
1892
        if (prefix is None) or (prefix == '0'):
1933
1893
            # diff -p0 format
1947
1907
            raise errors.BzrCommandError('bzr diff --revision takes exactly'
1948
1908
                                         ' one or two revision specifiers')
1949
1909
 
1950
 
        if using is not None and format is not None:
1951
 
            raise errors.BzrCommandError('--using and --format are mutually '
1952
 
                'exclusive.')
1953
 
 
1954
 
        (old_tree, new_tree,
1955
 
         old_branch, new_branch,
1956
 
         specific_files, extra_trees) = get_trees_and_branches_to_diff_locked(
1957
 
            file_list, revision, old, new, self.add_cleanup, apply_view=True)
1958
 
        # GNU diff on Windows uses ANSI encoding for filenames
1959
 
        path_encoding = osutils.get_diff_header_encoding()
 
1910
        old_tree, new_tree, specific_files, extra_trees = \
 
1911
                _get_trees_to_diff(file_list, revision, old, new,
 
1912
                apply_view=True)
1960
1913
        return show_diff_trees(old_tree, new_tree, sys.stdout,
1961
1914
                               specific_files=specific_files,
1962
1915
                               external_diff_options=diff_options,
1963
1916
                               old_label=old_label, new_label=new_label,
1964
 
                               extra_trees=extra_trees,
1965
 
                               path_encoding=path_encoding,
1966
 
                               using=using,
1967
 
                               format_cls=format)
 
1917
                               extra_trees=extra_trees, using=using)
1968
1918
 
1969
1919
 
1970
1920
class cmd_deleted(Command):
1971
 
    __doc__ = """List files deleted in the working tree.
 
1921
    """List files deleted in the working tree.
1972
1922
    """
1973
1923
    # TODO: Show files deleted since a previous revision, or
1974
1924
    # between two revisions.
1977
1927
    # level of effort but possibly much less IO.  (Or possibly not,
1978
1928
    # if the directories are very large...)
1979
1929
    _see_also = ['status', 'ls']
1980
 
    takes_options = ['directory', 'show-ids']
 
1930
    takes_options = ['show-ids']
1981
1931
 
1982
1932
    @display_command
1983
 
    def run(self, show_ids=False, directory=u'.'):
1984
 
        tree = WorkingTree.open_containing(directory)[0]
1985
 
        self.add_cleanup(tree.lock_read().unlock)
1986
 
        old = tree.basis_tree()
1987
 
        self.add_cleanup(old.lock_read().unlock)
1988
 
        for path, ie in old.inventory.iter_entries():
1989
 
            if not tree.has_id(ie.file_id):
1990
 
                self.outf.write(path)
1991
 
                if show_ids:
1992
 
                    self.outf.write(' ')
1993
 
                    self.outf.write(ie.file_id)
1994
 
                self.outf.write('\n')
 
1933
    def run(self, show_ids=False):
 
1934
        tree = WorkingTree.open_containing(u'.')[0]
 
1935
        tree.lock_read()
 
1936
        try:
 
1937
            old = tree.basis_tree()
 
1938
            old.lock_read()
 
1939
            try:
 
1940
                for path, ie in old.inventory.iter_entries():
 
1941
                    if not tree.has_id(ie.file_id):
 
1942
                        self.outf.write(path)
 
1943
                        if show_ids:
 
1944
                            self.outf.write(' ')
 
1945
                            self.outf.write(ie.file_id)
 
1946
                        self.outf.write('\n')
 
1947
            finally:
 
1948
                old.unlock()
 
1949
        finally:
 
1950
            tree.unlock()
1995
1951
 
1996
1952
 
1997
1953
class cmd_modified(Command):
1998
 
    __doc__ = """List files modified in working tree.
 
1954
    """List files modified in working tree.
1999
1955
    """
2000
1956
 
2001
1957
    hidden = True
2002
1958
    _see_also = ['status', 'ls']
2003
 
    takes_options = ['directory', 'null']
 
1959
    takes_options = [
 
1960
            Option('null',
 
1961
                   help='Write an ascii NUL (\\0) separator '
 
1962
                   'between files rather than a newline.')
 
1963
            ]
2004
1964
 
2005
1965
    @display_command
2006
 
    def run(self, null=False, directory=u'.'):
2007
 
        tree = WorkingTree.open_containing(directory)[0]
 
1966
    def run(self, null=False):
 
1967
        tree = WorkingTree.open_containing(u'.')[0]
2008
1968
        td = tree.changes_from(tree.basis_tree())
2009
1969
        for path, id, kind, text_modified, meta_modified in td.modified:
2010
1970
            if null:
2014
1974
 
2015
1975
 
2016
1976
class cmd_added(Command):
2017
 
    __doc__ = """List files added in working tree.
 
1977
    """List files added in working tree.
2018
1978
    """
2019
1979
 
2020
1980
    hidden = True
2021
1981
    _see_also = ['status', 'ls']
2022
 
    takes_options = ['directory', 'null']
 
1982
    takes_options = [
 
1983
            Option('null',
 
1984
                   help='Write an ascii NUL (\\0) separator '
 
1985
                   'between files rather than a newline.')
 
1986
            ]
2023
1987
 
2024
1988
    @display_command
2025
 
    def run(self, null=False, directory=u'.'):
2026
 
        wt = WorkingTree.open_containing(directory)[0]
2027
 
        self.add_cleanup(wt.lock_read().unlock)
2028
 
        basis = wt.basis_tree()
2029
 
        self.add_cleanup(basis.lock_read().unlock)
2030
 
        basis_inv = basis.inventory
2031
 
        inv = wt.inventory
2032
 
        for file_id in inv:
2033
 
            if file_id in basis_inv:
2034
 
                continue
2035
 
            if inv.is_root(file_id) and len(basis_inv) == 0:
2036
 
                continue
2037
 
            path = inv.id2path(file_id)
2038
 
            if not os.access(osutils.pathjoin(wt.basedir, path), os.F_OK):
2039
 
                continue
2040
 
            if null:
2041
 
                self.outf.write(path + '\0')
2042
 
            else:
2043
 
                self.outf.write(osutils.quotefn(path) + '\n')
 
1989
    def run(self, null=False):
 
1990
        wt = WorkingTree.open_containing(u'.')[0]
 
1991
        wt.lock_read()
 
1992
        try:
 
1993
            basis = wt.basis_tree()
 
1994
            basis.lock_read()
 
1995
            try:
 
1996
                basis_inv = basis.inventory
 
1997
                inv = wt.inventory
 
1998
                for file_id in inv:
 
1999
                    if file_id in basis_inv:
 
2000
                        continue
 
2001
                    if inv.is_root(file_id) and len(basis_inv) == 0:
 
2002
                        continue
 
2003
                    path = inv.id2path(file_id)
 
2004
                    if not os.access(osutils.abspath(path), os.F_OK):
 
2005
                        continue
 
2006
                    if null:
 
2007
                        self.outf.write(path + '\0')
 
2008
                    else:
 
2009
                        self.outf.write(osutils.quotefn(path) + '\n')
 
2010
            finally:
 
2011
                basis.unlock()
 
2012
        finally:
 
2013
            wt.unlock()
2044
2014
 
2045
2015
 
2046
2016
class cmd_root(Command):
2047
 
    __doc__ = """Show the tree root directory.
 
2017
    """Show the tree root directory.
2048
2018
 
2049
2019
    The root is the nearest enclosing directory with a .bzr control
2050
2020
    directory."""
2074
2044
 
2075
2045
 
2076
2046
class cmd_log(Command):
2077
 
    __doc__ = """Show historical log for a branch or subset of a branch.
 
2047
    """Show historical log for a branch or subset of a branch.
2078
2048
 
2079
2049
    log is bzr's default tool for exploring the history of a branch.
2080
2050
    The branch to use is taken from the first parameter. If no parameters
2191
2161
    :Tips & tricks:
2192
2162
 
2193
2163
      GUI tools and IDEs are often better at exploring history than command
2194
 
      line tools: you may prefer qlog or viz from qbzr or bzr-gtk, the
2195
 
      bzr-explorer shell, or the Loggerhead web interface.  See the Plugin
2196
 
      Guide <http://doc.bazaar.canonical.com/plugins/en/> and
2197
 
      <http://wiki.bazaar.canonical.com/IDEIntegration>.  
 
2164
      line tools. You may prefer qlog or glog from the QBzr and Bzr-Gtk packages
 
2165
      respectively for example. (TortoiseBzr uses qlog for displaying logs.) See
 
2166
      http://bazaar-vcs.org/BzrPlugins and http://bazaar-vcs.org/IDEIntegration.
 
2167
 
 
2168
      Web interfaces are often better at exploring history than command line
 
2169
      tools, particularly for branches on servers. You may prefer Loggerhead
 
2170
      or one of its alternatives. See http://bazaar-vcs.org/WebInterface.
2198
2171
 
2199
2172
      You may find it useful to add the aliases below to ``bazaar.conf``::
2200
2173
 
2241
2214
                   help='Show just the specified revision.'
2242
2215
                   ' See also "help revisionspec".'),
2243
2216
            'log-format',
2244
 
            RegistryOption('authors',
2245
 
                'What names to list as authors - first, all or committer.',
2246
 
                title='Authors',
2247
 
                lazy_registry=('bzrlib.log', 'author_list_registry'),
2248
 
            ),
2249
2217
            Option('levels',
2250
2218
                   short_name='n',
2251
2219
                   help='Number of levels to display - 0 for all, 1 for flat.',
2266
2234
                   help='Show changes made in each revision as a patch.'),
2267
2235
            Option('include-merges',
2268
2236
                   help='Show merged revisions like --levels 0 does.'),
2269
 
            Option('exclude-common-ancestry',
2270
 
                   help='Display only the revisions that are not part'
2271
 
                   ' of both ancestries (require -rX..Y)'
2272
 
                   )
2273
2237
            ]
2274
2238
    encoding_type = 'replace'
2275
2239
 
2285
2249
            message=None,
2286
2250
            limit=None,
2287
2251
            show_diff=False,
2288
 
            include_merges=False,
2289
 
            authors=None,
2290
 
            exclude_common_ancestry=False,
2291
 
            ):
 
2252
            include_merges=False):
2292
2253
        from bzrlib.log import (
2293
2254
            Logger,
2294
2255
            make_log_request_dict,
2295
2256
            _get_info_for_log_files,
2296
2257
            )
2297
2258
        direction = (forward and 'forward') or 'reverse'
2298
 
        if (exclude_common_ancestry
2299
 
            and (revision is None or len(revision) != 2)):
2300
 
            raise errors.BzrCommandError(
2301
 
                '--exclude-common-ancestry requires -r with two revisions')
2302
2259
        if include_merges:
2303
2260
            if levels is None:
2304
2261
                levels = 0
2319
2276
        filter_by_dir = False
2320
2277
        if file_list:
2321
2278
            # find the file ids to log and check for directory filtering
2322
 
            b, file_info_list, rev1, rev2 = _get_info_for_log_files(
2323
 
                revision, file_list, self.add_cleanup)
 
2279
            b, file_info_list, rev1, rev2 = _get_info_for_log_files(revision,
 
2280
                file_list)
2324
2281
            for relpath, file_id, kind in file_info_list:
2325
2282
                if file_id is None:
2326
2283
                    raise errors.BzrCommandError(
2344
2301
                location = '.'
2345
2302
            dir, relpath = bzrdir.BzrDir.open_containing(location)
2346
2303
            b = dir.open_branch()
2347
 
            self.add_cleanup(b.lock_read().unlock)
2348
2304
            rev1, rev2 = _get_revision_range(revision, b, self.name())
2349
2305
 
2350
2306
        # Decide on the type of delta & diff filtering to use
2360
2316
        else:
2361
2317
            diff_type = 'full'
2362
2318
 
2363
 
        # Build the log formatter
2364
 
        if log_format is None:
2365
 
            log_format = log.log_formatter_registry.get_default(b)
2366
 
        # Make a non-encoding output to include the diffs - bug 328007
2367
 
        unencoded_output = ui.ui_factory.make_output_stream(encoding_type='exact')
2368
 
        lf = log_format(show_ids=show_ids, to_file=self.outf,
2369
 
                        to_exact_file=unencoded_output,
2370
 
                        show_timezone=timezone,
2371
 
                        delta_format=get_verbosity_level(),
2372
 
                        levels=levels,
2373
 
                        show_advice=levels is None,
2374
 
                        author_list_handler=authors)
2375
 
 
2376
 
        # Choose the algorithm for doing the logging. It's annoying
2377
 
        # having multiple code paths like this but necessary until
2378
 
        # the underlying repository format is faster at generating
2379
 
        # deltas or can provide everything we need from the indices.
2380
 
        # The default algorithm - match-using-deltas - works for
2381
 
        # multiple files and directories and is faster for small
2382
 
        # amounts of history (200 revisions say). However, it's too
2383
 
        # slow for logging a single file in a repository with deep
2384
 
        # history, i.e. > 10K revisions. In the spirit of "do no
2385
 
        # evil when adding features", we continue to use the
2386
 
        # original algorithm - per-file-graph - for the "single
2387
 
        # file that isn't a directory without showing a delta" case.
2388
 
        partial_history = revision and b.repository._format.supports_chks
2389
 
        match_using_deltas = (len(file_ids) != 1 or filter_by_dir
2390
 
            or delta_type or partial_history)
2391
 
 
2392
 
        # Build the LogRequest and execute it
2393
 
        if len(file_ids) == 0:
2394
 
            file_ids = None
2395
 
        rqst = make_log_request_dict(
2396
 
            direction=direction, specific_fileids=file_ids,
2397
 
            start_revision=rev1, end_revision=rev2, limit=limit,
2398
 
            message_search=message, delta_type=delta_type,
2399
 
            diff_type=diff_type, _match_using_deltas=match_using_deltas,
2400
 
            exclude_common_ancestry=exclude_common_ancestry,
2401
 
            )
2402
 
        Logger(b, rqst).show(lf)
 
2319
        b.lock_read()
 
2320
        try:
 
2321
            # Build the log formatter
 
2322
            if log_format is None:
 
2323
                log_format = log.log_formatter_registry.get_default(b)
 
2324
            lf = log_format(show_ids=show_ids, to_file=self.outf,
 
2325
                            show_timezone=timezone,
 
2326
                            delta_format=get_verbosity_level(),
 
2327
                            levels=levels,
 
2328
                            show_advice=levels is None)
 
2329
 
 
2330
            # Choose the algorithm for doing the logging. It's annoying
 
2331
            # having multiple code paths like this but necessary until
 
2332
            # the underlying repository format is faster at generating
 
2333
            # deltas or can provide everything we need from the indices.
 
2334
            # The default algorithm - match-using-deltas - works for
 
2335
            # multiple files and directories and is faster for small
 
2336
            # amounts of history (200 revisions say). However, it's too
 
2337
            # slow for logging a single file in a repository with deep
 
2338
            # history, i.e. > 10K revisions. In the spirit of "do no
 
2339
            # evil when adding features", we continue to use the
 
2340
            # original algorithm - per-file-graph - for the "single
 
2341
            # file that isn't a directory without showing a delta" case.
 
2342
            partial_history = revision and b.repository._format.supports_chks
 
2343
            match_using_deltas = (len(file_ids) != 1 or filter_by_dir
 
2344
                or delta_type or partial_history)
 
2345
 
 
2346
            # Build the LogRequest and execute it
 
2347
            if len(file_ids) == 0:
 
2348
                file_ids = None
 
2349
            rqst = make_log_request_dict(
 
2350
                direction=direction, specific_fileids=file_ids,
 
2351
                start_revision=rev1, end_revision=rev2, limit=limit,
 
2352
                message_search=message, delta_type=delta_type,
 
2353
                diff_type=diff_type, _match_using_deltas=match_using_deltas)
 
2354
            Logger(b, rqst).show(lf)
 
2355
        finally:
 
2356
            b.unlock()
2403
2357
 
2404
2358
 
2405
2359
def _get_revision_range(revisionspec_list, branch, command_name):
2423
2377
            raise errors.BzrCommandError(
2424
2378
                "bzr %s doesn't accept two revisions in different"
2425
2379
                " branches." % command_name)
2426
 
        if start_spec.spec is None:
2427
 
            # Avoid loading all the history.
2428
 
            rev1 = RevisionInfo(branch, None, None)
2429
 
        else:
2430
 
            rev1 = start_spec.in_history(branch)
 
2380
        rev1 = start_spec.in_history(branch)
2431
2381
        # Avoid loading all of history when we know a missing
2432
2382
        # end of range means the last revision ...
2433
2383
        if end_spec.spec is None:
2462
2412
 
2463
2413
 
2464
2414
class cmd_touching_revisions(Command):
2465
 
    __doc__ = """Return revision-ids which affected a particular file.
 
2415
    """Return revision-ids which affected a particular file.
2466
2416
 
2467
2417
    A more user-friendly interface is "bzr log FILE".
2468
2418
    """
2473
2423
    @display_command
2474
2424
    def run(self, filename):
2475
2425
        tree, relpath = WorkingTree.open_containing(filename)
 
2426
        b = tree.branch
2476
2427
        file_id = tree.path2id(relpath)
2477
 
        b = tree.branch
2478
 
        self.add_cleanup(b.lock_read().unlock)
2479
 
        touching_revs = log.find_touching_revisions(b, file_id)
2480
 
        for revno, revision_id, what in touching_revs:
 
2428
        for revno, revision_id, what in log.find_touching_revisions(b, file_id):
2481
2429
            self.outf.write("%6d %s\n" % (revno, what))
2482
2430
 
2483
2431
 
2484
2432
class cmd_ls(Command):
2485
 
    __doc__ = """List files in a tree.
 
2433
    """List files in a tree.
2486
2434
    """
2487
2435
 
2488
2436
    _see_also = ['status', 'cat']
2494
2442
                   help='Recurse into subdirectories.'),
2495
2443
            Option('from-root',
2496
2444
                   help='Print paths relative to the root of the branch.'),
2497
 
            Option('unknown', short_name='u',
2498
 
                help='Print unknown files.'),
 
2445
            Option('unknown', help='Print unknown files.'),
2499
2446
            Option('versioned', help='Print versioned files.',
2500
2447
                   short_name='V'),
2501
 
            Option('ignored', short_name='i',
2502
 
                help='Print ignored files.'),
2503
 
            Option('kind', short_name='k',
 
2448
            Option('ignored', help='Print ignored files.'),
 
2449
            Option('null',
 
2450
                   help='Write an ascii NUL (\\0) separator '
 
2451
                   'between files rather than a newline.'),
 
2452
            Option('kind',
2504
2453
                   help='List entries of a particular kind: file, directory, symlink.',
2505
2454
                   type=unicode),
2506
 
            'null',
2507
2455
            'show-ids',
2508
 
            'directory',
2509
2456
            ]
2510
2457
    @display_command
2511
2458
    def run(self, revision=None, verbose=False,
2512
2459
            recursive=False, from_root=False,
2513
2460
            unknown=False, versioned=False, ignored=False,
2514
 
            null=False, kind=None, show_ids=False, path=None, directory=None):
 
2461
            null=False, kind=None, show_ids=False, path=None):
2515
2462
 
2516
2463
        if kind and kind not in ('file', 'directory', 'symlink'):
2517
2464
            raise errors.BzrCommandError('invalid kind specified')
2529
2476
                raise errors.BzrCommandError('cannot specify both --from-root'
2530
2477
                                             ' and PATH')
2531
2478
            fs_path = path
2532
 
        tree, branch, relpath = \
2533
 
            _open_directory_or_containing_tree_or_branch(fs_path, directory)
 
2479
        tree, branch, relpath = bzrdir.BzrDir.open_containing_tree_or_branch(
 
2480
            fs_path)
2534
2481
 
2535
2482
        # Calculate the prefix to use
2536
2483
        prefix = None
2537
2484
        if from_root:
2538
2485
            if relpath:
2539
2486
                prefix = relpath + '/'
2540
 
        elif fs_path != '.' and not fs_path.endswith('/'):
 
2487
        elif fs_path != '.':
2541
2488
            prefix = fs_path + '/'
2542
2489
 
2543
2490
        if revision is not None or tree is None:
2551
2498
                view_str = views.view_display_str(view_files)
2552
2499
                note("Ignoring files outside view. View is %s" % view_str)
2553
2500
 
2554
 
        self.add_cleanup(tree.lock_read().unlock)
2555
 
        for fp, fc, fkind, fid, entry in tree.list_files(include_root=False,
2556
 
            from_dir=relpath, recursive=recursive):
2557
 
            # Apply additional masking
2558
 
            if not all and not selection[fc]:
2559
 
                continue
2560
 
            if kind is not None and fkind != kind:
2561
 
                continue
2562
 
            if apply_view:
2563
 
                try:
2564
 
                    if relpath:
2565
 
                        fullpath = osutils.pathjoin(relpath, fp)
2566
 
                    else:
2567
 
                        fullpath = fp
2568
 
                    views.check_path_in_view(tree, fullpath)
2569
 
                except errors.FileOutsideView:
2570
 
                    continue
 
2501
        tree.lock_read()
 
2502
        try:
 
2503
            for fp, fc, fkind, fid, entry in tree.list_files(include_root=False,
 
2504
                from_dir=relpath, recursive=recursive):
 
2505
                # Apply additional masking
 
2506
                if not all and not selection[fc]:
 
2507
                    continue
 
2508
                if kind is not None and fkind != kind:
 
2509
                    continue
 
2510
                if apply_view:
 
2511
                    try:
 
2512
                        if relpath:
 
2513
                            fullpath = osutils.pathjoin(relpath, fp)
 
2514
                        else:
 
2515
                            fullpath = fp
 
2516
                        views.check_path_in_view(tree, fullpath)
 
2517
                    except errors.FileOutsideView:
 
2518
                        continue
2571
2519
 
2572
 
            # Output the entry
2573
 
            if prefix:
2574
 
                fp = osutils.pathjoin(prefix, fp)
2575
 
            kindch = entry.kind_character()
2576
 
            outstring = fp + kindch
2577
 
            ui.ui_factory.clear_term()
2578
 
            if verbose:
2579
 
                outstring = '%-8s %s' % (fc, outstring)
2580
 
                if show_ids and fid is not None:
2581
 
                    outstring = "%-50s %s" % (outstring, fid)
2582
 
                self.outf.write(outstring + '\n')
2583
 
            elif null:
2584
 
                self.outf.write(fp + '\0')
2585
 
                if show_ids:
2586
 
                    if fid is not None:
2587
 
                        self.outf.write(fid)
2588
 
                    self.outf.write('\0')
2589
 
                self.outf.flush()
2590
 
            else:
2591
 
                if show_ids:
2592
 
                    if fid is not None:
2593
 
                        my_id = fid
2594
 
                    else:
2595
 
                        my_id = ''
2596
 
                    self.outf.write('%-50s %s\n' % (outstring, my_id))
2597
 
                else:
 
2520
                # Output the entry
 
2521
                if prefix:
 
2522
                    fp = osutils.pathjoin(prefix, fp)
 
2523
                kindch = entry.kind_character()
 
2524
                outstring = fp + kindch
 
2525
                ui.ui_factory.clear_term()
 
2526
                if verbose:
 
2527
                    outstring = '%-8s %s' % (fc, outstring)
 
2528
                    if show_ids and fid is not None:
 
2529
                        outstring = "%-50s %s" % (outstring, fid)
2598
2530
                    self.outf.write(outstring + '\n')
 
2531
                elif null:
 
2532
                    self.outf.write(fp + '\0')
 
2533
                    if show_ids:
 
2534
                        if fid is not None:
 
2535
                            self.outf.write(fid)
 
2536
                        self.outf.write('\0')
 
2537
                    self.outf.flush()
 
2538
                else:
 
2539
                    if show_ids:
 
2540
                        if fid is not None:
 
2541
                            my_id = fid
 
2542
                        else:
 
2543
                            my_id = ''
 
2544
                        self.outf.write('%-50s %s\n' % (outstring, my_id))
 
2545
                    else:
 
2546
                        self.outf.write(outstring + '\n')
 
2547
        finally:
 
2548
            tree.unlock()
2599
2549
 
2600
2550
 
2601
2551
class cmd_unknowns(Command):
2602
 
    __doc__ = """List unknown files.
 
2552
    """List unknown files.
2603
2553
    """
2604
2554
 
2605
2555
    hidden = True
2606
2556
    _see_also = ['ls']
2607
 
    takes_options = ['directory']
2608
2557
 
2609
2558
    @display_command
2610
 
    def run(self, directory=u'.'):
2611
 
        for f in WorkingTree.open_containing(directory)[0].unknowns():
 
2559
    def run(self):
 
2560
        for f in WorkingTree.open_containing(u'.')[0].unknowns():
2612
2561
            self.outf.write(osutils.quotefn(f) + '\n')
2613
2562
 
2614
2563
 
2615
2564
class cmd_ignore(Command):
2616
 
    __doc__ = """Ignore specified files or patterns.
 
2565
    """Ignore specified files or patterns.
2617
2566
 
2618
2567
    See ``bzr help patterns`` for details on the syntax of patterns.
2619
2568
 
2620
 
    If a .bzrignore file does not exist, the ignore command
2621
 
    will create one and add the specified files or patterns to the newly
2622
 
    created file. The ignore command will also automatically add the 
2623
 
    .bzrignore file to be versioned. Creating a .bzrignore file without
2624
 
    the use of the ignore command will require an explicit add command.
2625
 
 
2626
2569
    To remove patterns from the ignore list, edit the .bzrignore file.
2627
2570
    After adding, editing or deleting that file either indirectly by
2628
2571
    using this command or directly by using an editor, be sure to commit
2629
2572
    it.
2630
 
    
2631
 
    Bazaar also supports a global ignore file ~/.bazaar/ignore. On Windows
2632
 
    the global ignore file can be found in the application data directory as
2633
 
    C:\\Documents and Settings\\<user>\\Application Data\\Bazaar\\2.0\\ignore.
2634
 
    Global ignores are not touched by this command. The global ignore file
2635
 
    can be edited directly using an editor.
2636
 
 
2637
 
    Patterns prefixed with '!' are exceptions to ignore patterns and take
2638
 
    precedence over regular ignores.  Such exceptions are used to specify
2639
 
    files that should be versioned which would otherwise be ignored.
2640
 
    
2641
 
    Patterns prefixed with '!!' act as regular ignore patterns, but have
2642
 
    precedence over the '!' exception patterns.
2643
2573
 
2644
2574
    Note: ignore patterns containing shell wildcards must be quoted from
2645
2575
    the shell on Unix.
2649
2579
 
2650
2580
            bzr ignore ./Makefile
2651
2581
 
2652
 
        Ignore .class files in all directories...::
 
2582
        Ignore class files in all directories::
2653
2583
 
2654
2584
            bzr ignore "*.class"
2655
2585
 
2656
 
        ...but do not ignore "special.class"::
2657
 
 
2658
 
            bzr ignore "!special.class"
2659
 
 
2660
2586
        Ignore .o files under the lib directory::
2661
2587
 
2662
2588
            bzr ignore "lib/**/*.o"
2668
2594
        Ignore everything but the "debian" toplevel directory::
2669
2595
 
2670
2596
            bzr ignore "RE:(?!debian/).*"
2671
 
        
2672
 
        Ignore everything except the "local" toplevel directory,
2673
 
        but always ignore "*~" autosave files, even under local/::
2674
 
        
2675
 
            bzr ignore "*"
2676
 
            bzr ignore "!./local"
2677
 
            bzr ignore "!!*~"
2678
2597
    """
2679
2598
 
2680
2599
    _see_also = ['status', 'ignored', 'patterns']
2681
2600
    takes_args = ['name_pattern*']
2682
 
    takes_options = ['directory',
2683
 
        Option('default-rules',
2684
 
               help='Display the default ignore rules that bzr uses.')
 
2601
    takes_options = [
 
2602
        Option('old-default-rules',
 
2603
               help='Write out the ignore rules bzr < 0.9 always used.')
2685
2604
        ]
2686
2605
 
2687
 
    def run(self, name_pattern_list=None, default_rules=None,
2688
 
            directory=u'.'):
 
2606
    def run(self, name_pattern_list=None, old_default_rules=None):
2689
2607
        from bzrlib import ignores
2690
 
        if default_rules is not None:
2691
 
            # dump the default rules and exit
2692
 
            for pattern in ignores.USER_DEFAULTS:
2693
 
                self.outf.write("%s\n" % pattern)
 
2608
        if old_default_rules is not None:
 
2609
            # dump the rules and exit
 
2610
            for pattern in ignores.OLD_DEFAULTS:
 
2611
                print pattern
2694
2612
            return
2695
2613
        if not name_pattern_list:
2696
2614
            raise errors.BzrCommandError("ignore requires at least one "
2697
 
                "NAME_PATTERN or --default-rules.")
 
2615
                                  "NAME_PATTERN or --old-default-rules")
2698
2616
        name_pattern_list = [globbing.normalize_pattern(p)
2699
2617
                             for p in name_pattern_list]
2700
 
        bad_patterns = ''
2701
 
        for p in name_pattern_list:
2702
 
            if not globbing.Globster.is_pattern_valid(p):
2703
 
                bad_patterns += ('\n  %s' % p)
2704
 
        if bad_patterns:
2705
 
            msg = ('Invalid ignore pattern(s) found. %s' % bad_patterns)
2706
 
            ui.ui_factory.show_error(msg)
2707
 
            raise errors.InvalidPattern('')
2708
2618
        for name_pattern in name_pattern_list:
2709
2619
            if (name_pattern[0] == '/' or
2710
2620
                (len(name_pattern) > 1 and name_pattern[1] == ':')):
2711
2621
                raise errors.BzrCommandError(
2712
2622
                    "NAME_PATTERN should not be an absolute path")
2713
 
        tree, relpath = WorkingTree.open_containing(directory)
 
2623
        tree, relpath = WorkingTree.open_containing(u'.')
2714
2624
        ignores.tree_ignores_add_patterns(tree, name_pattern_list)
2715
2625
        ignored = globbing.Globster(name_pattern_list)
2716
2626
        matches = []
2717
 
        self.add_cleanup(tree.lock_read().unlock)
 
2627
        tree.lock_read()
2718
2628
        for entry in tree.list_files():
2719
2629
            id = entry[3]
2720
2630
            if id is not None:
2721
2631
                filename = entry[0]
2722
2632
                if ignored.match(filename):
2723
 
                    matches.append(filename)
 
2633
                    matches.append(filename.encode('utf-8'))
 
2634
        tree.unlock()
2724
2635
        if len(matches) > 0:
2725
 
            self.outf.write("Warning: the following files are version controlled and"
2726
 
                  " match your ignore pattern:\n%s"
2727
 
                  "\nThese files will continue to be version controlled"
2728
 
                  " unless you 'bzr remove' them.\n" % ("\n".join(matches),))
 
2636
            print "Warning: the following files are version controlled and" \
 
2637
                  " match your ignore pattern:\n%s" \
 
2638
                  "\nThese files will continue to be version controlled" \
 
2639
                  " unless you 'bzr remove' them." % ("\n".join(matches),)
2729
2640
 
2730
2641
 
2731
2642
class cmd_ignored(Command):
2732
 
    __doc__ = """List ignored files and the patterns that matched them.
 
2643
    """List ignored files and the patterns that matched them.
2733
2644
 
2734
2645
    List all the ignored files and the ignore pattern that caused the file to
2735
2646
    be ignored.
2741
2652
 
2742
2653
    encoding_type = 'replace'
2743
2654
    _see_also = ['ignore', 'ls']
2744
 
    takes_options = ['directory']
2745
2655
 
2746
2656
    @display_command
2747
 
    def run(self, directory=u'.'):
2748
 
        tree = WorkingTree.open_containing(directory)[0]
2749
 
        self.add_cleanup(tree.lock_read().unlock)
2750
 
        for path, file_class, kind, file_id, entry in tree.list_files():
2751
 
            if file_class != 'I':
2752
 
                continue
2753
 
            ## XXX: Slightly inefficient since this was already calculated
2754
 
            pat = tree.is_ignored(path)
2755
 
            self.outf.write('%-50s %s\n' % (path, pat))
 
2657
    def run(self):
 
2658
        tree = WorkingTree.open_containing(u'.')[0]
 
2659
        tree.lock_read()
 
2660
        try:
 
2661
            for path, file_class, kind, file_id, entry in tree.list_files():
 
2662
                if file_class != 'I':
 
2663
                    continue
 
2664
                ## XXX: Slightly inefficient since this was already calculated
 
2665
                pat = tree.is_ignored(path)
 
2666
                self.outf.write('%-50s %s\n' % (path, pat))
 
2667
        finally:
 
2668
            tree.unlock()
2756
2669
 
2757
2670
 
2758
2671
class cmd_lookup_revision(Command):
2759
 
    __doc__ = """Lookup the revision-id from a revision-number
 
2672
    """Lookup the revision-id from a revision-number
2760
2673
 
2761
2674
    :Examples:
2762
2675
        bzr lookup-revision 33
2763
2676
    """
2764
2677
    hidden = True
2765
2678
    takes_args = ['revno']
2766
 
    takes_options = ['directory']
2767
2679
 
2768
2680
    @display_command
2769
 
    def run(self, revno, directory=u'.'):
 
2681
    def run(self, revno):
2770
2682
        try:
2771
2683
            revno = int(revno)
2772
2684
        except ValueError:
2773
 
            raise errors.BzrCommandError("not a valid revision-number: %r"
2774
 
                                         % revno)
2775
 
        revid = WorkingTree.open_containing(directory)[0].branch.get_rev_id(revno)
2776
 
        self.outf.write("%s\n" % revid)
 
2685
            raise errors.BzrCommandError("not a valid revision-number: %r" % revno)
 
2686
 
 
2687
        print WorkingTree.open_containing(u'.')[0].branch.get_rev_id(revno)
2777
2688
 
2778
2689
 
2779
2690
class cmd_export(Command):
2780
 
    __doc__ = """Export current or past revision to a destination directory or archive.
 
2691
    """Export current or past revision to a destination directory or archive.
2781
2692
 
2782
2693
    If no revision is specified this exports the last committed revision.
2783
2694
 
2805
2716
      =================       =========================
2806
2717
    """
2807
2718
    takes_args = ['dest', 'branch_or_subdir?']
2808
 
    takes_options = ['directory',
 
2719
    takes_options = [
2809
2720
        Option('format',
2810
2721
               help="Type of file to export to.",
2811
2722
               type=unicode),
2815
2726
        Option('root',
2816
2727
               type=str,
2817
2728
               help="Name of the root directory inside the exported file."),
2818
 
        Option('per-file-timestamps',
2819
 
               help='Set modification time of files to that of the last '
2820
 
                    'revision in which it was changed.'),
2821
2729
        ]
2822
2730
    def run(self, dest, branch_or_subdir=None, revision=None, format=None,
2823
 
        root=None, filters=False, per_file_timestamps=False, directory=u'.'):
 
2731
        root=None, filters=False):
2824
2732
        from bzrlib.export import export
2825
2733
 
2826
2734
        if branch_or_subdir is None:
2827
 
            tree = WorkingTree.open_containing(directory)[0]
 
2735
            tree = WorkingTree.open_containing(u'.')[0]
2828
2736
            b = tree.branch
2829
2737
            subdir = None
2830
2738
        else:
2833
2741
 
2834
2742
        rev_tree = _get_one_revision_tree('export', revision, branch=b, tree=tree)
2835
2743
        try:
2836
 
            export(rev_tree, dest, format, root, subdir, filtered=filters,
2837
 
                   per_file_timestamps=per_file_timestamps)
 
2744
            export(rev_tree, dest, format, root, subdir, filtered=filters)
2838
2745
        except errors.NoSuchExportFormat, e:
2839
2746
            raise errors.BzrCommandError('Unsupported export format: %s' % e.format)
2840
2747
 
2841
2748
 
2842
2749
class cmd_cat(Command):
2843
 
    __doc__ = """Write the contents of a file as of a given revision to standard output.
 
2750
    """Write the contents of a file as of a given revision to standard output.
2844
2751
 
2845
2752
    If no revision is nominated, the last revision is used.
2846
2753
 
2849
2756
    """
2850
2757
 
2851
2758
    _see_also = ['ls']
2852
 
    takes_options = ['directory',
 
2759
    takes_options = [
2853
2760
        Option('name-from-revision', help='The path name in the old tree.'),
2854
2761
        Option('filters', help='Apply content filters to display the '
2855
2762
                'convenience form.'),
2860
2767
 
2861
2768
    @display_command
2862
2769
    def run(self, filename, revision=None, name_from_revision=False,
2863
 
            filters=False, directory=None):
 
2770
            filters=False):
2864
2771
        if revision is not None and len(revision) != 1:
2865
2772
            raise errors.BzrCommandError("bzr cat --revision takes exactly"
2866
2773
                                         " one revision specifier")
2867
2774
        tree, branch, relpath = \
2868
 
            _open_directory_or_containing_tree_or_branch(filename, directory)
2869
 
        self.add_cleanup(branch.lock_read().unlock)
2870
 
        return self._run(tree, branch, relpath, filename, revision,
2871
 
                         name_from_revision, filters)
 
2775
            bzrdir.BzrDir.open_containing_tree_or_branch(filename)
 
2776
        branch.lock_read()
 
2777
        try:
 
2778
            return self._run(tree, branch, relpath, filename, revision,
 
2779
                             name_from_revision, filters)
 
2780
        finally:
 
2781
            branch.unlock()
2872
2782
 
2873
2783
    def _run(self, tree, b, relpath, filename, revision, name_from_revision,
2874
2784
        filtered):
2875
2785
        if tree is None:
2876
2786
            tree = b.basis_tree()
2877
2787
        rev_tree = _get_one_revision_tree('cat', revision, branch=b)
2878
 
        self.add_cleanup(rev_tree.lock_read().unlock)
2879
2788
 
2880
2789
        old_file_id = rev_tree.path2id(relpath)
2881
2790
 
2916
2825
            chunks = content.splitlines(True)
2917
2826
            content = filtered_output_bytes(chunks, filters,
2918
2827
                ContentFilterContext(relpath, rev_tree))
2919
 
            self.cleanup_now()
2920
2828
            self.outf.writelines(content)
2921
2829
        else:
2922
 
            self.cleanup_now()
2923
2830
            self.outf.write(content)
2924
2831
 
2925
2832
 
2926
2833
class cmd_local_time_offset(Command):
2927
 
    __doc__ = """Show the offset in seconds from GMT to local time."""
 
2834
    """Show the offset in seconds from GMT to local time."""
2928
2835
    hidden = True
2929
2836
    @display_command
2930
2837
    def run(self):
2931
 
        self.outf.write("%s\n" % osutils.local_time_offset())
 
2838
        print osutils.local_time_offset()
2932
2839
 
2933
2840
 
2934
2841
 
2935
2842
class cmd_commit(Command):
2936
 
    __doc__ = """Commit changes into a new revision.
 
2843
    """Commit changes into a new revision.
2937
2844
 
2938
2845
    An explanatory message needs to be given for each commit. This is
2939
2846
    often done by using the --message option (getting the message from the
3032
2939
             Option('strict',
3033
2940
                    help="Refuse to commit if there are unknown "
3034
2941
                    "files in the working tree."),
3035
 
             Option('commit-time', type=str,
3036
 
                    help="Manually set a commit time using commit date "
3037
 
                    "format, e.g. '2009-10-10 08:00:00 +0100'."),
3038
2942
             ListOption('fixes', type=str,
3039
2943
                    help="Mark a bug as being fixed by this revision "
3040
2944
                         "(see \"bzr help bugs\")."),
3047
2951
                         "the master branch until a normal commit "
3048
2952
                         "is performed."
3049
2953
                    ),
3050
 
             Option('show-diff', short_name='p',
3051
 
                    help='When no message is supplied, show the diff along'
3052
 
                    ' with the status summary in the message editor.'),
 
2954
              Option('show-diff',
 
2955
                     help='When no message is supplied, show the diff along'
 
2956
                     ' with the status summary in the message editor.'),
3053
2957
             ]
3054
2958
    aliases = ['ci', 'checkin']
3055
2959
 
3074
2978
 
3075
2979
    def run(self, message=None, file=None, verbose=False, selected_list=None,
3076
2980
            unchanged=False, strict=False, local=False, fixes=None,
3077
 
            author=None, show_diff=False, exclude=None, commit_time=None):
 
2981
            author=None, show_diff=False, exclude=None):
3078
2982
        from bzrlib.errors import (
3079
2983
            PointlessCommit,
3080
2984
            ConflictsInTree,
3086
2990
            make_commit_message_template_encoded
3087
2991
        )
3088
2992
 
3089
 
        commit_stamp = offset = None
3090
 
        if commit_time is not None:
3091
 
            try:
3092
 
                commit_stamp, offset = timestamp.parse_patch_date(commit_time)
3093
 
            except ValueError, e:
3094
 
                raise errors.BzrCommandError(
3095
 
                    "Could not parse --commit-time: " + str(e))
3096
 
 
3097
2993
        # TODO: Need a blackbox test for invoking the external editor; may be
3098
2994
        # slightly problematic to run this cross-platform.
3099
2995
 
3102
2998
 
3103
2999
        properties = {}
3104
3000
 
3105
 
        tree, selected_list = WorkingTree.open_containing_paths(selected_list)
 
3001
        tree, selected_list = tree_files(selected_list)
3106
3002
        if selected_list == ['']:
3107
3003
            # workaround - commit of root of tree should be exactly the same
3108
3004
            # as just default commit in that tree, and succeed even though
3119
3015
        if local and not tree.branch.get_bound_location():
3120
3016
            raise errors.LocalRequiresBoundBranch()
3121
3017
 
3122
 
        if message is not None:
3123
 
            try:
3124
 
                file_exists = osutils.lexists(message)
3125
 
            except UnicodeError:
3126
 
                # The commit message contains unicode characters that can't be
3127
 
                # represented in the filesystem encoding, so that can't be a
3128
 
                # file.
3129
 
                file_exists = False
3130
 
            if file_exists:
3131
 
                warning_msg = (
3132
 
                    'The commit message is a file name: "%(f)s".\n'
3133
 
                    '(use --file "%(f)s" to take commit message from that file)'
3134
 
                    % { 'f': message })
3135
 
                ui.ui_factory.show_warning(warning_msg)
3136
 
            if '\r' in message:
3137
 
                message = message.replace('\r\n', '\n')
3138
 
                message = message.replace('\r', '\n')
3139
 
            if file:
3140
 
                raise errors.BzrCommandError(
3141
 
                    "please specify either --message or --file")
3142
 
 
3143
3018
        def get_message(commit_obj):
3144
3019
            """Callback to get commit message"""
3145
 
            if file:
3146
 
                f = open(file)
3147
 
                try:
3148
 
                    my_message = f.read().decode(osutils.get_user_encoding())
3149
 
                finally:
3150
 
                    f.close()
3151
 
            elif message is not None:
3152
 
                my_message = message
3153
 
            else:
3154
 
                # No message supplied: make one up.
3155
 
                # text is the status of the tree
3156
 
                text = make_commit_message_template_encoded(tree,
 
3020
            my_message = message
 
3021
            if my_message is None and not file:
 
3022
                t = make_commit_message_template_encoded(tree,
3157
3023
                        selected_list, diff=show_diff,
3158
3024
                        output_encoding=osutils.get_user_encoding())
3159
 
                # start_message is the template generated from hooks
3160
 
                # XXX: Warning - looks like hooks return unicode,
3161
 
                # make_commit_message_template_encoded returns user encoding.
3162
 
                # We probably want to be using edit_commit_message instead to
3163
 
                # avoid this.
3164
3025
                start_message = generate_commit_message_template(commit_obj)
3165
 
                my_message = edit_commit_message_encoded(text,
 
3026
                my_message = edit_commit_message_encoded(t,
3166
3027
                    start_message=start_message)
3167
3028
                if my_message is None:
3168
3029
                    raise errors.BzrCommandError("please specify a commit"
3169
3030
                        " message with either --message or --file")
 
3031
            elif my_message and file:
 
3032
                raise errors.BzrCommandError(
 
3033
                    "please specify either --message or --file")
 
3034
            if file:
 
3035
                my_message = codecs.open(file, 'rt',
 
3036
                                         osutils.get_user_encoding()).read()
3170
3037
            if my_message == "":
3171
3038
                raise errors.BzrCommandError("empty commit message specified")
3172
3039
            return my_message
3180
3047
                        specific_files=selected_list,
3181
3048
                        allow_pointless=unchanged, strict=strict, local=local,
3182
3049
                        reporter=None, verbose=verbose, revprops=properties,
3183
 
                        authors=author, timestamp=commit_stamp,
3184
 
                        timezone=offset,
3185
 
                        exclude=tree.safe_relpath_files(exclude))
 
3050
                        authors=author,
 
3051
                        exclude=safe_relpath_files(tree, exclude))
3186
3052
        except PointlessCommit:
 
3053
            # FIXME: This should really happen before the file is read in;
 
3054
            # perhaps prepare the commit; get the message; then actually commit
3187
3055
            raise errors.BzrCommandError("No changes to commit."
3188
3056
                              " Use --unchanged to commit anyhow.")
3189
3057
        except ConflictsInTree:
3194
3062
            raise errors.BzrCommandError("Commit refused because there are"
3195
3063
                              " unknown files in the working tree.")
3196
3064
        except errors.BoundBranchOutOfDate, e:
3197
 
            e.extra_help = ("\n"
3198
 
                'To commit to master branch, run update and then commit.\n'
3199
 
                'You can also pass --local to commit to continue working '
3200
 
                'disconnected.')
3201
 
            raise
 
3065
            raise errors.BzrCommandError(str(e) + "\n"
 
3066
            'To commit to master branch, run update and then commit.\n'
 
3067
            'You can also pass --local to commit to continue working '
 
3068
            'disconnected.')
3202
3069
 
3203
3070
 
3204
3071
class cmd_check(Command):
3205
 
    __doc__ = """Validate working tree structure, branch consistency and repository history.
 
3072
    """Validate working tree structure, branch consistency and repository history.
3206
3073
 
3207
3074
    This command checks various invariants about branch and repository storage
3208
3075
    to detect data corruption or bzr bugs.
3272
3139
 
3273
3140
 
3274
3141
class cmd_upgrade(Command):
3275
 
    __doc__ = """Upgrade branch storage to current format.
 
3142
    """Upgrade branch storage to current format.
3276
3143
 
3277
3144
    The check command or bzr developers may sometimes advise you to run
3278
3145
    this command. When the default format has changed you may also be warned
3296
3163
 
3297
3164
 
3298
3165
class cmd_whoami(Command):
3299
 
    __doc__ = """Show or set bzr user id.
 
3166
    """Show or set bzr user id.
3300
3167
 
3301
3168
    :Examples:
3302
3169
        Show the email of the current user::
3307
3174
 
3308
3175
            bzr whoami "Frank Chu <fchu@example.com>"
3309
3176
    """
3310
 
    takes_options = [ 'directory',
3311
 
                      Option('email',
 
3177
    takes_options = [ Option('email',
3312
3178
                             help='Display email address only.'),
3313
3179
                      Option('branch',
3314
3180
                             help='Set identity for the current branch instead of '
3318
3184
    encoding_type = 'replace'
3319
3185
 
3320
3186
    @display_command
3321
 
    def run(self, email=False, branch=False, name=None, directory=None):
 
3187
    def run(self, email=False, branch=False, name=None):
3322
3188
        if name is None:
3323
 
            if directory is None:
3324
 
                # use branch if we're inside one; otherwise global config
3325
 
                try:
3326
 
                    c = Branch.open_containing(u'.')[0].get_config()
3327
 
                except errors.NotBranchError:
3328
 
                    c = _mod_config.GlobalConfig()
3329
 
            else:
3330
 
                c = Branch.open(directory).get_config()
 
3189
            # use branch if we're inside one; otherwise global config
 
3190
            try:
 
3191
                c = Branch.open_containing('.')[0].get_config()
 
3192
            except errors.NotBranchError:
 
3193
                c = config.GlobalConfig()
3331
3194
            if email:
3332
3195
                self.outf.write(c.user_email() + '\n')
3333
3196
            else:
3336
3199
 
3337
3200
        # display a warning if an email address isn't included in the given name.
3338
3201
        try:
3339
 
            _mod_config.extract_email_address(name)
 
3202
            config.extract_email_address(name)
3340
3203
        except errors.NoEmailInUsername, e:
3341
3204
            warning('"%s" does not seem to contain an email address.  '
3342
3205
                    'This is allowed, but not recommended.', name)
3343
3206
 
3344
3207
        # use global config unless --branch given
3345
3208
        if branch:
3346
 
            if directory is None:
3347
 
                c = Branch.open_containing(u'.')[0].get_config()
3348
 
            else:
3349
 
                c = Branch.open(directory).get_config()
 
3209
            c = Branch.open_containing('.')[0].get_config()
3350
3210
        else:
3351
 
            c = _mod_config.GlobalConfig()
 
3211
            c = config.GlobalConfig()
3352
3212
        c.set_user_option('email', name)
3353
3213
 
3354
3214
 
3355
3215
class cmd_nick(Command):
3356
 
    __doc__ = """Print or set the branch nickname.
 
3216
    """Print or set the branch nickname.
3357
3217
 
3358
3218
    If unset, the tree root directory name is used as the nickname.
3359
3219
    To print the current nickname, execute with no argument.
3364
3224
 
3365
3225
    _see_also = ['info']
3366
3226
    takes_args = ['nickname?']
3367
 
    takes_options = ['directory']
3368
 
    def run(self, nickname=None, directory=u'.'):
3369
 
        branch = Branch.open_containing(directory)[0]
 
3227
    def run(self, nickname=None):
 
3228
        branch = Branch.open_containing(u'.')[0]
3370
3229
        if nickname is None:
3371
3230
            self.printme(branch)
3372
3231
        else:
3374
3233
 
3375
3234
    @display_command
3376
3235
    def printme(self, branch):
3377
 
        self.outf.write('%s\n' % branch.nick)
 
3236
        print branch.nick
3378
3237
 
3379
3238
 
3380
3239
class cmd_alias(Command):
3381
 
    __doc__ = """Set/unset and display aliases.
 
3240
    """Set/unset and display aliases.
3382
3241
 
3383
3242
    :Examples:
3384
3243
        Show the current aliases::
3421
3280
                'bzr alias --remove expects an alias to remove.')
3422
3281
        # If alias is not found, print something like:
3423
3282
        # unalias: foo: not found
3424
 
        c = _mod_config.GlobalConfig()
 
3283
        c = config.GlobalConfig()
3425
3284
        c.unset_alias(alias_name)
3426
3285
 
3427
3286
    @display_command
3428
3287
    def print_aliases(self):
3429
3288
        """Print out the defined aliases in a similar format to bash."""
3430
 
        aliases = _mod_config.GlobalConfig().get_aliases()
 
3289
        aliases = config.GlobalConfig().get_aliases()
3431
3290
        for key, value in sorted(aliases.iteritems()):
3432
3291
            self.outf.write('bzr alias %s="%s"\n' % (key, value))
3433
3292
 
3443
3302
 
3444
3303
    def set_alias(self, alias_name, alias_command):
3445
3304
        """Save the alias in the global config."""
3446
 
        c = _mod_config.GlobalConfig()
 
3305
        c = config.GlobalConfig()
3447
3306
        c.set_alias(alias_name, alias_command)
3448
3307
 
3449
3308
 
3450
3309
class cmd_selftest(Command):
3451
 
    __doc__ = """Run internal test suite.
 
3310
    """Run internal test suite.
3452
3311
 
3453
3312
    If arguments are given, they are regular expressions that say which tests
3454
3313
    should run.  Tests matching any expression are run, and other tests are
3481
3340
    Tests that need working space on disk use a common temporary directory,
3482
3341
    typically inside $TMPDIR or /tmp.
3483
3342
 
3484
 
    If you set BZR_TEST_PDB=1 when running selftest, failing tests will drop
3485
 
    into a pdb postmortem session.
3486
 
 
3487
 
    The --coverage=DIRNAME global option produces a report with covered code
3488
 
    indicated.
3489
 
 
3490
3343
    :Examples:
3491
3344
        Run only tests relating to 'ignore'::
3492
3345
 
3501
3354
    def get_transport_type(typestring):
3502
3355
        """Parse and return a transport specifier."""
3503
3356
        if typestring == "sftp":
3504
 
            from bzrlib.tests import stub_sftp
3505
 
            return stub_sftp.SFTPAbsoluteServer
 
3357
            from bzrlib.transport.sftp import SFTPAbsoluteServer
 
3358
            return SFTPAbsoluteServer
3506
3359
        if typestring == "memory":
3507
 
            from bzrlib.tests import test_server
3508
 
            return memory.MemoryServer
 
3360
            from bzrlib.transport.memory import MemoryServer
 
3361
            return MemoryServer
3509
3362
        if typestring == "fakenfs":
3510
 
            from bzrlib.tests import test_server
3511
 
            return test_server.FakeNFSServer
 
3363
            from bzrlib.transport.fakenfs import FakeNFSServer
 
3364
            return FakeNFSServer
3512
3365
        msg = "No known transport type %s. Supported types are: sftp\n" %\
3513
3366
            (typestring)
3514
3367
        raise errors.BzrCommandError(msg)
3525
3378
                                 'throughout the test suite.',
3526
3379
                            type=get_transport_type),
3527
3380
                     Option('benchmark',
3528
 
                            help='Run the benchmarks rather than selftests.',
3529
 
                            hidden=True),
 
3381
                            help='Run the benchmarks rather than selftests.'),
3530
3382
                     Option('lsprof-timed',
3531
3383
                            help='Generate lsprof output for benchmarked'
3532
3384
                                 ' sections of code.'),
3533
3385
                     Option('lsprof-tests',
3534
3386
                            help='Generate lsprof output for each test.'),
 
3387
                     Option('cache-dir', type=str,
 
3388
                            help='Cache intermediate benchmark output in this '
 
3389
                                 'directory.'),
3535
3390
                     Option('first',
3536
3391
                            help='Run all tests, but run specified tests first.',
3537
3392
                            short_name='f',
3571
3426
 
3572
3427
    def run(self, testspecs_list=None, verbose=False, one=False,
3573
3428
            transport=None, benchmark=None,
3574
 
            lsprof_timed=None,
 
3429
            lsprof_timed=None, cache_dir=None,
3575
3430
            first=False, list_only=False,
3576
3431
            randomize=None, exclude=None, strict=False,
3577
3432
            load_list=None, debugflag=None, starting_with=None, subunit=False,
3578
3433
            parallel=None, lsprof_tests=False):
3579
 
        from bzrlib import tests
3580
 
 
 
3434
        from bzrlib.tests import selftest
 
3435
        import bzrlib.benchmarks as benchmarks
 
3436
        from bzrlib.benchmarks import tree_creator
 
3437
 
 
3438
        # Make deprecation warnings visible, unless -Werror is set
 
3439
        symbol_versioning.activate_deprecation_warnings(override=False)
 
3440
 
 
3441
        if cache_dir is not None:
 
3442
            tree_creator.TreeCreator.CACHE_ROOT = osutils.abspath(cache_dir)
3581
3443
        if testspecs_list is not None:
3582
3444
            pattern = '|'.join(testspecs_list)
3583
3445
        else:
3589
3451
                raise errors.BzrCommandError("subunit not available. subunit "
3590
3452
                    "needs to be installed to use --subunit.")
3591
3453
            self.additional_selftest_args['runner_class'] = SubUnitBzrRunner
3592
 
            # On Windows, disable automatic conversion of '\n' to '\r\n' in
3593
 
            # stdout, which would corrupt the subunit stream. 
3594
 
            # FIXME: This has been fixed in subunit trunk (>0.0.5) so the
3595
 
            # following code can be deleted when it's sufficiently deployed
3596
 
            # -- vila/mgz 20100514
3597
 
            if (sys.platform == "win32"
3598
 
                and getattr(sys.stdout, 'fileno', None) is not None):
3599
 
                import msvcrt
3600
 
                msvcrt.setmode(sys.stdout.fileno(), os.O_BINARY)
3601
3454
        if parallel:
3602
3455
            self.additional_selftest_args.setdefault(
3603
3456
                'suite_decorators', []).append(parallel)
3604
3457
        if benchmark:
3605
 
            raise errors.BzrCommandError(
3606
 
                "--benchmark is no longer supported from bzr 2.2; "
3607
 
                "use bzr-usertest instead")
3608
 
        test_suite_factory = None
3609
 
        selftest_kwargs = {"verbose": verbose,
3610
 
                          "pattern": pattern,
3611
 
                          "stop_on_failure": one,
3612
 
                          "transport": transport,
3613
 
                          "test_suite_factory": test_suite_factory,
3614
 
                          "lsprof_timed": lsprof_timed,
3615
 
                          "lsprof_tests": lsprof_tests,
3616
 
                          "matching_tests_first": first,
3617
 
                          "list_only": list_only,
3618
 
                          "random_seed": randomize,
3619
 
                          "exclude_pattern": exclude,
3620
 
                          "strict": strict,
3621
 
                          "load_list": load_list,
3622
 
                          "debug_flags": debugflag,
3623
 
                          "starting_with": starting_with
3624
 
                          }
3625
 
        selftest_kwargs.update(self.additional_selftest_args)
3626
 
 
3627
 
        # Make deprecation warnings visible, unless -Werror is set
3628
 
        cleanup = symbol_versioning.activate_deprecation_warnings(
3629
 
            override=False)
 
3458
            test_suite_factory = benchmarks.test_suite
 
3459
            # Unless user explicitly asks for quiet, be verbose in benchmarks
 
3460
            verbose = not is_quiet()
 
3461
            # TODO: should possibly lock the history file...
 
3462
            benchfile = open(".perf_history", "at", buffering=1)
 
3463
        else:
 
3464
            test_suite_factory = None
 
3465
            benchfile = None
3630
3466
        try:
3631
 
            result = tests.selftest(**selftest_kwargs)
 
3467
            selftest_kwargs = {"verbose": verbose,
 
3468
                              "pattern": pattern,
 
3469
                              "stop_on_failure": one,
 
3470
                              "transport": transport,
 
3471
                              "test_suite_factory": test_suite_factory,
 
3472
                              "lsprof_timed": lsprof_timed,
 
3473
                              "lsprof_tests": lsprof_tests,
 
3474
                              "bench_history": benchfile,
 
3475
                              "matching_tests_first": first,
 
3476
                              "list_only": list_only,
 
3477
                              "random_seed": randomize,
 
3478
                              "exclude_pattern": exclude,
 
3479
                              "strict": strict,
 
3480
                              "load_list": load_list,
 
3481
                              "debug_flags": debugflag,
 
3482
                              "starting_with": starting_with
 
3483
                              }
 
3484
            selftest_kwargs.update(self.additional_selftest_args)
 
3485
            result = selftest(**selftest_kwargs)
3632
3486
        finally:
3633
 
            cleanup()
 
3487
            if benchfile is not None:
 
3488
                benchfile.close()
3634
3489
        return int(not result)
3635
3490
 
3636
3491
 
3637
3492
class cmd_version(Command):
3638
 
    __doc__ = """Show version of bzr."""
 
3493
    """Show version of bzr."""
3639
3494
 
3640
3495
    encoding_type = 'replace'
3641
3496
    takes_options = [
3652
3507
 
3653
3508
 
3654
3509
class cmd_rocks(Command):
3655
 
    __doc__ = """Statement of optimism."""
 
3510
    """Statement of optimism."""
3656
3511
 
3657
3512
    hidden = True
3658
3513
 
3659
3514
    @display_command
3660
3515
    def run(self):
3661
 
        self.outf.write("It sure does!\n")
 
3516
        print "It sure does!"
3662
3517
 
3663
3518
 
3664
3519
class cmd_find_merge_base(Command):
3665
 
    __doc__ = """Find and print a base revision for merging two branches."""
 
3520
    """Find and print a base revision for merging two branches."""
3666
3521
    # TODO: Options to specify revisions on either side, as if
3667
3522
    #       merging only part of the history.
3668
3523
    takes_args = ['branch', 'other']
3674
3529
 
3675
3530
        branch1 = Branch.open_containing(branch)[0]
3676
3531
        branch2 = Branch.open_containing(other)[0]
3677
 
        self.add_cleanup(branch1.lock_read().unlock)
3678
 
        self.add_cleanup(branch2.lock_read().unlock)
3679
 
        last1 = ensure_null(branch1.last_revision())
3680
 
        last2 = ensure_null(branch2.last_revision())
3681
 
 
3682
 
        graph = branch1.repository.get_graph(branch2.repository)
3683
 
        base_rev_id = graph.find_unique_lca(last1, last2)
3684
 
 
3685
 
        self.outf.write('merge base is revision %s\n' % base_rev_id)
 
3532
        branch1.lock_read()
 
3533
        try:
 
3534
            branch2.lock_read()
 
3535
            try:
 
3536
                last1 = ensure_null(branch1.last_revision())
 
3537
                last2 = ensure_null(branch2.last_revision())
 
3538
 
 
3539
                graph = branch1.repository.get_graph(branch2.repository)
 
3540
                base_rev_id = graph.find_unique_lca(last1, last2)
 
3541
 
 
3542
                print 'merge base is revision %s' % base_rev_id
 
3543
            finally:
 
3544
                branch2.unlock()
 
3545
        finally:
 
3546
            branch1.unlock()
3686
3547
 
3687
3548
 
3688
3549
class cmd_merge(Command):
3689
 
    __doc__ = """Perform a three-way merge.
 
3550
    """Perform a three-way merge.
3690
3551
 
3691
3552
    The source of the merge can be specified either in the form of a branch,
3692
3553
    or in the form of a path to a file containing a merge directive generated
3721
3582
    committed to record the result of the merge.
3722
3583
 
3723
3584
    merge refuses to run if there are any uncommitted changes, unless
3724
 
    --force is given. The --force option can also be used to create a
3725
 
    merge revision which has more than two parents.
3726
 
 
3727
 
    If one would like to merge changes from the working tree of the other
3728
 
    branch without merging any committed revisions, the --uncommitted option
3729
 
    can be given.
 
3585
    --force is given.
3730
3586
 
3731
3587
    To select only some changes to merge, use "merge -i", which will prompt
3732
3588
    you to apply each diff hunk and file change, similar to "shelve".
3744
3600
 
3745
3601
            bzr merge -r 81..82 ../bzr.dev
3746
3602
 
3747
 
        To apply a merge directive contained in /tmp/merge::
 
3603
        To apply a merge directive contained in /tmp/merge:
3748
3604
 
3749
3605
            bzr merge /tmp/merge
3750
 
 
3751
 
        To create a merge revision with three parents from two branches
3752
 
        feature1a and feature1b:
3753
 
 
3754
 
            bzr merge ../feature1a
3755
 
            bzr merge ../feature1b --force
3756
 
            bzr commit -m 'revision with three parents'
3757
3606
    """
3758
3607
 
3759
3608
    encoding_type = 'exact'
3775
3624
                ' completely merged into the source, pull from the'
3776
3625
                ' source rather than merging.  When this happens,'
3777
3626
                ' you do not need to commit the result.'),
3778
 
        custom_help('directory',
 
3627
        Option('directory',
3779
3628
               help='Branch to merge into, '
3780
 
                    'rather than the one containing the working directory.'),
 
3629
                    'rather than the one containing the working directory.',
 
3630
               short_name='d',
 
3631
               type=unicode,
 
3632
               ),
3781
3633
        Option('preview', help='Instead of merging, show a diff of the'
3782
3634
               ' merge.'),
3783
3635
        Option('interactive', help='Select changes interactively.',
3801
3653
        verified = 'inapplicable'
3802
3654
        tree = WorkingTree.open_containing(directory)[0]
3803
3655
 
 
3656
        # die as quickly as possible if there are uncommitted changes
3804
3657
        try:
3805
3658
            basis_tree = tree.revision_tree(tree.last_revision())
3806
3659
        except errors.NoSuchRevision:
3807
3660
            basis_tree = tree.basis_tree()
3808
 
 
3809
 
        # die as quickly as possible if there are uncommitted changes
3810
3661
        if not force:
3811
 
            if tree.has_changes():
 
3662
            if tree.has_changes(basis_tree):
3812
3663
                raise errors.UncommittedChanges(tree)
3813
3664
 
3814
3665
        view_info = _get_view_info_for_change_reporter(tree)
3815
3666
        change_reporter = delta._ChangeReporter(
3816
3667
            unversioned_filter=tree.is_ignored, view_info=view_info)
3817
 
        pb = ui.ui_factory.nested_progress_bar()
3818
 
        self.add_cleanup(pb.finished)
3819
 
        self.add_cleanup(tree.lock_write().unlock)
3820
 
        if location is not None:
3821
 
            try:
3822
 
                mergeable = bundle.read_mergeable_from_url(location,
3823
 
                    possible_transports=possible_transports)
3824
 
            except errors.NotABundle:
3825
 
                mergeable = None
 
3668
        cleanups = []
 
3669
        try:
 
3670
            pb = ui.ui_factory.nested_progress_bar()
 
3671
            cleanups.append(pb.finished)
 
3672
            tree.lock_write()
 
3673
            cleanups.append(tree.unlock)
 
3674
            if location is not None:
 
3675
                try:
 
3676
                    mergeable = bundle.read_mergeable_from_url(location,
 
3677
                        possible_transports=possible_transports)
 
3678
                except errors.NotABundle:
 
3679
                    mergeable = None
 
3680
                else:
 
3681
                    if uncommitted:
 
3682
                        raise errors.BzrCommandError('Cannot use --uncommitted'
 
3683
                            ' with bundles or merge directives.')
 
3684
 
 
3685
                    if revision is not None:
 
3686
                        raise errors.BzrCommandError(
 
3687
                            'Cannot use -r with merge directives or bundles')
 
3688
                    merger, verified = _mod_merge.Merger.from_mergeable(tree,
 
3689
                       mergeable, pb)
 
3690
 
 
3691
            if merger is None and uncommitted:
 
3692
                if revision is not None and len(revision) > 0:
 
3693
                    raise errors.BzrCommandError('Cannot use --uncommitted and'
 
3694
                        ' --revision at the same time.')
 
3695
                merger = self.get_merger_from_uncommitted(tree, location, pb,
 
3696
                                                          cleanups)
 
3697
                allow_pending = False
 
3698
 
 
3699
            if merger is None:
 
3700
                merger, allow_pending = self._get_merger_from_branch(tree,
 
3701
                    location, revision, remember, possible_transports, pb)
 
3702
 
 
3703
            merger.merge_type = merge_type
 
3704
            merger.reprocess = reprocess
 
3705
            merger.show_base = show_base
 
3706
            self.sanity_check_merger(merger)
 
3707
            if (merger.base_rev_id == merger.other_rev_id and
 
3708
                merger.other_rev_id is not None):
 
3709
                note('Nothing to do.')
 
3710
                return 0
 
3711
            if pull:
 
3712
                if merger.interesting_files is not None:
 
3713
                    raise errors.BzrCommandError('Cannot pull individual files')
 
3714
                if (merger.base_rev_id == tree.last_revision()):
 
3715
                    result = tree.pull(merger.other_branch, False,
 
3716
                                       merger.other_rev_id)
 
3717
                    result.report(self.outf)
 
3718
                    return 0
 
3719
            merger.check_basis(False)
 
3720
            if preview:
 
3721
                return self._do_preview(merger, cleanups)
 
3722
            elif interactive:
 
3723
                return self._do_interactive(merger, cleanups)
3826
3724
            else:
3827
 
                if uncommitted:
3828
 
                    raise errors.BzrCommandError('Cannot use --uncommitted'
3829
 
                        ' with bundles or merge directives.')
3830
 
 
3831
 
                if revision is not None:
3832
 
                    raise errors.BzrCommandError(
3833
 
                        'Cannot use -r with merge directives or bundles')
3834
 
                merger, verified = _mod_merge.Merger.from_mergeable(tree,
3835
 
                   mergeable, None)
3836
 
 
3837
 
        if merger is None and uncommitted:
3838
 
            if revision is not None and len(revision) > 0:
3839
 
                raise errors.BzrCommandError('Cannot use --uncommitted and'
3840
 
                    ' --revision at the same time.')
3841
 
            merger = self.get_merger_from_uncommitted(tree, location, None)
3842
 
            allow_pending = False
3843
 
 
3844
 
        if merger is None:
3845
 
            merger, allow_pending = self._get_merger_from_branch(tree,
3846
 
                location, revision, remember, possible_transports, None)
3847
 
 
3848
 
        merger.merge_type = merge_type
3849
 
        merger.reprocess = reprocess
3850
 
        merger.show_base = show_base
3851
 
        self.sanity_check_merger(merger)
3852
 
        if (merger.base_rev_id == merger.other_rev_id and
3853
 
            merger.other_rev_id is not None):
3854
 
            note('Nothing to do.')
3855
 
            return 0
3856
 
        if pull:
3857
 
            if merger.interesting_files is not None:
3858
 
                raise errors.BzrCommandError('Cannot pull individual files')
3859
 
            if (merger.base_rev_id == tree.last_revision()):
3860
 
                result = tree.pull(merger.other_branch, False,
3861
 
                                   merger.other_rev_id)
3862
 
                result.report(self.outf)
3863
 
                return 0
3864
 
        if merger.this_basis is None:
3865
 
            raise errors.BzrCommandError(
3866
 
                "This branch has no commits."
3867
 
                " (perhaps you would prefer 'bzr pull')")
3868
 
        if preview:
3869
 
            return self._do_preview(merger)
3870
 
        elif interactive:
3871
 
            return self._do_interactive(merger)
3872
 
        else:
3873
 
            return self._do_merge(merger, change_reporter, allow_pending,
3874
 
                                  verified)
3875
 
 
3876
 
    def _get_preview(self, merger):
 
3725
                return self._do_merge(merger, change_reporter, allow_pending,
 
3726
                                      verified)
 
3727
        finally:
 
3728
            for cleanup in reversed(cleanups):
 
3729
                cleanup()
 
3730
 
 
3731
    def _get_preview(self, merger, cleanups):
3877
3732
        tree_merger = merger.make_merger()
3878
3733
        tt = tree_merger.make_preview_transform()
3879
 
        self.add_cleanup(tt.finalize)
 
3734
        cleanups.append(tt.finalize)
3880
3735
        result_tree = tt.get_preview_tree()
3881
3736
        return result_tree
3882
3737
 
3883
 
    def _do_preview(self, merger):
 
3738
    def _do_preview(self, merger, cleanups):
3884
3739
        from bzrlib.diff import show_diff_trees
3885
 
        result_tree = self._get_preview(merger)
3886
 
        path_encoding = osutils.get_diff_header_encoding()
 
3740
        result_tree = self._get_preview(merger, cleanups)
3887
3741
        show_diff_trees(merger.this_tree, result_tree, self.outf,
3888
 
                        old_label='', new_label='',
3889
 
                        path_encoding=path_encoding)
 
3742
                        old_label='', new_label='')
3890
3743
 
3891
3744
    def _do_merge(self, merger, change_reporter, allow_pending, verified):
3892
3745
        merger.change_reporter = change_reporter
3900
3753
        else:
3901
3754
            return 0
3902
3755
 
3903
 
    def _do_interactive(self, merger):
 
3756
    def _do_interactive(self, merger, cleanups):
3904
3757
        """Perform an interactive merge.
3905
3758
 
3906
3759
        This works by generating a preview tree of the merge, then using
3908
3761
        and the preview tree.
3909
3762
        """
3910
3763
        from bzrlib import shelf_ui
3911
 
        result_tree = self._get_preview(merger)
 
3764
        result_tree = self._get_preview(merger, cleanups)
3912
3765
        writer = bzrlib.option.diff_writer_registry.get()
3913
3766
        shelver = shelf_ui.Shelver(merger.this_tree, result_tree, destroy=True,
3914
3767
                                   reporter=shelf_ui.ApplyReporter(),
3915
3768
                                   diff_writer=writer(sys.stdout))
3916
 
        try:
3917
 
            shelver.run()
3918
 
        finally:
3919
 
            shelver.finalize()
 
3769
        shelver.run()
3920
3770
 
3921
3771
    def sanity_check_merger(self, merger):
3922
3772
        if (merger.show_base and
3982
3832
            allow_pending = True
3983
3833
        return merger, allow_pending
3984
3834
 
3985
 
    def get_merger_from_uncommitted(self, tree, location, pb):
 
3835
    def get_merger_from_uncommitted(self, tree, location, pb, cleanups):
3986
3836
        """Get a merger for uncommitted changes.
3987
3837
 
3988
3838
        :param tree: The tree the merger should apply to.
3989
3839
        :param location: The location containing uncommitted changes.
3990
3840
        :param pb: The progress bar to use for showing progress.
 
3841
        :param cleanups: A list of operations to perform to clean up the
 
3842
            temporary directories, unfinalized objects, etc.
3991
3843
        """
3992
3844
        location = self._select_branch_location(tree, location)[0]
3993
3845
        other_tree, other_path = WorkingTree.open_containing(location)
4045
3897
 
4046
3898
 
4047
3899
class cmd_remerge(Command):
4048
 
    __doc__ = """Redo a merge.
 
3900
    """Redo a merge.
4049
3901
 
4050
3902
    Use this if you want to try a different merge technique while resolving
4051
3903
    conflicts.  Some merge techniques are better than others, and remerge
4076
3928
 
4077
3929
    def run(self, file_list=None, merge_type=None, show_base=False,
4078
3930
            reprocess=False):
4079
 
        from bzrlib.conflicts import restore
4080
3931
        if merge_type is None:
4081
3932
            merge_type = _mod_merge.Merge3Merger
4082
 
        tree, file_list = WorkingTree.open_containing_paths(file_list)
4083
 
        self.add_cleanup(tree.lock_write().unlock)
4084
 
        parents = tree.get_parent_ids()
4085
 
        if len(parents) != 2:
4086
 
            raise errors.BzrCommandError("Sorry, remerge only works after normal"
4087
 
                                         " merges.  Not cherrypicking or"
4088
 
                                         " multi-merges.")
4089
 
        repository = tree.branch.repository
4090
 
        interesting_ids = None
4091
 
        new_conflicts = []
4092
 
        conflicts = tree.conflicts()
4093
 
        if file_list is not None:
4094
 
            interesting_ids = set()
4095
 
            for filename in file_list:
4096
 
                file_id = tree.path2id(filename)
4097
 
                if file_id is None:
4098
 
                    raise errors.NotVersionedError(filename)
4099
 
                interesting_ids.add(file_id)
4100
 
                if tree.kind(file_id) != "directory":
4101
 
                    continue
 
3933
        tree, file_list = tree_files(file_list)
 
3934
        tree.lock_write()
 
3935
        try:
 
3936
            parents = tree.get_parent_ids()
 
3937
            if len(parents) != 2:
 
3938
                raise errors.BzrCommandError("Sorry, remerge only works after normal"
 
3939
                                             " merges.  Not cherrypicking or"
 
3940
                                             " multi-merges.")
 
3941
            repository = tree.branch.repository
 
3942
            interesting_ids = None
 
3943
            new_conflicts = []
 
3944
            conflicts = tree.conflicts()
 
3945
            if file_list is not None:
 
3946
                interesting_ids = set()
 
3947
                for filename in file_list:
 
3948
                    file_id = tree.path2id(filename)
 
3949
                    if file_id is None:
 
3950
                        raise errors.NotVersionedError(filename)
 
3951
                    interesting_ids.add(file_id)
 
3952
                    if tree.kind(file_id) != "directory":
 
3953
                        continue
4102
3954
 
4103
 
                for name, ie in tree.inventory.iter_entries(file_id):
4104
 
                    interesting_ids.add(ie.file_id)
4105
 
            new_conflicts = conflicts.select_conflicts(tree, file_list)[0]
4106
 
        else:
4107
 
            # Remerge only supports resolving contents conflicts
4108
 
            allowed_conflicts = ('text conflict', 'contents conflict')
4109
 
            restore_files = [c.path for c in conflicts
4110
 
                             if c.typestring in allowed_conflicts]
4111
 
        _mod_merge.transform_tree(tree, tree.basis_tree(), interesting_ids)
4112
 
        tree.set_conflicts(ConflictList(new_conflicts))
4113
 
        if file_list is not None:
4114
 
            restore_files = file_list
4115
 
        for filename in restore_files:
 
3955
                    for name, ie in tree.inventory.iter_entries(file_id):
 
3956
                        interesting_ids.add(ie.file_id)
 
3957
                new_conflicts = conflicts.select_conflicts(tree, file_list)[0]
 
3958
            else:
 
3959
                # Remerge only supports resolving contents conflicts
 
3960
                allowed_conflicts = ('text conflict', 'contents conflict')
 
3961
                restore_files = [c.path for c in conflicts
 
3962
                                 if c.typestring in allowed_conflicts]
 
3963
            _mod_merge.transform_tree(tree, tree.basis_tree(), interesting_ids)
 
3964
            tree.set_conflicts(ConflictList(new_conflicts))
 
3965
            if file_list is not None:
 
3966
                restore_files = file_list
 
3967
            for filename in restore_files:
 
3968
                try:
 
3969
                    restore(tree.abspath(filename))
 
3970
                except errors.NotConflicted:
 
3971
                    pass
 
3972
            # Disable pending merges, because the file texts we are remerging
 
3973
            # have not had those merges performed.  If we use the wrong parents
 
3974
            # list, we imply that the working tree text has seen and rejected
 
3975
            # all the changes from the other tree, when in fact those changes
 
3976
            # have not yet been seen.
 
3977
            pb = ui.ui_factory.nested_progress_bar()
 
3978
            tree.set_parent_ids(parents[:1])
4116
3979
            try:
4117
 
                restore(tree.abspath(filename))
4118
 
            except errors.NotConflicted:
4119
 
                pass
4120
 
        # Disable pending merges, because the file texts we are remerging
4121
 
        # have not had those merges performed.  If we use the wrong parents
4122
 
        # list, we imply that the working tree text has seen and rejected
4123
 
        # all the changes from the other tree, when in fact those changes
4124
 
        # have not yet been seen.
4125
 
        tree.set_parent_ids(parents[:1])
4126
 
        try:
4127
 
            merger = _mod_merge.Merger.from_revision_ids(None, tree, parents[1])
4128
 
            merger.interesting_ids = interesting_ids
4129
 
            merger.merge_type = merge_type
4130
 
            merger.show_base = show_base
4131
 
            merger.reprocess = reprocess
4132
 
            conflicts = merger.do_merge()
 
3980
                merger = _mod_merge.Merger.from_revision_ids(pb,
 
3981
                                                             tree, parents[1])
 
3982
                merger.interesting_ids = interesting_ids
 
3983
                merger.merge_type = merge_type
 
3984
                merger.show_base = show_base
 
3985
                merger.reprocess = reprocess
 
3986
                conflicts = merger.do_merge()
 
3987
            finally:
 
3988
                tree.set_parent_ids(parents)
 
3989
                pb.finished()
4133
3990
        finally:
4134
 
            tree.set_parent_ids(parents)
 
3991
            tree.unlock()
4135
3992
        if conflicts > 0:
4136
3993
            return 1
4137
3994
        else:
4139
3996
 
4140
3997
 
4141
3998
class cmd_revert(Command):
4142
 
    __doc__ = """Revert files to a previous revision.
 
3999
    """Revert files to a previous revision.
4143
4000
 
4144
4001
    Giving a list of files will revert only those files.  Otherwise, all files
4145
4002
    will be reverted.  If the revision is not specified with '--revision', the
4159
4016
    name.  If you name a directory, all the contents of that directory will be
4160
4017
    reverted.
4161
4018
 
4162
 
    If you have newly added files since the target revision, they will be
4163
 
    removed.  If the files to be removed have been changed, backups will be
4164
 
    created as above.  Directories containing unknown files will not be
4165
 
    deleted.
 
4019
    Any files that have been newly added since that revision will be deleted,
 
4020
    with a backup kept if appropriate.  Directories containing unknown files
 
4021
    will not be deleted.
4166
4022
 
4167
 
    The working tree contains a list of revisions that have been merged but
4168
 
    not yet committed. These revisions will be included as additional parents
4169
 
    of the next commit.  Normally, using revert clears that list as well as
4170
 
    reverting the files.  If any files are specified, revert leaves the list
4171
 
    of uncommitted merges alone and reverts only the files.  Use ``bzr revert
4172
 
    .`` in the tree root to revert all files but keep the recorded merges,
4173
 
    and ``bzr revert --forget-merges`` to clear the pending merge list without
 
4023
    The working tree contains a list of pending merged revisions, which will
 
4024
    be included as parents in the next commit.  Normally, revert clears that
 
4025
    list as well as reverting the files.  If any files are specified, revert
 
4026
    leaves the pending merge list alone and reverts only the files.  Use "bzr
 
4027
    revert ." in the tree root to revert all files but keep the merge record,
 
4028
    and "bzr revert --forget-merges" to clear the pending merge list without
4174
4029
    reverting any files.
4175
 
 
4176
 
    Using "bzr revert --forget-merges", it is possible to apply all of the
4177
 
    changes from a branch in a single revision.  To do this, perform the merge
4178
 
    as desired.  Then doing revert with the "--forget-merges" option will keep
4179
 
    the content of the tree as it was, but it will clear the list of pending
4180
 
    merges.  The next commit will then contain all of the changes that are
4181
 
    present in the other branch, but without any other parent revisions.
4182
 
    Because this technique forgets where these changes originated, it may
4183
 
    cause additional conflicts on later merges involving the same source and
4184
 
    target branches.
4185
4030
    """
4186
4031
 
4187
4032
    _see_also = ['cat', 'export']
4195
4040
 
4196
4041
    def run(self, revision=None, no_backup=False, file_list=None,
4197
4042
            forget_merges=None):
4198
 
        tree, file_list = WorkingTree.open_containing_paths(file_list)
4199
 
        self.add_cleanup(tree.lock_tree_write().unlock)
4200
 
        if forget_merges:
4201
 
            tree.set_parent_ids(tree.get_parent_ids()[:1])
4202
 
        else:
4203
 
            self._revert_tree_to_revision(tree, revision, file_list, no_backup)
 
4043
        tree, file_list = tree_files(file_list)
 
4044
        tree.lock_write()
 
4045
        try:
 
4046
            if forget_merges:
 
4047
                tree.set_parent_ids(tree.get_parent_ids()[:1])
 
4048
            else:
 
4049
                self._revert_tree_to_revision(tree, revision, file_list, no_backup)
 
4050
        finally:
 
4051
            tree.unlock()
4204
4052
 
4205
4053
    @staticmethod
4206
4054
    def _revert_tree_to_revision(tree, revision, file_list, no_backup):
4207
4055
        rev_tree = _get_one_revision_tree('revert', revision, tree=tree)
4208
 
        tree.revert(file_list, rev_tree, not no_backup, None,
4209
 
            report_changes=True)
 
4056
        pb = ui.ui_factory.nested_progress_bar()
 
4057
        try:
 
4058
            tree.revert(file_list, rev_tree, not no_backup, pb,
 
4059
                report_changes=True)
 
4060
        finally:
 
4061
            pb.finished()
4210
4062
 
4211
4063
 
4212
4064
class cmd_assert_fail(Command):
4213
 
    __doc__ = """Test reporting of assertion failures"""
 
4065
    """Test reporting of assertion failures"""
4214
4066
    # intended just for use in testing
4215
4067
 
4216
4068
    hidden = True
4220
4072
 
4221
4073
 
4222
4074
class cmd_help(Command):
4223
 
    __doc__ = """Show help on a command or other topic.
 
4075
    """Show help on a command or other topic.
4224
4076
    """
4225
4077
 
4226
4078
    _see_also = ['topics']
4239
4091
 
4240
4092
 
4241
4093
class cmd_shell_complete(Command):
4242
 
    __doc__ = """Show appropriate completions for context.
 
4094
    """Show appropriate completions for context.
4243
4095
 
4244
4096
    For a list of all available commands, say 'bzr shell-complete'.
4245
4097
    """
4254
4106
 
4255
4107
 
4256
4108
class cmd_missing(Command):
4257
 
    __doc__ = """Show unmerged/unpulled revisions between two branches.
 
4109
    """Show unmerged/unpulled revisions between two branches.
4258
4110
 
4259
4111
    OTHER_BRANCH may be local or remote.
4260
4112
 
4261
4113
    To filter on a range of revisions, you can use the command -r begin..end
4262
4114
    -r revision requests a specific revision, -r ..end or -r begin.. are
4263
4115
    also valid.
4264
 
            
4265
 
    :Exit values:
4266
 
        1 - some missing revisions
4267
 
        0 - no missing revisions
4268
4116
 
4269
4117
    :Examples:
4270
4118
 
4291
4139
    _see_also = ['merge', 'pull']
4292
4140
    takes_args = ['other_branch?']
4293
4141
    takes_options = [
4294
 
        'directory',
4295
4142
        Option('reverse', 'Reverse the order of revisions.'),
4296
4143
        Option('mine-only',
4297
4144
               'Display changes in the local branch only.'),
4319
4166
            theirs_only=False,
4320
4167
            log_format=None, long=False, short=False, line=False,
4321
4168
            show_ids=False, verbose=False, this=False, other=False,
4322
 
            include_merges=False, revision=None, my_revision=None,
4323
 
            directory=u'.'):
 
4169
            include_merges=False, revision=None, my_revision=None):
4324
4170
        from bzrlib.missing import find_unmerged, iter_log_revisions
4325
4171
        def message(s):
4326
4172
            if not is_quiet():
4339
4185
        elif theirs_only:
4340
4186
            restrict = 'remote'
4341
4187
 
4342
 
        local_branch = Branch.open_containing(directory)[0]
4343
 
        self.add_cleanup(local_branch.lock_read().unlock)
4344
 
 
 
4188
        local_branch = Branch.open_containing(u".")[0]
4345
4189
        parent = local_branch.get_parent()
4346
4190
        if other_branch is None:
4347
4191
            other_branch = parent
4356
4200
        remote_branch = Branch.open(other_branch)
4357
4201
        if remote_branch.base == local_branch.base:
4358
4202
            remote_branch = local_branch
4359
 
        else:
4360
 
            self.add_cleanup(remote_branch.lock_read().unlock)
4361
4203
 
4362
4204
        local_revid_range = _revision_range_to_revid_range(
4363
4205
            _get_revision_range(my_revision, local_branch,
4367
4209
            _get_revision_range(revision,
4368
4210
                remote_branch, self.name()))
4369
4211
 
4370
 
        local_extra, remote_extra = find_unmerged(
4371
 
            local_branch, remote_branch, restrict,
4372
 
            backward=not reverse,
4373
 
            include_merges=include_merges,
4374
 
            local_revid_range=local_revid_range,
4375
 
            remote_revid_range=remote_revid_range)
4376
 
 
4377
 
        if log_format is None:
4378
 
            registry = log.log_formatter_registry
4379
 
            log_format = registry.get_default(local_branch)
4380
 
        lf = log_format(to_file=self.outf,
4381
 
                        show_ids=show_ids,
4382
 
                        show_timezone='original')
4383
 
 
4384
 
        status_code = 0
4385
 
        if local_extra and not theirs_only:
4386
 
            message("You have %d extra revision(s):\n" %
4387
 
                len(local_extra))
4388
 
            for revision in iter_log_revisions(local_extra,
4389
 
                                local_branch.repository,
4390
 
                                verbose):
4391
 
                lf.log_revision(revision)
4392
 
            printed_local = True
4393
 
            status_code = 1
4394
 
        else:
4395
 
            printed_local = False
4396
 
 
4397
 
        if remote_extra and not mine_only:
4398
 
            if printed_local is True:
4399
 
                message("\n\n\n")
4400
 
            message("You are missing %d revision(s):\n" %
4401
 
                len(remote_extra))
4402
 
            for revision in iter_log_revisions(remote_extra,
4403
 
                                remote_branch.repository,
4404
 
                                verbose):
4405
 
                lf.log_revision(revision)
4406
 
            status_code = 1
4407
 
 
4408
 
        if mine_only and not local_extra:
4409
 
            # We checked local, and found nothing extra
4410
 
            message('This branch is up to date.\n')
4411
 
        elif theirs_only and not remote_extra:
4412
 
            # We checked remote, and found nothing extra
4413
 
            message('Other branch is up to date.\n')
4414
 
        elif not (mine_only or theirs_only or local_extra or
4415
 
                  remote_extra):
4416
 
            # We checked both branches, and neither one had extra
4417
 
            # revisions
4418
 
            message("Branches are up to date.\n")
4419
 
        self.cleanup_now()
 
4212
        local_branch.lock_read()
 
4213
        try:
 
4214
            remote_branch.lock_read()
 
4215
            try:
 
4216
                local_extra, remote_extra = find_unmerged(
 
4217
                    local_branch, remote_branch, restrict,
 
4218
                    backward=not reverse,
 
4219
                    include_merges=include_merges,
 
4220
                    local_revid_range=local_revid_range,
 
4221
                    remote_revid_range=remote_revid_range)
 
4222
 
 
4223
                if log_format is None:
 
4224
                    registry = log.log_formatter_registry
 
4225
                    log_format = registry.get_default(local_branch)
 
4226
                lf = log_format(to_file=self.outf,
 
4227
                                show_ids=show_ids,
 
4228
                                show_timezone='original')
 
4229
 
 
4230
                status_code = 0
 
4231
                if local_extra and not theirs_only:
 
4232
                    message("You have %d extra revision(s):\n" %
 
4233
                        len(local_extra))
 
4234
                    for revision in iter_log_revisions(local_extra,
 
4235
                                        local_branch.repository,
 
4236
                                        verbose):
 
4237
                        lf.log_revision(revision)
 
4238
                    printed_local = True
 
4239
                    status_code = 1
 
4240
                else:
 
4241
                    printed_local = False
 
4242
 
 
4243
                if remote_extra and not mine_only:
 
4244
                    if printed_local is True:
 
4245
                        message("\n\n\n")
 
4246
                    message("You are missing %d revision(s):\n" %
 
4247
                        len(remote_extra))
 
4248
                    for revision in iter_log_revisions(remote_extra,
 
4249
                                        remote_branch.repository,
 
4250
                                        verbose):
 
4251
                        lf.log_revision(revision)
 
4252
                    status_code = 1
 
4253
 
 
4254
                if mine_only and not local_extra:
 
4255
                    # We checked local, and found nothing extra
 
4256
                    message('This branch is up to date.\n')
 
4257
                elif theirs_only and not remote_extra:
 
4258
                    # We checked remote, and found nothing extra
 
4259
                    message('Other branch is up to date.\n')
 
4260
                elif not (mine_only or theirs_only or local_extra or
 
4261
                          remote_extra):
 
4262
                    # We checked both branches, and neither one had extra
 
4263
                    # revisions
 
4264
                    message("Branches are up to date.\n")
 
4265
            finally:
 
4266
                remote_branch.unlock()
 
4267
        finally:
 
4268
            local_branch.unlock()
4420
4269
        if not status_code and parent is None and other_branch is not None:
4421
 
            self.add_cleanup(local_branch.lock_write().unlock)
4422
 
            # handle race conditions - a parent might be set while we run.
4423
 
            if local_branch.get_parent() is None:
4424
 
                local_branch.set_parent(remote_branch.base)
 
4270
            local_branch.lock_write()
 
4271
            try:
 
4272
                # handle race conditions - a parent might be set while we run.
 
4273
                if local_branch.get_parent() is None:
 
4274
                    local_branch.set_parent(remote_branch.base)
 
4275
            finally:
 
4276
                local_branch.unlock()
4425
4277
        return status_code
4426
4278
 
4427
4279
 
4428
4280
class cmd_pack(Command):
4429
 
    __doc__ = """Compress the data within a repository.
4430
 
 
4431
 
    This operation compresses the data within a bazaar repository. As
4432
 
    bazaar supports automatic packing of repository, this operation is
4433
 
    normally not required to be done manually.
4434
 
 
4435
 
    During the pack operation, bazaar takes a backup of existing repository
4436
 
    data, i.e. pack files. This backup is eventually removed by bazaar
4437
 
    automatically when it is safe to do so. To save disk space by removing
4438
 
    the backed up pack files, the --clean-obsolete-packs option may be
4439
 
    used.
4440
 
 
4441
 
    Warning: If you use --clean-obsolete-packs and your machine crashes
4442
 
    during or immediately after repacking, you may be left with a state
4443
 
    where the deletion has been written to disk but the new packs have not
4444
 
    been. In this case the repository may be unusable.
4445
 
    """
 
4281
    """Compress the data within a repository."""
4446
4282
 
4447
4283
    _see_also = ['repositories']
4448
4284
    takes_args = ['branch_or_repo?']
4449
 
    takes_options = [
4450
 
        Option('clean-obsolete-packs', 'Delete obsolete packs to save disk space.'),
4451
 
        ]
4452
4285
 
4453
 
    def run(self, branch_or_repo='.', clean_obsolete_packs=False):
 
4286
    def run(self, branch_or_repo='.'):
4454
4287
        dir = bzrdir.BzrDir.open_containing(branch_or_repo)[0]
4455
4288
        try:
4456
4289
            branch = dir.open_branch()
4457
4290
            repository = branch.repository
4458
4291
        except errors.NotBranchError:
4459
4292
            repository = dir.open_repository()
4460
 
        repository.pack(clean_obsolete_packs=clean_obsolete_packs)
 
4293
        repository.pack()
4461
4294
 
4462
4295
 
4463
4296
class cmd_plugins(Command):
4464
 
    __doc__ = """List the installed plugins.
 
4297
    """List the installed plugins.
4465
4298
 
4466
4299
    This command displays the list of installed plugins including
4467
4300
    version of plugin and a short description of each.
4474
4307
    adding new commands, providing additional network transports and
4475
4308
    customizing log output.
4476
4309
 
4477
 
    See the Bazaar Plugin Guide <http://doc.bazaar.canonical.com/plugins/en/>
4478
 
    for further information on plugins including where to find them and how to
4479
 
    install them. Instructions are also provided there on how to write new
4480
 
    plugins using the Python programming language.
 
4310
    See the Bazaar web site, http://bazaar-vcs.org, for further
 
4311
    information on plugins including where to find them and how to
 
4312
    install them. Instructions are also provided there on how to
 
4313
    write new plugins using the Python programming language.
4481
4314
    """
4482
4315
    takes_options = ['verbose']
4483
4316
 
4498
4331
                doc = '(no description)'
4499
4332
            result.append((name_ver, doc, plugin.path()))
4500
4333
        for name_ver, doc, path in sorted(result):
4501
 
            self.outf.write("%s\n" % name_ver)
4502
 
            self.outf.write("   %s\n" % doc)
 
4334
            print name_ver
 
4335
            print '   ', doc
4503
4336
            if verbose:
4504
 
                self.outf.write("   %s\n" % path)
4505
 
            self.outf.write("\n")
 
4337
                print '   ', path
 
4338
            print
4506
4339
 
4507
4340
 
4508
4341
class cmd_testament(Command):
4509
 
    __doc__ = """Show testament (signing-form) of a revision."""
 
4342
    """Show testament (signing-form) of a revision."""
4510
4343
    takes_options = [
4511
4344
            'revision',
4512
4345
            Option('long', help='Produce long-format testament.'),
4524
4357
            b = Branch.open_containing(branch)[0]
4525
4358
        else:
4526
4359
            b = Branch.open(branch)
4527
 
        self.add_cleanup(b.lock_read().unlock)
4528
 
        if revision is None:
4529
 
            rev_id = b.last_revision()
4530
 
        else:
4531
 
            rev_id = revision[0].as_revision_id(b)
4532
 
        t = testament_class.from_revision(b.repository, rev_id)
4533
 
        if long:
4534
 
            sys.stdout.writelines(t.as_text_lines())
4535
 
        else:
4536
 
            sys.stdout.write(t.as_short_text())
 
4360
        b.lock_read()
 
4361
        try:
 
4362
            if revision is None:
 
4363
                rev_id = b.last_revision()
 
4364
            else:
 
4365
                rev_id = revision[0].as_revision_id(b)
 
4366
            t = testament_class.from_revision(b.repository, rev_id)
 
4367
            if long:
 
4368
                sys.stdout.writelines(t.as_text_lines())
 
4369
            else:
 
4370
                sys.stdout.write(t.as_short_text())
 
4371
        finally:
 
4372
            b.unlock()
4537
4373
 
4538
4374
 
4539
4375
class cmd_annotate(Command):
4540
 
    __doc__ = """Show the origin of each line in a file.
 
4376
    """Show the origin of each line in a file.
4541
4377
 
4542
4378
    This prints out the given file with an annotation on the left side
4543
4379
    indicating which revision, author and date introduced the change.
4554
4390
                     Option('long', help='Show commit date in annotations.'),
4555
4391
                     'revision',
4556
4392
                     'show-ids',
4557
 
                     'directory',
4558
4393
                     ]
4559
4394
    encoding_type = 'exact'
4560
4395
 
4561
4396
    @display_command
4562
4397
    def run(self, filename, all=False, long=False, revision=None,
4563
 
            show_ids=False, directory=None):
 
4398
            show_ids=False):
4564
4399
        from bzrlib.annotate import annotate_file, annotate_file_tree
4565
4400
        wt, branch, relpath = \
4566
 
            _open_directory_or_containing_tree_or_branch(filename, directory)
4567
 
        if wt is not None:
4568
 
            self.add_cleanup(wt.lock_read().unlock)
4569
 
        else:
4570
 
            self.add_cleanup(branch.lock_read().unlock)
4571
 
        tree = _get_one_revision_tree('annotate', revision, branch=branch)
4572
 
        self.add_cleanup(tree.lock_read().unlock)
4573
 
        if wt is not None:
4574
 
            file_id = wt.path2id(relpath)
4575
 
        else:
4576
 
            file_id = tree.path2id(relpath)
4577
 
        if file_id is None:
4578
 
            raise errors.NotVersionedError(filename)
4579
 
        file_version = tree.inventory[file_id].revision
4580
 
        if wt is not None and revision is None:
4581
 
            # If there is a tree and we're not annotating historical
4582
 
            # versions, annotate the working tree's content.
4583
 
            annotate_file_tree(wt, file_id, self.outf, long, all,
4584
 
                show_ids=show_ids)
4585
 
        else:
4586
 
            annotate_file(branch, file_version, file_id, long, all, self.outf,
4587
 
                          show_ids=show_ids)
 
4401
            bzrdir.BzrDir.open_containing_tree_or_branch(filename)
 
4402
        if wt is not None:
 
4403
            wt.lock_read()
 
4404
        else:
 
4405
            branch.lock_read()
 
4406
        try:
 
4407
            tree = _get_one_revision_tree('annotate', revision, branch=branch)
 
4408
            if wt is not None:
 
4409
                file_id = wt.path2id(relpath)
 
4410
            else:
 
4411
                file_id = tree.path2id(relpath)
 
4412
            if file_id is None:
 
4413
                raise errors.NotVersionedError(filename)
 
4414
            file_version = tree.inventory[file_id].revision
 
4415
            if wt is not None and revision is None:
 
4416
                # If there is a tree and we're not annotating historical
 
4417
                # versions, annotate the working tree's content.
 
4418
                annotate_file_tree(wt, file_id, self.outf, long, all,
 
4419
                    show_ids=show_ids)
 
4420
            else:
 
4421
                annotate_file(branch, file_version, file_id, long, all, self.outf,
 
4422
                              show_ids=show_ids)
 
4423
        finally:
 
4424
            if wt is not None:
 
4425
                wt.unlock()
 
4426
            else:
 
4427
                branch.unlock()
4588
4428
 
4589
4429
 
4590
4430
class cmd_re_sign(Command):
4591
 
    __doc__ = """Create a digital signature for an existing revision."""
 
4431
    """Create a digital signature for an existing revision."""
4592
4432
    # TODO be able to replace existing ones.
4593
4433
 
4594
4434
    hidden = True # is this right ?
4595
4435
    takes_args = ['revision_id*']
4596
 
    takes_options = ['directory', 'revision']
 
4436
    takes_options = ['revision']
4597
4437
 
4598
 
    def run(self, revision_id_list=None, revision=None, directory=u'.'):
 
4438
    def run(self, revision_id_list=None, revision=None):
4599
4439
        if revision_id_list is not None and revision is not None:
4600
4440
            raise errors.BzrCommandError('You can only supply one of revision_id or --revision')
4601
4441
        if revision_id_list is None and revision is None:
4602
4442
            raise errors.BzrCommandError('You must supply either --revision or a revision_id')
4603
 
        b = WorkingTree.open_containing(directory)[0].branch
4604
 
        self.add_cleanup(b.lock_write().unlock)
4605
 
        return self._run(b, revision_id_list, revision)
 
4443
        b = WorkingTree.open_containing(u'.')[0].branch
 
4444
        b.lock_write()
 
4445
        try:
 
4446
            return self._run(b, revision_id_list, revision)
 
4447
        finally:
 
4448
            b.unlock()
4606
4449
 
4607
4450
    def _run(self, b, revision_id_list, revision):
4608
4451
        import bzrlib.gpg as gpg
4653
4496
 
4654
4497
 
4655
4498
class cmd_bind(Command):
4656
 
    __doc__ = """Convert the current branch into a checkout of the supplied branch.
4657
 
    If no branch is supplied, rebind to the last bound location.
 
4499
    """Convert the current branch into a checkout of the supplied branch.
4658
4500
 
4659
4501
    Once converted into a checkout, commits must succeed on the master branch
4660
4502
    before they will be applied to the local branch.
4661
4503
 
4662
4504
    Bound branches use the nickname of its master branch unless it is set
4663
 
    locally, in which case binding will update the local nickname to be
 
4505
    locally, in which case binding will update the the local nickname to be
4664
4506
    that of the master.
4665
4507
    """
4666
4508
 
4667
4509
    _see_also = ['checkouts', 'unbind']
4668
4510
    takes_args = ['location?']
4669
 
    takes_options = ['directory']
 
4511
    takes_options = []
4670
4512
 
4671
 
    def run(self, location=None, directory=u'.'):
4672
 
        b, relpath = Branch.open_containing(directory)
 
4513
    def run(self, location=None):
 
4514
        b, relpath = Branch.open_containing(u'.')
4673
4515
        if location is None:
4674
4516
            try:
4675
4517
                location = b.get_old_bound_location()
4678
4520
                    'This format does not remember old locations.')
4679
4521
            else:
4680
4522
                if location is None:
4681
 
                    if b.get_bound_location() is not None:
4682
 
                        raise errors.BzrCommandError('Branch is already bound')
4683
 
                    else:
4684
 
                        raise errors.BzrCommandError('No location supplied '
4685
 
                            'and no previous location known')
 
4523
                    raise errors.BzrCommandError('No location supplied and no '
 
4524
                        'previous location known')
4686
4525
        b_other = Branch.open(location)
4687
4526
        try:
4688
4527
            b.bind(b_other)
4694
4533
 
4695
4534
 
4696
4535
class cmd_unbind(Command):
4697
 
    __doc__ = """Convert the current checkout into a regular branch.
 
4536
    """Convert the current checkout into a regular branch.
4698
4537
 
4699
4538
    After unbinding, the local branch is considered independent and subsequent
4700
4539
    commits will be local only.
4702
4541
 
4703
4542
    _see_also = ['checkouts', 'bind']
4704
4543
    takes_args = []
4705
 
    takes_options = ['directory']
 
4544
    takes_options = []
4706
4545
 
4707
 
    def run(self, directory=u'.'):
4708
 
        b, relpath = Branch.open_containing(directory)
 
4546
    def run(self):
 
4547
        b, relpath = Branch.open_containing(u'.')
4709
4548
        if not b.unbind():
4710
4549
            raise errors.BzrCommandError('Local branch is not bound')
4711
4550
 
4712
4551
 
4713
4552
class cmd_uncommit(Command):
4714
 
    __doc__ = """Remove the last committed revision.
 
4553
    """Remove the last committed revision.
4715
4554
 
4716
4555
    --verbose will print out what is being removed.
4717
4556
    --dry-run will go through all the motions, but not actually
4757
4596
            b = control.open_branch()
4758
4597
 
4759
4598
        if tree is not None:
4760
 
            self.add_cleanup(tree.lock_write().unlock)
 
4599
            tree.lock_write()
4761
4600
        else:
4762
 
            self.add_cleanup(b.lock_write().unlock)
4763
 
        return self._run(b, tree, dry_run, verbose, revision, force, local=local)
 
4601
            b.lock_write()
 
4602
        try:
 
4603
            return self._run(b, tree, dry_run, verbose, revision, force,
 
4604
                             local=local)
 
4605
        finally:
 
4606
            if tree is not None:
 
4607
                tree.unlock()
 
4608
            else:
 
4609
                b.unlock()
4764
4610
 
4765
4611
    def _run(self, b, tree, dry_run, verbose, revision, force, local=False):
4766
4612
        from bzrlib.log import log_formatter, show_log
4798
4644
                 end_revision=last_revno)
4799
4645
 
4800
4646
        if dry_run:
4801
 
            self.outf.write('Dry-run, pretending to remove'
4802
 
                            ' the above revisions.\n')
 
4647
            print 'Dry-run, pretending to remove the above revisions.'
 
4648
            if not force:
 
4649
                val = raw_input('Press <enter> to continue')
4803
4650
        else:
4804
 
            self.outf.write('The above revision(s) will be removed.\n')
4805
 
 
4806
 
        if not force:
4807
 
            if not ui.ui_factory.confirm_action(
4808
 
                    'Uncommit these revisions',
4809
 
                    'bzrlib.builtins.uncommit',
4810
 
                    {}):
4811
 
                self.outf.write('Canceled\n')
4812
 
                return 0
 
4651
            print 'The above revision(s) will be removed.'
 
4652
            if not force:
 
4653
                val = raw_input('Are you sure [y/N]? ')
 
4654
                if val.lower() not in ('y', 'yes'):
 
4655
                    print 'Canceled'
 
4656
                    return 0
4813
4657
 
4814
4658
        mutter('Uncommitting from {%s} to {%s}',
4815
4659
               last_rev_id, rev_id)
4816
4660
        uncommit(b, tree=tree, dry_run=dry_run, verbose=verbose,
4817
4661
                 revno=revno, local=local)
4818
 
        self.outf.write('You can restore the old tip by running:\n'
4819
 
             '  bzr pull . -r revid:%s\n' % last_rev_id)
 
4662
        note('You can restore the old tip by running:\n'
 
4663
             '  bzr pull . -r revid:%s', last_rev_id)
4820
4664
 
4821
4665
 
4822
4666
class cmd_break_lock(Command):
4823
 
    __doc__ = """Break a dead lock.
4824
 
 
4825
 
    This command breaks a lock on a repository, branch, working directory or
4826
 
    config file.
 
4667
    """Break a dead lock on a repository, branch or working directory.
4827
4668
 
4828
4669
    CAUTION: Locks should only be broken when you are sure that the process
4829
4670
    holding the lock has been stopped.
4830
4671
 
4831
 
    You can get information on what locks are open via the 'bzr info
4832
 
    [location]' command.
 
4672
    You can get information on what locks are open via the 'bzr info' command.
4833
4673
 
4834
4674
    :Examples:
4835
4675
        bzr break-lock
4836
 
        bzr break-lock bzr+ssh://example.com/bzr/foo
4837
 
        bzr break-lock --conf ~/.bazaar
4838
4676
    """
4839
 
 
4840
4677
    takes_args = ['location?']
4841
 
    takes_options = [
4842
 
        Option('config',
4843
 
               help='LOCATION is the directory where the config lock is.'),
4844
 
        Option('force',
4845
 
            help='Do not ask for confirmation before breaking the lock.'),
4846
 
        ]
4847
4678
 
4848
 
    def run(self, location=None, config=False, force=False):
 
4679
    def run(self, location=None, show=False):
4849
4680
        if location is None:
4850
4681
            location = u'.'
4851
 
        if force:
4852
 
            ui.ui_factory = ui.ConfirmationUserInterfacePolicy(ui.ui_factory,
4853
 
                None,
4854
 
                {'bzrlib.lockdir.break': True})
4855
 
        if config:
4856
 
            conf = _mod_config.LockableConfig(file_name=location)
4857
 
            conf.break_lock()
4858
 
        else:
4859
 
            control, relpath = bzrdir.BzrDir.open_containing(location)
4860
 
            try:
4861
 
                control.break_lock()
4862
 
            except NotImplementedError:
4863
 
                pass
 
4682
        control, relpath = bzrdir.BzrDir.open_containing(location)
 
4683
        try:
 
4684
            control.break_lock()
 
4685
        except NotImplementedError:
 
4686
            pass
4864
4687
 
4865
4688
 
4866
4689
class cmd_wait_until_signalled(Command):
4867
 
    __doc__ = """Test helper for test_start_and_stop_bzr_subprocess_send_signal.
 
4690
    """Test helper for test_start_and_stop_bzr_subprocess_send_signal.
4868
4691
 
4869
4692
    This just prints a line to signal when it is ready, then blocks on stdin.
4870
4693
    """
4878
4701
 
4879
4702
 
4880
4703
class cmd_serve(Command):
4881
 
    __doc__ = """Run the bzr server."""
 
4704
    """Run the bzr server."""
4882
4705
 
4883
4706
    aliases = ['server']
4884
4707
 
4885
4708
    takes_options = [
4886
4709
        Option('inet',
4887
4710
               help='Serve on stdin/out for use from inetd or sshd.'),
4888
 
        RegistryOption('protocol',
4889
 
               help="Protocol to serve.",
 
4711
        RegistryOption('protocol', 
 
4712
               help="Protocol to serve.", 
4890
4713
               lazy_registry=('bzrlib.transport', 'transport_server_registry'),
4891
4714
               value_switches=True),
4892
4715
        Option('port',
4895
4718
                    'result in a dynamically allocated port.  The default port '
4896
4719
                    'depends on the protocol.',
4897
4720
               type=str),
4898
 
        custom_help('directory',
4899
 
               help='Serve contents of this directory.'),
 
4721
        Option('directory',
 
4722
               help='Serve contents of this directory.',
 
4723
               type=unicode),
4900
4724
        Option('allow-writes',
4901
4725
               help='By default the server is a readonly server.  Supplying '
4902
4726
                    '--allow-writes enables write access to the contents of '
4903
 
                    'the served directory and below.  Note that ``bzr serve`` '
4904
 
                    'does not perform authentication, so unless some form of '
4905
 
                    'external authentication is arranged supplying this '
4906
 
                    'option leads to global uncontrolled write access to your '
4907
 
                    'file system.'
 
4727
                    'the served directory and below.'
4908
4728
                ),
4909
4729
        ]
4910
4730
 
4929
4749
 
4930
4750
    def run(self, port=None, inet=False, directory=None, allow_writes=False,
4931
4751
            protocol=None):
4932
 
        from bzrlib import transport
 
4752
        from bzrlib.transport import get_transport, transport_server_registry
4933
4753
        if directory is None:
4934
4754
            directory = os.getcwd()
4935
4755
        if protocol is None:
4936
 
            protocol = transport.transport_server_registry.get()
 
4756
            protocol = transport_server_registry.get()
4937
4757
        host, port = self.get_host_and_port(port)
4938
4758
        url = urlutils.local_path_to_url(directory)
4939
4759
        if not allow_writes:
4940
4760
            url = 'readonly+' + url
4941
 
        t = transport.get_transport(url)
4942
 
        protocol(t, host, port, inet)
 
4761
        transport = get_transport(url)
 
4762
        protocol(transport, host, port, inet)
4943
4763
 
4944
4764
 
4945
4765
class cmd_join(Command):
4946
 
    __doc__ = """Combine a tree into its containing tree.
 
4766
    """Combine a tree into its containing tree.
4947
4767
 
4948
4768
    This command requires the target tree to be in a rich-root format.
4949
4769
 
4951
4771
    not part of it.  (Such trees can be produced by "bzr split", but also by
4952
4772
    running "bzr branch" with the target inside a tree.)
4953
4773
 
4954
 
    The result is a combined tree, with the subtree no longer an independent
 
4774
    The result is a combined tree, with the subtree no longer an independant
4955
4775
    part.  This is marked as a merge of the subtree into the containing tree,
4956
4776
    and all history is preserved.
4957
4777
    """
4989
4809
 
4990
4810
 
4991
4811
class cmd_split(Command):
4992
 
    __doc__ = """Split a subdirectory of a tree into a separate tree.
 
4812
    """Split a subdirectory of a tree into a separate tree.
4993
4813
 
4994
4814
    This command will produce a target tree in a format that supports
4995
4815
    rich roots, like 'rich-root' or 'rich-root-pack'.  These formats cannot be
5015
4835
 
5016
4836
 
5017
4837
class cmd_merge_directive(Command):
5018
 
    __doc__ = """Generate a merge directive for auto-merge tools.
 
4838
    """Generate a merge directive for auto-merge tools.
5019
4839
 
5020
4840
    A directive requests a merge to be performed, and also provides all the
5021
4841
    information necessary to do so.  This means it must either include a
5038
4858
    _see_also = ['send']
5039
4859
 
5040
4860
    takes_options = [
5041
 
        'directory',
5042
4861
        RegistryOption.from_kwargs('patch-type',
5043
4862
            'The type of patch to include in the directive.',
5044
4863
            title='Patch type',
5057
4876
    encoding_type = 'exact'
5058
4877
 
5059
4878
    def run(self, submit_branch=None, public_branch=None, patch_type='bundle',
5060
 
            sign=False, revision=None, mail_to=None, message=None,
5061
 
            directory=u'.'):
 
4879
            sign=False, revision=None, mail_to=None, message=None):
5062
4880
        from bzrlib.revision import ensure_null, NULL_REVISION
5063
4881
        include_patch, include_bundle = {
5064
4882
            'plain': (False, False),
5065
4883
            'diff': (True, False),
5066
4884
            'bundle': (True, True),
5067
4885
            }[patch_type]
5068
 
        branch = Branch.open(directory)
 
4886
        branch = Branch.open('.')
5069
4887
        stored_submit_branch = branch.get_submit_branch()
5070
4888
        if submit_branch is None:
5071
4889
            submit_branch = stored_submit_branch
5116
4934
 
5117
4935
 
5118
4936
class cmd_send(Command):
5119
 
    __doc__ = """Mail or create a merge-directive for submitting changes.
 
4937
    """Mail or create a merge-directive for submitting changes.
5120
4938
 
5121
4939
    A merge directive provides many things needed for requesting merges:
5122
4940
 
5128
4946
      directly from the merge directive, without retrieving data from a
5129
4947
      branch.
5130
4948
 
5131
 
    `bzr send` creates a compact data set that, when applied using bzr
5132
 
    merge, has the same effect as merging from the source branch.  
5133
 
    
5134
 
    By default the merge directive is self-contained and can be applied to any
5135
 
    branch containing submit_branch in its ancestory without needing access to
5136
 
    the source branch.
5137
 
    
5138
 
    If --no-bundle is specified, then Bazaar doesn't send the contents of the
5139
 
    revisions, but only a structured request to merge from the
5140
 
    public_location.  In that case the public_branch is needed and it must be
5141
 
    up-to-date and accessible to the recipient.  The public_branch is always
5142
 
    included if known, so that people can check it later.
5143
 
 
5144
 
    The submit branch defaults to the parent of the source branch, but can be
5145
 
    overridden.  Both submit branch and public branch will be remembered in
5146
 
    branch.conf the first time they are used for a particular branch.  The
5147
 
    source branch defaults to that containing the working directory, but can
5148
 
    be changed using --from.
5149
 
 
5150
 
    In order to calculate those changes, bzr must analyse the submit branch.
5151
 
    Therefore it is most efficient for the submit branch to be a local mirror.
5152
 
    If a public location is known for the submit_branch, that location is used
5153
 
    in the merge directive.
5154
 
 
5155
 
    The default behaviour is to send the merge directive by mail, unless -o is
5156
 
    given, in which case it is sent to a file.
 
4949
    If --no-bundle is specified, then public_branch is needed (and must be
 
4950
    up-to-date), so that the receiver can perform the merge using the
 
4951
    public_branch.  The public_branch is always included if known, so that
 
4952
    people can check it later.
 
4953
 
 
4954
    The submit branch defaults to the parent, but can be overridden.  Both
 
4955
    submit branch and public branch will be remembered if supplied.
 
4956
 
 
4957
    If a public_branch is known for the submit_branch, that public submit
 
4958
    branch is used in the merge instructions.  This means that a local mirror
 
4959
    can be used as your actual submit branch, once you have set public_branch
 
4960
    for that mirror.
5157
4961
 
5158
4962
    Mail is sent using your preferred mail program.  This should be transparent
5159
 
    on Windows (it uses MAPI).  On Unix, it requires the xdg-email utility.
 
4963
    on Windows (it uses MAPI).  On Linux, it requires the xdg-email utility.
5160
4964
    If the preferred client can't be found (or used), your editor will be used.
5161
4965
 
5162
4966
    To use a specific mail program, set the mail_client configuration option.
5163
4967
    (For Thunderbird 1.5, this works around some bugs.)  Supported values for
5164
 
    specific clients are "claws", "evolution", "kmail", "mail.app" (MacOS X's
5165
 
    Mail.app), "mutt", and "thunderbird"; generic options are "default",
5166
 
    "editor", "emacsclient", "mapi", and "xdg-email".  Plugins may also add
5167
 
    supported clients.
 
4968
    specific clients are "claws", "evolution", "kmail", "mutt", and
 
4969
    "thunderbird"; generic options are "default", "editor", "emacsclient",
 
4970
    "mapi", and "xdg-email".  Plugins may also add supported clients.
5168
4971
 
5169
4972
    If mail is being sent, a to address is required.  This can be supplied
5170
4973
    either on the commandline, by setting the submit_to configuration
5179
4982
 
5180
4983
    The merge directives created by bzr send may be applied using bzr merge or
5181
4984
    bzr pull by specifying a file containing a merge directive as the location.
5182
 
 
5183
 
    bzr send makes extensive use of public locations to map local locations into
5184
 
    URLs that can be used by other people.  See `bzr help configuration` to
5185
 
    set them, and use `bzr info` to display them.
5186
4985
    """
5187
4986
 
5188
4987
    encoding_type = 'exact'
5204
5003
               short_name='f',
5205
5004
               type=unicode),
5206
5005
        Option('output', short_name='o',
5207
 
               help='Write merge directive to this file or directory; '
 
5006
               help='Write merge directive to this file; '
5208
5007
                    'use - for stdout.',
5209
5008
               type=unicode),
5210
5009
        Option('strict',
5233
5032
 
5234
5033
 
5235
5034
class cmd_bundle_revisions(cmd_send):
5236
 
    __doc__ = """Create a merge-directive for submitting changes.
 
5035
    """Create a merge-directive for submitting changes.
5237
5036
 
5238
5037
    A merge directive provides many things needed for requesting merges:
5239
5038
 
5306
5105
 
5307
5106
 
5308
5107
class cmd_tag(Command):
5309
 
    __doc__ = """Create, remove or modify a tag naming a revision.
 
5108
    """Create, remove or modify a tag naming a revision.
5310
5109
 
5311
5110
    Tags give human-meaningful names to revisions.  Commands that take a -r
5312
5111
    (--revision) option can be given -rtag:X, where X is any previously
5320
5119
 
5321
5120
    To rename a tag (change the name but keep it on the same revsion), run ``bzr
5322
5121
    tag new-name -r tag:old-name`` and then ``bzr tag --delete oldname``.
5323
 
 
5324
 
    If no tag name is specified it will be determined through the 
5325
 
    'automatic_tag_name' hook. This can e.g. be used to automatically tag
5326
 
    upstream releases by reading configure.ac. See ``bzr help hooks`` for
5327
 
    details.
5328
5122
    """
5329
5123
 
5330
5124
    _see_also = ['commit', 'tags']
5331
 
    takes_args = ['tag_name?']
 
5125
    takes_args = ['tag_name']
5332
5126
    takes_options = [
5333
5127
        Option('delete',
5334
5128
            help='Delete this tag rather than placing it.',
5335
5129
            ),
5336
 
        custom_help('directory',
5337
 
            help='Branch in which to place the tag.'),
 
5130
        Option('directory',
 
5131
            help='Branch in which to place the tag.',
 
5132
            short_name='d',
 
5133
            type=unicode,
 
5134
            ),
5338
5135
        Option('force',
5339
5136
            help='Replace existing tags.',
5340
5137
            ),
5341
5138
        'revision',
5342
5139
        ]
5343
5140
 
5344
 
    def run(self, tag_name=None,
 
5141
    def run(self, tag_name,
5345
5142
            delete=None,
5346
5143
            directory='.',
5347
5144
            force=None,
5348
5145
            revision=None,
5349
5146
            ):
5350
5147
        branch, relpath = Branch.open_containing(directory)
5351
 
        self.add_cleanup(branch.lock_write().unlock)
5352
 
        if delete:
5353
 
            if tag_name is None:
5354
 
                raise errors.BzrCommandError("No tag specified to delete.")
5355
 
            branch.tags.delete_tag(tag_name)
5356
 
            self.outf.write('Deleted tag %s.\n' % tag_name)
5357
 
        else:
5358
 
            if revision:
5359
 
                if len(revision) != 1:
5360
 
                    raise errors.BzrCommandError(
5361
 
                        "Tags can only be placed on a single revision, "
5362
 
                        "not on a range")
5363
 
                revision_id = revision[0].as_revision_id(branch)
 
5148
        branch.lock_write()
 
5149
        try:
 
5150
            if delete:
 
5151
                branch.tags.delete_tag(tag_name)
 
5152
                self.outf.write('Deleted tag %s.\n' % tag_name)
5364
5153
            else:
5365
 
                revision_id = branch.last_revision()
5366
 
            if tag_name is None:
5367
 
                tag_name = branch.automatic_tag_name(revision_id)
5368
 
                if tag_name is None:
5369
 
                    raise errors.BzrCommandError(
5370
 
                        "Please specify a tag name.")
5371
 
            if (not force) and branch.tags.has_tag(tag_name):
5372
 
                raise errors.TagAlreadyExists(tag_name)
5373
 
            branch.tags.set_tag(tag_name, revision_id)
5374
 
            self.outf.write('Created tag %s.\n' % tag_name)
 
5154
                if revision:
 
5155
                    if len(revision) != 1:
 
5156
                        raise errors.BzrCommandError(
 
5157
                            "Tags can only be placed on a single revision, "
 
5158
                            "not on a range")
 
5159
                    revision_id = revision[0].as_revision_id(branch)
 
5160
                else:
 
5161
                    revision_id = branch.last_revision()
 
5162
                if (not force) and branch.tags.has_tag(tag_name):
 
5163
                    raise errors.TagAlreadyExists(tag_name)
 
5164
                branch.tags.set_tag(tag_name, revision_id)
 
5165
                self.outf.write('Created tag %s.\n' % tag_name)
 
5166
        finally:
 
5167
            branch.unlock()
5375
5168
 
5376
5169
 
5377
5170
class cmd_tags(Command):
5378
 
    __doc__ = """List tags.
 
5171
    """List tags.
5379
5172
 
5380
5173
    This command shows a table of tag names and the revisions they reference.
5381
5174
    """
5382
5175
 
5383
5176
    _see_also = ['tag']
5384
5177
    takes_options = [
5385
 
        custom_help('directory',
5386
 
            help='Branch whose tags should be displayed.'),
 
5178
        Option('directory',
 
5179
            help='Branch whose tags should be displayed.',
 
5180
            short_name='d',
 
5181
            type=unicode,
 
5182
            ),
5387
5183
        RegistryOption.from_kwargs('sort',
5388
5184
            'Sort tags by different criteria.', title='Sorting',
5389
5185
            alpha='Sort tags lexicographically (default).',
5406
5202
        if not tags:
5407
5203
            return
5408
5204
 
5409
 
        self.add_cleanup(branch.lock_read().unlock)
5410
 
        if revision:
5411
 
            graph = branch.repository.get_graph()
5412
 
            rev1, rev2 = _get_revision_range(revision, branch, self.name())
5413
 
            revid1, revid2 = rev1.rev_id, rev2.rev_id
5414
 
            # only show revisions between revid1 and revid2 (inclusive)
5415
 
            tags = [(tag, revid) for tag, revid in tags if
5416
 
                graph.is_between(revid, revid1, revid2)]
5417
 
        if sort == 'alpha':
5418
 
            tags.sort()
5419
 
        elif sort == 'time':
5420
 
            timestamps = {}
5421
 
            for tag, revid in tags:
5422
 
                try:
5423
 
                    revobj = branch.repository.get_revision(revid)
5424
 
                except errors.NoSuchRevision:
5425
 
                    timestamp = sys.maxint # place them at the end
5426
 
                else:
5427
 
                    timestamp = revobj.timestamp
5428
 
                timestamps[revid] = timestamp
5429
 
            tags.sort(key=lambda x: timestamps[x[1]])
5430
 
        if not show_ids:
5431
 
            # [ (tag, revid), ... ] -> [ (tag, dotted_revno), ... ]
5432
 
            for index, (tag, revid) in enumerate(tags):
5433
 
                try:
5434
 
                    revno = branch.revision_id_to_dotted_revno(revid)
5435
 
                    if isinstance(revno, tuple):
5436
 
                        revno = '.'.join(map(str, revno))
5437
 
                except errors.NoSuchRevision:
5438
 
                    # Bad tag data/merges can lead to tagged revisions
5439
 
                    # which are not in this branch. Fail gracefully ...
5440
 
                    revno = '?'
5441
 
                tags[index] = (tag, revno)
5442
 
        self.cleanup_now()
 
5205
        branch.lock_read()
 
5206
        try:
 
5207
            if revision:
 
5208
                graph = branch.repository.get_graph()
 
5209
                rev1, rev2 = _get_revision_range(revision, branch, self.name())
 
5210
                revid1, revid2 = rev1.rev_id, rev2.rev_id
 
5211
                # only show revisions between revid1 and revid2 (inclusive)
 
5212
                tags = [(tag, revid) for tag, revid in tags if
 
5213
                    graph.is_between(revid, revid1, revid2)]
 
5214
            if sort == 'alpha':
 
5215
                tags.sort()
 
5216
            elif sort == 'time':
 
5217
                timestamps = {}
 
5218
                for tag, revid in tags:
 
5219
                    try:
 
5220
                        revobj = branch.repository.get_revision(revid)
 
5221
                    except errors.NoSuchRevision:
 
5222
                        timestamp = sys.maxint # place them at the end
 
5223
                    else:
 
5224
                        timestamp = revobj.timestamp
 
5225
                    timestamps[revid] = timestamp
 
5226
                tags.sort(key=lambda x: timestamps[x[1]])
 
5227
            if not show_ids:
 
5228
                # [ (tag, revid), ... ] -> [ (tag, dotted_revno), ... ]
 
5229
                for index, (tag, revid) in enumerate(tags):
 
5230
                    try:
 
5231
                        revno = branch.revision_id_to_dotted_revno(revid)
 
5232
                        if isinstance(revno, tuple):
 
5233
                            revno = '.'.join(map(str, revno))
 
5234
                    except errors.NoSuchRevision:
 
5235
                        # Bad tag data/merges can lead to tagged revisions
 
5236
                        # which are not in this branch. Fail gracefully ...
 
5237
                        revno = '?'
 
5238
                    tags[index] = (tag, revno)
 
5239
        finally:
 
5240
            branch.unlock()
5443
5241
        for tag, revspec in tags:
5444
5242
            self.outf.write('%-20s %s\n' % (tag, revspec))
5445
5243
 
5446
5244
 
5447
5245
class cmd_reconfigure(Command):
5448
 
    __doc__ = """Reconfigure the type of a bzr directory.
 
5246
    """Reconfigure the type of a bzr directory.
5449
5247
 
5450
5248
    A target configuration must be specified.
5451
5249
 
5536
5334
 
5537
5335
 
5538
5336
class cmd_switch(Command):
5539
 
    __doc__ = """Set the branch of a checkout and update.
 
5337
    """Set the branch of a checkout and update.
5540
5338
 
5541
5339
    For lightweight checkouts, this changes the branch being referenced.
5542
5340
    For heavyweight checkouts, this checks that there are no local commits
5554
5352
    /path/to/newbranch.
5555
5353
 
5556
5354
    Bound branches use the nickname of its master branch unless it is set
5557
 
    locally, in which case switching will update the local nickname to be
 
5355
    locally, in which case switching will update the the local nickname to be
5558
5356
    that of the master.
5559
5357
    """
5560
5358
 
5561
 
    takes_args = ['to_location?']
5562
 
    takes_options = ['directory',
5563
 
                     Option('force',
 
5359
    takes_args = ['to_location']
 
5360
    takes_options = [Option('force',
5564
5361
                        help='Switch even if local commits will be lost.'),
5565
 
                     'revision',
5566
5362
                     Option('create-branch', short_name='b',
5567
5363
                        help='Create the target branch from this one before'
5568
5364
                             ' switching to it.'),
5569
 
                    ]
 
5365
                     ]
5570
5366
 
5571
 
    def run(self, to_location=None, force=False, create_branch=False,
5572
 
            revision=None, directory=u'.'):
 
5367
    def run(self, to_location, force=False, create_branch=False):
5573
5368
        from bzrlib import switch
5574
 
        tree_location = directory
5575
 
        revision = _get_one_revision('switch', revision)
 
5369
        tree_location = '.'
5576
5370
        control_dir = bzrdir.BzrDir.open_containing(tree_location)[0]
5577
 
        if to_location is None:
5578
 
            if revision is None:
5579
 
                raise errors.BzrCommandError('You must supply either a'
5580
 
                                             ' revision or a location')
5581
 
            to_location = tree_location
5582
5371
        try:
5583
5372
            branch = control_dir.open_branch()
5584
5373
            had_explicit_nick = branch.get_config().has_explicit_nickname()
5589
5378
            if branch is None:
5590
5379
                raise errors.BzrCommandError('cannot create branch without'
5591
5380
                                             ' source branch')
5592
 
            to_location = directory_service.directories.dereference(
5593
 
                              to_location)
5594
5381
            if '/' not in to_location and '\\' not in to_location:
5595
5382
                # This path is meant to be relative to the existing branch
5596
5383
                this_url = self._get_branch_location(control_dir)
5598
5385
            to_branch = branch.bzrdir.sprout(to_location,
5599
5386
                                 possible_transports=[branch.bzrdir.root_transport],
5600
5387
                                 source_branch=branch).open_branch()
 
5388
            # try:
 
5389
            #     from_branch = control_dir.open_branch()
 
5390
            # except errors.NotBranchError:
 
5391
            #     raise BzrCommandError('Cannot create a branch from this'
 
5392
            #         ' location when we cannot open this branch')
 
5393
            # from_branch.bzrdir.sprout(
 
5394
            pass
5601
5395
        else:
5602
5396
            try:
5603
5397
                to_branch = Branch.open(to_location)
5605
5399
                this_url = self._get_branch_location(control_dir)
5606
5400
                to_branch = Branch.open(
5607
5401
                    urlutils.join(this_url, '..', to_location))
5608
 
        if revision is not None:
5609
 
            revision = revision.as_revision_id(to_branch)
5610
 
        switch.switch(control_dir, to_branch, force, revision_id=revision)
 
5402
        switch.switch(control_dir, to_branch, force)
5611
5403
        if had_explicit_nick:
5612
5404
            branch = control_dir.open_branch() #get the new branch!
5613
5405
            branch.nick = to_branch.nick
5633
5425
 
5634
5426
 
5635
5427
class cmd_view(Command):
5636
 
    __doc__ = """Manage filtered views.
 
5428
    """Manage filtered views.
5637
5429
 
5638
5430
    Views provide a mask over the tree so that users can focus on
5639
5431
    a subset of a tree when doing their work. After creating a view,
5719
5511
            name=None,
5720
5512
            switch=None,
5721
5513
            ):
5722
 
        tree, file_list = WorkingTree.open_containing_paths(file_list,
5723
 
            apply_view=False)
 
5514
        tree, file_list = tree_files(file_list, apply_view=False)
5724
5515
        current_view, view_dict = tree.views.get_view_info()
5725
5516
        if name is None:
5726
5517
            name = current_view
5788
5579
 
5789
5580
 
5790
5581
class cmd_hooks(Command):
5791
 
    __doc__ = """Show hooks."""
 
5582
    """Show hooks."""
5792
5583
 
5793
5584
    hidden = True
5794
5585
 
5807
5598
                    self.outf.write("    <no hooks installed>\n")
5808
5599
 
5809
5600
 
5810
 
class cmd_remove_branch(Command):
5811
 
    __doc__ = """Remove a branch.
5812
 
 
5813
 
    This will remove the branch from the specified location but 
5814
 
    will keep any working tree or repository in place.
5815
 
 
5816
 
    :Examples:
5817
 
 
5818
 
      Remove the branch at repo/trunk::
5819
 
 
5820
 
        bzr remove-branch repo/trunk
5821
 
 
5822
 
    """
5823
 
 
5824
 
    takes_args = ["location?"]
5825
 
 
5826
 
    aliases = ["rmbranch"]
5827
 
 
5828
 
    def run(self, location=None):
5829
 
        if location is None:
5830
 
            location = "."
5831
 
        branch = Branch.open_containing(location)[0]
5832
 
        branch.bzrdir.destroy_branch()
5833
 
        
5834
 
 
5835
5601
class cmd_shelve(Command):
5836
 
    __doc__ = """Temporarily set aside some changes from the current tree.
 
5602
    """Temporarily set aside some changes from the current tree.
5837
5603
 
5838
5604
    Shelve allows you to temporarily put changes you've made "on the shelf",
5839
5605
    ie. out of the way, until a later time when you can bring them back from
5860
5626
    takes_args = ['file*']
5861
5627
 
5862
5628
    takes_options = [
5863
 
        'directory',
5864
5629
        'revision',
5865
5630
        Option('all', help='Shelve all changes.'),
5866
5631
        'message',
5875
5640
    _see_also = ['unshelve']
5876
5641
 
5877
5642
    def run(self, revision=None, all=False, file_list=None, message=None,
5878
 
            writer=None, list=False, destroy=False, directory=u'.'):
 
5643
            writer=None, list=False, destroy=False):
5879
5644
        if list:
5880
5645
            return self.run_for_list()
5881
5646
        from bzrlib.shelf_ui import Shelver
5883
5648
            writer = bzrlib.option.diff_writer_registry.get()
5884
5649
        try:
5885
5650
            shelver = Shelver.from_args(writer(sys.stdout), revision, all,
5886
 
                file_list, message, destroy=destroy, directory=directory)
 
5651
                file_list, message, destroy=destroy)
5887
5652
            try:
5888
5653
                shelver.run()
5889
5654
            finally:
5890
 
                shelver.finalize()
 
5655
                shelver.work_tree.unlock()
5891
5656
        except errors.UserAbort:
5892
5657
            return 0
5893
5658
 
5894
5659
    def run_for_list(self):
5895
5660
        tree = WorkingTree.open_containing('.')[0]
5896
 
        self.add_cleanup(tree.lock_read().unlock)
5897
 
        manager = tree.get_shelf_manager()
5898
 
        shelves = manager.active_shelves()
5899
 
        if len(shelves) == 0:
5900
 
            note('No shelved changes.')
5901
 
            return 0
5902
 
        for shelf_id in reversed(shelves):
5903
 
            message = manager.get_metadata(shelf_id).get('message')
5904
 
            if message is None:
5905
 
                message = '<no message>'
5906
 
            self.outf.write('%3d: %s\n' % (shelf_id, message))
5907
 
        return 1
 
5661
        tree.lock_read()
 
5662
        try:
 
5663
            manager = tree.get_shelf_manager()
 
5664
            shelves = manager.active_shelves()
 
5665
            if len(shelves) == 0:
 
5666
                note('No shelved changes.')
 
5667
                return 0
 
5668
            for shelf_id in reversed(shelves):
 
5669
                message = manager.get_metadata(shelf_id).get('message')
 
5670
                if message is None:
 
5671
                    message = '<no message>'
 
5672
                self.outf.write('%3d: %s\n' % (shelf_id, message))
 
5673
            return 1
 
5674
        finally:
 
5675
            tree.unlock()
5908
5676
 
5909
5677
 
5910
5678
class cmd_unshelve(Command):
5911
 
    __doc__ = """Restore shelved changes.
 
5679
    """Restore shelved changes.
5912
5680
 
5913
5681
    By default, the most recently shelved changes are restored. However if you
5914
5682
    specify a shelf by id those changes will be restored instead.  This works
5917
5685
 
5918
5686
    takes_args = ['shelf_id?']
5919
5687
    takes_options = [
5920
 
        'directory',
5921
5688
        RegistryOption.from_kwargs(
5922
5689
            'action', help="The action to perform.",
5923
5690
            enum_switch=False, value_switches=True,
5924
5691
            apply="Apply changes and remove from the shelf.",
5925
5692
            dry_run="Show changes, but do not apply or remove them.",
5926
 
            preview="Instead of unshelving the changes, show the diff that "
5927
 
                    "would result from unshelving.",
5928
 
            delete_only="Delete changes without applying them.",
5929
 
            keep="Apply changes but don't delete them.",
 
5693
            delete_only="Delete changes without applying them."
5930
5694
        )
5931
5695
    ]
5932
5696
    _see_also = ['shelve']
5933
5697
 
5934
 
    def run(self, shelf_id=None, action='apply', directory=u'.'):
 
5698
    def run(self, shelf_id=None, action='apply'):
5935
5699
        from bzrlib.shelf_ui import Unshelver
5936
 
        unshelver = Unshelver.from_args(shelf_id, action, directory=directory)
 
5700
        unshelver = Unshelver.from_args(shelf_id, action)
5937
5701
        try:
5938
5702
            unshelver.run()
5939
5703
        finally:
5941
5705
 
5942
5706
 
5943
5707
class cmd_clean_tree(Command):
5944
 
    __doc__ = """Remove unwanted files from working tree.
 
5708
    """Remove unwanted files from working tree.
5945
5709
 
5946
5710
    By default, only unknown files, not ignored files, are deleted.  Versioned
5947
5711
    files are never deleted.
5955
5719
 
5956
5720
    To check what clean-tree will do, use --dry-run.
5957
5721
    """
5958
 
    takes_options = ['directory',
5959
 
                     Option('ignored', help='Delete all ignored files.'),
 
5722
    takes_options = [Option('ignored', help='Delete all ignored files.'),
5960
5723
                     Option('detritus', help='Delete conflict files, merge'
5961
5724
                            ' backups, and failed selftest dirs.'),
5962
5725
                     Option('unknown',
5965
5728
                            ' deleting them.'),
5966
5729
                     Option('force', help='Do not prompt before deleting.')]
5967
5730
    def run(self, unknown=False, ignored=False, detritus=False, dry_run=False,
5968
 
            force=False, directory=u'.'):
 
5731
            force=False):
5969
5732
        from bzrlib.clean_tree import clean_tree
5970
5733
        if not (unknown or ignored or detritus):
5971
5734
            unknown = True
5972
5735
        if dry_run:
5973
5736
            force = True
5974
 
        clean_tree(directory, unknown=unknown, ignored=ignored,
5975
 
                   detritus=detritus, dry_run=dry_run, no_prompt=force)
 
5737
        clean_tree('.', unknown=unknown, ignored=ignored, detritus=detritus,
 
5738
                   dry_run=dry_run, no_prompt=force)
5976
5739
 
5977
5740
 
5978
5741
class cmd_reference(Command):
5979
 
    __doc__ = """list, view and set branch locations for nested trees.
 
5742
    """list, view and set branch locations for nested trees.
5980
5743
 
5981
5744
    If no arguments are provided, lists the branch locations for nested trees.
5982
5745
    If one argument is provided, display the branch location for that tree.
6022
5785
            self.outf.write('%s %s\n' % (path, location))
6023
5786
 
6024
5787
 
6025
 
def _register_lazy_builtins():
6026
 
    # register lazy builtins from other modules; called at startup and should
6027
 
    # be only called once.
6028
 
    for (name, aliases, module_name) in [
6029
 
        ('cmd_bundle_info', [], 'bzrlib.bundle.commands'),
6030
 
        ('cmd_dpush', [], 'bzrlib.foreign'),
6031
 
        ('cmd_version_info', [], 'bzrlib.cmd_version_info'),
6032
 
        ('cmd_resolve', ['resolved'], 'bzrlib.conflicts'),
6033
 
        ('cmd_conflicts', [], 'bzrlib.conflicts'),
6034
 
        ('cmd_sign_my_commits', [], 'bzrlib.sign_my_commits'),
6035
 
        ]:
6036
 
        builtin_command_registry.register_lazy(name, aliases, module_name)
 
5788
# these get imported and then picked up by the scan for cmd_*
 
5789
# TODO: Some more consistent way to split command definitions across files;
 
5790
# we do need to load at least some information about them to know of
 
5791
# aliases.  ideally we would avoid loading the implementation until the
 
5792
# details were needed.
 
5793
from bzrlib.cmd_version_info import cmd_version_info
 
5794
from bzrlib.conflicts import cmd_resolve, cmd_conflicts, restore
 
5795
from bzrlib.bundle.commands import (
 
5796
    cmd_bundle_info,
 
5797
    )
 
5798
from bzrlib.foreign import cmd_dpush
 
5799
from bzrlib.sign_my_commits import cmd_sign_my_commits
 
5800
from bzrlib.weave_commands import cmd_versionedfile_list, \
 
5801
        cmd_weave_plan_merge, cmd_weave_merge_text