/brz/remove-bazaar

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

« back to all changes in this revision

Viewing changes to bzrlib/builtins.py

  • Committer: John Arbash Meinel
  • Date: 2011-04-07 10:36:24 UTC
  • mfrom: (5764 +trunk)
  • mto: This revision was merged to the branch mainline in revision 5766.
  • Revision ID: john@arbash-meinel.com-20110407103624-n76g6tjeqmznwdcd
Merge bzr.dev 5764 to resolve release-notes (aka NEWS) conflicts

Show diffs side-by-side

added added

removed removed

Lines of Context:
1
 
# Copyright (C) 2005-2010 Canonical Ltd
 
1
# Copyright (C) 2005-2011 Canonical Ltd
2
2
#
3
3
# This program is free software; you can redistribute it and/or modify
4
4
# it under the terms of the GNU General Public License as published by
20
20
 
21
21
from bzrlib.lazy_import import lazy_import
22
22
lazy_import(globals(), """
23
 
import codecs
24
23
import cStringIO
25
24
import sys
26
25
import time
33
32
    bzrdir,
34
33
    directory_service,
35
34
    delta,
36
 
    config,
 
35
    config as _mod_config,
37
36
    errors,
38
37
    globbing,
39
38
    hooks,
75
74
from bzrlib.trace import mutter, note, warning, is_quiet, get_verbosity_level
76
75
 
77
76
 
 
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
 
    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]))
 
80
    return internal_tree_files(file_list, default_branch, canonicalize,
 
81
        apply_view)
86
82
 
87
83
 
88
84
def tree_files_for_add(file_list):
152
148
 
153
149
# XXX: Bad function name; should possibly also be a class method of
154
150
# WorkingTree rather than a function.
 
151
@symbol_versioning.deprecated_function(symbol_versioning.deprecated_in((2, 3, 0)))
155
152
def internal_tree_files(file_list, default_branch=u'.', canonicalize=True,
156
153
    apply_view=True):
157
154
    """Convert command-line paths to a WorkingTree and relative paths.
158
155
 
 
156
    Deprecated: use WorkingTree.open_containing_paths instead.
 
157
 
159
158
    This is typically used for command-line processors that take one or
160
159
    more filenames, and infer the workingtree that contains them.
161
160
 
171
170
 
172
171
    :return: workingtree, [relative_paths]
173
172
    """
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
 
173
    return WorkingTree.open_containing_paths(
 
174
        file_list, default_directory='.',
 
175
        canonicalize=True,
 
176
        apply_view=True)
221
177
 
222
178
 
223
179
def _get_view_info_for_change_reporter(tree):
232
188
    return view_info
233
189
 
234
190
 
 
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
 
235
199
# TODO: Make sure no commands unconditionally use the working directory as a
236
200
# branch.  If a filename argument is used, the first of them should be used to
237
201
# specify the branch.  (Perhaps this can be factored out into some kind of
286
250
    To skip the display of pending merge information altogether, use
287
251
    the no-pending option or specify a file/directory.
288
252
 
289
 
    If a revision argument is given, the status is calculated against
290
 
    that revision, or between two revisions if two are provided.
 
253
    To compare the working directory to a specific revision, pass a
 
254
    single revision to the revision argument.
 
255
 
 
256
    To see which files have changed in a specific revision, or between
 
257
    two revisions, pass a revision range to the revision argument.
 
258
    This will produce the same results as calling 'bzr diff --summarize'.
291
259
    """
292
260
 
293
261
    # TODO: --no-recurse, --recurse options
315
283
            raise errors.BzrCommandError('bzr status --revision takes exactly'
316
284
                                         ' one or two revision specifiers')
317
285
 
318
 
        tree, relfile_list = tree_files(file_list)
 
286
        tree, relfile_list = WorkingTree.open_containing_paths(file_list)
319
287
        # Avoid asking for specific files when that is not needed.
320
288
        if relfile_list == ['']:
321
289
            relfile_list = None
340
308
 
341
309
    hidden = True
342
310
    takes_args = ['revision_id?']
343
 
    takes_options = ['revision']
 
311
    takes_options = ['directory', 'revision']
344
312
    # cat-revision is more for frontends so should be exact
345
313
    encoding = 'strict'
346
314
 
353
321
        self.outf.write(revtext.decode('utf-8'))
354
322
 
355
323
    @display_command
356
 
    def run(self, revision_id=None, revision=None):
 
324
    def run(self, revision_id=None, revision=None, directory=u'.'):
357
325
        if revision_id is not None and revision is not None:
358
326
            raise errors.BzrCommandError('You can only supply one of'
359
327
                                         ' revision_id or --revision')
360
328
        if revision_id is None and revision is None:
361
329
            raise errors.BzrCommandError('You must supply either'
362
330
                                         ' --revision or a revision_id')
363
 
        b = WorkingTree.open_containing(u'.')[0].branch
 
331
 
 
332
        b = bzrdir.BzrDir.open_containing_tree_or_branch(directory)[1]
364
333
 
365
334
        revisions = b.repository.revisions
366
335
        if revisions is None:
444
413
                self.outf.write(page_bytes[:header_end])
445
414
                page_bytes = data
446
415
            self.outf.write('\nPage %d\n' % (page_idx,))
447
 
            decomp_bytes = zlib.decompress(page_bytes)
448
 
            self.outf.write(decomp_bytes)
449
 
            self.outf.write('\n')
 
416
            if len(page_bytes) == 0:
 
417
                self.outf.write('(empty)\n');
 
418
            else:
 
419
                decomp_bytes = zlib.decompress(page_bytes)
 
420
                self.outf.write(decomp_bytes)
 
421
                self.outf.write('\n')
450
422
 
451
423
    def _dump_entries(self, trans, basename):
452
424
        try:
483
455
    takes_options = [
484
456
        Option('force',
485
457
               help='Remove the working tree even if it has '
486
 
                    'uncommitted changes.'),
 
458
                    'uncommitted or shelved changes.'),
487
459
        ]
488
460
 
489
461
    def run(self, location_list, force=False):
503
475
            if not force:
504
476
                if (working.has_changes()):
505
477
                    raise errors.UncommittedChanges(working)
 
478
                if working.get_shelf_manager().last_shelf() is not None:
 
479
                    raise errors.ShelvedChanges(working)
506
480
 
507
481
            if working.user_url != working.branch.user_url:
508
482
                raise errors.BzrCommandError("You cannot remove the working tree"
511
485
            d.destroy_workingtree()
512
486
 
513
487
 
 
488
class cmd_repair_workingtree(Command):
 
489
    __doc__ = """Reset the working tree state file.
 
490
 
 
491
    This is not meant to be used normally, but more as a way to recover from
 
492
    filesystem corruption, etc. This rebuilds the working inventory back to a
 
493
    'known good' state. Any new modifications (adding a file, renaming, etc)
 
494
    will be lost, though modified files will still be detected as such.
 
495
 
 
496
    Most users will want something more like "bzr revert" or "bzr update"
 
497
    unless the state file has become corrupted.
 
498
 
 
499
    By default this attempts to recover the current state by looking at the
 
500
    headers of the state file. If the state file is too corrupted to even do
 
501
    that, you can supply --revision to force the state of the tree.
 
502
    """
 
503
 
 
504
    takes_options = ['revision', 'directory',
 
505
        Option('force',
 
506
               help='Reset the tree even if it doesn\'t appear to be'
 
507
                    ' corrupted.'),
 
508
    ]
 
509
    hidden = True
 
510
 
 
511
    def run(self, revision=None, directory='.', force=False):
 
512
        tree, _ = WorkingTree.open_containing(directory)
 
513
        self.add_cleanup(tree.lock_tree_write().unlock)
 
514
        if not force:
 
515
            try:
 
516
                tree.check_state()
 
517
            except errors.BzrError:
 
518
                pass # There seems to be a real error here, so we'll reset
 
519
            else:
 
520
                # Refuse
 
521
                raise errors.BzrCommandError(
 
522
                    'The tree does not appear to be corrupt. You probably'
 
523
                    ' want "bzr revert" instead. Use "--force" if you are'
 
524
                    ' sure you want to reset the working tree.')
 
525
        if revision is None:
 
526
            revision_ids = None
 
527
        else:
 
528
            revision_ids = [r.as_revision_id(tree.branch) for r in revision]
 
529
        try:
 
530
            tree.reset_state(revision_ids)
 
531
        except errors.BzrError, e:
 
532
            if revision_ids is None:
 
533
                extra = (', the header appears corrupt, try passing -r -1'
 
534
                         ' to set the state to the last commit')
 
535
            else:
 
536
                extra = ''
 
537
            raise errors.BzrCommandError('failed to reset the tree state'
 
538
                                         + extra)
 
539
 
 
540
 
514
541
class cmd_revno(Command):
515
542
    __doc__ = """Show current revision number.
516
543
 
528
555
        if tree:
529
556
            try:
530
557
                wt = WorkingTree.open_containing(location)[0]
531
 
                wt.lock_read()
 
558
                self.add_cleanup(wt.lock_read().unlock)
532
559
            except (errors.NoWorkingTree, errors.NotLocalUrl):
533
560
                raise errors.NoWorkingTree(location)
534
 
            self.add_cleanup(wt.unlock)
535
561
            revid = wt.last_revision()
536
562
            try:
537
563
                revno_t = wt.branch.revision_id_to_dotted_revno(revid)
540
566
            revno = ".".join(str(n) for n in revno_t)
541
567
        else:
542
568
            b = Branch.open_containing(location)[0]
543
 
            b.lock_read()
544
 
            self.add_cleanup(b.unlock)
 
569
            self.add_cleanup(b.lock_read().unlock)
545
570
            revno = b.revno()
546
571
        self.cleanup_now()
547
572
        self.outf.write(str(revno) + '\n')
554
579
    takes_args = ['revision_info*']
555
580
    takes_options = [
556
581
        'revision',
557
 
        Option('directory',
 
582
        custom_help('directory',
558
583
            help='Branch to examine, '
559
 
                 'rather than the one containing the working directory.',
560
 
            short_name='d',
561
 
            type=unicode,
562
 
            ),
 
584
                 'rather than the one containing the working directory.'),
563
585
        Option('tree', help='Show revno of working tree'),
564
586
        ]
565
587
 
570
592
        try:
571
593
            wt = WorkingTree.open_containing(directory)[0]
572
594
            b = wt.branch
573
 
            wt.lock_read()
574
 
            self.add_cleanup(wt.unlock)
 
595
            self.add_cleanup(wt.lock_read().unlock)
575
596
        except (errors.NoWorkingTree, errors.NotLocalUrl):
576
597
            wt = None
577
598
            b = Branch.open_containing(directory)[0]
578
 
            b.lock_read()
579
 
            self.add_cleanup(b.unlock)
 
599
            self.add_cleanup(b.lock_read().unlock)
580
600
        revision_ids = []
581
601
        if revision is not None:
582
602
            revision_ids.extend(rev.as_revision_id(b) for rev in revision)
681
701
                should_print=(not is_quiet()))
682
702
 
683
703
        if base_tree:
684
 
            base_tree.lock_read()
685
 
            self.add_cleanup(base_tree.unlock)
 
704
            self.add_cleanup(base_tree.lock_read().unlock)
686
705
        tree, file_list = tree_files_for_add(file_list)
687
706
        added, ignored = tree.smart_add(file_list, not
688
707
            no_recurse, action=action, save=not dry_run)
759
778
            raise errors.BzrCommandError('invalid kind %r specified' % (kind,))
760
779
 
761
780
        revision = _get_one_revision('inventory', revision)
762
 
        work_tree, file_list = tree_files(file_list)
763
 
        work_tree.lock_read()
764
 
        self.add_cleanup(work_tree.unlock)
 
781
        work_tree, file_list = WorkingTree.open_containing_paths(file_list)
 
782
        self.add_cleanup(work_tree.lock_read().unlock)
765
783
        if revision is not None:
766
784
            tree = revision.as_tree(work_tree.branch)
767
785
 
768
786
            extra_trees = [work_tree]
769
 
            tree.lock_read()
770
 
            self.add_cleanup(tree.unlock)
 
787
            self.add_cleanup(tree.lock_read().unlock)
771
788
        else:
772
789
            tree = work_tree
773
790
            extra_trees = []
832
849
            names_list = []
833
850
        if len(names_list) < 2:
834
851
            raise errors.BzrCommandError("missing file argument")
835
 
        tree, rel_names = tree_files(names_list, canonicalize=False)
836
 
        tree.lock_tree_write()
837
 
        self.add_cleanup(tree.unlock)
 
852
        tree, rel_names = WorkingTree.open_containing_paths(names_list, canonicalize=False)
 
853
        self.add_cleanup(tree.lock_tree_write().unlock)
838
854
        self._run(tree, names_list, rel_names, after)
839
855
 
840
856
    def run_auto(self, names_list, after, dry_run):
844
860
        if after:
845
861
            raise errors.BzrCommandError('--after cannot be specified with'
846
862
                                         ' --auto.')
847
 
        work_tree, file_list = tree_files(names_list, default_branch='.')
848
 
        work_tree.lock_tree_write()
849
 
        self.add_cleanup(work_tree.unlock)
 
863
        work_tree, file_list = WorkingTree.open_containing_paths(
 
864
            names_list, default_directory='.')
 
865
        self.add_cleanup(work_tree.lock_tree_write().unlock)
850
866
        rename_map.RenameMap.guess_renames(work_tree, dry_run)
851
867
 
852
868
    def _run(self, tree, names_list, rel_names, after):
960
976
    takes_options = ['remember', 'overwrite', 'revision',
961
977
        custom_help('verbose',
962
978
            help='Show logs of pulled revisions.'),
963
 
        Option('directory',
 
979
        custom_help('directory',
964
980
            help='Branch to pull into, '
965
 
                 'rather than the one containing the working directory.',
966
 
            short_name='d',
967
 
            type=unicode,
968
 
            ),
 
981
                 'rather than the one containing the working directory.'),
969
982
        Option('local',
970
983
            help="Perform a local pull in a bound "
971
984
                 "branch.  Local pulls are not applied to "
972
985
                 "the master branch."
973
986
            ),
 
987
        Option('show-base',
 
988
            help="Show base revision text in conflicts.")
974
989
        ]
975
990
    takes_args = ['location?']
976
991
    encoding_type = 'replace'
977
992
 
978
993
    def run(self, location=None, remember=False, overwrite=False,
979
994
            revision=None, verbose=False,
980
 
            directory=None, local=False):
 
995
            directory=None, local=False,
 
996
            show_base=False):
981
997
        # FIXME: too much stuff is in the command class
982
998
        revision_id = None
983
999
        mergeable = None
986
1002
        try:
987
1003
            tree_to = WorkingTree.open_containing(directory)[0]
988
1004
            branch_to = tree_to.branch
989
 
            tree_to.lock_write()
990
 
            self.add_cleanup(tree_to.unlock)
 
1005
            self.add_cleanup(tree_to.lock_write().unlock)
991
1006
        except errors.NoWorkingTree:
992
1007
            tree_to = None
993
1008
            branch_to = Branch.open_containing(directory)[0]
994
 
            branch_to.lock_write()
995
 
            self.add_cleanup(branch_to.unlock)
 
1009
            self.add_cleanup(branch_to.lock_write().unlock)
 
1010
 
 
1011
        if tree_to is None and show_base:
 
1012
            raise errors.BzrCommandError("Need working tree for --show-base.")
996
1013
 
997
1014
        if local and not branch_to.get_bound_location():
998
1015
            raise errors.LocalRequiresBoundBranch()
1029
1046
        else:
1030
1047
            branch_from = Branch.open(location,
1031
1048
                possible_transports=possible_transports)
1032
 
            branch_from.lock_read()
1033
 
            self.add_cleanup(branch_from.unlock)
 
1049
            self.add_cleanup(branch_from.lock_read().unlock)
1034
1050
 
1035
1051
            if branch_to.get_parent() is None or remember:
1036
1052
                branch_to.set_parent(branch_from.base)
1045
1061
                view_info=view_info)
1046
1062
            result = tree_to.pull(
1047
1063
                branch_from, overwrite, revision_id, change_reporter,
1048
 
                possible_transports=possible_transports, local=local)
 
1064
                possible_transports=possible_transports, local=local,
 
1065
                show_base=show_base)
1049
1066
        else:
1050
1067
            result = branch_to.pull(
1051
1068
                branch_from, overwrite, revision_id, local=local)
1055
1072
            log.show_branch_change(
1056
1073
                branch_to, self.outf, result.old_revno,
1057
1074
                result.old_revid)
 
1075
        if getattr(result, 'tag_conflicts', None):
 
1076
            return 1
 
1077
        else:
 
1078
            return 0
1058
1079
 
1059
1080
 
1060
1081
class cmd_push(Command):
1088
1109
        Option('create-prefix',
1089
1110
               help='Create the path leading up to the branch '
1090
1111
                    'if it does not already exist.'),
1091
 
        Option('directory',
 
1112
        custom_help('directory',
1092
1113
            help='Branch to push from, '
1093
 
                 'rather than the one containing the working directory.',
1094
 
            short_name='d',
1095
 
            type=unicode,
1096
 
            ),
 
1114
                 'rather than the one containing the working directory.'),
1097
1115
        Option('use-existing-dir',
1098
1116
               help='By default push will fail if the target'
1099
1117
                    ' directory exists, but does not already'
1110
1128
        Option('strict',
1111
1129
               help='Refuse to push if there are uncommitted changes in'
1112
1130
               ' the working tree, --no-strict disables the check.'),
 
1131
        Option('no-tree',
 
1132
               help="Don't populate the working tree, even for protocols"
 
1133
               " that support it."),
1113
1134
        ]
1114
1135
    takes_args = ['location?']
1115
1136
    encoding_type = 'replace'
1117
1138
    def run(self, location=None, remember=False, overwrite=False,
1118
1139
        create_prefix=False, verbose=False, revision=None,
1119
1140
        use_existing_dir=False, directory=None, stacked_on=None,
1120
 
        stacked=False, strict=None):
 
1141
        stacked=False, strict=None, no_tree=False):
1121
1142
        from bzrlib.push import _show_push_branch
1122
1143
 
1123
1144
        if directory is None:
1169
1190
        _show_push_branch(br_from, revision_id, location, self.outf,
1170
1191
            verbose=verbose, overwrite=overwrite, remember=remember,
1171
1192
            stacked_on=stacked_on, create_prefix=create_prefix,
1172
 
            use_existing_dir=use_existing_dir)
 
1193
            use_existing_dir=use_existing_dir, no_tree=no_tree)
1173
1194
 
1174
1195
 
1175
1196
class cmd_branch(Command):
1188
1209
 
1189
1210
    _see_also = ['checkout']
1190
1211
    takes_args = ['from_location', 'to_location?']
1191
 
    takes_options = ['revision', Option('hardlink',
1192
 
        help='Hard-link working tree files where possible.'),
 
1212
    takes_options = ['revision',
 
1213
        Option('hardlink', help='Hard-link working tree files where possible.'),
 
1214
        Option('files-from', type=str,
 
1215
               help="Get file contents from this tree."),
1193
1216
        Option('no-tree',
1194
1217
            help="Create a branch without a working-tree."),
1195
1218
        Option('switch',
1213
1236
 
1214
1237
    def run(self, from_location, to_location=None, revision=None,
1215
1238
            hardlink=False, stacked=False, standalone=False, no_tree=False,
1216
 
            use_existing_dir=False, switch=False, bind=False):
 
1239
            use_existing_dir=False, switch=False, bind=False,
 
1240
            files_from=None):
1217
1241
        from bzrlib import switch as _mod_switch
1218
1242
        from bzrlib.tag import _merge_tags_if_possible
1219
1243
        accelerator_tree, br_from = bzrdir.BzrDir.open_tree_or_branch(
1220
1244
            from_location)
 
1245
        if not (hardlink or files_from):
 
1246
            # accelerator_tree is usually slower because you have to read N
 
1247
            # files (no readahead, lots of seeks, etc), but allow the user to
 
1248
            # explicitly request it
 
1249
            accelerator_tree = None
 
1250
        if files_from is not None and files_from != from_location:
 
1251
            accelerator_tree = WorkingTree.open(files_from)
1221
1252
        revision = _get_one_revision('branch', revision)
1222
 
        br_from.lock_read()
1223
 
        self.add_cleanup(br_from.unlock)
 
1253
        self.add_cleanup(br_from.lock_read().unlock)
1224
1254
        if revision is not None:
1225
1255
            revision_id = revision.as_revision_id(br_from)
1226
1256
        else:
1331
1361
            to_location = branch_location
1332
1362
        accelerator_tree, source = bzrdir.BzrDir.open_tree_or_branch(
1333
1363
            branch_location)
 
1364
        if not (hardlink or files_from):
 
1365
            # accelerator_tree is usually slower because you have to read N
 
1366
            # files (no readahead, lots of seeks, etc), but allow the user to
 
1367
            # explicitly request it
 
1368
            accelerator_tree = None
1334
1369
        revision = _get_one_revision('checkout', revision)
1335
 
        if files_from is not None:
 
1370
        if files_from is not None and files_from != branch_location:
1336
1371
            accelerator_tree = WorkingTree.open(files_from)
1337
1372
        if revision is not None:
1338
1373
            revision_id = revision.as_revision_id(source)
1366
1401
    @display_command
1367
1402
    def run(self, dir=u'.'):
1368
1403
        tree = WorkingTree.open_containing(dir)[0]
1369
 
        tree.lock_read()
1370
 
        self.add_cleanup(tree.unlock)
 
1404
        self.add_cleanup(tree.lock_read().unlock)
1371
1405
        new_inv = tree.inventory
1372
1406
        old_tree = tree.basis_tree()
1373
 
        old_tree.lock_read()
1374
 
        self.add_cleanup(old_tree.unlock)
 
1407
        self.add_cleanup(old_tree.lock_read().unlock)
1375
1408
        old_inv = old_tree.inventory
1376
1409
        renames = []
1377
1410
        iterator = tree.iter_changes(old_tree, include_unchanged=True)
1396
1429
    If you want to discard your local changes, you can just do a
1397
1430
    'bzr revert' instead of 'bzr commit' after the update.
1398
1431
 
 
1432
    If you want to restore a file that has been removed locally, use
 
1433
    'bzr revert' instead of 'bzr update'.
 
1434
 
1399
1435
    If the tree's branch is bound to a master branch, it will also update
1400
1436
    the branch from the master.
1401
1437
    """
1402
1438
 
1403
1439
    _see_also = ['pull', 'working-trees', 'status-flags']
1404
1440
    takes_args = ['dir?']
1405
 
    takes_options = ['revision']
 
1441
    takes_options = ['revision',
 
1442
                     Option('show-base',
 
1443
                            help="Show base revision text in conflicts."),
 
1444
                     ]
1406
1445
    aliases = ['up']
1407
1446
 
1408
 
    def run(self, dir='.', revision=None):
 
1447
    def run(self, dir='.', revision=None, show_base=None):
1409
1448
        if revision is not None and len(revision) != 1:
1410
1449
            raise errors.BzrCommandError(
1411
1450
                        "bzr update --revision takes exactly one revision")
1415
1454
        master = branch.get_master_branch(
1416
1455
            possible_transports=possible_transports)
1417
1456
        if master is not None:
1418
 
            tree.lock_write()
1419
1457
            branch_location = master.base
 
1458
            tree.lock_write()
1420
1459
        else:
 
1460
            branch_location = tree.branch.base
1421
1461
            tree.lock_tree_write()
1422
 
            branch_location = tree.branch.base
1423
1462
        self.add_cleanup(tree.unlock)
1424
1463
        # get rid of the final '/' and be ready for display
1425
1464
        branch_location = urlutils.unescape_for_display(
1451
1490
                change_reporter,
1452
1491
                possible_transports=possible_transports,
1453
1492
                revision=revision_id,
1454
 
                old_tip=old_tip)
 
1493
                old_tip=old_tip,
 
1494
                show_base=show_base)
1455
1495
        except errors.NoSuchRevision, e:
1456
1496
            raise errors.BzrCommandError(
1457
1497
                                  "branch has no revision %s\n"
1519
1559
class cmd_remove(Command):
1520
1560
    __doc__ = """Remove files or directories.
1521
1561
 
1522
 
    This makes bzr stop tracking changes to the specified files. bzr will delete
1523
 
    them if they can easily be recovered using revert. If no options or
1524
 
    parameters are given bzr will scan for files that are being tracked by bzr
1525
 
    but missing in your tree and stop tracking them for you.
 
1562
    This makes Bazaar stop tracking changes to the specified files. Bazaar will
 
1563
    delete them if they can easily be recovered using revert otherwise they
 
1564
    will be backed up (adding an extention of the form .~#~). If no options or
 
1565
    parameters are given Bazaar will scan for files that are being tracked by
 
1566
    Bazaar but missing in your tree and stop tracking them for you.
1526
1567
    """
1527
1568
    takes_args = ['file*']
1528
1569
    takes_options = ['verbose',
1530
1571
        RegistryOption.from_kwargs('file-deletion-strategy',
1531
1572
            'The file deletion mode to be used.',
1532
1573
            title='Deletion Strategy', value_switches=True, enum_switch=False,
1533
 
            safe='Only delete files if they can be'
1534
 
                 ' safely recovered (default).',
 
1574
            safe='Backup changed files (default).',
1535
1575
            keep='Delete from bzr but leave the working copy.',
 
1576
            no_backup='Don\'t backup changed files.',
1536
1577
            force='Delete all the specified files, even if they can not be '
1537
 
                'recovered and even if they are non-empty directories.')]
 
1578
                'recovered and even if they are non-empty directories. '
 
1579
                '(deprecated, use no-backup)')]
