← 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-06-19 09:06:56 UTC
  • mfrom: (4463 +trunk)
  • mto: This revision was merged to the branch mainline in revision 4464.
  • Revision ID: mbp@sourcefrog.net-20090619090656-d5weqeecyscv8kqp
merge news

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
 
                wt.lock_read()
532
 
            except (errors.NoWorkingTree, errors.NotLocalUrl):
533
 
                raise errors.NoWorkingTree(location)
534
 
            self.add_cleanup(wt.unlock)
535
 
            revid = wt.last_revision()
536
 
            try:
537
 
                revno_t = wt.branch.revision_id_to_dotted_revno(revid)
538
 
            except errors.NoSuchRevision:
539
 
                revno_t = ('???',)
540
 
            revno = ".".join(str(n) for n in revno_t)
541
 
        else:
542
 
            b = Branch.open_containing(location)[0]
543
 
            b.lock_read()
544
 
            self.add_cleanup(b.unlock)
545
 
            revno = b.revno()
546
 
        self.cleanup_now()
547
 
        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')
548
482
 
549
483
 
550
484
class cmd_revision_info(Command):
551
 
    __doc__ = """Show revision number and revision id for a given revision identifier.
 
485
    """Show revision number and revision id for a given revision identifier.
552
486
    """
553
487
    hidden = True
554
488
    takes_args = ['revision_info*']
560
494
            short_name='d',
561
495
            type=unicode,
562
496
            ),
563
 
        Option('tree', help='Show revno of working tree'),
564
497
        ]
565
498
 
566
499
    @display_command
567
 
    def run(self, revision=None, directory=u'.', tree=False,
568
 
            revision_info_list=[]):
 
500
    def run(self, revision=None, directory=u'.', revision_info_list=[]):
569
501
 
570
 
        try:
571
 
            wt = WorkingTree.open_containing(directory)[0]
572
 
            b = wt.branch
573
 
            wt.lock_read()
574
 
            self.add_cleanup(wt.unlock)
575
 
        except (errors.NoWorkingTree, errors.NotLocalUrl):
576
 
            wt = None
577
 
            b = Branch.open_containing(directory)[0]
578
 
            b.lock_read()
579
 
            self.add_cleanup(b.unlock)
580
 
        revision_ids = []
 
502
        revs = []
581
503
        if revision is not None:
582
 
            revision_ids.extend(rev.as_revision_id(b) for rev in revision)
 
504
            revs.extend(revision)
583
505
        if revision_info_list is not None:
584
 
            for rev_str in revision_info_list:
585
 
                rev_spec = RevisionSpec.from_string(rev_str)
586
 
                revision_ids.append(rev_spec.as_revision_id(b))
587
 
        # No arguments supplied, default to the last revision
588
 
        if len(revision_ids) == 0:
589
 
            if tree:
590
 
                if wt is None:
591
 
                    raise errors.NoWorkingTree(directory)
592
 
                revision_ids.append(wt.last_revision())
593
 
            else:
594
 
                revision_ids.append(b.last_revision())
595
 
 
596
 
        revinfos = []
597
 
        maxlen = 0
598
 
        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)
599
516
            try:
600
 
                dotted_revno = b.revision_id_to_dotted_revno(revision_id)
601
 
                revno = '.'.join(str(i) for i in dotted_revno)
 
517
                revno = '%4d' % (b.revision_id_to_revno(revision_id))
602
518
            except errors.NoSuchRevision:
603
 
                revno = '???'
604
 
            maxlen = max(maxlen, len(revno))
605
 
            revinfos.append([revno, revision_id])
606
 
 
607
 
        self.cleanup_now()
608
 
        for ri in revinfos:
609
 
            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)
610
522
 
611
523
 
612
524
class cmd_add(Command):
613
 
    __doc__ = """Add specified files or directories.
 
525
    """Add specified files or directories.
614
526
 
615
527
    In non-recursive mode, all the named items are added, regardless
616
528
    of whether they were previously ignored.  A warning is given if
642
554
    branches that will be merged later (without showing the two different
643
555
    adds as a conflict). It is also useful when merging another project
644
556
    into a subdirectory of this one.
645
 
    
646
 
    Any files matching patterns in the ignore list will not be added
647
 
    unless they are explicitly mentioned.
648
557
    """
649
558
    takes_args = ['file*']
650
559
    takes_options = [
658
567
               help='Lookup file ids from this tree.'),
659
568
        ]
660
569
    encoding_type = 'replace'
661
 
    _see_also = ['remove', 'ignore']
 
570
    _see_also = ['remove']
662
571
 
663
572
    def run(self, file_list, no_recurse=False, dry_run=False, verbose=False,
664
573
            file_ids_from=None):
682
591
 
683
592
        if base_tree:
684
593
            base_tree.lock_read()
685
 
            self.add_cleanup(base_tree.unlock)
686
 
        tree, file_list = tree_files_for_add(file_list)
687
 
        added, ignored = tree.smart_add(file_list, not
688
 
            no_recurse, action=action, save=not dry_run)
689
 
        self.cleanup_now()
 
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()
690
602
        if len(ignored) > 0:
691
603
            if verbose:
692
604
                for glob in sorted(ignored.keys()):
693
605
                    for path in ignored[glob]:
694
606
                        self.outf.write("ignored %s matching \"%s\"\n"
695
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")
696
616
 
697
617
 
698
618
class cmd_mkdir(Command):
699
 
    __doc__ = """Create a new versioned directory.
 
619
    """Create a new versioned directory.
700
620
 
701
621
    This is equivalent to creating the directory and then adding it.
702
622
    """
706
626
 
707
627
    def run(self, dir_list):
708
628
        for d in dir_list:
 
629
            os.mkdir(d)
709
630
            wt, dd = WorkingTree.open_containing(d)
710
 
            base = os.path.dirname(dd)
711
 
            id = wt.path2id(base)
712
 
            if id != None:
713
 
                os.mkdir(d)
714
 
                wt.add([dd])
715
 
                self.outf.write('added %s\n' % d)
716
 
            else:
717
 
                raise errors.NotVersionedError(path=base)
 
631
            wt.add([dd])
 
632
            self.outf.write('added %s\n' % d)
718
633
 
719
634
 
720
635
class cmd_relpath(Command):
721
 
    __doc__ = """Show path of a file relative to root"""
 
636
    """Show path of a file relative to root"""
722
637
 
723
638
    takes_args = ['filename']
724
639
    hidden = True
733
648
 
734
649
 
735
650
class cmd_inventory(Command):
736
 
    __doc__ = """Show inventory of the current working copy or a revision.
 
651
    """Show inventory of the current working copy or a revision.
737
652
 
738
653
    It is possible to limit the output to a particular entry
739
654
    type using the --kind option.  For example: --kind file.
761
676
        revision = _get_one_revision('inventory', revision)
762
677
        work_tree, file_list = tree_files(file_list)
763
678
        work_tree.lock_read()
764
 
        self.add_cleanup(work_tree.unlock)
765
 
        if revision is not None:
766
 
            tree = revision.as_tree(work_tree.branch)
767
 
 
768
 
            extra_trees = [work_tree]
769
 
            tree.lock_read()
770
 
            self.add_cleanup(tree.unlock)
771
 
        else:
772
 
            tree = work_tree
773
 
            extra_trees = []
774
 
 
775
 
        if file_list is not None:
776
 
            file_ids = tree.paths2ids(file_list, trees=extra_trees,
777
 
                                      require_versioned=True)
778
 
            # find_ids_across_trees may include some paths that don't
779
 
            # exist in 'tree'.
780
 
            entries = sorted((tree.id2path(file_id), tree.inventory[file_id])
781
 
                             for file_id in file_ids if file_id in tree)
782
 
        else:
783
 
            entries = tree.inventory.entries()
784
 
 
785
 
        self.cleanup_now()
 
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
 
786
703
        for path, entry in entries:
787
704
            if kind and kind != entry.kind:
788
705
                continue
794
711
 
795
712
 
796
713
class cmd_mv(Command):
797
 
    __doc__ = """Move or rename a file.
 
714
    """Move or rename a file.
798
715
 
799
716
    :Usage:
800
717
        bzr mv OLDNAME NEWNAME
833
750
        if len(names_list) < 2:
834
751
            raise errors.BzrCommandError("missing file argument")
835
752
        tree, rel_names = tree_files(names_list, canonicalize=False)
836
 
        tree.lock_tree_write()
837
 
        self.add_cleanup(tree.unlock)
838
 
        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()
839
758
 
840
759
    def run_auto(self, names_list, after, dry_run):
841
760
        if names_list is not None and len(names_list) > 1:
845
764
            raise errors.BzrCommandError('--after cannot be specified with'
846
765
                                         ' --auto.')
847
766
        work_tree, file_list = tree_files(names_list, default_branch='.')
848
 
        work_tree.lock_tree_write()
849
 
        self.add_cleanup(work_tree.unlock)
850
 
        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()
851
772
 
852
773
    def _run(self, tree, names_list, rel_names, after):
853
774
        into_existing = osutils.isdir(names_list[-1])
874
795
            # All entries reference existing inventory items, so fix them up
875
796
            # for cicp file-systems.
876
797
            rel_names = tree.get_canonical_inventory_paths(rel_names)
877
 
            for src, dest in tree.move(rel_names[:-1], rel_names[-1], after=after):
878
 
                if not is_quiet():
879
 
                    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)
880
800
        else:
881
801
            if len(names_list) != 2:
882
802
                raise errors.BzrCommandError('to mv multiple files the'
926
846
            dest = osutils.pathjoin(dest_parent, dest_tail)
927
847
            mutter("attempting to move %s => %s", src, dest)
928
848
            tree.rename_one(src, dest, after=after)
929
 
            if not is_quiet():
930
 
                self.outf.write("%s => %s\n" % (src, dest))
 
849
            self.outf.write("%s => %s\n" % (src, dest))
931
850
 
932
851
 
933
852
class cmd_pull(Command):
934
 
    __doc__ = """Turn this branch into a mirror of another branch.
 
853
    """Turn this branch into a mirror of another branch.
935
854
 
936
 
    By default, this command only works on branches that have not diverged.
937
 
    Branches are considered diverged if the destination branch's most recent 
938
 
    commit is one that has not been merged (directly or indirectly) into the 
939
 
    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.
940
858
 
941
859
    If branches have diverged, you can use 'bzr merge' to integrate the changes
942
860
    from one into the other.  Once one branch has merged, the other should
943
861
    be able to pull it again.
944
862
 
945
 
    If you want to replace your local changes and just want your branch to
946
 
    match the remote one, use pull --overwrite. This will work even if the two
947
 
    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.
948
865
 
949
866
    If there is no default location set, the first pull will set it.  After
950
867
    that, you can omit the location to use the default.  To change the
986
903
        try:
987
904
            tree_to = WorkingTree.open_containing(directory)[0]
988
905
            branch_to = tree_to.branch
989
 
            tree_to.lock_write()
990
 
            self.add_cleanup(tree_to.unlock)
991
906
        except errors.NoWorkingTree:
992
907
            tree_to = None
993
908
            branch_to = Branch.open_containing(directory)[0]
994
 
            branch_to.lock_write()
995
 
            self.add_cleanup(branch_to.unlock)
996
 
 
 
909
        
997
910
        if local and not branch_to.get_bound_location():
998
911
            raise errors.LocalRequiresBoundBranch()
999
912
 
1029
942
        else:
1030
943
            branch_from = Branch.open(location,
1031
944
                possible_transports=possible_transports)
1032
 
            branch_from.lock_read()
1033
 
            self.add_cleanup(branch_from.unlock)
1034
945
 
1035
946
            if branch_to.get_parent() is None or remember:
1036
947
                branch_to.set_parent(branch_from.base)
1037
948
 
1038
 
        if revision is not None:
1039
 
            revision_id = revision.as_revision_id(branch_from)
1040
 
 
1041
 
        if tree_to is not None:
1042
 
            view_info = _get_view_info_for_change_reporter(tree_to)
1043
 
            change_reporter = delta._ChangeReporter(
1044
 
                unversioned_filter=tree_to.is_ignored,
1045
 
                view_info=view_info)
1046
 
            result = tree_to.pull(
1047
 
                branch_from, overwrite, revision_id, change_reporter,
1048
 
                possible_transports=possible_transports, local=local)
1049
 
        else:
1050
 
            result = branch_to.pull(
1051
 
                branch_from, overwrite, revision_id, local=local)
1052
 
 
1053
 
        result.report(self.outf)
1054
 
        if verbose and result.old_revid != result.new_revid:
1055
 
            log.show_branch_change(
1056
 
                branch_to, self.outf, result.old_revno,
1057
 
                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()
1058
979
 
1059
980
 
1060
981
class cmd_push(Command):
1061
 
    __doc__ = """Update a mirror of this branch.
 
982
    """Update a mirror of this branch.
1062
983
 
1063
984
    The target branch will not have its working tree populated because this
1064
985
    is both expensive, and is not supported on remote file systems.
1109
1030
            type=unicode),
1110
1031
        Option('strict',
1111
1032
               help='Refuse to push if there are uncommitted changes in'
1112
 
               ' the working tree, --no-strict disables the check.'),
 
1033
               ' the working tree.'),
1113
1034
        ]
1114
1035
    takes_args = ['location?']
1115
1036
    encoding_type = 'replace'
1123
1044
        if directory is None:
1124
1045
            directory = '.'
1125
1046
        # Get the source branch
1126
 
        (tree, br_from,
1127
 
         _unused) = bzrdir.BzrDir.open_containing_tree_or_branch(directory)
 
1047
        tree, br_from = bzrdir.BzrDir.open_tree_or_branch(directory)
 
1048
        if strict is None:
 
1049
            strict = br_from.get_config().get_user_option('push_strict')
 
1050
            if strict is not None:
 
1051
                # FIXME: This should be better supported by config
 
1052
                # -- vila 20090611
 
1053
                bools = dict(yes=True, no=False, on=True, off=False,
 
1054
                             true=True, false=False)
 
1055
                try:
 
1056
                    strict = bools[strict.lower()]
 
1057
                except KeyError:
 
1058
                    strict = None
 
1059
        if strict:
 
1060
            changes = tree.changes_from(tree.basis_tree())
 
1061
            if changes.has_changed():
 
1062
                raise errors.UncommittedChanges(tree)
1128
1063
        # Get the tip's revision_id
1129
1064
        revision = _get_one_revision('push', revision)
1130
1065
        if revision is not None:
1131
1066
            revision_id = revision.in_history(br_from).rev_id
1132
1067
        else:
1133
1068
            revision_id = None
1134
 
        if tree is not None and revision_id is None:
1135
 
            tree.check_changed_or_out_of_date(
1136
 
                strict, 'push_strict',
1137
 
                more_error='Use --no-strict to force the push.',
1138
 
                more_warning='Uncommitted changes will not be pushed.')
 
1069
 
1139
1070
        # Get the stacked_on branch, if any
1140
1071
        if stacked_on is not None:
1141
1072
            stacked_on = urlutils.normalize_url(stacked_on)
1173
1104
 
1174
1105
 
1175
1106
class cmd_branch(Command):
1176
 
    __doc__ = """Create a new branch that is a copy of an existing branch.
 
1107
    """Create a new branch that is a copy of an existing branch.
1177
1108
 
1178
1109
    If the TO_LOCATION is omitted, the last component of the FROM_LOCATION will
1179
1110
    be used.  In other words, "branch ../foo/bar" will attempt to create ./bar.
1192
1123
        help='Hard-link working tree files where possible.'),
1193
1124
        Option('no-tree',
1194
1125
            help="Create a branch without a working-tree."),
1195
 
        Option('switch',
1196
 
            help="Switch the checkout in the current directory "
1197
 
                 "to the new branch."),
1198
1126
        Option('stacked',
1199
1127
            help='Create a stacked branch referring to the source branch. '
1200
1128
                'The new branch will depend on the availability of the source '
1201
1129
                'branch for all operations.'),
1202
1130
        Option('standalone',
1203
1131
               help='Do not use a shared repository, even if available.'),
1204
 
        Option('use-existing-dir',
1205
 
               help='By default branch will fail if the target'
1206
 
                    ' directory exists, but does not already'
1207
 
                    ' have a control directory.  This flag will'
1208
 
                    ' allow branch to proceed.'),
1209
 
        Option('bind',
1210
 
            help="Bind new branch to from location."),
1211
1132
        ]
1212
1133
    aliases = ['get', 'clone']
1213
1134
 
1214
1135
    def run(self, from_location, to_location=None, revision=None,
1215
 
            hardlink=False, stacked=False, standalone=False, no_tree=False,
1216
 
            use_existing_dir=False, switch=False, bind=False):
1217
 
        from bzrlib import switch as _mod_switch
 
1136
            hardlink=False, stacked=False, standalone=False, no_tree=False):
1218
1137
        from bzrlib.tag import _merge_tags_if_possible
 
1138
 
1219
1139
        accelerator_tree, br_from = bzrdir.BzrDir.open_tree_or_branch(
1220
1140
            from_location)
 
1141
        if (accelerator_tree is not None and
 
1142
            accelerator_tree.supports_content_filtering()):
 
1143
            accelerator_tree = None
1221
1144
        revision = _get_one_revision('branch', revision)
1222
1145
        br_from.lock_read()
1223
 
        self.add_cleanup(br_from.unlock)
1224
 
        if revision is not None:
1225
 
            revision_id = revision.as_revision_id(br_from)
1226
 
        else:
1227
 
            # FIXME - wt.last_revision, fallback to branch, fall back to
1228
 
            # None or perhaps NULL_REVISION to mean copy nothing
1229
 
            # RBC 20060209
1230
 
            revision_id = br_from.last_revision()
1231
 
        if to_location is None:
1232
 
            to_location = urlutils.derive_to_location(from_location)
1233
 
        to_transport = transport.get_transport(to_location)
1234
1146
        try:
1235
 
            to_transport.mkdir('.')
1236
 
        except errors.FileExists:
1237
 
            if not use_existing_dir:
1238
 
                raise errors.BzrCommandError('Target directory "%s" '
1239
 
                    'already exists.' % to_location)
 
1147
            if revision is not None:
 
1148
                revision_id = revision.as_revision_id(br_from)
1240
1149
            else:
1241
 
                try:
1242
 
                    bzrdir.BzrDir.open_from_transport(to_transport)
1243
 
                except errors.NotBranchError:
1244
 
                    pass
1245
 
                else:
1246
 
                    raise errors.AlreadyBranchError(to_location)
1247
 
        except errors.NoSuchFile:
1248
 
            raise errors.BzrCommandError('Parent of "%s" does not exist.'
1249
 
                                         % to_location)
1250
 
        try:
1251
 
            # preserve whatever source format we have.
1252
 
            dir = br_from.bzrdir.sprout(to_transport.base, revision_id,
1253
 
                                        possible_transports=[to_transport],
1254
 
                                        accelerator_tree=accelerator_tree,
1255
 
                                        hardlink=hardlink, stacked=stacked,
1256
 
                                        force_new_repo=standalone,
1257
 
                                        create_tree_if_local=not no_tree,
1258
 
                                        source_branch=br_from)
1259
 
            branch = dir.open_branch()
1260
 
        except errors.NoSuchRevision:
1261
 
            to_transport.delete_tree('.')
1262
 
            msg = "The branch %s has no revision %s." % (from_location,
1263
 
                revision)
1264
 
            raise errors.BzrCommandError(msg)
1265
 
        _merge_tags_if_possible(br_from, branch)
1266
 
        # If the source branch is stacked, the new branch may
1267
 
        # be stacked whether we asked for that explicitly or not.
1268
 
        # We therefore need a try/except here and not just 'if stacked:'
1269
 
        try:
1270
 
            note('Created new stacked branch referring to %s.' %
1271
 
                branch.get_stacked_on_url())
1272
 
        except (errors.NotStacked, errors.UnstackableBranchFormat,
1273
 
            errors.UnstackableRepositoryFormat), e:
1274
 
            note('Branched %d revision(s).' % branch.revno())
1275
 
        if bind:
1276
 
            # Bind to the parent
1277
 
            parent_branch = Branch.open(from_location)
1278
 
            branch.bind(parent_branch)
1279
 
            note('New branch bound to %s' % from_location)
1280
 
        if switch:
1281
 
            # Switch to the new branch
1282
 
            wt, _ = WorkingTree.open_containing('.')
1283
 
            _mod_switch.switch(wt.bzrdir, branch)
1284
 
            note('Switched to branch: %s',
1285
 
                urlutils.unescape_for_display(branch.base, 'utf-8'))
 
1150
                # FIXME - wt.last_revision, fallback to branch, fall back to
 
1151
                # None or perhaps NULL_REVISION to mean copy nothing
 
1152
                # RBC 20060209
 
1153
                revision_id = br_from.last_revision()
 
1154
            if to_location is None:
 
1155
                to_location = urlutils.derive_to_location(from_location)
 
1156
            to_transport = transport.get_transport(to_location)
 
1157
            try:
 
1158
                to_transport.mkdir('.')
 
1159
            except errors.FileExists:
 
1160
                raise errors.BzrCommandError('Target directory "%s" already'
 
1161
                                             ' exists.' % to_location)
 
1162
            except errors.NoSuchFile:
 
1163
                raise errors.BzrCommandError('Parent of "%s" does not exist.'
 
1164
                                             % to_location)
 
1165
            try:
 
1166
                # preserve whatever source format we have.
 
1167
                dir = br_from.bzrdir.sprout(to_transport.base, revision_id,
 
1168
                                            possible_transports=[to_transport],
 
1169
                                            accelerator_tree=accelerator_tree,
 
1170
                                            hardlink=hardlink, stacked=stacked,
 
1171
                                            force_new_repo=standalone,
 
1172
                                            create_tree_if_local=not no_tree,
 
1173
                                            source_branch=br_from)
 
1174
                branch = dir.open_branch()
 
1175
            except errors.NoSuchRevision:
 
1176
                to_transport.delete_tree('.')
 
1177
                msg = "The branch %s has no revision %s." % (from_location,
 
1178
                    revision)
 
1179
                raise errors.BzrCommandError(msg)
 
1180
            _merge_tags_if_possible(br_from, branch)
 
1181
            # If the source branch is stacked, the new branch may
 
1182
            # be stacked whether we asked for that explicitly or not.
 
1183
            # We therefore need a try/except here and not just 'if stacked:'
 
1184
            try:
 
1185
                note('Created new stacked branch referring to %s.' %
 
1186
                    branch.get_stacked_on_url())
 
1187
            except (errors.NotStacked, errors.UnstackableBranchFormat,
 
1188
                errors.UnstackableRepositoryFormat), e:
 
1189
                note('Branched %d revision(s).' % branch.revno())
 
1190
        finally:
 
1191
            br_from.unlock()
1286
1192
 
1287
1193
 
1288
1194
class cmd_checkout(Command):
1289
 
    __doc__ = """Create a new checkout of an existing branch.
 
1195
    """Create a new checkout of an existing branch.
1290
1196
 
1291
1197
    If BRANCH_LOCATION is omitted, checkout will reconstitute a working tree for
1292
1198
    the branch found in '.'. This is useful if you have removed the working tree
1355
1261
 
1356
1262
 
1357
1263
class cmd_renames(Command):
1358
 
    __doc__ = """Show list of renamed files.
 
1264
    """Show list of renamed files.
1359
1265
    """
1360
1266
    # TODO: Option to show renames between two historical versions.
1361
1267
 
1367
1273
    def run(self, dir=u'.'):
1368
1274
        tree = WorkingTree.open_containing(dir)[0]
1369
1275
        tree.lock_read()
1370
 
        self.add_cleanup(tree.unlock)
1371
 
        new_inv = tree.inventory
1372
 
        old_tree = tree.basis_tree()
1373
 
        old_tree.lock_read()
1374
 
        self.add_cleanup(old_tree.unlock)
1375
 
        old_inv = old_tree.inventory
1376
 
        renames = []
1377
 
        iterator = tree.iter_changes(old_tree, include_unchanged=True)
1378
 
        for f, paths, c, v, p, n, k, e in iterator:
1379
 
            if paths[0] == paths[1]:
1380
 
                continue
1381
 
            if None in (paths):
1382
 
                continue
1383
 
            renames.append(paths)
1384
 
        renames.sort()
1385
 
        for old_name, new_name in renames:
1386
 
            self.outf.write("%s => %s\n" % (old_name, new_name))
 
1276
        try:
 
1277
            new_inv = tree.inventory
 
1278
            old_tree = tree.basis_tree()
 
1279
            old_tree.lock_read()
 
1280
            try:
 
1281
                old_inv = old_tree.inventory
 
1282
                renames = []
 
1283
                iterator = tree.iter_changes(old_tree, include_unchanged=True)
 
1284
                for f, paths, c, v, p, n, k, e in iterator:
 
1285
                    if paths[0] == paths[1]:
 
1286
                        continue
 
1287
                    if None in (paths):
 
1288
                        continue
 
1289
                    renames.append(paths)
 
1290
                renames.sort()
 
1291
                for old_name, new_name in renames:
 
1292
                    self.outf.write("%s => %s\n" % (old_name, new_name))
 
1293
            finally:
 
1294
                old_tree.unlock()
 
1295
        finally:
 
1296
            tree.unlock()
1387
1297
 
1388
1298
 
1389
1299
class cmd_update(Command):
1390
 
    __doc__ = """Update a tree to have the latest code committed to its branch.
 
1300
    """Update a tree to have the latest code committed to its branch.
1391
1301
 
1392
1302
    This will perform a merge into the working tree, and may generate
1393
1303
    conflicts. If you have any local changes, you will still
1395
1305
 
1396
1306
    If you want to discard your local changes, you can just do a
1397
1307
    'bzr revert' instead of 'bzr commit' after the update.
1398
 
 
1399
 
    If the tree's branch is bound to a master branch, it will also update
1400
 
    the branch from the master.
1401
1308
    """
1402
1309
 
1403
1310
    _see_also = ['pull', 'working-trees', 'status-flags']
1404
1311
    takes_args = ['dir?']
1405
 
    takes_options = ['revision']
1406
1312
    aliases = ['up']
1407
1313
 
1408
 
    def run(self, dir='.', revision=None):
1409
 
        if revision is not None and len(revision) != 1:
1410
 
            raise errors.BzrCommandError(
1411
 
                        "bzr update --revision takes exactly one revision")
 
1314
    def run(self, dir='.'):
1412
1315
        tree = WorkingTree.open_containing(dir)[0]
1413
 
        branch = tree.branch
1414
1316
        possible_transports = []
1415
 
        master = branch.get_master_branch(
 
1317
        master = tree.branch.get_master_branch(
1416
1318
            possible_transports=possible_transports)
1417
1319
        if master is not None:
1418
1320
            tree.lock_write()
1419
 
            branch_location = master.base
1420
1321
        else:
1421
1322
            tree.lock_tree_write()
1422
 
            branch_location = tree.branch.base
1423
 
        self.add_cleanup(tree.unlock)
1424
 
        # get rid of the final '/' and be ready for display
1425
 
        branch_location = urlutils.unescape_for_display(
1426
 
            branch_location.rstrip('/'),
1427
 
            self.outf.encoding)
1428
 
        existing_pending_merges = tree.get_parent_ids()[1:]
1429
 
        if master is None:
1430
 
            old_tip = None
1431
 
        else:
1432
 
            # may need to fetch data into a heavyweight checkout
1433
 
            # XXX: this may take some time, maybe we should display a
1434
 
            # message
1435
 
            old_tip = branch.update(possible_transports)
1436
 
        if revision is not None:
1437
 
            revision_id = revision[0].as_revision_id(branch)
1438
 
        else:
1439
 
            revision_id = branch.last_revision()
1440
 
        if revision_id == _mod_revision.ensure_null(tree.last_revision()):
1441
 
            revno = branch.revision_id_to_dotted_revno(revision_id)
1442
 
            note("Tree is up to date at revision %s of branch %s" %
1443
 
                ('.'.join(map(str, revno)), branch_location))
1444
 
            return 0
1445
 
        view_info = _get_view_info_for_change_reporter(tree)
1446
 
        change_reporter = delta._ChangeReporter(
1447
 
            unversioned_filter=tree.is_ignored,
1448
 
            view_info=view_info)
1449
1323
        try:
 
1324
            existing_pending_merges = tree.get_parent_ids()[1:]
 
1325
            last_rev = _mod_revision.ensure_null(tree.last_revision())
 
1326
            if last_rev == _mod_revision.ensure_null(
 
1327
                tree.branch.last_revision()):
 
1328
                # may be up to date, check master too.
 
1329
                if master is None or last_rev == _mod_revision.ensure_null(
 
1330
                    master.last_revision()):
 
1331
                    revno = tree.branch.revision_id_to_revno(last_rev)
 
1332
                    note("Tree is up to date at revision %d." % (revno,))
 
1333
                    return 0
 
1334
            view_info = _get_view_info_for_change_reporter(tree)
1450
1335
            conflicts = tree.update(
1451
 
                change_reporter,
1452
 
                possible_transports=possible_transports,
1453
 
                revision=revision_id,
1454
 
                old_tip=old_tip)
1455
 
        except errors.NoSuchRevision, e:
1456
 
            raise errors.BzrCommandError(
1457
 
                                  "branch has no revision %s\n"
1458
 
                                  "bzr update --revision only works"
1459
 
                                  " for a revision in the branch history"
1460
 
                                  % (e.revision))
1461
 
        revno = tree.branch.revision_id_to_dotted_revno(
1462
 
            _mod_revision.ensure_null(tree.last_revision()))
1463
 
        note('Updated to revision %s of branch %s' %
1464
 
             ('.'.join(map(str, revno)), branch_location))
1465
 
        parent_ids = tree.get_parent_ids()
1466
 
        if parent_ids[1:] and parent_ids[1:] != existing_pending_merges:
1467
 
            note('Your local commits will now show as pending merges with '
1468
 
                 "'bzr status', and can be committed with 'bzr commit'.")
1469
 
        if conflicts != 0:
1470
 
            return 1
1471
 
        else:
1472
 
            return 0
 
1336
                delta._ChangeReporter(unversioned_filter=tree.is_ignored,
 
1337
                view_info=view_info), possible_transports=possible_transports)
 
1338
            revno = tree.branch.revision_id_to_revno(
 
1339
                _mod_revision.ensure_null(tree.last_revision()))
 
1340
            note('Updated to revision %d.' % (revno,))
 
1341
            if tree.get_parent_ids()[1:] != existing_pending_merges:
 
1342
                note('Your local commits will now show as pending merges with '
 
1343
                     "'bzr status', and can be committed with 'bzr commit'.")
 
1344
            if conflicts != 0:
 
1345
                return 1
 
1346
            else:
 
1347
                return 0
 
1348
        finally:
 
1349
            tree.unlock()
1473
1350
 
1474
1351
 
1475
1352
class cmd_info(Command):
1476
 
    __doc__ = """Show information about a working tree, branch or repository.
 
1353
    """Show information about a working tree, branch or repository.
1477
1354
 
1478
1355
    This command will show all known locations and formats associated to the
1479
1356
    tree, branch or repository.
1517
1394
 
1518
1395
 
1519
1396
class cmd_remove(Command):
1520
 
    __doc__ = """Remove files or directories.
 
1397
    """Remove files or directories.
1521
1398
 
1522
1399
    This makes bzr stop tracking changes to the specified files. bzr will delete
1523
1400
    them if they can easily be recovered using revert. If no options or
1532
1409
            title='Deletion Strategy', value_switches=True, enum_switch=False,
1533
1410
            safe='Only delete files if they can be'
1534
1411
                 ' safely recovered (default).',
1535
 
            keep='Delete from bzr but leave the working copy.',
 
1412
            keep="Don't delete any files.",
1536
1413
            force='Delete all the specified files, even if they can not be '
1537
1414
                'recovered and even if they are non-empty directories.')]
1538
1415
    aliases = ['rm', 'del']
1546
1423
            file_list = [f for f in file_list]
1547
1424
 
1548
1425
        tree.lock_write()
1549
 
        self.add_cleanup(tree.unlock)
1550
 
        # Heuristics should probably all move into tree.remove_smart or
1551
 
        # some such?
1552
 
        if new:
1553
 
            added = tree.changes_from(tree.basis_tree(),
1554
 
                specific_files=file_list).added
1555
 
            file_list = sorted([f[0] for f in added], reverse=True)
1556
 
            if len(file_list) == 0:
1557
 
                raise errors.BzrCommandError('No matching files.')
1558
 
        elif file_list is None:
1559
 
            # missing files show up in iter_changes(basis) as
1560
 
            # versioned-with-no-kind.
1561
 
            missing = []
1562
 
            for change in tree.iter_changes(tree.basis_tree()):
1563
 
                # Find paths in the working tree that have no kind:
1564
 
                if change[1][1] is not None and change[6][1] is None:
1565
 
                    missing.append(change[1][1])
1566
 
            file_list = sorted(missing, reverse=True)
1567
 
            file_deletion_strategy = 'keep'
1568
 
        tree.remove(file_list, verbose=verbose, to_file=self.outf,
1569
 
            keep_files=file_deletion_strategy=='keep',
1570
 
            force=file_deletion_strategy=='force')
 
1426
        try:
 
1427
            # Heuristics should probably all move into tree.remove_smart or
 
1428
            # some such?
 
1429
            if new:
 
1430
                added = tree.changes_from(tree.basis_tree(),
 
1431
                    specific_files=file_list).added
 
1432
                file_list = sorted([f[0] for f in added], reverse=True)
 
1433
                if len(file_list) == 0:
 
1434
                    raise errors.BzrCommandError('No matching files.')
 
1435
            elif file_list is None:
 
1436
                # missing files show up in iter_changes(basis) as
 
1437
                # versioned-with-no-kind.
 
1438
                missing = []
 
1439
                for change in tree.iter_changes(tree.basis_tree()):
 
1440
                    # Find paths in the working tree that have no kind:
 
1441
                    if change[1][1] is not None and change[6][1] is None:
 
1442
                        missing.append(change[1][1])
 
1443
                file_list = sorted(missing, reverse=True)
 
1444
                file_deletion_strategy = 'keep'
 
1445
            tree.remove(file_list, verbose=verbose, to_file=self.outf,
 
1446
                keep_files=file_deletion_strategy=='keep',
 
1447
                force=file_deletion_strategy=='force')
 
1448
        finally:
 
1449
            tree.unlock()
1571
1450
 
1572
1451
 
1573
1452
class cmd_file_id(Command):
1574
 
    __doc__ = """Print file_id of a particular file or directory.
 
1453
    """Print file_id of a particular file or directory.
1575
1454
 
1576
1455
    The file_id is assigned when the file is first added and remains the
1577
1456
    same through all revisions where the file exists, even when it is
1593
1472
 
1594
1473
 
1595
1474
class cmd_file_path(Command):
1596
 
    __doc__ = """Print path of file_ids to a file or directory.
 
1475
    """Print path of file_ids to a file or directory.
1597
1476
 
1598
1477
    This prints one line for each directory down to the target,
1599
1478
    starting at the branch root.
1615
1494
 
1616
1495
 
1617
1496
class cmd_reconcile(Command):
1618
 
    __doc__ = """Reconcile bzr metadata in a branch.
 
1497
    """Reconcile bzr metadata in a branch.
1619
1498
 
1620
1499
    This can correct data mismatches that may have been caused by
1621
1500
    previous ghost operations or bzr upgrades. You should only
1643
1522
 
1644
1523
 
1645
1524
class cmd_revision_history(Command):
1646
 
    __doc__ = """Display the list of revision ids on a branch."""
 
1525
    """Display the list of revision ids on a branch."""
1647
1526
 
1648
1527
    _see_also = ['log']
1649
1528
    takes_args = ['location?']
1659
1538
 
1660
1539
 
1661
1540
class cmd_ancestry(Command):
1662
 
    __doc__ = """List all revisions merged into this branch."""
 
1541
    """List all revisions merged into this branch."""
1663
1542
 
1664
1543
    _see_also = ['log', 'revision-history']
1665
1544
    takes_args = ['location?']
1684
1563
 
1685
1564
 
1686
1565
class cmd_init(Command):
1687
 
    __doc__ = """Make a directory into a versioned branch.
 
1566
    """Make a directory into a versioned branch.
1688
1567
 
1689
1568
    Use this to create an empty branch, or before importing an
1690
1569
    existing project.
1718
1597
                lazy_registry=('bzrlib.bzrdir', 'format_registry'),
1719
1598
                converter=lambda name: bzrdir.format_registry.make_bzrdir(name),
1720
1599
                value_switches=True,
1721
 
                title="Branch format",
 
1600
                title="Branch Format",
1722
1601
                ),
1723
1602
         Option('append-revisions-only',
1724
1603
                help='Never change revnos or the existing log.'
1793
1672
 
1794
1673
 
1795
1674
class cmd_init_repository(Command):
1796
 
    __doc__ = """Create a shared repository for branches to share storage space.
 
1675
    """Create a shared repository to hold branches.
1797
1676
 
1798
1677
    New branches created under the repository directory will store their
1799
 
    revisions in the repository, not in the branch directory.  For branches
1800
 
    with shared history, this reduces the amount of storage needed and 
1801
 
    speeds up the creation of new branches.
 
1678
    revisions in the repository, not in the branch directory.
1802
1679
 
1803
 
    If the --no-trees option is given then the branches in the repository
1804
 
    will not have working trees by default.  They will still exist as 
1805
 
    directories on disk, but they will not have separate copies of the 
1806
 
    files at a certain revision.  This can be useful for repositories that
1807
 
    store branches which are interacted with through checkouts or remote
1808
 
    branches, such as on a server.
 
1680
    If the --no-trees option is used then the branches in the repository
 
1681
    will not have working trees by default.
1809
1682
 
1810
1683
    :Examples:
1811
 
        Create a shared repository holding just branches::
 
1684
        Create a shared repositories holding just branches::
1812
1685
 
1813
1686
            bzr init-repo --no-trees repo
1814
1687
            bzr init repo/trunk
1853
1726
 
1854
1727
 
1855
1728
class cmd_diff(Command):
1856
 
    __doc__ = """Show differences in the working tree, between revisions or branches.
 
1729
    """Show differences in the working tree, between revisions or branches.
1857
1730
 
1858
1731
    If no arguments are given, all changes for the current tree are listed.
1859
1732
    If files are given, only the changes in those files are listed.
1880
1753
 
1881
1754
            bzr diff -r1
1882
1755
 
1883
 
        Difference between revision 3 and revision 1::
1884
 
 
1885
 
            bzr diff -r1..3
1886
 
 
1887
 
        Difference between revision 3 and revision 1 for branch xxx::
1888
 
 
1889
 
            bzr diff -r1..3 xxx
1890
 
 
1891
 
        To see the changes introduced in revision X::
1892
 
        
1893
 
            bzr diff -cX
1894
 
 
1895
 
        Note that in the case of a merge, the -c option shows the changes
1896
 
        compared to the left hand parent. To see the changes against
1897
 
        another parent, use::
1898
 
 
1899
 
            bzr diff -r<chosen_parent>..X
1900
 
 
1901
 
        The changes introduced by revision 2 (equivalent to -r1..2)::
1902
 
 
1903
 
            bzr diff -c2
 
1756
        Difference between revision 2 and revision 1::
 
1757
 
 
1758
            bzr diff -r1..2
 
1759
 
 
1760
        Difference between revision 2 and revision 1 for branch xxx::
 
1761
 
 
1762
            bzr diff -r1..2 xxx
1904
1763
 
1905
1764
        Show just the differences for file NEWS::
1906
1765
 
1945
1804
            help='Use this command to compare files.',
1946
1805
            type=unicode,
1947
1806
            ),
1948
 
        RegistryOption('format',
1949
 
            help='Diff format to use.',
1950
 
            lazy_registry=('bzrlib.diff', 'format_registry'),
1951
 
            value_switches=False, title='Diff format'),
1952
1807
        ]
1953
1808
    aliases = ['di', 'dif']
1954
1809
    encoding_type = 'exact'
1955
1810
 
1956
1811
    @display_command
1957
1812
    def run(self, revision=None, file_list=None, diff_options=None,
1958
 
            prefix=None, old=None, new=None, using=None, format=None):
1959
 
        from bzrlib.diff import (get_trees_and_branches_to_diff_locked,
1960
 
            show_diff_trees)
 
1813
            prefix=None, old=None, new=None, using=None):
 
1814
        from bzrlib.diff import _get_trees_to_diff, show_diff_trees
1961
1815
 
1962
1816
        if (prefix is None) or (prefix == '0'):
1963
1817
            # diff -p0 format
1977
1831
            raise errors.BzrCommandError('bzr diff --revision takes exactly'
1978
1832
                                         ' one or two revision specifiers')
1979
1833
 
1980
 
        if using is not None and format is not None:
1981
 
            raise errors.BzrCommandError('--using and --format are mutually '
1982
 
                'exclusive.')
1983
 
 
1984
 
        (old_tree, new_tree,
1985
 
         old_branch, new_branch,
1986
 
         specific_files, extra_trees) = get_trees_and_branches_to_diff_locked(
1987
 
            file_list, revision, old, new, self.add_cleanup, apply_view=True)
 
1834
        old_tree, new_tree, specific_files, extra_trees = \
 
1835
                _get_trees_to_diff(file_list, revision, old, new,
 
1836
                apply_view=True)
1988
1837
        return show_diff_trees(old_tree, new_tree, sys.stdout,
1989
1838
                               specific_files=specific_files,
1990
1839
                               external_diff_options=diff_options,
1991
1840
                               old_label=old_label, new_label=new_label,
1992
 
                               extra_trees=extra_trees, using=using,
1993
 
                               format_cls=format)
 
1841
                               extra_trees=extra_trees, using=using)
1994
1842
 
1995
1843
 
1996
1844
class cmd_deleted(Command):
1997
 
    __doc__ = """List files deleted in the working tree.
 
1845
    """List files deleted in the working tree.
1998
1846
    """
1999
1847
    # TODO: Show files deleted since a previous revision, or
2000
1848
    # between two revisions.
2009
1857
    def run(self, show_ids=False):
2010
1858
        tree = WorkingTree.open_containing(u'.')[0]
2011
1859
        tree.lock_read()
2012
 
        self.add_cleanup(tree.unlock)
2013
 
        old = tree.basis_tree()
2014
 
        old.lock_read()
2015
 
        self.add_cleanup(old.unlock)
2016
 
        for path, ie in old.inventory.iter_entries():
2017
 
            if not tree.has_id(ie.file_id):
2018
 
                self.outf.write(path)
2019
 
                if show_ids:
2020
 
                    self.outf.write(' ')
2021
 
                    self.outf.write(ie.file_id)
2022
 
                self.outf.write('\n')
 
1860
        try:
 
1861
            old = tree.basis_tree()
 
1862
            old.lock_read()
 
1863
            try:
 
1864
                for path, ie in old.inventory.iter_entries():
 
1865
                    if not tree.has_id(ie.file_id):
 
1866
                        self.outf.write(path)
 
1867
                        if show_ids:
 
1868
                            self.outf.write(' ')
 
1869
                            self.outf.write(ie.file_id)
 
1870
                        self.outf.write('\n')
 
1871
            finally:
 
1872
                old.unlock()
 
1873
        finally:
 
1874
            tree.unlock()
2023
1875
 
2024
1876
 
2025
1877
class cmd_modified(Command):
2026
 
    __doc__ = """List files modified in working tree.
 
1878
    """List files modified in working tree.
2027
1879
    """
2028
1880
 
2029
1881
    hidden = True
2046
1898
 
2047
1899
 
2048
1900
class cmd_added(Command):
2049
 
    __doc__ = """List files added in working tree.
 
1901
    """List files added in working tree.
2050
1902
    """
2051
1903
 
2052
1904
    hidden = True
2061
1913
    def run(self, null=False):
2062
1914
        wt = WorkingTree.open_containing(u'.')[0]
2063
1915
        wt.lock_read()
2064
 
        self.add_cleanup(wt.unlock)
2065
 
        basis = wt.basis_tree()
2066
 
        basis.lock_read()
2067
 
        self.add_cleanup(basis.unlock)
2068
 
        basis_inv = basis.inventory
2069
 
        inv = wt.inventory
2070
 
        for file_id in inv:
2071
 
            if file_id in basis_inv:
2072
 
                continue
2073
 
            if inv.is_root(file_id) and len(basis_inv) == 0:
2074
 
                continue
2075
 
            path = inv.id2path(file_id)
2076
 
            if not os.access(osutils.abspath(path), os.F_OK):
2077
 
                continue
2078
 
            if null:
2079
 
                self.outf.write(path + '\0')
2080
 
            else:
2081
 
                self.outf.write(osutils.quotefn(path) + '\n')
 
1916
        try:
 
1917
            basis = wt.basis_tree()
 
1918
            basis.lock_read()
 
1919
            try:
 
1920
                basis_inv = basis.inventory
 
1921
                inv = wt.inventory
 
1922
                for file_id in inv:
 
1923
                    if file_id in basis_inv:
 
1924
                        continue
 
1925
                    if inv.is_root(file_id) and len(basis_inv) == 0:
 
1926
                        continue
 
1927
                    path = inv.id2path(file_id)
 
1928
                    if not os.access(osutils.abspath(path), os.F_OK):
 
1929
                        continue
 
1930
                    if null:
 
1931
                        self.outf.write(path + '\0')
 
1932
                    else:
 
1933
                        self.outf.write(osutils.quotefn(path) + '\n')
 
1934
            finally:
 
1935
                basis.unlock()
 
1936
        finally:
 
1937
            wt.unlock()
2082
1938
 
2083
1939
 
2084
1940
class cmd_root(Command):
2085
 
    __doc__ = """Show the tree root directory.
 
1941
    """Show the tree root directory.
2086
1942
 
2087
1943
    The root is the nearest enclosing directory with a .bzr control
2088
1944
    directory."""
2112
1968
 
2113
1969
 
2114
1970
class cmd_log(Command):
2115
 
    __doc__ = """Show historical log for a branch or subset of a branch.
 
1971
    """Show historical log for a branch or subset of a branch.
2116
1972
 
2117
1973
    log is bzr's default tool for exploring the history of a branch.
2118
1974
    The branch to use is taken from the first parameter. If no parameters
2229
2085
    :Tips & tricks:
2230
2086
 
2231
2087
      GUI tools and IDEs are often better at exploring history than command
2232
 
      line tools: you may prefer qlog or viz from qbzr or bzr-gtk, the
2233
 
      bzr-explorer shell, or the Loggerhead web interface.  See the Plugin
2234
 
      Guide <http://doc.bazaar.canonical.com/plugins/en/> and
2235
 
      <http://wiki.bazaar.canonical.com/IDEIntegration>.  
 
2088
      line tools. You may prefer qlog or glog from the QBzr and Bzr-Gtk packages
 
2089
      respectively for example. (TortoiseBzr uses qlog for displaying logs.) See
 
2090
      http://bazaar-vcs.org/BzrPlugins and http://bazaar-vcs.org/IDEIntegration.
 
2091
 
 
2092
      Web interfaces are often better at exploring history than command line
 
2093
      tools, particularly for branches on servers. You may prefer Loggerhead
 
2094
      or one of its alternatives. See http://bazaar-vcs.org/WebInterface.
2236
2095
 
2237
2096
      You may find it useful to add the aliases below to ``bazaar.conf``::
2238
2097
 
2299
2158
                   help='Show changes made in each revision as a patch.'),
2300
2159
            Option('include-merges',
2301
2160
                   help='Show merged revisions like --levels 0 does.'),
2302
 
            Option('exclude-common-ancestry',
2303
 
                   help='Display only the revisions that are not part'
2304
 
                   ' of both ancestries (require -rX..Y)'
2305
 
                   )
2306
2161
            ]
2307
2162
    encoding_type = 'replace'
2308
2163
 
2318
2173
            message=None,
2319
2174
            limit=None,
2320
2175
            show_diff=False,
2321
 
            include_merges=False,
2322
 
            exclude_common_ancestry=False,
2323
 
            ):
 
2176
            include_merges=False):
2324
2177
        from bzrlib.log import (
2325
2178
            Logger,
2326
2179
            make_log_request_dict,
2327
2180
            _get_info_for_log_files,
2328
2181
            )
2329
2182
        direction = (forward and 'forward') or 'reverse'
2330
 
        if (exclude_common_ancestry
2331
 
            and (revision is None or len(revision) != 2)):
2332
 
            raise errors.BzrCommandError(
2333
 
                '--exclude-common-ancestry requires -r with two revisions')
2334
2183
        if include_merges:
2335
2184
            if levels is None:
2336
2185
                levels = 0
2351
2200
        filter_by_dir = False
2352
2201
        if file_list:
2353
2202
            # find the file ids to log and check for directory filtering
2354
 
            b, file_info_list, rev1, rev2 = _get_info_for_log_files(
2355
 
                revision, file_list)
2356
 
            self.add_cleanup(b.unlock)
 
2203
            b, file_info_list, rev1, rev2 = _get_info_for_log_files(revision,
 
2204
                file_list)
2357
2205
            for relpath, file_id, kind in file_info_list:
2358
2206
                if file_id is None:
2359
2207
                    raise errors.BzrCommandError(
2377
2225
                location = '.'
2378
2226
            dir, relpath = bzrdir.BzrDir.open_containing(location)
2379
2227
            b = dir.open_branch()
2380
 
            b.lock_read()
2381
 
            self.add_cleanup(b.unlock)
2382
2228
            rev1, rev2 = _get_revision_range(revision, b, self.name())
2383
2229
 
2384
2230
        # Decide on the type of delta & diff filtering to use
2394
2240
        else:
2395
2241
            diff_type = 'full'
2396
2242
 
2397
 
        # Build the log formatter
2398
 
        if log_format is None:
2399
 
            log_format = log.log_formatter_registry.get_default(b)
2400
 
        # Make a non-encoding output to include the diffs - bug 328007
2401
 
        unencoded_output = ui.ui_factory.make_output_stream(encoding_type='exact')
2402
 
        lf = log_format(show_ids=show_ids, to_file=self.outf,
2403
 
                        to_exact_file=unencoded_output,
2404
 
                        show_timezone=timezone,
2405
 
                        delta_format=get_verbosity_level(),
2406
 
                        levels=levels,
2407
 
                        show_advice=levels is None)
2408
 
 
2409
 
        # Choose the algorithm for doing the logging. It's annoying
2410
 
        # having multiple code paths like this but necessary until
2411
 
        # the underlying repository format is faster at generating
2412
 
        # deltas or can provide everything we need from the indices.
2413
 
        # The default algorithm - match-using-deltas - works for
2414
 
        # multiple files and directories and is faster for small
2415
 
        # amounts of history (200 revisions say). However, it's too
2416
 
        # slow for logging a single file in a repository with deep
2417
 
        # history, i.e. > 10K revisions. In the spirit of "do no
2418
 
        # evil when adding features", we continue to use the
2419
 
        # original algorithm - per-file-graph - for the "single
2420
 
        # file that isn't a directory without showing a delta" case.
2421
 
        partial_history = revision and b.repository._format.supports_chks
2422
 
        match_using_deltas = (len(file_ids) != 1 or filter_by_dir
2423
 
            or delta_type or partial_history)
2424
 
 
2425
 
        # Build the LogRequest and execute it
2426
 
        if len(file_ids) == 0:
2427
 
            file_ids = None
2428
 
        rqst = make_log_request_dict(
2429
 
            direction=direction, specific_fileids=file_ids,
2430
 
            start_revision=rev1, end_revision=rev2, limit=limit,
2431
 
            message_search=message, delta_type=delta_type,
2432
 
            diff_type=diff_type, _match_using_deltas=match_using_deltas,
2433
 
            exclude_common_ancestry=exclude_common_ancestry,
2434
 
            )
2435
 
        Logger(b, rqst).show(lf)
 
2243
        b.lock_read()
 
2244
        try:
 
2245
            # Build the log formatter
 
2246
            if log_format is None:
 
2247
                log_format = log.log_formatter_registry.get_default(b)
 
2248
            lf = log_format(show_ids=show_ids, to_file=self.outf,
 
2249
                            show_timezone=timezone,
 
2250
                            delta_format=get_verbosity_level(),
 
2251
                            levels=levels,
 
2252
                            show_advice=levels is None)
 
2253
 
 
2254
            # Choose the algorithm for doing the logging. It's annoying
 
2255
            # having multiple code paths like this but necessary until
 
2256
            # the underlying repository format is faster at generating
 
2257
            # deltas or can provide everything we need from the indices.
 
2258
            # The default algorithm - match-using-deltas - works for
 
2259
            # multiple files and directories and is faster for small
 
2260
            # amounts of history (200 revisions say). However, it's too
 
2261
            # slow for logging a single file in a repository with deep
 
2262
            # history, i.e. > 10K revisions. In the spirit of "do no
 
2263
            # evil when adding features", we continue to use the
 
2264
            # original algorithm - per-file-graph - for the "single
 
2265
            # file that isn't a directory without showing a delta" case.
 
2266
            partial_history = revision and b.repository._format.supports_chks
 
2267
            match_using_deltas = (len(file_ids) != 1 or filter_by_dir
 
2268
                or delta_type or partial_history)
 
2269
 
 
2270
            # Build the LogRequest and execute it
 
2271
            if len(file_ids) == 0:
 
2272
                file_ids = None
 
2273
            rqst = make_log_request_dict(
 
2274
                direction=direction, specific_fileids=file_ids,
 
2275
                start_revision=rev1, end_revision=rev2, limit=limit,
 
2276
                message_search=message, delta_type=delta_type,
 
2277
                diff_type=diff_type, _match_using_deltas=match_using_deltas)
 
2278
            Logger(b, rqst).show(lf)
 
2279
        finally:
 
2280
            b.unlock()
2436
2281
 
2437
2282
 
2438
2283
def _get_revision_range(revisionspec_list, branch, command_name):
2456
2301
            raise errors.BzrCommandError(
2457
2302
                "bzr %s doesn't accept two revisions in different"
2458
2303
                " branches." % command_name)
2459
 
        if start_spec.spec is None:
2460
 
            # Avoid loading all the history.
2461
 
            rev1 = RevisionInfo(branch, None, None)
2462
 
        else:
2463
 
            rev1 = start_spec.in_history(branch)
 
2304
        rev1 = start_spec.in_history(branch)
2464
2305
        # Avoid loading all of history when we know a missing
2465
2306
        # end of range means the last revision ...
2466
2307
        if end_spec.spec is None:
2495
2336
 
2496
2337
 
2497
2338
class cmd_touching_revisions(Command):
2498
 
    __doc__ = """Return revision-ids which affected a particular file.
 
2339
    """Return revision-ids which affected a particular file.
2499
2340
 
2500
2341
    A more user-friendly interface is "bzr log FILE".
2501
2342
    """
2506
2347
    @display_command
2507
2348
    def run(self, filename):
2508
2349
        tree, relpath = WorkingTree.open_containing(filename)
 
2350
        b = tree.branch
2509
2351
        file_id = tree.path2id(relpath)
2510
 
        b = tree.branch
2511
 
        b.lock_read()
2512
 
        self.add_cleanup(b.unlock)
2513
 
        touching_revs = log.find_touching_revisions(b, file_id)
2514
 
        for revno, revision_id, what in touching_revs:
 
2352
        for revno, revision_id, what in log.find_touching_revisions(b, file_id):
2515
2353
            self.outf.write("%6d %s\n" % (revno, what))
2516
2354
 
2517
2355
 
2518
2356
class cmd_ls(Command):
2519
 
    __doc__ = """List files in a tree.
 
2357
    """List files in a tree.
2520
2358
    """
2521
2359
 
2522
2360
    _see_also = ['status', 'cat']
2570
2408
        if from_root:
2571
2409
            if relpath:
2572
2410
                prefix = relpath + '/'
2573
 
        elif fs_path != '.' and not fs_path.endswith('/'):
 
2411
        elif fs_path != '.':
2574
2412
            prefix = fs_path + '/'
2575
2413
 
2576
2414
        if revision is not None or tree is None:
2585
2423
                note("Ignoring files outside view. View is %s" % view_str)
2586
2424
 
2587
2425
        tree.lock_read()
2588
 
        self.add_cleanup(tree.unlock)
2589
 
        for fp, fc, fkind, fid, entry in tree.list_files(include_root=False,
2590
 
            from_dir=relpath, recursive=recursive):
2591
 
            # Apply additional masking
2592
 
            if not all and not selection[fc]:
2593
 
                continue
2594
 
            if kind is not None and fkind != kind:
2595
 
                continue
2596
 
            if apply_view:
2597
 
                try:
2598
 
                    if relpath:
2599
 
                        fullpath = osutils.pathjoin(relpath, fp)
2600
 
                    else:
2601
 
                        fullpath = fp
2602
 
                    views.check_path_in_view(tree, fullpath)
2603
 
                except errors.FileOutsideView:
2604
 
                    continue
 
2426
        try:
 
2427
            for fp, fc, fkind, fid, entry in tree.list_files(include_root=False,
 
2428
                from_dir=relpath, recursive=recursive):
 
2429
                # Apply additional masking
 
2430
                if not all and not selection[fc]:
 
2431
                    continue
 
2432
                if kind is not None and fkind != kind:
 
2433
                    continue
 
2434
                if apply_view:
 
2435
                    try:
 
2436
                        if relpath:
 
2437
                            fullpath = osutils.pathjoin(relpath, fp)
 
2438
                        else:
 
2439
                            fullpath = fp
 
2440
                        views.check_path_in_view(tree, fullpath)
 
2441
                    except errors.FileOutsideView:
 
2442
                        continue
2605
2443
 
2606
 
            # Output the entry
2607
 
            if prefix:
2608
 
                fp = osutils.pathjoin(prefix, fp)
2609
 
            kindch = entry.kind_character()
2610
 
            outstring = fp + kindch
2611
 
            ui.ui_factory.clear_term()
2612
 
            if verbose:
2613
 
                outstring = '%-8s %s' % (fc, outstring)
2614
 
                if show_ids and fid is not None:
2615
 
                    outstring = "%-50s %s" % (outstring, fid)
2616
 
                self.outf.write(outstring + '\n')
2617
 
            elif null:
2618
 
                self.outf.write(fp + '\0')
2619
 
                if show_ids:
2620
 
                    if fid is not None:
2621
 
                        self.outf.write(fid)
2622
 
                    self.outf.write('\0')
2623
 
                self.outf.flush()
2624
 
            else:
2625
 
                if show_ids:
2626
 
                    if fid is not None:
2627
 
                        my_id = fid
2628
 
                    else:
2629
 
                        my_id = ''
2630
 
                    self.outf.write('%-50s %s\n' % (outstring, my_id))
2631
 
                else:
 
2444
                # Output the entry
 
2445
                if prefix:
 
2446
                    fp = osutils.pathjoin(prefix, fp)
 
2447
                kindch = entry.kind_character()
 
2448
                outstring = fp + kindch
 
2449
                ui.ui_factory.clear_term()
 
2450
                if verbose:
 
2451
                    outstring = '%-8s %s' % (fc, outstring)
 
2452
                    if show_ids and fid is not None:
 
2453
                        outstring = "%-50s %s" % (outstring, fid)
2632
2454
                    self.outf.write(outstring + '\n')
 
2455
                elif null:
 
2456
                    self.outf.write(fp + '\0')
 
2457
                    if show_ids:
 
2458
                        if fid is not None:
 
2459
                            self.outf.write(fid)
 
2460
                        self.outf.write('\0')
 
2461
                    self.outf.flush()
 
2462
                else:
 
2463
                    if show_ids:
 
2464
                        if fid is not None:
 
2465
                            my_id = fid
 
2466
                        else:
 
2467
                            my_id = ''
 
2468
                        self.outf.write('%-50s %s\n' % (outstring, my_id))
 
2469
                    else:
 
2470
                        self.outf.write(outstring + '\n')
 
2471
        finally:
 
2472
            tree.unlock()
2633
2473
 
2634
2474
 
2635
2475
class cmd_unknowns(Command):
2636
 
    __doc__ = """List unknown files.
 
2476
    """List unknown files.
2637
2477
    """
2638
2478
 
2639
2479
    hidden = True
2646
2486
 
2647
2487
 
2648
2488
class cmd_ignore(Command):
2649
 
    __doc__ = """Ignore specified files or patterns.
 
2489
    """Ignore specified files or patterns.
2650
2490
 
2651
2491
    See ``bzr help patterns`` for details on the syntax of patterns.
2652
2492
 
2653
 
    If a .bzrignore file does not exist, the ignore command
2654
 
    will create one and add the specified files or patterns to the newly
2655
 
    created file. The ignore command will also automatically add the 
2656
 
    .bzrignore file to be versioned. Creating a .bzrignore file without
2657
 
    the use of the ignore command will require an explicit add command.
2658
 
 
2659
2493
    To remove patterns from the ignore list, edit the .bzrignore file.
2660
2494
    After adding, editing or deleting that file either indirectly by
2661
2495
    using this command or directly by using an editor, be sure to commit
2662
2496
    it.
2663
 
    
2664
 
    Bazaar also supports a global ignore file ~/.bazaar/ignore. On Windows
2665
 
    the global ignore file can be found in the application data directory as
2666
 
    C:\\Documents and Settings\\<user>\\Application Data\\Bazaar\\2.0\\ignore.
2667
 
    Global ignores are not touched by this command. The global ignore file
2668
 
    can be edited directly using an editor.
2669
 
 
2670
 
    Patterns prefixed with '!' are exceptions to ignore patterns and take
2671
 
    precedence over regular ignores.  Such exceptions are used to specify
2672
 
    files that should be versioned which would otherwise be ignored.
2673
 
    
2674
 
    Patterns prefixed with '!!' act as regular ignore patterns, but have
2675
 
    precedence over the '!' exception patterns.
2676
2497
 
2677
2498
    Note: ignore patterns containing shell wildcards must be quoted from
2678
2499
    the shell on Unix.
2682
2503
 
2683
2504
            bzr ignore ./Makefile
2684
2505
 
2685
 
        Ignore .class files in all directories...::
 
2506
        Ignore class files in all directories::
2686
2507
 
2687
2508
            bzr ignore "*.class"
2688
2509
 
2689
 
        ...but do not ignore "special.class"::
2690
 
 
2691
 
            bzr ignore "!special.class"
2692
 
 
2693
2510
        Ignore .o files under the lib directory::
2694
2511
 
2695
2512
            bzr ignore "lib/**/*.o"
2701
2518
        Ignore everything but the "debian" toplevel directory::
2702
2519
 
2703
2520
            bzr ignore "RE:(?!debian/).*"
2704
 
        
2705
 
        Ignore everything except the "local" toplevel directory,
2706
 
        but always ignore "*~" autosave files, even under local/::
2707
 
        
2708
 
            bzr ignore "*"
2709
 
            bzr ignore "!./local"
2710
 
            bzr ignore "!!*~"
2711
2521
    """
2712
2522
 
2713
2523
    _see_also = ['status', 'ignored', 'patterns']
2714
2524
    takes_args = ['name_pattern*']
2715
2525
    takes_options = [
2716
 
        Option('default-rules',
2717
 
               help='Display the default ignore rules that bzr uses.')
 
2526
        Option('old-default-rules',
 
2527
               help='Write out the ignore rules bzr < 0.9 always used.')
2718
2528
        ]
2719
2529
 
2720
 
    def run(self, name_pattern_list=None, default_rules=None):
 
2530
    def run(self, name_pattern_list=None, old_default_rules=None):
2721
2531
        from bzrlib import ignores
2722
 
        if default_rules is not None:
2723
 
            # dump the default rules and exit
2724
 
            for pattern in ignores.USER_DEFAULTS:
2725
 
                self.outf.write("%s\n" % pattern)
 
2532
        if old_default_rules is not None:
 
2533
            # dump the rules and exit
 
2534
            for pattern in ignores.OLD_DEFAULTS:
 
2535
                print pattern
2726
2536
            return
2727
2537
        if not name_pattern_list:
2728
2538
            raise errors.BzrCommandError("ignore requires at least one "
2729
 
                "NAME_PATTERN or --default-rules.")
 
2539
                                  "NAME_PATTERN or --old-default-rules")
2730
2540
        name_pattern_list = [globbing.normalize_pattern(p)
2731
2541
                             for p in name_pattern_list]
2732
2542
        for name_pattern in name_pattern_list:
2744
2554
            if id is not None:
2745
2555
                filename = entry[0]
2746
2556
                if ignored.match(filename):
2747
 
                    matches.append(filename)
 
2557
                    matches.append(filename.encode('utf-8'))
2748
2558
        tree.unlock()
2749
2559
        if len(matches) > 0:
2750
 
            self.outf.write("Warning: the following files are version controlled and"
2751
 
                  " match your ignore pattern:\n%s"
2752
 
                  "\nThese files will continue to be version controlled"
2753
 
                  " unless you 'bzr remove' them.\n" % ("\n".join(matches),))
 
2560
            print "Warning: the following files are version controlled and" \
 
2561
                  " match your ignore pattern:\n%s" \
 
2562
                  "\nThese files will continue to be version controlled" \
 
2563
                  " unless you 'bzr remove' them." % ("\n".join(matches),)
2754
2564
 
2755
2565
 
2756
2566
class cmd_ignored(Command):
2757
 
    __doc__ = """List ignored files and the patterns that matched them.
 
2567
    """List ignored files and the patterns that matched them.
2758
2568
 
2759
2569
    List all the ignored files and the ignore pattern that caused the file to
2760
2570
    be ignored.
2771
2581
    def run(self):
2772
2582
        tree = WorkingTree.open_containing(u'.')[0]
2773
2583
        tree.lock_read()
2774
 
        self.add_cleanup(tree.unlock)
2775
 
        for path, file_class, kind, file_id, entry in tree.list_files():
2776
 
            if file_class != 'I':
2777
 
                continue
2778
 
            ## XXX: Slightly inefficient since this was already calculated
2779
 
            pat = tree.is_ignored(path)
2780
 
            self.outf.write('%-50s %s\n' % (path, pat))
 
2584
        try:
 
2585
            for path, file_class, kind, file_id, entry in tree.list_files():
 
2586
                if file_class != 'I':
 
2587
                    continue
 
2588
                ## XXX: Slightly inefficient since this was already calculated
 
2589
                pat = tree.is_ignored(path)
 
2590
                self.outf.write('%-50s %s\n' % (path, pat))
 
2591
        finally:
 
2592
            tree.unlock()
2781
2593
 
2782
2594
 
2783
2595
class cmd_lookup_revision(Command):
2784
 
    __doc__ = """Lookup the revision-id from a revision-number
 
2596
    """Lookup the revision-id from a revision-number
2785
2597
 
2786
2598
    :Examples:
2787
2599
        bzr lookup-revision 33
2794
2606
        try:
2795
2607
            revno = int(revno)
2796
2608
        except ValueError:
2797
 
            raise errors.BzrCommandError("not a valid revision-number: %r"
2798
 
                                         % revno)
2799
 
        revid = WorkingTree.open_containing(u'.')[0].branch.get_rev_id(revno)
2800
 
        self.outf.write("%s\n" % revid)
 
2609
            raise errors.BzrCommandError("not a valid revision-number: %r" % revno)
 
2610
 
 
2611
        print WorkingTree.open_containing(u'.')[0].branch.get_rev_id(revno)
2801
2612
 
2802
2613
 
2803
2614
class cmd_export(Command):
2804
 
    __doc__ = """Export current or past revision to a destination directory or archive.
 
2615
    """Export current or past revision to a destination directory or archive.
2805
2616
 
2806
2617
    If no revision is specified this exports the last committed revision.
2807
2618
 
2839
2650
        Option('root',
2840
2651
               type=str,
2841
2652
               help="Name of the root directory inside the exported file."),
2842
 
        Option('per-file-timestamps',
2843
 
               help='Set modification time of files to that of the last '
2844
 
                    'revision in which it was changed.'),
2845
2653
        ]
2846
2654
    def run(self, dest, branch_or_subdir=None, revision=None, format=None,
2847
 
        root=None, filters=False, per_file_timestamps=False):
 
2655
        root=None, filters=False):
2848
2656
        from bzrlib.export import export
2849
2657
 
2850
2658
        if branch_or_subdir is None:
2857
2665
 
2858
2666
        rev_tree = _get_one_revision_tree('export', revision, branch=b, tree=tree)
2859
2667
        try:
2860
 
            export(rev_tree, dest, format, root, subdir, filtered=filters,
2861
 
                   per_file_timestamps=per_file_timestamps)
 
2668
            export(rev_tree, dest, format, root, subdir, filtered=filters)
2862
2669
        except errors.NoSuchExportFormat, e:
2863
2670
            raise errors.BzrCommandError('Unsupported export format: %s' % e.format)
2864
2671
 
2865
2672
 
2866
2673
class cmd_cat(Command):
2867
 
    __doc__ = """Write the contents of a file as of a given revision to standard output.
 
2674
    """Write the contents of a file as of a given revision to standard output.
2868
2675
 
2869
2676
    If no revision is nominated, the last revision is used.
2870
2677
 
2891
2698
        tree, branch, relpath = \
2892
2699
            bzrdir.BzrDir.open_containing_tree_or_branch(filename)
2893
2700
        branch.lock_read()
2894
 
        self.add_cleanup(branch.unlock)
2895
 
        return self._run(tree, branch, relpath, filename, revision,
2896
 
                         name_from_revision, filters)
 
2701
        try:
 
2702
            return self._run(tree, branch, relpath, filename, revision,
 
2703
                             name_from_revision, filters)
 
2704
        finally:
 
2705
            branch.unlock()
2897
2706
 
2898
2707
    def _run(self, tree, b, relpath, filename, revision, name_from_revision,
2899
2708
        filtered):
2900
2709
        if tree is None:
2901
2710
            tree = b.basis_tree()
2902
2711
        rev_tree = _get_one_revision_tree('cat', revision, branch=b)
2903
 
        rev_tree.lock_read()
2904
 
        self.add_cleanup(rev_tree.unlock)
2905
2712
 
2906
2713
        old_file_id = rev_tree.path2id(relpath)
2907
2714
 
2942
2749
            chunks = content.splitlines(True)
2943
2750
            content = filtered_output_bytes(chunks, filters,
2944
2751
                ContentFilterContext(relpath, rev_tree))
2945
 
            self.cleanup_now()
2946
2752
            self.outf.writelines(content)
2947
2753
        else:
2948
 
            self.cleanup_now()
2949
2754
            self.outf.write(content)
2950
2755
 
2951
2756
 
2952
2757
class cmd_local_time_offset(Command):
2953
 
    __doc__ = """Show the offset in seconds from GMT to local time."""
 
2758
    """Show the offset in seconds from GMT to local time."""
2954
2759
    hidden = True
2955
2760
    @display_command
2956
2761
    def run(self):
2957
 
        self.outf.write("%s\n" % osutils.local_time_offset())
 
2762
        print osutils.local_time_offset()
2958
2763
 
2959
2764
 
2960
2765
 
2961
2766
class cmd_commit(Command):
2962
 
    __doc__ = """Commit changes into a new revision.
 
2767
    """Commit changes into a new revision.
2963
2768
 
2964
2769
    An explanatory message needs to be given for each commit. This is
2965
2770
    often done by using the --message option (getting the message from the
3058
2863
             Option('strict',
3059
2864
                    help="Refuse to commit if there are unknown "
3060
2865
                    "files in the working tree."),
3061
 
             Option('commit-time', type=str,
3062
 
                    help="Manually set a commit time using commit date "
3063
 
                    "format, e.g. '2009-10-10 08:00:00 +0100'."),
3064
2866
             ListOption('fixes', type=str,
3065
2867
                    help="Mark a bug as being fixed by this revision "
3066
2868
                         "(see \"bzr help bugs\")."),
3073
2875
                         "the master branch until a normal commit "
3074
2876
                         "is performed."
3075
2877
                    ),
3076
 
             Option('show-diff', short_name='p',
3077
 
                    help='When no message is supplied, show the diff along'
3078
 
                    ' with the status summary in the message editor.'),
 
2878
              Option('show-diff',
 
2879
                     help='When no message is supplied, show the diff along'
 
2880
                     ' with the status summary in the message editor.'),
3079
2881
             ]
3080
2882
    aliases = ['ci', 'checkin']
3081
2883
 
3100
2902
 
3101
2903
    def run(self, message=None, file=None, verbose=False, selected_list=None,
3102
2904
            unchanged=False, strict=False, local=False, fixes=None,
3103
 
            author=None, show_diff=False, exclude=None, commit_time=None):
 
2905
            author=None, show_diff=False, exclude=None):
3104
2906
        from bzrlib.errors import (
3105
2907
            PointlessCommit,
3106
2908
            ConflictsInTree,
3112
2914
            make_commit_message_template_encoded
3113
2915
        )
3114
2916
 
3115
 
        commit_stamp = offset = None
3116
 
        if commit_time is not None:
3117
 
            try:
3118
 
                commit_stamp, offset = timestamp.parse_patch_date(commit_time)
3119
 
            except ValueError, e:
3120
 
                raise errors.BzrCommandError(
3121
 
                    "Could not parse --commit-time: " + str(e))
3122
 
 
3123
2917
        # TODO: Need a blackbox test for invoking the external editor; may be
3124
2918
        # slightly problematic to run this cross-platform.
3125
2919
 
3145
2939
        if local and not tree.branch.get_bound_location():
3146
2940
            raise errors.LocalRequiresBoundBranch()
3147
2941
 
3148
 
        if message is not None:
3149
 
            try:
3150
 
                file_exists = osutils.lexists(message)
3151
 
            except UnicodeError:
3152
 
                # The commit message contains unicode characters that can't be
3153
 
                # represented in the filesystem encoding, so that can't be a
3154
 
                # file.
3155
 
                file_exists = False
3156
 
            if file_exists:
3157
 
                warning_msg = (
3158
 
                    'The commit message is a file name: "%(f)s".\n'
3159
 
                    '(use --file "%(f)s" to take commit message from that file)'
3160
 
                    % { 'f': message })
3161
 
                ui.ui_factory.show_warning(warning_msg)
3162
 
            if '\r' in message:
3163
 
                message = message.replace('\r\n', '\n')
3164
 
                message = message.replace('\r', '\n')
3165
 
            if file:
3166
 
                raise errors.BzrCommandError(
3167
 
                    "please specify either --message or --file")
3168
 
 
3169
2942
        def get_message(commit_obj):
3170
2943
            """Callback to get commit message"""
3171
 
            if file:
3172
 
                my_message = codecs.open(
3173
 
                    file, 'rt', osutils.get_user_encoding()).read()
3174
 
            elif message is not None:
3175
 
                my_message = message
3176
 
            else:
3177
 
                # No message supplied: make one up.
3178
 
                # text is the status of the tree
3179
 
                text = make_commit_message_template_encoded(tree,
 
2944
            my_message = message
 
2945
            if my_message is None and not file:
 
2946
                t = make_commit_message_template_encoded(tree,
3180
2947
                        selected_list, diff=show_diff,
3181
2948
                        output_encoding=osutils.get_user_encoding())
3182
 
                # start_message is the template generated from hooks
3183
 
                # XXX: Warning - looks like hooks return unicode,
3184
 
                # make_commit_message_template_encoded returns user encoding.
3185
 
                # We probably want to be using edit_commit_message instead to
3186
 
                # avoid this.
3187
2949
                start_message = generate_commit_message_template(commit_obj)
3188
 
                my_message = edit_commit_message_encoded(text,
 
2950
                my_message = edit_commit_message_encoded(t,
3189
2951
                    start_message=start_message)
3190
2952
                if my_message is None:
3191
2953
                    raise errors.BzrCommandError("please specify a commit"
3192
2954
                        " message with either --message or --file")
 
2955
            elif my_message and file:
 
2956
                raise errors.BzrCommandError(
 
2957
                    "please specify either --message or --file")
 
2958
            if file:
 
2959
                my_message = codecs.open(file, 'rt',
 
2960
                                         osutils.get_user_encoding()).read()
3193
2961
            if my_message == "":
3194
2962
                raise errors.BzrCommandError("empty commit message specified")
3195
2963
            return my_message
3196
2964
 
3197
 
        # The API permits a commit with a filter of [] to mean 'select nothing'
3198
 
        # but the command line should not do that.
3199
 
        if not selected_list:
3200
 
            selected_list = None
3201
2965
        try:
3202
2966
            tree.commit(message_callback=get_message,
3203
2967
                        specific_files=selected_list,
3204
2968
                        allow_pointless=unchanged, strict=strict, local=local,
3205
2969
                        reporter=None, verbose=verbose, revprops=properties,
3206
 
                        authors=author, timestamp=commit_stamp,
3207
 
                        timezone=offset,
 
2970
                        authors=author,
3208
2971
                        exclude=safe_relpath_files(tree, exclude))
3209
2972
        except PointlessCommit:
 
2973
            # FIXME: This should really happen before the file is read in;
 
2974
            # perhaps prepare the commit; get the message; then actually commit
3210
2975
            raise errors.BzrCommandError("No changes to commit."
3211
2976
                              " Use --unchanged to commit anyhow.")
3212
2977
        except ConflictsInTree:
3217
2982
            raise errors.BzrCommandError("Commit refused because there are"
3218
2983
                              " unknown files in the working tree.")
3219
2984
        except errors.BoundBranchOutOfDate, e:
3220
 
            e.extra_help = ("\n"
3221
 
                'To commit to master branch, run update and then commit.\n'
3222
 
                'You can also pass --local to commit to continue working '
3223
 
                'disconnected.')
3224
 
            raise
 
2985
            raise errors.BzrCommandError(str(e) + "\n"
 
2986
            'To commit to master branch, run update and then commit.\n'
 
2987
            'You can also pass --local to commit to continue working '
 
2988
            'disconnected.')
3225
2989
 
3226
2990
 
3227
2991
class cmd_check(Command):
3228
 
    __doc__ = """Validate working tree structure, branch consistency and repository history.
 
2992
    """Validate working tree structure, branch consistency and repository history.
3229
2993
 
3230
2994
    This command checks various invariants about branch and repository storage
3231
2995
    to detect data corruption or bzr bugs.
3295
3059
 
3296
3060
 
3297
3061
class cmd_upgrade(Command):
3298
 
    __doc__ = """Upgrade branch storage to current format.
 
3062
    """Upgrade branch storage to current format.
3299
3063
 
3300
3064
    The check command or bzr developers may sometimes advise you to run
3301
3065
    this command. When the default format has changed you may also be warned
3319
3083
 
3320
3084
 
3321
3085
class cmd_whoami(Command):
3322
 
    __doc__ = """Show or set bzr user id.
 
3086
    """Show or set bzr user id.
3323
3087
 
3324
3088
    :Examples:
3325
3089
        Show the email of the current user::
3369
3133
 
3370
3134
 
3371
3135
class cmd_nick(Command):
3372
 
    __doc__ = """Print or set the branch nickname.
 
3136
    """Print or set the branch nickname.
3373
3137
 
3374
3138
    If unset, the tree root directory name is used as the nickname.
3375
3139
    To print the current nickname, execute with no argument.
3389
3153
 
3390
3154
    @display_command
3391
3155
    def printme(self, branch):
3392
 
        self.outf.write('%s\n' % branch.nick)
 
3156
        print branch.nick
3393
3157
 
3394
3158
 
3395
3159
class cmd_alias(Command):
3396
 
    __doc__ = """Set/unset and display aliases.
 
3160
    """Set/unset and display aliases.
3397
3161
 
3398
3162
    :Examples:
3399
3163
        Show the current aliases::
3463
3227
 
3464
3228
 
3465
3229
class cmd_selftest(Command):
3466
 
    __doc__ = """Run internal test suite.
 
3230
    """Run internal test suite.
3467
3231
 
3468
3232
    If arguments are given, they are regular expressions that say which tests
3469
3233
    should run.  Tests matching any expression are run, and other tests are
3496
3260
    Tests that need working space on disk use a common temporary directory,
3497
3261
    typically inside $TMPDIR or /tmp.
3498
3262
 
3499
 
    If you set BZR_TEST_PDB=1 when running selftest, failing tests will drop
3500
 
    into a pdb postmortem session.
3501
 
 
3502
3263
    :Examples:
3503
3264
        Run only tests relating to 'ignore'::
3504
3265
 
3513
3274
    def get_transport_type(typestring):
3514
3275
        """Parse and return a transport specifier."""
3515
3276
        if typestring == "sftp":
3516
 
            from bzrlib.tests import stub_sftp
3517
 
            return stub_sftp.SFTPAbsoluteServer
 
3277
            from bzrlib.transport.sftp import SFTPAbsoluteServer
 
3278
            return SFTPAbsoluteServer
3518
3279
        if typestring == "memory":
3519
 
            from bzrlib.tests import test_server
3520
 
            return memory.MemoryServer
 
3280
            from bzrlib.transport.memory import MemoryServer
 
3281
            return MemoryServer
3521
3282
        if typestring == "fakenfs":
3522
 
            from bzrlib.tests import test_server
3523
 
            return test_server.FakeNFSServer
 
3283
            from bzrlib.transport.fakenfs import FakeNFSServer
 
3284
            return FakeNFSServer
3524
3285
        msg = "No known transport type %s. Supported types are: sftp\n" %\
3525
3286
            (typestring)
3526
3287
        raise errors.BzrCommandError(msg)
3541
3302
                     Option('lsprof-timed',
3542
3303
                            help='Generate lsprof output for benchmarked'
3543
3304
                                 ' sections of code.'),
3544
 
                     Option('lsprof-tests',
3545
 
                            help='Generate lsprof output for each test.'),
3546
3305
                     Option('cache-dir', type=str,
3547
3306
                            help='Cache intermediate benchmark output in this '
3548
3307
                                 'directory.'),
3589
3348
            first=False, list_only=False,
3590
3349
            randomize=None, exclude=None, strict=False,
3591
3350
            load_list=None, debugflag=None, starting_with=None, subunit=False,
3592
 
            parallel=None, lsprof_tests=False):
 
3351
            parallel=None):
3593
3352
        from bzrlib.tests import selftest
3594
3353
        import bzrlib.benchmarks as benchmarks
3595
3354
        from bzrlib.benchmarks import tree_creator
3610
3369
                raise errors.BzrCommandError("subunit not available. subunit "
3611
3370
                    "needs to be installed to use --subunit.")
3612
3371
            self.additional_selftest_args['runner_class'] = SubUnitBzrRunner
3613
 
            # On Windows, disable automatic conversion of '\n' to '\r\n' in
3614
 
            # stdout, which would corrupt the subunit stream. 
3615
 
            if sys.platform == "win32" and sys.stdout.fileno() >= 0:
3616
 
                import msvcrt
3617
 
                msvcrt.setmode(sys.stdout.fileno(), os.O_BINARY)
3618
3372
        if parallel:
3619
3373
            self.additional_selftest_args.setdefault(
3620
3374
                'suite_decorators', []).append(parallel)
3624
3378
            verbose = not is_quiet()
3625
3379
            # TODO: should possibly lock the history file...
3626
3380
            benchfile = open(".perf_history", "at", buffering=1)
3627
 
            self.add_cleanup(benchfile.close)
3628
3381
        else:
3629
3382
            test_suite_factory = None
3630
3383
            benchfile = None
3631
 
        selftest_kwargs = {"verbose": verbose,
3632
 
                          "pattern": pattern,
3633
 
                          "stop_on_failure": one,
3634
 
                          "transport": transport,
3635
 
                          "test_suite_factory": test_suite_factory,
3636
 
                          "lsprof_timed": lsprof_timed,
3637
 
                          "lsprof_tests": lsprof_tests,
3638
 
                          "bench_history": benchfile,
3639
 
                          "matching_tests_first": first,
3640
 
                          "list_only": list_only,
3641
 
                          "random_seed": randomize,
3642
 
                          "exclude_pattern": exclude,
3643
 
                          "strict": strict,
3644
 
                          "load_list": load_list,
3645
 
                          "debug_flags": debugflag,
3646
 
                          "starting_with": starting_with
3647
 
                          }
3648
 
        selftest_kwargs.update(self.additional_selftest_args)
3649
 
        result = selftest(**selftest_kwargs)
 
3384
        try:
 
3385
            selftest_kwargs = {"verbose": verbose,
 
3386
                              "pattern": pattern,
 
3387
                              "stop_on_failure": one,
 
3388
                              "transport": transport,
 
3389
                              "test_suite_factory": test_suite_factory,
 
3390
                              "lsprof_timed": lsprof_timed,
 
3391
                              "bench_history": benchfile,
 
3392
                              "matching_tests_first": first,
 
3393
                              "list_only": list_only,
 
3394
                              "random_seed": randomize,
 
3395
                              "exclude_pattern": exclude,
 
3396
                              "strict": strict,
 
3397
                              "load_list": load_list,
 
3398
                              "debug_flags": debugflag,
 
3399
                              "starting_with": starting_with
 
3400
                              }
 
3401
            selftest_kwargs.update(self.additional_selftest_args)
 
3402
            result = selftest(**selftest_kwargs)
 
3403
        finally:
 
3404
            if benchfile is not None:
 
3405
                benchfile.close()
3650
3406
        return int(not result)
3651
3407
 
3652
3408
 
3653
3409
class cmd_version(Command):
3654
 
    __doc__ = """Show version of bzr."""
 
3410
    """Show version of bzr."""
3655
3411
 
3656
3412
    encoding_type = 'replace'
3657
3413
    takes_options = [
3668
3424
 
3669
3425
 
3670
3426
class cmd_rocks(Command):
3671
 
    __doc__ = """Statement of optimism."""
 
3427
    """Statement of optimism."""
3672
3428
 
3673
3429
    hidden = True
3674
3430
 
3675
3431
    @display_command
3676
3432
    def run(self):
3677
 
        self.outf.write("It sure does!\n")
 
3433
        print "It sure does!"
3678
3434
 
3679
3435
 
3680
3436
class cmd_find_merge_base(Command):
3681
 
    __doc__ = """Find and print a base revision for merging two branches."""
 
3437
    """Find and print a base revision for merging two branches."""
3682
3438
    # TODO: Options to specify revisions on either side, as if
3683
3439
    #       merging only part of the history.
3684
3440
    takes_args = ['branch', 'other']
3691
3447
        branch1 = Branch.open_containing(branch)[0]
3692
3448
        branch2 = Branch.open_containing(other)[0]
3693
3449
        branch1.lock_read()
3694
 
        self.add_cleanup(branch1.unlock)
3695
 
        branch2.lock_read()
3696
 
        self.add_cleanup(branch2.unlock)
3697
 
        last1 = ensure_null(branch1.last_revision())
3698
 
        last2 = ensure_null(branch2.last_revision())
3699
 
 
3700
 
        graph = branch1.repository.get_graph(branch2.repository)
3701
 
        base_rev_id = graph.find_unique_lca(last1, last2)
3702
 
 
3703
 
        self.outf.write('merge base is revision %s\n' % base_rev_id)
 
3450
        try:
 
3451
            branch2.lock_read()
 
3452
            try:
 
3453
                last1 = ensure_null(branch1.last_revision())
 
3454
                last2 = ensure_null(branch2.last_revision())
 
3455
 
 
3456
                graph = branch1.repository.get_graph(branch2.repository)
 
3457
                base_rev_id = graph.find_unique_lca(last1, last2)
 
3458
 
 
3459
                print 'merge base is revision %s' % base_rev_id
 
3460
            finally:
 
3461
                branch2.unlock()
 
3462
        finally:
 
3463
            branch1.unlock()
3704
3464
 
3705
3465
 
3706
3466
class cmd_merge(Command):
3707
 
    __doc__ = """Perform a three-way merge.
 
3467
    """Perform a three-way merge.
3708
3468
 
3709
3469
    The source of the merge can be specified either in the form of a branch,
3710
3470
    or in the form of a path to a file containing a merge directive generated
3739
3499
    committed to record the result of the merge.
3740
3500
 
3741
3501
    merge refuses to run if there are any uncommitted changes, unless
3742
 
    --force is given. The --force option can also be used to create a
3743
 
    merge revision which has more than two parents.
3744
 
 
3745
 
    If one would like to merge changes from the working tree of the other
3746
 
    branch without merging any committed revisions, the --uncommitted option
3747
 
    can be given.
3748
 
 
3749
 
    To select only some changes to merge, use "merge -i", which will prompt
3750
 
    you to apply each diff hunk and file change, similar to "shelve".
 
3502
    --force is given.
3751
3503
 
3752
3504
    :Examples:
3753
3505
        To merge the latest revision from bzr.dev::
3762
3514
 
3763
3515
            bzr merge -r 81..82 ../bzr.dev
3764
3516
 
3765
 
        To apply a merge directive contained in /tmp/merge::
 
3517
        To apply a merge directive contained in /tmp/merge:
3766
3518
 
3767
3519
            bzr merge /tmp/merge
3768
 
 
3769
 
        To create a merge revision with three parents from two branches
3770
 
        feature1a and feature1b:
3771
 
 
3772
 
            bzr merge ../feature1a
3773
 
            bzr merge ../feature1b --force
3774
 
            bzr commit -m 'revision with three parents'
3775
3520
    """
3776
3521
 
3777
3522
    encoding_type = 'exact'
3799
3544
               short_name='d',
3800
3545
               type=unicode,
3801
3546
               ),
