/brz/remove-bazaar

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

« back to all changes in this revision

Viewing changes to bzrlib/builtins.py

  • Committer: Vincent Ladeuil
  • Date: 2011-08-20 07:49:15 UTC
  • mto: This revision was merged to the branch mainline in revision 6087.
  • Revision ID: v.ladeuil+lp@free.fr-20110820074915-kjh3a6re56pvatit
Delay the required imports.

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:
1285
1334
                urlutils.unescape_for_display(branch.base, 'utf-8'))
1286
1335
 
1287
1336
 
 
1337
class cmd_branches(Command):
 
1338
    __doc__ = """List the branches available at the current location.
 
1339
 
 
1340
    This command will print the names of all the branches at the current location.
 
1341
    """
 
1342
 
 
1343
    takes_args = ['location?']
 
1344
 
 
1345
    def run(self, location="."):
 
1346
        dir = bzrdir.BzrDir.open_containing(location)[0]
 
1347
        for branch in dir.list_branches():
 
1348
            if branch.name is None:
 
1349
                self.outf.write(" (default)\n")
 
1350
            else:
 
1351
                self.outf.write(" %s\n" % branch.name.encode(self.outf.encoding))
 
1352
 
 
1353
 
1288
1354
class cmd_checkout(Command):
1289
1355
    __doc__ = """Create a new checkout of an existing branch.
1290
1356
 
1331
1397
            to_location = branch_location
1332
1398
        accelerator_tree, source = bzrdir.BzrDir.open_tree_or_branch(
1333
1399
            branch_location)
 
1400
        if not (hardlink or files_from):
 
1401
            # accelerator_tree is usually slower because you have to read N
 
1402
            # files (no readahead, lots of seeks, etc), but allow the user to
 
1403
            # explicitly request it
 
1404
            accelerator_tree = None
1334
1405
        revision = _get_one_revision('checkout', revision)
1335
 
        if files_from is not None:
 
1406
        if files_from is not None and files_from != branch_location:
1336
1407
            accelerator_tree = WorkingTree.open(files_from)
1337
1408
        if revision is not None:
1338
1409
            revision_id = revision.as_revision_id(source)
1366
1437
    @display_command
1367
1438
    def run(self, dir=u'.'):
1368
1439
        tree = WorkingTree.open_containing(dir)[0]
1369
 
        tree.lock_read()
1370
 
        self.add_cleanup(tree.unlock)
 
1440
        self.add_cleanup(tree.lock_read().unlock)
1371
1441
        new_inv = tree.inventory
1372
1442
        old_tree = tree.basis_tree()
1373
 
        old_tree.lock_read()
1374
 
        self.add_cleanup(old_tree.unlock)
 
1443
        self.add_cleanup(old_tree.lock_read().unlock)
1375
1444
        old_inv = old_tree.inventory
1376
1445
        renames = []
1377
1446
        iterator = tree.iter_changes(old_tree, include_unchanged=True)
1396
1465
    If you want to discard your local changes, you can just do a
1397
1466
    'bzr revert' instead of 'bzr commit' after the update.
1398
1467
 
 
1468
    If you want to restore a file that has been removed locally, use
 
1469
    'bzr revert' instead of 'bzr update'.
 
1470
 
1399
1471
    If the tree's branch is bound to a master branch, it will also update
1400
1472
    the branch from the master.
1401
1473
    """
1402
1474
 
1403
1475
    _see_also = ['pull', 'working-trees', 'status-flags']
1404
1476
    takes_args = ['dir?']
1405
 
    takes_options = ['revision']
 
1477
    takes_options = ['revision',
 
1478
                     Option('show-base',
 
1479
                            help="Show base revision text in conflicts."),
 
1480
                     ]
1406
1481
    aliases = ['up']
1407
1482
 
1408
 
    def run(self, dir='.', revision=None):
 
1483
    def run(self, dir='.', revision=None, show_base=None):
1409
1484
        if revision is not None and len(revision) != 1:
1410
1485
            raise errors.BzrCommandError(
1411
1486
                        "bzr update --revision takes exactly one revision")
1415
1490
        master = branch.get_master_branch(
1416
1491
            possible_transports=possible_transports)
1417
1492
        if master is not None:
1418
 
            tree.lock_write()
1419
1493
            branch_location = master.base
 
1494
            tree.lock_write()
1420
1495
        else:
 
1496
            branch_location = tree.branch.base
1421
1497
            tree.lock_tree_write()
1422
 
            branch_location = tree.branch.base
1423
1498
        self.add_cleanup(tree.unlock)
1424
1499
        # get rid of the final '/' and be ready for display
1425
1500
        branch_location = urlutils.unescape_for_display(
1451
1526
                change_reporter,
1452
1527
                possible_transports=possible_transports,
1453
1528
                revision=revision_id,
1454
 
                old_tip=old_tip)
 
1529
                old_tip=old_tip,
 
1530
                show_base=show_base)
1455
1531
        except errors.NoSuchRevision, e:
1456
1532
            raise errors.BzrCommandError(
1457
1533
                                  "branch has no revision %s\n"
1519
1595
class cmd_remove(Command):
1520
1596
    __doc__ = """Remove files or directories.
1521
1597
 
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.
 
1598
    This makes Bazaar stop tracking changes to the specified files. Bazaar will
 
1599
    delete them if they can easily be recovered using revert otherwise they
 
1600
    will be backed up (adding an extention of the form .~#~). If no options or
 
1601
    parameters are given Bazaar will scan for files that are being tracked by
 
1602
    Bazaar but missing in your tree and stop tracking them for you.
1526
1603
    """
1527
1604
    takes_args = ['file*']
1528
1605
    takes_options = ['verbose',
1530
1607
        RegistryOption.from_kwargs('file-deletion-strategy',
1531
1608
            'The file deletion mode to be used.',
1532
1609
            title='Deletion Strategy', value_switches=True, enum_switch=False,
1533
 
            safe='Only delete files if they can be'
1534
 
                 ' safely recovered (default).',
 
1610
            safe='Backup changed files (default).',
1535
1611
            keep='Delete from bzr but leave the working copy.',
 
1612
            no_backup='Don\'t backup changed files.',
1536
1613
            force='Delete all the specified files, even if they can not be '
1537
 
                'recovered and even if they are non-empty directories.')]
 
1614
                'recovered and even if they are non-empty directories. '
 
1615
                '(deprecated, use no-backup)')]
1538
1616
    aliases = ['rm', 'del']
1539
1617
    encoding_type = 'replace'
1540
1618
 
1541
1619
    def run(self, file_list, verbose=False, new=False,
1542
1620
        file_deletion_strategy='safe'):
1543
 
        tree, file_list = tree_files(file_list)
 
1621
        if file_deletion_strategy == 'force':
 
1622
            note("(The --force option is deprecated, rather use --no-backup "
 
1623
                "in future.)")
 
1624
            file_deletion_strategy = 'no-backup'
 
1625
 
 
1626
        tree, file_list = WorkingTree.open_containing_paths(file_list)
1544
1627
 
1545
1628
        if file_list is not None:
1546
1629
            file_list = [f for f in file_list]
1547
1630
 
1548
 
        tree.lock_write()
1549
 
        self.add_cleanup(tree.unlock)
 
1631
        self.add_cleanup(tree.lock_write().unlock)
1550
1632
        # Heuristics should probably all move into tree.remove_smart or
1551
1633
        # some such?
1552
1634
        if new:
1567
1649
            file_deletion_strategy = 'keep'
1568
1650
        tree.remove(file_list, verbose=verbose, to_file=self.outf,
1569
1651
            keep_files=file_deletion_strategy=='keep',
1570
 
            force=file_deletion_strategy=='force')
 
1652
            force=(file_deletion_strategy=='no-backup'))
1571
1653
 
1572
1654
 
1573
1655
class cmd_file_id(Command):
1635
1717
 
1636
1718
    _see_also = ['check']
1637
1719
    takes_args = ['branch?']
 
1720
    takes_options = [
 
1721
        Option('canonicalize-chks',
 
1722
               help='Make sure CHKs are in canonical form (repairs '
 
1723
                    'bug 522637).',
 
1724
               hidden=True),
 
1725
        ]
1638
1726
 
1639
 
    def run(self, branch="."):
 
1727
    def run(self, branch=".", canonicalize_chks=False):
1640
1728
        from bzrlib.reconcile import reconcile
1641
1729
        dir = bzrdir.BzrDir.open(branch)
1642
 
        reconcile(dir)
 
1730
        reconcile(dir, canonicalize_chks=canonicalize_chks)
1643
1731
 
1644
1732
 
1645
1733
class cmd_revision_history(Command):
1677
1765
            b = wt.branch
1678
1766
            last_revision = wt.last_revision()
1679
1767
 
1680
 
        revision_ids = b.repository.get_ancestry(last_revision)
1681
 
        revision_ids.pop(0)
1682
 
        for revision_id in revision_ids:
 
1768
        self.add_cleanup(b.repository.lock_read().unlock)
 
1769
        graph = b.repository.get_graph()
 
1770
        revisions = [revid for revid, parents in
 
1771
            graph.iter_ancestry([last_revision])]
 
1772
        for revision_id in reversed(revisions):
 
1773
            if _mod_revision.is_null(revision_id):
 
1774
                continue
1683
1775
            self.outf.write(revision_id + '\n')
1684
1776
 
1685
1777
 
1722
1814
                ),
1723
1815
         Option('append-revisions-only',
1724
1816
                help='Never change revnos or the existing log.'
1725
 
                '  Append revisions to it only.')
 
1817
                '  Append revisions to it only.'),
 
1818
         Option('no-tree',
 
1819
                'Create a branch without a working tree.')
1726
1820
         ]
1727
1821
    def run(self, location=None, format=None, append_revisions_only=False,
1728
 
            create_prefix=False):
 
1822
            create_prefix=False, no_tree=False):
1729
1823
        if format is None:
1730
1824
            format = bzrdir.format_registry.make_bzrdir('default')
1731
1825
        if location is None:
1754
1848
        except errors.NotBranchError:
1755
1849
            # really a NotBzrDir error...
1756
1850
            create_branch = bzrdir.BzrDir.create_branch_convenience
 
1851
            if no_tree:
 
1852
                force_new_tree = False
 
1853
            else:
 
1854
                force_new_tree = None
1757
1855
            branch = create_branch(to_transport.base, format=format,
1758
 
                                   possible_transports=[to_transport])
 
1856
                                   possible_transports=[to_transport],
 
1857
                                   force_new_tree=force_new_tree)
1759
1858
            a_bzrdir = branch.bzrdir
1760
1859
        else:
1761
1860
            from bzrlib.transport.local import LocalTransport
1765
1864
                        raise errors.BranchExistsWithoutWorkingTree(location)
1766
1865
                raise errors.AlreadyBranchError(location)
1767
1866
            branch = a_bzrdir.create_branch()
1768
 
            a_bzrdir.create_workingtree()
 
1867
            if not no_tree:
 
1868
                a_bzrdir.create_workingtree()
1769
1869
        if append_revisions_only:
1770
1870
            try:
1771
1871
                branch.set_append_revisions_only(True)
1865
1965
    "bzr diff -p1" is equivalent to "bzr diff --prefix old/:new/", and
1866
1966
    produces patches suitable for "patch -p1".
1867
1967
 
 
1968
    Note that when using the -r argument with a range of revisions, the
 
1969
    differences are computed between the two specified revisions.  That
 
1970
    is, the command does not show the changes introduced by the first 
 
1971
    revision in the range.  This differs from the interpretation of 
 
1972
    revision ranges used by "bzr log" which includes the first revision
 
1973
    in the range.
 
1974
 
1868
1975
    :Exit values:
1869
1976
        1 - changed
