~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/builtins.py

  • Committer: Canonical.com Patch Queue Manager
  • Date: 2011-08-17 18:13:57 UTC
  • mfrom: (5268.7.29 transport-segments)
  • Revision ID: pqm@pqm.ubuntu.com-20110817181357-y5q5eth1hk8bl3om
(jelmer) Allow specifying the colocated branch to use in the branch URL,
 and retrieving the branch name using ControlDir._get_selected_branch.
 (Jelmer Vernooij)

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)
681
710
                should_print=(not is_quiet()))
682
711
 
683
712
        if base_tree:
684
 
            base_tree.lock_read()
685
 
            self.add_cleanup(base_tree.unlock)
 
713
            self.add_cleanup(base_tree.lock_read().unlock)
686
714
        tree, file_list = tree_files_for_add(file_list)
687
715
        added, ignored = tree.smart_add(file_list, not
688
716
            no_recurse, action=action, save=not dry_run)
759
787
            raise errors.BzrCommandError('invalid kind %r specified' % (kind,))
760
788
 
761
789
        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)
 
790
        work_tree, file_list = WorkingTree.open_containing_paths(file_list)
 
791
        self.add_cleanup(work_tree.lock_read().unlock)
765
792
        if revision is not None:
766
793
            tree = revision.as_tree(work_tree.branch)
767
794
 
768
795
            extra_trees = [work_tree]
769
 
            tree.lock_read()
770
 
            self.add_cleanup(tree.unlock)
 
796
            self.add_cleanup(tree.lock_read().unlock)
771
797
        else:
772
798
            tree = work_tree
773
799
            extra_trees = []
777
803
                                      require_versioned=True)
778
804
            # find_ids_across_trees may include some paths that don't
779
805
            # 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)
 
806
            entries = sorted(
 
807
                (tree.id2path(file_id), tree.inventory[file_id])
 
808
                for file_id in file_ids if tree.has_id(file_id))
782
809
        else:
783
810
            entries = tree.inventory.entries()
784
811
 
832
859
            names_list = []
833
860
        if len(names_list) < 2:
834
861
            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)
 
862
        tree, rel_names = WorkingTree.open_containing_paths(names_list, canonicalize=False)
 
863
        self.add_cleanup(tree.lock_tree_write().unlock)
838
864
        self._run(tree, names_list, rel_names, after)
839
865
 
840
866
    def run_auto(self, names_list, after, dry_run):
844
870
        if after:
845
871
            raise errors.BzrCommandError('--after cannot be specified with'
846
872
                                         ' --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)
 
873
        work_tree, file_list = WorkingTree.open_containing_paths(
 
874
            names_list, default_directory='.')
 
875
        self.add_cleanup(work_tree.lock_tree_write().unlock)
850
876
        rename_map.RenameMap.guess_renames(work_tree, dry_run)
851
877
 
852
878
    def _run(self, tree, names_list, rel_names, after):
946
972
    match the remote one, use pull --overwrite. This will work even if the two
947
973
    branches have diverged.
948
974
 
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.
 
975
    If there is no default location set, the first pull will set it (use
 
976
    --no-remember to avoid settting it). After that, you can omit the
 
977
    location to use the default.  To change the default, use --remember. The
 
978
    value will only be saved if the remote location can be accessed.
953
979
 
954
980
    Note: The location can be specified either in the form of a branch,
955
981
    or in the form of a path to a file containing a merge directive generated
960
986
    takes_options = ['remember', 'overwrite', 'revision',
961
987
        custom_help('verbose',
962
988
            help='Show logs of pulled revisions.'),
963
 
        Option('directory',
 
989
        custom_help('directory',
964
990
            help='Branch to pull into, '
965
 
                 'rather than the one containing the working directory.',
966
 
            short_name='d',
967
 
            type=unicode,
968
 
            ),
 
991
                 'rather than the one containing the working directory.'),
969
992
        Option('local',
970
993
            help="Perform a local pull in a bound "
971
994
                 "branch.  Local pulls are not applied to "
972
995
                 "the master branch."
973
996
            ),
 
997
        Option('show-base',
 
998
            help="Show base revision text in conflicts.")
974
999
        ]
975
1000
    takes_args = ['location?']
976
1001
    encoding_type = 'replace'
977
1002
 
978
 
    def run(self, location=None, remember=False, overwrite=False,
 
1003
    def run(self, location=None, remember=None, overwrite=False,
979
1004
            revision=None, verbose=False,
980
 
            directory=None, local=False):
 
1005
            directory=None, local=False,
 
1006
            show_base=False):
981
1007
        # FIXME: too much stuff is in the command class
982
1008
        revision_id = None
983
1009
        mergeable = None
986
1012
        try:
987
1013
            tree_to = WorkingTree.open_containing(directory)[0]
988
1014
            branch_to = tree_to.branch
989
 
            tree_to.lock_write()
990
 
            self.add_cleanup(tree_to.unlock)
 
1015
            self.add_cleanup(tree_to.lock_write().unlock)
991
1016
        except errors.NoWorkingTree:
992
1017
            tree_to = None
993
1018
            branch_to = Branch.open_containing(directory)[0]
994
 
            branch_to.lock_write()
995
 
            self.add_cleanup(branch_to.unlock)
 
1019
            self.add_cleanup(branch_to.lock_write().unlock)
 
1020
 
 
1021
        if tree_to is None and show_base:
 
1022
            raise errors.BzrCommandError("Need working tree for --show-base.")
996
1023
 
997
1024
        if local and not branch_to.get_bound_location():
998
1025
            raise errors.LocalRequiresBoundBranch()
1029
1056
        else:
1030
1057
            branch_from = Branch.open(location,
1031
1058
                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:
 
1059
            self.add_cleanup(branch_from.lock_read().unlock)
 
1060
            # Remembers if asked explicitly or no previous location is set
 
1061
            if (remember
 
1062
                or (remember is None and branch_to.get_parent() is None)):
1036
1063
                branch_to.set_parent(branch_from.base)
1037
1064
 
1038
1065
        if revision is not None:
1045
1072
                view_info=view_info)
1046
1073
            result = tree_to.pull(
1047
1074
                branch_from, overwrite, revision_id, change_reporter,
1048
 
                possible_transports=possible_transports, local=local)
 
1075
                possible_transports=possible_transports, local=local,
 
1076
                show_base=show_base)
1049
1077
        else:
1050
1078
            result = branch_to.pull(
1051
1079
                branch_from, overwrite, revision_id, local=local)
1055
1083
            log.show_branch_change(
1056
1084
                branch_to, self.outf, result.old_revno,
1057
1085
                result.old_revid)
 
1086
        if getattr(result, 'tag_conflicts', None):
 
1087
            return 1
 
1088
        else:
 
1089
            return 0
1058
1090
 
1059
1091
 
1060
1092
class cmd_push(Command):
1077
1109
    do a merge (see bzr help merge) from the other branch, and commit that.
1078
1110
    After that you will be able to do a push without '--overwrite'.
1079
1111
 
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.
 
1112
    If there is no default push location set, the first push will set it (use
 
1113
    --no-remember to avoid settting it).  After that, you can omit the
 
1114
    location to use the default.  To change the default, use --remember. The
 
1115
    value will only be saved if the remote location can be accessed.
1084
1116
    """
1085
1117
 
1086
1118
    _see_also = ['pull', 'update', 'working-trees']
1088
1120
        Option('create-prefix',
1089
1121
               help='Create the path leading up to the branch '
1090
1122
                    'if it does not already exist.'),
1091
 
        Option('directory',
 
1123
        custom_help('directory',
1092
1124
            help='Branch to push from, '
1093
 
                 'rather than the one containing the working directory.',
1094
 
            short_name='d',
1095
 
            type=unicode,
1096
 
            ),
 
1125
                 'rather than the one containing the working directory.'),
1097
1126
        Option('use-existing-dir',
1098
1127
               help='By default push will fail if the target'
1099
1128
                    ' directory exists, but does not already'
1110
1139
        Option('strict',
1111
1140
               help='Refuse to push if there are uncommitted changes in'
1112
1141
               ' the working tree, --no-strict disables the check.'),
 
1142
        Option('no-tree',
 
1143
               help="Don't populate the working tree, even for protocols"
 
1144
               " that support it."),
1113
1145
        ]
1114
1146
    takes_args = ['location?']
1115
1147
    encoding_type = 'replace'
1116
1148
 
1117
 
    def run(self, location=None, remember=False, overwrite=False,
 
1149
    def run(self, location=None, remember=None, overwrite=False,
1118
1150
        create_prefix=False, verbose=False, revision=None,
1119
1151
        use_existing_dir=False, directory=None, stacked_on=None,
1120
 
        stacked=False, strict=None):
 
1152
        stacked=False, strict=None, no_tree=False):
1121
1153
        from bzrlib.push import _show_push_branch
1122
1154
 
1123
1155
        if directory is None:
1163
1195
            else:
1164
1196
                display_url = urlutils.unescape_for_display(stored_loc,
1165
1197
                        self.outf.encoding)
1166
 
                self.outf.write("Using saved push location: %s\n" % display_url)
 
1198
                note("Using saved push location: %s" % display_url)
1167
1199
                location = stored_loc
1168
1200
 
1169
1201
        _show_push_branch(br_from, revision_id, location, self.outf,
1170
1202
            verbose=verbose, overwrite=overwrite, remember=remember,
1171
1203
            stacked_on=stacked_on, create_prefix=create_prefix,
1172
 
            use_existing_dir=use_existing_dir)
 
1204
            use_existing_dir=use_existing_dir, no_tree=no_tree)
1173
1205
 
1174
1206
 
1175
1207
class cmd_branch(Command):
1184
1216
 
1185
1217
    To retrieve the branch as of a particular revision, supply the --revision
1186
1218
    parameter, as in "branch foo/bar -r 5".
 
1219
 
 
1220
    The synonyms 'clone' and 'get' for this command are deprecated.
1187
1221
    """
1188
1222
 
1189
1223
    _see_also = ['checkout']
1190
1224
    takes_args = ['from_location', 'to_location?']