3802
 
        Option('preview', help='Instead of merging, show a diff of the'
3803
 
               ' merge.'),
3804
 
        Option('interactive', help='Select changes interactively.',
3805
 
            short_name='i')
 
3547
        Option('preview', help='Instead of merging, show a diff of the merge.')
3806
3548
    ]
3807
3549
 
3808
3550
    def run(self, location=None, revision=None, force=False,
3810
3552
            uncommitted=False, pull=False,
3811
3553
            directory=None,
3812
3554
            preview=False,
3813
 
            interactive=False,
3814
3555
            ):
3815
3556
        if merge_type is None:
3816
3557
            merge_type = _mod_merge.Merge3Merger
3822
3563
        verified = 'inapplicable'
3823
3564
        tree = WorkingTree.open_containing(directory)[0]
3824
3565
 
 
3566
        # die as quickly as possible if there are uncommitted changes
3825
3567
        try:
3826
3568
            basis_tree = tree.revision_tree(tree.last_revision())
3827
3569
        except errors.NoSuchRevision:
3828
3570
            basis_tree = tree.basis_tree()
3829
 
 
3830
 
        # die as quickly as possible if there are uncommitted changes
3831
3571
        if not force:
3832
 
            if tree.has_changes():
 
3572
            changes = tree.changes_from(basis_tree)
 