1538
1580
    aliases = ['rm', 'del']
1539
1581
    encoding_type = 'replace'
1540
1582
 
1541
1583
    def run(self, file_list, verbose=False, new=False,
1542
1584
        file_deletion_strategy='safe'):
1543
 
        tree, file_list = tree_files(file_list)
 
1585
        if file_deletion_strategy == 'force':
 
1586
            note("(The --force option is deprecated, rather use --no-backup "
 
1587
                "in future.)")
 
1588
            file_deletion_strategy = 'no-backup'
 
1589
 
 
1590
        tree, file_list = WorkingTree.open_containing_paths(file_list)
1544
1591
 
1545
1592
        if file_list is not None:
1546
1593
            file_list = [f for f in file_list]
1547
1594
 
1548
 
        tree.lock_write()
1549
 
        self.add_cleanup(tree.unlock)
 
1595
        self.add_cleanup(tree.lock_write().unlock)
1550
1596
        # Heuristics should probably all move into tree.remove_smart or
1551
1597
        # some such?
1552
1598
        if new:
1567
1613
            file_deletion_strategy = 'keep'
1568
1614
        tree.remove(file_list, verbose=verbose, to_file=self.outf,
1569
1615
            keep_files=file_deletion_strategy=='keep',
1570
 
            force=file_deletion_strategy=='force')
 
1616
            force=(file_deletion_strategy=='no-backup'))
1571
1617
 
1572
1618
 
1573
1619
class cmd_file_id(Command):
1635
1681
 
1636
1682
    _see_also = ['check']
1637
1683
    takes_args = ['branch?']
 
1684
    takes_options = [
 
1685
        Option('canonicalize-chks',
 
1686
               help='Make sure CHKs are in canonical form (repairs '
 
1687
                    'bug 522637).',
 
1688
               hidden=True),
 
1689
        ]
1638
1690
 
1639
 
    def run(self, branch="."):
 
1691
    def run(self, branch=".", canonicalize_chks=False):
1640
1692
        from bzrlib.reconcile import reconcile
1641
1693
        dir = bzrdir.BzrDir.open(branch)
1642
 
        reconcile(dir)
 
1694
        reconcile(dir, canonicalize_chks=canonicalize_chks)
1643
1695
 
1644
1696
 
1645
1697
class cmd_revision_history(Command):
1722
1774
                ),
1723
1775
         Option('append-revisions-only',
1724
1776
                help='Never change revnos or the existing log.'
1725
 
                '  Append revisions to it only.')
 
1777
                '  Append revisions to it only.'),
 
1778
         Option('no-tree',
 
1779
                'Create a branch without a working tree.')
1726
1780
         ]
1727
1781
    def run(self, location=None, format=None, append_revisions_only=False,
1728
 
            create_prefix=False):
 
1782
            create_prefix=False, no_tree=False):
1729
1783
        if format is None:
1730
1784
            format = bzrdir.format_registry.make_bzrdir('default')
1731
1785
        if location is None:
1754
1808
        except errors.NotBranchError:
1755
1809
            # really a NotBzrDir error...
1756
1810
            create_branch = bzrdir.BzrDir.create_branch_convenience
 
1811
            if no_tree:
 
1812
                force_new_tree = False
 
1813
            else:
 
1814
                force_new_tree = None
1757
1815
            branch = create_branch(to_transport.base, format=format,
1758
 
                                   possible_transports=[to_transport])
 
1816
                                   possible_transports=[to_transport],
 
1817
                                   force_new_tree=force_new_tree)
1759
1818
            a_bzrdir = branch.bzrdir
1760
1819
        else:
1761
1820
            from bzrlib.transport.local import LocalTransport
1765
1824
                        raise errors.BranchExistsWithoutWorkingTree(location)
1766
1825
                raise errors.AlreadyBranchError(location)
1767
1826
            branch = a_bzrdir.create_branch()
1768
 
            a_bzrdir.create_workingtree()
 
1827
            if not no_tree:
 
1828
                a_bzrdir.create_workingtree()
1769
1829
        if append_revisions_only:
1770
1830
            try:
1771
1831
                branch.set_append_revisions_only(True)
1865
1925
    "bzr diff -p1" is equivalent to "bzr diff --prefix old/:new/", and
1866
1926
    produces patches suitable for "patch -p1".
1867
1927
 
 
1928
    Note that when using the -r argument with a range of revisions, the
 
1929
    differences are computed between the two specified revisions.  That
 
1930
    is, the command does not show the changes introduced by the first 
 
1931
    revision in the range.  This differs from the interpretation of 
 
1932
    revision ranges used by "bzr log" which includes the first revision
 
1933
    in the range.
 
1934
 
1868
1935
    :Exit values:
1869
1936
        1 - changed
1870
1937
        2 - unrepresentable changes
1888
1955
 
1889
1956
            bzr diff -r1..3 xxx
1890
1957
 
1891
 
        To see the changes introduced in revision X::
 
1958
        The changes introduced by revision 2 (equivalent to -r1..2)::
 
1959
 
 
1960
            bzr diff -c2
 
1961
 
 
1962
        To see the changes introduced by revision X::
1892
1963
        
1893
1964
            bzr diff -cX
1894
1965
 
1898
1969
 
1899
1970
            bzr diff -r<chosen_parent>..X
1900
1971
 
1901
 
        The changes introduced by revision 2 (equivalent to -r1..2)::
 
1972
        The changes between the current revision and the previous revision
 
1973
        (equivalent to -c-1 and -r-2..-1)
1902
1974
 
1903
 
            bzr diff -c2
 
1975
            bzr diff -r-2..
1904
1976
 
1905
1977
        Show just the differences for file NEWS::
1906
1978
 
1921
1993
        Same as 'bzr diff' but prefix paths with old/ and new/::
1922
1994
 
1923
1995
            bzr diff --prefix old/:new/
 
1996
            
 
1997
        Show the differences using a custom diff program with options::
 
1998
        
 
1999
            bzr diff --using /usr/bin/diff --diff-options -wu
