/brz/remove-bazaar

To get this branch, use:
bzr branch http://gegoxaren.bato24.eu/bzr/brz/remove-bazaar

« back to all changes in this revision

Viewing changes to bzrlib/builtins.py

  • Committer: Andrew Bennetts
  • Date: 2010-04-22 07:35:06 UTC
  • mto: This revision was merged to the branch mainline in revision 5193.
  • Revision ID: andrew.bennetts@canonical.com-20100422073506-7i5pqyhzdj5pcelx
Create a PerFileMerger helper class that is midway between AbstractPerFileMerger and ConfigurableFileMerger.  It allows the example merge plugin in the docs (the always conflict *.xml files) to be much, much simpler.

Show diffs side-by-side

added added

removed removed

Lines of Context:
bzrlib/builtins.py
232
232
    return view_info
233
233
 
234
234
 
235
 
def _open_directory_or_containing_tree_or_branch(filename, directory):
236
 
    """Open the tree or branch containing the specified file, unless
237
 
    the --directory option is used to specify a different branch."""
238
 
    if directory is not None:
239
 
        return (None, Branch.open(directory), filename)
240
 
    return bzrdir.BzrDir.open_containing_tree_or_branch(filename)
241
 
 
242
 
 
243
235
# TODO: Make sure no commands unconditionally use the working directory as a
244
236
# branch.  If a filename argument is used, the first of them should be used to
245
237
# specify the branch.  (Perhaps this can be factored out into some kind of
247
239
# opens the branch?)
248
240
 
249
241
class cmd_status(Command):
250
 
    __doc__ = """Display status summary.
 
242
    """Display status summary.
251
243
 
252
244
    This reports on versioned and unknown files, reporting them
253
245
    grouped by state.  Possible states are:
340
332
 
341
333
 
342
334
class cmd_cat_revision(Command):
343
 
    __doc__ = """Write out metadata for a revision.
 
335
    """Write out metadata for a revision.
344
336
 
345
337
    The revision to print can either be specified by a specific
346
338
    revision identifier, or you can use --revision.
348
340
 
349
341
    hidden = True
350
342
    takes_args = ['revision_id?']
351
 
    takes_options = ['directory', 'revision']
 
343
    takes_options = ['revision']
352
344
    # cat-revision is more for frontends so should be exact
353
345
    encoding = 'strict'
354
346
 
361
353
        self.outf.write(revtext.decode('utf-8'))
362
354
 
363
355
    @display_command
364
 
    def run(self, revision_id=None, revision=None, directory=u'.'):
 
356
    def run(self, revision_id=None, revision=None):
365
357
        if revision_id is not None and revision is not None:
366
358
            raise errors.BzrCommandError('You can only supply one of'
367
359
                                         ' revision_id or --revision')
368
360
        if revision_id is None and revision is None:
369
361
            raise errors.BzrCommandError('You must supply either'
370
362
                                         ' --revision or a revision_id')
371
 
        b = WorkingTree.open_containing(directory)[0].branch
 
363
        b = WorkingTree.open_containing(u'.')[0].branch
372
364
 
373
365
        revisions = b.repository.revisions
374
366
        if revisions is None:
398
390
        
399
391
 
400
392
class cmd_dump_btree(Command):
401
 
    __doc__ = """Dump the contents of a btree index file to stdout.
 
393
    """Dump the contents of a btree index file to stdout.
402
394
 
403
395
    PATH is a btree index file, it can be any URL. This includes things like
404
396
    .bzr/repository/pack-names, or .bzr/repository/indices/a34b3a...ca4a4.iix
479
471
 
480
472
 
481
473
class cmd_remove_tree(Command):
482
 
    __doc__ = """Remove the working tree from a given branch/checkout.
 
474
    """Remove the working tree from a given branch/checkout.
483
475
 
484
476
    Since a lightweight checkout is little more than a working tree
485
477
    this will refuse to run against one.
512
504
                if (working.has_changes()):
513
505
                    raise errors.UncommittedChanges(working)
514
506
 
515
 
            if working.user_url != working.branch.user_url:
 
507
            working_path = working.bzrdir.root_transport.base
 
508
            branch_path = working.branch.bzrdir.root_transport.base
 
509
            if working_path != branch_path:
516
510
                raise errors.BzrCommandError("You cannot remove the working tree"
517
511
                                             " from a lightweight checkout")
518
512
 
520
514
 
521
515
 
522
516
class cmd_revno(Command):
523
 
    __doc__ = """Show current revision number.
 
517
    """Show current revision number.
524
518
 
525
519
    This is equal to the number of revisions on this branch.
526
520
    """
536
530
        if tree:
537
531
            try:
538
532
                wt = WorkingTree.open_containing(location)[0]
539
 
                self.add_cleanup(wt.lock_read().unlock)
 
533
                wt.lock_read()
540
534
            except (errors.NoWorkingTree, errors.NotLocalUrl):
541
535
                raise errors.NoWorkingTree(location)
 
536
            self.add_cleanup(wt.unlock)
542
537
            revid = wt.last_revision()
543
538
            try:
544
539
                revno_t = wt.branch.revision_id_to_dotted_revno(revid)
547
542
            revno = ".".join(str(n) for n in revno_t)
548
543
        else:
549
544
            b = Branch.open_containing(location)[0]
550
 
            self.add_cleanup(b.lock_read().unlock)
 
545
            b.lock_read()
 
546
            self.add_cleanup(b.unlock)
551
547
            revno = b.revno()
552
548
        self.cleanup_now()
553
549
        self.outf.write(str(revno) + '\n')
554
550
 
555
551
 
556
552
class cmd_revision_info(Command):
557
 
    __doc__ = """Show revision number and revision id for a given revision identifier.
 
553
    """Show revision number and revision id for a given revision identifier.
558
554
    """
559
555
    hidden = True
560
556
    takes_args = ['revision_info*']
561
557
    takes_options = [
562
558
        'revision',
563
 
        custom_help('directory',
 
559
        Option('directory',
564
560
            help='Branch to examine, '
565
 
                 'rather than the one containing the working directory.'),
 
561
                 'rather than the one containing the working directory.',
 
562
            short_name='d',
 
563
            type=unicode,
 
564
            ),
566
565
        Option('tree', help='Show revno of working tree'),
567
566
        ]
568
567
 
573
572
        try:
574
573
            wt = WorkingTree.open_containing(directory)[0]
575
574
            b = wt.branch
576
 
            self.add_cleanup(wt.lock_read().unlock)
 
575
            wt.lock_read()
 
576
            self.add_cleanup(wt.unlock)
577
577
        except (errors.NoWorkingTree, errors.NotLocalUrl):
578
578
            wt = None
579
579
            b = Branch.open_containing(directory)[0]
580
 
            self.add_cleanup(b.lock_read().unlock)
 
580
            b.lock_read()
 
581
            self.add_cleanup(b.unlock)
581
582
        revision_ids = []
582
583
        if revision is not None:
583
584
            revision_ids.extend(rev.as_revision_id(b) for rev in revision)
611
612
 
612
613
 
613
614
class cmd_add(Command):
614
 
    __doc__ = """Add specified files or directories.
 
615
    """Add specified files or directories.
615
616
 
616
617
    In non-recursive mode, all the named items are added, regardless
617
618
    of whether they were previously ignored.  A warning is given if
682
683
                should_print=(not is_quiet()))
683
684
 
684
685
        if base_tree:
685
 
            self.add_cleanup(base_tree.lock_read().unlock)
 
686
            base_tree.lock_read()
 
687
            self.add_cleanup(base_tree.unlock)
686
688
        tree, file_list = tree_files_for_add(file_list)
687
689
        added, ignored = tree.smart_add(file_list, not
688
690
            no_recurse, action=action, save=not dry_run)
696
698
 
697
699
 
698
700
class cmd_mkdir(Command):
699
 
    __doc__ = """Create a new versioned directory.
 
701
    """Create a new versioned directory.
700
702
 
701
703
    This is equivalent to creating the directory and then adding it.
702
704
    """
718
720
 
719
721
 
720
722
class cmd_relpath(Command):
721
 
    __doc__ = """Show path of a file relative to root"""
 
723
    """Show path of a file relative to root"""
722
724
 
723
725
    takes_args = ['filename']
724
726
    hidden = True
733
735
 
734
736
 
735
737
class cmd_inventory(Command):
736
 
    __doc__ = """Show inventory of the current working copy or a revision.
 
738
    """Show inventory of the current working copy or a revision.
737
739
 
738
740
    It is possible to limit the output to a particular entry
739
741
    type using the --kind option.  For example: --kind file.
760
762
 
761
763
        revision = _get_one_revision('inventory', revision)
762
764
        work_tree, file_list = tree_files(file_list)
763
 
        self.add_cleanup(work_tree.lock_read().unlock)
 
765
        work_tree.lock_read()
 
766
        self.add_cleanup(work_tree.unlock)
764
767
        if revision is not None:
765
768
            tree = revision.as_tree(work_tree.branch)
766
769
 
767
770
            extra_trees = [work_tree]
768
 
            self.add_cleanup(tree.lock_read().unlock)
 
771
            tree.lock_read()
 
772
            self.add_cleanup(tree.unlock)
769
773
        else:
770
774
            tree = work_tree
771
775
            extra_trees = []
792
796
 
793
797
 
794
798
class cmd_mv(Command):
795
 
    __doc__ = """Move or rename a file.
 