1191
 
    takes_options = ['revision', Option('hardlink',
1192
 
        help='Hard-link working tree files where possible.'),
 
1225
    takes_options = ['revision',
 
1226
        Option('hardlink', help='Hard-link working tree files where possible.'),
 
1227
        Option('files-from', type=str,
 
1228
               help="Get file contents from this tree."),
1193
1229
        Option('no-tree',
1194
1230
            help="Create a branch without a working-tree."),
1195
1231
        Option('switch',
1213
1249
 
1214
1250
    def run(self, from_location, to_location=None, revision=None,
1215
1251
            hardlink=False, stacked=False, standalone=False, no_tree=False,
1216
 
            use_existing_dir=False, switch=False, bind=False):
 
1252
            use_existing_dir=False, switch=False, bind=False,
 
1253
            files_from=None):
1217
1254
        from bzrlib import switch as _mod_switch
1218
1255
        from bzrlib.tag import _merge_tags_if_possible
 
1256
        if self.invoked_as in ['get', 'clone']:
 
1257
            ui.ui_factory.show_user_warning(
 
1258
                'deprecated_command',
 
1259
                deprecated_name=self.invoked_as,
 
1260
                recommended_name='branch',
 
1261
                deprecated_in_version='2.4')
1219
1262
        accelerator_tree, br_from = bzrdir.BzrDir.open_tree_or_branch(
1220
1263
            from_location)
 
1264
        if not (hardlink or files_from):
 
1265
            # accelerator_tree is usually slower because you have to read N
 
1266
            # files (no readahead, lots of seeks, etc), but allow the user to
 
1267
            # explicitly request it
 
1268
            accelerator_tree = None
 
1269
        if files_from is not None and files_from != from_location:
 
1270
            accelerator_tree = WorkingTree.open(files_from)
1221
1271
        revision = _get_one_revision('branch', revision)
1222
 
        br_from.lock_read()
1223
 
        self.add_cleanup(br_from.unlock)
 
1272
        self.add_cleanup(br_from.lock_read().unlock)
1224
1273
        if revision is not None:
1225
1274
            revision_id = revision.as_revision_id(br_from)
1226
1275
        else:
1331
1380
            to_location = branch_location
1332
1381
        accelerator_tree, source = bzrdir.BzrDir.open_tree_or_branch(
1333
1382
            branch_location)
 
1383
        if not (hardlink or files_from):
 
1384
            # accelerator_tree is usually slower because you have to read N
 
1385
            # files (no readahead, lots of seeks, etc), but allow the user to
 
1386
            # explicitly request it
 
1387
            accelerator_tree = None
1334
1388
        revision = _get_one_revision('checkout', revision)
1335
 
        if files_from is not None:
 
1389
        if files_from is not None and files_from != branch_location:
1336
1390
            accelerator_tree = WorkingTree.open(files_from)
1337
1391
        if revision is not None:
1338
1392
            revision_id = revision.as_revision_id(source)
1366
1420
    @display_command
1367
1421
    def run(self, dir=u'.'):
1368
1422
        tree = WorkingTree.open_containing(dir)[0]
1369
 
        tree.lock_read()
1370
 
        self.add_cleanup(tree.unlock)
 
1423
        self.add_cleanup(tree.lock_read().unlock)
1371
1424
        new_inv = tree.inventory
1372
1425
        old_tree = tree.basis_tree()
1373
 
        old_tree.lock_read()
1374
 
        self.add_cleanup(old_tree.unlock)
 
1426
        self.add_cleanup(old_tree.lock_read().unlock)
1375
1427
        old_inv = old_tree.inventory
1376
1428
        renames = []
1377
1429
        iterator = tree.iter_changes(old_tree, include_unchanged=True)
1396
1448
    If you want to discard your local changes, you can just do a
1397
1449
    'bzr revert' instead of 'bzr commit' after the update.
1398
1450
 
 
1451
    If you want to restore a file that has been removed locally, use
 
1452
    'bzr revert' instead of 'bzr update'.
 
1453
 
1399
1454
    If the tree's branch is bound to a master branch, it will also update
1400
1455
    the branch from the master.
1401
1456
    """
1402
1457
 
1403
1458
    _see_also = ['pull', 'working-trees', 'status-flags']
1404
1459
    takes_args = ['dir?']
1405
 
    takes_options = ['revision']
 
1460
    takes_options = ['revision',
 
1461
                     Option('show-base',
 
1462
                            help="Show base revision text in conflicts."),
 
1463
                     ]
1406
1464
    aliases = ['up']
1407
1465
 
1408
 
    def run(self, dir='.', revision=None):
 
1466
    def run(self, dir='.', revision=None, show_base=None):
1409
1467
        if revision is not None and len(revision) != 1:
1410
1468
            raise errors.BzrCommandError(
1411
1469
                        "bzr update --revision takes exactly one revision")
1415
1473
        master = branch.get_master_branch(
1416
1474
            possible_transports=possible_transports)
1417
1475
        if master is not None:
1418
 
            tree.lock_write()
1419
1476
            branch_location = master.base
 
1477
            tree.lock_write()
1420
1478
        else:
 
1479
            branch_location = tree.branch.base
1421
1480
            tree.lock_tree_write()
1422
 
            branch_location = tree.branch.base
1423
1481
        self.add_cleanup(tree.unlock)
1424
1482
        # get rid of the final '/' and be ready for display
1425
1483
        branch_location = urlutils.unescape_for_display(
1451
1509
                change_reporter,
1452
1510
                possible_transports=possible_transports,
1453
1511
                revision=revision_id,
1454
 
                old_tip=old_tip)
 
1512
                old_tip=old_tip,
 
1513
                show_base=show_base)
1455
1514
        except errors.NoSuchRevision, e:
1456
1515
            raise errors.BzrCommandError(
1457
1516
                                  "branch has no revision %s\n"
1519
1578
class cmd_remove(Command):
1520
1579
    __doc__ = """Remove files or directories.
1521
1580
 
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.
 
1581
    This makes Bazaar stop tracking changes to the specified files. Bazaar will
 
1582
    delete them if they can easily be recovered using revert otherwise they
 
1583
    will be backed up (adding an extention of the form .~#~). If no options or
 
1584
    parameters are given Bazaar will scan for files that are being tracked by
 
1585
    Bazaar but missing in your tree and stop tracking them for you.
1526
1586
    """
1527
1587
    takes_args = ['file*']
1528
1588
    takes_options = ['verbose',
1530
1590
        RegistryOption.from_kwargs('file-deletion-strategy',
1531
1591
            'The file deletion mode to be used.',
1532
1592
            title='Deletion Strategy', value_switches=True, enum_switch=False,
1533
 
            safe='Only delete files if they can be'
1534
 
                 ' safely recovered (default).',
 
1593
            safe='Backup changed files (default).',
1535
1594
            keep='Delete from bzr but leave the working copy.',
 
1595
            no_backup='Don\'t backup changed files.',
1536
1596
            force='Delete all the specified files, even if they can not be '
1537
 
                'recovered and even if they are non-empty directories.')]
 
1597
                'recovered and even if they are non-empty directories. '
 
1598
                '(deprecated, use no-backup)')]
1538
1599
    aliases = ['rm', 'del']
1539
1600
    encoding_type = 'replace'
1540
1601
 
1541
1602
    def run(self, file_list, verbose=False, new=False,
1542
1603
        file_deletion_strategy='safe'):
1543
 
        tree, file_list = tree_files(file_list)
 
1604
        if file_deletion_strategy == 'force':
 
1605
            note("(The --force option is deprecated, rather use --no-backup "
 
1606
                "in future.)")
 
1607
            file_deletion_strategy = 'no-backup'
 
1608
 
 
1609
        tree, file_list = WorkingTree.open_containing_paths(file_list)
1544
1610
 
1545
1611
        if file_list is not None:
1546
1612
            file_list = [f for f in file_list]
1547
1613
 
1548
 
        tree.lock_write()
1549
 
        self.add_cleanup(tree.unlock)
 
1614
        self.add_cleanup(tree.lock_write().unlock)
1550
1615
        # Heuristics should probably all move into tree.remove_smart or
1551
1616
        # some such?
1552
1617
        if new:
1567
1632
            file_deletion_strategy = 'keep'
1568
1633
        tree.remove(file_list, verbose=verbose, to_file=self.outf,
1569
1634
            keep_files=file_deletion_strategy=='keep',
1570
 
            force=file_deletion_strategy=='force')
 
1635
            force=(file_deletion_strategy=='no-backup'))
1571
1636
 
1572
1637
 
1573
1638
class cmd_file_id(Command):
1635
1700
 
1636
1701
    _see_also = ['check']
1637
1702
    takes_args = ['branch?']
 
1703
    takes_options = [
 
1704
        Option('canonicalize-chks',
 
1705
               help='Make sure CHKs are in canonical form (repairs '
 
1706
                    'bug 522637).',
 
1707
               hidden=True),
 
1708
        ]
1638
1709
 
1639
 
    def run(self, branch="."):
 
1710
    def run(self, branch=".", canonicalize_chks=False):
1640
1711
        from bzrlib.reconcile import reconcile
1641
1712
        dir = bzrdir.BzrDir.open(branch)
1642
 
        reconcile(dir)
 
1713
        reconcile(dir, canonicalize_chks=canonicalize_chks)
1643
1714
 
1644
1715
 
1645
1716
class cmd_revision_history(Command):
1677
1748
            b = wt.branch
1678
1749
            last_revision = wt.last_revision()
1679
1750
 
1680
 
        revision_ids = b.repository.get_ancestry(last_revision)
1681
 
        revision_ids.pop(0)
1682
 
        for revision_id in revision_ids:
 
1751
        self.add_cleanup(b.repository.lock_read().unlock)
 
1752
        graph = b.repository.get_graph()
 
1753
        revisions = [revid for revid, parents in
 
1754
            graph.iter_ancestry([last_revision])]
 
1755
        for revision_id in reversed(revisions):
 
1756
            if _mod_revision.is_null(revision_id):
 
1757
                continue
1683
1758
            self.outf.write(revision_id + '\n')
1684
1759
 
1685
1760
 
1722
1797
                ),
1723
1798
         Option('append-revisions-only',
1724
1799
                help='Never change revnos or the existing log.'
1725
 
                '  Append revisions to it only.')
 
1800
                '  Append revisions to it only.'),
 
1801
         Option('no-tree',
 
1802
                'Create a branch without a working tree.')
1726
1803
         ]
1727
1804
    def run(self, location=None, format=None, append_revisions_only=False,
1728
 
            create_prefix=False):
 
1805
            create_prefix=False, no_tree=False):
1729
1806
        if format is None:
1730
1807
            format = bzrdir.format_registry.make_bzrdir('default')
1731
1808
        if location is None:
1754
1831
        except errors.NotBranchError:
1755
1832
            # really a NotBzrDir error...
1756
1833
            create_branch = bzrdir.BzrDir.create_branch_convenience
 
1834
            if no_tree:
 
1835
                force_new_tree = False
 
1836
            else:
 
1837
                force_new_tree = None
1757
1838
            branch = create_branch(to_transport.base, format=format,
1758
 
                                   possible_transports=[to_transport])
 
1839
                                   possible_transports=[to_transport],
 
1840
                                   force_new_tree=force_new_tree)
1759
1841
            a_bzrdir = branch.bzrdir
1760
1842
        else:
1761
1843
            from bzrlib.transport.local import LocalTransport
1765
1847
                        raise errors.BranchExistsWithoutWorkingTree(location)
1766
1848
                raise errors.AlreadyBranchError(location)
1767
1849
            branch = a_bzrdir.create_branch()
1768
 
            a_bzrdir.create_workingtree()
 
1850
            if not no_tree:
 
1851
                a_bzrdir.create_workingtree()
1769
1852
        if append_revisions_only:
1770
1853
            try:
1771
1854
                branch.set_append_revisions_only(True)
1865
1948
    "bzr diff -p1" is equivalent to "bzr diff --prefix old/:new/", and
1866
1949
    produces patches suitable for "patch -p1".
1867
1950
 
 
1951
    Note that when using the -r argument with a range of revisions, the
 
1952
    differences are computed between the two specified revisions.  That
 
1953
    is, the command does not show the changes introduced by the first 
 
1954
    revision in the range.  This differs from the interpretation of 
 
1955
    revision ranges used by "bzr log" which includes the first revision
 
1956
    in the range.
 
1957
 
1868
1958
    :Exit values:
1869
1959
        1 - changed
1870
1960
        2 - unrepresentable changes
1888
1978
 
1889
1979
            bzr diff -r1..3 xxx
1890
1980
 
1891
 
        To see the changes introduced in revision X::
 
1981
        The changes introduced by revision 2 (equivalent to -r1..2)::
 
1982
 
 
1983
            bzr diff -c2
 
1984
 
 
1985
        To see the changes introduced by revision X::
1892
1986
        
1893
1987
            bzr diff -cX
1894
1988
 
1898
1992
 
1899
1993
            bzr diff -r<chosen_parent>..X
1900
1994
 
1901
 
        The changes introduced by revision 2 (equivalent to -r1..2)::
 
1995
        The changes between the current revision and the previous revision
 
1996
        (equivalent to -c-1 and -r-2..-1)
1902
1997
 
1903
 
            bzr diff -c2
 
1998
            bzr diff -r-2..
1904
1999
 
1905
2000
        Show just the differences for file NEWS::
1906
2001
 
1921
2016
        Same as 'bzr diff' but prefix paths with old/ and new/::
1922
2017
 
1923
2018
            bzr diff --prefix old/:new/
 
2019
            
 
2020
        Show the differences using a custom diff program with options::
 
2021
        
 
2022
            bzr diff --using /usr/bin/diff --diff-options -wu
1924
2023
    """
1925
2024
    _see_also = ['status']
1926
2025
    takes_args = ['file*']
1946
2045
            type=unicode,
1947
2046
            ),
1948
2047
        RegistryOption('format',
 
2048
            short_name='F',
1949
2049
            help='Diff format to use.',
1950
2050
            lazy_registry=('bzrlib.diff', 'format_registry'),
1951
 
            value_switches=False, title='Diff format'),
 
2051
            title='Diff format'),
1952
2052
        ]
1953
2053
    aliases = ['di', 'dif']
1954
2054
    encoding_type = 'exact'
1985
2085
         old_branch, new_branch,
1986
2086
         specific_files, extra_trees) = get_trees_and_branches_to_diff_locked(
1987
2087
            file_list, revision, old, new, self.add_cleanup, apply_view=True)
 
2088
        # GNU diff on Windows uses ANSI encoding for filenames
 
2089
        path_encoding = osutils.get_diff_header_encoding()
1988
2090
        return show_diff_trees(old_tree, new_tree, sys.stdout,
1989
2091
                               specific_files=specific_files,
1990
2092
                               external_diff_options=diff_options,
1991
2093
                               old_label=old_label, new_label=new_label,
1992
 
                               extra_trees=extra_trees, using=using,
 
2094
                               extra_trees=extra_trees,
 
2095
                               path_encoding=path_encoding,
 
2096
                               using=using,
1993
2097
                               format_cls=format)
1994
2098
 
1995
2099
 
2003
2107
    # level of effort but possibly much less IO.  (Or possibly not,
2004
2108
    # if the directories are very large...)
2005
2109
    _see_also = ['status', 'ls']
2006
 
    takes_options = ['show-ids']
 
2110
    takes_options = ['directory', 'show-ids']
2007
2111
 
2008
2112
    @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)
 
2113
    def run(self, show_ids=False, directory=u'.'):
 
2114
        tree = WorkingTree.open_containing(directory)[0]
 
2115
        self.add_cleanup(tree.lock_read().unlock)
2013
2116
        old = tree.basis_tree()
2014
 
        old.lock_read()
2015
 
        self.add_cleanup(old.unlock)
 
2117
        self.add_cleanup(old.lock_read().unlock)
2016
2118
        for path, ie in old.inventory.iter_entries():
2017
2119
            if not tree.has_id(ie.file_id):