3573
            if changes.has_changed():
3833
3574
                raise errors.UncommittedChanges(tree)
3834
3575
 
3835
3576
        view_info = _get_view_info_for_change_reporter(tree)
3836
3577
        change_reporter = delta._ChangeReporter(
3837
3578
            unversioned_filter=tree.is_ignored, view_info=view_info)
3838
 
        pb = ui.ui_factory.nested_progress_bar()
3839
 
        self.add_cleanup(pb.finished)
3840
 
        tree.lock_write()
3841
 
        self.add_cleanup(tree.unlock)
3842
 
        if location is not None:
3843
 
            try:
3844
 
                mergeable = bundle.read_mergeable_from_url(location,
3845
 
                    possible_transports=possible_transports)
3846
 
            except errors.NotABundle:
3847
 
                mergeable = None
 
3579
        cleanups = []
 
3580
        try:
 
3581
            pb = ui.ui_factory.nested_progress_bar()
 
3582
            cleanups.append(pb.finished)
 
3583
            tree.lock_write()
 
3584
            cleanups.append(tree.unlock)
 
3585
            if location is not None:
 
3586
                try:
 
3587
                    mergeable = bundle.read_mergeable_from_url(location,
 
3588
                        possible_transports=possible_transports)
 
3589
                except errors.NotABundle:
 