799
    """Move or rename a file.
796
800
 
797
801
    :Usage:
798
802
        bzr mv OLDNAME NEWNAME
831
835
        if len(names_list) < 2:
832
836
            raise errors.BzrCommandError("missing file argument")
833
837
        tree, rel_names = tree_files(names_list, canonicalize=False)
834
 
        self.add_cleanup(tree.lock_tree_write().unlock)
 
838
        tree.lock_tree_write()
 
839
        self.add_cleanup(tree.unlock)
835
840
        self._run(tree, names_list, rel_names, after)
836
841
 
837
842
    def run_auto(self, names_list, after, dry_run):
842
847
            raise errors.BzrCommandError('--after cannot be specified with'
843
848
                                         ' --auto.')
844
849
        work_tree, file_list = tree_files(names_list, default_branch='.')
845
 
        self.add_cleanup(work_tree.lock_tree_write().unlock)
 
850
        work_tree.lock_tree_write()
 
851
        self.add_cleanup(work_tree.unlock)
846
852
        rename_map.RenameMap.guess_renames(work_tree, dry_run)
847
853
 
848
854
    def _run(self, tree, names_list, rel_names, after):
927
933
 
928
934
 
929
935
class cmd_pull(Command):
930
 
    __doc__ = """Turn this branch into a mirror of another branch.
 
936
    """Turn this branch into a mirror of another branch.
931
937
 
932
938
    By default, this command only works on branches that have not diverged.
933
939
    Branches are considered diverged if the destination branch's most recent 
956
962
    takes_options = ['remember', 'overwrite', 'revision',
957
963
        custom_help('verbose',
958
964
            help='Show logs of pulled revisions.'),
959
 
        custom_help('directory',
 
965
        Option('directory',
960
966
            help='Branch to pull into, '
961
 
                 'rather than the one containing the working directory.'),
 
967
                 'rather than the one containing the working directory.',
 
968
            short_name='d',
 
969
            type=unicode,
 
970
            ),
962
971
        Option('local',
963
972
            help="Perform a local pull in a bound "
964
973
                 "branch.  Local pulls are not applied to "
979
988
        try:
980
989
            tree_to = WorkingTree.open_containing(directory)[0]
981
990
            branch_to = tree_to.branch
982
 
            self.add_cleanup(tree_to.lock_write().unlock)
 
991
            tree_to.lock_write()
 
992
            self.add_cleanup(tree_to.unlock)
983
993
        except errors.NoWorkingTree:
984
994
            tree_to = None
985
995
            branch_to = Branch.open_containing(directory)[0]
986
 
            self.add_cleanup(branch_to.lock_write().unlock)
 
996
            branch_to.lock_write()
 
997
            self.add_cleanup(branch_to.unlock)
987
998
 
988
999
        if local and not branch_to.get_bound_location():
989
1000
            raise errors.LocalRequiresBoundBranch()
1020
1031
        else:
1021
1032
            branch_from = Branch.open(location,
1022
1033
                possible_transports=possible_transports)
1023
 
            self.add_cleanup(branch_from.lock_read().unlock)
 
1034
            branch_from.lock_read()
 
1035
            self.add_cleanup(branch_from.unlock)
1024
1036
 
1025
1037
            if branch_to.get_parent() is None or remember:
1026
1038
                branch_to.set_parent(branch_from.base)
1048
1060
 
1049
1061
 
1050
1062
class cmd_push(Command):
1051
 
    __doc__ = """Update a mirror of this branch.
 
1063
    """Update a mirror of this branch.
1052
1064
 
1053
1065
    The target branch will not have its working tree populated because this
1054
1066
    is both expensive, and is not supported on remote file systems.
1078
1090
        Option('create-prefix',
1079
1091
               help='Create the path leading up to the branch '
1080
1092
                    'if it does not already exist.'),
1081
 
        custom_help('directory',
 
1093
        Option('directory',
1082
1094
            help='Branch to push from, '
1083
 
                 'rather than the one containing the working directory.'),
 
1095
                 'rather than the one containing the working directory.',
 
1096
            short_name='d',
 
1097
            type=unicode,
 
1098
            ),
1084
1099
        Option('use-existing-dir',
1085
1100
               help='By default push will fail if the target'
1086
1101
                    ' directory exists, but does not already'
1119
1134
        else:
1120
1135
            revision_id = None
1121
1136
        if tree is not None and revision_id is None:
1122
 
            tree.check_changed_or_out_of_date(
1123
 
                strict, 'push_strict',
1124
 
                more_error='Use --no-strict to force the push.',
1125
 
                more_warning='Uncommitted changes will not be pushed.')
 
1137
            tree.warn_if_changed_or_out_of_date(
 
1138
                strict, 'push_strict', 'Use --no-strict to force the push.')
1126
1139
        # Get the stacked_on branch, if any
1127
1140
        if stacked_on is not None:
1128
1141
            stacked_on = urlutils.normalize_url(stacked_on)
1160
1173
 
1161
1174
 
1162
1175
class cmd_branch(Command):
1163
 
    __doc__ = """Create a new branch that is a copy of an existing branch.
 
1176
    """Create a new branch that is a copy of an existing branch.
1164
1177
 
1165
1178
    If the TO_LOCATION is omitted, the last component of the FROM_LOCATION will
1166
1179
    be used.  In other words, "branch ../foo/bar" will attempt to create ./bar.
1206
1219
        accelerator_tree, br_from = bzrdir.BzrDir.open_tree_or_branch(
1207
1220
            from_location)
1208
1221
        revision = _get_one_revision('branch', revision)
1209
 
        self.add_cleanup(br_from.lock_read().unlock)
 
1222
        br_from.lock_read()
 
1223
        self.add_cleanup(br_from.unlock)
1210
1224
        if revision is not None:
1211
1225
            revision_id = revision.as_revision_id(br_from)
1212
1226
        else:
1272
1286
 
1273
1287
 
1274
1288
class cmd_checkout(Command):
1275
 
    __doc__ = """Create a new checkout of an existing branch.
 
1289
    """Create a new checkout of an existing branch.
1276
1290
 
1277
1291
    If BRANCH_LOCATION is omitted, checkout will reconstitute a working tree for
1278
1292
    the branch found in '.'. This is useful if you have removed the working tree
1336
1350
            except errors.NoWorkingTree:
1337
1351
                source.bzrdir.create_workingtree(revision_id)
1338
1352
                return
1339
 
 
1340
 
        if not lightweight:
1341
 
            message = ('Copying history to "%s". '
1342
 
                'To checkout without local history use --lightweight.' % to_location)
1343
 
            ui.ui_factory.show_message(message)
1344
1353
        source.create_checkout(to_location, revision_id, lightweight,
1345
1354
                               accelerator_tree, hardlink)
1346
1355
 
1347
1356
 
1348
1357
class cmd_renames(Command):
1349
 
    __doc__ = """Show list of renamed files.
 
1358
    """Show list of renamed files.
1350
1359
    """
1351
1360
    # TODO: Option to show renames between two historical versions.
1352
1361
 
1357
1366
    @display_command
1358
1367
    def run(self, dir=u'.'):
1359
1368
        tree = WorkingTree.open_containing(dir)[0]
1360
 
        self.add_cleanup(tree.lock_read().unlock)
 
1369
        tree.lock_read()
 
1370
        self.add_cleanup(tree.unlock)
1361
1371
        new_inv = tree.inventory
1362
1372
        old_tree = tree.basis_tree()
1363
 
        self.add_cleanup(old_tree.lock_read().unlock)
 
1373
        old_tree.lock_read()
 
1374
        self.add_cleanup(old_tree.unlock)
1364
1375
        old_inv = old_tree.inventory
1365
1376
        renames = []
1366
1377
        iterator = tree.iter_changes(old_tree, include_unchanged=True)
1376
1387
 
1377
1388
 
1378
1389
class cmd_update(Command):
1379
 
    __doc__ = """Update a tree to have the latest code committed to its branch.
 
1390
    """Update a tree to have the latest code committed to its branch.
1380
1391
 
1381
1392
    This will perform a merge into the working tree, and may generate
1382
1393
    conflicts. If you have any local changes, you will still
1404
1415
        master = branch.get_master_branch(
1405
1416
            possible_transports=possible_transports)
1406
1417
        if master is not None:
 
1418
            tree.lock_write()
1407
1419
            branch_location = master.base
1408
 
            tree.lock_write()
1409
1420
        else:
 
1421
            tree.lock_tree_write()
1410
1422
            branch_location = tree.branch.base
1411
 
            tree.lock_tree_write()
1412
1423
        self.add_cleanup(tree.unlock)
1413
1424
        # get rid of the final '/' and be ready for display
