~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/builtins.py

  • Committer: Canonical.com Patch Queue Manager
  • Date: 2010-04-06 06:59:03 UTC
  • mfrom: (5051.5.1 subunit)
  • Revision ID: pqm@pqm.ubuntu.com-20100406065903-y9dxgwmog1pmw7dz
Use subunit when running tests in PQM.

Show diffs side-by-side

added added

removed removed

Lines of Context:
1
 
# Copyright (C) 2005-2011 Canonical Ltd
 
1
# Copyright (C) 2005-2010 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
23
24
import cStringIO
24
25
import sys
25
26
import time
32
33
    bzrdir,
33
34
    directory_service,
34
35
    delta,
35
 
    config as _mod_config,
 
36
    config,
36
37
    errors,
37
38
    globbing,
38
39
    hooks,
44
45
    rename_map,
45
46
    revision as _mod_revision,
46
47
    static_tuple,
 
48
    symbol_versioning,
47
49
    timestamp,
48
50
    transport,
49
51
    ui,
50
52
    urlutils,
51
53
    views,
52
 
    gpg,
53
54
    )
54
55
from bzrlib.branch import Branch
55
56
from bzrlib.conflicts import ConflictList
72
73
    _parse_revision_str,
73
74
    )
74
75
from bzrlib.trace import mutter, note, warning, is_quiet, get_verbosity_level
75
 
from bzrlib import (
76
 
    symbol_versioning,
77
 
    )
78
 
 
79
 
 
80
 
@symbol_versioning.deprecated_function(symbol_versioning.deprecated_in((2, 3, 0)))
 
76
 
 
77
 
81
78
def tree_files(file_list, default_branch=u'.', canonicalize=True,
82
79
    apply_view=True):
83
 
    return internal_tree_files(file_list, default_branch, canonicalize,
84
 
        apply_view)
 
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]))
85
86
 
86
87
 
87
88
def tree_files_for_add(file_list):
151
152
 
152
153
# XXX: Bad function name; should possibly also be a class method of
153
154
# 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
 
 
161
159
    This is typically used for command-line processors that take one or
162
160
    more filenames, and infer the workingtree that contains them.
163
161
 
173
171
 
174
172
    :return: workingtree, [relative_paths]
175
173
    """
176
 
    return WorkingTree.open_containing_paths(
177
 
        file_list, default_directory='.',
178
 
        canonicalize=True,
179
 
        apply_view=True)
 
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
180
221
 
181
222
 
182
223
def _get_view_info_for_change_reporter(tree):
191
232
    return view_info
192
233
 
193
234
 
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
 
 
202
235
# TODO: Make sure no commands unconditionally use the working directory as a
203
236
# branch.  If a filename argument is used, the first of them should be used to
204
237
# specify the branch.  (Perhaps this can be factored out into some kind of
206
239
# opens the branch?)
207
240
 
208
241
class cmd_status(Command):
209
 
    __doc__ = """Display status summary.
 
242
    """Display status summary.
210
243
 
211
244
    This reports on versioned and unknown files, reporting them
212
245
    grouped by state.  Possible states are:
253
286
    To skip the display of pending merge information altogether, use
254
287
    the no-pending option or specify a file/directory.
255
288
 
256
 
    To compare the working directory to a specific revision, pass a
257
 
    single revision to the revision argument.
258
 
 
259
 
    To see which files have changed in a specific revision, or between
260
 
    two revisions, pass a revision range to the revision argument.
261
 
    This will produce the same results as calling 'bzr diff --summarize'.
 
289
    If a revision argument is given, the status is calculated against
 
290
    that revision, or between two revisions if two are provided.
262
291
    """
263
292
 
264
293
    # TODO: --no-recurse, --recurse options
286
315
            raise errors.BzrCommandError('bzr status --revision takes exactly'
287
316
                                         ' one or two revision specifiers')
288
317
 
289
 
        tree, relfile_list = WorkingTree.open_containing_paths(file_list)
 
318
        tree, relfile_list = tree_files(file_list)
290
319
        # Avoid asking for specific files when that is not needed.
291
320
        if relfile_list == ['']:
292
321
            relfile_list = None
303
332
 
304
333
 
305
334
class cmd_cat_revision(Command):
306
 
    __doc__ = """Write out metadata for a revision.
 
335
    """Write out metadata for a revision.
307
336
 
308
337
    The revision to print can either be specified by a specific
309
338
    revision identifier, or you can use --revision.
311
340
 
312
341
    hidden = True
313
342
    takes_args = ['revision_id?']
314
 
    takes_options = ['directory', 'revision']
 
343
    takes_options = ['revision']
315
344
    # cat-revision is more for frontends so should be exact
316
345
    encoding = 'strict'
317
346
 
324
353
        self.outf.write(revtext.decode('utf-8'))
325
354
 
326
355
    @display_command
327
 
    def run(self, revision_id=None, revision=None, directory=u'.'):
 
356
    def run(self, revision_id=None, revision=None):
328
357
        if revision_id is not None and revision is not None:
329
358
            raise errors.BzrCommandError('You can only supply one of'
330
359
                                         ' revision_id or --revision')
331
360
        if revision_id is None and revision is None:
332
361
            raise errors.BzrCommandError('You must supply either'
333
362
                                         ' --revision or a revision_id')
334
 
 
335
 
        b = bzrdir.BzrDir.open_containing_tree_or_branch(directory)[1]
 
363
        b = WorkingTree.open_containing(u'.')[0].branch
336
364
 
337
365
        revisions = b.repository.revisions
338
366
        if revisions is None:
362
390
        
363
391
 
364
392
class cmd_dump_btree(Command):
365
 
    __doc__ = """Dump the contents of a btree index file to stdout.
 
393
    """Dump the contents of a btree index file to stdout.
366
394
 
367
395
    PATH is a btree index file, it can be any URL. This includes things like
368
396
    .bzr/repository/pack-names, or .bzr/repository/indices/a34b3a...ca4a4.iix
416
444
                self.outf.write(page_bytes[:header_end])
417
445
                page_bytes = data
418
446
            self.outf.write('\nPage %d\n' % (page_idx,))
419
 
            if len(page_bytes) == 0:
420
 
                self.outf.write('(empty)\n');
421
 
            else:
422
 
                decomp_bytes = zlib.decompress(page_bytes)
423
 
                self.outf.write(decomp_bytes)
424
 
                self.outf.write('\n')
 
447
            decomp_bytes = zlib.decompress(page_bytes)
 
448
            self.outf.write(decomp_bytes)
 
449
            self.outf.write('\n')
425
450
 
426
451
    def _dump_entries(self, trans, basename):
427
452
        try:
446
471
 
447
472
 
448
473
class cmd_remove_tree(Command):
449
 
    __doc__ = """Remove the working tree from a given branch/checkout.
 
474
    """Remove the working tree from a given branch/checkout.
450
475
 
451
476
    Since a lightweight checkout is little more than a working tree
452
477
    this will refuse to run against one.
458
483
    takes_options = [
459
484
        Option('force',
460
485
               help='Remove the working tree even if it has '
461
 
                    'uncommitted or shelved changes.'),
 
486
                    'uncommitted changes.'),
462
487
        ]
463
488
 
464
489
    def run(self, location_list, force=False):
478
503
            if not force:
479
504
                if (working.has_changes()):
480
505
                    raise errors.UncommittedChanges(working)
481
 
                if working.get_shelf_manager().last_shelf() is not None:
482
 
                    raise errors.ShelvedChanges(working)
483
506
 
484
 
            if working.user_url != working.branch.user_url:
 
507
            working_path = working.bzrdir.root_transport.base
 
508
            branch_path = working.branch.bzrdir.root_transport.base
 
509
            if working_path != branch_path:
485
510
                raise errors.BzrCommandError("You cannot remove the working tree"
486
511
                                             " from a lightweight checkout")
487
512
 
488
513
            d.destroy_workingtree()
489
514
 
490
515
 
491
 
class cmd_repair_workingtree(Command):
492
 
    __doc__ = """Reset the working tree state file.
493
 
 
494
 
    This is not meant to be used normally, but more as a way to recover from
495
 
    filesystem corruption, etc. This rebuilds the working inventory back to a
496
 
    'known good' state. Any new modifications (adding a file, renaming, etc)
497
 
    will be lost, though modified files will still be detected as such.
498
 
 
499
 
    Most users will want something more like "bzr revert" or "bzr update"
500
 
    unless the state file has become corrupted.
501
 
 
502
 
    By default this attempts to recover the current state by looking at the
503
 
    headers of the state file. If the state file is too corrupted to even do
504
 
    that, you can supply --revision to force the state of the tree.
505
 
    """
506
 
 
507
 
    takes_options = ['revision', 'directory',
508
 
        Option('force',
509
 
               help='Reset the tree even if it doesn\'t appear to be'
510
 
                    ' corrupted.'),
511
 
    ]
512
 
    hidden = True
513
 
 
514
 
    def run(self, revision=None, directory='.', force=False):
515
 
        tree, _ = WorkingTree.open_containing(directory)
516
 
        self.add_cleanup(tree.lock_tree_write().unlock)
517
 
        if not force:
518
 
            try:
519
 
                tree.check_state()
520
 
            except errors.BzrError:
521
 
                pass # There seems to be a real error here, so we'll reset
522
 
            else:
523
 
                # Refuse
524
 
                raise errors.BzrCommandError(
525
 
                    'The tree does not appear to be corrupt. You probably'
526
 
                    ' want "bzr revert" instead. Use "--force" if you are'
527
 
                    ' sure you want to reset the working tree.')
528
 
        if revision is None:
529
 
            revision_ids = None
530
 
        else:
531
 
            revision_ids = [r.as_revision_id(tree.branch) for r in revision]
532
 
        try:
533
 
            tree.reset_state(revision_ids)
534
 
        except errors.BzrError, e:
535
 
            if revision_ids is None:
536
 
                extra = (', the header appears corrupt, try passing -r -1'
537
 
                         ' to set the state to the last commit')
538
 
            else:
539
 
                extra = ''
540
 
            raise errors.BzrCommandError('failed to reset the tree state'
541
 
                                         + extra)
542
 
 
543
 
 
544
516
class cmd_revno(Command):
545
 
    __doc__ = """Show current revision number.
 
517
    """Show current revision number.
546
518
 
547
519
    This is equal to the number of revisions on this branch.
548
520
    """
558
530
        if tree:
559
531
            try:
560
532
                wt = WorkingTree.open_containing(location)[0]
561
 
                self.add_cleanup(wt.lock_read().unlock)
 
533
                wt.lock_read()
562
534
            except (errors.NoWorkingTree, errors.NotLocalUrl):
563
535
                raise errors.NoWorkingTree(location)
 
536
            self.add_cleanup(wt.unlock)
564
537
            revid = wt.last_revision()
565
538
            try:
566
539
                revno_t = wt.branch.revision_id_to_dotted_revno(revid)
569
542
            revno = ".".join(str(n) for n in revno_t)
570
543
        else:
571
544
            b = Branch.open_containing(location)[0]
572
 
            self.add_cleanup(b.lock_read().unlock)
 
545
            b.lock_read()
 
546
            self.add_cleanup(b.unlock)
573
547
            revno = b.revno()
574
548
        self.cleanup_now()
575
549
        self.outf.write(str(revno) + '\n')
576
550
 
577
551
 
578
552
class cmd_revision_info(Command):
579
 
    __doc__ = """Show revision number and revision id for a given revision identifier.
 
553
    """Show revision number and revision id for a given revision identifier.
580
554
    """
581
555
    hidden = True
582
556
    takes_args = ['revision_info*']
583
557
    takes_options = [
584
558
        'revision',
585
 
        custom_help('directory',
 
559
        Option('directory',
586
560
            help='Branch to examine, '
587
 
                 'rather than the one containing the working directory.'),
 
561
                 'rather than the one containing the working directory.',
 
562
            short_name='d',
 
563
            type=unicode,
 
564
            ),
588
565
        Option('tree', help='Show revno of working tree'),
589
566
        ]
590
567
 
595
572
        try:
596
573
            wt = WorkingTree.open_containing(directory)[0]
597
574
            b = wt.branch
598
 
            self.add_cleanup(wt.lock_read().unlock)
 
575
            wt.lock_read()
 
576
            self.add_cleanup(wt.unlock)
599
577
        except (errors.NoWorkingTree, errors.NotLocalUrl):
600
578
            wt = None
601
579
            b = Branch.open_containing(directory)[0]
602
 
            self.add_cleanup(b.lock_read().unlock)
 
580
            b.lock_read()
 
581
            self.add_cleanup(b.unlock)
603
582
        revision_ids = []
604
583
        if revision is not None:
605
584
            revision_ids.extend(rev.as_revision_id(b) for rev in revision)
633
612
 
634
613
 
635
614
class cmd_add(Command):
636
 
    __doc__ = """Add specified files or directories.
 
615
    """Add specified files or directories.
637
616
 
638
617
    In non-recursive mode, all the named items are added, regardless
639
618
    of whether they were previously ignored.  A warning is given if
704
683
                should_print=(not is_quiet()))
705
684
 
706
685
        if base_tree:
707
 
            self.add_cleanup(base_tree.lock_read().unlock)
 
686
            base_tree.lock_read()
 
687
            self.add_cleanup(base_tree.unlock)
708
688
        tree, file_list = tree_files_for_add(file_list)
709
689
        added, ignored = tree.smart_add(file_list, not
710
690
            no_recurse, action=action, save=not dry_run)
718
698
 
719
699
 
720
700
class cmd_mkdir(Command):
721
 
    __doc__ = """Create a new versioned directory.
 
701
    """Create a new versioned directory.
722
702
 
723
703
    This is equivalent to creating the directory and then adding it.
724
704
    """
740
720
 
741
721
 
742
722
class cmd_relpath(Command):
743
 
    __doc__ = """Show path of a file relative to root"""
 
723
    """Show path of a file relative to root"""
744
724
 
745
725
    takes_args = ['filename']
746
726
    hidden = True
755
735
 
756
736
 
757
737
class cmd_inventory(Command):
758
 
    __doc__ = """Show inventory of the current working copy or a revision.
 
738
    """Show inventory of the current working copy or a revision.
759
739
 
760
740
    It is possible to limit the output to a particular entry
761
741
    type using the --kind option.  For example: --kind file.
781
761
            raise errors.BzrCommandError('invalid kind %r specified' % (kind,))
782
762
 
783
763
        revision = _get_one_revision('inventory', revision)
784
 
        work_tree, file_list = WorkingTree.open_containing_paths(file_list)
785
 
        self.add_cleanup(work_tree.lock_read().unlock)
 
764
        work_tree, file_list = tree_files(file_list)
 
765
        work_tree.lock_read()
 
766
        self.add_cleanup(work_tree.unlock)
786
767
        if revision is not None:
787
768
            tree = revision.as_tree(work_tree.branch)
788
769
 
789
770
            extra_trees = [work_tree]
790
 
            self.add_cleanup(tree.lock_read().unlock)
 
771
            tree.lock_read()
 
772
            self.add_cleanup(tree.unlock)
791
773
        else:
792
774
            tree = work_tree
793
775
            extra_trees = []
797
779
                                      require_versioned=True)
798
780
            # find_ids_across_trees may include some paths that don't
799
781
            # exist in 'tree'.
800
 
            entries = sorted(
801
 
                (tree.id2path(file_id), tree.inventory[file_id])
802
 
                for file_id in file_ids if tree.has_id(file_id))
 
782
            entries = sorted((tree.id2path(file_id), tree.inventory[file_id])
 
783
                             for file_id in file_ids if file_id in tree)
803
784
        else:
804
785
            entries = tree.inventory.entries()
805
786
 
815
796
 
816
797
 
817
798
class cmd_mv(Command):
818
 
    __doc__ = """Move or rename a file.
 
799
    """Move or rename a file.
819
800
 
820
801
    :Usage:
821
802
        bzr mv OLDNAME NEWNAME
853
834
            names_list = []
854
835
        if len(names_list) < 2:
855
836
            raise errors.BzrCommandError("missing file argument")
856
 
        tree, rel_names = WorkingTree.open_containing_paths(names_list, canonicalize=False)
857
 
        self.add_cleanup(tree.lock_tree_write().unlock)
 
837
        tree, rel_names = tree_files(names_list, canonicalize=False)
 
838
        tree.lock_tree_write()
 
839
        self.add_cleanup(tree.unlock)
858
840
        self._run(tree, names_list, rel_names, after)
859
841
 
860
842
    def run_auto(self, names_list, after, dry_run):
864
846
        if after:
865
847
            raise errors.BzrCommandError('--after cannot be specified with'
866
848
                                         ' --auto.')
867
 
        work_tree, file_list = WorkingTree.open_containing_paths(
868
 
            names_list, default_directory='.')
869
 
        self.add_cleanup(work_tree.lock_tree_write().unlock)
 
849
        work_tree, file_list = tree_files(names_list, default_branch='.')
 
850
        work_tree.lock_tree_write()
 
851
        self.add_cleanup(work_tree.unlock)
870
852
        rename_map.RenameMap.guess_renames(work_tree, dry_run)
871
853
 
872
854
    def _run(self, tree, names_list, rel_names, after):
951
933
 
952
934
 
953
935
class cmd_pull(Command):
954
 
    __doc__ = """Turn this branch into a mirror of another branch.
 
