← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/builtins.py

  • Committer: Martin Pool
  • Date: 2009-07-02 03:48:25 UTC
  • mto: This revision was merged to the branch mainline in revision 4502.
  • Revision ID: mbp@sourcefrog.net-20090702034825-2330z69r93a701ws
iter(i) returns i so we don't need a check

Show diffs side-by-side

added added

removed removed

Lines of Context:
bzrlib/builtins.py
1
 
# Copyright (C) 2005-2010 Canonical Ltd
 
1
# Copyright (C) 2004, 2005, 2006, 2007, 2008, 2009 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
31
31
    bundle,
32
32
    btree_index,
33
33
    bzrdir,
34
 
    directory_service,
35
34
    delta,
36
35
    config,
37
36
    errors,
44
43
    reconfigure,
45
44
    rename_map,
46
45
    revision as _mod_revision,
47
 
    static_tuple,
48
46
    symbol_versioning,
49
 
    timestamp,
50
47
    transport,
 
48
    tree as _mod_tree,
51
49
    ui,
52
50
    urlutils,
53
51
    views,
54
52
    )
55
53
from bzrlib.branch import Branch
56
54
from bzrlib.conflicts import ConflictList
57
 
from bzrlib.transport import memory
58
55
from bzrlib.revisionspec import RevisionSpec, RevisionInfo
59
56
from bzrlib.smtp_connection import SMTPConnection
60
57
from bzrlib.workingtree import WorkingTree
61
58
""")
62
59
 
63
 
from bzrlib.commands import (
64
 
    Command,
65
 
    builtin_command_registry,
66
 
    display_command,
67
 
    )
 
60
from bzrlib.commands import Command, display_command
68
61
from bzrlib.option import (
69
62
    ListOption,
70
63
    Option,
128
121
 
129
122
 
130
123
def _get_one_revision_tree(command_name, revisions, branch=None, tree=None):
131
 
    """Get a revision tree. Not suitable for commands that change the tree.
132
 
    
133
 
    Specifically, the basis tree in dirstate trees is coupled to the dirstate
134
 
    and doing a commit/uncommit/pull will at best fail due to changing the
135
 
    basis revision data.
136
 
 
137
 
    If tree is passed in, it should be already locked, for lifetime management
138
 
    of the trees internal cached state.
139
 
    """
140
124
    if branch is None:
141
125
        branch = tree.branch
142
126
    if revisions is None:
239
223
# opens the branch?)
240
224
 
241
225
class cmd_status(Command):
242
 
    __doc__ = """Display status summary.
 
226
    """Display status summary.
243
227
 
244
228
    This reports on versioned and unknown files, reporting them
245
229
    grouped by state.  Possible states are:
265
249
    unknown
266
250
        Not versioned and not matching an ignore pattern.
267
251
 
268
 
    Additionally for directories, symlinks and files with an executable
269
 
    bit, Bazaar indicates their type using a trailing character: '/', '@'
270
 
    or '*' respectively.
271
 
 
272
252
    To see ignored files use 'bzr ignored'.  For details on the
273
253
    changes to file texts, use 'bzr diff'.
274
254
 
332
312
 
333
313
 
334
314
class cmd_cat_revision(Command):
335
 
    __doc__ = """Write out metadata for a revision.
 
315
    """Write out metadata for a revision.
336
316
 
337
317
    The revision to print can either be specified by a specific
338
318
    revision identifier, or you can use --revision.
344
324
    # cat-revision is more for frontends so should be exact
345
325
    encoding = 'strict'
346
326
 
347
 
    def print_revision(self, revisions, revid):
348
 
        stream = revisions.get_record_stream([(revid,)], 'unordered', True)
349
 
        record = stream.next()
350
 
        if record.storage_kind == 'absent':
351
 
            raise errors.NoSuchRevision(revisions, revid)
352
 
        revtext = record.get_bytes_as('fulltext')
353
 
        self.outf.write(revtext.decode('utf-8'))
354
 
 
355
327
    @display_command
356
328
    def run(self, revision_id=None, revision=None):
357
329
        if revision_id is not None and revision is not None:
362
334
                                         ' --revision or a revision_id')
363
335
        b = WorkingTree.open_containing(u'.')[0].branch
364
336
 
365
 
        revisions = b.repository.revisions
366
 
        if revisions is None:
367
 
            raise errors.BzrCommandError('Repository %r does not support '
368
 
                'access to raw revision texts')
 
337
        # TODO: jam 20060112 should cat-revision always output utf-8?
 
338
        if revision_id is not None:
 
339
            revision_id = osutils.safe_revision_id(revision_id, warn=False)
 
340
            try:
 
341
                self.outf.write(b.repository.get_revision_xml(revision_id).decode('utf-8'))
 
342
            except errors.NoSuchRevision:
 
343
                msg = "The repository %s contains no revision %s." % (b.repository.base,
 
344
                    revision_id)
 
345
                raise errors.BzrCommandError(msg)
 
346
        elif revision is not None:
 
347
            for rev in revision:
 
348
                if rev is None:
 
349
                    raise errors.BzrCommandError('You cannot specify a NULL'
 
350
                                                 ' revision.')
 
351
                rev_id = rev.as_revision_id(b)
 
352
                self.outf.write(b.repository.get_revision_xml(rev_id).decode('utf-8'))
369
353
 
370
 
        b.repository.lock_read()
371
 
        try:
372
 
            # TODO: jam 20060112 should cat-revision always output utf-8?
373
 
            if revision_id is not None:
374
 
                revision_id = osutils.safe_revision_id(revision_id, warn=False)
375
 
                try:
376
 
                    self.print_revision(revisions, revision_id)
377
 
                except errors.NoSuchRevision:
378
 
                    msg = "The repository %s contains no revision %s." % (
379
 
                        b.repository.base, revision_id)
380
 
                    raise errors.BzrCommandError(msg)
381
 
            elif revision is not None:
382
 
                for rev in revision:
383
 
                    if rev is None:
384
 
                        raise errors.BzrCommandError(
385
 
                            'You cannot specify a NULL revision.')
386
 
                    rev_id = rev.as_revision_id(b)
387
 
                    self.print_revision(revisions, rev_id)
388
 
        finally:
389
 
            b.repository.unlock()
390
 
        
391
354
 
392
355
class cmd_dump_btree(Command):
393
 
    __doc__ = """Dump the contents of a btree index file to stdout.
 
356
    """Dump the contents of a btree index file to stdout.
394
357
 
395
358
    PATH is a btree index file, it can be any URL. This includes things like
396
359
    .bzr/repository/pack-names, or .bzr/repository/indices/a34b3a...ca4a4.iix
460
423
        for node in bt.iter_all_entries():
461
424
            # Node is made up of:
462
425
            # (index, key, value, [references])
463
 
            try:
464
 
                refs = node[3]
465
 
            except IndexError:
466
 
                refs_as_tuples = None
467
 
            else:
468
 
                refs_as_tuples = static_tuple.as_tuples(refs)
469
 
            as_tuple = (tuple(node[1]), node[2], refs_as_tuples)
470
 
            self.outf.write('%s\n' % (as_tuple,))
 
426
            self.outf.write('%s\n' % (node[1:],))
471
427
 
472
428
 
473
429
class cmd_remove_tree(Command):
474
 
    __doc__ = """Remove the working tree from a given branch/checkout.
 
430
    """Remove the working tree from a given branch/checkout.
475
431
 
476
432
    Since a lightweight checkout is little more than a working tree
477
433
    this will refuse to run against one.
479
435
    To re-create the working tree, use "bzr checkout".
480
436
    """
481
437
    _see_also = ['checkout', 'working-trees']
482
 
    takes_args = ['location*']
 
438
    takes_args = ['location?']
483
439
    takes_options = [
484
440
        Option('force',
485
441
               help='Remove the working tree even if it has '
486
442
                    'uncommitted changes.'),
487
443
        ]
488
444
 
489
 
    def run(self, location_list, force=False):
490
 
        if not location_list:
491
 
            location_list=['.']
492
 
 
493
 
        for location in location_list:
494
 
            d = bzrdir.BzrDir.open(location)
495
 
            
496
 
            try:
497
 
                working = d.open_workingtree()
498
 
            except errors.NoWorkingTree:
499
 
                raise errors.BzrCommandError("No working tree to remove")
500
 
            except errors.NotLocalUrl:
501
 
                raise errors.BzrCommandError("You cannot remove the working tree"
502
 
                                             " of a remote path")
503
 
            if not force:
504
 
                if (working.has_changes()):
505
 
                    raise errors.UncommittedChanges(working)
506
 
 
507
 
            if working.user_url != working.branch.user_url:
508
 
                raise errors.BzrCommandError("You cannot remove the working tree"
509
 
                                             " from a lightweight checkout")
510
 
 
511
 
            d.destroy_workingtree()
 
445
    def run(self, location='.', force=False):
 
446
        d = bzrdir.BzrDir.open(location)
 
447
 
 
448
        try:
 
449
            working = d.open_workingtree()
 
450
        except errors.NoWorkingTree:
 
451
            raise errors.BzrCommandError("No working tree to remove")
 
452
        except errors.NotLocalUrl:
 
453
            raise errors.BzrCommandError("You cannot remove the working tree of a "
 
454
                                         "remote path")
 
455
        if not force:
 
456
            changes = working.changes_from(working.basis_tree())
 
457
            if changes.has_changed():
 
458
                raise errors.UncommittedChanges(working)
 
459
 
 
460
        working_path = working.bzrdir.root_transport.base
 
461
        branch_path = working.branch.bzrdir.root_transport.base
 
462
        if working_path != branch_path:
 
463
            raise errors.BzrCommandError("You cannot remove the working tree from "
 
464
                                         "a lightweight checkout")
 
465
 
 
466
        d.destroy_workingtree()
512
467
 
513
468
 
514
469
class cmd_revno(Command):
515
 
    __doc__ = """Show current revision number.
 
470
    """Show current revision number.
516
471
 
517
472
    This is equal to the number of revisions on this branch.
518
473
    """
519
474
 
520
475
    _see_also = ['info']
521
476
    takes_args = ['location?']
522
 
    takes_options = [
523
 
        Option('tree', help='Show revno of working tree'),
524
 
        ]
525
477
 
526
478
    @display_command
527
 
    def run(self, tree=False, location=u'.'):
528
 
        if tree:
529
 
            try:
530
 
                wt = WorkingTree.open_containing(location)[0]
531
 
                self.add_cleanup(wt.lock_read().unlock)
532
 
            except (errors.NoWorkingTree, errors.NotLocalUrl):
533
 
                raise errors.NoWorkingTree(location)
534
 
            revid = wt.last_revision()
535
 
            try:
536
 
                revno_t = wt.branch.revision_id_to_dotted_revno(revid)
537
 
            except errors.NoSuchRevision:
538
 
                revno_t = ('???',)
539
 
            revno = ".".join(str(n) for n in revno_t)
540
 
        else:
541
 
            b = Branch.open_containing(location)[0]
542
 
            self.add_cleanup(b.lock_read().unlock)
543
 
            revno = b.revno()
544
 
        self.cleanup_now()
545
 
        self.outf.write(str(revno) + '\n')
 
479
    def run(self, location=u'.'):
 
480
        self.outf.write(str(Branch.open_containing(location)[0].revno()))
 
481
        self.outf.write('\n')
546
482
 
547
483
 
548
484
class cmd_revision_info(Command):
549
 
    __doc__ = """Show revision number and revision id for a given revision identifier.
 
485
    """Show revision number and revision id for a given revision identifier.
550
486
    """
551
487
    hidden = True
552
488
    takes_args = ['revision_info*']
558
494
            short_name='d',
559
495
            type=unicode,
560
496
            ),
561
 
        Option('tree', help='Show revno of working tree'),
562
497
        ]
563
498
 
564
499
    @display_command
565
 
    def run(self, revision=None, directory=u'.', tree=False,
566
 
            revision_info_list=[]):
 
500
    def run(self, revision=None, directory=u'.', revision_info_list=[]):
567
501
 
568
 
        try:
569
 
            wt = WorkingTree.open_containing(directory)[0]
570
 
            b = wt.branch
571
 
            self.add_cleanup(wt.lock_read().unlock)
572
 
        except (errors.NoWorkingTree, errors.NotLocalUrl):
573
 
            wt = None
574
 
            b = Branch.open_containing(directory)[0]
575
 
            self.add_cleanup(b.lock_read().unlock)
576
 
        revision_ids = []
 
502
        revs = []
577
503
        if revision is not None:
578
 
            revision_ids.extend(rev.as_revision_id(b) for rev in revision)
 
504
            revs.extend(revision)
579
505
        if revision_info_list is not None:
580
 
            for rev_str in revision_info_list:
581
 
                rev_spec = RevisionSpec.from_string(rev_str)
582
 
                revision_ids.append(rev_spec.as_revision_id(b))
583
 
        # No arguments supplied, default to the last revision
584
 
        if len(revision_ids) == 0:
585
 
            if tree:
586
 
                if wt is None:
587
 
                    raise errors.NoWorkingTree(directory)
588
 
                revision_ids.append(wt.last_revision())
589
 
            else:
590
 
                revision_ids.append(b.last_revision())
591
 
 
592
 
        revinfos = []
593
 
        maxlen = 0
594
 
        for revision_id in revision_ids:
 
506
            for rev in revision_info_list:
 
507
                revs.append(RevisionSpec.from_string(rev))
 
508
 
 
509
        b = Branch.open_containing(directory)[0]
 
510
 
 
511
        if len(revs) == 0:
 
512
            revs.append(RevisionSpec.from_string('-1'))
 
513
 
 
514
        for rev in revs:
 
515
            revision_id = rev.as_revision_id(b)
595
516
            try:
596
 
                dotted_revno = b.revision_id_to_dotted_revno(revision_id)
597
 
                revno = '.'.join(str(i) for i in dotted_revno)
 
517
                revno = '%4d' % (b.revision_id_to_revno(revision_id))
598
518
            except errors.NoSuchRevision:
599
 
                revno = '???'
600
 
            maxlen = max(maxlen, len(revno))
601
 
            revinfos.append([revno, revision_id])
602
 
 
603
 
        self.cleanup_now()
604
 
        for ri in revinfos:
605
 
            self.outf.write('%*s %s\n' % (maxlen, ri[0], ri[1]))
 
519
                dotted_map = b.get_revision_id_to_revno_map()
 
520
                revno = '.'.join(str(i) for i in dotted_map[revision_id])
 
521
            print '%s %s' % (revno, revision_id)
606
522
 
607
523
 
608
524
class cmd_add(Command):
609
 
    __doc__ = """Add specified files or directories.
 
525
    """Add specified files or directories.
610
526
 
611
527
    In non-recursive mode, all the named items are added, regardless
612
528
    of whether they were previously ignored.  A warning is given if
638
554
    branches that will be merged later (without showing the two different
639
555
    adds as a conflict). It is also useful when merging another project
640
556
    into a subdirectory of this one.
641
 
    
642
 
    Any files matching patterns in the ignore list will not be added
643
 
    unless they are explicitly mentioned.
644
557
    """
645
558
    takes_args = ['file*']
646
559
    takes_options = [
654
567
               help='Lookup file ids from this tree.'),
655
568
        ]
656
569
    encoding_type = 'replace'
657
 
    _see_also = ['remove', 'ignore']
 
570
    _see_also = ['remove']
658
571
 
659
572
    def run(self, file_list, no_recurse=False, dry_run=False, verbose=False,
660
573
            file_ids_from=None):
677
590
                should_print=(not is_quiet()))
678
591
 
679
592
        if base_tree:
680
 
            self.add_cleanup(base_tree.lock_read().unlock)
681
 
        tree, file_list = tree_files_for_add(file_list)
682
 
        added, ignored = tree.smart_add(file_list, not
683
 
            no_recurse, action=action, save=not dry_run)
684
 
        self.cleanup_now()
 
593
            base_tree.lock_read()
 
594
        try:
 
595
            file_list = self._maybe_expand_globs(file_list)
 
596
            tree, file_list = tree_files_for_add(file_list)
 
597
            added, ignored = tree.smart_add(file_list, not
 
598
                no_recurse, action=action, save=not dry_run)
 
599
        finally:
 
600
            if base_tree is not None:
 
601
                base_tree.unlock()
685
602
        if len(ignored) > 0:
686
603
            if verbose:
687
604
                for glob in sorted(ignored.keys()):
688
605
                    for path in ignored[glob]:
689
606
                        self.outf.write("ignored %s matching \"%s\"\n"
690
607
                                        % (path, glob))
 
608
            else:
 
609
                match_len = 0
 
610
                for glob, paths in ignored.items():
 
611
                    match_len += len(paths)
 
612
                self.outf.write("ignored %d file(s).\n" % match_len)
 
613
            self.outf.write("If you wish to add ignored files, "
 
614
                            "please add them explicitly by name. "
 
615
                            "(\"bzr ignored\" gives a list)\n")
691
616
 
692
617
 
693
618
class cmd_mkdir(Command):
694
 
    __doc__ = """Create a new versioned directory.
 
619
    """Create a new versioned directory.
695
620
 
696
621
    This is equivalent to creating the directory and then adding it.
697
622
    """
701
626
 
702
627
    def run(self, dir_list):
703
628
        for d in dir_list:
 
629
            os.mkdir(d)
704
630
            wt, dd = WorkingTree.open_containing(d)
705
 
            base = os.path.dirname(dd)
706
 
            id = wt.path2id(base)
707
 
            if id != None:
708
 
                os.mkdir(d)
709
 
                wt.add([dd])
710
 
                self.outf.write('added %s\n' % d)
711
 
            else:
712
 
                raise errors.NotVersionedError(path=base)
 
631
            wt.add([dd])
 
632
            self.outf.write('added %s\n' % d)
713
633
 
714
634
 
715
635
class cmd_relpath(Command):
716
 
    __doc__ = """Show path of a file relative to root"""
 
636
    """Show path of a file relative to root"""
717
637
 
718
638
    takes_args = ['filename']
719
639
    hidden = True
728
648
 
729
649
 
730
650
class cmd_inventory(Command):
731
 
    __doc__ = """Show inventory of the current working copy or a revision.
 
651
    """Show inventory of the current working copy or a revision.
732
652
 
733
653
    It is possible to limit the output to a particular entry
734
654
    type using the --kind option.  For example: --kind file.
755
675
 
756
676
        revision = _get_one_revision('inventory', revision)
757
677
        work_tree, file_list = tree_files(file_list)
758
 
        self.add_cleanup(work_tree.lock_read().unlock)
759
 
        if revision is not None:
760
 
            tree = revision.as_tree(work_tree.branch)
761
 
 
762
 
            extra_trees = [work_tree]
763
 
            self.add_cleanup(tree.lock_read().unlock)
764
 
        else:
765
 
            tree = work_tree
766
 
            extra_trees = []
767
 
 
768
 
        if file_list is not None:
769
 
            file_ids = tree.paths2ids(file_list, trees=extra_trees,
770
 
                                      require_versioned=True)
771
 
            # find_ids_across_trees may include some paths that don't
772
 
            # exist in 'tree'.
773
 
            entries = sorted((tree.id2path(file_id), tree.inventory[file_id])
774
 
                             for file_id in file_ids if file_id in tree)
775
 
        else:
776
 
            entries = tree.inventory.entries()
777
 
 
778
 
        self.cleanup_now()
 
678
        work_tree.lock_read()
 
679
        try:
 
680
            if revision is not None:
 
681
                tree = revision.as_tree(work_tree.branch)
 
682
 
 
683
                extra_trees = [work_tree]
 
684
                tree.lock_read()
 
685
            else:
 
686
                tree = work_tree
 
687
                extra_trees = []
 
688
 
 
689
            if file_list is not None:
 
690
                file_ids = tree.paths2ids(file_list, trees=extra_trees,
 
691
                                          require_versioned=True)
 
692
                # find_ids_across_trees may include some paths that don't
 
693
                # exist in 'tree'.
 
694
                entries = sorted((tree.id2path(file_id), tree.inventory[file_id])
 
695
                                 for file_id in file_ids if file_id in tree)
 
696
            else:
 
697
                entries = tree.inventory.entries()
 
698
        finally:
 
699
            tree.unlock()
 
700
            if tree is not work_tree:
 
701
                work_tree.unlock()
 
702
 
779
703
        for path, entry in entries:
780
704
            if kind and kind != entry.kind:
781
705
                continue
787
711
 
788
712
 
789
713
class cmd_mv(Command):
790
 
    __doc__ = """Move or rename a file.
 
714
    """Move or rename a file.
791
715
 
792
716
    :Usage:
793
717
        bzr mv OLDNAME NEWNAME
826
750
        if len(names_list) < 2:
827
751
            raise errors.BzrCommandError("missing file argument")
828
752
        tree, rel_names = tree_files(names_list, canonicalize=False)
829
 
        self.add_cleanup(tree.lock_tree_write().unlock)
830
 
        self._run(tree, names_list, rel_names, after)
 
753
        tree.lock_write()
 
754
        try:
 
755
            self._run(tree, names_list, rel_names, after)
 
756
        finally:
 
757
            tree.unlock()
831
758
 
832
759
    def run_auto(self, names_list, after, dry_run):
833
760
        if names_list is not None and len(names_list) > 1:
837
764
            raise errors.BzrCommandError('--after cannot be specified with'
838
765
                                         ' --auto.')
839
766
        work_tree, file_list = tree_files(names_list, default_branch='.')
840
 
        self.add_cleanup(work_tree.lock_tree_write().unlock)
841
 
        rename_map.RenameMap.guess_renames(work_tree, dry_run)
 
767
        work_tree.lock_write()
 
768
        try:
 
769
            rename_map.RenameMap.guess_renames(work_tree, dry_run)
 
770
        finally:
 
771
            work_tree.unlock()
842
772
 
843
773
    def _run(self, tree, names_list, rel_names, after):
844
774
        into_existing = osutils.isdir(names_list[-1])
865
795
            # All entries reference existing inventory items, so fix them up
866
796
            # for cicp file-systems.
867
797
            rel_names = tree.get_canonical_inventory_paths(rel_names)
868
 
            for src, dest in tree.move(rel_names[:-1], rel_names[-1], after=after):
869
 
                if not is_quiet():
870
 
                    self.outf.write("%s => %s\n" % (src, dest))
 