1414
1425
        branch_location = urlutils.unescape_for_display(
1462
1473
 
1463
1474
 
1464
1475
class cmd_info(Command):
1465
 
    __doc__ = """Show information about a working tree, branch or repository.
 
1476
    """Show information about a working tree, branch or repository.
1466
1477
 
1467
1478
    This command will show all known locations and formats associated to the
1468
1479
    tree, branch or repository.
1506
1517
 
1507
1518
 
1508
1519
class cmd_remove(Command):
1509
 
    __doc__ = """Remove files or directories.
 
1520
    """Remove files or directories.
1510
1521
 
1511
1522
    This makes bzr stop tracking changes to the specified files. bzr will delete
1512
1523
    them if they can easily be recovered using revert. If no options or
1534
1545
        if file_list is not None:
1535
1546
            file_list = [f for f in file_list]
1536
1547
 
1537
 
        self.add_cleanup(tree.lock_write().unlock)
 
1548
        tree.lock_write()
 
1549
        self.add_cleanup(tree.unlock)
1538
1550
        # Heuristics should probably all move into tree.remove_smart or
1539
1551
        # some such?
1540
1552
        if new:
1559
1571
 
1560
1572
 
1561
1573
class cmd_file_id(Command):
1562
 
    __doc__ = """Print file_id of a particular file or directory.
 
1574
    """Print file_id of a particular file or directory.
1563
1575
 
1564
1576
    The file_id is assigned when the file is first added and remains the
1565
1577
    same through all revisions where the file exists, even when it is
1581
1593
 
1582
1594
 
1583
1595
class cmd_file_path(Command):
1584
 
    __doc__ = """Print path of file_ids to a file or directory.
 
1596
    """Print path of file_ids to a file or directory.
1585
1597
 
1586
1598
    This prints one line for each directory down to the target,
1587
1599
    starting at the branch root.
1603
1615
 
1604
1616
 
1605
1617
class cmd_reconcile(Command):
1606
 
    __doc__ = """Reconcile bzr metadata in a branch.
 
1618
    """Reconcile bzr metadata in a branch.
1607
1619
 
1608
1620
    This can correct data mismatches that may have been caused by
1609
1621
    previous ghost operations or bzr upgrades. You should only
1631
1643
 
1632
1644
 
1633
1645
class cmd_revision_history(Command):
1634
 
    __doc__ = """Display the list of revision ids on a branch."""
 
1646
    """Display the list of revision ids on a branch."""
1635
1647
 
1636
1648
    _see_also = ['log']
1637
1649
    takes_args = ['location?']
1647
1659
 
1648
1660
 
1649
1661
class cmd_ancestry(Command):
1650
 
    __doc__ = """List all revisions merged into this branch."""
 
1662
    """List all revisions merged into this branch."""
1651
1663
 
1652
1664
    _see_also = ['log', 'revision-history']
1653
1665
    takes_args = ['location?']
1672
1684
 
1673
1685
 
1674
1686
class cmd_init(Command):
1675
 
    __doc__ = """Make a directory into a versioned branch.
 
1687
    """Make a directory into a versioned branch.
1676
1688
 
1677
1689
    Use this to create an empty branch, or before importing an
1678
1690
    existing project.
1781
1793
 
1782
1794
 
1783
1795
class cmd_init_repository(Command):
1784
 
    __doc__ = """Create a shared repository for branches to share storage space.
 
1796
    """Create a shared repository for branches to share storage space.
1785
1797
 
1786
1798
    New branches created under the repository directory will store their
1787
1799
    revisions in the repository, not in the branch directory.  For branches
1841
1853
 
1842
1854
 
1843
1855
class cmd_diff(Command):
1844
 
    __doc__ = """Show differences in the working tree, between revisions or branches.
 
1856
    """Show differences in the working tree, between revisions or branches.
1845
1857
 
1846
1858
    If no arguments are given, all changes for the current tree are listed.
1847
1859
    If files are given, only the changes in those files are listed.
1982
1994
 
1983
1995
 
1984
1996
class cmd_deleted(Command):
1985
 
    __doc__ = """List files deleted in the working tree.
 
1997
    """List files deleted in the working tree.
1986
1998
    """
1987
1999
    # TODO: Show files deleted since a previous revision, or
1988
2000
    # between two revisions.
1991
2003
    # level of effort but possibly much less IO.  (Or possibly not,
1992
2004
    # if the directories are very large...)
1993
2005
    _see_also = ['status', 'ls']
1994
 
    takes_options = ['directory', 'show-ids']
 
2006
    takes_options = ['show-ids']
1995
2007
 
1996
2008
    @display_command
1997
 
    def run(self, show_ids=False, directory=u'.'):
1998
 
        tree = WorkingTree.open_containing(directory)[0]
1999
 
        self.add_cleanup(tree.lock_read().unlock)
 
2009
    def run(self, show_ids=False):
 
2010
        tree = WorkingTree.open_containing(u'.')[0]
 
2011
        tree.lock_read()
 
2012
        self.add_cleanup(tree.unlock)
2000
2013
        old = tree.basis_tree()
2001
 
        self.add_cleanup(old.lock_read().unlock)
 
2014
        old.lock_read()
 
2015
        self.add_cleanup(old.unlock)
2002
2016
        for path, ie in old.inventory.iter_entries():
2003
2017
            if not tree.has_id(ie.file_id):
2004
2018
                self.outf.write(path)
2009
2023
 
2010
2024
 
2011
2025
class cmd_modified(Command):
2012
 
    __doc__ = """List files modified in working tree.
 
2026
    """List files modified in working tree.
2013
2027
    """
2014
2028
 
2015
2029
    hidden = True
2016
2030
    _see_also = ['status', 'ls']
2017
 
    takes_options = ['directory', 'null']
 
2031
    takes_options = [
 
2032
            Option('null',
 
2033
                   help='Write an ascii NUL (\\0) separator '
 
2034
                   'between files rather than a newline.')
 
2035
            ]
2018
2036
 
2019
2037
    @display_command
2020
 
    def run(self, null=False, directory=u'.'):
2021
 
        tree = WorkingTree.open_containing(directory)[0]
 
2038
    def run(self, null=False):
 
2039
        tree = WorkingTree.open_containing(u'.')[0]
2022
2040
        td = tree.changes_from(tree.basis_tree())
2023
2041
        for path, id, kind, text_modified, meta_modified in td.modified:
2024
2042
            if null:
2028
2046
 
2029
2047
 
2030
2048
class cmd_added(Command):
2031
 
    __doc__ = """List files added in working tree.
 
2049
    """List files added in working tree.
2032
2050
    """
2033
2051
 
2034
2052
    hidden = True
2035
2053
    _see_also = ['status', 'ls']
2036
 
    takes_options = ['directory', 'null']
 
2054
    takes_options = [
 
2055
            Option('null',
 
2056
                   help='Write an ascii NUL (\\0) separator '
 
2057
                   'between files rather than a newline.')
 
2058
            ]
2037
2059
 
2038
2060
    @display_command
2039
 
    def run(self, null=False, directory=u'.'):
2040
 
        wt = WorkingTree.open_containing(directory)[0]
2041
 
        self.add_cleanup(wt.lock_read().unlock)
 
2061
    def run(self, null=False):
 
2062
        wt = WorkingTree.open_containing(u'.')[0]
 
2063
        wt.lock_read()
 
2064
        self.add_cleanup(wt.unlock)
2042
2065
        basis = wt.basis_tree()
2043
 
        self.add_cleanup(basis.lock_read().unlock)
 
2066
        basis.lock_read()
 
2067
        self.add_cleanup(basis.unlock)
2044
2068
        basis_inv = basis.inventory
2045
2069
        inv = wt.inventory
2046
2070
        for file_id in inv:
2049
2073
            if inv.is_root(file_id) and len(basis_inv) == 0:
2050
2074
                continue
2051
2075
            path = inv.id2path(file_id)
2052
 
            if not os.access(osutils.pathjoin(wt.basedir, path), os.F_OK):
 
2076
            if not os.access(osutils.abspath(path), os.F_OK):
2053
2077
                continue
2054
2078
            if null:
2055
2079
                self.outf.write(path + '\0')
2058
2082
 
2059
2083
 
2060
2084
class cmd_root(Command):
2061
 
    __doc__ = """Show the tree root directory.
 
2085
    """Show the tree root directory.
2062
2086
 
2063
2087
    The root is the nearest enclosing directory with a .bzr control
2064
2088
    directory."""
2088
2112
 
2089
2113
 
2090
2114
class cmd_log(Command):
2091
 
    __doc__ = """Show historical log for a branch or subset of a branch.
 
2115
    """Show historical log for a branch or subset of a branch.
2092
2116
 
2093
2117
    log is bzr's default tool for exploring the history of a branch.
2094
2118
    The branch to use is taken from the first parameter. If no parameters
2255
2279
                   help='Show just the specified revision.'
2256
2280
                   ' See also "help revisionspec".'),
2257
2281
            'log-format',
2258
 
            RegistryOption('authors',
2259
 
                'What names to list as authors - first, all or committer.',
2260
 
                title='Authors',
2261
 
                lazy_registry=('bzrlib.log', 'author_list_registry'),
2262
 
            ),
2263
2282
            Option('levels',
2264
2283
                   short_name='n',
2265
2284
                   help='Number of levels to display - 0 for all, 1 for flat.',
2280
2299
                   help='Show changes made in each revision as a patch.'),
2281
2300
            Option('include-merges',
2282
2301
                   help='Show merged revisions like --levels 0 does.'),
