~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/builtins.py

  • Committer: Martin Pool
  • Date: 2011-06-14 02:21:41 UTC
  • mto: This revision was merged to the branch mainline in revision 6001.
  • Revision ID: mbp@canonical.com-20110614022141-18hmm7s0iw3utcbj
Deprecate __contains__ on Tree and Inventory

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,
45
44
    rename_map,
46
45
    revision as _mod_revision,
47
46
    static_tuple,
48
 
    symbol_versioning,
49
47
    timestamp,
50
48
    transport,
51
49
    ui,
73
71
    _parse_revision_str,
74
72
    )
75
73
from bzrlib.trace import mutter, note, warning, is_quiet, get_verbosity_level
76
 
 
77
 
 
 
74
from bzrlib import (
 
75
    symbol_versioning,
 
76
    )
 
77
 
 
78
 
 
79
@symbol_versioning.deprecated_function(symbol_versioning.deprecated_in((2, 3, 0)))
78
80
def tree_files(file_list, default_branch=u'.', canonicalize=True,
79
81
    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]))
 
82
    return internal_tree_files(file_list, default_branch, canonicalize,
 
83
        apply_view)
86
84
 
87
85
 
88
86
def tree_files_for_add(file_list):
152
150
 
153
151
# XXX: Bad function name; should possibly also be a class method of
154
152
# WorkingTree rather than a function.
 
153
@symbol_versioning.deprecated_function(symbol_versioning.deprecated_in((2, 3, 0)))
155
154
def internal_tree_files(file_list, default_branch=u'.', canonicalize=True,
156
155
    apply_view=True):
157
156
    """Convert command-line paths to a WorkingTree and relative paths.
158
157
 
 
158
    Deprecated: use WorkingTree.open_containing_paths instead.
 
159
 
159
160
    This is typically used for command-line processors that take one or
160
161
    more filenames, and infer the workingtree that contains them.
161
162
 
171
172
 
172
173
    :return: workingtree, [relative_paths]
173
174
    """
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
 
175
    return WorkingTree.open_containing_paths(
 
176
        file_list, default_directory='.',
 
177
        canonicalize=True,
 
178
        apply_view=True)
221
179
 
222
180
 
223
181
def _get_view_info_for_change_reporter(tree):
232
190
    return view_info
233
191
 
234
192
 
 
193
def _open_directory_or_containing_tree_or_branch(filename, directory):
 
194
    """Open the tree or branch containing the specified file, unless
 
195
    the --directory option is used to specify a different branch."""
 
196
    if directory is not None:
 
197
        return (None, Branch.open(directory), filename)
 
198
    return bzrdir.BzrDir.open_containing_tree_or_branch(filename)
 
199
 
 
200
 
235
201
# TODO: Make sure no commands unconditionally use the working directory as a
236
202
# branch.  If a filename argument is used, the first of them should be used to
237
203
# specify the branch.  (Perhaps this can be factored out into some kind of
286
252
    To skip the display of pending merge information altogether, use
287
253
    the no-pending option or specify a file/directory.
288
254
 
289
 
    If a revision argument is given, the status is calculated against
290
 
    that revision, or between two revisions if two are provided.
 
255
    To compare the working directory to a specific revision, pass a
 
256
    single revision to the revision argument.
 
257
 
 
258
    To see which files have changed in a specific revision, or between
 
259
    two revisions, pass a revision range to the revision argument.
 
260
    This will produce the same results as calling 'bzr diff --summarize'.
291
261
    """
292
262
 
293
263
    # TODO: --no-recurse, --recurse options
315
285
            raise errors.BzrCommandError('bzr status --revision takes exactly'
316
286
                                         ' one or two revision specifiers')
317
287
 
318
 
        tree, relfile_list = tree_files(file_list)
 
288
        tree, relfile_list = WorkingTree.open_containing_paths(file_list)
319
289
        # Avoid asking for specific files when that is not needed.
320
290
        if relfile_list == ['']:
321
291
            relfile_list = None
340
310
 
341
311
    hidden = True
342
312
    takes_args = ['revision_id?']
343
 
    takes_options = ['revision']
 
313
    takes_options = ['directory', 'revision']
344
314
    # cat-revision is more for frontends so should be exact
345
315
    encoding = 'strict'
346
316
 
353
323
        self.outf.write(revtext.decode('utf-8'))
354
324
 
355
325
    @display_command
356
 
    def run(self, revision_id=None, revision=None):
 
326
    def run(self, revision_id=None, revision=None, directory=u'.'):
357
327
        if revision_id is not None and revision is not None:
358
328
            raise errors.BzrCommandError('You can only supply one of'
359
329
                                         ' revision_id or --revision')
360
330
        if revision_id is None and revision is None:
361
331
            raise errors.BzrCommandError('You must supply either'
362
332
                                         ' --revision or a revision_id')
363
 
        b = WorkingTree.open_containing(u'.')[0].branch
 
333
 
 
334
        b = bzrdir.BzrDir.open_containing_tree_or_branch(directory)[1]
364
335
 
365
336
        revisions = b.repository.revisions
366
337
        if revisions is None:
444
415
                self.outf.write(page_bytes[:header_end])
445
416
                page_bytes = data
446
417
            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')
 
418
            if len(page_bytes) == 0:
 
419
                self.outf.write('(empty)\n');
 
420
            else:
 
421
                decomp_bytes = zlib.decompress(page_bytes)
 
422
                self.outf.write(decomp_bytes)
 
423
                self.outf.write('\n')
450
424
 
451
425
    def _dump_entries(self, trans, basename):
452
426
        try:
483
457
    takes_options = [
484
458
        Option('force',
485
459
               help='Remove the working tree even if it has '
486
 
                    'uncommitted changes.'),
 
460
                    'uncommitted or shelved changes.'),
487
461
        ]
488
462
 
489
463
    def run(self, location_list, force=False):
503
477
            if not force:
504
478
                if (working.has_changes()):
505
479
                    raise errors.UncommittedChanges(working)
 
480
                if working.get_shelf_manager().last_shelf() is not None:
 
481
                    raise errors.ShelvedChanges(working)
506
482
 
507
483
            if working.user_url != working.branch.user_url:
508
484
                raise errors.BzrCommandError("You cannot remove the working tree"
511
487
            d.destroy_workingtree()
512
488
 
513
489
 
 
490
class cmd_repair_workingtree(Command):
 
491
    __doc__ = """Reset the working tree state file.
 
492
 
 
493
    This is not meant to be used normally, but more as a way to recover from
 
494
    filesystem corruption, etc. This rebuilds the working inventory back to a
 
495
    'known good' state. Any new modifications (adding a file, renaming, etc)
 
496
    will be lost, though modified files will still be detected as such.
 
497
 
 
498
    Most users will want something more like "bzr revert" or "bzr update"
 
499
    unless the state file has become corrupted.
 
500
 
 
501
    By default this attempts to recover the current state by looking at the
 
502
    headers of the state file. If the state file is too corrupted to even do
 
503
    that, you can supply --revision to force the state of the tree.
 
504
    """
 
505
 
 
506
    takes_options = ['revision', 'directory',
 
507
        Option('force',
 
508
               help='Reset the tree even if it doesn\'t appear to be'
 
509
                    ' corrupted.'),
 
510
    ]
 
511
    hidden = True
 
512
 
 
513
    def run(self, revision=None, directory='.', force=False):
 
514
        tree, _ = WorkingTree.open_containing(directory)
 
515
        self.add_cleanup(tree.lock_tree_write().unlock)
 
516
        if not force:
 
517
            try:
 
518
                tree.check_state()
 
519
            except errors.BzrError:
 
520
                pass # There seems to be a real error here, so we'll reset
 
521
            else:
 
522
                # Refuse
 
523
                raise errors.BzrCommandError(
 
524
                    'The tree does not appear to be corrupt. You probably'
 
525
                    ' want "bzr revert" instead. Use "--force" if you are'
 
526
                    ' sure you want to reset the working tree.')
 
527
        if revision is None:
 
528
            revision_ids = None
 
529
        else:
 
530
            revision_ids = [r.as_revision_id(tree.branch) for r in revision]
 
531
        try:
 
532
            tree.reset_state(revision_ids)
 
533
        except errors.BzrError, e:
 
534
            if revision_ids is None:
 
535
                extra = (', the header appears corrupt, try passing -r -1'
 
536
                         ' to set the state to the last commit')
 
537
            else:
 
538
                extra = ''
 
539
            raise errors.BzrCommandError('failed to reset the tree state'
 
540
                                         + extra)
 
541
 
 
542
 
514
543
class cmd_revno(Command):
515
544
    __doc__ = """Show current revision number.
516
545
 
528
557
        if tree:
529
558
            try:
530
559
                wt = WorkingTree.open_containing(location)[0]
531
 
                wt.lock_read()
 
560
                self.add_cleanup(wt.lock_read().unlock)
532
561
            except (errors.NoWorkingTree, errors.NotLocalUrl):
533
562
                raise errors.NoWorkingTree(location)
534
 
            self.add_cleanup(wt.unlock)
535
563
            revid = wt.last_revision()
536
564
            try:
537
565
                revno_t = wt.branch.revision_id_to_dotted_revno(revid)
540
568
            revno = ".".join(str(n) for n in revno_t)
541
569
        else:
542
570
            b = Branch.open_containing(location)[0]
543
 
            b.lock_read()
544
 
            self.add_cleanup(b.unlock)
 
571
            self.add_cleanup(b.lock_read().unlock)
545
572
            revno = b.revno()
546
573
        self.cleanup_now()
547
574
        self.outf.write(str(revno) + '\n')
554
581
    takes_args = ['revision_info*']
555
582
    takes_options = [
556
583
        'revision',
557
 
        Option('directory',
 
584
        custom_help('directory',
558
585
            help='Branch to examine, '
559
 
                 'rather than the one containing the working directory.',
560
 
            short_name='d',
561
 
            type=unicode,
562
 
            ),
 
586
                 'rather than the one containing the working directory.'),
563
587
        Option('tree', help='Show revno of working tree'),
564
588
        ]
565
589
 
570
594
        try:
571
595
            wt = WorkingTree.open_containing(directory)[0]
572
596
            b = wt.branch
573
 
            wt.lock_read()
574
 
            self.add_cleanup(wt.unlock)
 
597
            self.add_cleanup(wt.lock_read().unlock)
575
598
        except (errors.NoWorkingTree, errors.NotLocalUrl):
576
599
            wt = None
577
600
            b = Branch.open_containing(directory)[0]
578
 
            b.lock_read()
579
 
            self.add_cleanup(b.unlock)
 
601
            self.add_cleanup(b.lock_read().unlock)
580
602
        revision_ids = []
581
603
        if revision is not None:
582
604
            revision_ids.extend(rev.as_revision_id(b) for rev in revision)
681
703
                should_print=(not is_quiet()))
682
704
 
683
705
        if base_tree:
684
 
            base_tree.lock_read()
685
 
            self.add_cleanup(base_tree.unlock)
 
706
            self.add_cleanup(base_tree.lock_read().unlock)
686
707
        tree, file_list = tree_files_for_add(file_list)
687
708
        added, ignored = tree.smart_add(file_list, not
688
709
            no_recurse, action=action, save=not dry_run)
759
780
            raise errors.BzrCommandError('invalid kind %r specified' % (kind,))
760
781
 
761
782
        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)
 
783
        work_tree, file_list = WorkingTree.open_containing_paths(file_list)
 
784
        self.add_cleanup(work_tree.lock_read().unlock)
765
785
        if revision is not None:
766
786
            tree = revision.as_tree(work_tree.branch)
767
787
 
768
788
            extra_trees = [work_tree]
769
 
            tree.lock_read()
770
 
            self.add_cleanup(tree.unlock)
 
789
            self.add_cleanup(tree.lock_read().unlock)
771
790
        else:
772
791
            tree = work_tree
773
792
            extra_trees = []
777
796
                                      require_versioned=True)
778
797
            # find_ids_across_trees may include some paths that don't
779
798
            # exist in 'tree'.
780
 
            entries = sorted((tree.id2path(file_id), tree.inventory[file_id])
781
 
                             for file_id in file_ids if file_id in tree)
 
799
            entries = sorted(
 
800
                (tree.id2path(file_id), tree.inventory[file_id])
 
801
                for file_id in file_ids if tree.has_id(file_id))
782
802
        else:
783
803
            entries = tree.inventory.entries()
784
804
 
832
852
            names_list = []
833
853
        if len(names_list) < 2:
834
854
            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)
 
855
        tree, rel_names = WorkingTree.open_containing_paths(names_list, canonicalize=False)
 
856
        self.add_cleanup(tree.lock_tree_write().unlock)
838
857
        self._run(tree, names_list, rel_names, after)
839
858
 
840
859
    def run_auto(self, names_list, after, dry_run):
844
863
        if after:
