/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: Martin von Gagern
  • Date: 2010-05-02 20:10:25 UTC
  • mto: This revision was merged to the branch mainline in revision 5203.
  • Revision ID: martin.vgagern@gmx.net-20100502201025-ssuldxi8i98desfh
Added blackbox tests for --directory option.

Added tests for the new --directory (-d) option to these commands: added,
annotate, bind, cat, clean-tree, deleted, export, ignore, ignored,
lookup-revision, ls, modified, nick, re-sign, unbind, unknowns.

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):
 
235
def _open_tree_branch_or_directory(filename, directory):
236
236
    """Open the tree or branch containing the specified file, unless
237
237
    the --directory option is used to specify a different branch."""
238
238
    if directory is not None:
247
247
# opens the branch?)
248
248
 
249
249
class cmd_status(Command):
250
 
    __doc__ = """Display status summary.
 
250
    """Display status summary.
251
251
 
252
252
    This reports on versioned and unknown files, reporting them
253
253
    grouped by state.  Possible states are:
340
340
 
341
341
 
342
342
class cmd_cat_revision(Command):
343
 
    __doc__ = """Write out metadata for a revision.
 
343
    """Write out metadata for a revision.
344
344
 
345
345
    The revision to print can either be specified by a specific
346
346
    revision identifier, or you can use --revision.
398
398
        
399
399
 
400
400
class cmd_dump_btree(Command):
401
 
    __doc__ = """Dump the contents of a btree index file to stdout.
 
401
    """Dump the contents of a btree index file to stdout.
402
402
 
403
403
    PATH is a btree index file, it can be any URL. This includes things like
404
404
    .bzr/repository/pack-names, or .bzr/repository/indices/a34b3a...ca4a4.iix
479
479
 
480
480
 
481
481
class cmd_remove_tree(Command):
482
 
    __doc__ = """Remove the working tree from a given branch/checkout.
 
482
    """Remove the working tree from a given branch/checkout.
483
483
 
484
484
    Since a lightweight checkout is little more than a working tree
485
485
    this will refuse to run against one.
512
512
                if (working.has_changes()):
513
513
                    raise errors.UncommittedChanges(working)
514
514
 
515
 
            if working.user_url != working.branch.user_url:
 
515
            working_path = working.bzrdir.root_transport.base
 
516
            branch_path = working.branch.bzrdir.root_transport.base
 
517
            if working_path != branch_path:
516
518
                raise errors.BzrCommandError("You cannot remove the working tree"
517
519
                                             " from a lightweight checkout")
518
520
 
520
522
 
521
523
 
522
524
class cmd_revno(Command):
523
 
    __doc__ = """Show current revision number.
 
525
    """Show current revision number.
524
526
 
525
527
    This is equal to the number of revisions on this branch.
526
528
    """
536
538
        if tree:
537
539
            try:
538
540
                wt = WorkingTree.open_containing(location)[0]
539
 
                self.add_cleanup(wt.lock_read().unlock)
 
541
                wt.lock_read()
540
542
            except (errors.NoWorkingTree, errors.NotLocalUrl):
541
543
                raise errors.NoWorkingTree(location)
 
544
            self.add_cleanup(wt.unlock)
542
545
            revid = wt.last_revision()
543
546
            try:
544
547
                revno_t = wt.branch.revision_id_to_dotted_revno(revid)
547
550
            revno = ".".join(str(n) for n in revno_t)
548
551
        else:
549
552
            b = Branch.open_containing(location)[0]
550
 
            self.add_cleanup(b.lock_read().unlock)
 
553
            b.lock_read()
 
554
            self.add_cleanup(b.unlock)
551
555
            revno = b.revno()
552
556
        self.cleanup_now()
553
557
        self.outf.write(str(revno) + '\n')
554
558
 
555
559
 
556
560
class cmd_revision_info(Command):
557
 
    __doc__ = """Show revision number and revision id for a given revision identifier.
 
561
    """Show revision number and revision id for a given revision identifier.
558
562
    """
559
563
    hidden = True
560
564
    takes_args = ['revision_info*']
573
577
        try:
574
578
            wt = WorkingTree.open_containing(directory)[0]
575
579
            b = wt.branch
576
 
            self.add_cleanup(wt.lock_read().unlock)
 
580
            wt.lock_read()
 
581
            self.add_cleanup(wt.unlock)
577
582
        except (errors.NoWorkingTree, errors.NotLocalUrl):
578
583
            wt = None
579
584
            b = Branch.open_containing(directory)[0]
580
 
            self.add_cleanup(b.lock_read().unlock)
 
585
            b.lock_read()
 
586
            self.add_cleanup(b.unlock)
581
587
        revision_ids = []
582
588
        if revision is not None:
583
589
            revision_ids.extend(rev.as_revision_id(b) for rev in revision)
611
617
 
612
618
 
613
619
class cmd_add(Command):
614
 
    __doc__ = """Add specified files or directories.
 
620
    """Add specified files or directories.
615
621
 
616
622
    In non-recursive mode, all the named items are added, regardless
617
623
    of whether they were previously ignored.  A warning is given if
682
688
                should_print=(not is_quiet()))
683
689
 
684
690
        if base_tree:
685
 
            self.add_cleanup(base_tree.lock_read().unlock)
 
691
            base_tree.lock_read()
 
692
            self.add_cleanup(base_tree.unlock)
686
693
        tree, file_list = tree_files_for_add(file_list)
687
694
        added, ignored = tree.smart_add(file_list, not
688
695
            no_recurse, action=action, save=not dry_run)
696
703
 
697
704
 
698
705
class cmd_mkdir(Command):
699
 
    __doc__ = """Create a new versioned directory.
 
706
    """Create a new versioned directory.
700
707
 
701
708
    This is equivalent to creating the directory and then adding it.
702
709
    """
718
725
 
719
726
 
720
727
class cmd_relpath(Command):
721
 
    __doc__ = """Show path of a file relative to root"""
 
728
    """Show path of a file relative to root"""
722
729
 
723
730
    takes_args = ['filename']
724
731
    hidden = True
733
740
 
734
741
 
735
742
class cmd_inventory(Command):
736
 
    __doc__ = """Show inventory of the current working copy or a revision.
 
743
    """Show inventory of the current working copy or a revision.
737
744
 
738
745
    It is possible to limit the output to a particular entry
739
746
    type using the --kind option.  For example: --kind file.
760
767
 
761
768
        revision = _get_one_revision('inventory', revision)
762
769
        work_tree, file_list = tree_files(file_list)
763
 
        self.add_cleanup(work_tree.lock_read().unlock)
 
770
        work_tree.lock_read()
 
771
        self.add_cleanup(work_tree.unlock)
764
772
        if revision is not None:
765
773
            tree = revision.as_tree(work_tree.branch)
766
774
 
767
775
            extra_trees = [work_tree]
768
 
            self.add_cleanup(tree.lock_read().unlock)
 
776
            tree.lock_read()
 
777
            self.add_cleanup(tree.unlock)
769
778
        else:
770
779
            tree = work_tree
771
780
            extra_trees = []
792
801
 
793
802
 
794
803
class cmd_mv(Command):
795
 
    __doc__ = """Move or rename a file.
 