2283
 
            Option('exclude-common-ancestry',
2284
 
                   help='Display only the revisions that are not part'
2285
 
                   ' of both ancestries (require -rX..Y)'
2286
 
                   )
2287
2302
            ]
2288
2303
    encoding_type = 'replace'
2289
2304
 
2299
2314
            message=None,
2300
2315
            limit=None,
2301
2316
            show_diff=False,
2302
 
            include_merges=False,
2303
 
            authors=None,
2304
 
            exclude_common_ancestry=False,
2305
 
            ):
 
2317
            include_merges=False):
2306
2318
        from bzrlib.log import (
2307
2319
            Logger,
2308
2320
            make_log_request_dict,
2309
2321
            _get_info_for_log_files,
2310
2322
            )
2311
2323
        direction = (forward and 'forward') or 'reverse'
2312
 
        if (exclude_common_ancestry
2313
 
            and (revision is None or len(revision) != 2)):
2314
 
            raise errors.BzrCommandError(
2315
 
                '--exclude-common-ancestry requires -r with two revisions')
2316
2324
        if include_merges:
2317
2325
            if levels is None:
2318
2326
                levels = 0
2334
2342
        if file_list:
2335
2343
            # find the file ids to log and check for directory filtering
2336
2344
            b, file_info_list, rev1, rev2 = _get_info_for_log_files(
2337
 
                revision, file_list, self.add_cleanup)
 
2345
                revision, file_list)
 
2346
            self.add_cleanup(b.unlock)
2338
2347
            for relpath, file_id, kind in file_info_list:
2339
2348
                if file_id is None:
2340
2349
                    raise errors.BzrCommandError(
2358
2367
                location = '.'
2359
2368
            dir, relpath = bzrdir.BzrDir.open_containing(location)
2360
2369
            b = dir.open_branch()
2361
 
            self.add_cleanup(b.lock_read().unlock)
 
2370
            b.lock_read()
 
2371
            self.add_cleanup(b.unlock)
2362
2372
            rev1, rev2 = _get_revision_range(revision, b, self.name())
2363
2373
 
2364
2374
        # Decide on the type of delta & diff filtering to use
2384
2394
                        show_timezone=timezone,
2385
2395
                        delta_format=get_verbosity_level(),
2386
2396
                        levels=levels,
2387
 
                        show_advice=levels is None,
2388
 
                        author_list_handler=authors)
 
2397
                        show_advice=levels is None)
2389
2398
 
2390
2399
        # Choose the algorithm for doing the logging. It's annoying
2391
2400
        # having multiple code paths like this but necessary until
2410
2419
            direction=direction, specific_fileids=file_ids,
2411
2420
            start_revision=rev1, end_revision=rev2, limit=limit,
2412
2421
            message_search=message, delta_type=delta_type,
2413
 
            diff_type=diff_type, _match_using_deltas=match_using_deltas,
2414
 
            exclude_common_ancestry=exclude_common_ancestry,
2415
 
            )
 
2422
            diff_type=diff_type, _match_using_deltas=match_using_deltas)
2416
2423
        Logger(b, rqst).show(lf)
2417
2424
 
2418
2425
 
2476
2483
 
2477
2484
 
2478
2485
class cmd_touching_revisions(Command):
2479
 
    __doc__ = """Return revision-ids which affected a particular file.
 
2486
    """Return revision-ids which affected a particular file.
2480
2487
 
2481
2488
    A more user-friendly interface is "bzr log FILE".
2482
2489
    """
2489
2496
        tree, relpath = WorkingTree.open_containing(filename)
2490
2497
        file_id = tree.path2id(relpath)
2491
2498
        b = tree.branch
2492
 
        self.add_cleanup(b.lock_read().unlock)
 
2499
        b.lock_read()
 
2500
        self.add_cleanup(b.unlock)
2493
2501
        touching_revs = log.find_touching_revisions(b, file_id)
2494
2502
        for revno, revision_id, what in touching_revs:
2495
2503
            self.outf.write("%6d %s\n" % (revno, what))
2496
2504
 
2497
2505
 
2498
2506
class cmd_ls(Command):
2499
 
    __doc__ = """List files in a tree.
 
2507
    """List files in a tree.
2500
2508
    """
2501
2509
 
2502
2510
    _see_also = ['status', 'cat']
2508
2516
                   help='Recurse into subdirectories.'),
2509
2517
            Option('from-root',
2510
2518
                   help='Print paths relative to the root of the branch.'),
2511
 
            Option('unknown', short_name='u',
2512
 
                help='Print unknown files.'),
 
2519
            Option('unknown', help='Print unknown files.'),
2513
2520
            Option('versioned', help='Print versioned files.',
2514
2521
                   short_name='V'),
2515
 
            Option('ignored', short_name='i',
2516
 
                help='Print ignored files.'),
2517
 
            Option('kind', short_name='k',
 
2522
            Option('ignored', help='Print ignored files.'),
 
2523
            Option('null',
 
2524
                   help='Write an ascii NUL (\\0) separator '
 
2525
                   'between files rather than a newline.'),
 
2526
            Option('kind',
2518
2527
                   help='List entries of a particular kind: file, directory, symlink.',
2519
2528
                   type=unicode),
2520
 
            'null',
2521
2529
            'show-ids',
2522
 
            'directory',
2523
2530
            ]
2524
2531
    @display_command
2525
2532
    def run(self, revision=None, verbose=False,
2526
2533
            recursive=False, from_root=False,
2527
2534
            unknown=False, versioned=False, ignored=False,
2528
 
            null=False, kind=None, show_ids=False, path=None, directory=None):
 
2535
            null=False, kind=None, show_ids=False, path=None):
2529
2536
 
2530
2537
        if kind and kind not in ('file', 'directory', 'symlink'):
2531
2538
            raise errors.BzrCommandError('invalid kind specified')
2543
2550
                raise errors.BzrCommandError('cannot specify both --from-root'
2544
2551
                                             ' and PATH')
2545
2552
            fs_path = path
2546
 
        tree, branch, relpath = \
2547
 
            _open_directory_or_containing_tree_or_branch(fs_path, directory)
 
2553
        tree, branch, relpath = bzrdir.BzrDir.open_containing_tree_or_branch(
 
2554
            fs_path)
2548
2555
 
2549
2556
        # Calculate the prefix to use
2550
2557
        prefix = None
2565
2572
                view_str = views.view_display_str(view_files)
2566
2573
                note("Ignoring files outside view. View is %s" % view_str)
2567
2574
 
2568
 
        self.add_cleanup(tree.lock_read().unlock)
 
2575
        tree.lock_read()
 
2576
        self.add_cleanup(tree.unlock)
2569
2577
        for fp, fc, fkind, fid, entry in tree.list_files(include_root=False,
2570
2578
            from_dir=relpath, recursive=recursive):
2571
2579
            # Apply additional masking
2613
2621
 
2614
2622
 
2615
2623
class cmd_unknowns(Command):
2616
 
    __doc__ = """List unknown files.
 
2624
    """List unknown files.
2617
2625
    """
2618
2626
 
2619
2627
    hidden = True
2620
2628
    _see_also = ['ls']
2621
 
    takes_options = ['directory']
2622
2629
 
2623
2630
    @display_command
2624
 
    def run(self, directory=u'.'):
2625
 
        for f in WorkingTree.open_containing(directory)[0].unknowns():
 
2631
    def run(self):
 
2632
        for f in WorkingTree.open_containing(u'.')[0].unknowns():
2626
2633
            self.outf.write(osutils.quotefn(f) + '\n')
2627
2634
 
2628
2635
 
2629
2636
class cmd_ignore(Command):
2630
 
    __doc__ = """Ignore specified files or patterns.
 