845
864
            raise errors.BzrCommandError('--after cannot be specified with'
846
865
                                         ' --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)
 
866
        work_tree, file_list = WorkingTree.open_containing_paths(
 
867
            names_list, default_directory='.')
 
868
        self.add_cleanup(work_tree.lock_tree_write().unlock)
850
869
        rename_map.RenameMap.guess_renames(work_tree, dry_run)
851
870
 
852
871
    def _run(self, tree, names_list, rel_names, after):
946
965
    match the remote one, use pull --overwrite. This will work even if the two
947
966
    branches have diverged.
948
967
 
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.
 
968
    If there is no default location set, the first pull will set it (use
 
969
    --no-remember to avoid settting it). After that, you can omit the
 
970
    location to use the default.  To change the default, use --remember. The
 
971
    value will only be saved if the remote location can be accessed.
953
972
 
954
973
    Note: The location can be specified either in the form of a branch,
955
974
    or in the form of a path to a file containing a merge directive generated
960
979
    takes_options = ['remember', 'overwrite', 'revision',
961
980
        custom_help('verbose',
962
981
            help='Show logs of pulled revisions.'),
963
 
        Option('directory',
 
982
        custom_help('directory',
964
983
            help='Branch to pull into, '
965
 
                 'rather than the one containing the working directory.',
966
 
            short_name='d',
967
 
            type=unicode,
968
 
            ),
 
984
                 'rather than the one containing the working directory.'),
969
985
        Option('local',
970
986
            help="Perform a local pull in a bound "
971
987
                 "branch.  Local pulls are not applied to "
972
988
                 "the master branch."
973
989
            ),
 
990
        Option('show-base',
 
991
            help="Show base revision text in conflicts.")
974
992
        ]
975
993
    takes_args = ['location?']
976
994
    encoding_type = 'replace'
977
995
 
978
 
    def run(self, location=None, remember=False, overwrite=False,
 
996
    def run(self, location=None, remember=None, overwrite=False,
979
997
            revision=None, verbose=False,
980
 
            directory=None, local=False):
 
998
            directory=None, local=False,
 
999
            show_base=False):
981
1000
        # FIXME: too much stuff is in the command class
982
1001
        revision_id = None
983
1002
        mergeable = None
986
1005
        try:
987
1006
            tree_to = WorkingTree.open_containing(directory)[0]
988
1007
            branch_to = tree_to.branch
989
 
            tree_to.lock_write()
990
 
            self.add_cleanup(tree_to.unlock)
 
1008
            self.add_cleanup(tree_to.lock_write().unlock)
991
1009
        except errors.NoWorkingTree:
992
1010
            tree_to = None
993
1011
            branch_to = Branch.open_containing(directory)[0]
994
 
            branch_to.lock_write()
995
 
            self.add_cleanup(branch_to.unlock)
 
1012
            self.add_cleanup(branch_to.lock_write().unlock)
 
1013
 
 
1014
        if tree_to is None and show_base:
 
1015
            raise errors.BzrCommandError("Need working tree for --show-base.")
996
1016
 
997
1017
        if local and not branch_to.get_bound_location():
998
1018
            raise errors.LocalRequiresBoundBranch()
1029
1049
        else:
1030
1050
            branch_from = Branch.open(location,
1031
1051
                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:
 
1052
            self.add_cleanup(branch_from.lock_read().unlock)
 
1053
            # Remembers if asked explicitly or no previous location is set
 
1054
            if (remember
 
1055
                or (remember is None and branch_to.get_parent() is None)):
1036
1056
                branch_to.set_parent(branch_from.base)
1037
1057
 
1038
1058
        if revision is not None:
1045
1065
                view_info=view_info)
1046
1066
            result = tree_to.pull(
1047
1067
                branch_from, overwrite, revision_id, change_reporter,
1048
 
                possible_transports=possible_transports, local=local)
 
1068
                possible_transports=possible_transports, local=local,
 
1069
                show_base=show_base)
1049
1070
        else:
1050
1071
            result = branch_to.pull(
1051
1072
                branch_from, overwrite, revision_id, local=local)
1055
1076
            log.show_branch_change(
1056
1077
                branch_to, self.outf, result.old_revno,
1057
1078
                result.old_revid)
 
1079
        if getattr(result, 'tag_conflicts', None):
 
1080
            return 1
 
1081
        else:
 
1082
            return 0
1058
1083
 
1059
1084
 
1060
1085
class cmd_push(Command):
1077
1102
    do a merge (see bzr help merge) from the other branch, and commit that.
1078
1103
    After that you will be able to do a push without '--overwrite'.
1079
1104
 
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.
 
1105
    If there is no default push location set, the first push will set it (use
 
1106
    --no-remember to avoid settting it).  After that, you can omit the
 
1107
    location to use the default.  To change the default, use --remember. The
 
1108
    value will only be saved if the remote location can be accessed.
1084
1109
    """
1085
1110
 
1086
1111
    _see_also = ['pull', 'update', 'working-trees']
1088
1113
        Option('create-prefix',
1089
1114
               help='Create the path leading up to the branch '
1090
1115
                    'if it does not already exist.'),
1091
 
        Option('directory',
 
1116
        custom_help('directory',
1092
1117
            help='Branch to push from, '
1093
 
                 'rather than the one containing the working directory.',
1094
 
            short_name='d',
1095
 
            type=unicode,
1096
 
            ),
 
1118
                 'rather than the one containing the working directory.'),
1097
1119
        Option('use-existing-dir',
1098
1120
               help='By default push will fail if the target'
1099
1121
                    ' directory exists, but does not already'
1110
1132
        Option('strict',
1111
1133
               help='Refuse to push if there are uncommitted changes in'
1112
1134
               ' the working tree, --no-strict disables the check.'),
 
1135
        Option('no-tree',
 
1136
               help="Don't populate the working tree, even for protocols"
 
1137
               " that support it."),
1113
1138
        ]
1114
1139
    takes_args = ['location?']
1115
1140
    encoding_type = 'replace'
1116
1141
 
1117
 
    def run(self, location=None, remember=False, overwrite=False,
 
1142
    def run(self, location=None, remember=None, overwrite=False,
1118
1143
        create_prefix=False, verbose=False, revision=None,
1119
1144
        use_existing_dir=False, directory=None, stacked_on=None,
1120
 
        stacked=False, strict=None):
 
1145
        stacked=False, strict=None, no_tree=False):
1121
1146
        from bzrlib.push import _show_push_branch
1122
1147
 
1123
1148
        if directory is None:
1169
1194
        _show_push_branch(br_from, revision_id, location, self.outf,
1170
1195
            verbose=verbose, overwrite=overwrite, remember=remember,
1171
1196
            stacked_on=stacked_on, create_prefix=create_prefix,
1172
 
            use_existing_dir=use_existing_dir)
 
1197
            use_existing_dir=use_existing_dir, no_tree=no_tree)
1173
1198
 
1174
1199
 
1175
1200
class cmd_branch(Command):
1184
1209
 
1185
1210
    To retrieve the branch as of a particular revision, supply the --revision
1186
1211
    parameter, as in "branch foo/bar -r 5".
 
1212
 
 
1213
    The synonyms 'clone' and 'get' for this command are deprecated.
1187
1214
    """
1188
1215
 
1189
1216
    _see_also = ['checkout']
1190
1217
    takes_args = ['from_location', 'to_location?']
1191
 
    takes_options = ['revision', Option('hardlink',
1192
 
        help='Hard-link working tree files where possible.'),
 
1218
    takes_options = ['revision',
 
1219
        Option('hardlink', help='Hard-link working tree files where possible.'),
 
1220
        Option('files-from', type=str,
 
1221
               help="Get file contents from this tree."),
1193
1222
        Option('no-tree',
1194
1223
            help="Create a branch without a working-tree."),
1195
1224
        Option('switch',
1213
1242
 
1214
1243
    def run(self, from_location, to_location=None, revision=None,
1215
1244
            hardlink=False, stacked=False, standalone=False, no_tree=False,
1216
 
            use_existing_dir=False, switch=False, bind=False):
 
1245
            use_existing_dir=False, switch=False, bind=False,
 
1246
            files_from=None):
1217
1247
        from bzrlib import switch as _mod_switch
1218
1248
        from bzrlib.tag import _merge_tags_if_possible
 
1249
        if self.invoked_as in ['get', 'clone']:
 
1250
            ui.ui_factory.show_user_warning(
 
1251
                'deprecated_command',
 
1252
                deprecated_name=self.invoked_as,
 
1253
                recommended_name='branch',
 
1254
                deprecated_in_version='2.4')
1219
1255
        accelerator_tree, br_from = bzrdir.BzrDir.open_tree_or_branch(
1220
1256
            from_location)
 
1257
        if not (hardlink or files_from):
 
1258
            # accelerator_tree is usually slower because you have to read N
 
1259
            # files (no readahead, lots of seeks, etc), but allow the user to
 
1260
            # explicitly request it
 
1261
            accelerator_tree = None
 
1262
        if files_from is not None and files_from != from_location:
 
1263
            accelerator_tree = WorkingTree.open(files_from)
1221
1264
        revision = _get_one_revision('branch', revision)
1222
 
        br_from.lock_read()
1223
 
        self.add_cleanup(br_from.unlock)
 
1265
        self.add_cleanup(br_from.lock_read().unlock)
1224
1266
        if revision is not None:
1225
1267
            revision_id = revision.as_revision_id(br_from)
1226
1268
        else:
1331
1373
            to_location = branch_location
1332
1374
        accelerator_tree, source = bzrdir.BzrDir.open_tree_or_branch(
1333
1375
            branch_location)
 
1376
        if not (hardlink or files_from):
 
1377
            # accelerator_tree is usually slower because you have to read N
 
1378
            # files (no readahead, lots of seeks, etc), but allow the user to
 
1379
            # explicitly request it
 
1380
            accelerator_tree = None
1334
1381
        revision = _get_one_revision('checkout', revision)
1335
 
        if files_from is not None:
 
1382
        if files_from is not None and files_from != branch_location:
1336
1383
            accelerator_tree = WorkingTree.open(files_from)
1337
1384
        if revision is not None:
1338
1385
            revision_id = revision.as_revision_id(source)
1366
1413
    @display_command
1367
1414
    def run(self, dir=u'.'):
1368
1415
        tree = WorkingTree.open_containing(dir)[0]
1369
 
        tree.lock_read()
1370
 
        self.add_cleanup(tree.unlock)
 
1416
        self.add_cleanup(tree.lock_read().unlock)
1371
1417
        new_inv = tree.inventory
1372
1418
        old_tree = tree.basis_tree()
1373
 
        old_tree.lock_read()
1374
 
        self.add_cleanup(old_tree.unlock)
 
1419
        self.add_cleanup(old_tree.lock_read().unlock)
1375
1420
        old_inv = old_tree.inventory
1376
1421
        renames = []
1377
1422
        iterator = tree.iter_changes(old_tree, include_unchanged=True)
1396
1441
    If you want to discard your local changes, you can just do a
1397
1442
    'bzr revert' instead of 'bzr commit' after the update.
1398
1443
 
 
1444
    If you want to restore a file that has been removed locally, use
 
1445
    'bzr revert' instead of 'bzr update'.
 
1446
 
1399
1447
    If the tree's branch is bound to a master branch, it will also update
1400
1448
    the branch from the master.
1401
1449
    """
1402
1450
 
1403
1451
    _see_also = ['pull', 'working-trees', 'status-flags']
1404
1452
    takes_args = ['dir?']
1405
 
    takes_options = ['revision']
 
1453
    takes_options = ['revision',
 
1454
                     Option('show-base',
 
1455
                            help="Show base revision text in conflicts."),
 
1456
                     ]
1406
1457
    aliases = ['up']
1407
1458
 
1408
 
    def run(self, dir='.', revision=None):
 
1459
    def run(self, dir='.', revision=None, show_base=None):
1409
1460
        if revision is not None and len(revision) != 1:
1410
1461
            raise errors.BzrCommandError(
1411
1462
                        "bzr update --revision takes exactly one revision")
1415
1466
        master = branch.get_master_branch(
1416
1467
            possible_transports=possible_transports)
1417
1468
        if master is not None:
1418
 
            tree.lock_write()
1419
1469
            branch_location = master.base
 
1470
            tree.lock_write()
1420
1471
        else:
 
1472
            branch_location = tree.branch.base
1421
1473
            tree.lock_tree_write()
1422
 
            branch_location = tree.branch.base
1423
1474
        self.add_cleanup(tree.unlock)
1424
1475
        # get rid of the final '/' and be ready for display
1425
1476
        branch_location = urlutils.unescape_for_display(
1451
1502
                change_reporter,
1452
1503
                possible_transports=possible_transports,
1453
1504
                revision=revision_id,
1454
 
                old_tip=old_tip)
 
1505
                old_tip=old_tip,
 
1506
                show_base=show_base)
1455
1507
        except errors.NoSuchRevision, e:
1456
1508
            raise errors.BzrCommandError(
1457
1509
                                  "branch has no revision %s\n"
1519
1571
class cmd_remove(Command):
1520
1572
    __doc__ = """Remove files or directories.
1521
1573
 
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.
 
1574
    This makes Bazaar stop tracking changes to the specified files. Bazaar will
 
1575
    delete them if they can easily be recovered using revert otherwise they
 
1576
    will be backed up (adding an extention of the form .~#~). If no options or
 
1577
    parameters are given Bazaar will scan for files that are being tracked by
 
1578
    Bazaar but missing in your tree and stop tracking them for you.
1526
1579
    """
1527
1580
    takes_args = ['file*']
1528
1581
    takes_options = ['verbose',
1530
1583
        RegistryOption.from_kwargs('file-deletion-strategy',
1531
1584
            'The file deletion mode to be used.',
1532
1585
            title='Deletion Strategy', value_switches=True, enum_switch=False,
1533
 
            safe='Only delete files if they can be'
1534
 
                 ' safely recovered (default).',
 
1586
            safe='Backup changed files (default).',
1535
1587
            keep='Delete from bzr but leave the working copy.',
 
1588
            no_backup='Don\'t backup changed files.',
1536
1589
            force='Delete all the specified files, even if they can not be '
1537
 
                'recovered and even if they are non-empty directories.')]
 
1590
                'recovered and even if they are non-empty directories. '
 
1591
                '(deprecated, use no-backup)')]
1538
1592
    aliases = ['rm', 'del']
1539
1593
    encoding_type = 'replace'
1540
1594
 
1541
1595
    def run(self, file_list, verbose=False, new=False,
1542
1596
        file_deletion_strategy='safe'):
1543
 
        tree, file_list = tree_files(file_list)
 
1597
        if file_deletion_strategy == 'force':
 
1598
            note("(The --force option is deprecated, rather use --no-backup "
 
1599
                "in future.)")
 
1600
            file_deletion_strategy = 'no-backup'
 
1601
 
 
1602
        tree, file_list = WorkingTree.open_containing_paths(file_list)
1544
1603
 
1545
1604
        if file_list is not None:
1546
1605
            file_list = [f for f in file_list]
1547
1606
 
1548
 
        tree.lock_write()
1549
 
        self.add_cleanup(tree.unlock)
 
1607
        self.add_cleanup(tree.lock_write().unlock)
1550
1608
        # Heuristics should probably all move into tree.remove_smart or
1551
1609
        # some such?
1552
1610
        if new:
1567
1625
            file_deletion_strategy = 'keep'
1568
1626
        tree.remove(file_list, verbose=verbose, to_file=self.outf,
1569
1627
            keep_files=file_deletion_strategy=='keep',
1570
 
            force=file_deletion_strategy=='force')
 
1628
            force=(file_deletion_strategy=='no-backup'))
1571
1629
 
1572
1630
 
1573
1631
class cmd_file_id(Command):
1635
1693
 
1636
1694
    _see_also = ['check']
1637
1695
    takes_args = ['branch?']
 
1696
    takes_options = [
 
1697
        Option('canonicalize-chks',
 
1698
               help='Make sure CHKs are in canonical form (repairs '
 
1699
                    'bug 522637).',
 
1700
               hidden=True),
 
1701
        ]
1638
1702
 
1639
 
    def run(self, branch="."):
 
1703
    def run(self, branch=".", canonicalize_chks=False):
1640
1704
        from bzrlib.reconcile import reconcile
1641
1705
        dir = bzrdir.BzrDir.open(branch)
1642
 
        reconcile(dir)
 
1706
        reconcile(dir, canonicalize_chks=canonicalize_chks)
1643
1707
 
1644
1708
 
1645
1709
class cmd_revision_history(Command):
1722
1786
                ),
1723
1787
         Option('append-revisions-only',
1724
1788
                help='Never change revnos or the existing log.'
1725
 
                '  Append revisions to it only.')
 
1789
                '  Append revisions to it only.'),
 
1790
         Option('no-tree',
 
1791
                'Create a branch without a working tree.')
1726
1792
         ]
1727
1793
    def run(self, location=None, format=None, append_revisions_only=False,
1728
 
            create_prefix=False):
 
1794
            create_prefix=False, no_tree=False):
1729
1795
        if format is None:
1730
1796
            format = bzrdir.format_registry.make_bzrdir('default')
1731
1797
        if location is None:
1754
1820
        except errors.NotBranchError:
1755
1821
            # really a NotBzrDir error...
1756
1822
            create_branch = bzrdir.BzrDir.create_branch_convenience
 
1823
            if no_tree:
 
1824
                force_new_tree = False
 
1825
            else:
 
1826
                force_new_tree = None
1757
1827
            branch = create_branch(to_transport.base, format=format,
1758
 
                                   possible_transports=[to_transport])
 
1828
                                   possible_transports=[to_transport],
 
1829
                                   force_new_tree=force_new_tree)
1759
1830
            a_bzrdir = branch.bzrdir
1760
1831
        else:
1761
1832
            from bzrlib.transport.local import LocalTransport
1765
1836
                        raise errors.BranchExistsWithoutWorkingTree(location)
1766
1837
                raise errors.AlreadyBranchError(location)
1767
1838
            branch = a_bzrdir.create_branch()
1768
 
            a_bzrdir.create_workingtree()
 
1839
            if not no_tree:
 
1840
                a_bzrdir.create_workingtree()
1769
1841
        if append_revisions_only:
1770
1842
            try:
1771
1843
                branch.set_append_revisions_only(True)
1865
1937
    "bzr diff -p1" is equivalent to "bzr diff --prefix old/:new/", and
1866
1938
    produces patches suitable for "patch -p1".
1867
1939
 
 
1940
    Note that when using the -r argument with a range of revisions, the
 
1941
    differences are computed between the two specified revisions.  That
 
1942
    is, the command does not show the changes introduced by the first 
 
1943
    revision in the range.  This differs from the interpretation of 
 
1944
    revision ranges used by "bzr log" which includes the first revision
 
1945
    in the range.
 
1946
 
1868
1947
    :Exit values:
1869
1948
        1 - changed
1870
1949
        2 - unrepresentable changes
1888
1967
 
1889
1968
            bzr diff -r1..3 xxx
1890
1969
 
1891
 
        To see the changes introduced in revision X::
 
1970
        The changes introduced by revision 2 (equivalent to -r1..2)::
 
1971
 
 
1972
            bzr diff -c2
 
1973
 
 
1974
        To see the changes introduced by revision X::
1892
1975
        
1893
1976
            bzr diff -cX
1894
1977
 
1898
1981
 
1899
1982
            bzr diff -r<chosen_parent>..X
1900
1983
 
1901
 
        The changes introduced by revision 2 (equivalent to -r1..2)::
 
1984
        The changes between the current revision and the previous revision
 
1985
        (equivalent to -c-1 and -r-2..-1)
1902
1986
 
1903
 
            bzr diff -c2
 
1987
            bzr diff -r-2..
1904
1988
 
1905
1989
        Show just the differences for file NEWS::
1906
1990
 
1921
2005
        Same as 'bzr diff' but prefix paths with old/ and new/::
1922
2006
 
1923
2007
            bzr diff --prefix old/:new/
 
2008
            
 
2009
        Show the differences using a custom diff program with options::
 
2010
        
 
2011
            bzr diff --using /usr/bin/diff --diff-options -wu
1924
2012
    """
1925
2013
    _see_also = ['status']
1926
2014
    takes_args = ['file*']
1946
2034
            type=unicode,
1947
2035
            ),
1948
2036
        RegistryOption('format',
 
2037
            short_name='F',
1949
2038
            help='Diff format to use.',
1950
2039
            lazy_registry=('bzrlib.diff', 'format_registry'),
1951
 
            value_switches=False, title='Diff format'),
 
2040
            title='Diff format'),
1952
2041
        ]