936
    """Turn this branch into a mirror of another branch.
955
937
 
956
938
    By default, this command only works on branches that have not diverged.
957
939
    Branches are considered diverged if the destination branch's most recent 
966
948
    match the remote one, use pull --overwrite. This will work even if the two
967
949
    branches have diverged.
968
950
 
969
 
    If there is no default location set, the first pull will set it (use
970
 
    --no-remember to avoid settting it). After that, you can omit the
971
 
    location to use the default.  To change the default, use --remember. The
972
 
    value will only be saved if the remote location can be accessed.
 
951
    If there is no default location set, the first pull will set it.  After
 
952
    that, you can omit the location to use the default.  To change the
 
953
    default, use --remember. The value will only be saved if the remote
 
954
    location can be accessed.
973
955
 
974
956
    Note: The location can be specified either in the form of a branch,
975
957
    or in the form of a path to a file containing a merge directive generated
980
962
    takes_options = ['remember', 'overwrite', 'revision',
981
963
        custom_help('verbose',
982
964
            help='Show logs of pulled revisions.'),
983
 
        custom_help('directory',
 
965
        Option('directory',
984
966
            help='Branch to pull into, '
985
 
                 'rather than the one containing the working directory.'),
 
967
                 'rather than the one containing the working directory.',
 
968
            short_name='d',
 
969
            type=unicode,
 
970
            ),
986
971
        Option('local',
987
972
            help="Perform a local pull in a bound "
988
973
                 "branch.  Local pulls are not applied to "
989
974
                 "the master branch."
990
975
            ),
991
 
        Option('show-base',
992
 
            help="Show base revision text in conflicts.")
993
976
        ]
994
977
    takes_args = ['location?']
995
978
    encoding_type = 'replace'
996
979
 
997
 
    def run(self, location=None, remember=None, overwrite=False,
 
980
    def run(self, location=None, remember=False, overwrite=False,
998
981
            revision=None, verbose=False,
999
 
            directory=None, local=False,
1000
 
            show_base=False):
 
982
            directory=None, local=False):
1001
983
        # FIXME: too much stuff is in the command class
1002
984
        revision_id = None
1003
985
        mergeable = None
1006
988
        try:
1007
989
            tree_to = WorkingTree.open_containing(directory)[0]
1008
990
            branch_to = tree_to.branch
1009
 
            self.add_cleanup(tree_to.lock_write().unlock)
1010
991
        except errors.NoWorkingTree:
1011
992
            tree_to = None
1012
993
            branch_to = Branch.open_containing(directory)[0]
1013
 
            self.add_cleanup(branch_to.lock_write().unlock)
1014
 
 
1015
 
        if tree_to is None and show_base:
1016
 
            raise errors.BzrCommandError("Need working tree for --show-base.")
1017
 
 
 
994
        
1018
995
        if local and not branch_to.get_bound_location():
1019
996
            raise errors.LocalRequiresBoundBranch()
1020
997
 
1050
1027
        else:
1051
1028
            branch_from = Branch.open(location,
1052
1029
                possible_transports=possible_transports)
1053
 
            self.add_cleanup(branch_from.lock_read().unlock)
1054
 
            # Remembers if asked explicitly or no previous location is set
1055
 
            if (remember
1056
 
                or (remember is None and branch_to.get_parent() is None)):
 
1030
 
 
1031
            if branch_to.get_parent() is None or remember:
1057
1032
                branch_to.set_parent(branch_from.base)
1058
1033
 
 
1034
        if branch_from is not branch_to:
 
1035
            branch_from.lock_read()
 
1036
            self.add_cleanup(branch_from.unlock)
1059
1037
        if revision is not None:
1060
1038
            revision_id = revision.as_revision_id(branch_from)
1061
1039
 
 
1040
        branch_to.lock_write()
 
1041
        self.add_cleanup(branch_to.unlock)
1062
1042
        if tree_to is not None:
1063
1043
            view_info = _get_view_info_for_change_reporter(tree_to)
1064
1044
            change_reporter = delta._ChangeReporter(
1066
1046
                view_info=view_info)
1067
1047
            result = tree_to.pull(
1068
1048
                branch_from, overwrite, revision_id, change_reporter,
1069
 
                possible_transports=possible_transports, local=local,
1070
 
                show_base=show_base)
 
1049
                possible_transports=possible_transports, local=local)
1071
1050
        else:
1072
1051
            result = branch_to.pull(
1073
1052
                branch_from, overwrite, revision_id, local=local)
1077
1056
            log.show_branch_change(
1078
1057
                branch_to, self.outf, result.old_revno,
1079
1058
                result.old_revid)
1080
 
        if getattr(result, 'tag_conflicts', None):
1081
 
            return 1
1082
 
        else:
1083
 
            return 0
1084
1059
 
1085
1060
 
1086
1061
class cmd_push(Command):
1087
 
    __doc__ = """Update a mirror of this branch.
 
1062
    """Update a mirror of this branch.
1088
1063
 
1089
1064
    The target branch will not have its working tree populated because this
1090
1065
    is both expensive, and is not supported on remote file systems.
1103
1078
    do a merge (see bzr help merge) from the other branch, and commit that.
1104
1079
    After that you will be able to do a push without '--overwrite'.
1105
1080
 
1106
 
    If there is no default push location set, the first push will set it (use
1107
 
    --no-remember to avoid settting it).  After that, you can omit the
1108
 
    location to use the default.  To change the default, use --remember. The
1109
 
    value will only be saved if the remote location can be accessed.
 
1081
    If there is no default push location set, the first push will set it.
 
1082
    After that, you can omit the location to use the default.  To change the
 
1083
    default, use --remember. The value will only be saved if the remote
 
1084
    location can be accessed.
1110
1085
    """
1111
1086
 
1112
1087
    _see_also = ['pull', 'update', 'working-trees']
1114
1089
        Option('create-prefix',
1115
1090
               help='Create the path leading up to the branch '
1116
1091
                    'if it does not already exist.'),
1117
 
        custom_help('directory',
 
1092
        Option('directory',
1118
1093
            help='Branch to push from, '
1119
 
                 'rather than the one containing the working directory.'),
 
1094
                 'rather than the one containing the working directory.',
 
1095
            short_name='d',
 
1096
            type=unicode,
 
1097
            ),
1120
1098
        Option('use-existing-dir',
1121
1099
               help='By default push will fail if the target'
1122
1100
                    ' directory exists, but does not already'
1133
1111
        Option('strict',
1134
1112
               help='Refuse to push if there are uncommitted changes in'
1135
1113
               ' the working tree, --no-strict disables the check.'),
1136
 
        Option('no-tree',
1137
 
               help="Don't populate the working tree, even for protocols"
1138
 
               " that support it."),
1139
1114
        ]
1140
1115
    takes_args = ['location?']
1141
1116
    encoding_type = 'replace'
1142
1117
 
1143
 
    def run(self, location=None, remember=None, overwrite=False,
 
1118
    def run(self, location=None, remember=False, overwrite=False,
1144
1119
        create_prefix=False, verbose=False, revision=None,
1145
1120
        use_existing_dir=False, directory=None, stacked_on=None,
1146
 
        stacked=False, strict=None, no_tree=False):
 
1121
        stacked=False, strict=None):
1147
1122
        from bzrlib.push import _show_push_branch
1148
1123
 
1149
1124
        if directory is None:
1151
1126
        # Get the source branch
1152
1127
        (tree, br_from,
1153
1128
         _unused) = bzrdir.BzrDir.open_containing_tree_or_branch(directory)
 
1129
        if strict is None:
 
1130
            strict = br_from.get_config().get_user_option_as_bool('push_strict')
 
1131
        if strict is None: strict = True # default value
1154
1132
        # Get the tip's revision_id
1155
1133
        revision = _get_one_revision('push', revision)
1156
1134
        if revision is not None:
1157
1135
            revision_id = revision.in_history(br_from).rev_id
1158
1136
        else:
1159
1137
            revision_id = None
1160
 
        if tree is not None and revision_id is None:
1161
 
            tree.check_changed_or_out_of_date(
1162
 
                strict, 'push_strict',
1163
 
                more_error='Use --no-strict to force the push.',
1164
 
                more_warning='Uncommitted changes will not be pushed.')
 
1138
        if strict and tree is not None and revision_id is None:
 
1139
            if (tree.has_changes()):
 
1140
                raise errors.UncommittedChanges(
 
1141
                    tree, more='Use --no-strict to force the push.')
 
1142
            if tree.last_revision() != tree.branch.last_revision():
 
1143
                # The tree has lost sync with its branch, there is little
 
1144
                # chance that the user is aware of it but he can still force
 
1145
                # the push with --no-strict
 
1146
                raise errors.OutOfDateTree(
 
1147
                    tree, more='Use --no-strict to force the push.')
 
1148
 
1165
1149
        # Get the stacked_on branch, if any
1166
1150
        if stacked_on is not None:
1167
1151
            stacked_on = urlutils.normalize_url(stacked_on)
1195
1179
        _show_push_branch(br_from, revision_id, location, self.outf,
1196
1180
            verbose=verbose, overwrite=overwrite, remember=remember,
1197
1181
            stacked_on=stacked_on, create_prefix=create_prefix,
1198
 
            use_existing_dir=use_existing_dir, no_tree=no_tree)
 
1182
            use_existing_dir=use_existing_dir)
1199
1183
 
1200
1184
 
1201
1185
class cmd_branch(Command):
1202
 
    __doc__ = """Create a new branch that is a copy of an existing branch.
 
1186
    """Create a new branch that is a copy of an existing branch.
1203
1187
 
1204
1188
    If the TO_LOCATION is omitted, the last component of the FROM_LOCATION will
1205
1189
    be used.  In other words, "branch ../foo/bar" will attempt to create ./bar.
1210
1194
 
1211
1195
    To retrieve the branch as of a particular revision, supply the --revision
1212
1196
    parameter, as in "branch foo/bar -r 5".
1213
 
 
1214
 
    The synonyms 'clone' and 'get' for this command are deprecated.
1215
1197
    """
1216
1198
 
1217
1199
    _see_also = ['checkout']
1218
1200
    takes_args = ['from_location', 'to_location?']
1219
 
    takes_options = ['revision',
1220
 
        Option('hardlink', help='Hard-link working tree files where possible.'),
1221
 
        Option('files-from', type=str,
1222
 
               help="Get file contents from this tree."),
 
1201
    takes_options = ['revision', Option('hardlink',
 
1202
        help='Hard-link working tree files where possible.'),
1223
1203
        Option('no-tree',
1224
1204
            help="Create a branch without a working-tree."),
1225
1205
        Option('switch',
1243
1223
 
1244
1224
    def run(self, from_location, to_location=None, revision=None,
1245
1225
            hardlink=False, stacked=False, standalone=False, no_tree=False,
1246
 
            use_existing_dir=False, switch=False, bind=False,
1247
 
            files_from=None):
 
1226
            use_existing_dir=False, switch=False, bind=False):
1248
1227
        from bzrlib import switch as _mod_switch
1249
1228
        from bzrlib.tag import _merge_tags_if_possible
1250
 
        if self.invoked_as in ['get', 'clone']:
1251
 
            ui.ui_factory.show_user_warning(
1252
 
                'deprecated_command',
1253
 
                deprecated_name=self.invoked_as,
1254
 
                recommended_name='branch',
1255
 
                deprecated_in_version='2.4')
1256
1229
        accelerator_tree, br_from = bzrdir.BzrDir.open_tree_or_branch(
1257
1230
            from_location)
1258
 
        if not (hardlink or files_from):
1259
 
            # accelerator_tree is usually slower because you have to read N
1260
 
            # files (no readahead, lots of seeks, etc), but allow the user to
1261
 
            # explicitly request it
1262
 
            accelerator_tree = None
1263
 
        if files_from is not None and files_from != from_location:
1264
 
            accelerator_tree = WorkingTree.open(files_from)
1265
1231
        revision = _get_one_revision('branch', revision)
1266
 
        self.add_cleanup(br_from.lock_read().unlock)
 
1232
        br_from.lock_read()
 
1233
        self.add_cleanup(br_from.unlock)
1267
1234
        if revision is not None:
1268
1235
            revision_id = revision.as_revision_id(br_from)
1269
1236
        else:
1329
1296
 
1330
1297
 
1331
1298
class cmd_checkout(Command):
1332
 
    __doc__ = """Create a new checkout of an existing branch.
 
1299
    """Create a new checkout of an existing branch.
1333
1300
 
1334
1301
    If BRANCH_LOCATION is omitted, checkout will reconstitute a working tree for
1335
1302
    the branch found in '.'. This is useful if you have removed the working tree
1374
1341
            to_location = branch_location
1375
1342
        accelerator_tree, source = bzrdir.BzrDir.open_tree_or_branch(
1376
1343
            branch_location)
1377
 
        if not (hardlink or files_from):
1378
 
            # accelerator_tree is usually slower because you have to read N
1379
 
            # files (no readahead, lots of seeks, etc), but allow the user to
1380
 
            # explicitly request it
1381
 
            accelerator_tree = None
1382
1344
        revision = _get_one_revision('checkout', revision)
1383
 
        if files_from is not None and files_from != branch_location:
 
1345
        if files_from is not None:
1384
1346
            accelerator_tree = WorkingTree.open(files_from)
1385
1347
        if revision is not None:
1386
1348
            revision_id = revision.as_revision_id(source)
1403
1365
 
1404
1366
 
1405
1367
class cmd_renames(Command):
1406
 
    __doc__ = """Show list of renamed files.
 
1368
    """Show list of renamed files.
1407
1369
    """
1408
1370
    # TODO: Option to show renames between two historical versions.
1409
1371
 
1414
1376
    @display_command
1415
1377
    def run(self, dir=u'.'):
1416
1378
        tree = WorkingTree.open_containing(dir)[0]
1417
 
        self.add_cleanup(tree.lock_read().unlock)
 
1379
        tree.lock_read()
 
1380
        self.add_cleanup(tree.unlock)
1418
1381
        new_inv = tree.inventory
1419
1382
        old_tree = tree.basis_tree()
1420
 
        self.add_cleanup(old_tree.lock_read().unlock)
 
1383
        old_tree.lock_read()
 
1384
        self.add_cleanup(old_tree.unlock)
1421
1385
        old_inv = old_tree.inventory
1422
1386
        renames = []
1423
1387
        iterator = tree.iter_changes(old_tree, include_unchanged=True)
1433
1397
 
1434
1398
 
1435
1399
class cmd_update(Command):
1436
 
    __doc__ = """Update a tree to have the latest code committed to its branch.
 
1400
    """Update a tree to have the latest code committed to its branch.
1437
1401
 
1438
1402
    This will perform a merge into the working tree, and may generate
1439
1403
    conflicts. If you have any local changes, you will still
1442
1406
    If you want to discard your local changes, you can just do a
1443
1407
    'bzr revert' instead of 'bzr commit' after the update.
1444
1408
 
1445
 
    If you want to restore a file that has been removed locally, use
1446
 
    'bzr revert' instead of 'bzr update'.
1447
 
 
1448
1409
    If the tree's branch is bound to a master branch, it will also update
1449
1410
    the branch from the master.
1450
1411
    """
1451
1412
 
1452
1413
    _see_also = ['pull', 'working-trees', 'status-flags']
1453
1414
    takes_args = ['dir?']
1454
 
    takes_options = ['revision',
1455
 
                     Option('show-base',
1456
 
                            help="Show base revision text in conflicts."),
1457
 
                     ]
 
1415
    takes_options = ['revision']
1458
1416
    aliases = ['up']
1459
1417
 
1460
 
    def run(self, dir='.', revision=None, show_base=None):
 
1418
    def run(self, dir='.', revision=None):
1461
1419
        if revision is not None and len(revision) != 1:
1462
1420
            raise errors.BzrCommandError(
1463
1421
                        "bzr update --revision takes exactly one revision")
1467
1425
        master = branch.get_master_branch(
1468
1426
            possible_transports=possible_transports)
1469
1427
        if master is not None:
 
1428
            tree.lock_write()
1470
1429
            branch_location = master.base
1471
 
            tree.lock_write()
1472
1430
        else:
 
1431
            tree.lock_tree_write()
1473
1432
            branch_location = tree.branch.base
1474
 
            tree.lock_tree_write()
1475
1433
        self.add_cleanup(tree.unlock)
1476
1434
        # get rid of the final '/' and be ready for display
1477
1435
        branch_location = urlutils.unescape_for_display(
1490
1448
        else:
1491
1449
            revision_id = branch.last_revision()
1492
1450
        if revision_id == _mod_revision.ensure_null(tree.last_revision()):
1493
 
            revno = branch.revision_id_to_dotted_revno(revision_id)
1494
 
            note("Tree is up to date at revision %s of branch %s" %
1495
 
                ('.'.join(map(str, revno)), branch_location))
 
1451
            revno = branch.revision_id_to_revno(revision_id)
 
1452
            note("Tree is up to date at revision %d of branch %s" %
 
1453
                (revno, branch_location))
1496
1454
            return 0
1497
1455
        view_info = _get_view_info_for_change_reporter(tree)
1498
1456
        change_reporter = delta._ChangeReporter(
1503
1461
                change_reporter,
1504
1462
                possible_transports=possible_transports,
1505
1463
                revision=revision_id,
1506
 
                old_tip=old_tip,
1507
 
                show_base=show_base)
 
1464
                old_tip=old_tip)
1508
1465
        except errors.NoSuchRevision, e:
1509
1466
            raise errors.BzrCommandError(
1510
1467
                                  "branch has no revision %s\n"
1511
1468
                                  "bzr update --revision only works"
1512
1469
                                  " for a revision in the branch history"
1513
1470
                                  % (e.revision))
1514
 
        revno = tree.branch.revision_id_to_dotted_revno(
 
1471
        revno = tree.branch.revision_id_to_revno(
1515
1472
            _mod_revision.ensure_null(tree.last_revision()))
1516
 
        note('Updated to revision %s of branch %s' %
1517
 
             ('.'.join(map(str, revno)), branch_location))
1518
 
        parent_ids = tree.get_parent_ids()
1519
 
        if parent_ids[1:] and parent_ids[1:] != existing_pending_merges:
 
1473
        note('Updated to revision %d of branch %s' %
 
1474
             (revno, branch_location))
 
1475
        if tree.get_parent_ids()[1:] != existing_pending_merges:
1520
1476
            note('Your local commits will now show as pending merges with '
1521
1477
                 "'bzr status', and can be committed with 'bzr commit'.")
1522
1478
        if conflicts != 0:
1526
1482
 
1527
1483
 
1528
1484
class cmd_info(Command):
1529
 
    __doc__ = """Show information about a working tree, branch or repository.
 
1485
    """Show information about a working tree, branch or repository.
1530
1486
 
1531
1487
    This command will show all known locations and formats associated to the
1532
1488
    tree, branch or repository.
1570
1526
 
1571
1527
 
1572
1528
class cmd_remove(Command):
1573
 
    __doc__ = """Remove files or directories.
 
1529
    """Remove files or directories.
1574
1530
 
1575
 
    This makes Bazaar stop tracking changes to the specified files. Bazaar will
1576
 
    delete them if they can easily be recovered using revert otherwise they
1577
 
    will be backed up (adding an extention of the form .~#~). If no options or
1578
 
    parameters are given Bazaar will scan for files that are being tracked by
1579
 
    Bazaar but missing in your tree and stop tracking them for you.
 
1531
    This makes bzr stop tracking changes to the specified files. bzr will delete
 
1532
    them if they can easily be recovered using revert. If no options or
 
1533
    parameters are given bzr will scan for files that are being tracked by bzr
 
1534
    but missing in your tree and stop tracking them for you.
1580
1535
    """
1581
1536
    takes_args = ['file*']
1582
1537
    takes_options = ['verbose',
1584
1539
        RegistryOption.from_kwargs('file-deletion-strategy',
1585
1540
            'The file deletion mode to be used.',
1586
1541
            title='Deletion Strategy', value_switches=True, enum_switch=False,
1587
 
            safe='Backup changed files (default).',
 
1542
            safe='Only delete files if they can be'
 
1543
                 ' safely recovered (default).',
1588
1544
            keep='Delete from bzr but leave the working copy.',
1589
 
            no_backup='Don\'t backup changed files.',
1590
1545
            force='Delete all the specified files, even if they can not be '
1591
 
                'recovered and even if they are non-empty directories. '
1592
 
                '(deprecated, use no-backup)')]
 
1546
                'recovered and even if they are non-empty directories.')]
1593
1547
    aliases = ['rm', 'del']
1594
1548
    encoding_type = 'replace'
1595
1549
 
1596
1550
    def run(self, file_list, verbose=False, new=False,
1597
1551
        file_deletion_strategy='safe'):
1598
 
        if file_deletion_strategy == 'force':
1599
 
            note("(The --force option is deprecated, rather use --no-backup "
1600
 
                "in future.)")
1601
 
            file_deletion_strategy = 'no-backup'
1602
 
 
1603
 
        tree, file_list = WorkingTree.open_containing_paths(file_list)
 
1552
        tree, file_list = tree_files(file_list)
1604
1553
 
1605
1554
        if file_list is not None:
1606
1555
            file_list = [f for f in file_list]
1607
1556
 
1608
 
        self.add_cleanup(tree.lock_write().unlock)
 
1557
        tree.lock_write()
 
1558
        self.add_cleanup(tree.unlock)
1609
1559
        # Heuristics should probably all move into tree.remove_smart or
1610
1560
        # some such?
1611
1561
        if new:
1626
1576
            file_deletion_strategy = 'keep'
1627
1577
        tree.remove(file_list, verbose=verbose, to_file=self.outf,
1628
1578
            keep_files=file_deletion_strategy=='keep',
1629
 
            force=(file_deletion_strategy=='no-backup'))
 
1579
            force=file_deletion_strategy=='force')
1630
1580
 
1631
1581
 
1632
1582
class cmd_file_id(Command):
1633
 
    __doc__ = """Print file_id of a particular file or directory.
 
1583
    """Print file_id of a particular file or directory.
1634
1584
 
1635
1585
    The file_id is assigned when the file is first added and remains the
1636
1586
    same through all revisions where the file exists, even when it is
1652
1602
 
1653
1603
 
1654
1604
class cmd_file_path(Command):
1655
 
    __doc__ = """Print path of file_ids to a file or directory.
 
1605
    """Print path of file_ids to a file or directory.
1656
1606
 
1657
1607
    This prints one line for each directory down to the target,
1658
1608
    starting at the branch root.
1674
1624
 
1675
1625
 
1676
1626
class cmd_reconcile(Command):
1677
 
    __doc__ = """Reconcile bzr metadata in a branch.
 
1627
    """Reconcile bzr metadata in a branch.
1678
1628
 
1679
1629
    This can correct data mismatches that may have been caused by
1680
1630
    previous ghost operations or bzr upgrades. You should only
1694
1644
 
1695
1645
    _see_also = ['check']
1696
1646
    takes_args = ['branch?']
1697
 
    takes_options = [
1698
 
        Option('canonicalize-chks',
1699
 
               help='Make sure CHKs are in canonical form (repairs '
1700
 
                    'bug 522637).',
1701
 
               hidden=True),
1702
 
        ]
1703
1647
 
1704
 
    def run(self, branch=".", canonicalize_chks=False):
 
1648
    def run(self, branch="."):
1705
1649
        from bzrlib.reconcile import reconcile
1706
1650
        dir = bzrdir.BzrDir.open(branch)
1707
 
        reconcile(dir, canonicalize_chks=canonicalize_chks)
 
1651
        reconcile(dir)
1708
1652
 
1709
1653
 
1710
1654
class cmd_revision_history(Command):
1711
 
    __doc__ = """Display the list of revision ids on a branch."""
 
1655
    """Display the list of revision ids on a branch."""
1712
1656
 
1713
1657
    _see_also = ['log']
1714
1658
    takes_args = ['location?']
1724
1668
 
1725
1669
 
1726
1670
class cmd_ancestry(Command):
1727
 
    __doc__ = """List all revisions merged into this branch."""
 
1671
    """List all revisions merged into this branch."""
1728
1672
 
1729
1673
    _see_also = ['log', 'revision-history']
1730
1674
    takes_args = ['location?']
1742
1686
            b = wt.branch
1743
1687
            last_revision = wt.last_revision()
1744
1688
 
1745
 
        self.add_cleanup(b.repository.lock_read().unlock)
1746
 
        graph = b.repository.get_graph()
1747
 
        revisions = [revid for revid, parents in
1748
 
            graph.iter_ancestry([last_revision])]
1749
 
        for revision_id in reversed(revisions):
1750
 
            if _mod_revision.is_null(revision_id):
1751
 
                continue
 
1689
        revision_ids = b.repository.get_ancestry(last_revision)
 
1690
        revision_ids.pop(0)
 
1691
        for revision_id in revision_ids:
1752
1692
            self.outf.write(revision_id + '\n')
1753
1693
 
1754
1694
 
1755
1695
class cmd_init(Command):
1756
 
    __doc__ = """Make a directory into a versioned branch.
 
1696
    """Make a directory into a versioned branch.
1757
1697
 
1758
1698
    Use this to create an empty branch, or before importing an
1759
1699
    existing project.
1791
1731
                ),
1792
1732
         Option('append-revisions-only',
1793
1733
                help='Never change revnos or the existing log.'
1794
 
                '  Append revisions to it only.'),
1795
 
         Option('no-tree',
1796
 
                'Create a branch without a working tree.')
 
1734
                '  Append revisions to it only.')
1797
1735
         ]
1798
1736
    def run(self, location=None, format=None, append_revisions_only=False,
1799
 
            create_prefix=False, no_tree=False):
 
1737
            create_prefix=False):
1800
1738
        if format is None:
1801
1739
            format = bzrdir.format_registry.make_bzrdir('default')
1802
1740
        if location is None:
1825
1763
        except errors.NotBranchError:
1826
1764
            # really a NotBzrDir error...
1827
1765
            create_branch = bzrdir.BzrDir.create_branch_convenience
1828
 
            if no_tree:
1829
 
                force_new_tree = False
1830
 
            else:
1831
 
                force_new_tree = None
1832
1766
            branch = create_branch(to_transport.base, format=format,
1833
 
                                   possible_transports=[to_transport],
1834
 
                                   force_new_tree=force_new_tree)
 
1767
                                   possible_transports=[to_transport])
1835
1768
            a_bzrdir = branch.bzrdir
1836
1769
        else:
1837
1770
            from bzrlib.transport.local import LocalTransport
1841
1774
                        raise errors.BranchExistsWithoutWorkingTree(location)
1842
1775
                raise errors.AlreadyBranchError(location)
1843
1776
            branch = a_bzrdir.create_branch()
1844
 
            if not no_tree:
1845
 
                a_bzrdir.create_workingtree()
 
1777
            a_bzrdir.create_workingtree()
1846
1778
        if append_revisions_only:
1847
1779
            try:
1848
1780
                branch.set_append_revisions_only(True)
1870
1802
 
1871
1803
 
1872
1804
class cmd_init_repository(Command):
1873
 
    __doc__ = """Create a shared repository for branches to share storage space.
 
1805
    """Create a shared repository for branches to share storage space.
1874
1806
 
1875
1807
    New branches created under the repository directory will store their
1876
1808
    revisions in the repository, not in the branch directory.  For branches
1930
1862
 
1931
1863
 
1932
1864
class cmd_diff(Command):
1933
 
    __doc__ = """Show differences in the working tree, between revisions or branches.
 
1865
    """Show differences in the working tree, between revisions or branches.
1934
1866
 
1935
1867
    If no arguments are given, all changes for the current tree are listed.
1936
1868
    If files are given, only the changes in those files are listed.
1942
1874
    "bzr diff -p1" is equivalent to "bzr diff --prefix old/:new/", and
1943
1875
    produces patches suitable for "patch -p1".
1944
1876
 
1945
 
    Note that when using the -r argument with a range of revisions, the
1946
 
    differences are computed between the two specified revisions.  That
1947
 
    is, the command does not show the changes introduced by the first 
1948
 
    revision in the range.  This differs from the interpretation of 
1949
 
    revision ranges used by "bzr log" which includes the first revision
1950
 
    in the range.
1951
 
 
1952
1877
    :Exit values:
1953
1878
        1 - changed
1954
1879
        2 - unrepresentable changes
1972
1897
 
1973
1898
            bzr diff -r1..3 xxx
1974
1899
 
1975
 
        The changes introduced by revision 2 (equivalent to -r1..2)::
1976
 
 
1977
 
            bzr diff -c2
1978
 
 
1979
 
        To see the changes introduced by revision X::
 
1900
        To see the changes introduced in revision X::
1980
1901
        
1981
1902
            bzr diff -cX
1982
1903
 
1986
1907
 
1987
1908
            bzr diff -r<chosen_parent>..X
1988
1909
 
1989
 
        The changes between the current revision and the previous revision
1990
 
        (equivalent to -c-1 and -r-2..-1)
 
1910
        The changes introduced by revision 2 (equivalent to -r1..2)::
1991
1911
 
1992
 
            bzr diff -r-2..
 
1912
            bzr diff -c2
1993
1913
 
1994
1914
        Show just the differences for file NEWS::
1995
1915
 
2010
1930
        Same as 'bzr diff' but prefix paths with old/ and new/::
2011
1931
 
2012
1932
            bzr diff --prefix old/:new/
2013
 
            
2014
 
        Show the differences using a custom diff program with options::
2015
 
        
2016
 
            bzr diff --using /usr/bin/diff --diff-options -wu
2017
1933
    """
2018
1934
    _see_also = ['status']
2019
1935
    takes_args = ['file*']
2039
1955
            type=unicode,
2040
1956
            ),
2041
1957
        RegistryOption('format',
2042
 
            short_name='F',
2043
1958
            help='Diff format to use.',
2044
1959
            lazy_registry=('bzrlib.diff', 'format_registry'),
2045
 
            title='Diff format'),
 
1960
            value_switches=False, title='Diff format'),
2046
1961
        ]
2047
1962
    aliases = ['di', 'dif']
2048
1963
    encoding_type = 'exact'
2050
1965
    @display_command
2051
1966
    def run(self, revision=None, file_list=None, diff_options=None,
2052
1967
            prefix=None, old=None, new=None, using=None, format=None):
2053
 
        from bzrlib.diff import (get_trees_and_branches_to_diff_locked,
 
1968
        from bzrlib.diff import (get_trees_and_branches_to_diff,
2054
1969
            show_diff_trees)
2055
1970
 
2056
1971
        if (prefix is None) or (prefix == '0'):
2077
1992
 
2078
1993
        (old_tree, new_tree,
2079
1994
         old_branch, new_branch,
2080
 
         specific_files, extra_trees) = get_trees_and_branches_to_diff_locked(
2081
 
            file_list, revision, old, new, self.add_cleanup, apply_view=True)
2082
 
        # GNU diff on Windows uses ANSI encoding for filenames
2083
 
        path_encoding = osutils.get_diff_header_encoding()
 
1995
         specific_files, extra_trees) = get_trees_and_branches_to_diff(
 
1996
            file_list, revision, old, new, apply_view=True)
2084
1997
        return show_diff_trees(old_tree, new_tree, sys.stdout,
2085
1998
                               specific_files=specific_files,
2086
1999
                               external_diff_options=diff_options,
2087
2000
                               old_label=old_label, new_label=new_label,
2088
 
                               extra_trees=extra_trees,
2089
 
                               path_encoding=path_encoding,
2090
 
                               using=using,
 
2001
                               extra_trees=extra_trees, using=using,
2091
2002
                               format_cls=format)
2092
2003
 
2093
2004
 
2094
2005
class cmd_deleted(Command):
2095
 
    __doc__ = """List files deleted in the working tree.
 
2006
    """List files deleted in the working tree.
2096
2007
    """
2097
2008
    # TODO: Show files deleted since a previous revision, or
2098
2009
    # between two revisions.
2101
2012
    # level of effort but possibly much less IO.  (Or possibly not,
2102
2013
    # if the directories are very large...)
2103
2014
    _see_also = ['status', 'ls']
2104
 
    takes_options = ['directory', 'show-ids']
 
2015
    takes_options = ['show-ids']
2105
2016
 
2106
2017
    @display_command
2107
 
    def run(self, show_ids=False, directory=u'.'):
2108
 
        tree = WorkingTree.open_containing(directory)[0]
2109
 
        self.add_cleanup(tree.lock_read().unlock)
 
2018
    def run(self, show_ids=False):
 
2019
        tree = WorkingTree.open_containing(u'.')[0]
 
2020
        tree.lock_read()
 
2021
        self.add_cleanup(tree.unlock)
2110
2022
        old = tree.basis_tree()
2111
 
        self.add_cleanup(old.lock_read().unlock)
 
2023
        old.lock_read()
 
2024
        self.add_cleanup(old.unlock)
2112
2025
        for path, ie in old.inventory.iter_entries():
2113
2026
            if not tree.has_id(ie.file_id):
2114
2027
                self.outf.write(path)
2119
2032
 
2120
2033
 
2121
2034
class cmd_modified(Command):
2122
 
    __doc__ = """List files modified in working tree.
 
2035
    """List files modified in working tree.
2123
2036
    """
2124
2037
 
2125
2038
    hidden = True
2126
2039
    _see_also = ['status', 'ls']
2127
 
    takes_options = ['directory', 'null']
 
2040
    takes_options = [
 
2041
            Option('null',
 
2042
                   help='Write an ascii NUL (\\0) separator '
 
2043
                   'between files rather than a newline.')
 
2044
            ]
2128
2045
 
2129
2046
    @display_command
2130
 
    def run(self, null=False, directory=u'.'):
2131
 
        tree = WorkingTree.open_containing(directory)[0]
2132
 
        self.add_cleanup(tree.lock_read().unlock)
 
2047
    def run(self, null=False):
 
2048
        tree = WorkingTree.open_containing(u'.')[0]
2133
2049
        td = tree.changes_from(tree.basis_tree())
2134
 
        self.cleanup_now()
2135
2050
        for path, id, kind, text_modified, meta_modified in td.modified:
2136
2051
            if null:
2137
2052
                self.outf.write(path + '\0')
2140
2055
 
2141
2056
 
2142
2057
class cmd_added(Command):
2143
 
    __doc__ = """List files added in working tree.
 
2058
    """List files added in working tree.
2144
2059
    """
2145
2060
 
2146
2061
    hidden = True
2147
2062
    _see_also = ['status', 'ls']
2148
 
    takes_options = ['directory', 'null']
 
2063
    takes_options = [
 
2064
            Option('null',
 
2065
                   help='Write an ascii NUL (\\0) separator '
 
2066
                   'between files rather than a newline.')
 
2067
            ]
2149
2068
 
2150
2069
    @display_command
2151
 
    def run(self, null=False, directory=u'.'):
2152
 
        wt = WorkingTree.open_containing(directory)[0]
2153
 
        self.add_cleanup(wt.lock_read().unlock)
 
2070
    def run(self, null=False):
 
2071
        wt = WorkingTree.open_containing(u'.')[0]
 
2072
        wt.lock_read()
 
2073
        self.add_cleanup(wt.unlock)
2154
2074
        basis = wt.basis_tree()
2155
 
        self.add_cleanup(basis.lock_read().unlock)
 
2075
        basis.lock_read()
 
2076
        self.add_cleanup(basis.unlock)
2156
2077
        basis_inv = basis.inventory
2157
2078
        inv = wt.inventory
2158
2079
        for file_id in inv:
2159
 
            if basis_inv.has_id(file_id):
 
2080
            if file_id in basis_inv:
2160
2081
                continue
2161
2082
            if inv.is_root(file_id) and len(basis_inv) == 0:
2162
2083
                continue
2163
2084
            path = inv.id2path(file_id)
2164
 
            if not os.access(osutils.pathjoin(wt.basedir, path), os.F_OK):
 
2085
            if not os.access(osutils.abspath(path), os.F_OK):
2165
2086
                continue
2166
2087
            if null:
2167
2088
                self.outf.write(path + '\0')
2170
2091
 
2171
2092
 
2172
2093
class cmd_root(Command):
2173
 
    __doc__ = """Show the tree root directory.
 
2094
    """Show the tree root directory.
2174
2095
 
2175
2096
    The root is the nearest enclosing directory with a .bzr control
2176
2097
    directory."""
2200
2121
 
2201
2122
 
2202
2123
class cmd_log(Command):
2203
 
    __doc__ = """Show historical log for a branch or subset of a branch.
 
2124
    """Show historical log for a branch or subset of a branch.
2204
2125
 
2205
2126
    log is bzr's default tool for exploring the history of a branch.
2206
2127
    The branch to use is taken from the first parameter. If no parameters
2367
2288
                   help='Show just the specified revision.'
2368
2289
                   ' See also "help revisionspec".'),
2369
2290
            'log-format',
2370
 
            RegistryOption('authors',
2371
 
                'What names to list as authors - first, all or committer.',
2372
 
                title='Authors',
2373
 
                lazy_registry=('bzrlib.log', 'author_list_registry'),
2374
 
            ),
2375
2291
            Option('levels',
2376
2292
                   short_name='n',
2377
2293
                   help='Number of levels to display - 0 for all, 1 for flat.',
2392
2308
                   help='Show changes made in each revision as a patch.'),
2393
2309
            Option('include-merges',
2394
2310
                   help='Show merged revisions like --levels 0 does.'),
2395
 
            Option('exclude-common-ancestry',
2396
 
                   help='Display only the revisions that are not part'
2397
 
                   ' of both ancestries (require -rX..Y)'
2398
 
                   ),
2399
 
            Option('signatures',
2400
 
                   help='Show digital signature validity'),
2401
2311
            ]
2402
2312
    encoding_type = 'replace'
2403
2313
 
2413
2323
            message=None,
2414
2324
            limit=None,
2415
2325
            show_diff=False,
2416
 
            include_merges=False,
2417
 
            authors=None,
2418
 
            exclude_common_ancestry=False,
2419
 
            signatures=False,
2420
 
            ):
 
2326
            include_merges=False):
2421
2327
        from bzrlib.log import (
2422
2328
            Logger,
2423
2329
            make_log_request_dict,
2424
2330
            _get_info_for_log_files,
2425
2331
            )
2426
2332
        direction = (forward and 'forward') or 'reverse'
2427
 
        if (exclude_common_ancestry
2428
 
            and (revision is None or len(revision) != 2)):
2429
 
            raise errors.BzrCommandError(
2430
 
                '--exclude-common-ancestry requires -r with two revisions')
2431
2333
        if include_merges:
2432
2334
            if levels is None:
2433
2335
                levels = 0
2449
2351
        if file_list:
2450
2352
            # find the file ids to log and check for directory filtering
2451
2353
            b, file_info_list, rev1, rev2 = _get_info_for_log_files(
2452
 
                revision, file_list, self.add_cleanup)
 
2354
                revision, file_list)
 
2355
            self.add_cleanup(b.unlock)
2453
2356
            for relpath, file_id, kind in file_info_list:
2454
2357
                if file_id is None:
2455
2358
                    raise errors.BzrCommandError(
2473
2376
                location = '.'
2474
2377
            dir, relpath = bzrdir.BzrDir.open_containing(location)
2475
2378
            b = dir.open_branch()
2476
 
            self.add_cleanup(b.lock_read().unlock)
 
2379
            b.lock_read()
 
2380
            self.add_cleanup(b.unlock)
2477
2381
            rev1, rev2 = _get_revision_range(revision, b, self.name())
2478
2382
 
2479
 
        if b.get_config().validate_signatures_in_log():
2480
 
            signatures = True
2481
 
 
2482
 
        if signatures:
2483
 
            if not gpg.GPGStrategy.verify_signatures_available():
2484
 
                raise errors.GpgmeNotInstalled(None)
2485
 
 
2486
2383
        # Decide on the type of delta & diff filtering to use
2487
2384
        # TODO: add an --all-files option to make this configurable & consistent
2488
2385
        if not verbose:
2506
2403
                        show_timezone=timezone,
2507
2404
                        delta_format=get_verbosity_level(),
2508
2405
                        levels=levels,
2509
 
                        show_advice=levels is None,
2510
 
                        author_list_handler=authors)
 
2406
                        show_advice=levels is None)
2511
2407
 
2512
2408
        # Choose the algorithm for doing the logging. It's annoying
2513
2409
        # having multiple code paths like this but necessary until
2532
2428
            direction=direction, specific_fileids=file_ids,
2533
2429
            start_revision=rev1, end_revision=rev2, limit=limit,
2534
2430
            message_search=message, delta_type=delta_type,
2535
 
            diff_type=diff_type, _match_using_deltas=match_using_deltas,
2536
 
            exclude_common_ancestry=exclude_common_ancestry,
2537
 
            signature=signatures
2538
 
            )
 
2431
            diff_type=diff_type, _match_using_deltas=match_using_deltas)
2539
2432
        Logger(b, rqst).show(lf)
2540
2433
 
2541
2434
 
2599
2492
 
2600
2493
 
2601
2494
class cmd_touching_revisions(Command):
2602
 
    __doc__ = """Return revision-ids which affected a particular file.
 