1924
2000
    """
1925
2001
    _see_also = ['status']
1926
2002
    takes_args = ['file*']
1946
2022
            type=unicode,
1947
2023
            ),
1948
2024
        RegistryOption('format',
 
2025
            short_name='F',
1949
2026
            help='Diff format to use.',
1950
2027
            lazy_registry=('bzrlib.diff', 'format_registry'),
1951
 
            value_switches=False, title='Diff format'),
 
2028
            title='Diff format'),
1952
2029
        ]
1953
2030
    aliases = ['di', 'dif']
1954
2031
    encoding_type = 'exact'
1985
2062
         old_branch, new_branch,
1986
2063
         specific_files, extra_trees) = get_trees_and_branches_to_diff_locked(
1987
2064
            file_list, revision, old, new, self.add_cleanup, apply_view=True)
 
2065
        # GNU diff on Windows uses ANSI encoding for filenames
 
2066
        path_encoding = osutils.get_diff_header_encoding()
1988
2067
        return show_diff_trees(old_tree, new_tree, sys.stdout,
1989
2068
                               specific_files=specific_files,
1990
2069
                               external_diff_options=diff_options,
1991
2070
                               old_label=old_label, new_label=new_label,
1992
 
                               extra_trees=extra_trees, using=using,
 
2071
                               extra_trees=extra_trees,
 
2072
                               path_encoding=path_encoding,
 
2073
                               using=using,
1993
2074
                               format_cls=format)
1994
2075
 
1995
2076
 
2003
2084
    # level of effort but possibly much less IO.  (Or possibly not,
2004
2085
    # if the directories are very large...)
2005
2086
    _see_also = ['status', 'ls']
2006
 
    takes_options = ['show-ids']
 
2087
    takes_options = ['directory', 'show-ids']
2007
2088
 
2008
2089
    @display_command
2009
 
    def run(self, show_ids=False):
2010
 
        tree = WorkingTree.open_containing(u'.')[0]
2011
 
        tree.lock_read()
2012
 
        self.add_cleanup(tree.unlock)
 
2090
    def run(self, show_ids=False, directory=u'.'):
 
2091
        tree = WorkingTree.open_containing(directory)[0]
 
2092
        self.add_cleanup(tree.lock_read().unlock)
2013
2093
        old = tree.basis_tree()
2014
 
        old.lock_read()
2015
 
        self.add_cleanup(old.unlock)
 
2094
        self.add_cleanup(old.lock_read().unlock)
2016
2095
        for path, ie in old.inventory.iter_entries():
2017
2096
            if not tree.has_id(ie.file_id):
2018
2097
                self.outf.write(path)
2028
2107
 
2029
2108
    hidden = True
2030
2109
    _see_also = ['status', 'ls']
2031
 
    takes_options = [
2032
 
            Option('null',
2033
 
                   help='Write an ascii NUL (\\0) separator '
2034
 
                   'between files rather than a newline.')
2035
 
            ]
 
2110
    takes_options = ['directory', 'null']
2036
2111
 
2037
2112
    @display_command
2038
 
    def run(self, null=False):
2039
 
        tree = WorkingTree.open_containing(u'.')[0]
 
2113
    def run(self, null=False, directory=u'.'):
 
2114
        tree = WorkingTree.open_containing(directory)[0]
 
2115
        self.add_cleanup(tree.lock_read().unlock)
2040
2116
        td = tree.changes_from(tree.basis_tree())
 
2117
        self.cleanup_now()
2041
2118
        for path, id, kind, text_modified, meta_modified in td.modified:
2042
2119
            if null:
2043
2120
                self.outf.write(path + '\0')
2051
2128
 
2052
2129
    hidden = True
2053
2130
    _see_also = ['status', 'ls']
2054
 
    takes_options = [
2055
 
            Option('null',
2056
 
                   help='Write an ascii NUL (\\0) separator '
2057
 
                   'between files rather than a newline.')
2058
 
            ]
 
2131
    takes_options = ['directory', 'null']
2059
2132
 
2060
2133
    @display_command
2061
 
    def run(self, null=False):
2062
 
        wt = WorkingTree.open_containing(u'.')[0]
2063
 
        wt.lock_read()
2064
 
        self.add_cleanup(wt.unlock)
 
2134
    def run(self, null=False, directory=u'.'):
 
2135
        wt = WorkingTree.open_containing(directory)[0]
 
2136
        self.add_cleanup(wt.lock_read().unlock)
2065
2137
        basis = wt.basis_tree()
2066
 
        basis.lock_read()
2067
 
        self.add_cleanup(basis.unlock)
 
2138
        self.add_cleanup(basis.lock_read().unlock)
2068
2139
        basis_inv = basis.inventory
2069
2140
        inv = wt.inventory
2070
2141
        for file_id in inv:
2073
2144
            if inv.is_root(file_id) and len(basis_inv) == 0:
2074
2145
                continue
2075
2146
            path = inv.id2path(file_id)
2076
 
            if not os.access(osutils.abspath(path), os.F_OK):
 
2147
            if not os.access(osutils.pathjoin(wt.basedir, path), os.F_OK):
2077
2148
                continue
2078
2149
            if null:
2079
2150
                self.outf.write(path + '\0')
2279
2350
                   help='Show just the specified revision.'
2280
2351
                   ' See also "help revisionspec".'),
2281
2352
            'log-format',
 
2353
            RegistryOption('authors',
 
2354
                'What names to list as authors - first, all or committer.',
 
2355
                title='Authors',
 
2356
                lazy_registry=('bzrlib.log', 'author_list_registry'),
 
2357
            ),
2282
2358
            Option('levels',
2283
2359
                   short_name='n',
2284
2360
                   help='Number of levels to display - 0 for all, 1 for flat.',
2319
2395
            limit=None,
2320
2396
            show_diff=False,
2321
2397
            include_merges=False,
 
2398
            authors=None,
2322
2399
            exclude_common_ancestry=False,
2323
2400
            ):
2324
2401
        from bzrlib.log import (
2352
2429
        if file_list:
2353
2430
            # find the file ids to log and check for directory filtering
2354
2431
            b, file_info_list, rev1, rev2 = _get_info_for_log_files(
2355
 
                revision, file_list)
2356
 
            self.add_cleanup(b.unlock)
 
2432
                revision, file_list, self.add_cleanup)
2357
2433
            for relpath, file_id, kind in file_info_list:
2358
2434
                if file_id is None:
2359
2435
                    raise errors.BzrCommandError(
2377
2453
                location = '.'
2378
2454
            dir, relpath = bzrdir.BzrDir.open_containing(location)
2379
2455
            b = dir.open_branch()
2380
 
            b.lock_read()
2381
 
            self.add_cleanup(b.unlock)
 
2456
            self.add_cleanup(b.lock_read().unlock)
2382
2457
            rev1, rev2 = _get_revision_range(revision, b, self.name())
2383
2458
 
2384
2459
        # Decide on the type of delta & diff filtering to use
2404
2479
                        show_timezone=timezone,
2405
2480
                        delta_format=get_verbosity_level(),
2406
2481
                        levels=levels,
2407
 
                        show_advice=levels is None)
 
2482
                        show_advice=levels is None,
 
2483
                        author_list_handler=authors)
2408
2484
 
2409
2485
        # Choose the algorithm for doing the logging. It's annoying
2410
2486
        # having multiple code paths like this but necessary until
2508
2584
        tree, relpath = WorkingTree.open_containing(filename)
2509
2585
        file_id = tree.path2id(relpath)
2510
2586
        b = tree.branch
2511
 
        b.lock_read()
2512
 
        self.add_cleanup(b.unlock)
 
2587
        self.add_cleanup(b.lock_read().unlock)
2513
2588
        touching_revs = log.find_touching_revisions(b, file_id)
2514
2589
        for revno, revision_id, what in touching_revs:
2515
2590
            self.outf.write("%6d %s\n" % (revno, what))
2528
2603
                   help='Recurse into subdirectories.'),
2529
2604
            Option('from-root',
2530
2605
                   help='Print paths relative to the root of the branch.'),
2531
 
            Option('unknown', help='Print unknown files.'),
 
2606
            Option('unknown', short_name='u',
 
2607
                help='Print unknown files.'),
2532
2608
            Option('versioned', help='Print versioned files.',
2533
2609
                   short_name='V'),
2534
 
            Option('ignored', help='Print ignored files.'),
2535
 
            Option('null',
2536
 
                   help='Write an ascii NUL (\\0) separator '
2537
 
                   'between files rather than a newline.'),
2538
 
            Option('kind',
 
2610
            Option('ignored', short_name='i',
 
2611
                help='Print ignored files.'),
 
2612
            Option('kind', short_name='k',
2539
2613
                   help='List entries of a particular kind: file, directory, symlink.',
2540
2614
                   type=unicode),
 
2615
            'null',
2541
2616
            'show-ids',
 
2617
            'directory',
2542
2618
            ]
2543
2619
    @display_command
2544
2620
    def run(self, revision=None, verbose=False,
2545
2621
            recursive=False, from_root=False,
2546
2622
            unknown=False, versioned=False, ignored=False,
2547
 
            null=False, kind=None, show_ids=False, path=None):
 
2623
            null=False, kind=None, show_ids=False, path=None, directory=None):
2548
2624
 
2549
2625
        if kind and kind not in ('file', 'directory', 'symlink'):
2550
2626
            raise errors.BzrCommandError('invalid kind specified')
2562
2638
                raise errors.BzrCommandError('cannot specify both --from-root'
2563
2639
                                             ' and PATH')
2564
2640
            fs_path = path
2565
 
        tree, branch, relpath = bzrdir.BzrDir.open_containing_tree_or_branch(
2566
 
            fs_path)
 
2641
        tree, branch, relpath = \
 
2642
            _open_directory_or_containing_tree_or_branch(fs_path, directory)
2567
2643
 
2568
2644
        # Calculate the prefix to use
2569
2645
        prefix = None
2584
2660
                view_str = views.view_display_str(view_files)
2585
2661
                note("Ignoring files outside view. View is %s" % view_str)
2586
2662
 
2587
 
        tree.lock_read()
2588
 
        self.add_cleanup(tree.unlock)
 
2663
        self.add_cleanup(tree.lock_read().unlock)
2589
2664
        for fp, fc, fkind, fid, entry in tree.list_files(include_root=False,
2590
2665
            from_dir=relpath, recursive=recursive):
2591
2666
            # Apply additional masking
2638
2713
 
2639
2714
    hidden = True
2640
2715
    _see_also = ['ls']
 
2716
    takes_options = ['directory']
2641
2717
 
2642
2718
    @display_command
2643
 
    def run(self):
2644
 
        for f in WorkingTree.open_containing(u'.')[0].unknowns():
 
2719
    def run(self, directory=u'.'):
 
2720
        for f in WorkingTree.open_containing(directory)[0].unknowns():
2645
2721
            self.outf.write(osutils.quotefn(f) + '\n')
2646
2722
 
2647
2723
 
2674
2750
    Patterns prefixed with '!!' act as regular ignore patterns, but have
2675
2751
    precedence over the '!' exception patterns.
2676
2752
 
2677
 
    Note: ignore patterns containing shell wildcards must be quoted from
2678
 
    the shell on Unix.
 
2753
    :Notes: 
 
2754
        
 
2755
    * Ignore patterns containing shell wildcards must be quoted from
 
2756
      the shell on Unix.
 
2757
 
 
2758
    * Ignore patterns starting with "#" act as comments in the ignore file.
 
2759
      To ignore patterns that begin with that character, use the "RE:" prefix.
2679
2760
 
2680
2761
    :Examples:
2681
2762
        Ignore the top level Makefile::
2690
2771
 
2691
2772
            bzr ignore "!special.class"
2692
2773
 
 
2774
        Ignore files whose name begins with the "#" character::
 
2775
 
 
2776
            bzr ignore "RE:^#"
 
2777
 
2693
2778
        Ignore .o files under the lib directory::
2694
2779
 
2695
2780
            bzr ignore "lib/**/*.o"
2703
2788
            bzr ignore "RE:(?!debian/).*"
2704
2789
        
2705
2790
        Ignore everything except the "local" toplevel directory,
2706
 
        but always ignore "*~" autosave files, even under local/::
 
2791
        but always ignore autosave files ending in ~, even under local/::
2707
2792
        
2708
2793
            bzr ignore "*"
2709
2794
            bzr ignore "!./local"
2712
2797
 
2713
2798
    _see_also = ['status', 'ignored', 'patterns']
2714
2799
    takes_args = ['name_pattern*']
2715
 
    takes_options = [
 
2800
    takes_options = ['directory',
2716
2801
        Option('default-rules',
2717
2802
               help='Display the default ignore rules that bzr uses.')
2718
2803
        ]
2719
2804
 
2720
 
    def run(self, name_pattern_list=None, default_rules=None):
 
2805
    def run(self, name_pattern_list=None, default_rules=None,
 
2806
            directory=u'.'):
2721
2807
        from bzrlib import ignores
2722
2808
        if default_rules is not None:
2723
2809
            # dump the default rules and exit
2729
2815
                "NAME_PATTERN or --default-rules.")
2730
2816
        name_pattern_list = [globbing.normalize_pattern(p)
2731
2817
                             for p in name_pattern_list]
 
2818
        bad_patterns = ''
 
2819
        for p in name_pattern_list:
 
2820
            if not globbing.Globster.is_pattern_valid(p):
 
2821
                bad_patterns += ('\n  %s' % p)
 
2822
        if bad_patterns:
 
2823
            msg = ('Invalid ignore pattern(s) found. %s' % bad_patterns)
 
2824
            ui.ui_factory.show_error(msg)
 
2825
            raise errors.InvalidPattern('')
2732
2826
        for name_pattern in name_pattern_list:
2733
2827
            if (name_pattern[0] == '/' or
2734
2828
                (len(name_pattern) > 1 and name_pattern[1] == ':')):
2735
2829
                raise errors.BzrCommandError(
2736
2830
                    "NAME_PATTERN should not be an absolute path")
2737
 
        tree, relpath = WorkingTree.open_containing(u'.')
 
2831
        tree, relpath = WorkingTree.open_containing(directory)
2738
2832
        ignores.tree_ignores_add_patterns(tree, name_pattern_list)
2739
2833
        ignored = globbing.Globster(name_pattern_list)
2740
2834
        matches = []
2741
 
        tree.lock_read()
 
2835
        self.add_cleanup(tree.lock_read().unlock)
2742
2836
        for entry in tree.list_files():
2743
2837
            id = entry[3]
2744
2838
            if id is not None:
2745
2839
                filename = entry[0]
2746
2840
                if ignored.match(filename):
2747
2841
                    matches.append(filename)
2748
 
        tree.unlock()
2749
2842
        if len(matches) > 0:
2750
2843
            self.outf.write("Warning: the following files are version controlled and"
2751
2844
                  " match your ignore pattern:\n%s"
2766
2859
 
2767
2860
    encoding_type = 'replace'
2768
2861
    _see_also = ['ignore', 'ls']
 
2862
    takes_options = ['directory']
2769
2863
 
2770
2864
    @display_command
2771
 
    def run(self):
2772
 
        tree = WorkingTree.open_containing(u'.')[0]
2773
 
        tree.lock_read()
2774
 
        self.add_cleanup(tree.unlock)
 
2865
    def run(self, directory=u'.'):
 
2866
        tree = WorkingTree.open_containing(directory)[0]
 
2867
        self.add_cleanup(tree.lock_read().unlock)
2775
2868
        for path, file_class, kind, file_id, entry in tree.list_files():
2776
2869
            if file_class != 'I':
2777
2870
                continue
2788
2881
    """
2789
2882
    hidden = True
2790
2883
    takes_args = ['revno']
 
2884
    takes_options = ['directory']
2791
2885
 
2792
2886
    @display_command
2793
 
    def run(self, revno):
 
2887
    def run(self, revno, directory=u'.'):
2794
2888
        try:
2795
2889
            revno = int(revno)
2796
2890
        except ValueError:
2797
2891
            raise errors.BzrCommandError("not a valid revision-number: %r"
2798
2892
                                         % revno)
2799
 
        revid = WorkingTree.open_containing(u'.')[0].branch.get_rev_id(revno)
 
2893
        revid = WorkingTree.open_containing(directory)[0].branch.get_rev_id(revno)
2800
2894
        self.outf.write("%s\n" % revid)
2801
2895
 
2802
2896
 
2828
2922
         zip                          .zip
2829
2923
      =================       =========================
2830
2924
    """
 
2925
    encoding = 'exact'
2831
2926
    takes_args = ['dest', 'branch_or_subdir?']
2832
 
    takes_options = [
 
2927
    takes_options = ['directory',
2833
2928
        Option('format',
2834
2929
               help="Type of file to export to.",
2835
2930
               type=unicode),
2844
2939
                    'revision in which it was changed.'),
2845
2940
        ]
2846
2941
    def run(self, dest, branch_or_subdir=None, revision=None, format=None,
2847
 
        root=None, filters=False, per_file_timestamps=False):
 
2942
        root=None, filters=False, per_file_timestamps=False, directory=u'.'):
2848
2943
        from bzrlib.export import export
2849
2944
 
2850
2945
        if branch_or_subdir is None:
2851
 
            tree = WorkingTree.open_containing(u'.')[0]
 
2946
            tree = WorkingTree.open_containing(directory)[0]
2852
2947
            b = tree.branch
2853
2948
            subdir = None
2854
2949
        else:
2873
2968
    """
2874
2969
 
2875
2970
    _see_also = ['ls']