2018
2120
                self.outf.write(path)
2028
2130
 
2029
2131
    hidden = True
2030
2132
    _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
 
            ]
 
2133
    takes_options = ['directory', 'null']
2036
2134
 
2037
2135
    @display_command
2038
 
    def run(self, null=False):
2039
 
        tree = WorkingTree.open_containing(u'.')[0]
 
2136
    def run(self, null=False, directory=u'.'):
 
2137
        tree = WorkingTree.open_containing(directory)[0]
 
2138
        self.add_cleanup(tree.lock_read().unlock)
2040
2139
        td = tree.changes_from(tree.basis_tree())
 
2140
        self.cleanup_now()
2041
2141
        for path, id, kind, text_modified, meta_modified in td.modified:
2042
2142
            if null:
2043
2143
                self.outf.write(path + '\0')
2051
2151
 
2052
2152
    hidden = True
2053
2153
    _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
 
            ]
 
2154
    takes_options = ['directory', 'null']
2059
2155
 
2060
2156
    @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)
 
2157
    def run(self, null=False, directory=u'.'):
 
2158
        wt = WorkingTree.open_containing(directory)[0]
 
2159
        self.add_cleanup(wt.lock_read().unlock)
2065
2160
        basis = wt.basis_tree()
2066
 
        basis.lock_read()
2067
 
        self.add_cleanup(basis.unlock)
 
2161
        self.add_cleanup(basis.lock_read().unlock)
2068
2162
        basis_inv = basis.inventory
2069
2163
        inv = wt.inventory
2070
2164
        for file_id in inv:
2071
 
            if file_id in basis_inv:
 
2165
            if basis_inv.has_id(file_id):
2072
2166
                continue
2073
2167
            if inv.is_root(file_id) and len(basis_inv) == 0:
2074
2168
                continue
2075
2169
            path = inv.id2path(file_id)
2076
 
            if not os.access(osutils.abspath(path), os.F_OK):
 
2170
            if not os.access(osutils.pathjoin(wt.basedir, path), os.F_OK):
2077
2171
                continue
2078
2172
            if null:
2079
2173
                self.outf.write(path + '\0')
2223
2317
 
2224
2318
    :Other filtering:
2225
2319
 
2226
 
      The --message option can be used for finding revisions that match a
2227
 
      regular expression in a commit message.
 
2320
      The --match option can be used for finding revisions that match a
 
2321
      regular expression in a commit message, committer, author or bug.
 
2322
      Specifying the option several times will match any of the supplied
 
2323
      expressions. --match-author, --match-bugs, --match-committer and
 
2324
      --match-message can be used to only match a specific field.
2228
2325
 
2229
2326
    :Tips & tricks:
2230
2327
 
2279
2376
                   help='Show just the specified revision.'
2280
2377
                   ' See also "help revisionspec".'),
2281
2378
            'log-format',
 
2379
            RegistryOption('authors',
 
2380
                'What names to list as authors - first, all or committer.',
 
2381
                title='Authors',
 
2382
                lazy_registry=('bzrlib.log', 'author_list_registry'),
 
2383
            ),
2282
2384
            Option('levels',
2283
2385
                   short_name='n',
2284
2386
                   help='Number of levels to display - 0 for all, 1 for flat.',
2285
2387
                   argname='N',
2286
2388
                   type=_parse_levels),
2287
2389
            Option('message',
2288
 
                   short_name='m',
2289
2390
                   help='Show revisions whose message matches this '
2290
2391
                        'regular expression.',
2291
 
                   type=str),
 
2392
                   type=str,
 
2393
                   hidden=True),
2292
2394
            Option('limit',
2293
2395
                   short_name='l',
2294
2396
                   help='Limit the output to the first N revisions.',
2302
2404
            Option('exclude-common-ancestry',
2303
2405
                   help='Display only the revisions that are not part'
2304
2406
                   ' of both ancestries (require -rX..Y)'
2305
 
                   )
 
2407
                   ),
 
2408
            Option('signatures',
 
2409
                   help='Show digital signature validity'),
 
2410
            ListOption('match',
 
2411
                short_name='m',
 
2412
                help='Show revisions whose properties match this '
 
2413
                'expression.',
 
2414
                type=str),
 
2415
            ListOption('match-message',
 
2416
                   help='Show revisions whose message matches this '
 
2417
                   'expression.',
 
2418
                type=str),
 
2419
            ListOption('match-committer',
 
2420
                   help='Show revisions whose committer matches this '
 
2421
                   'expression.',
 
2422
                type=str),
 
2423
            ListOption('match-author',
 
2424
                   help='Show revisions whose authors match this '
 
2425
                   'expression.',
 
2426
                type=str),
 
2427
            ListOption('match-bugs',
 
2428
                   help='Show revisions whose bugs match this '
 
2429
                   'expression.',
 
2430
                type=str)
2306
2431
            ]
2307
2432
    encoding_type = 'replace'
2308
2433
 
2319
2444
            limit=None,
2320
2445
            show_diff=False,
2321
2446
            include_merges=False,
 
2447
            authors=None,
2322
2448
            exclude_common_ancestry=False,
 
2449
            signatures=False,
 
2450
            match=None,
 
2451
            match_message=None,
 
2452
            match_committer=None,
 
2453
            match_author=None,
 
2454
            match_bugs=None,
2323
2455
            ):
2324
2456
        from bzrlib.log import (
2325
2457
            Logger,
2352
2484
        if file_list:
2353
2485
            # find the file ids to log and check for directory filtering
2354
2486
            b, file_info_list, rev1, rev2 = _get_info_for_log_files(
2355
 
                revision, file_list)
2356
 
            self.add_cleanup(b.unlock)
 
2487
                revision, file_list, self.add_cleanup)
2357
2488
            for relpath, file_id, kind in file_info_list:
2358
2489
                if file_id is None:
2359
2490
                    raise errors.BzrCommandError(
2377
2508
                location = '.'
2378
2509
            dir, relpath = bzrdir.BzrDir.open_containing(location)
2379
2510
            b = dir.open_branch()
2380
 
            b.lock_read()
2381
 
            self.add_cleanup(b.unlock)
 
2511
            self.add_cleanup(b.lock_read().unlock)
2382
2512
            rev1, rev2 = _get_revision_range(revision, b, self.name())
2383
2513
 
 
2514
        if b.get_config().validate_signatures_in_log():
 
2515
            signatures = True
 
2516
 
 
2517
        if signatures:
 
2518
            if not gpg.GPGStrategy.verify_signatures_available():
 
2519
                raise errors.GpgmeNotInstalled(None)
 
2520
 
2384
2521
        # Decide on the type of delta & diff filtering to use
2385
2522
        # TODO: add an --all-files option to make this configurable & consistent
2386
2523
        if not verbose:
2404
2541
                        show_timezone=timezone,
2405
2542
                        delta_format=get_verbosity_level(),
2406
2543
                        levels=levels,
2407
 
                        show_advice=levels is None)
 
2544
                        show_advice=levels is None,
 
2545
                        author_list_handler=authors)
2408
2546
 
2409
2547
        # Choose the algorithm for doing the logging. It's annoying
2410
2548
        # having multiple code paths like this but necessary until
2422
2560
        match_using_deltas = (len(file_ids) != 1 or filter_by_dir
2423
2561
            or delta_type or partial_history)
2424
2562
 
 
2563
        match_dict = {}
 
2564
        if match:
 
2565
            match_dict[''] = match
 
2566
        if match_message:
 
2567
            match_dict['message'] = match_message
 
2568
        if match_committer:
 
2569
            match_dict['committer'] = match_committer
 
2570
        if match_author:
 
2571
            match_dict['author'] = match_author
 
2572
        if match_bugs:
 
2573
            match_dict['bugs'] = match_bugs
 
2574
            
2425
2575
        # Build the LogRequest and execute it
2426
2576
        if len(file_ids) == 0:
2427
2577
            file_ids = None
2430
2580
            start_revision=rev1, end_revision=rev2, limit=limit,
2431
2581
            message_search=message, delta_type=delta_type,
2432
2582
            diff_type=diff_type, _match_using_deltas=match_using_deltas,
2433
 
            exclude_common_ancestry=exclude_common_ancestry,
 
2583
            exclude_common_ancestry=exclude_common_ancestry, match=match_dict,
 
2584
            signature=signatures
2434
2585
            )
2435
2586
        Logger(b, rqst).show(lf)
2436
2587
 
2508
2659
        tree, relpath = WorkingTree.open_containing(filename)
2509
2660
        file_id = tree.path2id(relpath)
2510
2661
        b = tree.branch
2511
 
        b.lock_read()
2512
 
        self.add_cleanup(b.unlock)
 
2662
        self.add_cleanup(b.lock_read().unlock)
2513
2663
        touching_revs = log.find_touching_revisions(b, file_id)
2514
2664
        for revno, revision_id, what in touching_revs:
2515
2665
            self.outf.write("%6d %s\n" % (revno, what))
2528
2678
                   help='Recurse into subdirectories.'),
2529
2679
            Option('from-root',
2530
2680
                   help='Print paths relative to the root of the branch.'),
2531
 
            Option('unknown', help='Print unknown files.'),
 
2681
            Option('unknown', short_name='u',
 
2682
                help='Print unknown files.'),
2532
2683
            Option('versioned', help='Print versioned files.',
2533
2684
                   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',
 
2685
            Option('ignored', short_name='i',
 
2686
                help='Print ignored files.'),
 
2687
            Option('kind', short_name='k',
2539
2688
                   help='List entries of a particular kind: file, directory, symlink.',
2540
2689
                   type=unicode),
 
2690
            'null',
2541
2691
            'show-ids',
 
2692
            'directory',
2542
2693
            ]
2543
2694
    @display_command
2544
2695
    def run(self, revision=None, verbose=False,
2545
2696
            recursive=False, from_root=False,
2546
2697
            unknown=False, versioned=False, ignored=False,
2547
 
            null=False, kind=None, show_ids=False, path=None):
 
2698
            null=False, kind=None, show_ids=False, path=None, directory=None):
2548
2699
 
2549
2700
        if kind and kind not in ('file', 'directory', 'symlink'):
2550
2701
            raise errors.BzrCommandError('invalid kind specified')
2562
2713
                raise errors.BzrCommandError('cannot specify both --from-root'
2563
2714
                                             ' and PATH')
2564
2715
            fs_path = path
2565
 
        tree, branch, relpath = bzrdir.BzrDir.open_containing_tree_or_branch(
2566
 
            fs_path)
 
2716
        tree, branch, relpath = \
 
2717
            _open_directory_or_containing_tree_or_branch(fs_path, directory)
2567
2718
 
2568
2719
        # Calculate the prefix to use
2569
2720
        prefix = None
2584
2735
                view_str = views.view_display_str(view_files)
2585
2736
                note("Ignoring files outside view. View is %s" % view_str)
2586
2737
 
2587
 
        tree.lock_read()
2588
 
        self.add_cleanup(tree.unlock)
 
2738
        self.add_cleanup(tree.lock_read().unlock)
2589
2739
        for fp, fc, fkind, fid, entry in tree.list_files(include_root=False,
2590
2740
            from_dir=relpath, recursive=recursive):
2591
2741
            # Apply additional masking
2638
2788
 
2639
2789
    hidden = True
2640
2790
    _see_also = ['ls']
 
2791
    takes_options = ['directory']
2641
2792
 
2642
2793
    @display_command
2643
 
    def run(self):
2644
 
        for f in WorkingTree.open_containing(u'.')[0].unknowns():
 
2794
    def run(self, directory=u'.'):
 
2795
        for f in WorkingTree.open_containing(directory)[0].unknowns():
2645
2796
            self.outf.write(osutils.quotefn(f) + '\n')
2646
2797
 
2647
2798
 
2674
2825
    Patterns prefixed with '!!' act as regular ignore patterns, but have
2675
2826
    precedence over the '!' exception patterns.
2676
2827
 
2677
 
    Note: ignore patterns containing shell wildcards must be quoted from
2678
 
    the shell on Unix.
 
2828
    :Notes: 
 
2829
        
 
2830
    * Ignore patterns containing shell wildcards must be quoted from
 
2831
      the shell on Unix.
 
2832
 
 
2833
    * Ignore patterns starting with "#" act as comments in the ignore file.
 
2834
      To ignore patterns that begin with that character, use the "RE:" prefix.
2679
2835
 
2680
2836
    :Examples:
2681
2837
        Ignore the top level Makefile::
2690
2846
 
2691
2847
            bzr ignore "!special.class"
2692
2848
 
 
2849
        Ignore files whose name begins with the "#" character::
 
2850
 
 
2851
            bzr ignore "RE:^#"
 
2852
 
2693
2853
        Ignore .o files under the lib directory::
2694
2854
 
2695
2855
            bzr ignore "lib/**/*.o"
2703
2863
            bzr ignore "RE:(?!debian/).*"
2704
2864
        
2705
2865
        Ignore everything except the "local" toplevel directory,
2706
 
        but always ignore "*~" autosave files, even under local/::
 
