/brz/remove-bazaar

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

« back to all changes in this revision

Viewing changes to bzrlib/builtins.py

  • Committer: Shannon Weyrick
  • Date: 2011-08-19 21:01:49 UTC
  • mto: This revision was merged to the branch mainline in revision 6086.
  • Revision ID: weyrick@mozek.us-20110819210149-7q4qqungeb3im9pq
Make it explicit in docs that large file skips happen only in recursive mode. Add test.

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,
52
50
    urlutils,
53
51
    views,
 
52
    gpg,
54
53
    )
55
54
from bzrlib.branch import Branch
56
55
from bzrlib.conflicts import ConflictList
73
72
    _parse_revision_str,
74
73
    )
75
74
from bzrlib.trace import mutter, note, warning, is_quiet, get_verbosity_level
76
 
 
77
 
 
 
75
from bzrlib import (
 
76
    symbol_versioning,
 
77
    )
 
78
 
 
79
 
 
80
@symbol_versioning.deprecated_function(symbol_versioning.deprecated_in((2, 3, 0)))
78
81
def tree_files(file_list, default_branch=u'.', canonicalize=True,
79
82
    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]))
 
83
    return internal_tree_files(file_list, default_branch, canonicalize,
 
84
        apply_view)
86
85
 
87
86
 
88
87
def tree_files_for_add(file_list):
152
151
 
153
152
# XXX: Bad function name; should possibly also be a class method of
154
153
# WorkingTree rather than a function.
 
154
@symbol_versioning.deprecated_function(symbol_versioning.deprecated_in((2, 3, 0)))
155
155
def internal_tree_files(file_list, default_branch=u'.', canonicalize=True,
156
156
    apply_view=True):
157
157
    """Convert command-line paths to a WorkingTree and relative paths.
158
158
 
 
159
    Deprecated: use WorkingTree.open_containing_paths instead.
 
160
 
159
161
    This is typically used for command-line processors that take one or
160
162
    more filenames, and infer the workingtree that contains them.
161
163
 
171
173
 
172
174
    :return: workingtree, [relative_paths]
173
175
    """
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
 
176
    return WorkingTree.open_containing_paths(
 
177
        file_list, default_directory='.',
 
178
        canonicalize=True,
 
179
        apply_view=True)
221
180
 
222
181
 
223
182
def _get_view_info_for_change_reporter(tree):
232
191
    return view_info
233
192
 
234
193
 
 
194
def _open_directory_or_containing_tree_or_branch(filename, directory):
 
195
    """Open the tree or branch containing the specified file, unless
 
196
    the --directory option is used to specify a different branch."""
 
197
    if directory is not None:
 
198
        return (None, Branch.open(directory), filename)
 
199
    return bzrdir.BzrDir.open_containing_tree_or_branch(filename)
 
200
 
 
201
 
235
202
# TODO: Make sure no commands unconditionally use the working directory as a
236
203
# branch.  If a filename argument is used, the first of them should be used to
237
204
# specify the branch.  (Perhaps this can be factored out into some kind of
265
232
    unknown
266
233
        Not versioned and not matching an ignore pattern.
267
234
 
268
 
    Additionally for directories, symlinks and files with an executable
269
 
    bit, Bazaar indicates their type using a trailing character: '/', '@'
270
 
    or '*' respectively.
 
235
    Additionally for directories, symlinks and files with a changed
 
236
    executable bit, Bazaar indicates their type using a trailing
 
237
    character: '/', '@' or '*' respectively. These decorations can be
 
238
    disabled using the '--no-classify' option.
271
239
 
272
240
    To see ignored files use 'bzr ignored'.  For details on the
273
241
    changes to file texts, use 'bzr diff'.
286
254
    To skip the display of pending merge information altogether, use
287
255
    the no-pending option or specify a file/directory.
288
256
 
289
 
    If a revision argument is given, the status is calculated against
290
 
    that revision, or between two revisions if two are provided.
 
257
    To compare the working directory to a specific revision, pass a
 
258
    single revision to the revision argument.
 
259
 
 
260
    To see which files have changed in a specific revision, or between
 
261
    two revisions, pass a revision range to the revision argument.
 
262
    This will produce the same results as calling 'bzr diff --summarize'.
291
263
    """
292
264
 
293
265
    # TODO: --no-recurse, --recurse options
300
272
                            short_name='V'),
301
273
                     Option('no-pending', help='Don\'t show pending merges.',
302
274
                           ),
 
275
                     Option('no-classify',
 
276
                            help='Do not mark object type using indicator.',
 
277
                           ),
303
278
                     ]
304
279
    aliases = ['st', 'stat']
305
280
 
308
283
 
309
284
    @display_command
310
285
    def run(self, show_ids=False, file_list=None, revision=None, short=False,
311
 
            versioned=False, no_pending=False, verbose=False):
 
286
            versioned=False, no_pending=False, verbose=False,
 
287
            no_classify=False):
312
288
        from bzrlib.status import show_tree_status
313
289
 
314
290
        if revision and len(revision) > 2:
315
291
            raise errors.BzrCommandError('bzr status --revision takes exactly'
316
292
                                         ' one or two revision specifiers')
317
293
 
318
 
        tree, relfile_list = tree_files(file_list)
 
294
        tree, relfile_list = WorkingTree.open_containing_paths(file_list)
319
295
        # Avoid asking for specific files when that is not needed.
320
296
        if relfile_list == ['']:
321
297
            relfile_list = None
328
304
        show_tree_status(tree, show_ids=show_ids,
329
305
                         specific_files=relfile_list, revision=revision,
330
306
                         to_file=self.outf, short=short, versioned=versioned,
331
 
                         show_pending=(not no_pending), verbose=verbose)
 
307
                         show_pending=(not no_pending), verbose=verbose,
 
308
                         classify=not no_classify)
332
309
 
333
310
 
334
311
class cmd_cat_revision(Command):
340
317
 
341
318
    hidden = True
342
319
    takes_args = ['revision_id?']
343
 
    takes_options = ['revision']
 
320
    takes_options = ['directory', 'revision']
344
321
    # cat-revision is more for frontends so should be exact
345
322
    encoding = 'strict'
346
323
 
353
330
        self.outf.write(revtext.decode('utf-8'))
354
331
 
355
332
    @display_command
356
 
    def run(self, revision_id=None, revision=None):
 
333
    def run(self, revision_id=None, revision=None, directory=u'.'):
357
334
        if revision_id is not None and revision is not None:
358
335
            raise errors.BzrCommandError('You can only supply one of'
359
336
                                         ' revision_id or --revision')
360
337
        if revision_id is None and revision is None:
361
338
            raise errors.BzrCommandError('You must supply either'
362
339
                                         ' --revision or a revision_id')
363
 
        b = WorkingTree.open_containing(u'.')[0].branch
 
340
 
 
341
        b = bzrdir.BzrDir.open_containing_tree_or_branch(directory)[1]
364
342
 
365
343
        revisions = b.repository.revisions
366
344
        if revisions is None:
444
422
                self.outf.write(page_bytes[:header_end])
445
423
                page_bytes = data
446
424
            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')
 
425
            if len(page_bytes) == 0:
 
426
                self.outf.write('(empty)\n');
 
427
            else:
 
428
                decomp_bytes = zlib.decompress(page_bytes)
 
429
                self.outf.write(decomp_bytes)
 
430
                self.outf.write('\n')
450
431
 
451
432
    def _dump_entries(self, trans, basename):
452
433
        try:
483
464
    takes_options = [
484
465
        Option('force',
485
466
               help='Remove the working tree even if it has '
486
 
                    'uncommitted changes.'),
 
467
                    'uncommitted or shelved changes.'),
487
468
        ]
488
469
 
489
470
    def run(self, location_list, force=False):
503
484
            if not force:
504
485
                if (working.has_changes()):
505
486
                    raise errors.UncommittedChanges(working)
 
487
                if working.get_shelf_manager().last_shelf() is not None:
 
488
                    raise errors.ShelvedChanges(working)
506
489
 
507
490
            if working.user_url != working.branch.user_url:
508
491
                raise errors.BzrCommandError("You cannot remove the working tree"
511
494
            d.destroy_workingtree()
512
495
 
513
496
 
 
497
class cmd_repair_workingtree(Command):
 
498
    __doc__ = """Reset the working tree state file.
 
499
 
 
500
    This is not meant to be used normally, but more as a way to recover from
 
501
    filesystem corruption, etc. This rebuilds the working inventory back to a
 
502
    'known good' state. Any new modifications (adding a file, renaming, etc)
 
503
    will be lost, though modified files will still be detected as such.
 
504
 
 
505
    Most users will want something more like "bzr revert" or "bzr update"
 
506
    unless the state file has become corrupted.
 
507
 
 
508
    By default this attempts to recover the current state by looking at the
 
509
    headers of the state file. If the state file is too corrupted to even do
 
510
    that, you can supply --revision to force the state of the tree.
 
511
    """
 
512
 
 
513
    takes_options = ['revision', 'directory',
 
514
        Option('force',
 
515
               help='Reset the tree even if it doesn\'t appear to be'
 
516
                    ' corrupted.'),
 
517
    ]
 
518
    hidden = True
 
519
 
 
520
    def run(self, revision=None, directory='.', force=False):
 
521
        tree, _ = WorkingTree.open_containing(directory)
 
522
        self.add_cleanup(tree.lock_tree_write().unlock)
 
523
        if not force:
 
524
            try:
 
525
                tree.check_state()
 
526
            except errors.BzrError:
 
527
                pass # There seems to be a real error here, so we'll reset
 
528
            else:
 
529
                # Refuse
 
530
                raise errors.BzrCommandError(
 
531
                    'The tree does not appear to be corrupt. You probably'
 
532
                    ' want "bzr revert" instead. Use "--force" if you are'
 
533
                    ' sure you want to reset the working tree.')
 
534
        if revision is None:
 
535
            revision_ids = None
 
536
        else:
 
537
            revision_ids = [r.as_revision_id(tree.branch) for r in revision]
 
538
        try:
 
539
            tree.reset_state(revision_ids)
 
540
        except errors.BzrError, e:
 
541
            if revision_ids is None:
 
542
                extra = (', the header appears corrupt, try passing -r -1'
 
543
                         ' to set the state to the last commit')
 
544
            else:
 
545
                extra = ''
 
546
            raise errors.BzrCommandError('failed to reset the tree state'
 
547
                                         + extra)
 
548
 
 
549
 
514
550
class cmd_revno(Command):
515
551
    __doc__ = """Show current revision number.
516
552
 
528
564
        if tree:
529
565
            try:
530
566
                wt = WorkingTree.open_containing(location)[0]
531
 
                wt.lock_read()
 
567
                self.add_cleanup(wt.lock_read().unlock)
532
568
            except (errors.NoWorkingTree, errors.NotLocalUrl):
533
569
                raise errors.NoWorkingTree(location)
534
 
            self.add_cleanup(wt.unlock)
535
570
            revid = wt.last_revision()
536
571
            try:
537
572
                revno_t = wt.branch.revision_id_to_dotted_revno(revid)
540
575
            revno = ".".join(str(n) for n in revno_t)
541
576
        else:
542
577
            b = Branch.open_containing(location)[0]
543
 
            b.lock_read()
544
 
            self.add_cleanup(b.unlock)
 
578
            self.add_cleanup(b.lock_read().unlock)
545
579
            revno = b.revno()
546
580
        self.cleanup_now()
547
581
        self.outf.write(str(revno) + '\n')
554
588
    takes_args = ['revision_info*']
555
589
    takes_options = [
556
590
        'revision',
557
 
        Option('directory',
 
591
        custom_help('directory',
558
592
            help='Branch to examine, '
559
 
                 'rather than the one containing the working directory.',
560
 
            short_name='d',
561
 
            type=unicode,
562
 
            ),
 
593
                 'rather than the one containing the working directory.'),
563
594
        Option('tree', help='Show revno of working tree'),
564
595
        ]
565
596
 
570
601
        try:
571
602
            wt = WorkingTree.open_containing(directory)[0]
572
603
            b = wt.branch
573
 
            wt.lock_read()
574
 
            self.add_cleanup(wt.unlock)
 
604
            self.add_cleanup(wt.lock_read().unlock)
575
605
        except (errors.NoWorkingTree, errors.NotLocalUrl):
576
606
            wt = None
577
607
            b = Branch.open_containing(directory)[0]
578
 
            b.lock_read()
579
 
            self.add_cleanup(b.unlock)
 
608
            self.add_cleanup(b.lock_read().unlock)
580
609
        revision_ids = []
581
610
        if revision is not None:
582
611
            revision_ids.extend(rev.as_revision_id(b) for rev in revision)
645
674
    
646
675
    Any files matching patterns in the ignore list will not be added
647
676
    unless they are explicitly mentioned.
 
677
    
 
678
    In recursive mode, files larger than the configuration option 
 
679
    add.maximum_file_size will be skipped. Named items are never skipped due
 
680
    to file size.