1953
2042
    aliases = ['di', 'dif']
1954
2043
    encoding_type = 'exact'
1985
2074
         old_branch, new_branch,
1986
2075
         specific_files, extra_trees) = get_trees_and_branches_to_diff_locked(
1987
2076
            file_list, revision, old, new, self.add_cleanup, apply_view=True)
 
2077
        # GNU diff on Windows uses ANSI encoding for filenames
 
2078
        path_encoding = osutils.get_diff_header_encoding()
1988
2079
        return show_diff_trees(old_tree, new_tree, sys.stdout,
1989
2080
                               specific_files=specific_files,
1990
2081
                               external_diff_options=diff_options,
1991
2082
                               old_label=old_label, new_label=new_label,
1992
 
                               extra_trees=extra_trees, using=using,
 
2083
                               extra_trees=extra_trees,
 
2084
                               path_encoding=path_encoding,
 
2085
                               using=using,
1993
2086
                               format_cls=format)
1994
2087
 
1995
2088
 
2003
2096
    # level of effort but possibly much less IO.  (Or possibly not,
2004
2097
    # if the directories are very large...)
2005
2098
    _see_also = ['status', 'ls']
2006
 
    takes_options = ['show-ids']
 
2099
    takes_options = ['directory', 'show-ids']
2007
2100
 
2008
2101
    @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)
 
2102
    def run(self, show_ids=False, directory=u'.'):
 
2103
        tree = WorkingTree.open_containing(directory)[0]
 
2104
        self.add_cleanup(tree.lock_read().unlock)
2013
2105
        old = tree.basis_tree()
2014
 
        old.lock_read()
2015
 
        self.add_cleanup(old.unlock)
 
2106
        self.add_cleanup(old.lock_read().unlock)
2016
2107
        for path, ie in old.inventory.iter_entries():
2017
2108
            if not tree.has_id(ie.file_id):
2018
2109
                self.outf.write(path)
2028
2119
 
2029
2120
    hidden = True
2030
2121
    _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
 
            ]
 
2122
    takes_options = ['directory', 'null']
2036
2123
 
2037
2124
    @display_command
2038
 
    def run(self, null=False):
2039
 
        tree = WorkingTree.open_containing(u'.')[0]
 
2125
    def run(self, null=False, directory=u'.'):
 
2126
        tree = WorkingTree.open_containing(directory)[0]
 
2127
        self.add_cleanup(tree.lock_read().unlock)
2040
2128
        td = tree.changes_from(tree.basis_tree())
 
2129
        self.cleanup_now()
2041
2130
        for path, id, kind, text_modified, meta_modified in td.modified:
2042
2131
            if null:
2043
2132
                self.outf.write(path + '\0')
2051
2140
 
2052
2141
    hidden = True
2053
2142
    _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
 
            ]
 
2143
    takes_options = ['directory', 'null']
2059
2144
 
2060
2145
    @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)
 
2146
    def run(self, null=False, directory=u'.'):
 
2147
        wt = WorkingTree.open_containing(directory)[0]
 
2148
        self.add_cleanup(wt.lock_read().unlock)
2065
2149
        basis = wt.basis_tree()
2066
 
        basis.lock_read()
2067
 
        self.add_cleanup(basis.unlock)
 
2150
        self.add_cleanup(basis.lock_read().unlock)
2068
2151
        basis_inv = basis.inventory
2069
2152
        inv = wt.inventory
2070
2153
        for file_id in inv:
2071
 
            if file_id in basis_inv:
 
2154
            if basis_inv.has_id(file_id):
2072
2155
                continue
2073
2156
            if inv.is_root(file_id) and len(basis_inv) == 0:
2074
2157
                continue
2075
2158
            path = inv.id2path(file_id)
2076
 
            if not os.access(osutils.abspath(path), os.F_OK):
 
2159
            if not os.access(osutils.pathjoin(wt.basedir, path), os.F_OK):
2077
2160
                continue
2078
2161
            if null:
2079
2162
                self.outf.write(path + '\0')
2279
2362
                   help='Show just the specified revision.'
2280
2363
                   ' See also "help revisionspec".'),
2281
2364
            'log-format',
 
2365
            RegistryOption('authors',
 
2366
                'What names to list as authors - first, all or committer.',
 
2367
                title='Authors',
 
2368
                lazy_registry=('bzrlib.log', 'author_list_registry'),
 
2369
            ),
2282
2370
            Option('levels',
2283
2371
                   short_name='n',
2284
2372
                   help='Number of levels to display - 0 for all, 1 for flat.',
2319
2407
            limit=None,
2320
2408
            show_diff=False,
2321
2409
            include_merges=False,
 
2410
            authors=None,
2322
2411
            exclude_common_ancestry=False,
2323
2412
            ):
2324
2413
        from bzrlib.log import (
2352
2441
        if file_list:
2353
2442
            # find the file ids to log and check for directory filtering
2354
2443
            b, file_info_list, rev1, rev2 = _get_info_for_log_files(
2355
 
                revision, file_list)
2356
 
            self.add_cleanup(b.unlock)
 
2444
                revision, file_list, self.add_cleanup)
2357
2445
            for relpath, file_id, kind in file_info_list:
2358
2446
                if file_id is None:
2359
2447
                    raise errors.BzrCommandError(
2377
2465
                location = '.'
2378
2466
            dir, relpath = bzrdir.BzrDir.open_containing(location)
2379
2467
            b = dir.open_branch()
2380
 
            b.lock_read()
2381
 
            self.add_cleanup(b.unlock)
 
2468
            self.add_cleanup(b.lock_read().unlock)
2382
2469
            rev1, rev2 = _get_revision_range(revision, b, self.name())
2383
2470
 
2384
2471
        # Decide on the type of delta & diff filtering to use
2404
2491
                        show_timezone=timezone,
2405
2492
                        delta_format=get_verbosity_level(),
2406
2493
                        levels=levels,
2407
 
                        show_advice=levels is None)
 
2494
                        show_advice=levels is None,
 
2495
                        author_list_handler=authors)
2408
2496
 
2409
2497
        # Choose the algorithm for doing the logging. It's annoying
2410
2498
        # having multiple code paths like this but necessary until
2508
2596
        tree, relpath = WorkingTree.open_containing(filename)
2509
2597
        file_id = tree.path2id(relpath)
2510
2598
        b = tree.branch
2511
 
        b.lock_read()
2512
 
        self.add_cleanup(b.unlock)
 
2599
        self.add_cleanup(b.lock_read().unlock)
2513
2600
        touching_revs = log.find_touching_revisions(b, file_id)
2514
2601
        for revno, revision_id, what in touching_revs:
2515
2602
            self.outf.write("%6d %s\n" % (revno, what))
2528
2615
                   help='Recurse into subdirectories.'),
2529
2616
            Option('from-root',
2530
2617
                   help='Print paths relative to the root of the branch.'),