2495
    """Return revision-ids which affected a particular file.
2603
2496
 
2604
2497
    A more user-friendly interface is "bzr log FILE".
2605
2498
    """
2612
2505
        tree, relpath = WorkingTree.open_containing(filename)
2613
2506
        file_id = tree.path2id(relpath)
2614
2507
        b = tree.branch
2615
 
        self.add_cleanup(b.lock_read().unlock)
 
2508
        b.lock_read()
 
2509
        self.add_cleanup(b.unlock)
2616
2510
        touching_revs = log.find_touching_revisions(b, file_id)
2617
2511
        for revno, revision_id, what in touching_revs:
2618
2512
            self.outf.write("%6d %s\n" % (revno, what))
2619
2513
 
2620
2514
 
2621
2515
class cmd_ls(Command):
2622
 
    __doc__ = """List files in a tree.
 
2516
    """List files in a tree.
2623
2517
    """
2624
2518
 
2625
2519
    _see_also = ['status', 'cat']
2631
2525
                   help='Recurse into subdirectories.'),
2632
2526
            Option('from-root',
2633
2527
                   help='Print paths relative to the root of the branch.'),
2634
 
            Option('unknown', short_name='u',
2635
 
                help='Print unknown files.'),
 
2528
            Option('unknown', help='Print unknown files.'),
2636
2529
            Option('versioned', help='Print versioned files.',
2637
2530
                   short_name='V'),
2638
 
            Option('ignored', short_name='i',
2639
 
                help='Print ignored files.'),
2640
 
            Option('kind', short_name='k',
 
2531
            Option('ignored', help='Print ignored files.'),
 
2532
            Option('null',
 
2533
                   help='Write an ascii NUL (\\0) separator '
 
2534
                   'between files rather than a newline.'),
 
2535
            Option('kind',
2641
2536
                   help='List entries of a particular kind: file, directory, symlink.',
2642
2537
                   type=unicode),
2643
 
            'null',
2644
2538
            'show-ids',
2645
 
            'directory',
2646
2539
            ]
2647
2540
    @display_command
2648
2541
    def run(self, revision=None, verbose=False,
2649
2542
            recursive=False, from_root=False,
2650
2543
            unknown=False, versioned=False, ignored=False,
2651
 
            null=False, kind=None, show_ids=False, path=None, directory=None):
 
2544
            null=False, kind=None, show_ids=False, path=None):
2652
2545
 
2653
2546
        if kind and kind not in ('file', 'directory', 'symlink'):
2654
2547
            raise errors.BzrCommandError('invalid kind specified')
2666
2559
                raise errors.BzrCommandError('cannot specify both --from-root'
2667
2560
                                             ' and PATH')
2668
2561
            fs_path = path
2669
 
        tree, branch, relpath = \
2670
 
            _open_directory_or_containing_tree_or_branch(fs_path, directory)
 
2562
        tree, branch, relpath = bzrdir.BzrDir.open_containing_tree_or_branch(
 
2563
            fs_path)
2671
2564
 
2672
2565
        # Calculate the prefix to use
2673
2566
        prefix = None
2688
2581
                view_str = views.view_display_str(view_files)
2689
2582
                note("Ignoring files outside view. View is %s" % view_str)
2690
2583
 
2691
 
        self.add_cleanup(tree.lock_read().unlock)
 
2584
        tree.lock_read()
 
2585
        self.add_cleanup(tree.unlock)
2692
2586
        for fp, fc, fkind, fid, entry in tree.list_files(include_root=False,
2693
2587
            from_dir=relpath, recursive=recursive):
2694
2588
            # Apply additional masking
2736
2630
 
2737
2631
 
2738
2632
class cmd_unknowns(Command):
2739
 
    __doc__ = """List unknown files.
 
2633
    """List unknown files.
2740
2634
    """
2741
2635
 
2742
2636
    hidden = True
2743
2637
    _see_also = ['ls']
2744
 
    takes_options = ['directory']
2745
2638
 
2746
2639
    @display_command
2747
 
    def run(self, directory=u'.'):
2748
 
        for f in WorkingTree.open_containing(directory)[0].unknowns():
 
2640
    def run(self):
 
2641
        for f in WorkingTree.open_containing(u'.')[0].unknowns():
2749
2642
            self.outf.write(osutils.quotefn(f) + '\n')
2750
2643
 
2751
2644
 
2752
2645
class cmd_ignore(Command):
2753
 
    __doc__ = """Ignore specified files or patterns.
 
2646
    """Ignore specified files or patterns.
2754
2647
 
2755
2648
    See ``bzr help patterns`` for details on the syntax of patterns.
2756
2649
 
2765
2658
    using this command or directly by using an editor, be sure to commit
2766
2659
    it.
2767
2660
    
2768
 
    Bazaar also supports a global ignore file ~/.bazaar/ignore. On Windows
2769
 
    the global ignore file can be found in the application data directory as
2770
 
    C:\\Documents and Settings\\<user>\\Application Data\\Bazaar\\2.0\\ignore.
2771
 
    Global ignores are not touched by this command. The global ignore file
2772
 
    can be edited directly using an editor.
2773
 
 
2774
2661
    Patterns prefixed with '!' are exceptions to ignore patterns and take
2775
2662
    precedence over regular ignores.  Such exceptions are used to specify
2776
2663
    files that should be versioned which would otherwise be ignored.
2778
2665
    Patterns prefixed with '!!' act as regular ignore patterns, but have
2779
2666
    precedence over the '!' exception patterns.
2780
2667
 
2781
 
    :Notes: 
2782
 
        
2783
 
    * Ignore patterns containing shell wildcards must be quoted from
2784
 
      the shell on Unix.
2785
 
 
2786
 
    * Ignore patterns starting with "#" act as comments in the ignore file.
2787
 
      To ignore patterns that begin with that character, use the "RE:" prefix.
 
2668
    Note: ignore patterns containing shell wildcards must be quoted from
 
2669
    the shell on Unix.
2788
2670
 
2789
2671
    :Examples:
2790
2672
        Ignore the top level Makefile::
2799
2681
 
2800
2682
            bzr ignore "!special.class"
2801
2683
 
2802
 
        Ignore files whose name begins with the "#" character::
2803
 
 
2804
 
            bzr ignore "RE:^#"
2805
 
 
2806
2684
        Ignore .o files under the lib directory::
2807
2685
 
2808
2686
            bzr ignore "lib/**/*.o"
2816
2694
            bzr ignore "RE:(?!debian/).*"
2817
2695
        
2818
2696
        Ignore everything except the "local" toplevel directory,
2819
 
        but always ignore autosave files ending in ~, even under local/::
 
2697
        but always ignore "*~" autosave files, even under local/::
2820
2698
        
2821
2699
            bzr ignore "*"
2822
2700
            bzr ignore "!./local"
2825
2703
 
2826
2704
    _see_also = ['status', 'ignored', 'patterns']
2827
2705
    takes_args = ['name_pattern*']
2828
 
    takes_options = ['directory',
2829
 
        Option('default-rules',
2830
 
               help='Display the default ignore rules that bzr uses.')
 
2706
    takes_options = [
 
2707
        Option('old-default-rules',
 
2708
               help='Write out the ignore rules bzr < 0.9 always used.')
2831
2709
        ]
2832
2710
 
2833
 
    def run(self, name_pattern_list=None, default_rules=None,
2834
 
            directory=u'.'):
 
2711
    def run(self, name_pattern_list=None, old_default_rules=None):
2835
2712
        from bzrlib import ignores
2836
 
        if default_rules is not None:
2837
 
            # dump the default rules and exit
2838
 
            for pattern in ignores.USER_DEFAULTS:
 
2713
        if old_default_rules is not None:
 
2714
            # dump the rules and exit
 
2715
            for pattern in ignores.OLD_DEFAULTS:
2839
2716
                self.outf.write("%s\n" % pattern)
2840
2717
            return
2841
2718
        if not name_pattern_list:
2842
2719
            raise errors.BzrCommandError("ignore requires at least one "
2843
 
                "NAME_PATTERN or --default-rules.")
 
2720
                                  "NAME_PATTERN or --old-default-rules")
2844
2721
        name_pattern_list = [globbing.normalize_pattern(p)
2845
2722
                             for p in name_pattern_list]
2846
 
        bad_patterns = ''
2847
 
        for p in name_pattern_list:
2848
 
            if not globbing.Globster.is_pattern_valid(p):
2849
 
                bad_patterns += ('\n  %s' % p)
2850
 
        if bad_patterns:
2851
 
            msg = ('Invalid ignore pattern(s) found. %s' % bad_patterns)
2852
 
            ui.ui_factory.show_error(msg)
2853
 
            raise errors.InvalidPattern('')
2854
2723
        for name_pattern in name_pattern_list:
2855
2724
            if (name_pattern[0] == '/' or
2856
2725
                (len(name_pattern) > 1 and name_pattern[1] == ':')):
2857
2726
                raise errors.BzrCommandError(
2858
2727
                    "NAME_PATTERN should not be an absolute path")
2859
 
        tree, relpath = WorkingTree.open_containing(directory)
 
2728
        tree, relpath = WorkingTree.open_containing(u'.')
2860
2729
        ignores.tree_ignores_add_patterns(tree, name_pattern_list)
2861
2730
        ignored = globbing.Globster(name_pattern_list)
2862
2731
        matches = []
2863
 
        self.add_cleanup(tree.lock_read().unlock)
 
2732
        tree.lock_read()
2864
2733
        for entry in tree.list_files():
2865
2734
            id = entry[3]
2866
2735
            if id is not None:
2867
2736
                filename = entry[0]
2868
2737
                if ignored.match(filename):
2869
2738
                    matches.append(filename)
 
2739
        tree.unlock()
2870
2740
        if len(matches) > 0:
2871
2741
            self.outf.write("Warning: the following files are version controlled and"
2872
2742
                  " match your ignore pattern:\n%s"
2875
2745
 
2876
2746
 
2877
2747
class cmd_ignored(Command):
2878
 
    __doc__ = """List ignored files and the patterns that matched them.
 
2748
    """List ignored files and the patterns that matched them.
2879
2749
 
2880
2750
    List all the ignored files and the ignore pattern that caused the file to
2881
2751
    be ignored.
2887
2757
 
2888
2758
    encoding_type = 'replace'
2889
2759
    _see_also = ['ignore', 'ls']
2890
 
    takes_options = ['directory']
2891
2760
 
2892
2761
    @display_command
2893
 
    def run(self, directory=u'.'):
2894
 
        tree = WorkingTree.open_containing(directory)[0]
2895
 
        self.add_cleanup(tree.lock_read().unlock)
 
2762
    def run(self):
 
2763
        tree = WorkingTree.open_containing(u'.')[0]
 
2764
        tree.lock_read()
 
2765
        self.add_cleanup(tree.unlock)
2896
2766
        for path, file_class, kind, file_id, entry in tree.list_files():
2897
2767
            if file_class != 'I':
2898
2768
                continue
2902
2772
 
2903
2773
 
2904
2774
class cmd_lookup_revision(Command):
2905
 
    __doc__ = """Lookup the revision-id from a revision-number
 
2775
    """Lookup the revision-id from a revision-number
2906
2776
 
2907
2777
    :Examples:
2908
2778
        bzr lookup-revision 33
2909
2779
    """
2910
2780
    hidden = True
2911
2781
    takes_args = ['revno']
2912
 
    takes_options = ['directory']
2913
2782
 
2914
2783
    @display_command
2915
 
    def run(self, revno, directory=u'.'):
 
2784
    def run(self, revno):
2916
2785
        try:
2917
2786
            revno = int(revno)
2918
2787
        except ValueError:
2919
2788
            raise errors.BzrCommandError("not a valid revision-number: %r"
2920
2789
                                         % revno)
2921
 
        revid = WorkingTree.open_containing(directory)[0].branch.get_rev_id(revno)
 
2790
        revid = WorkingTree.open_containing(u'.')[0].branch.get_rev_id(revno)
2922
2791
        self.outf.write("%s\n" % revid)
2923
2792
 
2924
2793
 
2925
2794
class cmd_export(Command):
2926
 
    __doc__ = """Export current or past revision to a destination directory or archive.
 
2795
    """Export current or past revision to a destination directory or archive.
2927
2796
 
2928
2797
    If no revision is specified this exports the last committed revision.
2929
2798
 
2950
2819
         zip                          .zip
2951
2820
      =================       =========================
2952
2821
    """
2953
 
    encoding = 'exact'
2954
2822
    takes_args = ['dest', 'branch_or_subdir?']
2955
 
    takes_options = ['directory',
 
2823
    takes_options = [
2956
2824
        Option('format',
2957
2825
               help="Type of file to export to.",
2958
2826
               type=unicode),
2967
2835
                    'revision in which it was changed.'),
2968
2836
        ]
2969
2837
    def run(self, dest, branch_or_subdir=None, revision=None, format=None,
2970
 
        root=None, filters=False, per_file_timestamps=False, directory=u'.'):
 
2838
        root=None, filters=False, per_file_timestamps=False):
2971
2839
        from bzrlib.export import export
2972
2840
 
2973
2841
        if branch_or_subdir is None:
2974
 
            tree = WorkingTree.open_containing(directory)[0]
 
2842
            tree = WorkingTree.open_containing(u'.')[0]
2975
2843
            b = tree.branch
2976
2844
            subdir = None
2977
2845
        else:
2987
2855
 
2988
2856
 
2989
2857
class cmd_cat(Command):
2990
 
    __doc__ = """Write the contents of a file as of a given revision to standard output.
 
2858
    """Write the contents of a file as of a given revision to standard output.
2991
2859
 
2992
2860
    If no revision is nominated, the last revision is used.
2993
2861
 
2996
2864
    """
2997
2865
 
2998
2866
    _see_also = ['ls']
2999
 
    takes_options = ['directory',
 
2867
    takes_options = [
3000
2868
        Option('name-from-revision', help='The path name in the old tree.'),
3001
2869
        Option('filters', help='Apply content filters to display the '
3002
2870
                'convenience form.'),
3007
2875
 
3008
2876
    @display_command
3009
2877
    def run(self, filename, revision=None, name_from_revision=False,
3010
 
            filters=False, directory=None):
 
2878
            filters=False):
3011
2879
        if revision is not None and len(revision) != 1:
3012
2880
            raise errors.BzrCommandError("bzr cat --revision takes exactly"
3013
2881
                                         " one revision specifier")
3014
2882
        tree, branch, relpath = \
3015
 
            _open_directory_or_containing_tree_or_branch(filename, directory)
3016
 
        self.add_cleanup(branch.lock_read().unlock)
 
2883
            bzrdir.BzrDir.open_containing_tree_or_branch(filename)
 
2884
        branch.lock_read()
 
2885
        self.add_cleanup(branch.unlock)
3017
2886
        return self._run(tree, branch, relpath, filename, revision,
3018
2887
                         name_from_revision, filters)
3019
2888
 
3022
2891
        if tree is None:
3023
2892
            tree = b.basis_tree()
3024
2893
        rev_tree = _get_one_revision_tree('cat', revision, branch=b)
3025
 
        self.add_cleanup(rev_tree.lock_read().unlock)
 
2894
        rev_tree.lock_read()
 
2895
        self.add_cleanup(rev_tree.unlock)
3026
2896
 
3027
2897
        old_file_id = rev_tree.path2id(relpath)
3028
2898
 
3071
2941
 
3072
2942
 
3073
2943
class cmd_local_time_offset(Command):
3074
 
    __doc__ = """Show the offset in seconds from GMT to local time."""
 
2944
    """Show the offset in seconds from GMT to local time."""
3075
2945
    hidden = True
3076
2946
    @display_command
3077
2947
    def run(self):
3080
2950
 
3081
2951
 
3082
2952
class cmd_commit(Command):
3083
 
    __doc__ = """Commit changes into a new revision.
 
2953
    """Commit changes into a new revision.
3084
2954
 
3085
2955
    An explanatory message needs to be given for each commit. This is
3086
2956
    often done by using the --message option (getting the message from the
3134
3004
      to trigger updates to external systems like bug trackers. The --fixes
3135
3005
      option can be used to record the association between a revision and
3136
3006
      one or more bugs. See ``bzr help bugs`` for details.
 
3007
 
 
3008
      A selective commit may fail in some cases where the committed
 
3009
      tree would be invalid. Consider::
 
3010
  
 
3011
        bzr init foo
 
3012
        mkdir foo/bar
 
3013
        bzr add foo/bar
 
3014
        bzr commit foo -m "committing foo"
 
3015
        bzr mv foo/bar foo/baz
 
3016
        mkdir foo/bar
 
3017
        bzr add foo/bar
 
3018
        bzr commit foo/bar -m "committing bar but not baz"
 
3019
  
 
3020
      In the example above, the last commit will fail by design. This gives
 
3021
      the user the opportunity to decide whether they want to commit the
 
3022
      rename at the same time, separately first, or not at all. (As a general
 
3023
      rule, when in doubt, Bazaar has a policy of Doing the Safe Thing.)
3137
3024
    """
 
3025
    # TODO: Run hooks on tree to-be-committed, and after commit.
 
3026
 
 
3027
    # TODO: Strict commit that fails if there are deleted files.
 
3028
    #       (what does "deleted files" mean ??)
 
3029
 
 
3030
    # TODO: Give better message for -s, --summary, used by tla people
 
3031
 
 
3032
    # XXX: verbose currently does nothing
3138
3033
 
3139
3034
    _see_also = ['add', 'bugs', 'hooks', 'uncommit']
3140
3035
    takes_args = ['selected*']
3169
3064
                         "the master branch until a normal commit "
3170
3065
                         "is performed."
3171
3066
                    ),
3172
 
             Option('show-diff', short_name='p',
 
3067
             Option('show-diff',
3173
3068
                    help='When no message is supplied, show the diff along'
3174
3069
                    ' with the status summary in the message editor.'),
3175
 
             Option('lossy', 
3176
 
                    help='When committing to a foreign version control '
3177
 
                    'system do not push data that can not be natively '
3178
 
                    'represented.'),
3179
3070
             ]
3180
3071
    aliases = ['ci', 'checkin']
3181
3072
 
3200
3091
 
3201
3092
    def run(self, message=None, file=None, verbose=False, selected_list=None,
3202
3093
            unchanged=False, strict=False, local=False, fixes=None,
3203
 
            author=None, show_diff=False, exclude=None, commit_time=None,
3204
 
            lossy=False):
 