2866
        but always ignore autosave files ending in ~, even under local/::
2707
2867
        
2708
2868
            bzr ignore "*"
2709
2869
            bzr ignore "!./local"
2712
2872
 
2713
2873
    _see_also = ['status', 'ignored', 'patterns']
2714
2874
    takes_args = ['name_pattern*']
2715
 
    takes_options = [
 
2875
    takes_options = ['directory',
2716
2876
        Option('default-rules',
2717
2877
               help='Display the default ignore rules that bzr uses.')
2718
2878
        ]
2719
2879
 
2720
 
    def run(self, name_pattern_list=None, default_rules=None):
 
2880
    def run(self, name_pattern_list=None, default_rules=None,
 
2881
            directory=u'.'):
2721
2882
        from bzrlib import ignores
2722
2883
        if default_rules is not None:
2723
2884
            # dump the default rules and exit
2729
2890
                "NAME_PATTERN or --default-rules.")
2730
2891
        name_pattern_list = [globbing.normalize_pattern(p)
2731
2892
                             for p in name_pattern_list]
 
2893
        bad_patterns = ''
 
2894
        for p in name_pattern_list:
 
2895
            if not globbing.Globster.is_pattern_valid(p):
 
2896
                bad_patterns += ('\n  %s' % p)
 
2897
        if bad_patterns:
 
2898
            msg = ('Invalid ignore pattern(s) found. %s' % bad_patterns)
 
2899
            ui.ui_factory.show_error(msg)
 
2900
            raise errors.InvalidPattern('')
2732
2901
        for name_pattern in name_pattern_list:
2733
2902
            if (name_pattern[0] == '/' or
2734
2903
                (len(name_pattern) > 1 and name_pattern[1] == ':')):
2735
2904
                raise errors.BzrCommandError(
2736
2905
                    "NAME_PATTERN should not be an absolute path")
2737
 
        tree, relpath = WorkingTree.open_containing(u'.')
 
2906
        tree, relpath = WorkingTree.open_containing(directory)
2738
2907
        ignores.tree_ignores_add_patterns(tree, name_pattern_list)
2739
2908
        ignored = globbing.Globster(name_pattern_list)
2740
2909
        matches = []
2741
 
        tree.lock_read()
 
2910
        self.add_cleanup(tree.lock_read().unlock)
2742
2911
        for entry in tree.list_files():
2743
2912
            id = entry[3]
2744
2913
            if id is not None:
2745
2914
                filename = entry[0]
2746
2915
                if ignored.match(filename):
2747
2916
                    matches.append(filename)
2748
 
        tree.unlock()
2749
2917
        if len(matches) > 0:
2750
2918
            self.outf.write("Warning: the following files are version controlled and"
2751
2919
                  " match your ignore pattern:\n%s"
2766
2934
 
2767
2935
    encoding_type = 'replace'
2768
2936
    _see_also = ['ignore', 'ls']
 
2937
    takes_options = ['directory']
2769
2938
 
2770
2939
    @display_command
2771
 
    def run(self):
2772
 
        tree = WorkingTree.open_containing(u'.')[0]
2773
 
        tree.lock_read()
2774
 
        self.add_cleanup(tree.unlock)
 
2940
    def run(self, directory=u'.'):
 
2941
        tree = WorkingTree.open_containing(directory)[0]
 
2942
        self.add_cleanup(tree.lock_read().unlock)
2775
2943
        for path, file_class, kind, file_id, entry in tree.list_files():
2776
2944
            if file_class != 'I':
2777
2945
                continue
2788
2956
    """
2789
2957
    hidden = True
2790
2958
    takes_args = ['revno']
 
2959
    takes_options = ['directory']
2791
2960
 
2792
2961
    @display_command
2793
 
    def run(self, revno):
 
2962
    def run(self, revno, directory=u'.'):
2794
2963
        try:
2795
2964
            revno = int(revno)
2796
2965
        except ValueError:
2797
2966
            raise errors.BzrCommandError("not a valid revision-number: %r"
2798
2967
                                         % revno)
2799
 
        revid = WorkingTree.open_containing(u'.')[0].branch.get_rev_id(revno)
 
2968
        revid = WorkingTree.open_containing(directory)[0].branch.get_rev_id(revno)
2800
2969
        self.outf.write("%s\n" % revid)
2801
2970
 
2802
2971
 
2828
2997
         zip                          .zip
2829
2998
      =================       =========================
2830
2999
    """
 
3000
    encoding = 'exact'
2831
3001
    takes_args = ['dest', 'branch_or_subdir?']
2832
 
    takes_options = [
 
3002
    takes_options = ['directory',
2833
3003
        Option('format',
2834
3004
               help="Type of file to export to.",
2835
3005
               type=unicode),
2844
3014
                    'revision in which it was changed.'),
2845
3015
        ]
2846
3016
    def run(self, dest, branch_or_subdir=None, revision=None, format=None,
2847
 
        root=None, filters=False, per_file_timestamps=False):
 
3017
        root=None, filters=False, per_file_timestamps=False, directory=u'.'):
2848
3018
        from bzrlib.export import export
2849
3019
 
2850
3020
        if branch_or_subdir is None:
2851
 
            tree = WorkingTree.open_containing(u'.')[0]
 
3021
            tree = WorkingTree.open_containing(directory)[0]
2852
3022
            b = tree.branch
2853
3023
            subdir = None
2854
3024
        else:
2873
3043
    """
2874
3044
 
2875
3045
    _see_also = ['ls']
2876
 
    takes_options = [
 
3046
    takes_options = ['directory',
2877
3047
        Option('name-from-revision', help='The path name in the old tree.'),
2878
3048
        Option('filters', help='Apply content filters to display the '
2879
3049
                'convenience form.'),
2884
3054
 
2885
3055
    @display_command
2886
3056
    def run(self, filename, revision=None, name_from_revision=False,
2887
 
            filters=False):
 
3057
            filters=False, directory=None):
2888
3058
        if revision is not None and len(revision) != 1:
2889
3059
            raise errors.BzrCommandError("bzr cat --revision takes exactly"
2890
3060
                                         " one revision specifier")
2891
3061
        tree, branch, relpath = \
2892
 
            bzrdir.BzrDir.open_containing_tree_or_branch(filename)
2893
 
        branch.lock_read()
2894
 
        self.add_cleanup(branch.unlock)
 
3062
            _open_directory_or_containing_tree_or_branch(filename, directory)
 
3063
        self.add_cleanup(branch.lock_read().unlock)
2895
3064
        return self._run(tree, branch, relpath, filename, revision,
2896
3065
                         name_from_revision, filters)
2897
3066
 
2900
3069
        if tree is None:
2901
3070
            tree = b.basis_tree()
2902
3071
        rev_tree = _get_one_revision_tree('cat', revision, branch=b)
2903
 
        rev_tree.lock_read()
2904
 
        self.add_cleanup(rev_tree.unlock)
 
3072
        self.add_cleanup(rev_tree.lock_read().unlock)
2905
3073
 
2906
3074
        old_file_id = rev_tree.path2id(relpath)
2907
3075
 
 
3076
        # TODO: Split out this code to something that generically finds the
 
3077
        # best id for a path across one or more trees; it's like
 
3078
        # find_ids_across_trees but restricted to find just one. -- mbp
 
3079
        # 20110705.
2908
3080
        if name_from_revision:
2909
3081
            # Try in revision if requested
2910
3082
            if old_file_id is None:
2912
3084
                    "%r is not present in revision %s" % (
2913
3085
                        filename, rev_tree.get_revision_id()))
2914
3086
            else:
2915
 
                content = rev_tree.get_file_text(old_file_id)
 
3087
                actual_file_id = old_file_id
2916
3088
        else:
2917
3089
            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
 
3090
            if cur_file_id is not None and rev_tree.has_id(cur_file_id):
 
3091
                actual_file_id = cur_file_id
 
3092
            elif old_file_id is not None:
 
3093
                actual_file_id = old_file_id
 
3094
            else:
2933
3095
                raise errors.BzrCommandError(
2934
3096
                    "%r is not present in revision %s" % (
2935
3097
                        filename, rev_tree.get_revision_id()))
2936
3098
        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)
 
3099
            from bzrlib.filter_tree import ContentFilterTree
 
3100
            filter_tree = ContentFilterTree(rev_tree,
 
3101
                rev_tree._content_filter_stack)
 
3102
            content = filter_tree.get_file_text(actual_file_id)
2947
3103
        else:
2948
 
            self.cleanup_now()
2949
 
            self.outf.write(content)
 
3104
            content = rev_tree.get_file_text(actual_file_id)
 
3105
        self.cleanup_now()
 
3106
        self.outf.write(content)
2950
3107
 
2951
3108
 
2952
3109
class cmd_local_time_offset(Command):
3013
3170
      to trigger updates to external systems like bug trackers. The --fixes
3014
3171
      option can be used to record the association between a revision and
3015
3172
      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
3173
    """
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
3174
 
3043
3175
    _see_also = ['add', 'bugs', 'hooks', 'uncommit']
3044
3176
    takes_args = ['selected*']
3076
3208
             Option('show-diff', short_name='p',
3077
3209
                    help='When no message is supplied, show the diff along'
3078
3210
                    ' with the status summary in the message editor.'),
 
3211
             Option('lossy', 
 
3212
                    help='When committing to a foreign version control '
 
3213
                    'system do not push data that can not be natively '
 
3214
                    'represented.'),
3079
3215
             ]
3080
3216
    aliases = ['ci', 'checkin']
3081
3217
 
3100
3236
 
3101
3237
    def run(self, message=None, file=None, verbose=False, selected_list=None,
3102
3238
            unchanged=False, strict=False, local=False, fixes=None,
3103
 
            author=None, show_diff=False, exclude=None, commit_time=None):
 
3239
            author=None, show_diff=False, exclude=None, commit_time=None,
 
3240
            lossy=False):
3104
3241
        from bzrlib.errors import (
3105
3242
            PointlessCommit,
3106
3243
            ConflictsInTree,
3109
3246
        from bzrlib.msgeditor import (
3110
3247
            edit_commit_message_encoded,
3111
3248
            generate_commit_message_template,
3112
 
            make_commit_message_template_encoded
 
3249
            make_commit_message_template_encoded,
 
3250
            set_commit_message,
3113
3251
        )
3114
3252
 
3115
3253
        commit_stamp = offset = None
3120
3258
                raise errors.BzrCommandError(
3121
3259
                    "Could not parse --commit-time: " + str(e))
3122
3260
 
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
3261
        properties = {}
3130
3262
 
3131
 
        tree, selected_list = tree_files(selected_list)
 
3263
        tree, selected_list = WorkingTree.open_containing_paths(selected_list)
3132
3264
        if selected_list == ['']:
3133
3265
            # workaround - commit of root of tree should be exactly the same
3134
3266
            # as just default commit in that tree, and succeed even though
3169
3301
        def get_message(commit_obj):
3170
3302
            """Callback to get commit message"""
3171
3303
            if file:
3172
 
                my_message = codecs.open(
3173
 
                    file, 'rt', osutils.get_user_encoding()).read()
 
3304
                f = open(file)
 
3305
                try:
 
3306
                    my_message = f.read().decode(osutils.get_user_encoding())
 
3307
                finally:
 
3308
                    f.close()
3174
3309
            elif message is not None:
3175
3310
                my_message = message
3176
3311
            else:
3184
3319
                # make_commit_message_template_encoded returns user encoding.
3185
3320
                # We probably want to be using edit_commit_message instead to
3186
3321
                # avoid this.
3187
 
                start_message = generate_commit_message_template(commit_obj)
3188
 
                my_message = edit_commit_message_encoded(text,
3189
 
                    start_message=start_message)
 
3322
                my_message = set_commit_message(commit_obj)
 
3323
                if my_message is None:
 
3324
                    start_message = generate_commit_message_template(commit_obj)
 
3325
                    my_message = edit_commit_message_encoded(text,
 
3326
                        start_message=start_message)
3190
3327
                if my_message is None:
3191
3328
                    raise errors.BzrCommandError("please specify a commit"
3192
3329
                        " message with either --message or --file")
3193
3330
            if my_message == "":
3194
 
                raise errors.BzrCommandError("empty commit message specified")
 
3331
                raise errors.BzrCommandError("Empty commit message specified."
 
3332
                        " Please specify a commit message with either"
 
3333
                        " --message or --file or leave a blank message"
 
3334
                        " with --message \"\".")
3195
3335
            return my_message
3196
3336
 
3197
3337
        # The API permits a commit with a filter of [] to mean 'select nothing'
3205
3345
                        reporter=None, verbose=verbose, revprops=properties,
3206
3346
                        authors=author, timestamp=commit_stamp,
3207
3347
                        timezone=offset,
3208
 
                        exclude=safe_relpath_files(tree, exclude))
 
3348
                        exclude=tree.safe_relpath_files(exclude),
 
3349
                        lossy=lossy)
3209
3350
        except PointlessCommit:
3210
3351
            raise errors.BzrCommandError("No changes to commit."
3211
 
                              " Use --unchanged to commit anyhow.")
 
3352
                " Please 'bzr add' the files you want to commit, or use"
 
3353
                " --unchanged to force an empty commit.")
3212
3354
        except ConflictsInTree:
3213
3355
            raise errors.BzrCommandError('Conflicts detected in working '
3214
3356
                'tree.  Use "bzr conflicts" to list, "bzr resolve FILE" to'
3295
3437
 
3296
3438
 
3297
3439
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.
 
3440
    __doc__ = """Upgrade a repository, branch or working tree to a newer format.
 
3441
 
 
3442
    When the default format has changed after a major new release of
 
3443
    Bazaar, you may be informed during certain operations that you
 
3444
    should upgrade. Upgrading to a newer format may improve performance
 
3445
    or make new features available. It may however limit interoperability
 
3446
    with older repositories or with older versions of Bazaar.
 
3447
 
 
3448
    If you wish to upgrade to a particular format rather than the
 
3449
    current default, that can be specified using the --format option.
 
3450
    As a consequence, you can use the upgrade command this way to
 
3451
    "downgrade" to an earlier format, though some conversions are
 
3452
    a one way process (e.g. changing from the 1.x default to the
 
3453
    2.x default) so downgrading is not always possible.
 
3454
 
 
3455
    A backup.bzr.~#~ directory is created at the start of the conversion
 
3456
    process (where # is a number). By default, this is left there on
 
3457
    completion. If the conversion fails, delete the new .bzr directory
 
3458
    and rename this one back in its place. Use the --clean option to ask
 
3459
    for the backup.bzr directory to be removed on successful conversion.
 
3460
    Alternatively, you can delete it by hand if everything looks good
 
3461
    afterwards.
 
3462
 
 
3463
    If the location given is a shared repository, dependent branches
 
3464
    are also converted provided the repository converts successfully.
 
3465
    If the conversion of a branch fails, remaining branches are still
 
3466
    tried.
 
3467
 
 
3468
    For more information on upgrades, see the Bazaar Upgrade Guide,
 
3469
    http://doc.bazaar.canonical.com/latest/en/upgrade-guide/.
3303
3470
    """
3304
3471
 
3305
 
    _see_also = ['check']
 
3472
    _see_also = ['check', 'reconcile', 'formats']
3306
3473
    takes_args = ['url?']
3307
3474
    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
 
                    ]
 
3475
        RegistryOption('format',
 
3476
            help='Upgrade to a specific format.  See "bzr help'
 
3477
                 ' formats" for details.',
 
3478
            lazy_registry=('bzrlib.bzrdir', 'format_registry'),
 
3479
            converter=lambda name: bzrdir.format_registry.make_bzrdir(name),
 
3480
            value_switches=True, title='Branch format'),
 
3481
        Option('clean',
 
3482
            help='Remove the backup.bzr directory if successful.'),
 
3483
        Option('dry-run',
 
3484
            help="Show what would be done, but don't actually do anything."),
 
3485
    ]
3315
3486
 
3316
 
    def run(self, url='.', format=None):
 
3487
    def run(self, url='.', format=None, clean=False, dry_run=False):
3317
3488
        from bzrlib.upgrade import upgrade
3318
 
        upgrade(url, format)
 
3489
        exceptions = upgrade(url, format, clean_up=clean, dry_run=dry_run)
 
3490
        if exceptions:
 
3491
            if len(exceptions) == 1:
 
3492
                # Compatibility with historical behavior
 
3493
                raise exceptions[0]
 
3494
            else:
 
3495
                return 3
3319
3496
 
3320
3497
 
3321
3498
class cmd_whoami(Command):
3330
3507
 
3331
3508
            bzr whoami "Frank Chu <fchu@example.com>"