2531
 
            Option('unknown', help='Print unknown files.'),
 
2618
            Option('unknown', short_name='u',
 
2619
                help='Print unknown files.'),
2532
2620
            Option('versioned', help='Print versioned files.',
2533
2621
                   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',
 
2622
            Option('ignored', short_name='i',
 
2623
                help='Print ignored files.'),
 
2624
            Option('kind', short_name='k',
2539
2625
                   help='List entries of a particular kind: file, directory, symlink.',
2540
2626
                   type=unicode),
 
2627
            'null',
2541
2628
            'show-ids',
 
2629
            'directory',
2542
2630
            ]
2543
2631
    @display_command
2544
2632
    def run(self, revision=None, verbose=False,
2545
2633
            recursive=False, from_root=False,
2546
2634
            unknown=False, versioned=False, ignored=False,
2547
 
            null=False, kind=None, show_ids=False, path=None):
 
2635
            null=False, kind=None, show_ids=False, path=None, directory=None):
2548
2636
 
2549
2637
        if kind and kind not in ('file', 'directory', 'symlink'):
2550
2638
            raise errors.BzrCommandError('invalid kind specified')
2562
2650
                raise errors.BzrCommandError('cannot specify both --from-root'
2563
2651
                                             ' and PATH')
2564
2652
            fs_path = path
2565
 
        tree, branch, relpath = bzrdir.BzrDir.open_containing_tree_or_branch(
2566
 
            fs_path)
 
2653
        tree, branch, relpath = \
 
2654
            _open_directory_or_containing_tree_or_branch(fs_path, directory)
2567
2655
 
2568
2656
        # Calculate the prefix to use
2569
2657
        prefix = None
2584
2672
                view_str = views.view_display_str(view_files)
2585
2673
                note("Ignoring files outside view. View is %s" % view_str)
2586
2674
 
2587
 
        tree.lock_read()
2588
 
        self.add_cleanup(tree.unlock)
 
2675
        self.add_cleanup(tree.lock_read().unlock)
2589
2676
        for fp, fc, fkind, fid, entry in tree.list_files(include_root=False,
2590
2677
            from_dir=relpath, recursive=recursive):
2591
2678
            # Apply additional masking
2638
2725
 
2639
2726
    hidden = True
2640
2727
    _see_also = ['ls']
 
2728
    takes_options = ['directory']
2641
2729
 
2642
2730
    @display_command
2643
 
    def run(self):
2644
 
        for f in WorkingTree.open_containing(u'.')[0].unknowns():
 
2731
    def run(self, directory=u'.'):
 
2732
        for f in WorkingTree.open_containing(directory)[0].unknowns():
2645
2733
            self.outf.write(osutils.quotefn(f) + '\n')
2646
2734
 
2647
2735
 
2674
2762
    Patterns prefixed with '!!' act as regular ignore patterns, but have
2675
2763
    precedence over the '!' exception patterns.
2676
2764
 
2677
 
    Note: ignore patterns containing shell wildcards must be quoted from
2678
 
    the shell on Unix.
 
2765
    :Notes: 
 
2766
        
 
2767
    * Ignore patterns containing shell wildcards must be quoted from
 
2768
      the shell on Unix.
 
2769
 
 
2770
    * Ignore patterns starting with "#" act as comments in the ignore file.
 
2771
      To ignore patterns that begin with that character, use the "RE:" prefix.
2679
2772
 
2680
2773
    :Examples:
2681
2774
        Ignore the top level Makefile::
2690
2783
 
2691
2784
            bzr ignore "!special.class"
2692
2785
 
 
2786
        Ignore files whose name begins with the "#" character::
 
2787
 
 
2788
            bzr ignore "RE:^#"
 
2789
 
2693
2790
        Ignore .o files under the lib directory::
2694
2791
 
2695
2792
            bzr ignore "lib/**/*.o"
2703
2800
            bzr ignore "RE:(?!debian/).*"
2704
2801
        
2705
2802
        Ignore everything except the "local" toplevel directory,
2706
 
        but always ignore "*~" autosave files, even under local/::
 
2803
        but always ignore autosave files ending in ~, even under local/::
2707
2804
        
2708
2805
            bzr ignore "*"
2709
2806
            bzr ignore "!./local"
2712
2809
 
2713
2810
    _see_also = ['status', 'ignored', 'patterns']
2714
2811
    takes_args = ['name_pattern*']
2715
 
    takes_options = [
 
2812
    takes_options = ['directory',
2716
2813
        Option('default-rules',
2717
2814
               help='Display the default ignore rules that bzr uses.')
2718
2815
        ]
2719
2816
 
2720
 
    def run(self, name_pattern_list=None, default_rules=None):
 
2817
    def run(self, name_pattern_list=None, default_rules=None,
 
2818
            directory=u'.'):
2721
2819
        from bzrlib import ignores
2722
2820
        if default_rules is not None:
2723
2821
            # dump the default rules and exit
2729
2827
                "NAME_PATTERN or --default-rules.")
2730
2828
        name_pattern_list = [globbing.normalize_pattern(p)
2731
2829
                             for p in name_pattern_list]
 
2830
        bad_patterns = ''
 
2831
        for p in name_pattern_list:
 
2832
            if not globbing.Globster.is_pattern_valid(p):
 
2833
                bad_patterns += ('\n  %s' % p)
 
2834
        if bad_patterns:
 
2835
            msg = ('Invalid ignore pattern(s) found. %s' % bad_patterns)
 
2836
            ui.ui_factory.show_error(msg)
 
2837
            raise errors.InvalidPattern('')
2732
2838
        for name_pattern in name_pattern_list:
2733
2839
            if (name_pattern[0] == '/' or
2734
2840
                (len(name_pattern) > 1 and name_pattern[1] == ':')):
2735
2841
                raise errors.BzrCommandError(
2736
2842
                    "NAME_PATTERN should not be an absolute path")
2737
 
        tree, relpath = WorkingTree.open_containing(u'.')
 
2843
        tree, relpath = WorkingTree.open_containing(directory)
2738
2844
        ignores.tree_ignores_add_patterns(tree, name_pattern_list)
2739
2845
        ignored = globbing.Globster(name_pattern_list)
2740
2846
        matches = []
2741
 
        tree.lock_read()
 
2847
        self.add_cleanup(tree.lock_read().unlock)
2742
2848
        for entry in tree.list_files():
2743
2849
            id = entry[3]
2744
2850
            if id is not None:
2745
2851
                filename = entry[0]
2746
2852
                if ignored.match(filename):
2747
2853
                    matches.append(filename)
2748
 
        tree.unlock()
2749
2854
        if len(matches) > 0:
2750
2855
            self.outf.write("Warning: the following files are version controlled and"
2751
2856
                  " match your ignore pattern:\n%s"
2766
2871
 
2767
2872
    encoding_type = 'replace'
2768
2873
    _see_also = ['ignore', 'ls']
 
2874
    takes_options = ['directory']
2769
2875
 
2770
2876
    @display_command
2771
 
    def run(self):
2772
 
        tree = WorkingTree.open_containing(u'.')[0]
2773
 
        tree.lock_read()
2774
 
        self.add_cleanup(tree.unlock)
 
2877
    def run(self, directory=u'.'):
 
2878
        tree = WorkingTree.open_containing(directory)[0]
 
2879
        self.add_cleanup(tree.lock_read().unlock)
2775
2880
        for path, file_class, kind, file_id, entry in tree.list_files():
2776
2881
            if file_class != 'I':
2777
2882
                continue
2788
2893
    """
2789
2894
    hidden = True
2790
2895
    takes_args = ['revno']
 
2896
    takes_options = ['directory']
2791
2897
 
2792
2898
    @display_command
2793
 
    def run(self, revno):
 
2899
    def run(self, revno, directory=u'.'):
2794
2900
        try:
2795
2901
            revno = int(revno)
2796
2902
        except ValueError:
2797
2903
            raise errors.BzrCommandError("not a valid revision-number: %r"
2798
2904
                                         % revno)
2799
 
        revid = WorkingTree.open_containing(u'.')[0].branch.get_rev_id(revno)
 
2905
        revid = WorkingTree.open_containing(directory)[0].branch.get_rev_id(revno)
2800
2906
        self.outf.write("%s\n" % revid)
2801
2907
 
2802
2908
 
2828
2934
         zip                          .zip
2829
2935
      =================       =========================
2830
2936
    """
 
2937
    encoding = 'exact'
2831
2938
    takes_args = ['dest', 'branch_or_subdir?']
2832
 
    takes_options = [
 
2939
    takes_options = ['directory',
2833
2940
        Option('format',
2834
2941
               help="Type of file to export to.",
2835
2942
               type=unicode),
2844
2951
                    'revision in which it was changed.'),
2845
2952
        ]
2846
2953
    def run(self, dest, branch_or_subdir=None, revision=None, format=None,
2847
 
        root=None, filters=False, per_file_timestamps=False):
 
2954
        root=None, filters=False, per_file_timestamps=False, directory=u'.'):
2848
2955
        from bzrlib.export import export
2849
2956
 
2850
2957
        if branch_or_subdir is None:
2851
 
            tree = WorkingTree.open_containing(u'.')[0]
 
2958
            tree = WorkingTree.open_containing(directory)[0]
2852
2959
            b = tree.branch
2853
2960
            subdir = None
2854
2961
        else:
2873
2980
    """
2874
2981
 
2875
2982
    _see_also = ['ls']
2876
 
    takes_options = [
 
2983
    takes_options = ['directory',
2877
2984
        Option('name-from-revision', help='The path name in the old tree.'),
2878
2985
        Option('filters', help='Apply content filters to display the '
2879
2986
                'convenience form.'),
2884
2991
 
2885
2992
    @display_command
2886
2993
    def run(self, filename, revision=None, name_from_revision=False,
2887
 
            filters=False):
 
2994
            filters=False, directory=None):
2888
2995
        if revision is not None and len(revision) != 1:
2889
2996
            raise errors.BzrCommandError("bzr cat --revision takes exactly"
2890
2997
                                         " one revision specifier")
2891
2998
        tree, branch, relpath = \
2892
 
            bzrdir.BzrDir.open_containing_tree_or_branch(filename)
2893
 
        branch.lock_read()
2894
 
        self.add_cleanup(branch.unlock)
 
2999
            _open_directory_or_containing_tree_or_branch(filename, directory)
 
3000
        self.add_cleanup(branch.lock_read().unlock)
2895
3001
        return self._run(tree, branch, relpath, filename, revision,
2896
3002
                         name_from_revision, filters)
2897
3003
 
2900
3006
        if tree is None:
2901
3007
            tree = b.basis_tree()
2902
3008
        rev_tree = _get_one_revision_tree('cat', revision, branch=b)
2903
 
        rev_tree.lock_read()
2904
 
        self.add_cleanup(rev_tree.unlock)
 
3009
        self.add_cleanup(rev_tree.lock_read().unlock)
2905
3010
 
2906
3011
        old_file_id = rev_tree.path2id(relpath)
2907
3012
 
3013
3118
      to trigger updates to external systems like bug trackers. The --fixes
3014
3119
      option can be used to record the association between a revision and
3015
3120
      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
3121
    """
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
3122
 
3043
3123
    _see_also = ['add', 'bugs', 'hooks', 'uncommit']
3044
3124
    takes_args = ['selected*']
3076
3156
             Option('show-diff', short_name='p',
3077
3157
                    help='When no message is supplied, show the diff along'
3078
3158
                    ' with the status summary in the message editor.'),
 
3159
             Option('lossy', 
 
3160
                    help='When committing to a foreign version control '
 
3161
                    'system do not push data that can not be natively '
 
3162
                    'represented.'),
3079
3163
             ]
3080
3164
    aliases = ['ci', 'checkin']
3081
3165
 
3100
3184
 
3101
3185
    def run(self, message=None, file=None, verbose=False, selected_list=None,
3102
3186
            unchanged=False, strict=False, local=False, fixes=None,
3103
 
            author=None, show_diff=False, exclude=None, commit_time=None):
 
3187
            author=None, show_diff=False, exclude=None, commit_time=None,
 
3188
            lossy=False):
3104
3189
        from bzrlib.errors import (
3105
3190
            PointlessCommit,
3106
3191
            ConflictsInTree,
3109
3194
        from bzrlib.msgeditor import (
3110
3195
            edit_commit_message_encoded,
3111
3196
            generate_commit_message_template,
3112
 
            make_commit_message_template_encoded
 
3197
            make_commit_message_template_encoded,
 
3198
            set_commit_message,
3113
3199
        )
3114
3200
 
3115
3201
        commit_stamp = offset = None
3120
3206
                raise errors.BzrCommandError(
3121
3207
                    "Could not parse --commit-time: " + str(e))
3122
3208
 
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
3209
        properties = {}
3130
3210
 
3131
 
        tree, selected_list = tree_files(selected_list)
 
3211
        tree, selected_list = WorkingTree.open_containing_paths(selected_list)
3132
3212
        if selected_list == ['']:
3133
3213
            # workaround - commit of root of tree should be exactly the same
3134
3214
            # as just default commit in that tree, and succeed even though
3169
3249
        def get_message(commit_obj):
3170
3250
            """Callback to get commit message"""
3171
3251
            if file:
3172
 
                my_message = codecs.open(
3173
 
                    file, 'rt', osutils.get_user_encoding()).read()
 
3252
                f = open(file)
 
3253
                try:
 
3254
                    my_message = f.read().decode(osutils.get_user_encoding())
 
3255
                finally:
 
3256
                    f.close()
3174
3257
            elif message is not None:
3175
3258
                my_message = message
3176
3259
            else:
3184
3267
                # make_commit_message_template_encoded returns user encoding.
3185
3268
                # We probably want to be using edit_commit_message instead to
3186
3269
                # avoid this.
3187
 
                start_message = generate_commit_message_template(commit_obj)
3188
 
                my_message = edit_commit_message_encoded(text,
3189
 
                    start_message=start_message)
 
3270
                my_message = set_commit_message(commit_obj)
 
3271
                if my_message is None:
 
3272
                    start_message = generate_commit_message_template(commit_obj)
 
3273
                    my_message = edit_commit_message_encoded(text,
 
3274
                        start_message=start_message)
3190
3275
                if my_message is None:
3191
3276
                    raise errors.BzrCommandError("please specify a commit"
3192
3277
                        " message with either --message or --file")
3205
3290
                        reporter=None, verbose=verbose, revprops=properties,
3206
3291
                        authors=author, timestamp=commit_stamp,
3207
3292
                        timezone=offset,
3208
 
                        exclude=safe_relpath_files(tree, exclude))
 