2876
 
    takes_options = [
 
2971
    takes_options = ['directory',
2877
2972
        Option('name-from-revision', help='The path name in the old tree.'),
2878
2973
        Option('filters', help='Apply content filters to display the '
2879
2974
                'convenience form.'),
2884
2979
 
2885
2980
    @display_command
2886
2981
    def run(self, filename, revision=None, name_from_revision=False,
2887
 
            filters=False):
 
2982
            filters=False, directory=None):
2888
2983
        if revision is not None and len(revision) != 1:
2889
2984
            raise errors.BzrCommandError("bzr cat --revision takes exactly"
2890
2985
                                         " one revision specifier")
2891
2986
        tree, branch, relpath = \
2892
 
            bzrdir.BzrDir.open_containing_tree_or_branch(filename)
2893
 
        branch.lock_read()
2894
 
        self.add_cleanup(branch.unlock)
 
2987
            _open_directory_or_containing_tree_or_branch(filename, directory)
 
2988
        self.add_cleanup(branch.lock_read().unlock)
2895
2989
        return self._run(tree, branch, relpath, filename, revision,
2896
2990
                         name_from_revision, filters)
2897
2991
 
2900
2994
        if tree is None:
2901
2995
            tree = b.basis_tree()
2902
2996
        rev_tree = _get_one_revision_tree('cat', revision, branch=b)
2903
 
        rev_tree.lock_read()
2904
 
        self.add_cleanup(rev_tree.unlock)
 
2997
        self.add_cleanup(rev_tree.lock_read().unlock)
2905
2998
 
2906
2999
        old_file_id = rev_tree.path2id(relpath)
2907
3000
 
3013
3106
      to trigger updates to external systems like bug trackers. The --fixes
3014
3107
      option can be used to record the association between a revision and
3015
3108
      one or more bugs. See ``bzr help bugs`` for details.
3016
 
 
3017
 
      A selective commit may fail in some cases where the committed
3018
 
      tree would be invalid. Consider::
3019
 
  
3020
 
        bzr init foo
3021
 
        mkdir foo/bar
3022
 
        bzr add foo/bar
3023
 
        bzr commit foo -m "committing foo"
3024
 
        bzr mv foo/bar foo/baz
3025
 
        mkdir foo/bar
3026
 
        bzr add foo/bar
3027
 
        bzr commit foo/bar -m "committing bar but not baz"
3028
 
  
3029
 
      In the example above, the last commit will fail by design. This gives
3030
 
      the user the opportunity to decide whether they want to commit the
3031
 
      rename at the same time, separately first, or not at all. (As a general
3032
 
      rule, when in doubt, Bazaar has a policy of Doing the Safe Thing.)
3033
3109
    """
3034
 
    # TODO: Run hooks on tree to-be-committed, and after commit.
3035
 
 
3036
 
    # TODO: Strict commit that fails if there are deleted files.
3037
 
    #       (what does "deleted files" mean ??)
3038
 
 
3039
 
    # TODO: Give better message for -s, --summary, used by tla people
3040
 
 
3041
 
    # XXX: verbose currently does nothing
3042
3110
 
3043
3111
    _see_also = ['add', 'bugs', 'hooks', 'uncommit']
3044
3112
    takes_args = ['selected*']
3120
3188
                raise errors.BzrCommandError(
3121
3189
                    "Could not parse --commit-time: " + str(e))
3122
3190
 
3123
 
        # TODO: Need a blackbox test for invoking the external editor; may be
3124
 
        # slightly problematic to run this cross-platform.
3125
 
 
3126
 
        # TODO: do more checks that the commit will succeed before
3127
 
        # spending the user's valuable time typing a commit message.
3128
 
 
3129
3191
        properties = {}
3130
3192
 
3131
 
        tree, selected_list = tree_files(selected_list)
 
3193
        tree, selected_list = WorkingTree.open_containing_paths(selected_list)
3132
3194
        if selected_list == ['']:
3133
3195
            # workaround - commit of root of tree should be exactly the same
3134
3196
            # as just default commit in that tree, and succeed even though
3169
3231
        def get_message(commit_obj):
3170
3232
            """Callback to get commit message"""
3171
3233
            if file:
3172
 
                my_message = codecs.open(
3173
 
                    file, 'rt', osutils.get_user_encoding()).read()
 
3234
                f = open(file)
 
3235
                try:
 
3236
                    my_message = f.read().decode(osutils.get_user_encoding())
 
3237
                finally:
 
3238
                    f.close()
3174
3239
            elif message is not None:
3175
3240
                my_message = message
3176
3241
            else:
3205
3270
                        reporter=None, verbose=verbose, revprops=properties,
3206
3271
                        authors=author, timestamp=commit_stamp,
3207
3272
                        timezone=offset,
3208
 
                        exclude=safe_relpath_files(tree, exclude))
 
3273
                        exclude=tree.safe_relpath_files(exclude))
3209
3274
        except PointlessCommit:
3210
3275
            raise errors.BzrCommandError("No changes to commit."
3211
3276
                              " Use --unchanged to commit anyhow.")
3295
3360
 
3296
3361
 
3297
3362
class cmd_upgrade(Command):
3298
 
    __doc__ = """Upgrade branch storage to current format.
3299
 
 
3300
 
    The check command or bzr developers may sometimes advise you to run
3301
 
    this command. When the default format has changed you may also be warned
3302
 
    during other operations to upgrade.
 
3363
    __doc__ = """Upgrade a repository, branch or working tree to a newer format.
 
3364
 
 
3365
    When the default format has changed after a major new release of
 
3366
    Bazaar, you may be informed during certain operations that you
 
3367
    should upgrade. Upgrading to a newer format may improve performance
 
3368
    or make new features available. It may however limit interoperability
 
3369
    with older repositories or with older versions of Bazaar.
 
3370
 
 
3371
    If you wish to upgrade to a particular format rather than the
 
3372
    current default, that can be specified using the --format option.
 
3373
    As a consequence, you can use the upgrade command this way to
 
3374
    "downgrade" to an earlier format, though some conversions are
 
3375
    a one way process (e.g. changing from the 1.x default to the
 
3376
    2.x default) so downgrading is not always possible.
 
3377
 
 
3378
    A backup.bzr.~#~ directory is created at the start of the conversion
 
3379
    process (where # is a number). By default, this is left there on
 
3380
    completion. If the conversion fails, delete the new .bzr directory
 
3381
    and rename this one back in its place. Use the --clean option to ask
 
3382
    for the backup.bzr directory to be removed on successful conversion.
 
3383
    Alternatively, you can delete it by hand if everything looks good
 
3384
    afterwards.
 
3385
 
 
3386
    If the location given is a shared repository, dependent branches
 
3387
    are also converted provided the repository converts successfully.
 
3388
    If the conversion of a branch fails, remaining branches are still
 
3389
    tried.
 
3390
 
 
3391
    For more information on upgrades, see the Bazaar Upgrade Guide,
 
3392
    http://doc.bazaar.canonical.com/latest/en/upgrade-guide/.
3303
3393
    """
3304
3394
 
3305
 
    _see_also = ['check']
 
3395
    _see_also = ['check', 'reconcile', 'formats']
3306
3396
    takes_args = ['url?']
3307
3397
    takes_options = [
3308
 
                    RegistryOption('format',
3309
 
                        help='Upgrade to a specific format.  See "bzr help'
3310
 
                             ' formats" for details.',
3311
 
                        lazy_registry=('bzrlib.bzrdir', 'format_registry'),
3312
 
                        converter=lambda name: bzrdir.format_registry.make_bzrdir(name),
3313
 
                        value_switches=True, title='Branch format'),
3314
 
                    ]
 
3398
        RegistryOption('format',
 
3399
            help='Upgrade to a specific format.  See "bzr help'
 
3400
                 ' formats" for details.',
 
3401
            lazy_registry=('bzrlib.bzrdir', 'format_registry'),
 
3402
            converter=lambda name: bzrdir.format_registry.make_bzrdir(name),
 
3403
            value_switches=True, title='Branch format'),
 
3404
        Option('clean',
 
3405
            help='Remove the backup.bzr directory if successful.'),
 
3406
        Option('dry-run',
 
3407
            help="Show what would be done, but don't actually do anything."),
 
3408
    ]
3315
3409
 
3316
 
    def run(self, url='.', format=None):
 
3410
    def run(self, url='.', format=None, clean=False, dry_run=False):
3317
3411
        from bzrlib.upgrade import upgrade
3318
 
        upgrade(url, format)
 
3412
        exceptions = upgrade(url, format, clean_up=clean, dry_run=dry_run)
 
3413
        if exceptions:
 
3414
            if len(exceptions) == 1:
 
3415
                # Compatibility with historical behavior
 
3416
                raise exceptions[0]
 
3417
            else:
 
3418
                return 3
3319
3419
 
3320
3420
 
3321
3421
class cmd_whoami(Command):
3330
3430
 
3331
3431
            bzr whoami "Frank Chu <fchu@example.com>"