804
    """Move or rename a file.
796
805
 
797
806
    :Usage:
798
807
        bzr mv OLDNAME NEWNAME
831
840
        if len(names_list) < 2:
832
841
            raise errors.BzrCommandError("missing file argument")
833
842
        tree, rel_names = tree_files(names_list, canonicalize=False)
834
 
        self.add_cleanup(tree.lock_tree_write().unlock)
 
843
        tree.lock_tree_write()
 
844
        self.add_cleanup(tree.unlock)
835
845
        self._run(tree, names_list, rel_names, after)
836
846
 
837
847
    def run_auto(self, names_list, after, dry_run):
842
852
            raise errors.BzrCommandError('--after cannot be specified with'
843
853
                                         ' --auto.')
844
854
        work_tree, file_list = tree_files(names_list, default_branch='.')
845
 
        self.add_cleanup(work_tree.lock_tree_write().unlock)
 
855
        work_tree.lock_tree_write()
 
856
        self.add_cleanup(work_tree.unlock)
846
857
        rename_map.RenameMap.guess_renames(work_tree, dry_run)
847
858
 
848
859
    def _run(self, tree, names_list, rel_names, after):
927
938
 
928
939
 
929
940
class cmd_pull(Command):
930
 
    __doc__ = """Turn this branch into a mirror of another branch.
 
941
    """Turn this branch into a mirror of another branch.
931
942
 
932
943
    By default, this command only works on branches that have not diverged.
933
944
    Branches are considered diverged if the destination branch's most recent 
979
990
        try:
980
991
            tree_to = WorkingTree.open_containing(directory)[0]
981
992
            branch_to = tree_to.branch
982
 
            self.add_cleanup(tree_to.lock_write().unlock)
 
993
            tree_to.lock_write()
 
994
            self.add_cleanup(tree_to.unlock)
983
995
        except errors.NoWorkingTree:
984
996
            tree_to = None
985
997
            branch_to = Branch.open_containing(directory)[0]
986
 
            self.add_cleanup(branch_to.lock_write().unlock)
 
998
            branch_to.lock_write()
 
999
            self.add_cleanup(branch_to.unlock)
987
1000
 
988
1001
        if local and not branch_to.get_bound_location():
989
1002
            raise errors.LocalRequiresBoundBranch()
1020
1033
        else:
1021
1034
            branch_from = Branch.open(location,
1022
1035
                possible_transports=possible_transports)
1023
 
            self.add_cleanup(branch_from.lock_read().unlock)
 
1036
            branch_from.lock_read()
 
1037
            self.add_cleanup(branch_from.unlock)
1024
1038
 
1025
1039
            if branch_to.get_parent() is None or remember:
1026
1040
                branch_to.set_parent(branch_from.base)
1048
1062
 
1049
1063
 
1050
1064
class cmd_push(Command):
1051
 
    __doc__ = """Update a mirror of this branch.
 
1065
    """Update a mirror of this branch.
1052
1066
 
1053
1067
    The target branch will not have its working tree populated because this
1054
1068
    is both expensive, and is not supported on remote file systems.
1119
1133
        else:
1120
1134
            revision_id = None
1121
1135
        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.')
 
1136
            tree.warn_if_changed_or_out_of_date(
 
1137
                strict, 'push_strict', 'Use --no-strict to force the push.')
1126
1138
        # Get the stacked_on branch, if any
1127
1139
        if stacked_on is not None:
1128
1140
            stacked_on = urlutils.normalize_url(stacked_on)
1160
1172
 
1161
1173
 
1162
1174
class cmd_branch(Command):
1163
 
    __doc__ = """Create a new branch that is a copy of an existing branch.
 
1175
    """Create a new branch that is a copy of an existing branch.
1164
1176
 
1165
1177
    If the TO_LOCATION is omitted, the last component of the FROM_LOCATION will
1166
1178
    be used.  In other words, "branch ../foo/bar" will attempt to create ./bar.
1206
1218
        accelerator_tree, br_from = bzrdir.BzrDir.open_tree_or_branch(
1207
1219
            from_location)
1208
1220
        revision = _get_one_revision('branch', revision)
1209
 
        self.add_cleanup(br_from.lock_read().unlock)
 
1221
        br_from.lock_read()
 
1222
        self.add_cleanup(br_from.unlock)
1210
1223
        if revision is not None:
1211
1224
            revision_id = revision.as_revision_id(br_from)
1212
1225
        else:
1272
1285
 
1273
1286
 
1274
1287
class cmd_checkout(Command):
1275
 
    __doc__ = """Create a new checkout of an existing branch.
 
1288
    """Create a new checkout of an existing branch.
1276
1289
 
1277
1290
    If BRANCH_LOCATION is omitted, checkout will reconstitute a working tree for
1278
1291
    the branch found in '.'. This is useful if you have removed the working tree
1336
1349
            except errors.NoWorkingTree:
1337
1350
                source.bzrdir.create_workingtree(revision_id)
1338
1351
                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
1352
        source.create_checkout(to_location, revision_id, lightweight,
1345
1353
                               accelerator_tree, hardlink)
1346
1354
 
1347
1355
 
1348
1356
class cmd_renames(Command):
1349
 
    __doc__ = """Show list of renamed files.
 
1357
    """Show list of renamed files.
1350
1358
    """
1351
1359
    # TODO: Option to show renames between two historical versions.
1352
1360
 
1357
1365
    @display_command
1358
1366
    def run(self, dir=u'.'):
1359
1367
        tree = WorkingTree.open_containing(dir)[0]
1360
 
        self.add_cleanup(tree.lock_read().unlock)
 
1368
        tree.lock_read()
 
1369
        self.add_cleanup(tree.unlock)
1361
1370
        new_inv = tree.inventory
1362
1371
        old_tree = tree.basis_tree()
1363
 
        self.add_cleanup(old_tree.lock_read().unlock)
 
1372
        old_tree.lock_read()
 
1373
        self.add_cleanup(old_tree.unlock)
1364
1374
        old_inv = old_tree.inventory
1365
1375
        renames = []
1366
1376
        iterator = tree.iter_changes(old_tree, include_unchanged=True)
1376
1386
 
1377
1387
 
1378
1388
class cmd_update(Command):
1379
 
    __doc__ = """Update a tree to have the latest code committed to its branch.
 
1389
    """Update a tree to have the latest code committed to its branch.
1380
1390
 
1381
1391
    This will perform a merge into the working tree, and may generate
1382
1392
    conflicts. If you have any local changes, you will still
1404
1414
        master = branch.get_master_branch(
1405
1415
            possible_transports=possible_transports)
1406
1416
        if master is not None:
 
1417
            tree.lock_write()
1407
1418
            branch_location = master.base
1408
 
            tree.lock_write()