3293
                        exclude=tree.safe_relpath_files(exclude),
 
3294
                        lossy=lossy)
3209
3295
        except PointlessCommit:
3210
3296
            raise errors.BzrCommandError("No changes to commit."
3211
 
                              " Use --unchanged to commit anyhow.")
 
3297
                " Please 'bzr add' the files you want to commit, or use"
 
3298
                " --unchanged to force an empty commit.")
3212
3299
        except ConflictsInTree:
3213
3300
            raise errors.BzrCommandError('Conflicts detected in working '
3214
3301
                'tree.  Use "bzr conflicts" to list, "bzr resolve FILE" to'
3295
3382
 
3296
3383
 
3297
3384
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.
 
3385
    __doc__ = """Upgrade a repository, branch or working tree to a newer format.
 
3386
 
 
3387
    When the default format has changed after a major new release of
 
3388
    Bazaar, you may be informed during certain operations that you
 
3389
    should upgrade. Upgrading to a newer format may improve performance
 
3390
    or make new features available. It may however limit interoperability
 
3391
    with older repositories or with older versions of Bazaar.
 
3392
 
 
3393
    If you wish to upgrade to a particular format rather than the
 
3394
    current default, that can be specified using the --format option.
 
3395
    As a consequence, you can use the upgrade command this way to
 
3396
    "downgrade" to an earlier format, though some conversions are
 
3397
    a one way process (e.g. changing from the 1.x default to the
 
3398
    2.x default) so downgrading is not always possible.
 
3399
 
 
3400
    A backup.bzr.~#~ directory is created at the start of the conversion
 
3401
    process (where # is a number). By default, this is left there on
 
3402
    completion. If the conversion fails, delete the new .bzr directory
 
3403
    and rename this one back in its place. Use the --clean option to ask
 
3404
    for the backup.bzr directory to be removed on successful conversion.
 
3405
    Alternatively, you can delete it by hand if everything looks good
 
3406
    afterwards.
 
3407
 
 
3408
    If the location given is a shared repository, dependent branches
 
3409
    are also converted provided the repository converts successfully.
 
3410
    If the conversion of a branch fails, remaining branches are still
 
3411
    tried.
 
3412
 
 
3413
    For more information on upgrades, see the Bazaar Upgrade Guide,
 
3414
    http://doc.bazaar.canonical.com/latest/en/upgrade-guide/.
3303
3415
    """
3304
3416
 
3305
 
    _see_also = ['check']
 
3417
    _see_also = ['check', 'reconcile', 'formats']
3306
3418
    takes_args = ['url?']
3307
3419
    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
 
                    ]
 
3420
        RegistryOption('format',
 
3421
            help='Upgrade to a specific format.  See "bzr help'
 
3422
                 ' formats" for details.',
 
3423
            lazy_registry=('bzrlib.bzrdir', 'format_registry'),
 
3424
            converter=lambda name: bzrdir.format_registry.make_bzrdir(name),
 
3425
            value_switches=True, title='Branch format'),
 
3426
        Option('clean',
 
3427
            help='Remove the backup.bzr directory if successful.'),
 
3428
        Option('dry-run',
 
3429
            help="Show what would be done, but don't actually do anything."),
 
3430
    ]
3315
3431
 
3316
 
    def run(self, url='.', format=None):
 
3432
    def run(self, url='.', format=None, clean=False, dry_run=False):
3317
3433
        from bzrlib.upgrade import upgrade
3318
 
        upgrade(url, format)
 
3434
        exceptions = upgrade(url, format, clean_up=clean, dry_run=dry_run)
 
3435
        if exceptions:
 
3436
            if len(exceptions) == 1:
 
3437
                # Compatibility with historical behavior
 
3438
                raise exceptions[0]
 
3439
            else:
 
3440
                return 3
3319
3441
 
3320
3442
 
3321
3443
class cmd_whoami(Command):
3330
3452
 
3331
3453
            bzr whoami "Frank Chu <fchu@example.com>"