3590
                    mergeable = None
 
3591
                else:
 
3592
                    if uncommitted:
 
3593
                        raise errors.BzrCommandError('Cannot use --uncommitted'
 
3594
                            ' with bundles or merge directives.')
 
3595
 
 
3596
                    if revision is not None:
 
3597
                        raise errors.BzrCommandError(
 
3598
                            'Cannot use -r with merge directives or bundles')
 
3599
                    merger, verified = _mod_merge.Merger.from_mergeable(tree,
 
3600
                       mergeable, pb)
 
3601
 
 
3602
            if merger is None and uncommitted:
 
3603
                if revision is not None and len(revision) > 0:
 
3604
                    raise errors.BzrCommandError('Cannot use --uncommitted and'
 
3605
                        ' --revision at the same time.')
 
3606
                location = self._select_branch_location(tree, location)[0]
 
3607
                other_tree, other_path = WorkingTree.open_containing(location)
 
3608
                merger = _mod_merge.Merger.from_uncommitted(tree, other_tree,
 
3609
                    pb)
 
3610
                allow_pending = False
 
3611
                if other_path != '':
 
3612
                    merger.interesting_files = [other_path]
 
3613
 
 
3614
            if merger is None:
 
3615
                merger, allow_pending = self._get_merger_from_branch(tree,
 
3616
                    location, revision, remember, possible_transports, pb)
 
3617
 
 
3618
            merger.merge_type = merge_type
 
3619
            merger.reprocess = reprocess
 
3620
            merger.show_base = show_base
 
3621
            self.sanity_check_merger(merger)
 
3622
            if (merger.base_rev_id == merger.other_rev_id and
 
3623
                merger.other_rev_id is not None):
 
3624
                note('Nothing to do.')
 
3625
                return 0
 
3626
            if pull:
 
3627
                if merger.interesting_files is not None:
 
3628
                    raise errors.BzrCommandError('Cannot pull individual files')
 
3629
                if (merger.base_rev_id == tree.last_revision()):
 
3630
                    result = tree.pull(merger.other_branch, False,
 
3631
                                       merger.other_rev_id)
 
3632
                    result.report(self.outf)
 
3633
                    return 0
 
3634
            merger.check_basis(False)
 
3635
            if preview:
 
3636
                return self._do_preview(merger)
3848
3637
            else:
3849
 
                if uncommitted:
3850
 
                    raise errors.BzrCommandError('Cannot use --uncommitted'
3851
 
                        ' with bundles or merge directives.')
3852
 
 
3853
 
                if revision is not None:
3854
 
                    raise errors.BzrCommandError(
3855
 
                        'Cannot use -r with merge directives or bundles')
3856
 
                merger, verified = _mod_merge.Merger.from_mergeable(tree,
3857
 
                   mergeable, None)
3858
 
 
3859
 
        if merger is None and uncommitted:
3860
 
            if revision is not None and len(revision) > 0:
3861
 
                raise errors.BzrCommandError('Cannot use --uncommitted and'
3862
 
                    ' --revision at the same time.')
3863
 
            merger = self.get_merger_from_uncommitted(tree, location, None)
3864
 
            allow_pending = False
3865
 
 
3866
 
        if merger is None:
3867
 
            merger, allow_pending = self._get_merger_from_branch(tree,
3868
 
                location, revision, remember, possible_transports, None)
3869
 
 
3870
 
        merger.merge_type = merge_type
3871
 
        merger.reprocess = reprocess
3872
 
        merger.show_base = show_base
3873
 
        self.sanity_check_merger(merger)
3874
 
        if (merger.base_rev_id == merger.other_rev_id and
3875
 
            merger.other_rev_id is not None):
3876
 
            note('Nothing to do.')
3877
 
            return 0
3878
 
        if pull:
3879
 
            if merger.interesting_files is not None:
3880
 
                raise errors.BzrCommandError('Cannot pull individual files')
3881
 
            if (merger.base_rev_id == tree.last_revision()):
3882
 
                result = tree.pull(merger.other_branch, False,
3883
 
                                   merger.other_rev_id)
3884
 
                result.report(self.outf)
3885
 
                return 0
3886
 
        if merger.this_basis is None:
3887
 
            raise errors.BzrCommandError(
3888
 
                "This branch has no commits."
3889
 
                " (perhaps you would prefer 'bzr pull')")
3890
 
        if preview:
3891
 
            return self._do_preview(merger)
3892
 
        elif interactive:
3893
 
            return self._do_interactive(merger)
3894
 
        else:
3895
 
            return self._do_merge(merger, change_reporter, allow_pending,
3896
 
                                  verified)
3897
 
 
3898
 
    def _get_preview(self, merger):
 
3638
                return self._do_merge(merger, change_reporter, allow_pending,
 
3639
                                      verified)
 
3640
        finally:
 
3641
            for cleanup in reversed(cleanups):
 
3642
                cleanup()
 
3643
 
 
3644
    def _do_preview(self, merger):
 
3645
        from bzrlib.diff import show_diff_trees
3899
3646
        tree_merger = merger.make_merger()
3900
3647
        tt = tree_merger.make_preview_transform()
3901
 
        self.add_cleanup(tt.finalize)
3902
 
        result_tree = tt.get_preview_tree()
3903
 
        return result_tree
3904
 
 
3905
 
    def _do_preview(self, merger):
3906
 
        from bzrlib.diff import show_diff_trees
3907
 
        result_tree = self._get_preview(merger)
3908
 
        show_diff_trees(merger.this_tree, result_tree, self.outf,
3909
 
                        old_label='', new_label='')
 
3648
        try:
 
3649
            result_tree = tt.get_preview_tree()
 
3650
            show_diff_trees(merger.this_tree, result_tree, self.outf,
 
3651
                            old_label='', new_label='')
 
3652
        finally:
 
3653
            tt.finalize()
3910
3654
 
3911
3655
    def _do_merge(self, merger, change_reporter, allow_pending, verified):
3912
3656
        merger.change_reporter = change_reporter
3920
3664
        else:
3921
3665
            return 0
3922
3666
 
3923
 
    def _do_interactive(self, merger):
3924
 
        """Perform an interactive merge.
3925
 
 
3926
 
        This works by generating a preview tree of the merge, then using
3927
 
        Shelver to selectively remove the differences between the working tree
3928
 
        and the preview tree.
3929
 
        """
3930
 
        from bzrlib import shelf_ui
3931
 
        result_tree = self._get_preview(merger)
3932
 
        writer = bzrlib.option.diff_writer_registry.get()
3933
 
        shelver = shelf_ui.Shelver(merger.this_tree, result_tree, destroy=True,
3934
 
                                   reporter=shelf_ui.ApplyReporter(),
3935
 
                                   diff_writer=writer(sys.stdout))
3936
 
        try:
3937
 
            shelver.run()
3938
 
        finally:
3939
 
            shelver.finalize()
3940
 
 
3941
3667
    def sanity_check_merger(self, merger):
3942
3668
        if (merger.show_base and
3943
3669
            not merger.merge_type is _mod_merge.Merge3Merger):
3978
3704
            base_branch, base_path = Branch.open_containing(base_loc,
3979
3705
                possible_transports)
3980
3706
        # Find the revision ids
3981
 
        other_revision_id = None
3982
 
        base_revision_id = None
3983
 
        if revision is not None:
3984
 
            if len(revision) >= 1:
3985
 
                other_revision_id = revision[-1].as_revision_id(other_branch)
3986
 
            if len(revision) == 2:
3987
 
                base_revision_id = revision[0].as_revision_id(base_branch)
3988
 
        if other_revision_id is None:
 
3707
        if revision is None or len(revision) < 1 or revision[-1] is None:
3989
3708
            other_revision_id = _mod_revision.ensure_null(
3990
3709
                other_branch.last_revision())
 
3710
        else:
 
3711
            other_revision_id = revision[-1].as_revision_id(other_branch)
 
3712
        if (revision is not None and len(revision) == 2
 
3713
            and revision[0] is not None):
 
3714
            base_revision_id = revision[0].as_revision_id(base_branch)
 
3715
        else:
 
3716
            base_revision_id = None
3991
3717
        # Remember where we merge from
3992
3718
        if ((remember or tree.branch.get_submit_branch() is None) and
3993
3719
             user_location is not None):
4002
3728
            allow_pending = True
4003
3729
        return merger, allow_pending
4004
3730
 
4005
 
    def get_merger_from_uncommitted(self, tree, location, pb):
4006
 
        """Get a merger for uncommitted changes.
4007
 
 
4008
 
        :param tree: The tree the merger should apply to.
4009
 
        :param location: The location containing uncommitted changes.
4010
 
        :param pb: The progress bar to use for showing progress.
4011
 
        """
4012
 
        location = self._select_branch_location(tree, location)[0]
4013
 
        other_tree, other_path = WorkingTree.open_containing(location)
4014
 
        merger = _mod_merge.Merger.from_uncommitted(tree, other_tree, pb)
4015
 
        if other_path != '':
4016
 
            merger.interesting_files = [other_path]
4017
 
        return merger
4018
 
 
4019
3731
    def _select_branch_location(self, tree, user_location, revision=None,
4020
3732
                                index=None):
4021
3733
        """Select a branch location, according to possible inputs.
4065
3777
 
4066
3778
 
4067
3779
class cmd_remerge(Command):
4068
 
    __doc__ = """Redo a merge.
 