3094
            author=None, show_diff=False, exclude=None, commit_time=None):
3205
3095
        from bzrlib.errors import (
3206
3096
            PointlessCommit,
3207
3097
            ConflictsInTree,
3210
3100
        from bzrlib.msgeditor import (
3211
3101
            edit_commit_message_encoded,
3212
3102
            generate_commit_message_template,
3213
 
            make_commit_message_template_encoded,
3214
 
            set_commit_message,
 
3103
            make_commit_message_template_encoded
3215
3104
        )
3216
3105
 
3217
3106
        commit_stamp = offset = None
3222
3111
                raise errors.BzrCommandError(
3223
3112
                    "Could not parse --commit-time: " + str(e))
3224
3113
 
 
3114
        # TODO: Need a blackbox test for invoking the external editor; may be
 
3115
        # slightly problematic to run this cross-platform.
 
3116
 
 
3117
        # TODO: do more checks that the commit will succeed before
 
3118
        # spending the user's valuable time typing a commit message.
 
3119
 
3225
3120
        properties = {}
3226
3121
 
3227
 
        tree, selected_list = WorkingTree.open_containing_paths(selected_list)
 
3122
        tree, selected_list = tree_files(selected_list)
3228
3123
        if selected_list == ['']:
3229
3124
            # workaround - commit of root of tree should be exactly the same
3230
3125
            # as just default commit in that tree, and succeed even though
3255
3150
                    '(use --file "%(f)s" to take commit message from that file)'
3256
3151
                    % { 'f': message })
3257
3152
                ui.ui_factory.show_warning(warning_msg)
3258
 
            if '\r' in message:
3259
 
                message = message.replace('\r\n', '\n')
3260
 
                message = message.replace('\r', '\n')
3261
 
            if file:
3262
 
                raise errors.BzrCommandError(
3263
 
                    "please specify either --message or --file")
3264
3153
 
3265
3154
        def get_message(commit_obj):
3266
3155
            """Callback to get commit message"""
3267
 
            if file:
3268
 
                f = open(file)
3269
 
                try:
3270
 
                    my_message = f.read().decode(osutils.get_user_encoding())
3271
 
                finally:
3272
 
                    f.close()
3273
 
            elif message is not None:
3274
 
                my_message = message
3275
 
            else:
3276
 
                # No message supplied: make one up.
3277
 
                # text is the status of the tree
3278
 
                text = make_commit_message_template_encoded(tree,
 
3156
            my_message = message
 
3157
            if my_message is not None and '\r' in my_message:
 
3158
                my_message = my_message.replace('\r\n', '\n')
 
3159
                my_message = my_message.replace('\r', '\n')
 
3160
            if my_message is None and not file:
 
3161
                t = make_commit_message_template_encoded(tree,
3279
3162
                        selected_list, diff=show_diff,
3280
3163
                        output_encoding=osutils.get_user_encoding())
3281
 
                # start_message is the template generated from hooks
3282
 
                # XXX: Warning - looks like hooks return unicode,
3283
 
                # make_commit_message_template_encoded returns user encoding.
3284
 
                # We probably want to be using edit_commit_message instead to
3285
 
                # avoid this.
3286
 
                my_message = set_commit_message(commit_obj)
3287
 
                if my_message is None:
3288
 
                    start_message = generate_commit_message_template(commit_obj)
3289
 
                    my_message = edit_commit_message_encoded(text,
3290
 
                        start_message=start_message)
 
3164
                start_message = generate_commit_message_template(commit_obj)
 
3165
                my_message = edit_commit_message_encoded(t,
 
3166
                    start_message=start_message)
3291
3167
                if my_message is None:
3292
3168
                    raise errors.BzrCommandError("please specify a commit"
3293
3169
                        " message with either --message or --file")
 
3170
            elif my_message and file:
 
3171
                raise errors.BzrCommandError(
 
3172
                    "please specify either --message or --file")
 
3173
            if file:
 
3174
                my_message = codecs.open(file, 'rt',
 
3175
                                         osutils.get_user_encoding()).read()
3294
3176
            if my_message == "":
3295
3177
                raise errors.BzrCommandError("empty commit message specified")
3296
3178
            return my_message
3306
3188
                        reporter=None, verbose=verbose, revprops=properties,
3307
3189
                        authors=author, timestamp=commit_stamp,
3308
3190
                        timezone=offset,
3309
 
                        exclude=tree.safe_relpath_files(exclude),
3310
 
                        lossy=lossy)
 
3191
                        exclude=safe_relpath_files(tree, exclude))
3311
3192
        except PointlessCommit:
 
3193
            # FIXME: This should really happen before the file is read in;
 
3194
            # perhaps prepare the commit; get the message; then actually commit
3312
3195
            raise errors.BzrCommandError("No changes to commit."
3313
 
                " Please 'bzr add' the files you want to commit, or use"
3314
 
                " --unchanged to force an empty commit.")
 
3196
                              " Use --unchanged to commit anyhow.")
3315
3197
        except ConflictsInTree:
3316
3198
            raise errors.BzrCommandError('Conflicts detected in working '
3317
3199
                'tree.  Use "bzr conflicts" to list, "bzr resolve FILE" to'
3328
3210
 
3329
3211
 
3330
3212
class cmd_check(Command):
3331
 
    __doc__ = """Validate working tree structure, branch consistency and repository history.
 
3213
    """Validate working tree structure, branch consistency and repository history.
3332
3214
 
3333
3215
    This command checks various invariants about branch and repository storage
3334
3216
    to detect data corruption or bzr bugs.
3398
3280
 
3399
3281
 
3400
3282
class cmd_upgrade(Command):
3401
 
    __doc__ = """Upgrade a repository, branch or working tree to a newer format.
3402
 
 
3403
 
    When the default format has changed after a major new release of
3404
 
    Bazaar, you may be informed during certain operations that you
3405
 
    should upgrade. Upgrading to a newer format may improve performance
3406
 
    or make new features available. It may however limit interoperability
3407
 
    with older repositories or with older versions of Bazaar.
3408
 
 
3409
 
    If you wish to upgrade to a particular format rather than the
3410
 
    current default, that can be specified using the --format option.
3411
 
    As a consequence, you can use the upgrade command this way to
3412
 
    "downgrade" to an earlier format, though some conversions are
3413
 
    a one way process (e.g. changing from the 1.x default to the
3414
 
    2.x default) so downgrading is not always possible.
3415
 
 
3416
 
    A backup.bzr.~#~ directory is created at the start of the conversion
3417
 
    process (where # is a number). By default, this is left there on
3418
 
    completion. If the conversion fails, delete the new .bzr directory
3419
 
    and rename this one back in its place. Use the --clean option to ask
3420
 
    for the backup.bzr directory to be removed on successful conversion.
3421
 
    Alternatively, you can delete it by hand if everything looks good
3422
 
    afterwards.
3423
 
 
3424
 
    If the location given is a shared repository, dependent branches
3425
 
    are also converted provided the repository converts successfully.
3426
 
    If the conversion of a branch fails, remaining branches are still
3427
 
    tried.
3428
 
 
3429
 
    For more information on upgrades, see the Bazaar Upgrade Guide,
3430
 
    http://doc.bazaar.canonical.com/latest/en/upgrade-guide/.
 
3283
    """Upgrade branch storage to current format.
 
3284
 
 
3285
    The check command or bzr developers may sometimes advise you to run
 
3286
    this command. When the default format has changed you may also be warned
 
3287
    during other operations to upgrade.
3431
3288
    """
3432
3289
 
3433
 
    _see_also = ['check', 'reconcile', 'formats']
 
3290
    _see_also = ['check']
3434
3291
    takes_args = ['url?']
3435
3292
    takes_options = [
3436
 
        RegistryOption('format',
3437
 
            help='Upgrade to a specific format.  See "bzr help'
3438
 
                 ' formats" for details.',
3439
 
            lazy_registry=('bzrlib.bzrdir', 'format_registry'),
3440
 
            converter=lambda name: bzrdir.format_registry.make_bzrdir(name),
3441
 
            value_switches=True, title='Branch format'),
3442
 
        Option('clean',
3443
 
            help='Remove the backup.bzr directory if successful.'),
3444
 
        Option('dry-run',
3445
 
            help="Show what would be done, but don't actually do anything."),
3446
 
    ]
 
3293
                    RegistryOption('format',
 
3294
                        help='Upgrade to a specific format.  See "bzr help'
 
3295
                             ' formats" for details.',
 
3296
                        lazy_registry=('bzrlib.bzrdir', 'format_registry'),
 
3297
                        converter=lambda name: bzrdir.format_registry.make_bzrdir(name),
 
3298
                        value_switches=True, title='Branch format'),
 
3299
                    ]
3447
3300
 
3448
 
    def run(self, url='.', format=None, clean=False, dry_run=False):
 
3301
    def run(self, url='.', format=None):
3449
3302
        from bzrlib.upgrade import upgrade
3450
 
        exceptions = upgrade(url, format, clean_up=clean, dry_run=dry_run)
3451
 
        if exceptions:
3452
 
            if len(exceptions) == 1:
3453
 
                # Compatibility with historical behavior
3454
 
                raise exceptions[0]
3455
 
            else:
3456
 
                return 3
 
3303
        upgrade(url, format)
3457
3304
 
3458
3305
 
3459
3306
class cmd_whoami(Command):
3460
 
    __doc__ = """Show or set bzr user id.
 
3307
    """Show or set bzr user id.
3461
3308
 
3462
3309
    :Examples:
3463
3310
        Show the email of the current user::
3468
3315
 
3469
3316
            bzr whoami "Frank Chu <fchu@example.com>"
3470
3317
    """
3471
 
    takes_options = [ 'directory',
3472
 
                      Option('email',
 
3318
    takes_options = [ Option('email',
3473
3319
                             help='Display email address only.'),
3474
3320
                      Option('branch',
3475
3321
                             help='Set identity for the current branch instead of '
3479
3325
    encoding_type = 'replace'
3480
3326
 
3481
3327
    @display_command
3482
 
    def run(self, email=False, branch=False, name=None, directory=None):
 
3328
    def run(self, email=False, branch=False, name=None):
3483
3329
        if name is None:
3484
 
            if directory is None:
3485
 
                # use branch if we're inside one; otherwise global config
3486
 
                try:
3487
 
                    c = Branch.open_containing(u'.')[0].get_config()
3488
 
                except errors.NotBranchError:
3489
 
                    c = _mod_config.GlobalConfig()
3490
 
            else:
3491
 
                c = Branch.open(directory).get_config()
 
3330
            # use branch if we're inside one; otherwise global config
 
3331
            try:
 
3332
                c = Branch.open_containing('.')[0].get_config()
 
3333
            except errors.NotBranchError:
 
3334
                c = config.GlobalConfig()
3492
3335
            if email:
3493
3336
                self.outf.write(c.user_email() + '\n')
3494
3337
            else:
3495
3338
                self.outf.write(c.username() + '\n')
3496
3339
            return
3497
3340
 
3498
 
        if email:
3499
 
            raise errors.BzrCommandError("--email can only be used to display existing "
3500
 
                                         "identity")
3501
 
 
3502
3341
        # display a warning if an email address isn't included in the given name.
3503
3342
        try:
3504
 
            _mod_config.extract_email_address(name)
 
3343
            config.extract_email_address(name)
3505
3344
        except errors.NoEmailInUsername, e:
3506
3345
            warning('"%s" does not seem to contain an email address.  '
3507
3346
                    'This is allowed, but not recommended.', name)
3508
3347
 
3509
3348
        # use global config unless --branch given
3510
3349
        if branch:
3511
 
            if directory is None:
3512
 
                c = Branch.open_containing(u'.')[0].get_config()
3513
 
            else:
3514
 
                c = Branch.open(directory).get_config()
 
3350
            c = Branch.open_containing('.')[0].get_config()
3515
3351
        else:
3516
 
            c = _mod_config.GlobalConfig()
 
3352
            c = config.GlobalConfig()
3517
3353
        c.set_user_option('email', name)
3518
3354
 
3519
3355
 
3520
3356
class cmd_nick(Command):
3521
 
    __doc__ = """Print or set the branch nickname.
 
3357
    """Print or set the branch nickname.
3522
3358
 
3523
3359
    If unset, the tree root directory name is used as the nickname.
3524
3360
    To print the current nickname, execute with no argument.
3529
3365
 
3530
3366
    _see_also = ['info']
3531
3367
    takes_args = ['nickname?']
3532
 
    takes_options = ['directory']
3533
 
    def run(self, nickname=None, directory=u'.'):
3534
 
        branch = Branch.open_containing(directory)[0]
 
3368
    def run(self, nickname=None):
 
3369
        branch = Branch.open_containing(u'.')[0]
3535
3370
        if nickname is None:
3536
3371
            self.printme(branch)
3537
3372
        else:
3543
3378
 
3544
3379
 
3545
3380
class cmd_alias(Command):
3546
 
    __doc__ = """Set/unset and display aliases.
 
3381
    """Set/unset and display aliases.
3547
3382
 
3548
3383
    :Examples:
3549
3384
        Show the current aliases::
3586
3421
                'bzr alias --remove expects an alias to remove.')
3587
3422
        # If alias is not found, print something like:
3588
3423
        # unalias: foo: not found
3589
 
        c = _mod_config.GlobalConfig()
 
3424
        c = config.GlobalConfig()
3590
3425
        c.unset_alias(alias_name)
3591
3426
 
3592
3427
    @display_command
3593
3428
    def print_aliases(self):
3594
3429
        """Print out the defined aliases in a similar format to bash."""
3595
 
        aliases = _mod_config.GlobalConfig().get_aliases()
 
3430
        aliases = config.GlobalConfig().get_aliases()
3596
3431
        for key, value in sorted(aliases.iteritems()):
3597
3432
            self.outf.write('bzr alias %s="%s"\n' % (key, value))
3598
3433
 
3608
3443
 
3609
3444
    def set_alias(self, alias_name, alias_command):
3610
3445
        """Save the alias in the global config."""
3611
 
        c = _mod_config.GlobalConfig()
 
3446
        c = config.GlobalConfig()
3612
3447
        c.set_alias(alias_name, alias_command)
3613
3448
 
3614
3449
 
3615
3450
class cmd_selftest(Command):
3616
 
    __doc__ = """Run internal test suite.
 
3451
    """Run internal test suite.
3617
3452
 
3618
3453
    If arguments are given, they are regular expressions that say which tests
3619
3454
    should run.  Tests matching any expression are run, and other tests are
3649
3484
    If you set BZR_TEST_PDB=1 when running selftest, failing tests will drop
3650
3485
    into a pdb postmortem session.
3651
3486
 
3652
 
    The --coverage=DIRNAME global option produces a report with covered code
3653
 
    indicated.
3654
 
 
3655
3487
    :Examples:
3656
3488
        Run only tests relating to 'ignore'::
3657
3489
 
3668
3500
        if typestring == "sftp":
3669
3501
            from bzrlib.tests import stub_sftp
3670
3502
            return stub_sftp.SFTPAbsoluteServer
3671
 
        elif typestring == "memory":
 
3503
        if typestring == "memory":
3672
3504
            from bzrlib.tests import test_server
3673
3505
            return memory.MemoryServer
3674
 
        elif typestring == "fakenfs":
 
3506
        if typestring == "fakenfs":
3675
3507
            from bzrlib.tests import test_server
3676
3508
            return test_server.FakeNFSServer
3677
3509
        msg = "No known transport type %s. Supported types are: sftp\n" %\
3690
3522
                                 'throughout the test suite.',
3691
3523
                            type=get_transport_type),
3692
3524
                     Option('benchmark',
3693
 
                            help='Run the benchmarks rather than selftests.',
3694
 
                            hidden=True),
 
3525
                            help='Run the benchmarks rather than selftests.'),
3695
3526
                     Option('lsprof-timed',
3696
3527
                            help='Generate lsprof output for benchmarked'
3697
3528
                                 ' sections of code.'),
3698
3529
                     Option('lsprof-tests',
3699
3530
                            help='Generate lsprof output for each test.'),
 
3531
                     Option('cache-dir', type=str,
 
3532
                            help='Cache intermediate benchmark output in this '
 
3533
                                 'directory.'),
3700
3534
                     Option('first',
3701
3535
                            help='Run all tests, but run specified tests first.',
3702
3536
                            short_name='f',
3711
3545
                     Option('randomize', type=str, argname="SEED",
3712
3546
                            help='Randomize the order of tests using the given'
3713
3547
                                 ' seed or "now" for the current time.'),
3714
 
                     ListOption('exclude', type=str, argname="PATTERN",
3715
 
                                short_name='x',
3716
 
                                help='Exclude tests that match this regular'
3717
 
                                ' expression.'),
 
3548
                     Option('exclude', type=str, argname="PATTERN",
 
3549
                            short_name='x',
 
3550
                            help='Exclude tests that match this regular'
 
3551
                                 ' expression.'),
3718
3552
                     Option('subunit',
3719
3553
                        help='Output test progress via subunit.'),
3720
3554
                     Option('strict', help='Fail on missing dependencies or '
3736
3570
 
3737
3571
    def run(self, testspecs_list=None, verbose=False, one=False,
3738
3572
            transport=None, benchmark=None,
3739
 
            lsprof_timed=None,
 
3573
            lsprof_timed=None, cache_dir=None,
3740
3574
            first=False, list_only=False,
3741
3575
            randomize=None, exclude=None, strict=False,
3742
3576
            load_list=None, debugflag=None, starting_with=None, subunit=False,
3743
3577
            parallel=None, lsprof_tests=False):
3744
 
        from bzrlib import tests
3745
 
 
 
3578
        from bzrlib.tests import selftest
 
3579
        import bzrlib.benchmarks as benchmarks
 
3580
        from bzrlib.benchmarks import tree_creator
 
3581
 
 
3582
        # Make deprecation warnings visible, unless -Werror is set
 
3583
        symbol_versioning.activate_deprecation_warnings(override=False)
 
3584
 
 
3585
        if cache_dir is not None:
 
3586
            tree_creator.TreeCreator.CACHE_ROOT = osutils.abspath(cache_dir)
3746
3587
        if testspecs_list is not None:
3747
3588
            pattern = '|'.join(testspecs_list)
3748
3589
        else:
3754
3595
                raise errors.BzrCommandError("subunit not available. subunit "
3755
3596
                    "needs to be installed to use --subunit.")
3756
3597
            self.additional_selftest_args['runner_class'] = SubUnitBzrRunner
3757
 
            # On Windows, disable automatic conversion of '\n' to '\r\n' in
3758
 
            # stdout, which would corrupt the subunit stream. 
3759
 
            # FIXME: This has been fixed in subunit trunk (>0.0.5) so the
3760
 
            # following code can be deleted when it's sufficiently deployed
3761
 
            # -- vila/mgz 20100514
3762
 
            if (sys.platform == "win32"
3763
 
                and getattr(sys.stdout, 'fileno', None) is not None):
3764
 
                import msvcrt
3765
 
                msvcrt.setmode(sys.stdout.fileno(), os.O_BINARY)
3766
3598
        if parallel:
3767
3599
            self.additional_selftest_args.setdefault(
3768
3600
                'suite_decorators', []).append(parallel)
3769
3601
        if benchmark:
3770
 
            raise errors.BzrCommandError(
3771
 
                "--benchmark is no longer supported from bzr 2.2; "
3772
 
                "use bzr-usertest instead")
3773
 
        test_suite_factory = None
3774
 
        if not exclude:
3775
 
            exclude_pattern = None
 
3602
            test_suite_factory = benchmarks.test_suite
 
3603
            # Unless user explicitly asks for quiet, be verbose in benchmarks
 
3604
            verbose = not is_quiet()
 
3605
            # TODO: should possibly lock the history file...
 
3606
            benchfile = open(".perf_history", "at", buffering=1)
 
3607
            self.add_cleanup(benchfile.close)
3776
3608
        else:
3777
 
            exclude_pattern = '(' + '|'.join(exclude) + ')'
 
3609
            test_suite_factory = None
 
3610
            benchfile = None
3778
3611
        selftest_kwargs = {"verbose": verbose,
3779
3612
                          "pattern": pattern,
3780
3613
                          "stop_on_failure": one,
3782
3615
                          "test_suite_factory": test_suite_factory,
3783
3616
                          "lsprof_timed": lsprof_timed,
3784
3617
                          "lsprof_tests": lsprof_tests,
 
3618
                          "bench_history": benchfile,
3785
3619
                          "matching_tests_first": first,
3786
3620
                          "list_only": list_only,
3787
3621
                          "random_seed": randomize,
3788
 
                          "exclude_pattern": exclude_pattern,
 
3622
                          "exclude_pattern": exclude,
3789
3623
                          "strict": strict,
3790
3624
                          "load_list": load_list,
3791
3625
                          "debug_flags": debugflag,
3792
3626
                          "starting_with": starting_with
3793
3627
                          }
3794
3628
        selftest_kwargs.update(self.additional_selftest_args)
3795
 
 
3796
 
        # Make deprecation warnings visible, unless -Werror is set
3797
 
        cleanup = symbol_versioning.activate_deprecation_warnings(
3798
 
            override=False)
3799
 
        try:
3800
 
            result = tests.selftest(**selftest_kwargs)
3801
 
        finally:
3802
 
            cleanup()
 
3629
        result = selftest(**selftest_kwargs)
3803
3630
        return int(not result)
3804
3631
 
3805
3632
 
3806
3633
class cmd_version(Command):
3807
 
    __doc__ = """Show version of bzr."""
 
3634
    """Show version of bzr."""
3808
3635
 
3809
3636
    encoding_type = 'replace'
3810
3637
    takes_options = [
3821
3648
 
3822
3649
 
3823
3650
class cmd_rocks(Command):
3824
 
    __doc__ = """Statement of optimism."""
 
3651
    """Statement of optimism."""
3825
3652
 
3826
3653
    hidden = True
3827
3654
 
3831
3658
 
3832
3659
 
3833
3660
class cmd_find_merge_base(Command):
3834
 
    __doc__ = """Find and print a base revision for merging two branches."""
 
3661
    """Find and print a base revision for merging two branches."""
3835
3662
    # TODO: Options to specify revisions on either side, as if
3836
3663
    #       merging only part of the history.
3837
3664
    takes_args = ['branch', 'other']
3843
3670
 
3844
3671
        branch1 = Branch.open_containing(branch)[0]
3845
3672
        branch2 = Branch.open_containing(other)[0]
3846
 
        self.add_cleanup(branch1.lock_read().unlock)
3847
 
        self.add_cleanup(branch2.lock_read().unlock)
 
3673
        branch1.lock_read()
 
3674
        self.add_cleanup(branch1.unlock)
 
3675
        branch2.lock_read()
 
3676
        self.add_cleanup(branch2.unlock)
3848
3677
        last1 = ensure_null(branch1.last_revision())
3849
3678
        last2 = ensure_null(branch2.last_revision())
3850
3679
 
3855
3684
 
3856
3685
 
3857
3686
class cmd_merge(Command):
3858
 
    __doc__ = """Perform a three-way merge.
 
3687
    """Perform a three-way merge.
3859
3688
 
3860
3689
    The source of the merge can be specified either in the form of a branch,
3861
3690
    or in the form of a path to a file containing a merge directive generated
3862
3691
    with bzr send. If neither is specified, the default is the upstream branch
3863
 
    or the branch most recently merged using --remember.  The source of the
3864
 
    merge may also be specified in the form of a path to a file in another
3865
 
    branch:  in this case, only the modifications to that file are merged into
3866
 
    the current working tree.
3867
 
 
3868
 
    When merging from a branch, by default bzr will try to merge in all new
3869
 
    work from the other branch, automatically determining an appropriate base
3870
 
    revision.  If this fails, you may need to give an explicit base.
3871
 
 
3872
 
    To pick a different ending revision, pass "--revision OTHER".  bzr will
3873
 
    try to merge in all new work up to and including revision OTHER.
3874
 
 
3875
 
    If you specify two values, "--revision BASE..OTHER", only revisions BASE
3876
 
    through OTHER, excluding BASE but including OTHER, will be merged.  If this
3877
 
    causes some revisions to be skipped, i.e. if the destination branch does
3878
 
    not already contain revision BASE, such a merge is commonly referred to as
3879
 
    a "cherrypick". Unlike a normal merge, Bazaar does not currently track
3880
 
    cherrypicks. The changes look like a normal commit, and the history of the
3881
 
    changes from the other branch is not stored in the commit.
3882
 
 
3883
 
    Revision numbers are always relative to the source branch.
 
3692
    or the branch most recently merged using --remember.
 
3693
 
 
3694
    When merging a branch, by default the tip will be merged. To pick a different
 
3695
    revision, pass --revision. If you specify two values, the first will be used as
 
3696
    BASE and the second one as OTHER. Merging individual revisions, or a subset of
 
3697
    available revisions, like this is commonly referred to as "cherrypicking".
 
3698
 
 
3699
    Revision numbers are always relative to the branch being merged.
 
3700
 
 
3701
    By default, bzr will try to merge in all new work from the other
 
3702
    branch, automatically determining an appropriate base.  If this
 
3703
    fails, you may need to give an explicit base.
3884
3704
 
3885
3705
    Merge will do its best to combine the changes in two branches, but there
3886
3706
    are some kinds of problems only a human can fix.  When it encounters those,
3889
3709
 
3890
3710
    Use bzr resolve when you have fixed a problem.  See also bzr conflicts.
3891
3711
 
3892
 
    If there is no default branch set, the first merge will set it (use
3893
 
    --no-remember to avoid settting it). After that, you can omit the branch
3894
 
    to use the default.  To change the default, use --remember. The value will
3895
 
    only be saved if the remote location can be accessed.
 
3712
    If there is no default branch set, the first merge will set it. After
 
3713
    that, you can omit the branch to use the default.  To change the
 
3714
    default, use --remember. The value will only be saved if the remote
 
3715
    location can be accessed.
3896
3716
 
3897
3717
    The results of the merge are placed into the destination working
3898
3718
    directory, where they can be reviewed (with bzr diff), tested, and then
3899
3719
    committed to record the result of the merge.
3900
3720
 
3901
3721
    merge refuses to run if there are any uncommitted changes, unless
3902
 
    --force is given.  If --force is given, then the changes from the source 
3903
 
    will be merged with the current working tree, including any uncommitted
3904
 
    changes in the tree.  The --force option can also be used to create a
 
3722
    --force is given. The --force option can also be used to create a
3905
3723
    merge revision which has more than two parents.
3906
3724
 
3907
3725
    If one would like to merge changes from the working tree of the other
3912
3730
    you to apply each diff hunk and file change, similar to "shelve".
3913
3731
 
3914
3732
    :Examples:
3915
 
        To merge all new revisions from bzr.dev::
 
3733
        To merge the latest revision from bzr.dev::
3916
3734
 
3917
3735
            bzr merge ../bzr.dev
3918
3736
 
3955
3773
                ' completely merged into the source, pull from the'
3956
3774
                ' source rather than merging.  When this happens,'
3957
3775
                ' you do not need to commit the result.'),
3958
 
        custom_help('directory',
 
3776
        Option('directory',
3959
3777
               help='Branch to merge into, '
3960
 
                    'rather than the one containing the working directory.'),
 
3778
                    'rather than the one containing the working directory.',
 
3779
               short_name='d',
 
3780
               type=unicode,
 
3781
               ),
3961
3782
        Option('preview', help='Instead of merging, show a diff of the'
3962
3783
               ' merge.'),
3963
3784
        Option('interactive', help='Select changes interactively.',
3965
3786
    ]
3966
3787
 
3967
3788
    def run(self, location=None, revision=None, force=False,
3968
 
            merge_type=None, show_base=False, reprocess=None, remember=None,
 
3789
            merge_type=None, show_base=False, reprocess=None, remember=False,
3969
3790
            uncommitted=False, pull=False,
3970
3791
            directory=None,
3971
3792
            preview=False,
3979
3800
        merger = None
3980
3801
        allow_pending = True
3981
3802
        verified = 'inapplicable'
3982
 
 
3983
3803
        tree = WorkingTree.open_containing(directory)[0]
3984
 
        if tree.branch.revno() == 0:
3985
 
            raise errors.BzrCommandError('Merging into empty branches not currently supported, '
3986
 
                                         'https://bugs.launchpad.net/bzr/+bug/308562')
3987
3804
 
3988
3805
        try:
3989
3806
            basis_tree = tree.revision_tree(tree.last_revision())
4000
3817
            unversioned_filter=tree.is_ignored, view_info=view_info)
4001
3818
        pb = ui.ui_factory.nested_progress_bar()
4002
3819
        self.add_cleanup(pb.finished)
4003
 
        self.add_cleanup(tree.lock_write().unlock)
 
3820
        tree.lock_write()
 
3821
        self.add_cleanup(tree.unlock)
4004
3822
        if location is not None:
4005
3823
            try:
4006
3824
                mergeable = bundle.read_mergeable_from_url(location,
4035
3853
        self.sanity_check_merger(merger)
4036
3854
        if (merger.base_rev_id == merger.other_rev_id and
4037
3855
            merger.other_rev_id is not None):
4038
 
            # check if location is a nonexistent file (and not a branch) to
4039
 
            # disambiguate the 'Nothing to do'
4040
 
            if merger.interesting_files:
4041
 
                if not merger.other_tree.has_filename(
4042
 
                    merger.interesting_files[0]):
4043
 
                    note("merger: " + str(merger))
4044
 
                    raise errors.PathsDoNotExist([location])
4045
3856
            note('Nothing to do.')
4046
3857
            return 0
4047
 
        if pull and not preview:
 
3858
        if pull:
4048
3859
            if merger.interesting_files is not None:
4049
3860
                raise errors.BzrCommandError('Cannot pull individual files')
4050
3861
            if (merger.base_rev_id == tree.last_revision()):
4074
3885
    def _do_preview(self, merger):
4075
3886
        from bzrlib.diff import show_diff_trees
4076
3887
        result_tree = self._get_preview(merger)
4077
 
        path_encoding = osutils.get_diff_header_encoding()
4078
3888
        show_diff_trees(merger.this_tree, result_tree, self.outf,
4079
 
                        old_label='', new_label='',
4080
 
                        path_encoding=path_encoding)
 
3889
                        old_label='', new_label='')
4081
3890
 
4082
3891
    def _do_merge(self, merger, change_reporter, allow_pending, verified):
4083
3892
        merger.change_reporter = change_reporter
4159
3968
        if other_revision_id is None:
4160
3969
            other_revision_id = _mod_revision.ensure_null(
4161
3970
                other_branch.last_revision())
4162
 
        # Remember where we merge from. We need to remember if:
4163
 
        # - user specify a location (and we don't merge from the parent
4164
 
        #   branch)
4165
 
        # - user ask to remember or there is no previous location set to merge
4166
 
        #   from and user didn't ask to *not* remember
4167
 
        if (user_location is not None
4168
 
            and ((remember
4169
 
                  or (remember is None
4170
 
                      and tree.branch.get_submit_branch() is None)))):
 
3971
        # Remember where we merge from
 
3972
        if ((remember or tree.branch.get_submit_branch() is None) and
 
3973
             user_location is not None):
4171
3974
            tree.branch.set_submit_branch(other_branch.base)
4172
 
        # Merge tags (but don't set them in the master branch yet, the user
4173
 
        # might revert this merge).  Commit will propagate them.
4174
 
        _merge_tags_if_possible(other_branch, tree.branch, ignore_master=True)
 
3975
        _merge_tags_if_possible(other_branch, tree.branch)
4175
3976
        merger = _mod_merge.Merger.from_revision_ids(pb, tree,
4176
3977
            other_revision_id, base_revision_id, other_branch, base_branch)
4177
3978
        if other_path != '':
4244
4045
 
4245
4046
 
4246
4047
class cmd_remerge(Command):
4247
 
    __doc__ = """Redo a merge.
 
4048
    """Redo a merge.
4248
4049
 
4249
4050
    Use this if you want to try a different merge technique while resolving
4250
4051
    conflicts.  Some merge techniques are better than others, and remerge
4278
4079
        from bzrlib.conflicts import restore
4279
4080
        if merge_type is None:
4280
4081
            merge_type = _mod_merge.Merge3Merger
4281
 
        tree, file_list = WorkingTree.open_containing_paths(file_list)
4282
 
        self.add_cleanup(tree.lock_write().unlock)
 
4082
        tree, file_list = tree_files(file_list)
 
4083
        tree.lock_write()
 
4084
        self.add_cleanup(tree.unlock)
4283
4085
        parents = tree.get_parent_ids()
4284
4086
        if len(parents) != 2:
4285
4087
            raise errors.BzrCommandError("Sorry, remerge only works after normal"
4338
4140
 
4339
4141
 
4340
4142
class cmd_revert(Command):
4341
 
    __doc__ = """Revert files to a previous revision.
 
4143
    """Revert files to a previous revision.
4342
4144
 
4343
4145
    Giving a list of files will revert only those files.  Otherwise, all files
4344
4146
    will be reverted.  If the revision is not specified with '--revision', the
4345
4147
    last committed revision is used.
4346
4148
 
4347
4149
    To remove only some changes, without reverting to a prior version, use
4348
 
    merge instead.  For example, "merge . -r -2..-3" (don't forget the ".")
4349
 
    will remove the changes introduced by the second last commit (-2), without
4350
 
    affecting the changes introduced by the last commit (-1).  To remove
4351
 
    certain changes on a hunk-by-hunk basis, see the shelve command.
 
4150
    merge instead.  For example, "merge . --revision -2..-3" will remove the
 
4151
    changes introduced by -2, without affecting the changes introduced by -1.
 
4152
    Or to remove certain changes on a hunk-by-hunk basis, see the Shelf plugin.
4352
4153
 
4353
4154
    By default, any files that have been manually changed will be backed up
4354
4155
    first.  (Files changed only by merge are not backed up.)  Backup files have
4384
4185
    target branches.
4385
4186
    """
4386
4187
 
4387
 
    _see_also = ['cat', 'export', 'merge', 'shelve']
 
4188
    _see_also = ['cat', 'export']
4388
4189
    takes_options = [
4389
4190
        'revision',
4390
4191
        Option('no-backup', "Do not save backups of reverted files."),
4395
4196
 
4396
4197
    def run(self, revision=None, no_backup=False, file_list=None,
4397
4198
            forget_merges=None):
4398
 
        tree, file_list = WorkingTree.open_containing_paths(file_list)
4399
 
        self.add_cleanup(tree.lock_tree_write().unlock)
 
4199
        tree, file_list = tree_files(file_list)
 
4200
        tree.lock_write()
 
4201
        self.add_cleanup(tree.unlock)
4400
4202
        if forget_merges:
4401
4203
            tree.set_parent_ids(tree.get_parent_ids()[:1])
4402
4204
        else:
4410
4212
 
4411
4213
 
4412
4214
class cmd_assert_fail(Command):
4413
 
    __doc__ = """Test reporting of assertion failures"""
 
4215
    """Test reporting of assertion failures"""
4414
4216
    # intended just for use in testing
4415
4217
 
4416
4218
    hidden = True
4420
4222
 
4421
4223
 
4422
4224
class cmd_help(Command):
4423
 
    __doc__ = """Show help on a command or other topic.
 
4225
    """Show help on a command or other topic.
4424
4226
    """
4425
4227
 
4426
4228
    _see_also = ['topics']
4439
4241
 
4440
4242
 
4441
4243
class cmd_shell_complete(Command):
4442
 
    __doc__ = """Show appropriate completions for context.
 
4244
    """Show appropriate completions for context.
4443
4245
 
4444
4246
    For a list of all available commands, say 'bzr shell-complete'.
4445
4247
    """
4454
4256
 
4455
4257
 
4456
4258
class cmd_missing(Command):
4457
 
    __doc__ = """Show unmerged/unpulled revisions between two branches.
 
4259
    """Show unmerged/unpulled revisions between two branches.
4458
4260
 
4459
4261
    OTHER_BRANCH may be local or remote.
4460
4262
 
4491
4293
    _see_also = ['merge', 'pull']
4492
4294
    takes_args = ['other_branch?']
4493
4295
    takes_options = [
4494
 
        'directory',
4495
4296
        Option('reverse', 'Reverse the order of revisions.'),
4496
4297
        Option('mine-only',
4497
4298
               'Display changes in the local branch only.'),
4519
4320
            theirs_only=False,
4520
4321
            log_format=None, long=False, short=False, line=False,
4521
4322
            show_ids=False, verbose=False, this=False, other=False,
4522
 
            include_merges=False, revision=None, my_revision=None,
4523
 
            directory=u'.'):
 
4323
            include_merges=False, revision=None, my_revision=None):
4524
4324
        from bzrlib.missing import find_unmerged, iter_log_revisions
4525
4325
        def message(s):
4526
4326
            if not is_quiet():
4539
4339
        elif theirs_only:
4540
4340
            restrict = 'remote'
4541
4341
 
4542
 
        local_branch = Branch.open_containing(directory)[0]
4543
 
        self.add_cleanup(local_branch.lock_read().unlock)
4544
 
 
 
4342
        local_branch = Branch.open_containing(u".")[0]
4545
4343
        parent = local_branch.get_parent()
4546
4344
        if other_branch is None:
4547
4345
            other_branch = parent
4556
4354
        remote_branch = Branch.open(other_branch)
4557
4355
        if remote_branch.base == local_branch.base:
4558
4356
            remote_branch = local_branch
4559
 
        else:
4560
 
            self.add_cleanup(remote_branch.lock_read().unlock)
4561
4357
 
 
4358
        local_branch.lock_read()
 
4359
        self.add_cleanup(local_branch.unlock)
4562
4360
        local_revid_range = _revision_range_to_revid_range(
4563
4361
            _get_revision_range(my_revision, local_branch,
4564
4362
                self.name()))
4565
4363
 
 
4364
        remote_branch.lock_read()
 
4365
        self.add_cleanup(remote_branch.unlock)
4566
4366
        remote_revid_range = _revision_range_to_revid_range(
4567
4367
            _get_revision_range(revision,
4568
4368
                remote_branch, self.name()))
4618
4418
            message("Branches are up to date.\n")
4619
4419
        self.cleanup_now()
4620
4420
        if not status_code and parent is None and other_branch is not None:
4621
 
            self.add_cleanup(local_branch.lock_write().unlock)
 
4421
            local_branch.lock_write()
 
4422
            self.add_cleanup(local_branch.unlock)
4622
4423
            # handle race conditions - a parent might be set while we run.
4623
4424
            if local_branch.get_parent() is None:
4624
4425
                local_branch.set_parent(remote_branch.base)
4626
4427
 
4627
4428
 
4628
4429
class cmd_pack(Command):
4629
 
    __doc__ = """Compress the data within a repository.
4630
 
 
4631
 
    This operation compresses the data within a bazaar repository. As
4632
 
    bazaar supports automatic packing of repository, this operation is
4633
 
    normally not required to be done manually.
4634
 
 
4635
 
    During the pack operation, bazaar takes a backup of existing repository
4636
 
    data, i.e. pack files. This backup is eventually removed by bazaar
4637
 
    automatically when it is safe to do so. To save disk space by removing
4638
 
    the backed up pack files, the --clean-obsolete-packs option may be
4639
 
    used.
4640
 
 
4641
 
    Warning: If you use --clean-obsolete-packs and your machine crashes
4642
 
    during or immediately after repacking, you may be left with a state
4643
 
    where the deletion has been written to disk but the new packs have not
4644
 
    been. In this case the repository may be unusable.
4645
 
    """
 
4430
    """Compress the data within a repository."""
4646
4431
 
4647
4432
    _see_also = ['repositories']
4648
4433
    takes_args = ['branch_or_repo?']
4649
 
    takes_options = [
4650
 
        Option('clean-obsolete-packs', 'Delete obsolete packs to save disk space.'),
4651
 
        ]
4652
4434
 
4653
 
    def run(self, branch_or_repo='.', clean_obsolete_packs=False):
 
4435
    def run(self, branch_or_repo='.'):
4654
4436
        dir = bzrdir.BzrDir.open_containing(branch_or_repo)[0]
4655
4437
        try:
4656
4438
            branch = dir.open_branch()
4657
4439
            repository = branch.repository
4658
4440
        except errors.NotBranchError:
4659
4441
            repository = dir.open_repository()
4660
 
        repository.pack(clean_obsolete_packs=clean_obsolete_packs)
 
4442
        repository.pack()
4661
4443
 
4662
4444
 
4663
4445
class cmd_plugins(Command):
4664
 
    __doc__ = """List the installed plugins.
 
4446
    """List the installed plugins.
4665
4447
 
4666
4448
    This command displays the list of installed plugins including
4667
4449
    version of plugin and a short description of each.
4683
4465
 
4684
4466
    @display_command
4685
4467
    def run(self, verbose=False):
4686
 
        from bzrlib import plugin
4687
 
        # Don't give writelines a generator as some codecs don't like that
4688
 
        self.outf.writelines(
4689
 
            list(plugin.describe_plugins(show_paths=verbose)))
 
4468
        import bzrlib.plugin
 
4469
        from inspect import getdoc
 
4470
        result = []
 
4471
        for name, plugin in bzrlib.plugin.plugins().items():
 
4472
            version = plugin.__version__
 
4473
            if version == 'unknown':
 
4474
                version = ''
 
4475
            name_ver = '%s %s' % (name, version)
 
4476
            d = getdoc(plugin.module)
 
4477
            if d:
 
4478
                doc = d.split('\n')[0]
 
4479
            else:
 
4480
                doc = '(no description)'
 
4481
            result.append((name_ver, doc, plugin.path()))
 
4482
        for name_ver, doc, path in sorted(result):
 
4483
            self.outf.write("%s\n" % name_ver)
 
4484
            self.outf.write("   %s\n" % doc)
 
4485
            if verbose:
 
4486
                self.outf.write("   %s\n" % path)
 
4487
            self.outf.write("\n")
4690
4488
 
4691
4489
 
4692
4490
class cmd_testament(Command):
4693
 
    __doc__ = """Show testament (signing-form) of a revision."""
 
4491
    """Show testament (signing-form) of a revision."""
4694
4492
    takes_options = [
4695
4493
            'revision',
4696
4494
            Option('long', help='Produce long-format testament.'),
4708
4506
            b = Branch.open_containing(branch)[0]
4709
4507
        else:
4710
4508
            b = Branch.open(branch)
4711
 
        self.add_cleanup(b.lock_read().unlock)
 
4509
        b.lock_read()
 
4510
        self.add_cleanup(b.unlock)
4712
4511
        if revision is None:
4713
4512
            rev_id = b.last_revision()
4714
4513
        else:
4721
4520
 
4722
4521
 
4723
4522
class cmd_annotate(Command):
4724
 
    __doc__ = """Show the origin of each line in a file.
 
4523
    """Show the origin of each line in a file.
4725
4524
 
4726
4525
    This prints out the given file with an annotation on the left side
4727
4526
    indicating which revision, author and date introduced the change.
4738
4537
                     Option('long', help='Show commit date in annotations.'),
4739
4538
                     'revision',
4740
4539
                     'show-ids',
4741
 
                     'directory',
4742
4540
                     ]
4743
4541
    encoding_type = 'exact'
4744
4542
 
4745
4543
    @display_command
4746
4544
    def run(self, filename, all=False, long=False, revision=None,
4747
 
            show_ids=False, directory=None):
4748
 
        from bzrlib.annotate import (
4749
 
            annotate_file_tree,
4750
 
            )
 
4545
            show_ids=False):
 
4546
        from bzrlib.annotate import annotate_file, annotate_file_tree
4751
4547
        wt, branch, relpath = \
4752
 
            _open_directory_or_containing_tree_or_branch(filename, directory)
 
4548
            bzrdir.BzrDir.open_containing_tree_or_branch(filename)
4753
4549
        if wt is not None:
4754
 
            self.add_cleanup(wt.lock_read().unlock)
 
4550
            wt.lock_read()
 
4551
            self.add_cleanup(wt.unlock)
4755
4552
        else:
4756
 
            self.add_cleanup(branch.lock_read().unlock)
 
4553
            branch.lock_read()
 
4554
            self.add_cleanup(branch.unlock)
4757
4555
        tree = _get_one_revision_tree('annotate', revision, branch=branch)
4758
 
        self.add_cleanup(tree.lock_read().unlock)
4759
 
        if wt is not None and revision is None:
 
4556
        tree.lock_read()
 
4557
        self.add_cleanup(tree.unlock)
 
4558
        if wt is not None:
4760
4559
            file_id = wt.path2id(relpath)
4761
4560
        else:
4762
4561
            file_id = tree.path2id(relpath)
4763
4562
        if file_id is None:
4764
4563
            raise errors.NotVersionedError(filename)
 
4564
        file_version = tree.inventory[file_id].revision
4765
4565
        if wt is not None and revision is None:
4766
4566
            # If there is a tree and we're not annotating historical
4767
4567
            # versions, annotate the working tree's content.
4768
4568
            annotate_file_tree(wt, file_id, self.outf, long, all,
4769
4569
                show_ids=show_ids)
4770
4570
        else:
4771
 
            annotate_file_tree(tree, file_id, self.outf, long, all,
4772
 
                show_ids=show_ids, branch=branch)
 
4571
            annotate_file(branch, file_version, file_id, long, all, self.outf,
 
4572
                          show_ids=show_ids)
4773
4573
 
4774
4574
 
4775
4575
class cmd_re_sign(Command):
4776
 
    __doc__ = """Create a digital signature for an existing revision."""
 
4576
    """Create a digital signature for an existing revision."""
4777
4577
    # TODO be able to replace existing ones.
4778
4578
 
4779
4579
    hidden = True # is this right ?
4780
4580
    takes_args = ['revision_id*']
4781
 
    takes_options = ['directory', 'revision']
 
4581
    takes_options = ['revision']
4782
4582
 
4783
 
    def run(self, revision_id_list=None, revision=None, directory=u'.'):
 
4583
    def run(self, revision_id_list=None, revision=None):
4784
4584
        if revision_id_list is not None and revision is not None:
4785
4585
            raise errors.BzrCommandError('You can only supply one of revision_id or --revision')
4786
4586
        if revision_id_list is None and revision is None:
4787
4587
            raise errors.BzrCommandError('You must supply either --revision or a revision_id')
4788
 
        b = WorkingTree.open_containing(directory)[0].branch
4789
 
        self.add_cleanup(b.lock_write().unlock)
 
4588
        b = WorkingTree.open_containing(u'.')[0].branch
 
4589
        b.lock_write()
 
4590
        self.add_cleanup(b.unlock)
4790
4591
        return self._run(b, revision_id_list, revision)
4791
4592
 
4792
4593
    def _run(self, b, revision_id_list, revision):
4838
4639
 
4839
4640
 
4840
4641
class cmd_bind(Command):
4841
 
    __doc__ = """Convert the current branch into a checkout of the supplied branch.
4842
 
    If no branch is supplied, rebind to the last bound location.
 
4642
    """Convert the current branch into a checkout of the supplied branch.
4843
4643
 
4844
4644
    Once converted into a checkout, commits must succeed on the master branch
4845
4645
    before they will be applied to the local branch.
4851
4651
 
4852
4652
    _see_also = ['checkouts', 'unbind']
4853
4653
    takes_args = ['location?']
4854
 
    takes_options = ['directory']
 
4654
    takes_options = []
4855
4655
 
4856
 
    def run(self, location=None, directory=u'.'):
4857
 
        b, relpath = Branch.open_containing(directory)
 
4656
    def run(self, location=None):
 
4657
        b, relpath = Branch.open_containing(u'.')
4858
4658
        if location is None:
4859
4659
            try:
4860
4660
                location = b.get_old_bound_location()
4879
4679
 
4880
4680
 
4881
4681
class cmd_unbind(Command):
4882
 
    __doc__ = """Convert the current checkout into a regular branch.
 
4682
    """Convert the current checkout into a regular branch.
4883
4683
 
4884
4684
    After unbinding, the local branch is considered independent and subsequent
4885
4685
    commits will be local only.
4887
4687
 
4888
4688
    _see_also = ['checkouts', 'bind']
4889
4689
    takes_args = []
4890
 
    takes_options = ['directory']
 
4690
    takes_options = []
4891
4691
 
4892
 
    def run(self, directory=u'.'):
4893
 
        b, relpath = Branch.open_containing(directory)
 
4692
    def run(self):
 
4693
        b, relpath = Branch.open_containing(u'.')
4894
4694
        if not b.unbind():
4895
4695
            raise errors.BzrCommandError('Local branch is not bound')
4896
4696
 
4897
4697
 
4898
4698
class cmd_uncommit(Command):
4899
 
    __doc__ = """Remove the last committed revision.
 
4699
    """Remove the last committed revision.
4900
4700
 
4901
4701
    --verbose will print out what is being removed.
4902
4702
    --dry-run will go through all the motions, but not actually
4942
4742
            b = control.open_branch()
4943
4743
 
4944
4744
        if tree is not None:
4945
 
            self.add_cleanup(tree.lock_write().unlock)
 
4745
            tree.lock_write()
 
4746
            self.add_cleanup(tree.unlock)
4946
4747
        else:
4947
 
            self.add_cleanup(b.lock_write().unlock)
 
4748
            b.lock_write()
 
4749
            self.add_cleanup(b.unlock)
4948
4750
        return self._run(b, tree, dry_run, verbose, revision, force, local=local)
4949
4751
 
4950
4752
    def _run(self, b, tree, dry_run, verbose, revision, force, local=False):
4989
4791
            self.outf.write('The above revision(s) will be removed.\n')
4990
4792
 
4991
4793
        if not force:
4992
 
            if not ui.ui_factory.confirm_action(
4993
 
                    u'Uncommit these revisions',
4994
 
                    'bzrlib.builtins.uncommit',
4995
 
                    {}):
4996
 
                self.outf.write('Canceled\n')
 
4794
            if not ui.ui_factory.get_boolean('Are you sure'):
 
4795
                self.outf.write('Canceled')
4997
4796
                return 0
4998
4797
 
4999
4798
        mutter('Uncommitting from {%s} to {%s}',
5005
4804
 
5006
4805
 
5007
4806
class cmd_break_lock(Command):
5008
 
    __doc__ = """Break a dead lock.
5009
 
 
5010
 
    This command breaks a lock on a repository, branch, working directory or
5011
 
    config file.
 
4807
    """Break a dead lock on a repository, branch or working directory.
5012
4808
 
5013
4809
    CAUTION: Locks should only be broken when you are sure that the process
5014
4810
    holding the lock has been stopped.
5019
4815
    :Examples:
5020
4816
        bzr break-lock
5021
4817
        bzr break-lock bzr+ssh://example.com/bzr/foo
5022
 
        bzr break-lock --conf ~/.bazaar
5023
4818
    """
5024
 
 
5025
4819
    takes_args = ['location?']
5026
 
    takes_options = [
5027
 
        Option('config',
5028
 
               help='LOCATION is the directory where the config lock is.'),
5029
 
        Option('force',
5030
 
            help='Do not ask for confirmation before breaking the lock.'),
5031
 
        ]
5032
4820
 
5033
 
    def run(self, location=None, config=False, force=False):
 
4821
    def run(self, location=None, show=False):
5034
4822
        if location is None:
5035
4823
            location = u'.'
5036
 
        if force:
5037
 
            ui.ui_factory = ui.ConfirmationUserInterfacePolicy(ui.ui_factory,
5038
 
                None,
5039
 
                {'bzrlib.lockdir.break': True})
5040
 
        if config:
5041
 
            conf = _mod_config.LockableConfig(file_name=location)
5042
 
            conf.break_lock()
5043
 
        else:
5044
 
            control, relpath = bzrdir.BzrDir.open_containing(location)
5045
 
            try:
5046
 
                control.break_lock()
5047
 
            except NotImplementedError:
5048
 
                pass
 
4824
        control, relpath = bzrdir.BzrDir.open_containing(location)
 
4825
        try:
 
4826
            control.break_lock()
 
4827
        except NotImplementedError:
 
4828
            pass
5049
4829
 
5050
4830
 
5051
4831
class cmd_wait_until_signalled(Command):
5052
 
    __doc__ = """Test helper for test_start_and_stop_bzr_subprocess_send_signal.
 
4832
    """Test helper for test_start_and_stop_bzr_subprocess_send_signal.
5053
4833
 
5054
4834
    This just prints a line to signal when it is ready, then blocks on stdin.
5055
4835
    """
5063
4843
 
5064
4844
 
5065
4845
class cmd_serve(Command):
5066
 
    __doc__ = """Run the bzr server."""
 
4846
    """Run the bzr server."""
5067
4847
 
5068
4848
    aliases = ['server']
5069
4849
 
5080
4860
                    'result in a dynamically allocated port.  The default port '
5081
4861
                    'depends on the protocol.',
5082
4862
               type=str),
5083
 
        custom_help('directory',
5084
 
               help='Serve contents of this directory.'),
 
4863
        Option('directory',
 
4864
               help='Serve contents of this directory.',
 
4865
               type=unicode),
5085
4866
        Option('allow-writes',
5086
4867
               help='By default the server is a readonly server.  Supplying '
5087
4868
                    '--allow-writes enables write access to the contents of '
5114
4895
 
5115
4896
    def run(self, port=None, inet=False, directory=None, allow_writes=False,
5116
4897
            protocol=None):
5117
 
        from bzrlib import transport
 
4898
        from bzrlib.transport import get_transport, transport_server_registry
5118
4899
        if directory is None:
5119
4900
            directory = os.getcwd()
5120
4901
        if protocol is None:
5121
 
            protocol = transport.transport_server_registry.get()
 
4902
            protocol = transport_server_registry.get()
5122
4903
        host, port = self.get_host_and_port(port)
5123
4904
        url = urlutils.local_path_to_url(directory)
5124
4905
        if not allow_writes:
5125
4906
            url = 'readonly+' + url
5126
 
        t = transport.get_transport(url)
5127
 
        protocol(t, host, port, inet)
 
4907
        transport = get_transport(url)
 
4908
        protocol(transport, host, port, inet)
5128
4909
 
5129
4910
 
5130
4911
class cmd_join(Command):
5131
 
    __doc__ = """Combine a tree into its containing tree.
 
4912
    """Combine a tree into its containing tree.
5132
4913
 
5133
4914
    This command requires the target tree to be in a rich-root format.
5134
4915
 
5136
4917
    not part of it.  (Such trees can be produced by "bzr split", but also by
5137
4918
    running "bzr branch" with the target inside a tree.)
5138
4919
 
5139
 
    The result is a combined tree, with the subtree no longer an independent
 
4920
    The result is a combined tree, with the subtree no longer an independant
5140
4921
    part.  This is marked as a merge of the subtree into the containing tree,
5141
4922
    and all history is preserved.
5142
4923
    """
5174
4955
 
5175
4956
 
5176
4957
class cmd_split(Command):
5177
 
    __doc__ = """Split a subdirectory of a tree into a separate tree.
 
4958
    """Split a subdirectory of a tree into a separate tree.
5178
4959
 
5179
4960
    This command will produce a target tree in a format that supports
5180
4961
    rich roots, like 'rich-root' or 'rich-root-pack'.  These formats cannot be
5200
4981
 
5201
4982
 
5202
4983
class cmd_merge_directive(Command):
5203
 
    __doc__ = """Generate a merge directive for auto-merge tools.
 
4984
    """Generate a merge directive for auto-merge tools.
5204
4985
 
5205
4986
    A directive requests a merge to be performed, and also provides all the
5206
4987
    information necessary to do so.  This means it must either include a
5223
5004
    _see_also = ['send']
5224
5005
 
5225
5006
    takes_options = [
5226
 
        'directory',
5227
5007
        RegistryOption.from_kwargs('patch-type',
5228
5008
            'The type of patch to include in the directive.',
5229
5009
            title='Patch type',
5242
5022
    encoding_type = 'exact'
5243
5023
 
5244
5024
    def run(self, submit_branch=None, public_branch=None, patch_type='bundle',
5245
 
            sign=False, revision=None, mail_to=None, message=None,
5246
 
            directory=u'.'):
 
5025
            sign=False, revision=None, mail_to=None, message=None):
5247
5026
        from bzrlib.revision import ensure_null, NULL_REVISION
5248
5027
        include_patch, include_bundle = {
5249
5028
            'plain': (False, False),
5250
5029
            'diff': (True, False),
5251
5030
            'bundle': (True, True),
5252
5031
            }[patch_type]
5253
 
        branch = Branch.open(directory)
 
5032
        branch = Branch.open('.')
5254
5033
        stored_submit_branch = branch.get_submit_branch()
5255
5034
        if submit_branch is None:
5256
5035
            submit_branch = stored_submit_branch
5301
5080
 
5302
5081
 
5303
5082
class cmd_send(Command):
5304
 
    __doc__ = """Mail or create a merge-directive for submitting changes.
 
5083
    """Mail or create a merge-directive for submitting changes.
5305
5084
 
5306
5085
    A merge directive provides many things needed for requesting merges:
5307
5086
 
5332
5111
    source branch defaults to that containing the working directory, but can
5333
5112
    be changed using --from.
5334
5113
 
5335
 
    Both the submit branch and the public branch follow the usual behavior with
5336
 
    respect to --remember: If there is no default location set, the first send
5337
 
    will set it (use --no-remember to avoid settting it). After that, you can
5338
 
    omit the location to use the default.  To change the default, use
5339
 
    --remember. The value will only be saved if the location can be accessed.
5340
 
 
5341
5114
    In order to calculate those changes, bzr must analyse the submit branch.
5342
5115
    Therefore it is most efficient for the submit branch to be a local mirror.
5343
5116
    If a public location is known for the submit_branch, that location is used
5347
5120
    given, in which case it is sent to a file.
5348
5121
 
5349
5122
    Mail is sent using your preferred mail program.  This should be transparent
5350
 
    on Windows (it uses MAPI).  On Unix, it requires the xdg-email utility.
 
5123
    on Windows (it uses MAPI).  On Linux, it requires the xdg-email utility.
5351
5124
    If the preferred client can't be found (or used), your editor will be used.
5352
5125
 
5353
5126
    To use a specific mail program, set the mail_client configuration option.
5412
5185
        ]
5413
5186
 
5414
5187
    def run(self, submit_branch=None, public_branch=None, no_bundle=False,
5415
 
            no_patch=False, revision=None, remember=None, output=None,
 
5188
            no_patch=False, revision=None, remember=False, output=None,
5416
5189
            format=None, mail_to=None, message=None, body=None,
5417
5190
            strict=None, **kwargs):
5418
5191
        from bzrlib.send import send
5424
5197
 
5425
5198
 
5426
5199
class cmd_bundle_revisions(cmd_send):
5427
 
    __doc__ = """Create a merge-directive for submitting changes.
 
5200
    """Create a merge-directive for submitting changes.
5428
5201
 
5429
5202
    A merge directive provides many things needed for requesting merges:
5430
5203
 
5497
5270
 
5498
5271
 
5499
5272
class cmd_tag(Command):
5500
 
    __doc__ = """Create, remove or modify a tag naming a revision.
 
5273
    """Create, remove or modify a tag naming a revision.
5501
5274
 
5502
5275
    Tags give human-meaningful names to revisions.  Commands that take a -r
5503
5276
    (--revision) option can be given -rtag:X, where X is any previously
5524
5297
        Option('delete',
5525
5298
            help='Delete this tag rather than placing it.',
5526
5299
            ),
5527
 
        custom_help('directory',
5528
 
            help='Branch in which to place the tag.'),
 
5300
        Option('directory',
 
5301
            help='Branch in which to place the tag.',
 
5302
            short_name='d',
 
5303
            type=unicode,
 
5304
            ),
5529
5305
        Option('force',
5530
5306
            help='Replace existing tags.',
5531
5307
            ),
5539
5315
            revision=None,
5540
5316
            ):
5541
5317
        branch, relpath = Branch.open_containing(directory)
5542
 
        self.add_cleanup(branch.lock_write().unlock)
 
5318
        branch.lock_write()
 
5319
        self.add_cleanup(branch.unlock)
5543
5320
        if delete:
5544
5321
            if tag_name is None:
5545
5322
                raise errors.BzrCommandError("No tag specified to delete.")
5546
5323
            branch.tags.delete_tag(tag_name)
5547
 
            note('Deleted tag %s.' % tag_name)
 
5324
            self.outf.write('Deleted tag %s.\n' % tag_name)
5548
5325
        else:
5549
5326
            if revision:
5550
5327
                if len(revision) != 1:
5562
5339
            if (not force) and branch.tags.has_tag(tag_name):
5563
5340
                raise errors.TagAlreadyExists(tag_name)
5564
5341
            branch.tags.set_tag(tag_name, revision_id)
5565
 
            note('Created tag %s.' % tag_name)
 
5342
            self.outf.write('Created tag %s.\n' % tag_name)
5566
5343
 
5567
5344
 
5568
5345
class cmd_tags(Command):
5569
 
    __doc__ = """List tags.
 
5346
    """List tags.
5570
5347
 
5571
5348
    This command shows a table of tag names and the revisions they reference.
5572
5349
    """
5573
5350
 
5574
5351
    _see_also = ['tag']
5575
5352
    takes_options = [
5576
 
        custom_help('directory',
5577
 
            help='Branch whose tags should be displayed.'),
5578
 
        RegistryOption('sort',
 
5353
        Option('directory',
 
5354
            help='Branch whose tags should be displayed.',
 
5355
            short_name='d',
 
5356
            type=unicode,
 
5357
            ),
 
5358
        RegistryOption.from_kwargs('sort',
5579
5359
            'Sort tags by different criteria.', title='Sorting',
5580
 
            lazy_registry=('bzrlib.tag', 'tag_sort_methods')
 
5360
            alpha='Sort tags lexicographically (default).',
 
5361
            time='Sort tags chronologically.',
5581
5362
            ),
5582
5363
        'show-ids',
5583
5364
        'revision',
5584
5365
    ]
5585
5366
 
5586
5367
    @display_command
5587
 
    def run(self, directory='.', sort=None, show_ids=False, revision=None):
5588
 
        from bzrlib.tag import tag_sort_methods
 
5368
    def run(self,
 
5369
            directory='.',
 
5370
            sort='alpha',
 
5371
            show_ids=False,
 
5372
            revision=None,
 
5373
            ):
5589
5374
        branch, relpath = Branch.open_containing(directory)
5590
5375
 
5591
5376
        tags = branch.tags.get_tag_dict().items()
5592
5377
        if not tags:
5593
5378
            return
5594
5379
 
5595
 
        self.add_cleanup(branch.lock_read().unlock)
 
5380
        branch.lock_read()
 
5381
        self.add_cleanup(branch.unlock)
5596
5382
        if revision:
5597
5383
            graph = branch.repository.get_graph()
5598
5384
            rev1, rev2 = _get_revision_range(revision, branch, self.name())
5600
5386
            # only show revisions between revid1 and revid2 (inclusive)
5601
5387
            tags = [(tag, revid) for tag, revid in tags if
5602
5388
                graph.is_between(revid, revid1, revid2)]
5603
 
        if sort is None:
5604
 
            sort = tag_sort_methods.get()
5605
 
        sort(branch, tags)
 
5389
        if sort == 'alpha':
 
5390
            tags.sort()
 
5391
        elif sort == 'time':
 
5392
            timestamps = {}
 
5393
            for tag, revid in tags:
 
5394
                try:
 
5395
                    revobj = branch.repository.get_revision(revid)
 
5396
                except errors.NoSuchRevision:
 
5397
                    timestamp = sys.maxint # place them at the end
 
5398
                else:
 
5399
                    timestamp = revobj.timestamp
 
5400
                timestamps[revid] = timestamp
 
5401
            tags.sort(key=lambda x: timestamps[x[1]])
5606
5402
        if not show_ids:
5607
5403
            # [ (tag, revid), ... ] -> [ (tag, dotted_revno), ... ]
5608
5404
            for index, (tag, revid) in enumerate(tags):
5610
5406
                    revno = branch.revision_id_to_dotted_revno(revid)
5611
5407
                    if isinstance(revno, tuple):
5612
5408
                        revno = '.'.join(map(str, revno))
5613
 
                except (errors.NoSuchRevision, errors.GhostRevisionsHaveNoRevno):
 
5409
                except errors.NoSuchRevision:
5614
5410
                    # Bad tag data/merges can lead to tagged revisions
5615
5411
                    # which are not in this branch. Fail gracefully ...
5616
5412
                    revno = '?'
5621
5417
 
5622
5418
 
5623
5419
class cmd_reconfigure(Command):
5624
 
    __doc__ = """Reconfigure the type of a bzr directory.
 
5420
    """Reconfigure the type of a bzr directory.
5625
5421
 
5626
5422
    A target configuration must be specified.
5627
5423
 
5674
5470
            unstacked=None):
5675
5471
        directory = bzrdir.BzrDir.open(location)
5676
5472
        if stacked_on and unstacked:
5677
 
            raise errors.BzrCommandError("Can't use both --stacked-on and --unstacked")
 
5473
            raise BzrCommandError("Can't use both --stacked-on and --unstacked")
5678
5474
        elif stacked_on is not None:
5679
5475
            reconfigure.ReconfigureStackedOn().apply(directory, stacked_on)
5680
5476
        elif unstacked:
5712
5508
 
5713
5509
 
5714
5510
class cmd_switch(Command):
5715
 
    __doc__ = """Set the branch of a checkout and update.
 
5511
    """Set the branch of a checkout and update.
5716
5512
 
5717
5513
    For lightweight checkouts, this changes the branch being referenced.
5718
5514
    For heavyweight checkouts, this checks that there are no local commits
5735
5531
    """
5736
5532
 
5737
5533
    takes_args = ['to_location?']
5738
 
    takes_options = ['directory',
5739
 
                     Option('force',
 
5534
    takes_options = [Option('force',
5740
5535
                        help='Switch even if local commits will be lost.'),
5741
5536
                     'revision',
5742
5537
                     Option('create-branch', short_name='b',
5745
5540
                    ]
5746
5541
 
5747
5542
    def run(self, to_location=None, force=False, create_branch=False,
5748
 
            revision=None, directory=u'.'):
 
5543
            revision=None):
5749
5544
        from bzrlib import switch
5750
 
        tree_location = directory
 
5545
        tree_location = '.'
5751
5546
        revision = _get_one_revision('switch', revision)
5752
5547
        control_dir = bzrdir.BzrDir.open_containing(tree_location)[0]
5753
5548
        if to_location is None:
5754
5549
            if revision is None:
5755
5550
                raise errors.BzrCommandError('You must supply either a'
5756
5551
                                             ' revision or a location')
5757
 
            to_location = tree_location
 
5552
            to_location = '.'
5758
5553
        try:
5759
5554
            branch = control_dir.open_branch()
5760
5555
            had_explicit_nick = branch.get_config().has_explicit_nickname()
5809
5604
 
5810
5605
 
5811
5606
class cmd_view(Command):
5812
 
    __doc__ = """Manage filtered views.
 
5607
    """Manage filtered views.
5813
5608
 
5814
5609
    Views provide a mask over the tree so that users can focus on
5815
5610
    a subset of a tree when doing their work. After creating a view,
5895
5690
            name=None,
5896
5691
            switch=None,
5897
5692
            ):
5898
 
        tree, file_list = WorkingTree.open_containing_paths(file_list,
5899
 
            apply_view=False)
 
5693
        tree, file_list = tree_files(file_list, apply_view=False)
5900
5694
        current_view, view_dict = tree.views.get_view_info()
5901
5695
        if name is None:
5902
5696
            name = current_view
5964
5758
 
5965
5759
 
5966
5760
class cmd_hooks(Command):
5967
 
    __doc__ = """Show hooks."""
 
5761
    """Show hooks."""
5968
5762
 
5969
5763
    hidden = True
5970
5764
 
5984
5778
 
5985
5779
 
5986
5780
class cmd_remove_branch(Command):
5987
 
    __doc__ = """Remove a branch.
 
5781
    """Remove a branch.
5988
5782
 
5989
5783
    This will remove the branch from the specified location but 
5990
5784
    will keep any working tree or repository in place.
6006
5800
            location = "."
6007
5801
        branch = Branch.open_containing(location)[0]
6008
5802
        branch.bzrdir.destroy_branch()
6009
 
 
 
5803
        
6010
5804
 
6011
5805
class cmd_shelve(Command):
6012
 
    __doc__ = """Temporarily set aside some changes from the current tree.
 
5806
    """Temporarily set aside some changes from the current tree.
6013
5807
 
6014
5808
    Shelve allows you to temporarily put changes you've made "on the shelf",
6015
5809
    ie. out of the way, until a later time when you can bring them back from
6031
5825
 
6032
5826
    You can put multiple items on the shelf, and by default, 'unshelve' will
6033
5827
    restore the most recently shelved changes.
6034
 
 
6035
 
    For complicated changes, it is possible to edit the changes in a separate
6036
 
    editor program to decide what the file remaining in the working copy
6037
 
    should look like.  To do this, add the configuration option
6038
 
 
6039
 
        change_editor = PROGRAM @new_path @old_path
6040
 
 
6041
 
    where @new_path is replaced with the path of the new version of the 
6042
 
    file and @old_path is replaced with the path of the old version of 
6043
 
    the file.  The PROGRAM should save the new file with the desired 
6044
 
    contents of the file in the working tree.
6045
 
        
6046
5828
    """
6047
5829
 
6048
5830
    takes_args = ['file*']
6049
5831
 
6050
5832
    takes_options = [
6051
 
        'directory',
6052
5833
        'revision',
6053
5834
        Option('all', help='Shelve all changes.'),
6054
5835
        'message',
6060
5841
        Option('destroy',
6061
5842
               help='Destroy removed changes instead of shelving them.'),
6062
5843
    ]
6063
 
    _see_also = ['unshelve', 'configuration']
 
5844
    _see_also = ['unshelve']
6064
5845
 
6065
5846
    def run(self, revision=None, all=False, file_list=None, message=None,
6066
 
            writer=None, list=False, destroy=False, directory=None):
 
5847
            writer=None, list=False, destroy=False):
6067
5848
        if list:
6068
 
            return self.run_for_list(directory=directory)
 
5849
            return self.run_for_list()
6069
5850
        from bzrlib.shelf_ui import Shelver
6070
5851
        if writer is None:
6071
5852
            writer = bzrlib.option.diff_writer_registry.get()
6072
5853
        try:
6073
5854
            shelver = Shelver.from_args(writer(sys.stdout), revision, all,
6074
 
                file_list, message, destroy=destroy, directory=directory)
 
5855
                file_list, message, destroy=destroy)
6075
5856
            try:
6076
5857
                shelver.run()
6077
5858
            finally:
6079
5860
        except errors.UserAbort:
6080
5861
            return 0
6081
5862
 
6082
 
    def run_for_list(self, directory=None):
6083
 
        if directory is None:
6084
 
            directory = u'.'
6085
 
        tree = WorkingTree.open_containing(directory)[0]
6086
 
        self.add_cleanup(tree.lock_read().unlock)
 
5863
    def run_for_list(self):
 
5864
        tree = WorkingTree.open_containing('.')[0]
 
5865
        tree.lock_read()
 
5866
        self.add_cleanup(tree.unlock)
6087
5867
        manager = tree.get_shelf_manager()
6088
5868
        shelves = manager.active_shelves()
6089
5869
        if len(shelves) == 0:
6098
5878
 
6099
5879
 
6100
5880
class cmd_unshelve(Command):
6101
 
    __doc__ = """Restore shelved changes.
 
5881
    """Restore shelved changes.
6102
5882
 
6103
5883
    By default, the most recently shelved changes are restored. However if you
6104
5884
    specify a shelf by id those changes will be restored instead.  This works
6107
5887
 
6108
5888
    takes_args = ['shelf_id?']
6109
5889
    takes_options = [
6110
 
        'directory',
6111
5890
        RegistryOption.from_kwargs(
6112
5891
            'action', help="The action to perform.",
6113
5892
            enum_switch=False, value_switches=True,
6121
5900
    ]
6122
5901
    _see_also = ['shelve']
6123
5902
 
6124
 
    def run(self, shelf_id=None, action='apply', directory=u'.'):
 
5903
    def run(self, shelf_id=None, action='apply'):
6125
5904
        from bzrlib.shelf_ui import Unshelver
6126
 
        unshelver = Unshelver.from_args(shelf_id, action, directory=directory)
 
5905
        unshelver = Unshelver.from_args(shelf_id, action)
6127
5906
        try:
6128
5907
            unshelver.run()
6129
5908
        finally:
6131
5910
 
6132
5911
 
6133
5912
class cmd_clean_tree(Command):
6134
 
    __doc__ = """Remove unwanted files from working tree.
 
5913
    """Remove unwanted files from working tree.
6135
5914
 
6136
5915
    By default, only unknown files, not ignored files, are deleted.  Versioned
6137
5916
    files are never deleted.
6145
5924
 
6146
5925
    To check what clean-tree will do, use --dry-run.
6147
5926
    """
6148
 
    takes_options = ['directory',
6149
 
                     Option('ignored', help='Delete all ignored files.'),
6150
 
                     Option('detritus', help='Delete conflict files, merge and revert'
 
5927
    takes_options = [Option('ignored', help='Delete all ignored files.'),
 
5928
                     Option('detritus', help='Delete conflict files, merge'
6151
5929
                            ' backups, and failed selftest dirs.'),
6152
5930
                     Option('unknown',
6153
5931
                            help='Delete files unknown to bzr (default).'),
6155
5933
                            ' deleting them.'),
6156
5934
                     Option('force', help='Do not prompt before deleting.')]
6157
5935
    def run(self, unknown=False, ignored=False, detritus=False, dry_run=False,
6158
 
            force=False, directory=u'.'):
 
5936
            force=False):
6159
5937
        from bzrlib.clean_tree import clean_tree
6160
5938
        if not (unknown or ignored or detritus):
6161
5939
            unknown = True
6162
5940
        if dry_run:
6163
5941
            force = True
6164
 
        clean_tree(directory, unknown=unknown, ignored=ignored,
6165
 
                   detritus=detritus, dry_run=dry_run, no_prompt=force)
 
5942
        clean_tree('.', unknown=unknown, ignored=ignored, detritus=detritus,
 
5943
                   dry_run=dry_run, no_prompt=force)
6166
5944
 
6167
5945
 
6168
5946
class cmd_reference(Command):
6169
 
    __doc__ = """list, view and set branch locations for nested trees.
 
5947
    """list, view and set branch locations for nested trees.
6170
5948
 
6171
5949
    If no arguments are provided, lists the branch locations for nested trees.
6172
5950
    If one argument is provided, display the branch location for that tree.
6212
5990
            self.outf.write('%s %s\n' % (path, location))
6213
5991
 
6214
5992
 
6215
 
class cmd_export_pot(Command):
6216
 
    __doc__ = """Export command helps and error messages in po format."""
6217
 
 
6218
 
    hidden = True
6219
 
 
6220
 
    def run(self):
6221
 
        from bzrlib.export_pot import export_pot
6222
 
        export_pot(self.outf)
6223
 
 
6224
 
 
6225
5993
def _register_lazy_builtins():
6226
5994
    # register lazy builtins from other modules; called at startup and should
6227
5995
    # be only called once.
6228
5996
    for (name, aliases, module_name) in [
6229
5997
        ('cmd_bundle_info', [], 'bzrlib.bundle.commands'),
6230
 
        ('cmd_config', [], 'bzrlib.config'),
6231
5998
        ('cmd_dpush', [], 'bzrlib.foreign'),
6232
5999
        ('cmd_version_info', [], 'bzrlib.cmd_version_info'),
6233
6000
        ('cmd_resolve', ['resolved'], 'bzrlib.conflicts'),
6234
6001
        ('cmd_conflicts', [], 'bzrlib.conflicts'),
6235
 
        ('cmd_sign_my_commits', [], 'bzrlib.commit_signature_commands'),
6236
 
        ('cmd_verify_signatures', [],
6237
 
                                        'bzrlib.commit_signature_commands'),
6238
 
        ('cmd_test_script', [], 'bzrlib.cmd_test_script'),
 
6002
        ('cmd_sign_my_commits', [], 'bzrlib.sign_my_commits'),
6239
6003
        ]:
6240
6004
        builtin_command_registry.register_lazy(name, aliases, module_name)