3332
3509
    """
3333
 
    takes_options = [ Option('email',
 
3510
    takes_options = [ 'directory',
 
3511
                      Option('email',
3334
3512
                             help='Display email address only.'),
3335
3513
                      Option('branch',
3336
3514
                             help='Set identity for the current branch instead of '
3340
3518
    encoding_type = 'replace'
3341
3519
 
3342
3520
    @display_command
3343
 
    def run(self, email=False, branch=False, name=None):
 
3521
    def run(self, email=False, branch=False, name=None, directory=None):
3344
3522
        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()
 
3523
            if directory is None:
 
3524
                # use branch if we're inside one; otherwise global config
 
3525
                try:
 
3526
                    c = Branch.open_containing(u'.')[0].get_config()
 
3527
                except errors.NotBranchError:
 
3528
                    c = _mod_config.GlobalConfig()
 
3529
            else:
 
3530
                c = Branch.open(directory).get_config()
3350
3531
            if email:
3351
3532
                self.outf.write(c.user_email() + '\n')
3352
3533
            else:
3353
3534
                self.outf.write(c.username() + '\n')
3354
3535
            return
3355
3536
 
 
3537
        if email:
 
3538
            raise errors.BzrCommandError("--email can only be used to display existing "
 
3539
                                         "identity")
 
3540
 
3356
3541
        # display a warning if an email address isn't included in the given name.
3357
3542
        try:
3358
 
            config.extract_email_address(name)
 
3543
            _mod_config.extract_email_address(name)
3359
3544
        except errors.NoEmailInUsername, e:
3360
3545
            warning('"%s" does not seem to contain an email address.  '
3361
3546
                    'This is allowed, but not recommended.', name)
3362
3547
 
3363
3548
        # use global config unless --branch given
3364
3549
        if branch:
3365
 
            c = Branch.open_containing('.')[0].get_config()
 
3550
            if directory is None:
 
3551
                c = Branch.open_containing(u'.')[0].get_config()
 
3552
            else:
 
3553
                c = Branch.open(directory).get_config()
3366
3554
        else:
3367
 
            c = config.GlobalConfig()
 
3555
            c = _mod_config.GlobalConfig()
3368
3556
        c.set_user_option('email', name)
3369
3557
 
3370
3558
 
3380
3568
 
3381
3569
    _see_also = ['info']
3382
3570
    takes_args = ['nickname?']
3383
 
    def run(self, nickname=None):
3384
 
        branch = Branch.open_containing(u'.')[0]
 
3571
    takes_options = ['directory']
 
3572
    def run(self, nickname=None, directory=u'.'):
 
3573
        branch = Branch.open_containing(directory)[0]
3385
3574
        if nickname is None:
3386
3575
            self.printme(branch)
3387
3576
        else:
3436
3625
                'bzr alias --remove expects an alias to remove.')
3437
3626
        # If alias is not found, print something like:
3438
3627
        # unalias: foo: not found
3439
 
        c = config.GlobalConfig()
 
3628
        c = _mod_config.GlobalConfig()
3440
3629
        c.unset_alias(alias_name)
3441
3630
 
3442
3631
    @display_command
3443
3632
    def print_aliases(self):
3444
3633
        """Print out the defined aliases in a similar format to bash."""
3445
 
        aliases = config.GlobalConfig().get_aliases()
 
3634
        aliases = _mod_config.GlobalConfig().get_aliases()
3446
3635
        for key, value in sorted(aliases.iteritems()):
3447
3636
            self.outf.write('bzr alias %s="%s"\n' % (key, value))
3448
3637
 
3458
3647
 
3459
3648
    def set_alias(self, alias_name, alias_command):
3460
3649
        """Save the alias in the global config."""
3461
 
        c = config.GlobalConfig()
 
3650
        c = _mod_config.GlobalConfig()
3462
3651
        c.set_alias(alias_name, alias_command)
3463
3652
 
3464
3653
 
3499
3688
    If you set BZR_TEST_PDB=1 when running selftest, failing tests will drop
3500
3689
    into a pdb postmortem session.
3501
3690
 
 
3691
    The --coverage=DIRNAME global option produces a report with covered code
 
3692
    indicated.
 
3693
 
3502
3694
    :Examples:
3503
3695
        Run only tests relating to 'ignore'::
3504
3696
 
3515
3707
        if typestring == "sftp":
3516
3708
            from bzrlib.tests import stub_sftp
3517
3709
            return stub_sftp.SFTPAbsoluteServer
3518
 
        if typestring == "memory":
 
3710
        elif typestring == "memory":
3519
3711
            from bzrlib.tests import test_server
3520
3712
            return memory.MemoryServer
3521
 
        if typestring == "fakenfs":
 
3713
        elif typestring == "fakenfs":
3522
3714
            from bzrlib.tests import test_server
3523
3715
            return test_server.FakeNFSServer
3524
3716
        msg = "No known transport type %s. Supported types are: sftp\n" %\
3537
3729
                                 'throughout the test suite.',
3538
3730
                            type=get_transport_type),
3539
3731
                     Option('benchmark',
3540
 
                            help='Run the benchmarks rather than selftests.'),
 
3732
                            help='Run the benchmarks rather than selftests.',
 
3733
                            hidden=True),
3541
3734
                     Option('lsprof-timed',
3542
3735
                            help='Generate lsprof output for benchmarked'
3543
3736
                                 ' sections of code.'),
3544
3737
                     Option('lsprof-tests',
3545
3738
                            help='Generate lsprof output for each test.'),
3546
 
                     Option('cache-dir', type=str,
3547
 
                            help='Cache intermediate benchmark output in this '
3548
 
                                 'directory.'),
3549
3739
                     Option('first',
3550
3740
                            help='Run all tests, but run specified tests first.',
3551
3741
                            short_name='f',
3560
3750
                     Option('randomize', type=str, argname="SEED",
3561
3751
                            help='Randomize the order of tests using the given'
3562
3752
                                 ' 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.'),
 
3753
                     ListOption('exclude', type=str, argname="PATTERN",
 
3754
                                short_name='x',
 
3755
                                help='Exclude tests that match this regular'
 
3756
                                ' expression.'),
3567
3757
                     Option('subunit',
3568
3758
                        help='Output test progress via subunit.'),
3569
3759
                     Option('strict', help='Fail on missing dependencies or '
3585
3775
 
3586
3776
    def run(self, testspecs_list=None, verbose=False, one=False,
3587
3777
            transport=None, benchmark=None,
3588
 
            lsprof_timed=None, cache_dir=None,
 
3778
            lsprof_timed=None,
3589
3779
            first=False, list_only=False,
3590
3780
            randomize=None, exclude=None, strict=False,
3591
3781
            load_list=None, debugflag=None, starting_with=None, subunit=False,
3592
3782
            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)
 
3783
        from bzrlib import tests
 
3784
 
3602
3785
        if testspecs_list is not None:
3603
3786
            pattern = '|'.join(testspecs_list)
3604
3787
        else:
3612
3795
            self.additional_selftest_args['runner_class'] = SubUnitBzrRunner
3613
3796
            # On Windows, disable automatic conversion of '\n' to '\r\n' in
3614
3797
            # stdout, which would corrupt the subunit stream. 
3615
 
            if sys.platform == "win32" and sys.stdout.fileno() >= 0:
 
3798
            # FIXME: This has been fixed in subunit trunk (>0.0.5) so the
 
3799
            # following code can be deleted when it's sufficiently deployed
 
3800
            # -- vila/mgz 20100514
 
3801
            if (sys.platform == "win32"
 
3802
                and getattr(sys.stdout, 'fileno', None) is not None):
3616
3803
                import msvcrt
3617
3804
                msvcrt.setmode(sys.stdout.fileno(), os.O_BINARY)
3618
3805
        if parallel:
3619
3806
            self.additional_selftest_args.setdefault(
3620
3807
                'suite_decorators', []).append(parallel)
3621
3808
        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)
 
3809
            raise errors.BzrCommandError(
 
3810
                "--benchmark is no longer supported from bzr 2.2; "
 
3811
                "use bzr-usertest instead")
 
3812
        test_suite_factory = None
 
3813
        if not exclude:
 
3814
            exclude_pattern = None
3628
3815
        else:
3629
 
            test_suite_factory = None
3630
 
            benchfile = None
 
3816
            exclude_pattern = '(' + '|'.join(exclude) + ')'
3631
3817
        selftest_kwargs = {"verbose": verbose,
3632
3818
                          "pattern": pattern,
3633
3819
                          "stop_on_failure": one,
3635
3821
                          "test_suite_factory": test_suite_factory,
3636
3822
                          "lsprof_timed": lsprof_timed,
3637
3823
                          "lsprof_tests": lsprof_tests,
3638
 
                          "bench_history": benchfile,
3639
3824
                          "matching_tests_first": first,
3640
3825
                          "list_only": list_only,
3641
3826
                          "random_seed": randomize,
3642
 
                          "exclude_pattern": exclude,
 
3827
                          "exclude_pattern": exclude_pattern,
3643
3828
                          "strict": strict,
3644
3829
                          "load_list": load_list,
3645
3830
                          "debug_flags": debugflag,
3646
3831
                          "starting_with": starting_with
3647
3832
                          }
3648
3833
        selftest_kwargs.update(self.additional_selftest_args)
3649
 
        result = selftest(**selftest_kwargs)
 
3834
 
 
3835
        # Make deprecation warnings visible, unless -Werror is set
 
3836
        cleanup = symbol_versioning.activate_deprecation_warnings(
 
3837
            override=False)
 
3838
        try:
 
3839
            result = tests.selftest(**selftest_kwargs)
 
3840
        finally:
 
3841
            cleanup()
3650
3842
        return int(not result)
3651
3843
 
3652
3844
 
3690
3882
 
3691
3883
        branch1 = Branch.open_containing(branch)[0]
3692
3884
        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)
 
3885
        self.add_cleanup(branch1.lock_read().unlock)
 
3886
        self.add_cleanup(branch2.lock_read().unlock)
3697
3887
        last1 = ensure_null(branch1.last_revision())
3698
3888
        last2 = ensure_null(branch2.last_revision())
3699
3889
 
3709
3899
    The source of the merge can be specified either in the form of a branch,
3710
3900
    or in the form of a path to a file containing a merge directive generated
3711
3901
    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.
 
3902
    or the branch most recently merged using --remember.  The source of the
 
3903
    merge may also be specified in the form of a path to a file in another
 
3904
    branch:  in this case, only the modifications to that file are merged into
 
3905
    the current working tree.
 
3906
 
 
3907
    When merging from a branch, by default bzr will try to merge in all new
 
3908
    work from the other branch, automatically determining an appropriate base
 
3909
    revision.  If this fails, you may need to give an explicit base.
 
3910
 
 
3911
    To pick a different ending revision, pass "--revision OTHER".  bzr will
 
3912
    try to merge in all new work up to and including revision OTHER.
 
3913
 
 
3914
    If you specify two values, "--revision BASE..OTHER", only revisions BASE
 
3915
    through OTHER, excluding BASE but including OTHER, will be merged.  If this
 
3916
    causes some revisions to be skipped, i.e. if the destination branch does
 
3917
    not already contain revision BASE, such a merge is commonly referred to as
 
3918
    a "cherrypick". Unlike a normal merge, Bazaar does not currently track
 
3919
    cherrypicks. The changes look like a normal commit, and the history of the
 
3920
    changes from the other branch is not stored in the commit.
 
3921
 
 
3922
    Revision numbers are always relative to the source branch.
3724
3923
 
3725
3924
    Merge will do its best to combine the changes in two branches, but there
3726
3925
    are some kinds of problems only a human can fix.  When it encounters those,
3729
3928
 
3730
3929
    Use bzr resolve when you have fixed a problem.  See also bzr conflicts.
3731
3930
 
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.
 
3931
    If there is no default branch set, the first merge will set it (use
 
3932
    --no-remember to avoid settting it). After that, you can omit the branch
 
3933
    to use the default.  To change the default, use --remember. The value will
 
3934
    only be saved if the remote location can be accessed.
3736
3935
 
3737
3936
    The results of the merge are placed into the destination working
3738
3937
    directory, where they can be reviewed (with bzr diff), tested, and then
3739
3938
    committed to record the result of the merge.
3740
3939
 
3741
3940
    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
 
3941
    --force is given.  If --force is given, then the changes from the source 
 
3942
    will be merged with the current working tree, including any uncommitted
 
3943
    changes in the tree.  The --force option can also be used to create a
3743
3944
    merge revision which has more than two parents.
3744
3945
 
3745
3946
    If one would like to merge changes from the working tree of the other
3750
3951
    you to apply each diff hunk and file change, similar to "shelve".
3751
3952
 
3752
3953
    :Examples:
3753
 
        To merge the latest revision from bzr.dev::
 
3954
        To merge all new revisions from bzr.dev::
3754
3955
 
3755
3956
            bzr merge ../bzr.dev
3756
3957
 
3793
3994
                ' completely merged into the source, pull from the'
3794
3995
                ' source rather than merging.  When this happens,'
3795
3996
                ' you do not need to commit the result.'),
3796
 
        Option('directory',
 
3997
        custom_help('directory',
3797
3998
               help='Branch to merge into, '
3798
 
                    'rather than the one containing the working directory.',
3799
 
               short_name='d',
3800
 
               type=unicode,
3801
 
               ),
 
3999
                    'rather than the one containing the working directory.'),
3802
4000
        Option('preview', help='Instead of merging, show a diff of the'
3803
4001
               ' merge.'),
3804
4002
        Option('interactive', help='Select changes interactively.',
3806
4004
    ]
3807
4005
 
3808
4006
    def run(self, location=None, revision=None, force=False,
3809
 
            merge_type=None, show_base=False, reprocess=None, remember=False,
 
4007
            merge_type=None, show_base=False, reprocess=None, remember=None,
3810
4008
            uncommitted=False, pull=False,
3811
4009
            directory=None,
3812
4010
            preview=False,
3820
4018
        merger = None
3821
4019
        allow_pending = True
3822
4020
        verified = 'inapplicable'
 
4021
 
3823
4022
        tree = WorkingTree.open_containing(directory)[0]
 
4023
        if tree.branch.revno() == 0:
 
4024
            raise errors.BzrCommandError('Merging into empty branches not currently supported, '
 
4025
                                         'https://bugs.launchpad.net/bzr/+bug/308562')
3824
4026
 
3825
4027
        try:
3826
4028
            basis_tree = tree.revision_tree(tree.last_revision())
3837
4039
            unversioned_filter=tree.is_ignored, view_info=view_info)
3838
4040
        pb = ui.ui_factory.nested_progress_bar()
3839
4041
        self.add_cleanup(pb.finished)
3840
 
        tree.lock_write()
3841
 
        self.add_cleanup(tree.unlock)
 
4042
        self.add_cleanup(tree.lock_write().unlock)
3842
4043
        if location is not None:
3843
4044
            try:
3844
4045
                mergeable = bundle.read_mergeable_from_url(location,
3873
4074
        self.sanity_check_merger(merger)
3874
4075
        if (merger.base_rev_id == merger.other_rev_id and
3875
4076
            merger.other_rev_id is not None):
 
4077
            # check if location is a nonexistent file (and not a branch) to
 
4078
            # disambiguate the 'Nothing to do'
 
4079
            if merger.interesting_files:
 
4080
                if not merger.other_tree.has_filename(
 
4081
                    merger.interesting_files[0]):
 
4082
                    note("merger: " + str(merger))
 
4083
                    raise errors.PathsDoNotExist([location])
3876
4084
            note('Nothing to do.')
3877
4085
            return 0
3878
 
        if pull:
 
4086
        if pull and not preview:
3879
4087
            if merger.interesting_files is not None:
3880
4088
                raise errors.BzrCommandError('Cannot pull individual files')
3881
4089
            if (merger.base_rev_id == tree.last_revision()):
3905
4113
    def _do_preview(self, merger):
3906
4114
        from bzrlib.diff import show_diff_trees
3907
4115
        result_tree = self._get_preview(merger)
 
4116
        path_encoding = osutils.get_diff_header_encoding()
3908
4117
        show_diff_trees(merger.this_tree, result_tree, self.outf,
3909
 
                        old_label='', new_label='')
 
4118
                        old_label='', new_label='',
 
4119
                        path_encoding=path_encoding)
3910
4120
 
3911
4121
    def _do_merge(self, merger, change_reporter, allow_pending, verified):
3912
4122
        merger.change_reporter = change_reporter
3988
4198
        if other_revision_id is None:
3989
4199
            other_revision_id = _mod_revision.ensure_null(
3990
4200
                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):
 
4201
        # Remember where we merge from. We need to remember if:
 
4202
        # - user specify a location (and we don't merge from the parent
 
4203
        #   branch)
 
4204
        # - user ask to remember or there is no previous location set to merge
 
4205
        #   from and user didn't ask to *not* remember
 
4206
        if (user_location is not None
 
4207
            and ((remember
 
4208
                  or (remember is None
 
4209
                      and tree.branch.get_submit_branch() is None)))):
3994
4210
            tree.branch.set_submit_branch(other_branch.base)
3995
 
        _merge_tags_if_possible(other_branch, tree.branch)
 
4211
        # Merge tags (but don't set them in the master branch yet, the user
 
4212
        # might revert this merge).  Commit will propagate them.
 
4213
        _merge_tags_if_possible(other_branch, tree.branch, ignore_master=True)
3996
4214
        merger = _mod_merge.Merger.from_revision_ids(pb, tree,
3997
4215
            other_revision_id, base_revision_id, other_branch, base_branch)
3998
4216
        if other_path != '':
4099
4317
        from bzrlib.conflicts import restore
4100
4318
        if merge_type is None:
4101
4319
            merge_type = _mod_merge.Merge3Merger
4102
 
        tree, file_list = tree_files(file_list)
4103
 
        tree.lock_write()
4104
 
        self.add_cleanup(tree.unlock)
 
4320
        tree, file_list = WorkingTree.open_containing_paths(file_list)
 
4321
        self.add_cleanup(tree.lock_write().unlock)
4105
4322
        parents = tree.get_parent_ids()
4106
4323
        if len(parents) != 2:
4107
4324
            raise errors.BzrCommandError("Sorry, remerge only works after normal"
4167
4384
    last committed revision is used.
4168
4385
 
4169
4386
    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.
 
4387
    merge instead.  For example, "merge . -r -2..-3" (don't forget the ".")
 
4388
    will remove the changes introduced by the second last commit (-2), without
 
4389
    affecting the changes introduced by the last commit (-1).  To remove
 
4390
    certain changes on a hunk-by-hunk basis, see the shelve command.
4173
4391
 
4174
4392
    By default, any files that have been manually changed will be backed up
4175
4393
    first.  (Files changed only by merge are not backed up.)  Backup files have
4205
4423
    target branches.
4206
4424
    """
4207
4425
 
4208
 
    _see_also = ['cat', 'export']
 
4426
    _see_also = ['cat', 'export', 'merge', 'shelve']
4209
4427
    takes_options = [
4210
4428
        'revision',
4211
4429
        Option('no-backup', "Do not save backups of reverted files."),
4216
4434
 
4217
4435
    def run(self, revision=None, no_backup=False, file_list=None,
4218
4436
            forget_merges=None):
4219
 
        tree, file_list = tree_files(file_list)
4220
 
        tree.lock_tree_write()
4221
 
        self.add_cleanup(tree.unlock)
 
4437
        tree, file_list = WorkingTree.open_containing_paths(file_list)
 
4438
        self.add_cleanup(tree.lock_tree_write().unlock)
4222
4439
        if forget_merges:
4223
4440
            tree.set_parent_ids(tree.get_parent_ids()[:1])
4224
4441
        else:
4313
4530
    _see_also = ['merge', 'pull']
4314
4531
    takes_args = ['other_branch?']
4315
4532
    takes_options = [
 
4533
        'directory',
4316
4534
        Option('reverse', 'Reverse the order of revisions.'),
4317
4535
        Option('mine-only',
4318
4536
               'Display changes in the local branch only.'),
4340
4558
            theirs_only=False,
4341
4559
            log_format=None, long=False, short=False, line=False,
4342
4560
            show_ids=False, verbose=False, this=False, other=False,
4343
 
            include_merges=False, revision=None, my_revision=None):
 
4561
            include_merges=False, revision=None, my_revision=None,
 
4562
            directory=u'.'):
4344
4563
        from bzrlib.missing import find_unmerged, iter_log_revisions
4345
4564
        def message(s):
4346
4565
            if not is_quiet():
4359
4578
        elif theirs_only:
4360
4579
            restrict = 'remote'
4361
4580
 
4362
 
        local_branch = Branch.open_containing(u".")[0]
4363
 
        local_branch.lock_read()
4364
 
        self.add_cleanup(local_branch.unlock)
 
4581
        local_branch = Branch.open_containing(directory)[0]
 
4582
        self.add_cleanup(local_branch.lock_read().unlock)
4365
4583
 
4366
4584
        parent = local_branch.get_parent()
4367
4585
        if other_branch is None:
4378
4596
        if remote_branch.base == local_branch.base:
4379
4597
            remote_branch = local_branch
4380
4598
        else:
4381
 
            remote_branch.lock_read()
4382
 
            self.add_cleanup(remote_branch.unlock)
 
4599
            self.add_cleanup(remote_branch.lock_read().unlock)
4383
4600
 
4384
4601
        local_revid_range = _revision_range_to_revid_range(
4385
4602
            _get_revision_range(my_revision, local_branch,
4440
4657
            message("Branches are up to date.\n")
4441
4658
        self.cleanup_now()
4442
4659
        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)
 
4660
            self.add_cleanup(local_branch.lock_write().unlock)
4445
4661
            # handle race conditions - a parent might be set while we run.
4446
4662
            if local_branch.get_parent() is None:
4447
4663
                local_branch.set_parent(remote_branch.base)
4506
4722
 
4507
4723
    @display_command
4508
4724
    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")
 
4725
        from bzrlib import plugin
 
4726
        # Don't give writelines a generator as some codecs don't like that
 
4727
        self.outf.writelines(
 
4728
            list(plugin.describe_plugins(show_paths=verbose)))
4529
4729
 
4530
4730
 
4531
4731
class cmd_testament(Command):
4547
4747
            b = Branch.open_containing(branch)[0]
4548
4748
        else:
4549
4749
            b = Branch.open(branch)
4550
 
        b.lock_read()
4551
 
        self.add_cleanup(b.unlock)
 
4750
        self.add_cleanup(b.lock_read().unlock)
4552
4751
        if revision is None:
4553
4752
            rev_id = b.last_revision()
4554
4753
        else:
4578
4777
                     Option('long', help='Show commit date in annotations.'),
4579
4778
                     'revision',
4580
4779
                     'show-ids',
 
4780
                     'directory',
4581
4781
                     ]