798
            for pair in tree.move(rel_names[:-1], rel_names[-1], after=after):
 
799
                self.outf.write("%s => %s\n" % pair)
871
800
        else:
872
801
            if len(names_list) != 2:
873
802
                raise errors.BzrCommandError('to mv multiple files the'
917
846
            dest = osutils.pathjoin(dest_parent, dest_tail)
918
847
            mutter("attempting to move %s => %s", src, dest)
919
848
            tree.rename_one(src, dest, after=after)
920
 
            if not is_quiet():
921
 
                self.outf.write("%s => %s\n" % (src, dest))
 
849
            self.outf.write("%s => %s\n" % (src, dest))
922
850
 
923
851
 
924
852
class cmd_pull(Command):
925
 
    __doc__ = """Turn this branch into a mirror of another branch.
 
853
    """Turn this branch into a mirror of another branch.
926
854
 
927
 
    By default, this command only works on branches that have not diverged.
928
 
    Branches are considered diverged if the destination branch's most recent 
929
 
    commit is one that has not been merged (directly or indirectly) into the 
930
 
    parent.
 
855
    This command only works on branches that have not diverged.  Branches are
 
856
    considered diverged if the destination branch's most recent commit is one
 
857
    that has not been merged (directly or indirectly) into the parent.
931
858
 
932
859
    If branches have diverged, you can use 'bzr merge' to integrate the changes
933
860
    from one into the other.  Once one branch has merged, the other should
934
861
    be able to pull it again.
935
862
 
936
 
    If you want to replace your local changes and just want your branch to
937
 
    match the remote one, use pull --overwrite. This will work even if the two
938
 
    branches have diverged.
 
863
    If you want to forget your local changes and just update your branch to
 
864
    match the remote one, use pull --overwrite.
939
865
 
940
866
    If there is no default location set, the first pull will set it.  After
941
867
    that, you can omit the location to use the default.  To change the
977
903
        try:
978
904
            tree_to = WorkingTree.open_containing(directory)[0]
979
905
            branch_to = tree_to.branch
980
 
            self.add_cleanup(tree_to.lock_write().unlock)
981
906
        except errors.NoWorkingTree:
982
907
            tree_to = None
983
908
            branch_to = Branch.open_containing(directory)[0]
984
 
            self.add_cleanup(branch_to.lock_write().unlock)
985
 
 
 
909
        
986
910
        if local and not branch_to.get_bound_location():
987
911
            raise errors.LocalRequiresBoundBranch()
988
912
 
1018
942
        else:
1019
943
            branch_from = Branch.open(location,
1020
944
                possible_transports=possible_transports)
1021
 
            self.add_cleanup(branch_from.lock_read().unlock)
1022
945
 
1023
946
            if branch_to.get_parent() is None or remember:
1024
947
                branch_to.set_parent(branch_from.base)
1025
948
 
1026
 
        if revision is not None:
1027
 
            revision_id = revision.as_revision_id(branch_from)
1028
 
 
1029
 
        if tree_to is not None:
1030
 
            view_info = _get_view_info_for_change_reporter(tree_to)
1031
 
            change_reporter = delta._ChangeReporter(
1032
 
                unversioned_filter=tree_to.is_ignored,
1033
 
                view_info=view_info)
1034
 
            result = tree_to.pull(
1035
 
                branch_from, overwrite, revision_id, change_reporter,
1036
 
                possible_transports=possible_transports, local=local)
1037
 
        else:
1038
 
            result = branch_to.pull(
1039
 
                branch_from, overwrite, revision_id, local=local)
1040
 
 
1041
 
        result.report(self.outf)
1042
 
        if verbose and result.old_revid != result.new_revid:
1043
 
            log.show_branch_change(
1044
 
                branch_to, self.outf, result.old_revno,
1045
 
                result.old_revid)
 
949
        if branch_from is not branch_to:
 
950
            branch_from.lock_read()
 
951
        try:
 
952
            if revision is not None:
 
953
                revision_id = revision.as_revision_id(branch_from)
 
954
 
 
955
            branch_to.lock_write()
 
956
            try:
 
957
                if tree_to is not None:
 
958
                    view_info = _get_view_info_for_change_reporter(tree_to)
 
959
                    change_reporter = delta._ChangeReporter(
 
960
                        unversioned_filter=tree_to.is_ignored,
 
961
                        view_info=view_info)
 
962
                    result = tree_to.pull(
 
963
                        branch_from, overwrite, revision_id, change_reporter,
 
964
                        possible_transports=possible_transports, local=local)
 
965
                else:
 
966
                    result = branch_to.pull(
 
967
                        branch_from, overwrite, revision_id, local=local)
 
968
 
 
969
                result.report(self.outf)
 
970
                if verbose and result.old_revid != result.new_revid:
 
971
                    log.show_branch_change(
 
972
                        branch_to, self.outf, result.old_revno,
 
973
                        result.old_revid)
 
974
            finally:
 
975
                branch_to.unlock()
 
976
        finally:
 
977
            if branch_from is not branch_to:
 
978
                branch_from.unlock()
1046
979
 
1047
980
 
1048
981
class cmd_push(Command):
1049
 
    __doc__ = """Update a mirror of this branch.
 
982
    """Update a mirror of this branch.
1050
983
 
1051
984
    The target branch will not have its working tree populated because this
1052
985
    is both expensive, and is not supported on remote file systems.
1097
1030
            type=unicode),
1098
1031
        Option('strict',
1099
1032
               help='Refuse to push if there are uncommitted changes in'
1100
 
               ' the working tree, --no-strict disables the check.'),
 
1033
               ' the working tree.'),
1101
1034
        ]
1102
1035
    takes_args = ['location?']
1103
1036
    encoding_type = 'replace'
1113
1046
        # Get the source branch
1114
1047
        (tree, br_from,
1115
1048
         _unused) = bzrdir.BzrDir.open_containing_tree_or_branch(directory)
 
1049
        if strict is None:
 
1050
            strict = br_from.get_config().get_user_option('push_strict')
 
1051
            if strict is not None:
 
1052
                # FIXME: This should be better supported by config
 
1053
                # -- vila 20090611
 
1054
                bools = dict(yes=True, no=False, on=True, off=False,
 
1055
                             true=True, false=False)
 
1056
                try:
 
1057
                    strict = bools[strict.lower()]
 
1058
                except KeyError:
 
1059
                    strict = None
 
1060
        if strict:
 
1061
            changes = tree.changes_from(tree.basis_tree())
 
1062
            if changes.has_changed():
 
1063
                raise errors.UncommittedChanges(tree)
1116
1064
        # Get the tip's revision_id
1117
1065
        revision = _get_one_revision('push', revision)
1118
1066
        if revision is not None:
1119
1067
            revision_id = revision.in_history(br_from).rev_id
1120
1068
        else:
1121
1069
            revision_id = None
1122
 
        if tree is not None and revision_id is None:
1123
 
            tree.check_changed_or_out_of_date(
1124
 
                strict, 'push_strict',
1125
 
                more_error='Use --no-strict to force the push.',
1126
 
                more_warning='Uncommitted changes will not be pushed.')
 
1070
 
1127
1071
        # Get the stacked_on branch, if any
1128
1072
        if stacked_on is not None:
1129
1073
            stacked_on = urlutils.normalize_url(stacked_on)
1161
1105
 
1162
1106
 
1163
1107
class cmd_branch(Command):
1164
 
    __doc__ = """Create a new branch that is a copy of an existing branch.
 
1108
    """Create a new branch that is a copy of an existing branch.
1165
1109
 
1166
1110
    If the TO_LOCATION is omitted, the last component of the FROM_LOCATION will
1167
1111
    be used.  In other words, "branch ../foo/bar" will attempt to create ./bar.
1180
1124
        help='Hard-link working tree files where possible.'),
1181
1125
        Option('no-tree',
1182
1126
            help="Create a branch without a working-tree."),
1183
 
        Option('switch',
1184
 
            help="Switch the checkout in the current directory "
1185
 
                 "to the new branch."),
1186
1127
        Option('stacked',
1187
1128
            help='Create a stacked branch referring to the source branch. '
1188
1129
                'The new branch will depend on the availability of the source '
1189
1130
                'branch for all operations.'),
1190
1131
        Option('standalone',
1191
1132
               help='Do not use a shared repository, even if available.'),
1192
 
        Option('use-existing-dir',
1193
 
               help='By default branch will fail if the target'
1194
 
                    ' directory exists, but does not already'
1195
 
                    ' have a control directory.  This flag will'
1196
 
                    ' allow branch to proceed.'),
1197
 
        Option('bind',
1198
 
            help="Bind new branch to from location."),
1199
1133
        ]
1200
1134
    aliases = ['get', 'clone']
1201
1135
 
1202
1136
    def run(self, from_location, to_location=None, revision=None,
1203
 
            hardlink=False, stacked=False, standalone=False, no_tree=False,
1204
 
            use_existing_dir=False, switch=False, bind=False):
1205
 
        from bzrlib import switch as _mod_switch
 
1137
            hardlink=False, stacked=False, standalone=False, no_tree=False):
1206
1138
        from bzrlib.tag import _merge_tags_if_possible
 
1139
 
1207
1140
        accelerator_tree, br_from = bzrdir.BzrDir.open_tree_or_branch(
1208
1141
            from_location)
 
1142
        if (accelerator_tree is not None and
 
1143
            accelerator_tree.supports_content_filtering()):
 
1144
            accelerator_tree = None
1209
1145
        revision = _get_one_revision('branch', revision)
1210
 
        self.add_cleanup(br_from.lock_read().unlock)
1211
 
        if revision is not None:
1212
 
            revision_id = revision.as_revision_id(br_from)
1213
 
        else:
1214
 
            # FIXME - wt.last_revision, fallback to branch, fall back to
1215
 
            # None or perhaps NULL_REVISION to mean copy nothing
1216
 
            # RBC 20060209
1217
 
            revision_id = br_from.last_revision()
1218
 
        if to_location is None:
1219
 
            to_location = urlutils.derive_to_location(from_location)
1220
 
        to_transport = transport.get_transport(to_location)
 
1146
        br_from.lock_read()
1221
1147
        try:
1222
 
            to_transport.mkdir('.')
1223
 
        except errors.FileExists:
1224
 
            if not use_existing_dir:
1225
 
                raise errors.BzrCommandError('Target directory "%s" '
1226
 
                    'already exists.' % to_location)
 
1148
            if revision is not None:
 
1149
                revision_id = revision.as_revision_id(br_from)
1227
1150
            else:
1228
 
                try:
1229
 
                    bzrdir.BzrDir.open_from_transport(to_transport)
1230
 
                except errors.NotBranchError:
1231
 
                    pass
1232
 
                else:
1233
 
                    raise errors.AlreadyBranchError(to_location)
1234
 
        except errors.NoSuchFile:
1235
 
            raise errors.BzrCommandError('Parent of "%s" does not exist.'
1236
 
                                         % to_location)
1237
 
        try:
1238
 
            # preserve whatever source format we have.
1239
 
            dir = br_from.bzrdir.sprout(to_transport.base, revision_id,
1240
 
                                        possible_transports=[to_transport],
1241
 
                                        accelerator_tree=accelerator_tree,
1242
 
                                        hardlink=hardlink, stacked=stacked,
1243
 
                                        force_new_repo=standalone,
1244
 
                                        create_tree_if_local=not no_tree,
1245
 
                                        source_branch=br_from)
1246
 
            branch = dir.open_branch()
1247
 
        except errors.NoSuchRevision:
1248
 
            to_transport.delete_tree('.')
1249
 
            msg = "The branch %s has no revision %s." % (from_location,
1250
 
                revision)
1251
 
            raise errors.BzrCommandError(msg)
1252
 
        _merge_tags_if_possible(br_from, branch)
1253
 
        # If the source branch is stacked, the new branch may
1254
 
        # be stacked whether we asked for that explicitly or not.
1255
 
        # We therefore need a try/except here and not just 'if stacked:'
1256
 
        try:
1257
 
            note('Created new stacked branch referring to %s.' %
1258
 
                branch.get_stacked_on_url())
1259
 
        except (errors.NotStacked, errors.UnstackableBranchFormat,
1260
 
            errors.UnstackableRepositoryFormat), e:
1261
 
            note('Branched %d revision(s).' % branch.revno())
1262
 
        if bind:
1263
 
            # Bind to the parent
1264
 
            parent_branch = Branch.open(from_location)
1265
 
            branch.bind(parent_branch)
1266
 
            note('New branch bound to %s' % from_location)
1267
 
        if switch:
1268
 
            # Switch to the new branch
1269
 
            wt, _ = WorkingTree.open_containing('.')
1270
 
            _mod_switch.switch(wt.bzrdir, branch)
1271
 
            note('Switched to branch: %s',
1272
 
                urlutils.unescape_for_display(branch.base, 'utf-8'))
 
1151
                # FIXME - wt.last_revision, fallback to branch, fall back to
 
1152
                # None or perhaps NULL_REVISION to mean copy nothing
 
1153
                # RBC 20060209
 
1154
                revision_id = br_from.last_revision()
 
1155
            if to_location is None:
 
1156
                to_location = urlutils.derive_to_location(from_location)
 
1157
            to_transport = transport.get_transport(to_location)
 
1158
            try:
 
1159
                to_transport.mkdir('.')
 
1160
            except errors.FileExists:
 
1161
                raise errors.BzrCommandError('Target directory "%s" already'
 
1162
                                             ' exists.' % to_location)
 
1163
            except errors.NoSuchFile:
 
1164
                raise errors.BzrCommandError('Parent of "%s" does not exist.'
 
1165
                                             % to_location)
 
1166
            try:
 
1167
                # preserve whatever source format we have.
 
1168
                dir = br_from.bzrdir.sprout(to_transport.base, revision_id,
 
1169
                                            possible_transports=[to_transport],
 
1170
                                            accelerator_tree=accelerator_tree,
 
1171
                                            hardlink=hardlink, stacked=stacked,
 
1172
                                            force_new_repo=standalone,
 
1173
                                            create_tree_if_local=not no_tree,
 
1174
                                            source_branch=br_from)
 
1175
                branch = dir.open_branch()
 
1176
            except errors.NoSuchRevision:
 
1177
                to_transport.delete_tree('.')
 
1178
                msg = "The branch %s has no revision %s." % (from_location,
 
1179
                    revision)
 
1180
                raise errors.BzrCommandError(msg)
 
1181
            _merge_tags_if_possible(br_from, branch)
 
1182
            # If the source branch is stacked, the new branch may
 
1183
            # be stacked whether we asked for that explicitly or not.
 
1184
            # We therefore need a try/except here and not just 'if stacked:'
 
1185
            try:
 
1186
                note('Created new stacked branch referring to %s.' %
 
1187
                    branch.get_stacked_on_url())
 
1188
            except (errors.NotStacked, errors.UnstackableBranchFormat,
 
1189
                errors.UnstackableRepositoryFormat), e:
 
1190
                note('Branched %d revision(s).' % branch.revno())
 
1191
        finally:
 
1192
            br_from.unlock()
1273
1193
 
1274
1194
 
1275
1195
class cmd_checkout(Command):
1276
 
    __doc__ = """Create a new checkout of an existing branch.
 
1196
    """Create a new checkout of an existing branch.
1277
1197
 
1278
1198
    If BRANCH_LOCATION is omitted, checkout will reconstitute a working tree for
1279
1199
    the branch found in '.'. This is useful if you have removed the working tree
1342
1262
 
1343
1263
 
1344
1264
class cmd_renames(Command):
1345
 
    __doc__ = """Show list of renamed files.
 
1265
    """Show list of renamed files.
1346
1266
    """
1347
1267
    # TODO: Option to show renames between two historical versions.
1348
1268
 
1353
1273
    @display_command
1354
1274
    def run(self, dir=u'.'):
1355
1275
        tree = WorkingTree.open_containing(dir)[0]
1356
 
        self.add_cleanup(tree.lock_read().unlock)
1357
 
        new_inv = tree.inventory
1358
 
        old_tree = tree.basis_tree()
1359
 
        self.add_cleanup(old_tree.lock_read().unlock)
1360
 
        old_inv = old_tree.inventory
1361
 
        renames = []
1362
 
        iterator = tree.iter_changes(old_tree, include_unchanged=True)
1363
 
        for f, paths, c, v, p, n, k, e in iterator:
1364
 
            if paths[0] == paths[1]:
1365
 
                continue
1366
 
            if None in (paths):
1367
 
                continue
1368
 
            renames.append(paths)
1369
 
        renames.sort()
1370
 
        for old_name, new_name in renames:
1371
 
            self.outf.write("%s => %s\n" % (old_name, new_name))
 
1276
        tree.lock_read()
 
1277
        try:
 
1278
            new_inv = tree.inventory
 
1279
            old_tree = tree.basis_tree()
 
1280
            old_tree.lock_read()
 
1281
            try:
 
1282
                old_inv = old_tree.inventory
 
1283
                renames = []
 
1284
                iterator = tree.iter_changes(old_tree, include_unchanged=True)
 
1285
                for f, paths, c, v, p, n, k, e in iterator:
 
1286
                    if paths[0] == paths[1]:
 
1287
                        continue
 
1288
                    if None in (paths):
 
1289
                        continue
 
1290
                    renames.append(paths)
 
1291
                renames.sort()
 
1292
                for old_name, new_name in renames:
 
1293
                    self.outf.write("%s => %s\n" % (old_name, new_name))
 
1294
            finally:
 
1295
                old_tree.unlock()
 
1296
        finally:
 
1297
            tree.unlock()
1372
1298
 
1373
1299
 
1374
1300
class cmd_update(Command):
1375
 
    __doc__ = """Update a tree to have the latest code committed to its branch.
 
1301
    """Update a tree to have the latest code committed to its branch.
1376
1302
 
1377
1303
    This will perform a merge into the working tree, and may generate
1378
1304
    conflicts. If you have any local changes, you will still
1380
1306
 
1381
1307
    If you want to discard your local changes, you can just do a
1382
1308
    'bzr revert' instead of 'bzr commit' after the update.
1383
 
 
1384
 
    If the tree's branch is bound to a master branch, it will also update
1385
 
    the branch from the master.
1386
1309
    """
1387
1310
 
1388
1311
    _see_also = ['pull', 'working-trees', 'status-flags']
1389
1312
    takes_args = ['dir?']
1390
 
    takes_options = ['revision']
1391
1313
    aliases = ['up']
1392
1314
 
1393
 
    def run(self, dir='.', revision=None):
1394
 
        if revision is not None and len(revision) != 1:
1395
 
            raise errors.BzrCommandError(
1396
 
                        "bzr update --revision takes exactly one revision")
 
1315
    def run(self, dir='.'):
1397
1316
        tree = WorkingTree.open_containing(dir)[0]
1398
 
        branch = tree.branch
1399
1317
        possible_transports = []
1400
 
        master = branch.get_master_branch(
 
1318
        master = tree.branch.get_master_branch(
1401
1319
            possible_transports=possible_transports)
1402
1320
        if master is not None:
1403
 
            branch_location = master.base
1404
1321
            tree.lock_write()
1405
1322
        else:
1406
 
            branch_location = tree.branch.base
1407
1323
            tree.lock_tree_write()
1408
 
        self.add_cleanup(tree.unlock)
1409
 
        # get rid of the final '/' and be ready for display
1410
 
        branch_location = urlutils.unescape_for_display(
1411
 
            branch_location.rstrip('/'),
1412
 
            self.outf.encoding)
1413
 
        existing_pending_merges = tree.get_parent_ids()[1:]
1414
 
        if master is None:
1415
 
            old_tip = None
1416
 
        else:
1417
 
            # may need to fetch data into a heavyweight checkout
1418
 
            # XXX: this may take some time, maybe we should display a
1419
 
            # message
1420
 
            old_tip = branch.update(possible_transports)
1421
 
        if revision is not None:
1422
 
            revision_id = revision[0].as_revision_id(branch)
1423
 
        else:
1424
 
            revision_id = branch.last_revision()
1425
 
        if revision_id == _mod_revision.ensure_null(tree.last_revision()):
1426
 
            revno = branch.revision_id_to_dotted_revno(revision_id)
1427
 
            note("Tree is up to date at revision %s of branch %s" %
1428
 
                ('.'.join(map(str, revno)), branch_location))
1429
 
            return 0
1430
 
        view_info = _get_view_info_for_change_reporter(tree)
1431
 
        change_reporter = delta._ChangeReporter(
1432
 
            unversioned_filter=tree.is_ignored,
1433
 
            view_info=view_info)
1434
1324
        try:
 
1325
            existing_pending_merges = tree.get_parent_ids()[1:]
 
1326
            last_rev = _mod_revision.ensure_null(tree.last_revision())
 
1327
            if last_rev == _mod_revision.ensure_null(
 
1328
                tree.branch.last_revision()):
 
1329
                # may be up to date, check master too.
 
1330
                if master is None or last_rev == _mod_revision.ensure_null(
 
1331
                    master.last_revision()):
 
1332
                    revno = tree.branch.revision_id_to_revno(last_rev)
 
1333
                    note("Tree is up to date at revision %d." % (revno,))
 
1334
                    return 0
 
1335
            view_info = _get_view_info_for_change_reporter(tree)
1435
1336
            conflicts = tree.update(
1436
 
                change_reporter,
1437
 
                possible_transports=possible_transports,
1438
 
                revision=revision_id,
1439
 
                old_tip=old_tip)
1440
 
        except errors.NoSuchRevision, e:
1441
 
            raise errors.BzrCommandError(
1442
 
                                  "branch has no revision %s\n"
1443
 
                                  "bzr update --revision only works"
1444
 
                                  " for a revision in the branch history"
1445
 
                                  % (e.revision))
1446
 
        revno = tree.branch.revision_id_to_dotted_revno(
1447
 
            _mod_revision.ensure_null(tree.last_revision()))
1448
 
        note('Updated to revision %s of branch %s' %
1449
 
             ('.'.join(map(str, revno)), branch_location))
1450
 
        parent_ids = tree.get_parent_ids()
1451
 
        if parent_ids[1:] and parent_ids[1:] != existing_pending_merges:
1452
 
            note('Your local commits will now show as pending merges with '
1453
 
                 "'bzr status', and can be committed with 'bzr commit'.")
1454
 
        if conflicts != 0:
1455
 
            return 1
1456
 
        else:
1457
 
            return 0
 
1337
                delta._ChangeReporter(unversioned_filter=tree.is_ignored,
 
1338
                view_info=view_info), possible_transports=possible_transports)
 