1409
1419
        else:
 
1420
            tree.lock_tree_write()
1410
1421
            branch_location = tree.branch.base
1411
 
            tree.lock_tree_write()
1412
1422
        self.add_cleanup(tree.unlock)
1413
1423
        # get rid of the final '/' and be ready for display
1414
1424
        branch_location = urlutils.unescape_for_display(
1462
1472
 
1463
1473
 
1464
1474
class cmd_info(Command):
1465
 
    __doc__ = """Show information about a working tree, branch or repository.
 
1475
    """Show information about a working tree, branch or repository.
1466
1476
 
1467
1477
    This command will show all known locations and formats associated to the
1468
1478
    tree, branch or repository.
1506
1516
 
1507
1517
 
1508
1518
class cmd_remove(Command):
1509
 
    __doc__ = """Remove files or directories.
 
1519
    """Remove files or directories.
1510
1520
 
1511
1521
    This makes bzr stop tracking changes to the specified files. bzr will delete
1512
1522
    them if they can easily be recovered using revert. If no options or
1534
1544
        if file_list is not None:
1535
1545
            file_list = [f for f in file_list]
1536
1546
 
1537
 
        self.add_cleanup(tree.lock_write().unlock)
 
1547
        tree.lock_write()
 
1548
        self.add_cleanup(tree.unlock)
1538
1549
        # Heuristics should probably all move into tree.remove_smart or
1539
1550
        # some such?
1540
1551
        if new:
1559
1570
 
1560
1571
 
1561
1572
class cmd_file_id(Command):
1562
 
    __doc__ = """Print file_id of a particular file or directory.
 
1573
    """Print file_id of a particular file or directory.
1563
1574
 
1564
1575
    The file_id is assigned when the file is first added and remains the
1565
1576
    same through all revisions where the file exists, even when it is
1581
1592
 
1582
1593
 
1583
1594
class cmd_file_path(Command):
1584
 
    __doc__ = """Print path of file_ids to a file or directory.
 
1595
    """Print path of file_ids to a file or directory.
1585
1596
 
1586
1597
    This prints one line for each directory down to the target,
1587
1598
    starting at the branch root.
1603
1614
 
1604
1615
 
1605
1616
class cmd_reconcile(Command):
1606
 
    __doc__ = """Reconcile bzr metadata in a branch.
 
1617
    """Reconcile bzr metadata in a branch.
1607
1618
 
1608
1619
    This can correct data mismatches that may have been caused by
1609
1620
    previous ghost operations or bzr upgrades. You should only
1631
1642
 
1632
1643
 
1633
1644
class cmd_revision_history(Command):
1634
 
    __doc__ = """Display the list of revision ids on a branch."""
 
1645
    """Display the list of revision ids on a branch."""
1635
1646
 
1636
1647
    _see_also = ['log']
1637
1648
    takes_args = ['location?']
1647
1658
 
1648
1659
 
1649
1660
class cmd_ancestry(Command):
1650
 
    __doc__ = """List all revisions merged into this branch."""
 
1661
    """List all revisions merged into this branch."""
1651
1662
 
1652
1663
    _see_also = ['log', 'revision-history']
1653
1664
    takes_args = ['location?']
1672
1683
 
1673
1684
 
1674
1685
class cmd_init(Command):
1675
 
    __doc__ = """Make a directory into a versioned branch.
 
1686
    """Make a directory into a versioned branch.
1676
1687
 
1677
1688
    Use this to create an empty branch, or before importing an
1678
1689
    existing project.
1781
1792
 
1782
1793
 
1783
1794
class cmd_init_repository(Command):
1784
 
    __doc__ = """Create a shared repository for branches to share storage space.
 
1795
    """Create a shared repository for branches to share storage space.
1785
1796
 
1786
1797
    New branches created under the repository directory will store their
1787
1798
    revisions in the repository, not in the branch directory.  For branches
1841
1852
 
1842
1853
 
1843
1854
class cmd_diff(Command):
1844
 
    __doc__ = """Show differences in the working tree, between revisions or branches.
 
1855
    """Show differences in the working tree, between revisions or branches.
1845
1856
 
1846
1857
    If no arguments are given, all changes for the current tree are listed.
1847
1858
    If files are given, only the changes in those files are listed.
1982
1993
 
1983
1994
 
1984
1995
class cmd_deleted(Command):
1985
 
    __doc__ = """List files deleted in the working tree.
 
1996
    """List files deleted in the working tree.
1986
1997
    """
1987
1998
    # TODO: Show files deleted since a previous revision, or
1988
1999
    # between two revisions.
1996
2007
    @display_command
1997
2008
    def run(self, show_ids=False, directory=u'.'):
1998
2009
        tree = WorkingTree.open_containing(directory)[0]
1999
 
        self.add_cleanup(tree.lock_read().unlock)
 
2010
        tree.lock_read()
 
2011
        self.add_cleanup(tree.unlock)
2000
2012
        old = tree.basis_tree()
2001
 
        self.add_cleanup(old.lock_read().unlock)
 
2013
        old.lock_read()
 
2014
        self.add_cleanup(old.unlock)
2002
2015
        for path, ie in old.inventory.iter_entries():
2003
2016
            if not tree.has_id(ie.file_id):
2004
2017
                self.outf.write(path)
2009
2022
 
2010
2023
 
2011
2024
class cmd_modified(Command):
2012
 
    __doc__ = """List files modified in working tree.
 
2025
    """List files modified in working tree.
2013
2026
    """
2014
2027
 
2015
2028
    hidden = True
2016
2029
    _see_also = ['status', 'ls']
2017
 
    takes_options = ['directory', 'null']
 
2030
    takes_options = ['directory',
 
2031
            Option('null',
 
2032
                   help='Write an ascii NUL (\\0) separator '
 
2033
                   'between files rather than a newline.')
 
2034
            ]
2018
2035
 
2019
2036
    @display_command
2020
2037
    def run(self, null=False, directory=u'.'):
2028
2045
 
2029
2046
 
2030
2047
class cmd_added(Command):
2031
 
    __doc__ = """List files added in working tree.
 
2048
    """List files added in working tree.
2032
2049
    """
2033
2050
 
2034
2051
    hidden = True
2035
2052
    _see_also = ['status', 'ls']
2036
 
    takes_options = ['directory', 'null']
 
2053
    takes_options = ['directory',
 
2054
            Option('null',
 
2055
                   help='Write an ascii NUL (\\0) separator '
 
2056
                   'between files rather than a newline.')
 
2057
            ]
2037
2058
 
2038
2059
    @display_command
2039
2060
    def run(self, null=False, directory=u'.'):
2040
2061
        wt = WorkingTree.open_containing(directory)[0]
2041
 
        self.add_cleanup(wt.lock_read().unlock)
 
2062
        wt.lock_read()
 
2063
        self.add_cleanup(wt.unlock)
2042
2064
        basis = wt.basis_tree()
2043
 
        self.add_cleanup(basis.lock_read().unlock)
 
2065
        basis.lock_read()
 
2066
        self.add_cleanup(basis.unlock)
2044
2067
        basis_inv = basis.inventory
2045
2068
        inv = wt.inventory
2046
2069
        for file_id in inv:
2049
2072
            if inv.is_root(file_id) and len(basis_inv) == 0:
2050
2073
                continue
2051
2074
            path = inv.id2path(file_id)
2052
 
            if not os.access(osutils.pathjoin(wt.basedir, path), os.F_OK):
 
2075
            if not os.access(osutils.abspath(path), os.F_OK):
2053
2076
                continue
2054
2077
            if null:
2055
2078
                self.outf.write(path + '\0')
2058
2081
 
2059
2082
 
2060
2083
class cmd_root(Command):
2061
 
    __doc__ = """Show the tree root directory.
 
2084
    """Show the tree root directory.
2062
2085
 
2063
2086
    The root is the nearest enclosing directory with a .bzr control
2064
2087
    directory."""
2088
2111
 
2089
2112
 
2090
2113
class cmd_log(Command):
2091
 
    __doc__ = """Show historical log for a branch or subset of a branch.
 
2114
    """Show historical log for a branch or subset of a branch.
2092
2115
 
2093
2116
    log is bzr's default tool for exploring the history of a branch.
2094
2117
    The branch to use is taken from the first parameter. If no parameters
2255
2278
                   help='Show just the specified revision.'
2256
2279
                   ' See also "help revisionspec".'),