648
681
    """
649
682
    takes_args = ['file*']
650
683
    takes_options = [
677
710
            action = bzrlib.add.AddFromBaseAction(base_tree, base_path,
678
711
                          to_file=self.outf, should_print=(not is_quiet()))
679
712
        else:
680
 
            action = bzrlib.add.AddAction(to_file=self.outf,
 
713
            action = bzrlib.add.AddWithSkipLargeAction(to_file=self.outf,
681
714
                should_print=(not is_quiet()))
682
715
 
683
716
        if base_tree:
684
 
            base_tree.lock_read()
685
 
            self.add_cleanup(base_tree.unlock)
 
717
            self.add_cleanup(base_tree.lock_read().unlock)
686
718
        tree, file_list = tree_files_for_add(file_list)
687
719
        added, ignored = tree.smart_add(file_list, not
688
720
            no_recurse, action=action, save=not dry_run)
759
791
            raise errors.BzrCommandError('invalid kind %r specified' % (kind,))
760
792
 
761
793
        revision = _get_one_revision('inventory', revision)
762
 
        work_tree, file_list = tree_files(file_list)
763
 
        work_tree.lock_read()
764
 
        self.add_cleanup(work_tree.unlock)
 
794
        work_tree, file_list = WorkingTree.open_containing_paths(file_list)
 
795
        self.add_cleanup(work_tree.lock_read().unlock)
765
796
        if revision is not None:
766
797
            tree = revision.as_tree(work_tree.branch)
767
798
 
768
799
            extra_trees = [work_tree]
769
 
            tree.lock_read()
770
 
            self.add_cleanup(tree.unlock)
 
800
            self.add_cleanup(tree.lock_read().unlock)
771
801
        else:
772
802
            tree = work_tree
773
803
            extra_trees = []
777
807
                                      require_versioned=True)
778
808
            # find_ids_across_trees may include some paths that don't
779
809
            # exist in 'tree'.
780
 
            entries = sorted((tree.id2path(file_id), tree.inventory[file_id])
781
 
                             for file_id in file_ids if file_id in tree)
 
810
            entries = sorted(
 
811
                (tree.id2path(file_id), tree.inventory[file_id])
 
812
                for file_id in file_ids if tree.has_id(file_id))
782
813
        else:
783
814
            entries = tree.inventory.entries()
784
815
 
832
863
            names_list = []
833
864
        if len(names_list) < 2:
834
865
            raise errors.BzrCommandError("missing file argument")
835
 
        tree, rel_names = tree_files(names_list, canonicalize=False)
836
 
        tree.lock_tree_write()
837
 
        self.add_cleanup(tree.unlock)
 
866
        tree, rel_names = WorkingTree.open_containing_paths(names_list, canonicalize=False)
 
867
        self.add_cleanup(tree.lock_tree_write().unlock)
838
868
        self._run(tree, names_list, rel_names, after)
839
869
 
840
870
    def run_auto(self, names_list, after, dry_run):
844
874
        if after:
845
875
            raise errors.BzrCommandError('--after cannot be specified with'
846
876
                                         ' --auto.')
847
 
        work_tree, file_list = tree_files(names_list, default_branch='.')
848
 
        work_tree.lock_tree_write()
849
 
        self.add_cleanup(work_tree.unlock)
 
877
        work_tree, file_list = WorkingTree.open_containing_paths(
 
878
            names_list, default_directory='.')
 
879
        self.add_cleanup(work_tree.lock_tree_write().unlock)
850
880
        rename_map.RenameMap.guess_renames(work_tree, dry_run)
851
881
 
852
882
    def _run(self, tree, names_list, rel_names, after):
946
976
    match the remote one, use pull --overwrite. This will work even if the two
947
977
    branches have diverged.
948
978
 
949
 
    If there is no default location set, the first pull will set it.  After
950
 
    that, you can omit the location to use the default.  To change the
951
 
    default, use --remember. The value will only be saved if the remote
952
 
    location can be accessed.
 
979
    If there is no default location set, the first pull will set it (use
 
980
    --no-remember to avoid settting it). After that, you can omit the
 
981
    location to use the default.  To change the default, use --remember. The
 
982
    value will only be saved if the remote location can be accessed.
953
983
 
954
984
    Note: The location can be specified either in the form of a branch,
955
985
    or in the form of a path to a file containing a merge directive generated
960
990
    takes_options = ['remember', 'overwrite', 'revision',
961
991
        custom_help('verbose',
962
992
            help='Show logs of pulled revisions.'),
963
 
        Option('directory',
 
993
        custom_help('directory',
964
994
            help='Branch to pull into, '
965
 
                 'rather than the one containing the working directory.',
966
 
            short_name='d',
967
 
            type=unicode,
968
 
            ),
 
995
                 'rather than the one containing the working directory.'),
969
996
        Option('local',
970
997
            help="Perform a local pull in a bound "
971
998
                 "branch.  Local pulls are not applied to "
972
999
                 "the master branch."
973
1000
            ),
 
1001
        Option('show-base',
 
1002
            help="Show base revision text in conflicts.")
974
1003
        ]
975
1004
    takes_args = ['location?']
976
1005
    encoding_type = 'replace'
977
1006
 
978
 
    def run(self, location=None, remember=False, overwrite=False,
 
1007
    def run(self, location=None, remember=None, overwrite=False,
979
1008
            revision=None, verbose=False,
980
 
            directory=None, local=False):
 
1009
            directory=None, local=False,
 
1010
            show_base=False):
981
1011
        # FIXME: too much stuff is in the command class
982
1012
        revision_id = None
983
1013
        mergeable = None
986
1016
        try:
987
1017
            tree_to = WorkingTree.open_containing(directory)[0]
988
1018
            branch_to = tree_to.branch
989
 
            tree_to.lock_write()
990
 
            self.add_cleanup(tree_to.unlock)
 
1019
            self.add_cleanup(tree_to.lock_write().unlock)
991
1020
        except errors.NoWorkingTree:
992
1021
            tree_to = None
993
1022
            branch_to = Branch.open_containing(directory)[0]
994
 
            branch_to.lock_write()
995
 
            self.add_cleanup(branch_to.unlock)
 
1023
            self.add_cleanup(branch_to.lock_write().unlock)
 
1024
 
 
1025
        if tree_to is None and show_base:
 
1026
            raise errors.BzrCommandError("Need working tree for --show-base.")
996
1027
 
997
1028
        if local and not branch_to.get_bound_location():
998
1029
            raise errors.LocalRequiresBoundBranch()
1029
1060
        else:
1030
1061
            branch_from = Branch.open(location,
1031
1062
                possible_transports=possible_transports)
1032
 
            branch_from.lock_read()
1033
 
            self.add_cleanup(branch_from.unlock)
1034
 
 
1035
 
            if branch_to.get_parent() is None or remember:
 
1063
            self.add_cleanup(branch_from.lock_read().unlock)
 
1064
            # Remembers if asked explicitly or no previous location is set
 
1065
            if (remember
 
1066
                or (remember is None and branch_to.get_parent() is None)):
1036
1067
                branch_to.set_parent(branch_from.base)
1037
1068
 
1038
1069
        if revision is not None:
1045
1076
                view_info=view_info)
1046
1077
            result = tree_to.pull(
1047
1078
                branch_from, overwrite, revision_id, change_reporter,
1048
 
                possible_transports=possible_transports, local=local)
 
1079
                possible_transports=possible_transports, local=local,
 
1080
                show_base=show_base)
1049
1081
        else:
1050
1082
            result = branch_to.pull(
1051
1083
                branch_from, overwrite, revision_id, local=local)
1055
1087
            log.show_branch_change(
1056
1088
                branch_to, self.outf, result.old_revno,
1057
1089
                result.old_revid)
 
1090
        if getattr(result, 'tag_conflicts', None):
 
1091
            return 1
 
1092
        else:
 
1093
            return 0
1058
1094
 
1059
1095
 
1060
1096
class cmd_push(Command):
1077
1113
    do a merge (see bzr help merge) from the other branch, and commit that.
1078
1114
    After that you will be able to do a push without '--overwrite'.
1079
1115
 
1080
 
    If there is no default push location set, the first push will set it.
1081
 
    After that, you can omit the location to use the default.  To change the
1082
 
    default, use --remember. The value will only be saved if the remote
1083
 
    location can be accessed.
 
1116
    If there is no default push location set, the first push will set it (use
 
1117
    --no-remember to avoid settting it).  After that, you can omit the
 
1118
    location to use the default.  To change the default, use --remember. The
 
1119
    value will only be saved if the remote location can be accessed.
1084
1120
    """
1085
1121
 
1086
1122
    _see_also = ['pull', 'update', 'working-trees']
1088
1124
        Option('create-prefix',
1089
1125
               help='Create the path leading up to the branch '
1090
1126
                    'if it does not already exist.'),
1091
 
        Option('directory',
 
1127
        custom_help('directory',
1092
1128
            help='Branch to push from, '
1093
 
                 'rather than the one containing the working directory.',
1094
 
            short_name='d',
1095
 
            type=unicode,
1096
 
            ),
 
1129
                 'rather than the one containing the working directory.'),
1097
1130
        Option('use-existing-dir',
1098
1131
               help='By default push will fail if the target'
1099
1132
                    ' directory exists, but does not already'
1110
1143
        Option('strict',
1111
1144
               help='Refuse to push if there are uncommitted changes in'
1112
1145
               ' the working tree, --no-strict disables the check.'),
 
1146
        Option('no-tree',
 
1147
               help="Don't populate the working tree, even for protocols"
 
1148
               " that support it."),
1113
1149
        ]
1114
1150
    takes_args = ['location?']
1115
1151
    encoding_type = 'replace'
1116
1152
 
1117
 
    def run(self, location=None, remember=False, overwrite=False,
 
1153
    def run(self, location=None, remember=None, overwrite=False,
1118
1154
        create_prefix=False, verbose=False, revision=None,
1119
1155
        use_existing_dir=False, directory=None, stacked_on=None,
1120
 
        stacked=False, strict=None):
 
1156
        stacked=False, strict=None, no_tree=False):
1121
1157
        from bzrlib.push import _show_push_branch
1122
1158
 
1123
1159
        if directory is None:
1169
1205
        _show_push_branch(br_from, revision_id, location, self.outf,
1170
1206
            verbose=verbose, overwrite=overwrite, remember=remember,
1171
1207
            stacked_on=stacked_on, create_prefix=create_prefix,
1172
 
            use_existing_dir=use_existing_dir)
 
1208
            use_existing_dir=use_existing_dir, no_tree=no_tree)
1173
1209
 
1174
1210
 
1175
1211
class cmd_branch(Command):
1184
1220
 
1185
1221
    To retrieve the branch as of a particular revision, supply the --revision
1186
1222
    parameter, as in "branch foo/bar -r 5".
 
1223
 
 
1224
    The synonyms 'clone' and 'get' for this command are deprecated.
1187
1225
    """
1188
1226
 
1189
1227
    _see_also = ['checkout']
1190
1228
    takes_args = ['from_location', 'to_location?']
1191
 
    takes_options = ['revision', Option('hardlink',
1192
 
        help='Hard-link working tree files where possible.'),
 
1229
    takes_options = ['revision',
 
1230
        Option('hardlink', help='Hard-link working tree files where possible.'),
 
1231
        Option('files-from', type=str,
 
1232
               help="Get file contents from this tree."),
1193
1233
        Option('no-tree',
1194
1234
            help="Create a branch without a working-tree."),
1195
1235
        Option('switch',
1213
1253
 
1214
1254
    def run(self, from_location, to_location=None, revision=None,
1215
1255
            hardlink=False, stacked=False, standalone=False, no_tree=False,
1216
 
            use_existing_dir=False, switch=False, bind=False):
 
1256
            use_existing_dir=False, switch=False, bind=False,
 
1257
            files_from=None):
1217
1258
        from bzrlib import switch as _mod_switch
1218
1259
        from bzrlib.tag import _merge_tags_if_possible
 
1260
        if self.invoked_as in ['get', 'clone']:
 
1261
            ui.ui_factory.show_user_warning(
 
1262
                'deprecated_command',
 
1263
                deprecated_name=self.invoked_as,
 
1264
                recommended_name='branch',
 
1265
                deprecated_in_version='2.4')
1219
1266
        accelerator_tree, br_from = bzrdir.BzrDir.open_tree_or_branch(
1220
1267
            from_location)
 
1268
        if not (hardlink or files_from):
 
1269
            # accelerator_tree is usually slower because you have to read N
 
1270
            # files (no readahead, lots of seeks, etc), but allow the user to
 
1271
            # explicitly request it
 
1272
            accelerator_tree = None
 
1273
        if files_from is not None and files_from != from_location:
 
1274
            accelerator_tree = WorkingTree.open(files_from)
1221
1275
        revision = _get_one_revision('branch', revision)
1222
 
        br_from.lock_read()
1223
 
        self.add_cleanup(br_from.unlock)
 
1276
        self.add_cleanup(br_from.lock_read().unlock)
1224
1277
        if revision is not None:
1225
1278
            revision_id = revision.as_revision_id(br_from)
1226
1279
        else:
1331
1384
            to_location = branch_location
1332
1385
        accelerator_tree, source = bzrdir.BzrDir.open_tree_or_branch(
1333
1386
            branch_location)
 
1387
        if not (hardlink or files_from):
 
1388
            # accelerator_tree is usually slower because you have to read N
 
1389
            # files (no readahead, lots of seeks, etc), but allow the user to
 
1390
            # explicitly request it
 
1391
            accelerator_tree = None
1334
1392
        revision = _get_one_revision('checkout', revision)
1335
 
        if files_from is not None:
 
1393
        if files_from is not None and files_from != branch_location:
1336
1394
            accelerator_tree = WorkingTree.open(files_from)
1337
1395
        if revision is not None:
1338
1396
            revision_id = revision.as_revision_id(source)
1366
1424
    @display_command
1367
1425
    def run(self, dir=u'.'):
1368
1426
        tree = WorkingTree.open_containing(dir)[0]
1369
 
        tree.lock_read()
1370
 
        self.add_cleanup(tree.unlock)
 
1427
        self.add_cleanup(tree.lock_read().unlock)
1371
1428
        new_inv = tree.inventory
1372
1429
        old_tree = tree.basis_tree()
1373
 
        old_tree.lock_read()
1374
 
        self.add_cleanup(old_tree.unlock)
 
1430
        self.add_cleanup(old_tree.lock_read().unlock)
1375
1431
        old_inv = old_tree.inventory
1376
1432
        renames = []
1377
1433
        iterator = tree.iter_changes(old_tree, include_unchanged=True)
1396
1452
    If you want to discard your local changes, you can just do a
1397
1453
    'bzr revert' instead of 'bzr commit' after the update.
1398
1454
 
 
1455
    If you want to restore a file that has been removed locally, use
 
1456
    'bzr revert' instead of 'bzr update'.
 
1457
 
1399
1458
    If the tree's branch is bound to a master branch, it will also update
1400
1459
    the branch from the master.
1401
1460
    """
1402
1461
 
1403
1462
    _see_also = ['pull', 'working-trees', 'status-flags']
1404
1463
    takes_args = ['dir?']
1405
 
    takes_options = ['revision']
 
1464
    takes_options = ['revision',
 
1465
                     Option('show-base',
 
1466
                            help="Show base revision text in conflicts."),
 
1467
                     ]
1406
1468
    aliases = ['up']
1407
1469
 
1408
 
    def run(self, dir='.', revision=None):
 
1470
    def run(self, dir='.', revision=None, show_base=None):
1409
1471
        if revision is not None and len(revision) != 1:
1410
1472
            raise errors.BzrCommandError(
1411
1473
                        "bzr update --revision takes exactly one revision")
1415
1477
        master = branch.get_master_branch(
1416
1478
            possible_transports=possible_transports)
1417
1479
        if master is not None:
1418
 
            tree.lock_write()
1419
1480
            branch_location = master.base
 
1481
            tree.lock_write()
1420
1482
        else:
 
1483
            branch_location = tree.branch.base
1421
1484
            tree.lock_tree_write()
1422
 
            branch_location = tree.branch.base
1423
1485
        self.add_cleanup(tree.unlock)
1424
1486
        # get rid of the final '/' and be ready for display
1425
1487
        branch_location = urlutils.unescape_for_display(
1451
1513
                change_reporter,
1452
1514
                possible_transports=possible_transports,
1453
1515
                revision=revision_id,
1454
 
                old_tip=old_tip)
 
1516
                old_tip=old_tip,
 
1517
                show_base=show_base)
1455
1518
        except errors.NoSuchRevision, e:
1456
1519
            raise errors.BzrCommandError(
1457
1520
                                  "branch has no revision %s\n"
1519
1582
class cmd_remove(Command):
1520
1583
    __doc__ = """Remove files or directories.
1521
1584
 
1522
 
    This makes bzr stop tracking changes to the specified files. bzr will delete
1523
 
    them if they can easily be recovered using revert. If no options or
1524
 
    parameters are given bzr will scan for files that are being tracked by bzr
1525
 
    but missing in your tree and stop tracking them for you.
 
1585
    This makes Bazaar stop tracking changes to the specified files. Bazaar will
 
1586
    delete them if they can easily be recovered using revert otherwise they
 
1587
    will be backed up (adding an extention of the form .~#~). If no options or
 
1588
    parameters are given Bazaar will scan for files that are being tracked by
 
1589
    Bazaar but missing in your tree and stop tracking them for you.
1526
1590
    """
1527
1591
    takes_args = ['file*']
1528
1592
    takes_options = ['verbose',
1530
1594
        RegistryOption.from_kwargs('file-deletion-strategy',
1531
1595
            'The file deletion mode to be used.',
1532
1596
            title='Deletion Strategy', value_switches=True, enum_switch=False,
1533
 
            safe='Only delete files if they can be'
1534
 
                 ' safely recovered (default).',
 
1597
            safe='Backup changed files (default).',
1535
1598
            keep='Delete from bzr but leave the working copy.',
 
1599
            no_backup='Don\'t backup changed files.',
1536
1600
            force='Delete all the specified files, even if they can not be '
1537
 
                'recovered and even if they are non-empty directories.')]
 
1601
                'recovered and even if they are non-empty directories. '
 
1602
                '(deprecated, use no-backup)')]
1538
1603
    aliases = ['rm', 'del']
1539
1604
    encoding_type = 'replace'
1540
1605
 
1541
1606
    def run(self, file_list, verbose=False, new=False,
1542
1607
        file_deletion_strategy='safe'):
1543
 
        tree, file_list = tree_files(file_list)
 
1608
        if file_deletion_strategy == 'force':
 
1609
            note("(The --force option is deprecated, rather use --no-backup "
 
1610
                "in future.)")
 
1611
            file_deletion_strategy = 'no-backup'
 
1612
 
 
1613
        tree, file_list = WorkingTree.open_containing_paths(file_list)
1544
1614
 
1545
1615
        if file_list is not None:
1546
1616
            file_list = [f for f in file_list]
1547
1617
 
1548
 
        tree.lock_write()
1549
 
        self.add_cleanup(tree.unlock)
 
1618
        self.add_cleanup(tree.lock_write().unlock)
1550
1619
        # Heuristics should probably all move into tree.remove_smart or
1551
1620
        # some such?
1552
1621
        if new:
1567
1636
            file_deletion_strategy = 'keep'
1568
1637
        tree.remove(file_list, verbose=verbose, to_file=self.outf,
1569
1638
            keep_files=file_deletion_strategy=='keep',
1570
 
            force=file_deletion_strategy=='force')
 
1639
            force=(file_deletion_strategy=='no-backup'))
1571
1640
 
1572
1641
 
1573
1642
class cmd_file_id(Command):
1635
1704
 
1636
1705
    _see_also = ['check']
1637
1706
    takes_args = ['branch?']
 
1707
    takes_options = [
 
1708
        Option('canonicalize-chks',
 
1709
               help='Make sure CHKs are in canonical form (repairs '
 
1710
                    'bug 522637).',
 
1711
               hidden=True),
 
1712
        ]
1638
1713
 
1639
 
    def run(self, branch="."):
 
1714
    def run(self, branch=".", canonicalize_chks=False):
1640
1715
        from bzrlib.reconcile import reconcile
1641
1716
        dir = bzrdir.BzrDir.open(branch)
1642
 
        reconcile(dir)
 
1717
        reconcile(dir, canonicalize_chks=canonicalize_chks)
1643
1718
 
1644
1719
 
1645
1720
class cmd_revision_history(Command):
1677
1752
            b = wt.branch
1678
1753
            last_revision = wt.last_revision()
1679
1754
 
1680
 
        revision_ids = b.repository.get_ancestry(last_revision)
1681
 
        revision_ids.pop(0)
1682
 
        for revision_id in revision_ids:
 
1755
        self.add_cleanup(b.repository.lock_read().unlock)
 
1756
        graph = b.repository.get_graph()
 
1757
        revisions = [revid for revid, parents in
 
1758
            graph.iter_ancestry([last_revision])]
 
1759
        for revision_id in reversed(revisions):
 
1760
            if _mod_revision.is_null(revision_id):
 
1761
                continue
1683
1762
            self.outf.write(revision_id + '\n')
1684
1763
 
1685
1764
 
1722
1801
                ),
1723
1802
         Option('append-revisions-only',
1724
1803
                help='Never change revnos or the existing log.'
1725
 
                '  Append revisions to it only.')
 
1804
                '  Append revisions to it only.'),
 
1805
         Option('no-tree',
 
1806
                'Create a branch without a working tree.')
1726
1807
         ]
1727
1808
    def run(self, location=None, format=None, append_revisions_only=False,
1728
 
            create_prefix=False):
 
1809
            create_prefix=False, no_tree=False):
1729
1810
        if format is None:
1730
1811
            format = bzrdir.format_registry.make_bzrdir('default')
1731
1812
        if location is None:
1754
1835
        except errors.NotBranchError:
1755
1836
            # really a NotBzrDir error...
1756
1837
            create_branch = bzrdir.BzrDir.create_branch_convenience
 
1838
            if no_tree:
 
1839
                force_new_tree = False
 
1840
            else:
 
1841
                force_new_tree = None
1757
1842
            branch = create_branch(to_transport.base, format=format,
1758
 
                                   possible_transports=[to_transport])
 
1843
                                   possible_transports=[to_transport],
 
1844
                                   force_new_tree=force_new_tree)
1759
1845
            a_bzrdir = branch.bzrdir
1760
1846
        else:
1761
1847
            from bzrlib.transport.local import LocalTransport
1765
1851
                        raise errors.BranchExistsWithoutWorkingTree(location)
1766
1852
                raise errors.AlreadyBranchError(location)
1767
1853
            branch = a_bzrdir.create_branch()
1768
 
            a_bzrdir.create_workingtree()
 
1854
            if not no_tree:
 
1855
                a_bzrdir.create_workingtree()
1769
1856
        if append_revisions_only:
1770
1857
            try:
1771
1858
                branch.set_append_revisions_only(True)
1865
1952
    "bzr diff -p1" is equivalent to "bzr diff --prefix old/:new/", and
1866
1953
    produces patches suitable for "patch -p1".
1867
1954
 
 
1955
    Note that when using the -r argument with a range of revisions, the
 
1956
    differences are computed between the two specified revisions.  That
 
1957
    is, the command does not show the changes introduced by the first 
 
1958
    revision in the range.  This differs from the interpretation of 
 
1959
    revision ranges used by "bzr log" which includes the first revision
 
1960
    in the range.
 
1961
 
1868
1962
    :Exit values:
1869
1963
        1 - changed
1870
1964
        2 - unrepresentable changes
1888
1982
 
1889
1983
            bzr diff -r1..3 xxx
1890
1984
 
1891
 
        To see the changes introduced in revision X::
 
1985
        The changes introduced by revision 2 (equivalent to -r1..2)::
 
1986
 
 
1987
            bzr diff -c2
 
1988
 
 
1989
        To see the changes introduced by revision X::
1892
1990
        
1893
1991
            bzr diff -cX
1894
1992
 
1898
1996
 
1899
1997
            bzr diff -r<chosen_parent>..X
1900
1998
 
1901
 
        The changes introduced by revision 2 (equivalent to -r1..2)::
 
1999
        The changes between the current revision and the previous revision
 
2000
        (equivalent to -c-1 and -r-2..-1)
1902
2001
 
1903
 
            bzr diff -c2
 
2002
            bzr diff -r-2..
1904
2003
 
1905
2004
        Show just the differences for file NEWS::
1906
2005
 
1921
2020
        Same as 'bzr diff' but prefix paths with old/ and new/::
1922
2021
 
1923
2022
            bzr diff --prefix old/:new/
 
2023
            
 
2024
        Show the differences using a custom diff program with options::
 
2025
        
 
2026
            bzr diff --using /usr/bin/diff --diff-options -wu
1924
2027
    """
1925
2028
    _see_also = ['status']
1926
2029
    takes_args = ['file*']
1946
2049
            type=unicode,
1947
2050
            ),
1948
2051
        RegistryOption('format',
 
2052
            short_name='F',
1949
2053
            help='Diff format to use.',
1950
2054
            lazy_registry=('bzrlib.diff', 'format_registry'),
1951
 
            value_switches=False, title='Diff format'),
 
2055
            title='Diff format'),
1952
2056
        ]
1953
2057
    aliases = ['di', 'dif']
1954
2058
    encoding_type = 'exact'
1985
2089
         old_branch, new_branch,
1986
2090
         specific_files, extra_trees) = get_trees_and_branches_to_diff_locked(
1987
2091
            file_list, revision, old, new, self.add_cleanup, apply_view=True)
 
2092
        # GNU diff on Windows uses ANSI encoding for filenames
 
2093
        path_encoding = osutils.get_diff_header_encoding()
1988
2094
        return show_diff_trees(old_tree, new_tree, sys.stdout,
1989
2095
                               specific_files=specific_files,
1990
2096
                               external_diff_options=diff_options,
1991
2097
                               old_label=old_label, new_label=new_label,
1992
 
                               extra_trees=extra_trees, using=using,
 
2098
                               extra_trees=extra_trees,
 
2099
                               path_encoding=path_encoding,
 
2100
                               using=using,
1993
2101
                               format_cls=format)
1994
2102
 
1995
2103
 
2003
2111
    # level of effort but possibly much less IO.  (Or possibly not,
2004
2112
    # if the directories are very large...)
2005
2113
    _see_also = ['status', 'ls']
2006
 
    takes_options = ['show-ids']
 
2114
    takes_options = ['directory', 'show-ids']
2007
2115
 
2008
2116
    @display_command
2009
 
    def run(self, show_ids=False):
2010
 
        tree = WorkingTree.open_containing(u'.')[0]
2011
 
        tree.lock_read()
2012
 
        self.add_cleanup(tree.unlock)
 
2117
    def run(self, show_ids=False, directory=u'.'):
 
2118
        tree = WorkingTree.open_containing(directory)[0]
 
2119
        self.add_cleanup(tree.lock_read().unlock)
2013
2120
        old = tree.basis_tree()
2014
 
        old.lock_read()
2015
 
        self.add_cleanup(old.unlock)
 
2121
        self.add_cleanup(old.lock_read().unlock)
2016
2122
        for path, ie in old.inventory.iter_entries():
2017
2123
            if not tree.has_id(ie.file_id):
2018
2124
                self.outf.write(path)
2028
2134
 
2029
2135
    hidden = True
2030
2136
    _see_also = ['status', 'ls']
2031
 
    takes_options = [
2032
 
            Option('null',
2033
 
                   help='Write an ascii NUL (\\0) separator '
2034
 
                   'between files rather than a newline.')
2035
 
            ]
 
2137
    takes_options = ['directory', 'null']
2036
2138
 
2037
2139
    @display_command
2038
 
    def run(self, null=False):
2039
 
        tree = WorkingTree.open_containing(u'.')[0]
 
2140
    def run(self, null=False, directory=u'.'):
 
2141
        tree = WorkingTree.open_containing(directory)[0]
 
2142
        self.add_cleanup(tree.lock_read().unlock)
2040
2143
        td = tree.changes_from(tree.basis_tree())
 
2144
        self.cleanup_now()
2041
2145
        for path, id, kind, text_modified, meta_modified in td.modified:
2042
2146
            if null:
2043
2147
                self.outf.write(path + '\0')
2051
2155
 
2052
2156
    hidden = True
2053
2157
    _see_also = ['status', 'ls']
2054
 
    takes_options = [
2055
 
            Option('null',
2056
 
                   help='Write an ascii NUL (\\0) separator '
2057
 
                   'between files rather than a newline.')
2058
 
            ]
 
2158
    takes_options = ['directory', 'null']
2059
2159
 
2060
2160
    @display_command
2061
 
    def run(self, null=False):
2062
 
        wt = WorkingTree.open_containing(u'.')[0]
2063
 
        wt.lock_read()
2064
 
        self.add_cleanup(wt.unlock)
 
2161
    def run(self, null=False, directory=u'.'):
 
2162
        wt = WorkingTree.open_containing(directory)[0]
 
2163
        self.add_cleanup(wt.lock_read().unlock)
2065
2164
        basis = wt.basis_tree()
2066
 
        basis.lock_read()
2067
 
        self.add_cleanup(basis.unlock)
 
2165
        self.add_cleanup(basis.lock_read().unlock)
2068
2166
        basis_inv = basis.inventory
2069
2167
        inv = wt.inventory
2070
2168
        for file_id in inv:
2071
 
            if file_id in basis_inv:
 
2169
            if basis_inv.has_id(file_id):
2072
2170
                continue
2073
2171
            if inv.is_root(file_id) and len(basis_inv) == 0:
2074
2172
                continue
2075
2173
            path = inv.id2path(file_id)
2076
 
            if not os.access(osutils.abspath(path), os.F_OK):
 
2174
            if not os.access(osutils.pathjoin(wt.basedir, path), os.F_OK):
2077
2175
                continue
2078
2176
            if null:
2079
2177
                self.outf.write(path + '\0')
2223
2321
 
2224
2322
    :Other filtering:
2225
2323
 
2226
 
      The --message option can be used for finding revisions that match a
2227
 
      regular expression in a commit message.
 
2324
      The --match option can be used for finding revisions that match a
 
2325
      regular expression in a commit message, committer, author or bug.
 
2326
      Specifying the option several times will match any of the supplied
 
2327
      expressions. --match-author, --match-bugs, --match-committer and
 
2328
      --match-message can be used to only match a specific field.
2228
2329
 
2229
2330
    :Tips & tricks:
2230
2331
 
2279
2380
                   help='Show just the specified revision.'
2280
2381
                   ' See also "help revisionspec".'),
2281
2382
            'log-format',
 
2383
            RegistryOption('authors',
 
2384
                'What names to list as authors - first, all or committer.',
 
2385
                title='Authors',
 
2386
                lazy_registry=('bzrlib.log', 'author_list_registry'),
 
2387
            ),
2282
2388
            Option('levels',
2283
2389
                   short_name='n',
2284
2390
                   help='Number of levels to display - 0 for all, 1 for flat.',
2285
2391
                   argname='N',
2286
2392
                   type=_parse_levels),
2287
2393
            Option('message',
2288
 
                   short_name='m',
2289
2394
                   help='Show revisions whose message matches this '
2290
2395
                        'regular expression.',
2291
 
                   type=str),
 
2396
                   type=str,
 
2397
                   hidden=True),
2292
2398
            Option('limit',
2293
2399
                   short_name='l',
2294
2400
                   help='Limit the output to the first N revisions.',
2302
2408
            Option('exclude-common-ancestry',
2303
2409
                   help='Display only the revisions that are not part'
2304
2410
                   ' of both ancestries (require -rX..Y)'
2305
 
                   )
 
2411
                   ),
 
2412
            Option('signatures',
 
2413
                   help='Show digital signature validity'),
 
2414
            ListOption('match',
 
2415
                short_name='m',
 
2416
                help='Show revisions whose properties match this '
 
2417
                'expression.',
 
2418
                type=str),
 
2419
            ListOption('match-message',
 
2420
                   help='Show revisions whose message matches this '
 
2421
                   'expression.',
 
2422
                type=str),
 
2423
            ListOption('match-committer',
 
2424
                   help='Show revisions whose committer matches this '
 
2425
                   'expression.',
 
2426
                type=str),
 
2427
            ListOption('match-author',
 
2428
                   help='Show revisions whose authors match this '
 
2429
                   'expression.',
 
2430
                type=str),
 
2431
            ListOption('match-bugs',
 
2432
                   help='Show revisions whose bugs match this '
 
2433
                   'expression.',
 
2434
                type=str)
2306
2435
            ]
2307
2436
    encoding_type = 'replace'
2308
2437
 
2319
2448
            limit=None,
2320
2449
            show_diff=False,
2321
2450
            include_merges=False,
 
2451
            authors=None,
2322
2452
            exclude_common_ancestry=False,
 
2453
            signatures=False,
 
2454
            match=None,
 
2455
            match_message=None,
 
2456
            match_committer=None,
 
2457
            match_author=None,
 
2458
            match_bugs=None,
2323
2459
            ):
2324
2460
        from bzrlib.log import (
2325
2461
            Logger,
2352
2488
        if file_list:
2353
2489
            # find the file ids to log and check for directory filtering
2354
2490
            b, file_info_list, rev1, rev2 = _get_info_for_log_files(
2355
 
                revision, file_list)
2356
 
            self.add_cleanup(b.unlock)
 
2491
                revision, file_list, self.add_cleanup)
2357
2492
            for relpath, file_id, kind in file_info_list:
2358
2493
                if file_id is None:
2359
2494
                    raise errors.BzrCommandError(
2377
2512
                location = '.'
2378
2513
            dir, relpath = bzrdir.BzrDir.open_containing(location)
2379
2514
            b = dir.open_branch()
2380
 
            b.lock_read()
2381
 
            self.add_cleanup(b.unlock)
 
2515
            self.add_cleanup(b.lock_read().unlock)
2382
2516
            rev1, rev2 = _get_revision_range(revision, b, self.name())
2383
2517
 
 
2518
        if b.get_config().validate_signatures_in_log():
 
2519
            signatures = True
 
2520
 
 
2521
        if signatures:
 
2522
            if not gpg.GPGStrategy.verify_signatures_available():
 
2523
                raise errors.GpgmeNotInstalled(None)
 
2524
 
2384
2525
        # Decide on the type of delta & diff filtering to use
2385
2526
        # TODO: add an --all-files option to make this configurable & consistent
2386
2527
        if not verbose:
2404
2545
                        show_timezone=timezone,
2405
2546
                        delta_format=get_verbosity_level(),
2406
2547
                        levels=levels,
2407
 
                        show_advice=levels is None)
 
2548
                        show_advice=levels is None,
 
2549
                        author_list_handler=authors)
2408
2550
 
2409
2551
        # Choose the algorithm for doing the logging. It's annoying
2410
2552
        # having multiple code paths like this but necessary until
2422
2564
        match_using_deltas = (len(file_ids) != 1 or filter_by_dir
2423
2565
            or delta_type or partial_history)
2424
2566
 
 
2567
        match_dict = {}
 
2568
        if match:
 
2569
            match_dict[''] = match
 
2570
        if match_message:
 
2571
            match_dict['message'] = match_message
 
2572
        if match_committer:
 
2573
            match_dict['committer'] = match_committer
 
2574
        if match_author:
 
2575
            match_dict['author'] = match_author
 
2576
        if match_bugs:
 
2577
            match_dict['bugs'] = match_bugs
 
2578
            
2425
2579
        # Build the LogRequest and execute it
2426
2580
        if len(file_ids) == 0:
2427
2581
            file_ids = None
2430
2584
            start_revision=rev1, end_revision=rev2, limit=limit,
2431
2585
            message_search=message, delta_type=delta_type,
2432
2586
            diff_type=diff_type, _match_using_deltas=match_using_deltas,
2433
 
            exclude_common_ancestry=exclude_common_ancestry,
 
2587
            exclude_common_ancestry=exclude_common_ancestry, match=match_dict,
 
2588
            signature=signatures
2434
2589
            )
2435
2590
        Logger(b, rqst).show(lf)
2436
2591
 
2508
2663
        tree, relpath = WorkingTree.open_containing(filename)
2509
2664
        file_id = tree.path2id(relpath)
2510
2665
        b = tree.branch
2511
 
        b.lock_read()
2512
 
        self.add_cleanup(b.unlock)
 
2666
        self.add_cleanup(b.lock_read().unlock)
2513
2667
        touching_revs = log.find_touching_revisions(b, file_id)
2514
2668
        for revno, revision_id, what in touching_revs:
2515
2669
            self.outf.write("%6d %s\n" % (revno, what))
2528
2682
                   help='Recurse into subdirectories.'),
2529
2683
            Option('from-root',
2530
2684
                   help='Print paths relative to the root of the branch.'),
2531
 
            Option('unknown', help='Print unknown files.'),
 
2685
            Option('unknown', short_name='u',
 
2686
                help='Print unknown files.'),
2532
2687
            Option('versioned', help='Print versioned files.',
2533
2688
                   short_name='V'),
2534
 
            Option('ignored', help='Print ignored files.'),
2535
 
            Option('null',
2536
 
                   help='Write an ascii NUL (\\0) separator '
2537
 
                   'between files rather than a newline.'),
2538
 
            Option('kind',
 
2689
            Option('ignored', short_name='i',
 
2690
                help='Print ignored files.'),
 
2691
            Option('kind', short_name='k',
2539
2692
                   help='List entries of a particular kind: file, directory, symlink.',
2540
2693
                   type=unicode),
 
2694
            'null',
2541
2695
            'show-ids',
 
2696
            'directory',
2542
2697
            ]
2543
2698
    @display_command
2544
2699
    def run(self, revision=None, verbose=False,
2545
2700
            recursive=False, from_root=False,
2546
2701
            unknown=False, versioned=False, ignored=False,
2547
 
            null=False, kind=None, show_ids=False, path=None):
 
2702
            null=False, kind=None, show_ids=False, path=None, directory=None):
2548
2703
 
2549
2704
        if kind and kind not in ('file', 'directory', 'symlink'):
2550
2705
            raise errors.BzrCommandError('invalid kind specified')
2562
2717
                raise errors.BzrCommandError('cannot specify both --from-root'
2563
2718
                                             ' and PATH')
2564
2719
            fs_path = path
2565
 
        tree, branch, relpath = bzrdir.BzrDir.open_containing_tree_or_branch(
2566
 
            fs_path)
 
2720
        tree, branch, relpath = \
 
2721
            _open_directory_or_containing_tree_or_branch(fs_path, directory)
2567
2722
 
2568
2723
        # Calculate the prefix to use
2569
2724
        prefix = None
2584
2739
                view_str = views.view_display_str(view_files)
2585
2740
                note("Ignoring files outside view. View is %s" % view_str)
2586
2741
 
2587
 
        tree.lock_read()
2588
 
        self.add_cleanup(tree.unlock)
 
2742
        self.add_cleanup(tree.lock_read().unlock)
2589
2743
        for fp, fc, fkind, fid, entry in tree.list_files(include_root=False,
2590
2744
            from_dir=relpath, recursive=recursive):
2591
2745
            # Apply additional masking
2638
2792
 
2639
2793
    hidden = True
2640
2794
    _see_also = ['ls']
 
2795
    takes_options = ['directory']
2641
2796
 
2642
2797
    @display_command
2643
 
    def run(self):
2644
 
        for f in WorkingTree.open_containing(u'.')[0].unknowns():
 
2798
    def run(self, directory=u'.'):
 
2799
        for f in WorkingTree.open_containing(directory)[0].unknowns():
2645
2800
            self.outf.write(osutils.quotefn(f) + '\n')
2646
2801
 
2647
2802
 
2674
2829
    Patterns prefixed with '!!' act as regular ignore patterns, but have
2675
2830
    precedence over the '!' exception patterns.
2676
2831
 
2677
 
    Note: ignore patterns containing shell wildcards must be quoted from
2678
 
    the shell on Unix.
 
2832
    :Notes: 
 
2833
        
 
2834
    * Ignore patterns containing shell wildcards must be quoted from
 
2835
      the shell on Unix.
 
2836
 
 
2837
    * Ignore patterns starting with "#" act as comments in the ignore file.
 
2838
      To ignore patterns that begin with that character, use the "RE:" prefix.
2679
2839
 
2680
2840
    :Examples:
2681
2841
        Ignore the top level Makefile::
2690
2850
 
2691
2851
            bzr ignore "!special.class"
2692
2852
 
 
2853
        Ignore files whose name begins with the "#" character::
 
2854
 
 
2855
            bzr ignore "RE:^#"
 
2856
 
2693
2857
        Ignore .o files under the lib directory::
2694
2858
 
2695
2859
            bzr ignore "lib/**/*.o"
2703
2867
            bzr ignore "RE:(?!debian/).*"
2704
2868
        
2705
2869
        Ignore everything except the "local" toplevel directory,
2706
 
        but always ignore "*~" autosave files, even under local/::
 
2870
        but always ignore autosave files ending in ~, even under local/::
2707
2871
        
2708
2872
            bzr ignore "*"
2709
2873
            bzr ignore "!./local"
2712
2876
 
2713
2877
    _see_also = ['status', 'ignored', 'patterns']
2714
2878
    takes_args = ['name_pattern*']
2715
 
    takes_options = [
 
2879
    takes_options = ['directory',
2716
2880
        Option('default-rules',
2717
2881
               help='Display the default ignore rules that bzr uses.')
2718
2882
        ]
2719
2883
 
2720
 
    def run(self, name_pattern_list=None, default_rules=None):
 
2884
    def run(self, name_pattern_list=None, default_rules=None,
 
2885
            directory=u'.'):
2721
2886
        from bzrlib import ignores
2722
2887
        if default_rules is not None:
2723
2888
            # dump the default rules and exit
2729
2894
                "NAME_PATTERN or --default-rules.")
2730
2895
        name_pattern_list = [globbing.normalize_pattern(p)
2731
2896
                             for p in name_pattern_list]
 
2897
        bad_patterns = ''
 
2898
        for p in name_pattern_list:
 
2899
            if not globbing.Globster.is_pattern_valid(p):
 
2900
                bad_patterns += ('\n  %s' % p)
 
2901
        if bad_patterns:
 
2902
            msg = ('Invalid ignore pattern(s) found. %s' % bad_patterns)
 
2903
            ui.ui_factory.show_error(msg)
 
2904
            raise errors.InvalidPattern('')
2732
2905
        for name_pattern in name_pattern_list:
2733
2906
            if (name_pattern[0] == '/' or
2734
2907
                (len(name_pattern) > 1 and name_pattern[1] == ':')):
2735
2908
                raise errors.BzrCommandError(
2736
2909
                    "NAME_PATTERN should not be an absolute path")
2737
 
        tree, relpath = WorkingTree.open_containing(u'.')
 
2910
        tree, relpath = WorkingTree.open_containing(directory)
2738
2911
        ignores.tree_ignores_add_patterns(tree, name_pattern_list)
2739
2912
        ignored = globbing.Globster(name_pattern_list)
2740
2913
        matches = []
2741
 
        tree.lock_read()
 
2914
        self.add_cleanup(tree.lock_read().unlock)
2742
2915
        for entry in tree.list_files():
2743
2916
            id = entry[3]
2744
2917
            if id is not None:
2745
2918
                filename = entry[0]
2746
2919
                if ignored.match(filename):
2747
2920
                    matches.append(filename)
2748
 
        tree.unlock()
2749
2921
        if len(matches) > 0:
2750
2922
            self.outf.write("Warning: the following files are version controlled and"
2751
2923
                  " match your ignore pattern:\n%s"
2766
2938
 
2767
2939
    encoding_type = 'replace'
2768
2940
    _see_also = ['ignore', 'ls']
 
2941
    takes_options = ['directory']
2769
2942
 
2770
2943
    @display_command
2771
 
    def run(self):
2772
 
        tree = WorkingTree.open_containing(u'.')[0]
2773
 
        tree.lock_read()
2774
 
        self.add_cleanup(tree.unlock)
 
2944
    def run(self, directory=u'.'):
 
2945
        tree = WorkingTree.open_containing(directory)[0]
 
2946
        self.add_cleanup(tree.lock_read().unlock)
2775
2947
        for path, file_class, kind, file_id, entry in tree.list_files():
2776
2948
            if file_class != 'I':
2777
2949
                continue
2788
2960
    """