3332
3432
    """
3333
 
    takes_options = [ Option('email',
 
3433
    takes_options = [ 'directory',
 
3434
                      Option('email',
3334
3435
                             help='Display email address only.'),
3335
3436
                      Option('branch',
3336
3437
                             help='Set identity for the current branch instead of '
3340
3441
    encoding_type = 'replace'
3341
3442
 
3342
3443
    @display_command
3343
 
    def run(self, email=False, branch=False, name=None):
 
3444
    def run(self, email=False, branch=False, name=None, directory=None):
3344
3445
        if name is None:
3345
 
            # use branch if we're inside one; otherwise global config
3346
 
            try:
3347
 
                c = Branch.open_containing('.')[0].get_config()
3348
 
            except errors.NotBranchError:
3349
 
                c = config.GlobalConfig()
 
3446
            if directory is None:
 
3447
                # use branch if we're inside one; otherwise global config
 
3448
                try:
 
3449
                    c = Branch.open_containing(u'.')[0].get_config()
 
3450
                except errors.NotBranchError:
 
3451
                    c = _mod_config.GlobalConfig()
 
3452
            else:
 
3453
                c = Branch.open(directory).get_config()
3350
3454
            if email:
3351
3455
                self.outf.write(c.user_email() + '\n')
3352
3456
            else:
3353
3457
                self.outf.write(c.username() + '\n')
3354
3458
            return
3355
3459
 
 
3460
        if email:
 
3461
            raise errors.BzrCommandError("--email can only be used to display existing "
 
3462
                                         "identity")
 
3463
 
3356
3464
        # display a warning if an email address isn't included in the given name.
3357
3465
        try:
3358
 
            config.extract_email_address(name)
 
3466
            _mod_config.extract_email_address(name)
3359
3467
        except errors.NoEmailInUsername, e:
3360
3468
            warning('"%s" does not seem to contain an email address.  '
3361
3469
                    'This is allowed, but not recommended.', name)
3362
3470
 
3363
3471
        # use global config unless --branch given
3364
3472
        if branch:
3365
 
            c = Branch.open_containing('.')[0].get_config()
 
3473
            if directory is None:
 
3474
                c = Branch.open_containing(u'.')[0].get_config()
 
3475
            else:
 
3476
                c = Branch.open(directory).get_config()
3366
3477
        else:
3367
 
            c = config.GlobalConfig()
 
3478
            c = _mod_config.GlobalConfig()
3368
3479
        c.set_user_option('email', name)
3369
3480
 
3370
3481
 
3380
3491
 
3381
3492
    _see_also = ['info']
3382
3493
    takes_args = ['nickname?']
3383
 
    def run(self, nickname=None):
3384
 
        branch = Branch.open_containing(u'.')[0]
 
3494
    takes_options = ['directory']
 
3495
    def run(self, nickname=None, directory=u'.'):
 
3496
        branch = Branch.open_containing(directory)[0]
3385
3497
        if nickname is None:
3386
3498
            self.printme(branch)
3387
3499
        else:
3436
3548
                'bzr alias --remove expects an alias to remove.')
3437
3549
        # If alias is not found, print something like:
3438
3550
        # unalias: foo: not found
3439
 
        c = config.GlobalConfig()
 
3551
        c = _mod_config.GlobalConfig()
3440
3552
        c.unset_alias(alias_name)
3441
3553
 
3442
3554
    @display_command
3443
3555
    def print_aliases(self):
3444
3556
        """Print out the defined aliases in a similar format to bash."""
3445
 
        aliases = config.GlobalConfig().get_aliases()
 
3557
        aliases = _mod_config.GlobalConfig().get_aliases()
3446
3558
        for key, value in sorted(aliases.iteritems()):
3447
3559
            self.outf.write('bzr alias %s="%s"\n' % (key, value))
3448
3560
 
3458
3570
 
3459
3571
    def set_alias(self, alias_name, alias_command):
3460
3572
        """Save the alias in the global config."""
3461
 
        c = config.GlobalConfig()
 
3573
        c = _mod_config.GlobalConfig()
3462
3574
        c.set_alias(alias_name, alias_command)
3463
3575
 
3464
3576
 
3499
3611
    If you set BZR_TEST_PDB=1 when running selftest, failing tests will drop
3500
3612
    into a pdb postmortem session.
3501
3613
 
 
3614
    The --coverage=DIRNAME global option produces a report with covered code
 
3615
    indicated.
 
3616
 
3502
3617
    :Examples:
3503
3618
        Run only tests relating to 'ignore'::
3504
3619
 
3537
3652
                                 'throughout the test suite.',
3538
3653
                            type=get_transport_type),
3539
3654
                     Option('benchmark',
3540
 
                            help='Run the benchmarks rather than selftests.'),
 
3655
                            help='Run the benchmarks rather than selftests.',
 
3656
                            hidden=True),
3541
3657
                     Option('lsprof-timed',
3542
3658
                            help='Generate lsprof output for benchmarked'
3543
3659
                                 ' sections of code.'),
3544
3660
                     Option('lsprof-tests',
3545
3661
                            help='Generate lsprof output for each test.'),
3546
 
                     Option('cache-dir', type=str,
3547
 
                            help='Cache intermediate benchmark output in this '
3548
 
                                 'directory.'),
3549
3662
                     Option('first',
3550
3663
                            help='Run all tests, but run specified tests first.',
3551
3664
                            short_name='f',
3585
3698
 
3586
3699
    def run(self, testspecs_list=None, verbose=False, one=False,
3587
3700
            transport=None, benchmark=None,
3588
 
            lsprof_timed=None, cache_dir=None,
 
3701
            lsprof_timed=None,
3589
3702
            first=False, list_only=False,
3590
3703
            randomize=None, exclude=None, strict=False,
3591
3704
            load_list=None, debugflag=None, starting_with=None, subunit=False,
3592
3705
            parallel=None, lsprof_tests=False):
3593
 
        from bzrlib.tests import selftest
3594
 
        import bzrlib.benchmarks as benchmarks
3595
 
        from bzrlib.benchmarks import tree_creator
3596
 
 
3597
 
        # Make deprecation warnings visible, unless -Werror is set
3598
 
        symbol_versioning.activate_deprecation_warnings(override=False)
3599
 
 
3600
 
        if cache_dir is not None:
3601
 
            tree_creator.TreeCreator.CACHE_ROOT = osutils.abspath(cache_dir)
 
3706
        from bzrlib import tests
 
3707
 
3602
3708
        if testspecs_list is not None:
3603
3709
            pattern = '|'.join(testspecs_list)
3604
3710
        else:
3612
3718
            self.additional_selftest_args['runner_class'] = SubUnitBzrRunner
3613
3719
            # On Windows, disable automatic conversion of '\n' to '\r\n' in
3614
3720
            # stdout, which would corrupt the subunit stream. 
3615
 
            if sys.platform == "win32" and sys.stdout.fileno() >= 0:
 
3721
            # FIXME: This has been fixed in subunit trunk (>0.0.5) so the
 
3722
            # following code can be deleted when it's sufficiently deployed
 
3723
            # -- vila/mgz 20100514
 
3724
            if (sys.platform == "win32"
 
3725
                and getattr(sys.stdout, 'fileno', None) is not None):
3616
3726
                import msvcrt
3617
3727
                msvcrt.setmode(sys.stdout.fileno(), os.O_BINARY)
3618
3728
        if parallel:
3619
3729
            self.additional_selftest_args.setdefault(
3620
3730
                'suite_decorators', []).append(parallel)
3621
3731
        if benchmark:
3622
 
            test_suite_factory = benchmarks.test_suite
3623
 
            # Unless user explicitly asks for quiet, be verbose in benchmarks
3624
 
            verbose = not is_quiet()
3625
 
            # TODO: should possibly lock the history file...
3626
 
            benchfile = open(".perf_history", "at", buffering=1)
3627
 
            self.add_cleanup(benchfile.close)
3628
 
        else:
3629
 
            test_suite_factory = None
3630
 
            benchfile = None
 
3732
            raise errors.BzrCommandError(
 
3733
                "--benchmark is no longer supported from bzr 2.2; "
 
3734
                "use bzr-usertest instead")
 
3735
        test_suite_factory = None
3631
3736
        selftest_kwargs = {"verbose": verbose,
3632
3737
                          "pattern": pattern,
3633
3738
                          "stop_on_failure": one,
3635
3740
                          "test_suite_factory": test_suite_factory,
3636
3741
                          "lsprof_timed": lsprof_timed,
3637
3742
                          "lsprof_tests": lsprof_tests,
3638
 
                          "bench_history": benchfile,
3639
3743
                          "matching_tests_first": first,
3640
3744
                          "list_only": list_only,
3641
3745
                          "random_seed": randomize,
3646
3750
                          "starting_with": starting_with
3647
3751
                          }
3648
3752
        selftest_kwargs.update(self.additional_selftest_args)
3649
 
        result = selftest(**selftest_kwargs)
 
3753
 
 
3754
        # Make deprecation warnings visible, unless -Werror is set
 
3755
        cleanup = symbol_versioning.activate_deprecation_warnings(
 
3756
            override=False)
 
3757
        try:
 
3758
            result = tests.selftest(**selftest_kwargs)
 
3759
        finally:
 
3760
            cleanup()
3650
3761
        return int(not result)
3651
3762
 
3652
3763
 
3690
3801
 
3691
3802
        branch1 = Branch.open_containing(branch)[0]
3692
3803
        branch2 = Branch.open_containing(other)[0]
3693
 
        branch1.lock_read()
3694
 
        self.add_cleanup(branch1.unlock)
3695
 
        branch2.lock_read()
3696
 
        self.add_cleanup(branch2.unlock)
 
3804
        self.add_cleanup(branch1.lock_read().unlock)
 
3805
        self.add_cleanup(branch2.lock_read().unlock)
3697
3806
        last1 = ensure_null(branch1.last_revision())
3698
3807
        last2 = ensure_null(branch2.last_revision())
3699
3808
 
3711
3820
    with bzr send. If neither is specified, the default is the upstream branch
3712
3821
    or the branch most recently merged using --remember.
3713
3822
 
3714
 
    When merging a branch, by default the tip will be merged. To pick a different
3715
 
    revision, pass --revision. If you specify two values, the first will be used as
3716
 
    BASE and the second one as OTHER. Merging individual revisions, or a subset of
3717
 
    available revisions, like this is commonly referred to as "cherrypicking".
3718
 
 
3719
 
    Revision numbers are always relative to the branch being merged.
3720
 
 
3721
 
    By default, bzr will try to merge in all new work from the other
3722
 
    branch, automatically determining an appropriate base.  If this
3723
 
    fails, you may need to give an explicit base.
 
3823
    When merging from a branch, by default bzr will try to merge in all new
 
3824
    work from the other branch, automatically determining an appropriate base
 
3825
    revision.  If this fails, you may need to give an explicit base.
 
3826
 
 
3827
    To pick a different ending revision, pass "--revision OTHER".  bzr will
 
3828
    try to merge in all new work up to and including revision OTHER.
 
3829
 
 
3830
    If you specify two values, "--revision BASE..OTHER", only revisions BASE
 
3831
    through OTHER, excluding BASE but including OTHER, will be merged.  If this
 
3832
    causes some revisions to be skipped, i.e. if the destination branch does
 
3833
    not already contain revision BASE, such a merge is commonly referred to as
 
3834
    a "cherrypick".
 
3835
 
 
3836
    Revision numbers are always relative to the source branch.
3724
3837
 
3725
3838
    Merge will do its best to combine the changes in two branches, but there
3726
3839
    are some kinds of problems only a human can fix.  When it encounters those,
3750
3863
    you to apply each diff hunk and file change, similar to "shelve".
3751
3864
 
3752
3865
    :Examples:
3753
 
        To merge the latest revision from bzr.dev::
 
3866
        To merge all new revisions from bzr.dev::
3754
3867
 
3755
3868
            bzr merge ../bzr.dev
3756
3869
 
3793
3906
                ' completely merged into the source, pull from the'
3794
3907
                ' source rather than merging.  When this happens,'
3795
3908
                ' you do not need to commit the result.'),
3796
 
        Option('directory',
 
3909
        custom_help('directory',
3797
3910
               help='Branch to merge into, '
3798
 
                    'rather than the one containing the working directory.',
3799
 
               short_name='d',
3800
 
               type=unicode,
3801
 
               ),
 
3911
                    'rather than the one containing the working directory.'),
3802
3912
        Option('preview', help='Instead of merging, show a diff of the'
3803
3913
               ' merge.'),
3804
3914
        Option('interactive', help='Select changes interactively.',
3837
3947
            unversioned_filter=tree.is_ignored, view_info=view_info)
3838
3948
        pb = ui.ui_factory.nested_progress_bar()
3839
3949
        self.add_cleanup(pb.finished)
3840
 
        tree.lock_write()
3841
 
        self.add_cleanup(tree.unlock)
 
3950
        self.add_cleanup(tree.lock_write().unlock)
3842
3951
        if location is not None:
3843
3952
            try:
3844
3953
                mergeable = bundle.read_mergeable_from_url(location,
3905
4014
    def _do_preview(self, merger):
3906
4015
        from bzrlib.diff import show_diff_trees
3907
4016
        result_tree = self._get_preview(merger)
 
4017
        path_encoding = osutils.get_diff_header_encoding()
3908
4018
        show_diff_trees(merger.this_tree, result_tree, self.outf,
3909
 
                        old_label='', new_label='')
 
4019
                        old_label='', new_label='',
 
4020
                        path_encoding=path_encoding)
3910
4021
 
3911
4022
    def _do_merge(self, merger, change_reporter, allow_pending, verified):
3912
4023
        merger.change_reporter = change_reporter
3992
4103
        if ((remember or tree.branch.get_submit_branch() is None) and
3993
4104
             user_location is not None):
3994
4105
            tree.branch.set_submit_branch(other_branch.base)
3995
 
        _merge_tags_if_possible(other_branch, tree.branch)
 
4106
        # Merge tags (but don't set them in the master branch yet, the user
 
4107
        # might revert this merge).  Commit will propagate them.
 
4108
        _merge_tags_if_possible(other_branch, tree.branch, ignore_master=True)
3996
4109
        merger = _mod_merge.Merger.from_revision_ids(pb, tree,
3997
4110
            other_revision_id, base_revision_id, other_branch, base_branch)
3998
4111
        if other_path != '':
4099
4212
        from bzrlib.conflicts import restore
4100
4213
        if merge_type is None:
4101
4214
            merge_type = _mod_merge.Merge3Merger
4102
 
        tree, file_list = tree_files(file_list)
4103
 
        tree.lock_write()
4104
 
        self.add_cleanup(tree.unlock)
 
4215
        tree, file_list = WorkingTree.open_containing_paths(file_list)
 
4216
        self.add_cleanup(tree.lock_write().unlock)
4105
4217
        parents = tree.get_parent_ids()
4106
4218
        if len(parents) != 2:
4107
4219
            raise errors.BzrCommandError("Sorry, remerge only works after normal"
4167
4279
    last committed revision is used.
4168
4280
 
4169
4281
    To remove only some changes, without reverting to a prior version, use
4170
 
    merge instead.  For example, "merge . --revision -2..-3" will remove the
4171
 
    changes introduced by -2, without affecting the changes introduced by -1.
4172
 
    Or to remove certain changes on a hunk-by-hunk basis, see the Shelf plugin.
 
4282
    merge instead.  For example, "merge . -r -2..-3" (don't forget the ".")
 
4283
    will remove the changes introduced by the second last commit (-2), without
 
4284
    affecting the changes introduced by the last commit (-1).  To remove
 
4285
    certain changes on a hunk-by-hunk basis, see the shelve command.
4173
4286
 
4174
4287
    By default, any files that have been manually changed will be backed up
4175
4288
    first.  (Files changed only by merge are not backed up.)  Backup files have
4205
4318
    target branches.
4206
4319
    """
4207
4320
 
4208
 
    _see_also = ['cat', 'export']
 
4321
    _see_also = ['cat', 'export', 'merge', 'shelve']
4209
4322
    takes_options = [
4210
4323
        'revision',
4211
4324
        Option('no-backup', "Do not save backups of reverted files."),
4216
4329
 
4217
4330
    def run(self, revision=None, no_backup=False, file_list=None,
4218
4331
            forget_merges=None):
4219
 
        tree, file_list = tree_files(file_list)
4220
 
        tree.lock_tree_write()
4221
 
        self.add_cleanup(tree.unlock)
 
4332
        tree, file_list = WorkingTree.open_containing_paths(file_list)
 
4333
        self.add_cleanup(tree.lock_tree_write().unlock)
4222
4334
        if forget_merges:
4223
4335
            tree.set_parent_ids(tree.get_parent_ids()[:1])
4224
4336
        else:
4313
4425
    _see_also = ['merge', 'pull']
4314
4426
    takes_args = ['other_branch?']
4315
4427
    takes_options = [
 
4428
        'directory',
4316
4429
        Option('reverse', 'Reverse the order of revisions.'),
4317
4430
        Option('mine-only',
4318
4431
               'Display changes in the local branch only.'),
4340
4453
            theirs_only=False,
4341
4454
            log_format=None, long=False, short=False, line=False,
4342
4455
            show_ids=False, verbose=False, this=False, other=False,
4343
 
            include_merges=False, revision=None, my_revision=None):
 
4456
            include_merges=False, revision=None, my_revision=None,
 
4457
            directory=u'.'):
4344
4458
        from bzrlib.missing import find_unmerged, iter_log_revisions
4345
4459
        def message(s):
4346
4460
            if not is_quiet():
4359
4473
        elif theirs_only:
4360
4474
            restrict = 'remote'
4361
4475
 
4362
 
        local_branch = Branch.open_containing(u".")[0]
4363
 
        local_branch.lock_read()
4364
 
        self.add_cleanup(local_branch.unlock)
 
4476
        local_branch = Branch.open_containing(directory)[0]
 
4477
        self.add_cleanup(local_branch.lock_read().unlock)
4365
4478
 
4366
4479
        parent = local_branch.get_parent()
4367
4480
        if other_branch is None:
4378
4491
        if remote_branch.base == local_branch.base:
4379
4492
            remote_branch = local_branch
4380
4493
        else:
4381
 
            remote_branch.lock_read()
4382
 
            self.add_cleanup(remote_branch.unlock)
 
4494
            self.add_cleanup(remote_branch.lock_read().unlock)
4383
4495
 