1339
            revno = tree.branch.revision_id_to_revno(
 
1340
                _mod_revision.ensure_null(tree.last_revision()))
 
1341
            note('Updated to revision %d.' % (revno,))
 
1342
            if tree.get_parent_ids()[1:] != existing_pending_merges:
 
1343
                note('Your local commits will now show as pending merges with '
 
1344
                     "'bzr status', and can be committed with 'bzr commit'.")
 
1345
            if conflicts != 0:
 
1346
                return 1
 
1347
            else:
 
1348
                return 0
 
1349
        finally:
 
1350
            tree.unlock()
1458
1351
 
1459
1352
 
1460
1353
class cmd_info(Command):
1461
 
    __doc__ = """Show information about a working tree, branch or repository.
 
1354
    """Show information about a working tree, branch or repository.
1462
1355
 
1463
1356
    This command will show all known locations and formats associated to the
1464
1357
    tree, branch or repository.
1502
1395
 
1503
1396
 
1504
1397
class cmd_remove(Command):
1505
 
    __doc__ = """Remove files or directories.
 
1398
    """Remove files or directories.
1506
1399
 
1507
1400
    This makes bzr stop tracking changes to the specified files. bzr will delete
1508
1401
    them if they can easily be recovered using revert. If no options or
1517
1410
            title='Deletion Strategy', value_switches=True, enum_switch=False,
1518
1411
            safe='Only delete files if they can be'
1519
1412
                 ' safely recovered (default).',
1520
 
            keep='Delete from bzr but leave the working copy.',
 
1413
            keep="Don't delete any files.",
1521
1414
            force='Delete all the specified files, even if they can not be '
1522
1415
                'recovered and even if they are non-empty directories.')]
1523
1416
    aliases = ['rm', 'del']
1530
1423
        if file_list is not None:
1531
1424
            file_list = [f for f in file_list]
1532
1425
 
1533
 
        self.add_cleanup(tree.lock_write().unlock)
1534
 
        # Heuristics should probably all move into tree.remove_smart or
1535
 
        # some such?
1536
 
        if new:
1537
 
            added = tree.changes_from(tree.basis_tree(),
1538
 
                specific_files=file_list).added
1539
 
            file_list = sorted([f[0] for f in added], reverse=True)
1540
 
            if len(file_list) == 0:
1541
 
                raise errors.BzrCommandError('No matching files.')
1542
 
        elif file_list is None:
1543
 
            # missing files show up in iter_changes(basis) as
1544
 
            # versioned-with-no-kind.
1545
 
            missing = []
1546
 
            for change in tree.iter_changes(tree.basis_tree()):
1547
 
                # Find paths in the working tree that have no kind:
1548
 
                if change[1][1] is not None and change[6][1] is None:
1549
 
                    missing.append(change[1][1])
1550
 
            file_list = sorted(missing, reverse=True)
1551
 
            file_deletion_strategy = 'keep'
1552
 
        tree.remove(file_list, verbose=verbose, to_file=self.outf,
1553
 
            keep_files=file_deletion_strategy=='keep',
1554
 
            force=file_deletion_strategy=='force')
 
1426
        tree.lock_write()
 
1427
        try:
 
1428
            # Heuristics should probably all move into tree.remove_smart or
 
1429
            # some such?
 
1430
            if new:
 
1431
                added = tree.changes_from(tree.basis_tree(),
 
1432
                    specific_files=file_list).added
 
1433
                file_list = sorted([f[0] for f in added], reverse=True)
 
1434
                if len(file_list) == 0:
 
1435
                    raise errors.BzrCommandError('No matching files.')
 
1436
            elif file_list is None:
 
1437
                # missing files show up in iter_changes(basis) as
 
1438
                # versioned-with-no-kind.
 
1439
                missing = []
 
1440
                for change in tree.iter_changes(tree.basis_tree()):
 
1441
                    # Find paths in the working tree that have no kind:
 
1442
                    if change[1][1] is not None and change[6][1] is None:
 
1443
                        missing.append(change[1][1])
 
1444
                file_list = sorted(missing, reverse=True)
 
1445
                file_deletion_strategy = 'keep'
 
1446
            tree.remove(file_list, verbose=verbose, to_file=self.outf,
 
1447
                keep_files=file_deletion_strategy=='keep',
 
1448
                force=file_deletion_strategy=='force')
 
1449
        finally:
 
1450
            tree.unlock()
1555
1451
 
1556
1452
 
1557
1453
class cmd_file_id(Command):
1558
 
    __doc__ = """Print file_id of a particular file or directory.
 
1454
    """Print file_id of a particular file or directory.
1559
1455
 
1560
1456
    The file_id is assigned when the file is first added and remains the
1561
1457
    same through all revisions where the file exists, even when it is
1577
1473
 
1578
1474
 
1579
1475
class cmd_file_path(Command):
1580
 
    __doc__ = """Print path of file_ids to a file or directory.
 
1476
    """Print path of file_ids to a file or directory.
1581
1477
 
1582
1478
    This prints one line for each directory down to the target,
1583
1479
    starting at the branch root.
1599
1495
 
1600
1496
 
1601
1497
class cmd_reconcile(Command):
1602
 
    __doc__ = """Reconcile bzr metadata in a branch.
 
1498
    """Reconcile bzr metadata in a branch.
1603
1499
 
1604
1500
    This can correct data mismatches that may have been caused by
1605
1501
    previous ghost operations or bzr upgrades. You should only
1627
1523
 
1628
1524
 
1629
1525
class cmd_revision_history(Command):
1630
 
    __doc__ = """Display the list of revision ids on a branch."""
 
1526
    """Display the list of revision ids on a branch."""
1631
1527
 
1632
1528
    _see_also = ['log']
1633
1529
    takes_args = ['location?']
1643
1539
 
1644
1540
 
1645
1541
class cmd_ancestry(Command):
1646
 
    __doc__ = """List all revisions merged into this branch."""
 
1542
    """List all revisions merged into this branch."""
1647
1543
 
1648
1544
    _see_also = ['log', 'revision-history']
1649
1545
    takes_args = ['location?']
1668
1564
 
1669
1565
 
1670
1566
class cmd_init(Command):
1671
 
    __doc__ = """Make a directory into a versioned branch.
 
1567
    """Make a directory into a versioned branch.
1672
1568
 
1673
1569
    Use this to create an empty branch, or before importing an
1674
1570
    existing project.
1702
1598
                lazy_registry=('bzrlib.bzrdir', 'format_registry'),
1703
1599
                converter=lambda name: bzrdir.format_registry.make_bzrdir(name),
1704
1600
                value_switches=True,
1705
 
                title="Branch format",
 
1601
                title="Branch Format",
1706
1602
                ),
1707
1603
         Option('append-revisions-only',
1708
1604
                help='Never change revnos or the existing log.'
1777
1673
 
1778
1674
 
1779
1675
class cmd_init_repository(Command):
1780
 
    __doc__ = """Create a shared repository for branches to share storage space.
 
1676
    """Create a shared repository to hold branches.
1781
1677
 
1782
1678
    New branches created under the repository directory will store their
1783
 
    revisions in the repository, not in the branch directory.  For branches
1784
 
    with shared history, this reduces the amount of storage needed and 
1785
 
    speeds up the creation of new branches.
 
1679
    revisions in the repository, not in the branch directory.
1786
1680
 
1787
 
    If the --no-trees option is given then the branches in the repository
1788
 
    will not have working trees by default.  They will still exist as 
1789
 
    directories on disk, but they will not have separate copies of the 
1790
 
    files at a certain revision.  This can be useful for repositories that
1791
 
    store branches which are interacted with through checkouts or remote
1792
 
    branches, such as on a server.
 
1681
    If the --no-trees option is used then the branches in the repository
 
1682
    will not have working trees by default.
1793
1683
 
1794
1684
    :Examples:
1795
 
        Create a shared repository holding just branches::
 
1685
        Create a shared repositories holding just branches::
1796
1686
 
1797
1687
            bzr init-repo --no-trees repo
1798
1688
            bzr init repo/trunk
1837
1727
 
1838
1728
 
1839
1729
class cmd_diff(Command):
1840
 
    __doc__ = """Show differences in the working tree, between revisions or branches.
 
1730
    """Show differences in the working tree, between revisions or branches.
1841
1731
 
1842
1732
    If no arguments are given, all changes for the current tree are listed.
1843
1733
    If files are given, only the changes in those files are listed.
1864
1754
 
1865
1755
            bzr diff -r1
1866
1756
 
1867
 
        Difference between revision 3 and revision 1::
1868
 
 
1869
 
            bzr diff -r1..3
1870
 
 
1871
 
        Difference between revision 3 and revision 1 for branch xxx::
1872
 
 
1873
 
            bzr diff -r1..3 xxx
1874
 
 
1875
 
        To see the changes introduced in revision X::
1876
 
        
1877
 
            bzr diff -cX
1878
 
 
1879
 
        Note that in the case of a merge, the -c option shows the changes
1880
 
        compared to the left hand parent. To see the changes against
1881
 
        another parent, use::
1882
 
 
1883
 
            bzr diff -r<chosen_parent>..X
1884
 
 
1885
 
        The changes introduced by revision 2 (equivalent to -r1..2)::
1886
 
 
1887
 
            bzr diff -c2
 
1757
        Difference between revision 2 and revision 1::
 
1758
 
 
1759
            bzr diff -r1..2
 
1760
 
 
1761
        Difference between revision 2 and revision 1 for branch xxx::
 
1762
 
 
1763
            bzr diff -r1..2 xxx
1888
1764
 
1889
1765
        Show just the differences for file NEWS::
1890
1766
 
1929
1805
            help='Use this command to compare files.',
1930
1806
            type=unicode,
1931
1807
            ),
1932
 
        RegistryOption('format',
1933
 
            help='Diff format to use.',
1934
 
            lazy_registry=('bzrlib.diff', 'format_registry'),
1935
 
            value_switches=False, title='Diff format'),
1936
1808
        ]
1937
1809
    aliases = ['di', 'dif']
1938
1810
    encoding_type = 'exact'
1939
1811
 
1940
1812
    @display_command
1941
1813
    def run(self, revision=None, file_list=None, diff_options=None,
1942
 
            prefix=None, old=None, new=None, using=None, format=None):
1943
 
        from bzrlib.diff import (get_trees_and_branches_to_diff_locked,
1944
 
            show_diff_trees)
 
1814
            prefix=None, old=None, new=None, using=None):
 
1815
        from bzrlib.diff import _get_trees_to_diff, show_diff_trees
1945
1816
 
1946
1817
        if (prefix is None) or (prefix == '0'):
1947
1818
            # diff -p0 format
1961
1832
            raise errors.BzrCommandError('bzr diff --revision takes exactly'
1962
1833
                                         ' one or two revision specifiers')
1963
1834
 
1964
 
        if using is not None and format is not None:
1965
 
            raise errors.BzrCommandError('--using and --format are mutually '
1966
 
                'exclusive.')
1967
 
 
1968
 
        (old_tree, new_tree,
1969
 
         old_branch, new_branch,
1970
 
         specific_files, extra_trees) = get_trees_and_branches_to_diff_locked(
1971
 
            file_list, revision, old, new, self.add_cleanup, apply_view=True)
 
1835
        old_tree, new_tree, specific_files, extra_trees = \
 
1836
                _get_trees_to_diff(file_list, revision, old, new,
 
1837
                apply_view=True)
1972
1838
        return show_diff_trees(old_tree, new_tree, sys.stdout,
1973
1839
                               specific_files=specific_files,
1974
1840
                               external_diff_options=diff_options,
1975
1841
                               old_label=old_label, new_label=new_label,
1976
 
                               extra_trees=extra_trees, using=using,
1977
 
                               format_cls=format)
 
1842
                               extra_trees=extra_trees, using=using)
1978
1843
 
1979
1844
 
1980
1845
class cmd_deleted(Command):
1981
 
    __doc__ = """List files deleted in the working tree.
 
1846
    """List files deleted in the working tree.
1982
1847
    """
1983
1848
    # TODO: Show files deleted since a previous revision, or
1984
1849
    # between two revisions.
1992
1857
    @display_command
1993
1858
    def run(self, show_ids=False):
1994
1859
        tree = WorkingTree.open_containing(u'.')[0]
1995
 
        self.add_cleanup(tree.lock_read().unlock)
1996
 
        old = tree.basis_tree()
1997
 
        self.add_cleanup(old.lock_read().unlock)
1998
 
        for path, ie in old.inventory.iter_entries():
1999
 
            if not tree.has_id(ie.file_id):
2000
 
                self.outf.write(path)
2001
 
                if show_ids:
2002
 
                    self.outf.write(' ')
2003
 
                    self.outf.write(ie.file_id)
2004
 
                self.outf.write('\n')
 
1860
        tree.lock_read()
 
1861
        try:
 
1862
            old = tree.basis_tree()
 
1863
            old.lock_read()
 
1864
            try:
 
1865
                for path, ie in old.inventory.iter_entries():
 
1866
                    if not tree.has_id(ie.file_id):
 
1867
                        self.outf.write(path)
 
1868
                        if show_ids:
 
1869
                            self.outf.write(' ')
 
1870
                            self.outf.write(ie.file_id)
 
1871
                        self.outf.write('\n')
 
1872
            finally:
 
1873
                old.unlock()
 
1874
        finally:
 
1875
            tree.unlock()
2005
1876
 
2006
1877
 
2007
1878
class cmd_modified(Command):
2008
 
    __doc__ = """List files modified in working tree.
 
1879
    """List files modified in working tree.
2009
1880
    """
2010
1881
 
2011
1882
    hidden = True
2028
1899
 
2029
1900
 
2030
1901
class cmd_added(Command):
2031
 
    __doc__ = """List files added in working tree.
 
1902
    """List files added in working tree.
2032
1903
    """
2033
1904
 
2034
1905
    hidden = True
2042
1913
    @display_command
2043
1914
    def run(self, null=False):
2044
1915
        wt = WorkingTree.open_containing(u'.')[0]
2045
 
        self.add_cleanup(wt.lock_read().unlock)
2046
 
        basis = wt.basis_tree()
2047
 
        self.add_cleanup(basis.lock_read().unlock)
2048
 
        basis_inv = basis.inventory
2049
 
        inv = wt.inventory
2050
 
        for file_id in inv:
2051
 
            if file_id in basis_inv:
2052
 
                continue
2053
 
            if inv.is_root(file_id) and len(basis_inv) == 0:
2054
 
                continue
2055
 
            path = inv.id2path(file_id)
2056
 
            if not os.access(osutils.abspath(path), os.F_OK):
2057
 
                continue
2058
 
            if null:
2059
 
                self.outf.write(path + '\0')
2060
 
            else:
2061
 
                self.outf.write(osutils.quotefn(path) + '\n')
 
1916
        wt.lock_read()
 
1917
        try:
 
1918
            basis = wt.basis_tree()
 
1919
            basis.lock_read()
 
1920
            try:
 
1921
                basis_inv = basis.inventory
 
1922
                inv = wt.inventory
 
1923
                for file_id in inv:
 
1924
                    if file_id in basis_inv:
 
1925
                        continue
 
1926
                    if inv.is_root(file_id) and len(basis_inv) == 0:
 
1927
                        continue
 
1928
                    path = inv.id2path(file_id)
 
1929
                    if not os.access(osutils.abspath(path), os.F_OK):
 
1930
                        continue
 
1931
                    if null:
 
1932
                        self.outf.write(path + '\0')
 
1933
                    else:
 
1934
                        self.outf.write(osutils.quotefn(path) + '\n')
 
1935
            finally:
 
1936
                basis.unlock()
 
1937
        finally:
 
1938
            wt.unlock()
2062
1939
 
2063
1940
 
2064
1941
class cmd_root(Command):
2065
 
    __doc__ = """Show the tree root directory.
 
1942
    """Show the tree root directory.
2066
1943
 
2067
1944
    The root is the nearest enclosing directory with a .bzr control
2068
1945
    directory."""
2092
1969
 
2093
1970
 
2094
1971
class cmd_log(Command):
2095
 
    __doc__ = """Show historical log for a branch or subset of a branch.
 
1972
    """Show historical log for a branch or subset of a branch.
2096
1973
 
2097
1974
    log is bzr's default tool for exploring the history of a branch.
2098
1975
    The branch to use is taken from the first parameter. If no parameters
2209
2086
    :Tips & tricks:
2210
2087
 
2211
2088
      GUI tools and IDEs are often better at exploring history than command
2212
 
      line tools: you may prefer qlog or viz from qbzr or bzr-gtk, the
2213
 
      bzr-explorer shell, or the Loggerhead web interface.  See the Plugin
2214
 
      Guide <http://doc.bazaar.canonical.com/plugins/en/> and
2215
 
      <http://wiki.bazaar.canonical.com/IDEIntegration>.  
 
2089
      line tools. You may prefer qlog or glog from the QBzr and Bzr-Gtk packages
 
2090
      respectively for example. (TortoiseBzr uses qlog for displaying logs.) See
 
2091
      http://bazaar-vcs.org/BzrPlugins and http://bazaar-vcs.org/IDEIntegration.
 
2092
 
 
2093
      Web interfaces are often better at exploring history than command line
 
2094
      tools, particularly for branches on servers. You may prefer Loggerhead
 
2095
      or one of its alternatives. See http://bazaar-vcs.org/WebInterface.
2216
2096
 
2217
2097
      You may find it useful to add the aliases below to ``bazaar.conf``::
2218
2098
 
2279
2159
                   help='Show changes made in each revision as a patch.'),
2280
2160
            Option('include-merges',
2281
2161
                   help='Show merged revisions like --levels 0 does.'),
2282
 
            Option('exclude-common-ancestry',
2283
 
                   help='Display only the revisions that are not part'
2284
 
                   ' of both ancestries (require -rX..Y)'
2285
 
                   )
2286
2162
            ]
2287
2163
    encoding_type = 'replace'
2288
2164
 
2298
2174
            message=None,
2299
2175
            limit=None,
2300
2176
            show_diff=False,
2301
 
            include_merges=False,
2302
 
            exclude_common_ancestry=False,
2303
 
            ):
 
2177
            include_merges=False):
2304
2178
        from bzrlib.log import (
2305
2179
            Logger,
2306
2180
            make_log_request_dict,
2307
2181
            _get_info_for_log_files,
2308
2182
            )
2309
2183
        direction = (forward and 'forward') or 'reverse'
2310
 
        if (exclude_common_ancestry
2311
 
            and (revision is None or len(revision) != 2)):
2312
 
            raise errors.BzrCommandError(
2313
 
                '--exclude-common-ancestry requires -r with two revisions')
2314
2184
        if include_merges:
2315
2185
            if levels is None:
2316
2186
                levels = 0
2331
2201
        filter_by_dir = False
2332
2202
        if file_list:
2333
2203
            # find the file ids to log and check for directory filtering
2334
 
            b, file_info_list, rev1, rev2 = _get_info_for_log_files(
2335
 
                revision, file_list, self.add_cleanup)
 
2204
            b, file_info_list, rev1, rev2 = _get_info_for_log_files(revision,
 
2205
                file_list)
2336
2206
            for relpath, file_id, kind in file_info_list:
2337
2207
                if file_id is None:
2338
2208
                    raise errors.BzrCommandError(
2356
2226
                location = '.'
2357
2227
            dir, relpath = bzrdir.BzrDir.open_containing(location)
2358
2228
            b = dir.open_branch()
2359
 
            self.add_cleanup(b.lock_read().unlock)
2360
2229
            rev1, rev2 = _get_revision_range(revision, b, self.name())
2361
2230
 
2362
2231
        # Decide on the type of delta & diff filtering to use
2372
2241
        else:
2373
2242
            diff_type = 'full'
2374
2243
 
2375
 
        # Build the log formatter
2376
 
        if log_format is None:
2377
 
            log_format = log.log_formatter_registry.get_default(b)
2378
 
        # Make a non-encoding output to include the diffs - bug 328007
2379
 
        unencoded_output = ui.ui_factory.make_output_stream(encoding_type='exact')
2380
 
        lf = log_format(show_ids=show_ids, to_file=self.outf,
2381
 
                        to_exact_file=unencoded_output,
2382
 
                        show_timezone=timezone,
2383
 
                        delta_format=get_verbosity_level(),
2384
 
                        levels=levels,
2385
 
                        show_advice=levels is None)
2386
 
 
2387
 
        # Choose the algorithm for doing the logging. It's annoying
2388
 
        # having multiple code paths like this but necessary until
2389
 
        # the underlying repository format is faster at generating
2390
 
        # deltas or can provide everything we need from the indices.
2391
 
        # The default algorithm - match-using-deltas - works for
2392
 
        # multiple files and directories and is faster for small
2393
 
        # amounts of history (200 revisions say). However, it's too
2394
 
        # slow for logging a single file in a repository with deep
2395
 
        # history, i.e. > 10K revisions. In the spirit of "do no
2396
 
        # evil when adding features", we continue to use the
2397
 
        # original algorithm - per-file-graph - for the "single
2398
 
        # file that isn't a directory without showing a delta" case.
2399
 
        partial_history = revision and b.repository._format.supports_chks
2400
 
        match_using_deltas = (len(file_ids) != 1 or filter_by_dir
2401
 
            or delta_type or partial_history)
2402
 
 
2403
 
        # Build the LogRequest and execute it
2404
 
        if len(file_ids) == 0:
2405
 
            file_ids = None
2406
 
        rqst = make_log_request_dict(
2407
 
            direction=direction, specific_fileids=file_ids,
2408
 
            start_revision=rev1, end_revision=rev2, limit=limit,
2409
 
            message_search=message, delta_type=delta_type,
2410
 
            diff_type=diff_type, _match_using_deltas=match_using_deltas,
2411
 
            exclude_common_ancestry=exclude_common_ancestry,
2412
 
            )
2413
 
        Logger(b, rqst).show(lf)
 
2244
        b.lock_read()
 
2245
        try:
 
2246
            # Build the log formatter
 
2247
            if log_format is None:
 
2248
                log_format = log.log_formatter_registry.get_default(b)
 
2249
            lf = log_format(show_ids=show_ids, to_file=self.outf,
 
2250
                            show_timezone=timezone,
 
2251
                            delta_format=get_verbosity_level(),
 
2252
                            levels=levels,
 
2253
                            show_advice=levels is None)
 
2254
 
 
2255
            # Choose the algorithm for doing the logging. It's annoying
 
2256
            # having multiple code paths like this but necessary until
 
2257
            # the underlying repository format is faster at generating
 
2258
            # deltas or can provide everything we need from the indices.
 
2259
            # The default algorithm - match-using-deltas - works for
 
2260
            # multiple files and directories and is faster for small
 
2261
            # amounts of history (200 revisions say). However, it's too
 
2262
            # slow for logging a single file in a repository with deep
 
2263
            # history, i.e. > 10K revisions. In the spirit of "do no
 
2264
            # evil when adding features", we continue to use the
 
2265
            # original algorithm - per-file-graph - for the "single
 
2266
            # file that isn't a directory without showing a delta" case.
 
2267
            partial_history = revision and b.repository._format.supports_chks
 
2268
            match_using_deltas = (len(file_ids) != 1 or filter_by_dir
 
2269
                or delta_type or partial_history)
 
2270
 
 
2271
            # Build the LogRequest and execute it
 
2272
            if len(file_ids) == 0:
 
2273
                file_ids = None
 
2274
            rqst = make_log_request_dict(
 
2275
                direction=direction, specific_fileids=file_ids,
 
2276
                start_revision=rev1, end_revision=rev2, limit=limit,
 
2277
                message_search=message, delta_type=delta_type,
 
2278
                diff_type=diff_type, _match_using_deltas=match_using_deltas)
 
2279
            Logger(b, rqst).show(lf)
 
2280
        finally:
 
2281
            b.unlock()
2414
2282
 
2415
2283
 
2416
2284
def _get_revision_range(revisionspec_list, branch, command_name):
2434
2302
            raise errors.BzrCommandError(
2435
2303
                "bzr %s doesn't accept two revisions in different"
2436
2304
                " branches." % command_name)
2437
 
        if start_spec.spec is None:
2438
 
            # Avoid loading all the history.
2439
 
            rev1 = RevisionInfo(branch, None, None)
2440
 
        else:
2441
 
            rev1 = start_spec.in_history(branch)
 
2305
        rev1 = start_spec.in_history(branch)
2442
2306
        # Avoid loading all of history when we know a missing
2443
2307
        # end of range means the last revision ...
2444
2308
        if end_spec.spec is None:
2473
2337
 
2474
2338
 
2475
2339
class cmd_touching_revisions(Command):
2476
 
    __doc__ = """Return revision-ids which affected a particular file.
 
2340
    """Return revision-ids which affected a particular file.
2477
2341
 
2478
2342
    A more user-friendly interface is "bzr log FILE".
2479
2343
    """
2484
2348
    @display_command
2485
2349
    def run(self, filename):
2486
2350
        tree, relpath = WorkingTree.open_containing(filename)
 
2351
        b = tree.branch
2487
2352
        file_id = tree.path2id(relpath)
2488
 
        b = tree.branch
2489
 
        self.add_cleanup(b.lock_read().unlock)
2490
 
        touching_revs = log.find_touching_revisions(b, file_id)
2491
 
        for revno, revision_id, what in touching_revs:
 
2353
        for revno, revision_id, what in log.find_touching_revisions(b, file_id):
2492
2354
            self.outf.write("%6d %s\n" % (revno, what))
2493
2355
 
2494
2356
 
2495
2357
class cmd_ls(Command):
2496
 
    __doc__ = """List files in a tree.
 
2358
    """List files in a tree.
2497
2359
    """
2498
2360
 
2499
2361
    _see_also = ['status', 'cat']
2547
2409
        if from_root:
2548
2410
            if relpath:
2549
2411
                prefix = relpath + '/'
2550
 
        elif fs_path != '.' and not fs_path.endswith('/'):
 
2412
        elif fs_path != '.':
2551
2413
            prefix = fs_path + '/'
2552
2414
 
2553
2415
        if revision is not None or tree is None:
2561
2423
                view_str = views.view_display_str(view_files)
2562
2424
                note("Ignoring files outside view. View is %s" % view_str)
2563
2425
 
2564
 
        self.add_cleanup(tree.lock_read().unlock)
2565
 
        for fp, fc, fkind, fid, entry in tree.list_files(include_root=False,
2566
 
            from_dir=relpath, recursive=recursive):
2567
 
            # Apply additional masking
2568
 
            if not all and not selection[fc]:
2569
 
                continue
2570
 
            if kind is not None and fkind != kind:
2571
 
                continue
2572
 
            if apply_view:
2573
 
                try:
2574
 
                    if relpath:
2575
 
                        fullpath = osutils.pathjoin(relpath, fp)
2576
 
                    else:
2577
 
                        fullpath = fp
2578
 
                    views.check_path_in_view(tree, fullpath)
2579
 
                except errors.FileOutsideView:
2580
 
                    continue
 
2426
        tree.lock_read()
 
2427
        try:
 
2428
            for fp, fc, fkind, fid, entry in tree.list_files(include_root=False,
 
2429
                from_dir=relpath, recursive=recursive):
 
2430
                # Apply additional masking
 
2431
                if not all and not selection[fc]:
 
2432
                    continue
 
2433
                if kind is not None and fkind != kind:
 
2434
                    continue
 
2435
                if apply_view:
 
2436
                    try:
 
2437
                        if relpath:
 
2438
                            fullpath = osutils.pathjoin(relpath, fp)
 
2439
                        else:
 
2440
                            fullpath = fp
 
2441
                        views.check_path_in_view(tree, fullpath)
 
2442
                    except errors.FileOutsideView:
 
2443
                        continue
2581
2444
 
2582
 
            # Output the entry
2583
 
            if prefix:
2584
 
                fp = osutils.pathjoin(prefix, fp)
2585
 
            kindch = entry.kind_character()
2586
 
            outstring = fp + kindch
2587
 
            ui.ui_factory.clear_term()
2588
 
            if verbose:
2589
 
                outstring = '%-8s %s' % (fc, outstring)
2590
 
                if show_ids and fid is not None:
2591
 
                    outstring = "%-50s %s" % (outstring, fid)
2592
 
                self.outf.write(outstring + '\n')
2593
 
            elif null:
2594
 
                self.outf.write(fp + '\0')
2595
 
                if show_ids:
2596
 
                    if fid is not None:
2597
 
                        self.outf.write(fid)
2598
 
                    self.outf.write('\0')
2599
 
                self.outf.flush()
2600
 
            else:
2601
 
                if show_ids:
2602
 
                    if fid is not None:
2603
 
                        my_id = fid
2604
 
                    else:
2605
 
                        my_id = ''
2606
 
                    self.outf.write('%-50s %s\n' % (outstring, my_id))
2607
 
                else:
 
2445
                # Output the entry
 
2446
                if prefix:
 
2447
                    fp = osutils.pathjoin(prefix, fp)
 
2448
                kindch = entry.kind_character()
 
2449
                outstring = fp + kindch
 
2450
                ui.ui_factory.clear_term()
 
2451
                if verbose:
 
2452
                    outstring = '%-8s %s' % (fc, outstring)
 
2453
                    if show_ids and fid is not None:
 
2454
                        outstring = "%-50s %s" % (outstring, fid)
2608
2455
                    self.outf.write(outstring + '\n')
 
2456
                elif null:
 
2457
                    self.outf.write(fp + '\0')
 
2458
                    if show_ids:
 
2459
                        if fid is not None:
 
2460
                            self.outf.write(fid)
 
2461
                        self.outf.write('\0')
 
2462
                    self.outf.flush()
 
2463
                else:
 
2464
                    if show_ids:
 
2465
                        if fid is not None:
 
2466
                            my_id = fid
 
2467
                        else:
 
2468
                            my_id = ''
 
2469
                        self.outf.write('%-50s %s\n' % (outstring, my_id))
 
2470
                    else:
 
2471
                        self.outf.write(outstring + '\n')
 
2472
        finally:
 
2473
            tree.unlock()
2609
2474
 
2610
2475
 
2611
2476
class cmd_unknowns(Command):
2612
 
    __doc__ = """List unknown files.
 
2477
    """List unknown files.
2613
2478
    """
2614
2479
 
2615
2480
    hidden = True
2622
2487
 
2623
2488
 
2624
2489
class cmd_ignore(Command):
2625
 
    __doc__ = """Ignore specified files or patterns.
 
2490
    """Ignore specified files or patterns.
2626
2491
 
2627
2492
    See ``bzr help patterns`` for details on the syntax of patterns.
2628
2493
 
2629
 
    If a .bzrignore file does not exist, the ignore command
2630
 
    will create one and add the specified files or patterns to the newly
2631
 
    created file. The ignore command will also automatically add the 
2632
 
    .bzrignore file to be versioned. Creating a .bzrignore file without
2633
 
    the use of the ignore command will require an explicit add command.
2634
 
 
2635
2494
    To remove patterns from the ignore list, edit the .bzrignore file.
2636
2495
    After adding, editing or deleting that file either indirectly by
2637
2496
    using this command or directly by using an editor, be sure to commit
2638
2497
    it.
2639
 
    
2640
 
    Bazaar also supports a global ignore file ~/.bazaar/ignore. On Windows
2641
 
    the global ignore file can be found in the application data directory as
2642
 
    C:\\Documents and Settings\\<user>\\Application Data\\Bazaar\\2.0\\ignore.
2643
 
    Global ignores are not touched by this command. The global ignore file
2644
 
    can be edited directly using an editor.
2645
 
 
2646
 
    Patterns prefixed with '!' are exceptions to ignore patterns and take
2647
 
    precedence over regular ignores.  Such exceptions are used to specify
2648
 
    files that should be versioned which would otherwise be ignored.
2649
 
    
2650
 
    Patterns prefixed with '!!' act as regular ignore patterns, but have
2651
 
    precedence over the '!' exception patterns.
2652
2498
 
2653
2499
    Note: ignore patterns containing shell wildcards must be quoted from
2654
2500
    the shell on Unix.
2658
2504
 
2659
2505
            bzr ignore ./Makefile
2660
2506
 
2661
 
        Ignore .class files in all directories...::
 
2507
        Ignore class files in all directories::
2662
2508
 
2663
2509
            bzr ignore "*.class"
2664
2510
 
2665
 
        ...but do not ignore "special.class"::
2666
 
 
2667
 
            bzr ignore "!special.class"
2668
 
 
2669
2511
        Ignore .o files under the lib directory::
2670
2512
 
2671
2513
            bzr ignore "lib/**/*.o"
2677
2519
        Ignore everything but the "debian" toplevel directory::
2678
2520
 
2679
2521
            bzr ignore "RE:(?!debian/).*"
2680
 
        
2681
 
        Ignore everything except the "local" toplevel directory,
2682
 
        but always ignore "*~" autosave files, even under local/::
2683
 
        
2684
 
            bzr ignore "*"
2685
 
            bzr ignore "!./local"
2686
 
            bzr ignore "!!*~"
2687
2522
    """
2688
2523
 
2689
2524
    _see_also = ['status', 'ignored', 'patterns']
2690
2525
    takes_args = ['name_pattern*']
2691
2526
    takes_options = [
2692
 
        Option('default-rules',
2693
 
               help='Display the default ignore rules that bzr uses.')
 
2527
        Option('old-default-rules',
 
2528
               help='Write out the ignore rules bzr < 0.9 always used.')
2694
2529
        ]
2695
2530
 
2696
 
    def run(self, name_pattern_list=None, default_rules=None):
 
2531
    def run(self, name_pattern_list=None, old_default_rules=None):
2697
2532
        from bzrlib import ignores
2698
 
        if default_rules is not None:
2699
 
            # dump the default rules and exit
2700
 
            for pattern in ignores.USER_DEFAULTS:
2701
 
                self.outf.write("%s\n" % pattern)
 
2533
        if old_default_rules is not None:
 
2534
            # dump the rules and exit
 
2535
            for pattern in ignores.OLD_DEFAULTS:
 
2536
                print pattern
2702
2537
            return
2703
2538
        if not name_pattern_list:
2704
2539
            raise errors.BzrCommandError("ignore requires at least one "
2705
 
                "NAME_PATTERN or --default-rules.")
 
2540
                                  "NAME_PATTERN or --old-default-rules")
2706
2541
        name_pattern_list = [globbing.normalize_pattern(p)
2707
2542
                             for p in name_pattern_list]
2708
2543
        for name_pattern in name_pattern_list:
2720
2555
            if id is not None:
2721
2556
                filename = entry[0]
2722
2557
                if ignored.match(filename):
2723
 
                    matches.append(filename)
 
2558
                    matches.append(filename.encode('utf-8'))
2724
2559
        tree.unlock()
2725
2560
        if len(matches) > 0:
2726
 
            self.outf.write("Warning: the following files are version controlled and"
2727
 
                  " match your ignore pattern:\n%s"
2728
 
                  "\nThese files will continue to be version controlled"
2729
 
                  " unless you 'bzr remove' them.\n" % ("\n".join(matches),))
 
2561
            print "Warning: the following files are version controlled and" \
 
2562
                  " match your ignore pattern:\n%s" \
 
2563
                  "\nThese files will continue to be version controlled" \
 
2564
                  " unless you 'bzr remove' them." % ("\n".join(matches),)
2730
2565
 
2731
2566
 
2732
2567
class cmd_ignored(Command):
2733
 
    __doc__ = """List ignored files and the patterns that matched them.
 
2568
    """List ignored files and the patterns that matched them.
2734
2569
 
2735
2570
    List all the ignored files and the ignore pattern that caused the file to
2736
2571
    be ignored.
2746
2581
    @display_command
2747
2582
    def run(self):
2748
2583
        tree = WorkingTree.open_containing(u'.')[0]
2749
 
        self.add_cleanup(tree.lock_read().unlock)
2750
 
        for path, file_class, kind, file_id, entry in tree.list_files():
2751
 
            if file_class != 'I':
2752
 
                continue
2753
 
            ## XXX: Slightly inefficient since this was already calculated
2754
 
            pat = tree.is_ignored(path)
2755
 
            self.outf.write('%-50s %s\n' % (path, pat))
 
2584
        tree.lock_read()
 
2585
        try:
 
2586
            for path, file_class, kind, file_id, entry in tree.list_files():
 
2587
                if file_class != 'I':
 
2588
                    continue
 
2589
                ## XXX: Slightly inefficient since this was already calculated
 
2590
                pat = tree.is_ignored(path)
 
2591
                self.outf.write('%-50s %s\n' % (path, pat))
 
2592
        finally:
 
2593
            tree.unlock()
2756
2594
 
2757
2595
 
2758
2596
class cmd_lookup_revision(Command):
2759
 
    __doc__ = """Lookup the revision-id from a revision-number
 
2597
    """Lookup the revision-id from a revision-number
2760
2598
 
2761
2599
    :Examples:
2762
2600
        bzr lookup-revision 33
2769
2607
        try:
2770
2608
            revno = int(revno)
2771
2609
        except ValueError:
2772
 
            raise errors.BzrCommandError("not a valid revision-number: %r"
2773
 
                                         % revno)
2774
 
        revid = WorkingTree.open_containing(u'.')[0].branch.get_rev_id(revno)
2775
 
        self.outf.write("%s\n" % revid)
 
2610
            raise errors.BzrCommandError("not a valid revision-number: %r" % revno)
 
2611
 
 
2612
        print WorkingTree.open_containing(u'.')[0].branch.get_rev_id(revno)
2776
2613
 
2777
2614
 
2778
2615
class cmd_export(Command):
2779
 
    __doc__ = """Export current or past revision to a destination directory or archive.
 
2616
    """Export current or past revision to a destination directory or archive.
2780
2617
 
2781
2618
    If no revision is specified this exports the last committed revision.
2782
2619
 
2814
2651
        Option('root',
2815
2652
               type=str,
2816
2653
               help="Name of the root directory inside the exported file."),
2817
 
        Option('per-file-timestamps',
2818
 
               help='Set modification time of files to that of the last '
2819
 
                    'revision in which it was changed.'),
2820
2654
        ]
2821
2655
    def run(self, dest, branch_or_subdir=None, revision=None, format=None,
2822
 
        root=None, filters=False, per_file_timestamps=False):
 
2656
        root=None, filters=False):
2823
2657
        from bzrlib.export import export
2824
2658
 
2825
2659
        if branch_or_subdir is None:
2832
2666
 
2833
2667
        rev_tree = _get_one_revision_tree('export', revision, branch=b, tree=tree)
2834
2668
        try:
2835
 
            export(rev_tree, dest, format, root, subdir, filtered=filters,
2836
 
                   per_file_timestamps=per_file_timestamps)
 
2669
            export(rev_tree, dest, format, root, subdir, filtered=filters)
2837
2670
        except errors.NoSuchExportFormat, e:
2838
2671
            raise errors.BzrCommandError('Unsupported export format: %s' % e.format)
2839
2672
 
2840
2673
 
2841
2674
class cmd_cat(Command):
2842
 
    __doc__ = """Write the contents of a file as of a given revision to standard output.
 
2675
    """Write the contents of a file as of a given revision to standard output.
2843
2676
 
2844
2677
    If no revision is nominated, the last revision is used.
2845
2678
 
2865
2698
                                         " one revision specifier")
2866
2699
        tree, branch, relpath = \
2867
2700
            bzrdir.BzrDir.open_containing_tree_or_branch(filename)
2868
 
        self.add_cleanup(branch.lock_read().unlock)
2869
 
        return self._run(tree, branch, relpath, filename, revision,
2870
 
                         name_from_revision, filters)
 
2701
        branch.lock_read()
 
2702
        try:
 
2703
            return self._run(tree, branch, relpath, filename, revision,
 
2704
                             name_from_revision, filters)
 
2705
        finally:
 
2706
            branch.unlock()
2871
2707
 
2872
2708
    def _run(self, tree, b, relpath, filename, revision, name_from_revision,
2873
2709
        filtered):
2874
2710
        if tree is None:
2875
2711
            tree = b.basis_tree()
2876
2712
        rev_tree = _get_one_revision_tree('cat', revision, branch=b)
2877
 
        self.add_cleanup(rev_tree.lock_read().unlock)
2878
2713
 
2879
2714
        old_file_id = rev_tree.path2id(relpath)
2880
2715
 
2915
2750
            chunks = content.splitlines(True)
2916
2751
            content = filtered_output_bytes(chunks, filters,
2917
2752
                ContentFilterContext(relpath, rev_tree))
2918
 
            self.cleanup_now()
2919
2753
            self.outf.writelines(content)
2920
2754
        else:
2921
 
            self.cleanup_now()
2922
2755
            self.outf.write(content)
2923
2756
 
2924
2757
 
2925
2758
class cmd_local_time_offset(Command):
2926
 
    __doc__ = """Show the offset in seconds from GMT to local time."""
 
2759
    """Show the offset in seconds from GMT to local time."""
2927
2760
    hidden = True
2928
2761
    @display_command
2929
2762
    def run(self):
2930
 
        self.outf.write("%s\n" % osutils.local_time_offset())
 
2763
        print osutils.local_time_offset()
2931
2764
 
2932
2765
 
2933
2766
 
2934
2767
class cmd_commit(Command):
2935
 
    __doc__ = """Commit changes into a new revision.
 
2768
    """Commit changes into a new revision.
2936
2769
 
2937
2770
    An explanatory message needs to be given for each commit. This is
2938
2771
    often done by using the --message option (getting the message from the
3031
2864
             Option('strict',
3032
2865
                    help="Refuse to commit if there are unknown "
3033
2866
                    "files in the working tree."),
3034
 
             Option('commit-time', type=str,
3035
 
                    help="Manually set a commit time using commit date "
3036
 
                    "format, e.g. '2009-10-10 08:00:00 +0100'."),
3037
2867
             ListOption('fixes', type=str,
3038
2868
                    help="Mark a bug as being fixed by this revision "
3039
2869
                         "(see \"bzr help bugs\")."),
3046
2876
                         "the master branch until a normal commit "
3047
2877
                         "is performed."
3048
2878
                    ),
3049
 
             Option('show-diff', short_name='p',
3050
 
                    help='When no message is supplied, show the diff along'
3051
 
                    ' with the status summary in the message editor.'),
 
2879
              Option('show-diff',
 
2880
                     help='When no message is supplied, show the diff along'
 
2881
                     ' with the status summary in the message editor.'),
3052
2882
             ]
3053
2883
    aliases = ['ci', 'checkin']
3054
2884
 
3073
2903
 
3074
2904
    def run(self, message=None, file=None, verbose=False, selected_list=None,
3075
2905
            unchanged=False, strict=False, local=False, fixes=None,
3076
 
            author=None, show_diff=False, exclude=None, commit_time=None):
 
2906
            author=None, show_diff=False, exclude=None):
3077
2907
        from bzrlib.errors import (
3078
2908
            PointlessCommit,
3079
2909
            ConflictsInTree,
3085
2915
            make_commit_message_template_encoded
3086
2916
        )
3087
2917
 
3088
 
        commit_stamp = offset = None
3089
 
        if commit_time is not None:
3090
 
            try:
3091
 
                commit_stamp, offset = timestamp.parse_patch_date(commit_time)
3092
 
            except ValueError, e:
3093
 
                raise errors.BzrCommandError(
3094
 
                    "Could not parse --commit-time: " + str(e))
3095
 
 
3096
2918
        # TODO: Need a blackbox test for invoking the external editor; may be
3097
2919
        # slightly problematic to run this cross-platform.
3098
2920
 
3118
2940
        if local and not tree.branch.get_bound_location():
3119
2941
            raise errors.LocalRequiresBoundBranch()
3120
2942
 
3121
 
        if message is not None:
3122
 
            try:
3123
 
                file_exists = osutils.lexists(message)
3124
 
            except UnicodeError:
3125
 
                # The commit message contains unicode characters that can't be
3126
 
                # represented in the filesystem encoding, so that can't be a
3127
 
                # file.
3128
 
                file_exists = False
3129
 
            if file_exists:
3130
 
                warning_msg = (
3131
 
                    'The commit message is a file name: "%(f)s".\n'
3132
 
                    '(use --file "%(f)s" to take commit message from that file)'
3133
 
                    % { 'f': message })