3780
    """Redo a merge.
4069
3781
 
4070
3782
    Use this if you want to try a different merge technique while resolving
4071
3783
    conflicts.  Some merge techniques are better than others, and remerge
4096
3808
 
4097
3809
    def run(self, file_list=None, merge_type=None, show_base=False,
4098
3810
            reprocess=False):
4099
 
        from bzrlib.conflicts import restore
4100
3811
        if merge_type is None:
4101
3812
            merge_type = _mod_merge.Merge3Merger
4102
3813
        tree, file_list = tree_files(file_list)
4103
3814
        tree.lock_write()
4104
 
        self.add_cleanup(tree.unlock)
4105
 
        parents = tree.get_parent_ids()
4106
 
        if len(parents) != 2:
4107
 
            raise errors.BzrCommandError("Sorry, remerge only works after normal"
4108
 
                                         " merges.  Not cherrypicking or"
4109
 
                                         " multi-merges.")
4110
 
        repository = tree.branch.repository
4111
 
        interesting_ids = None
4112
 
        new_conflicts = []
4113
 
        conflicts = tree.conflicts()
4114
 
        if file_list is not None:
4115
 
            interesting_ids = set()
4116
 
            for filename in file_list:
4117
 
                file_id = tree.path2id(filename)
4118
 
                if file_id is None:
4119
 
                    raise errors.NotVersionedError(filename)
4120
 
                interesting_ids.add(file_id)
4121
 
                if tree.kind(file_id) != "directory":
4122
 
                    continue
 
3815
        try:
 
3816
            parents = tree.get_parent_ids()
 
3817
            if len(parents) != 2:
 
3818
                raise errors.BzrCommandError("Sorry, remerge only works after normal"
 
3819
                                             " merges.  Not cherrypicking or"
 
3820
                                             " multi-merges.")
 
3821
            repository = tree.branch.repository
 
3822
            interesting_ids = None
 
3823
            new_conflicts = []
 
3824
            conflicts = tree.conflicts()
 
3825
            if file_list is not None:
 
3826
                interesting_ids = set()
 
3827
                for filename in file_list:
 
3828
                    file_id = tree.path2id(filename)
 
3829
                    if file_id is None:
 
3830
                        raise errors.NotVersionedError(filename)
 
3831
                    interesting_ids.add(file_id)
 
3832
                    if tree.kind(file_id) != "directory":
 
3833
                        continue
4123
3834
 
4124
 
                for name, ie in tree.inventory.iter_entries(file_id):
4125
 
                    interesting_ids.add(ie.file_id)
4126
 
            new_conflicts = conflicts.select_conflicts(tree, file_list)[0]
4127
 
        else:
4128
 
            # Remerge only supports resolving contents conflicts
4129
 
            allowed_conflicts = ('text conflict', 'contents conflict')
4130
 
            restore_files = [c.path for c in conflicts
4131
 
                             if c.typestring in allowed_conflicts]
4132
 
        _mod_merge.transform_tree(tree, tree.basis_tree(), interesting_ids)
4133
 
        tree.set_conflicts(ConflictList(new_conflicts))
4134
 
        if file_list is not None:
4135
 
            restore_files = file_list
4136
 
        for filename in restore_files:
 
3835
                    for name, ie in tree.inventory.iter_entries(file_id):
 
3836
                        interesting_ids.add(ie.file_id)
 
3837
                new_conflicts = conflicts.select_conflicts(tree, file_list)[0]
 
3838
            else:
 
3839
                # Remerge only supports resolving contents conflicts
 
3840
                allowed_conflicts = ('text conflict', 'contents conflict')
 
3841
                restore_files = [c.path for c in conflicts
 
3842
                                 if c.typestring in allowed_conflicts]
 
3843
            _mod_merge.transform_tree(tree, tree.basis_tree(), interesting_ids)
 
3844
            tree.set_conflicts(ConflictList(new_conflicts))
 
3845
            if file_list is not None:
 
3846
                restore_files = file_list
 
3847
            for filename in restore_files:
 
3848
                try:
 
3849
                    restore(tree.abspath(filename))
 
3850
                except errors.NotConflicted:
 
3851
                    pass
 
3852
            # Disable pending merges, because the file texts we are remerging
 
3853
            # have not had those merges performed.  If we use the wrong parents
 
3854
            # list, we imply that the working tree text has seen and rejected
 
3855
            # all the changes from the other tree, when in fact those changes
 
3856
            # have not yet been seen.
 
3857
            pb = ui.ui_factory.nested_progress_bar()
 
3858
            tree.set_parent_ids(parents[:1])
4137
3859
            try:
4138
 
                restore(tree.abspath(filename))
4139
 
            except errors.NotConflicted:
4140
 
                pass
4141
 
        # Disable pending merges, because the file texts we are remerging
4142
 
        # have not had those merges performed.  If we use the wrong parents
4143
 
        # list, we imply that the working tree text has seen and rejected
4144
 
        # all the changes from the other tree, when in fact those changes
4145
 
        # have not yet been seen.
4146
 
        tree.set_parent_ids(parents[:1])
4147
 
        try:
4148
 
            merger = _mod_merge.Merger.from_revision_ids(None, tree, parents[1])
4149
 
            merger.interesting_ids = interesting_ids
4150
 
            merger.merge_type = merge_type
4151
 
            merger.show_base = show_base
4152
 
            merger.reprocess = reprocess
4153
 
            conflicts = merger.do_merge()
 
3860
                merger = _mod_merge.Merger.from_revision_ids(pb,
 
3861
                                                             tree, parents[1])
 
3862
                merger.interesting_ids = interesting_ids
 
3863
                merger.merge_type = merge_type
 
3864
                merger.show_base = show_base
 
3865
                merger.reprocess = reprocess
 
3866
                conflicts = merger.do_merge()
 
3867
            finally:
 
3868
                tree.set_parent_ids(parents)
 
3869
                pb.finished()
4154
3870
        finally:
4155
 
            tree.set_parent_ids(parents)
 
3871
            tree.unlock()
4156
3872
        if conflicts > 0:
4157
3873
            return 1
4158
3874
        else:
4160
3876
 
4161
3877
 
4162
3878
class cmd_revert(Command):
4163
 
    __doc__ = """Revert files to a previous revision.
 
3879
    """Revert files to a previous revision.
4164
3880
 
4165
3881
    Giving a list of files will revert only those files.  Otherwise, all files
4166
3882
    will be reverted.  If the revision is not specified with '--revision', the
4180
3896
    name.  If you name a directory, all the contents of that directory will be
4181
3897
    reverted.
4182
3898
 
4183
 
    If you have newly added files since the target revision, they will be
4184
 
    removed.  If the files to be removed have been changed, backups will be
4185
 
    created as above.  Directories containing unknown files will not be
4186
 
    deleted.
 
3899
    Any files that have been newly added since that revision will be deleted,
 
3900
    with a backup kept if appropriate.  Directories containing unknown files
 
3901
    will not be deleted.
4187
3902
 
4188
 
    The working tree contains a list of revisions that have been merged but
4189
 
    not yet committed. These revisions will be included as additional parents
4190
 
    of the next commit.  Normally, using revert clears that list as well as
4191
 
    reverting the files.  If any files are specified, revert leaves the list
4192
 
    of uncommitted merges alone and reverts only the files.  Use ``bzr revert
4193
 
    .`` in the tree root to revert all files but keep the recorded merges,
4194
 
    and ``bzr revert --forget-merges`` to clear the pending merge list without
 
3903
    The working tree contains a list of pending merged revisions, which will
 
3904
    be included as parents in the next commit.  Normally, revert clears that
 
3905
    list as well as reverting the files.  If any files are specified, revert
 
3906
    leaves the pending merge list alone and reverts only the files.  Use "bzr
 
3907
    revert ." in the tree root to revert all files but keep the merge record,
 
3908
    and "bzr revert --forget-merges" to clear the pending merge list without
4195
3909
    reverting any files.
4196
 
 
4197
 
    Using "bzr revert --forget-merges", it is possible to apply all of the
4198
 
    changes from a branch in a single revision.  To do this, perform the merge
4199
 
    as desired.  Then doing revert with the "--forget-merges" option will keep
4200
 
    the content of the tree as it was, but it will clear the list of pending
4201
 
    merges.  The next commit will then contain all of the changes that are
4202
 
    present in the other branch, but without any other parent revisions.
4203
 
    Because this technique forgets where these changes originated, it may
4204
 
    cause additional conflicts on later merges involving the same source and
4205
 
    target branches.
4206
3910
    """
4207
3911
 
4208
3912
    _see_also = ['cat', 'export']
4217
3921
    def run(self, revision=None, no_backup=False, file_list=None,
4218
3922
            forget_merges=None):
4219
3923
        tree, file_list = tree_files(file_list)
4220
 
        tree.lock_tree_write()
4221
 
        self.add_cleanup(tree.unlock)
4222
 
        if forget_merges:
4223
 
            tree.set_parent_ids(tree.get_parent_ids()[:1])
4224
 
        else:
4225
 
            self._revert_tree_to_revision(tree, revision, file_list, no_backup)
 
3924
        tree.lock_write()
 
3925
        try:
 
3926
            if forget_merges:
 
3927
                tree.set_parent_ids(tree.get_parent_ids()[:1])
 
3928
            else:
 
3929
                self._revert_tree_to_revision(tree, revision, file_list, no_backup)
 
3930
        finally:
 
3931
            tree.unlock()
4226
3932
 
4227
3933
    @staticmethod
4228
3934
    def _revert_tree_to_revision(tree, revision, file_list, no_backup):
4229
3935
        rev_tree = _get_one_revision_tree('revert', revision, tree=tree)
4230
 
        tree.revert(file_list, rev_tree, not no_backup, None,
4231
 
            report_changes=True)
 
3936
        pb = ui.ui_factory.nested_progress_bar()
 
3937
        try:
 
3938
            tree.revert(file_list, rev_tree, not no_backup, pb,
 
3939
                report_changes=True)
 
3940
        finally:
 
3941
            pb.finished()
4232
3942
 
4233
3943
 
4234
3944
class cmd_assert_fail(Command):
4235
 
    __doc__ = """Test reporting of assertion failures"""
 
3945
    """Test reporting of assertion failures"""
4236
3946
    # intended just for use in testing
4237
3947
 
4238
3948
    hidden = True
4242
3952
 
4243
3953
 
4244
3954
class cmd_help(Command):
4245
 
    __doc__ = """Show help on a command or other topic.
 
3955
    """Show help on a command or other topic.
4246
3956
    """
4247
3957
 
4248
3958
    _see_also = ['topics']
4261
3971
 
4262
3972
 
4263
3973
class cmd_shell_complete(Command):
4264
 
    __doc__ = """Show appropriate completions for context.
 
3974
    """Show appropriate completions for context.
4265
3975
 
4266
3976
    For a list of all available commands, say 'bzr shell-complete'.
4267
3977
    """
4276
3986
 
4277
3987
 
4278
3988
class cmd_missing(Command):
4279
 
    __doc__ = """Show unmerged/unpulled revisions between two branches.
 
3989
    """Show unmerged/unpulled revisions between two branches.
4280
3990
 
4281
3991
    OTHER_BRANCH may be local or remote.
4282
3992
 
4283
3993
    To filter on a range of revisions, you can use the command -r begin..end
4284
3994
    -r revision requests a specific revision, -r ..end or -r begin.. are
4285
3995
    also valid.
4286
 
            
4287
 
    :Exit values:
4288
 
        1 - some missing revisions
4289
 
        0 - no missing revisions
4290
3996
 
4291
3997
    :Examples:
4292
3998
 
4360
4066
            restrict = 'remote'
4361
4067
 
4362
4068
        local_branch = Branch.open_containing(u".")[0]
4363
 
        local_branch.lock_read()
4364
 
        self.add_cleanup(local_branch.unlock)
4365
 
 
4366
4069
        parent = local_branch.get_parent()
4367
4070
        if other_branch is None:
4368
4071
            other_branch = parent
4377
4080
        remote_branch = Branch.open(other_branch)
4378
4081
        if remote_branch.base == local_branch.base:
4379
4082
            remote_branch = local_branch
4380
 
        else:
4381
 
            remote_branch.lock_read()
4382
 
            self.add_cleanup(remote_branch.unlock)
4383
4083
 
4384
4084
        local_revid_range = _revision_range_to_revid_range(
4385
4085
            _get_revision_range(my_revision, local_branch,
4389
4089
            _get_revision_range(revision,
4390
4090
                remote_branch, self.name()))
4391
4091
 
4392
 
        local_extra, remote_extra = find_unmerged(
4393
 
            local_branch, remote_branch, restrict,
4394
 
            backward=not reverse,
4395
 
            include_merges=include_merges,
4396
 
            local_revid_range=local_revid_range,
4397
 
            remote_revid_range=remote_revid_range)
4398
 
 
4399
 
        if log_format is None:
4400
 
            registry = log.log_formatter_registry
4401
 
            log_format = registry.get_default(local_branch)
4402
 
        lf = log_format(to_file=self.outf,
4403
 
                        show_ids=show_ids,
4404
 
                        show_timezone='original')
4405
 
 
4406
 
        status_code = 0
4407
 
        if local_extra and not theirs_only:
4408
 
            message("You have %d extra revision(s):\n" %
4409
 
                len(local_extra))
4410
 
            for revision in iter_log_revisions(local_extra,
4411
 
                                local_branch.repository,
4412
 
                                verbose):
4413
 
                lf.log_revision(revision)
4414
 
            printed_local = True
4415
 
            status_code = 1
4416
 
        else:
4417
 
            printed_local = False
4418
 
 
4419
 
        if remote_extra and not mine_only:
4420
 
            if printed_local is True:
4421
 
                message("\n\n\n")
4422
 
            message("You are missing %d revision(s):\n" %
4423
 
                len(remote_extra))
4424
 
            for revision in iter_log_revisions(remote_extra,
4425
 
                                remote_branch.repository,
4426
 
                                verbose):
4427
 
                lf.log_revision(revision)
4428
 
            status_code = 1
4429
 
 
4430
 
        if mine_only and not local_extra:
4431
 
            # We checked local, and found nothing extra
4432
 
            message('This branch is up to date.\n')
4433
 
        elif theirs_only and not remote_extra:
4434
 
            # We checked remote, and found nothing extra
4435
 
            message('Other branch is up to date.\n')
4436
 
        elif not (mine_only or theirs_only or local_extra or
4437
 
                  remote_extra):
4438
 
            # We checked both branches, and neither one had extra
4439
 
            # revisions
4440
 
            message("Branches are up to date.\n")
4441
 
        self.cleanup_now()
 
4092
        local_branch.lock_read()
 
4093
        try:
 
4094
            remote_branch.lock_read()
 
4095
            try:
 
4096
                local_extra, remote_extra = find_unmerged(
 
4097
                    local_branch, remote_branch, restrict,
 
4098
                    backward=not reverse,
 
4099
                    include_merges=include_merges,
 
4100
                    local_revid_range=local_revid_range,
 
4101
                    remote_revid_range=remote_revid_range)
 
4102
 
 
4103
                if log_format is None:
 
4104
                    registry = log.log_formatter_registry
 
4105
                    log_format = registry.get_default(local_branch)
 
4106
                lf = log_format(to_file=self.outf,
 
4107
                                show_ids=show_ids,
 
4108
                                show_timezone='original')
 
4109
 
 
4110
                status_code = 0
 
4111
                if local_extra and not theirs_only:
 
4112
                    message("You have %d extra revision(s):\n" %
 
4113
                        len(local_extra))
 
4114
                    for revision in iter_log_revisions(local_extra,
 
4115
                                        local_branch.repository,
 
4116
                                        verbose):
 
4117
                        lf.log_revision(revision)
 
4118
                    printed_local = True
 
4119
                    status_code = 1
 
4120
                else:
 
4121
                    printed_local = False
 
4122
 
 
4123
                if remote_extra and not mine_only:
 
4124
                    if printed_local is True:
 
4125
                        message("\n\n\n")
 
4126
                    message("You are missing %d revision(s):\n" %
 
4127
                        len(remote_extra))
 
4128
                    for revision in iter_log_revisions(remote_extra,
 
4129
                                        remote_branch.repository,
 
4130
                                        verbose):
 
4131
                        lf.log_revision(revision)
 
4132
                    status_code = 1
 
4133
 
 
4134
                if mine_only and not local_extra:
 
4135
                    # We checked local, and found nothing extra
 
4136
                    message('This branch is up to date.\n')
 
4137
                elif theirs_only and not remote_extra:
 
4138
                    # We checked remote, and found nothing extra
 
4139
                    message('Other branch is up to date.\n')
 
4140
                elif not (mine_only or theirs_only or local_extra or
 
4141
                          remote_extra):
 
4142
                    # We checked both branches, and neither one had extra
 
4143
                    # revisions
 
4144
                    message("Branches are up to date.\n")
 
4145
            finally:
 
4146
                remote_branch.unlock()
 
4147
        finally:
 
4148
            local_branch.unlock()
4442
4149
        if not status_code and parent is None and other_branch is not None:
4443
4150
            local_branch.lock_write()
4444
 
            self.add_cleanup(local_branch.unlock)
4445
 
            # handle race conditions - a parent might be set while we run.
4446
 
            if local_branch.get_parent() is None:
4447
 
                local_branch.set_parent(remote_branch.base)
 
4151
            try:
 
4152
                # handle race conditions - a parent might be set while we run.
 
4153
                if local_branch.get_parent() is None:
 
4154
                    local_branch.set_parent(remote_branch.base)
 
4155
            finally:
 
4156
                local_branch.unlock()
4448
4157
        return status_code
4449
4158
 
4450
4159
 
4451
4160
class cmd_pack(Command):
4452
 
    __doc__ = """Compress the data within a repository.
4453
 
 
4454
 
    This operation compresses the data within a bazaar repository. As
4455
 
    bazaar supports automatic packing of repository, this operation is
4456
 
    normally not required to be done manually.
4457
 
 
4458
 
    During the pack operation, bazaar takes a backup of existing repository
4459
 
    data, i.e. pack files. This backup is eventually removed by bazaar
4460
 
    automatically when it is safe to do so. To save disk space by removing
4461
 
    the backed up pack files, the --clean-obsolete-packs option may be
4462
 
    used.
4463
 
 
4464
 
    Warning: If you use --clean-obsolete-packs and your machine crashes
4465
 
    during or immediately after repacking, you may be left with a state
4466
 
    where the deletion has been written to disk but the new packs have not
4467
 
    been. In this case the repository may be unusable.
4468
 
    """
 
4161
    """Compress the data within a repository."""
4469
4162
 
4470
4163
    _see_also = ['repositories']
4471
4164
    takes_args = ['branch_or_repo?']
4472
 
    takes_options = [
4473
 
        Option('clean-obsolete-packs', 'Delete obsolete packs to save disk space.'),
4474
 
        ]
4475
4165
 
4476
 
    def run(self, branch_or_repo='.', clean_obsolete_packs=False):
 
4166
    def run(self, branch_or_repo='.'):
4477
4167
        dir = bzrdir.BzrDir.open_containing(branch_or_repo)[0]
4478
4168
        try:
4479
4169
            branch = dir.open_branch()
4480
4170
            repository = branch.repository
4481
4171
        except errors.NotBranchError:
4482
4172
            repository = dir.open_repository()
4483
 
        repository.pack(clean_obsolete_packs=clean_obsolete_packs)
 
4173
        repository.pack()
4484
4174
 
4485
4175
 
4486
4176
class cmd_plugins(Command):
4487
 
    __doc__ = """List the installed plugins.
 
4177
    """List the installed plugins.
4488
4178
 
4489
4179
    This command displays the list of installed plugins including
4490
4180
    version of plugin and a short description of each.
4497
4187
    adding new commands, providing additional network transports and
4498
4188
    customizing log output.
4499
4189
 
4500
 
    See the Bazaar Plugin Guide <http://doc.bazaar.canonical.com/plugins/en/>
4501
 
    for further information on plugins including where to find them and how to
4502
 
    install them. Instructions are also provided there on how to write new
4503
 
    plugins using the Python programming language.
 
4190
    See the Bazaar web site, http://bazaar-vcs.org, for further
 
4191
    information on plugins including where to find them and how to
 
4192
    install them. Instructions are also provided there on how to
 
4193
    write new plugins using the Python programming language.
4504
4194
    """
4505
4195
    takes_options = ['verbose']
4506
4196
 
4521
4211
                doc = '(no description)'
4522
4212
            result.append((name_ver, doc, plugin.path()))
4523
4213
        for name_ver, doc, path in sorted(result):
4524
 
            self.outf.write("%s\n" % name_ver)
4525
 
            self.outf.write("   %s\n" % doc)
 
4214
            print name_ver
 
4215
            print '   ', doc
4526
4216
            if verbose:
4527
 
                self.outf.write("   %s\n" % path)
4528
 
            self.outf.write("\n")
 
4217
                print '   ', path
 
4218
            print
4529
4219
 
4530
4220
 
4531
4221
class cmd_testament(Command):
4532
 
    __doc__ = """Show testament (signing-form) of a revision."""
 
4222
    """Show testament (signing-form) of a revision."""
4533
4223
    takes_options = [
4534
4224
            'revision',
4535
4225
            Option('long', help='Produce long-format testament.'),
4548
4238
        else:
4549
4239
            b = Branch.open(branch)
4550
4240
        b.lock_read()
4551
 
        self.add_cleanup(b.unlock)
4552
 
        if revision is None:
4553
 
            rev_id = b.last_revision()
4554
 
        else:
4555
 
            rev_id = revision[0].as_revision_id(b)
4556
 
        t = testament_class.from_revision(b.repository, rev_id)
4557
 
        if long:
4558
 
            sys.stdout.writelines(t.as_text_lines())
4559
 
        else:
4560
 
            sys.stdout.write(t.as_short_text())
 
4241
        try:
 
4242
            if revision is None:
 
4243
                rev_id = b.last_revision()
 
4244
            else:
 
4245
                rev_id = revision[0].as_revision_id(b)
 
4246
            t = testament_class.from_revision(b.repository, rev_id)
 
4247
            if long:
 
4248
                sys.stdout.writelines(t.as_text_lines())
 
4249
            else:
 
4250
                sys.stdout.write(t.as_short_text())
 
4251
        finally:
 
4252
            b.unlock()
4561
4253
 
4562
4254
 
4563
4255
class cmd_annotate(Command):
4564
 
    __doc__ = """Show the origin of each line in a file.
 
4256
    """Show the origin of each line in a file.
4565
4257
 
4566
4258
    This prints out the given file with an annotation on the left side
4567
4259
    indicating which revision, author and date introduced the change.
4589
4281
            bzrdir.BzrDir.open_containing_tree_or_branch(filename)
4590
4282
        if wt is not None:
4591
4283
            wt.lock_read()
4592
 
            self.add_cleanup(wt.unlock)
4593
4284
        else:
4594
4285
            branch.lock_read()
4595
 
            self.add_cleanup(branch.unlock)
4596
 
        tree = _get_one_revision_tree('annotate', revision, branch=branch)
4597
 
        tree.lock_read()
4598
 
        self.add_cleanup(tree.unlock)
4599
 
        if wt is not None:
4600
 
            file_id = wt.path2id(relpath)
4601
 
        else:
4602
 
            file_id = tree.path2id(relpath)
4603
 
        if file_id is None:
4604
 
            raise errors.NotVersionedError(filename)
4605
 
        file_version = tree.inventory[file_id].revision
4606
 
        if wt is not None and revision is None:
4607
 
            # If there is a tree and we're not annotating historical
4608
 
            # versions, annotate the working tree's content.
4609
 
            annotate_file_tree(wt, file_id, self.outf, long, all,
4610
 
                show_ids=show_ids)
4611
 
        else:
4612
 
            annotate_file(branch, file_version, file_id, long, all, self.outf,
4613
 
                          show_ids=show_ids)
 
4286
        try:
 
4287
            tree = _get_one_revision_tree('annotate', revision, branch=branch)
 
4288
            if wt is not None:
 
4289
                file_id = wt.path2id(relpath)
 
4290
            else:
 
4291
                file_id = tree.path2id(relpath)
 
4292
            if file_id is None:
 
4293
                raise errors.NotVersionedError(filename)
 
4294
            file_version = tree.inventory[file_id].revision
 
4295
            if wt is not None and revision is None:
 
4296
                # If there is a tree and we're not annotating historical
 
4297
                # versions, annotate the working tree's content.
 
4298
                annotate_file_tree(wt, file_id, self.outf, long, all,
 
4299
                    show_ids=show_ids)
 
4300
            else:
 
4301
                annotate_file(branch, file_version, file_id, long, all, self.outf,
 
4302
                              show_ids=show_ids)
 
4303
        finally:
 
4304
            if wt is not None:
 
4305
                wt.unlock()
 
4306
            else:
 
4307
                branch.unlock()
4614
4308
 
4615
4309
 
4616
4310
class cmd_re_sign(Command):
4617
 
    __doc__ = """Create a digital signature for an existing revision."""
 
4311
    """Create a digital signature for an existing revision."""
4618
4312
    # TODO be able to replace existing ones.
4619
4313
 
4620
4314
    hidden = True # is this right ?
4628
4322
            raise errors.BzrCommandError('You must supply either --revision or a revision_id')
4629
4323
        b = WorkingTree.open_containing(u'.')[0].branch
4630
4324
        b.lock_write()
4631
 
        self.add_cleanup(b.unlock)
4632
 
        return self._run(b, revision_id_list, revision)
 
4325
        try:
 
4326
            return self._run(b, revision_id_list, revision)
 
4327
        finally:
 
4328
            b.unlock()
4633
4329
 
4634
4330
    def _run(self, b, revision_id_list, revision):
4635
4331
        import bzrlib.gpg as gpg
4680
4376
 
4681
4377
 
4682
4378
class cmd_bind(Command):
4683
 
    __doc__ = """Convert the current branch into a checkout of the supplied branch.
4684
 
    If no branch is supplied, rebind to the last bound location.
 
4379
    """Convert the current branch into a checkout of the supplied branch.
4685
4380
 
4686
4381
    Once converted into a checkout, commits must succeed on the master branch
4687
4382
    before they will be applied to the local branch.
4688
4383
 
4689
4384
    Bound branches use the nickname of its master branch unless it is set
4690
 
    locally, in which case binding will update the local nickname to be
 
4385
    locally, in which case binding will update the the local nickname to be
4691
4386
    that of the master.
4692
4387
    """
4693
4388
 
4705
4400
                    'This format does not remember old locations.')