4582
4782
    encoding_type = 'exact'
4583
4783
 
4584
4784
    @display_command
4585
4785
    def run(self, filename, all=False, long=False, revision=None,
4586
 
            show_ids=False):
4587
 
        from bzrlib.annotate import annotate_file, annotate_file_tree
 
4786
            show_ids=False, directory=None):
 
4787
        from bzrlib.annotate import (
 
4788
            annotate_file_tree,
 
4789
            )
4588
4790
        wt, branch, relpath = \
4589
 
            bzrdir.BzrDir.open_containing_tree_or_branch(filename)
 
4791
            _open_directory_or_containing_tree_or_branch(filename, directory)
4590
4792
        if wt is not None:
4591
 
            wt.lock_read()
4592
 
            self.add_cleanup(wt.unlock)
 
4793
            self.add_cleanup(wt.lock_read().unlock)
4593
4794
        else:
4594
 
            branch.lock_read()
4595
 
            self.add_cleanup(branch.unlock)
 
4795
            self.add_cleanup(branch.lock_read().unlock)
4596
4796
        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:
 
4797
        self.add_cleanup(tree.lock_read().unlock)
 
4798
        if wt is not None and revision is None:
4600
4799
            file_id = wt.path2id(relpath)
4601
4800
        else:
4602
4801
            file_id = tree.path2id(relpath)
4603
4802
        if file_id is None:
4604
4803
            raise errors.NotVersionedError(filename)
4605
 
        file_version = tree.inventory[file_id].revision
4606
4804
        if wt is not None and revision is None:
4607
4805
            # If there is a tree and we're not annotating historical
4608
4806
            # versions, annotate the working tree's content.
4609
4807
            annotate_file_tree(wt, file_id, self.outf, long, all,
4610
4808
                show_ids=show_ids)
4611
4809
        else:
4612
 
            annotate_file(branch, file_version, file_id, long, all, self.outf,
4613
 
                          show_ids=show_ids)
 
4810
            annotate_file_tree(tree, file_id, self.outf, long, all,
 
4811
                show_ids=show_ids, branch=branch)
4614
4812
 
4615
4813
 
4616
4814
class cmd_re_sign(Command):
4619
4817
 
4620
4818
    hidden = True # is this right ?
4621
4819
    takes_args = ['revision_id*']
4622
 
    takes_options = ['revision']
 
4820
    takes_options = ['directory', 'revision']
4623
4821
 
4624
 
    def run(self, revision_id_list=None, revision=None):
 
4822
    def run(self, revision_id_list=None, revision=None, directory=u'.'):
4625
4823
        if revision_id_list is not None and revision is not None:
4626
4824
            raise errors.BzrCommandError('You can only supply one of revision_id or --revision')
4627
4825
        if revision_id_list is None and revision is None:
4628
4826
            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)
 
4827
        b = WorkingTree.open_containing(directory)[0].branch
 
4828
        self.add_cleanup(b.lock_write().unlock)
4632
4829
        return self._run(b, revision_id_list, revision)
4633
4830
 
4634
4831
    def _run(self, b, revision_id_list, revision):
4693
4890
 
4694
4891
    _see_also = ['checkouts', 'unbind']
4695
4892
    takes_args = ['location?']
4696
 
    takes_options = []
 
4893
    takes_options = ['directory']
4697
4894
 
4698
 
    def run(self, location=None):
4699
 
        b, relpath = Branch.open_containing(u'.')
 
4895
    def run(self, location=None, directory=u'.'):
 
4896
        b, relpath = Branch.open_containing(directory)
4700
4897
        if location is None:
4701
4898
            try:
4702
4899
                location = b.get_old_bound_location()
4729
4926
 
4730
4927
    _see_also = ['checkouts', 'bind']
4731
4928
    takes_args = []
4732
 
    takes_options = []
 
4929
    takes_options = ['directory']
4733
4930
 
4734
 
    def run(self):
4735
 
        b, relpath = Branch.open_containing(u'.')
 
4931
    def run(self, directory=u'.'):
 
4932
        b, relpath = Branch.open_containing(directory)
4736
4933
        if not b.unbind():
4737
4934
            raise errors.BzrCommandError('Local branch is not bound')
4738
4935
 
4784
4981
            b = control.open_branch()
4785
4982
 
4786
4983
        if tree is not None:
4787
 
            tree.lock_write()
4788
 
            self.add_cleanup(tree.unlock)
 
4984
            self.add_cleanup(tree.lock_write().unlock)
4789
4985
        else:
4790
 
            b.lock_write()
4791
 
            self.add_cleanup(b.unlock)
 
4986
            self.add_cleanup(b.lock_write().unlock)
4792
4987
        return self._run(b, tree, dry_run, verbose, revision, force, local=local)
4793
4988
 
4794
4989
    def _run(self, b, tree, dry_run, verbose, revision, force, local=False):
4833
5028
            self.outf.write('The above revision(s) will be removed.\n')
4834
5029
 
4835
5030
        if not force:
4836
 
            if not ui.ui_factory.get_boolean('Are you sure'):
4837
 
                self.outf.write('Canceled')
 
5031
            if not ui.ui_factory.confirm_action(
 
5032
                    u'Uncommit these revisions',
 
5033
                    'bzrlib.builtins.uncommit',
 
5034
                    {}):
 
5035
                self.outf.write('Canceled\n')
4838
5036
                return 0
4839
5037
 
4840
5038
        mutter('Uncommitting from {%s} to {%s}',
4846
5044
 
4847
5045
 
4848
5046
class cmd_break_lock(Command):
4849
 
    __doc__ = """Break a dead lock on a repository, branch or working directory.
 
5047
    __doc__ = """Break a dead lock.
 
5048
 
 
5049
    This command breaks a lock on a repository, branch, working directory or
 
5050
    config file.
4850
5051
 
4851
5052
    CAUTION: Locks should only be broken when you are sure that the process
4852
5053
    holding the lock has been stopped.
4857
5058
    :Examples:
4858
5059
        bzr break-lock
4859
5060
        bzr break-lock bzr+ssh://example.com/bzr/foo
 
5061
        bzr break-lock --conf ~/.bazaar
4860
5062
    """
 
5063
 
4861
5064
    takes_args = ['location?']
 
5065
    takes_options = [
 
5066
        Option('config',
 
5067
               help='LOCATION is the directory where the config lock is.'),
 
5068
        Option('force',
 
5069
            help='Do not ask for confirmation before breaking the lock.'),
 
5070
        ]
4862
5071
 
4863
 
    def run(self, location=None, show=False):
 
5072
    def run(self, location=None, config=False, force=False):
4864
5073
        if location is None:
4865
5074
            location = u'.'
4866
 
        control, relpath = bzrdir.BzrDir.open_containing(location)
4867
 
        try:
4868
 
            control.break_lock()
4869
 
        except NotImplementedError:
4870
 
            pass
 
5075
        if force:
 
5076
            ui.ui_factory = ui.ConfirmationUserInterfacePolicy(ui.ui_factory,
 
5077
                None,
 
5078
                {'bzrlib.lockdir.break': True})
 
5079
        if config:
 
5080
            conf = _mod_config.LockableConfig(file_name=location)
 
5081
            conf.break_lock()
 
5082
        else:
 
5083
            control, relpath = bzrdir.BzrDir.open_containing(location)
 
5084
            try:
 
5085
                control.break_lock()
 
5086
            except NotImplementedError:
 
5087
                pass
4871
5088
 
4872
5089
 
4873
5090
class cmd_wait_until_signalled(Command):
4902
5119
                    'result in a dynamically allocated port.  The default port '
4903
5120
                    'depends on the protocol.',
4904
5121
               type=str),
4905
 
        Option('directory',
4906
 
               help='Serve contents of this directory.',
4907
 
               type=unicode),
 
5122
        custom_help('directory',
 
5123
               help='Serve contents of this directory.'),
4908
5124
        Option('allow-writes',
4909
5125
               help='By default the server is a readonly server.  Supplying '
4910
5126
                    '--allow-writes enables write access to the contents of '
4937
5153
 
4938
5154
    def run(self, port=None, inet=False, directory=None, allow_writes=False,
4939
5155
            protocol=None):
4940
 
        from bzrlib.transport import get_transport, transport_server_registry
 
5156
        from bzrlib import transport
4941
5157
        if directory is None:
4942
5158
            directory = os.getcwd()
4943
5159
        if protocol is None:
4944
 
            protocol = transport_server_registry.get()
 
5160
            protocol = transport.transport_server_registry.get()
4945
5161
        host, port = self.get_host_and_port(port)
4946
5162
        url = urlutils.local_path_to_url(directory)
4947
5163
        if not allow_writes:
4948
5164
            url = 'readonly+' + url
4949
 
        transport = get_transport(url)
4950
 
        protocol(transport, host, port, inet)
 
5165
        t = transport.get_transport(url)
 
5166
        protocol(t, host, port, inet)
4951
5167
 
4952
5168
 
4953
5169
class cmd_join(Command):
4959
5175
    not part of it.  (Such trees can be produced by "bzr split", but also by
4960
5176
    running "bzr branch" with the target inside a tree.)
4961
5177
 
4962
 
    The result is a combined tree, with the subtree no longer an independant
 
5178
    The result is a combined tree, with the subtree no longer an independent
4963
5179
    part.  This is marked as a merge of the subtree into the containing tree,
4964
5180
    and all history is preserved.
4965
5181
    """
5046
5262
    _see_also = ['send']
5047
5263
 
5048
5264
    takes_options = [
 
5265
        'directory',
5049
5266
        RegistryOption.from_kwargs('patch-type',
5050
5267
            'The type of patch to include in the directive.',
5051
5268
            title='Patch type',
5064
5281
    encoding_type = 'exact'
5065
5282
 
5066
5283
    def run(self, submit_branch=None, public_branch=None, patch_type='bundle',
5067
 
            sign=False, revision=None, mail_to=None, message=None):
 
5284
            sign=False, revision=None, mail_to=None, message=None,
 
5285
            directory=u'.'):
5068
5286
        from bzrlib.revision import ensure_null, NULL_REVISION
5069
5287
        include_patch, include_bundle = {
5070
5288
            'plain': (False, False),
5071
5289
            'diff': (True, False),
5072
5290
            'bundle': (True, True),
5073
5291
            }[patch_type]
5074
 
        branch = Branch.open('.')
 
5292
        branch = Branch.open(directory)
5075
5293
        stored_submit_branch = branch.get_submit_branch()
5076
5294
        if submit_branch is None:
5077
5295
            submit_branch = stored_submit_branch
5153
5371
    source branch defaults to that containing the working directory, but can
5154
5372
    be changed using --from.
5155
5373
 
 
5374
    Both the submit branch and the public branch follow the usual behavior with
 
5375
    respect to --remember: If there is no default location set, the first send
 
5376
    will set it (use --no-remember to avoid settting it). After that, you can
 
5377
    omit the location to use the default.  To change the default, use
 
5378
    --remember. The value will only be saved if the location can be accessed.
 
5379
 
5156
5380
    In order to calculate those changes, bzr must analyse the submit branch.
5157
5381
    Therefore it is most efficient for the submit branch to be a local mirror.
5158
5382
    If a public location is known for the submit_branch, that location is used
5162
5386
    given, in which case it is sent to a file.
5163
5387
 
5164
5388
    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.
 
5389
    on Windows (it uses MAPI).  On Unix, it requires the xdg-email utility.
5166
5390
    If the preferred client can't be found (or used), your editor will be used.
5167
5391
 
5168
5392
    To use a specific mail program, set the mail_client configuration option.
5227
5451
        ]
5228
5452
 
5229
5453
    def run(self, submit_branch=None, public_branch=None, no_bundle=False,
5230
 
            no_patch=False, revision=None, remember=False, output=None,
 
5454
            no_patch=False, revision=None, remember=None, output=None,
5231
5455
            format=None, mail_to=None, message=None, body=None,
5232
5456
            strict=None, **kwargs):
5233
5457
        from bzrlib.send import send
5339
5563
        Option('delete',
5340
5564
            help='Delete this tag rather than placing it.',
5341
5565
            ),
5342
 
        Option('directory',
5343
 
            help='Branch in which to place the tag.',
5344
 
            short_name='d',
5345
 
            type=unicode,
5346
 
            ),
 
5566
        custom_help('directory',
 
5567
            help='Branch in which to place the tag.'),
5347
5568
        Option('force',
5348
5569
            help='Replace existing tags.',
5349
5570
            ),
5357
5578
            revision=None,
5358
5579
            ):