2257
2280
            '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
2281
            Option('levels',
2264
2282
                   short_name='n',
2265
2283
                   help='Number of levels to display - 0 for all, 1 for flat.',
2280
2298
                   help='Show changes made in each revision as a patch.'),
2281
2299
            Option('include-merges',
2282
2300
                   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
2301
            ]
2288
2302
    encoding_type = 'replace'
2289
2303
 
2299
2313
            message=None,
2300
2314
            limit=None,
2301
2315
            show_diff=False,
2302
 
            include_merges=False,
2303
 
            authors=None,
2304
 
            exclude_common_ancestry=False,
2305
 
            ):
 
2316
            include_merges=False):
2306
2317
        from bzrlib.log import (
2307
2318
            Logger,
2308
2319
            make_log_request_dict,
2309
2320
            _get_info_for_log_files,
2310
2321
            )
2311
2322
        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
2323
        if include_merges:
2317
2324
            if levels is None:
2318
2325
                levels = 0
2334
2341
        if file_list:
2335
2342
            # find the file ids to log and check for directory filtering
2336
2343
            b, file_info_list, rev1, rev2 = _get_info_for_log_files(
2337
 
                revision, file_list, self.add_cleanup)
 
2344
                revision, file_list)
 
2345
            self.add_cleanup(b.unlock)
2338
2346
            for relpath, file_id, kind in file_info_list:
2339
2347
                if file_id is None:
2340
2348
                    raise errors.BzrCommandError(
2358
2366
                location = '.'
2359
2367
            dir, relpath = bzrdir.BzrDir.open_containing(location)
2360
2368
            b = dir.open_branch()
2361
 
            self.add_cleanup(b.lock_read().unlock)
 
2369
            b.lock_read()
 
2370
            self.add_cleanup(b.unlock)
2362
2371
            rev1, rev2 = _get_revision_range(revision, b, self.name())
2363
2372
 
2364
2373
        # Decide on the type of delta & diff filtering to use
2384
2393
                        show_timezone=timezone,
2385
2394
                        delta_format=get_verbosity_level(),
2386
2395
                        levels=levels,
2387
 
                        show_advice=levels is None,
2388
 
                        author_list_handler=authors)
 
2396
                        show_advice=levels is None)
2389
2397
 
2390
2398
        # Choose the algorithm for doing the logging. It's annoying
2391
2399
        # having multiple code paths like this but necessary until
2410
2418
            direction=direction, specific_fileids=file_ids,
2411
2419
            start_revision=rev1, end_revision=rev2, limit=limit,
2412
2420
            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
 
            )
 
2421
            diff_type=diff_type, _match_using_deltas=match_using_deltas)
2416
2422
        Logger(b, rqst).show(lf)
2417
2423
 
2418
2424
 
2476
2482
 
2477
2483
 
2478
2484
class cmd_touching_revisions(Command):
2479
 
    __doc__ = """Return revision-ids which affected a particular file.
 
2485
    """Return revision-ids which affected a particular file.
2480
2486
 
2481
2487
    A more user-friendly interface is "bzr log FILE".
2482
2488
    """
2489
2495
        tree, relpath = WorkingTree.open_containing(filename)
2490
2496
        file_id = tree.path2id(relpath)
2491
2497
        b = tree.branch
2492
 
        self.add_cleanup(b.lock_read().unlock)
 
2498
        b.lock_read()
 
2499
        self.add_cleanup(b.unlock)
2493
2500
        touching_revs = log.find_touching_revisions(b, file_id)
2494
2501
        for revno, revision_id, what in touching_revs:
2495
2502
            self.outf.write("%6d %s\n" % (revno, what))
2496
2503
 
2497
2504
 
2498
2505
class cmd_ls(Command):
2499
 
    __doc__ = """List files in a tree.
 
2506
    """List files in a tree.
2500
2507
    """
2501
2508
 
2502
2509
    _see_also = ['status', 'cat']
2508
2515
                   help='Recurse into subdirectories.'),
2509
2516
            Option('from-root',
2510
2517
                   help='Print paths relative to the root of the branch.'),
2511
 
            Option('unknown', short_name='u',
2512
 
                help='Print unknown files.'),
 
2518
            Option('unknown', help='Print unknown files.'),
2513
2519
            Option('versioned', help='Print versioned files.',
2514
2520
                   short_name='V'),
2515
 
            Option('ignored', short_name='i',
2516
 
                help='Print ignored files.'),
2517
 
            Option('kind', short_name='k',
 
2521
            Option('ignored', help='Print ignored files.'),
 
2522
            Option('null',
 
2523
                   help='Write an ascii NUL (\\0) separator '
 
2524
                   'between files rather than a newline.'),
 
2525
            Option('kind',
2518
2526
                   help='List entries of a particular kind: file, directory, symlink.',
2519
2527
                   type=unicode),
2520
 
            'null',
2521
2528
            'show-ids',
2522
2529
            'directory',
2523
2530
            ]
2544
2551
                                             ' and PATH')
2545
2552
            fs_path = path
2546
2553
        tree, branch, relpath = \
2547
 
            _open_directory_or_containing_tree_or_branch(fs_path, directory)
 
2554
            _open_tree_branch_or_directory(fs_path, directory)
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
2627
2635
 
2628
2636
 
2629
2637
class cmd_ignore(Command):
2630
 
    __doc__ = """Ignore specified files or patterns.
 
2638
    """Ignore specified files or patterns.
2631
2639
 
2632
2640
    See ``bzr help patterns`` for details on the syntax of patterns.