4706
4401
            else:
4707
4402
                if location is None:
4708
 
                    if b.get_bound_location() is not None:
4709
 
                        raise errors.BzrCommandError('Branch is already bound')
4710
 
                    else:
4711
 
                        raise errors.BzrCommandError('No location supplied '
4712
 
                            'and no previous location known')
 
4403
                    raise errors.BzrCommandError('No location supplied and no '
 
4404
                        'previous location known')
4713
4405
        b_other = Branch.open(location)
4714
4406
        try:
4715
4407
            b.bind(b_other)
4721
4413
 
4722
4414
 
4723
4415
class cmd_unbind(Command):
4724
 
    __doc__ = """Convert the current checkout into a regular branch.
 
4416
    """Convert the current checkout into a regular branch.
4725
4417
 
4726
4418
    After unbinding, the local branch is considered independent and subsequent
4727
4419
    commits will be local only.
4738
4430
 
4739
4431
 
4740
4432
class cmd_uncommit(Command):
4741
 
    __doc__ = """Remove the last committed revision.
 
4433
    """Remove the last committed revision.
4742
4434
 
4743
4435
    --verbose will print out what is being removed.
4744
4436
    --dry-run will go through all the motions, but not actually
4785
4477
 
4786
4478
        if tree is not None:
4787
4479
            tree.lock_write()
4788
 
            self.add_cleanup(tree.unlock)
4789
4480
        else:
4790
4481
            b.lock_write()
4791
 
            self.add_cleanup(b.unlock)
4792
 
        return self._run(b, tree, dry_run, verbose, revision, force, local=local)
 
4482
        try:
 
4483
            return self._run(b, tree, dry_run, verbose, revision, force,
 
4484
                             local=local)
 
4485
        finally:
 
4486
            if tree is not None:
 
4487
                tree.unlock()
 
4488
            else:
 
4489
                b.unlock()
4793
4490
 
4794
4491
    def _run(self, b, tree, dry_run, verbose, revision, force, local=False):
4795
4492
        from bzrlib.log import log_formatter, show_log
4827
4524
                 end_revision=last_revno)
4828
4525
 
4829
4526
        if dry_run:
4830
 
            self.outf.write('Dry-run, pretending to remove'
4831
 
                            ' the above revisions.\n')
 
4527
            print 'Dry-run, pretending to remove the above revisions.'
 
4528
            if not force:
 
4529
                val = raw_input('Press <enter> to continue')
4832
4530
        else:
4833
 
            self.outf.write('The above revision(s) will be removed.\n')
4834
 
 
4835
 
        if not force:
4836
 
            if not ui.ui_factory.get_boolean('Are you sure'):
4837
 
                self.outf.write('Canceled')
4838
 
                return 0
 
4531
            print 'The above revision(s) will be removed.'
 
4532
            if not force:
 
4533
                val = raw_input('Are you sure [y/N]? ')
 
4534
                if val.lower() not in ('y', 'yes'):
 
4535
                    print 'Canceled'
 
4536
                    return 0
4839
4537
 
4840
4538
        mutter('Uncommitting from {%s} to {%s}',
4841
4539
               last_rev_id, rev_id)
4842
4540
        uncommit(b, tree=tree, dry_run=dry_run, verbose=verbose,
4843
4541
                 revno=revno, local=local)
4844
 
        self.outf.write('You can restore the old tip by running:\n'
4845
 
             '  bzr pull . -r revid:%s\n' % last_rev_id)
 
4542
        note('You can restore the old tip by running:\n'
 
4543
             '  bzr pull . -r revid:%s', last_rev_id)
4846
4544
 
4847
4545
 
4848
4546
class cmd_break_lock(Command):
4849
 
    __doc__ = """Break a dead lock on a repository, branch or working directory.
 
4547
    """Break a dead lock on a repository, branch or working directory.
4850
4548
 
4851
4549
    CAUTION: Locks should only be broken when you are sure that the process
4852
4550
    holding the lock has been stopped.
4853
4551
 
4854
 
    You can get information on what locks are open via the 'bzr info
4855
 
    [location]' command.
 
4552
    You can get information on what locks are open via the 'bzr info' command.
4856
4553
 
4857
4554
    :Examples:
4858
4555
        bzr break-lock
4859
 
        bzr break-lock bzr+ssh://example.com/bzr/foo
4860
4556
    """
4861
4557
    takes_args = ['location?']
4862
4558
 
4871
4567
 
4872
4568
 
4873
4569
class cmd_wait_until_signalled(Command):
4874
 
    __doc__ = """Test helper for test_start_and_stop_bzr_subprocess_send_signal.
 
4570
    """Test helper for test_start_and_stop_bzr_subprocess_send_signal.
4875
4571
 
4876
4572
    This just prints a line to signal when it is ready, then blocks on stdin.
4877
4573
    """
4885
4581
 
4886
4582
 
4887
4583
class cmd_serve(Command):
4888
 
    __doc__ = """Run the bzr server."""
 
4584
    """Run the bzr server."""
4889
4585
 
4890
4586
    aliases = ['server']
4891
4587
 