3134
 
                ui.ui_factory.show_warning(warning_msg)
3135
 
            if '\r' in message:
3136
 
                message = message.replace('\r\n', '\n')
3137
 
                message = message.replace('\r', '\n')
3138
 
            if file:
3139
 
                raise errors.BzrCommandError(
3140
 
                    "please specify either --message or --file")
3141
 
 
3142
2943
        def get_message(commit_obj):
3143
2944
            """Callback to get commit message"""
3144
 
            if file:
3145
 
                my_message = codecs.open(
3146
 
                    file, 'rt', osutils.get_user_encoding()).read()
3147
 
            elif message is not None:
3148
 
                my_message = message
3149
 
            else:
3150
 
                # No message supplied: make one up.
3151
 
                # text is the status of the tree
3152
 
                text = make_commit_message_template_encoded(tree,
 
2945
            my_message = message
 
2946
            if my_message is None and not file:
 
2947
                t = make_commit_message_template_encoded(tree,
3153
2948
                        selected_list, diff=show_diff,
3154
2949
                        output_encoding=osutils.get_user_encoding())
3155
 
                # start_message is the template generated from hooks
3156
 
                # XXX: Warning - looks like hooks return unicode,
3157
 
                # make_commit_message_template_encoded returns user encoding.
3158
 
                # We probably want to be using edit_commit_message instead to
3159
 
                # avoid this.
3160
2950
                start_message = generate_commit_message_template(commit_obj)
3161
 
                my_message = edit_commit_message_encoded(text,
 
2951
                my_message = edit_commit_message_encoded(t,
3162
2952
                    start_message=start_message)
3163
2953
                if my_message is None:
3164
2954
                    raise errors.BzrCommandError("please specify a commit"
3165
2955
                        " message with either --message or --file")
 
2956
            elif my_message and file:
 
2957
                raise errors.BzrCommandError(
 
2958
                    "please specify either --message or --file")
 
2959
            if file:
 
2960
                my_message = codecs.open(file, 'rt',
 
2961
                                         osutils.get_user_encoding()).read()
3166
2962
            if my_message == "":
3167
2963
                raise errors.BzrCommandError("empty commit message specified")
3168
2964
            return my_message
3169
2965
 
3170
 
        # The API permits a commit with a filter of [] to mean 'select nothing'
3171
 
        # but the command line should not do that.
3172
 
        if not selected_list:
3173
 
            selected_list = None
3174
2966
        try:
3175
2967
            tree.commit(message_callback=get_message,
3176
2968
                        specific_files=selected_list,
3177
2969
                        allow_pointless=unchanged, strict=strict, local=local,
3178
2970
                        reporter=None, verbose=verbose, revprops=properties,
3179
 
                        authors=author, timestamp=commit_stamp,
3180
 
                        timezone=offset,
 
2971
                        authors=author,
3181
2972
                        exclude=safe_relpath_files(tree, exclude))
3182
2973
        except PointlessCommit:
 
2974
            # FIXME: This should really happen before the file is read in;
 
2975
            # perhaps prepare the commit; get the message; then actually commit
3183
2976
            raise errors.BzrCommandError("No changes to commit."
3184
2977
                              " Use --unchanged to commit anyhow.")
3185
2978
        except ConflictsInTree:
3190
2983
            raise errors.BzrCommandError("Commit refused because there are"
3191
2984
                              " unknown files in the working tree.")
3192
2985
        except errors.BoundBranchOutOfDate, e:
3193
 
            e.extra_help = ("\n"
3194
 
                'To commit to master branch, run update and then commit.\n'
3195
 
                'You can also pass --local to commit to continue working '
3196
 
                'disconnected.')
3197
 
            raise
 
2986
            raise errors.BzrCommandError(str(e) + "\n"
 
2987
            'To commit to master branch, run update and then commit.\n'
 
2988
            'You can also pass --local to commit to continue working '
 
2989
            'disconnected.')
3198
2990
 
3199
2991
 
3200
2992
class cmd_check(Command):
3201
 
    __doc__ = """Validate working tree structure, branch consistency and repository history.
 
2993
    """Validate working tree structure, branch consistency and repository history.
3202
2994
 
3203
2995
    This command checks various invariants about branch and repository storage
3204
2996
    to detect data corruption or bzr bugs.
3268
3060
 
3269
3061
 
3270
3062
class cmd_upgrade(Command):
3271
 
    __doc__ = """Upgrade branch storage to current format.
 
3063
    """Upgrade branch storage to current format.
3272
3064
 
3273
3065
    The check command or bzr developers may sometimes advise you to run
3274
3066
    this command. When the default format has changed you may also be warned
3292
3084
 
3293
3085
 
3294
3086
class cmd_whoami(Command):
3295
 
    __doc__ = """Show or set bzr user id.
 
3087
    """Show or set bzr user id.
3296
3088
 
3297
3089
    :Examples:
3298
3090
        Show the email of the current user::
3342
3134
 
3343
3135
 
3344
3136
class cmd_nick(Command):
3345
 
    __doc__ = """Print or set the branch nickname.
 
3137
    """Print or set the branch nickname.
3346
3138
 
3347
3139
    If unset, the tree root directory name is used as the nickname.
3348
3140
    To print the current nickname, execute with no argument.
3362
3154
 
3363
3155
    @display_command
3364
3156
    def printme(self, branch):
3365
 
        self.outf.write('%s\n' % branch.nick)
 
3157
        print branch.nick
3366
3158
 
3367
3159
 
3368
3160
class cmd_alias(Command):
3369
 
    __doc__ = """Set/unset and display aliases.
 
3161
    """Set/unset and display aliases.
3370
3162
 
3371
3163
    :Examples:
3372
3164
        Show the current aliases::
3436
3228
 
3437
3229
 
3438
3230
class cmd_selftest(Command):
3439
 
    __doc__ = """Run internal test suite.
 
3231
    """Run internal test suite.
3440
3232
 
3441
3233
    If arguments are given, they are regular expressions that say which tests
3442
3234
    should run.  Tests matching any expression are run, and other tests are
3469
3261
    Tests that need working space on disk use a common temporary directory,
3470
3262
    typically inside $TMPDIR or /tmp.
3471
3263
 
3472
 
    If you set BZR_TEST_PDB=1 when running selftest, failing tests will drop
3473
 
    into a pdb postmortem session.
3474
 
 
3475
3264
    :Examples:
3476
3265
        Run only tests relating to 'ignore'::
3477
3266
 
3486
3275
    def get_transport_type(typestring):
3487
3276
        """Parse and return a transport specifier."""
3488
3277
        if typestring == "sftp":
3489
 
            from bzrlib.tests import stub_sftp
3490
 
            return stub_sftp.SFTPAbsoluteServer
 
3278
            from bzrlib.transport.sftp import SFTPAbsoluteServer
 
3279
            return SFTPAbsoluteServer
3491
3280
        if typestring == "memory":
3492
 
            from bzrlib.tests import test_server
3493
 
            return memory.MemoryServer
 
3281
            from bzrlib.transport.memory import MemoryServer
 
3282
            return MemoryServer
3494
3283
        if typestring == "fakenfs":
3495
 
            from bzrlib.tests import test_server
3496
 
            return test_server.FakeNFSServer
 
3284
            from bzrlib.transport.fakenfs import FakeNFSServer
 
3285
            return FakeNFSServer
3497
3286
        msg = "No known transport type %s. Supported types are: sftp\n" %\
3498
3287
            (typestring)
3499
3288
        raise errors.BzrCommandError(msg)
3514
3303
                     Option('lsprof-timed',
3515
3304
                            help='Generate lsprof output for benchmarked'
3516
3305
                                 ' sections of code.'),
3517
 
                     Option('lsprof-tests',
3518
 
                            help='Generate lsprof output for each test.'),
3519
3306
                     Option('cache-dir', type=str,
3520
3307
                            help='Cache intermediate benchmark output in this '
3521
3308
                                 'directory.'),
3562
3349
            first=False, list_only=False,
3563
3350
            randomize=None, exclude=None, strict=False,
3564
3351
            load_list=None, debugflag=None, starting_with=None, subunit=False,
3565
 
            parallel=None, lsprof_tests=False):
 
3352
            parallel=None):
3566
3353
        from bzrlib.tests import selftest
3567
3354
        import bzrlib.benchmarks as benchmarks
3568
3355
        from bzrlib.benchmarks import tree_creator
3583
3370
                raise errors.BzrCommandError("subunit not available. subunit "
3584
3371
                    "needs to be installed to use --subunit.")
3585
3372
            self.additional_selftest_args['runner_class'] = SubUnitBzrRunner
3586
 
            # On Windows, disable automatic conversion of '\n' to '\r\n' in
3587
 
            # stdout, which would corrupt the subunit stream. 
3588
 
            if sys.platform == "win32" and sys.stdout.fileno() >= 0:
3589
 
                import msvcrt
3590
 
                msvcrt.setmode(sys.stdout.fileno(), os.O_BINARY)
3591
3373
        if parallel:
3592
3374
            self.additional_selftest_args.setdefault(
3593
3375
                'suite_decorators', []).append(parallel)
3597
3379
            verbose = not is_quiet()
3598
3380
            # TODO: should possibly lock the history file...
3599
3381
            benchfile = open(".perf_history", "at", buffering=1)
3600
 
            self.add_cleanup(benchfile.close)
3601
3382
        else:
3602
3383
            test_suite_factory = None
3603
3384
            benchfile = None
3604
 
        selftest_kwargs = {"verbose": verbose,
3605
 
                          "pattern": pattern,
3606
 
                          "stop_on_failure": one,
3607
 
                          "transport": transport,
3608
 
                          "test_suite_factory": test_suite_factory,
3609
 
                          "lsprof_timed": lsprof_timed,
3610
 
                          "lsprof_tests": lsprof_tests,
3611
 
                          "bench_history": benchfile,
3612
 
                          "matching_tests_first": first,
3613
 
                          "list_only": list_only,
3614
 
                          "random_seed": randomize,
3615
 
                          "exclude_pattern": exclude,
3616
 
                          "strict": strict,
3617
 
                          "load_list": load_list,
3618
 
                          "debug_flags": debugflag,
3619
 
                          "starting_with": starting_with
3620
 
                          }
3621
 
        selftest_kwargs.update(self.additional_selftest_args)
3622
 
        result = selftest(**selftest_kwargs)
 
3385
        try:
 
3386
            selftest_kwargs = {"verbose": verbose,
 
3387
                              "pattern": pattern,
 
3388
                              "stop_on_failure": one,
 
3389
                              "transport": transport,
 
3390
                              "test_suite_factory": test_suite_factory,
 
3391
                              "lsprof_timed": lsprof_timed,
 
3392
                              "bench_history": benchfile,
 
3393
                              "matching_tests_first": first,
 
3394
                              "list_only": list_only,
 
3395
                              "random_seed": randomize,
 
3396
                              "exclude_pattern": exclude,
 
3397
                              "strict": strict,
 
3398
                              "load_list": load_list,
 
3399
                              "debug_flags": debugflag,
 
3400
                              "starting_with": starting_with
 
3401
                              }
 
3402
            selftest_kwargs.update(self.additional_selftest_args)
 
3403
            result = selftest(**selftest_kwargs)
 
3404
        finally:
 
3405
            if benchfile is not None:
 
3406
                benchfile.close()
3623
3407
        return int(not result)
3624
3408
 
3625
3409
 
3626
3410
class cmd_version(Command):
3627
 
    __doc__ = """Show version of bzr."""
 
3411
    """Show version of bzr."""
3628
3412
 
3629
3413
    encoding_type = 'replace'
