~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/builtins.py

  • Committer: Jelmer Vernooij
  • Date: 2011-06-16 11:58:04 UTC
  • mto: This revision was merged to the branch mainline in revision 5987.
  • Revision ID: jelmer@samba.org-20110616115804-7tnqon61emrbdoxm
Remove unused Tree._get_ancestors.

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
 
552
581
    takes_args = ['revision_info*']
553
582
    takes_options = [
554
583
        'revision',
555
 
        Option('directory',
 
584
        custom_help('directory',
556
585
            help='Branch to examine, '
557
 
                 'rather than the one containing the working directory.',
558
 
            short_name='d',
559
 
            type=unicode,
560
 
            ),
 
586
                 'rather than the one containing the working directory.'),
561
587
        Option('tree', help='Show revno of working tree'),
562
588
        ]
563
589
 
754
780
            raise errors.BzrCommandError('invalid kind %r specified' % (kind,))
755
781
 
756
782
        revision = _get_one_revision('inventory', revision)
757
 
        work_tree, file_list = tree_files(file_list)
 
783
        work_tree, file_list = WorkingTree.open_containing_paths(file_list)
758
784
        self.add_cleanup(work_tree.lock_read().unlock)
759
785
        if revision is not None:
760
786
            tree = revision.as_tree(work_tree.branch)
825
851
            names_list = []
826
852
        if len(names_list) < 2:
827
853
            raise errors.BzrCommandError("missing file argument")
828
 
        tree, rel_names = tree_files(names_list, canonicalize=False)
 
854
        tree, rel_names = WorkingTree.open_containing_paths(names_list, canonicalize=False)
829
855
        self.add_cleanup(tree.lock_tree_write().unlock)
830
856
        self._run(tree, names_list, rel_names, after)
831
857
 
836
862
        if after:
837
863
            raise errors.BzrCommandError('--after cannot be specified with'
838
864
                                         ' --auto.')
839
 
        work_tree, file_list = tree_files(names_list, default_branch='.')
 
865
        work_tree, file_list = WorkingTree.open_containing_paths(
 
866
            names_list, default_directory='.')
840
867
        self.add_cleanup(work_tree.lock_tree_write().unlock)
841
868
        rename_map.RenameMap.guess_renames(work_tree, dry_run)
842
869
 
937
964
    match the remote one, use pull --overwrite. This will work even if the two
938
965
    branches have diverged.
939
966
 
940
 
    If there is no default location set, the first pull will set it.  After
941
 
    that, you can omit the location to use the default.  To change the
942
 
    default, use --remember. The value will only be saved if the remote
943
 
    location can be accessed.
 
967
    If there is no default location set, the first pull will set it (use
 
968
    --no-remember to avoid settting it). After that, you can omit the
 
969
    location to use the default.  To change the default, use --remember. The
 
970
    value will only be saved if the remote location can be accessed.
944
971
 
945
972
    Note: The location can be specified either in the form of a branch,
946
973
    or in the form of a path to a file containing a merge directive generated
951
978
    takes_options = ['remember', 'overwrite', 'revision',
952
979
        custom_help('verbose',
953
980
            help='Show logs of pulled revisions.'),
954
 
        Option('directory',
 
981
        custom_help('directory',
955
982
            help='Branch to pull into, '
956
 
                 'rather than the one containing the working directory.',
957
 
            short_name='d',
958
 
            type=unicode,
959
 
            ),
 
983
                 'rather than the one containing the working directory.'),
960
984
        Option('local',
961
985
            help="Perform a local pull in a bound "
962
986
                 "branch.  Local pulls are not applied to "
963
987
                 "the master branch."
964
988
            ),
 
989
        Option('show-base',
 
990
            help="Show base revision text in conflicts.")
965
991
        ]
966
992
    takes_args = ['location?']
967
993
    encoding_type = 'replace'
968
994
 
969
 
    def run(self, location=None, remember=False, overwrite=False,
 
995
    def run(self, location=None, remember=None, overwrite=False,
970
996
            revision=None, verbose=False,
971
 
            directory=None, local=False):
 
997
            directory=None, local=False,
 
998
            show_base=False):
972
999
        # FIXME: too much stuff is in the command class
973
1000
        revision_id = None
974
1001
        mergeable = None
983
1010
            branch_to = Branch.open_containing(directory)[0]
984
1011
            self.add_cleanup(branch_to.lock_write().unlock)
985
1012
 
 
1013
        if tree_to is None and show_base:
 
1014
            raise errors.BzrCommandError("Need working tree for --show-base.")
 
1015
 
986
1016
        if local and not branch_to.get_bound_location():
987
1017
            raise errors.LocalRequiresBoundBranch()
988
1018
 
1019
1049
            branch_from = Branch.open(location,
1020
1050
                possible_transports=possible_transports)
1021
1051
            self.add_cleanup(branch_from.lock_read().unlock)
1022
 
 
1023
 
            if branch_to.get_parent() is None or remember:
 
1052
            # Remembers if asked explicitly or no previous location is set
 
1053
            if (remember
 
1054
                or (remember is None and branch_to.get_parent() is None)):
1024
1055
                branch_to.set_parent(branch_from.base)
1025
1056
 
1026
1057
        if revision is not None:
1033
1064
                view_info=view_info)
1034
1065
            result = tree_to.pull(
1035
1066
                branch_from, overwrite, revision_id, change_reporter,
1036
 
                possible_transports=possible_transports, local=local)
 
1067
                possible_transports=possible_transports, local=local,
 
1068
                show_base=show_base)
1037
1069
        else:
1038
1070
            result = branch_to.pull(
1039
1071
                branch_from, overwrite, revision_id, local=local)
1043
1075
            log.show_branch_change(
1044
1076
                branch_to, self.outf, result.old_revno,
1045
1077
                result.old_revid)
 
1078
        if getattr(result, 'tag_conflicts', None):
 
1079
            return 1
 
1080
        else:
 
1081
            return 0
1046
1082
 
1047
1083
 
1048
1084
class cmd_push(Command):
1065
1101
    do a merge (see bzr help merge) from the other branch, and commit that.
1066
1102
    After that you will be able to do a push without '--overwrite'.
1067
1103
 
1068
 
    If there is no default push location set, the first push will set it.
1069
 
    After that, you can omit the location to use the default.  To change the
1070
 
    default, use --remember. The value will only be saved if the remote
1071
 
    location can be accessed.
 
1104
    If there is no default push location set, the first push will set it (use
 
1105
    --no-remember to avoid settting it).  After that, you can omit the
 
1106
    location to use the default.  To change the default, use --remember. The
 
1107
    value will only be saved if the remote location can be accessed.
1072
1108
    """
1073
1109
 
1074
1110
    _see_also = ['pull', 'update', 'working-trees']
1076
1112
        Option('create-prefix',
1077
1113
               help='Create the path leading up to the branch '
1078
1114
                    'if it does not already exist.'),
1079
 
        Option('directory',
 
1115
        custom_help('directory',
1080
1116
            help='Branch to push from, '
1081
 
                 'rather than the one containing the working directory.',
1082
 
            short_name='d',
1083
 
            type=unicode,
1084
 
            ),
 
1117
                 'rather than the one containing the working directory.'),
1085
1118
        Option('use-existing-dir',
1086
1119
               help='By default push will fail if the target'
1087
1120
                    ' directory exists, but does not already'
1098
1131
        Option('strict',
1099
1132
               help='Refuse to push if there are uncommitted changes in'
1100
1133
               ' the working tree, --no-strict disables the check.'),
 
1134
        Option('no-tree',
 
1135
               help="Don't populate the working tree, even for protocols"
 
1136
               " that support it."),
1101
1137
        ]
1102
1138
    takes_args = ['location?']
1103
1139
    encoding_type = 'replace'
1104
1140
 
1105
 
    def run(self, location=None, remember=False, overwrite=False,
 
1141
    def run(self, location=None, remember=None, overwrite=False,
1106
1142
        create_prefix=False, verbose=False, revision=None,
1107
1143
        use_existing_dir=False, directory=None, stacked_on=None,
1108
 
        stacked=False, strict=None):
 
1144
        stacked=False, strict=None, no_tree=False):
1109
1145
        from bzrlib.push import _show_push_branch
1110
1146
 
1111
1147
        if directory is None:
1157
1193
        _show_push_branch(br_from, revision_id, location, self.outf,
1158
1194
            verbose=verbose, overwrite=overwrite, remember=remember,
1159
1195
            stacked_on=stacked_on, create_prefix=create_prefix,
1160
 
            use_existing_dir=use_existing_dir)
 
1196
            use_existing_dir=use_existing_dir, no_tree=no_tree)
1161
1197
 
1162
1198
 
1163
1199
class cmd_branch(Command):
1172
1208
 
1173
1209
    To retrieve the branch as of a particular revision, supply the --revision
1174
1210
    parameter, as in "branch foo/bar -r 5".
 
1211
 
 
1212
    The synonyms 'clone' and 'get' for this command are deprecated.
1175
1213
    """
1176
1214
 
1177
1215
    _see_also = ['checkout']
1178
1216
    takes_args = ['from_location', 'to_location?']