2633
2641
 
2642
2650
    using this command or directly by using an editor, be sure to commit
2643
2651
    it.
2644
2652
    
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
2653
    Patterns prefixed with '!' are exceptions to ignore patterns and take
2652
2654
    precedence over regular ignores.  Such exceptions are used to specify
2653
2655
    files that should be versioned which would otherwise be ignored.
2694
2696
    _see_also = ['status', 'ignored', 'patterns']
2695
2697
    takes_args = ['name_pattern*']
2696
2698
    takes_options = ['directory',
2697
 
        Option('default-rules',
2698
 
               help='Display the default ignore rules that bzr uses.')
 
2699
        Option('old-default-rules',
 
2700
               help='Write out the ignore rules bzr < 0.9 always used.')
2699
2701
        ]
2700
2702
 
2701
 
    def run(self, name_pattern_list=None, default_rules=None,
 
2703
    def run(self, name_pattern_list=None, old_default_rules=None,
2702
2704
            directory=u'.'):
2703
2705
        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:
 
2706
        if old_default_rules is not None:
 
2707
            # dump the rules and exit
 
2708
            for pattern in ignores.OLD_DEFAULTS:
2707
2709
                self.outf.write("%s\n" % pattern)
2708
2710
            return
2709
2711
        if not name_pattern_list:
2710
2712
            raise errors.BzrCommandError("ignore requires at least one "
2711
 
                "NAME_PATTERN or --default-rules.")
 
2713
                                  "NAME_PATTERN or --old-default-rules")
2712
2714
        name_pattern_list = [globbing.normalize_pattern(p)
2713
2715
                             for p in name_pattern_list]
2714
2716
        for name_pattern in name_pattern_list:
2736
2738
 
2737
2739
 
2738
2740
class cmd_ignored(Command):
2739
 
    __doc__ = """List ignored files and the patterns that matched them.
 
2741
    """List ignored files and the patterns that matched them.
2740
2742
 
2741
2743
    List all the ignored files and the ignore pattern that caused the file to
2742
2744
    be ignored.
2753
2755
    @display_command
2754
2756
    def run(self, directory=u'.'):
2755
2757
        tree = WorkingTree.open_containing(directory)[0]
2756
 
        self.add_cleanup(tree.lock_read().unlock)
 
2758
        tree.lock_read()
 
2759
        self.add_cleanup(tree.unlock)
2757
2760
        for path, file_class, kind, file_id, entry in tree.list_files():
2758
2761
            if file_class != 'I':
2759
2762
                continue
2763
2766
 
2764
2767
 
2765
2768
class cmd_lookup_revision(Command):
2766
 
    __doc__ = """Lookup the revision-id from a revision-number
 
2769
    """Lookup the revision-id from a revision-number
2767
2770
 
2768
2771
    :Examples:
2769
2772
        bzr lookup-revision 33
2784
2787
 
2785
2788
 
2786
2789
class cmd_export(Command):
2787
 
    __doc__ = """Export current or past revision to a destination directory or archive.
 
2790
    """Export current or past revision to a destination directory or archive.
2788
2791
 
2789
2792
    If no revision is specified this exports the last committed revision.
2790
2793
 
2847
2850
 
2848
2851
 
2849
2852
class cmd_cat(Command):
2850
 
    __doc__ = """Write the contents of a file as of a given revision to standard output.
 
2853
    """Write the contents of a file as of a given revision to standard output.
2851
2854
 
2852
2855
    If no revision is nominated, the last revision is used.
2853
2856
 
2872
2875
            raise errors.BzrCommandError("bzr cat --revision takes exactly"
2873
2876
                                         " one revision specifier")
2874
2877
        tree, branch, relpath = \
2875
 
            _open_directory_or_containing_tree_or_branch(filename, directory)
2876
 
        self.add_cleanup(branch.lock_read().unlock)
 
2878
            _open_tree_branch_or_directory(filename, directory)
 
2879
        branch.lock_read()
 
2880
        self.add_cleanup(branch.unlock)
2877
2881
        return self._run(tree, branch, relpath, filename, revision,
2878
2882
                         name_from_revision, filters)
2879
2883
 
2882
2886
        if tree is None:
2883
2887
            tree = b.basis_tree()
2884
2888
        rev_tree = _get_one_revision_tree('cat', revision, branch=b)
2885
 
        self.add_cleanup(rev_tree.lock_read().unlock)
 
2889
        rev_tree.lock_read()
 
2890
        self.add_cleanup(rev_tree.unlock)
2886
2891
 
2887
2892
        old_file_id = rev_tree.path2id(relpath)
2888
2893
 
2931
2936
 
2932
2937
 
2933
2938
class cmd_local_time_offset(Command):
2934
 
    __doc__ = """Show the offset in seconds from GMT to local time."""
 
2939
    """Show the offset in seconds from GMT to local time."""
2935
2940
    hidden = True
2936
2941
    @display_command
2937
2942
    def run(self):
2940
2945
 
2941
2946
 
2942
2947
class cmd_commit(Command):
2943
 
    __doc__ = """Commit changes into a new revision.
 
2948
    """Commit changes into a new revision.
2944
2949
 
2945
2950
    An explanatory message needs to be given for each commit. This is
2946
2951
    often done by using the --message option (getting the message from the
3054
3059
                         "the master branch until a normal commit "
3055
3060
                         "is performed."
3056
3061
                    ),
3057
 
             Option('show-diff', short_name='p',
 
3062
             Option('show-diff',
3058
3063
                    help='When no message is supplied, show the diff along'
3059
3064
                    ' with the status summary in the message editor.'),
3060
3065
             ]
3206
3211
 
3207
3212
 
3208
3213
class cmd_check(Command):
3209
 
    __doc__ = """Validate working tree structure, branch consistency and repository history.
 
3214
    """Validate working tree structure, branch consistency and repository history.
3210
3215
 
3211
3216
    This command checks various invariants about branch and repository storage
3212
3217
    to detect data corruption or bzr bugs.
3276
3281
 
3277
3282
 
3278
3283
class cmd_upgrade(Command):
3279
 
    __doc__ = """Upgrade branch storage to current format.
 
3284
    """Upgrade branch storage to current format.
3280
3285
 
3281
3286
    The check command or bzr developers may sometimes advise you to run
3282
3287
    this command. When the default format has changed you may also be warned
3300
3305
 
3301
3306
 
3302
3307
class cmd_whoami(Command):
3303
 
    __doc__ = """Show or set bzr user id.
 
3308
    """Show or set bzr user id.
3304
3309
 
3305
3310
    :Examples:
3306
3311
        Show the email of the current user::
3350
3355
 
3351
3356
 
3352
3357
class cmd_nick(Command):
3353
 
    __doc__ = """Print or set the branch nickname.
 
3358
    """Print or set the branch nickname.
3354
3359
 
3355
3360
    If unset, the tree root directory name is used as the nickname.
3356
3361
    To print the current nickname, execute with no argument.
