/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: Robert Collins
  • Date: 2010-05-06 11:08:10 UTC
  • mto: This revision was merged to the branch mainline in revision 5223.
  • Revision ID: robertc@robertcollins.net-20100506110810-h3j07fh5gmw54s25
Cleaner matcher matching revised unlocking protocol.

Show diffs side-by-side

added added

removed removed

Lines of Context:
1
 
# Copyright (C) 2005-2011 Canonical Ltd
 
1
# Copyright (C) 2005-2010 Canonical Ltd
2
2
#
3
3
# This program is free software; you can redistribute it and/or modify
4
4
# it under the terms of the GNU General Public License as published by
20
20
 
21
21
from bzrlib.lazy_import import lazy_import
22
22
lazy_import(globals(), """
 
23
import codecs
23
24
import cStringIO
24
25
import sys
25
26
import time
32
33
    bzrdir,
33
34
    directory_service,
34
35
    delta,
35
 
    config as _mod_config,
 
36
    config,
36
37
    errors,
37
38
    globbing,
38
39
    hooks,
74
75
from bzrlib.trace import mutter, note, warning, is_quiet, get_verbosity_level
75
76
 
76
77
 
77
 
@symbol_versioning.deprecated_function(symbol_versioning.deprecated_in((2, 3, 0)))
78
78
def tree_files(file_list, default_branch=u'.', canonicalize=True,
79
79
    apply_view=True):
80
 
    return internal_tree_files(file_list, default_branch, canonicalize,
81
 
        apply_view)
 
80
    try:
 
81
        return internal_tree_files(file_list, default_branch, canonicalize,
 
82
            apply_view)
 
83
    except errors.FileInWrongBranch, e:
 
84
        raise errors.BzrCommandError("%s is not in the same branch as %s" %
 
85
                                     (e.path, file_list[0]))
82
86
 
83
87
 
84
88
def tree_files_for_add(file_list):
148
152
 
149
153
# XXX: Bad function name; should possibly also be a class method of
150
154
# WorkingTree rather than a function.
151
 
@symbol_versioning.deprecated_function(symbol_versioning.deprecated_in((2, 3, 0)))
152
155
def internal_tree_files(file_list, default_branch=u'.', canonicalize=True,
153
156
    apply_view=True):
154
157
    """Convert command-line paths to a WorkingTree and relative paths.
155
158
 
156
 
    Deprecated: use WorkingTree.open_containing_paths instead.
157
 
 
158
159
    This is typically used for command-line processors that take one or
159
160
    more filenames, and infer the workingtree that contains them.
160
161
 
170
171
 
171
172
    :return: workingtree, [relative_paths]
172
173
    """
173
 
    return WorkingTree.open_containing_paths(
174
 
        file_list, default_directory='.',
175
 
        canonicalize=True,
176
 
        apply_view=True)
 
174
    if file_list is None or len(file_list) == 0:
 
175
        tree = WorkingTree.open_containing(default_branch)[0]
 
176
        if tree.supports_views() and apply_view:
 
177
            view_files = tree.views.lookup_view()
 
178
            if view_files:
 
179
                file_list = view_files
 
180
                view_str = views.view_display_str(view_files)
 
181
                note("Ignoring files outside view. View is %s" % view_str)
 
182
        return tree, file_list
 
183
    tree = WorkingTree.open_containing(osutils.realpath(file_list[0]))[0]
 
184
    return tree, safe_relpath_files(tree, file_list, canonicalize,
 
185
        apply_view=apply_view)
 
186
 
 
187
 
 
188
def safe_relpath_files(tree, file_list, canonicalize=True, apply_view=True):
 
189
    """Convert file_list into a list of relpaths in tree.
 
190
 
 
191
    :param tree: A tree to operate on.
 
192
    :param file_list: A list of user provided paths or None.
 
193
    :param apply_view: if True and a view is set, apply it or check that
 
194
        specified files are within it
 
195
    :return: A list of relative paths.
 
196
    :raises errors.PathNotChild: When a provided path is in a different tree
 
197
        than tree.
 
198
    """
 
199
    if file_list is None:
 
200
        return None
 
201
    if tree.supports_views() and apply_view:
 
202
        view_files = tree.views.lookup_view()
 
203
    else:
 
204
        view_files = []
 
205
    new_list = []
 
206
    # tree.relpath exists as a "thunk" to osutils, but canonical_relpath
 
207
    # doesn't - fix that up here before we enter the loop.
 
208
    if canonicalize:
 
209
        fixer = lambda p: osutils.canonical_relpath(tree.basedir, p)
 
210
    else:
 
211
        fixer = tree.relpath
 
212
    for filename in file_list:
 
213
        try:
 
214
            relpath = fixer(osutils.dereference_path(filename))
 
215
            if  view_files and not osutils.is_inside_any(view_files, relpath):
 
216
                raise errors.FileOutsideView(filename, view_files)
 
217
            new_list.append(relpath)
 
218
        except errors.PathNotChild:
 
219
            raise errors.FileInWrongBranch(tree.branch, filename)
 
220
    return new_list
177
221
 
178
222
 
179
223
def _get_view_info_for_change_reporter(tree):
188
232
    return view_info
189
233
 
190
234
 
191
 
def _open_directory_or_containing_tree_or_branch(filename, directory):
192
 
    """Open the tree or branch containing the specified file, unless
193
 
    the --directory option is used to specify a different branch."""
194
 
    if directory is not None:
195
 
        return (None, Branch.open(directory), filename)
196
 
    return bzrdir.BzrDir.open_containing_tree_or_branch(filename)
197
 
 
198
 
 
199
235
# TODO: Make sure no commands unconditionally use the working directory as a
200
236
# branch.  If a filename argument is used, the first of them should be used to
201
237
# specify the branch.  (Perhaps this can be factored out into some kind of
250
286
    To skip the display of pending merge information altogether, use
251
287
    the no-pending option or specify a file/directory.
252
288
 
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'.
 
289
    If a revision argument is given, the status is calculated against
 
290
    that revision, or between two revisions if two are provided.
259
291
    """
260
292
 
261
293
    # TODO: --no-recurse, --recurse options
283
315
            raise errors.BzrCommandError('bzr status --revision takes exactly'
284
316
                                         ' one or two revision specifiers')
285
317
 
286
 
        tree, relfile_list = WorkingTree.open_containing_paths(file_list)
 
318
        tree, relfile_list = tree_files(file_list)
287
319
        # Avoid asking for specific files when that is not needed.
288
320
        if relfile_list == ['']:
289
321
            relfile_list = None
308
340
 
309
341
    hidden = True
310
342
    takes_args = ['revision_id?']
311
 
    takes_options = ['directory', 'revision']
 
343
    takes_options = ['revision']
312
344
    # cat-revision is more for frontends so should be exact
313
345
    encoding = 'strict'
314
346
 
321
353
        self.outf.write(revtext.decode('utf-8'))
322
354
 
323
355
    @display_command
324
 
    def run(self, revision_id=None, revision=None, directory=u'.'):
 
356
    def run(self, revision_id=None, revision=None):
325
357
        if revision_id is not None and revision is not None:
326
358
            raise errors.BzrCommandError('You can only supply one of'
327
359
                                         ' revision_id or --revision')
328
360
        if revision_id is None and revision is None:
329
361
            raise errors.BzrCommandError('You must supply either'
330
362
                                         ' --revision or a revision_id')
331
 
 
332
 
        b = bzrdir.BzrDir.open_containing_tree_or_branch(directory)[1]
 
363
        b = WorkingTree.open_containing(u'.')[0].branch
333
364
 
334
365
        revisions = b.repository.revisions
335
366
        if revisions is None:
413
444
                self.outf.write(page_bytes[:header_end])
414
445
                page_bytes = data
415
446
            self.outf.write('\nPage %d\n' % (page_idx,))
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')
 
447
            decomp_bytes = zlib.decompress(page_bytes)
 
448
            self.outf.write(decomp_bytes)
 
449
            self.outf.write('\n')
422
450
 
423
451
    def _dump_entries(self, trans, basename):
424
452
        try:
455
483
    takes_options = [
456
484
        Option('force',
457
485
               help='Remove the working tree even if it has '
458
 
                    'uncommitted or shelved changes.'),
 
486
                    'uncommitted changes.'),
459
487
        ]
460
488
 
461
489
    def run(self, location_list, force=False):
475
503
            if not force:
476
504
                if (working.has_changes()):
477
505
                    raise errors.UncommittedChanges(working)
478
 
                if working.get_shelf_manager().last_shelf() is not None:
479
 
                    raise errors.ShelvedChanges(working)
480
506
 
481
507
            if working.user_url != working.branch.user_url:
482
508
                raise errors.BzrCommandError("You cannot remove the working tree"
485
511
            d.destroy_workingtree()
486
512
 
487
513
 
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
 
 
541
514
class cmd_revno(Command):
542
515
    __doc__ = """Show current revision number.
543
516
 
555
528
        if tree:
556
529
            try:
557
530
                wt = WorkingTree.open_containing(location)[0]
558
 
                self.add_cleanup(wt.lock_read().unlock)
 
531
                wt.lock_read()
559
532
            except (errors.NoWorkingTree, errors.NotLocalUrl):
560
533
                raise errors.NoWorkingTree(location)
 
534
            self.add_cleanup(wt.unlock)
561
535
            revid = wt.last_revision()
562
536
            try:
563
537
                revno_t = wt.branch.revision_id_to_dotted_revno(revid)
566
540
            revno = ".".join(str(n) for n in revno_t)
567
541
        else:
568
542
            b = Branch.open_containing(location)[0]
569
 
            self.add_cleanup(b.lock_read().unlock)
 
543
            b.lock_read()
 
544
            self.add_cleanup(b.unlock)
570
545
            revno = b.revno()
571
546
        self.cleanup_now()
572
547
        self.outf.write(str(revno) + '\n')
579
554
    takes_args = ['revision_info*']
580
555
    takes_options = [
581
556
        'revision',
582
 
        custom_help('directory',
 
557
        Option('directory',
583
558
            help='Branch to examine, '
584
 
                 'rather than the one containing the working directory.'),
 
559
                 'rather than the one containing the working directory.',
 
560
            short_name='d',
 
561
            type=unicode,
 
562
            ),
585
563
        Option('tree', help='Show revno of working tree'),
586
564
        ]
587
565
 
592
570
        try:
593
571
            wt = WorkingTree.open_containing(directory)[0]
594
572
            b = wt.branch
595
 
            self.add_cleanup(wt.lock_read().unlock)
 
573
            wt.lock_read()
 
574
            self.add_cleanup(wt.unlock)
596
575
        except (errors.NoWorkingTree, errors.NotLocalUrl):
597
576
            wt = None
598
577
            b = Branch.open_containing(directory)[0]
599
 
            self.add_cleanup(b.lock_read().unlock)
 
578
            b.lock_read()
 
579
            self.add_cleanup(b.unlock)
600
580
        revision_ids = []
601
581
        if revision is not None:
602
582
            revision_ids.extend(rev.as_revision_id(b) for rev in revision)
701
681
                should_print=(not is_quiet()))
702
682
 
703
683
        if base_tree:
704
 
            self.add_cleanup(base_tree.lock_read().unlock)
 
684
            base_tree.lock_read()
 
685
            self.add_cleanup(base_tree.unlock)
705
686
        tree, file_list = tree_files_for_add(file_list)
706
687
        added, ignored = tree.smart_add(file_list, not
707
688
            no_recurse, action=action, save=not dry_run)
778
759
            raise errors.BzrCommandError('invalid kind %r specified' % (kind,))
779
760
 
780
761
        revision = _get_one_revision('inventory', revision)
781
 
        work_tree, file_list = WorkingTree.open_containing_paths(file_list)
782
 
        self.add_cleanup(work_tree.lock_read().unlock)
 
762
        work_tree, file_list = tree_files(file_list)
 
763
        work_tree.lock_read()
 
764
        self.add_cleanup(work_tree.unlock)
783
765
        if revision is not None:
784
766
            tree = revision.as_tree(work_tree.branch)
785
767
 
786
768
            extra_trees = [work_tree]
787
 
            self.add_cleanup(tree.lock_read().unlock)
 
769
            tree.lock_read()
 
770
            self.add_cleanup(tree.unlock)
788
771
        else:
789
772
            tree = work_tree
790
773
            extra_trees = []
849
832
            names_list = []
850
833
        if len(names_list) < 2:
851
834
            raise errors.BzrCommandError("missing file argument")
852
 
        tree, rel_names = WorkingTree.open_containing_paths(names_list, canonicalize=False)
853
 
        self.add_cleanup(tree.lock_tree_write().unlock)
 
835
        tree, rel_names = tree_files(names_list, canonicalize=False)
 
836
        tree.lock_tree_write()
 
837
        self.add_cleanup(tree.unlock)
854
838
        self._run(tree, names_list, rel_names, after)
855
839
 
856
840
    def run_auto(self, names_list, after, dry_run):
860
844
        if after:
861
845
            raise errors.BzrCommandError('--after cannot be specified with'
862
846
                                         ' --auto.')
863
 
        work_tree, file_list = WorkingTree.open_containing_paths(
864
 
            names_list, default_directory='.')
865
 
        self.add_cleanup(work_tree.lock_tree_write().unlock)
 
847
        work_tree, file_list = tree_files(names_list, default_branch='.')
 
848
        work_tree.lock_tree_write()
 
849
        self.add_cleanup(work_tree.unlock)
866
850
        rename_map.RenameMap.guess_renames(work_tree, dry_run)
867
851
 
868
852
    def _run(self, tree, names_list, rel_names, after):
962
946
    match the remote one, use pull --overwrite. This will work even if the two
963
947
    branches have diverged.
964
948
 
965
 
    If there is no default location set, the first pull will set it (use
966
 
    --no-remember to avoid settting it). After that, you can omit the
967
 
    location to use the default.  To change the default, use --remember. The
968
 
    value will only be saved if the remote location can be accessed.
 
949
    If there is no default location set, the first pull will set it.  After
 
950
    that, you can omit the location to use the default.  To change the
 
951
    default, use --remember. The value will only be saved if the remote
 
952
    location can be accessed.
969
953
 
970
954
    Note: The location can be specified either in the form of a branch,
971
955
    or in the form of a path to a file containing a merge directive generated
976
960
    takes_options = ['remember', 'overwrite', 'revision',
977
961
        custom_help('verbose',
978
962
            help='Show logs of pulled revisions.'),
979
 
        custom_help('directory',
 
963
        Option('directory',
980
964
            help='Branch to pull into, '
981
 
                 'rather than the one containing the working directory.'),
 
965
                 'rather than the one containing the working directory.',
 
966
            short_name='d',
 
967
            type=unicode,
 
968
            ),
982
969
        Option('local',
983
970
            help="Perform a local pull in a bound "
984
971
                 "branch.  Local pulls are not applied to "
985
972
                 "the master branch."
986
973
            ),
987
 
        Option('show-base',
988
 
            help="Show base revision text in conflicts.")
989
974
        ]
990
975
    takes_args = ['location?']
991
976
    encoding_type = 'replace'
992
977
 
993
 
    def run(self, location=None, remember=None, overwrite=False,
 
978
    def run(self, location=None, remember=False, overwrite=False,
994
979
            revision=None, verbose=False,
995
 
            directory=None, local=False,
996
 
            show_base=False):
 
980
            directory=None, local=False):
997
981
        # FIXME: too much stuff is in the command class
998
982
        revision_id = None
999
983
        mergeable = None
1002
986
        try:
1003
987
            tree_to = WorkingTree.open_containing(directory)[0]
1004
988
            branch_to = tree_to.branch
1005
 
            self.add_cleanup(tree_to.lock_write().unlock)
 
989
            tree_to.lock_write()
 
990
            self.add_cleanup(tree_to.unlock)
1006
991
        except errors.NoWorkingTree:
1007
992
            tree_to = None
1008
993
            branch_to = Branch.open_containing(directory)[0]
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.")
 
994
            branch_to.lock_write()
 
995
            self.add_cleanup(branch_to.unlock)
1013
996
 
1014
997
        if local and not branch_to.get_bound_location():
1015
998
            raise errors.LocalRequiresBoundBranch()
1046
1029
        else:
1047
1030
            branch_from = Branch.open(location,
1048
1031
                possible_transports=possible_transports)
1049
 
            self.add_cleanup(branch_from.lock_read().unlock)
1050
 
            # Remembers if asked explicitly or no previous location is set
1051
 
            if (remember
1052
 
                or (remember is None and branch_to.get_parent() is None)):
 
1032
            branch_from.lock_read()
 
1033
            self.add_cleanup(branch_from.unlock)
 
1034
 
 
1035
            if branch_to.get_parent() is None or remember:
1053
1036
                branch_to.set_parent(branch_from.base)
1054
1037
 
1055
1038
        if revision is not None:
1062
1045
                view_info=view_info)
1063
1046
            result = tree_to.pull(
1064
1047
                branch_from, overwrite, revision_id, change_reporter,
1065
 
                possible_transports=possible_transports, local=local,
1066
 
                show_base=show_base)
 
1048
                possible_transports=possible_transports, local=local)
1067
1049
        else:
1068
1050
            result = branch_to.pull(
1069
1051
                branch_from, overwrite, revision_id, local=local)
1073
1055
            log.show_branch_change(
1074
1056
                branch_to, self.outf, result.old_revno,
1075
1057
                result.old_revid)
1076
 
        if getattr(result, 'tag_conflicts', None):
1077
 
            return 1
1078
 
        else:
1079
 
            return 0
1080
1058
 
1081
1059
 
1082
1060
class cmd_push(Command):
1099
1077
    do a merge (see bzr help merge) from the other branch, and commit that.
1100
1078
    After that you will be able to do a push without '--overwrite'.
1101
1079
 
1102
 
    If there is no default push location set, the first push will set it (use
1103
 
    --no-remember to avoid settting it).  After that, you can omit the
1104
 
    location to use the default.  To change the default, use --remember. The
1105
 
    value will only be saved if the remote location can be accessed.
 
1080
    If there is no default push location set, the first push will set it.
 
1081
    After that, you can omit the location to use the default.  To change the
 
1082
    default, use --remember. The value will only be saved if the remote
 
1083
    location can be accessed.
1106
1084
    """
1107
1085
 
1108
1086
    _see_also = ['pull', 'update', 'working-trees']
1110
1088
        Option('create-prefix',
1111
1089
               help='Create the path leading up to the branch '
1112
1090
                    'if it does not already exist.'),
1113
 
        custom_help('directory',
 
1091
        Option('directory',
1114
1092
            help='Branch to push from, '
1115
 
                 'rather than the one containing the working directory.'),
 
1093
                 'rather than the one containing the working directory.',
 
1094
            short_name='d',
 
1095
            type=unicode,
 
1096
            ),
1116
1097
        Option('use-existing-dir',
1117
1098
               help='By default push will fail if the target'
1118
1099
                    ' directory exists, but does not already'
1129
1110
        Option('strict',
1130
1111
               help='Refuse to push if there are uncommitted changes in'
1131
1112
               ' the working tree, --no-strict disables the check.'),
1132
 
        Option('no-tree',
1133
 
               help="Don't populate the working tree, even for protocols"
1134
 
               " that support it."),
1135
1113
        ]
1136
1114
    takes_args = ['location?']
1137
1115
    encoding_type = 'replace'
1138
1116
 
1139
 
    def run(self, location=None, remember=None, overwrite=False,
 
1117
    def run(self, location=None, remember=False, overwrite=False,
1140
1118
        create_prefix=False, verbose=False, revision=None,
1141
1119
        use_existing_dir=False, directory=None, stacked_on=None,
1142
 
        stacked=False, strict=None, no_tree=False):
 
1120
        stacked=False, strict=None):
1143
1121
        from bzrlib.push import _show_push_branch
1144
1122
 
1145
1123
        if directory is None:
1191
1169
        _show_push_branch(br_from, revision_id, location, self.outf,
1192
1170
            verbose=verbose, overwrite=overwrite, remember=remember,
1193
1171
            stacked_on=stacked_on, create_prefix=create_prefix,
1194
 
            use_existing_dir=use_existing_dir, no_tree=no_tree)
 
1172
            use_existing_dir=use_existing_dir)
1195
1173
 
1196
1174
 
1197
1175
class cmd_branch(Command):
1206
1184
 
1207
1185
    To retrieve the branch as of a particular revision, supply the --revision
1208
1186
    parameter, as in "branch foo/bar -r 5".
1209
 
 
1210
 
    The synonyms 'clone' and 'get' for this command are deprecated.
1211
1187
    """
1212
1188
 
1213
1189
    _see_also = ['checkout']
1214
1190
    takes_args = ['from_location', 'to_location?']
1215
 
    takes_options = ['revision',
1216
 
        Option('hardlink', help='Hard-link working tree files where possible.'),
1217
 
        Option('files-from', type=str,
1218
 
               help="Get file contents from this tree."),
 
1191
    takes_options = ['revision', Option('hardlink',
 
1192
        help='Hard-link working tree files where possible.'),
1219
1193
        Option('no-tree',
1220
1194
            help="Create a branch without a working-tree."),
1221
1195
        Option('switch',
1239
1213
 
1240
1214
    def run(self, from_location, to_location=None, revision=None,
1241
1215
            hardlink=False, stacked=False, standalone=False, no_tree=False,
1242
 
            use_existing_dir=False, switch=False, bind=False,
1243
 
            files_from=None):
 
1216
            use_existing_dir=False, switch=False, bind=False):
1244
1217
        from bzrlib import switch as _mod_switch
1245
1218
        from bzrlib.tag import _merge_tags_if_possible
1246
 
        if self.invoked_as in ['get', 'clone']:
1247
 
            ui.ui_factory.show_user_warning(
1248
 
                'deprecated_command',
1249
 
                deprecated_name=self.invoked_as,
1250
 
                recommended_name='branch',
1251
 
                deprecated_in_version='2.4')
1252
1219
        accelerator_tree, br_from = bzrdir.BzrDir.open_tree_or_branch(
1253
1220
            from_location)
1254
 
        if not (hardlink or files_from):
1255
 
            # accelerator_tree is usually slower because you have to read N
1256
 
            # files (no readahead, lots of seeks, etc), but allow the user to
1257
 
            # explicitly request it
1258
 
            accelerator_tree = None
1259
 
        if files_from is not None and files_from != from_location:
1260
 
            accelerator_tree = WorkingTree.open(files_from)
1261
1221
        revision = _get_one_revision('branch', revision)
1262
 
        self.add_cleanup(br_from.lock_read().unlock)
 
1222
        br_from.lock_read()
 
1223
        self.add_cleanup(br_from.unlock)
1263
1224
        if revision is not None:
1264
1225
            revision_id = revision.as_revision_id(br_from)
1265
1226
        else:
1370
1331
            to_location = branch_location
1371
1332
        accelerator_tree, source = bzrdir.BzrDir.open_tree_or_branch(
1372
1333
            branch_location)
1373
 
        if not (hardlink or files_from):
1374
 
            # accelerator_tree is usually slower because you have to read N
1375
 
            # files (no readahead, lots of seeks, etc), but allow the user to
1376
 
            # explicitly request it
1377
 
            accelerator_tree = None
1378
1334
        revision = _get_one_revision('checkout', revision)
1379
 
        if files_from is not None and files_from != branch_location:
 
1335
        if files_from is not None:
1380
1336
            accelerator_tree = WorkingTree.open(files_from)
1381
1337
        if revision is not None:
1382
1338
            revision_id = revision.as_revision_id(source)
1410
1366
    @display_command
1411
1367
    def run(self, dir=u'.'):
1412
1368
        tree = WorkingTree.open_containing(dir)[0]
1413
 
        self.add_cleanup(tree.lock_read().unlock)
 
1369
        tree.lock_read()
 
1370
        self.add_cleanup(tree.unlock)
1414
1371
        new_inv = tree.inventory
1415
1372
        old_tree = tree.basis_tree()
1416
 
        self.add_cleanup(old_tree.lock_read().unlock)
 
1373
        old_tree.lock_read()
 
1374
        self.add_cleanup(old_tree.unlock)
1417
1375
        old_inv = old_tree.inventory
1418
1376
        renames = []
1419
1377
        iterator = tree.iter_changes(old_tree, include_unchanged=True)
1438
1396
    If you want to discard your local changes, you can just do a
1439
1397
    'bzr revert' instead of 'bzr commit' after the update.
1440
1398
 
1441
 
    If you want to restore a file that has been removed locally, use
1442
 
    'bzr revert' instead of 'bzr update'.
1443
 
 
1444
1399
    If the tree's branch is bound to a master branch, it will also update
1445
1400
    the branch from the master.
1446
1401
    """
1447
1402
 
1448
1403
    _see_also = ['pull', 'working-trees', 'status-flags']
1449
1404
    takes_args = ['dir?']
1450
 
    takes_options = ['revision',
1451
 
                     Option('show-base',
1452
 
                            help="Show base revision text in conflicts."),
1453
 
                     ]
 
1405
    takes_options = ['revision']
1454
1406
    aliases = ['up']
1455
1407
 
1456
 
    def run(self, dir='.', revision=None, show_base=None):
 
1408
    def run(self, dir='.', revision=None):
1457
1409
        if revision is not None and len(revision) != 1:
1458
1410
            raise errors.BzrCommandError(
1459
1411
                        "bzr update --revision takes exactly one revision")
1463
1415
        master = branch.get_master_branch(
1464
1416
            possible_transports=possible_transports)
1465
1417
        if master is not None:
 
1418
            tree.lock_write()
1466
1419
            branch_location = master.base
1467
 
            tree.lock_write()
1468
1420
        else:
 
1421
            tree.lock_tree_write()
1469
1422
            branch_location = tree.branch.base
1470
 
            tree.lock_tree_write()
1471
1423
        self.add_cleanup(tree.unlock)
1472
1424
        # get rid of the final '/' and be ready for display
1473
1425
        branch_location = urlutils.unescape_for_display(
1499
1451
                change_reporter,
1500
1452
                possible_transports=possible_transports,
1501
1453
                revision=revision_id,
1502
 
                old_tip=old_tip,
1503
 
                show_base=show_base)
 
1454
                old_tip=old_tip)
1504
1455
        except errors.NoSuchRevision, e:
1505
1456
            raise errors.BzrCommandError(
1506
1457
                                  "branch has no revision %s\n"
1568
1519
class cmd_remove(Command):
1569
1520
    __doc__ = """Remove files or directories.
1570
1521
 
1571
 
    This makes Bazaar stop tracking changes to the specified files. Bazaar will
1572
 
    delete them if they can easily be recovered using revert otherwise they
1573
 
    will be backed up (adding an extention of the form .~#~). If no options or
1574
 
    parameters are given Bazaar will scan for files that are being tracked by
1575
 
    Bazaar but missing in your tree and stop tracking them for you.
 
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.
1576
1526
    """
1577
1527
    takes_args = ['file*']
1578
1528
    takes_options = ['verbose',
1580
1530
        RegistryOption.from_kwargs('file-deletion-strategy',
1581
1531
            'The file deletion mode to be used.',
1582
1532
            title='Deletion Strategy', value_switches=True, enum_switch=False,
1583
 
            safe='Backup changed files (default).',
 
1533
            safe='Only delete files if they can be'
 
1534
                 ' safely recovered (default).',
1584
1535
            keep='Delete from bzr but leave the working copy.',
1585
 
            no_backup='Don\'t backup changed files.',
1586
1536
            force='Delete all the specified files, even if they can not be '
1587
 
                'recovered and even if they are non-empty directories. '
1588
 
                '(deprecated, use no-backup)')]
 
1537
                'recovered and even if they are non-empty directories.')]
1589
1538
    aliases = ['rm', 'del']
1590
1539
    encoding_type = 'replace'
1591
1540
 
1592
1541
    def run(self, file_list, verbose=False, new=False,
1593
1542
        file_deletion_strategy='safe'):
1594
 
        if file_deletion_strategy == 'force':
1595
 
            note("(The --force option is deprecated, rather use --no-backup "
1596
 
                "in future.)")
1597
 
            file_deletion_strategy = 'no-backup'
1598
 
 
1599
 
        tree, file_list = WorkingTree.open_containing_paths(file_list)
 
1543
        tree, file_list = tree_files(file_list)
1600
1544
 
1601
1545
        if file_list is not None:
1602
1546
            file_list = [f for f in file_list]
1603
1547
 
1604
 
        self.add_cleanup(tree.lock_write().unlock)
 
1548
        tree.lock_write()
 
1549
        self.add_cleanup(tree.unlock)
1605
1550
        # Heuristics should probably all move into tree.remove_smart or
1606
1551
        # some such?
1607
1552
        if new:
1622
1567
            file_deletion_strategy = 'keep'
1623
1568
        tree.remove(file_list, verbose=verbose, to_file=self.outf,
1624
1569
            keep_files=file_deletion_strategy=='keep',
1625
 
            force=(file_deletion_strategy=='no-backup'))
 
1570
            force=file_deletion_strategy=='force')
1626
1571
 
1627
1572
 
1628
1573
class cmd_file_id(Command):
1690
1635
 
1691
1636
    _see_also = ['check']
1692
1637
    takes_args = ['branch?']
1693
 
    takes_options = [
1694
 
        Option('canonicalize-chks',
1695
 
               help='Make sure CHKs are in canonical form (repairs '
1696
 
                    'bug 522637).',
1697
 
               hidden=True),
1698
 
        ]
1699
1638
 
1700
 
    def run(self, branch=".", canonicalize_chks=False):
 
1639
    def run(self, branch="."):
1701
1640
        from bzrlib.reconcile import reconcile
1702
1641
        dir = bzrdir.BzrDir.open(branch)
1703
 
        reconcile(dir, canonicalize_chks=canonicalize_chks)
 
1642
        reconcile(dir)
1704
1643
 
1705
1644
 
1706
1645
class cmd_revision_history(Command):
1783
1722
                ),
1784
1723
         Option('append-revisions-only',
1785
1724
                help='Never change revnos or the existing log.'
1786
 
                '  Append revisions to it only.'),
1787
 
         Option('no-tree',
1788
 
                'Create a branch without a working tree.')
 
1725
                '  Append revisions to it only.')
1789
1726
         ]
1790
1727
    def run(self, location=None, format=None, append_revisions_only=False,
1791
 
            create_prefix=False, no_tree=False):
 
1728
            create_prefix=False):
1792
1729
        if format is None:
1793
1730
            format = bzrdir.format_registry.make_bzrdir('default')
1794
1731
        if location is None:
1817
1754
        except errors.NotBranchError:
1818
1755
            # really a NotBzrDir error...
1819
1756
            create_branch = bzrdir.BzrDir.create_branch_convenience
1820
 
            if no_tree:
1821
 
                force_new_tree = False
1822
 
            else:
1823
 
                force_new_tree = None
1824
1757
            branch = create_branch(to_transport.base, format=format,
1825
 
                                   possible_transports=[to_transport],
1826
 
                                   force_new_tree=force_new_tree)
 
1758
                                   possible_transports=[to_transport])
1827
1759
            a_bzrdir = branch.bzrdir
1828
1760
        else:
1829
1761
            from bzrlib.transport.local import LocalTransport
1833
1765
                        raise errors.BranchExistsWithoutWorkingTree(location)
1834
1766
                raise errors.AlreadyBranchError(location)
1835
1767
            branch = a_bzrdir.create_branch()
1836
 
            if not no_tree:
1837
 
                a_bzrdir.create_workingtree()
 
1768
            a_bzrdir.create_workingtree()
1838
1769
        if append_revisions_only:
1839
1770
            try:
1840
1771
                branch.set_append_revisions_only(True)
1934
1865
    "bzr diff -p1" is equivalent to "bzr diff --prefix old/:new/", and
1935
1866
    produces patches suitable for "patch -p1".
1936
1867
 
1937
 
    Note that when using the -r argument with a range of revisions, the
1938
 
    differences are computed between the two specified revisions.  That
1939
 
    is, the command does not show the changes introduced by the first 
1940
 
    revision in the range.  This differs from the interpretation of 
1941
 
    revision ranges used by "bzr log" which includes the first revision
1942
 
    in the range.
1943
 
 
1944
1868
    :Exit values:
1945
1869
        1 - changed
1946
1870
        2 - unrepresentable changes
1964
1888
 
1965
1889
            bzr diff -r1..3 xxx
1966
1890
 
1967
 
        The changes introduced by revision 2 (equivalent to -r1..2)::
1968
 
 
1969
 
            bzr diff -c2
1970
 
 
1971
 
        To see the changes introduced by revision X::
 
1891
        To see the changes introduced in revision X::
1972
1892
        
1973
1893
            bzr diff -cX
1974
1894
 
1978
1898
 
1979
1899
            bzr diff -r<chosen_parent>..X
1980
1900
 
1981
 
        The changes between the current revision and the previous revision
1982
 
        (equivalent to -c-1 and -r-2..-1)
 
1901
        The changes introduced by revision 2 (equivalent to -r1..2)::
1983
1902
 
1984
 
            bzr diff -r-2..
 
1903
            bzr diff -c2
1985
1904
 
1986
1905
        Show just the differences for file NEWS::
1987
1906
 
2002
1921
        Same as 'bzr diff' but prefix paths with old/ and new/::
2003
1922
 
2004
1923
            bzr diff --prefix old/:new/
2005
 
            
2006
 
        Show the differences using a custom diff program with options::
2007
 
        
2008
 
            bzr diff --using /usr/bin/diff --diff-options -wu