1179
 
    takes_options = ['revision', Option('hardlink',
1180
 
        help='Hard-link working tree files where possible.'),
 
1217
    takes_options = ['revision',
 
1218
        Option('hardlink', help='Hard-link working tree files where possible.'),
 
1219
        Option('files-from', type=str,
 
1220
               help="Get file contents from this tree."),
1181
1221
        Option('no-tree',
1182
1222
            help="Create a branch without a working-tree."),
1183
1223
        Option('switch',
1201
1241
 
1202
1242
    def run(self, from_location, to_location=None, revision=None,
1203
1243
            hardlink=False, stacked=False, standalone=False, no_tree=False,
1204
 
            use_existing_dir=False, switch=False, bind=False):
 
1244
            use_existing_dir=False, switch=False, bind=False,
 
1245
            files_from=None):
1205
1246
        from bzrlib import switch as _mod_switch
1206
1247
        from bzrlib.tag import _merge_tags_if_possible
 
1248
        if self.invoked_as in ['get', 'clone']:
 
1249
            ui.ui_factory.show_user_warning(
 
1250
                'deprecated_command',
 
1251
                deprecated_name=self.invoked_as,
 
1252
                recommended_name='branch',
 
1253
                deprecated_in_version='2.4')
1207
1254
        accelerator_tree, br_from = bzrdir.BzrDir.open_tree_or_branch(
1208
1255
            from_location)
 
1256
        if not (hardlink or files_from):
 
1257
            # accelerator_tree is usually slower because you have to read N
 
1258
            # files (no readahead, lots of seeks, etc), but allow the user to
 
1259
            # explicitly request it
 
1260
            accelerator_tree = None
 
1261
        if files_from is not None and files_from != from_location:
 
1262
            accelerator_tree = WorkingTree.open(files_from)
1209
1263
        revision = _get_one_revision('branch', revision)
1210
1264
        self.add_cleanup(br_from.lock_read().unlock)
1211
1265
        if revision is not None:
1318
1372
            to_location = branch_location
1319
1373
        accelerator_tree, source = bzrdir.BzrDir.open_tree_or_branch(
1320
1374
            branch_location)
 
1375
        if not (hardlink or files_from):
 
1376
            # accelerator_tree is usually slower because you have to read N
 
1377
            # files (no readahead, lots of seeks, etc), but allow the user to
 
1378
            # explicitly request it
 
1379
            accelerator_tree = None
1321
1380
        revision = _get_one_revision('checkout', revision)
1322
 
        if files_from is not None:
 
1381
        if files_from is not None and files_from != branch_location:
1323
1382
            accelerator_tree = WorkingTree.open(files_from)
1324
1383
        if revision is not None:
1325
1384
            revision_id = revision.as_revision_id(source)
1381
1440
    If you want to discard your local changes, you can just do a
1382
1441
    'bzr revert' instead of 'bzr commit' after the update.
1383
1442
 
 
1443
    If you want to restore a file that has been removed locally, use
 
1444
    'bzr revert' instead of 'bzr update'.
 
1445
 
1384
1446
    If the tree's branch is bound to a master branch, it will also update
1385
1447
    the branch from the master.
1386
1448
    """
1387
1449
 
1388
1450
    _see_also = ['pull', 'working-trees', 'status-flags']
1389
1451
    takes_args = ['dir?']
1390
 
    takes_options = ['revision']
 
1452
    takes_options = ['revision',
 
1453
                     Option('show-base',
 
1454
                            help="Show base revision text in conflicts."),
 
1455
                     ]
1391
1456
    aliases = ['up']
1392
1457
 
1393
 
    def run(self, dir='.', revision=None):
 
1458
    def run(self, dir='.', revision=None, show_base=None):
1394
1459
        if revision is not None and len(revision) != 1:
1395
1460
            raise errors.BzrCommandError(
1396
1461
                        "bzr update --revision takes exactly one revision")
1436
1501
                change_reporter,
1437
1502
                possible_transports=possible_transports,
1438
1503
                revision=revision_id,
1439
 
                old_tip=old_tip)
 
1504
                old_tip=old_tip,
 
1505
                show_base=show_base)
1440
1506
        except errors.NoSuchRevision, e:
1441
1507
            raise errors.BzrCommandError(
1442
1508
                                  "branch has no revision %s\n"
1504
1570
class cmd_remove(Command):
1505
1571
    __doc__ = """Remove files or directories.
1506
1572
 
1507
 
    This makes bzr stop tracking changes to the specified files. bzr will delete
1508
 
    them if they can easily be recovered using revert. If no options or
1509
 
    parameters are given bzr will scan for files that are being tracked by bzr
1510
 
    but missing in your tree and stop tracking them for you.
 
1573
    This makes Bazaar stop tracking changes to the specified files. Bazaar will
 
1574
    delete them if they can easily be recovered using revert otherwise they
 
1575
    will be backed up (adding an extention of the form .~#~). If no options or
 
1576
    parameters are given Bazaar will scan for files that are being tracked by
 
1577
    Bazaar but missing in your tree and stop tracking them for you.
1511
1578
    """
1512
1579
    takes_args = ['file*']
1513
1580
    takes_options = ['verbose',
1515
1582
        RegistryOption.from_kwargs('file-deletion-strategy',
1516
1583
            'The file deletion mode to be used.',
1517
1584
            title='Deletion Strategy', value_switches=True, enum_switch=False,
1518
 
            safe='Only delete files if they can be'
1519
 
                 ' safely recovered (default).',
 
1585
            safe='Backup changed files (default).',
1520
1586
            keep='Delete from bzr but leave the working copy.',
 
1587
            no_backup='Don\'t backup changed files.',
1521
1588
            force='Delete all the specified files, even if they can not be '
1522
 
                'recovered and even if they are non-empty directories.')]
 
1589
                'recovered and even if they are non-empty directories. '
 
1590
                '(deprecated, use no-backup)')]
1523
1591
    aliases = ['rm', 'del']
1524
1592
    encoding_type = 'replace'
1525
1593
 
1526
1594
    def run(self, file_list, verbose=False, new=False,
1527
1595
        file_deletion_strategy='safe'):
1528
 
        tree, file_list = tree_files(file_list)
 
1596
        if file_deletion_strategy == 'force':
 
1597
            note("(The --force option is deprecated, rather use --no-backup "
 
1598
                "in future.)")
 
1599
            file_deletion_strategy = 'no-backup'
 
1600
 
 
1601
        tree, file_list = WorkingTree.open_containing_paths(file_list)
1529
1602
 
1530
1603
        if file_list is not None:
1531
1604
            file_list = [f for f in file_list]
1551
1624
            file_deletion_strategy = 'keep'
1552
1625
        tree.remove(file_list, verbose=verbose, to_file=self.outf,
1553
1626
            keep_files=file_deletion_strategy=='keep',
1554
 
            force=file_deletion_strategy=='force')
 
1627
            force=(file_deletion_strategy=='no-backup'))
1555
1628
 
1556
1629
 
1557
1630
class cmd_file_id(Command):
1619
1692
 
1620
1693
    _see_also = ['check']
1621
1694
    takes_args = ['branch?']
 
1695
    takes_options = [
 
1696
        Option('canonicalize-chks',
 
1697
               help='Make sure CHKs are in canonical form (repairs '
 
1698
                    'bug 522637).',
 
1699
               hidden=True),
 
1700
        ]
1622
1701
 
1623
 
    def run(self, branch="."):
 
1702
    def run(self, branch=".", canonicalize_chks=False):
1624
1703
        from bzrlib.reconcile import reconcile
1625
1704
        dir = bzrdir.BzrDir.open(branch)
1626
 
        reconcile(dir)
 
1705
        reconcile(dir, canonicalize_chks=canonicalize_chks)
1627
1706
 
1628
1707
 
1629
1708
class cmd_revision_history(Command):
1661
1740
            b = wt.branch
1662
1741
            last_revision = wt.last_revision()
1663
1742
 
1664
 
        revision_ids = b.repository.get_ancestry(last_revision)
1665
 
        revision_ids.pop(0)
1666
 
        for revision_id in revision_ids:
 
1743
        self.add_cleanup(b.repository.lock_read().unlock)
 
1744
        graph = b.repository.get_graph()
 
1745
        for revision_id, parents in graph.iter_ancestry([last_revision]):
 
1746
            if _mod_revision.is_null(revision_id):
 
1747
                continue
1667
1748
            self.outf.write(revision_id + '\n')
1668
1749
 
1669
1750
 
1706
1787
                ),
1707
1788
         Option('append-revisions-only',
1708
1789
                help='Never change revnos or the existing log.'
1709
 
                '  Append revisions to it only.')
 
1790
                '  Append revisions to it only.'),
 
1791
         Option('no-tree',
 
1792
                'Create a branch without a working tree.')
1710
1793
         ]
1711
1794
    def run(self, location=None, format=None, append_revisions_only=False,
1712
 
            create_prefix=False):
 
1795
            create_prefix=False, no_tree=False):
1713
1796
        if format is None:
1714
1797
            format = bzrdir.format_registry.make_bzrdir('default')
1715
1798
        if location is None:
1738
1821
        except errors.NotBranchError:
1739
1822
            # really a NotBzrDir error...
1740
1823
            create_branch = bzrdir.BzrDir.create_branch_convenience
 
1824
            if no_tree:
 
1825
                force_new_tree = False
 
1826
            else:
 
1827
                force_new_tree = None
1741
1828
            branch = create_branch(to_transport.base, format=format,
1742
 
                                   possible_transports=[to_transport])
 
1829
                                   possible_transports=[to_transport],
 
1830
                                   force_new_tree=force_new_tree)
1743
1831
            a_bzrdir = branch.bzrdir
1744
1832
        else:
1745
1833
            from bzrlib.transport.local import LocalTransport
1749
1837
                        raise errors.BranchExistsWithoutWorkingTree(location)
1750
1838
                raise errors.AlreadyBranchError(location)
1751
1839
            branch = a_bzrdir.create_branch()
1752
 
            a_bzrdir.create_workingtree()
 
1840
            if not no_tree:
 
1841
                a_bzrdir.create_workingtree()
1753
1842
        if append_revisions_only:
1754
1843
            try:
1755
1844
                branch.set_append_revisions_only(True)
1849
1938
    "bzr diff -p1" is equivalent to "bzr diff --prefix old/:new/", and
1850
1939
    produces patches suitable for "patch -p1".
1851
1940
 
 
1941
    Note that when using the -r argument with a range of revisions, the
 
1942
    differences are computed between the two specified revisions.  That
 
1943
    is, the command does not show the changes introduced by the first 
 
1944
    revision in the range.  This differs from the interpretation of 
 
1945
    revision ranges used by "bzr log" which includes the first revision
 
1946
    in the range.
 
1947
 
1852
1948
    :Exit values:
1853
1949
        1 - changed
1854
1950
        2 - unrepresentable changes
1872
1968
 
1873
1969
            bzr diff -r1..3 xxx
1874
1970
 
1875
 
        To see the changes introduced in revision X::
 
1971
        The changes introduced by revision 2 (equivalent to -r1..2)::
 
1972
 
 
1973
            bzr diff -c2
 
1974
 
 
1975
        To see the changes introduced by revision X::
1876
1976
        
1877
1977
            bzr diff -cX
1878
1978
 
1882
1982
 
1883
1983
            bzr diff -r<chosen_parent>..X
1884
1984
 
1885
 
        The changes introduced by revision 2 (equivalent to -r1..2)::
 
1985
        The changes between the current revision and the previous revision
 
1986
        (equivalent to -c-1 and -r-2..-1)
1886
1987
 
1887
 
            bzr diff -c2
 
1988
            bzr diff -r-2..
1888
1989
 
1889
1990
        Show just the differences for file NEWS::
1890
1991
 
1905
2006
        Same as 'bzr diff' but prefix paths with old/ and new/::
1906
2007
 
1907
2008
            bzr diff --prefix old/:new/
 
2009
            
 
2010
        Show the differences using a custom diff program with options::
 
2011
        
 
2012
            bzr diff --using /usr/bin/diff --diff-options -wu
1908
2013
    """
1909
2014
    _see_also = ['status']
1910
2015
    takes_args = ['file*']
1930
2035
            type=unicode,
1931
2036
            ),
1932
2037
        RegistryOption('format',
 
2038
            short_name='F',
1933
2039
            help='Diff format to use.',
1934
2040
            lazy_registry=('bzrlib.diff', 'format_registry'),
1935
 
            value_switches=False, title='Diff format'),
 
2041
            title='Diff format'),
1936
2042
        ]
1937
2043
    aliases = ['di', 'dif']
1938
2044
    encoding_type = 'exact'
1969
2075
         old_branch, new_branch,
1970
2076
         specific_files, extra_trees) = get_trees_and_branches_to_diff_locked(
1971
2077
            file_list, revision, old, new, self.add_cleanup, apply_view=True)
 
2078
        # GNU diff on Windows uses ANSI encoding for filenames
 
2079
        path_encoding = osutils.get_diff_header_encoding()
1972
2080
        return show_diff_trees(old_tree, new_tree, sys.stdout,
1973
2081
                               specific_files=specific_files,
1974
2082
                               external_diff_options=diff_options,
1975
2083
                               old_label=old_label, new_label=new_label,
1976
 
                               extra_trees=extra_trees, using=using,
 
2084
                               extra_trees=extra_trees,
 
2085
                               path_encoding=path_encoding,
 
2086
                               using=using,
1977
2087
                               format_cls=format)
1978
2088
 
1979
2089
 
1987
2097
    # level of effort but possibly much less IO.  (Or possibly not,
1988
2098
    # if the directories are very large...)
1989
2099
    _see_also = ['status', 'ls']
1990
 
    takes_options = ['show-ids']
 
2100
    takes_options = ['directory', 'show-ids']
1991
2101
 
1992
2102
    @display_command
1993
 
    def run(self, show_ids=False):
1994
 
        tree = WorkingTree.open_containing(u'.')[0]
 
2103
    def run(self, show_ids=False, directory=u'.'):
 
2104
        tree = WorkingTree.open_containing(directory)[0]
1995
2105
        self.add_cleanup(tree.lock_read().unlock)
1996
2106
        old = tree.basis_tree()
1997
2107
        self.add_cleanup(old.lock_read().unlock)
2010
2120
 
2011
2121
    hidden = True
2012
2122
    _see_also = ['status', 'ls']
2013
 
    takes_options = [
2014
 
            Option('null',
2015
 
                   help='Write an ascii NUL (\\0) separator '
2016
 
                   'between files rather than a newline.')
2017
 
            ]
 
2123
    takes_options = ['directory', 'null']
2018
2124
 
2019
2125
    @display_command
2020
 
    def run(self, null=False):
2021
 
        tree = WorkingTree.open_containing(u'.')[0]
 