2789
2961
    hidden = True
2790
2962
    takes_args = ['revno']
 
2963
    takes_options = ['directory']
2791
2964
 
2792
2965
    @display_command
2793
 
    def run(self, revno):
 
2966
    def run(self, revno, directory=u'.'):
2794
2967
        try:
2795
2968
            revno = int(revno)
2796
2969
        except ValueError:
2797
2970
            raise errors.BzrCommandError("not a valid revision-number: %r"
2798
2971
                                         % revno)
2799
 
        revid = WorkingTree.open_containing(u'.')[0].branch.get_rev_id(revno)
 
2972
        revid = WorkingTree.open_containing(directory)[0].branch.get_rev_id(revno)
2800
2973
        self.outf.write("%s\n" % revid)
2801
2974
 
2802
2975
 
2828
3001
         zip                          .zip
2829
3002
      =================       =========================
2830
3003
    """
 
3004
    encoding = 'exact'
2831
3005
    takes_args = ['dest', 'branch_or_subdir?']
2832
 
    takes_options = [
 
3006
    takes_options = ['directory',
2833
3007
        Option('format',
2834
3008
               help="Type of file to export to.",
2835
3009
               type=unicode),
2844
3018
                    'revision in which it was changed.'),
2845
3019
        ]
2846
3020
    def run(self, dest, branch_or_subdir=None, revision=None, format=None,
2847
 
        root=None, filters=False, per_file_timestamps=False):
 
3021
        root=None, filters=False, per_file_timestamps=False, directory=u'.'):
2848
3022
        from bzrlib.export import export
2849
3023
 
2850
3024
        if branch_or_subdir is None:
2851
 
            tree = WorkingTree.open_containing(u'.')[0]
 
3025
            tree = WorkingTree.open_containing(directory)[0]
2852
3026
            b = tree.branch
2853
3027
            subdir = None
2854
3028
        else:
2873
3047
    """
2874
3048
 
2875
3049
    _see_also = ['ls']
2876
 
    takes_options = [
 
3050
    takes_options = ['directory',
2877
3051
        Option('name-from-revision', help='The path name in the old tree.'),
2878
3052
        Option('filters', help='Apply content filters to display the '
2879
3053
                'convenience form.'),
2884
3058
 
2885
3059
    @display_command
2886
3060
    def run(self, filename, revision=None, name_from_revision=False,
2887
 
            filters=False):
 
3061
            filters=False, directory=None):
2888
3062
        if revision is not None and len(revision) != 1:
2889
3063
            raise errors.BzrCommandError("bzr cat --revision takes exactly"
2890
3064
                                         " one revision specifier")
2891
3065
        tree, branch, relpath = \
2892
 
            bzrdir.BzrDir.open_containing_tree_or_branch(filename)
2893
 
        branch.lock_read()
2894
 
        self.add_cleanup(branch.unlock)
 
3066
            _open_directory_or_containing_tree_or_branch(filename, directory)
 
3067
        self.add_cleanup(branch.lock_read().unlock)
2895
3068
        return self._run(tree, branch, relpath, filename, revision,
2896
3069
                         name_from_revision, filters)
2897
3070
 
2900
3073
        if tree is None:
2901
3074
            tree = b.basis_tree()
2902
3075
        rev_tree = _get_one_revision_tree('cat', revision, branch=b)
2903
 
        rev_tree.lock_read()
2904
 
        self.add_cleanup(rev_tree.unlock)
 
3076
        self.add_cleanup(rev_tree.lock_read().unlock)
2905
3077
 
2906
3078
        old_file_id = rev_tree.path2id(relpath)
2907
3079
 
 
3080
        # TODO: Split out this code to something that generically finds the
 
3081
        # best id for a path across one or more trees; it's like
 
3082
        # find_ids_across_trees but restricted to find just one. -- mbp
 
3083
        # 20110705.
2908
3084
        if name_from_revision:
2909
3085
            # Try in revision if requested
2910
3086
            if old_file_id is None:
2912
3088
                    "%r is not present in revision %s" % (
2913
3089
                        filename, rev_tree.get_revision_id()))
2914
3090
            else:
2915
 
                content = rev_tree.get_file_text(old_file_id)
 
3091
                actual_file_id = old_file_id
2916
3092
        else:
2917
3093
            cur_file_id = tree.path2id(relpath)
2918
 
            found = False
2919
 
            if cur_file_id is not None:
2920
 
                # Then try with the actual file id
2921
 
                try:
2922
 
                    content = rev_tree.get_file_text(cur_file_id)
2923
 
                    found = True
2924
 
                except errors.NoSuchId:
2925
 
                    # The actual file id didn't exist at that time
2926
 
                    pass
2927
 
            if not found and old_file_id is not None:
2928
 
                # Finally try with the old file id
2929
 
                content = rev_tree.get_file_text(old_file_id)
2930
 
                found = True
2931
 
            if not found:
2932
 
                # Can't be found anywhere
 
3094
            if cur_file_id is not None and rev_tree.has_id(cur_file_id):
 
3095
                actual_file_id = cur_file_id
 
3096
            elif old_file_id is not None:
 
3097
                actual_file_id = old_file_id
 
3098
            else:
2933
3099
                raise errors.BzrCommandError(
2934
3100
                    "%r is not present in revision %s" % (
2935
3101
                        filename, rev_tree.get_revision_id()))
2936
3102
        if filtered:
2937
 
            from bzrlib.filters import (
2938
 
                ContentFilterContext,
2939
 
                filtered_output_bytes,
2940
 
                )
2941
 
            filters = rev_tree._content_filter_stack(relpath)
2942
 
            chunks = content.splitlines(True)
2943
 
            content = filtered_output_bytes(chunks, filters,
2944
 
                ContentFilterContext(relpath, rev_tree))
2945
 
            self.cleanup_now()
2946
 
            self.outf.writelines(content)
 
3103
            from bzrlib.filter_tree import ContentFilterTree
 
3104
            filter_tree = ContentFilterTree(rev_tree,
 
3105
                rev_tree._content_filter_stack)
 
3106
            content = filter_tree.get_file_text(actual_file_id)
2947
3107
        else:
2948
 
            self.cleanup_now()
2949
 
            self.outf.write(content)
 