1870
1977
        2 - unrepresentable changes
1888
1995
 
1889
1996
            bzr diff -r1..3 xxx
1890
1997
 
1891
 
        To see the changes introduced in revision X::
 
1998
        The changes introduced by revision 2 (equivalent to -r1..2)::
 
1999
 
 
2000
            bzr diff -c2
 
2001
 
 
2002
        To see the changes introduced by revision X::
1892
2003
        
1893
2004
            bzr diff -cX
1894
2005
 
1898
2009
 
1899
2010
            bzr diff -r<chosen_parent>..X
1900
2011
 
1901
 
        The changes introduced by revision 2 (equivalent to -r1..2)::
 
2012
        The changes between the current revision and the previous revision
 
2013
        (equivalent to -c-1 and -r-2..-1)
1902
2014
 
1903
 
            bzr diff -c2
 
2015
            bzr diff -r-2..
1904
2016
 
1905
2017
        Show just the differences for file NEWS::
1906
2018
 
1921
2033
        Same as 'bzr diff' but prefix paths with old/ and new/::
1922
2034
 
1923
2035
            bzr diff --prefix old/:new/
 
2036
            
 
2037
        Show the differences using a custom diff program with options::
 
2038
        
 
2039
            bzr diff --using /usr/bin/diff --diff-options -wu
1924
2040
    """
1925
2041
    _see_also = ['status']
1926
2042
    takes_args = ['file*']
1946
2062
            type=unicode,
1947
2063
            ),
1948
2064
        RegistryOption('format',
 
2065
            short_name='F',
1949
2066
            help='Diff format to use.',
1950
2067
            lazy_registry=('bzrlib.diff', 'format_registry'),
1951
 
            value_switches=False, title='Diff format'),
 
2068
            title='Diff format'),
1952
2069
        ]
1953
2070
    aliases = ['di', 'dif']
1954
2071
    encoding_type = 'exact'
1985
2102
         old_branch, new_branch,
1986
2103
         specific_files, extra_trees) = get_trees_and_branches_to_diff_locked(
1987
2104
            file_list, revision, old, new, self.add_cleanup, apply_view=True)
 
2105
        # GNU diff on Windows uses ANSI encoding for filenames
 
2106
        path_encoding = osutils.get_diff_header_encoding()
1988
2107
        return show_diff_trees(old_tree, new_tree, sys.stdout,
1989
2108
                               specific_files=specific_files,
1990
2109
                               external_diff_options=diff_options,
1991
2110
                               old_label=old_label, new_label=new_label,
1992
 
                               extra_trees=extra_trees, using=using,
 
2111
                               extra_trees=extra_trees,
 
2112
                               path_encoding=path_encoding,
 
2113
                               using=using,
1993
2114
                               format_cls=format)
1994
2115
 
1995
2116
 
2003
2124
    # level of effort but possibly much less IO.  (Or possibly not,
2004
2125
    # if the directories are very large...)
2005
2126
    _see_also = ['status', 'ls']
2006
 
    takes_options = ['show-ids']
 
2127
    takes_options = ['directory', 'show-ids']
2007
2128
 
2008
2129
    @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)
 
2130
    def run(self, show_ids=False, directory=u'.'):
 
2131
        tree = WorkingTree.open_containing(directory)[0]
 
2132
        self.add_cleanup(tree.lock_read().unlock)
2013
2133
        old = tree.basis_tree()
2014
 
        old.lock_read()
2015
 
        self.add_cleanup(old.unlock)
 
2134
        self.add_cleanup(old.lock_read().unlock)
2016
2135
        for path, ie in old.inventory.iter_entries():
2017
2136
            if not tree.has_id(ie.file_id):
2018
2137
                self.outf.write(path)
2028
2147
 
2029
2148
    hidden = True
2030
2149
    _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
 
            ]
 
2150
    takes_options = ['directory', 'null']
2036
2151
 
2037
2152
    @display_command
2038
 
    def run(self, null=False):
2039
 
        tree = WorkingTree.open_containing(u'.')[0]
 
2153
    def run(self, null=False, directory=u'.'):
 
2154
        tree = WorkingTree.open_containing(directory)[0]
 
2155
        self.add_cleanup(tree.lock_read().unlock)
2040
2156
        td = tree.changes_from(tree.basis_tree())
 
2157
        self.cleanup_now()
2041
2158
        for path, id, kind, text_modified, meta_modified in td.modified:
2042
2159
            if null:
2043
2160
                self.outf.write(path + '\0')
2051
2168
 
2052
2169
    hidden = True
2053
2170
    _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
 
            ]
 
2171
    takes_options = ['directory', 'null']
2059
2172
 
2060
2173
    @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)
 
2174
    def run(self, null=False, directory=u'.'):
 
2175
        wt = WorkingTree.open_containing(directory)[0]
 
2176
        self.add_cleanup(wt.lock_read().unlock)
2065
2177
        basis = wt.basis_tree()
2066
 
        basis.lock_read()
2067
 
        self.add_cleanup(basis.unlock)
 
2178
        self.add_cleanup(basis.lock_read().unlock)
2068
2179
        basis_inv = basis.inventory
2069
2180
        inv = wt.inventory
2070
2181
        for file_id in inv:
2071
 
            if file_id in basis_inv:
 
2182
            if basis_inv.has_id(file_id):
2072
2183
                continue
2073
2184
            if inv.is_root(file_id) and len(basis_inv) == 0:
2074
2185
                continue
2075
2186
            path = inv.id2path(file_id)
2076
 
            if not os.access(osutils.abspath(path), os.F_OK):
 
2187
            if not os.access(osutils.pathjoin(wt.basedir, path), os.F_OK):
2077
2188
                continue
2078
2189
            if null:
2079
2190
                self.outf.write(path + '\0')
2223
2334
 
2224
2335
    :Other filtering:
2225
2336
 
2226
 
      The --message option can be used for finding revisions that match a
2227
 
      regular expression in a commit message.
 
2337
      The --match option can be used for finding revisions that match a
 
2338
      regular expression in a commit message, committer, author or bug.
 
2339
      Specifying the option several times will match any of the supplied
 
2340
      expressions. --match-author, --match-bugs, --match-committer and
 
2341
      --match-message can be used to only match a specific field.
2228
2342
 
2229
2343
    :Tips & tricks:
2230
2344
 
2279
2393
                   help='Show just the specified revision.'
2280
2394
                   ' See also "help revisionspec".'),
2281
2395
            'log-format',
 
2396
            RegistryOption('authors',
 
2397
                'What names to list as authors - first, all or committer.',
 
2398
                title='Authors',
 
2399
                lazy_registry=('bzrlib.log', 'author_list_registry'),
 
2400
            ),
2282
2401
            Option('levels',
2283
2402
                   short_name='n',
2284
2403
                   help='Number of levels to display - 0 for all, 1 for flat.',
2285
2404
                   argname='N',
2286
2405
                   type=_parse_levels),
2287
2406
            Option('message',
2288
 
                   short_name='m',
2289
2407
                   help='Show revisions whose message matches this '
2290
2408
                        'regular expression.',
2291
 
                   type=str),
 
2409
                   type=str,
 
2410
                   hidden=True),
2292
2411
            Option('limit',
2293
2412
                   short_name='l',
2294
2413
                   help='Limit the output to the first N revisions.',
2302
2421
            Option('exclude-common-ancestry',
2303
2422
                   help='Display only the revisions that are not part'
2304
2423
                   ' of both ancestries (require -rX..Y)'
2305
 
                   )
 
2424
                   ),
 
2425
            Option('signatures',
 
2426
                   help='Show digital signature validity'),
 
2427
            ListOption('match',
 
2428
                short_name='m',
 
2429
                help='Show revisions whose properties match this '
 
2430
                'expression.',
 
2431
                type=str),
 
2432
            ListOption('match-message',
 
2433
                   help='Show revisions whose message matches this '
 
2434
                   'expression.',
 
2435
                type=str),
 
2436
            ListOption('match-committer',
 
2437
                   help='Show revisions whose committer matches this '
 
2438
                   'expression.',
 
2439
                type=str),
 
2440
            ListOption('match-author',
 
2441
                   help='Show revisions whose authors match this '
 
2442
                   'expression.',
 
2443
                type=str),
 
2444
            ListOption('match-bugs',
 
2445
                   help='Show revisions whose bugs match this '
 
2446
                   'expression.',
 
2447
                type=str)
2306
2448
            ]
2307
2449
    encoding_type = 'replace'
2308
2450
 
2319
2461
            limit=None,
2320
2462
            show_diff=False,
2321
2463
            include_merges=False,
 
2464
            authors=None,
2322
2465
            exclude_common_ancestry=False,
 
2466
            signatures=False,
 
2467
            match=None,
 
2468
            match_message=None,
 
2469
            match_committer=None,
 
2470
            match_author=None,
 
2471
            match_bugs=None,
2323
2472
            ):
2324
2473
        from bzrlib.log import (
2325
2474
            Logger,
2352
2501
        if file_list:
2353
2502
            # find the file ids to log and check for directory filtering
2354
2503
            b, file_info_list, rev1, rev2 = _get_info_for_log_files(
2355
 
                revision, file_list)
2356
 
            self.add_cleanup(b.unlock)
 
2504
                revision, file_list, self.add_cleanup)
2357
2505
            for relpath, file_id, kind in file_info_list:
2358
2506
                if file_id is None:
2359
2507
                    raise errors.BzrCommandError(
2377
2525
                location = '.'
2378
2526
            dir, relpath = bzrdir.BzrDir.open_containing(location)
2379
2527
            b = dir.open_branch()
2380
 
            b.lock_read()
2381
 
            self.add_cleanup(b.unlock)
 
2528
            self.add_cleanup(b.lock_read().unlock)
2382
2529
            rev1, rev2 = _get_revision_range(revision, b, self.name())
2383
2530
 
 
2531
        if b.get_config().validate_signatures_in_log():
 
2532
            signatures = True
 
2533
 
 
2534
        if signatures:
 
2535
            if not gpg.GPGStrategy.verify_signatures_available():
 
2536
                raise errors.GpgmeNotInstalled(None)
 
2537
 
2384
2538
        # Decide on the type of delta & diff filtering to use
2385
2539
        # TODO: add an --all-files option to make this configurable & consistent
2386
2540
        if not verbose:
2404
2558
                        show_timezone=timezone,
2405
2559
                        delta_format=get_verbosity_level(),
2406
2560
                        levels=levels,
2407
 
                        show_advice=levels is None)
 
2561
                        show_advice=levels is None,
 
2562
                        author_list_handler=authors)
2408
2563
 
2409
2564
        # Choose the algorithm for doing the logging. It's annoying
2410
2565
        # having multiple code paths like this but necessary until
2422
2577
        match_using_deltas = (len(file_ids) != 1 or filter_by_dir
2423
2578
            or delta_type or partial_history)
2424
2579
 
 
2580
        match_dict = {}
 
2581
        if match:
 
2582
            match_dict[''] = match
 
2583
        if match_message:
 
2584
            match_dict['message'] = match_message
 
2585
        if match_committer:
 
2586
            match_dict['committer'] = match_committer
 
2587
        if match_author:
 
2588
            match_dict['author'] = match_author
 
2589
        if match_bugs:
 
2590
            match_dict['bugs'] = match_bugs
 
2591
            
2425
2592
        # Build the LogRequest and execute it
2426
2593
        if len(file_ids) == 0:
2427
2594
            file_ids = None
2430
2597
            start_revision=rev1, end_revision=rev2, limit=limit,
2431
2598
            message_search=message, delta_type=delta_type,
2432
2599
            diff_type=diff_type, _match_using_deltas=match_using_deltas,
2433
 
            exclude_common_ancestry=exclude_common_ancestry,
 
2600
            exclude_common_ancestry=exclude_common_ancestry, match=match_dict,
 
2601
            signature=signatures
2434
2602
            )
2435
2603
        Logger(b, rqst).show(lf)
2436
2604
 
2508
2676
        tree, relpath = WorkingTree.open_containing(filename)
2509
2677
        file_id = tree.path2id(relpath)
2510
2678
        b = tree.branch
2511
 
        b.lock_read()
2512
 
        self.add_cleanup(b.unlock)
 
2679
        self.add_cleanup(b.lock_read().unlock)
2513
2680
        touching_revs = log.find_touching_revisions(b, file_id)
2514
2681
        for revno, revision_id, what in touching_revs:
2515
2682
            self.outf.write("%6d %s\n" % (revno, what))
2528
2695
                   help='Recurse into subdirectories.'),
2529
2696
            Option('from-root',
2530
2697
                   help='Print paths relative to the root of the branch.'),
2531
 
            Option('unknown', help='Print unknown files.'),
 
2698
            Option('unknown', short_name='u',
 
2699
                help='Print unknown files.'),
2532
2700
            Option('versioned', help='Print versioned files.',
2533
2701
                   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',
 
2702
            Option('ignored', short_name='i',
 
2703
                help='Print ignored files.'),
 
2704
            Option('kind', short_name='k',
2539
2705
                   help='List entries of a particular kind: file, directory, symlink.',
2540
2706
                   type=unicode),
 
2707
            'null',
2541
2708
            'show-ids',
 
2709
            'directory',
2542
2710
            ]
2543
2711
    @display_command
2544
2712
    def run(self, revision=None, verbose=False,
2545
2713
            recursive=False, from_root=False,
2546
2714
            unknown=False, versioned=False, ignored=False,
2547
 
            null=False, kind=None, show_ids=False, path=None):
 
2715
            null=False, kind=None, show_ids=False, path=None, directory=None):
2548
2716
 
2549
2717
        if kind and kind not in ('file', 'directory', 'symlink'):
2550
2718
            raise errors.BzrCommandError('invalid kind specified')
2562
2730
                raise errors.BzrCommandError('cannot specify both --from-root'
2563
2731
                                             ' and PATH')
2564
2732
            fs_path = path
2565
 
        tree, branch, relpath = bzrdir.BzrDir.open_containing_tree_or_branch(
2566
 
            fs_path)
 
2733
        tree, branch, relpath = \
 
2734
            _open_directory_or_containing_tree_or_branch(fs_path, directory)
2567
2735
 
2568
2736
        # Calculate the prefix to use
2569
2737
        prefix = None
2584
2752
                view_str = views.view_display_str(view_files)
2585
2753
                note("Ignoring files outside view. View is %s" % view_str)
2586
2754
 
2587
 
        tree.lock_read()
2588
 
        self.add_cleanup(tree.unlock)
 
2755
        self.add_cleanup(tree.lock_read().unlock)
2589
2756
        for fp, fc, fkind, fid, entry in tree.list_files(include_root=False,
2590
2757
            from_dir=relpath, recursive=recursive):
2591
2758
            # Apply additional masking
2638
2805
 
2639
2806
    hidden = True
2640
2807
    _see_also = ['ls']
 
2808
    takes_options = ['directory']
2641
2809
 
2642
2810
    @display_command
2643
 
    def run(self):
2644
 
        for f in WorkingTree.open_containing(u'.')[0].unknowns():
 
2811
    def run(self, directory=u'.'):
 
2812
        for f in WorkingTree.open_containing(directory)[0].unknowns():
2645
2813
            self.outf.write(osutils.quotefn(f) + '\n')
2646
2814
 
2647
2815
 
2674
2842
    Patterns prefixed with '!!' act as regular ignore patterns, but have
2675
2843
    precedence over the '!' exception patterns.
2676
2844
 
2677
 
    Note: ignore patterns containing shell wildcards must be quoted from
2678
 
    the shell on Unix.
 
2845
    :Notes: 
 
2846
        
 
2847
    * Ignore patterns containing shell wildcards must be quoted from
 
2848
      the shell on Unix.
 
2849
 
 
2850
    * Ignore patterns starting with "#" act as comments in the ignore file.
 
2851
      To ignore patterns that begin with that character, use the "RE:" prefix.
2679
2852
 
2680
2853
    :Examples:
2681
2854
        Ignore the top level Makefile::
2690
2863
 
2691
2864
            bzr ignore "!special.class"
2692
2865
 
 
2866
        Ignore files whose name begins with the "#" character::
 
2867
 
 
2868
            bzr ignore "RE:^#"
 
2869
 
2693
2870
        Ignore .o files under the lib directory::
2694
2871
 
2695
2872
            bzr ignore "lib/**/*.o"
2703
2880
            bzr ignore "RE:(?!debian/).*"
2704
2881
        
2705
2882
        Ignore everything except the "local" toplevel directory,
2706
 
        but always ignore "*~" autosave files, even under local/::
 
2883
        but always ignore autosave files ending in ~, even under local/::
2707
2884
        
2708
2885
            bzr ignore "*"
2709
2886
            bzr ignore "!./local"
2712
2889
 
2713
2890
    _see_also = ['status', 'ignored', 'patterns']
2714
2891
    takes_args = ['name_pattern*']
2715
 
    takes_options = [
 
2892
    takes_options = ['directory',
2716
2893
        Option('default-rules',
2717
2894
               help='Display the default ignore rules that bzr uses.')
2718
2895
        ]
2719
2896
 
2720
 
    def run(self, name_pattern_list=None, default_rules=None):
 
2897
    def run(self, name_pattern_list=None, default_rules=None,
 
2898
            directory=u'.'):
2721
2899
        from bzrlib import ignores
2722
2900
        if default_rules is not None:
2723
2901
            # dump the default rules and exit
2729
2907
                "NAME_PATTERN or --default-rules.")
2730
2908
        name_pattern_list = [globbing.normalize_pattern(p)
2731
2909
                             for p in name_pattern_list]
 
2910
        bad_patterns = ''
 
2911
        for p in name_pattern_list:
 
2912
            if not globbing.Globster.is_pattern_valid(p):
 
2913
                bad_patterns += ('\n  %s' % p)
 
2914
        if bad_patterns:
 
2915
            msg = ('Invalid ignore pattern(s) found. %s' % bad_patterns)
 
2916
            ui.ui_factory.show_error(msg)
 
2917
            raise errors.InvalidPattern('')
2732
2918
        for name_pattern in name_pattern_list:
2733
2919
            if (name_pattern[0] == '/' or
2734
2920
                (len(name_pattern) > 1 and name_pattern[1] == ':')):
2735
2921
                raise errors.BzrCommandError(
2736
2922
                    "NAME_PATTERN should not be an absolute path")
2737
 
        tree, relpath = WorkingTree.open_containing(u'.')
 
2923
        tree, relpath = WorkingTree.open_containing(directory)
2738
2924
        ignores.tree_ignores_add_patterns(tree, name_pattern_list)
2739
2925
        ignored = globbing.Globster(name_pattern_list)
2740
2926
        matches = []
2741
 
        tree.lock_read()
 
2927
        self.add_cleanup(tree.lock_read().unlock)
2742
2928
        for entry in tree.list_files():
2743
2929
            id = entry[3]
2744
2930
            if id is not None:
2745
2931
                filename = entry[0]
2746
2932
                if ignored.match(filename):
2747
2933
                    matches.append(filename)
2748
 
        tree.unlock()
2749
2934
        if len(matches) > 0:
2750
2935
            self.outf.write("Warning: the following files are version controlled and"
2751
2936
                  " match your ignore pattern:\n%s"
2766
2951
 
2767
2952
    encoding_type = 'replace'
2768
2953
    _see_also = ['ignore', 'ls']
 
2954
    takes_options = ['directory']
2769
2955
 
2770
2956
    @display_command
2771
 
    def run(self):
2772
 
        tree = WorkingTree.open_containing(u'.')[0]
2773
 
        tree.lock_read()
2774
 
        self.add_cleanup(tree.unlock)
 
2957
    def run(self, directory=u'.'):
 
2958
        tree = WorkingTree.open_containing(directory)[0]
 
2959
        self.add_cleanup(tree.lock_read().unlock)
2775
2960
        for path, file_class, kind, file_id, entry in tree.list_files():
2776
2961
            if file_class != 'I':
2777
2962
                continue
2788
2973
    """