3630
3414
    takes_options = [
3641
3425
 
3642
3426
 
3643
3427
class cmd_rocks(Command):
3644
 
    __doc__ = """Statement of optimism."""
 
3428
    """Statement of optimism."""
3645
3429
 
3646
3430
    hidden = True
3647
3431
 
3648
3432
    @display_command
3649
3433
    def run(self):
3650
 
        self.outf.write("It sure does!\n")
 
3434
        print "It sure does!"
3651
3435
 
3652
3436
 
3653
3437
class cmd_find_merge_base(Command):
3654
 
    __doc__ = """Find and print a base revision for merging two branches."""
 
3438
    """Find and print a base revision for merging two branches."""
3655
3439
    # TODO: Options to specify revisions on either side, as if
3656
3440
    #       merging only part of the history.
3657
3441
    takes_args = ['branch', 'other']
3663
3447
 
3664
3448
        branch1 = Branch.open_containing(branch)[0]
3665
3449
        branch2 = Branch.open_containing(other)[0]
3666
 
        self.add_cleanup(branch1.lock_read().unlock)
3667
 
        self.add_cleanup(branch2.lock_read().unlock)
3668
 
        last1 = ensure_null(branch1.last_revision())
3669
 
        last2 = ensure_null(branch2.last_revision())
3670
 
 
3671
 
        graph = branch1.repository.get_graph(branch2.repository)
3672
 
        base_rev_id = graph.find_unique_lca(last1, last2)
3673
 
 
3674
 
        self.outf.write('merge base is revision %s\n' % base_rev_id)
 
3450
        branch1.lock_read()
 
3451
        try:
 
3452
            branch2.lock_read()
 
3453
            try:
 
3454
                last1 = ensure_null(branch1.last_revision())
 
3455
                last2 = ensure_null(branch2.last_revision())
 
3456
 
 
3457
                graph = branch1.repository.get_graph(branch2.repository)
 
3458
                base_rev_id = graph.find_unique_lca(last1, last2)
 
3459
 
 
3460
                print 'merge base is revision %s' % base_rev_id
 
3461
            finally:
 
3462
                branch2.unlock()
 
3463
        finally:
 
3464
            branch1.unlock()
3675
3465
 
3676
3466
 
3677
3467
class cmd_merge(Command):
3678
 
    __doc__ = """Perform a three-way merge.
 
3468
    """Perform a three-way merge.
3679
3469
 
3680
3470
    The source of the merge can be specified either in the form of a branch,
3681
3471
    or in the form of a path to a file containing a merge directive generated
3710
3500
    committed to record the result of the merge.
3711
3501
 
3712
3502
    merge refuses to run if there are any uncommitted changes, unless
3713
 
    --force is given. The --force option can also be used to create a
3714
 
    merge revision which has more than two parents.
3715
 
 
3716
 
    If one would like to merge changes from the working tree of the other
3717
 
    branch without merging any committed revisions, the --uncommitted option
3718
 
    can be given.
3719
 
 
3720
 
    To select only some changes to merge, use "merge -i", which will prompt
3721
 
    you to apply each diff hunk and file change, similar to "shelve".
 
3503
    --force is given.
3722
3504
 
3723
3505
    :Examples:
3724
3506
        To merge the latest revision from bzr.dev::
3733
3515
 
3734
3516
            bzr merge -r 81..82 ../bzr.dev
3735
3517
 
3736
 
        To apply a merge directive contained in /tmp/merge::
 
3518
        To apply a merge directive contained in /tmp/merge:
3737
3519
 
3738
3520
            bzr merge /tmp/merge
3739
 
 
3740
 
        To create a merge revision with three parents from two branches
3741
 
        feature1a and feature1b:
3742
 
 
3743
 
            bzr merge ../feature1a
3744
 
            bzr merge ../feature1b --force
3745
 
            bzr commit -m 'revision with three parents'
3746
3521
    """
3747
3522
 
3748
3523
    encoding_type = 'exact'
3770
3545
               short_name='d',
3771
3546
               type=unicode,
3772
3547
               ),
3773
 
        Option('preview', help='Instead of merging, show a diff of the'
3774
 
               ' merge.'),
3775
 
        Option('interactive', help='Select changes interactively.',
3776
 
            short_name='i')
 
3548
        Option('preview', help='Instead of merging, show a diff of the merge.')
3777
3549
    ]
3778
3550
 
3779
3551
    def run(self, location=None, revision=None, force=False,
3781
3553
            uncommitted=False, pull=False,
3782
3554
            directory=None,
3783
3555
            preview=False,
3784
 
            interactive=False,
3785
3556
            ):
3786
3557
        if merge_type is None:
3787
3558
            merge_type = _mod_merge.Merge3Merger
3793
3564
        verified = 'inapplicable'
3794
3565
        tree = WorkingTree.open_containing(directory)[0]
3795
3566
 
 
3567
        # die as quickly as possible if there are uncommitted changes
3796
3568
        try:
3797
3569
            basis_tree = tree.revision_tree(tree.last_revision())
3798
3570
        except errors.NoSuchRevision:
3799
3571
            basis_tree = tree.basis_tree()
3800
 
 
3801
 
        # die as quickly as possible if there are uncommitted changes
3802
3572
        if not force:
3803
 
            if tree.has_changes():
 
3573
            changes = tree.changes_from(basis_tree)
 
3574
            if changes.has_changed():
3804
3575
                raise errors.UncommittedChanges(tree)
3805
3576
 
3806
3577
        view_info = _get_view_info_for_change_reporter(tree)
3807
3578
        change_reporter = delta._ChangeReporter(
3808
3579
            unversioned_filter=tree.is_ignored, view_info=view_info)
3809
 
        pb = ui.ui_factory.nested_progress_bar()
3810
 
        self.add_cleanup(pb.finished)
3811
 
        self.add_cleanup(tree.lock_write().unlock)
3812
 
        if location is not None:
3813
 
            try:
3814
 
                mergeable = bundle.read_mergeable_from_url(location,
3815
 
                    possible_transports=possible_transports)
3816
 
            except errors.NotABundle:
3817
 
                mergeable = None
 
3580
        cleanups = []
 
3581
        try:
 
3582
            pb = ui.ui_factory.nested_progress_bar()
 
3583
            cleanups.append(pb.finished)
 
3584
            tree.lock_write()
 
3585
            cleanups.append(tree.unlock)
 
3586
            if location is not None:
 
3587
                try:
 
3588
                    mergeable = bundle.read_mergeable_from_url(location,
 
3589
                        possible_transports=possible_transports)
 
3590
                except errors.NotABundle:
 
3591
                    mergeable = None
 
3592
                else:
 
3593
                    if uncommitted:
 
3594
                        raise errors.BzrCommandError('Cannot use --uncommitted'
 
3595
                            ' with bundles or merge directives.')
 
3596
 
 
3597
                    if revision is not None:
 
3598
                        raise errors.BzrCommandError(
 
3599
                            'Cannot use -r with merge directives or bundles')
 
3600
                    merger, verified = _mod_merge.Merger.from_mergeable(tree,
 
3601
                       mergeable, pb)
 
3602
 
 
3603
            if merger is None and uncommitted:
 
3604
                if revision is not None and len(revision) > 0:
 
3605
                    raise errors.BzrCommandError('Cannot use --uncommitted and'
 
3606
                        ' --revision at the same time.')
 
3607
                merger = self.get_merger_from_uncommitted(tree, location, pb,
 
3608
                                                          cleanups)
 
3609
                allow_pending = False
 
3610
 
 
3611
            if merger is None:
 
3612
                merger, allow_pending = self._get_merger_from_branch(tree,
 
3613
                    location, revision, remember, possible_transports, pb)
 
3614
 
 
3615
            merger.merge_type = merge_type
 
3616
            merger.reprocess = reprocess
 
3617
            merger.show_base = show_base
 
3618
            self.sanity_check_merger(merger)
 
3619
            if (merger.base_rev_id == merger.other_rev_id and
 
3620
                merger.other_rev_id is not None):
 
3621
                note('Nothing to do.')
 
3622
                return 0
 
3623
            if pull:
 
3624
                if merger.interesting_files is not None:
 
3625
                    raise errors.BzrCommandError('Cannot pull individual files')
 
3626
                if (merger.base_rev_id == tree.last_revision()):
 
3627
                    result = tree.pull(merger.other_branch, False,
 
3628
                                       merger.other_rev_id)
 
3629
                    result.report(self.outf)
 
3630
                    return 0
 
3631
            merger.check_basis(False)
 
3632
            if preview:
 
3633
                return self._do_preview(merger)
3818
3634
            else:
3819
 
                if uncommitted:
3820
 
                    raise errors.BzrCommandError('Cannot use --uncommitted'
3821
 
                        ' with bundles or merge directives.')
3822
 
 
3823
 
                if revision is not None:
3824
 
                    raise errors.BzrCommandError(
3825
 
                        'Cannot use -r with merge directives or bundles')
3826
 
                merger, verified = _mod_merge.Merger.from_mergeable(tree,
3827
 
                   mergeable, None)
3828
 
 
3829
 
        if merger is None and uncommitted:
3830
 
            if revision is not None and len(revision) > 0:
3831
 
                raise errors.BzrCommandError('Cannot use --uncommitted and'
3832
 
                    ' --revision at the same time.')
3833
 
            merger = self.get_merger_from_uncommitted(tree, location, None)
3834
 
            allow_pending = False
3835
 
 
3836
 
        if merger is None:
3837
 
            merger, allow_pending = self._get_merger_from_branch(tree,
3838
 
                location, revision, remember, possible_transports, None)
3839
 
 
3840
 
        merger.merge_type = merge_type
3841
 
        merger.reprocess = reprocess
3842
 
        merger.show_base = show_base
3843
 
        self.sanity_check_merger(merger)
3844
 
        if (merger.base_rev_id == merger.other_rev_id and
3845
 
            merger.other_rev_id is not None):
3846
 
            note('Nothing to do.')
3847
 
            return 0
3848
 
        if pull:
3849
 
            if merger.interesting_files is not None:
3850
 
                raise errors.BzrCommandError('Cannot pull individual files')
3851
 
            if (merger.base_rev_id == tree.last_revision()):
3852
 
                result = tree.pull(merger.other_branch, False,
3853
 
                                   merger.other_rev_id)
3854
 
                result.report(self.outf)
3855
 
                return 0
3856
 
        if merger.this_basis is None:
3857
 
            raise errors.BzrCommandError(
3858
 
                "This branch has no commits."
3859
 
                " (perhaps you would prefer 'bzr pull')")
3860
 
        if preview:
3861
 
            return self._do_preview(merger)
3862
 
        elif interactive:
3863
 
            return self._do_interactive(merger)
3864
 
        else:
3865
 
            return self._do_merge(merger, change_reporter, allow_pending,
3866
 
                                  verified)
3867
 
 
3868
 
    def _get_preview(self, merger):
 
3635
                return self._do_merge(merger, change_reporter, allow_pending,
 
3636
                                      verified)
 
3637
        finally:
 
3638
            for cleanup in reversed(cleanups):
 
3639
                cleanup()
 
3640
 
 
3641
    def _do_preview(self, merger):
 
3642
        from bzrlib.diff import show_diff_trees
3869
3643
        tree_merger = merger.make_merger()
3870
3644
        tt = tree_merger.make_preview_transform()
3871
 
        self.add_cleanup(tt.finalize)
3872
 
        result_tree = tt.get_preview_tree()
3873
 
        return result_tree
3874
 
 
3875
 
    def _do_preview(self, merger):
3876
 
        from bzrlib.diff import show_diff_trees
3877
 
        result_tree = self._get_preview(merger)
3878
 
        show_diff_trees(merger.this_tree, result_tree, self.outf,
3879
 
                        old_label='', new_label='')
 
3645
        try:
 
3646
            result_tree = tt.get_preview_tree()
 
3647
            show_diff_trees(merger.this_tree, result_tree, self.outf,
 
3648
                            old_label='', new_label='')
 
3649
        finally:
 
3650
            tt.finalize()
3880
3651
 
3881
3652
    def _do_merge(self, merger, change_reporter, allow_pending, verified):
3882
3653
        merger.change_reporter = change_reporter
3890
3661
        else:
3891
3662
            return 0
3892
3663
 
3893
 
    def _do_interactive(self, merger):
3894
 
        """Perform an interactive merge.
3895
 
 
3896
 
        This works by generating a preview tree of the merge, then using
3897
 
        Shelver to selectively remove the differences between the working tree
3898
 
        and the preview tree.
3899
 
        """
3900
 
        from bzrlib import shelf_ui
3901
 
        result_tree = self._get_preview(merger)
3902
 
        writer = bzrlib.option.diff_writer_registry.get()
3903
 
        shelver = shelf_ui.Shelver(merger.this_tree, result_tree, destroy=True,
3904
 
                                   reporter=shelf_ui.ApplyReporter(),
3905
 
                                   diff_writer=writer(sys.stdout))
3906
 
        try:
3907
 
            shelver.run()
3908
 
        finally:
3909
 
            shelver.finalize()
3910
 
 
3911
3664
    def sanity_check_merger(self, merger):
3912
3665
        if (merger.show_base and
3913
3666
            not merger.merge_type is _mod_merge.Merge3Merger):
3948
3701
            base_branch, base_path = Branch.open_containing(base_loc,
3949
3702
                possible_transports)
3950
3703
        # Find the revision ids
3951
 
        other_revision_id = None
3952
 
        base_revision_id = None
3953
 
        if revision is not None:
3954
 
            if len(revision) >= 1:
3955
 
                other_revision_id = revision[-1].as_revision_id(other_branch)
3956
 
            if len(revision) == 2:
3957
 
                base_revision_id = revision[0].as_revision_id(base_branch)
3958
 
        if other_revision_id is None:
 
3704
        if revision is None or len(revision) < 1 or revision[-1] is None:
3959
3705
            other_revision_id = _mod_revision.ensure_null(
3960
3706
                other_branch.last_revision())
 
3707
        else:
 
3708
            other_revision_id = revision[-1].as_revision_id(other_branch)
 
3709
        if (revision is not None and len(revision) == 2
 
3710
            and revision[0] is not None):
 
3711
            base_revision_id = revision[0].as_revision_id(base_branch)
 
3712
        else:
 
3713
            base_revision_id = None
3961
3714
        # Remember where we merge from
3962
3715
        if ((remember or tree.branch.get_submit_branch() is None) and
3963
3716
             user_location is not None):
3972
3725
            allow_pending = True
3973
3726
        return merger, allow_pending
3974
3727
 
3975
 
    def get_merger_from_uncommitted(self, tree, location, pb):
 
3728
    def get_merger_from_uncommitted(self, tree, location, pb, cleanups):
3976
3729
        """Get a merger for uncommitted changes.
3977
3730
 
3978
3731
        :param tree: The tree the merger should apply to.
3979
3732
        :param location: The location containing uncommitted changes.
3980
3733
        :param pb: The progress bar to use for showing progress.
 
3734
        :param cleanups: A list of operations to perform to clean up the
 
3735
            temporary directories, unfinalized objects, etc.
3981
3736
        """
3982
3737
        location = self._select_branch_location(tree, location)[0]
3983
3738
        other_tree, other_path = WorkingTree.open_containing(location)
4035
3790
 
4036
3791
 
4037
3792
class cmd_remerge(Command):
4038
 
    __doc__ = """Redo a merge.
 
3793
    """Redo a merge.
4039
3794
 
4040
3795
    Use this if you want to try a different merge technique while resolving
4041
3796
    conflicts.  Some merge techniques are better than others, and remerge
4066
3821
 
4067
3822
    def run(self, file_list=None, merge_type=None, show_base=False,
4068
3823
            reprocess=False):
4069
 
        from bzrlib.conflicts import restore
4070
3824
        if merge_type is None:
4071
3825
            merge_type = _mod_merge.Merge3Merger
4072
3826
        tree, file_list = tree_files(file_list)
4073
 
        self.add_cleanup(tree.lock_write().unlock)
4074
 
        parents = tree.get_parent_ids()
4075
 
        if len(parents) != 2:
4076
 
            raise errors.BzrCommandError("Sorry, remerge only works after normal"
4077
 
                                         " merges.  Not cherrypicking or"
4078
 
                                         " multi-merges.")
4079
 
        repository = tree.branch.repository
4080
 
        interesting_ids = None
4081
 
        new_conflicts = []
4082
 
        conflicts = tree.conflicts()
4083
 
        if file_list is not None:
4084
 
            interesting_ids = set()
4085
 
            for filename in file_list:
4086
 
                file_id = tree.path2id(filename)
4087
 
                if file_id is None:
4088
 
                    raise errors.NotVersionedError(filename)
4089
 
                interesting_ids.add(file_id)
4090
 
                if tree.kind(file_id) != "directory":
4091
 
                    continue
 
3827
        tree.lock_write()
 
3828
        try:
 
3829
            parents = tree.get_parent_ids()
 
3830
            if len(parents) != 2:
 
3831
                raise errors.BzrCommandError("Sorry, remerge only works after normal"
 
3832
                                             " merges.  Not cherrypicking or"
 
3833
                                             " multi-merges.")
 
3834
            repository = tree.branch.repository
 
3835
            interesting_ids = None
 
3836
            new_conflicts = []
 
3837
            conflicts = tree.conflicts()
 
3838
            if file_list is not None:
 
3839
                interesting_ids = set()
 
3840
                for filename in file_list:
 
3841
                    file_id = tree.path2id(filename)
 
3842
                    if file_id is None:
 
3843
                        raise errors.NotVersionedError(filename)
 
3844
                    interesting_ids.add(file_id)
 
3845
                    if tree.kind(file_id) != "directory":
 
3846
                        continue
4092
3847
 
4093
 
                for name, ie in tree.inventory.iter_entries(file_id):
4094
 
                    interesting_ids.add(ie.file_id)
4095
 
            new_conflicts = conflicts.select_conflicts(tree, file_list)[0]
4096
 
        else:
4097
 
            # Remerge only supports resolving contents conflicts
4098
 
            allowed_conflicts = ('text conflict', 'contents conflict')
4099
 
            restore_files = [c.path for c in conflicts
4100
 
                             if c.typestring in allowed_conflicts]
4101
 
        _mod_merge.transform_tree(tree, tree.basis_tree(), interesting_ids)
4102
 
        tree.set_conflicts(ConflictList(new_conflicts))
4103
 
        if file_list is not None:
4104
 
            restore_files = file_list
4105
 
        for filename in restore_files:
 
3848
                    for name, ie in tree.inventory.iter_entries(file_id):
 
3849
                        interesting_ids.add(ie.file_id)
 
3850
                new_conflicts = conflicts.select_conflicts(tree, file_list)[0]
 
3851
            else:
 
3852
                # Remerge only supports resolving contents conflicts
 
3853
                allowed_conflicts = ('text conflict', 'contents conflict')
 
3854
                restore_files = [c.path for c in conflicts
 
3855
                                 if c.typestring in allowed_conflicts]
 
3856
            _mod_merge.transform_tree(tree, tree.basis_tree(), interesting_ids)
 
3857
            tree.set_conflicts(ConflictList(new_conflicts))
 
3858
            if file_list is not None:
 
3859
                restore_files = file_list
 
3860
            for filename in restore_files:
 
3861
                try:
 
3862
                    restore(tree.abspath(filename))
 
3863
                except errors.NotConflicted:
 
3864
                    pass
 
3865
            # Disable pending merges, because the file texts we are remerging
 
3866
            # have not had those merges performed.  If we use the wrong parents
 
3867
            # list, we imply that the working tree text has seen and rejected
 
3868
            # all the changes from the other tree, when in fact those changes
 
3869
            # have not yet been seen.
 
3870
            pb = ui.ui_factory.nested_progress_bar()
 
3871
            tree.set_parent_ids(parents[:1])
4106
3872
            try:
4107
 
                restore(tree.abspath(filename))
4108
 
            except errors.NotConflicted:
4109
 
                pass
4110
 
        # Disable pending merges, because the file texts we are remerging
4111
 
        # have not had those merges performed.  If we use the wrong parents
4112
 
        # list, we imply that the working tree text has seen and rejected
4113
 
        # all the changes from the other tree, when in fact those changes
4114
 
        # have not yet been seen.
4115
 
        tree.set_parent_ids(parents[:1])
4116
 
        try:
4117
 
            merger = _mod_merge.Merger.from_revision_ids(None, tree, parents[1])
4118
 
            merger.interesting_ids = interesting_ids
4119
 
            merger.merge_type = merge_type
4120
 
            merger.show_base = show_base
4121
 
            merger.reprocess = reprocess
4122
 
            conflicts = merger.do_merge()
 
3873
                merger = _mod_merge.Merger.from_revision_ids(pb,
 
3874
                                                             tree, parents[1])
 
3875
                merger.interesting_ids = interesting_ids
 
3876
                merger.merge_type = merge_type
 
3877
                merger.show_base = show_base
 
3878
                merger.reprocess = reprocess
 
3879
                conflicts = merger.do_merge()
 
3880
            finally:
 
3881
                tree.set_parent_ids(parents)
 
3882
                pb.finished()
4123
3883
        finally:
4124
 
            tree.set_parent_ids(parents)
 
3884
            tree.unlock()
4125
3885
        if conflicts > 0:
4126
3886
            return 1
4127
3887
        else:
4129
3889
 
4130
3890
 
4131
3891
class cmd_revert(Command):
4132
 
    __doc__ = """Revert files to a previous revision.
 
3892
    """Revert files to a previous revision.
4133
3893
 
4134
3894
    Giving a list of files will revert only those files.  Otherwise, all files
4135
3895
    will be reverted.  If the revision is not specified with '--revision', the
4149
3909
    name.  If you name a directory, all the contents of that directory will be
4150
3910
    reverted.
4151
3911
 
4152
 
    If you have newly added files since the target revision, they will be
4153
 
    removed.  If the files to be removed have been changed, backups will be
4154
 
    created as above.  Directories containing unknown files will not be
4155
 
    deleted.
 
3912
    Any files that have been newly added since that revision will be deleted,
 
3913
    with a backup kept if appropriate.  Directories containing unknown files
 
3914
    will not be deleted.
4156
3915
 
4157
 
    The working tree contains a list of revisions that have been merged but
4158
 
    not yet committed. These revisions will be included as additional parents
4159
 
    of the next commit.  Normally, using revert clears that list as well as
4160
 
    reverting the files.  If any files are specified, revert leaves the list
4161
 
    of uncommitted merges alone and reverts only the files.  Use ``bzr revert
4162
 
    .`` in the tree root to revert all files but keep the recorded merges,
4163
 
    and ``bzr revert --forget-merges`` to clear the pending merge list without
 
3916
    The working tree contains a list of pending merged revisions, which will
 
3917
    be included as parents in the next commit.  Normally, revert clears that
 
3918
    list as well as reverting the files.  If any files are specified, revert
 
3919
    leaves the pending merge list alone and reverts only the files.  Use "bzr
 
3920
    revert ." in the tree root to revert all files but keep the merge record,
 
3921
    and "bzr revert --forget-merges" to clear the pending merge list without
4164
3922
    reverting any files.
4165
 
 
4166
 
    Using "bzr revert --forget-merges", it is possible to apply all of the
4167
 
    changes from a branch in a single revision.  To do this, perform the merge
4168
 
    as desired.  Then doing revert with the "--forget-merges" option will keep
4169
 
    the content of the tree as it was, but it will clear the list of pending
4170
 
    merges.  The next commit will then contain all of the changes that are
4171
 
    present in the other branch, but without any other parent revisions.
4172
 
    Because this technique forgets where these changes originated, it may
4173
 
    cause additional conflicts on later merges involving the same source and
4174
 
    target branches.
4175
3923
    """
4176
3924
 
4177
3925
    _see_also = ['cat', 'export']
4186
3934
    def run(self, revision=None, no_backup=False, file_list=None,
4187
3935
            forget_merges=None):
4188
3936
        tree, file_list = tree_files(file_list)
4189
 
        self.add_cleanup(tree.lock_tree_write().unlock)
4190
 
        if forget_merges:
4191
 
            tree.set_parent_ids(tree.get_parent_ids()[:1])
4192
 
        else:
4193
 
            self._revert_tree_to_revision(tree, revision, file_list, no_backup)
 
3937
        tree.lock_write()
 
3938
        try:
 
3939
            if forget_merges:
 
3940
                tree.set_parent_ids(tree.get_parent_ids()[:1])
 
3941
            else:
 
3942
                self._revert_tree_to_revision(tree, revision, file_list, no_backup)
 
3943
        finally:
 
3944
            tree.unlock()
4194
3945
 
4195
3946
    @staticmethod
4196
3947
    def _revert_tree_to_revision(tree, revision, file_list, no_backup):
4197
3948
        rev_tree = _get_one_revision_tree('revert', revision, tree=tree)
4198
 
        tree.revert(file_list, rev_tree, not no_backup, None,
4199
 
            report_changes=True)
 
3949
        pb = ui.ui_factory.nested_progress_bar()
 
3950
        try:
 
3951
            tree.revert(file_list, rev_tree, not no_backup, pb,
 
3952
                report_changes=True)
 
3953
        finally:
 
3954
            pb.finished()
4200
3955
 
4201
3956
 
4202
3957
class cmd_assert_fail(Command):
4203
 
    __doc__ = """Test reporting of assertion failures"""
 
3958
    """Test reporting of assertion failures"""
4204
3959
    # intended just for use in testing
4205
3960
 
4206
3961
    hidden = True
4210
3965
 
4211
3966
 
4212
3967
class cmd_help(Command):
4213
 
    __doc__ = """Show help on a command or other topic.
 
3968
    """Show help on a command or other topic.
4214
3969
    """
4215
3970
 
4216
3971
    _see_also = ['topics']
4229
3984
 
4230
3985
 
4231
3986
class cmd_shell_complete(Command):
4232
 
    __doc__ = """Show appropriate completions for context.
 
3987
    """Show appropriate completions for context.
4233
3988
 
4234
3989
    For a list of all available commands, say 'bzr shell-complete'.
4235
3990
    """
4244
3999
 
4245
4000
 
4246
4001
class cmd_missing(Command):
4247
 
    __doc__ = """Show unmerged/unpulled revisions between two branches.
 
4002
    """Show unmerged/unpulled revisions between two branches.
4248
4003
 
4249
4004
    OTHER_BRANCH may be local or remote.
4250
4005
 
4251
4006
    To filter on a range of revisions, you can use the command -r begin..end
4252
4007
    -r revision requests a specific revision, -r ..end or -r begin.. are
4253
4008
    also valid.
4254
 
            
4255
 
    :Exit values:
4256
 
        1 - some missing revisions
4257
 
        0 - no missing revisions
4258
4009
 
4259
4010
    :Examples:
4260
4011
 
4328
4079
            restrict = 'remote'
4329
4080
 
4330
4081
        local_branch = Branch.open_containing(u".")[0]
4331
 
        self.add_cleanup(local_branch.lock_read().unlock)
4332
 
 
4333
4082
        parent = local_branch.get_parent()
4334
4083
        if other_branch is None:
4335
4084
            other_branch = parent
4344
4093
        remote_branch = Branch.open(other_branch)
4345
4094
        if remote_branch.base == local_branch.base:
4346
4095
            remote_branch = local_branch
4347
 
        else:
4348
 
            self.add_cleanup(remote_branch.lock_read().unlock)
4349
4096
 
4350
4097
        local_revid_range = _revision_range_to_revid_range(
4351
4098
            _get_revision_range(my_revision, local_branch,
4355
4102
            _get_revision_range(revision,
4356
4103
                remote_branch, self.name()))
4357
4104
 
4358
 
        local_extra, remote_extra = find_unmerged(
4359
 
            local_branch, remote_branch, restrict,
4360
 
            backward=not reverse,
4361
 
            include_merges=include_merges,
4362
 
            local_revid_range=local_revid_range,
4363
 
            remote_revid_range=remote_revid_range)
4364
 
 
4365
 
        if log_format is None:
4366
 
            registry = log.log_formatter_registry
4367
 
            log_format = registry.get_default(local_branch)
4368
 
        lf = log_format(to_file=self.outf,
4369
 
                        show_ids=show_ids,
4370
 
                        show_timezone='original')
4371
 
 
4372
 
        status_code = 0
4373
 
        if local_extra and not theirs_only:
4374
 
            message("You have %d extra revision(s):\n" %
4375
 
                len(local_extra))
4376
 
            for revision in iter_log_revisions(local_extra,
4377
 
                                local_branch.repository,
4378
 
                                verbose):
4379
 
                lf.log_revision(revision)
4380
 
            printed_local = True
4381
 
            status_code = 1
4382
 
        else:
4383
 
            printed_local = False
4384
 
 
4385
 
        if remote_extra and not mine_only:
4386
 
            if printed_local is True:
4387
 
                message("\n\n\n")
4388
 
            message("You are missing %d revision(s):\n" %
4389
 
                len(remote_extra))
4390
 
            for revision in iter_log_revisions(remote_extra,
4391
 
                                remote_branch.repository,
4392
 
                                verbose):
4393
 
                lf.log_revision(revision)
4394
 
            status_code = 1
4395
 
 
4396
 
        if mine_only and not local_extra:
4397
 
            # We checked local, and found nothing extra
4398
 
            message('This branch is up to date.\n')
4399
 
        elif theirs_only and not remote_extra:
4400
 
            # We checked remote, and found nothing extra
4401
 
            message('Other branch is up to date.\n')
4402
 
        elif not (mine_only or theirs_only or local_extra or
4403
 
                  remote_extra):
4404
 
            # We checked both branches, and neither one had extra
4405
 
            # revisions
4406
 
            message("Branches are up to date.\n")
4407
 
        self.cleanup_now()
 
4105
        local_branch.lock_read()
 
4106
        try:
 
4107
            remote_branch.lock_read()
 
4108
            try:
 
4109
                local_extra, remote_extra = find_unmerged(
 
4110
                    local_branch, remote_branch, restrict,
 
4111
                    backward=not reverse,
 
4112
                    include_merges=include_merges,
 
4113
                    local_revid_range=local_revid_range,
 
4114
                    remote_revid_range=remote_revid_range)
 
4115
 
 
4116
                if log_format is None:
 
4117
                    registry = log.log_formatter_registry
 
4118
                    log_format = registry.get_default(local_branch)
 
4119
                lf = log_format(to_file=self.outf,
 
4120
                                show_ids=show_ids,
 
4121
                                show_timezone='original')
 
4122
 
 
4123
                status_code = 0
 
4124
                if local_extra and not theirs_only:
 
4125
                    message("You have %d extra revision(s):\n" %
 
4126
                        len(local_extra))
 
4127
                    for revision in iter_log_revisions(local_extra,
 
4128
                                        local_branch.repository,
 
4129
                                        verbose):
 
4130
                        lf.log_revision(revision)
 
4131
                    printed_local = True
 
4132
                    status_code = 1
 
4133
                else:
 
4134
                    printed_local = False
 
4135
 
 
4136
                if remote_extra and not mine_only:
 
4137
                    if printed_local is True:
 
4138
                        message("\n\n\n")
 
4139
                    message("You are missing %d revision(s):\n" %
 
4140
                        len(remote_extra))
 
4141
                    for revision in iter_log_revisions(remote_extra,
 
4142
                                        remote_branch.repository,
 
4143
                                        verbose):
 
4144
                        lf.log_revision(revision)
 
4145
                    status_code = 1
 
4146
 
 
4147
                if mine_only and not local_extra:
 
4148
                    # We checked local, and found nothing extra
 
4149
                    message('This branch is up to date.\n')
 
4150
                elif theirs_only and not remote_extra:
 
4151
                    # We checked remote, and found nothing extra
 
4152
                    message('Other branch is up to date.\n')
 
4153
                elif not (mine_only or theirs_only or local_extra or
 
4154
                          remote_extra):
 
4155
                    # We checked both branches, and neither one had extra
 
4156
                    # revisions
 
4157
                    message("Branches are up to date.\n")
 
4158
            finally:
 
4159
                remote_branch.unlock()
 
4160
        finally:
 
4161
            local_branch.unlock()
4408
4162
        if not status_code and parent is None and other_branch is not None:
4409
 
            self.add_cleanup(local_branch.lock_write().unlock)
4410
 
            # handle race conditions - a parent might be set while we run.
4411
 
            if local_branch.get_parent() is None:
4412
 
                local_branch.set_parent(remote_branch.base)
 
4163
            local_branch.lock_write()
 
4164
            try:
 
4165
                # handle race conditions - a parent might be set while we run.
 
4166
                if local_branch.get_parent() is None:
 
4167
                    local_branch.set_parent(remote_branch.base)
 
4168
            finally:
 
4169
                local_branch.unlock()
4413
4170
        return status_code
4414
4171
 
4415
4172
 
4416
4173
class cmd_pack(Command):
4417
 
    __doc__ = """Compress the data within a repository.
4418
 
 
4419
 
    This operation compresses the data within a bazaar repository. As
4420
 
    bazaar supports automatic packing of repository, this operation is
4421
 
    normally not required to be done manually.
4422
 
 
4423
 
    During the pack operation, bazaar takes a backup of existing repository
4424
 
    data, i.e. pack files. This backup is eventually removed by bazaar
4425
 
    automatically when it is safe to do so. To save disk space by removing
4426
 
    the backed up pack files, the --clean-obsolete-packs option may be
4427
 
    used.
4428
 
 
4429
 
    Warning: If you use --clean-obsolete-packs and your machine crashes
4430
 
    during or immediately after repacking, you may be left with a state
4431
 
    where the deletion has been written to disk but the new packs have not
4432
 
    been. In this case the repository may be unusable.
4433
 
    """
 
4174
    """Compress the data within a repository."""
4434
4175
 
4435
4176
    _see_also = ['repositories']
4436
4177
    takes_args = ['branch_or_repo?']
4437
 
    takes_options = [
4438
 
        Option('clean-obsolete-packs', 'Delete obsolete packs to save disk space.'),
4439
 
        ]
4440
4178
 
4441
 
    def run(self, branch_or_repo='.', clean_obsolete_packs=False):
 
4179
    def run(self, branch_or_repo='.'):
4442
4180
        dir = bzrdir.BzrDir.open_containing(branch_or_repo)[0]
4443
4181
        try:
4444
4182
            branch = dir.open_branch()
4445
4183
            repository = branch.repository
4446
4184
        except errors.NotBranchError:
4447
4185
            repository = dir.open_repository()
4448
 
        repository.pack(clean_obsolete_packs=clean_obsolete_packs)
 
4186
        repository.pack()
4449
4187
 
4450
4188
 
4451
4189
class cmd_plugins(Command):
4452
 
    __doc__ = """List the installed plugins.
 
4190
    """List the installed plugins.
4453
4191
 
4454
4192
    This command displays the list of installed plugins including
4455
4193
    version of plugin and a short description of each.
4462
4200
    adding new commands, providing additional network transports and
4463
4201
    customizing log output.
4464
4202
 
4465
 
    See the Bazaar Plugin Guide <http://doc.bazaar.canonical.com/plugins/en/>
4466
 
    for further information on plugins including where to find them and how to
4467
 
    install them. Instructions are also provided there on how to write new
4468
 
    plugins using the Python programming language.
 
4203
    See the Bazaar web site, http://bazaar-vcs.org, for further
 
4204
    information on plugins including where to find them and how to
 
4205
    install them. Instructions are also provided there on how to
 
4206
    write new plugins using the Python programming language.
4469
4207
    """
4470
4208
    takes_options = ['verbose']
4471
4209
 
4486
4224
                doc = '(no description)'
4487
4225
            result.append((name_ver, doc, plugin.path()))
4488
4226
        for name_ver, doc, path in sorted(result):
4489
 
            self.outf.write("%s\n" % name_ver)
4490
 
            self.outf.write("   %s\n" % doc)
 
4227
            print name_ver
 
4228
            print '   ', doc
4491
4229
            if verbose:
4492
 
                self.outf.write("   %s\n" % path)
4493
 
            self.outf.write("\n")
 
4230
                print '   ', path
 
4231
            print
4494
4232
 
4495
4233
 
4496
4234
class cmd_testament(Command):
4497
 
    __doc__ = """Show testament (signing-form) of a revision."""
 
4235
    """Show testament (signing-form) of a revision."""
4498
4236
    takes_options = [
4499
4237
            'revision',
4500
4238
            Option('long', help='Produce long-format testament.'),
4512
4250
            b = Branch.open_containing(branch)[0]
4513
4251
        else:
4514
4252
            b = Branch.open(branch)
4515
 
        self.add_cleanup(b.lock_read().unlock)
4516
 
        if revision is None:
4517
 
            rev_id = b.last_revision()
4518
 
        else:
4519
 
            rev_id = revision[0].as_revision_id(b)
4520
 
        t = testament_class.from_revision(b.repository, rev_id)
4521
 
        if long:
4522
 
            sys.stdout.writelines(t.as_text_lines())
4523
 
        else:
4524
 
            sys.stdout.write(t.as_short_text())
 
4253
        b.lock_read()
 
4254
        try:
 
4255
            if revision is None:
 
4256
                rev_id = b.last_revision()
 
4257
            else:
 
4258
                rev_id = revision[0].as_revision_id(b)
 
4259
            t = testament_class.from_revision(b.repository, rev_id)
 
4260
            if long:
 
4261
                sys.stdout.writelines(t.as_text_lines())
 
4262
            else:
 
4263
                sys.stdout.write(t.as_short_text())
 
4264
        finally:
 
4265
            b.unlock()
4525
4266
 
4526
4267
 
4527
4268
class cmd_annotate(Command):
4528
 
    __doc__ = """Show the origin of each line in a file.
 
4269
    """Show the origin of each line in a file.
4529
4270
 
4530
4271
    This prints out the given file with an annotation on the left side
4531
4272
    indicating which revision, author and date introduced the change.
4552
4293
        wt, branch, relpath = \
4553
4294
            bzrdir.BzrDir.open_containing_tree_or_branch(filename)
4554
4295
        if wt is not None:
4555
 
            self.add_cleanup(wt.lock_read().unlock)
4556
 
        else:
4557
 
            self.add_cleanup(branch.lock_read().unlock)
4558
 
        tree = _get_one_revision_tree('annotate', revision, branch=branch)
4559
 
        self.add_cleanup(tree.lock_read().unlock)
4560
 
        if wt is not None:
4561
 
            file_id = wt.path2id(relpath)
4562
 
        else:
4563
 
            file_id = tree.path2id(relpath)
4564
 
        if file_id is None:
4565
 
            raise errors.NotVersionedError(filename)
4566
 
        file_version = tree.inventory[file_id].revision
4567
 
        if wt is not None and revision is None:
4568
 
            # If there is a tree and we're not annotating historical
4569
 
            # versions, annotate the working tree's content.
4570
 
            annotate_file_tree(wt, file_id, self.outf, long, all,
4571
 
                show_ids=show_ids)
4572
 
        else:
4573
 
            annotate_file(branch, file_version, file_id, long, all, self.outf,
4574
 
                          show_ids=show_ids)
 
4296
            wt.lock_read()
 
4297
        else:
 
4298
            branch.lock_read()
 
4299
        try:
 
4300
            tree = _get_one_revision_tree('annotate', revision, branch=branch)
 
4301
            if wt is not None:
 
4302
                file_id = wt.path2id(relpath)
 
4303
            else:
 
4304
                file_id = tree.path2id(relpath)
 
4305
            if file_id is None:
 
4306
                raise errors.NotVersionedError(filename)
 
4307
            file_version = tree.inventory[file_id].revision
 
4308
            if wt is not None and revision is None:
 
4309
                # If there is a tree and we're not annotating historical
 
4310
                # versions, annotate the working tree's content.
 
4311
                annotate_file_tree(wt, file_id, self.outf, long, all,
 
4312
                    show_ids=show_ids)
 
4313
            else:
 
4314
                annotate_file(branch, file_version, file_id, long, all, self.outf,
 
4315
                              show_ids=show_ids)
 
4316
        finally:
 
4317
            if wt is not None:
 
4318
                wt.unlock()
 
4319
            else:
 
4320
                branch.unlock()
4575
4321
 
4576
4322
 
4577
4323
class cmd_re_sign(Command):
4578
 
    __doc__ = """Create a digital signature for an existing revision."""
 
4324
    """Create a digital signature for an existing revision."""
4579
4325
    # TODO be able to replace existing ones.
4580
4326
 
4581
4327
    hidden = True # is this right ?
4588
4334
        if revision_id_list is None and revision is None:
4589
4335
            raise errors.BzrCommandError('You must supply either --revision or a revision_id')
4590
4336
        b = WorkingTree.open_containing(u'.')[0].branch
4591
 
        self.add_cleanup(b.lock_write().unlock)
4592
 
        return self._run(b, revision_id_list, revision)
 
4337
        b.lock_write()
 
4338
        try:
 
4339
            return self._run(b, revision_id_list, revision)
 
4340
        finally:
 
4341
            b.unlock()
4593
4342
 
4594
4343
    def _run(self, b, revision_id_list, revision):
4595
4344
        import bzrlib.gpg as gpg
4640
4389
 
4641
4390
 
4642
4391
class cmd_bind(Command):
4643
 
    __doc__ = """Convert the current branch into a checkout of the supplied branch.
4644
 
    If no branch is supplied, rebind to the last bound location.
 
4392
    """Convert the current branch into a checkout of the supplied branch.
4645
4393
 
4646
4394
    Once converted into a checkout, commits must succeed on the master branch
4647
4395
    before they will be applied to the local branch.
4648
4396
 
4649
4397
    Bound branches use the nickname of its master branch unless it is set
4650
 
    locally, in which case binding will update the local nickname to be
 
4398
    locally, in which case binding will update the the local nickname to be
4651
4399
    that of the master.
4652
4400
    """
4653
4401
 
4665
4413
                    'This format does not remember old locations.')
4666
4414
            else:
4667
4415
                if location is None:
4668
 
                    if b.get_bound_location() is not None:
4669
 
                        raise errors.BzrCommandError('Branch is already bound')
4670
 
                    else:
4671
 
                        raise errors.BzrCommandError('No location supplied '
4672
 
                            'and no previous location known')
 
4416
                    raise errors.BzrCommandError('No location supplied and no '
 
4417
                        'previous location known')
4673
4418
        b_other = Branch.open(location)
4674
4419
        try:
4675
4420
            b.bind(b_other)
4681
4426
 
4682
4427
 
4683
4428
class cmd_unbind(Command):
4684
 
    __doc__ = """Convert the current checkout into a regular branch.
 
4429
    """Convert the current checkout into a regular branch.
4685
4430
 
4686
4431
    After unbinding, the local branch is considered independent and subsequent
4687
4432
    commits will be local only.
4698
4443
 
4699
4444
 
4700
4445
class cmd_uncommit(Command):
4701
 
    __doc__ = """Remove the last committed revision.
 
4446
    """Remove the last committed revision.
4702
4447
 
4703
4448
    --verbose will print out what is being removed.
4704
4449
    --dry-run will go through all the motions, but not actually
4744
4489
            b = control.open_branch()
4745
4490
 
4746
4491
        if tree is not None:
4747
 
            self.add_cleanup(tree.lock_write().unlock)
 
4492
            tree.lock_write()
4748
4493
        else:
4749
 
            self.add_cleanup(b.lock_write().unlock)
4750
 
        return self._run(b, tree, dry_run, verbose, revision, force, local=local)
 
4494
            b.lock_write()
 
4495
        try:
 
4496
            return self._run(b, tree, dry_run, verbose, revision, force,
 
4497
                             local=local)
 
4498
        finally:
 
4499
            if tree is not None:
 
4500
                tree.unlock()
 
4501
            else:
 
4502
                b.unlock()
4751
4503
 
4752
4504
    def _run(self, b, tree, dry_run, verbose, revision, force, local=False):
4753
4505
        from bzrlib.log import log_formatter, show_log
4785
4537
                 end_revision=last_revno)