4892
4588
    takes_options = [
4893
4589
        Option('inet',
4894
4590
               help='Serve on stdin/out for use from inetd or sshd.'),
4895
 
        RegistryOption('protocol',
4896
 
               help="Protocol to serve.",
 
4591
        RegistryOption('protocol', 
 
4592
               help="Protocol to serve.", 
4897
4593
               lazy_registry=('bzrlib.transport', 'transport_server_registry'),
4898
4594
               value_switches=True),
4899
4595
        Option('port',
4908
4604
        Option('allow-writes',
4909
4605
               help='By default the server is a readonly server.  Supplying '
4910
4606
                    '--allow-writes enables write access to the contents of '
4911
 
                    'the served directory and below.  Note that ``bzr serve`` '
4912
 
                    'does not perform authentication, so unless some form of '
4913
 
                    'external authentication is arranged supplying this '
4914
 
                    'option leads to global uncontrolled write access to your '
4915
 
                    'file system.'
 
4607
                    'the served directory and below.'
4916
4608
                ),
4917
4609
        ]
4918
4610
 
4951
4643
 
4952
4644
 
4953
4645
class cmd_join(Command):
4954
 
    __doc__ = """Combine a tree into its containing tree.
 
4646
    """Combine a tree into its containing tree.
4955
4647
 
4956
4648
    This command requires the target tree to be in a rich-root format.
4957
4649
 
4997
4689
 
4998
4690
 
4999
4691
class cmd_split(Command):
5000
 
    __doc__ = """Split a subdirectory of a tree into a separate tree.
 
4692
    """Split a subdirectory of a tree into a separate tree.
5001
4693
 
5002
4694
    This command will produce a target tree in a format that supports
5003
4695
    rich roots, like 'rich-root' or 'rich-root-pack'.  These formats cannot be
5023
4715
 
5024
4716
 
5025
4717
class cmd_merge_directive(Command):
5026
 
    __doc__ = """Generate a merge directive for auto-merge tools.
 
4718
    """Generate a merge directive for auto-merge tools.
5027
4719
 
5028
4720
    A directive requests a merge to be performed, and also provides all the
5029
4721
    information necessary to do so.  This means it must either include a
5122
4814
 
5123
4815
 
5124
4816
class cmd_send(Command):
5125
 
    __doc__ = """Mail or create a merge-directive for submitting changes.
 
4817
    """Mail or create a merge-directive for submitting changes.
5126
4818
 
5127
4819
    A merge directive provides many things needed for requesting merges:
5128
4820
 
5134
4826
      directly from the merge directive, without retrieving data from a
5135
4827
      branch.
5136
4828
 
5137
 
    `bzr send` creates a compact data set that, when applied using bzr
5138
 
    merge, has the same effect as merging from the source branch.  
5139
 
    
5140
 
    By default the merge directive is self-contained and can be applied to any
5141
 
    branch containing submit_branch in its ancestory without needing access to
5142
 
    the source branch.
5143
 
    
5144
 
    If --no-bundle is specified, then Bazaar doesn't send the contents of the
5145
 
    revisions, but only a structured request to merge from the
5146
 
    public_location.  In that case the public_branch is needed and it must be
5147
 
    up-to-date and accessible to the recipient.  The public_branch is always
5148
 
    included if known, so that people can check it later.
5149
 
 
5150
 
    The submit branch defaults to the parent of the source branch, but can be
5151
 
    overridden.  Both submit branch and public branch will be remembered in
5152
 
    branch.conf the first time they are used for a particular branch.  The
5153
 
    source branch defaults to that containing the working directory, but can
5154
 
    be changed using --from.
5155
 
 
5156
 
    In order to calculate those changes, bzr must analyse the submit branch.
5157
 
    Therefore it is most efficient for the submit branch to be a local mirror.
5158
 
    If a public location is known for the submit_branch, that location is used
5159
 
    in the merge directive.
5160
 
 
5161
 
    The default behaviour is to send the merge directive by mail, unless -o is
5162
 
    given, in which case it is sent to a file.
 
4829
    If --no-bundle is specified, then public_branch is needed (and must be
 
4830
    up-to-date), so that the receiver can perform the merge using the
 
4831
    public_branch.  The public_branch is always included if known, so that
 
4832
    people can check it later.
 
4833
 
 
4834
    The submit branch defaults to the parent, but can be overridden.  Both
 
4835
    submit branch and public branch will be remembered if supplied.
 
4836
 
 
4837
    If a public_branch is known for the submit_branch, that public submit
 
4838
    branch is used in the merge instructions.  This means that a local mirror
 
4839
    can be used as your actual submit branch, once you have set public_branch
 
4840
    for that mirror.
5163
4841
 
5164
4842
    Mail is sent using your preferred mail program.  This should be transparent
5165
4843
    on Windows (it uses MAPI).  On Linux, it requires the xdg-email utility.
5167
4845
 
5168
4846
    To use a specific mail program, set the mail_client configuration option.
5169
4847
    (For Thunderbird 1.5, this works around some bugs.)  Supported values for
5170
 
    specific clients are "claws", "evolution", "kmail", "mail.app" (MacOS X's
5171
 
    Mail.app), "mutt", and "thunderbird"; generic options are "default",
5172
 
    "editor", "emacsclient", "mapi", and "xdg-email".  Plugins may also add
5173
 
    supported clients.
 
4848
    specific clients are "claws", "evolution", "kmail", "mutt", and
 
4849
    "thunderbird"; generic options are "default", "editor", "emacsclient",
 
4850
    "mapi", and "xdg-email".  Plugins may also add supported clients.
5174
4851
 
5175
4852
    If mail is being sent, a to address is required.  This can be supplied
5176
4853
    either on the commandline, by setting the submit_to configuration
5185
4862
 
5186
4863
    The merge directives created by bzr send may be applied using bzr merge or
5187
4864
    bzr pull by specifying a file containing a merge directive as the location.
5188
 
 
5189
 
    bzr send makes extensive use of public locations to map local locations into
5190
 
    URLs that can be used by other people.  See `bzr help configuration` to
5191
 
    set them, and use `bzr info` to display them.
5192
4865
    """
5193
4866
 
5194
4867
    encoding_type = 'exact'
5210
4883
               short_name='f',
5211
4884
               type=unicode),
5212
4885
        Option('output', short_name='o',
5213
 
               help='Write merge directive to this file or directory; '
 
4886
               help='Write merge directive to this file; '
5214
4887
                    'use - for stdout.',
5215
4888
               type=unicode),
5216
 
        Option('strict',
5217
 
               help='Refuse to send if there are uncommitted changes in'
5218
 
               ' the working tree, --no-strict disables the check.'),
5219
4889
        Option('mail-to', help='Mail the request to this address.',
5220
4890
               type=unicode),
5221
4891
        'revision',
5222
4892
        'message',
5223
4893
        Option('body', help='Body for the email.', type=unicode),
5224
4894
        RegistryOption('format',
5225
 
                       help='Use the specified output format.',
5226
 
                       lazy_registry=('bzrlib.send', 'format_registry')),
 
4895
                       help='Use the specified output format.', 
 
4896
                       lazy_registry=('bzrlib.send', 'format_registry'))
5227
4897
        ]
5228
4898
 
5229
4899
    def run(self, submit_branch=None, public_branch=None, no_bundle=False,
5230
4900
            no_patch=False, revision=None, remember=False, output=None,
5231
 
            format=None, mail_to=None, message=None, body=None,
5232
 
            strict=None, **kwargs):
 
4901
            format=None, mail_to=None, message=None, body=None, **kwargs):
5233
4902
        from bzrlib.send import send
5234
4903
        return send(submit_branch, revision, public_branch, remember,
5235
 
                    format, no_bundle, no_patch, output,
5236
 
                    kwargs.get('from', '.'), mail_to, message, body,
5237
 
                    self.outf,
5238
 
                    strict=strict)
 
4904
                         format, no_bundle, no_patch, output,
 
4905
                         kwargs.get('from', '.'), mail_to, message, body,
 
4906
                         self.outf)
5239
4907
 
5240
4908
 
5241
4909
class cmd_bundle_revisions(cmd_send):
5242
 
    __doc__ = """Create a merge-directive for submitting changes.
 
4910
    """Create a merge-directive for submitting changes.
5243
4911
 
5244
4912
    A merge directive provides many things needed for requesting merges:
5245
4913
 
5285
4953
               type=unicode),
5286
4954
        Option('output', short_name='o', help='Write directive to this file.',
5287
4955
               type=unicode),
5288
 
        Option('strict',
5289
 
               help='Refuse to bundle revisions if there are uncommitted'
5290
 
               ' changes in the working tree, --no-strict disables the check.'),
5291
4956
        'revision',
5292
4957
        RegistryOption('format',
5293
4958
                       help='Use the specified output format.',
5301
4966
 
5302
4967
    def run(self, submit_branch=None, public_branch=None, no_bundle=False,
5303
4968
            no_patch=False, revision=None, remember=False, output=None,
5304
 
            format=None, strict=None, **kwargs):
 
4969
            format=None, **kwargs):
5305
4970
        if output is None:
5306
4971
            output = '-'
5307
4972
        from bzrlib.send import send
5308
4973
        return send(submit_branch, revision, public_branch, remember,
5309
4974
                         format, no_bundle, no_patch, output,
5310
4975
                         kwargs.get('from', '.'), None, None, None,
5311
 
                         self.outf, strict=strict)
 
4976
                         self.outf)
5312
4977
 
5313
4978
 
5314
4979
class cmd_tag(Command):
5315
 
    __doc__ = """Create, remove or modify a tag naming a revision.
 
4980
    """Create, remove or modify a tag naming a revision.
5316
4981
 
5317
4982
    Tags give human-meaningful names to revisions.  Commands that take a -r
5318
4983
    (--revision) option can be given -rtag:X, where X is any previously
5326
4991
 
5327
4992
    To rename a tag (change the name but keep it on the same revsion), run ``bzr
5328
4993
    tag new-name -r tag:old-name`` and then ``bzr tag --delete oldname``.
5329
 
 
5330
 
    If no tag name is specified it will be determined through the 
5331
 
    'automatic_tag_name' hook. This can e.g. be used to automatically tag
5332
 
    upstream releases by reading configure.ac. See ``bzr help hooks`` for
5333
 
    details.
5334
4994
    """
5335
4995
 
5336
4996
    _see_also = ['commit', 'tags']
5337
 
    takes_args = ['tag_name?']
 
4997
    takes_args = ['tag_name']
5338
4998
    takes_options = [
5339
4999
        Option('delete',
5340
5000
            help='Delete this tag rather than placing it.',
5350
5010
        'revision',
5351
5011
        ]
5352
5012
 
5353
 
    def run(self, tag_name=None,
 
5013
    def run(self, tag_name,
5354
5014
            delete=None,
5355
5015
            directory='.',
5356
5016
            force=None,
5358
5018
            ):
5359
5019
        branch, relpath = Branch.open_containing(directory)
5360
5020
        branch.lock_write()
5361
 
        self.add_cleanup(branch.unlock)
5362
 
        if delete:
5363
 
            if tag_name is None:
5364
 
                raise errors.BzrCommandError("No tag specified to delete.")
5365
 
            branch.tags.delete_tag(tag_name)
5366
 
            self.outf.write('Deleted tag %s.\n' % tag_name)
5367
 
        else:
5368
 
            if revision:
5369
 
                if len(revision) != 1:
5370
 
                    raise errors.BzrCommandError(
5371
 
                        "Tags can only be placed on a single revision, "
5372
 
                        "not on a range")
5373
 
                revision_id = revision[0].as_revision_id(branch)
 
5021
        try:
 
5022
            if delete:
 
5023
                branch.tags.delete_tag(tag_name)
 
5024
                self.outf.write('Deleted tag %s.\n' % tag_name)
5374
5025
            else:
5375
 
                revision_id = branch.last_revision()
5376
 
            if tag_name is None:
5377
 
                tag_name = branch.automatic_tag_name(revision_id)
5378
 
                if tag_name is None:
5379
 
                    raise errors.BzrCommandError(
5380
 
                        "Please specify a tag name.")
5381
 
            if (not force) and branch.tags.has_tag(tag_name):
5382
 
                raise errors.TagAlreadyExists(tag_name)
5383
 
            branch.tags.set_tag(tag_name, revision_id)
5384
 
            self.outf.write('Created tag %s.\n' % tag_name)
 
5026
                if revision:
 
5027
                    if len(revision) != 1:
 
5028
                        raise errors.BzrCommandError(
 
5029
                            "Tags can only be placed on a single revision, "
 
5030
                            "not on a range")
 
5031
                    revision_id = revision[0].as_revision_id(branch)
 
5032
                else:
 
5033
                    revision_id = branch.last_revision()
 
5034
                if (not force) and branch.tags.has_tag(tag_name):
 
5035
                    raise errors.TagAlreadyExists(tag_name)
 
5036
                branch.tags.set_tag(tag_name, revision_id)
 
5037
                self.outf.write('Created tag %s.\n' % tag_name)
 
5038
        finally:
 
5039
            branch.unlock()
5385
5040
 
5386
5041
 
5387
5042
class cmd_tags(Command):
5388
 
    __doc__ = """List tags.
 
5043
    """List tags.
5389
5044
 
5390
5045
    This command shows a table of tag names and the revisions they reference.
5391
5046
    """
5420
5075
            return
5421
5076
 
5422
5077
        branch.lock_read()
5423
 
        self.add_cleanup(branch.unlock)
5424
 
        if revision:
5425
 
            graph = branch.repository.get_graph()
5426
 
            rev1, rev2 = _get_revision_range(revision, branch, self.name())
5427
 
            revid1, revid2 = rev1.rev_id, rev2.rev_id
5428
 
            # only show revisions between revid1 and revid2 (inclusive)
5429
 
            tags = [(tag, revid) for tag, revid in tags if
5430
 
                graph.is_between(revid, revid1, revid2)]
5431
 
        if sort == 'alpha':
5432
 
            tags.sort()
5433
 
        elif sort == 'time':
5434
 
            timestamps = {}
5435
 
            for tag, revid in tags:
5436
 
                try:
5437
 
                    revobj = branch.repository.get_revision(revid)
5438
 
                except errors.NoSuchRevision:
5439
 
                    timestamp = sys.maxint # place them at the end
5440
 
                else:
5441
 
                    timestamp = revobj.timestamp
5442
 
                timestamps[revid] = timestamp
5443
 
            tags.sort(key=lambda x: timestamps[x[1]])
5444
 
        if not show_ids:
5445
 
            # [ (tag, revid), ... ] -> [ (tag, dotted_revno), ... ]
5446
 
            for index, (tag, revid) in enumerate(tags):
5447
 
                try:
5448
 
                    revno = branch.revision_id_to_dotted_revno(revid)
5449
 
                    if isinstance(revno, tuple):
5450
 
                        revno = '.'.join(map(str, revno))
5451
 
                except errors.NoSuchRevision:
5452
 
                    # Bad tag data/merges can lead to tagged revisions
5453
 
                    # which are not in this branch. Fail gracefully ...
5454
 
                    revno = '?'
5455
 
                tags[index] = (tag, revno)
5456
 
        self.cleanup_now()
 
5078
        try:
 
5079
            if revision:
 
5080
                graph = branch.repository.get_graph()
 
5081
                rev1, rev2 = _get_revision_range(revision, branch, self.name())
 
5082
                revid1, revid2 = rev1.rev_id, rev2.rev_id
 
5083
                # only show revisions between revid1 and revid2 (inclusive)
 
5084
                tags = [(tag, revid) for tag, revid in tags if
 
5085
                    graph.is_between(revid, revid1, revid2)]
 
5086
            if sort == 'alpha':
 
5087
                tags.sort()
 
5088
            elif sort == 'time':
 
5089
                timestamps = {}
 
5090
                for tag, revid in tags:
 
5091
                    try:
 
5092
                        revobj = branch.repository.get_revision(revid)
 
5093
                    except errors.NoSuchRevision:
 
5094
                        timestamp = sys.maxint # place them at the end
 
5095
                    else:
 
5096
                        timestamp = revobj.timestamp
 
5097
                    timestamps[revid] = timestamp
 
5098
                tags.sort(key=lambda x: timestamps[x[1]])
 
5099
            if not show_ids:
 
5100
                # [ (tag, revid), ... ] -> [ (tag, dotted_revno), ... ]
 
5101
                for index, (tag, revid) in enumerate(tags):
 
5102
                    try:
 
5103
                        revno = branch.revision_id_to_dotted_revno(revid)
 
5104
                        if isinstance(revno, tuple):
 
5105
                            revno = '.'.join(map(str, revno))
 
5106
                    except errors.NoSuchRevision:
 
5107
                        # Bad tag data/merges can lead to tagged revisions
 
5108
                        # which are not in this branch. Fail gracefully ...
 
5109
                        revno = '?'
 
5110
                    tags[index] = (tag, revno)
 
5111
        finally:
 
5112
            branch.unlock()
5457
5113
        for tag, revspec in tags:
5458
5114
            self.outf.write('%-20s %s\n' % (tag, revspec))
5459
5115
 
5460
5116
 
5461
5117
class cmd_reconfigure(Command):
5462
 
    __doc__ = """Reconfigure the type of a bzr directory.
 
5118
    """Reconfigure the type of a bzr directory.
5463
5119
 
5464
5120
    A target configuration must be specified.
5465
5121
 
5495
5151
            ),
5496
5152
        Option('bind-to', help='Branch to bind checkout to.', type=str),
5497
5153
        Option('force',
5498
 
            help='Perform reconfiguration even if local changes'
5499
 
            ' will be lost.'),
5500
 
        Option('stacked-on',
5501
 
            help='Reconfigure a branch to be stacked on another branch.',
5502
 
            type=unicode,
5503
 
            ),
5504
 
        Option('unstacked',
5505
 
            help='Reconfigure a branch to be unstacked.  This '
5506
 
                'may require copying substantial data into it.',
5507
 
            ),
 
5154
               help='Perform reconfiguration even if local changes'
 
5155
               ' will be lost.')
5508
5156
        ]
5509
5157
 
5510
 
    def run(self, location=None, target_type=None, bind_to=None, force=False,
5511
 
            stacked_on=None,
5512
 
            unstacked=None):
 
5158
    def run(self, location=None, target_type=None, bind_to=None, force=False):
5513
5159
        directory = bzrdir.BzrDir.open(location)
5514
 
        if stacked_on and unstacked:
5515
 
            raise BzrCommandError("Can't use both --stacked-on and --unstacked")
5516
 
        elif stacked_on is not None:
5517
 
            reconfigure.ReconfigureStackedOn().apply(directory, stacked_on)
5518
 
        elif unstacked:
5519
 
            reconfigure.ReconfigureUnstacked().apply(directory)
5520
 
        # At the moment you can use --stacked-on and a different
5521
 
        # reconfiguration shape at the same time; there seems no good reason
5522
 
        # to ban it.
5523
5160
        if target_type is None:
5524
 
            if stacked_on or unstacked:
5525
 
                return
5526
 
            else:
5527
 
                raise errors.BzrCommandError('No target configuration '
5528
 
                    'specified')
 
5161
            raise errors.BzrCommandError('No target configuration specified')
5529
5162
        elif target_type == 'branch':
5530
5163
            reconfiguration = reconfigure.Reconfigure.to_branch(directory)
5531
5164
        elif target_type == 'tree':
5550
5183
 
5551
5184
 
5552
5185
class cmd_switch(Command):
5553
 
    __doc__ = """Set the branch of a checkout and update.
 
5186
    """Set the branch of a checkout and update.
5554
5187
 
5555
5188
    For lightweight checkouts, this changes the branch being referenced.
5556
5189
    For heavyweight checkouts, this checks that there are no local commits
5568
5201
    /path/to/newbranch.
5569
5202
 
5570
5203
    Bound branches use the nickname of its master branch unless it is set
5571
 
    locally, in which case switching will update the local nickname to be
 
5204
    locally, in which case switching will update the the local nickname to be
5572
5205
    that of the master.
5573
5206
    """
5574
5207
 
5575
 
    takes_args = ['to_location?']
 
5208
    takes_args = ['to_location']
5576
5209
    takes_options = [Option('force',
5577
 
                        help='Switch even if local commits will be lost.'),
5578
 
                     'revision',
5579
 
                     Option('create-branch', short_name='b',
5580
 
                        help='Create the target branch from this one before'
5581
 
                             ' switching to it.'),
5582
 
                    ]
 
5210
                        help='Switch even if local commits will be lost.')
 
5211
                     ]
5583
5212
 
5584
 
    def run(self, to_location=None, force=False, create_branch=False,
5585
 
            revision=None):
 
5213
    def run(self, to_location, force=False):
5586
5214
        from bzrlib import switch
5587
5215
        tree_location = '.'
5588
 
        revision = _get_one_revision('switch', revision)
5589
5216
        control_dir = bzrdir.BzrDir.open_containing(tree_location)[0]
5590
 
        if to_location is None:
5591
 
            if revision is None:
5592
 
                raise errors.BzrCommandError('You must supply either a'
5593
 
                                             ' revision or a location')
5594
 
            to_location = '.'
5595
5217
        try:
5596
5218
            branch = control_dir.open_branch()
5597
5219
            had_explicit_nick = branch.get_config().has_explicit_nickname()
5598
5220
        except errors.NotBranchError:
5599
 
            branch = None
5600
5221
            had_explicit_nick = False
5601
 
        if create_branch:
5602
 
            if branch is None:
5603
 
                raise errors.BzrCommandError('cannot create branch without'
5604
 
                                             ' source branch')
5605
 
            to_location = directory_service.directories.dereference(
5606
 
                              to_location)
5607
 
            if '/' not in to_location and '\\' not in to_location:
5608
 
                # This path is meant to be relative to the existing branch
5609
 
                this_url = self._get_branch_location(control_dir)
5610
 
                to_location = urlutils.join(this_url, '..', to_location)
5611
 
            to_branch = branch.bzrdir.sprout(to_location,
5612
 
                                 possible_transports=[branch.bzrdir.root_transport],
5613
 
                                 source_branch=branch).open_branch()
5614
 
        else:
5615
 
            try:
5616
 
                to_branch = Branch.open(to_location)
5617
 
            except errors.NotBranchError:
5618
 
                this_url = self._get_branch_location(control_dir)
5619
 
                to_branch = Branch.open(
5620
 
                    urlutils.join(this_url, '..', to_location))
5621
 
        if revision is not None:
5622
 
            revision = revision.as_revision_id(to_branch)
5623
 
        switch.switch(control_dir, to_branch, force, revision_id=revision)
 
5222
        try:
 
5223
            to_branch = Branch.open(to_location)
 
5224
        except errors.NotBranchError:
 
5225
            this_url = self._get_branch_location(control_dir)
 
5226
            to_branch = Branch.open(
 
5227
                urlutils.join(this_url, '..', to_location))
 
5228
        switch.switch(control_dir, to_branch, force)
5624
5229
        if had_explicit_nick:
5625
5230
            branch = control_dir.open_branch() #get the new branch!
5626
5231
            branch.nick = to_branch.nick
5646
5251
 
5647
5252
 
5648
5253
class cmd_view(Command):
5649
 
    __doc__ = """Manage filtered views.
 
5254
    """Manage filtered views.
5650
5255
 
5651
5256
    Views provide a mask over the tree so that users can focus on
5652
5257
    a subset of a tree when doing their work. After creating a view,
5800
5405
 
5801
5406
 
5802
5407
class cmd_hooks(Command):
5803
 
    __doc__ = """Show hooks."""
 
5408
    """Show hooks."""
5804
5409
 
5805
5410
    hidden = True
5806
5411
 
5819
5424
                    self.outf.write("    <no hooks installed>\n")
5820
5425
 
5821
5426
 
5822
 
class cmd_remove_branch(Command):
5823
 
    __doc__ = """Remove a branch.
5824
 
 
5825
 
    This will remove the branch from the specified location but 
5826
 
    will keep any working tree or repository in place.
5827
 
 
5828
 
    :Examples:
5829
 
 
5830
 
      Remove the branch at repo/trunk::
5831
 
 
5832
 
        bzr remove-branch repo/trunk
5833
 
 
5834
 
    """
5835
 
 
5836
 
    takes_args = ["location?"]
5837
 
 
5838
 
    aliases = ["rmbranch"]
5839
 
 
5840
 
    def run(self, location=None):
5841
 
        if location is None:
5842
 
            location = "."
5843
 
        branch = Branch.open_containing(location)[0]
5844
 
        branch.bzrdir.destroy_branch()
5845
 
        
5846
 
 
5847
5427
class cmd_shelve(Command):
5848
 
    __doc__ = """Temporarily set aside some changes from the current tree.
 
5428
    """Temporarily set aside some changes from the current tree.
5849
5429
 
5850
5430
    Shelve allows you to temporarily put changes you've made "on the shelf",
5851
5431
    ie. out of the way, until a later time when you can bring them back from
5893
5473
        if writer is None:
5894
5474
            writer = bzrlib.option.diff_writer_registry.get()
5895
5475
        try:
5896
 
            shelver = Shelver.from_args(writer(sys.stdout), revision, all,
5897
 
                file_list, message, destroy=destroy)
5898
 
            try:
5899
 
                shelver.run()
5900
 
            finally:
5901
 
                shelver.finalize()
 
5476
            Shelver.from_args(writer(sys.stdout), revision, all, file_list,
 
5477
                              message, destroy=destroy).run()
5902
5478
        except errors.UserAbort:
5903
5479
            return 0
5904
5480
 
5905
5481
    def run_for_list(self):
5906
5482
        tree = WorkingTree.open_containing('.')[0]
5907
5483
        tree.lock_read()
5908
 
        self.add_cleanup(tree.unlock)
5909
 
        manager = tree.get_shelf_manager()
5910
 
        shelves = manager.active_shelves()
5911
 
        if len(shelves) == 0:
5912
 
            note('No shelved changes.')
5913
 
            return 0
5914
 
        for shelf_id in reversed(shelves):
5915
 
            message = manager.get_metadata(shelf_id).get('message')
5916
 
            if message is None:
5917
 
                message = '<no message>'
5918
 
            self.outf.write('%3d: %s\n' % (shelf_id, message))
5919
 
        return 1
 
5484
        try:
 
5485
            manager = tree.get_shelf_manager()
 
5486
            shelves = manager.active_shelves()
 
5487
            if len(shelves) == 0:
 
5488
                note('No shelved changes.')
 
5489
                return 0
 
5490
            for shelf_id in reversed(shelves):
 
5491
                message = manager.get_metadata(shelf_id).get('message')
 
5492
                if message is None:
 
5493
                    message = '<no message>'
 
5494
                self.outf.write('%3d: %s\n' % (shelf_id, message))
 
5495
            return 1
 
5496
        finally:
 
5497
            tree.unlock()
5920
5498
 
5921
5499
 
5922
5500
class cmd_unshelve(Command):
5923
 
    __doc__ = """Restore shelved changes.
 
5501
    """Restore shelved changes.
5924
5502
 
5925
5503
    By default, the most recently shelved changes are restored. However if you
5926
5504
    specify a shelf by id those changes will be restored instead.  This works
5934
5512
            enum_switch=False, value_switches=True,
5935
5513
            apply="Apply changes and remove from the shelf.",
5936
5514
            dry_run="Show changes, but do not apply or remove them.",
5937
 
            preview="Instead of unshelving the changes, show the diff that "
5938
 
                    "would result from unshelving.",
5939
 
            delete_only="Delete changes without applying them.",
5940
 
            keep="Apply changes but don't delete them.",
 
5515
            delete_only="Delete changes without applying them."
5941
5516
        )
5942
5517
    ]
5943
5518
    _see_also = ['shelve']
5944
5519
 
5945
5520
    def run(self, shelf_id=None, action='apply'):
5946
5521
        from bzrlib.shelf_ui import Unshelver
5947
 
        unshelver = Unshelver.from_args(shelf_id, action)
5948
 
        try:
5949
 
            unshelver.run()
5950
 
        finally:
5951
 
            unshelver.tree.unlock()
 
5522
        Unshelver.from_args(shelf_id, action).run()
5952
5523
 
5953
5524
 
5954
5525
class cmd_clean_tree(Command):
5955
 
    __doc__ = """Remove unwanted files from working tree.
 
5526
    """Remove unwanted files from working tree.
5956
5527
 
5957
5528
    By default, only unknown files, not ignored files, are deleted.  Versioned
5958
5529
    files are never deleted.
5986
5557
 
5987
5558
 
5988
5559
class cmd_reference(Command):
5989
 
    __doc__ = """list, view and set branch locations for nested trees.
 
5560
    """list, view and set branch locations for nested trees.
5990
5561
 
5991
5562
    If no arguments are provided, lists the branch locations for nested trees.
5992
5563
    If one argument is provided, display the branch location for that tree.
6032
5603
            self.outf.write('%s %s\n' % (path, location))
6033
5604
 
6034
5605
 
6035
 
def _register_lazy_builtins():
6036
 
    # register lazy builtins from other modules; called at startup and should
6037
 
    # be only called once.
6038
 
    for (name, aliases, module_name) in [
6039
 
        ('cmd_bundle_info', [], 'bzrlib.bundle.commands'),
6040
 
        ('cmd_dpush', [], 'bzrlib.foreign'),
6041
 
        ('cmd_version_info', [], 'bzrlib.cmd_version_info'),
6042
 
        ('cmd_resolve', ['resolved'], 'bzrlib.conflicts'),
6043
 
        ('cmd_conflicts', [], 'bzrlib.conflicts'),
6044
 
        ('cmd_sign_my_commits', [], 'bzrlib.sign_my_commits'),
6045
 
        ]:
6046
 
        builtin_command_registry.register_lazy(name, aliases, module_name)
 
5606
# these get imported and then picked up by the scan for cmd_*
 
5607
# TODO: Some more consistent way to split command definitions across files;
 
5608
# we do need to load at least some information about them to know of
 
5609
# aliases.  ideally we would avoid loading the implementation until the
 
5610
# details were needed.
 
5611
from bzrlib.cmd_version_info import cmd_version_info
 
5612
from bzrlib.conflicts import cmd_resolve, cmd_conflicts, restore
 
5613
from bzrlib.bundle.commands import (
 
5614
    cmd_bundle_info,
 
5615
    )
 
5616
from bzrlib.foreign import cmd_dpush
 
5617
from bzrlib.sign_my_commits import cmd_sign_my_commits
 
5618
from bzrlib.weave_commands import cmd_versionedfile_list, \
 
5619
        cmd_weave_plan_merge, cmd_weave_merge_text