2789
2974
    hidden = True
2790
2975
    takes_args = ['revno']
 
2976
    takes_options = ['directory']
2791
2977
 
2792
2978
    @display_command
2793
 
    def run(self, revno):
 
2979
    def run(self, revno, directory=u'.'):
2794
2980
        try:
2795
2981
            revno = int(revno)
2796
2982
        except ValueError:
2797
2983
            raise errors.BzrCommandError("not a valid revision-number: %r"
2798
2984
                                         % revno)
2799
 
        revid = WorkingTree.open_containing(u'.')[0].branch.get_rev_id(revno)
 
2985
        revid = WorkingTree.open_containing(directory)[0].branch.get_rev_id(revno)
2800
2986
        self.outf.write("%s\n" % revid)
2801
2987
 
2802
2988
 
2828
3014
         zip                          .zip
2829
3015
      =================       =========================
2830
3016
    """
 
3017
    encoding = 'exact'
2831
3018
    takes_args = ['dest', 'branch_or_subdir?']
2832
 
    takes_options = [
 
3019
    takes_options = ['directory',
2833
3020
        Option('format',
2834
3021
               help="Type of file to export to.",
2835
3022
               type=unicode),
2844
3031
                    'revision in which it was changed.'),
2845
3032
        ]
2846
3033
    def run(self, dest, branch_or_subdir=None, revision=None, format=None,
2847
 
        root=None, filters=False, per_file_timestamps=False):
 
3034
        root=None, filters=False, per_file_timestamps=False, directory=u'.'):
2848
3035
        from bzrlib.export import export
2849
3036
 
2850
3037
        if branch_or_subdir is None:
2851
 
            tree = WorkingTree.open_containing(u'.')[0]
 
3038
            tree = WorkingTree.open_containing(directory)[0]
2852
3039
            b = tree.branch
2853
3040
            subdir = None
2854
3041
        else:
2873
3060
    """
2874
3061
 
2875
3062
    _see_also = ['ls']
2876
 
    takes_options = [
 
3063
    takes_options = ['directory',
2877
3064
        Option('name-from-revision', help='The path name in the old tree.'),
2878
3065
        Option('filters', help='Apply content filters to display the '
2879
3066
                'convenience form.'),
2884
3071
 
2885
3072
    @display_command
2886
3073
    def run(self, filename, revision=None, name_from_revision=False,
2887
 
            filters=False):
 
3074
            filters=False, directory=None):
2888
3075
        if revision is not None and len(revision) != 1:
2889
3076
            raise errors.BzrCommandError("bzr cat --revision takes exactly"
2890
3077
                                         " one revision specifier")
2891
3078
        tree, branch, relpath = \
2892
 
            bzrdir.BzrDir.open_containing_tree_or_branch(filename)
2893
 
        branch.lock_read()
2894
 
        self.add_cleanup(branch.unlock)
 
3079
            _open_directory_or_containing_tree_or_branch(filename, directory)
 
3080
        self.add_cleanup(branch.lock_read().unlock)
2895
3081
        return self._run(tree, branch, relpath, filename, revision,
2896
3082
                         name_from_revision, filters)
2897
3083
 
2900
3086
        if tree is None:
2901
3087
            tree = b.basis_tree()
2902
3088
        rev_tree = _get_one_revision_tree('cat', revision, branch=b)
2903
 
        rev_tree.lock_read()
2904
 
        self.add_cleanup(rev_tree.unlock)
 
3089
        self.add_cleanup(rev_tree.lock_read().unlock)
2905
3090
 
2906
3091
        old_file_id = rev_tree.path2id(relpath)
2907
3092
 
 
3093
        # TODO: Split out this code to something that generically finds the
 
3094
        # best id for a path across one or more trees; it's like
 
3095
        # find_ids_across_trees but restricted to find just one. -- mbp
 
3096
        # 20110705.
2908
3097
        if name_from_revision:
2909
3098
            # Try in revision if requested
2910
3099
            if old_file_id is None:
2912
3101
                    "%r is not present in revision %s" % (
2913
3102
                        filename, rev_tree.get_revision_id()))