4786
4538
 
4787
4539
        if dry_run:
4788
 
            self.outf.write('Dry-run, pretending to remove'
4789
 
                            ' the above revisions.\n')
 
4540
            print 'Dry-run, pretending to remove the above revisions.'
 
4541
            if not force:
 
4542
                val = raw_input('Press <enter> to continue')
4790
4543
        else:
4791
 
            self.outf.write('The above revision(s) will be removed.\n')
4792
 
 
4793
 
        if not force:
4794
 
            if not ui.ui_factory.get_boolean('Are you sure'):
4795
 
                self.outf.write('Canceled')
4796
 
                return 0
 
4544
            print 'The above revision(s) will be removed.'
 
4545
            if not force:
 
4546
                val = raw_input('Are you sure [y/N]? ')
 
4547
                if val.lower() not in ('y', 'yes'):
 
4548
                    print 'Canceled'
 
4549
                    return 0
4797
4550
 
4798
4551
        mutter('Uncommitting from {%s} to {%s}',
4799
4552
               last_rev_id, rev_id)
4800
4553
        uncommit(b, tree=tree, dry_run=dry_run, verbose=verbose,
4801
4554
                 revno=revno, local=local)
4802
 
        self.outf.write('You can restore the old tip by running:\n'
4803
 
             '  bzr pull . -r revid:%s\n' % last_rev_id)
 
4555
        note('You can restore the old tip by running:\n'
 
4556
             '  bzr pull . -r revid:%s', last_rev_id)
4804
4557
 
4805
4558
 
4806
4559
class cmd_break_lock(Command):
4807
 
    __doc__ = """Break a dead lock on a repository, branch or working directory.
 
4560
    """Break a dead lock on a repository, branch or working directory.
4808
4561
 
4809
4562
    CAUTION: Locks should only be broken when you are sure that the process
4810
4563
    holding the lock has been stopped.
4811
4564
 
4812
 
    You can get information on what locks are open via the 'bzr info
4813
 
    [location]' command.
 
4565
    You can get information on what locks are open via the 'bzr info' command.
4814
4566
 
4815
4567
    :Examples:
4816
4568
        bzr break-lock
4817
 
        bzr break-lock bzr+ssh://example.com/bzr/foo
4818
4569
    """
4819
4570
    takes_args = ['location?']
4820
4571
 
4829
4580
 
4830
4581
 
4831
4582
class cmd_wait_until_signalled(Command):
4832
 
    __doc__ = """Test helper for test_start_and_stop_bzr_subprocess_send_signal.
 
4583
    """Test helper for test_start_and_stop_bzr_subprocess_send_signal.
4833
4584
 
4834
4585
    This just prints a line to signal when it is ready, then blocks on stdin.
4835
4586
    """
4843
4594
 
4844
4595
 
4845
4596
class cmd_serve(Command):
4846
 
    __doc__ = """Run the bzr server."""
 
4597
    """Run the bzr server."""
4847
4598
 
4848
4599
    aliases = ['server']
4849
4600
 