2009
1924
    """
2010
1925
    _see_also = ['status']
2011
1926
    takes_args = ['file*']
2031
1946
            type=unicode,
2032
1947
            ),
2033
1948
        RegistryOption('format',
2034
 
            short_name='F',
2035
1949
            help='Diff format to use.',
2036
1950
            lazy_registry=('bzrlib.diff', 'format_registry'),
2037
 
            title='Diff format'),
 
1951
            value_switches=False, title='Diff format'),
2038
1952
        ]
2039
1953
    aliases = ['di', 'dif']
2040
1954
    encoding_type = 'exact'
2071
1985
         old_branch, new_branch,
2072
1986
         specific_files, extra_trees) = get_trees_and_branches_to_diff_locked(
2073
1987
            file_list, revision, old, new, self.add_cleanup, apply_view=True)
2074
 
        # GNU diff on Windows uses ANSI encoding for filenames
2075
 
        path_encoding = osutils.get_diff_header_encoding()
2076
1988
        return show_diff_trees(old_tree, new_tree, sys.stdout,
2077
1989
                               specific_files=specific_files,
2078
1990
                               external_diff_options=diff_options,
2079
1991
                               old_label=old_label, new_label=new_label,
2080
 
                               extra_trees=extra_trees,
2081
 
                               path_encoding=path_encoding,
2082
 
                               using=using,
 
1992
                               extra_trees=extra_trees, using=using,
2083
1993
                               format_cls=format)
2084
1994
 
2085
1995
 
2093
2003
    # level of effort but possibly much less IO.  (Or possibly not,
2094
2004
    # if the directories are very large...)
2095
2005
    _see_also = ['status', 'ls']
2096
 
    takes_options = ['directory', 'show-ids']
 
2006
    takes_options = ['show-ids']
2097
2007
 
2098
2008
    @display_command
2099
 
    def run(self, show_ids=False, directory=u'.'):
2100
 
        tree = WorkingTree.open_containing(directory)[0]
2101
 
        self.add_cleanup(tree.lock_read().unlock)
 
2009
    def run(self, show_ids=False):
 
2010
        tree = WorkingTree.open_containing(u'.')[0]
 
2011
        tree.lock_read()
 
2012
        self.add_cleanup(tree.unlock)
2102
2013
        old = tree.basis_tree()
2103
 
        self.add_cleanup(old.lock_read().unlock)
 
2014
        old.lock_read()
 
2015
        self.add_cleanup(old.unlock)
2104
2016
        for path, ie in old.inventory.iter_entries():
2105
2017
            if not tree.has_id(ie.file_id):
2106
2018
                self.outf.write(path)
2116
2028
 
2117
2029
    hidden = True
2118
2030
    _see_also = ['status', 'ls']
2119
 
    takes_options = ['directory', 'null']
 
2031
    takes_options = [
 
2032
            Option('null',
 
2033
                   help='Write an ascii NUL (\\0) separator '
 
2034
                   'between files rather than a newline.')
 
2035
            ]
2120
2036
 
2121
2037
    @display_command
2122
 
    def run(self, null=False, directory=u'.'):
2123
 
        tree = WorkingTree.open_containing(directory)[0]
2124
 
        self.add_cleanup(tree.lock_read().unlock)
 
2038
    def run(self, null=False):
 
2039
        tree = WorkingTree.open_containing(u'.')[0]
2125
2040
        td = tree.changes_from(tree.basis_tree())
2126
 
        self.cleanup_now()
2127
2041
        for path, id, kind, text_modified, meta_modified in td.modified:
2128
2042
            if null:
2129
2043
                self.outf.write(path + '\0')
2137
2051
 
2138
2052
    hidden = True
2139
2053
    _see_also = ['status', 'ls']
2140
 
    takes_options = ['directory', 'null']
 
2054
    takes_options = [
 
2055
            Option('null',
 
2056
                   help='Write an ascii NUL (\\0) separator '
 
2057
                   'between files rather than a newline.')
 
2058
            ]
2141
2059
 
2142
2060
    @display_command
2143
 
    def run(self, null=False, directory=u'.'):
2144
 
        wt = WorkingTree.open_containing(directory)[0]
2145
 
        self.add_cleanup(wt.lock_read().unlock)
 
2061
    def run(self, null=False):
 
2062
        wt = WorkingTree.open_containing(u'.')[0]
 
2063
        wt.lock_read()
 
2064
        self.add_cleanup(wt.unlock)
2146
2065
        basis = wt.basis_tree()
2147
 
        self.add_cleanup(basis.lock_read().unlock)
 
2066
        basis.lock_read()
 
2067
        self.add_cleanup(basis.unlock)
2148
2068
        basis_inv = basis.inventory
2149
2069
        inv = wt.inventory
2150
2070
        for file_id in inv:
2153
2073
            if inv.is_root(file_id) and len(basis_inv) == 0:
2154
2074
                continue
2155
2075
            path = inv.id2path(file_id)
2156
 
            if not os.access(osutils.pathjoin(wt.basedir, path), os.F_OK):
 
2076
            if not os.access(osutils.abspath(path), os.F_OK):
2157
2077
                continue
2158
2078
            if null:
2159
2079
                self.outf.write(path + '\0')
2359
2279
                   help='Show just the specified revision.'
2360
2280
                   ' See also "help revisionspec".'),
2361
2281
            'log-format',
2362
 
            RegistryOption('authors',
2363
 
                'What names to list as authors - first, all or committer.',
2364
 
                title='Authors',
2365
 
                lazy_registry=('bzrlib.log', 'author_list_registry'),
2366
 
            ),
2367
2282
            Option('levels',
2368
2283
                   short_name='n',
2369
2284
                   help='Number of levels to display - 0 for all, 1 for flat.',
2404
2319
            limit=None,
2405
2320
            show_diff=False,
2406
2321
            include_merges=False,
2407
 
            authors=None,
2408
2322
            exclude_common_ancestry=False,
2409
2323
            ):
2410
2324
        from bzrlib.log import (
2438
2352
        if file_list:
2439
2353
            # find the file ids to log and check for directory filtering
2440
2354
            b, file_info_list, rev1, rev2 = _get_info_for_log_files(
2441
 
                revision, file_list, self.add_cleanup)
 
2355
                revision, file_list)
 
2356
            self.add_cleanup(b.unlock)
2442
2357
            for relpath, file_id, kind in file_info_list:
2443
2358
                if file_id is None:
2444
2359
                    raise errors.BzrCommandError(
2462
2377
                location = '.'
2463
2378
            dir, relpath = bzrdir.BzrDir.open_containing(location)
2464
2379
            b = dir.open_branch()
2465
 
            self.add_cleanup(b.lock_read().unlock)
 
2380
            b.lock_read()
 
2381
            self.add_cleanup(b.unlock)
2466
2382
            rev1, rev2 = _get_revision_range(revision, b, self.name())
2467
2383
 
2468
2384
        # Decide on the type of delta & diff filtering to use
2488
2404
                        show_timezone=timezone,
2489
2405
                        delta_format=get_verbosity_level(),
2490
2406
                        levels=levels,
2491
 
                        show_advice=levels is None,
2492
 
                        author_list_handler=authors)
 
2407
                        show_advice=levels is None)
2493
2408
 
2494
2409
        # Choose the algorithm for doing the logging. It's annoying
2495
2410
        # having multiple code paths like this but necessary until
2593
2508
        tree, relpath = WorkingTree.open_containing(filename)
2594
2509
        file_id = tree.path2id(relpath)
2595
2510
        b = tree.branch
2596
 
        self.add_cleanup(b.lock_read().unlock)
 
2511
        b.lock_read()
 
2512
        self.add_cleanup(b.unlock)
2597
2513
        touching_revs = log.find_touching_revisions(b, file_id)
2598
2514
        for revno, revision_id, what in touching_revs:
2599
2515
            self.outf.write("%6d %s\n" % (revno, what))
2612
2528
                   help='Recurse into subdirectories.'),
2613
2529
            Option('from-root',
2614
2530
                   help='Print paths relative to the root of the branch.'),
2615
 
            Option('unknown', short_name='u',
2616
 
                help='Print unknown files.'),
 
2531
            Option('unknown', help='Print unknown files.'),
2617
2532
            Option('versioned', help='Print versioned files.',
2618
2533
                   short_name='V'),
2619
 
            Option('ignored', short_name='i',
2620
 
                help='Print ignored files.'),
2621
 
            Option('kind', short_name='k',
 
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',
2622
2539
                   help='List entries of a particular kind: file, directory, symlink.',
2623
2540
                   type=unicode),
2624
 
            'null',
2625
2541
            'show-ids',
2626
 
            'directory',
2627
2542
            ]
2628
2543
    @display_command
2629
2544
    def run(self, revision=None, verbose=False,
2630
2545
            recursive=False, from_root=False,
2631
2546
            unknown=False, versioned=False, ignored=False,
2632
 
            null=False, kind=None, show_ids=False, path=None, directory=None):
 
2547
            null=False, kind=None, show_ids=False, path=None):
2633
2548
 
2634
2549
        if kind and kind not in ('file', 'directory', 'symlink'):
2635
2550
            raise errors.BzrCommandError('invalid kind specified')
2647
2562
                raise errors.BzrCommandError('cannot specify both --from-root'
2648
2563
                                             ' and PATH')
2649
2564
            fs_path = path
2650
 
        tree, branch, relpath = \
2651
 
            _open_directory_or_containing_tree_or_branch(fs_path, directory)
 
2565
        tree, branch, relpath = bzrdir.BzrDir.open_containing_tree_or_branch(
 
2566
            fs_path)
2652
2567
 
2653
2568
        # Calculate the prefix to use
2654
2569
        prefix = None
2669
2584
                view_str = views.view_display_str(view_files)
2670
2585
                note("Ignoring files outside view. View is %s" % view_str)
2671
2586
 
2672
 
        self.add_cleanup(tree.lock_read().unlock)
 
2587
        tree.lock_read()
 
2588
        self.add_cleanup(tree.unlock)
2673
2589
        for fp, fc, fkind, fid, entry in tree.list_files(include_root=False,
2674
2590
            from_dir=relpath, recursive=recursive):
2675
2591
            # Apply additional masking
2722
2638
 
2723
2639
    hidden = True
2724
2640
    _see_also = ['ls']
2725
 
    takes_options = ['directory']
2726
2641
 
2727
2642
    @display_command
2728
 
    def run(self, directory=u'.'):
2729
 
        for f in WorkingTree.open_containing(directory)[0].unknowns():
 
2643
    def run(self):
 
2644
        for f in WorkingTree.open_containing(u'.')[0].unknowns():
2730
2645
            self.outf.write(osutils.quotefn(f) + '\n')
2731
2646
 
2732
2647
 
2759
2674
    Patterns prefixed with '!!' act as regular ignore patterns, but have
2760
2675
    precedence over the '!' exception patterns.
2761
2676
 
2762
 
    :Notes: 
2763
 
        
2764
 
    * Ignore patterns containing shell wildcards must be quoted from
2765
 
      the shell on Unix.
2766
 
 
2767
 
    * Ignore patterns starting with "#" act as comments in the ignore file.
2768
 
      To ignore patterns that begin with that character, use the "RE:" prefix.
 
2677
    Note: ignore patterns containing shell wildcards must be quoted from
 
2678
    the shell on Unix.
2769
2679
 
2770
2680
    :Examples:
2771
2681
        Ignore the top level Makefile::
2780
2690
 
2781
2691
            bzr ignore "!special.class"
2782
2692
 
2783
 
        Ignore files whose name begins with the "#" character::
2784
 
 
2785
 
            bzr ignore "RE:^#"
2786
 
 
2787
2693
        Ignore .o files under the lib directory::
2788
2694
 
2789
2695
            bzr ignore "lib/**/*.o"
2797
2703
            bzr ignore "RE:(?!debian/).*"
2798
2704
        
2799
2705
        Ignore everything except the "local" toplevel directory,
2800
 
        but always ignore autosave files ending in ~, even under local/::
 
2706
        but always ignore "*~" autosave files, even under local/::
2801
2707
        
2802
2708
            bzr ignore "*"
2803
2709
            bzr ignore "!./local"
2806
2712
 
2807
2713
    _see_also = ['status', 'ignored', 'patterns']
2808
2714
    takes_args = ['name_pattern*']
2809
 
    takes_options = ['directory',
 
2715
    takes_options = [
2810
2716
        Option('default-rules',
2811
2717
               help='Display the default ignore rules that bzr uses.')
2812
2718
        ]
2813
2719
 
2814
 
    def run(self, name_pattern_list=None, default_rules=None,
2815
 
            directory=u'.'):
 
2720
    def run(self, name_pattern_list=None, default_rules=None):
2816
2721
        from bzrlib import ignores
2817
2722
        if default_rules is not None:
2818
2723
            # dump the default rules and exit
2824
2729
                "NAME_PATTERN or --default-rules.")
2825
2730
        name_pattern_list = [globbing.normalize_pattern(p)
2826
2731
                             for p in name_pattern_list]
2827
 
        bad_patterns = ''
2828
 
        for p in name_pattern_list:
2829
 
            if not globbing.Globster.is_pattern_valid(p):
2830
 
                bad_patterns += ('\n  %s' % p)
2831
 
        if bad_patterns:
2832
 
            msg = ('Invalid ignore pattern(s) found. %s' % bad_patterns)
2833
 
            ui.ui_factory.show_error(msg)
2834
 
            raise errors.InvalidPattern('')
2835
2732
        for name_pattern in name_pattern_list:
2836
2733
            if (name_pattern[0] == '/' or
2837
2734
                (len(name_pattern) > 1 and name_pattern[1] == ':')):
2838
2735
                raise errors.BzrCommandError(
2839
2736
                    "NAME_PATTERN should not be an absolute path")
2840
 
        tree, relpath = WorkingTree.open_containing(directory)
 
2737
        tree, relpath = WorkingTree.open_containing(u'.')
2841
2738
        ignores.tree_ignores_add_patterns(tree, name_pattern_list)
2842
2739
        ignored = globbing.Globster(name_pattern_list)
2843
2740
        matches = []
2844
 
        self.add_cleanup(tree.lock_read().unlock)
 
2741
        tree.lock_read()
2845
2742
        for entry in tree.list_files():
2846
2743
            id = entry[3]
2847
2744
            if id is not None:
2848
2745
                filename = entry[0]
2849
2746
                if ignored.match(filename):
2850
2747
                    matches.append(filename)
 
2748
        tree.unlock()
2851
2749
        if len(matches) > 0:
2852
2750
            self.outf.write("Warning: the following files are version controlled and"
2853
2751
                  " match your ignore pattern:\n%s"
2868
2766
 
2869
2767
    encoding_type = 'replace'
2870
2768
    _see_also = ['ignore', 'ls']
2871
 
    takes_options = ['directory']
2872
2769
 
2873
2770
    @display_command
2874
 
    def run(self, directory=u'.'):
2875
 
        tree = WorkingTree.open_containing(directory)[0]
2876
 
        self.add_cleanup(tree.lock_read().unlock)
 
2771
    def run(self):
 
2772
        tree = WorkingTree.open_containing(u'.')[0]
 
2773
        tree.lock_read()
 
2774
        self.add_cleanup(tree.unlock)
2877
2775
        for path, file_class, kind, file_id, entry in tree.list_files():
2878
2776
            if file_class != 'I':
2879
2777
                continue
2890
2788
    """
2891
2789
    hidden = True
2892
2790
    takes_args = ['revno']
2893
 
    takes_options = ['directory']
2894
2791
 
2895
2792
    @display_command
2896
 
    def run(self, revno, directory=u'.'):
 
2793
    def run(self, revno):
2897
2794
        try:
2898
2795
            revno = int(revno)
2899
2796
        except ValueError:
2900
2797
            raise errors.BzrCommandError("not a valid revision-number: %r"
2901
2798
                                         % revno)
2902
 
        revid = WorkingTree.open_containing(directory)[0].branch.get_rev_id(revno)
 
2799
        revid = WorkingTree.open_containing(u'.')[0].branch.get_rev_id(revno)
2903
2800
        self.outf.write("%s\n" % revid)
2904
2801
 
2905
2802
 
2931
2828
         zip                          .zip
2932
2829
      =================       =========================
2933
2830
    """
2934
 
    encoding = 'exact'
2935
2831
    takes_args = ['dest', 'branch_or_subdir?']
2936
 
    takes_options = ['directory',
 
2832
    takes_options = [
2937
2833
        Option('format',
2938
2834
               help="Type of file to export to.",
2939
2835
               type=unicode),
2948
2844
                    'revision in which it was changed.'),
2949
2845
        ]
2950
2846
    def run(self, dest, branch_or_subdir=None, revision=None, format=None,
2951
 
        root=None, filters=False, per_file_timestamps=False, directory=u'.'):
 
2847
        root=None, filters=False, per_file_timestamps=False):
2952
2848
        from bzrlib.export import export
2953
2849
 
2954
2850
        if branch_or_subdir is None:
2955
 
            tree = WorkingTree.open_containing(directory)[0]
 
2851
            tree = WorkingTree.open_containing(u'.')[0]
2956
2852
            b = tree.branch
2957
2853
            subdir = None
2958
2854
        else:
2977
2873
    """
2978
2874
 
2979
2875
    _see_also = ['ls']
2980
 
    takes_options = ['directory',
 
2876
    takes_options = [
2981
2877
        Option('name-from-revision', help='The path name in the old tree.'),
2982
2878
        Option('filters', help='Apply content filters to display the '
2983
2879
                'convenience form.'),
2988
2884
 
2989
2885
    @display_command
2990
2886
    def run(self, filename, revision=None, name_from_revision=False,
2991
 
            filters=False, directory=None):
 
2887
            filters=False):
2992
2888
        if revision is not None and len(revision) != 1:
2993
2889
            raise errors.BzrCommandError("bzr cat --revision takes exactly"
2994
2890
                                         " one revision specifier")
2995
2891
        tree, branch, relpath = \
2996
 
            _open_directory_or_containing_tree_or_branch(filename, directory)
2997
 
        self.add_cleanup(branch.lock_read().unlock)
 
2892
            bzrdir.BzrDir.open_containing_tree_or_branch(filename)
 
2893
        branch.lock_read()
 
2894
        self.add_cleanup(branch.unlock)
2998
2895
        return self._run(tree, branch, relpath, filename, revision,
2999
2896
                         name_from_revision, filters)
3000
2897
 
3003
2900
        if tree is None:
3004
2901
            tree = b.basis_tree()
3005
2902
        rev_tree = _get_one_revision_tree('cat', revision, branch=b)
3006
 
        self.add_cleanup(rev_tree.lock_read().unlock)
 
2903
        rev_tree.lock_read()
 
2904
        self.add_cleanup(rev_tree.unlock)
3007
2905
 
3008
2906
        old_file_id = rev_tree.path2id(relpath)
3009
2907
 
3115
3013
      to trigger updates to external systems like bug trackers. The --fixes
3116
3014
      option can be used to record the association between a revision and
3117
3015
      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.)