2914
3103
            else:
2915
 
                content = rev_tree.get_file_text(old_file_id)
 
3104
                actual_file_id = old_file_id
2916
3105
        else:
2917
3106
            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
 
3107
            if cur_file_id is not None and rev_tree.has_id(cur_file_id):
 
3108
                actual_file_id = cur_file_id
 
3109
            elif old_file_id is not None:
 
3110
                actual_file_id = old_file_id
 
3111
            else:
2933
3112
                raise errors.BzrCommandError(
2934
3113
                    "%r is not present in revision %s" % (
2935
3114
                        filename, rev_tree.get_revision_id()))
2936
3115
        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)
 
3116
            from bzrlib.filter_tree import ContentFilterTree
 
3117
            filter_tree = ContentFilterTree(rev_tree,
 
3118
                rev_tree._content_filter_stack)
 
3119
            content = filter_tree.get_file_text(actual_file_id)
2947
3120
        else:
2948
 
            self.cleanup_now()
2949
 
            self.outf.write(content)
 
3121
            content = rev_tree.get_file_text(actual_file_id)
 
3122
        self.cleanup_now()
 
3123
        self.outf.write(content)
2950
3124
 
2951
3125
 
2952
3126
class cmd_local_time_offset(Command):
3013
3187
      to trigger updates to external systems like bug trackers. The --fixes
3014
3188
      option can be used to record the association between a revision and
3015
3189
      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
3190
    """
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
3191
 
3043
3192
    _see_also = ['add', 'bugs', 'hooks', 'uncommit']
3044
3193
    takes_args = ['selected*']
3076
3225
             Option('show-diff', short_name='p',
3077
3226
                    help='When no message is supplied, show the diff along'
3078
3227
                    ' with the status summary in the message editor.'),
 
3228
             Option('lossy', 
 
3229
                    help='When committing to a foreign version control '
 
3230
                    'system do not push data that can not be natively '
 
3231
                    'represented.'),
3079
3232
             ]
3080
3233
    aliases = ['ci', 'checkin']
3081
3234
 
3100
3253
 
3101
3254
    def run(self, message=None, file=None, verbose=False, selected_list=None,
3102
3255
            unchanged=False, strict=False, local=False, fixes=None,
3103
 
            author=None, show_diff=False, exclude=None, commit_time=None):
 
3256
            author=None, show_diff=False, exclude=None, commit_time=None,
 
3257
            lossy=False):
3104
3258
        from bzrlib.errors import (
3105
3259
            PointlessCommit,
3106
3260
            ConflictsInTree,
3109
3263
        from bzrlib.msgeditor import (
3110
3264
            edit_commit_message_encoded,
3111
3265
            generate_commit_message_template,
3112
 
            make_commit_message_template_encoded
 
3266
            make_commit_message_template_encoded,
 
3267
            set_commit_message,
3113
3268
        )
3114
3269
 
3115
3270
        commit_stamp = offset = None
3120
3275
                raise errors.BzrCommandError(
3121
3276
                    "Could not parse --commit-time: " + str(e))
3122
3277
 
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
3278
        properties = {}
3130
3279
 
3131
 
        tree, selected_list = tree_files(selected_list)
 
3280
        tree, selected_list = WorkingTree.open_containing_paths(selected_list)
3132
3281
        if selected_list == ['']:
3133
3282
            # workaround - commit of root of tree should be exactly the same
3134
3283
            # as just default commit in that tree, and succeed even though
3169
3318
        def get_message(commit_obj):
3170
3319
            """Callback to get commit message"""
3171
3320
            if file:
3172
 
                my_message = codecs.open(
3173
 
                    file, 'rt', osutils.get_user_encoding()).read()
 
3321
                f = open(file)
 
3322
                try:
 
3323
                    my_message = f.read().decode(osutils.get_user_encoding())
 
3324
                finally:
 
3325
                    f.close()
3174
3326
            elif message is not None:
3175
3327
                my_message = message
3176
3328
            else:
3184
3336
                # make_commit_message_template_encoded returns user encoding.
3185
3337
                # We probably want to be using edit_commit_message instead to
3186
3338
                # avoid this.
3187
 
                start_message = generate_commit_message_template(commit_obj)
3188
 
                my_message = edit_commit_message_encoded(text,
3189
 
                    start_message=start_message)
 
3339
                my_message = set_commit_message(commit_obj)
 
3340
                if my_message is None:
 
3341
                    start_message = generate_commit_message_template(commit_obj)
 
3342
                    my_message = edit_commit_message_encoded(text,
 
3343
                        start_message=start_message)
3190
3344
                if my_message is None:
3191
3345
                    raise errors.BzrCommandError("please specify a commit"
3192
3346
                        " message with either --message or --file")
3193
 
            if my_message == "":
3194
 
                raise errors.BzrCommandError("empty commit message specified")
 
3347
                if my_message == "":
 
3348
                    raise errors.BzrCommandError("Empty commit message specified."
 
3349
                            " Please specify a commit message with either"
 
3350
                            " --message or --file or leave a blank message"
 
3351
                            " with --message \"\".")
3195
3352
            return my_message
3196
3353
 
3197
3354
        # The API permits a commit with a filter of [] to mean 'select nothing'
3205
3362
                        reporter=None, verbose=verbose, revprops=properties,
3206
3363
                        authors=author, timestamp=commit_stamp,
3207
3364
                        timezone=offset,
3208
 
                        exclude=safe_relpath_files(tree, exclude))
 
3365
                        exclude=tree.safe_relpath_files(exclude),
 
3366
                        lossy=lossy)
3209
3367
        except PointlessCommit:
3210
3368
            raise errors.BzrCommandError("No changes to commit."
3211
 
                              " Use --unchanged to commit anyhow.")
 
3369
                " Please 'bzr add' the files you want to commit, or use"
 
3370
                " --unchanged to force an empty commit.")
3212
3371
        except ConflictsInTree:
3213
3372
            raise errors.BzrCommandError('Conflicts detected in working '
3214
3373
                'tree.  Use "bzr conflicts" to list, "bzr resolve FILE" to'
3295
3454
 
3296
3455
 
3297
3456
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.
 
3457
    __doc__ = """Upgrade a repository, branch or working tree to a newer format.
 
3458
 
 
3459
    When the default format has changed after a major new release of
 
3460
    Bazaar, you may be informed during certain operations that you
 
3461
    should upgrade. Upgrading to a newer format may improve performance
 
3462
    or make new features available. It may however limit interoperability
 
3463
    with older repositories or with older versions of Bazaar.
 
3464
 
 
3465
    If you wish to upgrade to a particular format rather than the
 
3466
    current default, that can be specified using the --format option.
 
3467
    As a consequence, you can use the upgrade command this way to
 
3468
    "downgrade" to an earlier format, though some conversions are
 
3469
    a one way process (e.g. changing from the 1.x default to the
 
3470
    2.x default) so downgrading is not always possible.
 
3471
 
 
3472
    A backup.bzr.~#~ directory is created at the start of the conversion
 