5359
5580
        branch, relpath = Branch.open_containing(directory)
5360
 
        branch.lock_write()
5361
 
        self.add_cleanup(branch.unlock)
 
5581
        self.add_cleanup(branch.lock_write().unlock)
5362
5582
        if delete:
5363
5583
            if tag_name is None:
5364
5584
                raise errors.BzrCommandError("No tag specified to delete.")
5365
5585
            branch.tags.delete_tag(tag_name)
5366
 
            self.outf.write('Deleted tag %s.\n' % tag_name)
 
5586
            note('Deleted tag %s.' % tag_name)
5367
5587
        else:
5368
5588
            if revision:
5369
5589
                if len(revision) != 1:
5381
5601
            if (not force) and branch.tags.has_tag(tag_name):
5382
5602
                raise errors.TagAlreadyExists(tag_name)
5383
5603
            branch.tags.set_tag(tag_name, revision_id)
5384
 
            self.outf.write('Created tag %s.\n' % tag_name)
 
5604
            note('Created tag %s.' % tag_name)
5385
5605
 
5386
5606
 
5387
5607
class cmd_tags(Command):
5392
5612
 
5393
5613
    _see_also = ['tag']
5394
5614
    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',
 
5615
        custom_help('directory',
 
5616
            help='Branch whose tags should be displayed.'),
 
5617
        RegistryOption('sort',
5401
5618
            'Sort tags by different criteria.', title='Sorting',
5402
 
            alpha='Sort tags lexicographically (default).',
5403
 
            time='Sort tags chronologically.',
 
5619
            lazy_registry=('bzrlib.tag', 'tag_sort_methods')
5404
5620
            ),
5405
5621
        'show-ids',
5406
5622
        'revision',
5407
5623
    ]
5408
5624
 
5409
5625
    @display_command
5410
 
    def run(self,
5411
 
            directory='.',
5412
 
            sort='alpha',
5413
 
            show_ids=False,
5414
 
            revision=None,
5415
 
            ):
 
5626
    def run(self, directory='.', sort=None, show_ids=False, revision=None):
 
5627
        from bzrlib.tag import tag_sort_methods
5416
5628
        branch, relpath = Branch.open_containing(directory)
5417
5629
 
5418
5630
        tags = branch.tags.get_tag_dict().items()
5419
5631
        if not tags:
5420
5632
            return
5421
5633
 
5422
 
        branch.lock_read()
5423
 
        self.add_cleanup(branch.unlock)
 
5634
        self.add_cleanup(branch.lock_read().unlock)
5424
5635
        if revision:
5425
5636
            graph = branch.repository.get_graph()
5426
5637
            rev1, rev2 = _get_revision_range(revision, branch, self.name())
5428
5639
            # only show revisions between revid1 and revid2 (inclusive)
5429
5640
            tags = [(tag, revid) for tag, revid in tags if
5430
5641
                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]])
 
5642
        if sort is None:
 
5643
            sort = tag_sort_methods.get()
 
5644
        sort(branch, tags)
5444
5645
        if not show_ids:
5445
5646
            # [ (tag, revid), ... ] -> [ (tag, dotted_revno), ... ]
5446
5647
            for index, (tag, revid) in enumerate(tags):
5448
5649
                    revno = branch.revision_id_to_dotted_revno(revid)
5449
5650
                    if isinstance(revno, tuple):
5450
5651
                        revno = '.'.join(map(str, revno))
5451
 
                except errors.NoSuchRevision:
 
5652
                except (errors.NoSuchRevision, errors.GhostRevisionsHaveNoRevno):
5452
5653
                    # Bad tag data/merges can lead to tagged revisions
5453
5654
                    # which are not in this branch. Fail gracefully ...
5454
5655
                    revno = '?'
5512
5713
            unstacked=None):
5513
5714
        directory = bzrdir.BzrDir.open(location)
5514
5715
        if stacked_on and unstacked:
5515
 
            raise BzrCommandError("Can't use both --stacked-on and --unstacked")
 
5716
            raise errors.BzrCommandError("Can't use both --stacked-on and --unstacked")
5516
5717
        elif stacked_on is not None:
5517
5718
            reconfigure.ReconfigureStackedOn().apply(directory, stacked_on)
5518
5719
        elif unstacked:
5573
5774
    """
5574
5775
 
5575
5776
    takes_args = ['to_location?']
5576
 
    takes_options = [Option('force',
 
5777
    takes_options = ['directory',
 
5778
                     Option('force',
5577
5779
                        help='Switch even if local commits will be lost.'),
5578
5780
                     'revision',
5579
5781
                     Option('create-branch', short_name='b',
5582
5784
                    ]
5583
5785
 
5584
5786
    def run(self, to_location=None, force=False, create_branch=False,
5585
 
            revision=None):
 
5787
            revision=None, directory=u'.'):
5586
5788
        from bzrlib import switch
5587
 
        tree_location = '.'
 
5789
        tree_location = directory
5588
5790
        revision = _get_one_revision('switch', revision)
5589
5791
        control_dir = bzrdir.BzrDir.open_containing(tree_location)[0]
5590
5792
        if to_location is None:
5591
5793
            if revision is None:
5592
5794
                raise errors.BzrCommandError('You must supply either a'
5593
5795
                                             ' revision or a location')
5594
 
            to_location = '.'
 
5796
            to_location = tree_location
5595
5797
        try:
5596
5798
            branch = control_dir.open_branch()
5597
5799
            had_explicit_nick = branch.get_config().has_explicit_nickname()
5732
5934
            name=None,
5733
5935
            switch=None,
5734
5936
            ):
5735
 
        tree, file_list = tree_files(file_list, apply_view=False)
 
5937
        tree, file_list = WorkingTree.open_containing_paths(file_list,
 
5938
            apply_view=False)
5736
5939
        current_view, view_dict = tree.views.get_view_info()
5737
5940
        if name is None:
5738
5941
            name = current_view
5842
6045
            location = "."
5843
6046
        branch = Branch.open_containing(location)[0]
5844
6047
        branch.bzrdir.destroy_branch()
5845
 
        
 
6048
 
5846
6049
 
5847
6050
class cmd_shelve(Command):
5848
6051
    __doc__ = """Temporarily set aside some changes from the current tree.
5867
6070
 
5868
6071
    You can put multiple items on the shelf, and by default, 'unshelve' will
5869
6072
    restore the most recently shelved changes.
 
6073
 
 
6074
    For complicated changes, it is possible to edit the changes in a separate
 
6075
    editor program to decide what the file remaining in the working copy
 
6076
    should look like.  To do this, add the configuration option
 
6077
 
 
6078
        change_editor = PROGRAM @new_path @old_path
 
6079
 
 
6080
    where @new_path is replaced with the path of the new version of the 
 
6081
    file and @old_path is replaced with the path of the old version of 
 
6082
    the file.  The PROGRAM should save the new file with the desired 
 
6083
    contents of the file in the working tree.
 
6084
        
5870
6085
    """
5871
6086
 
5872
6087
    takes_args = ['file*']
5873
6088
 
5874
6089
    takes_options = [
 
6090
        'directory',
5875
6091
        'revision',
5876
6092
        Option('all', help='Shelve all changes.'),
5877
6093
        'message',
5883
6099
        Option('destroy',
5884
6100
               help='Destroy removed changes instead of shelving them.'),
5885
6101
    ]
5886
 
    _see_also = ['unshelve']
 
6102
    _see_also = ['unshelve', 'configuration']
5887
6103
 
5888
6104
    def run(self, revision=None, all=False, file_list=None, message=None,
5889
 
            writer=None, list=False, destroy=False):
 
6105
            writer=None, list=False, destroy=False, directory=None):
5890
6106
        if list:
5891
 
            return self.run_for_list()
 
6107
            return self.run_for_list(directory=directory)
5892
6108
        from bzrlib.shelf_ui import Shelver
5893
6109
        if writer is None:
5894
6110
            writer = bzrlib.option.diff_writer_registry.get()
5895
6111
        try:
5896
6112
            shelver = Shelver.from_args(writer(sys.stdout), revision, all,
5897
 
                file_list, message, destroy=destroy)
 
6113
                file_list, message, destroy=destroy, directory=directory)
5898
6114
            try:
5899
6115
                shelver.run()
5900
6116
            finally:
5902
6118
        except errors.UserAbort:
5903
6119
            return 0
5904
6120
 
5905
 
    def run_for_list(self):
5906
 
        tree = WorkingTree.open_containing('.')[0]
5907
 
        tree.lock_read()
5908
 
        self.add_cleanup(tree.unlock)
 
6121
    def run_for_list(self, directory=None):
 
6122
        if directory is None:
 
6123
            directory = u'.'
 
6124
        tree = WorkingTree.open_containing(directory)[0]
 
6125
        self.add_cleanup(tree.lock_read().unlock)
5909
6126
        manager = tree.get_shelf_manager()
5910
6127
        shelves = manager.active_shelves()
5911
6128
        if len(shelves) == 0:
5929
6146
 
5930
6147
    takes_args = ['shelf_id?']
5931
6148
    takes_options = [
 
6149
        'directory',
5932
6150
        RegistryOption.from_kwargs(
5933
6151
            'action', help="The action to perform.",
5934
6152
            enum_switch=False, value_switches=True,
5942
6160
    ]
5943
6161
    _see_also = ['shelve']
5944
6162
 
5945
 
    def run(self, shelf_id=None, action='apply'):
 
6163
    def run(self, shelf_id=None, action='apply', directory=u'.'):
5946
6164
        from bzrlib.shelf_ui import Unshelver
5947
 
        unshelver = Unshelver.from_args(shelf_id, action)
 
6165
        unshelver = Unshelver.from_args(shelf_id, action, directory=directory)
5948
6166
        try:
5949
6167
            unshelver.run()
5950
6168
        finally:
5966
6184
 
5967
6185
    To check what clean-tree will do, use --dry-run.
5968
6186
    """
5969
 
    takes_options = [Option('ignored', help='Delete all ignored files.'),
5970
 
                     Option('detritus', help='Delete conflict files, merge'
 
6187
    takes_options = ['directory',
 
6188
                     Option('ignored', help='Delete all ignored files.'),
 
6189
                     Option('detritus', help='Delete conflict files, merge and revert'
5971
6190
                            ' backups, and failed selftest dirs.'),
5972
6191
                     Option('unknown',
5973
6192
                            help='Delete files unknown to bzr (default).'),
5975
6194
                            ' deleting them.'),
5976
6195
                     Option('force', help='Do not prompt before deleting.')]
5977
6196
    def run(self, unknown=False, ignored=False, detritus=False, dry_run=False,
5978
 
            force=False):
 
6197
            force=False, directory=u'.'):
5979
6198
        from bzrlib.clean_tree import clean_tree
5980
6199
        if not (unknown or ignored or detritus):
5981
6200
            unknown = True
5982
6201
        if dry_run:
5983
6202
            force = True
5984
 
        clean_tree('.', unknown=unknown, ignored=ignored, detritus=detritus,
5985
 
                   dry_run=dry_run, no_prompt=force)
 
6203
        clean_tree(directory, unknown=unknown, ignored=ignored,
 
6204
                   detritus=detritus, dry_run=dry_run, no_prompt=force)
5986
6205
 
5987
6206
 
5988
6207
class cmd_reference(Command):
6032
6251
            self.outf.write('%s %s\n' % (path, location))
6033
6252
 
6034
6253
 
 
6254
class cmd_export_pot(Command):
 
6255
    __doc__ = """Export command helps and error messages in po format."""
 
6256
 
 
6257
    hidden = True
 
6258
 
 
6259
    def run(self):
 
6260
        from bzrlib.export_pot import export_pot
 
6261
        export_pot(self.outf)
 
6262
 
 
6263
 
6035
6264
def _register_lazy_builtins():
6036
6265
    # register lazy builtins from other modules; called at startup and should
6037
6266
    # be only called once.
6038
6267
    for (name, aliases, module_name) in [
6039
6268
        ('cmd_bundle_info', [], 'bzrlib.bundle.commands'),
 
6269
        ('cmd_config', [], 'bzrlib.config'),
6040
6270
        ('cmd_dpush', [], 'bzrlib.foreign'),
6041
6271
        ('cmd_version_info', [], 'bzrlib.cmd_version_info'),
6042
6272
        ('cmd_resolve', ['resolved'], 'bzrlib.conflicts'),
6043
6273
        ('cmd_conflicts', [], 'bzrlib.conflicts'),
6044
 
        ('cmd_sign_my_commits', [], 'bzrlib.sign_my_commits'),
 
6274
        ('cmd_sign_my_commits', [], 'bzrlib.commit_signature_commands'),
 
6275
        ('cmd_verify_signatures', [],
 
6276
                                        'bzrlib.commit_signature_commands'),
 
6277
        ('cmd_test_script', [], 'bzrlib.cmd_test_script'),
6045
6278
        ]:
6046
6279
        builtin_command_registry.register_lazy(name, aliases, module_name)