2637
    """Ignore specified files or patterns.
2631
2638
 
2632
2639
    See ``bzr help patterns`` for details on the syntax of patterns.
2633
2640
 
2642
2649
    using this command or directly by using an editor, be sure to commit
2643
2650
    it.
2644
2651
    
2645
 
    Bazaar also supports a global ignore file ~/.bazaar/ignore. On Windows
2646
 
    the global ignore file can be found in the application data directory as
2647
 
    C:\\Documents and Settings\\<user>\\Application Data\\Bazaar\\2.0\\ignore.
2648
 
    Global ignores are not touched by this command. The global ignore file
2649
 
    can be edited directly using an editor.
2650
 
 
2651
2652
    Patterns prefixed with '!' are exceptions to ignore patterns and take
2652
2653
    precedence over regular ignores.  Such exceptions are used to specify
2653
2654
    files that should be versioned which would otherwise be ignored.
2693
2694
 
2694
2695
    _see_also = ['status', 'ignored', 'patterns']
2695
2696
    takes_args = ['name_pattern*']
2696
 
    takes_options = ['directory',
2697
 
        Option('default-rules',
2698
 
               help='Display the default ignore rules that bzr uses.')
 
2697
    takes_options = [
 
2698
        Option('old-default-rules',
 
2699
               help='Write out the ignore rules bzr < 0.9 always used.')
2699
2700
        ]
2700
2701
 
2701
 
    def run(self, name_pattern_list=None, default_rules=None,
2702
 
            directory=u'.'):
 
2702
    def run(self, name_pattern_list=None, old_default_rules=None):
2703
2703
        from bzrlib import ignores
2704
 
        if default_rules is not None:
2705
 
            # dump the default rules and exit
2706
 
            for pattern in ignores.USER_DEFAULTS:
 
2704
        if old_default_rules is not None:
 
2705
            # dump the rules and exit
 
2706
            for pattern in ignores.OLD_DEFAULTS:
2707
2707
                self.outf.write("%s\n" % pattern)
2708
2708
            return
2709
2709
        if not name_pattern_list:
2710
2710
            raise errors.BzrCommandError("ignore requires at least one "
2711
 
                "NAME_PATTERN or --default-rules.")
 
2711
                                  "NAME_PATTERN or --old-default-rules")
2712
2712
        name_pattern_list = [globbing.normalize_pattern(p)
2713
2713
                             for p in name_pattern_list]
2714
2714
        for name_pattern in name_pattern_list:
2716
2716
                (len(name_pattern) > 1 and name_pattern[1] == ':')):
2717
2717
                raise errors.BzrCommandError(
2718
2718
                    "NAME_PATTERN should not be an absolute path")
2719
 
        tree, relpath = WorkingTree.open_containing(directory)
 
2719
        tree, relpath = WorkingTree.open_containing(u'.')
2720
2720
        ignores.tree_ignores_add_patterns(tree, name_pattern_list)
2721
2721
        ignored = globbing.Globster(name_pattern_list)
2722
2722
        matches = []
2736
2736
 
2737
2737
 
2738
2738
class cmd_ignored(Command):
2739
 
    __doc__ = """List ignored files and the patterns that matched them.
 
2739
    """List ignored files and the patterns that matched them.
2740
2740
 
2741
2741
    List all the ignored files and the ignore pattern that caused the file to
2742
2742
    be ignored.
2748
2748
 
2749
2749
    encoding_type = 'replace'
2750
2750
    _see_also = ['ignore', 'ls']
2751
 
    takes_options = ['directory']
2752
2751
 
2753
2752
    @display_command
2754
 
    def run(self, directory=u'.'):
2755
 
        tree = WorkingTree.open_containing(directory)[0]
2756
 
        self.add_cleanup(tree.lock_read().unlock)
 
2753
    def run(self):
 
2754
        tree = WorkingTree.open_containing(u'.')[0]
 
2755
        tree.lock_read()
 
2756
        self.add_cleanup(tree.unlock)
2757
2757
        for path, file_class, kind, file_id, entry in tree.list_files():
2758
2758
            if file_class != 'I':
2759
2759
                continue
2763
2763
 
2764
2764
 
2765
2765
class cmd_lookup_revision(Command):
2766
 
    __doc__ = """Lookup the revision-id from a revision-number
 
2766
    """Lookup the revision-id from a revision-number
2767
2767
 
2768
2768
    :Examples:
2769
2769
        bzr lookup-revision 33
2770
2770
    """
2771
2771
    hidden = True
2772
2772
    takes_args = ['revno']
2773
 
    takes_options = ['directory']
2774
2773
 
2775
2774
    @display_command
2776
 
    def run(self, revno, directory=u'.'):
 
2775
    def run(self, revno):
2777
2776
        try:
2778
2777
            revno = int(revno)
2779
2778
        except ValueError:
2780
2779
            raise errors.BzrCommandError("not a valid revision-number: %r"
2781
2780
                                         % revno)
2782
 
        revid = WorkingTree.open_containing(directory)[0].branch.get_rev_id(revno)
 
2781
        revid = WorkingTree.open_containing(u'.')[0].branch.get_rev_id(revno)
2783
2782
        self.outf.write("%s\n" % revid)
2784
2783
 
2785
2784
 
2786
2785
class cmd_export(Command):
2787
 
    __doc__ = """Export current or past revision to a destination directory or archive.
 
2786
    """Export current or past revision to a destination directory or archive.
2788
2787
 
2789
2788
    If no revision is specified this exports the last committed revision.
2790
2789
 
2812
2811
      =================       =========================
2813
2812
    """
2814
2813
    takes_args = ['dest', 'branch_or_subdir?']
2815
 
    takes_options = ['directory',
 
2814
    takes_options = [
2816
2815
        Option('format',
2817
2816
               help="Type of file to export to.",
2818
2817
               type=unicode),
2827
2826
                    'revision in which it was changed.'),
2828
2827
        ]
2829
2828
    def run(self, dest, branch_or_subdir=None, revision=None, format=None,
2830
 
        root=None, filters=False, per_file_timestamps=False, directory=u'.'):
 
2829
        root=None, filters=False, per_file_timestamps=False):
2831
2830
        from bzrlib.export import export
2832
2831
 
2833
2832
        if branch_or_subdir is None:
2834
 
            tree = WorkingTree.open_containing(directory)[0]
 
2833
            tree = WorkingTree.open_containing(u'.')[0]
2835
2834
            b = tree.branch
2836
2835
            subdir = None
2837
2836
        else:
2847
2846
 
2848
2847
 
2849
2848
class cmd_cat(Command):
2850
 
    __doc__ = """Write the contents of a file as of a given revision to standard output.
 
2849
    """Write the contents of a file as of a given revision to standard output.
2851
2850
 
2852
2851
    If no revision is nominated, the last revision is used.
2853
2852
 
2856
2855
    """
2857
2856
 
2858
2857
    _see_also = ['ls']