3118
3033
    """
 
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
3119
3042
 
3120
3043
    _see_also = ['add', 'bugs', 'hooks', 'uncommit']
3121
3044
    takes_args = ['selected*']
3153
3076
             Option('show-diff', short_name='p',
3154
3077
                    help='When no message is supplied, show the diff along'
3155
3078
                    ' with the status summary in the message editor.'),
3156
 
             Option('lossy', 
3157
 
                    help='When committing to a foreign version control '
3158
 
                    'system do not push data that can not be natively '
3159
 
                    'represented.'),
3160
3079
             ]
3161
3080
    aliases = ['ci', 'checkin']
3162
3081
 
3181
3100
 
3182
3101
    def run(self, message=None, file=None, verbose=False, selected_list=None,
3183
3102
            unchanged=False, strict=False, local=False, fixes=None,
3184
 
            author=None, show_diff=False, exclude=None, commit_time=None,
3185
 
            lossy=False):
 
3103
            author=None, show_diff=False, exclude=None, commit_time=None):
3186
3104
        from bzrlib.errors import (
3187
3105
            PointlessCommit,
3188
3106
            ConflictsInTree,
3202
3120
                raise errors.BzrCommandError(
3203
3121
                    "Could not parse --commit-time: " + str(e))
3204
3122
 
 
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
 
3205
3129
        properties = {}
3206
3130
 
3207
 
        tree, selected_list = WorkingTree.open_containing_paths(selected_list)
 
3131
        tree, selected_list = tree_files(selected_list)
3208
3132
        if selected_list == ['']:
3209
3133
            # workaround - commit of root of tree should be exactly the same
3210
3134
            # as just default commit in that tree, and succeed even though
3245
3169
        def get_message(commit_obj):
3246
3170
            """Callback to get commit message"""
3247
3171
            if file:
3248
 
                f = open(file)
3249
 
                try:
3250
 
                    my_message = f.read().decode(osutils.get_user_encoding())
3251
 
                finally:
3252
 
                    f.close()
 
3172
                my_message = codecs.open(
 
3173
                    file, 'rt', osutils.get_user_encoding()).read()
3253
3174
            elif message is not None:
3254
3175
                my_message = message
3255
3176
            else:
3284
3205
                        reporter=None, verbose=verbose, revprops=properties,
3285
3206
                        authors=author, timestamp=commit_stamp,
3286
3207
                        timezone=offset,
3287
 
                        exclude=tree.safe_relpath_files(exclude),
3288
 
                        lossy=lossy)
 
3208
                        exclude=safe_relpath_files(tree, exclude))
3289
3209
        except PointlessCommit:
3290
3210
            raise errors.BzrCommandError("No changes to commit."
3291
 
                " Please 'bzr add' the files you want to commit, or use"
3292
 
                " --unchanged to force an empty commit.")
 
3211
                              " Use --unchanged to commit anyhow.")
3293
3212
        except ConflictsInTree:
3294
3213
            raise errors.BzrCommandError('Conflicts detected in working '
3295
3214
                'tree.  Use "bzr conflicts" to list, "bzr resolve FILE" to'
3376
3295
 
3377
3296
 
3378
3297
class cmd_upgrade(Command):
3379
 
    __doc__ = """Upgrade a repository, branch or working tree to a newer format.
3380
 
 
3381
 
    When the default format has changed after a major new release of
3382
 
    Bazaar, you may be informed during certain operations that you
3383
 
    should upgrade. Upgrading to a newer format may improve performance
3384
 
    or make new features available. It may however limit interoperability
3385
 
    with older repositories or with older versions of Bazaar.
3386
 
 
3387
 
    If you wish to upgrade to a particular format rather than the
3388
 
    current default, that can be specified using the --format option.
3389
 
    As a consequence, you can use the upgrade command this way to
3390
 
    "downgrade" to an earlier format, though some conversions are
3391
 
    a one way process (e.g. changing from the 1.x default to the
3392
 
    2.x default) so downgrading is not always possible.
3393
 
 
3394
 
    A backup.bzr.~#~ directory is created at the start of the conversion
3395
 
    process (where # is a number). By default, this is left there on
3396
 
    completion. If the conversion fails, delete the new .bzr directory
3397
 
    and rename this one back in its place. Use the --clean option to ask
3398
 
    for the backup.bzr directory to be removed on successful conversion.
3399
 
    Alternatively, you can delete it by hand if everything looks good
3400
 
    afterwards.
3401
 
 
3402
 
    If the location given is a shared repository, dependent branches
3403
 
    are also converted provided the repository converts successfully.
3404
 
    If the conversion of a branch fails, remaining branches are still
3405
 
    tried.
3406
 
 
3407
 
    For more information on upgrades, see the Bazaar Upgrade Guide,
3408
 
    http://doc.bazaar.canonical.com/latest/en/upgrade-guide/.
 
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.
3409
3303
    """
3410
3304
 
3411
 
    _see_also = ['check', 'reconcile', 'formats']
 
3305
    _see_also = ['check']
3412
3306
    takes_args = ['url?']
3413
3307
    takes_options = [
3414
 
        RegistryOption('format',
3415
 
            help='Upgrade to a specific format.  See "bzr help'
3416
 
                 ' formats" for details.',
3417
 
            lazy_registry=('bzrlib.bzrdir', 'format_registry'),
3418
 
            converter=lambda name: bzrdir.format_registry.make_bzrdir(name),
3419
 
            value_switches=True, title='Branch format'),
3420
 
        Option('clean',
3421
 
            help='Remove the backup.bzr directory if successful.'),
3422
 
        Option('dry-run',
3423
 
            help="Show what would be done, but don't actually do anything."),
3424
 
    ]
 
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
                    ]
3425
3315
 
3426
 
    def run(self, url='.', format=None, clean=False, dry_run=False):
 
3316
    def run(self, url='.', format=None):
3427
3317
        from bzrlib.upgrade import upgrade
3428
 
        exceptions = upgrade(url, format, clean_up=clean, dry_run=dry_run)
3429
 
        if exceptions:
3430
 
            if len(exceptions) == 1:
3431
 
                # Compatibility with historical behavior
3432
 
                raise exceptions[0]
3433
 
            else:
3434
 
                return 3
 
3318
        upgrade(url, format)
3435
3319
 
3436
3320
 
3437
3321
class cmd_whoami(Command):
3446
3330
 
3447
3331
            bzr whoami "Frank Chu <fchu@example.com>"
3448
3332
    """
3449
 
    takes_options = [ 'directory',
3450
 
                      Option('email',
 
3333
    takes_options = [ Option('email',
3451
3334
                             help='Display email address only.'),
3452
3335
                      Option('branch',
3453
3336
                             help='Set identity for the current branch instead of '
3457
3340
    encoding_type = 'replace'
3458
3341
 
3459
3342
    @display_command
3460
 
    def run(self, email=False, branch=False, name=None, directory=None):
 
3343
    def run(self, email=False, branch=False, name=None):
3461
3344
        if name is None:
3462
 
            if directory is None:
3463
 
                # use branch if we're inside one; otherwise global config
3464
 
                try:
3465
 
                    c = Branch.open_containing(u'.')[0].get_config()
3466
 
                except errors.NotBranchError:
3467
 
                    c = _mod_config.GlobalConfig()
3468
 
            else:
3469
 
                c = Branch.open(directory).get_config()
 
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()
3470
3350
            if email:
3471
3351
                self.outf.write(c.user_email() + '\n')
3472
3352
            else:
3473
3353
                self.outf.write(c.username() + '\n')
3474
3354
            return
3475
3355
 
3476
 
        if email:
3477
 
            raise errors.BzrCommandError("--email can only be used to display existing "
3478
 
                                         "identity")
3479
 
 
3480
3356
        # display a warning if an email address isn't included in the given name.
3481
3357
        try:
3482
 
            _mod_config.extract_email_address(name)
 
3358
            config.extract_email_address(name)
3483
3359
        except errors.NoEmailInUsername, e:
3484
3360
            warning('"%s" does not seem to contain an email address.  '
3485
3361
                    'This is allowed, but not recommended.', name)
3486
3362
 
3487
3363
        # use global config unless --branch given
3488
3364
        if branch:
3489
 
            if directory is None:
3490
 
                c = Branch.open_containing(u'.')[0].get_config()
3491
 
            else:
3492
 
                c = Branch.open(directory).get_config()
 
3365
            c = Branch.open_containing('.')[0].get_config()
3493
3366
        else:
3494
 
            c = _mod_config.GlobalConfig()
 
3367
            c = config.GlobalConfig()
3495
3368
        c.set_user_option('email', name)
3496
3369
 
3497
3370
 
3507
3380
 
3508
3381
    _see_also = ['info']
3509
3382
    takes_args = ['nickname?']
3510
 
    takes_options = ['directory']
3511
 
    def run(self, nickname=None, directory=u'.'):
3512
 
        branch = Branch.open_containing(directory)[0]
 
3383
    def run(self, nickname=None):
 
3384
        branch = Branch.open_containing(u'.')[0]
3513
3385
        if nickname is None:
3514
3386
            self.printme(branch)
3515
3387
        else:
3564
3436
                'bzr alias --remove expects an alias to remove.')
3565
3437
        # If alias is not found, print something like:
3566
3438
        # unalias: foo: not found
3567
 
        c = _mod_config.GlobalConfig()
 
3439
        c = config.GlobalConfig()
3568
3440
        c.unset_alias(alias_name)
3569
3441
 
3570
3442
    @display_command
3571
3443
    def print_aliases(self):
3572
3444
        """Print out the defined aliases in a similar format to bash."""
3573
 
        aliases = _mod_config.GlobalConfig().get_aliases()
 
3445
        aliases = config.GlobalConfig().get_aliases()
3574
3446
        for key, value in sorted(aliases.iteritems()):
3575
3447
            self.outf.write('bzr alias %s="%s"\n' % (key, value))
3576
3448
 
3586
3458
 
3587
3459
    def set_alias(self, alias_name, alias_command):
3588
3460
        """Save the alias in the global config."""
3589
 
        c = _mod_config.GlobalConfig()
 
3461
        c = config.GlobalConfig()
3590
3462
        c.set_alias(alias_name, alias_command)
3591
3463
 
3592
3464
 
3627
3499
    If you set BZR_TEST_PDB=1 when running selftest, failing tests will drop
3628
3500
    into a pdb postmortem session.
3629
3501
 
3630
 
    The --coverage=DIRNAME global option produces a report with covered code
3631
 
    indicated.
3632
 
 
3633
3502
    :Examples:
3634
3503
        Run only tests relating to 'ignore'::
3635
3504
 
3668
3537
                                 'throughout the test suite.',
3669
3538
                            type=get_transport_type),
3670
3539
                     Option('benchmark',
3671
 
                            help='Run the benchmarks rather than selftests.',
3672
 
                            hidden=True),
 
3540
                            help='Run the benchmarks rather than selftests.'),
3673
3541
                     Option('lsprof-timed',
3674
3542
                            help='Generate lsprof output for benchmarked'
3675
3543
                                 ' sections of code.'),
3676
3544
                     Option('lsprof-tests',
3677
3545
                            help='Generate lsprof output for each test.'),
 
3546
                     Option('cache-dir', type=str,
 
3547
                            help='Cache intermediate benchmark output in this '
 
3548
                                 'directory.'),
3678
3549
                     Option('first',
3679
3550
                            help='Run all tests, but run specified tests first.',
3680
3551
                            short_name='f',
3714
3585
 
3715
3586
    def run(self, testspecs_list=None, verbose=False, one=False,
3716
3587
            transport=None, benchmark=None,
3717
 
            lsprof_timed=None,
 
3588
            lsprof_timed=None, cache_dir=None,
3718
3589
            first=False, list_only=False,
3719
3590
            randomize=None, exclude=None, strict=False,
3720
3591
            load_list=None, debugflag=None, starting_with=None, subunit=False,
3721
3592
            parallel=None, lsprof_tests=False):
3722
 
        from bzrlib import tests
3723
 
 
 
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)
3724
3602
        if testspecs_list is not None:
3725
3603
            pattern = '|'.join(testspecs_list)
3726
3604
        else:
3734
3612
            self.additional_selftest_args['runner_class'] = SubUnitBzrRunner
3735
3613
            # On Windows, disable automatic conversion of '\n' to '\r\n' in
3736
3614
            # stdout, which would corrupt the subunit stream. 
3737
 
            # FIXME: This has been fixed in subunit trunk (>0.0.5) so the
3738
 
            # following code can be deleted when it's sufficiently deployed
3739
 
            # -- vila/mgz 20100514
3740
 
            if (sys.platform == "win32"
3741
 
                and getattr(sys.stdout, 'fileno', None) is not None):
 
3615
            if sys.platform == "win32" and sys.stdout.fileno() >= 0:
3742
3616
                import msvcrt
3743
3617
                msvcrt.setmode(sys.stdout.fileno(), os.O_BINARY)
3744
3618
        if parallel:
3745
3619
            self.additional_selftest_args.setdefault(
3746
3620
                'suite_decorators', []).append(parallel)
3747
3621
        if benchmark:
3748
 
            raise errors.BzrCommandError(
3749
 
                "--benchmark is no longer supported from bzr 2.2; "
3750
 
                "use bzr-usertest instead")
3751
 
        test_suite_factory = None
 
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
3752
3631
        selftest_kwargs = {"verbose": verbose,
3753
3632
                          "pattern": pattern,
3754
3633
                          "stop_on_failure": one,
3756
3635
                          "test_suite_factory": test_suite_factory,
3757
3636
                          "lsprof_timed": lsprof_timed,
3758
3637
                          "lsprof_tests": lsprof_tests,
 
3638
                          "bench_history": benchfile,
3759
3639
                          "matching_tests_first": first,
3760
3640
                          "list_only": list_only,
3761
3641
                          "random_seed": randomize,
3766
3646
                          "starting_with": starting_with
3767
3647
                          }
3768
3648
        selftest_kwargs.update(self.additional_selftest_args)
3769
 
 
3770
 
        # Make deprecation warnings visible, unless -Werror is set
3771
 
        cleanup = symbol_versioning.activate_deprecation_warnings(
3772
 
            override=False)
3773
 
        try:
3774
 
            result = tests.selftest(**selftest_kwargs)
3775
 
        finally:
3776
 
            cleanup()
 
3649
        result = selftest(**selftest_kwargs)
3777
3650
        return int(not result)
3778
3651
 
3779
3652
 
3817
3690
 
3818
3691
        branch1 = Branch.open_containing(branch)[0]
3819
3692
        branch2 = Branch.open_containing(other)[0]
3820
 
        self.add_cleanup(branch1.lock_read().unlock)
3821
 
        self.add_cleanup(branch2.lock_read().unlock)
 
3693
        branch1.lock_read()
 
3694
        self.add_cleanup(branch1.unlock)
 
3695
        branch2.lock_read()
 
3696
        self.add_cleanup(branch2.unlock)
3822
3697
        last1 = ensure_null(branch1.last_revision())
3823
3698
        last2 = ensure_null(branch2.last_revision())
3824
3699
 
3836
3711
    with bzr send. If neither is specified, the default is the upstream branch
3837
3712
    or the branch most recently merged using --remember.
3838
3713
 
3839
 
    When merging from a branch, by default bzr will try to merge in all new
3840
 
    work from the other branch, automatically determining an appropriate base
3841
 
    revision.  If this fails, you may need to give an explicit base.
3842
 
 
3843
 
    To pick a different ending revision, pass "--revision OTHER".  bzr will
3844
 
    try to merge in all new work up to and including revision OTHER.
3845
 
 
3846
 
    If you specify two values, "--revision BASE..OTHER", only revisions BASE
3847
 
    through OTHER, excluding BASE but including OTHER, will be merged.  If this
3848
 
    causes some revisions to be skipped, i.e. if the destination branch does
3849
 
    not already contain revision BASE, such a merge is commonly referred to as
3850
 
    a "cherrypick". Unlike a normal merge, Bazaar does not currently track
3851
 
    cherrypicks. The changes look like a normal commit, and the history of the
3852
 
    changes from the other branch is not stored in the commit.
3853
 
 
3854
 
    Revision numbers are always relative to the source branch.
 
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.
3855
3724
 
3856
3725
    Merge will do its best to combine the changes in two branches, but there
3857
3726
    are some kinds of problems only a human can fix.  When it encounters those,
3860
3729
 
3861
3730
    Use bzr resolve when you have fixed a problem.  See also bzr conflicts.
3862
3731
 
3863
 
    If there is no default branch set, the first merge will set it (use
3864
 
    --no-remember to avoid settting it). After that, you can omit the branch
3865
 
    to use the default.  To change the default, use --remember. The value will
3866
 
    only be saved if the remote location can be accessed.
 
3732
    If there is no default branch set, the first merge will set it. After
 
3733
    that, you can omit the branch to use the default.  To change the
 
3734
    default, use --remember. The value will only be saved if the remote
 
3735
    location can be accessed.
3867
3736
 
3868
3737
    The results of the merge are placed into the destination working
3869
3738
    directory, where they can be reviewed (with bzr diff), tested, and then
3881
3750
    you to apply each diff hunk and file change, similar to "shelve".
3882
3751
 
3883
3752
    :Examples:
3884
 
        To merge all new revisions from bzr.dev::
 
3753
        To merge the latest revision from bzr.dev::
3885
3754
 
3886
3755
            bzr merge ../bzr.dev
3887
3756
 
3924
3793
                ' completely merged into the source, pull from the'
3925
3794
                ' source rather than merging.  When this happens,'
3926
3795
                ' you do not need to commit the result.'),
3927
 
        custom_help('directory',
 
3796
        Option('directory',
3928
3797
               help='Branch to merge into, '
3929
 
                    'rather than the one containing the working directory.'),
 
3798
                    'rather than the one containing the working directory.',
 
3799
               short_name='d',
 
3800
               type=unicode,
 
3801
               ),
3930
3802
        Option('preview', help='Instead of merging, show a diff of the'
3931
3803
               ' merge.'),
3932
3804
        Option('interactive', help='Select changes interactively.',
3934
3806
    ]
3935
3807
 
3936
3808
    def run(self, location=None, revision=None, force=False,
3937
 
            merge_type=None, show_base=False, reprocess=None, remember=None,
 
3809
            merge_type=None, show_base=False, reprocess=None, remember=False,
3938
3810
            uncommitted=False, pull=False,
3939
3811
            directory=None,
3940
3812
            preview=False,
3948
3820
        merger = None
3949
3821
        allow_pending = True
3950
3822
        verified = 'inapplicable'
3951
 
 
3952
3823
        tree = WorkingTree.open_containing(directory)[0]
3953
 
        if tree.branch.revno() == 0:
3954
 
            raise errors.BzrCommandError('Merging into empty branches not currently supported, '
3955
 
                                         'https://bugs.launchpad.net/bzr/+bug/308562')
3956
3824
 
3957
3825
        try:
3958
3826
            basis_tree = tree.revision_tree(tree.last_revision())
3969
3837
            unversioned_filter=tree.is_ignored, view_info=view_info)
3970
3838
        pb = ui.ui_factory.nested_progress_bar()
3971
3839
        self.add_cleanup(pb.finished)
3972
 
        self.add_cleanup(tree.lock_write().unlock)
 
3840
        tree.lock_write()
 
3841
        self.add_cleanup(tree.unlock)
3973
3842
        if location is not None:
3974
3843
            try:
3975
3844
                mergeable = bundle.read_mergeable_from_url(location,
4006
3875
            merger.other_rev_id is not None):
4007
3876
            note('Nothing to do.')
4008
3877
            return 0
4009
 
        if pull and not preview:
 
3878
        if pull:
4010
3879
            if merger.interesting_files is not None:
4011
3880
                raise errors.BzrCommandError('Cannot pull individual files')
4012
3881
            if (merger.base_rev_id == tree.last_revision()):
4036
3905
    def _do_preview(self, merger):
4037
3906
        from bzrlib.diff import show_diff_trees
4038
3907
        result_tree = self._get_preview(merger)
4039
 
        path_encoding = osutils.get_diff_header_encoding()
4040
3908
        show_diff_trees(merger.this_tree, result_tree, self.outf,
4041
 
                        old_label='', new_label='',
4042
 
                        path_encoding=path_encoding)
 
3909
                        old_label='', new_label='')
