/brz/remove-bazaar

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

« back to all changes in this revision

Viewing changes to bzrlib/builtins.py

  • Committer: John Arbash Meinel
  • Date: 2011-05-25 13:44:28 UTC
  • mto: This revision was merged to the branch mainline in revision 5913.
  • Revision ID: john@arbash-meinel.com-20110525134428-pgce0hkk91qhjyyc
Fix a test that was failing on win32.

You can't open() a file that is exclusive locked.
So just read it from the raw file.

Show diffs side-by-side

added added

removed removed

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