4850
4601
    takes_options = [
4851
4602
        Option('inet',
4852
4603
               help='Serve on stdin/out for use from inetd or sshd.'),
4853
 
        RegistryOption('protocol',
4854
 
               help="Protocol to serve.",
 
4604
        RegistryOption('protocol', 
 
4605
               help="Protocol to serve.", 
4855
4606
               lazy_registry=('bzrlib.transport', 'transport_server_registry'),
4856
4607
               value_switches=True),
4857
4608
        Option('port',
4866
4617
        Option('allow-writes',
4867
4618
               help='By default the server is a readonly server.  Supplying '
4868
4619
                    '--allow-writes enables write access to the contents of '
4869
 
                    'the served directory and below.  Note that ``bzr serve`` '
4870
 
                    'does not perform authentication, so unless some form of '
4871
 
                    'external authentication is arranged supplying this '
4872
 
                    'option leads to global uncontrolled write access to your '
4873
 
                    'file system.'
 
4620
                    'the served directory and below.'
4874
4621
                ),
4875
4622
        ]
4876
4623
 
4909
4656
 
4910
4657
 
4911
4658
class cmd_join(Command):
4912
 
    __doc__ = """Combine a tree into its containing tree.
 
4659
    """Combine a tree into its containing tree.
4913
4660
 
4914
4661
    This command requires the target tree to be in a rich-root format.
4915
4662
 
4955
4702
 
4956
4703
 
4957
4704
class cmd_split(Command):
4958
 
    __doc__ = """Split a subdirectory of a tree into a separate tree.
 
4705
    """Split a subdirectory of a tree into a separate tree.
4959
4706
 
4960
4707
    This command will produce a target tree in a format that supports
4961
4708
    rich roots, like 'rich-root' or 'rich-root-pack'.  These formats cannot be
4981
4728
 
4982
4729
 
4983
4730
class cmd_merge_directive(Command):
4984
 
    __doc__ = """Generate a merge directive for auto-merge tools.
 
4731
    """Generate a merge directive for auto-merge tools.
4985
4732
 
4986
4733
    A directive requests a merge to be performed, and also provides all the
4987
4734
    information necessary to do so.  This means it must either include a
5080
4827
 
5081
4828
 
5082
4829
class cmd_send(Command):
5083
 
    __doc__ = """Mail or create a merge-directive for submitting changes.
 
4830
    """Mail or create a merge-directive for submitting changes.
5084
4831
 
5085
4832
    A merge directive provides many things needed for requesting merges:
5086
4833
 
5092
4839
      directly from the merge directive, without retrieving data from a
5093
4840
      branch.
5094
4841
 
5095
 
    `bzr send` creates a compact data set that, when applied using bzr
5096
 
    merge, has the same effect as merging from the source branch.  
5097
 
    
5098
 
    By default the merge directive is self-contained and can be applied to any
5099
 
    branch containing submit_branch in its ancestory without needing access to
5100
 
    the source branch.
5101
 
    
5102
 
    If --no-bundle is specified, then Bazaar doesn't send the contents of the
5103
 
    revisions, but only a structured request to merge from the
5104
 
    public_location.  In that case the public_branch is needed and it must be
5105
 
    up-to-date and accessible to the recipient.  The public_branch is always
5106
 
    included if known, so that people can check it later.
5107
 
 
5108
 
    The submit branch defaults to the parent of the source branch, but can be
5109
 
    overridden.  Both submit branch and public branch will be remembered in
5110
 
    branch.conf the first time they are used for a particular branch.  The
5111
 
    source branch defaults to that containing the working directory, but can
5112
 
    be changed using --from.
5113
 
 
5114
 
    In order to calculate those changes, bzr must analyse the submit branch.
5115
 
    Therefore it is most efficient for the submit branch to be a local mirror.
5116
 
    If a public location is known for the submit_branch, that location is used
5117
 
    in the merge directive.
5118
 
 
5119
 
    The default behaviour is to send the merge directive by mail, unless -o is
5120
 
    given, in which case it is sent to a file.
 
4842
    If --no-bundle is specified, then public_branch is needed (and must be
 
4843
    up-to-date), so that the receiver can perform the merge using the
 
4844
    public_branch.  The public_branch is always included if known, so that
 
4845
    people can check it later.
 
4846
 
 
4847
    The submit branch defaults to the parent, but can be overridden.  Both
 
4848
    submit branch and public branch will be remembered if supplied.
 
4849
 
 
4850
    If a public_branch is known for the submit_branch, that public submit
 
4851
    branch is used in the merge instructions.  This means that a local mirror
 
4852
    can be used as your actual submit branch, once you have set public_branch
 
4853
    for that mirror.
5121
4854
 
5122
4855
    Mail is sent using your preferred mail program.  This should be transparent
5123
4856
    on Windows (it uses MAPI).  On Linux, it requires the xdg-email utility.
5125
4858
 
5126
4859
    To use a specific mail program, set the mail_client configuration option.
5127
4860
    (For Thunderbird 1.5, this works around some bugs.)  Supported values for
5128
 
    specific clients are "claws", "evolution", "kmail", "mail.app" (MacOS X's
5129
 
    Mail.app), "mutt", and "thunderbird"; generic options are "default",
5130
 
    "editor", "emacsclient", "mapi", and "xdg-email".  Plugins may also add
5131
 
    supported clients.
 
4861
    specific clients are "claws", "evolution", "kmail", "mutt", and
 
4862
    "thunderbird"; generic options are "default", "editor", "emacsclient",
 
4863
    "mapi", and "xdg-email".  Plugins may also add supported clients.
5132
4864
 
5133
4865
    If mail is being sent, a to address is required.  This can be supplied
5134
4866
    either on the commandline, by setting the submit_to configuration
5143
4875
 
5144
4876
    The merge directives created by bzr send may be applied using bzr merge or
5145
4877
    bzr pull by specifying a file containing a merge directive as the location.
5146
 
 
5147
 
    bzr send makes extensive use of public locations to map local locations into
5148
 
    URLs that can be used by other people.  See `bzr help configuration` to
5149
 
    set them, and use `bzr info` to display them.
5150
4878
    """
5151
4879
 
5152
4880
    encoding_type = 'exact'
5168
4896
               short_name='f',
5169
4897
               type=unicode),
5170
4898
        Option('output', short_name='o',
5171
 
               help='Write merge directive to this file or directory; '
 
4899
               help='Write merge directive to this file; '
5172
4900
                    'use - for stdout.',
5173
4901
               type=unicode),
5174
 
        Option('strict',
5175
 
               help='Refuse to send if there are uncommitted changes in'
5176
 
               ' the working tree, --no-strict disables the check.'),
5177
4902
        Option('mail-to', help='Mail the request to this address.',
5178
4903
               type=unicode),
5179
4904
        'revision',
5180
4905
        'message',
5181
4906
        Option('body', help='Body for the email.', type=unicode),
5182
4907
        RegistryOption('format',
5183
 
                       help='Use the specified output format.',
5184
 
                       lazy_registry=('bzrlib.send', 'format_registry')),
 
4908
                       help='Use the specified output format.', 
 
4909
                       lazy_registry=('bzrlib.send', 'format_registry'))
5185
4910
        ]
5186
4911
 
5187
4912
    def run(self, submit_branch=None, public_branch=None, no_bundle=False,
5188
4913
            no_patch=False, revision=None, remember=False, output=None,
5189
 
            format=None, mail_to=None, message=None, body=None,
5190
 
            strict=None, **kwargs):
 
4914
            format=None, mail_to=None, message=None, body=None, **kwargs):
5191
4915
        from bzrlib.send import send
5192
4916
        return send(submit_branch, revision, public_branch, remember,
5193
 
                    format, no_bundle, no_patch, output,
5194
 
                    kwargs.get('from', '.'), mail_to, message, body,
5195
 
                    self.outf,
5196
 
                    strict=strict)
 
4917
                         format, no_bundle, no_patch, output,
 
4918
                         kwargs.get('from', '.'), mail_to, message, body,
 
4919
                         self.outf)
5197
4920
 
5198
4921
 
5199
4922
class cmd_bundle_revisions(cmd_send):
5200
 
    __doc__ = """Create a merge-directive for submitting changes.
 
4923
    """Create a merge-directive for submitting changes.
5201
4924
 
5202
4925
    A merge directive provides many things needed for requesting merges:
5203
4926
 
5243
4966
               type=unicode),
5244
4967
        Option('output', short_name='o', help='Write directive to this file.',
5245
4968
               type=unicode),
5246
 
        Option('strict',
5247
 
               help='Refuse to bundle revisions if there are uncommitted'
5248
 
               ' changes in the working tree, --no-strict disables the check.'),
5249
4969
        'revision',
5250
4970
        RegistryOption('format',
5251
4971
                       help='Use the specified output format.',
5259
4979
 
5260
4980
    def run(self, submit_branch=None, public_branch=None, no_bundle=False,
5261
4981
            no_patch=False, revision=None, remember=False, output=None,
5262
 
            format=None, strict=None, **kwargs):
 
4982
            format=None, **kwargs):
5263
4983
        if output is None:
5264
4984
            output = '-'
5265
4985
        from bzrlib.send import send
5266
4986
        return send(submit_branch, revision, public_branch, remember,
5267
4987
                         format, no_bundle, no_patch, output,
5268
4988
                         kwargs.get('from', '.'), None, None, None,
5269
 
                         self.outf, strict=strict)
 
4989
                         self.outf)
5270
4990
 
5271
4991
 
5272
4992
class cmd_tag(Command):
5273
 
    __doc__ = """Create, remove or modify a tag naming a revision.
 
4993
    """Create, remove or modify a tag naming a revision.
5274
4994
 
5275
4995
    Tags give human-meaningful names to revisions.  Commands that take a -r
5276
4996
    (--revision) option can be given -rtag:X, where X is any previously
5284
5004
 
5285
5005
    To rename a tag (change the name but keep it on the same revsion), run ``bzr
5286
5006
    tag new-name -r tag:old-name`` and then ``bzr tag --delete oldname``.
5287
 
 
5288
 
    If no tag name is specified it will be determined through the 
5289
 
    'automatic_tag_name' hook. This can e.g. be used to automatically tag
5290
 
    upstream releases by reading configure.ac. See ``bzr help hooks`` for
5291
 
    details.
5292
5007
    """
5293
5008
 
5294
5009
    _see_also = ['commit', 'tags']
5295
 
    takes_args = ['tag_name?']
 
5010
    takes_args = ['tag_name']
5296
5011
    takes_options = [
5297
5012
        Option('delete',
5298
5013
            help='Delete this tag rather than placing it.',
5308
5023
        'revision',
5309
5024
        ]
5310
5025
 
5311
 
    def run(self, tag_name=None,
 
5026
    def run(self, tag_name,
5312
5027
            delete=None,
5313
5028
            directory='.',
5314
5029
            force=None,
5315
5030
            revision=None,
5316
5031
            ):
5317
5032
        branch, relpath = Branch.open_containing(directory)
5318
 
        self.add_cleanup(branch.lock_write().unlock)
5319
 
        if delete:
5320
 
            if tag_name is None:
5321
 
                raise errors.BzrCommandError("No tag specified to delete.")
5322
 
            branch.tags.delete_tag(tag_name)
5323
 
            self.outf.write('Deleted tag %s.\n' % tag_name)
5324
 
        else:
5325
 
            if revision:
5326
 
                if len(revision) != 1:
5327
 
                    raise errors.BzrCommandError(
5328
 
                        "Tags can only be placed on a single revision, "
5329
 
                        "not on a range")
5330
 
                revision_id = revision[0].as_revision_id(branch)
 
5033
        branch.lock_write()
 
5034
        try:
 
5035
            if delete:
 
5036
                branch.tags.delete_tag(tag_name)
 
5037
                self.outf.write('Deleted tag %s.\n' % tag_name)
5331
5038
            else:
5332
 
                revision_id = branch.last_revision()
5333
 
            if tag_name is None:
5334
 
                tag_name = branch.automatic_tag_name(revision_id)
5335
 
                if tag_name is None:
5336
 
                    raise errors.BzrCommandError(
5337
 
                        "Please specify a tag name.")
5338
 
            if (not force) and branch.tags.has_tag(tag_name):
5339
 
                raise errors.TagAlreadyExists(tag_name)
5340
 
            branch.tags.set_tag(tag_name, revision_id)
5341
 
            self.outf.write('Created tag %s.\n' % tag_name)
 
5039
                if revision:
 
5040
                    if len(revision) != 1:
 
5041
                        raise errors.BzrCommandError(
 
5042
                            "Tags can only be placed on a single revision, "
 
5043
                            "not on a range")
 
5044
                    revision_id = revision[0].as_revision_id(branch)
 
5045
                else:
 
5046
                    revision_id = branch.last_revision()
 
5047
                if (not force) and branch.tags.has_tag(tag_name):
 
5048
                    raise errors.TagAlreadyExists(tag_name)
 
5049
                branch.tags.set_tag(tag_name, revision_id)
 
5050
                self.outf.write('Created tag %s.\n' % tag_name)
 
5051
        finally:
 
5052
            branch.unlock()
5342
5053
 
5343
5054
 
5344
5055
class cmd_tags(Command):
5345
 
    __doc__ = """List tags.
 
5056
    """List tags.
5346
5057
 
5347
5058
    This command shows a table of tag names and the revisions they reference.
5348
5059
    """
5376
5087
        if not tags:
5377
5088
            return
5378
5089
 
5379
 
        self.add_cleanup(branch.lock_read().unlock)
5380
 
        if revision:
5381
 
            graph = branch.repository.get_graph()
5382
 
            rev1, rev2 = _get_revision_range(revision, branch, self.name())
5383
 
            revid1, revid2 = rev1.rev_id, rev2.rev_id
5384
 
            # only show revisions between revid1 and revid2 (inclusive)
5385
 
            tags = [(tag, revid) for tag, revid in tags if
5386
 
                graph.is_between(revid, revid1, revid2)]
5387
 
        if sort == 'alpha':
5388
 
            tags.sort()
5389
 
        elif sort == 'time':
5390
 
            timestamps = {}
5391
 
            for tag, revid in tags:
5392
 
                try:
5393
 
                    revobj = branch.repository.get_revision(revid)
5394
 
                except errors.NoSuchRevision:
5395
 
                    timestamp = sys.maxint # place them at the end
5396
 
                else:
5397
 
                    timestamp = revobj.timestamp
5398
 
                timestamps[revid] = timestamp
5399
 
            tags.sort(key=lambda x: timestamps[x[1]])
5400
 
        if not show_ids:
5401
 
            # [ (tag, revid), ... ] -> [ (tag, dotted_revno), ... ]
5402
 
            for index, (tag, revid) in enumerate(tags):
5403
 
                try:
5404
 
                    revno = branch.revision_id_to_dotted_revno(revid)
5405
 
                    if isinstance(revno, tuple):
5406
 
                        revno = '.'.join(map(str, revno))
5407
 
                except errors.NoSuchRevision:
5408
 
                    # Bad tag data/merges can lead to tagged revisions
5409
 
                    # which are not in this branch. Fail gracefully ...
5410
 
                    revno = '?'
5411
 
                tags[index] = (tag, revno)
5412
 
        self.cleanup_now()
 
5090
        branch.lock_read()
 
5091
        try:
 
5092
            if revision:
 
5093
                graph = branch.repository.get_graph()
 
5094
                rev1, rev2 = _get_revision_range(revision, branch, self.name())
 
5095
                revid1, revid2 = rev1.rev_id, rev2.rev_id
 
5096
                # only show revisions between revid1 and revid2 (inclusive)
 
5097
                tags = [(tag, revid) for tag, revid in tags if
 
5098
                    graph.is_between(revid, revid1, revid2)]
 
5099
            if sort == 'alpha':
 
5100
                tags.sort()
 
5101
            elif sort == 'time':
 
5102
                timestamps = {}
 
5103
                for tag, revid in tags:
 
5104
                    try:
 
5105
                        revobj = branch.repository.get_revision(revid)
 
5106
                    except errors.NoSuchRevision:
 
5107
                        timestamp = sys.maxint # place them at the end
 
5108
                    else:
 
5109
                        timestamp = revobj.timestamp
 
5110
                    timestamps[revid] = timestamp
 
5111
                tags.sort(key=lambda x: timestamps[x[1]])
 
5112
            if not show_ids:
 
5113
                # [ (tag, revid), ... ] -> [ (tag, dotted_revno), ... ]
 
5114
                for index, (tag, revid) in enumerate(tags):
 
5115
                    try:
 
5116
                        revno = branch.revision_id_to_dotted_revno(revid)
 
5117
                        if isinstance(revno, tuple):
 
5118
                            revno = '.'.join(map(str, revno))
 
5119
                    except errors.NoSuchRevision:
 
5120
                        # Bad tag data/merges can lead to tagged revisions
 
5121
                        # which are not in this branch. Fail gracefully ...
 
5122
                        revno = '?'
 
5123
                    tags[index] = (tag, revno)
 
5124
        finally:
 
5125
            branch.unlock()
5413
5126
        for tag, revspec in tags:
5414
5127
            self.outf.write('%-20s %s\n' % (tag, revspec))
5415
5128
 
5416
5129
 
5417
5130
class cmd_reconfigure(Command):
5418
 
    __doc__ = """Reconfigure the type of a bzr directory.
 
5131
    """Reconfigure the type of a bzr directory.
5419
5132
 
5420
5133
    A target configuration must be specified.
5421
5134
 
5451
5164
            ),
5452
5165
        Option('bind-to', help='Branch to bind checkout to.', type=str),
5453
5166
        Option('force',
5454
 
            help='Perform reconfiguration even if local changes'
5455
 
            ' will be lost.'),
5456
 
        Option('stacked-on',
5457
 
            help='Reconfigure a branch to be stacked on another branch.',
5458
 
            type=unicode,
5459
 
            ),
5460
 
        Option('unstacked',
5461
 
            help='Reconfigure a branch to be unstacked.  This '
5462
 
                'may require copying substantial data into it.',
5463
 
            ),
 
5167
               help='Perform reconfiguration even if local changes'
 
5168
               ' will be lost.')
5464
5169
        ]
5465
5170
 
5466
 
    def run(self, location=None, target_type=None, bind_to=None, force=False,
5467
 
            stacked_on=None,
5468
 
            unstacked=None):
 
5171
    def run(self, location=None, target_type=None, bind_to=None, force=False):
5469
5172
        directory = bzrdir.BzrDir.open(location)
5470
 
        if stacked_on and unstacked:
5471
 
            raise BzrCommandError("Can't use both --stacked-on and --unstacked")
5472
 
        elif stacked_on is not None:
5473
 
            reconfigure.ReconfigureStackedOn().apply(directory, stacked_on)
5474
 
        elif unstacked:
5475
 
            reconfigure.ReconfigureUnstacked().apply(directory)
5476
 
        # At the moment you can use --stacked-on and a different
5477
 
        # reconfiguration shape at the same time; there seems no good reason
5478
 
        # to ban it.
5479
5173
        if target_type is None:
5480
 
            if stacked_on or unstacked:
5481
 
                return
5482
 
            else:
5483
 
                raise errors.BzrCommandError('No target configuration '
5484
 
                    'specified')
 
5174
            raise errors.BzrCommandError('No target configuration specified')
5485
5175
        elif target_type == 'branch':
5486
5176
            reconfiguration = reconfigure.Reconfigure.to_branch(directory)
5487
5177
        elif target_type == 'tree':
5506
5196
 
5507
5197
 
5508
5198
class cmd_switch(Command):
5509
 
    __doc__ = """Set the branch of a checkout and update.
 
5199
    """Set the branch of a checkout and update.
5510
5200
 
5511
5201
    For lightweight checkouts, this changes the branch being referenced.
5512
5202
    For heavyweight checkouts, this checks that there are no local commits
5524
5214
    /path/to/newbranch.
5525
5215
 
5526
5216
    Bound branches use the nickname of its master branch unless it is set
5527
 
    locally, in which case switching will update the local nickname to be
 
5217
    locally, in which case switching will update the the local nickname to be
5528
5218
    that of the master.
5529
5219
    """
5530
5220
 
5531
 
    takes_args = ['to_location?']
 
5221
    takes_args = ['to_location']
5532
5222
    takes_options = [Option('force',
5533
 
                        help='Switch even if local commits will be lost.'),
5534
 
                     'revision',
5535
 
                     Option('create-branch', short_name='b',
5536
 
                        help='Create the target branch from this one before'
5537
 
                             ' switching to it.'),
5538
 
                    ]
 
5223
                        help='Switch even if local commits will be lost.')
 
5224
                     ]
5539
5225
 
5540
 
    def run(self, to_location=None, force=False, create_branch=False,
5541
 
            revision=None):
 
5226
    def run(self, to_location, force=False):
5542
5227
        from bzrlib import switch
5543
5228
        tree_location = '.'
5544
 
        revision = _get_one_revision('switch', revision)
5545
5229
        control_dir = bzrdir.BzrDir.open_containing(tree_location)[0]
5546
 
        if to_location is None:
5547
 
            if revision is None:
5548
 
                raise errors.BzrCommandError('You must supply either a'
5549
 
                                             ' revision or a location')
5550
 
            to_location = '.'
5551
5230
        try:
5552
5231
            branch = control_dir.open_branch()
5553
5232
            had_explicit_nick = branch.get_config().has_explicit_nickname()
5554
5233
        except errors.NotBranchError:
5555
 
            branch = None
5556
5234
            had_explicit_nick = False
5557
 
        if create_branch:
5558
 
            if branch is None:
5559
 
                raise errors.BzrCommandError('cannot create branch without'
5560
 
                                             ' source branch')
5561
 
            to_location = directory_service.directories.dereference(
5562
 
                              to_location)
5563
 
            if '/' not in to_location and '\\' not in to_location:
5564
 
                # This path is meant to be relative to the existing branch
5565
 
                this_url = self._get_branch_location(control_dir)
5566
 
                to_location = urlutils.join(this_url, '..', to_location)
5567
 
            to_branch = branch.bzrdir.sprout(to_location,
5568
 
                                 possible_transports=[branch.bzrdir.root_transport],
5569
 
                                 source_branch=branch).open_branch()
5570
 
        else:
5571
 
            try:
5572
 
                to_branch = Branch.open(to_location)
5573
 
            except errors.NotBranchError:
5574
 
                this_url = self._get_branch_location(control_dir)
5575
 
                to_branch = Branch.open(
5576
 
                    urlutils.join(this_url, '..', to_location))
5577
 
        if revision is not None:
5578
 
            revision = revision.as_revision_id(to_branch)
5579
 
        switch.switch(control_dir, to_branch, force, revision_id=revision)
 
5235
        try:
 
5236
            to_branch = Branch.open(to_location)
 
5237
        except errors.NotBranchError:
 
5238
            this_url = self._get_branch_location(control_dir)
 
5239
            to_branch = Branch.open(
 
5240
                urlutils.join(this_url, '..', to_location))
 
5241
        switch.switch(control_dir, to_branch, force)
5580
5242
        if had_explicit_nick:
5581
5243
            branch = control_dir.open_branch() #get the new branch!
5582
5244
            branch.nick = to_branch.nick
5602
5264
 
5603
5265
 
5604
5266
class cmd_view(Command):
5605
 
    __doc__ = """Manage filtered views.
 
5267
    """Manage filtered views.
5606
5268
 
5607
5269
    Views provide a mask over the tree so that users can focus on
5608
5270
    a subset of a tree when doing their work. After creating a view,
5756
5418
 
5757
5419
 
5758
5420
class cmd_hooks(Command):
5759
 
    __doc__ = """Show hooks."""
 
5421
    """Show hooks."""
5760
5422
 
5761
5423
    hidden = True
5762
5424
 
5775
5437
                    self.outf.write("    <no hooks installed>\n")
5776
5438
 
5777
5439
 
5778
 
class cmd_remove_branch(Command):
5779
 
    __doc__ = """Remove a branch.
5780
 
 
5781
 
    This will remove the branch from the specified location but 
5782
 
    will keep any working tree or repository in place.
5783
 
 
5784
 
    :Examples:
5785
 
 
5786
 
      Remove the branch at repo/trunk::
5787
 
 
5788
 
        bzr remove-branch repo/trunk
5789
 
 
5790
 
    """
5791
 
 
5792
 
    takes_args = ["location?"]
5793
 
 
5794
 
    aliases = ["rmbranch"]
5795
 
 
5796
 
    def run(self, location=None):
5797
 
        if location is None:
5798
 
            location = "."
5799
 
        branch = Branch.open_containing(location)[0]
5800
 
        branch.bzrdir.destroy_branch()
5801
 
        
5802
 
 
5803
5440
class cmd_shelve(Command):
5804
 
    __doc__ = """Temporarily set aside some changes from the current tree.
 
5441
    """Temporarily set aside some changes from the current tree.
5805
5442
 
5806
5443
    Shelve allows you to temporarily put changes you've made "on the shelf",
5807
5444
    ie. out of the way, until a later time when you can bring them back from
5849
5486
        if writer is None:
5850
5487
            writer = bzrlib.option.diff_writer_registry.get()
5851
5488
        try:
5852
 
            shelver = Shelver.from_args(writer(sys.stdout), revision, all,
5853
 
                file_list, message, destroy=destroy)
5854
 
            try:
5855
 
                shelver.run()
5856
 
            finally:
5857
 
                shelver.finalize()
 
5489
            Shelver.from_args(writer(sys.stdout), revision, all, file_list,
 
5490
                              message, destroy=destroy).run()
5858
5491
        except errors.UserAbort:
5859
5492
            return 0
5860
5493
 
5861
5494
    def run_for_list(self):
5862
5495
        tree = WorkingTree.open_containing('.')[0]
5863
 
        self.add_cleanup(tree.lock_read().unlock)
5864
 
        manager = tree.get_shelf_manager()
5865
 
        shelves = manager.active_shelves()
5866
 
        if len(shelves) == 0:
5867
 
            note('No shelved changes.')
5868
 
            return 0
5869
 
        for shelf_id in reversed(shelves):
5870
 
            message = manager.get_metadata(shelf_id).get('message')
5871
 
            if message is None:
5872
 
                message = '<no message>'
5873
 
            self.outf.write('%3d: %s\n' % (shelf_id, message))
5874
 
        return 1
 
5496
        tree.lock_read()
 
5497
        try:
 
5498
            manager = tree.get_shelf_manager()
 
5499
            shelves = manager.active_shelves()
 
5500
            if len(shelves) == 0:
 
5501
                note('No shelved changes.')
 
5502
                return 0
 
5503
            for shelf_id in reversed(shelves):
 
5504
                message = manager.get_metadata(shelf_id).get('message')
 
5505
                if message is None:
 
5506
                    message = '<no message>'
 
5507
                self.outf.write('%3d: %s\n' % (shelf_id, message))
 
5508
            return 1
 
5509
        finally:
 
5510
            tree.unlock()
5875
5511
 
5876
5512
 
5877
5513
class cmd_unshelve(Command):
5878
 
    __doc__ = """Restore shelved changes.
 
5514
    """Restore shelved changes.
5879
5515
 
5880
5516
    By default, the most recently shelved changes are restored. However if you
5881
5517
    specify a shelf by id those changes will be restored instead.  This works
5889
5525
            enum_switch=False, value_switches=True,
5890
5526
            apply="Apply changes and remove from the shelf.",
5891
5527
            dry_run="Show changes, but do not apply or remove them.",
5892
 
            preview="Instead of unshelving the changes, show the diff that "
5893
 
                    "would result from unshelving.",
5894
 
            delete_only="Delete changes without applying them.",
5895
 
            keep="Apply changes but don't delete them.",
 
5528
            delete_only="Delete changes without applying them."
5896
5529
        )
5897
5530
    ]
5898
5531
    _see_also = ['shelve']
5899
5532
 
5900
5533
    def run(self, shelf_id=None, action='apply'):
5901
5534
        from bzrlib.shelf_ui import Unshelver
5902
 
        unshelver = Unshelver.from_args(shelf_id, action)
5903
 
        try:
5904
 
            unshelver.run()
5905
 
        finally:
5906
 
            unshelver.tree.unlock()
 
5535
        Unshelver.from_args(shelf_id, action).run()
5907
5536
 
5908
5537
 
5909
5538
class cmd_clean_tree(Command):
5910
 
    __doc__ = """Remove unwanted files from working tree.
 
5539
    """Remove unwanted files from working tree.
5911
5540
 
5912
5541
    By default, only unknown files, not ignored files, are deleted.  Versioned
5913
5542
    files are never deleted.
5941
5570
 
5942
5571
 
5943
5572
class cmd_reference(Command):
5944
 
    __doc__ = """list, view and set branch locations for nested trees.
 
5573
    """list, view and set branch locations for nested trees.
5945
5574
 
5946
5575
    If no arguments are provided, lists the branch locations for nested trees.
5947
5576
    If one argument is provided, display the branch location for that tree.
5987
5616
            self.outf.write('%s %s\n' % (path, location))
5988
5617
 
5989
5618
 
5990
 
def _register_lazy_builtins():
5991
 
    # register lazy builtins from other modules; called at startup and should
5992
 
    # be only called once.
5993
 
    for (name, aliases, module_name) in [
5994
 
        ('cmd_bundle_info', [], 'bzrlib.bundle.commands'),
5995
 
        ('cmd_dpush', [], 'bzrlib.foreign'),
5996
 
        ('cmd_version_info', [], 'bzrlib.cmd_version_info'),
5997
 
        ('cmd_resolve', ['resolved'], 'bzrlib.conflicts'),
5998
 
        ('cmd_conflicts', [], 'bzrlib.conflicts'),
5999
 
        ('cmd_sign_my_commits', [], 'bzrlib.sign_my_commits'),
6000
 
        ]:
6001
 
        builtin_command_registry.register_lazy(name, aliases, module_name)
 
5619
# these get imported and then picked up by the scan for cmd_*
 
5620
# TODO: Some more consistent way to split command definitions across files;
 
5621
# we do need to load at least some information about them to know of
 
5622
# aliases.  ideally we would avoid loading the implementation until the
 
5623
# details were needed.
 
5624
from bzrlib.cmd_version_info import cmd_version_info
 
5625
from bzrlib.conflicts import cmd_resolve, cmd_conflicts, restore
 
5626
from bzrlib.bundle.commands import (
 
5627
    cmd_bundle_info,
 
5628
    )
 
5629
from bzrlib.foreign import cmd_dpush
 
5630
from bzrlib.sign_my_commits import cmd_sign_my_commits
 
5631
from bzrlib.weave_commands import cmd_versionedfile_list, \
 
5632
        cmd_weave_plan_merge, cmd_weave_merge_text