2859
 
    takes_options = ['directory',
 
2858
    takes_options = [
2860
2859
        Option('name-from-revision', help='The path name in the old tree.'),
2861
2860
        Option('filters', help='Apply content filters to display the '
2862
2861
                'convenience form.'),
2867
2866
 
2868
2867
    @display_command
2869
2868
    def run(self, filename, revision=None, name_from_revision=False,
2870
 
            filters=False, directory=None):
 
2869
            filters=False):
2871
2870
        if revision is not None and len(revision) != 1:
2872
2871
            raise errors.BzrCommandError("bzr cat --revision takes exactly"
2873
2872
                                         " one revision specifier")
2874
2873
        tree, branch, relpath = \
2875
 
            _open_directory_or_containing_tree_or_branch(filename, directory)
2876
 
        self.add_cleanup(branch.lock_read().unlock)
 
2874
            bzrdir.BzrDir.open_containing_tree_or_branch(filename)
 
2875
        branch.lock_read()
 
2876
        self.add_cleanup(branch.unlock)
2877
2877
        return self._run(tree, branch, relpath, filename, revision,
2878
2878
                         name_from_revision, filters)
2879
2879
 
2882
2882
        if tree is None:
2883
2883
            tree = b.basis_tree()
2884
2884
        rev_tree = _get_one_revision_tree('cat', revision, branch=b)
2885
 
        self.add_cleanup(rev_tree.lock_read().unlock)
 
2885
        rev_tree.lock_read()
 
2886
        self.add_cleanup(rev_tree.unlock)
2886
2887
 
2887
2888
        old_file_id = rev_tree.path2id(relpath)
2888
2889
 
2931
2932
 
2932
2933
 
2933
2934
class cmd_local_time_offset(Command):
2934
 
    __doc__ = """Show the offset in seconds from GMT to local time."""
 
2935
    """Show the offset in seconds from GMT to local time."""
2935
2936
    hidden = True
2936
2937
    @display_command
2937
2938
    def run(self):
2940
2941
 
2941
2942
 
2942
2943
class cmd_commit(Command):
2943
 
    __doc__ = """Commit changes into a new revision.
 
2944
    """Commit changes into a new revision.
2944
2945
 
2945
2946
    An explanatory message needs to be given for each commit. This is
2946
2947
    often done by using the --message option (getting the message from the
3054
3055
                         "the master branch until a normal commit "
3055
3056
                         "is performed."
3056
3057
                    ),
3057
 
             Option('show-diff', short_name='p',
 
3058
             Option('show-diff',
3058
3059
                    help='When no message is supplied, show the diff along'
3059
3060
                    ' with the status summary in the message editor.'),
3060
3061
             ]
3206
3207
 
3207
3208
 
3208
3209
class cmd_check(Command):
3209
 
    __doc__ = """Validate working tree structure, branch consistency and repository history.
 
3210
    """Validate working tree structure, branch consistency and repository history.
3210
3211
 
3211
3212
    This command checks various invariants about branch and repository storage
3212
3213
    to detect data corruption or bzr bugs.
3276
3277
 
3277
3278
 
3278
3279
class cmd_upgrade(Command):
3279
 
    __doc__ = """Upgrade branch storage to current format.
 
3280
    """Upgrade branch storage to current format.
3280
3281
 
3281
3282
    The check command or bzr developers may sometimes advise you to run
3282
3283
    this command. When the default format has changed you may also be warned
3300
3301
 
3301
3302
 
3302
3303
class cmd_whoami(Command):
3303
 
    __doc__ = """Show or set bzr user id.
 
3304
    """Show or set bzr user id.
3304
3305
 
3305
3306
    :Examples:
3306
3307
        Show the email of the current user::
3350
3351
 
3351
3352
 
3352
3353
class cmd_nick(Command):
3353
 
    __doc__ = """Print or set the branch nickname.
 
3354
    """Print or set the branch nickname.
3354
3355
 
3355
3356
    If unset, the tree root directory name is used as the nickname.
3356
3357
    To print the current nickname, execute with no argument.
3361
3362
 
3362
3363
    _see_also = ['info']
3363
3364
    takes_args = ['nickname?']
3364
 
    takes_options = ['directory']
3365
 
    def run(self, nickname=None, directory=u'.'):
3366
 
        branch = Branch.open_containing(directory)[0]
 
3365
    def run(self, nickname=None):
 
3366
        branch = Branch.open_containing(u'.')[0]
3367
3367
        if nickname is None:
3368
3368
            self.printme(branch)
3369
3369
        else:
3375
3375
 
3376
3376
 
3377
3377
class cmd_alias(Command):
3378
 
    __doc__ = """Set/unset and display aliases.
 
3378
    """Set/unset and display aliases.
3379
3379
 
3380
3380
    :Examples:
3381
3381
        Show the current aliases::
3445
3445
 
3446
3446
 
3447
3447
class cmd_selftest(Command):
3448
 
    __doc__ = """Run internal test suite.
 
3448
    """Run internal test suite.
3449
3449
 
3450
3450
    If arguments are given, they are regular expressions that say which tests
3451
3451
    should run.  Tests matching any expression are run, and other tests are
3592
3592
                raise errors.BzrCommandError("subunit not available. subunit "
3593
3593
                    "needs to be installed to use --subunit.")
3594
3594
            self.additional_selftest_args['runner_class'] = SubUnitBzrRunner
3595
 
            # On Windows, disable automatic conversion of '\n' to '\r\n' in
3596
 
            # stdout, which would corrupt the subunit stream. 
3597
 
            if sys.platform == "win32" and sys.stdout.fileno() >= 0:
3598
 
                import msvcrt
3599
 
                msvcrt.setmode(sys.stdout.fileno(), os.O_BINARY)
3600
3595
        if parallel:
3601
3596
            self.additional_selftest_args.setdefault(
3602
3597
                'suite_decorators', []).append(parallel)
3633
3628
 
3634
3629
 
3635
3630
class cmd_version(Command):
3636
 
    __doc__ = """Show version of bzr."""
 
3631
    """Show version of bzr."""
3637
3632
 
3638
3633
    encoding_type = 'replace'
3639
3634
    takes_options = [
3650
3645
 
3651
3646
 
3652
3647
class cmd_rocks(Command):
3653
 
    __doc__ = """Statement of optimism."""
 
3648
    """Statement of optimism."""
3654
3649
 
3655
3650
    hidden = True
3656
3651
 
3660
3655
 
3661
3656
 
3662
3657
class cmd_find_merge_base(Command):
3663
 
    __doc__ = """Find and print a base revision for merging two branches."""
 
3658
    """Find and print a base revision for merging two branches."""
3664
3659
    # TODO: Options to specify revisions on either side, as if
3665
3660
    #       merging only part of the history.
3666
3661
    takes_args = ['branch', 'other']
3672
3667
 
3673
3668
        branch1 = Branch.open_containing(branch)[0]
3674
3669
        branch2 = Branch.open_containing(other)[0]
3675
 
        self.add_cleanup(branch1.lock_read().unlock)
3676
 
        self.add_cleanup(branch2.lock_read().unlock)
 
3670
        branch1.lock_read()
 
3671
        self.add_cleanup(branch1.unlock)
 
3672
        branch2.lock_read()
 
3673
        self.add_cleanup(branch2.unlock)
3677
3674
        last1 = ensure_null(branch1.last_revision())
3678
3675
        last2 = ensure_null(branch2.last_revision())
3679
3676
 
3684
3681
 
3685
3682
 
3686
3683
class cmd_merge(Command):
3687
 
    __doc__ = """Perform a three-way merge.
 
3684
    """Perform a three-way merge.
3688
3685
 
3689
3686
    The source of the merge can be specified either in the form of a branch,
3690
3687
    or in the form of a path to a file containing a merge directive generated
3773
3770
                ' completely merged into the source, pull from the'
3774
3771
                ' source rather than merging.  When this happens,'
3775
3772
                ' you do not need to commit the result.'),
3776
 
        custom_help('directory',
 
3773
        Option('directory',
3777
3774
               help='Branch to merge into, '
3778
 
                    'rather than the one containing the working directory.'),
 
3775
                    'rather than the one containing the working directory.',
 
3776
               short_name='d',
 
3777
               type=unicode,
 
3778
               ),
3779
3779
        Option('preview', help='Instead of merging, show a diff of the'
3780
3780
               ' merge.'),
3781
3781
        Option('interactive', help='Select changes interactively.',
3814
3814
            unversioned_filter=tree.is_ignored, view_info=view_info)
3815
3815
        pb = ui.ui_factory.nested_progress_bar()
3816
3816
        self.add_cleanup(pb.finished)
3817
 
        self.add_cleanup(tree.lock_write().unlock)
 
3817
        tree.lock_write()
 
3818
        self.add_cleanup(tree.unlock)
3818
3819
        if location is not None:
3819
3820
            try:
3820
3821
                mergeable = bundle.read_mergeable_from_url(location,
4041
4042
 
4042
4043
 
4043
4044
class cmd_remerge(Command):
4044
 
    __doc__ = """Redo a merge.
 
4045
    """Redo a merge.
4045
4046
 
4046
4047
    Use this if you want to try a different merge technique while resolving
4047
4048
    conflicts.  Some merge techniques are better than others, and remerge
4076
4077
        if merge_type is None:
4077
4078
            merge_type = _mod_merge.Merge3Merger
4078
4079
        tree, file_list = tree_files(file_list)
4079
 
        self.add_cleanup(tree.lock_write().unlock)
 
4080
        tree.lock_write()
 
4081
        self.add_cleanup(tree.unlock)
4080
4082
        parents = tree.get_parent_ids()
4081
4083
        if len(parents) != 2:
4082
4084
            raise errors.BzrCommandError("Sorry, remerge only works after normal"
4135
4137
 
4136
4138
 
4137
4139
class cmd_revert(Command):
4138
 
    __doc__ = """Revert files to a previous revision.
 
4140
    """Revert files to a previous revision.
4139
4141
 
4140
4142
    Giving a list of files will revert only those files.  Otherwise, all files
4141
4143
    will be reverted.  If the revision is not specified with '--revision', the
4192
4194
    def run(self, revision=None, no_backup=False, file_list=None,
4193
4195
            forget_merges=None):
4194
4196
        tree, file_list = tree_files(file_list)
4195
 
        self.add_cleanup(tree.lock_tree_write().unlock)
 
4197
        tree.lock_tree_write()
 
4198
        self.add_cleanup(tree.unlock)
4196
4199
        if forget_merges:
4197
4200
            tree.set_parent_ids(tree.get_parent_ids()[:1])
4198
4201
        else:
4206
4209
 
4207
4210
 
4208
4211
class cmd_assert_fail(Command):
4209
 
    __doc__ = """Test reporting of assertion failures"""
 
4212
    """Test reporting of assertion failures"""
4210
4213
    # intended just for use in testing
4211
4214
 
4212
4215
    hidden = True
4216
4219
 
4217
4220
 
4218
4221
class cmd_help(Command):
4219
 
    __doc__ = """Show help on a command or other topic.
 
4222
    """Show help on a command or other topic.
4220
4223
    """
4221
4224
 
4222
4225
    _see_also = ['topics']
4235
4238
 
4236
4239
 
4237
4240
class cmd_shell_complete(Command):
4238
 
    __doc__ = """Show appropriate completions for context.
 
4241
    """Show appropriate completions for context.
4239
4242
 
4240
4243
    For a list of all available commands, say 'bzr shell-complete'.
4241
4244
    """
4250
4253
 
4251
4254
 
4252
4255
class cmd_missing(Command):
4253
 
    __doc__ = """Show unmerged/unpulled revisions between two branches.
 
4256
    """Show unmerged/unpulled revisions between two branches.
4254
4257
 
4255
4258
    OTHER_BRANCH may be local or remote.
4256
4259
 
4334
4337
            restrict = 'remote'
4335
4338
 
4336
4339
        local_branch = Branch.open_containing(u".")[0]
4337
 
        self.add_cleanup(local_branch.lock_read().unlock)
 
4340
        local_branch.lock_read()
 
4341
        self.add_cleanup(local_branch.unlock)
4338
4342
 
4339
4343
        parent = local_branch.get_parent()
4340
4344
        if other_branch is None:
4351
4355
        if remote_branch.base == local_branch.base:
4352
4356
            remote_branch = local_branch
4353
4357
        else:
4354
 
            self.add_cleanup(remote_branch.lock_read().unlock)
 
4358
            remote_branch.lock_read()
 
4359
            self.add_cleanup(remote_branch.unlock)
4355
4360
 
4356
4361
        local_revid_range = _revision_range_to_revid_range(
4357
4362
            _get_revision_range(my_revision, local_branch,
4412
4417
            message("Branches are up to date.\n")
4413
4418
        self.cleanup_now()
4414
4419
        if not status_code and parent is None and other_branch is not None:
4415
 
            self.add_cleanup(local_branch.lock_write().unlock)
 
4420
            local_branch.lock_write()
 
4421
            self.add_cleanup(local_branch.unlock)
4416
4422
            # handle race conditions - a parent might be set while we run.
4417
4423
            if local_branch.get_parent() is None:
4418
4424
                local_branch.set_parent(remote_branch.base)
4420
4426
 
4421
4427
 
4422
4428
class cmd_pack(Command):
4423
 
    __doc__ = """Compress the data within a repository.
 
4429
    """Compress the data within a repository.
4424
4430
 
4425
4431
    This operation compresses the data within a bazaar repository. As
4426
4432
    bazaar supports automatic packing of repository, this operation is
4455
4461
 
4456
4462
 
4457
4463
class cmd_plugins(Command):
4458
 
    __doc__ = """List the installed plugins.
 
4464
    """List the installed plugins.
4459
4465
 
4460
4466
    This command displays the list of installed plugins including
4461
4467
    version of plugin and a short description of each.
4500
4506
 
4501
4507
 
4502
4508
class cmd_testament(Command):
4503
 
    __doc__ = """Show testament (signing-form) of a revision."""
 
4509
    """Show testament (signing-form) of a revision."""
4504
4510
    takes_options = [
4505
4511
            'revision',
4506
4512
            Option('long', help='Produce long-format testament.'),
4518
4524
            b = Branch.open_containing(branch)[0]
4519
4525
        else:
4520
4526
            b = Branch.open(branch)
4521
 
        self.add_cleanup(b.lock_read().unlock)
 
4527
        b.lock_read()
 
4528
        self.add_cleanup(b.unlock)
4522
4529
        if revision is None:
4523
4530
            rev_id = b.last_revision()
4524
4531
        else:
4531
4538
 
4532
4539
 
4533
4540
class cmd_annotate(Command):
4534
 
    __doc__ = """Show the origin of each line in a file.
 
4541
    """Show the origin of each line in a file.
4535
4542
 
4536
4543
    This prints out the given file with an annotation on the left side
4537
4544
    indicating which revision, author and date introduced the change.
4548
4555
                     Option('long', help='Show commit date in annotations.'),
4549
4556
                     'revision',
4550
4557
                     'show-ids',
4551
 
                     'directory',
4552
4558
                     ]
4553
4559
    encoding_type = 'exact'
4554
4560
 
4555
4561
    @display_command
4556
4562
    def run(self, filename, all=False, long=False, revision=None,
4557
 
            show_ids=False, directory=None):
 
4563
            show_ids=False):
4558
4564
        from bzrlib.annotate import annotate_file, annotate_file_tree
4559
4565
        wt, branch, relpath = \
4560
 
            _open_directory_or_containing_tree_or_branch(filename, directory)
 
4566
            bzrdir.BzrDir.open_containing_tree_or_branch(filename)
4561
4567
        if wt is not None:
4562
 
            self.add_cleanup(wt.lock_read().unlock)
 
4568
            wt.lock_read()
 
4569
            self.add_cleanup(wt.unlock)
4563
4570
        else:
4564
 
            self.add_cleanup(branch.lock_read().unlock)
 
4571
            branch.lock_read()
 
4572
            self.add_cleanup(branch.unlock)
4565
4573
        tree = _get_one_revision_tree('annotate', revision, branch=branch)
4566
 
        self.add_cleanup(tree.lock_read().unlock)
 
4574
        tree.lock_read()
 
4575
        self.add_cleanup(tree.unlock)
4567
4576
        if wt is not None:
4568
4577
            file_id = wt.path2id(relpath)
4569
4578
        else:
4582
4591
 
4583
4592
 
4584
4593
class cmd_re_sign(Command):
4585
 
    __doc__ = """Create a digital signature for an existing revision."""
 
4594
    """Create a digital signature for an existing revision."""
4586
4595
    # TODO be able to replace existing ones.
4587
4596
 
4588
4597
    hidden = True # is this right ?
4589
4598
    takes_args = ['revision_id*']
4590
 
    takes_options = ['directory', 'revision']
 
4599
    takes_options = ['revision']
4591
4600
 
4592
 
    def run(self, revision_id_list=None, revision=None, directory=u'.'):
 
4601
    def run(self, revision_id_list=None, revision=None):
4593
4602
        if revision_id_list is not None and revision is not None:
4594
4603
            raise errors.BzrCommandError('You can only supply one of revision_id or --revision')
4595
4604
        if revision_id_list is None and revision is None:
4596
4605
            raise errors.BzrCommandError('You must supply either --revision or a revision_id')
4597
 
        b = WorkingTree.open_containing(directory)[0].branch
4598
 
        self.add_cleanup(b.lock_write().unlock)
 
4606
        b = WorkingTree.open_containing(u'.')[0].branch
 
4607
        b.lock_write()
 
4608
        self.add_cleanup(b.unlock)
4599
4609
        return self._run(b, revision_id_list, revision)
4600
4610
 
4601
4611
    def _run(self, b, revision_id_list, revision):
4647
4657
 
4648
4658
 
4649
4659
class cmd_bind(Command):
4650
 
    __doc__ = """Convert the current branch into a checkout of the supplied branch.
4651
 
    If no branch is supplied, rebind to the last bound location.
 
4660
    """Convert the current branch into a checkout of the supplied branch.
4652
4661
 
4653
4662
    Once converted into a checkout, commits must succeed on the master branch
4654
4663
    before they will be applied to the local branch.
4660
4669
 
4661
4670
    _see_also = ['checkouts', 'unbind']
4662
4671
    takes_args = ['location?']
4663
 
    takes_options = ['directory']
 
4672
    takes_options = []
4664
4673
 
4665
 
    def run(self, location=None, directory=u'.'):
4666
 
        b, relpath = Branch.open_containing(directory)
 
4674
    def run(self, location=None):
 
4675
        b, relpath = Branch.open_containing(u'.')
4667
4676
        if location is None:
4668
4677
            try:
4669
4678
                location = b.get_old_bound_location()
4688
4697
 
4689
4698
 
4690
4699
class cmd_unbind(Command):
4691
 
    __doc__ = """Convert the current checkout into a regular branch.
 
4700
    """Convert the current checkout into a regular branch.
4692
4701
 
4693
4702
    After unbinding, the local branch is considered independent and subsequent
4694
4703
    commits will be local only.
4696
4705
 
4697
4706
    _see_also = ['checkouts', 'bind']
4698
4707
    takes_args = []
4699
 
    takes_options = ['directory']
 
4708
    takes_options = []
4700
4709
 
4701
 
    def run(self, directory=u'.'):
4702
 
        b, relpath = Branch.open_containing(directory)
 
4710
    def run(self):
 
4711
        b, relpath = Branch.open_containing(u'.')
4703
4712
        if not b.unbind():
4704
4713
            raise errors.BzrCommandError('Local branch is not bound')
4705
4714
 
4706
4715
 
4707
4716
class cmd_uncommit(Command):
4708
 
    __doc__ = """Remove the last committed revision.
 
4717
    """Remove the last committed revision.
4709
4718
 
4710
4719
    --verbose will print out what is being removed.
4711
4720
    --dry-run will go through all the motions, but not actually
4751
4760
            b = control.open_branch()
4752
4761
 
4753
4762
        if tree is not None:
4754
 
            self.add_cleanup(tree.lock_write().unlock)
 
4763
            tree.lock_write()
 
4764
            self.add_cleanup(tree.unlock)
4755
4765
        else:
4756
 
            self.add_cleanup(b.lock_write().unlock)
 
4766
            b.lock_write()
 
4767
            self.add_cleanup(b.unlock)
4757
4768
        return self._run(b, tree, dry_run, verbose, revision, force, local=local)
4758
4769
 
4759
4770
    def _run(self, b, tree, dry_run, verbose, revision, force, local=False):
4811
4822
 
4812
4823
 
4813
4824
class cmd_break_lock(Command):
4814
 
    __doc__ = """Break a dead lock on a repository, branch or working directory.
 
4825
    """Break a dead lock on a repository, branch or working directory.
4815
4826
 
4816
4827
    CAUTION: Locks should only be broken when you are sure that the process
4817
4828
    holding the lock has been stopped.
4836
4847
 
4837
4848
 
4838
4849
class cmd_wait_until_signalled(Command):
4839
 
    __doc__ = """Test helper for test_start_and_stop_bzr_subprocess_send_signal.
 
4850
    """Test helper for test_start_and_stop_bzr_subprocess_send_signal.
4840
4851
 
4841
4852
    This just prints a line to signal when it is ready, then blocks on stdin.
4842
4853
    """
4850
4861
 
4851
4862
 
4852
4863
class cmd_serve(Command):
4853
 
    __doc__ = """Run the bzr server."""
 
4864
    """Run the bzr server."""
4854
4865
 
4855
4866
    aliases = ['server']
4856
4867
 
4867
4878
                    'result in a dynamically allocated port.  The default port '
4868
4879
                    'depends on the protocol.',
4869
4880
               type=str),
4870
 
        custom_help('directory',
4871
 
               help='Serve contents of this directory.'),
 
4881
        Option('directory',
 
4882
               help='Serve contents of this directory.',
 
4883
               type=unicode),
4872
4884
        Option('allow-writes',
4873
4885
               help='By default the server is a readonly server.  Supplying '
4874
4886
                    '--allow-writes enables write access to the contents of '
4915
4927
 
4916
4928
 
4917
4929
class cmd_join(Command):
4918
 
    __doc__ = """Combine a tree into its containing tree.
 
4930
    """Combine a tree into its containing tree.
4919
4931
 
4920
4932
    This command requires the target tree to be in a rich-root format.
4921
4933
 
4961
4973
 
4962
4974
 
4963
4975
class cmd_split(Command):
4964
 
    __doc__ = """Split a subdirectory of a tree into a separate tree.
 
4976
    """Split a subdirectory of a tree into a separate tree.
4965
4977
 
4966
4978
    This command will produce a target tree in a format that supports
4967
4979
    rich roots, like 'rich-root' or 'rich-root-pack'.  These formats cannot be
4987
4999
 
4988
5000
 
4989
5001
class cmd_merge_directive(Command):
4990
 
    __doc__ = """Generate a merge directive for auto-merge tools.
 
5002
    """Generate a merge directive for auto-merge tools.
4991
5003
 
4992
5004
    A directive requests a merge to be performed, and also provides all the
4993
5005
    information necessary to do so.  This means it must either include a
5086
5098
 
5087
5099
 
5088
5100
class cmd_send(Command):
5089
 
    __doc__ = """Mail or create a merge-directive for submitting changes.
 
5101
    """Mail or create a merge-directive for submitting changes.
5090
5102
 
5091
5103
    A merge directive provides many things needed for requesting merges:
5092
5104
 
5203
5215
 
5204
5216
 
5205
5217
class cmd_bundle_revisions(cmd_send):
5206
 
    __doc__ = """Create a merge-directive for submitting changes.
 
5218
    """Create a merge-directive for submitting changes.
5207
5219
 
5208
5220
    A merge directive provides many things needed for requesting merges:
5209
5221
 
5276
5288
 
5277
5289
 
5278
5290
class cmd_tag(Command):
5279
 
    __doc__ = """Create, remove or modify a tag naming a revision.
 
5291
    """Create, remove or modify a tag naming a revision.
5280
5292
 
5281
5293
    Tags give human-meaningful names to revisions.  Commands that take a -r
5282
5294
    (--revision) option can be given -rtag:X, where X is any previously
5303
5315
        Option('delete',
5304
5316
            help='Delete this tag rather than placing it.',
5305
5317
            ),
5306
 
        custom_help('directory',
5307
 
            help='Branch in which to place the tag.'),
 
5318
        Option('directory',
 
5319
            help='Branch in which to place the tag.',
 
5320
            short_name='d',
 
5321
            type=unicode,
 
5322
            ),
5308
5323
        Option('force',
5309
5324
            help='Replace existing tags.',
5310
5325
            ),
5318
5333
            revision=None,
5319
5334
            ):
5320
5335
        branch, relpath = Branch.open_containing(directory)
5321
 
        self.add_cleanup(branch.lock_write().unlock)
 
5336
        branch.lock_write()
 
5337
        self.add_cleanup(branch.unlock)
5322
5338
        if delete:
5323
5339
            if tag_name is None:
5324
5340
                raise errors.BzrCommandError("No tag specified to delete.")
5345
5361
 
5346
5362
 
5347
5363
class cmd_tags(Command):
5348
 
    __doc__ = """List tags.
 
5364
    """List tags.
5349
5365
 
5350
5366
    This command shows a table of tag names and the revisions they reference.
5351
5367
    """
5352
5368
 
5353
5369
    _see_also = ['tag']
5354
5370
    takes_options = [
5355
 
        custom_help('directory',
5356
 
            help='Branch whose tags should be displayed.'),
 
5371
        Option('directory',
 
5372
            help='Branch whose tags should be displayed.',
 
5373
            short_name='d',
 
5374
            type=unicode,
 
5375
            ),
5357
5376
        RegistryOption.from_kwargs('sort',
5358
5377
            'Sort tags by different criteria.', title='Sorting',
5359
5378
            alpha='Sort tags lexicographically (default).',
5376
5395
        if not tags:
5377
5396
            return
5378
5397
 
5379
 
        self.add_cleanup(branch.lock_read().unlock)
 
5398
        branch.lock_read()
 
5399
        self.add_cleanup(branch.unlock)
5380
5400
        if revision:
5381
5401
            graph = branch.repository.get_graph()
5382
5402
            rev1, rev2 = _get_revision_range(revision, branch, self.name())
5415
5435
 
5416
5436
 
5417
5437
class cmd_reconfigure(Command):
5418
 
    __doc__ = """Reconfigure the type of a bzr directory.
 
5438
    """Reconfigure the type of a bzr directory.
5419
5439
 
5420
5440
    A target configuration must be specified.
5421
5441
 
5506
5526
 
5507
5527
 
5508
5528
class cmd_switch(Command):
5509
 
    __doc__ = """Set the branch of a checkout and update.
 
5529
    """Set the branch of a checkout and update.
5510
5530
 
5511
5531
    For lightweight checkouts, this changes the branch being referenced.
5512
5532
    For heavyweight checkouts, this checks that there are no local commits
5602
5622
 
5603
5623
 
5604
5624
class cmd_view(Command):
5605
 
    __doc__ = """Manage filtered views.
 
5625
    """Manage filtered views.
5606
5626
 
5607
5627
    Views provide a mask over the tree so that users can focus on
5608
5628
    a subset of a tree when doing their work. After creating a view,
5756
5776
 
5757
5777
 
5758
5778
class cmd_hooks(Command):
5759
 
    __doc__ = """Show hooks."""
 
5779
    """Show hooks."""
5760
5780
 
5761
5781
    hidden = True
5762
5782
 
5776
5796
 
5777
5797
 
5778
5798
class cmd_remove_branch(Command):
5779
 
    __doc__ = """Remove a branch.
 
5799
    """Remove a branch.
5780
5800
 
5781
5801
    This will remove the branch from the specified location but 
5782
5802
    will keep any working tree or repository in place.
5801
5821
        
5802
5822
 
5803
5823
class cmd_shelve(Command):
5804
 
    __doc__ = """Temporarily set aside some changes from the current tree.
 
5824
    """Temporarily set aside some changes from the current tree.
5805
5825
 
5806
5826
    Shelve allows you to temporarily put changes you've made "on the shelf",
5807
5827
    ie. out of the way, until a later time when you can bring them back from
5860
5880
 
5861
5881
    def run_for_list(self):
5862
5882
        tree = WorkingTree.open_containing('.')[0]
5863
 
        self.add_cleanup(tree.lock_read().unlock)
 
5883
        tree.lock_read()
 
5884
        self.add_cleanup(tree.unlock)
5864
5885
        manager = tree.get_shelf_manager()
5865
5886
        shelves = manager.active_shelves()
5866
5887
        if len(shelves) == 0:
5875
5896
 
5876
5897
 
5877
5898
class cmd_unshelve(Command):
5878
 
    __doc__ = """Restore shelved changes.
 
5899
    """Restore shelved changes.
5879
5900
 
5880
5901
    By default, the most recently shelved changes are restored. However if you
5881
5902
    specify a shelf by id those changes will be restored instead.  This works
5907
5928
 
5908
5929
 
5909
5930
class cmd_clean_tree(Command):
5910
 
    __doc__ = """Remove unwanted files from working tree.
 
5931
    """Remove unwanted files from working tree.
5911
5932
 
5912
5933
    By default, only unknown files, not ignored files, are deleted.  Versioned
5913
5934
    files are never deleted.
5921
5942
 
5922
5943
    To check what clean-tree will do, use --dry-run.
5923
5944
    """
5924
 
    takes_options = ['directory',
5925
 
                     Option('ignored', help='Delete all ignored files.'),
 
5945
    takes_options = [Option('ignored', help='Delete all ignored files.'),
5926
5946
                     Option('detritus', help='Delete conflict files, merge'
5927
5947
                            ' backups, and failed selftest dirs.'),
5928
5948
                     Option('unknown',
5931
5951
                            ' deleting them.'),
5932
5952
                     Option('force', help='Do not prompt before deleting.')]
5933
5953
    def run(self, unknown=False, ignored=False, detritus=False, dry_run=False,
5934
 
            force=False, directory=u'.'):
 
5954
            force=False):
5935
5955
        from bzrlib.clean_tree import clean_tree
5936
5956
        if not (unknown or ignored or detritus):
5937
5957
            unknown = True
5938
5958
        if dry_run:
5939
5959
            force = True
5940
 
        clean_tree(directory, unknown=unknown, ignored=ignored,
5941
 
                   detritus=detritus, dry_run=dry_run, no_prompt=force)
 
5960
        clean_tree('.', unknown=unknown, ignored=ignored, detritus=detritus,
 
5961
                   dry_run=dry_run, no_prompt=force)
5942
5962
 
5943
5963
 
5944
5964
class cmd_reference(Command):
5945
 
    __doc__ = """list, view and set branch locations for nested trees.
 
5965
    """list, view and set branch locations for nested trees.
5946
5966
 
5947
5967
    If no arguments are provided, lists the branch locations for nested trees.
5948
5968
    If one argument is provided, display the branch location for that tree.