3332
3454
    """
3333
 
    takes_options = [ Option('email',
 
3455
    takes_options = [ 'directory',
 
3456
                      Option('email',
3334
3457
                             help='Display email address only.'),
3335
3458
                      Option('branch',
3336
3459
                             help='Set identity for the current branch instead of '
3340
3463
    encoding_type = 'replace'
3341
3464
 
3342
3465
    @display_command
3343
 
    def run(self, email=False, branch=False, name=None):
 
3466
    def run(self, email=False, branch=False, name=None, directory=None):
3344
3467
        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()
 
3468
            if directory is None:
 
3469
                # use branch if we're inside one; otherwise global config
 
3470
                try:
 
3471
                    c = Branch.open_containing(u'.')[0].get_config()
 
3472
                except errors.NotBranchError:
 
3473
                    c = _mod_config.GlobalConfig()
 
3474
            else:
 
3475
                c = Branch.open(directory).get_config()
3350
3476
            if email:
3351
3477
                self.outf.write(c.user_email() + '\n')
3352
3478
            else:
3353
3479
                self.outf.write(c.username() + '\n')
3354
3480
            return
3355
3481
 
 
3482
        if email:
 
3483
            raise errors.BzrCommandError("--email can only be used to display existing "
 
3484
                                         "identity")
 
3485
 
3356
3486
        # display a warning if an email address isn't included in the given name.
3357
3487
        try:
3358
 
            config.extract_email_address(name)
 
3488
            _mod_config.extract_email_address(name)
3359
3489
        except errors.NoEmailInUsername, e:
3360
3490
            warning('"%s" does not seem to contain an email address.  '
3361
3491
                    'This is allowed, but not recommended.', name)
3362
3492
 
3363
3493
        # use global config unless --branch given
3364
3494
        if branch:
3365
 
            c = Branch.open_containing('.')[0].get_config()
 
3495
            if directory is None:
 
3496
                c = Branch.open_containing(u'.')[0].get_config()
 
3497
            else:
 
3498
                c = Branch.open(directory).get_config()
3366
3499
        else:
3367
 
            c = config.GlobalConfig()
 
3500
            c = _mod_config.GlobalConfig()
3368
3501
        c.set_user_option('email', name)
3369
3502
 
3370
3503
 
3380
3513
 
3381
3514
    _see_also = ['info']
3382
3515
    takes_args = ['nickname?']
3383
 
    def run(self, nickname=None):
3384
 
        branch = Branch.open_containing(u'.')[0]
 
3516
    takes_options = ['directory']
 
3517
    def run(self, nickname=None, directory=u'.'):
 
3518
        branch = Branch.open_containing(directory)[0]
3385
3519
        if nickname is None:
3386
3520
            self.printme(branch)
3387
3521
        else:
3436
3570
                'bzr alias --remove expects an alias to remove.')
3437
3571
        # If alias is not found, print something like:
3438
3572
        # unalias: foo: not found
3439
 
        c = config.GlobalConfig()
 
3573
        c = _mod_config.GlobalConfig()
3440
3574
        c.unset_alias(alias_name)
3441
3575
 
3442
3576
    @display_command
3443
3577
    def print_aliases(self):
3444
3578
        """Print out the defined aliases in a similar format to bash."""
3445
 
        aliases = config.GlobalConfig().get_aliases()
 
3579
        aliases = _mod_config.GlobalConfig().get_aliases()
3446
3580
        for key, value in sorted(aliases.iteritems()):
3447
3581
            self.outf.write('bzr alias %s="%s"\n' % (key, value))
3448
3582
 
3458
3592
 
3459
3593
    def set_alias(self, alias_name, alias_command):
3460
3594
        """Save the alias in the global config."""
3461
 
        c = config.GlobalConfig()
 
3595
        c = _mod_config.GlobalConfig()
3462
3596
        c.set_alias(alias_name, alias_command)
3463
3597
 
3464
3598
 
3499
3633
    If you set BZR_TEST_PDB=1 when running selftest, failing tests will drop
3500
3634
    into a pdb postmortem session.
3501
3635
 
 
3636
    The --coverage=DIRNAME global option produces a report with covered code
 
3637
    indicated.
 
3638
 
3502
3639
    :Examples:
3503
3640
        Run only tests relating to 'ignore'::
3504
3641
 
3515
3652
        if typestring == "sftp":
3516
3653
            from bzrlib.tests import stub_sftp
3517
3654
            return stub_sftp.SFTPAbsoluteServer
3518
 
        if typestring == "memory":
 
3655
        elif typestring == "memory":
3519
3656
            from bzrlib.tests import test_server
3520
3657
            return memory.MemoryServer
3521
 
        if typestring == "fakenfs":
 
3658
        elif typestring == "fakenfs":
3522
3659
            from bzrlib.tests import test_server
3523
3660
            return test_server.FakeNFSServer
3524
3661
        msg = "No known transport type %s. Supported types are: sftp\n" %\
3537
3674
                                 'throughout the test suite.',
3538
3675
                            type=get_transport_type),
3539
3676
                     Option('benchmark',
3540
 
                            help='Run the benchmarks rather than selftests.'),
 
3677
                            help='Run the benchmarks rather than selftests.',
 
3678
                            hidden=True),
3541
3679
                     Option('lsprof-timed',
3542
3680
                            help='Generate lsprof output for benchmarked'
3543
3681
                                 ' sections of code.'),
3544
3682
                     Option('lsprof-tests',
3545
3683
                            help='Generate lsprof output for each test.'),
3546
 
                     Option('cache-dir', type=str,
3547
 
                            help='Cache intermediate benchmark output in this '
3548
 
                                 'directory.'),
3549
3684
                     Option('first',
3550
3685
                            help='Run all tests, but run specified tests first.',
3551
3686
                            short_name='f',
3560
3695
                     Option('randomize', type=str, argname="SEED",
3561
3696
                            help='Randomize the order of tests using the given'
3562
3697
                                 ' seed or "now" for the current time.'),
3563
 
                     Option('exclude', type=str, argname="PATTERN",
3564
 
                            short_name='x',
3565
 
                            help='Exclude tests that match this regular'
3566
 
                                 ' expression.'),
 
3698
                     ListOption('exclude', type=str, argname="PATTERN",
 
3699
                                short_name='x',
 
3700
                                help='Exclude tests that match this regular'
 
3701
                                ' expression.'),
3567
3702
                     Option('subunit',
3568
3703
                        help='Output test progress via subunit.'),
3569
3704
                     Option('strict', help='Fail on missing dependencies or '
3585
3720
 
3586
3721
    def run(self, testspecs_list=None, verbose=False, one=False,
3587
3722
            transport=None, benchmark=None,
3588
 
            lsprof_timed=None, cache_dir=None,
 
3723
            lsprof_timed=None,
3589
3724
            first=False, list_only=False,
3590
3725
            randomize=None, exclude=None, strict=False,
3591
3726
            load_list=None, debugflag=None, starting_with=None, subunit=False,
3592
3727
            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)
 
3728
        from bzrlib import tests
 
3729
 
3602
3730
        if testspecs_list is not None:
3603
3731
            pattern = '|'.join(testspecs_list)
3604
3732
        else:
3612
3740
            self.additional_selftest_args['runner_class'] = SubUnitBzrRunner
3613
3741
            # On Windows, disable automatic conversion of '\n' to '\r\n' in
3614
3742
            # stdout, which would corrupt the subunit stream. 
3615
 
            if sys.platform == "win32" and sys.stdout.fileno() >= 0:
 
3743
            # FIXME: This has been fixed in subunit trunk (>0.0.5) so the
 
3744
            # following code can be deleted when it's sufficiently deployed
 
3745
            # -- vila/mgz 20100514
 
3746
            if (sys.platform == "win32"
 
3747
                and getattr(sys.stdout, 'fileno', None) is not None):
3616
3748
                import msvcrt
3617
3749
                msvcrt.setmode(sys.stdout.fileno(), os.O_BINARY)
3618
3750
        if parallel:
3619
3751
            self.additional_selftest_args.setdefault(
3620
3752
                'suite_decorators', []).append(parallel)
3621
3753
        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)
 
3754
            raise errors.BzrCommandError(
 
3755
                "--benchmark is no longer supported from bzr 2.2; "
 
3756
                "use bzr-usertest instead")
 
3757
        test_suite_factory = None
 
3758
        if not exclude:
 
3759
            exclude_pattern = None
3628
3760
        else:
3629
 
            test_suite_factory = None
3630
 
            benchfile = None
 
3761
            exclude_pattern = '(' + '|'.join(exclude) + ')'
3631
3762
        selftest_kwargs = {"verbose": verbose,
3632
3763
                          "pattern": pattern,
3633
3764
                          "stop_on_failure": one,
3635
3766
                          "test_suite_factory": test_suite_factory,
3636
3767
                          "lsprof_timed": lsprof_timed,
3637
3768
                          "lsprof_tests": lsprof_tests,
3638
 
                          "bench_history": benchfile,
3639
3769
                          "matching_tests_first": first,
3640
3770
                          "list_only": list_only,
3641
3771
                          "random_seed": randomize,
3642
 
                          "exclude_pattern": exclude,
 
3772
                          "exclude_pattern": exclude_pattern,
3643
3773
                          "strict": strict,
3644
3774
                          "load_list": load_list,
3645
3775
                          "debug_flags": debugflag,
3646
3776
                          "starting_with": starting_with
3647
3777
                          }
3648
3778
        selftest_kwargs.update(self.additional_selftest_args)
3649
 
        result = selftest(**selftest_kwargs)
 
3779
 
 
3780
        # Make deprecation warnings visible, unless -Werror is set
 
3781
        cleanup = symbol_versioning.activate_deprecation_warnings(
 
3782
            override=False)
 
3783
        try:
 
3784
            result = tests.selftest(**selftest_kwargs)
 
3785
        finally:
 
3786
            cleanup()
3650
3787
        return int(not result)
3651
3788
 
3652
3789
 
3690
3827
 
3691
3828
        branch1 = Branch.open_containing(branch)[0]
3692
3829
        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)
 
3830
        self.add_cleanup(branch1.lock_read().unlock)
 
3831
        self.add_cleanup(branch2.lock_read().unlock)
3697
3832
        last1 = ensure_null(branch1.last_revision())
3698
3833
        last2 = ensure_null(branch2.last_revision())
3699
3834
 
3709
3844
    The source of the merge can be specified either in the form of a branch,
3710
3845
    or in the form of a path to a file containing a merge directive generated
3711
3846
    with bzr send. If neither is specified, the default is the upstream branch
3712
 
    or the branch most recently merged using --remember.
3713
 
 
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.
 
3847
    or the branch most recently merged using --remember.  The source of the
 
3848
    merge may also be specified in the form of a path to a file in another
 
3849
    branch:  in this case, only the modifications to that file are merged into
 
3850
    the current working tree.
 
3851
 
 
3852
    When merging from a branch, by default bzr will try to merge in all new
 
3853
    work from the other branch, automatically determining an appropriate base
 
3854
    revision.  If this fails, you may need to give an explicit base.
 
3855
 
 
3856
    To pick a different ending revision, pass "--revision OTHER".  bzr will
 
3857
    try to merge in all new work up to and including revision OTHER.
 
3858
 
 
3859
    If you specify two values, "--revision BASE..OTHER", only revisions BASE
 
3860
    through OTHER, excluding BASE but including OTHER, will be merged.  If this
 
3861
    causes some revisions to be skipped, i.e. if the destination branch does
 
3862
    not already contain revision BASE, such a merge is commonly referred to as
 
3863
    a "cherrypick". Unlike a normal merge, Bazaar does not currently track
 
3864
    cherrypicks. The changes look like a normal commit, and the history of the
 
3865
    changes from the other branch is not stored in the commit.
 
3866
 
 
3867
    Revision numbers are always relative to the source branch.
3724
3868
 
3725
3869
    Merge will do its best to combine the changes in two branches, but there
3726
3870
    are some kinds of problems only a human can fix.  When it encounters those,
3729
3873
 
3730
3874
    Use bzr resolve when you have fixed a problem.  See also bzr conflicts.
3731
3875
 
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.
 
3876
    If there is no default branch set, the first merge will set it (use
 
3877
    --no-remember to avoid settting it). After that, you can omit the branch
 
3878
    to use the default.  To change the default, use --remember. The value will
 
3879
    only be saved if the remote location can be accessed.
3736
3880
 
3737
3881
    The results of the merge are placed into the destination working
3738
3882
    directory, where they can be reviewed (with bzr diff), tested, and then
3739
3883
    committed to record the result of the merge.
3740
3884
 
3741
3885
    merge refuses to run if there are any uncommitted changes, unless
3742
 
    --force is given. The --force option can also be used to create a
 
3886
    --force is given.  If --force is given, then the changes from the source 
 
3887
    will be merged with the current working tree, including any uncommitted
 
3888
    changes in the tree.  The --force option can also be used to create a
3743
3889
    merge revision which has more than two parents.
3744
3890
 
3745
3891
    If one would like to merge changes from the working tree of the other
3750
3896
    you to apply each diff hunk and file change, similar to "shelve".
3751
3897
 
3752
3898
    :Examples:
3753
 
        To merge the latest revision from bzr.dev::
 
3899
        To merge all new revisions from bzr.dev::
3754
3900
 
3755
3901
            bzr merge ../bzr.dev
3756
3902
 
3793
3939
                ' completely merged into the source, pull from the'
3794
3940
                ' source rather than merging.  When this happens,'
3795
3941
                ' you do not need to commit the result.'),
3796
 
        Option('directory',
 
3942
        custom_help('directory',
3797
3943
               help='Branch to merge into, '
3798
 
                    'rather than the one containing the working directory.',
3799
 
               short_name='d',
3800
 
               type=unicode,
3801
 
               ),
 
3944
                    'rather than the one containing the working directory.'),
3802
3945
        Option('preview', help='Instead of merging, show a diff of the'
3803
3946
               ' merge.'),
3804
3947
        Option('interactive', help='Select changes interactively.',
3806
3949
    ]
3807
3950
 
3808
3951
    def run(self, location=None, revision=None, force=False,
3809
 
            merge_type=None, show_base=False, reprocess=None, remember=False,
 
3952
            merge_type=None, show_base=False, reprocess=None, remember=None,
3810
3953
            uncommitted=False, pull=False,
3811
3954
            directory=None,
3812
3955
            preview=False,
3820
3963
        merger = None
3821
3964
        allow_pending = True
3822
3965
        verified = 'inapplicable'
 
3966
 
3823
3967
        tree = WorkingTree.open_containing(directory)[0]
 
3968
        if tree.branch.revno() == 0:
 
3969
            raise errors.BzrCommandError('Merging into empty branches not currently supported, '
 
3970
                                         'https://bugs.launchpad.net/bzr/+bug/308562')
3824
3971
 
3825
3972
        try:
3826
3973
            basis_tree = tree.revision_tree(tree.last_revision())
3837
3984
            unversioned_filter=tree.is_ignored, view_info=view_info)
3838
3985
        pb = ui.ui_factory.nested_progress_bar()
3839
3986
        self.add_cleanup(pb.finished)
3840
 
        tree.lock_write()
3841
 
        self.add_cleanup(tree.unlock)
 
3987
        self.add_cleanup(tree.lock_write().unlock)
3842
3988
        if location is not None:
3843
3989
            try:
3844
3990
                mergeable = bundle.read_mergeable_from_url(location,
3873
4019
        self.sanity_check_merger(merger)
3874
4020
        if (merger.base_rev_id == merger.other_rev_id and
3875
4021
            merger.other_rev_id is not None):
 
4022
            # check if location is a nonexistent file (and not a branch) to
 
4023
            # disambiguate the 'Nothing to do'
 
4024
            if merger.interesting_files:
 
4025
                if not merger.other_tree.has_filename(
 
4026
                    merger.interesting_files[0]):
 
4027
                    note("merger: " + str(merger))
 
4028
                    raise errors.PathsDoNotExist([location])
3876
4029
            note('Nothing to do.')
3877
4030
            return 0
3878
 
        if pull:
 
4031
        if pull and not preview:
3879
4032
            if merger.interesting_files is not None:
3880
4033
                raise errors.BzrCommandError('Cannot pull individual files')
3881
4034
            if (merger.base_rev_id == tree.last_revision()):
3905
4058
    def _do_preview(self, merger):
3906
4059
        from bzrlib.diff import show_diff_trees
3907
4060
        result_tree = self._get_preview(merger)
 
4061
        path_encoding = osutils.get_diff_header_encoding()
3908
4062
        show_diff_trees(merger.this_tree, result_tree, self.outf,
3909
 
                        old_label='', new_label='')
 
4063
                        old_label='', new_label='',
 
4064
                        path_encoding=path_encoding)
3910
4065
 
3911
4066
    def _do_merge(self, merger, change_reporter, allow_pending, verified):
3912
4067
        merger.change_reporter = change_reporter
3988
4143
        if other_revision_id is None:
3989
4144
            other_revision_id = _mod_revision.ensure_null(
3990
4145
                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):
 
4146
        # Remember where we merge from. We need to remember if:
 
4147
        # - user specify a location (and we don't merge from the parent
 
4148
        #   branch)
 
4149
        # - user ask to remember or there is no previous location set to merge
 
4150
        #   from and user didn't ask to *not* remember
 
4151
        if (user_location is not None
 
4152
            and ((remember
 
4153
                  or (remember is None
 
4154
                      and tree.branch.get_submit_branch() is None)))):
3994
4155
            tree.branch.set_submit_branch(other_branch.base)
3995
 
        _merge_tags_if_possible(other_branch, tree.branch)
 
4156
        # Merge tags (but don't set them in the master branch yet, the user
 
4157
        # might revert this merge).  Commit will propagate them.
 
4158
        _merge_tags_if_possible(other_branch, tree.branch, ignore_master=True)
3996
4159
        merger = _mod_merge.Merger.from_revision_ids(pb, tree,
3997
4160
            other_revision_id, base_revision_id, other_branch, base_branch)
3998
4161
        if other_path != '':
4099
4262
        from bzrlib.conflicts import restore
4100
4263
        if merge_type is None:
4101
4264
            merge_type = _mod_merge.Merge3Merger
4102
 
        tree, file_list = tree_files(file_list)
4103
 
        tree.lock_write()
4104
 
        self.add_cleanup(tree.unlock)
 
4265
        tree, file_list = WorkingTree.open_containing_paths(file_list)
 
4266
        self.add_cleanup(tree.lock_write().unlock)
4105
4267
        parents = tree.get_parent_ids()
4106
4268
        if len(parents) != 2:
4107
4269
            raise errors.BzrCommandError("Sorry, remerge only works after normal"
4167
4329
    last committed revision is used.
4168
4330
 
4169
4331
    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.
 
4332
    merge instead.  For example, "merge . -r -2..-3" (don't forget the ".")
 
4333
    will remove the changes introduced by the second last commit (-2), without
 
4334
    affecting the changes introduced by the last commit (-1).  To remove
 
4335
    certain changes on a hunk-by-hunk basis, see the shelve command.
4173
4336
 
4174
4337
    By default, any files that have been manually changed will be backed up
4175
4338
    first.  (Files changed only by merge are not backed up.)  Backup files have
4205
4368
    target branches.
4206
4369
    """
4207
4370
 
4208
 
    _see_also = ['cat', 'export']
 
4371
    _see_also = ['cat', 'export', 'merge', 'shelve']
4209
4372
    takes_options = [
4210
4373
        'revision',
4211
4374
        Option('no-backup', "Do not save backups of reverted files."),
4216
4379
 
4217
4380
    def run(self, revision=None, no_backup=False, file_list=None,
4218
4381
            forget_merges=None):
4219
 
        tree, file_list = tree_files(file_list)
4220
 
        tree.lock_tree_write()
4221
 
        self.add_cleanup(tree.unlock)
 
4382
        tree, file_list = WorkingTree.open_containing_paths(file_list)
 
4383
        self.add_cleanup(tree.lock_tree_write().unlock)
4222
4384
        if forget_merges:
4223
4385
            tree.set_parent_ids(tree.get_parent_ids()[:1])
4224
4386
        else:
4313
4475
    _see_also = ['merge', 'pull']
4314
4476
    takes_args = ['other_branch?']
4315
4477
    takes_options = [
 
4478
        'directory',
4316
4479
        Option('reverse', 'Reverse the order of revisions.'),
4317
4480
        Option('mine-only',
4318
4481
               'Display changes in the local branch only.'),
4340
4503
            theirs_only=False,
4341
4504
            log_format=None, long=False, short=False, line=False,
4342
4505
            show_ids=False, verbose=False, this=False, other=False,
4343
 
            include_merges=False, revision=None, my_revision=None):
 
4506
            include_merges=False, revision=None, my_revision=None,
 
4507
            directory=u'.'):
4344
4508
        from bzrlib.missing import find_unmerged, iter_log_revisions
4345
4509
        def message(s):
4346
4510
            if not is_quiet():
4359
4523
        elif theirs_only:
4360
4524
            restrict = 'remote'
4361
4525
 
4362
 
        local_branch = Branch.open_containing(u".")[0]
4363
 
        local_branch.lock_read()
4364
 
        self.add_cleanup(local_branch.unlock)
 
4526
        local_branch = Branch.open_containing(directory)[0]
 
4527
        self.add_cleanup(local_branch.lock_read().unlock)
4365
4528
 
4366
4529
        parent = local_branch.get_parent()
4367
4530
        if other_branch is None:
4378
4541
        if remote_branch.base == local_branch.base:
4379
4542
            remote_branch = local_branch
4380
4543
        else:
4381
 
            remote_branch.lock_read()