3108
            content = rev_tree.get_file_text(actual_file_id)
 
3109
        self.cleanup_now()
 
3110
        self.outf.write(content)
2950
3111
 
2951
3112
 
2952
3113
class cmd_local_time_offset(Command):
3013
3174
      to trigger updates to external systems like bug trackers. The --fixes
3014
3175
      option can be used to record the association between a revision and
3015
3176
      one or more bugs. See ``bzr help bugs`` for details.
3016
 
 
3017
 
      A selective commit may fail in some cases where the committed
3018
 
      tree would be invalid. Consider::
3019
 
  
3020
 
        bzr init foo
3021
 
        mkdir foo/bar
3022
 
        bzr add foo/bar
3023
 
        bzr commit foo -m "committing foo"
3024
 
        bzr mv foo/bar foo/baz
3025
 
        mkdir foo/bar
3026
 
        bzr add foo/bar
3027
 
        bzr commit foo/bar -m "committing bar but not baz"
3028
 
  
3029
 
      In the example above, the last commit will fail by design. This gives
3030
 
      the user the opportunity to decide whether they want to commit the
3031
 
      rename at the same time, separately first, or not at all. (As a general
3032
 
      rule, when in doubt, Bazaar has a policy of Doing the Safe Thing.)
3033
3177
    """
3034
 
    # TODO: Run hooks on tree to-be-committed, and after commit.
3035
 
 
3036
 
    # TODO: Strict commit that fails if there are deleted files.
3037
 
    #       (what does "deleted files" mean ??)
3038
 
 
3039
 
    # TODO: Give better message for -s, --summary, used by tla people
3040
 
 
3041
 
    # XXX: verbose currently does nothing
3042
3178
 
3043
3179
    _see_also = ['add', 'bugs', 'hooks', 'uncommit']
3044
3180
    takes_args = ['selected*']
3076
3212
             Option('show-diff', short_name='p',
3077
3213
                    help='When no message is supplied, show the diff along'
3078
3214
                    ' with the status summary in the message editor.'),
 
3215
             Option('lossy', 
 
3216
                    help='When committing to a foreign version control '
 
3217
                    'system do not push data that can not be natively '
 
3218
                    'represented.'),
3079
3219
             ]
3080
3220
    aliases = ['ci', 'checkin']
3081
3221
 
3100
3240
 
3101
3241
    def run(self, message=None, file=None, verbose=False, selected_list=None,
3102
3242
            unchanged=False, strict=False, local=False, fixes=None,
3103
 
            author=None, show_diff=False, exclude=None, commit_time=None):
 
3243
            author=None, show_diff=False, exclude=None, commit_time=None,
 
3244
            lossy=False):
3104
3245
        from bzrlib.errors import (
3105
3246
            PointlessCommit,
3106
3247
            ConflictsInTree,
3109
3250
        from bzrlib.msgeditor import (
3110
3251
            edit_commit_message_encoded,
3111
3252
            generate_commit_message_template,
3112
 
            make_commit_message_template_encoded
 
3253
            make_commit_message_template_encoded,
 
3254
            set_commit_message,
3113
3255
        )
3114
3256
 
3115
3257
        commit_stamp = offset = None
3120
3262
                raise errors.BzrCommandError(
3121
3263
                    "Could not parse --commit-time: " + str(e))
3122
3264
 
3123
 
        # TODO: Need a blackbox test for invoking the external editor; may be
3124
 
        # slightly problematic to run this cross-platform.
3125
 
 
3126
 
        # TODO: do more checks that the commit will succeed before
3127
 
        # spending the user's valuable time typing a commit message.
3128
 
 
3129
3265
        properties = {}
3130
3266
 
3131
 
        tree, selected_list = tree_files(selected_list)
 
3267
        tree, selected_list = WorkingTree.open_containing_paths(selected_list)
3132
3268
        if selected_list == ['']:
3133
3269
            # workaround - commit of root of tree should be exactly the same
3134
3270
            # as just default commit in that tree, and succeed even though
3169
3305
        def get_message(commit_obj):
3170
3306
            """Callback to get commit message"""
3171
3307
            if file:
3172
 
                my_message = codecs.open(
3173
 
                    file, 'rt', osutils.get_user_encoding()).read()
 
3308
                f = open(file)
 
3309
                try:
 
3310
                    my_message = f.read().decode(osutils.get_user_encoding())
 
3311
                finally:
 
3312
                    f.close()
3174
3313
            elif message is not None:
3175
3314
                my_message = message
3176
3315
            else:
3184
3323
                # make_commit_message_template_encoded returns user encoding.
3185
3324
                # We probably want to be using edit_commit_message instead to
3186
3325
                # avoid this.
3187
 
                start_message = generate_commit_message_template(commit_obj)
3188
 
                my_message = edit_commit_message_encoded(text,
3189
 
                    start_message=start_message)
 
3326
                my_message = set_commit_message(commit_obj)
 
3327
                if my_message is None:
 
3328
                    start_message = generate_commit_message_template(commit_obj)
 
3329
                    my_message = edit_commit_message_encoded(text,
 
3330
                        start_message=start_message)
3190
3331
                if my_message is None:
3191
3332
                    raise errors.BzrCommandError("please specify a commit"
3192
3333
                        " message with either --message or --file")
3205
3346
                        reporter=None, verbose=verbose, revprops=properties,
3206
3347
                        authors=author, timestamp=commit_stamp,
3207
3348
                        timezone=offset,
3208
 
                        exclude=safe_relpath_files(tree, exclude))
 
3349
                        exclude=tree.safe_relpath_files(exclude),
 
3350
                        lossy=lossy)
3209
3351
        except PointlessCommit:
3210
3352
            raise errors.BzrCommandError("No changes to commit."
3211
 
                              " Use --unchanged to commit anyhow.")
 
3353
                " Please 'bzr add' the files you want to commit, or use"
 
3354
                " --unchanged to force an empty commit.")
3212
3355
        except ConflictsInTree:
3213
3356
            raise errors.BzrCommandError('Conflicts detected in working '
3214
3357
                'tree.  Use "bzr conflicts" to list, "bzr resolve FILE" to'
3295
3438
 
3296
3439
 
3297
3440
class cmd_upgrade(Command):
3298
 
    __doc__ = """Upgrade branch storage to current format.
3299
 
 
3300
 
    The check command or bzr developers may sometimes advise you to run
3301
 
    this command. When the default format has changed you may also be warned
3302
 
    during other operations to upgrade.
 
3441
    __doc__ = """Upgrade a repository, branch or working tree to a newer format.
 
3442
 
 
3443
    When the default format has changed after a major new release of
 
3444
    Bazaar, you may be informed during certain operations that you
 
3445
    should upgrade. Upgrading to a newer format may improve performance
 
3446
    or make new features available. It may however limit interoperability
 
3447
    with older repositories or with older versions of Bazaar.
 
3448
 
 
3449
    If you wish to upgrade to a particular format rather than the
 
3450
    current default, that can be specified using the --format option.
 
3451
    As a consequence, you can use the upgrade command this way to
 
3452
    "downgrade" to an earlier format, though some conversions are
 
3453
    a one way process (e.g. changing from the 1.x default to the
 
3454
    2.x default) so downgrading is not always possible.
 
3455
 
 
3456
    A backup.bzr.~#~ directory is created at the start of the conversion
 
3457
    process (where # is a number). By default, this is left there on
 
3458
    completion. If the conversion fails, delete the new .bzr directory
 
3459
    and rename this one back in its place. Use the --clean option to ask
 
3460
    for the backup.bzr directory to be removed on successful conversion.
 
3461
    Alternatively, you can delete it by hand if everything looks good
 
3462
    afterwards.
 
3463
 
 
3464
    If the location given is a shared repository, dependent branches
 
3465
    are also converted provided the repository converts successfully.
 
3466
    If the conversion of a branch fails, remaining branches are still
 
3467
    tried.
 
3468
 
 
3469
    For more information on upgrades, see the Bazaar Upgrade Guide,
 
3470
    http://doc.bazaar.canonical.com/latest/en/upgrade-guide/.
3303
3471
    """
3304
3472
 
3305
 
    _see_also = ['check']
 
3473
    _see_also = ['check', 'reconcile', 'formats']
3306
3474
    takes_args = ['url?']
3307
3475
    takes_options = [
3308
 
                    RegistryOption('format',
3309
 
                        help='Upgrade to a specific format.  See "bzr help'
3310
 
                             ' formats" for details.',
3311
 
                        lazy_registry=('bzrlib.bzrdir', 'format_registry'),
3312
 
                        converter=lambda name: bzrdir.format_registry.make_bzrdir(name),
3313
 
                        value_switches=True, title='Branch format'),
3314
 
                    ]
 
3476
        RegistryOption('format',
 
3477
            help='Upgrade to a specific format.  See "bzr help'
 
3478
                 ' formats" for details.',
 
3479
            lazy_registry=('bzrlib.bzrdir', 'format_registry'),
 
3480
            converter=lambda name: bzrdir.format_registry.make_bzrdir(name),
 
3481
            value_switches=True, title='Branch format'),
 
3482
        Option('clean',
 
3483
            help='Remove the backup.bzr directory if successful.'),
 
3484
        Option('dry-run',
 
3485
            help="Show what would be done, but don't actually do anything."),
 
3486
    ]
3315
3487
 
3316
 
    def run(self, url='.', format=None):
 
3488
    def run(self, url='.', format=None, clean=False, dry_run=False):
3317
3489
        from bzrlib.upgrade import upgrade
3318
 
        upgrade(url, format)
 
3490
        exceptions = upgrade(url, format, clean_up=clean, dry_run=dry_run)
 
3491
        if exceptions:
 
3492
            if len(exceptions) == 1:
 
3493
                # Compatibility with historical behavior
 
3494
                raise exceptions[0]
 
3495
            else:
 
3496
                return 3
3319
3497
 
3320
3498
 
3321
3499
class cmd_whoami(Command):
3330
3508
 
3331
3509
            bzr whoami "Frank Chu <fchu@example.com>"