3375
3380
 
3376
3381
 
3377
3382
class cmd_alias(Command):
3378
 
    __doc__ = """Set/unset and display aliases.
 
3383
    """Set/unset and display aliases.
3379
3384
 
3380
3385
    :Examples:
3381
3386
        Show the current aliases::
3445
3450
 
3446
3451
 
3447
3452
class cmd_selftest(Command):
3448
 
    __doc__ = """Run internal test suite.
 
3453
    """Run internal test suite.
3449
3454
 
3450
3455
    If arguments are given, they are regular expressions that say which tests
3451
3456
    should run.  Tests matching any expression are run, and other tests are
3592
3597
                raise errors.BzrCommandError("subunit not available. subunit "
3593
3598
                    "needs to be installed to use --subunit.")
3594
3599
            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
3600
        if parallel:
3601
3601
            self.additional_selftest_args.setdefault(
3602
3602
                'suite_decorators', []).append(parallel)
3633
3633
 
3634
3634
 
3635
3635
class cmd_version(Command):
3636
 
    __doc__ = """Show version of bzr."""
 
3636
    """Show version of bzr."""
3637
3637
 
3638
3638
    encoding_type = 'replace'
3639
3639
    takes_options = [
3650
3650
 
3651
3651
 
3652
3652
class cmd_rocks(Command):
3653
 
    __doc__ = """Statement of optimism."""
 
3653
    """Statement of optimism."""
3654
3654
 
3655
3655
    hidden = True
3656
3656
 
3660
3660
 
3661
3661
 
3662
3662
class cmd_find_merge_base(Command):
3663
 
    __doc__ = """Find and print a base revision for merging two branches."""
 
3663
    """Find and print a base revision for merging two branches."""
3664
3664
    # TODO: Options to specify revisions on either side, as if
3665
3665
    #       merging only part of the history.
3666
3666
    takes_args = ['branch', 'other']
3672
3672
 
3673
3673
        branch1 = Branch.open_containing(branch)[0]
3674
3674
        branch2 = Branch.open_containing(other)[0]
3675
 
        self.add_cleanup(branch1.lock_read().unlock)
3676
 
        self.add_cleanup(branch2.lock_read().unlock)
 
3675
        branch1.lock_read()
 
3676
        self.add_cleanup(branch1.unlock)
 
3677
        branch2.lock_read()
 
3678
        self.add_cleanup(branch2.unlock)
3677
3679
        last1 = ensure_null(branch1.last_revision())
3678
3680
        last2 = ensure_null(branch2.last_revision())
3679
3681
 
3684
3686
 
3685
3687
 
3686
3688
class cmd_merge(Command):
3687
 
    __doc__ = """Perform a three-way merge.
 
3689
    """Perform a three-way merge.
3688
3690
 
3689
3691
    The source of the merge can be specified either in the form of a branch,
3690
3692
    or in the form of a path to a file containing a merge directive generated
3814
3816
            unversioned_filter=tree.is_ignored, view_info=view_info)
3815
3817
        pb = ui.ui_factory.nested_progress_bar()
3816
3818
        self.add_cleanup(pb.finished)
3817
 
        self.add_cleanup(tree.lock_write().unlock)
 
3819
        tree.lock_write()
 
3820
        self.add_cleanup(tree.unlock)
3818
3821
        if location is not None:
3819
3822
            try:
3820
3823
                mergeable = bundle.read_mergeable_from_url(location,
4041
4044
 
4042
4045
 
4043
4046
class cmd_remerge(Command):
4044
 
    __doc__ = """Redo a merge.
 
4047
    """Redo a merge.
4045
4048
 
4046
4049
    Use this if you want to try a different merge technique while resolving
4047
4050
    conflicts.  Some merge techniques are better than others, and remerge
4076
4079
        if merge_type is None:
4077
4080
            merge_type = _mod_merge.Merge3Merger
4078
4081
        tree, file_list = tree_files(file_list)
4079
 
        self.add_cleanup(tree.lock_write().unlock)
 
4082
        tree.lock_write()
 
4083
        self.add_cleanup(tree.unlock)
4080
4084
        parents = tree.get_parent_ids()
4081
4085
        if len(parents) != 2:
4082
4086
            raise errors.BzrCommandError("Sorry, remerge only works after normal"
4135
4139
 
4136
4140
 
4137
4141
class cmd_revert(Command):
4138
 
    __doc__ = """Revert files to a previous revision.
 
4142
    """Revert files to a previous revision.
4139
4143
 
4140
4144
    Giving a list of files will revert only those files.  Otherwise, all files
4141
4145
    will be reverted.  If the revision is not specified with '--revision', the
4192
4196
    def run(self, revision=None, no_backup=False, file_list=None,
4193
4197
            forget_merges=None):
4194
4198
        tree, file_list = tree_files(file_list)
4195
 
        self.add_cleanup(tree.lock_tree_write().unlock)
 
4199
        tree.lock_tree_write()
 
4200
        self.add_cleanup(tree.unlock)
4196
4201
        if forget_merges:
4197
4202
            tree.set_parent_ids(tree.get_parent_ids()[:1])
4198
4203
        else:
4206
4211
 
4207
4212
 
4208
4213
class cmd_assert_fail(Command):
4209
 
    __doc__ = """Test reporting of assertion failures"""
 
4214
    """Test reporting of assertion failures"""
4210
4215
    # intended just for use in testing
4211
4216
 
4212
4217
    hidden = True
4216
4221
 
4217
4222
 
4218
4223
class cmd_help(Command):
4219
 
    __doc__ = """Show help on a command or other topic.
 
4224
    """Show help on a command or other topic.
4220
4225
    """
4221
4226
 
4222
4227
    _see_also = ['topics']
4235
4240
 
4236
4241
 
4237
4242
class cmd_shell_complete(Command):
4238
 
    __doc__ = """Show appropriate completions for context.
 
4243
    """Show appropriate completions for context.
4239
4244
 
4240
4245
    For a list of all available commands, say 'bzr shell-complete'.
4241
4246
    """
4250
4255
 
4251
4256
 
4252
4257
class cmd_missing(Command):
4253
 
    __doc__ = """Show unmerged/unpulled revisions between two branches.
 
4258
    """Show unmerged/unpulled revisions between two branches.
4254
4259
 
4255
4260
    OTHER_BRANCH may be local or remote.
4256
4261
 
4334
4339
            restrict = 'remote'
4335
4340
 
4336
4341
        local_branch = Branch.open_containing(u".")[0]
4337
 
        self.add_cleanup(local_branch.lock_read().unlock)
 
4342
        local_branch.lock_read()
 
4343
        self.add_cleanup(local_branch.unlock)
4338
4344
 
4339
4345
        parent = local_branch.get_parent()
4340
4346
        if other_branch is None:
4351
4357
        if remote_branch.base == local_branch.base:
4352
4358
            remote_branch = local_branch
4353
4359
        else:
4354
 
            self.add_cleanup(remote_branch.lock_read().unlock)
 
4360
            remote_branch.lock_read()
 
4361
            self.add_cleanup(remote_branch.unlock)
4355
4362
 
4356
4363
        local_revid_range = _revision_range_to_revid_range(
4357
4364
            _get_revision_range(my_revision, local_branch,
4412
4419
            message("Branches are up to date.\n")
4413
4420
        self.cleanup_now()
4414
4421
        if not status_code and parent is None and other_branch is not None:
4415
 
            self.add_cleanup(local_branch.lock_write().unlock)
 
4422
            local_branch.lock_write()
 
4423
            self.add_cleanup(local_branch.unlock)
4416
4424
            # handle race conditions - a parent might be set while we run.
4417
4425
            if local_branch.get_parent() is None:
4418
4426
                local_branch.set_parent(remote_branch.base)
4420
4428
 
4421
4429
 
4422
4430
class cmd_pack(Command):
4423
 
    __doc__ = """Compress the data within a repository.
 
4431
    """Compress the data within a repository.
4424
4432
 
4425
4433
    This operation compresses the data within a bazaar repository. As
4426
4434
    bazaar supports automatic packing of repository, this operation is
4455
4463
 
4456
4464
 
4457
4465
class cmd_plugins(Command):
4458
 
    __doc__ = """List the installed plugins.
 
4466
    """List the installed plugins.
4459
4467
 
4460
4468
    This command displays the list of installed plugins including
4461
4469
    version of plugin and a short description of each.
4500
4508
 
4501
4509
 
4502
4510
class cmd_testament(Command):
4503
 
    __doc__ = """Show testament (signing-form) of a revision."""
 
4511
    """Show testament (signing-form) of a revision."""
4504
4512
    takes_options = [
4505
4513
            'revision',
4506
4514
            Option('long', help='Produce long-format testament.'),
4518
4526
            b = Branch.open_containing(branch)[0]
4519
4527
        else:
4520
4528
            b = Branch.open(branch)
4521
 
        self.add_cleanup(b.lock_read().unlock)
 
4529
        b.lock_read()
 
4530
        self.add_cleanup(b.unlock)
4522
4531
        if revision is None:
4523
4532
            rev_id = b.last_revision()
4524
4533
        else:
4531
4540
 
4532
4541
 
4533
4542
class cmd_annotate(Command):
4534
 
    __doc__ = """Show the origin of each line in a file.
 
4543
    """Show the origin of each line in a file.
4535
4544
 
4536
4545
    This prints out the given file with an annotation on the left side
4537
4546
    indicating which revision, author and date introduced the change.
4557
4566
            show_ids=False, directory=None):
4558
4567
        from bzrlib.annotate import annotate_file, annotate_file_tree
4559
4568
        wt, branch, relpath = \
4560
 
            _open_directory_or_containing_tree_or_branch(filename, directory)
 
4569
            _open_tree_branch_or_directory(filename, directory)
4561
4570
        if wt is not None:
4562
 
            self.add_cleanup(wt.lock_read().unlock)
 
4571
            wt.lock_read()
 
4572
            self.add_cleanup(wt.unlock)
4563
4573
        else:
4564
 
            self.add_cleanup(branch.lock_read().unlock)
 
4574
            branch.lock_read()
 
4575
            self.add_cleanup(branch.unlock)
4565
4576
        tree = _get_one_revision_tree('annotate', revision, branch=branch)
4566
 
        self.add_cleanup(tree.lock_read().unlock)
 
4577
        tree.lock_read()
 
4578
        self.add_cleanup(tree.unlock)
4567
4579
        if wt is not None:
4568
4580
            file_id = wt.path2id(relpath)
4569
4581
        else:
4582
4594
 
4583
4595
 
4584
4596
class cmd_re_sign(Command):
4585
 
    __doc__ = """Create a digital signature for an existing revision."""
 
4597
    """Create a digital signature for an existing revision."""
4586
4598
    # TODO be able to replace existing ones.
4587
4599
 
4588
4600
    hidden = True # is this right ?
4595
4607
        if revision_id_list is None and revision is None:
4596
4608
            raise errors.BzrCommandError('You must supply either --revision or a revision_id')
4597
4609
        b = WorkingTree.open_containing(directory)[0].branch
4598
 
        self.add_cleanup(b.lock_write().unlock)
 
4610
        b.lock_write()
 
4611
        self.add_cleanup(b.unlock)
4599
4612
        return self._run(b, revision_id_list, revision)
4600
4613
 
4601
4614
    def _run(self, b, revision_id_list, revision):
4647
4660
 
4648
4661
 
4649
4662
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.
 
4663
    """Convert the current branch into a checkout of the supplied branch.
4652
4664
 
4653
4665
    Once converted into a checkout, commits must succeed on the master branch
4654
4666
    before they will be applied to the local branch.
4688
4700
 
4689
4701
 
4690
4702
class cmd_unbind(Command):
4691
 
    __doc__ = """Convert the current checkout into a regular branch.
 
4703
    """Convert the current checkout into a regular branch.
4692
4704
 
4693
4705
    After unbinding, the local branch is considered independent and subsequent
4694
4706
    commits will be local only.
4705
4717
 
4706
4718
 
4707
4719
class cmd_uncommit(Command):
4708
 
    __doc__ = """Remove the last committed revision.
 
4720
    """Remove the last committed revision.
4709
4721
 
4710
4722
    --verbose will print out what is being removed.
4711
4723
    --dry-run will go through all the motions, but not actually
4751
4763
            b = control.open_branch()
4752
4764
 
4753
4765
        if tree is not None:
4754
 
            self.add_cleanup(tree.lock_write().unlock)
 
4766
            tree.lock_write()
 
4767
            self.add_cleanup(tree.unlock)
4755
4768
        else:
4756
 
            self.add_cleanup(b.lock_write().unlock)
 
4769
            b.lock_write()
 
4770
            self.add_cleanup(b.unlock)
4757
4771
        return self._run(b, tree, dry_run, verbose, revision, force, local=local)
4758
4772
 
4759
4773
    def _run(self, b, tree, dry_run, verbose, revision, force, local=False):
4811
4825
 
4812
4826
 
4813
4827
class cmd_break_lock(Command):
4814
 
    __doc__ = """Break a dead lock on a repository, branch or working directory.
 
4828
    """Break a dead lock on a repository, branch or working directory.
4815
4829
 
4816
4830
    CAUTION: Locks should only be broken when you are sure that the process
4817
4831
    holding the lock has been stopped.
4836
4850
 
4837
4851
 
4838
4852
class cmd_wait_until_signalled(Command):
4839
 
    __doc__ = """Test helper for test_start_and_stop_bzr_subprocess_send_signal.
 
4853
    """Test helper for test_start_and_stop_bzr_subprocess_send_signal.
4840
4854
 
4841
4855
    This just prints a line to signal when it is ready, then blocks on stdin.
4842
4856
    """
4850
4864
 
4851
4865
 
4852
4866
class cmd_serve(Command):
4853
 
    __doc__ = """Run the bzr server."""
 
4867
    """Run the bzr server."""
4854
4868
 
4855
4869
    aliases = ['server']
4856
4870
 
4915
4929
 
4916
4930
 
4917
4931
class cmd_join(Command):
4918
 
    __doc__ = """Combine a tree into its containing tree.
 
4932
    """Combine a tree into its containing tree.
4919
4933
 
4920
4934
    This command requires the target tree to be in a rich-root format.
4921
4935
 
4961
4975
 
4962
4976
 
4963
4977
class cmd_split(Command):
4964
 
    __doc__ = """Split a subdirectory of a tree into a separate tree.
 
4978
    """Split a subdirectory of a tree into a separate tree.
4965
4979
 
4966
4980
    This command will produce a target tree in a format that supports
4967
4981
    rich roots, like 'rich-root' or 'rich-root-pack'.  These formats cannot be
4987
5001
 
4988
5002
 
4989
5003
class cmd_merge_directive(Command):
4990
 
    __doc__ = """Generate a merge directive for auto-merge tools.
 
5004
    """Generate a merge directive for auto-merge tools.
4991
5005
 
4992
5006
    A directive requests a merge to be performed, and also provides all the
4993
5007
    information necessary to do so.  This means it must either include a
5086
5100
 
5087
5101
 
5088
5102
class cmd_send(Command):
5089
 
    __doc__ = """Mail or create a merge-directive for submitting changes.
 
5103
    """Mail or create a merge-directive for submitting changes.
5090
5104
 
5091
5105
    A merge directive provides many things needed for requesting merges:
5092
5106
 
5203
5217
 
5204
5218
 
5205
5219
class cmd_bundle_revisions(cmd_send):
5206
 
    __doc__ = """Create a merge-directive for submitting changes.
 
5220
    """Create a merge-directive for submitting changes.
5207
5221
 
5208
5222
    A merge directive provides many things needed for requesting merges:
5209
5223
 
5276
5290
 
5277
5291
 
5278
5292
class cmd_tag(Command):
5279
 
    __doc__ = """Create, remove or modify a tag naming a revision.
 
5293
    """Create, remove or modify a tag naming a revision.
5280
5294
 
5281
5295
    Tags give human-meaningful names to revisions.  Commands that take a -r
5282
5296
    (--revision) option can be given -rtag:X, where X is any previously
5318
5332
            revision=None,
5319
5333
            ):
5320
5334
        branch, relpath = Branch.open_containing(directory)
5321
 
        self.add_cleanup(branch.lock_write().unlock)
 
5335
        branch.lock_write()
 
5336
        self.add_cleanup(branch.unlock)
5322
5337
        if delete:
5323
5338
            if tag_name is None:
5324
5339
                raise errors.BzrCommandError("No tag specified to delete.")
5345
5360
 
5346
5361
 
5347
5362
class cmd_tags(Command):
5348
 
    __doc__ = """List tags.
 
5363
    """List tags.
5349
5364
 
5350
5365
    This command shows a table of tag names and the revisions they reference.
5351
5366
    """
5376
5391
        if not tags:
5377
5392
            return
5378
5393
 
5379
 
        self.add_cleanup(branch.lock_read().unlock)
 
5394
        branch.lock_read()
 
5395
        self.add_cleanup(branch.unlock)
5380
5396
        if revision:
5381
5397
            graph = branch.repository.get_graph()
5382
5398
            rev1, rev2 = _get_revision_range(revision, branch, self.name())
5415
5431
 
5416
5432
 
5417
5433
class cmd_reconfigure(Command):
5418
 
    __doc__ = """Reconfigure the type of a bzr directory.
 
5434
    """Reconfigure the type of a bzr directory.
5419
5435
 
5420
5436
    A target configuration must be specified.
5421
5437
 
5506
5522
 
5507
5523
 
5508
5524
class cmd_switch(Command):
5509
 
    __doc__ = """Set the branch of a checkout and update.
 
5525
    """Set the branch of a checkout and update.
5510
5526
 
5511
5527
    For lightweight checkouts, this changes the branch being referenced.
5512
5528
    For heavyweight checkouts, this checks that there are no local commits
5602
5618
 
5603
5619
 
5604
5620
class cmd_view(Command):
5605
 
    __doc__ = """Manage filtered views.
 
5621
    """Manage filtered views.
5606
5622
 
5607
5623
    Views provide a mask over the tree so that users can focus on
5608
5624
    a subset of a tree when doing their work. After creating a view,
5756
5772
 
5757
5773
 
5758
5774
class cmd_hooks(Command):
5759
 
    __doc__ = """Show hooks."""
 
5775
    """Show hooks."""
5760
5776
 
5761
5777
    hidden = True
5762
5778
 
5776
5792
 
5777
5793
 
5778
5794
class cmd_remove_branch(Command):
5779
 
    __doc__ = """Remove a branch.
 
5795
    """Remove a branch.
5780
5796
 
5781
5797
    This will remove the branch from the specified location but 
5782
5798
    will keep any working tree or repository in place.
5801
5817
        
5802
5818
 
5803
5819
class cmd_shelve(Command):
5804
 
    __doc__ = """Temporarily set aside some changes from the current tree.
 
5820
    """Temporarily set aside some changes from the current tree.
5805
5821
 
5806
5822
    Shelve allows you to temporarily put changes you've made "on the shelf",
5807
5823
    ie. out of the way, until a later time when you can bring them back from
5860
5876
 
5861
5877
    def run_for_list(self):
5862
5878
        tree = WorkingTree.open_containing('.')[0]
5863
 
        self.add_cleanup(tree.lock_read().unlock)
 
5879
        tree.lock_read()
 
5880
        self.add_cleanup(tree.unlock)
5864
5881
        manager = tree.get_shelf_manager()
5865
5882
        shelves = manager.active_shelves()
5866
5883
        if len(shelves) == 0:
5875
5892
 
5876
5893
 
5877
5894
class cmd_unshelve(Command):
5878
 
    __doc__ = """Restore shelved changes.
 
5895
    """Restore shelved changes.
5879
5896
 
5880
5897
    By default, the most recently shelved changes are restored. However if you
5881
5898
    specify a shelf by id those changes will be restored instead.  This works
5907
5924
 
5908
5925
 
5909
5926
class cmd_clean_tree(Command):
5910
 
    __doc__ = """Remove unwanted files from working tree.
 
5927
    """Remove unwanted files from working tree.
5911
5928
 
5912
5929
    By default, only unknown files, not ignored files, are deleted.  Versioned
5913
5930
    files are never deleted.
5942
5959
 
5943
5960
 
5944
5961
class cmd_reference(Command):
5945
 
    __doc__ = """list, view and set branch locations for nested trees.
 
5962
    """list, view and set branch locations for nested trees.
5946
5963
 
5947
5964
    If no arguments are provided, lists the branch locations for nested trees.
5948
5965
    If one argument is provided, display the branch location for that tree.