4382
 
            self.add_cleanup(remote_branch.unlock)
 
4544
            self.add_cleanup(remote_branch.lock_read().unlock)
4383
4545
 
4384
4546
        local_revid_range = _revision_range_to_revid_range(
4385
4547
            _get_revision_range(my_revision, local_branch,
4440
4602
            message("Branches are up to date.\n")
4441
4603
        self.cleanup_now()
4442
4604
        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)
 
4605
            self.add_cleanup(local_branch.lock_write().unlock)
4445
4606
            # handle race conditions - a parent might be set while we run.
4446
4607
            if local_branch.get_parent() is None:
4447
4608
                local_branch.set_parent(remote_branch.base)
4506
4667
 
4507
4668
    @display_command
4508
4669
    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")
 
4670
        from bzrlib import plugin
 
4671
        # Don't give writelines a generator as some codecs don't like that
 
4672
        self.outf.writelines(
 
4673
            list(plugin.describe_plugins(show_paths=verbose)))
4529
4674
 
4530
4675
 
4531
4676
class cmd_testament(Command):
4547
4692
            b = Branch.open_containing(branch)[0]
4548
4693
        else:
4549
4694
            b = Branch.open(branch)
4550
 
        b.lock_read()
4551
 
        self.add_cleanup(b.unlock)
 
4695
        self.add_cleanup(b.lock_read().unlock)
4552
4696
        if revision is None:
4553
4697
            rev_id = b.last_revision()
4554
4698
        else:
4578
4722
                     Option('long', help='Show commit date in annotations.'),
4579
4723
                     'revision',
4580
4724
                     'show-ids',
 
4725
                     'directory',
4581
4726
                     ]
4582
4727
    encoding_type = 'exact'
4583
4728
 
4584
4729
    @display_command
4585
4730
    def run(self, filename, all=False, long=False, revision=None,
4586
 
            show_ids=False):
4587
 
        from bzrlib.annotate import annotate_file, annotate_file_tree
 
4731
            show_ids=False, directory=None):
 
4732
        from bzrlib.annotate import (
 
4733
            annotate_file_tree,
 
4734
            )
4588
4735
        wt, branch, relpath = \
4589
 
            bzrdir.BzrDir.open_containing_tree_or_branch(filename)
 
4736
            _open_directory_or_containing_tree_or_branch(filename, directory)
4590
4737
        if wt is not None:
4591
 
            wt.lock_read()
4592
 
            self.add_cleanup(wt.unlock)
 
4738
            self.add_cleanup(wt.lock_read().unlock)
4593
4739
        else:
4594
 
            branch.lock_read()
4595
 
            self.add_cleanup(branch.unlock)
 
4740
            self.add_cleanup(branch.lock_read().unlock)
4596
4741
        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:
 
4742
        self.add_cleanup(tree.lock_read().unlock)
 
4743
        if wt is not None and revision is None:
4600
4744
            file_id = wt.path2id(relpath)
4601
4745
        else:
4602
4746
            file_id = tree.path2id(relpath)
4603
4747
        if file_id is None:
4604
4748
            raise errors.NotVersionedError(filename)
4605
 
        file_version = tree.inventory[file_id].revision
4606
4749
        if wt is not None and revision is None:
4607
4750
            # If there is a tree and we're not annotating historical
4608
4751
            # versions, annotate the working tree's content.
4609
4752
            annotate_file_tree(wt, file_id, self.outf, long, all,
4610
4753
                show_ids=show_ids)
4611
4754
        else:
4612
 
            annotate_file(branch, file_version, file_id, long, all, self.outf,
4613
 
                          show_ids=show_ids)
 
4755
            annotate_file_tree(tree, file_id, self.outf, long, all,
 
4756
                show_ids=show_ids, branch=branch)
4614
4757
 
4615
4758
 
4616
4759
class cmd_re_sign(Command):
4619
4762
 
4620
4763
    hidden = True # is this right ?
4621
4764
    takes_args = ['revision_id*']
4622
 
    takes_options = ['revision']
 
4765
    takes_options = ['directory', 'revision']
4623
4766
 
4624
 
    def run(self, revision_id_list=None, revision=None):
 
4767
    def run(self, revision_id_list=None, revision=None, directory=u'.'):
4625
4768
        if revision_id_list is not None and revision is not None:
4626
4769
            raise errors.BzrCommandError('You can only supply one of revision_id or --revision')
4627
4770
        if revision_id_list is None and revision is None:
4628
4771
            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)
 
4772
        b = WorkingTree.open_containing(directory)[0].branch
 
4773
        self.add_cleanup(b.lock_write().unlock)
4632
4774
        return self._run(b, revision_id_list, revision)
4633
4775
 
4634
4776
    def _run(self, b, revision_id_list, revision):
4693
4835
 
4694
4836
    _see_also = ['checkouts', 'unbind']
4695
4837
    takes_args = ['location?']
4696
 
    takes_options = []
 
4838
    takes_options = ['directory']
4697
4839
 
4698
 
    def run(self, location=None):
4699
 
        b, relpath = Branch.open_containing(u'.')
 
4840
    def run(self, location=None, directory=u'.'):
 
4841
        b, relpath = Branch.open_containing(directory)
4700
4842
        if location is None:
4701
4843
            try:
4702
4844
                location = b.get_old_bound_location()
4729
4871
 
4730
4872
    _see_also = ['checkouts', 'bind']
4731
4873
    takes_args = []
4732
 
    takes_options = []
 
4874
    takes_options = ['directory']
4733
4875
 
4734
 
    def run(self):
4735
 
        b, relpath = Branch.open_containing(u'.')
 
4876
    def run(self, directory=u'.'):
 
4877
        b, relpath = Branch.open_containing(directory)
4736
4878
        if not b.unbind():
4737
4879
            raise errors.BzrCommandError('Local branch is not bound')
4738
4880
 
4784
4926
            b = control.open_branch()
4785
4927
 
4786
4928
        if tree is not None:
4787
 
            tree.lock_write()
4788
 
            self.add_cleanup(tree.unlock)
 
4929
            self.add_cleanup(tree.lock_write().unlock)
4789
4930
        else:
4790
 
            b.lock_write()
4791
 
            self.add_cleanup(b.unlock)
 
4931
            self.add_cleanup(b.lock_write().unlock)
4792
4932
        return self._run(b, tree, dry_run, verbose, revision, force, local=local)
4793
4933
 
4794
4934
    def _run(self, b, tree, dry_run, verbose, revision, force, local=False):
4833
4973
            self.outf.write('The above revision(s) will be removed.\n')
4834
4974
 
4835
4975
        if not force:
4836
 
            if not ui.ui_factory.get_boolean('Are you sure'):
4837
 
                self.outf.write('Canceled')
 
4976
            if not ui.ui_factory.confirm_action(
 
4977
                    u'Uncommit these revisions',
 
4978
                    'bzrlib.builtins.uncommit',
 
4979
                    {}):
 
4980
                self.outf.write('Canceled\n')
4838
4981
                return 0
4839
4982
 
4840
4983
        mutter('Uncommitting from {%s} to {%s}',
4846
4989
 
4847
4990
 
4848
4991
class cmd_break_lock(Command):
4849
 
    __doc__ = """Break a dead lock on a repository, branch or working directory.
 
4992
    __doc__ = """Break a dead lock.
 
4993
 
 
4994
    This command breaks a lock on a repository, branch, working directory or
 
4995
    config file.
4850
4996
 
4851
4997
    CAUTION: Locks should only be broken when you are sure that the process
4852
4998
    holding the lock has been stopped.
4857
5003
    :Examples:
4858
5004
        bzr break-lock
4859
5005
        bzr break-lock bzr+ssh://example.com/bzr/foo
 
5006
        bzr break-lock --conf ~/.bazaar
4860
5007
    """
 
5008
 
4861
5009
    takes_args = ['location?']
 
5010
    takes_options = [
 
5011
        Option('config',
 
5012
               help='LOCATION is the directory where the config lock is.'),
 
5013
        Option('force',
 
5014
            help='Do not ask for confirmation before breaking the lock.'),
 
5015
        ]
4862
5016
 
4863
 
    def run(self, location=None, show=False):
 
5017
    def run(self, location=None, config=False, force=False):
4864
5018
        if location is None:
4865
5019
            location = u'.'
4866
 
        control, relpath = bzrdir.BzrDir.open_containing(location)
4867
 
        try:
4868
 
            control.break_lock()
4869
 
        except NotImplementedError:
4870
 
            pass
 
5020
        if force:
 
5021
            ui.ui_factory = ui.ConfirmationUserInterfacePolicy(ui.ui_factory,
 
5022
                None,
 
5023
                {'bzrlib.lockdir.break': True})
 
5024
        if config:
 
5025
            conf = _mod_config.LockableConfig(file_name=location)
 
5026
            conf.break_lock()
 
5027
        else:
 
5028
            control, relpath = bzrdir.BzrDir.open_containing(location)
 
5029
            try:
 
5030
                control.break_lock()
 
5031
            except NotImplementedError:
 
5032
                pass
4871
5033
 
4872
5034
 
4873
5035
class cmd_wait_until_signalled(Command):
4902
5064
                    'result in a dynamically allocated port.  The default port '
4903
5065
                    'depends on the protocol.',
4904
5066
               type=str),
4905
 
        Option('directory',
4906
 
               help='Serve contents of this directory.',
4907
 
               type=unicode),
 
5067
        custom_help('directory',
 
5068
               help='Serve contents of this directory.'),
4908
5069
        Option('allow-writes',
4909
5070
               help='By default the server is a readonly server.  Supplying '
4910
5071
                    '--allow-writes enables write access to the contents of '
4937
5098
 
4938
5099
    def run(self, port=None, inet=False, directory=None, allow_writes=False,
4939
5100
            protocol=None):
4940
 
        from bzrlib.transport import get_transport, transport_server_registry
 
5101
        from bzrlib import transport
4941
5102
        if directory is None:
4942
5103
            directory = os.getcwd()
4943
5104
        if protocol is None:
4944
 
            protocol = transport_server_registry.get()
 
5105
            protocol = transport.transport_server_registry.get()
4945
5106
        host, port = self.get_host_and_port(port)
4946
5107
        url = urlutils.local_path_to_url(directory)
4947
5108
        if not allow_writes:
4948
5109
            url = 'readonly+' + url
4949
 
        transport = get_transport(url)
4950
 
        protocol(transport, host, port, inet)
 
5110
        t = transport.get_transport(url)
 
5111
        protocol(t, host, port, inet)
4951
5112
 
4952
5113
 
4953
5114
class cmd_join(Command):
4959
5120
    not part of it.  (Such trees can be produced by "bzr split", but also by
4960
5121
    running "bzr branch" with the target inside a tree.)
4961
5122
 
4962
 
    The result is a combined tree, with the subtree no longer an independant
 
5123
    The result is a combined tree, with the subtree no longer an independent
4963
5124
    part.  This is marked as a merge of the subtree into the containing tree,
4964
5125
    and all history is preserved.
4965
5126
    """
5046
5207
    _see_also = ['send']
5047
5208
 
5048
5209
    takes_options = [
 
5210
        'directory',
5049
5211
        RegistryOption.from_kwargs('patch-type',
5050
5212
            'The type of patch to include in the directive.',
5051
5213
            title='Patch type',
5064
5226
    encoding_type = 'exact'
5065
5227
 
5066
5228
    def run(self, submit_branch=None, public_branch=None, patch_type='bundle',
5067
 
            sign=False, revision=None, mail_to=None, message=None):
 
5229
            sign=False, revision=None, mail_to=None, message=None,
 
5230
            directory=u'.'):
5068
5231
        from bzrlib.revision import ensure_null, NULL_REVISION
5069
5232
        include_patch, include_bundle = {
5070
5233
            'plain': (False, False),
5071
5234
            'diff': (True, False),
5072
5235
            'bundle': (True, True),
5073
5236
            }[patch_type]
5074
 
        branch = Branch.open('.')
 
5237
        branch = Branch.open(directory)
5075
5238
        stored_submit_branch = branch.get_submit_branch()
5076
5239
        if submit_branch is None:
5077
5240
            submit_branch = stored_submit_branch
5153
5316
    source branch defaults to that containing the working directory, but can
5154
5317
    be changed using --from.
5155
5318
 
 
5319
    Both the submit branch and the public branch follow the usual behavior with
 
5320
    respect to --remember: If there is no default location set, the first send
 
5321
    will set it (use --no-remember to avoid settting it). After that, you can
 
5322
    omit the location to use the default.  To change the default, use
 
5323
    --remember. The value will only be saved if the location can be accessed.
 
5324
 
5156
5325
    In order to calculate those changes, bzr must analyse the submit branch.
5157
5326
    Therefore it is most efficient for the submit branch to be a local mirror.
5158
5327
    If a public location is known for the submit_branch, that location is used
5162
5331
    given, in which case it is sent to a file.
5163
5332
 
5164
5333
    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.
 
5334
    on Windows (it uses MAPI).  On Unix, it requires the xdg-email utility.
5166
5335
    If the preferred client can't be found (or used), your editor will be used.
5167
5336
 
5168
5337
    To use a specific mail program, set the mail_client configuration option.
5227
5396
        ]
5228
5397
 
5229
5398
    def run(self, submit_branch=None, public_branch=None, no_bundle=False,
5230
 
            no_patch=False, revision=None, remember=False, output=None,
 
5399
            no_patch=False, revision=None, remember=None, output=None,
5231
5400
            format=None, mail_to=None, message=None, body=None,
5232
5401
            strict=None, **kwargs):
5233
5402
        from bzrlib.send import send
5339
5508
        Option('delete',
5340
5509
            help='Delete this tag rather than placing it.',
5341
5510
            ),
5342
 
        Option('directory',
5343
 
            help='Branch in which to place the tag.',
5344
 
            short_name='d',
5345
 
            type=unicode,
5346
 
            ),
 
5511
        custom_help('directory',
 
5512
            help='Branch in which to place the tag.'),
5347
5513
        Option('force',
5348
5514
            help='Replace existing tags.',
5349
5515
            ),
5357
5523
            revision=None,
5358
5524
            ):