3332
3510
    """
3333
 
    takes_options = [ Option('email',
 
3511
    takes_options = [ 'directory',
 
3512
                      Option('email',
3334
3513
                             help='Display email address only.'),
3335
3514
                      Option('branch',
3336
3515
                             help='Set identity for the current branch instead of '
3340
3519
    encoding_type = 'replace'
3341
3520
 
3342
3521
    @display_command
3343
 
    def run(self, email=False, branch=False, name=None):
 
3522
    def run(self, email=False, branch=False, name=None, directory=None):
3344
3523
        if name is None:
3345
 
            # use branch if we're inside one; otherwise global config
3346
 
            try:
3347
 
                c = Branch.open_containing('.')[0].get_config()
3348
 
            except errors.NotBranchError:
3349
 
                c = config.GlobalConfig()
 
3524
            if directory is None:
 
3525
                # use branch if we're inside one; otherwise global config
 
3526
                try:
 
3527
                    c = Branch.open_containing(u'.')[0].get_config()
 
3528
                except errors.NotBranchError:
 
3529
                    c = _mod_config.GlobalConfig()
 
3530
            else:
 
3531
                c = Branch.open(directory).get_config()
3350
3532
            if email:
3351
3533
                self.outf.write(c.user_email() + '\n')
3352
3534
            else:
3353
3535
                self.outf.write(c.username() + '\n')
3354
3536
            return
3355
3537
 
 
3538
        if email:
 
3539
            raise errors.BzrCommandError("--email can only be used to display existing "
 
3540
                                         "identity")
 
3541
 
3356
3542
        # display a warning if an email address isn't included in the given name.
3357
3543
        try:
3358
 
            config.extract_email_address(name)
 
3544
            _mod_config.extract_email_address(name)
3359
3545
        except errors.NoEmailInUsername, e:
3360
3546
            warning('"%s" does not seem to contain an email address.  '
3361
3547
                    'This is allowed, but not recommended.', name)
3362
3548
 
3363
3549
        # use global config unless --branch given
3364
3550
        if branch:
3365
 
            c = Branch.open_containing('.')[0].get_config()
 
3551
            if directory is None:
 
3552
                c = Branch.open_containing(u'.')[0].get_config()
 
3553
            else:
 
3554
                c = Branch.open(directory).get_config()
3366
3555
        else:
3367
 
            c = config.GlobalConfig()
 
3556
            c = _mod_config.GlobalConfig()
3368
3557
        c.set_user_option('email', name)
3369
3558
 
3370
3559
 
3380
3569
 
3381
3570
    _see_also = ['info']
3382
3571
    takes_args = ['nickname?']
3383
 
    def run(self, nickname=None):
3384
 
        branch = Branch.open_containing(u'.')[0]
 
3572
    takes_options = ['directory']
 
3573
    def run(self, nickname=None, directory=u'.'):
 
3574
        branch = Branch.open_containing(directory)[0]
3385
3575
        if nickname is None:
3386
3576
            self.printme(branch)
3387
3577
        else:
3436
3626
                'bzr alias --remove expects an alias to remove.')
3437
3627
        # If alias is not found, print something like:
3438
3628
        # unalias: foo: not found
3439
 
        c = config.GlobalConfig()
 
3629
        c = _mod_config.GlobalConfig()
3440
3630
        c.unset_alias(alias_name)
3441
3631
 
3442
3632
    @display_command
3443
3633
    def print_aliases(self):
3444
3634
        """Print out the defined aliases in a similar format to bash."""
3445
 
        aliases = config.GlobalConfig().get_aliases()
 
3635
        aliases = _mod_config.GlobalConfig().get_aliases()
3446
3636
        for key, value in sorted(aliases.iteritems()):
3447
3637
            self.outf.write('bzr alias %s="%s"\n' % (key, value))
3448
3638
 
3458
3648
 
3459
3649
    def set_alias(self, alias_name, alias_command):
3460
3650
        """Save the alias in the global config."""
3461
 
        c = config.GlobalConfig()
 
3651
        c = _mod_config.GlobalConfig()
3462
3652
        c.set_alias(alias_name, alias_command)
3463
3653
 
3464
3654
 
3499
3689
    If you set BZR_TEST_PDB=1 when running selftest, failing tests will drop
3500
3690
    into a pdb postmortem session.
3501
3691
 
 
3692
    The --coverage=DIRNAME global option produces a report with covered code
 
3693
    indicated.
 
3694
 
3502
3695
    :Examples:
3503
3696
        Run only tests relating to 'ignore'::
3504
3697
 
3515
3708
        if typestring == "sftp":
3516
3709
            from bzrlib.tests import stub_sftp
3517
3710
            return stub_sftp.SFTPAbsoluteServer
3518
 
        if typestring == "memory":
 
3711
        elif typestring == "memory":
3519
3712
            from bzrlib.tests import test_server
3520
3713
            return memory.MemoryServer
3521
 
        if typestring == "fakenfs":
 
3714
        elif typestring == "fakenfs":
3522
3715
            from bzrlib.tests import test_server
3523
3716
            return test_server.FakeNFSServer
3524
3717
        msg = "No known transport type %s. Supported types are: sftp\n" %\
3537
3730
                                 'throughout the test suite.',
3538
3731
                            type=get_transport_type),
3539
3732
                     Option('benchmark',
3540
 
                            help='Run the benchmarks rather than selftests.'),
 
3733
                            help='Run the benchmarks rather than selftests.',
 
3734
                            hidden=True),
3541
3735
                     Option('lsprof-timed',
3542
3736
                            help='Generate lsprof output for benchmarked'
3543
3737
                                 ' sections of code.'),
3544
3738
                     Option('lsprof-tests',
3545
3739
                            help='Generate lsprof output for each test.'),
3546
 
                     Option('cache-dir', type=str,
3547
 
                            help='Cache intermediate benchmark output in this '
3548
 
                                 'directory.'),
3549
3740
                     Option('first',
3550
3741
                            help='Run all tests, but run specified tests first.',
3551
3742
                            short_name='f',
3560
3751
                     Option('randomize', type=str, argname="SEED",
3561
3752
                            help='Randomize the order of tests using the given'
3562
3753
                                 ' seed or "now" for the current time.'),
3563
 
                     Option('exclude', type=str, argname="PATTERN",
3564
 
                            short_name='x',
3565
 
                            help='Exclude tests that match this regular'
3566
 
                                 ' expression.'),
 
3754
                     ListOption('exclude', type=str, argname="PATTERN",
 
3755
                                short_name='x',
 
3756
                                help='Exclude tests that match this regular'
 
3757
                                ' expression.'),
3567
3758
                     Option('subunit',
3568
3759
                        help='Output test progress via subunit.'),
3569
3760
                     Option('strict', help='Fail on missing dependencies or '
3585
3776
 
3586
3777
    def run(self, testspecs_list=None, verbose=False, one=False,
3587
3778
            transport=None, benchmark=None,
3588
 
            lsprof_timed=None, cache_dir=None,
 
3779
            lsprof_timed=None,
3589
3780
            first=False, list_only=False,
3590
3781
            randomize=None, exclude=None, strict=False,
3591
3782
            load_list=None, debugflag=None, starting_with=None, subunit=False,
3592
3783
            parallel=None, lsprof_tests=False):
3593
 
        from bzrlib.tests import selftest
3594
 
        import bzrlib.benchmarks as benchmarks
3595
 
        from bzrlib.benchmarks import tree_creator
3596
 
 
3597
 
        # Make deprecation warnings visible, unless -Werror is set
3598
 
        symbol_versioning.activate_deprecation_warnings(override=False)
3599
 
 
3600
 
        if cache_dir is not None:
3601
 
            tree_creator.TreeCreator.CACHE_ROOT = osutils.abspath(cache_dir)
 
3784
        from bzrlib import tests
 
3785
 
3602
3786
        if testspecs_list is not None:
3603
3787
            pattern = '|'.join(testspecs_list)
3604
3788
        else:
3612
3796
            self.additional_selftest_args['runner_class'] = SubUnitBzrRunner
3613
3797
            # On Windows, disable automatic conversion of '\n' to '\r\n' in
3614
3798
            # stdout, which would corrupt the subunit stream. 
3615
 
            if sys.platform == "win32" and sys.stdout.fileno() >= 0:
 
3799
            # FIXME: This has been fixed in subunit trunk (>0.0.5) so the
 
3800
            # following code can be deleted when it's sufficiently deployed
 
3801
            # -- vila/mgz 20100514
 
3802
            if (sys.platform == "win32"
 
3803
                and getattr(sys.stdout, 'fileno', None) is not None):
3616
3804
                import msvcrt
3617
3805
                msvcrt.setmode(sys.stdout.fileno(), os.O_BINARY)
3618
3806
        if parallel:
3619
3807
            self.additional_selftest_args.setdefault(
3620
3808
                'suite_decorators', []).append(parallel)
3621
3809
        if benchmark:
3622
 
            test_suite_factory = benchmarks.test_suite
3623
 
            # Unless user explicitly asks for quiet, be verbose in benchmarks
3624
 
            verbose = not is_quiet()
3625
 
            # TODO: should possibly lock the history file...
3626
 
            benchfile = open(".perf_history", "at", buffering=1)
3627
 
            self.add_cleanup(benchfile.close)
 
3810
            raise errors.BzrCommandError(
 
3811
                "--benchmark is no longer supported from bzr 2.2; "
 
3812
                "use bzr-usertest instead")
 
3813
        test_suite_factory = None
 
3814
        if not exclude:
 
3815
            exclude_pattern = None
3628
3816
        else:
3629
 
            test_suite_factory = None
3630
 
            benchfile = None
 
3817
            exclude_pattern = '(' + '|'.join(exclude) + ')'
3631
3818
        selftest_kwargs = {"verbose": verbose,
3632
3819
                          "pattern": pattern,
3633
3820
                          "stop_on_failure": one,
3635
3822
                          "test_suite_factory": test_suite_factory,
3636
3823
                          "lsprof_timed": lsprof_timed,
3637
3824
                          "lsprof_tests": lsprof_tests,
3638
 
                          "bench_history": benchfile,
3639
3825
                          "matching_tests_first": first,
3640
3826
                          "list_only": list_only,
3641
3827
                          "random_seed": randomize,
3642
 
                          "exclude_pattern": exclude,
 
3828
                          "exclude_pattern": exclude_pattern,
3643
3829
                          "strict": strict,
3644
3830
                          "load_list": load_list,
3645
3831
                          "debug_flags": debugflag,
3646
3832
                          "starting_with": starting_with
3647
3833
                          }
3648
3834
        selftest_kwargs.update(self.additional_selftest_args)
3649
 
        result = selftest(**selftest_kwargs)
 
3835
 
 
3836
        # Make deprecation warnings visible, unless -Werror is set
 
3837
        cleanup = symbol_versioning.activate_deprecation_warnings(
 
3838
            override=False)
 
3839
        try:
 
3840
            result = tests.selftest(**selftest_kwargs)
 
3841
        finally:
 
3842
            cleanup()
3650
3843
        return int(not result)
3651
3844
 
3652
3845
 
3690
3883
 
3691
3884
        branch1 = Branch.open_containing(branch)[0]
3692
3885
        branch2 = Branch.open_containing(other)[0]
3693
 
        branch1.lock_read()
3694
 
        self.add_cleanup(branch1.unlock)
3695
 
        branch2.lock_read()
3696
 
        self.add_cleanup(branch2.unlock)
 
3886
        self.add_cleanup(branch1.lock_read().unlock)
 
3887
        self.add_cleanup(branch2.lock_read().unlock)
3697
3888
        last1 = ensure_null(branch1.last_revision())
3698
3889
        last2 = ensure_null(branch2.last_revision())
3699
3890
 
3709
3900
    The source of the merge can be specified either in the form of a branch,
3710
3901
    or in the form of a path to a file containing a merge directive generated
3711
3902
    with bzr send. If neither is specified, the default is the upstream branch
3712
 
    or the branch most recently merged using --remember.
3713
 
 
3714
 
    When merging a branch, by default the tip will be merged. To pick a different
3715
 
    revision, pass --revision. If you specify two values, the first will be used as
3716
 
    BASE and the second one as OTHER. Merging individual revisions, or a subset of
3717
 
    available revisions, like this is commonly referred to as "cherrypicking".
3718
 
 
3719
 
    Revision numbers are always relative to the branch being merged.
3720
 
 
3721
 
    By default, bzr will try to merge in all new work from the other
3722
 
    branch, automatically determining an appropriate base.  If this
3723
 
    fails, you may need to give an explicit base.
 
3903
    or the branch most recently merged using --remember.  The source of the
 
3904
    merge may also be specified in the form of a path to a file in another
 
3905
    branch:  in this case, only the modifications to that file are merged into
 
3906
    the current working tree.
 
3907
 
 
3908
    When merging from a branch, by default bzr will try to merge in all new
 
3909
    work from the other branch, automatically determining an appropriate base
 
3910
    revision.  If this fails, you may need to give an explicit base.
 
3911
 
 
3912
    To pick a different ending revision, pass "--revision OTHER".  bzr will
 
3913
    try to merge in all new work up to and including revision OTHER.
 
3914
 
 
3915
    If you specify two values, "--revision BASE..OTHER", only revisions BASE
 
3916
    through OTHER, excluding BASE but including OTHER, will be merged.  If this
 
3917
    causes some revisions to be skipped, i.e. if the destination branch does
 
3918
    not already contain revision BASE, such a merge is commonly referred to as
 
3919
    a "cherrypick". Unlike a normal merge, Bazaar does not currently track
 
3920
    cherrypicks. The changes look like a normal commit, and the history of the
 
3921
    changes from the other branch is not stored in the commit.
 
3922
 
 
3923
    Revision numbers are always relative to the source branch.
3724
3924
 
3725
3925
    Merge will do its best to combine the changes in two branches, but there
3726
3926
    are some kinds of problems only a human can fix.  When it encounters those,
3729
3929
 
3730
3930
    Use bzr resolve when you have fixed a problem.  See also bzr conflicts.
3731
3931
 
3732
 
    If there is no default branch set, the first merge will set it. After
3733
 
    that, you can omit the branch to use the default.  To change the
3734
 
    default, use --remember. The value will only be saved if the remote
3735
 
    location can be accessed.
 
3932
    If there is no default branch set, the first merge will set it (use
 
3933
    --no-remember to avoid settting it). After that, you can omit the branch
 
3934
    to use the default.  To change the default, use --remember. The value will
 
3935
    only be saved if the remote location can be accessed.
3736
3936
 
3737
3937
    The results of the merge are placed into the destination working
3738
3938
    directory, where they can be reviewed (with bzr diff), tested, and then
3739
3939
    committed to record the result of the merge.
3740
3940
 
3741
3941
    merge refuses to run if there are any uncommitted changes, unless
3742
 
    --force is given. The --force option can also be used to create a
 
3942
    --force is given.  If --force is given, then the changes from the source 
 
3943
    will be merged with the current working tree, including any uncommitted
 
3944
    changes in the tree.  The --force option can also be used to create a
3743
3945
    merge revision which has more than two parents.
3744
3946
 
3745
3947
    If one would like to merge changes from the working tree of the other
3750
3952
    you to apply each diff hunk and file change, similar to "shelve".
3751
3953
 
3752
3954
    :Examples:
3753
 
        To merge the latest revision from bzr.dev::
 
3955
        To merge all new revisions from bzr.dev::
3754
3956
 
3755
3957
            bzr merge ../bzr.dev
3756
3958
 
3793
3995
                ' completely merged into the source, pull from the'
3794
3996
                ' source rather than merging.  When this happens,'
3795
3997
                ' you do not need to commit the result.'),
3796
 
        Option('directory',
 
3998
        custom_help('directory',
3797
3999
               help='Branch to merge into, '
3798
 
                    'rather than the one containing the working directory.',
3799
 
               short_name='d',
3800
 
               type=unicode,
3801
 
               ),
 
4000
                    'rather than the one containing the working directory.'),
3802
4001
        Option('preview', help='Instead of merging, show a diff of the'
3803
4002
               ' merge.'),
3804
4003
        Option('interactive', help='Select changes interactively.',
3806
4005
    ]
3807
4006
 
3808
4007
    def run(self, location=None, revision=None, force=False,
3809
 
            merge_type=None, show_base=False, reprocess=None, remember=False,
 
4008
            merge_type=None, show_base=False, reprocess=None, remember=None,
3810
4009
            uncommitted=False, pull=False,
3811
4010
            directory=None,
3812
4011
            preview=False,
3820
4019
        merger = None
3821
4020
        allow_pending = True
3822
4021
        verified = 'inapplicable'
 
4022
 
3823
4023
        tree = WorkingTree.open_containing(directory)[0]
 
4024
        if tree.branch.revno() == 0:
 
4025
            raise errors.BzrCommandError('Merging into empty branches not currently supported, '
 
4026
                                         'https://bugs.launchpad.net/bzr/+bug/308562')
3824
4027
 
3825
4028
        try:
3826
4029
            basis_tree = tree.revision_tree(tree.last_revision())
3837
4040
            unversioned_filter=tree.is_ignored, view_info=view_info)
3838
4041
        pb = ui.ui_factory.nested_progress_bar()
3839
4042
        self.add_cleanup(pb.finished)
3840
 
        tree.lock_write()
3841
 
        self.add_cleanup(tree.unlock)
 
4043
        self.add_cleanup(tree.lock_write().unlock)
3842
4044
        if location is not None:
3843
4045
            try:
3844
4046
                mergeable = bundle.read_mergeable_from_url(location,
3873
4075
        self.sanity_check_merger(merger)
3874
4076
        if (merger.base_rev_id == merger.other_rev_id and
3875
4077
            merger.other_rev_id is not None):
 
4078
            # check if location is a nonexistent file (and not a branch) to
 
4079
            # disambiguate the 'Nothing to do'
 
4080
            if merger.interesting_files:
 
4081
                if not merger.other_tree.has_filename(
 
4082
                    merger.interesting_files[0]):
 
4083
                    note("merger: " + str(merger))
 
4084
                    raise errors.PathsDoNotExist([location])
3876
4085
            note('Nothing to do.')
3877
4086
            return 0
3878
 
        if pull:
 
4087
        if pull and not preview:
3879
4088
            if merger.interesting_files is not None:
3880
4089
                raise errors.BzrCommandError('Cannot pull individual files')
3881
4090
            if (merger.base_rev_id == tree.last_revision()):
3905
4114
    def _do_preview(self, merger):
3906
4115
        from bzrlib.diff import show_diff_trees
3907
4116
        result_tree = self._get_preview(merger)
 
4117
        path_encoding = osutils.get_diff_header_encoding()
3908
4118
        show_diff_trees(merger.this_tree, result_tree, self.outf,
3909
 
                        old_label='', new_label='')
 
4119
                        old_label='', new_label='',
 
4120
                        path_encoding=path_encoding)
3910
4121
 
3911
4122
    def _do_merge(self, merger, change_reporter, allow_pending, verified):
3912
4123
        merger.change_reporter = change_reporter
3988
4199
        if other_revision_id is None:
3989
4200
            other_revision_id = _mod_revision.ensure_null(
3990
4201
                other_branch.last_revision())
3991
 
        # Remember where we merge from
3992
 
        if ((remember or tree.branch.get_submit_branch() is None) and
3993
 
             user_location is not None):
 
4202
        # Remember where we merge from. We need to remember if:
 
4203
        # - user specify a location (and we don't merge from the parent
 
4204
        #   branch)
 
4205
        # - user ask to remember or there is no previous location set to merge
 
4206
        #   from and user didn't ask to *not* remember
 
4207
        if (user_location is not None
 
4208
            and ((remember
 
4209
                  or (remember is None
 
4210
                      and tree.branch.get_submit_branch() is None)))):
3994
4211
            tree.branch.set_submit_branch(other_branch.base)
3995
 
        _merge_tags_if_possible(other_branch, tree.branch)
 
4212
        # Merge tags (but don't set them in the master branch yet, the user
 
4213
        # might revert this merge).  Commit will propagate them.
 
4214
        _merge_tags_if_possible(other_branch, tree.branch, ignore_master=True)
3996
4215
        merger = _mod_merge.Merger.from_revision_ids(pb, tree,
3997
4216
            other_revision_id, base_revision_id, other_branch, base_branch)
3998
4217
        if other_path != '':
4099
4318
        from bzrlib.conflicts import restore
4100
4319
        if merge_type is None:
4101
4320
            merge_type = _mod_merge.Merge3Merger
4102
 
        tree, file_list = tree_files(file_list)
4103
 
        tree.lock_write()
4104
 
        self.add_cleanup(tree.unlock)
 
4321
        tree, file_list = WorkingTree.open_containing_paths(file_list)
 
4322
        self.add_cleanup(tree.lock_write().unlock)
4105
4323
        parents = tree.get_parent_ids()
4106
4324
        if len(parents) != 2:
4107
4325
            raise errors.BzrCommandError("Sorry, remerge only works after normal"
4167
4385
    last committed revision is used.
4168
4386
 
4169
4387
    To remove only some changes, without reverting to a prior version, use
4170
 
    merge instead.  For example, "merge . --revision -2..-3" will remove the
4171
 
    changes introduced by -2, without affecting the changes introduced by -1.
4172
 
    Or to remove certain changes on a hunk-by-hunk basis, see the Shelf plugin.
 
4388
    merge instead.  For example, "merge . -r -2..-3" (don't forget the ".")
 
4389
    will remove the changes introduced by the second last commit (-2), without
 
4390
    affecting the changes introduced by the last commit (-1).  To remove
 
4391
    certain changes on a hunk-by-hunk basis, see the shelve command.
4173
4392
 
4174
4393
    By default, any files that have been manually changed will be backed up
4175
4394
    first.  (Files changed only by merge are not backed up.)  Backup files have
4205
4424
    target branches.
4206
4425
    """