4043
3910
 
4044
3911
    def _do_merge(self, merger, change_reporter, allow_pending, verified):
4045
3912
        merger.change_reporter = change_reporter
4121
3988
        if other_revision_id is None:
4122
3989
            other_revision_id = _mod_revision.ensure_null(
4123
3990
                other_branch.last_revision())
4124
 
        # Remember where we merge from. We need to remember if:
4125
 
        # - user specify a location (and we don't merge from the parent
4126
 
        #   branch)
4127
 
        # - user ask to remember or there is no previous location set to merge
4128
 
        #   from and user didn't ask to *not* remember
4129
 
        if (user_location is not None
4130
 
            and ((remember
4131
 
                  or (remember is None
4132
 
                      and tree.branch.get_submit_branch() is None)))):
 
3991
        # Remember where we merge from
 
3992
        if ((remember or tree.branch.get_submit_branch() is None) and
 
3993
             user_location is not None):
4133
3994
            tree.branch.set_submit_branch(other_branch.base)
4134
 
        # Merge tags (but don't set them in the master branch yet, the user
4135
 
        # might revert this merge).  Commit will propagate them.
4136
 
        _merge_tags_if_possible(other_branch, tree.branch, ignore_master=True)
 
3995
        _merge_tags_if_possible(other_branch, tree.branch)
4137
3996
        merger = _mod_merge.Merger.from_revision_ids(pb, tree,
4138
3997
            other_revision_id, base_revision_id, other_branch, base_branch)
4139
3998
        if other_path != '':
4240
4099
        from bzrlib.conflicts import restore
4241
4100
        if merge_type is None:
4242
4101
            merge_type = _mod_merge.Merge3Merger
4243
 
        tree, file_list = WorkingTree.open_containing_paths(file_list)
4244
 
        self.add_cleanup(tree.lock_write().unlock)
 
4102
        tree, file_list = tree_files(file_list)
 
4103
        tree.lock_write()
 
4104
        self.add_cleanup(tree.unlock)
4245
4105
        parents = tree.get_parent_ids()
4246
4106
        if len(parents) != 2:
4247
4107
            raise errors.BzrCommandError("Sorry, remerge only works after normal"
4307
4167
    last committed revision is used.
4308
4168
 
4309
4169
    To remove only some changes, without reverting to a prior version, use
4310
 
    merge instead.  For example, "merge . -r -2..-3" (don't forget the ".")
4311
 
    will remove the changes introduced by the second last commit (-2), without
4312
 
    affecting the changes introduced by the last commit (-1).  To remove
4313
 
    certain changes on a hunk-by-hunk basis, see the shelve command.
 
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.
4314
4173
 
4315
4174
    By default, any files that have been manually changed will be backed up
4316
4175
    first.  (Files changed only by merge are not backed up.)  Backup files have
4346
4205
    target branches.
4347
4206
    """
4348
4207
 
4349
 
    _see_also = ['cat', 'export', 'merge', 'shelve']
 
4208
    _see_also = ['cat', 'export']
4350
4209
    takes_options = [
4351
4210
        'revision',
4352
4211
        Option('no-backup', "Do not save backups of reverted files."),
4357
4216
 
4358
4217
    def run(self, revision=None, no_backup=False, file_list=None,
4359
4218
            forget_merges=None):
4360
 
        tree, file_list = WorkingTree.open_containing_paths(file_list)
4361
 
        self.add_cleanup(tree.lock_tree_write().unlock)
 
4219
        tree, file_list = tree_files(file_list)
 
4220
        tree.lock_tree_write()
 
4221
        self.add_cleanup(tree.unlock)
4362
4222
        if forget_merges:
4363
4223
            tree.set_parent_ids(tree.get_parent_ids()[:1])
4364
4224
        else:
4453
4313
    _see_also = ['merge', 'pull']
4454
4314
    takes_args = ['other_branch?']
4455
4315
    takes_options = [
4456
 
        'directory',
4457
4316
        Option('reverse', 'Reverse the order of revisions.'),
4458
4317
        Option('mine-only',
4459
4318
               'Display changes in the local branch only.'),
4481
4340
            theirs_only=False,
4482
4341
            log_format=None, long=False, short=False, line=False,
4483
4342
            show_ids=False, verbose=False, this=False, other=False,
4484
 
            include_merges=False, revision=None, my_revision=None,
4485
 
            directory=u'.'):
 
4343
            include_merges=False, revision=None, my_revision=None):
4486
4344
        from bzrlib.missing import find_unmerged, iter_log_revisions
4487
4345
        def message(s):
4488
4346
            if not is_quiet():
4501
4359
        elif theirs_only:
4502
4360
            restrict = 'remote'
4503
4361
 
4504
 
        local_branch = Branch.open_containing(directory)[0]
4505
 
        self.add_cleanup(local_branch.lock_read().unlock)
 
4362
        local_branch = Branch.open_containing(u".")[0]
 
4363
        local_branch.lock_read()
 
4364
        self.add_cleanup(local_branch.unlock)
4506
4365
 
4507
4366
        parent = local_branch.get_parent()
4508
4367
        if other_branch is None:
4519
4378
        if remote_branch.base == local_branch.base:
4520
4379
            remote_branch = local_branch
4521
4380
        else:
4522
 
            self.add_cleanup(remote_branch.lock_read().unlock)
 
4381
            remote_branch.lock_read()
 
4382
            self.add_cleanup(remote_branch.unlock)
4523
4383
 
4524
4384
        local_revid_range = _revision_range_to_revid_range(
4525
4385
            _get_revision_range(my_revision, local_branch,
4580
4440
            message("Branches are up to date.\n")
4581
4441
        self.cleanup_now()
4582
4442
        if not status_code and parent is None and other_branch is not None:
4583
 
            self.add_cleanup(local_branch.lock_write().unlock)
 
4443
            local_branch.lock_write()
 
4444
            self.add_cleanup(local_branch.unlock)
4584
4445
            # handle race conditions - a parent might be set while we run.
4585
4446
            if local_branch.get_parent() is None:
4586
4447
                local_branch.set_parent(remote_branch.base)
4645
4506
 
4646
4507
    @display_command
4647
4508
    def run(self, verbose=False):
4648
 
        from bzrlib import plugin
4649
 
        # Don't give writelines a generator as some codecs don't like that
4650
 
        self.outf.writelines(
4651
 
            list(plugin.describe_plugins(show_paths=verbose)))
 
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")
4652
4529
 
4653
4530
 
4654
4531
class cmd_testament(Command):
4670
4547
            b = Branch.open_containing(branch)[0]
4671
4548
        else:
4672
4549
            b = Branch.open(branch)
4673
 
        self.add_cleanup(b.lock_read().unlock)
 
4550
        b.lock_read()
 
4551
        self.add_cleanup(b.unlock)
4674
4552
        if revision is None:
4675
4553
            rev_id = b.last_revision()
4676
4554
        else:
4700
4578
                     Option('long', help='Show commit date in annotations.'),
4701
4579
                     'revision',
4702
4580
                     'show-ids',
4703
 
                     'directory',
4704
4581
                     ]
4705
4582
    encoding_type = 'exact'
4706
4583
 
4707
4584
    @display_command
4708
4585
    def run(self, filename, all=False, long=False, revision=None,
4709
 
            show_ids=False, directory=None):
4710
 
        from bzrlib.annotate import (
4711
 
            annotate_file_tree,
4712
 
            )
 
4586
            show_ids=False):
 
4587
        from bzrlib.annotate import annotate_file, annotate_file_tree
4713
4588
        wt, branch, relpath = \
4714
 
            _open_directory_or_containing_tree_or_branch(filename, directory)
 
4589
            bzrdir.BzrDir.open_containing_tree_or_branch(filename)
4715
4590
        if wt is not None:
4716
 
            self.add_cleanup(wt.lock_read().unlock)
 
4591
            wt.lock_read()
 
4592
            self.add_cleanup(wt.unlock)
4717
4593
        else:
4718
 
            self.add_cleanup(branch.lock_read().unlock)
 
4594
            branch.lock_read()
 
4595
            self.add_cleanup(branch.unlock)
4719
4596
        tree = _get_one_revision_tree('annotate', revision, branch=branch)
4720
 
        self.add_cleanup(tree.lock_read().unlock)
4721
 
        if wt is not None and revision is None:
 
4597
        tree.lock_read()
 
4598
        self.add_cleanup(tree.unlock)
 
4599
        if wt is not None:
4722
4600
            file_id = wt.path2id(relpath)
4723
4601
        else:
4724
4602
            file_id = tree.path2id(relpath)
4725
4603
        if file_id is None:
4726
4604
            raise errors.NotVersionedError(filename)
 
4605
        file_version = tree.inventory[file_id].revision
4727
4606
        if wt is not None and revision is None:
4728
4607
            # If there is a tree and we're not annotating historical
4729
4608
            # versions, annotate the working tree's content.
4730
4609
            annotate_file_tree(wt, file_id, self.outf, long, all,
4731
4610
                show_ids=show_ids)
4732
4611
        else:
4733
 
            annotate_file_tree(tree, file_id, self.outf, long, all,
4734
 
                show_ids=show_ids, branch=branch)
 
4612
            annotate_file(branch, file_version, file_id, long, all, self.outf,
 
4613
                          show_ids=show_ids)
4735
4614
 
4736
4615
 
4737
4616
class cmd_re_sign(Command):
4740
4619
 
4741
4620
    hidden = True # is this right ?
4742
4621
    takes_args = ['revision_id*']
4743
 
    takes_options = ['directory', 'revision']
 
4622
    takes_options = ['revision']
4744
4623
 
4745
 
    def run(self, revision_id_list=None, revision=None, directory=u'.'):
 
4624
    def run(self, revision_id_list=None, revision=None):
4746
4625
        if revision_id_list is not None and revision is not None:
4747
4626
            raise errors.BzrCommandError('You can only supply one of revision_id or --revision')
4748
4627
        if revision_id_list is None and revision is None:
4749
4628
            raise errors.BzrCommandError('You must supply either --revision or a revision_id')
4750
 
        b = WorkingTree.open_containing(directory)[0].branch
4751
 
        self.add_cleanup(b.lock_write().unlock)
 
4629
        b = WorkingTree.open_containing(u'.')[0].branch
 
4630
        b.lock_write()
 
4631
        self.add_cleanup(b.unlock)
4752
4632
        return self._run(b, revision_id_list, revision)
4753
4633
 
4754
4634
    def _run(self, b, revision_id_list, revision):
4813
4693
 
4814
4694
    _see_also = ['checkouts', 'unbind']
4815
4695
    takes_args = ['location?']
4816
 
    takes_options = ['directory']
 
4696
    takes_options = []
4817
4697
 
4818
 
    def run(self, location=None, directory=u'.'):
4819
 
        b, relpath = Branch.open_containing(directory)
 
4698
    def run(self, location=None):
 
4699
        b, relpath = Branch.open_containing(u'.')
4820
4700
        if location is None:
4821
4701
            try:
4822
4702
                location = b.get_old_bound_location()
4849
4729
 
4850
4730
    _see_also = ['checkouts', 'bind']
4851
4731
    takes_args = []
4852
 
    takes_options = ['directory']
 
4732
    takes_options = []
4853
4733
 
4854
 
    def run(self, directory=u'.'):
4855
 
        b, relpath = Branch.open_containing(directory)
 
4734
    def run(self):
 
4735
        b, relpath = Branch.open_containing(u'.')
4856
4736
        if not b.unbind():
4857
4737
            raise errors.BzrCommandError('Local branch is not bound')
4858
4738
 
4904
4784
            b = control.open_branch()
4905
4785
 
4906
4786
        if tree is not None:
4907
 
            self.add_cleanup(tree.lock_write().unlock)
 
4787
            tree.lock_write()
 
4788
            self.add_cleanup(tree.unlock)
4908
4789
        else:
4909
 
            self.add_cleanup(b.lock_write().unlock)
 
4790
            b.lock_write()
 
4791
            self.add_cleanup(b.unlock)
4910
4792
        return self._run(b, tree, dry_run, verbose, revision, force, local=local)
4911
4793
 
4912
4794
    def _run(self, b, tree, dry_run, verbose, revision, force, local=False):
4951
4833
            self.outf.write('The above revision(s) will be removed.\n')
4952
4834
 
4953
4835
        if not force:
4954
 
            if not ui.ui_factory.confirm_action(
4955
 
                    'Uncommit these revisions',
4956
 
                    'bzrlib.builtins.uncommit',
4957
 
                    {}):
4958
 
                self.outf.write('Canceled\n')
 
4836
            if not ui.ui_factory.get_boolean('Are you sure'):
 
4837
                self.outf.write('Canceled')
4959
4838
                return 0
4960
4839
 
4961
4840
        mutter('Uncommitting from {%s} to {%s}',
4967
4846
 
4968
4847
 
4969
4848
class cmd_break_lock(Command):
4970
 
    __doc__ = """Break a dead lock.
4971
 
 
4972
 
    This command breaks a lock on a repository, branch, working directory or
4973
 
    config file.
 
4849
    __doc__ = """Break a dead lock on a repository, branch or working directory.
4974
4850
 
4975
4851
    CAUTION: Locks should only be broken when you are sure that the process
4976
4852
    holding the lock has been stopped.
4981
4857
    :Examples:
4982
4858
        bzr break-lock
4983
4859
        bzr break-lock bzr+ssh://example.com/bzr/foo
4984
 
        bzr break-lock --conf ~/.bazaar
4985
4860
    """
4986
 
 
4987
4861
    takes_args = ['location?']
4988
 
    takes_options = [
4989
 
        Option('config',
4990
 
               help='LOCATION is the directory where the config lock is.'),
4991
 
        Option('force',
4992
 
            help='Do not ask for confirmation before breaking the lock.'),
4993
 
        ]
4994
4862
 
4995
 
    def run(self, location=None, config=False, force=False):
 
4863
    def run(self, location=None, show=False):
4996
4864
        if location is None:
4997
4865
            location = u'.'
4998
 
        if force:
4999
 
            ui.ui_factory = ui.ConfirmationUserInterfacePolicy(ui.ui_factory,
5000
 
                None,
5001
 
                {'bzrlib.lockdir.break': True})
5002
 
        if config:
5003
 
            conf = _mod_config.LockableConfig(file_name=location)
5004
 
            conf.break_lock()
5005
 
        else:
5006
 
            control, relpath = bzrdir.BzrDir.open_containing(location)
5007
 
            try:
5008
 
                control.break_lock()
5009
 
            except NotImplementedError:
5010
 
                pass
 
4866
        control, relpath = bzrdir.BzrDir.open_containing(location)
 
4867
        try:
 
4868
            control.break_lock()
 
4869
        except NotImplementedError:
 
4870
            pass
5011
4871
 
5012
4872
 
5013
4873
class cmd_wait_until_signalled(Command):
5042
4902
                    'result in a dynamically allocated port.  The default port '
5043
4903
                    'depends on the protocol.',
5044
4904
               type=str),
5045
 
        custom_help('directory',
5046
 
               help='Serve contents of this directory.'),
 
4905
        Option('directory',
 
4906
               help='Serve contents of this directory.',
 
4907
               type=unicode),
5047
4908
        Option('allow-writes',
5048
4909
               help='By default the server is a readonly server.  Supplying '
5049
4910
                    '--allow-writes enables write access to the contents of '
5076
4937
 
5077
4938
    def run(self, port=None, inet=False, directory=None, allow_writes=False,
5078
4939
            protocol=None):
5079
 
        from bzrlib import transport
 
4940
        from bzrlib.transport import get_transport, transport_server_registry
5080
4941
        if directory is None:
5081
4942
            directory = os.getcwd()
5082
4943
        if protocol is None:
5083
 
            protocol = transport.transport_server_registry.get()
 
4944
            protocol = transport_server_registry.get()
5084
4945
        host, port = self.get_host_and_port(port)
5085
4946
        url = urlutils.local_path_to_url(directory)
5086
4947
        if not allow_writes:
5087
4948
            url = 'readonly+' + url
5088
 
        t = transport.get_transport(url)
5089
 
        protocol(t, host, port, inet)
 
4949
        transport = get_transport(url)
 
4950
        protocol(transport, host, port, inet)
5090
4951
 
5091
4952
 
5092
4953
class cmd_join(Command):
5098
4959
    not part of it.  (Such trees can be produced by "bzr split", but also by
5099
4960
    running "bzr branch" with the target inside a tree.)
5100
4961
 
5101
 
    The result is a combined tree, with the subtree no longer an independent
 
4962
    The result is a combined tree, with the subtree no longer an independant
5102
4963
    part.  This is marked as a merge of the subtree into the containing tree,
5103
4964
    and all history is preserved.
5104
4965
    """
5185
5046
    _see_also = ['send']
5186
5047
 
5187
5048
    takes_options = [
5188
 
        'directory',
5189
5049
        RegistryOption.from_kwargs('patch-type',
5190
5050
            'The type of patch to include in the directive.',
5191
5051
            title='Patch type',
5204
5064
    encoding_type = 'exact'
5205
5065
 
5206
5066
    def run(self, submit_branch=None, public_branch=None, patch_type='bundle',
5207
 
            sign=False, revision=None, mail_to=None, message=None,
5208
 
            directory=u'.'):
 
5067
            sign=False, revision=None, mail_to=None, message=None):
5209
5068
        from bzrlib.revision import ensure_null, NULL_REVISION
5210
5069
        include_patch, include_bundle = {
5211
5070
            'plain': (False, False),
5212
5071
            'diff': (True, False),
5213
5072
            'bundle': (True, True),
5214
5073
            }[patch_type]
5215
 
        branch = Branch.open(directory)
 
5074
        branch = Branch.open('.')
5216
5075
        stored_submit_branch = branch.get_submit_branch()
5217
5076
        if submit_branch is None:
5218
5077
            submit_branch = stored_submit_branch
5294
5153
    source branch defaults to that containing the working directory, but can
5295
5154
    be changed using --from.
5296
5155
 
5297
 
    Both the submit branch and the public branch follow the usual behavior with
5298
 
    respect to --remember: If there is no default location set, the first send
5299
 
    will set it (use --no-remember to avoid settting it). After that, you can
5300
 
    omit the location to use the default.  To change the default, use
5301
 
    --remember. The value will only be saved if the location can be accessed.
5302
 
 
5303
5156
    In order to calculate those changes, bzr must analyse the submit branch.
5304
5157
    Therefore it is most efficient for the submit branch to be a local mirror.
5305
5158
    If a public location is known for the submit_branch, that location is used
5309
5162
    given, in which case it is sent to a file.
5310
5163
 
5311
5164
    Mail is sent using your preferred mail program.  This should be transparent
5312
 
    on Windows (it uses MAPI).  On Unix, it requires the xdg-email utility.
 
5165
    on Windows (it uses MAPI).  On Linux, it requires the xdg-email utility.
5313
5166
    If the preferred client can't be found (or used), your editor will be used.
5314
5167
 
5315
5168
    To use a specific mail program, set the mail_client configuration option.
5374
5227
        ]
5375
5228
 
5376
5229
    def run(self, submit_branch=None, public_branch=None, no_bundle=False,
5377
 
            no_patch=False, revision=None, remember=None, output=None,
 
5230
            no_patch=False, revision=None, remember=False, output=None,
5378
5231
            format=None, mail_to=None, message=None, body=None,
5379
5232
            strict=None, **kwargs):
5380
5233
        from bzrlib.send import send
5486
5339
        Option('delete',
5487
5340
            help='Delete this tag rather than placing it.',
5488
5341
            ),
5489
 
        custom_help('directory',
5490
 
            help='Branch in which to place the tag.'),
 
5342
        Option('directory',
 
5343
            help='Branch in which to place the tag.',
 
5344
            short_name='d',
 
5345
            type=unicode,
 
5346
            ),
5491
5347
        Option('force',
5492
5348
            help='Replace existing tags.',
5493
5349
            ),
5501
5357
            revision=None,
5502
5358
            ):
5503
5359
        branch, relpath = Branch.open_containing(directory)
5504
 
        self.add_cleanup(branch.lock_write().unlock)
 
5360
        branch.lock_write()
 
5361
        self.add_cleanup(branch.unlock)
5505
5362
        if delete:
5506
5363
            if tag_name is None:
5507
5364
                raise errors.BzrCommandError("No tag specified to delete.")
5508
5365
            branch.tags.delete_tag(tag_name)
5509
 
            note('Deleted tag %s.' % tag_name)
 
5366
            self.outf.write('Deleted tag %s.\n' % tag_name)
5510
5367
        else:
5511
5368
            if revision:
5512
5369
                if len(revision) != 1:
5524
5381
            if (not force) and branch.tags.has_tag(tag_name):
5525
5382
                raise errors.TagAlreadyExists(tag_name)
5526
5383
            branch.tags.set_tag(tag_name, revision_id)
5527
 
            note('Created tag %s.' % tag_name)
 
5384
            self.outf.write('Created tag %s.\n' % tag_name)
5528
5385
 
5529
5386
 
5530
5387
class cmd_tags(Command):
5535
5392
 
5536
5393
    _see_also = ['tag']
5537
5394
    takes_options = [
5538
 
        custom_help('directory',
5539
 
            help='Branch whose tags should be displayed.'),
5540
 
        RegistryOption('sort',
 
5395
        Option('directory',
 
5396
            help='Branch whose tags should be displayed.',
 
5397
            short_name='d',
 
5398
            type=unicode,
 
5399
            ),
 
5400
        RegistryOption.from_kwargs('sort',
5541
5401
            'Sort tags by different criteria.', title='Sorting',
5542
 
            lazy_registry=('bzrlib.tag', 'tag_sort_methods')
 
5402
            alpha='Sort tags lexicographically (default).',
 
5403
            time='Sort tags chronologically.',
5543
5404
            ),
5544
5405
        'show-ids',
5545
5406
        'revision',
5546
5407
    ]
5547
5408
 
5548
5409
    @display_command
5549
 
    def run(self, directory='.', sort=None, show_ids=False, revision=None):
5550
 
        from bzrlib.tag import tag_sort_methods
 
5410
    def run(self,
 
5411
            directory='.',
 
5412
            sort='alpha',
 
5413
            show_ids=False,
 
5414
            revision=None,
 
5415
            ):
5551
5416
        branch, relpath = Branch.open_containing(directory)
5552
5417
 
5553
5418
        tags = branch.tags.get_tag_dict().items()
5554
5419
        if not tags:
5555
5420
            return
5556
5421
 
5557
 
        self.add_cleanup(branch.lock_read().unlock)
 
5422
        branch.lock_read()
 
5423
        self.add_cleanup(branch.unlock)
5558
5424
        if revision:
5559
5425
            graph = branch.repository.get_graph()
5560
5426
            rev1, rev2 = _get_revision_range(revision, branch, self.name())
5562
5428
            # only show revisions between revid1 and revid2 (inclusive)
5563
5429
            tags = [(tag, revid) for tag, revid in tags if
5564
5430
                graph.is_between(revid, revid1, revid2)]
5565
 
        if sort is None:
5566
 
            sort = tag_sort_methods.get()
5567
 
        sort(branch, tags)
 
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]])
5568
5444
        if not show_ids:
5569
5445
            # [ (tag, revid), ... ] -> [ (tag, dotted_revno), ... ]
5570
5446
            for index, (tag, revid) in enumerate(tags):
5572
5448
                    revno = branch.revision_id_to_dotted_revno(revid)
5573
5449
                    if isinstance(revno, tuple):
5574
5450
                        revno = '.'.join(map(str, revno))
5575
 
                except (errors.NoSuchRevision, errors.GhostRevisionsHaveNoRevno):
 
5451
                except errors.NoSuchRevision:
5576
5452
                    # Bad tag data/merges can lead to tagged revisions
5577
5453
                    # which are not in this branch. Fail gracefully ...
5578
5454
                    revno = '?'
5697
5573
    """
5698
5574
 
5699
5575
    takes_args = ['to_location?']
5700
 
    takes_options = ['directory',
5701
 
                     Option('force',
 
5576
    takes_options = [Option('force',
5702
5577
                        help='Switch even if local commits will be lost.'),
5703
5578
                     'revision',
5704
5579
                     Option('create-branch', short_name='b',
5707
5582
                    ]
5708
5583
 
5709
5584
    def run(self, to_location=None, force=False, create_branch=False,
5710
 
            revision=None, directory=u'.'):
 
5585
            revision=None):
5711
5586
        from bzrlib import switch
5712
 
        tree_location = directory
 
5587
        tree_location = '.'
5713
5588
        revision = _get_one_revision('switch', revision)
5714
5589
        control_dir = bzrdir.BzrDir.open_containing(tree_location)[0]
5715
5590
        if to_location is None:
5716
5591
            if revision is None:
5717
5592
                raise errors.BzrCommandError('You must supply either a'
5718
5593
                                             ' revision or a location')
5719
 
            to_location = tree_location
 
5594
            to_location = '.'
5720
5595
        try:
5721
5596
            branch = control_dir.open_branch()
5722
5597
            had_explicit_nick = branch.get_config().has_explicit_nickname()
5857
5732
            name=None,
5858
5733
            switch=None,
5859
5734
            ):
5860
 
        tree, file_list = WorkingTree.open_containing_paths(file_list,
5861
 
            apply_view=False)
 
5735
        tree, file_list = tree_files(file_list, apply_view=False)
5862
5736
        current_view, view_dict = tree.views.get_view_info()
5863
5737
        if name is None:
5864
5738
            name = current_view
5968
5842
            location = "."
5969
5843
        branch = Branch.open_containing(location)[0]
5970
5844
        branch.bzrdir.destroy_branch()
5971
 
 
 
5845
        
5972
5846
 
5973
5847
class cmd_shelve(Command):
5974
5848
    __doc__ = """Temporarily set aside some changes from the current tree.
5993
5867
 
5994
5868
    You can put multiple items on the shelf, and by default, 'unshelve' will
5995
5869
    restore the most recently shelved changes.
5996
 
 
5997
 
    For complicated changes, it is possible to edit the changes in a separate
5998
 
    editor program to decide what the file remaining in the working copy
5999
 
    should look like.  To do this, add the configuration option
6000
 
 
6001
 
        change_editor = PROGRAM @new_path @old_path
6002
 
 
6003
 
    where @new_path is replaced with the path of the new version of the 
6004
 
    file and @old_path is replaced with the path of the old version of 
6005
 
    the file.  The PROGRAM should save the new file with the desired 
6006
 
    contents of the file in the working tree.
6007
 
        
6008
5870
    """
6009
5871
 
6010
5872
    takes_args = ['file*']
6011
5873
 
6012
5874
    takes_options = [
6013
 
        'directory',
6014
5875
        'revision',
6015
5876
        Option('all', help='Shelve all changes.'),
6016
5877
        'message',
6022
5883
        Option('destroy',
6023
5884
               help='Destroy removed changes instead of shelving them.'),
6024
5885
    ]
6025
 
    _see_also = ['unshelve', 'configuration']
 
5886
    _see_also = ['unshelve']
6026
5887
 
6027
5888
    def run(self, revision=None, all=False, file_list=None, message=None,
6028
 
            writer=None, list=False, destroy=False, directory=None):
 
5889
            writer=None, list=False, destroy=False):
6029
5890
        if list:
6030
 
            return self.run_for_list(directory=directory)
 
5891
            return self.run_for_list()
6031
5892
        from bzrlib.shelf_ui import Shelver
6032
5893
        if writer is None:
6033
5894
            writer = bzrlib.option.diff_writer_registry.get()
6034
5895
        try:
6035
5896
            shelver = Shelver.from_args(writer(sys.stdout), revision, all,
6036
 
                file_list, message, destroy=destroy, directory=directory)
 
5897
                file_list, message, destroy=destroy)
6037
5898
            try:
6038
5899
                shelver.run()
6039
5900
            finally:
6041
5902
        except errors.UserAbort:
6042
5903
            return 0
6043
5904
 
6044
 
    def run_for_list(self, directory=None):
6045
 
        if directory is None:
6046
 
            directory = u'.'
6047
 
        tree = WorkingTree.open_containing(directory)[0]
6048
 
        self.add_cleanup(tree.lock_read().unlock)
 
5905
    def run_for_list(self):
 
5906
        tree = WorkingTree.open_containing('.')[0]
 
5907
        tree.lock_read()
 
5908
        self.add_cleanup(tree.unlock)
6049
5909
        manager = tree.get_shelf_manager()
6050
5910
        shelves = manager.active_shelves()
6051
5911
        if len(shelves) == 0:
6069
5929
 
6070
5930
    takes_args = ['shelf_id?']
6071
5931
    takes_options = [
6072
 
        'directory',
6073
5932
        RegistryOption.from_kwargs(
6074
5933
            'action', help="The action to perform.",
6075
5934
            enum_switch=False, value_switches=True,
6083
5942
    ]
6084
5943
    _see_also = ['shelve']
6085
5944
 
6086
 
    def run(self, shelf_id=None, action='apply', directory=u'.'):
 
5945
    def run(self, shelf_id=None, action='apply'):
6087
5946
        from bzrlib.shelf_ui import Unshelver
6088
 
        unshelver = Unshelver.from_args(shelf_id, action, directory=directory)
 
5947
        unshelver = Unshelver.from_args(shelf_id, action)
6089
5948
        try:
6090
5949
            unshelver.run()
6091
5950
        finally:
6107
5966
 
6108
5967
    To check what clean-tree will do, use --dry-run.
6109
5968
    """
6110
 
    takes_options = ['directory',
6111
 
                     Option('ignored', help='Delete all ignored files.'),
6112
 
                     Option('detritus', help='Delete conflict files, merge and revert'
 
5969
    takes_options = [Option('ignored', help='Delete all ignored files.'),
 
5970
                     Option('detritus', help='Delete conflict files, merge'
6113
5971
                            ' backups, and failed selftest dirs.'),
6114
5972
                     Option('unknown',
6115
5973
                            help='Delete files unknown to bzr (default).'),
6117
5975
                            ' deleting them.'),
6118
5976
                     Option('force', help='Do not prompt before deleting.')]
6119
5977
    def run(self, unknown=False, ignored=False, detritus=False, dry_run=False,
6120
 
            force=False, directory=u'.'):
 
5978
            force=False):
6121
5979
        from bzrlib.clean_tree import clean_tree
6122
5980
        if not (unknown or ignored or detritus):
6123
5981
            unknown = True
6124
5982
        if dry_run:
6125
5983
            force = True
6126
 
        clean_tree(directory, unknown=unknown, ignored=ignored,
6127
 
                   detritus=detritus, dry_run=dry_run, no_prompt=force)
 
5984
        clean_tree('.', unknown=unknown, ignored=ignored, detritus=detritus,
 
5985
                   dry_run=dry_run, no_prompt=force)
6128
5986
 
6129
5987
 
6130
5988
class cmd_reference(Command):
6174
6032
            self.outf.write('%s %s\n' % (path, location))
6175
6033
 
6176
6034
 
6177
 
class cmd_export_pot(Command):
6178
 
    __doc__ = """Export command helps and error messages in po format."""
6179
 
 
6180
 
    hidden = True
6181
 
 
6182
 
    def run(self):
6183
 
        from bzrlib.export_pot import export_pot
6184
 
        export_pot(self.outf)
6185
 
 
6186
 
 
6187
6035
def _register_lazy_builtins():
6188
6036
    # register lazy builtins from other modules; called at startup and should
6189
6037
    # be only called once.
6190
6038
    for (name, aliases, module_name) in [
6191
6039
        ('cmd_bundle_info', [], 'bzrlib.bundle.commands'),
6192
 
        ('cmd_config', [], 'bzrlib.config'),
6193
6040
        ('cmd_dpush', [], 'bzrlib.foreign'),
6194
6041
        ('cmd_version_info', [], 'bzrlib.cmd_version_info'),
6195
6042
        ('cmd_resolve', ['resolved'], 'bzrlib.conflicts'),
6196
6043
        ('cmd_conflicts', [], 'bzrlib.conflicts'),
6197
6044
        ('cmd_sign_my_commits', [], 'bzrlib.sign_my_commits'),
6198
 
        ('cmd_test_script', [], 'bzrlib.cmd_test_script'),
6199
6045
        ]:
6200
6046
        builtin_command_registry.register_lazy(name, aliases, module_name)