~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/builtins.py

  • Committer: Martin Pool
  • Date: 2010-04-21 11:27:04 UTC
  • mto: This revision was merged to the branch mainline in revision 5189.
  • Revision ID: mbp@canonical.com-20100421112704-zijso22b6pdevrxy
Simplify various code to use user_url

Show diffs side-by-side

added added

removed removed

Lines of Context:
20
20
 
21
21
from bzrlib.lazy_import import lazy_import
22
22
lazy_import(globals(), """
 
23
import codecs
23
24
import cStringIO
24
25
import sys
25
26
import time
32
33
    bzrdir,
33
34
    directory_service,
34
35
    delta,
35
 
    config as _mod_config,
 
36
    config,
36
37
    errors,
37
38
    globbing,
38
39
    hooks,
74
75
from bzrlib.trace import mutter, note, warning, is_quiet, get_verbosity_level
75
76
 
76
77
 
77
 
@symbol_versioning.deprecated_function(symbol_versioning.deprecated_in((2, 3, 0)))
78
78
def tree_files(file_list, default_branch=u'.', canonicalize=True,
79
79
    apply_view=True):
80
 
    return internal_tree_files(file_list, default_branch, canonicalize,
81
 
        apply_view)
 
80
    try:
 
81
        return internal_tree_files(file_list, default_branch, canonicalize,
 
82
            apply_view)
 
83
    except errors.FileInWrongBranch, e:
 
84
        raise errors.BzrCommandError("%s is not in the same branch as %s" %
 
85
                                     (e.path, file_list[0]))
82
86
 
83
87
 
84
88
def tree_files_for_add(file_list):
148
152
 
149
153
# XXX: Bad function name; should possibly also be a class method of
150
154
# WorkingTree rather than a function.
151
 
@symbol_versioning.deprecated_function(symbol_versioning.deprecated_in((2, 3, 0)))
152
155
def internal_tree_files(file_list, default_branch=u'.', canonicalize=True,
153
156
    apply_view=True):
154
157
    """Convert command-line paths to a WorkingTree and relative paths.
155
158
 
156
 
    Deprecated: use WorkingTree.open_containing_paths instead.
157
 
 
158
159
    This is typically used for command-line processors that take one or
159
160
    more filenames, and infer the workingtree that contains them.
160
161
 
170
171
 
171
172
    :return: workingtree, [relative_paths]
172
173
    """
173
 
    return WorkingTree.open_containing_paths(
174
 
        file_list, default_directory='.',
175
 
        canonicalize=True,
176
 
        apply_view=True)
 
174
    if file_list is None or len(file_list) == 0:
 
175
        tree = WorkingTree.open_containing(default_branch)[0]
 
176
        if tree.supports_views() and apply_view:
 
177
            view_files = tree.views.lookup_view()
 
178
            if view_files:
 
179
                file_list = view_files
 
180
                view_str = views.view_display_str(view_files)
 
181
                note("Ignoring files outside view. View is %s" % view_str)
 
182
        return tree, file_list
 
183
    tree = WorkingTree.open_containing(osutils.realpath(file_list[0]))[0]
 
184
    return tree, safe_relpath_files(tree, file_list, canonicalize,
 
185
        apply_view=apply_view)
 
186
 
 
187
 
 
188
def safe_relpath_files(tree, file_list, canonicalize=True, apply_view=True):
 
189
    """Convert file_list into a list of relpaths in tree.
 
190
 
 
191
    :param tree: A tree to operate on.
 
192
    :param file_list: A list of user provided paths or None.
 
193
    :param apply_view: if True and a view is set, apply it or check that
 
194
        specified files are within it
 
195
    :return: A list of relative paths.
 
196
    :raises errors.PathNotChild: When a provided path is in a different tree
 
197
        than tree.
 
198
    """
 
199
    if file_list is None:
 
200
        return None
 
201
    if tree.supports_views() and apply_view:
 
202
        view_files = tree.views.lookup_view()
 
203
    else:
 
204
        view_files = []
 
205
    new_list = []
 
206
    # tree.relpath exists as a "thunk" to osutils, but canonical_relpath
 
207
    # doesn't - fix that up here before we enter the loop.
 
208
    if canonicalize:
 
209
        fixer = lambda p: osutils.canonical_relpath(tree.basedir, p)
 
210
    else:
 
211
        fixer = tree.relpath
 
212
    for filename in file_list:
 
213
        try:
 
214
            relpath = fixer(osutils.dereference_path(filename))
 
215
            if  view_files and not osutils.is_inside_any(view_files, relpath):
 
216
                raise errors.FileOutsideView(filename, view_files)
 
217
            new_list.append(relpath)
 
218
        except errors.PathNotChild:
 
219
            raise errors.FileInWrongBranch(tree.branch, filename)
 
220
    return new_list
177
221
 
178
222
 
179
223
def _get_view_info_for_change_reporter(tree):
188
232
    return view_info
189
233
 
190
234
 
191
 
def _open_directory_or_containing_tree_or_branch(filename, directory):
192
 
    """Open the tree or branch containing the specified file, unless
193
 
    the --directory option is used to specify a different branch."""
194
 
    if directory is not None:
195
 
        return (None, Branch.open(directory), filename)
196
 
    return bzrdir.BzrDir.open_containing_tree_or_branch(filename)
197
 
 
198
 
 
199
235
# TODO: Make sure no commands unconditionally use the working directory as a
200
236
# branch.  If a filename argument is used, the first of them should be used to
201
237
# specify the branch.  (Perhaps this can be factored out into some kind of
203
239
# opens the branch?)
204
240
 
205
241
class cmd_status(Command):
206
 
    __doc__ = """Display status summary.
 
242
    """Display status summary.
207
243
 
208
244
    This reports on versioned and unknown files, reporting them
209
245
    grouped by state.  Possible states are:
279
315
            raise errors.BzrCommandError('bzr status --revision takes exactly'
280
316
                                         ' one or two revision specifiers')
281
317
 
282
 
        tree, relfile_list = WorkingTree.open_containing_paths(file_list)
 
318
        tree, relfile_list = tree_files(file_list)
283
319
        # Avoid asking for specific files when that is not needed.
284
320
        if relfile_list == ['']:
285
321
            relfile_list = None
296
332
 
297
333
 
298
334
class cmd_cat_revision(Command):
299
 
    __doc__ = """Write out metadata for a revision.
 
335
    """Write out metadata for a revision.
300
336
 
301
337
    The revision to print can either be specified by a specific
302
338
    revision identifier, or you can use --revision.
304
340
 
305
341
    hidden = True
306
342
    takes_args = ['revision_id?']
307
 
    takes_options = ['directory', 'revision']
 
343
    takes_options = ['revision']
308
344
    # cat-revision is more for frontends so should be exact
309
345
    encoding = 'strict'
310
346
 
317
353
        self.outf.write(revtext.decode('utf-8'))
318
354
 
319
355
    @display_command
320
 
    def run(self, revision_id=None, revision=None, directory=u'.'):
 
356
    def run(self, revision_id=None, revision=None):
321
357
        if revision_id is not None and revision is not None:
322
358
            raise errors.BzrCommandError('You can only supply one of'
323
359
                                         ' revision_id or --revision')
324
360
        if revision_id is None and revision is None:
325
361
            raise errors.BzrCommandError('You must supply either'
326
362
                                         ' --revision or a revision_id')
327
 
        b = WorkingTree.open_containing(directory)[0].branch
 
363
        b = WorkingTree.open_containing(u'.')[0].branch
328
364
 
329
365
        revisions = b.repository.revisions
330
366
        if revisions is None:
354
390
        
355
391
 
356
392
class cmd_dump_btree(Command):
357
 
    __doc__ = """Dump the contents of a btree index file to stdout.
 
393
    """Dump the contents of a btree index file to stdout.
358
394
 
359
395
    PATH is a btree index file, it can be any URL. This includes things like
360
396
    .bzr/repository/pack-names, or .bzr/repository/indices/a34b3a...ca4a4.iix
435
471
 
436
472
 
437
473
class cmd_remove_tree(Command):
438
 
    __doc__ = """Remove the working tree from a given branch/checkout.
 
474
    """Remove the working tree from a given branch/checkout.
439
475
 
440
476
    Since a lightweight checkout is little more than a working tree
441
477
    this will refuse to run against one.
447
483
    takes_options = [
448
484
        Option('force',
449
485
               help='Remove the working tree even if it has '
450
 
                    'uncommitted or shelved changes.'),
 
486
                    'uncommitted changes.'),
451
487
        ]
452
488
 
453
489
    def run(self, location_list, force=False):
467
503
            if not force:
468
504
                if (working.has_changes()):
469
505
                    raise errors.UncommittedChanges(working)
470
 
                if working.get_shelf_manager().last_shelf() is not None:
471
 
                    raise errors.ShelvedChanges(working)
472
506
 
473
507
            if working.user_url != working.branch.user_url:
474
508
                raise errors.BzrCommandError("You cannot remove the working tree"
478
512
 
479
513
 
480
514
class cmd_revno(Command):
481
 
    __doc__ = """Show current revision number.
 
515
    """Show current revision number.
482
516
 
483
517
    This is equal to the number of revisions on this branch.
484
518
    """
494
528
        if tree:
495
529
            try:
496
530
                wt = WorkingTree.open_containing(location)[0]
497
 
                self.add_cleanup(wt.lock_read().unlock)
 
531
                wt.lock_read()
498
532
            except (errors.NoWorkingTree, errors.NotLocalUrl):
499
533
                raise errors.NoWorkingTree(location)
 
534
            self.add_cleanup(wt.unlock)
500
535
            revid = wt.last_revision()
501
536
            try:
502
537
                revno_t = wt.branch.revision_id_to_dotted_revno(revid)
505
540
            revno = ".".join(str(n) for n in revno_t)
506
541
        else:
507
542
            b = Branch.open_containing(location)[0]
508
 
            self.add_cleanup(b.lock_read().unlock)
 
543
            b.lock_read()
 
544
            self.add_cleanup(b.unlock)
509
545
            revno = b.revno()
510
546
        self.cleanup_now()
511
547
        self.outf.write(str(revno) + '\n')
512
548
 
513
549
 
514
550
class cmd_revision_info(Command):
515
 
    __doc__ = """Show revision number and revision id for a given revision identifier.
 
551
    """Show revision number and revision id for a given revision identifier.
516
552
    """
517
553
    hidden = True
518
554
    takes_args = ['revision_info*']
519
555
    takes_options = [
520
556
        'revision',
521
 
        custom_help('directory',
 
557
        Option('directory',
522
558
            help='Branch to examine, '
523
 
                 'rather than the one containing the working directory.'),
 
559
                 'rather than the one containing the working directory.',
 
560
            short_name='d',
 
561
            type=unicode,
 
562
            ),
524
563
        Option('tree', help='Show revno of working tree'),
525
564
        ]
526
565
 
531
570
        try:
532
571
            wt = WorkingTree.open_containing(directory)[0]
533
572
            b = wt.branch
534
 
            self.add_cleanup(wt.lock_read().unlock)
 
573
            wt.lock_read()
 
574
            self.add_cleanup(wt.unlock)
535
575
        except (errors.NoWorkingTree, errors.NotLocalUrl):
536
576
            wt = None
537
577
            b = Branch.open_containing(directory)[0]
538
 
            self.add_cleanup(b.lock_read().unlock)
 
578
            b.lock_read()
 
579
            self.add_cleanup(b.unlock)
539
580
        revision_ids = []
540
581
        if revision is not None:
541
582
            revision_ids.extend(rev.as_revision_id(b) for rev in revision)
569
610
 
570
611
 
571
612
class cmd_add(Command):
572
 
    __doc__ = """Add specified files or directories.
 
613
    """Add specified files or directories.
573
614
 
574
615
    In non-recursive mode, all the named items are added, regardless
575
616
    of whether they were previously ignored.  A warning is given if
640
681
                should_print=(not is_quiet()))
641
682
 
642
683
        if base_tree:
643
 
            self.add_cleanup(base_tree.lock_read().unlock)
 
684
            base_tree.lock_read()
 
685
            self.add_cleanup(base_tree.unlock)
644
686
        tree, file_list = tree_files_for_add(file_list)
645
687
        added, ignored = tree.smart_add(file_list, not
646
688
            no_recurse, action=action, save=not dry_run)
654
696
 
655
697
 
656
698
class cmd_mkdir(Command):
657
 
    __doc__ = """Create a new versioned directory.
 
699
    """Create a new versioned directory.
658
700
 
659
701
    This is equivalent to creating the directory and then adding it.
660
702
    """
676
718
 
677
719
 
678
720
class cmd_relpath(Command):
679
 
    __doc__ = """Show path of a file relative to root"""
 
721
    """Show path of a file relative to root"""
680
722
 
681
723
    takes_args = ['filename']
682
724
    hidden = True
691
733
 
692
734
 
693
735
class cmd_inventory(Command):
694
 
    __doc__ = """Show inventory of the current working copy or a revision.
 
736
    """Show inventory of the current working copy or a revision.
695
737
 
696
738
    It is possible to limit the output to a particular entry
697
739
    type using the --kind option.  For example: --kind file.
717
759
            raise errors.BzrCommandError('invalid kind %r specified' % (kind,))
718
760
 
719
761
        revision = _get_one_revision('inventory', revision)
720
 
        work_tree, file_list = WorkingTree.open_containing_paths(file_list)
721
 
        self.add_cleanup(work_tree.lock_read().unlock)
 
762
        work_tree, file_list = tree_files(file_list)
 
763
        work_tree.lock_read()
 
764
        self.add_cleanup(work_tree.unlock)
722
765
        if revision is not None:
723
766
            tree = revision.as_tree(work_tree.branch)
724
767
 
725
768
            extra_trees = [work_tree]
726
 
            self.add_cleanup(tree.lock_read().unlock)
 
769
            tree.lock_read()
 
770
            self.add_cleanup(tree.unlock)
727
771
        else:
728
772
            tree = work_tree
729
773
            extra_trees = []
750
794
 
751
795
 
752
796
class cmd_mv(Command):
753
 
    __doc__ = """Move or rename a file.
 
797
    """Move or rename a file.
754
798
 
755
799
    :Usage:
756
800
        bzr mv OLDNAME NEWNAME
788
832
            names_list = []
789
833
        if len(names_list) < 2:
790
834
            raise errors.BzrCommandError("missing file argument")
791
 
        tree, rel_names = WorkingTree.open_containing_paths(names_list, canonicalize=False)
792
 
        self.add_cleanup(tree.lock_tree_write().unlock)
 
835
        tree, rel_names = tree_files(names_list, canonicalize=False)
 
836
        tree.lock_tree_write()
 
837
        self.add_cleanup(tree.unlock)
793
838
        self._run(tree, names_list, rel_names, after)
794
839
 
795
840
    def run_auto(self, names_list, after, dry_run):
799
844
        if after:
800
845
            raise errors.BzrCommandError('--after cannot be specified with'
801
846
                                         ' --auto.')
802
 
        work_tree, file_list = WorkingTree.open_containing_paths(
803
 
            names_list, default_directory='.')
804
 
        self.add_cleanup(work_tree.lock_tree_write().unlock)
 
847
        work_tree, file_list = tree_files(names_list, default_branch='.')
 
848
        work_tree.lock_tree_write()
 
849
        self.add_cleanup(work_tree.unlock)
805
850
        rename_map.RenameMap.guess_renames(work_tree, dry_run)
806
851
 
807
852
    def _run(self, tree, names_list, rel_names, after):
886
931
 
887
932
 
888
933
class cmd_pull(Command):
889
 
    __doc__ = """Turn this branch into a mirror of another branch.
 
934
    """Turn this branch into a mirror of another branch.
890
935
 
891
936
    By default, this command only works on branches that have not diverged.
892
937
    Branches are considered diverged if the destination branch's most recent 
915
960
    takes_options = ['remember', 'overwrite', 'revision',
916
961
        custom_help('verbose',
917
962
            help='Show logs of pulled revisions.'),
918
 
        custom_help('directory',
 
963
        Option('directory',
919
964
            help='Branch to pull into, '
920
 
                 'rather than the one containing the working directory.'),
 
965
                 'rather than the one containing the working directory.',
 
966
            short_name='d',
 
967
            type=unicode,
 
968
            ),
921
969
        Option('local',
922
970
            help="Perform a local pull in a bound "
923
971
                 "branch.  Local pulls are not applied to "
938
986
        try:
939
987
            tree_to = WorkingTree.open_containing(directory)[0]
940
988
            branch_to = tree_to.branch
941
 
            self.add_cleanup(tree_to.lock_write().unlock)
 
989
            tree_to.lock_write()
 
990
            self.add_cleanup(tree_to.unlock)
942
991
        except errors.NoWorkingTree:
943
992
            tree_to = None
944
993
            branch_to = Branch.open_containing(directory)[0]
945
 
            self.add_cleanup(branch_to.lock_write().unlock)
 
994
            branch_to.lock_write()
 
995
            self.add_cleanup(branch_to.unlock)
946
996
 
947
997
        if local and not branch_to.get_bound_location():
948
998
            raise errors.LocalRequiresBoundBranch()
979
1029
        else:
980
1030
            branch_from = Branch.open(location,
981
1031
                possible_transports=possible_transports)
982
 
            self.add_cleanup(branch_from.lock_read().unlock)
 
1032
            branch_from.lock_read()
 
1033
            self.add_cleanup(branch_from.unlock)
983
1034
 
984
1035
            if branch_to.get_parent() is None or remember:
985
1036
                branch_to.set_parent(branch_from.base)
1007
1058
 
1008
1059
 
1009
1060
class cmd_push(Command):
1010
 
    __doc__ = """Update a mirror of this branch.
 
1061
    """Update a mirror of this branch.
1011
1062
 
1012
1063
    The target branch will not have its working tree populated because this
1013
1064
    is both expensive, and is not supported on remote file systems.
1037
1088
        Option('create-prefix',
1038
1089
               help='Create the path leading up to the branch '
1039
1090
                    'if it does not already exist.'),
1040
 
        custom_help('directory',
 
1091
        Option('directory',
1041
1092
            help='Branch to push from, '
1042
 
                 'rather than the one containing the working directory.'),
 
1093
                 'rather than the one containing the working directory.',
 
1094
            short_name='d',
 
1095
            type=unicode,
 
1096
            ),
1043
1097
        Option('use-existing-dir',
1044
1098
               help='By default push will fail if the target'
1045
1099
                    ' directory exists, but does not already'
1078
1132
        else:
1079
1133
            revision_id = None
1080
1134
        if tree is not None and revision_id is None:
1081
 
            tree.check_changed_or_out_of_date(
1082
 
                strict, 'push_strict',
1083
 
                more_error='Use --no-strict to force the push.',
1084
 
                more_warning='Uncommitted changes will not be pushed.')
 
1135
            tree.warn_if_changed_or_out_of_date(
 
1136
                strict, 'push_strict', 'Use --no-strict to force the push.')
1085
1137
        # Get the stacked_on branch, if any
1086
1138
        if stacked_on is not None:
1087
1139
            stacked_on = urlutils.normalize_url(stacked_on)
1119
1171
 
1120
1172
 
1121
1173
class cmd_branch(Command):
1122
 
    __doc__ = """Create a new branch that is a copy of an existing branch.
 
1174
    """Create a new branch that is a copy of an existing branch.
1123
1175
 
1124
1176
    If the TO_LOCATION is omitted, the last component of the FROM_LOCATION will
1125
1177
    be used.  In other words, "branch ../foo/bar" will attempt to create ./bar.
1134
1186
 
1135
1187
    _see_also = ['checkout']
1136
1188
    takes_args = ['from_location', 'to_location?']
1137
 
    takes_options = ['revision',
1138
 
        Option('hardlink', help='Hard-link working tree files where possible.'),
1139
 
        Option('files-from', type=str,
1140
 
               help="Get file contents from this tree."),
 
1189
    takes_options = ['revision', Option('hardlink',
 
1190
        help='Hard-link working tree files where possible.'),
1141
1191
        Option('no-tree',
1142
1192
            help="Create a branch without a working-tree."),
1143
1193
        Option('switch',
1161
1211
 
1162
1212
    def run(self, from_location, to_location=None, revision=None,
1163
1213
            hardlink=False, stacked=False, standalone=False, no_tree=False,
1164
 
            use_existing_dir=False, switch=False, bind=False,
1165
 
            files_from=None):
 
1214
            use_existing_dir=False, switch=False, bind=False):
1166
1215
        from bzrlib import switch as _mod_switch
1167
1216
        from bzrlib.tag import _merge_tags_if_possible
1168
1217
        accelerator_tree, br_from = bzrdir.BzrDir.open_tree_or_branch(
1169
1218
            from_location)
1170
 
        if not (hardlink or files_from):
1171
 
            # accelerator_tree is usually slower because you have to read N
1172
 
            # files (no readahead, lots of seeks, etc), but allow the user to
1173
 
            # explicitly request it
1174
 
            accelerator_tree = None
1175
 
        if files_from is not None and files_from != from_location:
1176
 
            accelerator_tree = WorkingTree.open(files_from)
1177
1219
        revision = _get_one_revision('branch', revision)
1178
 
        self.add_cleanup(br_from.lock_read().unlock)
 
1220
        br_from.lock_read()
 
1221
        self.add_cleanup(br_from.unlock)
1179
1222
        if revision is not None:
1180
1223
            revision_id = revision.as_revision_id(br_from)
1181
1224
        else:
1241
1284
 
1242
1285
 
1243
1286
class cmd_checkout(Command):
1244
 
    __doc__ = """Create a new checkout of an existing branch.
 
1287
    """Create a new checkout of an existing branch.
1245
1288
 
1246
1289
    If BRANCH_LOCATION is omitted, checkout will reconstitute a working tree for
1247
1290
    the branch found in '.'. This is useful if you have removed the working tree
1286
1329
            to_location = branch_location
1287
1330
        accelerator_tree, source = bzrdir.BzrDir.open_tree_or_branch(
1288
1331
            branch_location)
1289
 
        if not (hardlink or files_from):
1290
 
            # accelerator_tree is usually slower because you have to read N
1291
 
            # files (no readahead, lots of seeks, etc), but allow the user to
1292
 
            # explicitly request it
1293
 
            accelerator_tree = None
1294
1332
        revision = _get_one_revision('checkout', revision)
1295
 
        if files_from is not None and files_from != branch_location:
 
1333
        if files_from is not None:
1296
1334
            accelerator_tree = WorkingTree.open(files_from)
1297
1335
        if revision is not None:
1298
1336
            revision_id = revision.as_revision_id(source)
1315
1353
 
1316
1354
 
1317
1355
class cmd_renames(Command):
1318
 
    __doc__ = """Show list of renamed files.
 
1356
    """Show list of renamed files.
1319
1357
    """
1320
1358
    # TODO: Option to show renames between two historical versions.
1321
1359
 
1326
1364
    @display_command
1327
1365
    def run(self, dir=u'.'):
1328
1366
        tree = WorkingTree.open_containing(dir)[0]
1329
 
        self.add_cleanup(tree.lock_read().unlock)
 
1367
        tree.lock_read()
 
1368
        self.add_cleanup(tree.unlock)
1330
1369
        new_inv = tree.inventory
1331
1370
        old_tree = tree.basis_tree()
1332
 
        self.add_cleanup(old_tree.lock_read().unlock)
 
1371
        old_tree.lock_read()
 
1372
        self.add_cleanup(old_tree.unlock)
1333
1373
        old_inv = old_tree.inventory
1334
1374
        renames = []
1335
1375
        iterator = tree.iter_changes(old_tree, include_unchanged=True)
1345
1385
 
1346
1386
 
1347
1387
class cmd_update(Command):
1348
 
    __doc__ = """Update a tree to have the latest code committed to its branch.
 
1388
    """Update a tree to have the latest code committed to its branch.
1349
1389
 
1350
1390
    This will perform a merge into the working tree, and may generate
1351
1391
    conflicts. If you have any local changes, you will still
1373
1413
        master = branch.get_master_branch(
1374
1414
            possible_transports=possible_transports)
1375
1415
        if master is not None:
 
1416
            tree.lock_write()
1376
1417
            branch_location = master.base
1377
 
            tree.lock_write()
1378
1418
        else:
 
1419
            tree.lock_tree_write()
1379
1420
            branch_location = tree.branch.base
1380
 
            tree.lock_tree_write()
1381
1421
        self.add_cleanup(tree.unlock)
1382
1422
        # get rid of the final '/' and be ready for display
1383
1423
        branch_location = urlutils.unescape_for_display(
1431
1471
 
1432
1472
 
1433
1473
class cmd_info(Command):
1434
 
    __doc__ = """Show information about a working tree, branch or repository.
 
1474
    """Show information about a working tree, branch or repository.
1435
1475
 
1436
1476
    This command will show all known locations and formats associated to the
1437
1477
    tree, branch or repository.
1475
1515
 
1476
1516
 
1477
1517
class cmd_remove(Command):
1478
 
    __doc__ = """Remove files or directories.
 
1518
    """Remove files or directories.
1479
1519
 
1480
 
    This makes Bazaar stop tracking changes to the specified files. Bazaar will
1481
 
    delete them if they can easily be recovered using revert otherwise they
1482
 
    will be backed up (adding an extention of the form .~#~). If no options or
1483
 
    parameters are given Bazaar will scan for files that are being tracked by
1484
 
    Bazaar but missing in your tree and stop tracking them for you.
 
1520
    This makes bzr stop tracking changes to the specified files. bzr will delete
 
1521
    them if they can easily be recovered using revert. If no options or
 
1522
    parameters are given bzr will scan for files that are being tracked by bzr
 
1523
    but missing in your tree and stop tracking them for you.
1485
1524
    """
1486
1525
    takes_args = ['file*']
1487
1526
    takes_options = ['verbose',
1489
1528
        RegistryOption.from_kwargs('file-deletion-strategy',
1490
1529
            'The file deletion mode to be used.',
1491
1530
            title='Deletion Strategy', value_switches=True, enum_switch=False,
1492
 
            safe='Backup changed files (default).',
 
1531
            safe='Only delete files if they can be'
 
1532
                 ' safely recovered (default).',
1493
1533
            keep='Delete from bzr but leave the working copy.',
1494
1534
            force='Delete all the specified files, even if they can not be '
1495
1535
                'recovered and even if they are non-empty directories.')]
1498
1538
 
1499
1539
    def run(self, file_list, verbose=False, new=False,
1500
1540
        file_deletion_strategy='safe'):
1501
 
        tree, file_list = WorkingTree.open_containing_paths(file_list)
 
1541
        tree, file_list = tree_files(file_list)
1502
1542
 
1503
1543
        if file_list is not None:
1504
1544
            file_list = [f for f in file_list]
1505
1545
 
1506
 
        self.add_cleanup(tree.lock_write().unlock)
 
1546
        tree.lock_write()
 
1547
        self.add_cleanup(tree.unlock)
1507
1548
        # Heuristics should probably all move into tree.remove_smart or
1508
1549
        # some such?
1509
1550
        if new:
1528
1569
 
1529
1570
 
1530
1571
class cmd_file_id(Command):
1531
 
    __doc__ = """Print file_id of a particular file or directory.
 
1572
    """Print file_id of a particular file or directory.
1532
1573
 
1533
1574
    The file_id is assigned when the file is first added and remains the
1534
1575
    same through all revisions where the file exists, even when it is
1550
1591
 
1551
1592
 
1552
1593
class cmd_file_path(Command):
1553
 
    __doc__ = """Print path of file_ids to a file or directory.
 
1594
    """Print path of file_ids to a file or directory.
1554
1595
 
1555
1596
    This prints one line for each directory down to the target,
1556
1597
    starting at the branch root.
1572
1613
 
1573
1614
 
1574
1615
class cmd_reconcile(Command):
1575
 
    __doc__ = """Reconcile bzr metadata in a branch.
 
1616
    """Reconcile bzr metadata in a branch.
1576
1617
 
1577
1618
    This can correct data mismatches that may have been caused by
1578
1619
    previous ghost operations or bzr upgrades. You should only
1592
1633
 
1593
1634
    _see_also = ['check']
1594
1635
    takes_args = ['branch?']
1595
 
    takes_options = [
1596
 
        Option('canonicalize-chks',
1597
 
               help='Make sure CHKs are in canonical form (repairs '
1598
 
                    'bug 522637).',
1599
 
               hidden=True),
1600
 
        ]
1601
1636
 
1602
 
    def run(self, branch=".", canonicalize_chks=False):
 
1637
    def run(self, branch="."):
1603
1638
        from bzrlib.reconcile import reconcile
1604
1639
        dir = bzrdir.BzrDir.open(branch)
1605
 
        reconcile(dir, canonicalize_chks=canonicalize_chks)
 
1640
        reconcile(dir)
1606
1641
 
1607
1642
 
1608
1643
class cmd_revision_history(Command):
1609
 
    __doc__ = """Display the list of revision ids on a branch."""
 
1644
    """Display the list of revision ids on a branch."""
1610
1645
 
1611
1646
    _see_also = ['log']
1612
1647
    takes_args = ['location?']
1622
1657
 
1623
1658
 
1624
1659
class cmd_ancestry(Command):
1625
 
    __doc__ = """List all revisions merged into this branch."""
 
1660
    """List all revisions merged into this branch."""
1626
1661
 
1627
1662
    _see_also = ['log', 'revision-history']
1628
1663
    takes_args = ['location?']
1647
1682
 
1648
1683
 
1649
1684
class cmd_init(Command):
1650
 
    __doc__ = """Make a directory into a versioned branch.
 
1685
    """Make a directory into a versioned branch.
1651
1686
 
1652
1687
    Use this to create an empty branch, or before importing an
1653
1688
    existing project.
1756
1791
 
1757
1792
 
1758
1793
class cmd_init_repository(Command):
1759
 
    __doc__ = """Create a shared repository for branches to share storage space.
 
1794
    """Create a shared repository for branches to share storage space.
1760
1795
 
1761
1796
    New branches created under the repository directory will store their
1762
1797
    revisions in the repository, not in the branch directory.  For branches
1816
1851
 
1817
1852
 
1818
1853
class cmd_diff(Command):
1819
 
    __doc__ = """Show differences in the working tree, between revisions or branches.
 
1854
    """Show differences in the working tree, between revisions or branches.
1820
1855
 
1821
1856
    If no arguments are given, all changes for the current tree are listed.
1822
1857
    If files are given, only the changes in those files are listed.
1884
1919
        Same as 'bzr diff' but prefix paths with old/ and new/::
1885
1920
 
1886
1921
            bzr diff --prefix old/:new/
1887
 
            
1888
 
        Show the differences using a custom diff program with options::
1889
 
        
1890
 
            bzr diff --using /usr/bin/diff --diff-options -wu
1891
1922
    """
1892
1923
    _see_also = ['status']
1893
1924
    takes_args = ['file*']
1952
1983
         old_branch, new_branch,
1953
1984
         specific_files, extra_trees) = get_trees_and_branches_to_diff_locked(
1954
1985
            file_list, revision, old, new, self.add_cleanup, apply_view=True)
1955
 
        # GNU diff on Windows uses ANSI encoding for filenames
1956
 
        path_encoding = osutils.get_diff_header_encoding()
1957
1986
        return show_diff_trees(old_tree, new_tree, sys.stdout,
1958
1987
                               specific_files=specific_files,
1959
1988
                               external_diff_options=diff_options,
1960
1989
                               old_label=old_label, new_label=new_label,
1961
 
                               extra_trees=extra_trees,
1962
 
                               path_encoding=path_encoding,
1963
 
                               using=using,
 
1990
                               extra_trees=extra_trees, using=using,
1964
1991
                               format_cls=format)
1965
1992
 
1966
1993
 
1967
1994
class cmd_deleted(Command):
1968
 
    __doc__ = """List files deleted in the working tree.
 
1995
    """List files deleted in the working tree.
1969
1996
    """
1970
1997
    # TODO: Show files deleted since a previous revision, or
1971
1998
    # between two revisions.
1974
2001
    # level of effort but possibly much less IO.  (Or possibly not,
1975
2002
    # if the directories are very large...)
1976
2003
    _see_also = ['status', 'ls']
1977
 
    takes_options = ['directory', 'show-ids']
 
2004
    takes_options = ['show-ids']
1978
2005
 
1979
2006
    @display_command
1980
 
    def run(self, show_ids=False, directory=u'.'):
1981
 
        tree = WorkingTree.open_containing(directory)[0]
1982
 
        self.add_cleanup(tree.lock_read().unlock)
 
2007
    def run(self, show_ids=False):
 
2008
        tree = WorkingTree.open_containing(u'.')[0]
 
2009
        tree.lock_read()
 
2010
        self.add_cleanup(tree.unlock)
1983
2011
        old = tree.basis_tree()
1984
 
        self.add_cleanup(old.lock_read().unlock)
 
2012
        old.lock_read()
 
2013
        self.add_cleanup(old.unlock)
1985
2014
        for path, ie in old.inventory.iter_entries():
1986
2015
            if not tree.has_id(ie.file_id):
1987
2016
                self.outf.write(path)
1992
2021
 
1993
2022
 
1994
2023
class cmd_modified(Command):
1995
 
    __doc__ = """List files modified in working tree.
 
2024
    """List files modified in working tree.
1996
2025
    """
1997
2026
 
1998
2027
    hidden = True
1999
2028
    _see_also = ['status', 'ls']
2000
 
    takes_options = ['directory', 'null']
 
2029
    takes_options = [
 
2030
            Option('null',
 
2031
                   help='Write an ascii NUL (\\0) separator '
 
2032
                   'between files rather than a newline.')
 
2033
            ]
2001
2034
 
2002
2035
    @display_command
2003
 
    def run(self, null=False, directory=u'.'):
2004
 
        tree = WorkingTree.open_containing(directory)[0]
 
2036
    def run(self, null=False):
 
2037
        tree = WorkingTree.open_containing(u'.')[0]
2005
2038
        td = tree.changes_from(tree.basis_tree())
2006
2039
        for path, id, kind, text_modified, meta_modified in td.modified:
2007
2040
            if null:
2011
2044
 
2012
2045
 
2013
2046
class cmd_added(Command):
2014
 
    __doc__ = """List files added in working tree.
 
2047
    """List files added in working tree.
2015
2048
    """
2016
2049
 
2017
2050
    hidden = True
2018
2051
    _see_also = ['status', 'ls']
2019
 
    takes_options = ['directory', 'null']
 
2052
    takes_options = [
 
2053
            Option('null',
 
2054
                   help='Write an ascii NUL (\\0) separator '
 
2055
                   'between files rather than a newline.')
 
2056
            ]
2020
2057
 
2021
2058
    @display_command
2022
 
    def run(self, null=False, directory=u'.'):
2023
 
        wt = WorkingTree.open_containing(directory)[0]
2024
 
        self.add_cleanup(wt.lock_read().unlock)
 
2059
    def run(self, null=False):
 
2060
        wt = WorkingTree.open_containing(u'.')[0]
 
2061
        wt.lock_read()
 
2062
        self.add_cleanup(wt.unlock)
2025
2063
        basis = wt.basis_tree()
2026
 
        self.add_cleanup(basis.lock_read().unlock)
 
2064
        basis.lock_read()
 
2065
        self.add_cleanup(basis.unlock)
2027
2066
        basis_inv = basis.inventory
2028
2067
        inv = wt.inventory
2029
2068
        for file_id in inv:
2032
2071
            if inv.is_root(file_id) and len(basis_inv) == 0:
2033
2072
                continue
2034
2073
            path = inv.id2path(file_id)
2035
 
            if not os.access(osutils.pathjoin(wt.basedir, path), os.F_OK):
 
2074
            if not os.access(osutils.abspath(path), os.F_OK):
2036
2075
                continue
2037
2076
            if null:
2038
2077
                self.outf.write(path + '\0')
2041
2080
 
2042
2081
 
2043
2082
class cmd_root(Command):
2044
 
    __doc__ = """Show the tree root directory.
 
2083
    """Show the tree root directory.
2045
2084
 
2046
2085
    The root is the nearest enclosing directory with a .bzr control
2047
2086
    directory."""
2071
2110
 
2072
2111
 
2073
2112
class cmd_log(Command):
2074
 
    __doc__ = """Show historical log for a branch or subset of a branch.
 
2113
    """Show historical log for a branch or subset of a branch.
2075
2114
 
2076
2115
    log is bzr's default tool for exploring the history of a branch.
2077
2116
    The branch to use is taken from the first parameter. If no parameters
2238
2277
                   help='Show just the specified revision.'
2239
2278
                   ' See also "help revisionspec".'),
2240
2279
            'log-format',
2241
 
            RegistryOption('authors',
2242
 
                'What names to list as authors - first, all or committer.',
2243
 
                title='Authors',
2244
 
                lazy_registry=('bzrlib.log', 'author_list_registry'),
2245
 
            ),
2246
2280
            Option('levels',
2247
2281
                   short_name='n',
2248
2282
                   help='Number of levels to display - 0 for all, 1 for flat.',
2263
2297
                   help='Show changes made in each revision as a patch.'),
2264
2298
            Option('include-merges',
2265
2299
                   help='Show merged revisions like --levels 0 does.'),
2266
 
            Option('exclude-common-ancestry',
2267
 
                   help='Display only the revisions that are not part'
2268
 
                   ' of both ancestries (require -rX..Y)'
2269
 
                   )
2270
2300
            ]
2271
2301
    encoding_type = 'replace'
2272
2302
 
2282
2312
            message=None,
2283
2313
            limit=None,
2284
2314
            show_diff=False,
2285
 
            include_merges=False,
2286
 
            authors=None,
2287
 
            exclude_common_ancestry=False,
2288
 
            ):
 
2315
            include_merges=False):
2289
2316
        from bzrlib.log import (
2290
2317
            Logger,
2291
2318
            make_log_request_dict,
2292
2319
            _get_info_for_log_files,
2293
2320
            )
2294
2321
        direction = (forward and 'forward') or 'reverse'
2295
 
        if (exclude_common_ancestry
2296
 
            and (revision is None or len(revision) != 2)):
2297
 
            raise errors.BzrCommandError(
2298
 
                '--exclude-common-ancestry requires -r with two revisions')
2299
2322
        if include_merges:
2300
2323
            if levels is None:
2301
2324
                levels = 0
2317
2340
        if file_list:
2318
2341
            # find the file ids to log and check for directory filtering
2319
2342
            b, file_info_list, rev1, rev2 = _get_info_for_log_files(
2320
 
                revision, file_list, self.add_cleanup)
 
2343
                revision, file_list)
 
2344
            self.add_cleanup(b.unlock)
2321
2345
            for relpath, file_id, kind in file_info_list:
2322
2346
                if file_id is None:
2323
2347
                    raise errors.BzrCommandError(
2341
2365
                location = '.'
2342
2366
            dir, relpath = bzrdir.BzrDir.open_containing(location)
2343
2367
            b = dir.open_branch()
2344
 
            self.add_cleanup(b.lock_read().unlock)
 
2368
            b.lock_read()
 
2369
            self.add_cleanup(b.unlock)
2345
2370
            rev1, rev2 = _get_revision_range(revision, b, self.name())
2346
2371
 
2347
2372
        # Decide on the type of delta & diff filtering to use
2367
2392
                        show_timezone=timezone,
2368
2393
                        delta_format=get_verbosity_level(),
2369
2394
                        levels=levels,
2370
 
                        show_advice=levels is None,
2371
 
                        author_list_handler=authors)
 
2395
                        show_advice=levels is None)
2372
2396
 
2373
2397
        # Choose the algorithm for doing the logging. It's annoying
2374
2398
        # having multiple code paths like this but necessary until
2393
2417
            direction=direction, specific_fileids=file_ids,
2394
2418
            start_revision=rev1, end_revision=rev2, limit=limit,
2395
2419
            message_search=message, delta_type=delta_type,
2396
 
            diff_type=diff_type, _match_using_deltas=match_using_deltas,
2397
 
            exclude_common_ancestry=exclude_common_ancestry,
2398
 
            )
 
2420
            diff_type=diff_type, _match_using_deltas=match_using_deltas)
2399
2421
        Logger(b, rqst).show(lf)
2400
2422
 
2401
2423
 
2459
2481
 
2460
2482
 
2461
2483
class cmd_touching_revisions(Command):
2462
 
    __doc__ = """Return revision-ids which affected a particular file.
 
2484
    """Return revision-ids which affected a particular file.
2463
2485
 
2464
2486
    A more user-friendly interface is "bzr log FILE".
2465
2487
    """
2472
2494
        tree, relpath = WorkingTree.open_containing(filename)
2473
2495
        file_id = tree.path2id(relpath)
2474
2496
        b = tree.branch
2475
 
        self.add_cleanup(b.lock_read().unlock)
 
2497
        b.lock_read()
 
2498
        self.add_cleanup(b.unlock)
2476
2499
        touching_revs = log.find_touching_revisions(b, file_id)
2477
2500
        for revno, revision_id, what in touching_revs:
2478
2501
            self.outf.write("%6d %s\n" % (revno, what))
2479
2502
 
2480
2503
 
2481
2504
class cmd_ls(Command):
2482
 
    __doc__ = """List files in a tree.
 
2505
    """List files in a tree.
2483
2506
    """
2484
2507
 
2485
2508
    _see_also = ['status', 'cat']
2491
2514
                   help='Recurse into subdirectories.'),
2492
2515
            Option('from-root',
2493
2516
                   help='Print paths relative to the root of the branch.'),
2494
 
            Option('unknown', short_name='u',
2495
 
                help='Print unknown files.'),
 
2517
            Option('unknown', help='Print unknown files.'),
2496
2518
            Option('versioned', help='Print versioned files.',
2497
2519
                   short_name='V'),
2498
 
            Option('ignored', short_name='i',
2499
 
                help='Print ignored files.'),
2500
 
            Option('kind', short_name='k',
 
2520
            Option('ignored', help='Print ignored files.'),
 
2521
            Option('null',
 
2522
                   help='Write an ascii NUL (\\0) separator '
 
2523
                   'between files rather than a newline.'),
 
2524
            Option('kind',
2501
2525
                   help='List entries of a particular kind: file, directory, symlink.',
2502
2526
                   type=unicode),
2503
 
            'null',
2504
2527
            'show-ids',
2505
 
            'directory',
2506
2528
            ]
2507
2529
    @display_command
2508
2530
    def run(self, revision=None, verbose=False,
2509
2531
            recursive=False, from_root=False,
2510
2532
            unknown=False, versioned=False, ignored=False,
2511
 
            null=False, kind=None, show_ids=False, path=None, directory=None):
 
2533
            null=False, kind=None, show_ids=False, path=None):
2512
2534
 
2513
2535
        if kind and kind not in ('file', 'directory', 'symlink'):
2514
2536
            raise errors.BzrCommandError('invalid kind specified')
2526
2548
                raise errors.BzrCommandError('cannot specify both --from-root'
2527
2549
                                             ' and PATH')
2528
2550
            fs_path = path
2529
 
        tree, branch, relpath = \
2530
 
            _open_directory_or_containing_tree_or_branch(fs_path, directory)
 
2551
        tree, branch, relpath = bzrdir.BzrDir.open_containing_tree_or_branch(
 
2552
            fs_path)
2531
2553
 
2532
2554
        # Calculate the prefix to use
2533
2555
        prefix = None
2548
2570
                view_str = views.view_display_str(view_files)
2549
2571
                note("Ignoring files outside view. View is %s" % view_str)
2550
2572
 
2551
 
        self.add_cleanup(tree.lock_read().unlock)
 
2573
        tree.lock_read()
 
2574
        self.add_cleanup(tree.unlock)
2552
2575
        for fp, fc, fkind, fid, entry in tree.list_files(include_root=False,
2553
2576
            from_dir=relpath, recursive=recursive):
2554
2577
            # Apply additional masking
2596
2619
 
2597
2620
 
2598
2621
class cmd_unknowns(Command):
2599
 
    __doc__ = """List unknown files.
 
2622
    """List unknown files.
2600
2623
    """
2601
2624
 
2602
2625
    hidden = True
2603
2626
    _see_also = ['ls']
2604
 
    takes_options = ['directory']
2605
2627
 
2606
2628
    @display_command
2607
 
    def run(self, directory=u'.'):
2608
 
        for f in WorkingTree.open_containing(directory)[0].unknowns():
 
2629
    def run(self):
 
2630
        for f in WorkingTree.open_containing(u'.')[0].unknowns():
2609
2631
            self.outf.write(osutils.quotefn(f) + '\n')
2610
2632
 
2611
2633
 
2612
2634
class cmd_ignore(Command):
2613
 
    __doc__ = """Ignore specified files or patterns.
 
2635
    """Ignore specified files or patterns.
2614
2636
 
2615
2637
    See ``bzr help patterns`` for details on the syntax of patterns.
2616
2638
 
2625
2647
    using this command or directly by using an editor, be sure to commit
2626
2648
    it.
2627
2649
    
2628
 
    Bazaar also supports a global ignore file ~/.bazaar/ignore. On Windows
2629
 
    the global ignore file can be found in the application data directory as
2630
 
    C:\\Documents and Settings\\<user>\\Application Data\\Bazaar\\2.0\\ignore.
2631
 
    Global ignores are not touched by this command. The global ignore file
2632
 
    can be edited directly using an editor.
2633
 
 
2634
2650
    Patterns prefixed with '!' are exceptions to ignore patterns and take
2635
2651
    precedence over regular ignores.  Such exceptions are used to specify
2636
2652
    files that should be versioned which would otherwise be ignored.
2676
2692
 
2677
2693
    _see_also = ['status', 'ignored', 'patterns']
2678
2694
    takes_args = ['name_pattern*']
2679
 
    takes_options = ['directory',
2680
 
        Option('default-rules',
2681
 
               help='Display the default ignore rules that bzr uses.')
 
2695
    takes_options = [
 
2696
        Option('old-default-rules',
 
2697
               help='Write out the ignore rules bzr < 0.9 always used.')
2682
2698
        ]
2683
2699
 
2684
 
    def run(self, name_pattern_list=None, default_rules=None,
2685
 
            directory=u'.'):
 
2700
    def run(self, name_pattern_list=None, old_default_rules=None):
2686
2701
        from bzrlib import ignores
2687
 
        if default_rules is not None:
2688
 
            # dump the default rules and exit
2689
 
            for pattern in ignores.USER_DEFAULTS:
 
2702
        if old_default_rules is not None:
 
2703
            # dump the rules and exit
 
2704
            for pattern in ignores.OLD_DEFAULTS:
2690
2705
                self.outf.write("%s\n" % pattern)
2691
2706
            return
2692
2707
        if not name_pattern_list:
2693
2708
            raise errors.BzrCommandError("ignore requires at least one "
2694
 
                "NAME_PATTERN or --default-rules.")
 
2709
                                  "NAME_PATTERN or --old-default-rules")
2695
2710
        name_pattern_list = [globbing.normalize_pattern(p)
2696
2711
                             for p in name_pattern_list]
2697
 
        bad_patterns = ''
2698
 
        for p in name_pattern_list:
2699
 
            if not globbing.Globster.is_pattern_valid(p):
2700
 
                bad_patterns += ('\n  %s' % p)
2701
 
        if bad_patterns:
2702
 
            msg = ('Invalid ignore pattern(s) found. %s' % bad_patterns)
2703
 
            ui.ui_factory.show_error(msg)
2704
 
            raise errors.InvalidPattern('')
2705
2712
        for name_pattern in name_pattern_list:
2706
2713
            if (name_pattern[0] == '/' or
2707
2714
                (len(name_pattern) > 1 and name_pattern[1] == ':')):
2708
2715
                raise errors.BzrCommandError(
2709
2716
                    "NAME_PATTERN should not be an absolute path")
2710
 
        tree, relpath = WorkingTree.open_containing(directory)
 
2717
        tree, relpath = WorkingTree.open_containing(u'.')
2711
2718
        ignores.tree_ignores_add_patterns(tree, name_pattern_list)
2712
2719
        ignored = globbing.Globster(name_pattern_list)
2713
2720
        matches = []
2714
 
        self.add_cleanup(tree.lock_read().unlock)
 
2721
        tree.lock_read()
2715
2722
        for entry in tree.list_files():
2716
2723
            id = entry[3]
2717
2724
            if id is not None:
2718
2725
                filename = entry[0]
2719
2726
                if ignored.match(filename):
2720
2727
                    matches.append(filename)
 
2728
        tree.unlock()
2721
2729
        if len(matches) > 0:
2722
2730
            self.outf.write("Warning: the following files are version controlled and"
2723
2731
                  " match your ignore pattern:\n%s"
2726
2734
 
2727
2735
 
2728
2736
class cmd_ignored(Command):
2729
 
    __doc__ = """List ignored files and the patterns that matched them.
 
2737
    """List ignored files and the patterns that matched them.
2730
2738
 
2731
2739
    List all the ignored files and the ignore pattern that caused the file to
2732
2740
    be ignored.
2738
2746
 
2739
2747
    encoding_type = 'replace'
2740
2748
    _see_also = ['ignore', 'ls']
2741
 
    takes_options = ['directory']
2742
2749
 
2743
2750
    @display_command
2744
 
    def run(self, directory=u'.'):
2745
 
        tree = WorkingTree.open_containing(directory)[0]
2746
 
        self.add_cleanup(tree.lock_read().unlock)
 
2751
    def run(self):
 
2752
        tree = WorkingTree.open_containing(u'.')[0]
 
2753
        tree.lock_read()
 
2754
        self.add_cleanup(tree.unlock)
2747
2755
        for path, file_class, kind, file_id, entry in tree.list_files():
2748
2756
            if file_class != 'I':
2749
2757
                continue
2753
2761
 
2754
2762
 
2755
2763
class cmd_lookup_revision(Command):
2756
 
    __doc__ = """Lookup the revision-id from a revision-number
 
2764
    """Lookup the revision-id from a revision-number
2757
2765
 
2758
2766
    :Examples:
2759
2767
        bzr lookup-revision 33
2760
2768
    """
2761
2769
    hidden = True
2762
2770
    takes_args = ['revno']
2763
 
    takes_options = ['directory']
2764
2771
 
2765
2772
    @display_command
2766
 
    def run(self, revno, directory=u'.'):
 
2773
    def run(self, revno):
2767
2774
        try:
2768
2775
            revno = int(revno)
2769
2776
        except ValueError:
2770
2777
            raise errors.BzrCommandError("not a valid revision-number: %r"
2771
2778
                                         % revno)
2772
 
        revid = WorkingTree.open_containing(directory)[0].branch.get_rev_id(revno)
 
2779
        revid = WorkingTree.open_containing(u'.')[0].branch.get_rev_id(revno)
2773
2780
        self.outf.write("%s\n" % revid)
2774
2781
 
2775
2782
 
2776
2783
class cmd_export(Command):
2777
 
    __doc__ = """Export current or past revision to a destination directory or archive.
 
2784
    """Export current or past revision to a destination directory or archive.
2778
2785
 
2779
2786
    If no revision is specified this exports the last committed revision.
2780
2787
 
2802
2809
      =================       =========================
2803
2810
    """
2804
2811
    takes_args = ['dest', 'branch_or_subdir?']
2805
 
    takes_options = ['directory',
 
2812
    takes_options = [
2806
2813
        Option('format',
2807
2814
               help="Type of file to export to.",
2808
2815
               type=unicode),
2817
2824
                    'revision in which it was changed.'),
2818
2825
        ]
2819
2826
    def run(self, dest, branch_or_subdir=None, revision=None, format=None,
2820
 
        root=None, filters=False, per_file_timestamps=False, directory=u'.'):
 
2827
        root=None, filters=False, per_file_timestamps=False):
2821
2828
        from bzrlib.export import export
2822
2829
 
2823
2830
        if branch_or_subdir is None:
2824
 
            tree = WorkingTree.open_containing(directory)[0]
 
2831
            tree = WorkingTree.open_containing(u'.')[0]
2825
2832
            b = tree.branch
2826
2833
            subdir = None
2827
2834
        else:
2837
2844
 
2838
2845
 
2839
2846
class cmd_cat(Command):
2840
 
    __doc__ = """Write the contents of a file as of a given revision to standard output.
 
2847
    """Write the contents of a file as of a given revision to standard output.
2841
2848
 
2842
2849
    If no revision is nominated, the last revision is used.
2843
2850
 
2846
2853
    """
2847
2854
 
2848
2855
    _see_also = ['ls']
2849
 
    takes_options = ['directory',
 
2856
    takes_options = [
2850
2857
        Option('name-from-revision', help='The path name in the old tree.'),
2851
2858
        Option('filters', help='Apply content filters to display the '
2852
2859
                'convenience form.'),
2857
2864
 
2858
2865
    @display_command
2859
2866
    def run(self, filename, revision=None, name_from_revision=False,
2860
 
            filters=False, directory=None):
 
2867
            filters=False):
2861
2868
        if revision is not None and len(revision) != 1:
2862
2869
            raise errors.BzrCommandError("bzr cat --revision takes exactly"
2863
2870
                                         " one revision specifier")
2864
2871
        tree, branch, relpath = \
2865
 
            _open_directory_or_containing_tree_or_branch(filename, directory)
2866
 
        self.add_cleanup(branch.lock_read().unlock)
 
2872
            bzrdir.BzrDir.open_containing_tree_or_branch(filename)
 
2873
        branch.lock_read()
 
2874
        self.add_cleanup(branch.unlock)
2867
2875
        return self._run(tree, branch, relpath, filename, revision,
2868
2876
                         name_from_revision, filters)
2869
2877
 
2872
2880
        if tree is None:
2873
2881
            tree = b.basis_tree()
2874
2882
        rev_tree = _get_one_revision_tree('cat', revision, branch=b)
2875
 
        self.add_cleanup(rev_tree.lock_read().unlock)
 
2883
        rev_tree.lock_read()
 
2884
        self.add_cleanup(rev_tree.unlock)
2876
2885
 
2877
2886
        old_file_id = rev_tree.path2id(relpath)
2878
2887
 
2921
2930
 
2922
2931
 
2923
2932
class cmd_local_time_offset(Command):
2924
 
    __doc__ = """Show the offset in seconds from GMT to local time."""
 
2933
    """Show the offset in seconds from GMT to local time."""
2925
2934
    hidden = True
2926
2935
    @display_command
2927
2936
    def run(self):
2930
2939
 
2931
2940
 
2932
2941
class cmd_commit(Command):
2933
 
    __doc__ = """Commit changes into a new revision.
 
2942
    """Commit changes into a new revision.
2934
2943
 
2935
2944
    An explanatory message needs to be given for each commit. This is
2936
2945
    often done by using the --message option (getting the message from the
3044
3053
                         "the master branch until a normal commit "
3045
3054
                         "is performed."
3046
3055
                    ),
3047
 
             Option('show-diff', short_name='p',
 
3056
             Option('show-diff',
3048
3057
                    help='When no message is supplied, show the diff along'
3049
3058
                    ' with the status summary in the message editor.'),
3050
3059
             ]
3099
3108
 
3100
3109
        properties = {}
3101
3110
 
3102
 
        tree, selected_list = WorkingTree.open_containing_paths(selected_list)
 
3111
        tree, selected_list = tree_files(selected_list)
3103
3112
        if selected_list == ['']:
3104
3113
            # workaround - commit of root of tree should be exactly the same
3105
3114
            # as just default commit in that tree, and succeed even though
3140
3149
        def get_message(commit_obj):
3141
3150
            """Callback to get commit message"""
3142
3151
            if file:
3143
 
                f = open(file)
3144
 
                try:
3145
 
                    my_message = f.read().decode(osutils.get_user_encoding())
3146
 
                finally:
3147
 
                    f.close()
 
3152
                my_message = codecs.open(
 
3153
                    file, 'rt', osutils.get_user_encoding()).read()
3148
3154
            elif message is not None:
3149
3155
                my_message = message
3150
3156
            else:
3179
3185
                        reporter=None, verbose=verbose, revprops=properties,
3180
3186
                        authors=author, timestamp=commit_stamp,
3181
3187
                        timezone=offset,
3182
 
                        exclude=tree.safe_relpath_files(exclude))
 
3188
                        exclude=safe_relpath_files(tree, exclude))
3183
3189
        except PointlessCommit:
3184
3190
            raise errors.BzrCommandError("No changes to commit."
3185
3191
                              " Use --unchanged to commit anyhow.")
3199
3205
 
3200
3206
 
3201
3207
class cmd_check(Command):
3202
 
    __doc__ = """Validate working tree structure, branch consistency and repository history.
 
3208
    """Validate working tree structure, branch consistency and repository history.
3203
3209
 
3204
3210
    This command checks various invariants about branch and repository storage
3205
3211
    to detect data corruption or bzr bugs.
3269
3275
 
3270
3276
 
3271
3277
class cmd_upgrade(Command):
3272
 
    __doc__ = """Upgrade branch storage to current format.
 
3278
    """Upgrade branch storage to current format.
3273
3279
 
3274
3280
    The check command or bzr developers may sometimes advise you to run
3275
3281
    this command. When the default format has changed you may also be warned
3293
3299
 
3294
3300
 
3295
3301
class cmd_whoami(Command):
3296
 
    __doc__ = """Show or set bzr user id.
 
3302
    """Show or set bzr user id.
3297
3303
 
3298
3304
    :Examples:
3299
3305
        Show the email of the current user::
3304
3310
 
3305
3311
            bzr whoami "Frank Chu <fchu@example.com>"
3306
3312
    """
3307
 
    takes_options = [ 'directory',
3308
 
                      Option('email',
 
3313
    takes_options = [ Option('email',
3309
3314
                             help='Display email address only.'),
3310
3315
                      Option('branch',
3311
3316
                             help='Set identity for the current branch instead of '
3315
3320
    encoding_type = 'replace'
3316
3321
 
3317
3322
    @display_command
3318
 
    def run(self, email=False, branch=False, name=None, directory=None):
 
3323
    def run(self, email=False, branch=False, name=None):
3319
3324
        if name is None:
3320
 
            if directory is None:
3321
 
                # use branch if we're inside one; otherwise global config
3322
 
                try:
3323
 
                    c = Branch.open_containing(u'.')[0].get_config()
3324
 
                except errors.NotBranchError:
3325
 
                    c = _mod_config.GlobalConfig()
3326
 
            else:
3327
 
                c = Branch.open(directory).get_config()
 
3325
            # use branch if we're inside one; otherwise global config
 
3326
            try:
 
3327
                c = Branch.open_containing('.')[0].get_config()
 
3328
            except errors.NotBranchError:
 
3329
                c = config.GlobalConfig()
3328
3330
            if email:
3329
3331
                self.outf.write(c.user_email() + '\n')
3330
3332
            else:
3333
3335
 
3334
3336
        # display a warning if an email address isn't included in the given name.
3335
3337
        try:
3336
 
            _mod_config.extract_email_address(name)
 
3338
            config.extract_email_address(name)
3337
3339
        except errors.NoEmailInUsername, e:
3338
3340
            warning('"%s" does not seem to contain an email address.  '
3339
3341
                    'This is allowed, but not recommended.', name)
3340
3342
 
3341
3343
        # use global config unless --branch given
3342
3344
        if branch:
3343
 
            if directory is None:
3344
 
                c = Branch.open_containing(u'.')[0].get_config()
3345
 
            else:
3346
 
                c = Branch.open(directory).get_config()
 
3345
            c = Branch.open_containing('.')[0].get_config()
3347
3346
        else:
3348
 
            c = _mod_config.GlobalConfig()
 
3347
            c = config.GlobalConfig()
3349
3348
        c.set_user_option('email', name)
3350
3349
 
3351
3350
 
3352
3351
class cmd_nick(Command):
3353
 
    __doc__ = """Print or set the branch nickname.
 
3352
    """Print or set the branch nickname.
3354
3353
 
3355
3354
    If unset, the tree root directory name is used as the nickname.
3356
3355
    To print the current nickname, execute with no argument.
3361
3360
 
3362
3361
    _see_also = ['info']
3363
3362
    takes_args = ['nickname?']
3364
 
    takes_options = ['directory']
3365
 
    def run(self, nickname=None, directory=u'.'):
3366
 
        branch = Branch.open_containing(directory)[0]
 
3363
    def run(self, nickname=None):
 
3364
        branch = Branch.open_containing(u'.')[0]
3367
3365
        if nickname is None:
3368
3366
            self.printme(branch)
3369
3367
        else:
3375
3373
 
3376
3374
 
3377
3375
class cmd_alias(Command):
3378
 
    __doc__ = """Set/unset and display aliases.
 
3376
    """Set/unset and display aliases.
3379
3377
 
3380
3378
    :Examples:
3381
3379
        Show the current aliases::
3418
3416
                'bzr alias --remove expects an alias to remove.')
3419
3417
        # If alias is not found, print something like:
3420
3418
        # unalias: foo: not found
3421
 
        c = _mod_config.GlobalConfig()
 
3419
        c = config.GlobalConfig()
3422
3420
        c.unset_alias(alias_name)
3423
3421
 
3424
3422
    @display_command
3425
3423
    def print_aliases(self):
3426
3424
        """Print out the defined aliases in a similar format to bash."""
3427
 
        aliases = _mod_config.GlobalConfig().get_aliases()
 
3425
        aliases = config.GlobalConfig().get_aliases()
3428
3426
        for key, value in sorted(aliases.iteritems()):
3429
3427
            self.outf.write('bzr alias %s="%s"\n' % (key, value))
3430
3428
 
3440
3438
 
3441
3439
    def set_alias(self, alias_name, alias_command):
3442
3440
        """Save the alias in the global config."""
3443
 
        c = _mod_config.GlobalConfig()
 
3441
        c = config.GlobalConfig()
3444
3442
        c.set_alias(alias_name, alias_command)
3445
3443
 
3446
3444
 
3447
3445
class cmd_selftest(Command):
3448
 
    __doc__ = """Run internal test suite.
 
3446
    """Run internal test suite.
3449
3447
 
3450
3448
    If arguments are given, they are regular expressions that say which tests
3451
3449
    should run.  Tests matching any expression are run, and other tests are
3519
3517
                                 'throughout the test suite.',
3520
3518
                            type=get_transport_type),
3521
3519
                     Option('benchmark',
3522
 
                            help='Run the benchmarks rather than selftests.',
3523
 
                            hidden=True),
 
3520
                            help='Run the benchmarks rather than selftests.'),
3524
3521
                     Option('lsprof-timed',
3525
3522
                            help='Generate lsprof output for benchmarked'
3526
3523
                                 ' sections of code.'),
3527
3524
                     Option('lsprof-tests',
3528
3525
                            help='Generate lsprof output for each test.'),
 
3526
                     Option('cache-dir', type=str,
 
3527
                            help='Cache intermediate benchmark output in this '
 
3528
                                 'directory.'),
3529
3529
                     Option('first',
3530
3530
                            help='Run all tests, but run specified tests first.',
3531
3531
                            short_name='f',
3565
3565
 
3566
3566
    def run(self, testspecs_list=None, verbose=False, one=False,
3567
3567
            transport=None, benchmark=None,
3568
 
            lsprof_timed=None,
 
3568
            lsprof_timed=None, cache_dir=None,
3569
3569
            first=False, list_only=False,
3570
3570
            randomize=None, exclude=None, strict=False,
3571
3571
            load_list=None, debugflag=None, starting_with=None, subunit=False,
3572
3572
            parallel=None, lsprof_tests=False):
3573
 
        from bzrlib import tests
3574
 
 
 
3573
        from bzrlib.tests import selftest
 
3574
        import bzrlib.benchmarks as benchmarks
 
3575
        from bzrlib.benchmarks import tree_creator
 
3576
 
 
3577
        # Make deprecation warnings visible, unless -Werror is set
 
3578
        symbol_versioning.activate_deprecation_warnings(override=False)
 
3579
 
 
3580
        if cache_dir is not None:
 
3581
            tree_creator.TreeCreator.CACHE_ROOT = osutils.abspath(cache_dir)
3575
3582
        if testspecs_list is not None:
3576
3583
            pattern = '|'.join(testspecs_list)
3577
3584
        else:
3583
3590
                raise errors.BzrCommandError("subunit not available. subunit "
3584
3591
                    "needs to be installed to use --subunit.")
3585
3592
            self.additional_selftest_args['runner_class'] = SubUnitBzrRunner
3586
 
            # On Windows, disable automatic conversion of '\n' to '\r\n' in
3587
 
            # stdout, which would corrupt the subunit stream. 
3588
 
            # FIXME: This has been fixed in subunit trunk (>0.0.5) so the
3589
 
            # following code can be deleted when it's sufficiently deployed
3590
 
            # -- vila/mgz 20100514
3591
 
            if (sys.platform == "win32"
3592
 
                and getattr(sys.stdout, 'fileno', None) is not None):
3593
 
                import msvcrt
3594
 
                msvcrt.setmode(sys.stdout.fileno(), os.O_BINARY)
3595
3593
        if parallel:
3596
3594
            self.additional_selftest_args.setdefault(
3597
3595
                'suite_decorators', []).append(parallel)
3598
3596
        if benchmark:
3599
 
            raise errors.BzrCommandError(
3600
 
                "--benchmark is no longer supported from bzr 2.2; "
3601
 
                "use bzr-usertest instead")
3602
 
        test_suite_factory = None
 
3597
            test_suite_factory = benchmarks.test_suite
 
3598
            # Unless user explicitly asks for quiet, be verbose in benchmarks
 
3599
            verbose = not is_quiet()
 
3600
            # TODO: should possibly lock the history file...
 
3601
            benchfile = open(".perf_history", "at", buffering=1)
 
3602
            self.add_cleanup(benchfile.close)
 
3603
        else:
 
3604
            test_suite_factory = None
 
3605
            benchfile = None
3603
3606
        selftest_kwargs = {"verbose": verbose,
3604
3607
                          "pattern": pattern,
3605
3608
                          "stop_on_failure": one,
3607
3610
                          "test_suite_factory": test_suite_factory,
3608
3611
                          "lsprof_timed": lsprof_timed,
3609
3612
                          "lsprof_tests": lsprof_tests,
 
3613
                          "bench_history": benchfile,
3610
3614
                          "matching_tests_first": first,
3611
3615
                          "list_only": list_only,
3612
3616
                          "random_seed": randomize,
3617
3621
                          "starting_with": starting_with
3618
3622
                          }
3619
3623
        selftest_kwargs.update(self.additional_selftest_args)
3620
 
 
3621
 
        # Make deprecation warnings visible, unless -Werror is set
3622
 
        cleanup = symbol_versioning.activate_deprecation_warnings(
3623
 
            override=False)
3624
 
        try:
3625
 
            result = tests.selftest(**selftest_kwargs)
3626
 
        finally:
3627
 
            cleanup()
 
3624
        result = selftest(**selftest_kwargs)
3628
3625
        return int(not result)
3629
3626
 
3630
3627
 
3631
3628
class cmd_version(Command):
3632
 
    __doc__ = """Show version of bzr."""
 
3629
    """Show version of bzr."""
3633
3630
 
3634
3631
    encoding_type = 'replace'
3635
3632
    takes_options = [
3646
3643
 
3647
3644
 
3648
3645
class cmd_rocks(Command):
3649
 
    __doc__ = """Statement of optimism."""
 
3646
    """Statement of optimism."""
3650
3647
 
3651
3648
    hidden = True
3652
3649
 
3656
3653
 
3657
3654
 
3658
3655
class cmd_find_merge_base(Command):
3659
 
    __doc__ = """Find and print a base revision for merging two branches."""
 
3656
    """Find and print a base revision for merging two branches."""
3660
3657
    # TODO: Options to specify revisions on either side, as if
3661
3658
    #       merging only part of the history.
3662
3659
    takes_args = ['branch', 'other']
3668
3665
 
3669
3666
        branch1 = Branch.open_containing(branch)[0]
3670
3667
        branch2 = Branch.open_containing(other)[0]
3671
 
        self.add_cleanup(branch1.lock_read().unlock)
3672
 
        self.add_cleanup(branch2.lock_read().unlock)
 
3668
        branch1.lock_read()
 
3669
        self.add_cleanup(branch1.unlock)
 
3670
        branch2.lock_read()
 
3671
        self.add_cleanup(branch2.unlock)
3673
3672
        last1 = ensure_null(branch1.last_revision())
3674
3673
        last2 = ensure_null(branch2.last_revision())
3675
3674
 
3680
3679
 
3681
3680
 
3682
3681
class cmd_merge(Command):
3683
 
    __doc__ = """Perform a three-way merge.
 
3682
    """Perform a three-way merge.
3684
3683
 
3685
3684
    The source of the merge can be specified either in the form of a branch,
3686
3685
    or in the form of a path to a file containing a merge directive generated
3769
3768
                ' completely merged into the source, pull from the'
3770
3769
                ' source rather than merging.  When this happens,'
3771
3770
                ' you do not need to commit the result.'),
3772
 
        custom_help('directory',
 
3771
        Option('directory',
3773
3772
               help='Branch to merge into, '
3774
 
                    'rather than the one containing the working directory.'),
 
3773
                    'rather than the one containing the working directory.',
 
3774
               short_name='d',
 
3775
               type=unicode,
 
3776
               ),
3775
3777
        Option('preview', help='Instead of merging, show a diff of the'
3776
3778
               ' merge.'),
3777
3779
        Option('interactive', help='Select changes interactively.',
3810
3812
            unversioned_filter=tree.is_ignored, view_info=view_info)
3811
3813
        pb = ui.ui_factory.nested_progress_bar()
3812
3814
        self.add_cleanup(pb.finished)
3813
 
        self.add_cleanup(tree.lock_write().unlock)
 
3815
        tree.lock_write()
 
3816
        self.add_cleanup(tree.unlock)
3814
3817
        if location is not None:
3815
3818
            try:
3816
3819
                mergeable = bundle.read_mergeable_from_url(location,
3877
3880
    def _do_preview(self, merger):
3878
3881
        from bzrlib.diff import show_diff_trees
3879
3882
        result_tree = self._get_preview(merger)
3880
 
        path_encoding = osutils.get_diff_header_encoding()
3881
3883
        show_diff_trees(merger.this_tree, result_tree, self.outf,
3882
 
                        old_label='', new_label='',
3883
 
                        path_encoding=path_encoding)
 
3884
                        old_label='', new_label='')
3884
3885
 
3885
3886
    def _do_merge(self, merger, change_reporter, allow_pending, verified):
3886
3887
        merger.change_reporter = change_reporter
4039
4040
 
4040
4041
 
4041
4042
class cmd_remerge(Command):
4042
 
    __doc__ = """Redo a merge.
 
4043
    """Redo a merge.
4043
4044
 
4044
4045
    Use this if you want to try a different merge technique while resolving
4045
4046
    conflicts.  Some merge techniques are better than others, and remerge
4073
4074
        from bzrlib.conflicts import restore
4074
4075
        if merge_type is None:
4075
4076
            merge_type = _mod_merge.Merge3Merger
4076
 
        tree, file_list = WorkingTree.open_containing_paths(file_list)
4077
 
        self.add_cleanup(tree.lock_write().unlock)
 
4077
        tree, file_list = tree_files(file_list)
 
4078
        tree.lock_write()
 
4079
        self.add_cleanup(tree.unlock)
4078
4080
        parents = tree.get_parent_ids()
4079
4081
        if len(parents) != 2:
4080
4082
            raise errors.BzrCommandError("Sorry, remerge only works after normal"
4133
4135
 
4134
4136
 
4135
4137
class cmd_revert(Command):
4136
 
    __doc__ = """Revert files to a previous revision.
 
4138
    """Revert files to a previous revision.
4137
4139
 
4138
4140
    Giving a list of files will revert only those files.  Otherwise, all files
4139
4141
    will be reverted.  If the revision is not specified with '--revision', the
4189
4191
 
4190
4192
    def run(self, revision=None, no_backup=False, file_list=None,
4191
4193
            forget_merges=None):
4192
 
        tree, file_list = WorkingTree.open_containing_paths(file_list)
4193
 
        self.add_cleanup(tree.lock_tree_write().unlock)
 
4194
        tree, file_list = tree_files(file_list)
 
4195
        tree.lock_write()
 
4196
        self.add_cleanup(tree.unlock)
4194
4197
        if forget_merges:
4195
4198
            tree.set_parent_ids(tree.get_parent_ids()[:1])
4196
4199
        else:
4204
4207
 
4205
4208
 
4206
4209
class cmd_assert_fail(Command):
4207
 
    __doc__ = """Test reporting of assertion failures"""
 
4210
    """Test reporting of assertion failures"""
4208
4211
    # intended just for use in testing
4209
4212
 
4210
4213
    hidden = True
4214
4217
 
4215
4218
 
4216
4219
class cmd_help(Command):
4217
 
    __doc__ = """Show help on a command or other topic.
 
4220
    """Show help on a command or other topic.
4218
4221
    """
4219
4222
 
4220
4223
    _see_also = ['topics']
4233
4236
 
4234
4237
 
4235
4238
class cmd_shell_complete(Command):
4236
 
    __doc__ = """Show appropriate completions for context.
 
4239
    """Show appropriate completions for context.
4237
4240
 
4238
4241
    For a list of all available commands, say 'bzr shell-complete'.
4239
4242
    """
4248
4251
 
4249
4252
 
4250
4253
class cmd_missing(Command):
4251
 
    __doc__ = """Show unmerged/unpulled revisions between two branches.
 
4254
    """Show unmerged/unpulled revisions between two branches.
4252
4255
 
4253
4256
    OTHER_BRANCH may be local or remote.
4254
4257
 
4285
4288
    _see_also = ['merge', 'pull']
4286
4289
    takes_args = ['other_branch?']
4287
4290
    takes_options = [
4288
 
        'directory',
4289
4291
        Option('reverse', 'Reverse the order of revisions.'),
4290
4292
        Option('mine-only',
4291
4293
               'Display changes in the local branch only.'),
4313
4315
            theirs_only=False,
4314
4316
            log_format=None, long=False, short=False, line=False,
4315
4317
            show_ids=False, verbose=False, this=False, other=False,
4316
 
            include_merges=False, revision=None, my_revision=None,
4317
 
            directory=u'.'):
 
4318
            include_merges=False, revision=None, my_revision=None):
4318
4319
        from bzrlib.missing import find_unmerged, iter_log_revisions
4319
4320
        def message(s):
4320
4321
            if not is_quiet():
4333
4334
        elif theirs_only:
4334
4335
            restrict = 'remote'
4335
4336
 
4336
 
        local_branch = Branch.open_containing(directory)[0]
4337
 
        self.add_cleanup(local_branch.lock_read().unlock)
 
4337
        local_branch = Branch.open_containing(u".")[0]
 
4338
        local_branch.lock_read()
 
4339
        self.add_cleanup(local_branch.unlock)
4338
4340
 
4339
4341
        parent = local_branch.get_parent()
4340
4342
        if other_branch is None:
4351
4353
        if remote_branch.base == local_branch.base:
4352
4354
            remote_branch = local_branch
4353
4355
        else:
4354
 
            self.add_cleanup(remote_branch.lock_read().unlock)
 
4356
            remote_branch.lock_read()
 
4357
            self.add_cleanup(remote_branch.unlock)
4355
4358
 
4356
4359
        local_revid_range = _revision_range_to_revid_range(
4357
4360
            _get_revision_range(my_revision, local_branch,
4412
4415
            message("Branches are up to date.\n")
4413
4416
        self.cleanup_now()
4414
4417
        if not status_code and parent is None and other_branch is not None:
4415
 
            self.add_cleanup(local_branch.lock_write().unlock)
 
4418
            local_branch.lock_write()
 
4419
            self.add_cleanup(local_branch.unlock)
4416
4420
            # handle race conditions - a parent might be set while we run.
4417
4421
            if local_branch.get_parent() is None:
4418
4422
                local_branch.set_parent(remote_branch.base)
4420
4424
 
4421
4425
 
4422
4426
class cmd_pack(Command):
4423
 
    __doc__ = """Compress the data within a repository.
4424
 
 
4425
 
    This operation compresses the data within a bazaar repository. As
4426
 
    bazaar supports automatic packing of repository, this operation is
4427
 
    normally not required to be done manually.
4428
 
 
4429
 
    During the pack operation, bazaar takes a backup of existing repository
4430
 
    data, i.e. pack files. This backup is eventually removed by bazaar
4431
 
    automatically when it is safe to do so. To save disk space by removing
4432
 
    the backed up pack files, the --clean-obsolete-packs option may be
4433
 
    used.
4434
 
 
4435
 
    Warning: If you use --clean-obsolete-packs and your machine crashes
4436
 
    during or immediately after repacking, you may be left with a state
4437
 
    where the deletion has been written to disk but the new packs have not
4438
 
    been. In this case the repository may be unusable.
4439
 
    """
 
4427
    """Compress the data within a repository."""
4440
4428
 
4441
4429
    _see_also = ['repositories']
4442
4430
    takes_args = ['branch_or_repo?']
4443
 
    takes_options = [
4444
 
        Option('clean-obsolete-packs', 'Delete obsolete packs to save disk space.'),
4445
 
        ]
4446
4431
 
4447
 
    def run(self, branch_or_repo='.', clean_obsolete_packs=False):
 
4432
    def run(self, branch_or_repo='.'):
4448
4433
        dir = bzrdir.BzrDir.open_containing(branch_or_repo)[0]
4449
4434
        try:
4450
4435
            branch = dir.open_branch()
4451
4436
            repository = branch.repository
4452
4437
        except errors.NotBranchError:
4453
4438
            repository = dir.open_repository()
4454
 
        repository.pack(clean_obsolete_packs=clean_obsolete_packs)
 
4439
        repository.pack()
4455
4440
 
4456
4441
 
4457
4442
class cmd_plugins(Command):
4458
 
    __doc__ = """List the installed plugins.
 
4443
    """List the installed plugins.
4459
4444
 
4460
4445
    This command displays the list of installed plugins including
4461
4446
    version of plugin and a short description of each.
4500
4485
 
4501
4486
 
4502
4487
class cmd_testament(Command):
4503
 
    __doc__ = """Show testament (signing-form) of a revision."""
 
4488
    """Show testament (signing-form) of a revision."""
4504
4489
    takes_options = [
4505
4490
            'revision',
4506
4491
            Option('long', help='Produce long-format testament.'),
4518
4503
            b = Branch.open_containing(branch)[0]
4519
4504
        else:
4520
4505
            b = Branch.open(branch)
4521
 
        self.add_cleanup(b.lock_read().unlock)
 
4506
        b.lock_read()
 
4507
        self.add_cleanup(b.unlock)
4522
4508
        if revision is None:
4523
4509
            rev_id = b.last_revision()
4524
4510
        else:
4531
4517
 
4532
4518
 
4533
4519
class cmd_annotate(Command):
4534
 
    __doc__ = """Show the origin of each line in a file.
 
4520
    """Show the origin of each line in a file.
4535
4521
 
4536
4522
    This prints out the given file with an annotation on the left side
4537
4523
    indicating which revision, author and date introduced the change.
4548
4534
                     Option('long', help='Show commit date in annotations.'),
4549
4535
                     'revision',
4550
4536
                     'show-ids',
4551
 
                     'directory',
4552
4537
                     ]
4553
4538
    encoding_type = 'exact'
4554
4539
 
4555
4540
    @display_command
4556
4541
    def run(self, filename, all=False, long=False, revision=None,
4557
 
            show_ids=False, directory=None):
 
4542
            show_ids=False):
4558
4543
        from bzrlib.annotate import annotate_file, annotate_file_tree
4559
4544
        wt, branch, relpath = \
4560
 
            _open_directory_or_containing_tree_or_branch(filename, directory)
 
4545
            bzrdir.BzrDir.open_containing_tree_or_branch(filename)
4561
4546
        if wt is not None:
4562
 
            self.add_cleanup(wt.lock_read().unlock)
 
4547
            wt.lock_read()
 
4548
            self.add_cleanup(wt.unlock)
4563
4549
        else:
4564
 
            self.add_cleanup(branch.lock_read().unlock)
 
4550
            branch.lock_read()
 
4551
            self.add_cleanup(branch.unlock)
4565
4552
        tree = _get_one_revision_tree('annotate', revision, branch=branch)
4566
 
        self.add_cleanup(tree.lock_read().unlock)
 
4553
        tree.lock_read()
 
4554
        self.add_cleanup(tree.unlock)
4567
4555
        if wt is not None:
4568
4556
            file_id = wt.path2id(relpath)
4569
4557
        else:
4582
4570
 
4583
4571
 
4584
4572
class cmd_re_sign(Command):
4585
 
    __doc__ = """Create a digital signature for an existing revision."""
 
4573
    """Create a digital signature for an existing revision."""
4586
4574
    # TODO be able to replace existing ones.
4587
4575
 
4588
4576
    hidden = True # is this right ?
4589
4577
    takes_args = ['revision_id*']
4590
 
    takes_options = ['directory', 'revision']
 
4578
    takes_options = ['revision']
4591
4579
 
4592
 
    def run(self, revision_id_list=None, revision=None, directory=u'.'):
 
4580
    def run(self, revision_id_list=None, revision=None):
4593
4581
        if revision_id_list is not None and revision is not None:
4594
4582
            raise errors.BzrCommandError('You can only supply one of revision_id or --revision')
4595
4583
        if revision_id_list is None and revision is None:
4596
4584
            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)
 
4585
        b = WorkingTree.open_containing(u'.')[0].branch
 
4586
        b.lock_write()
 
4587
        self.add_cleanup(b.unlock)
4599
4588
        return self._run(b, revision_id_list, revision)
4600
4589
 
4601
4590
    def _run(self, b, revision_id_list, revision):
4647
4636
 
4648
4637
 
4649
4638
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.
 
4639
    """Convert the current branch into a checkout of the supplied branch.
4652
4640
 
4653
4641
    Once converted into a checkout, commits must succeed on the master branch
4654
4642
    before they will be applied to the local branch.
4660
4648
 
4661
4649
    _see_also = ['checkouts', 'unbind']
4662
4650
    takes_args = ['location?']
4663
 
    takes_options = ['directory']
 
4651
    takes_options = []
4664
4652
 
4665
 
    def run(self, location=None, directory=u'.'):
4666
 
        b, relpath = Branch.open_containing(directory)
 
4653
    def run(self, location=None):
 
4654
        b, relpath = Branch.open_containing(u'.')
4667
4655
        if location is None:
4668
4656
            try:
4669
4657
                location = b.get_old_bound_location()
4688
4676
 
4689
4677
 
4690
4678
class cmd_unbind(Command):
4691
 
    __doc__ = """Convert the current checkout into a regular branch.
 
4679
    """Convert the current checkout into a regular branch.
4692
4680
 
4693
4681
    After unbinding, the local branch is considered independent and subsequent
4694
4682
    commits will be local only.
4696
4684
 
4697
4685
    _see_also = ['checkouts', 'bind']
4698
4686
    takes_args = []
4699
 
    takes_options = ['directory']
 
4687
    takes_options = []
4700
4688
 
4701
 
    def run(self, directory=u'.'):
4702
 
        b, relpath = Branch.open_containing(directory)
 
4689
    def run(self):
 
4690
        b, relpath = Branch.open_containing(u'.')
4703
4691
        if not b.unbind():
4704
4692
            raise errors.BzrCommandError('Local branch is not bound')
4705
4693
 
4706
4694
 
4707
4695
class cmd_uncommit(Command):
4708
 
    __doc__ = """Remove the last committed revision.
 
4696
    """Remove the last committed revision.
4709
4697
 
4710
4698
    --verbose will print out what is being removed.
4711
4699
    --dry-run will go through all the motions, but not actually
4751
4739
            b = control.open_branch()
4752
4740
 
4753
4741
        if tree is not None:
4754
 
            self.add_cleanup(tree.lock_write().unlock)
 
4742
            tree.lock_write()
 
4743
            self.add_cleanup(tree.unlock)
4755
4744
        else:
4756
 
            self.add_cleanup(b.lock_write().unlock)
 
4745
            b.lock_write()
 
4746
            self.add_cleanup(b.unlock)
4757
4747
        return self._run(b, tree, dry_run, verbose, revision, force, local=local)
4758
4748
 
4759
4749
    def _run(self, b, tree, dry_run, verbose, revision, force, local=False):
4811
4801
 
4812
4802
 
4813
4803
class cmd_break_lock(Command):
4814
 
    __doc__ = """Break a dead lock.
4815
 
 
4816
 
    This command breaks a lock on a repository, branch, working directory or
4817
 
    config file.
 
4804
    """Break a dead lock on a repository, branch or working directory.
4818
4805
 
4819
4806
    CAUTION: Locks should only be broken when you are sure that the process
4820
4807
    holding the lock has been stopped.
4825
4812
    :Examples:
4826
4813
        bzr break-lock
4827
4814
        bzr break-lock bzr+ssh://example.com/bzr/foo
4828
 
        bzr break-lock --conf ~/.bazaar
4829
4815
    """
4830
 
 
4831
4816
    takes_args = ['location?']
4832
 
    takes_options = [
4833
 
        Option('config',
4834
 
               help='LOCATION is the directory where the config lock is.'),
4835
 
        ]
4836
4817
 
4837
 
    def run(self, location=None, config=False):
 
4818
    def run(self, location=None, show=False):
4838
4819
        if location is None:
4839
4820
            location = u'.'
4840
 
        if config:
4841
 
            conf = _mod_config.LockableConfig(file_name=location)
4842
 
            conf.break_lock()
4843
 
        else:
4844
 
            control, relpath = bzrdir.BzrDir.open_containing(location)
4845
 
            try:
4846
 
                control.break_lock()
4847
 
            except NotImplementedError:
4848
 
                pass
 
4821
        control, relpath = bzrdir.BzrDir.open_containing(location)
 
4822
        try:
 
4823
            control.break_lock()
 
4824
        except NotImplementedError:
 
4825
            pass
4849
4826
 
4850
4827
 
4851
4828
class cmd_wait_until_signalled(Command):
4852
 
    __doc__ = """Test helper for test_start_and_stop_bzr_subprocess_send_signal.
 
4829
    """Test helper for test_start_and_stop_bzr_subprocess_send_signal.
4853
4830
 
4854
4831
    This just prints a line to signal when it is ready, then blocks on stdin.
4855
4832
    """
4863
4840
 
4864
4841
 
4865
4842
class cmd_serve(Command):
4866
 
    __doc__ = """Run the bzr server."""
 
4843
    """Run the bzr server."""
4867
4844
 
4868
4845
    aliases = ['server']
4869
4846
 
4880
4857
                    'result in a dynamically allocated port.  The default port '
4881
4858
                    'depends on the protocol.',
4882
4859
               type=str),
4883
 
        custom_help('directory',
4884
 
               help='Serve contents of this directory.'),
 
4860
        Option('directory',
 
4861
               help='Serve contents of this directory.',
 
4862
               type=unicode),
4885
4863
        Option('allow-writes',
4886
4864
               help='By default the server is a readonly server.  Supplying '
4887
4865
                    '--allow-writes enables write access to the contents of '
4914
4892
 
4915
4893
    def run(self, port=None, inet=False, directory=None, allow_writes=False,
4916
4894
            protocol=None):
4917
 
        from bzrlib import transport
 
4895
        from bzrlib.transport import get_transport, transport_server_registry
4918
4896
        if directory is None:
4919
4897
            directory = os.getcwd()
4920
4898
        if protocol is None:
4921
 
            protocol = transport.transport_server_registry.get()
 
4899
            protocol = transport_server_registry.get()
4922
4900
        host, port = self.get_host_and_port(port)
4923
4901
        url = urlutils.local_path_to_url(directory)
4924
4902
        if not allow_writes:
4925
4903
            url = 'readonly+' + url
4926
 
        t = transport.get_transport(url)
4927
 
        protocol(t, host, port, inet)
 
4904
        transport = get_transport(url)
 
4905
        protocol(transport, host, port, inet)
4928
4906
 
4929
4907
 
4930
4908
class cmd_join(Command):
4931
 
    __doc__ = """Combine a tree into its containing tree.
 
4909
    """Combine a tree into its containing tree.
4932
4910
 
4933
4911
    This command requires the target tree to be in a rich-root format.
4934
4912
 
4974
4952
 
4975
4953
 
4976
4954
class cmd_split(Command):
4977
 
    __doc__ = """Split a subdirectory of a tree into a separate tree.
 
4955
    """Split a subdirectory of a tree into a separate tree.
4978
4956
 
4979
4957
    This command will produce a target tree in a format that supports
4980
4958
    rich roots, like 'rich-root' or 'rich-root-pack'.  These formats cannot be
5000
4978
 
5001
4979
 
5002
4980
class cmd_merge_directive(Command):
5003
 
    __doc__ = """Generate a merge directive for auto-merge tools.
 
4981
    """Generate a merge directive for auto-merge tools.
5004
4982
 
5005
4983
    A directive requests a merge to be performed, and also provides all the
5006
4984
    information necessary to do so.  This means it must either include a
5023
5001
    _see_also = ['send']
5024
5002
 
5025
5003
    takes_options = [
5026
 
        'directory',
5027
5004
        RegistryOption.from_kwargs('patch-type',
5028
5005
            'The type of patch to include in the directive.',
5029
5006
            title='Patch type',
5042
5019
    encoding_type = 'exact'
5043
5020
 
5044
5021
    def run(self, submit_branch=None, public_branch=None, patch_type='bundle',
5045
 
            sign=False, revision=None, mail_to=None, message=None,
5046
 
            directory=u'.'):
 
5022
            sign=False, revision=None, mail_to=None, message=None):
5047
5023
        from bzrlib.revision import ensure_null, NULL_REVISION
5048
5024
        include_patch, include_bundle = {
5049
5025
            'plain': (False, False),
5050
5026
            'diff': (True, False),
5051
5027
            'bundle': (True, True),
5052
5028
            }[patch_type]
5053
 
        branch = Branch.open(directory)
 
5029
        branch = Branch.open('.')
5054
5030
        stored_submit_branch = branch.get_submit_branch()
5055
5031
        if submit_branch is None:
5056
5032
            submit_branch = stored_submit_branch
5101
5077
 
5102
5078
 
5103
5079
class cmd_send(Command):
5104
 
    __doc__ = """Mail or create a merge-directive for submitting changes.
 
5080
    """Mail or create a merge-directive for submitting changes.
5105
5081
 
5106
5082
    A merge directive provides many things needed for requesting merges:
5107
5083
 
5141
5117
    given, in which case it is sent to a file.
5142
5118
 
5143
5119
    Mail is sent using your preferred mail program.  This should be transparent
5144
 
    on Windows (it uses MAPI).  On Unix, it requires the xdg-email utility.
 
5120
    on Windows (it uses MAPI).  On Linux, it requires the xdg-email utility.
5145
5121
    If the preferred client can't be found (or used), your editor will be used.
5146
5122
 
5147
5123
    To use a specific mail program, set the mail_client configuration option.
5218
5194
 
5219
5195
 
5220
5196
class cmd_bundle_revisions(cmd_send):
5221
 
    __doc__ = """Create a merge-directive for submitting changes.
 
5197
    """Create a merge-directive for submitting changes.
5222
5198
 
5223
5199
    A merge directive provides many things needed for requesting merges:
5224
5200
 
5291
5267
 
5292
5268
 
5293
5269
class cmd_tag(Command):
5294
 
    __doc__ = """Create, remove or modify a tag naming a revision.
 
5270
    """Create, remove or modify a tag naming a revision.
5295
5271
 
5296
5272
    Tags give human-meaningful names to revisions.  Commands that take a -r
5297
5273
    (--revision) option can be given -rtag:X, where X is any previously
5318
5294
        Option('delete',
5319
5295
            help='Delete this tag rather than placing it.',
5320
5296
            ),
5321
 
        custom_help('directory',
5322
 
            help='Branch in which to place the tag.'),
 
5297
        Option('directory',
 
5298
            help='Branch in which to place the tag.',
 
5299
            short_name='d',
 
5300
            type=unicode,
 
5301
            ),
5323
5302
        Option('force',
5324
5303
            help='Replace existing tags.',
5325
5304
            ),
5333
5312
            revision=None,
5334
5313
            ):
5335
5314
        branch, relpath = Branch.open_containing(directory)
5336
 
        self.add_cleanup(branch.lock_write().unlock)
 
5315
        branch.lock_write()
 
5316
        self.add_cleanup(branch.unlock)
5337
5317
        if delete:
5338
5318
            if tag_name is None:
5339
5319
                raise errors.BzrCommandError("No tag specified to delete.")
5360
5340
 
5361
5341
 
5362
5342
class cmd_tags(Command):
5363
 
    __doc__ = """List tags.
 
5343
    """List tags.
5364
5344
 
5365
5345
    This command shows a table of tag names and the revisions they reference.
5366
5346
    """
5367
5347
 
5368
5348
    _see_also = ['tag']
5369
5349
    takes_options = [
5370
 
        custom_help('directory',
5371
 
            help='Branch whose tags should be displayed.'),
 
5350
        Option('directory',
 
5351
            help='Branch whose tags should be displayed.',
 
5352
            short_name='d',
 
5353
            type=unicode,
 
5354
            ),
5372
5355
        RegistryOption.from_kwargs('sort',
5373
5356
            'Sort tags by different criteria.', title='Sorting',
5374
5357
            alpha='Sort tags lexicographically (default).',
5391
5374
        if not tags:
5392
5375
            return
5393
5376
 
5394
 
        self.add_cleanup(branch.lock_read().unlock)
 
5377
        branch.lock_read()
 
5378
        self.add_cleanup(branch.unlock)
5395
5379
        if revision:
5396
5380
            graph = branch.repository.get_graph()
5397
5381
            rev1, rev2 = _get_revision_range(revision, branch, self.name())
5430
5414
 
5431
5415
 
5432
5416
class cmd_reconfigure(Command):
5433
 
    __doc__ = """Reconfigure the type of a bzr directory.
 
5417
    """Reconfigure the type of a bzr directory.
5434
5418
 
5435
5419
    A target configuration must be specified.
5436
5420
 
5521
5505
 
5522
5506
 
5523
5507
class cmd_switch(Command):
5524
 
    __doc__ = """Set the branch of a checkout and update.
 
5508
    """Set the branch of a checkout and update.
5525
5509
 
5526
5510
    For lightweight checkouts, this changes the branch being referenced.
5527
5511
    For heavyweight checkouts, this checks that there are no local commits
5544
5528
    """
5545
5529
 
5546
5530
    takes_args = ['to_location?']
5547
 
    takes_options = ['directory',
5548
 
                     Option('force',
 
5531
    takes_options = [Option('force',
5549
5532
                        help='Switch even if local commits will be lost.'),
5550
5533
                     'revision',
5551
5534
                     Option('create-branch', short_name='b',
5554
5537
                    ]
5555
5538
 
5556
5539
    def run(self, to_location=None, force=False, create_branch=False,
5557
 
            revision=None, directory=u'.'):
 
5540
            revision=None):
5558
5541
        from bzrlib import switch
5559
 
        tree_location = directory
 
5542
        tree_location = '.'
5560
5543
        revision = _get_one_revision('switch', revision)
5561
5544
        control_dir = bzrdir.BzrDir.open_containing(tree_location)[0]
5562
5545
        if to_location is None:
5563
5546
            if revision is None:
5564
5547
                raise errors.BzrCommandError('You must supply either a'
5565
5548
                                             ' revision or a location')
5566
 
            to_location = tree_location
 
5549
            to_location = '.'
5567
5550
        try:
5568
5551
            branch = control_dir.open_branch()
5569
5552
            had_explicit_nick = branch.get_config().has_explicit_nickname()
5618
5601
 
5619
5602
 
5620
5603
class cmd_view(Command):
5621
 
    __doc__ = """Manage filtered views.
 
5604
    """Manage filtered views.
5622
5605
 
5623
5606
    Views provide a mask over the tree so that users can focus on
5624
5607
    a subset of a tree when doing their work. After creating a view,
5704
5687
            name=None,
5705
5688
            switch=None,
5706
5689
            ):
5707
 
        tree, file_list = WorkingTree.open_containing_paths(file_list,
5708
 
            apply_view=False)
 
5690
        tree, file_list = tree_files(file_list, apply_view=False)
5709
5691
        current_view, view_dict = tree.views.get_view_info()
5710
5692
        if name is None:
5711
5693
            name = current_view
5773
5755
 
5774
5756
 
5775
5757
class cmd_hooks(Command):
5776
 
    __doc__ = """Show hooks."""
 
5758
    """Show hooks."""
5777
5759
 
5778
5760
    hidden = True
5779
5761
 
5793
5775
 
5794
5776
 
5795
5777
class cmd_remove_branch(Command):
5796
 
    __doc__ = """Remove a branch.
 
5778
    """Remove a branch.
5797
5779
 
5798
5780
    This will remove the branch from the specified location but 
5799
5781
    will keep any working tree or repository in place.
5818
5800
        
5819
5801
 
5820
5802
class cmd_shelve(Command):
5821
 
    __doc__ = """Temporarily set aside some changes from the current tree.
 
5803
    """Temporarily set aside some changes from the current tree.
5822
5804
 
5823
5805
    Shelve allows you to temporarily put changes you've made "on the shelf",
5824
5806
    ie. out of the way, until a later time when you can bring them back from
5845
5827
    takes_args = ['file*']
5846
5828
 
5847
5829
    takes_options = [
5848
 
        'directory',
5849
5830
        'revision',
5850
5831
        Option('all', help='Shelve all changes.'),
5851
5832
        'message',
5860
5841
    _see_also = ['unshelve']
5861
5842
 
5862
5843
    def run(self, revision=None, all=False, file_list=None, message=None,
5863
 
            writer=None, list=False, destroy=False, directory=u'.'):
 
5844
            writer=None, list=False, destroy=False):
5864
5845
        if list:
5865
5846
            return self.run_for_list()
5866
5847
        from bzrlib.shelf_ui import Shelver
5868
5849
            writer = bzrlib.option.diff_writer_registry.get()
5869
5850
        try:
5870
5851
            shelver = Shelver.from_args(writer(sys.stdout), revision, all,
5871
 
                file_list, message, destroy=destroy, directory=directory)
 
5852
                file_list, message, destroy=destroy)
5872
5853
            try:
5873
5854
                shelver.run()
5874
5855
            finally:
5878
5859
 
5879
5860
    def run_for_list(self):
5880
5861
        tree = WorkingTree.open_containing('.')[0]
5881
 
        self.add_cleanup(tree.lock_read().unlock)
 
5862
        tree.lock_read()
 
5863
        self.add_cleanup(tree.unlock)
5882
5864
        manager = tree.get_shelf_manager()
5883
5865
        shelves = manager.active_shelves()
5884
5866
        if len(shelves) == 0:
5893
5875
 
5894
5876
 
5895
5877
class cmd_unshelve(Command):
5896
 
    __doc__ = """Restore shelved changes.
 
5878
    """Restore shelved changes.
5897
5879
 
5898
5880
    By default, the most recently shelved changes are restored. However if you
5899
5881
    specify a shelf by id those changes will be restored instead.  This works
5902
5884
 
5903
5885
    takes_args = ['shelf_id?']
5904
5886
    takes_options = [
5905
 
        'directory',
5906
5887
        RegistryOption.from_kwargs(
5907
5888
            'action', help="The action to perform.",
5908
5889
            enum_switch=False, value_switches=True,
5916
5897
    ]
5917
5898
    _see_also = ['shelve']
5918
5899
 
5919
 
    def run(self, shelf_id=None, action='apply', directory=u'.'):
 
5900
    def run(self, shelf_id=None, action='apply'):
5920
5901
        from bzrlib.shelf_ui import Unshelver
5921
 
        unshelver = Unshelver.from_args(shelf_id, action, directory=directory)
 
5902
        unshelver = Unshelver.from_args(shelf_id, action)
5922
5903
        try:
5923
5904
            unshelver.run()
5924
5905
        finally:
5926
5907
 
5927
5908
 
5928
5909
class cmd_clean_tree(Command):
5929
 
    __doc__ = """Remove unwanted files from working tree.
 
5910
    """Remove unwanted files from working tree.
5930
5911
 
5931
5912
    By default, only unknown files, not ignored files, are deleted.  Versioned
5932
5913
    files are never deleted.
5940
5921
 
5941
5922
    To check what clean-tree will do, use --dry-run.
5942
5923
    """
5943
 
    takes_options = ['directory',
5944
 
                     Option('ignored', help='Delete all ignored files.'),
 
5924
    takes_options = [Option('ignored', help='Delete all ignored files.'),
5945
5925
                     Option('detritus', help='Delete conflict files, merge'
5946
5926
                            ' backups, and failed selftest dirs.'),
5947
5927
                     Option('unknown',
5950
5930
                            ' deleting them.'),
5951
5931
                     Option('force', help='Do not prompt before deleting.')]
5952
5932
    def run(self, unknown=False, ignored=False, detritus=False, dry_run=False,
5953
 
            force=False, directory=u'.'):
 
5933
            force=False):
5954
5934
        from bzrlib.clean_tree import clean_tree
5955
5935
        if not (unknown or ignored or detritus):
5956
5936
            unknown = True
5957
5937
        if dry_run:
5958
5938
            force = True
5959
 
        clean_tree(directory, unknown=unknown, ignored=ignored,
5960
 
                   detritus=detritus, dry_run=dry_run, no_prompt=force)
 
5939
        clean_tree('.', unknown=unknown, ignored=ignored, detritus=detritus,
 
5940
                   dry_run=dry_run, no_prompt=force)
5961
5941
 
5962
5942
 
5963
5943
class cmd_reference(Command):
5964
 
    __doc__ = """list, view and set branch locations for nested trees.
 
5944
    """list, view and set branch locations for nested trees.
5965
5945
 
5966
5946
    If no arguments are provided, lists the branch locations for nested trees.
5967
5947
    If one argument is provided, display the branch location for that tree.