4207
4426
 
4208
 
    _see_also = ['cat', 'export']
 
4427
    _see_also = ['cat', 'export', 'merge', 'shelve']
4209
4428
    takes_options = [
4210
4429
        'revision',
4211
4430
        Option('no-backup', "Do not save backups of reverted files."),
4216
4435
 
4217
4436
    def run(self, revision=None, no_backup=False, file_list=None,
4218
4437
            forget_merges=None):
4219
 
        tree, file_list = tree_files(file_list)
4220
 
        tree.lock_tree_write()
4221
 
        self.add_cleanup(tree.unlock)
 
4438
        tree, file_list = WorkingTree.open_containing_paths(file_list)
 
4439
        self.add_cleanup(tree.lock_tree_write().unlock)
4222
4440
        if forget_merges:
4223
4441
            tree.set_parent_ids(tree.get_parent_ids()[:1])
4224
4442
        else:
4313
4531
    _see_also = ['merge', 'pull']
4314
4532
    takes_args = ['other_branch?']
4315
4533
    takes_options = [
 
4534
        'directory',
4316
4535
        Option('reverse', 'Reverse the order of revisions.'),
4317
4536
        Option('mine-only',
4318
4537
               'Display changes in the local branch only.'),
4340
4559
            theirs_only=False,
4341
4560
            log_format=None, long=False, short=False, line=False,
4342
4561
            show_ids=False, verbose=False, this=False, other=False,
4343
 
            include_merges=False, revision=None, my_revision=None):
 
4562
            include_merges=False, revision=None, my_revision=None,
 
4563
            directory=u'.'):
4344
4564
        from bzrlib.missing import find_unmerged, iter_log_revisions
4345
4565
        def message(s):
4346
4566
            if not is_quiet():
4359
4579
        elif theirs_only:
4360
4580
            restrict = 'remote'
4361
4581
 
4362
 
        local_branch = Branch.open_containing(u".")[0]
4363
 
        local_branch.lock_read()
4364
 
        self.add_cleanup(local_branch.unlock)
 
4582
        local_branch = Branch.open_containing(directory)[0]
 
4583
        self.add_cleanup(local_branch.lock_read().unlock)
4365
4584
 
4366
4585
        parent = local_branch.get_parent()
4367
4586
        if other_branch is None:
4378
4597
        if remote_branch.base == local_branch.base:
4379
4598
            remote_branch = local_branch
4380
4599
        else:
4381
 
            remote_branch.lock_read()
4382
 
            self.add_cleanup(remote_branch.unlock)
 
4600
            self.add_cleanup(remote_branch.lock_read().unlock)
4383
4601
 
4384
4602
        local_revid_range = _revision_range_to_revid_range(
4385
4603
            _get_revision_range(my_revision, local_branch,
4440
4658
            message("Branches are up to date.\n")
4441
4659
        self.cleanup_now()
4442
4660
        if not status_code and parent is None and other_branch is not None:
4443
 
            local_branch.lock_write()
4444
 
            self.add_cleanup(local_branch.unlock)
 
4661
            self.add_cleanup(local_branch.lock_write().unlock)
4445
4662
            # handle race conditions - a parent might be set while we run.
4446
4663
            if local_branch.get_parent() is None:
4447
4664
                local_branch.set_parent(remote_branch.base)
4506
4723
 
4507
4724
    @display_command
4508
4725
    def run(self, verbose=False):
4509
 
        import bzrlib.plugin
4510
 
        from inspect import getdoc
4511
 
        result = []
4512
 
        for name, plugin in bzrlib.plugin.plugins().items():
4513
 
            version = plugin.__version__
4514
 
            if version == 'unknown':
4515
 
                version = ''
4516
 
            name_ver = '%s %s' % (name, version)
4517
 
            d = getdoc(plugin.module)
4518
 
            if d:
4519
 
                doc = d.split('\n')[0]
4520
 
            else:
4521
 
                doc = '(no description)'
4522
 
            result.append((name_ver, doc, plugin.path()))
4523
 
        for name_ver, doc, path in sorted(result):
4524
 
            self.outf.write("%s\n" % name_ver)
4525
 
            self.outf.write("   %s\n" % doc)
4526
 
            if verbose:
4527
 
                self.outf.write("   %s\n" % path)
4528
 
            self.outf.write("\n")
 
4726
        from bzrlib import plugin
 
4727
        # Don't give writelines a generator as some codecs don't like that
 
4728
        self.outf.writelines(
 
4729
            list(plugin.describe_plugins(show_paths=verbose)))
4529
4730
 
4530
4731
 
4531
4732
class cmd_testament(Command):
4547
4748
            b = Branch.open_containing(branch)[0]
4548
4749
        else:
4549
4750
            b = Branch.open(branch)
4550
 
        b.lock_read()
4551
 
        self.add_cleanup(b.unlock)
 
4751
        self.add_cleanup(b.lock_read().unlock)
4552
4752
        if revision is None:
4553
4753
            rev_id = b.last_revision()
4554
4754
        else:
4578
4778
                     Option('long', help='Show commit date in annotations.'),
4579
4779
                     'revision',
4580
4780
                     'show-ids',
 
4781
                     'directory',
4581
4782
                     ]
4582
4783
    encoding_type = 'exact'
4583
4784
 
4584
4785
    @display_command
4585
4786
    def run(self, filename, all=False, long=False, revision=None,
4586
 
            show_ids=False):
4587
 
        from bzrlib.annotate import annotate_file, annotate_file_tree
 
4787
            show_ids=False, directory=None):
 
4788
        from bzrlib.annotate import (
 
4789
            annotate_file_tree,
 
4790
            )
4588
4791
        wt, branch, relpath = \
4589
 
            bzrdir.BzrDir.open_containing_tree_or_branch(filename)
 
4792
            _open_directory_or_containing_tree_or_branch(filename, directory)
4590
4793
        if wt is not None:
4591
 
            wt.lock_read()
4592
 
            self.add_cleanup(wt.unlock)
 
4794
            self.add_cleanup(wt.lock_read().unlock)
4593
4795
        else:
4594
 
            branch.lock_read()
4595
 
            self.add_cleanup(branch.unlock)
 
4796
            self.add_cleanup(branch.lock_read().unlock)
4596
4797
        tree = _get_one_revision_tree('annotate', revision, branch=branch)
4597
 
        tree.lock_read()
4598
 
        self.add_cleanup(tree.unlock)
4599
 
        if wt is not None:
 
4798
        self.add_cleanup(tree.lock_read().unlock)
 
4799
        if wt is not None and revision is None:
4600
4800
            file_id = wt.path2id(relpath)
4601
4801
        else:
4602
4802
            file_id = tree.path2id(relpath)
4603
4803
        if file_id is None:
4604
4804
            raise errors.NotVersionedError(filename)
4605
 
        file_version = tree.inventory[file_id].revision
4606
4805
        if wt is not None and revision is None:
4607
4806
            # If there is a tree and we're not annotating historical
4608
4807
            # versions, annotate the working tree's content.
4609
4808
            annotate_file_tree(wt, file_id, self.outf, long, all,
4610
4809
                show_ids=show_ids)
4611
4810
        else:
4612
 
            annotate_file(branch, file_version, file_id, long, all, self.outf,
4613
 
                          show_ids=show_ids)
 
4811
            annotate_file_tree(tree, file_id, self.outf, long, all,
 
4812
                show_ids=show_ids, branch=branch)
4614
4813
 
4615
4814
 
4616
4815
class cmd_re_sign(Command):
4619
4818
 
4620
4819
    hidden = True # is this right ?
4621
4820
    takes_args = ['revision_id*']
4622
 
    takes_options = ['revision']
 
4821
    takes_options = ['directory', 'revision']
4623
4822
 
4624
 
    def run(self, revision_id_list=None, revision=None):
 
4823
    def run(self, revision_id_list=None, revision=None, directory=u'.'):
4625
4824
        if revision_id_list is not None and revision is not None:
4626
4825
            raise errors.BzrCommandError('You can only supply one of revision_id or --revision')
4627
4826
        if revision_id_list is None and revision is None:
4628
4827
            raise errors.BzrCommandError('You must supply either --revision or a revision_id')
4629
 
        b = WorkingTree.open_containing(u'.')[0].branch
4630
 
        b.lock_write()
4631
 
        self.add_cleanup(b.unlock)
 
4828
        b = WorkingTree.open_containing(directory)[0].branch
 
4829
        self.add_cleanup(b.lock_write().unlock)
4632
4830
        return self._run(b, revision_id_list, revision)
4633
4831
 
4634
4832
    def _run(self, b, revision_id_list, revision):
4693
4891
 
4694
4892
    _see_also = ['checkouts', 'unbind']
4695
4893
    takes_args = ['location?']
4696
 
    takes_options = []
 
4894
    takes_options = ['directory']
4697
4895
 
4698
 
    def run(self, location=None):
4699
 
        b, relpath = Branch.open_containing(u'.')
 
4896
    def run(self, location=None, directory=u'.'):
 
4897
        b, relpath = Branch.open_containing(directory)
4700
4898
        if location is None:
4701
4899
            try:
4702
4900
                location = b.get_old_bound_location()
4729
4927
 
4730
4928
    _see_also = ['checkouts', 'bind']
4731
4929
    takes_args = []
4732
 
    takes_options = []
 
4930
    takes_options = ['directory']
4733
4931
 
4734
 
    def run(self):
4735
 
        b, relpath = Branch.open_containing(u'.')
 
4932
    def run(self, directory=u'.'):
 
4933
        b, relpath = Branch.open_containing(directory)
4736
4934
        if not b.unbind():
4737
4935
            raise errors.BzrCommandError('Local branch is not bound')
4738
4936
 
4784
4982
            b = control.open_branch()
4785
4983
 
4786
4984
        if tree is not None:
4787
 
            tree.lock_write()
4788
 
            self.add_cleanup(tree.unlock)
 
4985
            self.add_cleanup(tree.lock_write().unlock)
4789
4986
        else:
4790
 
            b.lock_write()
4791
 
            self.add_cleanup(b.unlock)
 
4987
            self.add_cleanup(b.lock_write().unlock)
4792
4988
        return self._run(b, tree, dry_run, verbose, revision, force, local=local)
4793
4989
 
4794
4990
    def _run(self, b, tree, dry_run, verbose, revision, force, local=False):
4833
5029
            self.outf.write('The above revision(s) will be removed.\n')
4834
5030
 
4835
5031
        if not force:
4836
 
            if not ui.ui_factory.get_boolean('Are you sure'):
4837
 
                self.outf.write('Canceled')
 
5032
            if not ui.ui_factory.confirm_action(
 
5033
                    u'Uncommit these revisions',
 
5034
                    'bzrlib.builtins.uncommit',
 
5035
                    {}):
 
5036
                self.outf.write('Canceled\n')
4838
5037
                return 0
4839
5038
 
4840
5039
        mutter('Uncommitting from {%s} to {%s}',
4846
5045
 
4847
5046
 
4848
5047
class cmd_break_lock(Command):
4849
 
    __doc__ = """Break a dead lock on a repository, branch or working directory.
 
5048
    __doc__ = """Break a dead lock.
 
5049
 
 
5050
    This command breaks a lock on a repository, branch, working directory or
 
5051
    config file.
4850
5052
 
4851
5053
    CAUTION: Locks should only be broken when you are sure that the process
4852
5054
    holding the lock has been stopped.
4857
5059
    :Examples:
4858
5060
        bzr break-lock
4859
5061
        bzr break-lock bzr+ssh://example.com/bzr/foo
 
5062
        bzr break-lock --conf ~/.bazaar
4860
5063
    """
 
5064
 
4861
5065
    takes_args = ['location?']
 
5066
    takes_options = [
 
5067
        Option('config',
 
5068
               help='LOCATION is the directory where the config lock is.'),
 
5069
        Option('force',
 
5070
            help='Do not ask for confirmation before breaking the lock.'),
 
5071
        ]
4862
5072
 
4863
 
    def run(self, location=None, show=False):
 
5073
    def run(self, location=None, config=False, force=False):
4864
5074
        if location is None:
4865
5075
            location = u'.'
4866
 
        control, relpath = bzrdir.BzrDir.open_containing(location)
4867
 
        try:
4868
 
            control.break_lock()
4869
 
        except NotImplementedError:
4870
 
            pass
 
5076
        if force:
 
5077
            ui.ui_factory = ui.ConfirmationUserInterfacePolicy(ui.ui_factory,
 
5078
                None,
 
5079
                {'bzrlib.lockdir.break': True})
 
5080
        if config:
 
5081
            conf = _mod_config.LockableConfig(file_name=location)
 
5082
            conf.break_lock()
 
5083
        else:
 
5084
            control, relpath = bzrdir.BzrDir.open_containing(location)
 
5085
            try:
 
5086
                control.break_lock()
 
5087
            except NotImplementedError:
 
5088
                pass
4871
5089
 
4872
5090
 
4873
5091
class cmd_wait_until_signalled(Command):
4902
5120
                    'result in a dynamically allocated port.  The default port '
4903
5121
                    'depends on the protocol.',
4904
5122
               type=str),
4905
 
        Option('directory',
4906
 
               help='Serve contents of this directory.',
4907
 
               type=unicode),
 
5123
        custom_help('directory',
 
5124
               help='Serve contents of this directory.'),
4908
5125
        Option('allow-writes',
4909
5126
               help='By default the server is a readonly server.  Supplying '
4910
5127
                    '--allow-writes enables write access to the contents of '
4937
5154
 
4938
5155
    def run(self, port=None, inet=False, directory=None, allow_writes=False,
4939
5156
            protocol=None):
4940
 
        from bzrlib.transport import get_transport, transport_server_registry
 
5157
        from bzrlib import transport
4941
5158
        if directory is None:
4942
5159
            directory = os.getcwd()
4943
5160
        if protocol is None:
4944
 
            protocol = transport_server_registry.get()
 
5161
            protocol = transport.transport_server_registry.get()
4945
5162
        host, port = self.get_host_and_port(port)
4946
5163
        url = urlutils.local_path_to_url(directory)
4947
5164
        if not allow_writes:
4948
5165
            url = 'readonly+' + url
4949
 
        transport = get_transport(url)
4950
 
        protocol(transport, host, port, inet)
 
5166
        t = transport.get_transport(url)
 
5167
        protocol(t, host, port, inet)
4951
5168
 
4952
5169
 
4953
5170
class cmd_join(Command):
4959
5176
    not part of it.  (Such trees can be produced by "bzr split", but also by
4960
5177
    running "bzr branch" with the target inside a tree.)
4961
5178
 
4962
 
    The result is a combined tree, with the subtree no longer an independant
 
5179
    The result is a combined tree, with the subtree no longer an independent
4963
5180
    part.  This is marked as a merge of the subtree into the containing tree,
4964
5181
    and all history is preserved.
4965
5182
    """
5046
5263
    _see_also = ['send']
5047
5264
 
5048
5265
    takes_options = [
 
5266
        'directory',
5049
5267
        RegistryOption.from_kwargs('patch-type',
5050
5268
            'The type of patch to include in the directive.',
5051
5269
            title='Patch type',
5064
5282
    encoding_type = 'exact'
5065
5283
 
5066
5284
    def run(self, submit_branch=None, public_branch=None, patch_type='bundle',
5067
 
            sign=False, revision=None, mail_to=None, message=None):
 
5285
            sign=False, revision=None, mail_to=None, message=None,
 
5286
            directory=u'.'):
5068
5287
        from bzrlib.revision import ensure_null, NULL_REVISION
5069
5288
        include_patch, include_bundle = {
5070
5289
            'plain': (False, False),
5071
5290
            'diff': (True, False),
5072
5291
            'bundle': (True, True),
5073
5292
            }[patch_type]
5074
 
        branch = Branch.open('.')
 
5293
        branch = Branch.open(directory)
5075
5294
        stored_submit_branch = branch.get_submit_branch()
5076
5295
        if submit_branch is None:
5077
5296
            submit_branch = stored_submit_branch
5153
5372
    source branch defaults to that containing the working directory, but can
5154
5373
    be changed using --from.
5155
5374
 
 
5375
    Both the submit branch and the public branch follow the usual behavior with
 
5376
    respect to --remember: If there is no default location set, the first send
 
5377
    will set it (use --no-remember to avoid settting it). After that, you can
 
5378
    omit the location to use the default.  To change the default, use
 
5379
    --remember. The value will only be saved if the location can be accessed.
 
5380
 
5156
5381
    In order to calculate those changes, bzr must analyse the submit branch.
5157
5382
    Therefore it is most efficient for the submit branch to be a local mirror.
5158
5383
    If a public location is known for the submit_branch, that location is used
5162
5387
    given, in which case it is sent to a file.
5163
5388
 
5164
5389
    Mail is sent using your preferred mail program.  This should be transparent
5165
 
    on Windows (it uses MAPI).  On Linux, it requires the xdg-email utility.
 
5390
    on Windows (it uses MAPI).  On Unix, it requires the xdg-email utility.
5166
5391
    If the preferred client can't be found (or used), your editor will be used.
5167
5392
 
5168
5393
    To use a specific mail program, set the mail_client configuration option.
5227
5452
        ]
5228
5453
 
5229
5454
    def run(self, submit_branch=None, public_branch=None, no_bundle=False,
5230
 
            no_patch=False, revision=None, remember=False, output=None,
 
5455
            no_patch=False, revision=None, remember=None, output=None,
5231
5456
            format=None, mail_to=None, message=None, body=None,
5232
5457
            strict=None, **kwargs):
5233
5458
        from bzrlib.send import send
5339
5564
        Option('delete',
5340
5565
            help='Delete this tag rather than placing it.',
5341
5566
            ),
5342
 
        Option('directory',
5343
 
            help='Branch in which to place the tag.',
5344
 
            short_name='d',
5345
 
            type=unicode,
5346
 
            ),
 
5567
        custom_help('directory',
 
5568
            help='Branch in which to place the tag.'),
5347
5569
        Option('force',
5348
5570
            help='Replace existing tags.',
5349
5571
            ),
5357
5579
            revision=None,
5358
5580
            ):