5359
5525
        branch, relpath = Branch.open_containing(directory)
5360
 
        branch.lock_write()
5361
 
        self.add_cleanup(branch.unlock)
 
5526
        self.add_cleanup(branch.lock_write().unlock)
5362
5527
        if delete:
5363
5528
            if tag_name is None:
5364
5529
                raise errors.BzrCommandError("No tag specified to delete.")
5365
5530
            branch.tags.delete_tag(tag_name)
5366
 
            self.outf.write('Deleted tag %s.\n' % tag_name)
 
5531
            note('Deleted tag %s.' % tag_name)
5367
5532
        else:
5368
5533
            if revision:
5369
5534
                if len(revision) != 1:
5381
5546
            if (not force) and branch.tags.has_tag(tag_name):
5382
5547
                raise errors.TagAlreadyExists(tag_name)
5383
5548
            branch.tags.set_tag(tag_name, revision_id)
5384
 
            self.outf.write('Created tag %s.\n' % tag_name)
 
5549
            note('Created tag %s.' % tag_name)
5385
5550
 
5386
5551
 
5387
5552
class cmd_tags(Command):
5392
5557
 
5393
5558
    _see_also = ['tag']
5394
5559
    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',
 
5560
        custom_help('directory',
 
5561
            help='Branch whose tags should be displayed.'),
 
5562
        RegistryOption('sort',
5401
5563
            'Sort tags by different criteria.', title='Sorting',
5402
 
            alpha='Sort tags lexicographically (default).',
5403
 
            time='Sort tags chronologically.',
 
5564
            lazy_registry=('bzrlib.tag', 'tag_sort_methods')
5404
5565
            ),
5405
5566
        'show-ids',
5406
5567
        'revision',
5407
5568
    ]
5408
5569
 
5409
5570
    @display_command
5410
 
    def run(self,
5411
 
            directory='.',
5412
 
            sort='alpha',
5413
 
            show_ids=False,
5414
 
            revision=None,
5415
 
            ):
 
5571
    def run(self, directory='.', sort=None, show_ids=False, revision=None):
 
5572
        from bzrlib.tag import tag_sort_methods
5416
5573
        branch, relpath = Branch.open_containing(directory)
5417
5574
 
5418
5575
        tags = branch.tags.get_tag_dict().items()
5419
5576
        if not tags:
5420
5577
            return
5421
5578
 
5422
 
        branch.lock_read()
5423
 
        self.add_cleanup(branch.unlock)
 
5579
        self.add_cleanup(branch.lock_read().unlock)
5424
5580
        if revision:
5425
5581
            graph = branch.repository.get_graph()
5426
5582
            rev1, rev2 = _get_revision_range(revision, branch, self.name())
5428
5584
            # only show revisions between revid1 and revid2 (inclusive)
5429
5585
            tags = [(tag, revid) for tag, revid in tags if
5430
5586
                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]])
 
5587
        if sort is None:
 
5588
            sort = tag_sort_methods.get()
 
5589
        sort(branch, tags)
5444
5590
        if not show_ids:
5445
5591
            # [ (tag, revid), ... ] -> [ (tag, dotted_revno), ... ]
5446
5592
            for index, (tag, revid) in enumerate(tags):
5448
5594
                    revno = branch.revision_id_to_dotted_revno(revid)
5449
5595
                    if isinstance(revno, tuple):
5450
5596
                        revno = '.'.join(map(str, revno))
5451
 
                except errors.NoSuchRevision:
 
5597
                except (errors.NoSuchRevision, errors.GhostRevisionsHaveNoRevno):
5452
5598
                    # Bad tag data/merges can lead to tagged revisions
5453
5599
                    # which are not in this branch. Fail gracefully ...
5454
5600
                    revno = '?'
5512
5658
            unstacked=None):
5513
5659
        directory = bzrdir.BzrDir.open(location)
5514
5660
        if stacked_on and unstacked:
5515
 
            raise BzrCommandError("Can't use both --stacked-on and --unstacked")
 
5661
            raise errors.BzrCommandError("Can't use both --stacked-on and --unstacked")
5516
5662
        elif stacked_on is not None:
5517
5663
            reconfigure.ReconfigureStackedOn().apply(directory, stacked_on)
5518
5664
        elif unstacked:
5573
5719
    """
5574
5720
 
5575
5721
    takes_args = ['to_location?']
5576
 
    takes_options = [Option('force',
 
5722
    takes_options = ['directory',
 
5723
                     Option('force',
5577
5724
                        help='Switch even if local commits will be lost.'),
5578
5725
                     'revision',
5579
5726
                     Option('create-branch', short_name='b',
5582
5729
                    ]
5583
5730
 
5584
5731
    def run(self, to_location=None, force=False, create_branch=False,
5585
 
            revision=None):
 
5732
            revision=None, directory=u'.'):
5586
5733
        from bzrlib import switch
5587
 
        tree_location = '.'
 
5734
        tree_location = directory
5588
5735
        revision = _get_one_revision('switch', revision)
5589
5736
        control_dir = bzrdir.BzrDir.open_containing(tree_location)[0]
5590
5737
        if to_location is None:
5591
5738
            if revision is None:
5592
5739
                raise errors.BzrCommandError('You must supply either a'
5593
5740
                                             ' revision or a location')
5594
 
            to_location = '.'
 
5741
            to_location = tree_location
5595
5742
        try:
5596
5743
            branch = control_dir.open_branch()
5597
5744
            had_explicit_nick = branch.get_config().has_explicit_nickname()
5732
5879
            name=None,
5733
5880
            switch=None,
5734
5881
            ):
5735
 
        tree, file_list = tree_files(file_list, apply_view=False)
 
5882
        tree, file_list = WorkingTree.open_containing_paths(file_list,
 
5883
            apply_view=False)
5736
5884
        current_view, view_dict = tree.views.get_view_info()
5737
5885
        if name is None:
5738
5886
            name = current_view
5842
5990
            location = "."
5843
5991
        branch = Branch.open_containing(location)[0]
5844
5992
        branch.bzrdir.destroy_branch()
5845
 
        
 
5993
 
5846
5994
 
5847
5995
class cmd_shelve(Command):
5848
5996
    __doc__ = """Temporarily set aside some changes from the current tree.
5867
6015
 
5868
6016
    You can put multiple items on the shelf, and by default, 'unshelve' will
5869
6017
    restore the most recently shelved changes.
 
6018
 
 
6019
    For complicated changes, it is possible to edit the changes in a separate
 
6020
    editor program to decide what the file remaining in the working copy
 
6021
    should look like.  To do this, add the configuration option
 
6022
 
 
6023
        change_editor = PROGRAM @new_path @old_path
 
6024
 
 
6025
    where @new_path is replaced with the path of the new version of the 
 
6026
    file and @old_path is replaced with the path of the old version of 
 
6027
    the file.  The PROGRAM should save the new file with the desired 
 
6028
    contents of the file in the working tree.
 
6029
        
5870
6030
    """
5871
6031
 
5872
6032
    takes_args = ['file*']
5873
6033
 
5874
6034
    takes_options = [
 
6035
        'directory',
5875
6036
        'revision',
5876
6037
        Option('all', help='Shelve all changes.'),
5877
6038
        'message',
5883
6044
        Option('destroy',
5884
6045
               help='Destroy removed changes instead of shelving them.'),
5885
6046
    ]
5886
 
    _see_also = ['unshelve']
 
6047
    _see_also = ['unshelve', 'configuration']
5887
6048
 
5888
6049
    def run(self, revision=None, all=False, file_list=None, message=None,
5889
 
            writer=None, list=False, destroy=False):
 
6050
            writer=None, list=False, destroy=False, directory=None):
5890
6051
        if list:
5891
 
            return self.run_for_list()
 
6052
            return self.run_for_list(directory=directory)
5892
6053
        from bzrlib.shelf_ui import Shelver
5893
6054
        if writer is None:
5894
6055
            writer = bzrlib.option.diff_writer_registry.get()
5895
6056
        try:
5896
6057
            shelver = Shelver.from_args(writer(sys.stdout), revision, all,
5897
 
                file_list, message, destroy=destroy)
 
6058
                file_list, message, destroy=destroy, directory=directory)
5898
6059
            try:
5899
6060
                shelver.run()
5900
6061
            finally:
5902
6063
        except errors.UserAbort:
5903
6064
            return 0
5904
6065
 
5905
 
    def run_for_list(self):
5906
 
        tree = WorkingTree.open_containing('.')[0]
5907
 
        tree.lock_read()
5908
 
        self.add_cleanup(tree.unlock)
 
6066
    def run_for_list(self, directory=None):
 
6067
        if directory is None:
 
6068
            directory = u'.'
 
6069
        tree = WorkingTree.open_containing(directory)[0]
 
6070
        self.add_cleanup(tree.lock_read().unlock)
5909
6071
        manager = tree.get_shelf_manager()
5910
6072
        shelves = manager.active_shelves()
5911
6073
        if len(shelves) == 0:
5929
6091
 
5930
6092
    takes_args = ['shelf_id?']
5931
6093
    takes_options = [
 
6094
        'directory',
5932
6095
        RegistryOption.from_kwargs(
5933
6096
            'action', help="The action to perform.",
5934
6097
            enum_switch=False, value_switches=True,
5942
6105
    ]
5943
6106
    _see_also = ['shelve']
5944
6107
 
5945
 
    def run(self, shelf_id=None, action='apply'):
 
6108
    def run(self, shelf_id=None, action='apply', directory=u'.'):
5946
6109
        from bzrlib.shelf_ui import Unshelver
5947
 
        unshelver = Unshelver.from_args(shelf_id, action)
 
6110
        unshelver = Unshelver.from_args(shelf_id, action, directory=directory)
5948
6111
        try:
5949
6112
            unshelver.run()
5950
6113
        finally:
5966
6129
 
5967
6130
    To check what clean-tree will do, use --dry-run.
5968
6131
    """
5969
 
    takes_options = [Option('ignored', help='Delete all ignored files.'),
5970
 
                     Option('detritus', help='Delete conflict files, merge'
 
6132
    takes_options = ['directory',
 
6133
                     Option('ignored', help='Delete all ignored files.'),
 
6134
                     Option('detritus', help='Delete conflict files, merge and revert'
5971
6135
                            ' backups, and failed selftest dirs.'),
5972
6136
                     Option('unknown',
5973
6137
                            help='Delete files unknown to bzr (default).'),
5975
6139
                            ' deleting them.'),
5976
6140
                     Option('force', help='Do not prompt before deleting.')]
5977
6141
    def run(self, unknown=False, ignored=False, detritus=False, dry_run=False,
5978
 
            force=False):
 
6142
            force=False, directory=u'.'):
5979
6143
        from bzrlib.clean_tree import clean_tree
5980
6144
        if not (unknown or ignored or detritus):
5981
6145
            unknown = True
5982
6146
        if dry_run:
5983
6147
            force = True
5984
 
        clean_tree('.', unknown=unknown, ignored=ignored, detritus=detritus,
5985
 
                   dry_run=dry_run, no_prompt=force)
 
6148
        clean_tree(directory, unknown=unknown, ignored=ignored,
 
6149
                   detritus=detritus, dry_run=dry_run, no_prompt=force)
5986
6150
 
5987
6151
 
5988
6152
class cmd_reference(Command):
6032
6196
            self.outf.write('%s %s\n' % (path, location))
6033
6197
 
6034
6198
 
 
6199
class cmd_export_pot(Command):
 
6200
    __doc__ = """Export command helps and error messages in po format."""
 
6201
 
 
6202
    hidden = True
 
6203
 
 
6204
    def run(self):
 
6205
        from bzrlib.export_pot import export_pot
 
6206
        export_pot(self.outf)
 
6207
 
 
6208
 
6035
6209
def _register_lazy_builtins():
6036
6210
    # register lazy builtins from other modules; called at startup and should
6037
6211
    # be only called once.
6038
6212
    for (name, aliases, module_name) in [
6039
6213
        ('cmd_bundle_info', [], 'bzrlib.bundle.commands'),
 
6214
        ('cmd_config', [], 'bzrlib.config'),
6040
6215
        ('cmd_dpush', [], 'bzrlib.foreign'),
6041
6216
        ('cmd_version_info', [], 'bzrlib.cmd_version_info'),
6042
6217
        ('cmd_resolve', ['resolved'], 'bzrlib.conflicts'),
6043
6218
        ('cmd_conflicts', [], 'bzrlib.conflicts'),
6044
6219
        ('cmd_sign_my_commits', [], 'bzrlib.sign_my_commits'),
 
6220
        ('cmd_test_script', [], 'bzrlib.cmd_test_script'),
6045
6221
        ]:
6046
6222
        builtin_command_registry.register_lazy(name, aliases, module_name)