2126
    def run(self, null=False, directory=u'.'):
 
2127
        tree = WorkingTree.open_containing(directory)[0]
 
2128
        self.add_cleanup(tree.lock_read().unlock)
2022
2129
        td = tree.changes_from(tree.basis_tree())
 
2130
        self.cleanup_now()
2023
2131
        for path, id, kind, text_modified, meta_modified in td.modified:
2024
2132
            if null:
2025
2133
                self.outf.write(path + '\0')
2033
2141
 
2034
2142
    hidden = True
2035
2143
    _see_also = ['status', 'ls']
2036
 
    takes_options = [
2037
 
            Option('null',
2038
 
                   help='Write an ascii NUL (\\0) separator '
2039
 
                   'between files rather than a newline.')
2040
 
            ]
 
2144
    takes_options = ['directory', 'null']
2041
2145
 
2042
2146
    @display_command
2043
 
    def run(self, null=False):
2044
 
        wt = WorkingTree.open_containing(u'.')[0]
 
2147
    def run(self, null=False, directory=u'.'):
 
2148
        wt = WorkingTree.open_containing(directory)[0]
2045
2149
        self.add_cleanup(wt.lock_read().unlock)
2046
2150
        basis = wt.basis_tree()
2047
2151
        self.add_cleanup(basis.lock_read().unlock)
2053
2157
            if inv.is_root(file_id) and len(basis_inv) == 0:
2054
2158
                continue
2055
2159
            path = inv.id2path(file_id)
2056
 
            if not os.access(osutils.abspath(path), os.F_OK):
 
2160
            if not os.access(osutils.pathjoin(wt.basedir, path), os.F_OK):
2057
2161
                continue
2058
2162
            if null:
2059
2163
                self.outf.write(path + '\0')
2259
2363
                   help='Show just the specified revision.'
2260
2364
                   ' See also "help revisionspec".'),
2261
2365
            'log-format',
 
2366
            RegistryOption('authors',
 
2367
                'What names to list as authors - first, all or committer.',
 
2368
                title='Authors',
 
2369
                lazy_registry=('bzrlib.log', 'author_list_registry'),
 
2370
            ),
2262
2371
            Option('levels',
2263
2372
                   short_name='n',
2264
2373
                   help='Number of levels to display - 0 for all, 1 for flat.',
2299
2408
            limit=None,
2300
2409
            show_diff=False,
2301
2410
            include_merges=False,
 
2411
            authors=None,
2302
2412
            exclude_common_ancestry=False,
2303
2413
            ):
2304
2414
        from bzrlib.log import (
2382
2492
                        show_timezone=timezone,
2383
2493
                        delta_format=get_verbosity_level(),
2384
2494
                        levels=levels,
2385
 
                        show_advice=levels is None)
 
2495
                        show_advice=levels is None,
 
2496
                        author_list_handler=authors)
2386
2497
 
2387
2498
        # Choose the algorithm for doing the logging. It's annoying
2388
2499
        # having multiple code paths like this but necessary until
2505
2616
                   help='Recurse into subdirectories.'),
2506
2617
            Option('from-root',
2507
2618
                   help='Print paths relative to the root of the branch.'),
2508
 
            Option('unknown', help='Print unknown files.'),
 
2619
            Option('unknown', short_name='u',
 
2620
                help='Print unknown files.'),
2509
2621
            Option('versioned', help='Print versioned files.',
2510
2622
                   short_name='V'),
2511
 
            Option('ignored', help='Print ignored files.'),
2512
 
            Option('null',
2513
 
                   help='Write an ascii NUL (\\0) separator '
2514
 
                   'between files rather than a newline.'),
2515
 
            Option('kind',
 
2623
            Option('ignored', short_name='i',
 
2624
                help='Print ignored files.'),
 
2625
            Option('kind', short_name='k',
2516
2626
                   help='List entries of a particular kind: file, directory, symlink.',
2517
2627
                   type=unicode),
 
2628
            'null',
2518
2629
            'show-ids',
 
2630
            'directory',
2519
2631
            ]
2520
2632
    @display_command
2521
2633
    def run(self, revision=None, verbose=False,
2522
2634
            recursive=False, from_root=False,
2523
2635
            unknown=False, versioned=False, ignored=False,
2524
 
            null=False, kind=None, show_ids=False, path=None):
 
2636
            null=False, kind=None, show_ids=False, path=None, directory=None):
2525
2637
 
2526
2638
        if kind and kind not in ('file', 'directory', 'symlink'):
2527
2639
            raise errors.BzrCommandError('invalid kind specified')
2539
2651
                raise errors.BzrCommandError('cannot specify both --from-root'
2540
2652
                                             ' and PATH')
2541
2653
            fs_path = path
2542
 
        tree, branch, relpath = bzrdir.BzrDir.open_containing_tree_or_branch(
2543
 
            fs_path)
 
2654
        tree, branch, relpath = \
 
2655
            _open_directory_or_containing_tree_or_branch(fs_path, directory)
2544
2656
 
2545
2657
        # Calculate the prefix to use
2546
2658
        prefix = None
2614
2726
 
2615
2727
    hidden = True
2616
2728
    _see_also = ['ls']
 
2729
    takes_options = ['directory']
2617
2730
 
2618
2731
    @display_command
2619
 
    def run(self):
2620
 
        for f in WorkingTree.open_containing(u'.')[0].unknowns():
 
2732
    def run(self, directory=u'.'):
 
2733
        for f in WorkingTree.open_containing(directory)[0].unknowns():
2621
2734
            self.outf.write(osutils.quotefn(f) + '\n')
2622
2735
 
2623
2736
 
2650
2763
    Patterns prefixed with '!!' act as regular ignore patterns, but have
2651
2764
    precedence over the '!' exception patterns.
2652
2765
 
2653
 
    Note: ignore patterns containing shell wildcards must be quoted from
2654
 
    the shell on Unix.
 
2766
    :Notes: 
 
2767
        
 
2768
    * Ignore patterns containing shell wildcards must be quoted from
 
2769
      the shell on Unix.
 
2770
 
 
2771
    * Ignore patterns starting with "#" act as comments in the ignore file.
 
2772
      To ignore patterns that begin with that character, use the "RE:" prefix.
2655
2773
 
2656
2774
    :Examples:
2657
2775
        Ignore the top level Makefile::
2666
2784
 
2667
2785
            bzr ignore "!special.class"
2668
2786
 
 
2787
        Ignore files whose name begins with the "#" character::
 
2788
 
 
2789
            bzr ignore "RE:^#"
 
2790
 
2669
2791
        Ignore .o files under the lib directory::
2670
2792
 
2671
2793
            bzr ignore "lib/**/*.o"
2679
2801
            bzr ignore "RE:(?!debian/).*"
2680
2802
        
2681
2803
        Ignore everything except the "local" toplevel directory,
2682
 
        but always ignore "*~" autosave files, even under local/::
 
2804
        but always ignore autosave files ending in ~, even under local/::
2683
2805
        
2684
2806
            bzr ignore "*"
2685
2807
            bzr ignore "!./local"
2688
2810
 
2689
2811
    _see_also = ['status', 'ignored', 'patterns']
2690
2812
    takes_args = ['name_pattern*']
2691
 
    takes_options = [
 
2813
    takes_options = ['directory',
2692
2814
        Option('default-rules',
2693
2815
               help='Display the default ignore rules that bzr uses.')
2694
2816
        ]
2695
2817
 
2696
 
    def run(self, name_pattern_list=None, default_rules=None):
 
2818
    def run(self, name_pattern_list=None, default_rules=None,
 
2819
            directory=u'.'):
2697
2820
        from bzrlib import ignores
2698
2821
        if default_rules is not None:
2699
2822
            # dump the default rules and exit
2705
2828
                "NAME_PATTERN or --default-rules.")
2706
2829
        name_pattern_list = [globbing.normalize_pattern(p)
2707
2830
                             for p in name_pattern_list]
 
2831
        bad_patterns = ''
 
2832
        for p in name_pattern_list:
 
2833
            if not globbing.Globster.is_pattern_valid(p):
 
2834
                bad_patterns += ('\n  %s' % p)
 
2835
        if bad_patterns:
 
2836
            msg = ('Invalid ignore pattern(s) found. %s' % bad_patterns)
 
2837
            ui.ui_factory.show_error(msg)
 
2838
            raise errors.InvalidPattern('')
2708
2839
        for name_pattern in name_pattern_list:
2709
2840
            if (name_pattern[0] == '/' or
2710
2841
                (len(name_pattern) > 1 and name_pattern[1] == ':')):
2711
2842
                raise errors.BzrCommandError(
2712
2843
                    "NAME_PATTERN should not be an absolute path")
2713
 
        tree, relpath = WorkingTree.open_containing(u'.')
 
2844
        tree, relpath = WorkingTree.open_containing(directory)
2714
2845
        ignores.tree_ignores_add_patterns(tree, name_pattern_list)
2715
2846
        ignored = globbing.Globster(name_pattern_list)
2716
2847
        matches = []
2717
 
        tree.lock_read()
 
2848
        self.add_cleanup(tree.lock_read().unlock)
2718
2849
        for entry in tree.list_files():
2719
2850
            id = entry[3]
2720
2851
            if id is not None:
2721
2852
                filename = entry[0]
2722
2853
                if ignored.match(filename):
2723
2854
                    matches.append(filename)
2724
 
        tree.unlock()
2725
2855
        if len(matches) > 0:
2726
2856
            self.outf.write("Warning: the following files are version controlled and"
2727
2857
                  " match your ignore pattern:\n%s"
2742
2872
 
2743
2873
    encoding_type = 'replace'
2744
2874
    _see_also = ['ignore', 'ls']
 
2875
    takes_options = ['directory']
2745
2876
 
2746
2877
    @display_command
2747
 
    def run(self):
2748
 
        tree = WorkingTree.open_containing(u'.')[0]
 
2878
    def run(self, directory=u'.'):
 
2879
        tree = WorkingTree.open_containing(directory)[0]
2749
2880
        self.add_cleanup(tree.lock_read().unlock)
2750
2881
        for path, file_class, kind, file_id, entry in tree.list_files():
2751
2882
            if file_class != 'I':
2763
2894
    """
2764
2895
    hidden = True
2765
2896
    takes_args = ['revno']
 
2897
    takes_options = ['directory']
2766
2898
 
2767
2899
    @display_command
2768
 
    def run(self, revno):
 
2900
    def run(self, revno, directory=u'.'):
2769
2901
        try:
2770
2902
            revno = int(revno)
2771
2903
        except ValueError:
2772
2904
            raise errors.BzrCommandError("not a valid revision-number: %r"
2773
2905
                                         % revno)
2774
 
        revid = WorkingTree.open_containing(u'.')[0].branch.get_rev_id(revno)
 
2906
        revid = WorkingTree.open_containing(directory)[0].branch.get_rev_id(revno)
2775
2907
        self.outf.write("%s\n" % revid)
2776
2908
 
2777
2909
 
2803
2935
         zip                          .zip
2804
2936
      =================       =========================
2805
2937
    """
 
2938
    encoding = 'exact'
2806
2939
    takes_args = ['dest', 'branch_or_subdir?']
2807
 
    takes_options = [
 
2940
    takes_options = ['directory',
2808
2941
        Option('format',
2809
2942
               help="Type of file to export to.",
2810
2943
               type=unicode),
2819
2952
                    'revision in which it was changed.'),
2820
2953
        ]
2821
2954
    def run(self, dest, branch_or_subdir=None, revision=None, format=None,
2822
 
        root=None, filters=False, per_file_timestamps=False):
 
2955
        root=None, filters=False, per_file_timestamps=False, directory=u'.'):
2823
2956
        from bzrlib.export import export
2824
2957
 
2825
2958
        if branch_or_subdir is None:
2826
 
            tree = WorkingTree.open_containing(u'.')[0]
 
2959
            tree = WorkingTree.open_containing(directory)[0]
2827
2960
            b = tree.branch
2828
2961
            subdir = None
2829
2962
        else:
2848
2981
    """
2849
2982
 
2850
2983
    _see_also = ['ls']
2851
 
    takes_options = [
 
2984
    takes_options = ['directory',
2852
2985
        Option('name-from-revision', help='The path name in the old tree.'),
2853
2986
        Option('filters', help='Apply content filters to display the '
2854
2987
                'convenience form.'),
2859
2992
 
2860
2993
    @display_command
2861
2994
    def run(self, filename, revision=None, name_from_revision=False,
2862
 
            filters=False):
 
2995
            filters=False, directory=None):
2863
2996
        if revision is not None and len(revision) != 1:
2864
2997
            raise errors.BzrCommandError("bzr cat --revision takes exactly"
2865
2998
                                         " one revision specifier")
2866
2999
        tree, branch, relpath = \
2867
 
            bzrdir.BzrDir.open_containing_tree_or_branch(filename)
 
3000
            _open_directory_or_containing_tree_or_branch(filename, directory)
2868
3001
        self.add_cleanup(branch.lock_read().unlock)
2869
3002
        return self._run(tree, branch, relpath, filename, revision,
2870
3003
                         name_from_revision, filters)
2986
3119
      to trigger updates to external systems like bug trackers. The --fixes
2987
3120
      option can be used to record the association between a revision and
2988
3121
      one or more bugs. See ``bzr help bugs`` for details.
2989
 
 
2990
 
      A selective commit may fail in some cases where the committed
2991
 
      tree would be invalid. Consider::
2992
 
  
2993
 
        bzr init foo
2994
 
        mkdir foo/bar
2995
 
        bzr add foo/bar
2996
 
        bzr commit foo -m "committing foo"
2997
 
        bzr mv foo/bar foo/baz
2998
 
        mkdir foo/bar
2999
 
        bzr add foo/bar
3000
 
        bzr commit foo/bar -m "committing bar but not baz"
3001
 
  
3002
 
      In the example above, the last commit will fail by design. This gives
3003
 
      the user the opportunity to decide whether they want to commit the
3004
 
      rename at the same time, separately first, or not at all. (As a general
3005
 
      rule, when in doubt, Bazaar has a policy of Doing the Safe Thing.)
3006
3122
    """
3007
 
    # TODO: Run hooks on tree to-be-committed, and after commit.
3008
 
 
3009
 
    # TODO: Strict commit that fails if there are deleted files.
3010
 
    #       (what does "deleted files" mean ??)
3011
 
 
3012
 
    # TODO: Give better message for -s, --summary, used by tla people
3013
 
 
3014
 
    # XXX: verbose currently does nothing
3015
3123
 
3016
3124
    _see_also = ['add', 'bugs', 'hooks', 'uncommit']
3017
3125
    takes_args = ['selected*']
3049
3157
             Option('show-diff', short_name='p',
3050
3158
                    help='When no message is supplied, show the diff along'
3051
3159
                    ' with the status summary in the message editor.'),
 
3160
             Option('lossy', 
 
3161
                    help='When committing to a foreign version control '
 
3162
                    'system do not push data that can not be natively '
 
3163
                    'represented.'),
3052
3164
             ]
3053
3165
    aliases = ['ci', 'checkin']
3054
3166
 
3073
3185
 
3074
3186
    def run(self, message=None, file=None, verbose=False, selected_list=None,
3075
3187
            unchanged=False, strict=False, local=False, fixes=None,
3076
 
            author=None, show_diff=False, exclude=None, commit_time=None):
 
3188
            author=None, show_diff=False, exclude=None, commit_time=None,
 
3189
            lossy=False):
3077
3190
        from bzrlib.errors import (
3078
3191
            PointlessCommit,
3079
3192
            ConflictsInTree,
3082
3195
        from bzrlib.msgeditor import (
3083
3196
            edit_commit_message_encoded,
3084
3197
            generate_commit_message_template,
3085
 
            make_commit_message_template_encoded
 
3198
            make_commit_message_template_encoded,
 
3199
            set_commit_message,
3086
3200
        )
3087
3201
 
3088
3202
        commit_stamp = offset = None
3093
3207
                raise errors.BzrCommandError(
3094
3208
                    "Could not parse --commit-time: " + str(e))
3095
3209
 
3096
 
        # TODO: Need a blackbox test for invoking the external editor; may be
3097
 
        # slightly problematic to run this cross-platform.
3098
 
 
3099
 
        # TODO: do more checks that the commit will succeed before
3100
 
        # spending the user's valuable time typing a commit message.
3101
 
 
3102
3210
        properties = {}
3103
3211
 
3104
 
        tree, selected_list = tree_files(selected_list)
 
3212
        tree, selected_list = WorkingTree.open_containing_paths(selected_list)
3105
3213
        if selected_list == ['']:
3106
3214
            # workaround - commit of root of tree should be exactly the same
3107
3215
            # as just default commit in that tree, and succeed even though
3142
3250
        def get_message(commit_obj):
3143
3251
            """Callback to get commit message"""
3144
3252
            if file:
3145
 
                my_message = codecs.open(
3146
 
                    file, 'rt', osutils.get_user_encoding()).read()
 
3253
                f = open(file)
 
3254
                try:
 
3255
                    my_message = f.read().decode(osutils.get_user_encoding())
 
3256
                finally:
 
3257
                    f.close()
3147
3258
            elif message is not None:
3148
3259
                my_message = message
3149
3260
            else:
3157
3268
                # make_commit_message_template_encoded returns user encoding.
3158
3269
                # We probably want to be using edit_commit_message instead to
3159
3270
                # avoid this.
3160
 
                start_message = generate_commit_message_template(commit_obj)
3161
 
                my_message = edit_commit_message_encoded(text,
3162
 
                    start_message=start_message)
 
3271
                my_message = set_commit_message(commit_obj)
 
3272
                if my_message is None:
 
3273
                    start_message = generate_commit_message_template(commit_obj)
 
3274
                    my_message = edit_commit_message_encoded(text,
 
3275
                        start_message=start_message)
3163
3276
                if my_message is None:
3164
3277
                    raise errors.BzrCommandError("please specify a commit"
3165
3278
                        " message with either --message or --file")
3178
3291
                        reporter=None, verbose=verbose, revprops=properties,
3179
3292
                        authors=author, timestamp=commit_stamp,
3180
3293
                        timezone=offset,
3181
 
                        exclude=safe_relpath_files(tree, exclude))
 
3294
                        exclude=tree.safe_relpath_files(exclude),
 
3295
                        lossy=lossy)
3182
3296
        except PointlessCommit:
3183
3297
            raise errors.BzrCommandError("No changes to commit."
3184
 
                              " Use --unchanged to commit anyhow.")
 
3298
                " Please 'bzr add' the files you want to commit, or use"
 
3299
                " --unchanged to force an empty commit.")
3185
3300
        except ConflictsInTree:
3186
3301
            raise errors.BzrCommandError('Conflicts detected in working '
3187
3302
                'tree.  Use "bzr conflicts" to list, "bzr resolve FILE" to'
3268
3383
 
3269
3384
 
3270
3385
class cmd_upgrade(Command):
3271
 
    __doc__ = """Upgrade branch storage to current format.
3272
 
 
3273
 
    The check command or bzr developers may sometimes advise you to run
3274
 
    this command. When the default format has changed you may also be warned
3275
 
    during other operations to upgrade.
 
3386
    __doc__ = """Upgrade a repository, branch or working tree to a newer format.
 
3387
 
 
3388
    When the default format has changed after a major new release of
 
3389
    Bazaar, you may be informed during certain operations that you
 
3390
    should upgrade. Upgrading to a newer format may improve performance
 
3391
    or make new features available. It may however limit interoperability
 
3392
    with older repositories or with older versions of Bazaar.
 
3393
 
 
3394
    If you wish to upgrade to a particular format rather than the
 
3395
    current default, that can be specified using the --format option.
 
3396
    As a consequence, you can use the upgrade command this way to
 
3397
    "downgrade" to an earlier format, though some conversions are
 
3398
    a one way process (e.g. changing from the 1.x default to the
 
3399
    2.x default) so downgrading is not always possible.
 
3400
 
 
3401
    A backup.bzr.~#~ directory is created at the start of the conversion
 
3402
    process (where # is a number). By default, this is left there on
 
3403
    completion. If the conversion fails, delete the new .bzr directory
 
3404
    and rename this one back in its place. Use the --clean option to ask
 
3405
    for the backup.bzr directory to be removed on successful conversion.
 
3406
    Alternatively, you can delete it by hand if everything looks good
 
3407
    afterwards.
 
3408
 
 
3409
    If the location given is a shared repository, dependent branches
 
3410
    are also converted provided the repository converts successfully.
 
3411
    If the conversion of a branch fails, remaining branches are still
 
3412
    tried.
 
3413
 
 
3414
    For more information on upgrades, see the Bazaar Upgrade Guide,
 
3415
    http://doc.bazaar.canonical.com/latest/en/upgrade-guide/.
3276
3416
    """
3277
3417
 
3278
 
    _see_also = ['check']
 
3418
    _see_also = ['check', 'reconcile', 'formats']
3279
3419
    takes_args = ['url?']
3280
3420
    takes_options = [
3281
 
                    RegistryOption('format',
3282
 
                        help='Upgrade to a specific format.  See "bzr help'
3283
 
                             ' formats" for details.',
3284
 
                        lazy_registry=('bzrlib.bzrdir', 'format_registry'),
3285
 
                        converter=lambda name: bzrdir.format_registry.make_bzrdir(name),
3286
 
                        value_switches=True, title='Branch format'),
3287
 
                    ]
 
3421
        RegistryOption('format',
 
3422
            help='Upgrade to a specific format.  See "bzr help'
 
3423
                 ' formats" for details.',
 
3424
            lazy_registry=('bzrlib.bzrdir', 'format_registry'),
 
3425
            converter=lambda name: bzrdir.format_registry.make_bzrdir(name),
 
3426
            value_switches=True, title='Branch format'),
 
3427
        Option('clean',
 
3428
            help='Remove the backup.bzr directory if successful.'),
 
3429
        Option('dry-run',
 
3430
            help="Show what would be done, but don't actually do anything."),
 
3431
    ]
3288
3432
 
3289
 
    def run(self, url='.', format=None):
 
3433
    def run(self, url='.', format=None, clean=False, dry_run=False):
3290
3434
        from bzrlib.upgrade import upgrade
3291
 
        upgrade(url, format)
 
3435
        exceptions = upgrade(url, format, clean_up=clean, dry_run=dry_run)
 
3436
        if exceptions:
 
3437
            if len(exceptions) == 1:
 
3438
                # Compatibility with historical behavior
 
3439
                raise exceptions[0]
 
3440
            else:
 
3441
                return 3
3292
3442
 
3293
3443
 
3294
3444
class cmd_whoami(Command):
3303
3453
 
3304
3454
            bzr whoami "Frank Chu <fchu@example.com>"
3305
3455
    """
3306
 
    takes_options = [ Option('email',
 
3456
    takes_options = [ 'directory',
 
3457
                      Option('email',
3307
3458
                             help='Display email address only.'),
3308
3459
                      Option('branch',
3309
3460
                             help='Set identity for the current branch instead of '
3313
3464
    encoding_type = 'replace'
3314
3465
 
3315
3466
    @display_command
3316
 
    def run(self, email=False, branch=False, name=None):
 
3467
    def run(self, email=False, branch=False, name=None, directory=None):
3317
3468
        if name is None:
3318
 
            # use branch if we're inside one; otherwise global config
3319
 
            try:
3320
 
                c = Branch.open_containing('.')[0].get_config()
3321
 
            except errors.NotBranchError:
3322
 
                c = config.GlobalConfig()
 
3469
            if directory is None:
 
3470
                # use branch if we're inside one; otherwise global config
 
3471
                try:
 
3472
                    c = Branch.open_containing(u'.')[0].get_config()
 
3473
                except errors.NotBranchError:
 
3474
                    c = _mod_config.GlobalConfig()
 
3475
            else:
 
3476
                c = Branch.open(directory).get_config()
3323
3477
            if email:
3324
3478
                self.outf.write(c.user_email() + '\n')
3325
3479
            else:
3326
3480
                self.outf.write(c.username() + '\n')
3327
3481
            return
3328
3482
 
 
3483
        if email:
 
3484
            raise errors.BzrCommandError("--email can only be used to display existing "
 
3485
                                         "identity")
 
3486
 
3329
3487
        # display a warning if an email address isn't included in the given name.
3330
3488
        try:
3331
 
            config.extract_email_address(name)
 
3489
            _mod_config.extract_email_address(name)
3332
3490
        except errors.NoEmailInUsername, e:
3333
3491
            warning('"%s" does not seem to contain an email address.  '
3334
3492
                    'This is allowed, but not recommended.', name)
3335
3493
 
3336
3494
        # use global config unless --branch given
3337
3495
        if branch:
3338
 
            c = Branch.open_containing('.')[0].get_config()
 
3496
            if directory is None:
 
3497
                c = Branch.open_containing(u'.')[0].get_config()
 
3498
            else:
 
3499
                c = Branch.open(directory).get_config()
3339
3500
        else:
3340
 
            c = config.GlobalConfig()
 
3501
            c = _mod_config.GlobalConfig()
3341
3502
        c.set_user_option('email', name)
3342
3503
 
3343
3504
 
3353
3514
 
3354
3515
    _see_also = ['info']
3355
3516
    takes_args = ['nickname?']
3356
 
    def run(self, nickname=None):
3357
 
        branch = Branch.open_containing(u'.')[0]
 
3517
    takes_options = ['directory']
 
3518
    def run(self, nickname=None, directory=u'.'):
 
3519
        branch = Branch.open_containing(directory)[0]
3358
3520
        if nickname is None:
3359
3521
            self.printme(branch)
3360
3522
        else:
3409
3571
                'bzr alias --remove expects an alias to remove.')
3410
3572
        # If alias is not found, print something like:
3411
3573
        # unalias: foo: not found
3412
 
        c = config.GlobalConfig()
 
3574
        c = _mod_config.GlobalConfig()
3413
3575
        c.unset_alias(alias_name)
3414
3576
 
3415
3577
    @display_command
3416
3578
    def print_aliases(self):
3417
3579
        """Print out the defined aliases in a similar format to bash."""
3418
 
        aliases = config.GlobalConfig().get_aliases()
 
3580
        aliases = _mod_config.GlobalConfig().get_aliases()
3419
3581
        for key, value in sorted(aliases.iteritems()):
3420
3582
            self.outf.write('bzr alias %s="%s"\n' % (key, value))
3421
3583
 
3431
3593
 
3432
3594
    def set_alias(self, alias_name, alias_command):
3433
3595
        """Save the alias in the global config."""
3434
 
        c = config.GlobalConfig()
 
3596
        c = _mod_config.GlobalConfig()
3435
3597
        c.set_alias(alias_name, alias_command)
3436
3598
 
3437
3599
 
3472
3634
    If you set BZR_TEST_PDB=1 when running selftest, failing tests will drop
3473
3635
    into a pdb postmortem session.
3474
3636
 
 
3637
    The --coverage=DIRNAME global option produces a report with covered code
 
3638
    indicated.
 
3639
 
3475
3640
    :Examples:
3476
3641
        Run only tests relating to 'ignore'::
3477
3642
 
3488
3653
        if typestring == "sftp":
3489
3654
            from bzrlib.tests import stub_sftp
3490
3655
            return stub_sftp.SFTPAbsoluteServer
3491
 
        if typestring == "memory":
 
3656
        elif typestring == "memory":
3492
3657
            from bzrlib.tests import test_server
3493
3658
            return memory.MemoryServer
3494
 
        if typestring == "fakenfs":
 
3659
        elif typestring == "fakenfs":
3495
3660
            from bzrlib.tests import test_server
3496
3661
            return test_server.FakeNFSServer
3497
3662
        msg = "No known transport type %s. Supported types are: sftp\n" %\
3510
3675
                                 'throughout the test suite.',
3511
3676
                            type=get_transport_type),
3512
3677
                     Option('benchmark',
3513
 
                            help='Run the benchmarks rather than selftests.'),
 
3678
                            help='Run the benchmarks rather than selftests.',
 
3679
                            hidden=True),
3514
3680
                     Option('lsprof-timed',
3515
3681
                            help='Generate lsprof output for benchmarked'
3516
3682
                                 ' sections of code.'),
3517
3683
                     Option('lsprof-tests',
3518
3684
                            help='Generate lsprof output for each test.'),
3519
 
                     Option('cache-dir', type=str,
3520
 
                            help='Cache intermediate benchmark output in this '
3521
 
                                 'directory.'),
3522
3685
                     Option('first',
3523
3686
                            help='Run all tests, but run specified tests first.',
3524
3687
                            short_name='f',
3533
3696
                     Option('randomize', type=str, argname="SEED",
3534
3697
                            help='Randomize the order of tests using the given'
3535
3698
                                 ' seed or "now" for the current time.'),
3536
 
                     Option('exclude', type=str, argname="PATTERN",
3537
 
                            short_name='x',
3538
 
                            help='Exclude tests that match this regular'
3539
 
                                 ' expression.'),
 
3699
                     ListOption('exclude', type=str, argname="PATTERN",
 
3700
                                short_name='x',
 
3701
                                help='Exclude tests that match this regular'
 
3702
                                ' expression.'),
3540
3703
                     Option('subunit',
3541
3704
                        help='Output test progress via subunit.'),
3542
3705
                     Option('strict', help='Fail on missing dependencies or '
3558
3721
 
3559
3722
    def run(self, testspecs_list=None, verbose=False, one=False,
3560
3723
            transport=None, benchmark=None,
3561
 
            lsprof_timed=None, cache_dir=None,
 
3724
            lsprof_timed=None,
3562
3725
            first=False, list_only=False,
3563
3726
            randomize=None, exclude=None, strict=False,
3564
3727
            load_list=None, debugflag=None, starting_with=None, subunit=False,
3565
3728
            parallel=None, lsprof_tests=False):
3566
 
        from bzrlib.tests import selftest
3567
 
        import bzrlib.benchmarks as benchmarks
3568
 
        from bzrlib.benchmarks import tree_creator
3569
 
 
3570
 
        # Make deprecation warnings visible, unless -Werror is set
3571
 
        symbol_versioning.activate_deprecation_warnings(override=False)
3572
 
 
3573
 
        if cache_dir is not None:
3574
 
            tree_creator.TreeCreator.CACHE_ROOT = osutils.abspath(cache_dir)
 
3729
        from bzrlib import tests
 
3730
 
3575
3731
        if testspecs_list is not None:
3576
3732
            pattern = '|'.join(testspecs_list)
3577
3733
        else:
3585
3741
            self.additional_selftest_args['runner_class'] = SubUnitBzrRunner
3586
3742
            # On Windows, disable automatic conversion of '\n' to '\r\n' in
3587
3743
            # stdout, which would corrupt the subunit stream. 
3588
 
            if sys.platform == "win32" and sys.stdout.fileno() >= 0:
 
3744
            # FIXME: This has been fixed in subunit trunk (>0.0.5) so the
 
3745
            # following code can be deleted when it's sufficiently deployed
 
3746
            # -- vila/mgz 20100514
 
3747
            if (sys.platform == "win32"
 
3748
                and getattr(sys.stdout, 'fileno', None) is not None):
3589
3749
                import msvcrt
3590
3750
                msvcrt.setmode(sys.stdout.fileno(), os.O_BINARY)
3591
3751
        if parallel:
3592
3752
            self.additional_selftest_args.setdefault(
3593
3753
                'suite_decorators', []).append(parallel)
3594
3754
        if benchmark:
3595
 
            test_suite_factory = benchmarks.test_suite
3596
 
            # Unless user explicitly asks for quiet, be verbose in benchmarks
3597
 
            verbose = not is_quiet()
3598
 
            # TODO: should possibly lock the history file...
3599
 
            benchfile = open(".perf_history", "at", buffering=1)
3600
 
            self.add_cleanup(benchfile.close)
 
3755
            raise errors.BzrCommandError(
 
3756
                "--benchmark is no longer supported from bzr 2.2; "
 
3757
                "use bzr-usertest instead")
 
3758
        test_suite_factory = None
 
3759
        if not exclude:
 
3760
            exclude_pattern = None
3601
3761
        else:
3602
 
            test_suite_factory = None
3603
 
            benchfile = None
 
3762
            exclude_pattern = '(' + '|'.join(exclude) + ')'
3604
3763
        selftest_kwargs = {"verbose": verbose,
3605
3764
                          "pattern": pattern,
3606
3765
                          "stop_on_failure": one,
3608
3767
                          "test_suite_factory": test_suite_factory,
3609
3768
                          "lsprof_timed": lsprof_timed,
3610
3769
                          "lsprof_tests": lsprof_tests,
3611
 
                          "bench_history": benchfile,
3612
3770
                          "matching_tests_first": first,
3613
3771
                          "list_only": list_only,
3614
3772
                          "random_seed": randomize,
3615
 
                          "exclude_pattern": exclude,
 
3773
                          "exclude_pattern": exclude_pattern,
3616
3774
                          "strict": strict,
3617
3775
                          "load_list": load_list,
3618
3776
                          "debug_flags": debugflag,
3619
3777
                          "starting_with": starting_with
3620
3778
                          }
3621
3779
        selftest_kwargs.update(self.additional_selftest_args)
3622
 
        result = selftest(**selftest_kwargs)
 
3780
 
 
3781
        # Make deprecation warnings visible, unless -Werror is set
 
3782
        cleanup = symbol_versioning.activate_deprecation_warnings(
 
3783
            override=False)
 
3784
        try:
 
3785
            result = tests.selftest(**selftest_kwargs)
 
3786
        finally:
 
3787
            cleanup()
3623
3788
        return int(not result)
3624
3789
 
3625
3790
 
3680
3845
    The source of the merge can be specified either in the form of a branch,
3681
3846
    or in the form of a path to a file containing a merge directive generated
3682
3847
    with bzr send. If neither is specified, the default is the upstream branch
3683
 
    or the branch most recently merged using --remember.
3684
 
 
3685
 
    When merging a branch, by default the tip will be merged. To pick a different
3686
 
    revision, pass --revision. If you specify two values, the first will be used as
3687
 
    BASE and the second one as OTHER. Merging individual revisions, or a subset of
3688
 
    available revisions, like this is commonly referred to as "cherrypicking".
3689
 
 
3690
 
    Revision numbers are always relative to the branch being merged.
3691
 
 
3692
 
    By default, bzr will try to merge in all new work from the other
3693
 
    branch, automatically determining an appropriate base.  If this
3694
 
    fails, you may need to give an explicit base.
 
3848
    or the branch most recently merged using --remember.  The source of the
 
3849
    merge may also be specified in the form of a path to a file in another
 
3850
    branch:  in this case, only the modifications to that file are merged into
 
3851
    the current working tree.
 
3852
 
 
3853
    When merging from a branch, by default bzr will try to merge in all new
 
3854
    work from the other branch, automatically determining an appropriate base
 
3855
    revision.  If this fails, you may need to give an explicit base.
 
3856
 
 
3857
    To pick a different ending revision, pass "--revision OTHER".  bzr will
 
3858
    try to merge in all new work up to and including revision OTHER.
 
3859
 
 
3860
    If you specify two values, "--revision BASE..OTHER", only revisions BASE
 
3861
    through OTHER, excluding BASE but including OTHER, will be merged.  If this
 
3862
    causes some revisions to be skipped, i.e. if the destination branch does
 
3863
    not already contain revision BASE, such a merge is commonly referred to as
 
3864
    a "cherrypick". Unlike a normal merge, Bazaar does not currently track
 
3865
    cherrypicks. The changes look like a normal commit, and the history of the
 
3866
    changes from the other branch is not stored in the commit.
 
3867
 
 
3868
    Revision numbers are always relative to the source branch.
3695
3869
 
3696
3870
    Merge will do its best to combine the changes in two branches, but there
3697
3871
    are some kinds of problems only a human can fix.  When it encounters those,
3700
3874
 
3701
3875
    Use bzr resolve when you have fixed a problem.  See also bzr conflicts.
3702
3876
 
3703
 
    If there is no default branch set, the first merge will set it. After
3704
 
    that, you can omit the branch to use the default.  To change the
3705
 
    default, use --remember. The value will only be saved if the remote
3706
 
    location can be accessed.
 
3877
    If there is no default branch set, the first merge will set it (use
 
3878
    --no-remember to avoid settting it). After that, you can omit the branch
 
3879
    to use the default.  To change the default, use --remember. The value will
 
3880
    only be saved if the remote location can be accessed.
3707
3881
 
3708
3882
    The results of the merge are placed into the destination working
3709
3883
    directory, where they can be reviewed (with bzr diff), tested, and then
3710
3884
    committed to record the result of the merge.
3711
3885
 
3712
3886
    merge refuses to run if there are any uncommitted changes, unless
3713
 
    --force is given. The --force option can also be used to create a
 
3887
    --force is given.  If --force is given, then the changes from the source 
 
3888
    will be merged with the current working tree, including any uncommitted
 
3889
    changes in the tree.  The --force option can also be used to create a
3714
3890
    merge revision which has more than two parents.
3715
3891
 
3716
3892
    If one would like to merge changes from the working tree of the other
3721
3897
    you to apply each diff hunk and file change, similar to "shelve".
3722
3898
 
3723
3899
    :Examples:
3724
 
        To merge the latest revision from bzr.dev::
 
3900
        To merge all new revisions from bzr.dev::
3725
3901
 
3726
3902
            bzr merge ../bzr.dev
3727
3903
 
3764
3940
                ' completely merged into the source, pull from the'
3765
3941
                ' source rather than merging.  When this happens,'
3766
3942
                ' you do not need to commit the result.'),
3767
 
        Option('directory',
 
3943
        custom_help('directory',
3768
3944
               help='Branch to merge into, '
3769
 
                    'rather than the one containing the working directory.',
3770
 
               short_name='d',
3771
 
               type=unicode,
3772
 
               ),
 
3945
                    'rather than the one containing the working directory.'),
3773
3946
        Option('preview', help='Instead of merging, show a diff of the'
3774
3947
               ' merge.'),
3775
3948
        Option('interactive', help='Select changes interactively.',
3777
3950
    ]
3778
3951
 
3779
3952
    def run(self, location=None, revision=None, force=False,
3780
 
            merge_type=None, show_base=False, reprocess=None, remember=False,
 
3953
            merge_type=None, show_base=False, reprocess=None, remember=None,
3781
3954
            uncommitted=False, pull=False,
3782
3955
            directory=None,
3783
3956
            preview=False,
3791
3964
        merger = None
3792
3965
        allow_pending = True
3793
3966
        verified = 'inapplicable'
 
3967
 
3794
3968
        tree = WorkingTree.open_containing(directory)[0]
 
3969
        if tree.branch.revno() == 0:
 
3970
            raise errors.BzrCommandError('Merging into empty branches not currently supported, '
 
3971
                                         'https://bugs.launchpad.net/bzr/+bug/308562')
3795
3972
 
3796
3973
        try:
3797
3974
            basis_tree = tree.revision_tree(tree.last_revision())
3843
4020
        self.sanity_check_merger(merger)
3844
4021
        if (merger.base_rev_id == merger.other_rev_id and
3845
4022
            merger.other_rev_id is not None):
 
4023
            # check if location is a nonexistent file (and not a branch) to
 
4024
            # disambiguate the 'Nothing to do'
 
4025
            if merger.interesting_files:
 
4026
                if not merger.other_tree.has_filename(
 
4027
                    merger.interesting_files[0]):
 
4028
                    note("merger: " + str(merger))
 
4029
                    raise errors.PathsDoNotExist([location])
3846
4030
            note('Nothing to do.')
3847
4031
            return 0
3848
 
        if pull:
 
4032
        if pull and not preview:
3849
4033
            if merger.interesting_files is not None:
3850
4034
                raise errors.BzrCommandError('Cannot pull individual files')
3851
4035
            if (merger.base_rev_id == tree.last_revision()):
3875
4059
    def _do_preview(self, merger):
3876
4060
        from bzrlib.diff import show_diff_trees
3877
4061
        result_tree = self._get_preview(merger)
 
4062
        path_encoding = osutils.get_diff_header_encoding()
3878
4063
        show_diff_trees(merger.this_tree, result_tree, self.outf,
3879
 
                        old_label='', new_label='')
 
4064
                        old_label='', new_label='',
 
4065
                        path_encoding=path_encoding)
3880
4066
 
3881
4067
    def _do_merge(self, merger, change_reporter, allow_pending, verified):
3882
4068
        merger.change_reporter = change_reporter
3958
4144
        if other_revision_id is None:
3959
4145
            other_revision_id = _mod_revision.ensure_null(
3960
4146
                other_branch.last_revision())
3961
 
        # Remember where we merge from
3962
 
        if ((remember or tree.branch.get_submit_branch() is None) and
3963
 
             user_location is not None):
 
4147
        # Remember where we merge from. We need to remember if:
 
4148
        # - user specify a location (and we don't merge from the parent
 
4149
        #   branch)
 
4150
        # - user ask to remember or there is no previous location set to merge
 
4151
        #   from and user didn't ask to *not* remember
 
4152
        if (user_location is not None
 
4153
            and ((remember
 
4154
                  or (remember is None
 
4155
                      and tree.branch.get_submit_branch() is None)))):
3964
4156
            tree.branch.set_submit_branch(other_branch.base)
3965
 
        _merge_tags_if_possible(other_branch, tree.branch)
 
4157
        # Merge tags (but don't set them in the master branch yet, the user
 
4158
        # might revert this merge).  Commit will propagate them.
 
4159
        _merge_tags_if_possible(other_branch, tree.branch, ignore_master=True)
3966
4160
        merger = _mod_merge.Merger.from_revision_ids(pb, tree,
3967
4161
            other_revision_id, base_revision_id, other_branch, base_branch)
3968
4162
        if other_path != '':
4069
4263
        from bzrlib.conflicts import restore
4070
4264
        if merge_type is None:
4071
4265
            merge_type = _mod_merge.Merge3Merger
4072
 
        tree, file_list = tree_files(file_list)
 
4266
        tree, file_list = WorkingTree.open_containing_paths(file_list)
4073
4267
        self.add_cleanup(tree.lock_write().unlock)
4074
4268
        parents = tree.get_parent_ids()
4075
4269
        if len(parents) != 2:
4136
4330
    last committed revision is used.
4137
4331
 
4138
4332
    To remove only some changes, without reverting to a prior version, use
4139
 
    merge instead.  For example, "merge . --revision -2..-3" will remove the
4140
 
    changes introduced by -2, without affecting the changes introduced by -1.
4141
 
    Or to remove certain changes on a hunk-by-hunk basis, see the Shelf plugin.
 
4333
    merge instead.  For example, "merge . -r -2..-3" (don't forget the ".")
 
4334
    will remove the changes introduced by the second last commit (-2), without
 
4335
    affecting the changes introduced by the last commit (-1).  To remove
 
4336
    certain changes on a hunk-by-hunk basis, see the shelve command.
4142
4337
 
4143
4338
    By default, any files that have been manually changed will be backed up
4144
4339
    first.  (Files changed only by merge are not backed up.)  Backup files have
4174
4369
    target branches.
4175
4370
    """
4176
4371
 
4177
 
    _see_also = ['cat', 'export']
 
4372
    _see_also = ['cat', 'export', 'merge', 'shelve']
4178
4373
    takes_options = [
4179
4374
        'revision',
4180
4375
        Option('no-backup', "Do not save backups of reverted files."),
4185
4380
 
4186
4381
    def run(self, revision=None, no_backup=False, file_list=None,
4187
4382
            forget_merges=None):
4188
 
        tree, file_list = tree_files(file_list)
 
4383
        tree, file_list = WorkingTree.open_containing_paths(file_list)
4189
4384
        self.add_cleanup(tree.lock_tree_write().unlock)
4190
4385
        if forget_merges:
4191
4386
            tree.set_parent_ids(tree.get_parent_ids()[:1])
4281
4476
    _see_also = ['merge', 'pull']
4282
4477
    takes_args = ['other_branch?']
4283
4478
    takes_options = [
 
4479
        'directory',
4284
4480
        Option('reverse', 'Reverse the order of revisions.'),
4285
4481
        Option('mine-only',
4286
4482
               'Display changes in the local branch only.'),
4308
4504
            theirs_only=False,
4309
4505
            log_format=None, long=False, short=False, line=False,
4310
4506
            show_ids=False, verbose=False, this=False, other=False,
4311
 
            include_merges=False, revision=None, my_revision=None):
 
4507
            include_merges=False, revision=None, my_revision=None,
 
4508
            directory=u'.'):
4312
4509
        from bzrlib.missing import find_unmerged, iter_log_revisions
4313
4510
        def message(s):
4314
4511
            if not is_quiet():
4327
4524
        elif theirs_only:
4328
4525
            restrict = 'remote'
4329
4526
 
4330
 
        local_branch = Branch.open_containing(u".")[0]
 
4527
        local_branch = Branch.open_containing(directory)[0]
4331
4528
        self.add_cleanup(local_branch.lock_read().unlock)
4332
4529
 
4333
4530
        parent = local_branch.get_parent()
4471
4668
 
4472
4669
    @display_command
4473
4670
    def run(self, verbose=False):
4474
 
        import bzrlib.plugin
4475
 
        from inspect import getdoc
4476
 
        result = []
4477
 
        for name, plugin in bzrlib.plugin.plugins().items():
4478
 
            version = plugin.__version__
4479
 
            if version == 'unknown':
4480
 
                version = ''
4481
 
            name_ver = '%s %s' % (name, version)
4482
 
            d = getdoc(plugin.module)
4483
 
            if d:
4484
 
                doc = d.split('\n')[0]
4485
 
            else:
4486
 
                doc = '(no description)'
4487
 
            result.append((name_ver, doc, plugin.path()))
4488
 
        for name_ver, doc, path in sorted(result):
4489
 
            self.outf.write("%s\n" % name_ver)
4490
 
            self.outf.write("   %s\n" % doc)
4491
 
            if verbose:
4492
 
                self.outf.write("   %s\n" % path)
4493
 
            self.outf.write("\n")
 
4671
        from bzrlib import plugin
 
4672
        # Don't give writelines a generator as some codecs don't like that
 
4673
        self.outf.writelines(
 
4674
            list(plugin.describe_plugins(show_paths=verbose)))
4494
4675
 
4495
4676
 
4496
4677
class cmd_testament(Command):
4542
4723
                     Option('long', help='Show commit date in annotations.'),
4543
4724
                     'revision',
4544
4725
                     'show-ids',
 
4726
                     'directory',
4545
4727
                     ]
4546
4728
    encoding_type = 'exact'
4547
4729
 
4548
4730
    @display_command
4549
4731
    def run(self, filename, all=False, long=False, revision=None,
4550
 
            show_ids=False):
4551
 
        from bzrlib.annotate import annotate_file, annotate_file_tree
 
4732
            show_ids=False, directory=None):
 
4733
        from bzrlib.annotate import (
 
4734
            annotate_file_tree,
 
4735
            )
4552
4736
        wt, branch, relpath = \
4553
 
            bzrdir.BzrDir.open_containing_tree_or_branch(filename)
 
4737
            _open_directory_or_containing_tree_or_branch(filename, directory)
4554
4738
        if wt is not None:
4555
4739
            self.add_cleanup(wt.lock_read().unlock)
4556
4740
        else:
4557
4741
            self.add_cleanup(branch.lock_read().unlock)
4558
4742
        tree = _get_one_revision_tree('annotate', revision, branch=branch)
4559
4743
        self.add_cleanup(tree.lock_read().unlock)
4560
 
        if wt is not None:
 
4744
        if wt is not None and revision is None:
4561
4745
            file_id = wt.path2id(relpath)
4562
4746
        else:
4563
4747
            file_id = tree.path2id(relpath)
4564
4748
        if file_id is None:
4565
4749
            raise errors.NotVersionedError(filename)
4566
 
        file_version = tree.inventory[file_id].revision
4567
4750
        if wt is not None and revision is None:
4568
4751
            # If there is a tree and we're not annotating historical
4569
4752
            # versions, annotate the working tree's content.
4570
4753
            annotate_file_tree(wt, file_id, self.outf, long, all,
4571
4754
                show_ids=show_ids)
4572
4755
        else:
4573
 
            annotate_file(branch, file_version, file_id, long, all, self.outf,
4574
 
                          show_ids=show_ids)
 
4756
            annotate_file_tree(tree, file_id, self.outf, long, all,
 
4757
                show_ids=show_ids, branch=branch)
4575
4758
 
4576
4759
 
4577
4760
class cmd_re_sign(Command):
4580
4763
 
4581
4764
    hidden = True # is this right ?
4582
4765
    takes_args = ['revision_id*']
4583
 
    takes_options = ['revision']
 
4766
    takes_options = ['directory', 'revision']
4584
4767
 
4585
 
    def run(self, revision_id_list=None, revision=None):
 
4768
    def run(self, revision_id_list=None, revision=None, directory=u'.'):
4586
4769
        if revision_id_list is not None and revision is not None:
4587
4770
            raise errors.BzrCommandError('You can only supply one of revision_id or --revision')
4588
4771
        if revision_id_list is None and revision is None:
4589
4772
            raise errors.BzrCommandError('You must supply either --revision or a revision_id')
4590
 
        b = WorkingTree.open_containing(u'.')[0].branch
 
4773
        b = WorkingTree.open_containing(directory)[0].branch
4591
4774
        self.add_cleanup(b.lock_write().unlock)
4592
4775
        return self._run(b, revision_id_list, revision)
4593
4776
 
4653
4836
 
4654
4837
    _see_also = ['checkouts', 'unbind']
4655
4838
    takes_args = ['location?']
4656
 
    takes_options = []
 
4839
    takes_options = ['directory']
4657
4840
 
4658
 
    def run(self, location=None):
4659
 
        b, relpath = Branch.open_containing(u'.')
 
4841
    def run(self, location=None, directory=u'.'):
 
4842
        b, relpath = Branch.open_containing(directory)
4660
4843
        if location is None:
4661
4844
            try:
4662
4845
                location = b.get_old_bound_location()
4689
4872
 
4690
4873
    _see_also = ['checkouts', 'bind']
4691
4874
    takes_args = []
4692
 
    takes_options = []
 
4875
    takes_options = ['directory']
4693
4876
 
4694
 
    def run(self):
4695
 
        b, relpath = Branch.open_containing(u'.')
 
4877
    def run(self, directory=u'.'):
 
4878
        b, relpath = Branch.open_containing(directory)
4696
4879
        if not b.unbind():
4697
4880
            raise errors.BzrCommandError('Local branch is not bound')
4698
4881
 
4791
4974
            self.outf.write('The above revision(s) will be removed.\n')
4792
4975
 
4793
4976
        if not force:
4794
 
            if not ui.ui_factory.get_boolean('Are you sure'):
4795
 
                self.outf.write('Canceled')
 
4977
            if not ui.ui_factory.confirm_action(
 
4978
                    u'Uncommit these revisions',
 
4979
                    'bzrlib.builtins.uncommit',
 
4980
                    {}):
 
4981
                self.outf.write('Canceled\n')
4796
4982
                return 0
4797
4983
 
4798
4984
        mutter('Uncommitting from {%s} to {%s}',
4804
4990
 
4805
4991
 
4806
4992
class cmd_break_lock(Command):
4807
 
    __doc__ = """Break a dead lock on a repository, branch or working directory.
 
4993
    __doc__ = """Break a dead lock.
 
4994
 
 
4995
    This command breaks a lock on a repository, branch, working directory or
 
4996
    config file.
4808
4997
 
4809
4998
    CAUTION: Locks should only be broken when you are sure that the process
4810
4999
    holding the lock has been stopped.
4815
5004
    :Examples:
4816
5005
        bzr break-lock
4817
5006
        bzr break-lock bzr+ssh://example.com/bzr/foo
 
5007
        bzr break-lock --conf ~/.bazaar
4818
5008
    """
 
5009
 
4819
5010
    takes_args = ['location?']
 
5011
    takes_options = [
 
5012
        Option('config',
 
5013
               help='LOCATION is the directory where the config lock is.'),
 
5014
        Option('force',
 
5015
            help='Do not ask for confirmation before breaking the lock.'),
 
5016
        ]
4820
5017
 
4821
 
    def run(self, location=None, show=False):
 
5018
    def run(self, location=None, config=False, force=False):
4822
5019
        if location is None:
4823
5020
            location = u'.'
4824
 
        control, relpath = bzrdir.BzrDir.open_containing(location)
4825
 
        try:
4826
 
            control.break_lock()
4827
 
        except NotImplementedError:
4828
 
            pass
 
5021
        if force:
 
5022
            ui.ui_factory = ui.ConfirmationUserInterfacePolicy(ui.ui_factory,
 
5023
                None,
 
5024
                {'bzrlib.lockdir.break': True})
 
5025
        if config:
 
5026
            conf = _mod_config.LockableConfig(file_name=location)
 
5027
            conf.break_lock()
 
5028
        else:
 
5029
            control, relpath = bzrdir.BzrDir.open_containing(location)
 
5030
            try:
 
5031
                control.break_lock()
 
5032
            except NotImplementedError:
 
5033
                pass
4829
5034
 
4830
5035
 
4831
5036
class cmd_wait_until_signalled(Command):
4860
5065
                    'result in a dynamically allocated port.  The default port '
4861
5066
                    'depends on the protocol.',
4862
5067
               type=str),
4863
 
        Option('directory',
4864
 
               help='Serve contents of this directory.',
4865
 
               type=unicode),
 
5068
        custom_help('directory',
 
5069
               help='Serve contents of this directory.'),
4866
5070
        Option('allow-writes',
4867
5071
               help='By default the server is a readonly server.  Supplying '
4868
5072
                    '--allow-writes enables write access to the contents of '
4895
5099
 
4896
5100
    def run(self, port=None, inet=False, directory=None, allow_writes=False,
4897
5101
            protocol=None):
4898
 
        from bzrlib.transport import get_transport, transport_server_registry
 
5102
        from bzrlib import transport
4899
5103
        if directory is None:
4900
5104
            directory = os.getcwd()
4901
5105
        if protocol is None:
4902
 
            protocol = transport_server_registry.get()
 
5106
            protocol = transport.transport_server_registry.get()
4903
5107
        host, port = self.get_host_and_port(port)
4904
5108
        url = urlutils.local_path_to_url(directory)
4905
5109
        if not allow_writes:
4906
5110
            url = 'readonly+' + url
4907
 
        transport = get_transport(url)
4908
 
        protocol(transport, host, port, inet)
 
5111
        t = transport.get_transport(url)
 
5112
        protocol(t, host, port, inet)
4909
5113
 
4910
5114
 
4911
5115
class cmd_join(Command):
4917
5121
    not part of it.  (Such trees can be produced by "bzr split", but also by
4918
5122
    running "bzr branch" with the target inside a tree.)
4919
5123
 
4920
 
    The result is a combined tree, with the subtree no longer an independant
 
5124
    The result is a combined tree, with the subtree no longer an independent
4921
5125
    part.  This is marked as a merge of the subtree into the containing tree,
4922
5126
    and all history is preserved.
4923
5127
    """
5004
5208
    _see_also = ['send']
5005
5209
 
5006
5210
    takes_options = [
 
5211
        'directory',
5007
5212
        RegistryOption.from_kwargs('patch-type',
5008
5213
            'The type of patch to include in the directive.',
5009
5214
            title='Patch type',
5022
5227
    encoding_type = 'exact'
5023
5228
 
5024
5229
    def run(self, submit_branch=None, public_branch=None, patch_type='bundle',
5025
 
            sign=False, revision=None, mail_to=None, message=None):
 
5230
            sign=False, revision=None, mail_to=None, message=None,
 
5231
            directory=u'.'):
5026
5232
        from bzrlib.revision import ensure_null, NULL_REVISION
5027
5233
        include_patch, include_bundle = {
5028
5234
            'plain': (False, False),
5029
5235
            'diff': (True, False),
5030
5236
            'bundle': (True, True),
5031
5237
            }[patch_type]
5032
 
        branch = Branch.open('.')
 
5238
        branch = Branch.open(directory)
5033
5239
        stored_submit_branch = branch.get_submit_branch()
5034
5240
        if submit_branch is None:
5035
5241
            submit_branch = stored_submit_branch
5111
5317
    source branch defaults to that containing the working directory, but can
5112
5318
    be changed using --from.
5113
5319
 
 
5320
    Both the submit branch and the public branch follow the usual behavior with
 
5321
    respect to --remember: If there is no default location set, the first send
 
5322
    will set it (use --no-remember to avoid settting it). After that, you can
 
5323
    omit the location to use the default.  To change the default, use
 
5324
    --remember. The value will only be saved if the location can be accessed.
 
5325
 
5114
5326
    In order to calculate those changes, bzr must analyse the submit branch.
5115
5327
    Therefore it is most efficient for the submit branch to be a local mirror.
5116
5328
    If a public location is known for the submit_branch, that location is used
5120
5332
    given, in which case it is sent to a file.
5121
5333
 
5122
5334
    Mail is sent using your preferred mail program.  This should be transparent
5123
 
    on Windows (it uses MAPI).  On Linux, it requires the xdg-email utility.
 
5335
    on Windows (it uses MAPI).  On Unix, it requires the xdg-email utility.
5124
5336
    If the preferred client can't be found (or used), your editor will be used.
5125
5337
 
5126
5338
    To use a specific mail program, set the mail_client configuration option.
5185
5397
        ]
5186
5398
 
5187
5399
    def run(self, submit_branch=None, public_branch=None, no_bundle=False,
5188
 
            no_patch=False, revision=None, remember=False, output=None,
 
5400
            no_patch=False, revision=None, remember=None, output=None,
5189
5401
            format=None, mail_to=None, message=None, body=None,
5190
5402
            strict=None, **kwargs):
5191
5403
        from bzrlib.send import send
5297
5509
        Option('delete',
5298
5510
            help='Delete this tag rather than placing it.',
5299
5511
            ),
5300
 
        Option('directory',
5301
 
            help='Branch in which to place the tag.',
5302
 
            short_name='d',
5303
 
            type=unicode,
5304
 
            ),
 
5512
        custom_help('directory',
 
5513
            help='Branch in which to place the tag.'),
5305
5514
        Option('force',
5306
5515
            help='Replace existing tags.',
5307
5516
            ),
5320
5529
            if tag_name is None:
5321
5530
                raise errors.BzrCommandError("No tag specified to delete.")
5322
5531
            branch.tags.delete_tag(tag_name)
5323
 
            self.outf.write('Deleted tag %s.\n' % tag_name)
 
5532
            note('Deleted tag %s.' % tag_name)
5324
5533
        else:
5325
5534
            if revision:
5326
5535
                if len(revision) != 1:
5338
5547
            if (not force) and branch.tags.has_tag(tag_name):
5339
5548
                raise errors.TagAlreadyExists(tag_name)
5340
5549
            branch.tags.set_tag(tag_name, revision_id)
5341
 
            self.outf.write('Created tag %s.\n' % tag_name)
 
5550
            note('Created tag %s.' % tag_name)
5342
5551
 
5343
5552
 
5344
5553
class cmd_tags(Command):
5349
5558
 
5350
5559
    _see_also = ['tag']
5351
5560
    takes_options = [
5352
 
        Option('directory',
5353
 
            help='Branch whose tags should be displayed.',
5354
 
            short_name='d',
5355
 
            type=unicode,
5356
 
            ),
5357
 
        RegistryOption.from_kwargs('sort',
 
5561
        custom_help('directory',
 
5562
            help='Branch whose tags should be displayed.'),
 
5563
        RegistryOption('sort',
5358
5564
            'Sort tags by different criteria.', title='Sorting',
5359
 
            alpha='Sort tags lexicographically (default).',
5360
 
            time='Sort tags chronologically.',
 
5565
            lazy_registry=('bzrlib.tag', 'tag_sort_methods')
5361
5566
            ),
5362
5567
        'show-ids',
5363
5568
        'revision',
5364
5569
    ]
5365
5570
 
5366
5571
    @display_command
5367
 
    def run(self,
5368
 
            directory='.',
5369
 
            sort='alpha',
5370
 
            show_ids=False,
5371
 
            revision=None,
5372
 
            ):
 
5572
    def run(self, directory='.', sort=None, show_ids=False, revision=None):
 
5573
        from bzrlib.tag import tag_sort_methods
5373
5574
        branch, relpath = Branch.open_containing(directory)
5374
5575
 
5375
5576
        tags = branch.tags.get_tag_dict().items()
5384
5585
            # only show revisions between revid1 and revid2 (inclusive)
5385
5586
            tags = [(tag, revid) for tag, revid in tags if
5386
5587
                graph.is_between(revid, revid1, revid2)]
5387
 
        if sort == 'alpha':
5388
 
            tags.sort()
5389
 
        elif sort == 'time':
5390
 
            timestamps = {}
5391
 
            for tag, revid in tags:
5392
 
                try:
5393
 
                    revobj = branch.repository.get_revision(revid)
5394
 
                except errors.NoSuchRevision:
5395
 
                    timestamp = sys.maxint # place them at the end
5396
 
                else:
5397
 
                    timestamp = revobj.timestamp
5398
 
                timestamps[revid] = timestamp
5399
 
            tags.sort(key=lambda x: timestamps[x[1]])
 
5588
        if sort is None:
 
5589
            sort = tag_sort_methods.get()
 
5590
        sort(branch, tags)
5400
5591
        if not show_ids:
5401
5592
            # [ (tag, revid), ... ] -> [ (tag, dotted_revno), ... ]
5402
5593
            for index, (tag, revid) in enumerate(tags):
5404
5595
                    revno = branch.revision_id_to_dotted_revno(revid)
5405
5596
                    if isinstance(revno, tuple):
5406
5597
                        revno = '.'.join(map(str, revno))
5407
 
                except errors.NoSuchRevision:
 
5598
                except (errors.NoSuchRevision, errors.GhostRevisionsHaveNoRevno):
5408
5599
                    # Bad tag data/merges can lead to tagged revisions
5409
5600
                    # which are not in this branch. Fail gracefully ...
5410
5601
                    revno = '?'
5468
5659
            unstacked=None):
5469
5660
        directory = bzrdir.BzrDir.open(location)
5470
5661
        if stacked_on and unstacked:
5471
 
            raise BzrCommandError("Can't use both --stacked-on and --unstacked")
 
5662
            raise errors.BzrCommandError("Can't use both --stacked-on and --unstacked")
5472
5663
        elif stacked_on is not None:
5473
5664
            reconfigure.ReconfigureStackedOn().apply(directory, stacked_on)
5474
5665
        elif unstacked:
5529
5720
    """
5530
5721
 
5531
5722
    takes_args = ['to_location?']
5532
 
    takes_options = [Option('force',
 
5723
    takes_options = ['directory',
 
5724
                     Option('force',
5533
5725
                        help='Switch even if local commits will be lost.'),
5534
5726
                     'revision',
5535
5727
                     Option('create-branch', short_name='b',
5538
5730
                    ]
5539
5731
 
5540
5732
    def run(self, to_location=None, force=False, create_branch=False,
5541
 
            revision=None):
 
5733
            revision=None, directory=u'.'):
5542
5734
        from bzrlib import switch
5543
 
        tree_location = '.'
 
5735
        tree_location = directory
5544
5736
        revision = _get_one_revision('switch', revision)
5545
5737
        control_dir = bzrdir.BzrDir.open_containing(tree_location)[0]
5546
5738
        if to_location is None:
5547
5739
            if revision is None:
5548
5740
                raise errors.BzrCommandError('You must supply either a'
5549
5741
                                             ' revision or a location')
5550
 
            to_location = '.'
 
5742
            to_location = tree_location
5551
5743
        try:
5552
5744
            branch = control_dir.open_branch()
5553
5745
            had_explicit_nick = branch.get_config().has_explicit_nickname()
5688
5880
            name=None,
5689
5881
            switch=None,
5690
5882
            ):
5691
 
        tree, file_list = tree_files(file_list, apply_view=False)
 
5883
        tree, file_list = WorkingTree.open_containing_paths(file_list,
 
5884
            apply_view=False)
5692
5885
        current_view, view_dict = tree.views.get_view_info()
5693
5886
        if name is None:
5694
5887
            name = current_view
5798
5991
            location = "."
5799
5992
        branch = Branch.open_containing(location)[0]
5800
5993
        branch.bzrdir.destroy_branch()
5801
 
        
 
5994
 
5802
5995
 
5803
5996
class cmd_shelve(Command):
5804
5997
    __doc__ = """Temporarily set aside some changes from the current tree.
5823
6016
 
5824
6017
    You can put multiple items on the shelf, and by default, 'unshelve' will
5825
6018
    restore the most recently shelved changes.
 
6019
 
 
6020
    For complicated changes, it is possible to edit the changes in a separate
 
6021
    editor program to decide what the file remaining in the working copy
 
6022
    should look like.  To do this, add the configuration option
 
6023
 
 
6024
        change_editor = PROGRAM @new_path @old_path
 
6025
 
 
6026
    where @new_path is replaced with the path of the new version of the 
 
6027
    file and @old_path is replaced with the path of the old version of 
 
6028
    the file.  The PROGRAM should save the new file with the desired 
 
6029
    contents of the file in the working tree.
 
6030
        
5826
6031
    """
5827
6032
 
5828
6033
    takes_args = ['file*']
5829
6034
 
5830
6035
    takes_options = [
 
6036
        'directory',
5831
6037
        'revision',
5832
6038
        Option('all', help='Shelve all changes.'),
5833
6039
        'message',
5839
6045
        Option('destroy',
5840
6046
               help='Destroy removed changes instead of shelving them.'),
5841
6047
    ]
5842
 
    _see_also = ['unshelve']
 
6048
    _see_also = ['unshelve', 'configuration']
5843
6049
 
5844
6050
    def run(self, revision=None, all=False, file_list=None, message=None,
5845
 
            writer=None, list=False, destroy=False):
 
6051
            writer=None, list=False, destroy=False, directory=None):
5846
6052
        if list:
5847
 
            return self.run_for_list()
 
6053
            return self.run_for_list(directory=directory)
5848
6054
        from bzrlib.shelf_ui import Shelver
5849
6055
        if writer is None:
5850
6056
            writer = bzrlib.option.diff_writer_registry.get()
5851
6057
        try:
5852
6058
            shelver = Shelver.from_args(writer(sys.stdout), revision, all,
5853
 
                file_list, message, destroy=destroy)
 
6059
                file_list, message, destroy=destroy, directory=directory)
5854
6060
            try:
5855
6061
                shelver.run()
5856
6062
            finally:
5858
6064
        except errors.UserAbort:
5859
6065
            return 0
5860
6066
 
5861
 
    def run_for_list(self):
5862
 
        tree = WorkingTree.open_containing('.')[0]
 
6067
    def run_for_list(self, directory=None):
 
6068
        if directory is None:
 
6069
            directory = u'.'
 
6070
        tree = WorkingTree.open_containing(directory)[0]
5863
6071
        self.add_cleanup(tree.lock_read().unlock)
5864
6072
        manager = tree.get_shelf_manager()
5865
6073
        shelves = manager.active_shelves()
5884
6092
 
5885
6093
    takes_args = ['shelf_id?']
5886
6094
    takes_options = [
 
6095
        'directory',
5887
6096
        RegistryOption.from_kwargs(
5888
6097
            'action', help="The action to perform.",
5889
6098
            enum_switch=False, value_switches=True,
5897
6106
    ]
5898
6107
    _see_also = ['shelve']
5899
6108
 
5900
 
    def run(self, shelf_id=None, action='apply'):
 
6109
    def run(self, shelf_id=None, action='apply', directory=u'.'):
5901
6110
        from bzrlib.shelf_ui import Unshelver
5902
 
        unshelver = Unshelver.from_args(shelf_id, action)
 
6111
        unshelver = Unshelver.from_args(shelf_id, action, directory=directory)
5903
6112
        try:
5904
6113
            unshelver.run()
5905
6114
        finally:
5921
6130
 
5922
6131
    To check what clean-tree will do, use --dry-run.
5923
6132
    """
5924
 
    takes_options = [Option('ignored', help='Delete all ignored files.'),
5925
 
                     Option('detritus', help='Delete conflict files, merge'
 
6133
    takes_options = ['directory',
 
6134
                     Option('ignored', help='Delete all ignored files.'),
 
6135
                     Option('detritus', help='Delete conflict files, merge and revert'
5926
6136
                            ' backups, and failed selftest dirs.'),
5927
6137
                     Option('unknown',
5928
6138
                            help='Delete files unknown to bzr (default).'),
5930
6140
                            ' deleting them.'),
5931
6141
                     Option('force', help='Do not prompt before deleting.')]
5932
6142
    def run(self, unknown=False, ignored=False, detritus=False, dry_run=False,
5933
 
            force=False):
 
6143
            force=False, directory=u'.'):
5934
6144
        from bzrlib.clean_tree import clean_tree
5935
6145
        if not (unknown or ignored or detritus):
5936
6146
            unknown = True
5937
6147
        if dry_run:
5938
6148
            force = True
5939
 
        clean_tree('.', unknown=unknown, ignored=ignored, detritus=detritus,
5940
 
                   dry_run=dry_run, no_prompt=force)
 
6149
        clean_tree(directory, unknown=unknown, ignored=ignored,
 
6150
                   detritus=detritus, dry_run=dry_run, no_prompt=force)
5941
6151
 
5942
6152
 
5943
6153
class cmd_reference(Command):
5987
6197
            self.outf.write('%s %s\n' % (path, location))
5988
6198
 
5989
6199
 
 
6200
class cmd_export_pot(Command):
 
6201
    __doc__ = """Export command helps and error messages in po format."""
 
6202
 
 
6203
    hidden = True
 
6204
 
 
6205
    def run(self):
 
6206
        from bzrlib.export_pot import export_pot
 
6207
        export_pot(self.outf)
 
6208
 
 
6209
 
5990
6210
def _register_lazy_builtins():
5991
6211
    # register lazy builtins from other modules; called at startup and should
5992
6212
    # be only called once.
5993
6213
    for (name, aliases, module_name) in [
5994
6214
        ('cmd_bundle_info', [], 'bzrlib.bundle.commands'),
 
6215
        ('cmd_config', [], 'bzrlib.config'),
5995
6216
        ('cmd_dpush', [], 'bzrlib.foreign'),
5996
6217
        ('cmd_version_info', [], 'bzrlib.cmd_version_info'),
5997
6218
        ('cmd_resolve', ['resolved'], 'bzrlib.conflicts'),
5998
6219
        ('cmd_conflicts', [], 'bzrlib.conflicts'),
5999
6220
        ('cmd_sign_my_commits', [], 'bzrlib.sign_my_commits'),
 
6221
        ('cmd_test_script', [], 'bzrlib.cmd_test_script'),
6000
6222
        ]:
6001
6223
        builtin_command_registry.register_lazy(name, aliases, module_name)