5359
5581
        branch, relpath = Branch.open_containing(directory)
5360
 
        branch.lock_write()
5361
 
        self.add_cleanup(branch.unlock)
 
5582
        self.add_cleanup(branch.lock_write().unlock)
5362
5583
        if delete:
5363
5584
            if tag_name is None:
5364
5585
                raise errors.BzrCommandError("No tag specified to delete.")
5365
5586
            branch.tags.delete_tag(tag_name)
5366
 
            self.outf.write('Deleted tag %s.\n' % tag_name)
 
5587
            note('Deleted tag %s.' % tag_name)
5367
5588
        else:
5368
5589
            if revision:
5369
5590
                if len(revision) != 1:
5381
5602
            if (not force) and branch.tags.has_tag(tag_name):
5382
5603
                raise errors.TagAlreadyExists(tag_name)
5383
5604
            branch.tags.set_tag(tag_name, revision_id)
5384
 
            self.outf.write('Created tag %s.\n' % tag_name)
 
5605
            note('Created tag %s.' % tag_name)
5385
5606
 
5386
5607
 
5387
5608
class cmd_tags(Command):
5392
5613
 
5393
5614
    _see_also = ['tag']
5394
5615
    takes_options = [
5395
 
        Option('directory',
5396
 
            help='Branch whose tags should be displayed.',
5397
 
            short_name='d',
5398
 
            type=unicode,
5399
 
            ),
5400
 
        RegistryOption.from_kwargs('sort',
 
5616
        custom_help('directory',
 
5617
            help='Branch whose tags should be displayed.'),
 
5618
        RegistryOption('sort',
5401
5619
            'Sort tags by different criteria.', title='Sorting',
5402
 
            alpha='Sort tags lexicographically (default).',
5403
 
            time='Sort tags chronologically.',
 
5620
            lazy_registry=('bzrlib.tag', 'tag_sort_methods')
5404
5621
            ),
5405
5622
        'show-ids',
5406
5623
        'revision',
5407
5624
    ]
5408
5625
 
5409
5626
    @display_command
5410
 
    def run(self,
5411
 
            directory='.',
5412
 
            sort='alpha',
5413
 
            show_ids=False,
5414
 
            revision=None,
5415
 
            ):
 
5627
    def run(self, directory='.', sort=None, show_ids=False, revision=None):
 
5628
        from bzrlib.tag import tag_sort_methods
5416
5629
        branch, relpath = Branch.open_containing(directory)
5417
5630
 
5418
5631
        tags = branch.tags.get_tag_dict().items()
5419
5632
        if not tags:
5420
5633
            return
5421
5634
 
5422
 
        branch.lock_read()
5423
 
        self.add_cleanup(branch.unlock)
 
5635
        self.add_cleanup(branch.lock_read().unlock)
5424
5636
        if revision:
5425
5637
            graph = branch.repository.get_graph()
5426
5638
            rev1, rev2 = _get_revision_range(revision, branch, self.name())
5428
5640
            # only show revisions between revid1 and revid2 (inclusive)
5429
5641
            tags = [(tag, revid) for tag, revid in tags if
5430
5642
                graph.is_between(revid, revid1, revid2)]
5431
 
        if sort == 'alpha':
5432
 
            tags.sort()
5433
 
        elif sort == 'time':
5434
 
            timestamps = {}
5435
 
            for tag, revid in tags:
5436
 
                try:
5437
 
                    revobj = branch.repository.get_revision(revid)
5438
 
                except errors.NoSuchRevision:
5439
 
                    timestamp = sys.maxint # place them at the end
5440
 
                else:
5441
 
                    timestamp = revobj.timestamp
5442
 
                timestamps[revid] = timestamp
5443
 
            tags.sort(key=lambda x: timestamps[x[1]])
 
5643
        if sort is None:
 
5644
            sort = tag_sort_methods.get()
 
5645
        sort(branch, tags)
5444
5646
        if not show_ids:
5445
5647
            # [ (tag, revid), ... ] -> [ (tag, dotted_revno), ... ]
5446
5648
            for index, (tag, revid) in enumerate(tags):
5448
5650
                    revno = branch.revision_id_to_dotted_revno(revid)
5449
5651
                    if isinstance(revno, tuple):
5450
5652
                        revno = '.'.join(map(str, revno))
5451
 
                except errors.NoSuchRevision:
 
5653
                except (errors.NoSuchRevision, errors.GhostRevisionsHaveNoRevno):
5452
5654
                    # Bad tag data/merges can lead to tagged revisions
5453
5655
                    # which are not in this branch. Fail gracefully ...
5454
5656
                    revno = '?'
5512
5714
            unstacked=None):
5513
5715
        directory = bzrdir.BzrDir.open(location)
5514
5716
        if stacked_on and unstacked:
5515
 
            raise BzrCommandError("Can't use both --stacked-on and --unstacked")
 
5717
            raise errors.BzrCommandError("Can't use both --stacked-on and --unstacked")
5516
5718
        elif stacked_on is not None:
5517
5719
            reconfigure.ReconfigureStackedOn().apply(directory, stacked_on)
5518
5720
        elif unstacked:
5573
5775
    """
5574
5776
 
5575
5777
    takes_args = ['to_location?']
5576
 
    takes_options = [Option('force',
 
5778
    takes_options = ['directory',
 
5779
                     Option('force',
5577
5780
                        help='Switch even if local commits will be lost.'),
5578
5781
                     'revision',
5579
5782
                     Option('create-branch', short_name='b',
5582
5785
                    ]
5583
5786
 
5584
5787
    def run(self, to_location=None, force=False, create_branch=False,
5585
 
            revision=None):
 
5788
            revision=None, directory=u'.'):
5586
5789
        from bzrlib import switch
5587
 
        tree_location = '.'
 
5790
        tree_location = directory
5588
5791
        revision = _get_one_revision('switch', revision)
5589
5792
        control_dir = bzrdir.BzrDir.open_containing(tree_location)[0]
5590
5793
        if to_location is None:
5591
5794
            if revision is None:
5592
5795
                raise errors.BzrCommandError('You must supply either a'
5593
5796
                                             ' revision or a location')
5594
 
            to_location = '.'
 
5797
            to_location = tree_location
5595
5798
        try:
5596
5799
            branch = control_dir.open_branch()
5597
5800
            had_explicit_nick = branch.get_config().has_explicit_nickname()
5732
5935
            name=None,
5733
5936
            switch=None,
5734
5937
            ):
5735
 
        tree, file_list = tree_files(file_list, apply_view=False)
 
5938
        tree, file_list = WorkingTree.open_containing_paths(file_list,
 
5939
            apply_view=False)
5736
5940
        current_view, view_dict = tree.views.get_view_info()
5737
5941
        if name is None:
5738
5942
            name = current_view
5842
6046
            location = "."
5843
6047
        branch = Branch.open_containing(location)[0]
5844
6048
        branch.bzrdir.destroy_branch()
5845
 
        
 
6049
 
5846
6050
 
5847
6051
class cmd_shelve(Command):
5848
6052
    __doc__ = """Temporarily set aside some changes from the current tree.
5867
6071
 
5868
6072
    You can put multiple items on the shelf, and by default, 'unshelve' will
5869
6073
    restore the most recently shelved changes.
 
6074
 
 
6075
    For complicated changes, it is possible to edit the changes in a separate
 
6076
    editor program to decide what the file remaining in the working copy
 
6077
    should look like.  To do this, add the configuration option
 
6078
 
 
6079
        change_editor = PROGRAM @new_path @old_path
 
6080
 
 
6081
    where @new_path is replaced with the path of the new version of the 
 
6082
    file and @old_path is replaced with the path of the old version of 
 
6083
    the file.  The PROGRAM should save the new file with the desired 
 
6084
    contents of the file in the working tree.
 
6085
        
5870
6086
    """
5871
6087
 
5872
6088
    takes_args = ['file*']
5873
6089
 
5874
6090
    takes_options = [
 
6091
        'directory',
5875
6092
        'revision',
5876
6093
        Option('all', help='Shelve all changes.'),
5877
6094
        'message',
5883
6100
        Option('destroy',
5884
6101
               help='Destroy removed changes instead of shelving them.'),
5885
6102
    ]
5886
 
    _see_also = ['unshelve']
 
6103
    _see_also = ['unshelve', 'configuration']
5887
6104
 
5888
6105
    def run(self, revision=None, all=False, file_list=None, message=None,
5889
 
            writer=None, list=False, destroy=False):
 
6106
            writer=None, list=False, destroy=False, directory=None):
5890
6107
        if list:
5891
 
            return self.run_for_list()
 
6108
            return self.run_for_list(directory=directory)
5892
6109
        from bzrlib.shelf_ui import Shelver
5893
6110
        if writer is None:
5894
6111
            writer = bzrlib.option.diff_writer_registry.get()
5895
6112
        try:
5896
6113
            shelver = Shelver.from_args(writer(sys.stdout), revision, all,
5897
 
                file_list, message, destroy=destroy)
 
6114
                file_list, message, destroy=destroy, directory=directory)
5898
6115
            try:
5899
6116
                shelver.run()
5900
6117
            finally:
5902
6119
        except errors.UserAbort:
5903
6120
            return 0
5904
6121
 
5905
 
    def run_for_list(self):
5906
 
        tree = WorkingTree.open_containing('.')[0]
5907
 
        tree.lock_read()
5908
 
        self.add_cleanup(tree.unlock)
 
6122
    def run_for_list(self, directory=None):
 
6123
        if directory is None:
 
6124
            directory = u'.'
 
6125
        tree = WorkingTree.open_containing(directory)[0]
 
6126
        self.add_cleanup(tree.lock_read().unlock)
5909
6127
        manager = tree.get_shelf_manager()
5910
6128
        shelves = manager.active_shelves()
5911
6129
        if len(shelves) == 0:
5929
6147
 
5930
6148
    takes_args = ['shelf_id?']
5931
6149
    takes_options = [
 
6150
        'directory',
5932
6151
        RegistryOption.from_kwargs(
5933
6152
            'action', help="The action to perform.",
5934
6153
            enum_switch=False, value_switches=True,
5942
6161
    ]
5943
6162
    _see_also = ['shelve']
5944
6163
 
5945
 
    def run(self, shelf_id=None, action='apply'):
 
6164
    def run(self, shelf_id=None, action='apply', directory=u'.'):
5946
6165
        from bzrlib.shelf_ui import Unshelver
5947
 
        unshelver = Unshelver.from_args(shelf_id, action)
 
6166
        unshelver = Unshelver.from_args(shelf_id, action, directory=directory)
5948
6167
        try:
5949
6168
            unshelver.run()
5950
6169
        finally:
5966
6185
 
5967
6186
    To check what clean-tree will do, use --dry-run.
5968
6187
    """
5969
 
    takes_options = [Option('ignored', help='Delete all ignored files.'),
5970
 
                     Option('detritus', help='Delete conflict files, merge'
 
6188
    takes_options = ['directory',
 
6189
                     Option('ignored', help='Delete all ignored files.'),
 
6190
                     Option('detritus', help='Delete conflict files, merge and revert'
5971
6191
                            ' backups, and failed selftest dirs.'),
5972
6192
                     Option('unknown',
5973
6193
                            help='Delete files unknown to bzr (default).'),
5975
6195
                            ' deleting them.'),
5976
6196
                     Option('force', help='Do not prompt before deleting.')]
5977
6197
    def run(self, unknown=False, ignored=False, detritus=False, dry_run=False,
5978
 
            force=False):
 
6198
            force=False, directory=u'.'):
5979
6199
        from bzrlib.clean_tree import clean_tree
5980
6200
        if not (unknown or ignored or detritus):
5981
6201
            unknown = True
5982
6202
        if dry_run:
5983
6203
            force = True
5984
 
        clean_tree('.', unknown=unknown, ignored=ignored, detritus=detritus,
5985
 
                   dry_run=dry_run, no_prompt=force)
 
6204
        clean_tree(directory, unknown=unknown, ignored=ignored,
 
6205
                   detritus=detritus, dry_run=dry_run, no_prompt=force)
5986
6206
 
5987
6207
 
5988
6208
class cmd_reference(Command):
6032
6252
            self.outf.write('%s %s\n' % (path, location))
6033
6253
 
6034
6254
 
 
6255
class cmd_export_pot(Command):
 
6256
    __doc__ = """Export command helps and error messages in po format."""
 
6257
 
 
6258
    hidden = True
 
6259
 
 
6260
    def run(self):
 
6261
        from bzrlib.export_pot import export_pot
 
6262
        export_pot(self.outf)
 
6263
 
 
6264
 
6035
6265
def _register_lazy_builtins():
6036
6266
    # register lazy builtins from other modules; called at startup and should
6037
6267
    # be only called once.
6038
6268
    for (name, aliases, module_name) in [
6039
6269
        ('cmd_bundle_info', [], 'bzrlib.bundle.commands'),
 
6270
        ('cmd_config', [], 'bzrlib.config'),
6040
6271
        ('cmd_dpush', [], 'bzrlib.foreign'),
6041
6272
        ('cmd_version_info', [], 'bzrlib.cmd_version_info'),
6042
6273
        ('cmd_resolve', ['resolved'], 'bzrlib.conflicts'),
6043
6274
        ('cmd_conflicts', [], 'bzrlib.conflicts'),
6044
 
        ('cmd_sign_my_commits', [], 'bzrlib.sign_my_commits'),
 
6275
        ('cmd_sign_my_commits', [], 'bzrlib.commit_signature_commands'),
 
6276
        ('cmd_verify_signatures', [],
 
6277
                                        'bzrlib.commit_signature_commands'),
 
6278
        ('cmd_test_script', [], 'bzrlib.cmd_test_script'),
6045
6279
        ]:
6046
6280
        builtin_command_registry.register_lazy(name, aliases, module_name)