4384
4496
        local_revid_range = _revision_range_to_revid_range(
4385
4497
            _get_revision_range(my_revision, local_branch,
4440
4552
            message("Branches are up to date.\n")
4441
4553
        self.cleanup_now()
4442
4554
        if not status_code and parent is None and other_branch is not None:
4443
 
            local_branch.lock_write()
4444
 
            self.add_cleanup(local_branch.unlock)
 
4555
            self.add_cleanup(local_branch.lock_write().unlock)
4445
4556
            # handle race conditions - a parent might be set while we run.
4446
4557
            if local_branch.get_parent() is None:
4447
4558
                local_branch.set_parent(remote_branch.base)
4506
4617
 
4507
4618
    @display_command
4508
4619
    def run(self, verbose=False):
4509
 
        import bzrlib.plugin
4510
 
        from inspect import getdoc
4511
 
        result = []
4512
 
        for name, plugin in bzrlib.plugin.plugins().items():
4513
 
            version = plugin.__version__
4514
 
            if version == 'unknown':
4515
 
                version = ''
4516
 
            name_ver = '%s %s' % (name, version)
4517
 
            d = getdoc(plugin.module)
4518
 
            if d:
4519
 
                doc = d.split('\n')[0]
4520
 
            else:
4521
 
                doc = '(no description)'
4522
 
            result.append((name_ver, doc, plugin.path()))
4523
 
        for name_ver, doc, path in sorted(result):
4524
 
            self.outf.write("%s\n" % name_ver)
4525
 
            self.outf.write("   %s\n" % doc)
4526
 
            if verbose:
4527
 
                self.outf.write("   %s\n" % path)
4528
 
            self.outf.write("\n")
 
4620
        from bzrlib import plugin
 
4621
        self.outf.writelines(
 
4622
            plugin.describe_plugins(show_paths=verbose))
4529
4623
 
4530
4624
 
4531
4625
class cmd_testament(Command):
4547
4641
            b = Branch.open_containing(branch)[0]
4548
4642
        else:
4549
4643
            b = Branch.open(branch)
4550
 
        b.lock_read()
4551
 
        self.add_cleanup(b.unlock)
 
4644
        self.add_cleanup(b.lock_read().unlock)
4552
4645
        if revision is None:
4553
4646
            rev_id = b.last_revision()
4554
4647
        else:
4578
4671
                     Option('long', help='Show commit date in annotations.'),
4579
4672
                     'revision',
4580
4673
                     'show-ids',
 
4674
                     'directory',
4581
4675
                     ]
4582
4676
    encoding_type = 'exact'
4583
4677
 
4584
4678
    @display_command
4585
4679
    def run(self, filename, all=False, long=False, revision=None,
4586
 
            show_ids=False):
 
4680
            show_ids=False, directory=None):
4587
4681
        from bzrlib.annotate import annotate_file, annotate_file_tree
4588
4682
        wt, branch, relpath = \
4589
 
            bzrdir.BzrDir.open_containing_tree_or_branch(filename)
 
4683
            _open_directory_or_containing_tree_or_branch(filename, directory)
4590
4684
        if wt is not None:
4591
 
            wt.lock_read()
4592
 
            self.add_cleanup(wt.unlock)
 
4685
            self.add_cleanup(wt.lock_read().unlock)
4593
4686
        else:
4594
 
            branch.lock_read()
4595
 
            self.add_cleanup(branch.unlock)
 
4687
            self.add_cleanup(branch.lock_read().unlock)
4596
4688
        tree = _get_one_revision_tree('annotate', revision, branch=branch)
4597
 
        tree.lock_read()
4598
 
        self.add_cleanup(tree.unlock)
4599
 
        if wt is not None:
 
4689
        self.add_cleanup(tree.lock_read().unlock)
 
4690
        if wt is not None and revision is None:
4600
4691
            file_id = wt.path2id(relpath)
4601
4692
        else:
4602
4693
            file_id = tree.path2id(relpath)
4603
4694
        if file_id is None:
4604
4695
            raise errors.NotVersionedError(filename)
4605
 
        file_version = tree.inventory[file_id].revision
4606
4696
        if wt is not None and revision is None:
4607
4697
            # If there is a tree and we're not annotating historical
4608
4698
            # versions, annotate the working tree's content.
4609
4699
            annotate_file_tree(wt, file_id, self.outf, long, all,
4610
4700
                show_ids=show_ids)
4611
4701
        else:
 
4702
            file_version = tree.inventory[file_id].revision
4612
4703
            annotate_file(branch, file_version, file_id, long, all, self.outf,
4613
4704
                          show_ids=show_ids)
4614
4705
 
4619
4710
 
4620
4711
    hidden = True # is this right ?
4621
4712
    takes_args = ['revision_id*']
4622
 
    takes_options = ['revision']
 
4713
    takes_options = ['directory', 'revision']
4623
4714
 
4624
 
    def run(self, revision_id_list=None, revision=None):
 
4715
    def run(self, revision_id_list=None, revision=None, directory=u'.'):
4625
4716
        if revision_id_list is not None and revision is not None:
4626
4717
            raise errors.BzrCommandError('You can only supply one of revision_id or --revision')
4627
4718
        if revision_id_list is None and revision is None:
4628
4719
            raise errors.BzrCommandError('You must supply either --revision or a revision_id')
4629
 
        b = WorkingTree.open_containing(u'.')[0].branch
4630
 
        b.lock_write()
4631
 
        self.add_cleanup(b.unlock)
 
4720
        b = WorkingTree.open_containing(directory)[0].branch
 
4721
        self.add_cleanup(b.lock_write().unlock)
4632
4722
        return self._run(b, revision_id_list, revision)
4633
4723
 
4634
4724
    def _run(self, b, revision_id_list, revision):
4693
4783
 
4694
4784
    _see_also = ['checkouts', 'unbind']
4695
4785
    takes_args = ['location?']
4696
 
    takes_options = []
 
4786
    takes_options = ['directory']
4697
4787
 
4698
 
    def run(self, location=None):
4699
 
        b, relpath = Branch.open_containing(u'.')
 
4788
    def run(self, location=None, directory=u'.'):
 
4789
        b, relpath = Branch.open_containing(directory)
4700
4790
        if location is None:
4701
4791
            try:
4702
4792
                location = b.get_old_bound_location()
4729
4819
 
4730
4820
    _see_also = ['checkouts', 'bind']
4731
4821
    takes_args = []
4732
 
    takes_options = []
 
4822
    takes_options = ['directory']
4733
4823
 
4734
 
    def run(self):
4735
 
        b, relpath = Branch.open_containing(u'.')
 
4824
    def run(self, directory=u'.'):
 
4825
        b, relpath = Branch.open_containing(directory)
4736
4826
        if not b.unbind():
4737
4827
            raise errors.BzrCommandError('Local branch is not bound')
4738
4828
 
4784
4874
            b = control.open_branch()
4785
4875
 
4786
4876
        if tree is not None:
4787
 
            tree.lock_write()
4788
 
            self.add_cleanup(tree.unlock)
 
4877
            self.add_cleanup(tree.lock_write().unlock)
4789
4878
        else:
4790
 
            b.lock_write()
4791
 
            self.add_cleanup(b.unlock)
 
4879
            self.add_cleanup(b.lock_write().unlock)
4792
4880
        return self._run(b, tree, dry_run, verbose, revision, force, local=local)
4793
4881
 
4794
4882
    def _run(self, b, tree, dry_run, verbose, revision, force, local=False):
4833
4921
            self.outf.write('The above revision(s) will be removed.\n')
4834
4922
 
4835
4923
        if not force:
4836
 
            if not ui.ui_factory.get_boolean('Are you sure'):
4837
 
                self.outf.write('Canceled')
 
4924
            if not ui.ui_factory.confirm_action(
 
4925
                    'Uncommit these revisions',
 
4926
                    'bzrlib.builtins.uncommit',
 
4927
                    {}):
 
4928
                self.outf.write('Canceled\n')
4838
4929
                return 0
4839
4930
 