3473
    process (where # is a number). By default, this is left there on
 
3474
    completion. If the conversion fails, delete the new .bzr directory
 
3475
    and rename this one back in its place. Use the --clean option to ask
 
3476
    for the backup.bzr directory to be removed on successful conversion.
 
3477
    Alternatively, you can delete it by hand if everything looks good
 
3478
    afterwards.
 
3479
 
 
3480
    If the location given is a shared repository, dependent branches
 
3481
    are also converted provided the repository converts successfully.
 
3482
    If the conversion of a branch fails, remaining branches are still
 
3483
    tried.
 
3484
 
 
3485
    For more information on upgrades, see the Bazaar Upgrade Guide,
 
3486
    http://doc.bazaar.canonical.com/latest/en/upgrade-guide/.
3303
3487
    """
3304
3488
 
3305
 
    _see_also = ['check']
 
3489
    _see_also = ['check', 'reconcile', 'formats']
3306
3490
    takes_args = ['url?']
3307
3491
    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
 
                    ]
 
3492
        RegistryOption('format',
 
3493
            help='Upgrade to a specific format.  See "bzr help'
 
3494
                 ' formats" for details.',
 
3495
            lazy_registry=('bzrlib.bzrdir', 'format_registry'),
 
3496
            converter=lambda name: bzrdir.format_registry.make_bzrdir(name),
 
3497
            value_switches=True, title='Branch format'),
 
3498
        Option('clean',
 
3499
            help='Remove the backup.bzr directory if successful.'),
 
3500
        Option('dry-run',
 
3501
            help="Show what would be done, but don't actually do anything."),
 
3502
    ]
3315
3503
 
3316
 
    def run(self, url='.', format=None):
 
3504
    def run(self, url='.', format=None, clean=False, dry_run=False):
3317
3505
        from bzrlib.upgrade import upgrade
3318
 
        upgrade(url, format)
 
3506
        exceptions = upgrade(url, format, clean_up=clean, dry_run=dry_run)
 
3507
        if exceptions:
 
3508
            if len(exceptions) == 1:
 
3509
                # Compatibility with historical behavior
 
3510
                raise exceptions[0]
 
3511
            else:
 
3512
                return 3
3319
3513
 
3320
3514
 
3321
3515
class cmd_whoami(Command):
3330
3524
 
3331
3525
            bzr whoami "Frank Chu <fchu@example.com>"
3332
3526
    """
3333
 
    takes_options = [ Option('email',
 
3527
    takes_options = [ 'directory',
 
3528
                      Option('email',
3334
3529
                             help='Display email address only.'),
3335
3530
                      Option('branch',
3336
3531
                             help='Set identity for the current branch instead of '
3340
3535
    encoding_type = 'replace'
3341
3536
 
3342
3537
    @display_command
3343
 
    def run(self, email=False, branch=False, name=None):
 
3538
    def run(self, email=False, branch=False, name=None, directory=None):
3344
3539
        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()
 
3540
            if directory is None:
 
3541
                # use branch if we're inside one; otherwise global config
 
3542
                try:
 
3543
                    c = Branch.open_containing(u'.')[0].get_config()
 
3544
                except errors.NotBranchError:
 
3545
                    c = _mod_config.GlobalConfig()
 
3546
            else:
 
3547
                c = Branch.open(directory).get_config()
3350
3548
            if email:
3351
3549
                self.outf.write(c.user_email() + '\n')
3352
3550
            else:
3353
3551
                self.outf.write(c.username() + '\n')
3354
3552
            return
3355
3553
 
 
3554
        if email:
 
3555
            raise errors.BzrCommandError("--email can only be used to display existing "
 
3556
                                         "identity")
 
3557
 
3356
3558
        # display a warning if an email address isn't included in the given name.
3357
3559
        try:
3358
 
            config.extract_email_address(name)
 
3560
            _mod_config.extract_email_address(name)
3359
3561
        except errors.NoEmailInUsername, e:
3360
3562
            warning('"%s" does not seem to contain an email address.  '
3361
3563
                    'This is allowed, but not recommended.', name)
3362
3564
 
3363
3565
        # use global config unless --branch given
3364
3566
        if branch:
3365
 
            c = Branch.open_containing('.')[0].get_config()
 
3567
            if directory is None:
 
3568
                c = Branch.open_containing(u'.')[0].get_config()
 
3569
            else:
 
3570
                c = Branch.open(directory).get_config()
3366
3571
        else:
3367
 
            c = config.GlobalConfig()
 
3572
            c = _mod_config.GlobalConfig()
3368
3573
        c.set_user_option('email', name)
3369
3574
 
3370
3575
 
3380
3585
 
3381
3586
    _see_also = ['info']
3382
3587
    takes_args = ['nickname?']
3383
 
    def run(self, nickname=None):
3384
 
        branch = Branch.open_containing(u'.')[0]
 
3588
    takes_options = ['directory']
 
3589
    def run(self, nickname=None, directory=u'.'):
 
3590
        branch = Branch.open_containing(directory)[0]
3385
3591
        if nickname is None:
3386
3592
            self.printme(branch)
3387
3593
        else:
3436
3642
                'bzr alias --remove expects an alias to remove.')
3437
3643
        # If alias is not found, print something like:
3438
3644
        # unalias: foo: not found
3439
 
        c = config.GlobalConfig()
 
3645
        c = _mod_config.GlobalConfig()
3440
3646
        c.unset_alias(alias_name)
3441
3647
 
3442
3648
    @display_command
3443
3649
    def print_aliases(self):
3444
3650
        """Print out the defined aliases in a similar format to bash."""
3445
 
        aliases = config.GlobalConfig().get_aliases()
 
3651
        aliases = _mod_config.GlobalConfig().get_aliases()
3446
3652
        for key, value in sorted(aliases.iteritems()):
3447
3653
            self.outf.write('bzr alias %s="%s"\n' % (key, value))
3448
3654
 
3458
3664
 
3459
3665
    def set_alias(self, alias_name, alias_command):
3460
3666
        """Save the alias in the global config."""
3461
 
        c = config.GlobalConfig()
 
3667
        c = _mod_config.GlobalConfig()
3462
3668
        c.set_alias(alias_name, alias_command)
3463
3669
 
3464
3670
 
3499
3705
    If you set BZR_TEST_PDB=1 when running selftest, failing tests will drop
3500
3706
    into a pdb postmortem session.
3501
3707
 
 
3708
    The --coverage=DIRNAME global option produces a report with covered code
 
3709
    indicated.
 
3710
 
3502
3711
    :Examples:
3503
3712
        Run only tests relating to 'ignore'::
3504
3713
 
3515
3724
        if typestring == "sftp":
3516
3725
            from bzrlib.tests import stub_sftp
3517
3726
            return stub_sftp.SFTPAbsoluteServer
3518
 
        if typestring == "memory":
 
3727
        elif typestring == "memory":
3519
3728
            from bzrlib.tests import test_server
3520
3729
            return memory.MemoryServer
3521
 
        if typestring == "fakenfs":
 
3730
        elif typestring == "fakenfs":
3522
3731
            from bzrlib.tests import test_server
3523
3732
            return test_server.FakeNFSServer
3524
3733
        msg = "No known transport type %s. Supported types are: sftp\n" %\
3537
3746
                                 'throughout the test suite.',
3538
3747
                            type=get_transport_type),
3539
3748
                     Option('benchmark',
3540
 
                            help='Run the benchmarks rather than selftests.'),
 
3749
                            help='Run the benchmarks rather than selftests.',
 
3750
                            hidden=True),
3541
3751
                     Option('lsprof-timed',
3542
3752
                            help='Generate lsprof output for benchmarked'
3543
3753
                                 ' sections of code.'),
3544
3754
                     Option('lsprof-tests',
3545
3755
                            help='Generate lsprof output for each test.'),
3546
 
                     Option('cache-dir', type=str,
3547
 
                            help='Cache intermediate benchmark output in this '
3548
 
                                 'directory.'),
3549
3756
                     Option('first',
3550
3757
                            help='Run all tests, but run specified tests first.',
3551
3758
                            short_name='f',
3560
3767
                     Option('randomize', type=str, argname="SEED",
3561
3768
                            help='Randomize the order of tests using the given'
3562
3769
                                 ' 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.'),
 
3770
                     ListOption('exclude', type=str, argname="PATTERN",
 
3771
                                short_name='x',
 
3772
                                help='Exclude tests that match this regular'
 
3773
                                ' expression.'),
3567
3774
                     Option('subunit',
3568
3775
                        help='Output test progress via subunit.'),
3569
3776
                     Option('strict', help='Fail on missing dependencies or '
3585
3792
 
3586
3793
    def run(self, testspecs_list=None, verbose=False, one=False,
3587
3794
            transport=None, benchmark=None,
3588
 
            lsprof_timed=None, cache_dir=None,
 
3795
            lsprof_timed=None,
3589
3796
            first=False, list_only=False,
3590
3797
            randomize=None, exclude=None, strict=False,
3591
3798
            load_list=None, debugflag=None, starting_with=None, subunit=False,
3592
3799
            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)
 
3800
        from bzrlib import tests
 
3801
 
3602
3802
        if testspecs_list is not None:
3603
3803
            pattern = '|'.join(testspecs_list)
3604
3804
        else:
3612
3812
            self.additional_selftest_args['runner_class'] = SubUnitBzrRunner
3613
3813
            # On Windows, disable automatic conversion of '\n' to '\r\n' in
3614
3814
            # stdout, which would corrupt the subunit stream. 
3615
 
            if sys.platform == "win32" and sys.stdout.fileno() >= 0:
 
3815
            # FIXME: This has been fixed in subunit trunk (>0.0.5) so the
 
3816
            # following code can be deleted when it's sufficiently deployed
 
3817
            # -- vila/mgz 20100514
 
3818
            if (sys.platform == "win32"
 
3819
                and getattr(sys.stdout, 'fileno', None) is not None):
3616
3820
                import msvcrt
3617
3821
                msvcrt.setmode(sys.stdout.fileno(), os.O_BINARY)
3618
3822
        if parallel:
3619
3823
            self.additional_selftest_args.setdefault(
3620
3824
                'suite_decorators', []).append(parallel)
3621
3825
        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)
 
3826
            raise errors.BzrCommandError(
 
3827
                "--benchmark is no longer supported from bzr 2.2; "
 
3828
                "use bzr-usertest instead")
 
3829
        test_suite_factory = None
 
3830
        if not exclude:
 
3831
            exclude_pattern = None
3628
3832
        else:
3629
 
            test_suite_factory = None
3630
 
            benchfile = None
 
3833
            exclude_pattern = '(' + '|'.join(exclude) + ')'
3631
3834
        selftest_kwargs = {"verbose": verbose,
3632
3835
                          "pattern": pattern,
3633
3836
                          "stop_on_failure": one,
3635
3838
                          "test_suite_factory": test_suite_factory,
3636
3839
                          "lsprof_timed": lsprof_timed,
3637
3840
                          "lsprof_tests": lsprof_tests,
3638
 
                          "bench_history": benchfile,
3639
3841
                          "matching_tests_first": first,
3640
3842
                          "list_only": list_only,
3641
3843
                          "random_seed": randomize,
3642
 
                          "exclude_pattern": exclude,
 
3844
                          "exclude_pattern": exclude_pattern,
3643
3845
                          "strict": strict,
3644
3846
                          "load_list": load_list,
3645
3847
                          "debug_flags": debugflag,
3646
3848
                          "starting_with": starting_with
3647
3849
                          }
3648
3850
        selftest_kwargs.update(self.additional_selftest_args)
3649
 
        result = selftest(**selftest_kwargs)
 
3851
 
 
3852
        # Make deprecation warnings visible, unless -Werror is set
 
3853
        cleanup = symbol_versioning.activate_deprecation_warnings(
 
3854
            override=False)
 
3855
        try:
 
3856
            result = tests.selftest(**selftest_kwargs)
 
3857
        finally:
 
3858
            cleanup()
3650
3859
        return int(not result)
3651
3860
 
3652
3861
 
3690
3899
 
3691
3900
        branch1 = Branch.open_containing(branch)[0]
3692
3901
        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)
 
3902
        self.add_cleanup(branch1.lock_read().unlock)
 
3903
        self.add_cleanup(branch2.lock_read().unlock)
3697
3904
        last1 = ensure_null(branch1.last_revision())
3698
3905
        last2 = ensure_null(branch2.last_revision())
3699
3906
 
3709
3916
    The source of the merge can be specified either in the form of a branch,
3710
3917
    or in the form of a path to a file containing a merge directive generated
3711
3918
    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.
 
3919
    or the branch most recently merged using --remember.  The source of the
 
3920
    merge may also be specified in the form of a path to a file in another
 
3921
    branch:  in this case, only the modifications to that file are merged into
 
3922
    the current working tree.
 
3923
 
 
3924
    When merging from a branch, by default bzr will try to merge in all new
 
3925
    work from the other branch, automatically determining an appropriate base
 
3926
    revision.  If this fails, you may need to give an explicit base.
 
3927
 
 
3928
    To pick a different ending revision, pass "--revision OTHER".  bzr will
 
3929
    try to merge in all new work up to and including revision OTHER.
 
3930
 
 
3931
    If you specify two values, "--revision BASE..OTHER", only revisions BASE
 
3932
    through OTHER, excluding BASE but including OTHER, will be merged.  If this
 
3933
    causes some revisions to be skipped, i.e. if the destination branch does
 
3934
    not already contain revision BASE, such a merge is commonly referred to as
 
3935
    a "cherrypick". Unlike a normal merge, Bazaar does not currently track
 
3936
    cherrypicks. The changes look like a normal commit, and the history of the
 
3937
    changes from the other branch is not stored in the commit.
 
3938
 
 
3939
    Revision numbers are always relative to the source branch.
3724
3940
 
3725
3941
    Merge will do its best to combine the changes in two branches, but there
3726
3942
    are some kinds of problems only a human can fix.  When it encounters those,
3729
3945
 
3730
3946
    Use bzr resolve when you have fixed a problem.  See also bzr conflicts.
3731
3947
 
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.
 
3948
    If there is no default branch set, the first merge will set it (use
 
3949
    --no-remember to avoid settting it). After that, you can omit the branch
 
3950
    to use the default.  To change the default, use --remember. The value will
 
3951
    only be saved if the remote location can be accessed.
3736
3952
 
3737
3953
    The results of the merge are placed into the destination working
3738
3954
    directory, where they can be reviewed (with bzr diff), tested, and then
3739
3955
    committed to record the result of the merge.
3740
3956
 
3741
3957
    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
 
3958
    --force is given.  If --force is given, then the changes from the source 
 
3959
    will be merged with the current working tree, including any uncommitted
 
3960
    changes in the tree.  The --force option can also be used to create a
3743
3961
    merge revision which has more than two parents.
3744
3962
 
3745
3963
    If one would like to merge changes from the working tree of the other
3750
3968
    you to apply each diff hunk and file change, similar to "shelve".
3751
3969
 
3752
3970
    :Examples:
3753
 
        To merge the latest revision from bzr.dev::
 
3971
        To merge all new revisions from bzr.dev::
3754
3972
 
3755
3973
            bzr merge ../bzr.dev
3756
3974
 
3793
4011
                ' completely merged into the source, pull from the'
3794
4012
                ' source rather than merging.  When this happens,'
3795
4013
                ' you do not need to commit the result.'),
3796
 
        Option('directory',
 
4014
        custom_help('directory',
3797
4015
               help='Branch to merge into, '
3798
 
                    'rather than the one containing the working directory.',
3799
 
               short_name='d',
3800
 
               type=unicode,
3801
 
               ),
 
4016
                    'rather than the one containing the working directory.'),
3802
4017
        Option('preview', help='Instead of merging, show a diff of the'
3803
4018
               ' merge.'),
3804
4019
        Option('interactive', help='Select changes interactively.',
3806
4021
    ]
3807
4022
 
3808
4023
    def run(self, location=None, revision=None, force=False,
3809
 
            merge_type=None, show_base=False, reprocess=None, remember=False,
 
4024
            merge_type=None, show_base=False, reprocess=None, remember=None,
3810
4025
            uncommitted=False, pull=False,
3811
4026
            directory=None,
3812
4027
            preview=False,
3820
4035
        merger = None
3821
4036
        allow_pending = True
3822
4037
        verified = 'inapplicable'
 
4038
 
3823
4039
        tree = WorkingTree.open_containing(directory)[0]
 
4040
        if tree.branch.revno() == 0:
 
4041
            raise errors.BzrCommandError('Merging into empty branches not currently supported, '
 
4042
                                         'https://bugs.launchpad.net/bzr/+bug/308562')
3824
4043
 
3825
4044
        try:
3826
4045
            basis_tree = tree.revision_tree(tree.last_revision())
3837
4056
            unversioned_filter=tree.is_ignored, view_info=view_info)
3838
4057
        pb = ui.ui_factory.nested_progress_bar()
3839
4058
        self.add_cleanup(pb.finished)
3840
 
        tree.lock_write()
3841
 
        self.add_cleanup(tree.unlock)
 
4059
        self.add_cleanup(tree.lock_write().unlock)
3842
4060
        if location is not None:
3843
4061
            try:
3844
4062
                mergeable = bundle.read_mergeable_from_url(location,
3873
4091
        self.sanity_check_merger(merger)
3874
4092
        if (merger.base_rev_id == merger.other_rev_id and
3875
4093
            merger.other_rev_id is not None):
 
4094
            # check if location is a nonexistent file (and not a branch) to
 
4095
            # disambiguate the 'Nothing to do'
 
4096
            if merger.interesting_files:
 
4097
                if not merger.other_tree.has_filename(
 
4098
                    merger.interesting_files[0]):
 
4099
                    note("merger: " + str(merger))
 
4100
                    raise errors.PathsDoNotExist([location])
3876
4101
            note('Nothing to do.')
3877
4102
            return 0
3878
 
        if pull:
 
4103
        if pull and not preview:
3879
4104
            if merger.interesting_files is not None:
3880
4105
                raise errors.BzrCommandError('Cannot pull individual files')
3881
4106
            if (merger.base_rev_id == tree.last_revision()):
3905
4130
    def _do_preview(self, merger):
3906
4131
        from bzrlib.diff import show_diff_trees
3907
4132
        result_tree = self._get_preview(merger)
 
4133
        path_encoding = osutils.get_diff_header_encoding()
3908
4134
        show_diff_trees(merger.this_tree, result_tree, self.outf,
3909
 
                        old_label='', new_label='')
 
4135
                        old_label='', new_label='',
 
4136
                        path_encoding=path_encoding)
3910
4137
 
3911
4138
    def _do_merge(self, merger, change_reporter, allow_pending, verified):
3912
4139
        merger.change_reporter = change_reporter
3988
4215
        if other_revision_id is None:
3989
4216
            other_revision_id = _mod_revision.ensure_null(
3990
4217
                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):
 
4218
        # Remember where we merge from. We need to remember if:
 
4219
        # - user specify a location (and we don't merge from the parent
 
4220
        #   branch)
 
4221
        # - user ask to remember or there is no previous location set to merge
 
4222
        #   from and user didn't ask to *not* remember
 
4223
        if (user_location is not None
 
4224
            and ((remember
 
4225
                  or (remember is None
 
4226
                      and tree.branch.get_submit_branch() is None)))):
3994
4227
            tree.branch.set_submit_branch(other_branch.base)
3995
 
        _merge_tags_if_possible(other_branch, tree.branch)
 
4228
        # Merge tags (but don't set them in the master branch yet, the user
 
4229
        # might revert this merge).  Commit will propagate them.
 
4230
        _merge_tags_if_possible(other_branch, tree.branch, ignore_master=True)
3996
4231
        merger = _mod_merge.Merger.from_revision_ids(pb, tree,
3997
4232
            other_revision_id, base_revision_id, other_branch, base_branch)
3998
4233
        if other_path != '':
4099
4334
        from bzrlib.conflicts import restore
4100
4335
        if merge_type is None:
4101
4336
            merge_type = _mod_merge.Merge3Merger
4102
 
        tree, file_list = tree_files(file_list)
4103
 
        tree.lock_write()
4104
 
        self.add_cleanup(tree.unlock)
 
4337
        tree, file_list = WorkingTree.open_containing_paths(file_list)
 
4338
        self.add_cleanup(tree.lock_write().unlock)
4105
4339
        parents = tree.get_parent_ids()
4106
4340
        if len(parents) != 2:
4107
4341
            raise errors.BzrCommandError("Sorry, remerge only works after normal"
4167
4401
    last committed revision is used.
4168
4402
 
4169
4403
    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.
 
4404
    merge instead.  For example, "merge . -r -2..-3" (don't forget the ".")
 
4405
    will remove the changes introduced by the second last commit (-2), without
 
4406
    affecting the changes introduced by the last commit (-1).  To remove
 
4407
    certain changes on a hunk-by-hunk basis, see the shelve command.
4173
4408
 
4174
4409
    By default, any files that have been manually changed will be backed up
4175
4410
    first.  (Files changed only by merge are not backed up.)  Backup files have
4205
4440
    target branches.
4206
4441
    """
4207
4442
 
4208
 
    _see_also = ['cat', 'export']
 
4443
    _see_also = ['cat', 'export', 'merge', 'shelve']
4209
4444
    takes_options = [
4210
4445
        'revision',
4211
4446
        Option('no-backup', "Do not save backups of reverted files."),
4216
4451
 
4217
4452
    def run(self, revision=None, no_backup=False, file_list=None,
4218
4453
            forget_merges=None):
4219
 
        tree, file_list = tree_files(file_list)
4220
 
        tree.lock_tree_write()
4221
 
        self.add_cleanup(tree.unlock)
 
4454
        tree, file_list = WorkingTree.open_containing_paths(file_list)
 
4455
        self.add_cleanup(tree.lock_tree_write().unlock)
4222
4456
        if forget_merges:
4223
4457
            tree.set_parent_ids(tree.get_parent_ids()[:1])
4224
4458
        else:
4313
4547
    _see_also = ['merge', 'pull']
4314
4548
    takes_args = ['other_branch?']
4315
4549
    takes_options = [
 
4550
        'directory',
4316
4551
        Option('reverse', 'Reverse the order of revisions.'),
4317
4552
        Option('mine-only',
4318
4553
               'Display changes in the local branch only.'),
4340
4575
            theirs_only=False,
4341
4576
            log_format=None, long=False, short=False, line=False,
4342
4577
            show_ids=False, verbose=False, this=False, other=False,
4343
 
            include_merges=False, revision=None, my_revision=None):
 
4578
            include_merges=False, revision=None, my_revision=None,
 
4579
            directory=u'.'):
4344
4580
        from bzrlib.missing import find_unmerged, iter_log_revisions
4345
4581
        def message(s):
4346
4582
            if not is_quiet():
4359
4595
        elif theirs_only:
4360
4596
            restrict = 'remote'
4361
4597
 
4362
 
        local_branch = Branch.open_containing(u".")[0]
4363
 
        local_branch.lock_read()
4364
 
        self.add_cleanup(local_branch.unlock)
 
4598
        local_branch = Branch.open_containing(directory)[0]
 
4599
        self.add_cleanup(local_branch.lock_read().unlock)
4365
4600
 
4366
4601
        parent = local_branch.get_parent()
4367
4602
        if other_branch is None:
4378
4613
        if remote_branch.base == local_branch.base:
4379
4614
            remote_branch = local_branch
4380
4615
        else:
4381
 
            remote_branch.lock_read()
4382
 
            self.add_cleanup(remote_branch.unlock)
 
4616
            self.add_cleanup(remote_branch.lock_read().unlock)
4383
4617
 
4384
4618
        local_revid_range = _revision_range_to_revid_range(
4385
4619
            _get_revision_range(my_revision, local_branch,
4440
4674
            message("Branches are up to date.\n")
4441
4675
        self.cleanup_now()
4442
4676
        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)
 
4677
            self.add_cleanup(local_branch.lock_write().unlock)
4445
4678
            # handle race conditions - a parent might be set while we run.
4446
4679
            if local_branch.get_parent() is None:
4447
4680
                local_branch.set_parent(remote_branch.base)
4506
4739
 
4507
4740
    @display_command
4508
4741
    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")
 
4742
        from bzrlib import plugin
 
4743
        # Don't give writelines a generator as some codecs don't like that
 
4744
        self.outf.writelines(
 
4745
            list(plugin.describe_plugins(show_paths=verbose)))
4529
4746
 
4530
4747
 
4531
4748
class cmd_testament(Command):
4547
4764
            b = Branch.open_containing(branch)[0]
4548
4765
        else:
4549
4766
            b = Branch.open(branch)
4550
 
        b.lock_read()
4551
 
        self.add_cleanup(b.unlock)
 
4767
        self.add_cleanup(b.lock_read().unlock)
4552
4768
        if revision is None:
4553
4769
            rev_id = b.last_revision()
4554
4770
        else:
4578
4794
                     Option('long', help='Show commit date in annotations.'),
4579
4795
                     'revision',
4580
4796
                     'show-ids',
 
4797
                     'directory',
4581
4798
                     ]
4582
4799
    encoding_type = 'exact'
4583
4800
 
4584
4801
    @display_command
4585
4802
    def run(self, filename, all=False, long=False, revision=None,
4586
 
            show_ids=False):
4587
 
        from bzrlib.annotate import annotate_file, annotate_file_tree
 
4803
            show_ids=False, directory=None):
 
4804
        from bzrlib.annotate import (
 
4805
            annotate_file_tree,
 
4806
            )
4588
4807
        wt, branch, relpath = \
4589
 
            bzrdir.BzrDir.open_containing_tree_or_branch(filename)
 
4808
            _open_directory_or_containing_tree_or_branch(filename, directory)
4590
4809
        if wt is not None:
4591
 
            wt.lock_read()
4592
 
            self.add_cleanup(wt.unlock)
 
4810
            self.add_cleanup(wt.lock_read().unlock)
4593
4811
        else:
4594
 
            branch.lock_read()
4595
 
            self.add_cleanup(branch.unlock)
 
4812
            self.add_cleanup(branch.lock_read().unlock)
4596
4813
        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:
 
4814
        self.add_cleanup(tree.lock_read().unlock)
 
4815
        if wt is not None and revision is None:
4600
4816
            file_id = wt.path2id(relpath)
4601
4817
        else:
4602
4818
            file_id = tree.path2id(relpath)
4603
4819
        if file_id is None:
4604
4820
            raise errors.NotVersionedError(filename)
4605
 
        file_version = tree.inventory[file_id].revision
4606
4821
        if wt is not None and revision is None:
4607
4822
            # If there is a tree and we're not annotating historical
4608
4823
            # versions, annotate the working tree's content.
4609
4824
            annotate_file_tree(wt, file_id, self.outf, long, all,
4610
4825
                show_ids=show_ids)
4611
4826
        else:
4612
 
            annotate_file(branch, file_version, file_id, long, all, self.outf,
4613
 
                          show_ids=show_ids)
 
4827
            annotate_file_tree(tree, file_id, self.outf, long, all,
 
4828
                show_ids=show_ids, branch=branch)
4614
4829
 
4615
4830
 
4616
4831
class cmd_re_sign(Command):
4619
4834
 
4620
4835
    hidden = True # is this right ?
4621
4836
    takes_args = ['revision_id*']
4622
 
    takes_options = ['revision']
 
4837
    takes_options = ['directory', 'revision']
4623
4838
 
4624
 
    def run(self, revision_id_list=None, revision=None):
 
4839
    def run(self, revision_id_list=None, revision=None, directory=u'.'):
4625
4840
        if revision_id_list is not None and revision is not None:
4626
4841
            raise errors.BzrCommandError('You can only supply one of revision_id or --revision')
4627
4842
        if revision_id_list is None and revision is None:
4628
4843
            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)
 
4844
        b = WorkingTree.open_containing(directory)[0].branch
 
4845
        self.add_cleanup(b.lock_write().unlock)
4632
4846
        return self._run(b, revision_id_list, revision)
4633
4847
 
4634
4848
    def _run(self, b, revision_id_list, revision):
4693
4907
 
4694
4908
    _see_also = ['checkouts', 'unbind']
4695
4909
    takes_args = ['location?']
4696
 
    takes_options = []
 
4910
    takes_options = ['directory']
4697
4911
 
4698
 
    def run(self, location=None):
4699
 
        b, relpath = Branch.open_containing(u'.')
 
4912
    def run(self, location=None, directory=u'.'):
 
4913
        b, relpath = Branch.open_containing(directory)
4700
4914
        if location is None:
4701
4915
            try:
4702
4916
                location = b.get_old_bound_location()
4729
4943
 
4730
4944
    _see_also = ['checkouts', 'bind']
4731
4945
    takes_args = []
4732
 
    takes_options = []
 
4946
    takes_options = ['directory']
4733
4947
 
4734
 
    def run(self):
4735
 
        b, relpath = Branch.open_containing(u'.')
 
4948
    def run(self, directory=u'.'):
 
4949
        b, relpath = Branch.open_containing(directory)
4736
4950
        if not b.unbind():
4737
4951
            raise errors.BzrCommandError('Local branch is not bound')
4738
4952
 
4784
4998
            b = control.open_branch()
4785
4999
 
4786
5000
        if tree is not None:
4787
 
            tree.lock_write()
4788
 
            self.add_cleanup(tree.unlock)
 
5001
            self.add_cleanup(tree.lock_write().unlock)
4789
5002
        else:
4790
 
            b.lock_write()
4791
 
            self.add_cleanup(b.unlock)
 
5003
            self.add_cleanup(b.lock_write().unlock)
4792
5004
        return self._run(b, tree, dry_run, verbose, revision, force, local=local)
4793
5005
 
4794
5006
    def _run(self, b, tree, dry_run, verbose, revision, force, local=False):
4833
5045
            self.outf.write('The above revision(s) will be removed.\n')
4834
5046
 
4835
5047
        if not force:
4836
 
            if not ui.ui_factory.get_boolean('Are you sure'):
4837
 
                self.outf.write('Canceled')
 
5048
            if not ui.ui_factory.confirm_action(
 
5049
                    u'Uncommit these revisions',
 
5050
                    'bzrlib.builtins.uncommit',
 
5051
                    {}):
 
5052
                self.outf.write('Canceled\n')
4838
5053
                return 0
4839
5054
 
4840
5055
        mutter('Uncommitting from {%s} to {%s}',
4846
5061
 
4847
5062
 
4848
5063
class cmd_break_lock(Command):
4849
 
    __doc__ = """Break a dead lock on a repository, branch or working directory.
 
5064
    __doc__ = """Break a dead lock.
 
5065
 
 
5066
    This command breaks a lock on a repository, branch, working directory or
 
5067
    config file.
4850
5068
 
4851
5069
    CAUTION: Locks should only be broken when you are sure that the process
4852
5070
    holding the lock has been stopped.
4857
5075
    :Examples:
4858
5076
        bzr break-lock
4859
5077
        bzr break-lock bzr+ssh://example.com/bzr/foo
 
5078
        bzr break-lock --conf ~/.bazaar
4860
5079
    """
 
5080
 
4861
5081
    takes_args = ['location?']
 
5082
    takes_options = [
 
5083
        Option('config',
 
5084
               help='LOCATION is the directory where the config lock is.'),
 
5085
        Option('force',
 
5086
            help='Do not ask for confirmation before breaking the lock.'),
 
5087
        ]
4862
5088
 
4863
 
    def run(self, location=None, show=False):
 
5089
    def run(self, location=None, config=False, force=False):
4864
5090
        if location is None:
4865
5091
            location = u'.'
4866
 
        control, relpath = bzrdir.BzrDir.open_containing(location)
4867
 
        try:
4868
 
            control.break_lock()
4869
 
        except NotImplementedError:
4870
 
            pass
 
5092
        if force:
 
5093
            ui.ui_factory = ui.ConfirmationUserInterfacePolicy(ui.ui_factory,
 
5094
                None,
 
5095
                {'bzrlib.lockdir.break': True})
 
5096
        if config:
 
5097
            conf = _mod_config.LockableConfig(file_name=location)
 
5098
            conf.break_lock()
 
5099
        else:
 
5100
            control, relpath = bzrdir.BzrDir.open_containing(location)
 
5101
            try:
 
5102
                control.break_lock()
 
5103
            except NotImplementedError:
 
5104
                pass
4871
5105
 
4872
5106
 
4873
5107
class cmd_wait_until_signalled(Command):
4902
5136
                    'result in a dynamically allocated port.  The default port '
4903
5137
                    'depends on the protocol.',
4904
5138
               type=str),
4905
 
        Option('directory',
4906
 
               help='Serve contents of this directory.',
4907
 
               type=unicode),
 
5139
        custom_help('directory',
 
5140
               help='Serve contents of this directory.'),
4908
5141
        Option('allow-writes',
4909
5142
               help='By default the server is a readonly server.  Supplying '
4910
5143
                    '--allow-writes enables write access to the contents of '
4937
5170
 
4938
5171
    def run(self, port=None, inet=False, directory=None, allow_writes=False,
4939
5172
            protocol=None):
4940
 
        from bzrlib.transport import get_transport, transport_server_registry
 
5173
        from bzrlib import transport
4941
5174
        if directory is None:
4942
5175
            directory = os.getcwd()
4943
5176
        if protocol is None:
4944
 
            protocol = transport_server_registry.get()
 
5177
            protocol = transport.transport_server_registry.get()
4945
5178
        host, port = self.get_host_and_port(port)
4946
5179
        url = urlutils.local_path_to_url(directory)
4947
5180
        if not allow_writes:
4948
5181
            url = 'readonly+' + url
4949
 
        transport = get_transport(url)
4950
 
        protocol(transport, host, port, inet)
 
5182
        t = transport.get_transport(url)
 
5183
        protocol(t, host, port, inet)
4951
5184
 
4952
5185
 
4953
5186
class cmd_join(Command):
4959
5192
    not part of it.  (Such trees can be produced by "bzr split", but also by
4960
5193
    running "bzr branch" with the target inside a tree.)
4961
5194
 
4962
 
    The result is a combined tree, with the subtree no longer an independant
 
5195
    The result is a combined tree, with the subtree no longer an independent
4963
5196
    part.  This is marked as a merge of the subtree into the containing tree,
4964
5197
    and all history is preserved.
4965
5198
    """
5046
5279
    _see_also = ['send']
5047
5280
 
5048
5281
    takes_options = [
 
5282
        'directory',
5049
5283
        RegistryOption.from_kwargs('patch-type',
5050
5284
            'The type of patch to include in the directive.',
5051
5285
            title='Patch type',
5064
5298
    encoding_type = 'exact'
5065
5299
 
5066
5300
    def run(self, submit_branch=None, public_branch=None, patch_type='bundle',
5067
 
            sign=False, revision=None, mail_to=None, message=None):
 
5301
            sign=False, revision=None, mail_to=None, message=None,
 
5302
            directory=u'.'):
5068
5303
        from bzrlib.revision import ensure_null, NULL_REVISION
5069
5304
        include_patch, include_bundle = {
5070
5305
            'plain': (False, False),
5071
5306
            'diff': (True, False),
5072
5307
            'bundle': (True, True),
5073
5308
            }[patch_type]
5074
 
        branch = Branch.open('.')
 
5309
        branch = Branch.open(directory)
5075
5310
        stored_submit_branch = branch.get_submit_branch()
5076
5311
        if submit_branch is None:
5077
5312
            submit_branch = stored_submit_branch
5153
5388
    source branch defaults to that containing the working directory, but can
5154
5389
    be changed using --from.
5155
5390
 
 
5391
    Both the submit branch and the public branch follow the usual behavior with
 
5392
    respect to --remember: If there is no default location set, the first send
 
5393
    will set it (use --no-remember to avoid settting it). After that, you can
 
5394
    omit the location to use the default.  To change the default, use
 
5395
    --remember. The value will only be saved if the location can be accessed.
 
5396
 
5156
5397
    In order to calculate those changes, bzr must analyse the submit branch.
5157
5398
    Therefore it is most efficient for the submit branch to be a local mirror.
5158
5399
    If a public location is known for the submit_branch, that location is used
5162
5403
    given, in which case it is sent to a file.
5163
5404
 
5164
5405
    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.
 
5406
    on Windows (it uses MAPI).  On Unix, it requires the xdg-email utility.
5166
5407
    If the preferred client can't be found (or used), your editor will be used.
5167
5408
 
5168
5409
    To use a specific mail program, set the mail_client configuration option.
5227
5468
        ]
5228
5469
 
5229
5470
    def run(self, submit_branch=None, public_branch=None, no_bundle=False,
5230
 
            no_patch=False, revision=None, remember=False, output=None,
 
5471
            no_patch=False, revision=None, remember=None, output=None,
5231
5472
            format=None, mail_to=None, message=None, body=None,
5232
5473
            strict=None, **kwargs):
5233
5474
        from bzrlib.send import send
5339
5580
        Option('delete',
5340
5581
            help='Delete this tag rather than placing it.',
5341
5582
            ),
5342
 
        Option('directory',
5343
 
            help='Branch in which to place the tag.',
5344
 
            short_name='d',
5345
 
            type=unicode,
5346
 
            ),
 
5583
        custom_help('directory',
 
5584
            help='Branch in which to place the tag.'),
5347
5585
        Option('force',
5348
5586
            help='Replace existing tags.',
5349
5587
            ),
5357
5595
            revision=None,
5358
5596
            ):
5359
5597
        branch, relpath = Branch.open_containing(directory)
5360
 
        branch.lock_write()
5361
 
        self.add_cleanup(branch.unlock)
 
5598
        self.add_cleanup(branch.lock_write().unlock)
5362
5599
        if delete:
5363
5600
            if tag_name is None:
5364
5601
                raise errors.BzrCommandError("No tag specified to delete.")
5365
5602
            branch.tags.delete_tag(tag_name)
5366
 
            self.outf.write('Deleted tag %s.\n' % tag_name)
 
5603
            note('Deleted tag %s.' % tag_name)
5367
5604
        else:
5368
5605
            if revision:
5369
5606
                if len(revision) != 1:
5381
5618
            if (not force) and branch.tags.has_tag(tag_name):
5382
5619
                raise errors.TagAlreadyExists(tag_name)
5383
5620
            branch.tags.set_tag(tag_name, revision_id)
5384
 
            self.outf.write('Created tag %s.\n' % tag_name)
 
5621
            note('Created tag %s.' % tag_name)
5385
5622
 
5386
5623
 
5387
5624
class cmd_tags(Command):
5392
5629
 
5393
5630
    _see_also = ['tag']
5394
5631
    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',
 
5632
        custom_help('directory',
 
5633
            help='Branch whose tags should be displayed.'),
 
5634
        RegistryOption('sort',
5401
5635
            'Sort tags by different criteria.', title='Sorting',
5402
 
            alpha='Sort tags lexicographically (default).',
5403
 
            time='Sort tags chronologically.',
 
5636
            lazy_registry=('bzrlib.tag', 'tag_sort_methods')
5404
5637
            ),
5405
5638
        'show-ids',
5406
5639
        'revision',
5407
5640
    ]
5408
5641
 
5409
5642
    @display_command
5410
 
    def run(self,
5411
 
            directory='.',
5412
 
            sort='alpha',
5413
 
            show_ids=False,
5414
 
            revision=None,
5415
 
            ):
 
5643
    def run(self, directory='.', sort=None, show_ids=False, revision=None):
 
5644
        from bzrlib.tag import tag_sort_methods
5416
5645
        branch, relpath = Branch.open_containing(directory)
5417
5646
 
5418
5647
        tags = branch.tags.get_tag_dict().items()
5419
5648
        if not tags:
5420
5649
            return
5421
5650
 
5422
 
        branch.lock_read()
5423
 
        self.add_cleanup(branch.unlock)
 
5651
        self.add_cleanup(branch.lock_read().unlock)
5424
5652
        if revision:
5425
5653
            graph = branch.repository.get_graph()
5426
5654
            rev1, rev2 = _get_revision_range(revision, branch, self.name())
5428
5656
            # only show revisions between revid1 and revid2 (inclusive)
5429
5657
            tags = [(tag, revid) for tag, revid in tags if
5430
5658
                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]])
 
5659
        if sort is None:
 
5660
            sort = tag_sort_methods.get()
 
5661
        sort(branch, tags)
5444
5662
        if not show_ids:
5445
5663
            # [ (tag, revid), ... ] -> [ (tag, dotted_revno), ... ]
5446
5664
            for index, (tag, revid) in enumerate(tags):
5448
5666
                    revno = branch.revision_id_to_dotted_revno(revid)
5449
5667
                    if isinstance(revno, tuple):
5450
5668
                        revno = '.'.join(map(str, revno))
5451
 
                except errors.NoSuchRevision:
 
5669
                except (errors.NoSuchRevision, errors.GhostRevisionsHaveNoRevno):
5452
5670
                    # Bad tag data/merges can lead to tagged revisions
5453
5671
                    # which are not in this branch. Fail gracefully ...
5454
5672
                    revno = '?'
5512
5730
            unstacked=None):
5513
5731
        directory = bzrdir.BzrDir.open(location)
5514
5732
        if stacked_on and unstacked:
5515
 
            raise BzrCommandError("Can't use both --stacked-on and --unstacked")
 
5733
            raise errors.BzrCommandError("Can't use both --stacked-on and --unstacked")
5516
5734
        elif stacked_on is not None:
5517
5735
            reconfigure.ReconfigureStackedOn().apply(directory, stacked_on)
5518
5736
        elif unstacked:
5573
5791
    """
5574
5792
 
5575
5793
    takes_args = ['to_location?']
5576
 
    takes_options = [Option('force',
 
5794
    takes_options = ['directory',
 
5795
                     Option('force',
5577
5796
                        help='Switch even if local commits will be lost.'),
5578
5797
                     'revision',
5579
5798
                     Option('create-branch', short_name='b',
5582
5801
                    ]
5583
5802
 
5584
5803
    def run(self, to_location=None, force=False, create_branch=False,
5585
 
            revision=None):
 
5804
            revision=None, directory=u'.'):
5586
5805
        from bzrlib import switch
5587
 
        tree_location = '.'
 
5806
        tree_location = directory
5588
5807
        revision = _get_one_revision('switch', revision)
5589
5808
        control_dir = bzrdir.BzrDir.open_containing(tree_location)[0]
5590
5809
        if to_location is None:
5591
5810
            if revision is None:
5592
5811
                raise errors.BzrCommandError('You must supply either a'
5593
5812
                                             ' revision or a location')
5594
 
            to_location = '.'
 
5813
            to_location = tree_location
5595
5814
        try:
5596
5815
            branch = control_dir.open_branch()
5597
5816
            had_explicit_nick = branch.get_config().has_explicit_nickname()
5732
5951
            name=None,
5733
5952
            switch=None,
5734
5953
            ):
5735
 
        tree, file_list = tree_files(file_list, apply_view=False)
 
5954
        tree, file_list = WorkingTree.open_containing_paths(file_list,
 
5955
            apply_view=False)
5736
5956
        current_view, view_dict = tree.views.get_view_info()
5737
5957
        if name is None:
5738
5958
            name = current_view
5842
6062
            location = "."
5843
6063
        branch = Branch.open_containing(location)[0]
5844
6064
        branch.bzrdir.destroy_branch()
5845
 
        
 
6065
 
5846
6066
 
5847
6067
class cmd_shelve(Command):
5848
6068
    __doc__ = """Temporarily set aside some changes from the current tree.
5867
6087
 
5868
6088
    You can put multiple items on the shelf, and by default, 'unshelve' will
5869
6089
    restore the most recently shelved changes.
 
6090
 
 
6091
    For complicated changes, it is possible to edit the changes in a separate
 
6092
    editor program to decide what the file remaining in the working copy
 
6093
    should look like.  To do this, add the configuration option
 
6094
 
 
6095
        change_editor = PROGRAM @new_path @old_path
 
6096
 
 
6097
    where @new_path is replaced with the path of the new version of the 
 
6098
    file and @old_path is replaced with the path of the old version of 
 
6099
    the file.  The PROGRAM should save the new file with the desired 
 
6100
    contents of the file in the working tree.
 
6101
        
5870
6102
    """
5871
6103
 
5872
6104
    takes_args = ['file*']
5873
6105
 
5874
6106
    takes_options = [
 
6107
        'directory',
5875
6108
        'revision',
5876
6109
        Option('all', help='Shelve all changes.'),
5877
6110
        'message',
5883
6116
        Option('destroy',
5884
6117
               help='Destroy removed changes instead of shelving them.'),
5885
6118
    ]
5886
 
    _see_also = ['unshelve']
 
6119
    _see_also = ['unshelve', 'configuration']
5887
6120
 
5888
6121
    def run(self, revision=None, all=False, file_list=None, message=None,
5889
 
            writer=None, list=False, destroy=False):
 
6122
            writer=None, list=False, destroy=False, directory=None):
5890
6123
        if list:
5891
 
            return self.run_for_list()
 
6124
            return self.run_for_list(directory=directory)
5892
6125
        from bzrlib.shelf_ui import Shelver
5893
6126
        if writer is None:
5894
6127
            writer = bzrlib.option.diff_writer_registry.get()
5895
6128
        try:
5896
6129
            shelver = Shelver.from_args(writer(sys.stdout), revision, all,
5897
 
                file_list, message, destroy=destroy)
 
6130
                file_list, message, destroy=destroy, directory=directory)
5898
6131
            try:
5899
6132
                shelver.run()
5900
6133
            finally:
5902
6135
        except errors.UserAbort:
5903
6136
            return 0
5904
6137
 
5905
 
    def run_for_list(self):
5906
 
        tree = WorkingTree.open_containing('.')[0]
5907
 
        tree.lock_read()
5908
 
        self.add_cleanup(tree.unlock)
 
6138
    def run_for_list(self, directory=None):
 
6139
        if directory is None:
 
6140
            directory = u'.'
 
6141
        tree = WorkingTree.open_containing(directory)[0]
 
6142
        self.add_cleanup(tree.lock_read().unlock)
5909
6143
        manager = tree.get_shelf_manager()
5910
6144
        shelves = manager.active_shelves()
5911
6145
        if len(shelves) == 0:
5929
6163
 
5930
6164
    takes_args = ['shelf_id?']
5931
6165
    takes_options = [
 
6166
        'directory',
5932
6167
        RegistryOption.from_kwargs(
5933
6168
            'action', help="The action to perform.",
5934
6169
            enum_switch=False, value_switches=True,
5942
6177
    ]
5943
6178
    _see_also = ['shelve']
5944
6179
 
5945
 
    def run(self, shelf_id=None, action='apply'):
 
6180
    def run(self, shelf_id=None, action='apply', directory=u'.'):
5946
6181
        from bzrlib.shelf_ui import Unshelver
5947
 
        unshelver = Unshelver.from_args(shelf_id, action)
 
6182
        unshelver = Unshelver.from_args(shelf_id, action, directory=directory)
5948
6183
        try:
5949
6184
            unshelver.run()
5950
6185
        finally:
5966
6201
 
5967
6202
    To check what clean-tree will do, use --dry-run.
5968
6203
    """
5969
 
    takes_options = [Option('ignored', help='Delete all ignored files.'),
5970
 
                     Option('detritus', help='Delete conflict files, merge'
 
6204
    takes_options = ['directory',
 
6205
                     Option('ignored', help='Delete all ignored files.'),
 
6206
                     Option('detritus', help='Delete conflict files, merge and revert'
5971
6207
                            ' backups, and failed selftest dirs.'),
5972
6208
                     Option('unknown',
5973
6209
                            help='Delete files unknown to bzr (default).'),
5975
6211
                            ' deleting them.'),
5976
6212
                     Option('force', help='Do not prompt before deleting.')]
5977
6213
    def run(self, unknown=False, ignored=False, detritus=False, dry_run=False,
5978
 
            force=False):
 
6214
            force=False, directory=u'.'):
5979
6215
        from bzrlib.clean_tree import clean_tree
5980
6216
        if not (unknown or ignored or detritus):
5981
6217
            unknown = True
5982
6218
        if dry_run:
5983
6219
            force = True
5984
 
        clean_tree('.', unknown=unknown, ignored=ignored, detritus=detritus,
5985
 
                   dry_run=dry_run, no_prompt=force)
 
6220
        clean_tree(directory, unknown=unknown, ignored=ignored,
 
6221
                   detritus=detritus, dry_run=dry_run, no_prompt=force)
5986
6222
 
5987
6223
 
5988
6224
class cmd_reference(Command):
6032
6268
            self.outf.write('%s %s\n' % (path, location))
6033
6269
 
6034
6270
 
 
6271
class cmd_export_pot(Command):
 
6272
    __doc__ = """Export command helps and error messages in po format."""
 
6273
 
 
6274
    hidden = True
 
6275
 
 
6276
    def run(self):
 
6277
        from bzrlib.export_pot import export_pot
 
6278
        export_pot(self.outf)
 
6279
 
 
6280
 
6035
6281
def _register_lazy_builtins():
6036
6282
    # register lazy builtins from other modules; called at startup and should
6037
6283
    # be only called once.
6038
6284
    for (name, aliases, module_name) in [
6039
6285
        ('cmd_bundle_info', [], 'bzrlib.bundle.commands'),
 
6286
        ('cmd_config', [], 'bzrlib.config'),
6040
6287
        ('cmd_dpush', [], 'bzrlib.foreign'),
6041
6288
        ('cmd_version_info', [], 'bzrlib.cmd_version_info'),
6042
6289
        ('cmd_resolve', ['resolved'], 'bzrlib.conflicts'),
6043
6290
        ('cmd_conflicts', [], 'bzrlib.conflicts'),
6044
 
        ('cmd_sign_my_commits', [], 'bzrlib.sign_my_commits'),
 
6291
        ('cmd_sign_my_commits', [], 'bzrlib.commit_signature_commands'),
 
6292
        ('cmd_verify_signatures', [],
 
6293
                                        'bzrlib.commit_signature_commands'),
 
6294
        ('cmd_test_script', [], 'bzrlib.cmd_test_script'),
6045
6295
        ]:
6046
6296
        builtin_command_registry.register_lazy(name, aliases, module_name)