4840
4931
        mutter('Uncommitting from {%s} to {%s}',
4846
4937
 
4847
4938
 
4848
4939
class cmd_break_lock(Command):
4849
 
    __doc__ = """Break a dead lock on a repository, branch or working directory.
 
4940
    __doc__ = """Break a dead lock.
 
4941
 
 
4942
    This command breaks a lock on a repository, branch, working directory or
 
4943
    config file.
4850
4944
 
4851
4945
    CAUTION: Locks should only be broken when you are sure that the process
4852
4946
    holding the lock has been stopped.
4857
4951
    :Examples:
4858
4952
        bzr break-lock
4859
4953
        bzr break-lock bzr+ssh://example.com/bzr/foo
 
4954
        bzr break-lock --conf ~/.bazaar
4860
4955
    """
 
4956
 
4861
4957
    takes_args = ['location?']
 
4958
    takes_options = [
 
4959
        Option('config',
 
4960
               help='LOCATION is the directory where the config lock is.'),
 
4961
        Option('force',
 
4962
            help='Do not ask for confirmation before breaking the lock.'),
 
4963
        ]
4862
4964
 
4863
 
    def run(self, location=None, show=False):
 
4965
    def run(self, location=None, config=False, force=False):
4864
4966
        if location is None:
4865
4967
            location = u'.'
4866
 
        control, relpath = bzrdir.BzrDir.open_containing(location)
4867
 
        try:
4868
 
            control.break_lock()
4869
 
        except NotImplementedError:
4870
 
            pass
 
4968
        if force:
 
4969
            ui.ui_factory = ui.ConfirmationUserInterfacePolicy(ui.ui_factory,
 
4970
                None,
 
4971
                {'bzrlib.lockdir.break': True})
 
4972
        if config:
 
4973
            conf = _mod_config.LockableConfig(file_name=location)
 
4974
            conf.break_lock()
 
4975
        else:
 
4976
            control, relpath = bzrdir.BzrDir.open_containing(location)
 
4977
            try:
 
4978
                control.break_lock()
 
4979
            except NotImplementedError:
 
4980
                pass
4871
4981
 
4872
4982
 
4873
4983
class cmd_wait_until_signalled(Command):
4902
5012
                    'result in a dynamically allocated port.  The default port '
4903
5013
                    'depends on the protocol.',
4904
5014
               type=str),
4905
 
        Option('directory',
4906
 
               help='Serve contents of this directory.',
4907
 
               type=unicode),
 
5015
        custom_help('directory',
 
5016
               help='Serve contents of this directory.'),
4908
5017
        Option('allow-writes',
4909
5018
               help='By default the server is a readonly server.  Supplying '
4910
5019
                    '--allow-writes enables write access to the contents of '
4937
5046
 
4938
5047
    def run(self, port=None, inet=False, directory=None, allow_writes=False,
4939
5048
            protocol=None):
4940
 
        from bzrlib.transport import get_transport, transport_server_registry
 
5049
        from bzrlib import transport
4941
5050
        if directory is None:
4942
5051
            directory = os.getcwd()
4943
5052
        if protocol is None:
4944
 
            protocol = transport_server_registry.get()
 
5053
            protocol = transport.transport_server_registry.get()
4945
5054
        host, port = self.get_host_and_port(port)
4946
5055
        url = urlutils.local_path_to_url(directory)
4947
5056
        if not allow_writes:
4948
5057
            url = 'readonly+' + url
4949
 
        transport = get_transport(url)
4950
 
        protocol(transport, host, port, inet)
 
5058
        t = transport.get_transport(url)
 
5059
        protocol(t, host, port, inet)
4951
5060
 
4952
5061
 
4953
5062
class cmd_join(Command):
4959
5068
    not part of it.  (Such trees can be produced by "bzr split", but also by
4960
5069
    running "bzr branch" with the target inside a tree.)
4961
5070
 
4962
 
    The result is a combined tree, with the subtree no longer an independant
 
5071
    The result is a combined tree, with the subtree no longer an independent
4963
5072
    part.  This is marked as a merge of the subtree into the containing tree,
4964
5073
    and all history is preserved.
4965
5074
    """
5046
5155
    _see_also = ['send']
5047
5156
 
5048
5157
    takes_options = [
 
5158
        'directory',
5049
5159
        RegistryOption.from_kwargs('patch-type',
5050
5160
            'The type of patch to include in the directive.',
5051
5161
            title='Patch type',
5064
5174
    encoding_type = 'exact'
5065
5175
 
5066
5176
    def run(self, submit_branch=None, public_branch=None, patch_type='bundle',
5067
 
            sign=False, revision=None, mail_to=None, message=None):
 
5177
            sign=False, revision=None, mail_to=None, message=None,
 
5178
            directory=u'.'):
5068
5179
        from bzrlib.revision import ensure_null, NULL_REVISION
5069
5180
        include_patch, include_bundle = {
5070
5181
            'plain': (False, False),
5071
5182
            'diff': (True, False),
5072
5183
            'bundle': (True, True),
5073
5184
            }[patch_type]
5074
 
        branch = Branch.open('.')
 
5185
        branch = Branch.open(directory)
5075
5186
        stored_submit_branch = branch.get_submit_branch()
5076
5187
        if submit_branch is None:
5077
5188
            submit_branch = stored_submit_branch
5162
5273
    given, in which case it is sent to a file.
5163
5274
 
5164
5275
    Mail is sent using your preferred mail program.  This should be transparent
5165
 
    on Windows (it uses MAPI).  On Linux, it requires the xdg-email utility.
 
5276
    on Windows (it uses MAPI).  On Unix, it requires the xdg-email utility.
5166
5277
    If the preferred client can't be found (or used), your editor will be used.
5167
5278
 
5168
5279
    To use a specific mail program, set the mail_client configuration option.
5339
5450
        Option('delete',
5340
5451
            help='Delete this tag rather than placing it.',
5341
5452
            ),
5342
 
        Option('directory',
5343
 
            help='Branch in which to place the tag.',
5344
 
            short_name='d',
5345
 
            type=unicode,
5346
 
            ),
 
5453
        custom_help('directory',
 
5454
            help='Branch in which to place the tag.'),
5347
5455
        Option('force',
5348
5456
            help='Replace existing tags.',
5349
5457
            ),
5357
5465
            revision=None,
5358
5466
            ):
5359
5467
        branch, relpath = Branch.open_containing(directory)
5360
 
        branch.lock_write()
5361
 
        self.add_cleanup(branch.unlock)
 
5468
        self.add_cleanup(branch.lock_write().unlock)
5362
5469
        if delete:
5363
5470
            if tag_name is None:
5364
5471
                raise errors.BzrCommandError("No tag specified to delete.")
5365
5472
            branch.tags.delete_tag(tag_name)
5366
 
            self.outf.write('Deleted tag %s.\n' % tag_name)
 
5473
            note('Deleted tag %s.' % tag_name)
5367
5474
        else:
5368
5475
            if revision:
5369
5476
                if len(revision) != 1:
5381
5488
            if (not force) and branch.tags.has_tag(tag_name):
5382
5489
                raise errors.TagAlreadyExists(tag_name)
5383
5490
            branch.tags.set_tag(tag_name, revision_id)
5384
 
            self.outf.write('Created tag %s.\n' % tag_name)
 
5491
            note('Created tag %s.' % tag_name)
5385
5492
 
5386
5493
 
5387
5494
class cmd_tags(Command):
5392
5499
 
5393
5500
    _see_also = ['tag']
5394
5501
    takes_options = [
5395
 
        Option('directory',
5396
 
            help='Branch whose tags should be displayed.',
5397
 
            short_name='d',
5398
 
            type=unicode,
5399
 
            ),
5400
 
        RegistryOption.from_kwargs('sort',
 
5502
        custom_help('directory',
 
5503
            help='Branch whose tags should be displayed.'),
 
5504
        RegistryOption('sort',
5401
5505
            'Sort tags by different criteria.', title='Sorting',
5402
 
            alpha='Sort tags lexicographically (default).',
5403
 
            time='Sort tags chronologically.',
 
5506
            lazy_registry=('bzrlib.tag', 'tag_sort_methods')
5404
5507
            ),
5405
5508
        'show-ids',
5406
5509
        'revision',
5407
5510
    ]
5408
5511
 
5409
5512
    @display_command
5410
 
    def run(self,
5411
 
            directory='.',
5412
 
            sort='alpha',
5413
 
            show_ids=False,
5414
 
            revision=None,
5415
 
            ):
 
5513
    def run(self, directory='.', sort=None, show_ids=False, revision=None):
 
5514
        from bzrlib.tag import tag_sort_methods
5416
5515
        branch, relpath = Branch.open_containing(directory)
5417
5516
 
5418
5517
        tags = branch.tags.get_tag_dict().items()
5419
5518
        if not tags:
5420
5519
            return
5421
5520
 
5422
 
        branch.lock_read()
5423
 
        self.add_cleanup(branch.unlock)
 
5521
        self.add_cleanup(branch.lock_read().unlock)
5424
5522
        if revision:
5425
5523
            graph = branch.repository.get_graph()
5426
5524
            rev1, rev2 = _get_revision_range(revision, branch, self.name())
5428
5526
            # only show revisions between revid1 and revid2 (inclusive)
5429
5527
            tags = [(tag, revid) for tag, revid in tags if
5430
5528
                graph.is_between(revid, revid1, revid2)]
5431
 
        if sort == 'alpha':
5432
 
            tags.sort()
5433
 
        elif sort == 'time':
5434
 
            timestamps = {}
5435
 
            for tag, revid in tags:
5436
 
                try:
5437
 
                    revobj = branch.repository.get_revision(revid)
5438
 
                except errors.NoSuchRevision:
5439
 
                    timestamp = sys.maxint # place them at the end
5440
 
                else:
5441
 
                    timestamp = revobj.timestamp
5442
 
                timestamps[revid] = timestamp
5443
 
            tags.sort(key=lambda x: timestamps[x[1]])
 
5529
        if sort is None:
 
5530
            sort = tag_sort_methods.get()
 
5531
        sort(branch, tags)
5444
5532
        if not show_ids:
5445
5533
            # [ (tag, revid), ... ] -> [ (tag, dotted_revno), ... ]
5446
5534
            for index, (tag, revid) in enumerate(tags):
5448
5536
                    revno = branch.revision_id_to_dotted_revno(revid)
5449
5537
                    if isinstance(revno, tuple):
5450
5538
                        revno = '.'.join(map(str, revno))
5451
 
                except errors.NoSuchRevision:
 
5539
                except (errors.NoSuchRevision, errors.GhostRevisionsHaveNoRevno):
5452
5540
                    # Bad tag data/merges can lead to tagged revisions
5453
5541
                    # which are not in this branch. Fail gracefully ...
5454
5542
                    revno = '?'
5573
5661
    """
5574
5662
 
5575
5663
    takes_args = ['to_location?']
5576
 
    takes_options = [Option('force',
 
5664
    takes_options = ['directory',
 
5665
                     Option('force',
5577
5666
                        help='Switch even if local commits will be lost.'),
5578
5667
                     'revision',
5579
5668
                     Option('create-branch', short_name='b',
5582
5671
                    ]
5583
5672
 
5584
5673
    def run(self, to_location=None, force=False, create_branch=False,
5585
 
            revision=None):
 
5674
            revision=None, directory=u'.'):
5586
5675
        from bzrlib import switch
5587
 
        tree_location = '.'
 
5676
        tree_location = directory
5588
5677
        revision = _get_one_revision('switch', revision)
5589
5678
        control_dir = bzrdir.BzrDir.open_containing(tree_location)[0]
5590
5679
        if to_location is None:
5591
5680
            if revision is None:
5592
5681
                raise errors.BzrCommandError('You must supply either a'
5593
5682
                                             ' revision or a location')
5594
 
            to_location = '.'
 
5683
            to_location = tree_location
5595
5684
        try:
5596
5685
            branch = control_dir.open_branch()
5597
5686
            had_explicit_nick = branch.get_config().has_explicit_nickname()
5732
5821
            name=None,
5733
5822
            switch=None,
5734
5823
            ):
5735
 
        tree, file_list = tree_files(file_list, apply_view=False)
 
5824
        tree, file_list = WorkingTree.open_containing_paths(file_list,
 
5825
            apply_view=False)
5736
5826
        current_view, view_dict = tree.views.get_view_info()
5737
5827
        if name is None:
5738
5828
            name = current_view
5842
5932
            location = "."
5843
5933
        branch = Branch.open_containing(location)[0]
5844
5934
        branch.bzrdir.destroy_branch()
5845
 
        
 
5935
 
5846
5936
 
5847
5937
class cmd_shelve(Command):
5848
5938
    __doc__ = """Temporarily set aside some changes from the current tree.
5867
5957
 
5868
5958
    You can put multiple items on the shelf, and by default, 'unshelve' will
5869
5959
    restore the most recently shelved changes.
 
5960
 
 
5961
    For complicated changes, it is possible to edit the changes in a separate
 
5962
    editor program to decide what the file remaining in the working copy
 
5963
    should look like.  To do this, add the configuration option
 
5964
 
 
5965
        change_editor = PROGRAM @new_path @old_path
 
5966
 
 
5967
    where @new_path is replaced with the path of the new version of the 
 
5968
    file and @old_path is replaced with the path of the old version of 
 
5969
    the file.  The PROGRAM should save the new file with the desired 
 
5970
    contents of the file in the working tree.
 
5971
        
5870
5972
    """
5871
5973
 
5872
5974
    takes_args = ['file*']
5873
5975
 
5874
5976
    takes_options = [
 
5977
        'directory',
5875
5978
        'revision',
5876
5979
        Option('all', help='Shelve all changes.'),
5877
5980
        'message',
5883
5986
        Option('destroy',
5884
5987
               help='Destroy removed changes instead of shelving them.'),
5885
5988
    ]
5886
 
    _see_also = ['unshelve']
 
5989
    _see_also = ['unshelve', 'configuration']
5887
5990
 
5888
5991
    def run(self, revision=None, all=False, file_list=None, message=None,
5889
 
            writer=None, list=False, destroy=False):
 
5992
            writer=None, list=False, destroy=False, directory=None):
5890
5993
        if list:
5891
 
            return self.run_for_list()
 
5994
            return self.run_for_list(directory=directory)
5892
5995
        from bzrlib.shelf_ui import Shelver
5893
5996
        if writer is None:
5894
5997
            writer = bzrlib.option.diff_writer_registry.get()
5895
5998
        try:
5896
5999
            shelver = Shelver.from_args(writer(sys.stdout), revision, all,
5897
 
                file_list, message, destroy=destroy)
 
6000
                file_list, message, destroy=destroy, directory=directory)
5898
6001
            try:
5899
6002
                shelver.run()
5900
6003
            finally:
5902
6005
        except errors.UserAbort:
5903
6006
            return 0
5904
6007
 
5905
 
    def run_for_list(self):
5906
 
        tree = WorkingTree.open_containing('.')[0]
5907
 
        tree.lock_read()
5908
 
        self.add_cleanup(tree.unlock)
 
6008
    def run_for_list(self, directory=None):
 
6009
        if directory is None:
 
6010
            directory = u'.'
 
6011
        tree = WorkingTree.open_containing(directory)[0]
 
6012
        self.add_cleanup(tree.lock_read().unlock)
5909
6013
        manager = tree.get_shelf_manager()
5910
6014
        shelves = manager.active_shelves()
5911
6015
        if len(shelves) == 0:
5929
6033
 
5930
6034
    takes_args = ['shelf_id?']
5931
6035
    takes_options = [
 
6036
        'directory',
5932
6037
        RegistryOption.from_kwargs(
5933
6038
            'action', help="The action to perform.",
5934
6039
            enum_switch=False, value_switches=True,
5942
6047
    ]
5943
6048
    _see_also = ['shelve']
5944
6049
 
5945
 
    def run(self, shelf_id=None, action='apply'):
 
6050
    def run(self, shelf_id=None, action='apply', directory=u'.'):
5946
6051
        from bzrlib.shelf_ui import Unshelver
5947
 
        unshelver = Unshelver.from_args(shelf_id, action)
 
6052
        unshelver = Unshelver.from_args(shelf_id, action, directory=directory)
5948
6053
        try:
5949
6054
            unshelver.run()
5950
6055
        finally:
5966
6071
 
5967
6072
    To check what clean-tree will do, use --dry-run.
5968
6073
    """
5969
 
    takes_options = [Option('ignored', help='Delete all ignored files.'),
5970
 
                     Option('detritus', help='Delete conflict files, merge'
 
6074
    takes_options = ['directory',
 
6075
                     Option('ignored', help='Delete all ignored files.'),
 
6076
                     Option('detritus', help='Delete conflict files, merge and revert'
5971
6077
                            ' backups, and failed selftest dirs.'),
5972
6078
                     Option('unknown',
5973
6079
                            help='Delete files unknown to bzr (default).'),
5975
6081
                            ' deleting them.'),
5976
6082
                     Option('force', help='Do not prompt before deleting.')]
5977
6083
    def run(self, unknown=False, ignored=False, detritus=False, dry_run=False,
5978
 
            force=False):
 
6084
            force=False, directory=u'.'):
5979
6085
        from bzrlib.clean_tree import clean_tree
5980
6086
        if not (unknown or ignored or detritus):
5981
6087
            unknown = True
5982
6088
        if dry_run:
5983
6089
            force = True
5984
 
        clean_tree('.', unknown=unknown, ignored=ignored, detritus=detritus,
5985
 
                   dry_run=dry_run, no_prompt=force)
 
6090
        clean_tree(directory, unknown=unknown, ignored=ignored,
 
6091
                   detritus=detritus, dry_run=dry_run, no_prompt=force)
5986
6092
 
5987
6093
 
5988
6094
class cmd_reference(Command):
6037
6143
    # be only called once.
6038
6144
    for (name, aliases, module_name) in [
6039
6145
        ('cmd_bundle_info', [], 'bzrlib.bundle.commands'),
 
6146
        ('cmd_config', [], 'bzrlib.config'),
6040
6147
        ('cmd_dpush', [], 'bzrlib.foreign'),
6041
6148
        ('cmd_version_info', [], 'bzrlib.cmd_version_info'),
6042
6149
        ('cmd_resolve', ['resolved'], 'bzrlib.conflicts'),
6043
6150
        ('cmd_conflicts', [], 'bzrlib.conflicts'),
6044
6151
        ('cmd_sign_my_commits', [], 'bzrlib.sign_my_commits'),
 
6152
        ('cmd_test_script', [], 'bzrlib.cmd_test_script'),
6045
6153
        ]:
6046
6154
        builtin_command_registry.register_lazy(name, aliases, module_name)