~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/builtins.py

  • Committer: Vincent Ladeuil
  • Date: 2010-04-26 13:51:08 UTC
  • mto: (5184.2.1 integration)
  • mto: This revision was merged to the branch mainline in revision 5185.
  • Revision ID: v.ladeuil+lp@free.fr-20100426135108-vwmfphc2xg1w058c
Random cleanups to catch up with copyright updates in trunk.

Show diffs side-by-side

added added

removed removed

Lines of Context:
1
 
# Copyright (C) 2004, 2005, 2006, 2007, 2008, 2009 Canonical Ltd
 
1
# Copyright (C) 2005-2010 Canonical Ltd
2
2
#
3
3
# This program is free software; you can redistribute it and/or modify
4
4
# it under the terms of the GNU General Public License as published by
31
31
    bundle,
32
32
    btree_index,
33
33
    bzrdir,
 
34
    directory_service,
34
35
    delta,
35
36
    config,
36
37
    errors,
43
44
    reconfigure,
44
45
    rename_map,
45
46
    revision as _mod_revision,
 
47
    static_tuple,
46
48
    symbol_versioning,
 
49
    timestamp,
47
50
    transport,
48
 
    tree as _mod_tree,
49
51
    ui,
50
52
    urlutils,
51
53
    views,
52
54
    )
53
55
from bzrlib.branch import Branch
54
56
from bzrlib.conflicts import ConflictList
 
57
from bzrlib.transport import memory
55
58
from bzrlib.revisionspec import RevisionSpec, RevisionInfo
56
59
from bzrlib.smtp_connection import SMTPConnection
57
60
from bzrlib.workingtree import WorkingTree
58
61
""")
59
62
 
60
 
from bzrlib.commands import Command, display_command
 
63
from bzrlib.commands import (
 
64
    Command,
 
65
    builtin_command_registry,
 
66
    display_command,
 
67
    )
61
68
from bzrlib.option import (
62
69
    ListOption,
63
70
    Option,
79
86
 
80
87
 
81
88
def tree_files_for_add(file_list):
82
 
    """Add handles files a bit differently so it a custom implementation."""
 
89
    """
 
90
    Return a tree and list of absolute paths from a file list.
 
91
 
 
92
    Similar to tree_files, but add handles files a bit differently, so it a
 
93
    custom implementation.  In particular, MutableTreeTree.smart_add expects
 
94
    absolute paths, which it immediately converts to relative paths.
 
95
    """
 
96
    # FIXME Would be nice to just return the relative paths like
 
97
    # internal_tree_files does, but there are a large number of unit tests
 
98
    # that assume the current interface to mutabletree.smart_add
83
99
    if file_list:
84
 
        tree = WorkingTree.open_containing(file_list[0])[0]
 
100
        tree, relpath = WorkingTree.open_containing(file_list[0])
85
101
        if tree.supports_views():
86
102
            view_files = tree.views.lookup_view()
87
103
            if view_files:
88
104
                for filename in file_list:
89
105
                    if not osutils.is_inside_any(view_files, filename):
90
106
                        raise errors.FileOutsideView(filename, view_files)
 
107
        file_list = file_list[:]
 
108
        file_list[0] = tree.abspath(relpath)
91
109
    else:
92
110
        tree = WorkingTree.open_containing(u'.')[0]
93
111
        if tree.supports_views():
95
113
            if view_files:
96
114
                file_list = view_files
97
115
                view_str = views.view_display_str(view_files)
98
 
                note("ignoring files outside view: %s" % view_str)
 
116
                note("Ignoring files outside view. View is %s" % view_str)
99
117
    return tree, file_list
100
118
 
101
119
 
110
128
 
111
129
 
112
130
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
    """
113
140
    if branch is None:
114
141
        branch = tree.branch
115
142
    if revisions is None:
151
178
            if view_files:
152
179
                file_list = view_files
153
180
                view_str = views.view_display_str(view_files)
154
 
                note("ignoring files outside view: %s" % view_str)
 
181
                note("Ignoring files outside view. View is %s" % view_str)
155
182
        return tree, file_list
156
183
    tree = WorkingTree.open_containing(osutils.realpath(file_list[0]))[0]
157
184
    return tree, safe_relpath_files(tree, file_list, canonicalize,
212
239
# opens the branch?)
213
240
 
214
241
class cmd_status(Command):
215
 
    """Display status summary.
 
242
    __doc__ = """Display status summary.
216
243
 
217
244
    This reports on versioned and unknown files, reporting them
218
245
    grouped by state.  Possible states are:
238
265
    unknown
239
266
        Not versioned and not matching an ignore pattern.
240
267
 
 
268
    Additionally for directories, symlinks and files with an executable
 
269
    bit, Bazaar indicates their type using a trailing character: '/', '@'
 
270
    or '*' respectively.
 
271
 
241
272
    To see ignored files use 'bzr ignored'.  For details on the
242
273
    changes to file texts, use 'bzr diff'.
243
274
 
301
332
 
302
333
 
303
334
class cmd_cat_revision(Command):
304
 
    """Write out metadata for a revision.
 
335
    __doc__ = """Write out metadata for a revision.
305
336
 
306
337
    The revision to print can either be specified by a specific
307
338
    revision identifier, or you can use --revision.
313
344
    # cat-revision is more for frontends so should be exact
314
345
    encoding = 'strict'
315
346
 
 
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
 
316
355
    @display_command
317
356
    def run(self, revision_id=None, revision=None):
318
357
        if revision_id is not None and revision is not None:
323
362
                                         ' --revision or a revision_id')
324
363
        b = WorkingTree.open_containing(u'.')[0].branch
325
364
 
326
 
        # TODO: jam 20060112 should cat-revision always output utf-8?
327
 
        if revision_id is not None:
328
 
            revision_id = osutils.safe_revision_id(revision_id, warn=False)
329
 
            try:
330
 
                self.outf.write(b.repository.get_revision_xml(revision_id).decode('utf-8'))
331
 
            except errors.NoSuchRevision:
332
 
                msg = "The repository %s contains no revision %s." % (b.repository.base,
333
 
                    revision_id)
334
 
                raise errors.BzrCommandError(msg)
335
 
        elif revision is not None:
336
 
            for rev in revision:
337
 
                if rev is None:
338
 
                    raise errors.BzrCommandError('You cannot specify a NULL'
339
 
                                                 ' revision.')
340
 
                rev_id = rev.as_revision_id(b)
341
 
                self.outf.write(b.repository.get_revision_xml(rev_id).decode('utf-8'))
 
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')
342
369
 
 
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
        
343
391
 
344
392
class cmd_dump_btree(Command):
345
 
    """Dump the contents of a btree index file to stdout.
 
393
    __doc__ = """Dump the contents of a btree index file to stdout.
346
394
 
347
395
    PATH is a btree index file, it can be any URL. This includes things like
348
396
    .bzr/repository/pack-names, or .bzr/repository/indices/a34b3a...ca4a4.iix
412
460
        for node in bt.iter_all_entries():
413
461
            # Node is made up of:
414
462
            # (index, key, value, [references])
415
 
            self.outf.write('%s\n' % (node[1:],))
 
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,))
416
471
 
417
472
 
418
473
class cmd_remove_tree(Command):
419
 
    """Remove the working tree from a given branch/checkout.
 
474
    __doc__ = """Remove the working tree from a given branch/checkout.
420
475
 
421
476
    Since a lightweight checkout is little more than a working tree
422
477
    this will refuse to run against one.
424
479
    To re-create the working tree, use "bzr checkout".
425
480
    """
426
481
    _see_also = ['checkout', 'working-trees']
427
 
    takes_args = ['location?']
 
482
    takes_args = ['location*']
428
483
    takes_options = [
429
484
        Option('force',
430
485
               help='Remove the working tree even if it has '
431
486
                    'uncommitted changes.'),
432
487
        ]
433
488
 
434
 
    def run(self, location='.', force=False):
435
 
        d = bzrdir.BzrDir.open(location)
436
 
 
437
 
        try:
438
 
            working = d.open_workingtree()
439
 
        except errors.NoWorkingTree:
440
 
            raise errors.BzrCommandError("No working tree to remove")
441
 
        except errors.NotLocalUrl:
442
 
            raise errors.BzrCommandError("You cannot remove the working tree of a "
443
 
                                         "remote path")
444
 
        if not force:
445
 
            changes = working.changes_from(working.basis_tree())
446
 
            if changes.has_changed():
447
 
                raise errors.UncommittedChanges(working)
448
 
 
449
 
        working_path = working.bzrdir.root_transport.base
450
 
        branch_path = working.branch.bzrdir.root_transport.base
451
 
        if working_path != branch_path:
452
 
            raise errors.BzrCommandError("You cannot remove the working tree from "
453
 
                                         "a lightweight checkout")
454
 
 
455
 
        d.destroy_workingtree()
 
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
            working_path = working.bzrdir.root_transport.base
 
508
            branch_path = working.branch.bzrdir.root_transport.base
 
509
            if working_path != branch_path:
 
510
                raise errors.BzrCommandError("You cannot remove the working tree"
 
511
                                             " from a lightweight checkout")
 
512
 
 
513
            d.destroy_workingtree()
456
514
 
457
515
 
458
516
class cmd_revno(Command):
459
 
    """Show current revision number.
 
517
    __doc__ = """Show current revision number.
460
518
 
461
519
    This is equal to the number of revisions on this branch.
462
520
    """
463
521
 
464
522
    _see_also = ['info']
465
523
    takes_args = ['location?']
 
524
    takes_options = [
 
525
        Option('tree', help='Show revno of working tree'),
 
526
        ]
466
527
 
467
528
    @display_command
468
 
    def run(self, location=u'.'):
469
 
        self.outf.write(str(Branch.open_containing(location)[0].revno()))
470
 
        self.outf.write('\n')
 
529
    def run(self, tree=False, location=u'.'):
 
530
        if tree:
 
531
            try:
 
532
                wt = WorkingTree.open_containing(location)[0]
 
533
                wt.lock_read()
 
534
            except (errors.NoWorkingTree, errors.NotLocalUrl):
 
535
                raise errors.NoWorkingTree(location)
 
536
            self.add_cleanup(wt.unlock)
 
537
            revid = wt.last_revision()
 
538
            try:
 
539
                revno_t = wt.branch.revision_id_to_dotted_revno(revid)
 
540
            except errors.NoSuchRevision:
 
541
                revno_t = ('???',)
 
542
            revno = ".".join(str(n) for n in revno_t)
 
543
        else:
 
544
            b = Branch.open_containing(location)[0]
 
545
            b.lock_read()
 
546
            self.add_cleanup(b.unlock)
 
547
            revno = b.revno()
 
548
        self.cleanup_now()
 
549
        self.outf.write(str(revno) + '\n')
471
550
 
472
551
 
473
552
class cmd_revision_info(Command):
474
 
    """Show revision number and revision id for a given revision identifier.
 
553
    __doc__ = """Show revision number and revision id for a given revision identifier.
475
554
    """
476
555
    hidden = True
477
556
    takes_args = ['revision_info*']
483
562
            short_name='d',
484
563
            type=unicode,
485
564
            ),
 
565
        Option('tree', help='Show revno of working tree'),
486
566
        ]
487
567
 
488
568
    @display_command
489
 
    def run(self, revision=None, directory=u'.', revision_info_list=[]):
 
569
    def run(self, revision=None, directory=u'.', tree=False,
 
570
            revision_info_list=[]):
490
571
 
491
 
        revs = []
 
572
        try:
 
573
            wt = WorkingTree.open_containing(directory)[0]
 
574
            b = wt.branch
 
575
            wt.lock_read()
 
576
            self.add_cleanup(wt.unlock)
 
577
        except (errors.NoWorkingTree, errors.NotLocalUrl):
 
578
            wt = None
 
579
            b = Branch.open_containing(directory)[0]
 
580
            b.lock_read()
 
581
            self.add_cleanup(b.unlock)
 
582
        revision_ids = []
492
583
        if revision is not None:
493
 
            revs.extend(revision)
 
584
            revision_ids.extend(rev.as_revision_id(b) for rev in revision)
494
585
        if revision_info_list is not None:
495
 
            for rev in revision_info_list:
496
 
                revs.append(RevisionSpec.from_string(rev))
497
 
 
498
 
        b = Branch.open_containing(directory)[0]
499
 
 
500
 
        if len(revs) == 0:
501
 
            revs.append(RevisionSpec.from_string('-1'))
502
 
 
503
 
        for rev in revs:
504
 
            revision_id = rev.as_revision_id(b)
 
586
            for rev_str in revision_info_list:
 
587
                rev_spec = RevisionSpec.from_string(rev_str)
 
588
                revision_ids.append(rev_spec.as_revision_id(b))
 
589
        # No arguments supplied, default to the last revision
 
590
        if len(revision_ids) == 0:
 
591
            if tree:
 
592
                if wt is None:
 
593
                    raise errors.NoWorkingTree(directory)
 
594
                revision_ids.append(wt.last_revision())
 
595
            else:
 
596
                revision_ids.append(b.last_revision())
 
597
 
 
598
        revinfos = []
 
599
        maxlen = 0
 
600
        for revision_id in revision_ids:
505
601
            try:
506
 
                revno = '%4d' % (b.revision_id_to_revno(revision_id))
 
602
                dotted_revno = b.revision_id_to_dotted_revno(revision_id)
 
603
                revno = '.'.join(str(i) for i in dotted_revno)
507
604
            except errors.NoSuchRevision:
508
 
                dotted_map = b.get_revision_id_to_revno_map()
509
 
                revno = '.'.join(str(i) for i in dotted_map[revision_id])
510
 
            print '%s %s' % (revno, revision_id)
 
605
                revno = '???'
 
606
            maxlen = max(maxlen, len(revno))
 
607
            revinfos.append([revno, revision_id])
 
608
 
 
609
        self.cleanup_now()
 
610
        for ri in revinfos:
 
611
            self.outf.write('%*s %s\n' % (maxlen, ri[0], ri[1]))
511
612
 
512
613
 
513
614
class cmd_add(Command):
514
 
    """Add specified files or directories.
 
615
    __doc__ = """Add specified files or directories.
515
616
 
516
617
    In non-recursive mode, all the named items are added, regardless
517
618
    of whether they were previously ignored.  A warning is given if
543
644
    branches that will be merged later (without showing the two different
544
645
    adds as a conflict). It is also useful when merging another project
545
646
    into a subdirectory of this one.
 
647
    
 
648
    Any files matching patterns in the ignore list will not be added
 
649
    unless they are explicitly mentioned.
546
650
    """
547
651
    takes_args = ['file*']
548
652
    takes_options = [
556
660
               help='Lookup file ids from this tree.'),
557
661
        ]
558
662
    encoding_type = 'replace'
559
 
    _see_also = ['remove']
 
663
    _see_also = ['remove', 'ignore']
560
664
 
561
665
    def run(self, file_list, no_recurse=False, dry_run=False, verbose=False,
562
666
            file_ids_from=None):
580
684
 
581
685
        if base_tree:
582
686
            base_tree.lock_read()
583
 
        try:
584
 
            file_list = self._maybe_expand_globs(file_list)
585
 
            tree, file_list = tree_files_for_add(file_list)
586
 
            added, ignored = tree.smart_add(file_list, not
587
 
                no_recurse, action=action, save=not dry_run)
588
 
        finally:
589
 
            if base_tree is not None:
590
 
                base_tree.unlock()
 
687
            self.add_cleanup(base_tree.unlock)
 
688
        tree, file_list = tree_files_for_add(file_list)
 
689
        added, ignored = tree.smart_add(file_list, not
 
690
            no_recurse, action=action, save=not dry_run)
 
691
        self.cleanup_now()
591
692
        if len(ignored) > 0:
592
693
            if verbose:
593
694
                for glob in sorted(ignored.keys()):
594
695
                    for path in ignored[glob]:
595
696
                        self.outf.write("ignored %s matching \"%s\"\n"
596
697
                                        % (path, glob))
597
 
            else:
598
 
                match_len = 0
599
 
                for glob, paths in ignored.items():
600
 
                    match_len += len(paths)
601
 
                self.outf.write("ignored %d file(s).\n" % match_len)
602
 
            self.outf.write("If you wish to add some of these files,"
603
 
                            " please add them by name.\n")
604
698
 
605
699
 
606
700
class cmd_mkdir(Command):
607
 
    """Create a new versioned directory.
 
701
    __doc__ = """Create a new versioned directory.
608
702
 
609
703
    This is equivalent to creating the directory and then adding it.
610
704
    """
614
708
 
615
709
    def run(self, dir_list):
616
710
        for d in dir_list:
617
 
            os.mkdir(d)
618
711
            wt, dd = WorkingTree.open_containing(d)
619
 
            wt.add([dd])
620
 
            self.outf.write('added %s\n' % d)
 
712
            base = os.path.dirname(dd)
 
713
            id = wt.path2id(base)
 
714
            if id != None:
 
715
                os.mkdir(d)
 
716
                wt.add([dd])
 
717
                self.outf.write('added %s\n' % d)
 
718
            else:
 
719
                raise errors.NotVersionedError(path=base)
621
720
 
622
721
 
623
722
class cmd_relpath(Command):
624
 
    """Show path of a file relative to root"""
 
723
    __doc__ = """Show path of a file relative to root"""
625
724
 
626
725
    takes_args = ['filename']
627
726
    hidden = True
636
735
 
637
736
 
638
737
class cmd_inventory(Command):
639
 
    """Show inventory of the current working copy or a revision.
 
738
    __doc__ = """Show inventory of the current working copy or a revision.
640
739
 
641
740
    It is possible to limit the output to a particular entry
642
741
    type using the --kind option.  For example: --kind file.
664
763
        revision = _get_one_revision('inventory', revision)
665
764
        work_tree, file_list = tree_files(file_list)
666
765
        work_tree.lock_read()
667
 
        try:
668
 
            if revision is not None:
669
 
                tree = revision.as_tree(work_tree.branch)
670
 
 
671
 
                extra_trees = [work_tree]
672
 
                tree.lock_read()
673
 
            else:
674
 
                tree = work_tree
675
 
                extra_trees = []
676
 
 
677
 
            if file_list is not None:
678
 
                file_ids = tree.paths2ids(file_list, trees=extra_trees,
679
 
                                          require_versioned=True)
680
 
                # find_ids_across_trees may include some paths that don't
681
 
                # exist in 'tree'.
682
 
                entries = sorted((tree.id2path(file_id), tree.inventory[file_id])
683
 
                                 for file_id in file_ids if file_id in tree)
684
 
            else:
685
 
                entries = tree.inventory.entries()
686
 
        finally:
687
 
            tree.unlock()
688
 
            if tree is not work_tree:
689
 
                work_tree.unlock()
690
 
 
 
766
        self.add_cleanup(work_tree.unlock)
 
767
        if revision is not None:
 
768
            tree = revision.as_tree(work_tree.branch)
 
769
 
 
770
            extra_trees = [work_tree]
 
771
            tree.lock_read()
 
772
            self.add_cleanup(tree.unlock)
 
773
        else:
 
774
            tree = work_tree
 
775
            extra_trees = []
 
776
 
 
777
        if file_list is not None:
 
778
            file_ids = tree.paths2ids(file_list, trees=extra_trees,
 
779
                                      require_versioned=True)
 
780
            # find_ids_across_trees may include some paths that don't
 
781
            # exist in 'tree'.
 
782
            entries = sorted((tree.id2path(file_id), tree.inventory[file_id])
 
783
                             for file_id in file_ids if file_id in tree)
 
784
        else:
 
785
            entries = tree.inventory.entries()
 
786
 
 
787
        self.cleanup_now()
691
788
        for path, entry in entries:
692
789
            if kind and kind != entry.kind:
693
790
                continue
699
796
 
700
797
 
701
798
class cmd_mv(Command):
702
 
    """Move or rename a file.
 
799
    __doc__ = """Move or rename a file.
703
800
 
704
801
    :Usage:
705
802
        bzr mv OLDNAME NEWNAME
722
819
    takes_args = ['names*']
723
820
    takes_options = [Option("after", help="Move only the bzr identifier"
724
821
        " of the file, because the file has already been moved."),
 
822
        Option('auto', help='Automatically guess renames.'),
 
823
        Option('dry-run', help='Avoid making changes when guessing renames.'),
725
824
        ]
726
825
    aliases = ['move', 'rename']
727
826
    encoding_type = 'replace'
728
827
 
729
 
    def run(self, names_list, after=False):
 
828
    def run(self, names_list, after=False, auto=False, dry_run=False):
 
829
        if auto:
 
830
            return self.run_auto(names_list, after, dry_run)
 
831
        elif dry_run:
 
832
            raise errors.BzrCommandError('--dry-run requires --auto.')
730
833
        if names_list is None:
731
834
            names_list = []
732
 
 
733
835
        if len(names_list) < 2:
734
836
            raise errors.BzrCommandError("missing file argument")
735
837
        tree, rel_names = tree_files(names_list, canonicalize=False)
736
 
        tree.lock_write()
737
 
        try:
738
 
            self._run(tree, names_list, rel_names, after)
739
 
        finally:
740
 
            tree.unlock()
 
838
        tree.lock_tree_write()
 
839
        self.add_cleanup(tree.unlock)
 
840
        self._run(tree, names_list, rel_names, after)
 
841
 
 
842
    def run_auto(self, names_list, after, dry_run):
 
843
        if names_list is not None and len(names_list) > 1:
 
844
            raise errors.BzrCommandError('Only one path may be specified to'
 
845
                                         ' --auto.')
 
846
        if after:
 
847
            raise errors.BzrCommandError('--after cannot be specified with'
 
848
                                         ' --auto.')
 
849
        work_tree, file_list = tree_files(names_list, default_branch='.')
 
850
        work_tree.lock_tree_write()
 
851
        self.add_cleanup(work_tree.unlock)
 
852
        rename_map.RenameMap.guess_renames(work_tree, dry_run)
741
853
 
742
854
    def _run(self, tree, names_list, rel_names, after):
743
855
        into_existing = osutils.isdir(names_list[-1])
764
876
            # All entries reference existing inventory items, so fix them up
765
877
            # for cicp file-systems.
766
878
            rel_names = tree.get_canonical_inventory_paths(rel_names)
767
 
            for pair in tree.move(rel_names[:-1], rel_names[-1], after=after):
768
 
                self.outf.write("%s => %s\n" % pair)
 
879
            for src, dest in tree.move(rel_names[:-1], rel_names[-1], after=after):
 
880
                if not is_quiet():
 
881
                    self.outf.write("%s => %s\n" % (src, dest))
769
882
        else:
770
883
            if len(names_list) != 2:
771
884
                raise errors.BzrCommandError('to mv multiple files the'
815
928
            dest = osutils.pathjoin(dest_parent, dest_tail)
816
929
            mutter("attempting to move %s => %s", src, dest)
817
930
            tree.rename_one(src, dest, after=after)
818
 
            self.outf.write("%s => %s\n" % (src, dest))
 
931
            if not is_quiet():
 
932
                self.outf.write("%s => %s\n" % (src, dest))
819
933
 
820
934
 
821
935
class cmd_pull(Command):
822
 
    """Turn this branch into a mirror of another branch.
 
936
    __doc__ = """Turn this branch into a mirror of another branch.
823
937
 
824
 
    This command only works on branches that have not diverged.  Branches are
825
 
    considered diverged if the destination branch's most recent commit is one
826
 
    that has not been merged (directly or indirectly) into the parent.
 
938
    By default, this command only works on branches that have not diverged.
 
939
    Branches are considered diverged if the destination branch's most recent 
 
940
    commit is one that has not been merged (directly or indirectly) into the 
 
941
    parent.
827
942
 
828
943
    If branches have diverged, you can use 'bzr merge' to integrate the changes
829
944
    from one into the other.  Once one branch has merged, the other should
830
945
    be able to pull it again.
831
946
 
832
 
    If you want to forget your local changes and just update your branch to
833
 
    match the remote one, use pull --overwrite.
 
947
    If you want to replace your local changes and just want your branch to
 
948
    match the remote one, use pull --overwrite. This will work even if the two
 
949
    branches have diverged.
834
950
 
835
951
    If there is no default location set, the first pull will set it.  After
836
952
    that, you can omit the location to use the default.  To change the
852
968
            short_name='d',
853
969
            type=unicode,
854
970
            ),
 
971
        Option('local',
 
972
            help="Perform a local pull in a bound "
 
973
                 "branch.  Local pulls are not applied to "
 
974
                 "the master branch."
 
975
            ),
855
976
        ]
856
977
    takes_args = ['location?']
857
978
    encoding_type = 'replace'
858
979
 
859
980
    def run(self, location=None, remember=False, overwrite=False,
860
981
            revision=None, verbose=False,
861
 
            directory=None):
 
982
            directory=None, local=False):
862
983
        # FIXME: too much stuff is in the command class
863
984
        revision_id = None
864
985
        mergeable = None
867
988
        try:
868
989
            tree_to = WorkingTree.open_containing(directory)[0]
869
990
            branch_to = tree_to.branch
 
991
            tree_to.lock_write()
 
992
            self.add_cleanup(tree_to.unlock)
870
993
        except errors.NoWorkingTree:
871
994
            tree_to = None
872
995
            branch_to = Branch.open_containing(directory)[0]
 
996
            branch_to.lock_write()
 
997
            self.add_cleanup(branch_to.unlock)
 
998
 
 
999
        if local and not branch_to.get_bound_location():
 
1000
            raise errors.LocalRequiresBoundBranch()
873
1001
 
874
1002
        possible_transports = []
875
1003
        if location is not None:
903
1031
        else:
904
1032
            branch_from = Branch.open(location,
905
1033
                possible_transports=possible_transports)
 
1034
            branch_from.lock_read()
 
1035
            self.add_cleanup(branch_from.unlock)
906
1036
 
907
1037
            if branch_to.get_parent() is None or remember:
908
1038
                branch_to.set_parent(branch_from.base)
910
1040
        if revision is not None:
911
1041
            revision_id = revision.as_revision_id(branch_from)
912
1042
 
913
 
        branch_to.lock_write()
914
 
        try:
915
 
            if tree_to is not None:
916
 
                view_info = _get_view_info_for_change_reporter(tree_to)
917
 
                change_reporter = delta._ChangeReporter(
918
 
                    unversioned_filter=tree_to.is_ignored, view_info=view_info)
919
 
                result = tree_to.pull(branch_from, overwrite, revision_id,
920
 
                                      change_reporter,
921
 
                                      possible_transports=possible_transports)
922
 
            else:
923
 
                result = branch_to.pull(branch_from, overwrite, revision_id)
 
1043
        if tree_to is not None:
 
1044
            view_info = _get_view_info_for_change_reporter(tree_to)
 
1045
            change_reporter = delta._ChangeReporter(
 
1046
                unversioned_filter=tree_to.is_ignored,
 
1047
                view_info=view_info)
 
1048
            result = tree_to.pull(
 
1049
                branch_from, overwrite, revision_id, change_reporter,
 
1050
                possible_transports=possible_transports, local=local)
 
1051
        else:
 
1052
            result = branch_to.pull(
 
1053
                branch_from, overwrite, revision_id, local=local)
924
1054
 
925
 
            result.report(self.outf)
926
 
            if verbose and result.old_revid != result.new_revid:
927
 
                log.show_branch_change(branch_to, self.outf, result.old_revno,
928
 
                                       result.old_revid)
929
 
        finally:
930
 
            branch_to.unlock()
 
1055
        result.report(self.outf)
 
1056
        if verbose and result.old_revid != result.new_revid:
 
1057
            log.show_branch_change(
 
1058
                branch_to, self.outf, result.old_revno,
 
1059
                result.old_revid)
931
1060
 
932
1061
 
933
1062
class cmd_push(Command):
934
 
    """Update a mirror of this branch.
 
1063
    __doc__ = """Update a mirror of this branch.
935
1064
 
936
1065
    The target branch will not have its working tree populated because this
937
1066
    is both expensive, and is not supported on remote file systems.
980
1109
                'for the commit history. Only the work not present in the '
981
1110
                'referenced branch is included in the branch created.',
982
1111
            type=unicode),
 
1112
        Option('strict',
 
1113
               help='Refuse to push if there are uncommitted changes in'
 
1114
               ' the working tree, --no-strict disables the check.'),
983
1115
        ]
984
1116
    takes_args = ['location?']
985
1117
    encoding_type = 'replace'
987
1119
    def run(self, location=None, remember=False, overwrite=False,
988
1120
        create_prefix=False, verbose=False, revision=None,
989
1121
        use_existing_dir=False, directory=None, stacked_on=None,
990
 
        stacked=False):
 
1122
        stacked=False, strict=None):
991
1123
        from bzrlib.push import _show_push_branch
992
1124
 
993
 
        # Get the source branch and revision_id
994
1125
        if directory is None:
995
1126
            directory = '.'
996
 
        br_from = Branch.open_containing(directory)[0]
 
1127
        # Get the source branch
 
1128
        (tree, br_from,
 
1129
         _unused) = bzrdir.BzrDir.open_containing_tree_or_branch(directory)
 
1130
        # Get the tip's revision_id
997
1131
        revision = _get_one_revision('push', revision)
998
1132
        if revision is not None:
999
1133
            revision_id = revision.in_history(br_from).rev_id
1000
1134
        else:
1001
 
            revision_id = br_from.last_revision()
1002
 
 
 
1135
            revision_id = None
 
1136
        if tree is not None and revision_id is None:
 
1137
            tree.warn_if_changed_or_out_of_date(
 
1138
                strict, 'push_strict', 'Use --no-strict to force the push.')
1003
1139
        # Get the stacked_on branch, if any
1004
1140
        if stacked_on is not None:
1005
1141
            stacked_on = urlutils.normalize_url(stacked_on)
1037
1173
 
1038
1174
 
1039
1175
class cmd_branch(Command):
1040
 
    """Create a new copy of a branch.
 
1176
    __doc__ = """Create a new branch that is a copy of an existing branch.
1041
1177
 
1042
1178
    If the TO_LOCATION is omitted, the last component of the FROM_LOCATION will
1043
1179
    be used.  In other words, "branch ../foo/bar" will attempt to create ./bar.
1056
1192
        help='Hard-link working tree files where possible.'),
1057
1193
        Option('no-tree',
1058
1194
            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."),
1059
1198
        Option('stacked',
1060
1199
            help='Create a stacked branch referring to the source branch. '
1061
1200
                'The new branch will depend on the availability of the source '
1062
1201
                'branch for all operations.'),
1063
1202
        Option('standalone',
1064
1203
               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."),
1065
1211
        ]
1066
1212
    aliases = ['get', 'clone']
1067
1213
 
1068
1214
    def run(self, from_location, to_location=None, revision=None,
1069
 
            hardlink=False, stacked=False, standalone=False, no_tree=False):
 
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
1070
1218
        from bzrlib.tag import _merge_tags_if_possible
1071
 
 
1072
1219
        accelerator_tree, br_from = bzrdir.BzrDir.open_tree_or_branch(
1073
1220
            from_location)
1074
1221
        revision = _get_one_revision('branch', revision)
1075
1222
        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)
1076
1234
        try:
1077
 
            if revision is not None:
1078
 
                revision_id = revision.as_revision_id(br_from)
 
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)
1079
1240
            else:
1080
 
                # FIXME - wt.last_revision, fallback to branch, fall back to
1081
 
                # None or perhaps NULL_REVISION to mean copy nothing
1082
 
                # RBC 20060209
1083
 
                revision_id = br_from.last_revision()
1084
 
            if to_location is None:
1085
 
                to_location = urlutils.derive_to_location(from_location)
1086
 
            to_transport = transport.get_transport(to_location)
1087
 
            try:
1088
 
                to_transport.mkdir('.')
1089
 
            except errors.FileExists:
1090
 
                raise errors.BzrCommandError('Target directory "%s" already'
1091
 
                                             ' exists.' % to_location)
1092
 
            except errors.NoSuchFile:
1093
 
                raise errors.BzrCommandError('Parent of "%s" does not exist.'
1094
 
                                             % to_location)
1095
 
            try:
1096
 
                # preserve whatever source format we have.
1097
 
                dir = br_from.bzrdir.sprout(to_transport.base, revision_id,
1098
 
                                            possible_transports=[to_transport],
1099
 
                                            accelerator_tree=accelerator_tree,
1100
 
                                            hardlink=hardlink, stacked=stacked,
1101
 
                                            force_new_repo=standalone,
1102
 
                                            create_tree_if_local=not no_tree,
1103
 
                                            source_branch=br_from)
1104
 
                branch = dir.open_branch()
1105
 
            except errors.NoSuchRevision:
1106
 
                to_transport.delete_tree('.')
1107
 
                msg = "The branch %s has no revision %s." % (from_location,
1108
 
                    revision)
1109
 
                raise errors.BzrCommandError(msg)
1110
 
            _merge_tags_if_possible(br_from, branch)
1111
 
            # If the source branch is stacked, the new branch may
1112
 
            # be stacked whether we asked for that explicitly or not.
1113
 
            # We therefore need a try/except here and not just 'if stacked:'
1114
 
            try:
1115
 
                note('Created new stacked branch referring to %s.' %
1116
 
                    branch.get_stacked_on_url())
1117
 
            except (errors.NotStacked, errors.UnstackableBranchFormat,
1118
 
                errors.UnstackableRepositoryFormat), e:
1119
 
                note('Branched %d revision(s).' % branch.revno())
1120
 
        finally:
1121
 
            br_from.unlock()
 
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'))
1122
1286
 
1123
1287
 
1124
1288
class cmd_checkout(Command):
1125
 
    """Create a new checkout of an existing branch.
 
1289
    __doc__ = """Create a new checkout of an existing branch.
1126
1290
 
1127
1291
    If BRANCH_LOCATION is omitted, checkout will reconstitute a working tree for
1128
1292
    the branch found in '.'. This is useful if you have removed the working tree
1191
1355
 
1192
1356
 
1193
1357
class cmd_renames(Command):
1194
 
    """Show list of renamed files.
 
1358
    __doc__ = """Show list of renamed files.
1195
1359
    """
1196
1360
    # TODO: Option to show renames between two historical versions.
1197
1361
 
1203
1367
    def run(self, dir=u'.'):
1204
1368
        tree = WorkingTree.open_containing(dir)[0]
1205
1369
        tree.lock_read()
1206
 
        try:
1207
 
            new_inv = tree.inventory
1208
 
            old_tree = tree.basis_tree()
1209
 
            old_tree.lock_read()
1210
 
            try:
1211
 
                old_inv = old_tree.inventory
1212
 
                renames = []
1213
 
                iterator = tree.iter_changes(old_tree, include_unchanged=True)
1214
 
                for f, paths, c, v, p, n, k, e in iterator:
1215
 
                    if paths[0] == paths[1]:
1216
 
                        continue
1217
 
                    if None in (paths):
1218
 
                        continue
1219
 
                    renames.append(paths)
1220
 
                renames.sort()
1221
 
                for old_name, new_name in renames:
1222
 
                    self.outf.write("%s => %s\n" % (old_name, new_name))
1223
 
            finally:
1224
 
                old_tree.unlock()
1225
 
        finally:
1226
 
            tree.unlock()
 
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))
1227
1387
 
1228
1388
 
1229
1389
class cmd_update(Command):
1230
 
    """Update a tree to have the latest code committed to its branch.
 
1390
    __doc__ = """Update a tree to have the latest code committed to its branch.
1231
1391
 
1232
1392
    This will perform a merge into the working tree, and may generate
1233
1393
    conflicts. If you have any local changes, you will still
1235
1395
 
1236
1396
    If you want to discard your local changes, you can just do a
1237
1397
    '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.
1238
1401
    """
1239
1402
 
1240
1403
    _see_also = ['pull', 'working-trees', 'status-flags']
1241
1404
    takes_args = ['dir?']
 
1405
    takes_options = ['revision']
1242
1406
    aliases = ['up']
1243
1407
 
1244
 
    def run(self, dir='.'):
 
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")
1245
1412
        tree = WorkingTree.open_containing(dir)[0]
 
1413
        branch = tree.branch
1246
1414
        possible_transports = []
1247
 
        master = tree.branch.get_master_branch(
 
1415
        master = branch.get_master_branch(
1248
1416
            possible_transports=possible_transports)
1249
1417
        if master is not None:
1250
1418
            tree.lock_write()
 
1419
            branch_location = master.base
1251
1420
        else:
1252
1421
            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)
1253
1449
        try:
1254
 
            existing_pending_merges = tree.get_parent_ids()[1:]
1255
 
            last_rev = _mod_revision.ensure_null(tree.last_revision())
1256
 
            if last_rev == _mod_revision.ensure_null(
1257
 
                tree.branch.last_revision()):
1258
 
                # may be up to date, check master too.
1259
 
                if master is None or last_rev == _mod_revision.ensure_null(
1260
 
                    master.last_revision()):
1261
 
                    revno = tree.branch.revision_id_to_revno(last_rev)
1262
 
                    note("Tree is up to date at revision %d." % (revno,))
1263
 
                    return 0
1264
 
            view_info = _get_view_info_for_change_reporter(tree)
1265
1450
            conflicts = tree.update(
1266
 
                delta._ChangeReporter(unversioned_filter=tree.is_ignored,
1267
 
                view_info=view_info), possible_transports=possible_transports)
1268
 
            revno = tree.branch.revision_id_to_revno(
1269
 
                _mod_revision.ensure_null(tree.last_revision()))
1270
 
            note('Updated to revision %d.' % (revno,))
1271
 
            if tree.get_parent_ids()[1:] != existing_pending_merges:
1272
 
                note('Your local commits will now show as pending merges with '
1273
 
                     "'bzr status', and can be committed with 'bzr commit'.")
1274
 
            if conflicts != 0:
1275
 
                return 1
1276
 
            else:
1277
 
                return 0
1278
 
        finally:
1279
 
            tree.unlock()
 
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
1280
1473
 
1281
1474
 
1282
1475
class cmd_info(Command):
1283
 
    """Show information about a working tree, branch or repository.
 
1476
    __doc__ = """Show information about a working tree, branch or repository.
1284
1477
 
1285
1478
    This command will show all known locations and formats associated to the
1286
1479
    tree, branch or repository.
1301
1494
      basic statistics (like the number of files in the working tree and
1302
1495
      number of revisions in the branch and repository):
1303
1496
 
1304
 
        bzr -v info
 
1497
        bzr info -v
1305
1498
 
1306
1499
      Display the above together with number of committers to the branch:
1307
1500
 
1308
 
        bzr -vv info
 
1501
        bzr info -vv
1309
1502
    """
1310
1503
    _see_also = ['revno', 'working-trees', 'repositories']
1311
1504
    takes_args = ['location?']
1324
1517
 
1325
1518
 
1326
1519
class cmd_remove(Command):
1327
 
    """Remove files or directories.
 
1520
    __doc__ = """Remove files or directories.
1328
1521
 
1329
1522
    This makes bzr stop tracking changes to the specified files. bzr will delete
1330
1523
    them if they can easily be recovered using revert. If no options or
1339
1532
            title='Deletion Strategy', value_switches=True, enum_switch=False,
1340
1533
            safe='Only delete files if they can be'
1341
1534
                 ' safely recovered (default).',
1342
 
            keep="Don't delete any files.",
 
1535
            keep='Delete from bzr but leave the working copy.',
1343
1536
            force='Delete all the specified files, even if they can not be '
1344
1537
                'recovered and even if they are non-empty directories.')]
1345
1538
    aliases = ['rm', 'del']
1353
1546
            file_list = [f for f in file_list]
1354
1547
 
1355
1548
        tree.lock_write()
1356
 
        try:
1357
 
            # Heuristics should probably all move into tree.remove_smart or
1358
 
            # some such?
1359
 
            if new:
1360
 
                added = tree.changes_from(tree.basis_tree(),
1361
 
                    specific_files=file_list).added
1362
 
                file_list = sorted([f[0] for f in added], reverse=True)
1363
 
                if len(file_list) == 0:
1364
 
                    raise errors.BzrCommandError('No matching files.')
1365
 
            elif file_list is None:
1366
 
                # missing files show up in iter_changes(basis) as
1367
 
                # versioned-with-no-kind.
1368
 
                missing = []
1369
 
                for change in tree.iter_changes(tree.basis_tree()):
1370
 
                    # Find paths in the working tree that have no kind:
1371
 
                    if change[1][1] is not None and change[6][1] is None:
1372
 
                        missing.append(change[1][1])
1373
 
                file_list = sorted(missing, reverse=True)
1374
 
                file_deletion_strategy = 'keep'
1375
 
            tree.remove(file_list, verbose=verbose, to_file=self.outf,
1376
 
                keep_files=file_deletion_strategy=='keep',
1377
 
                force=file_deletion_strategy=='force')
1378
 
        finally:
1379
 
            tree.unlock()
 
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')
1380
1571
 
1381
1572
 
1382
1573
class cmd_file_id(Command):
1383
 
    """Print file_id of a particular file or directory.
 
1574
    __doc__ = """Print file_id of a particular file or directory.
1384
1575
 
1385
1576
    The file_id is assigned when the file is first added and remains the
1386
1577
    same through all revisions where the file exists, even when it is
1402
1593
 
1403
1594
 
1404
1595
class cmd_file_path(Command):
1405
 
    """Print path of file_ids to a file or directory.
 
1596
    __doc__ = """Print path of file_ids to a file or directory.
1406
1597
 
1407
1598
    This prints one line for each directory down to the target,
1408
1599
    starting at the branch root.
1424
1615
 
1425
1616
 
1426
1617
class cmd_reconcile(Command):
1427
 
    """Reconcile bzr metadata in a branch.
 
1618
    __doc__ = """Reconcile bzr metadata in a branch.
1428
1619
 
1429
1620
    This can correct data mismatches that may have been caused by
1430
1621
    previous ghost operations or bzr upgrades. You should only
1452
1643
 
1453
1644
 
1454
1645
class cmd_revision_history(Command):
1455
 
    """Display the list of revision ids on a branch."""
 
1646
    __doc__ = """Display the list of revision ids on a branch."""
1456
1647
 
1457
1648
    _see_also = ['log']
1458
1649
    takes_args = ['location?']
1468
1659
 
1469
1660
 
1470
1661
class cmd_ancestry(Command):
1471
 
    """List all revisions merged into this branch."""
 
1662
    __doc__ = """List all revisions merged into this branch."""
1472
1663
 
1473
1664
    _see_also = ['log', 'revision-history']
1474
1665
    takes_args = ['location?']
1493
1684
 
1494
1685
 
1495
1686
class cmd_init(Command):
1496
 
    """Make a directory into a versioned branch.
 
1687
    __doc__ = """Make a directory into a versioned branch.
1497
1688
 
1498
1689
    Use this to create an empty branch, or before importing an
1499
1690
    existing project.
1527
1718
                lazy_registry=('bzrlib.bzrdir', 'format_registry'),
1528
1719
                converter=lambda name: bzrdir.format_registry.make_bzrdir(name),
1529
1720
                value_switches=True,
1530
 
                title="Branch Format",
 
1721
                title="Branch format",
1531
1722
                ),
1532
1723
         Option('append-revisions-only',
1533
1724
                help='Never change revnos or the existing log.'
1556
1747
                    "\nYou may supply --create-prefix to create all"
1557
1748
                    " leading parent directories."
1558
1749
                    % location)
1559
 
            _create_prefix(to_transport)
 
1750
            to_transport.create_prefix()
1560
1751
 
1561
1752
        try:
1562
1753
            a_bzrdir = bzrdir.BzrDir.open_from_transport(to_transport)
1580
1771
                branch.set_append_revisions_only(True)
1581
1772
            except errors.UpgradeRequired:
1582
1773
                raise errors.BzrCommandError('This branch format cannot be set'
1583
 
                    ' to append-revisions-only.  Try --experimental-branch6')
 
1774
                    ' to append-revisions-only.  Try --default.')
1584
1775
        if not is_quiet():
1585
1776
            from bzrlib.info import describe_layout, describe_format
1586
1777
            try:
1602
1793
 
1603
1794
 
1604
1795
class cmd_init_repository(Command):
1605
 
    """Create a shared repository to hold branches.
 
1796
    __doc__ = """Create a shared repository for branches to share storage space.
1606
1797
 
1607
1798
    New branches created under the repository directory will store their
1608
 
    revisions in the repository, not in the branch directory.
 
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.
1609
1802
 
1610
 
    If the --no-trees option is used then the branches in the repository
1611
 
    will not have working trees by default.
 
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.
1612
1809
 
1613
1810
    :Examples:
1614
 
        Create a shared repositories holding just branches::
 
1811
        Create a shared repository holding just branches::
1615
1812
 
1616
1813
            bzr init-repo --no-trees repo
1617
1814
            bzr init repo/trunk
1656
1853
 
1657
1854
 
1658
1855
class cmd_diff(Command):
1659
 
    """Show differences in the working tree, between revisions or branches.
 
1856
    __doc__ = """Show differences in the working tree, between revisions or branches.
1660
1857
 
1661
1858
    If no arguments are given, all changes for the current tree are listed.
1662
1859
    If files are given, only the changes in those files are listed.
1683
1880
 
1684
1881
            bzr diff -r1
1685
1882
 
1686
 
        Difference between revision 2 and revision 1::
1687
 
 
1688
 
            bzr diff -r1..2
1689
 
 
1690
 
        Difference between revision 2 and revision 1 for branch xxx::
1691
 
 
1692
 
            bzr diff -r1..2 xxx
 
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
1693
1904
 
1694
1905
        Show just the differences for file NEWS::
1695
1906
 
1734
1945
            help='Use this command to compare files.',
1735
1946
            type=unicode,
1736
1947
            ),
 
1948
        RegistryOption('format',
 
1949
            help='Diff format to use.',
 
1950
            lazy_registry=('bzrlib.diff', 'format_registry'),
 
1951
            value_switches=False, title='Diff format'),
1737
1952
        ]
1738
1953
    aliases = ['di', 'dif']
1739
1954
    encoding_type = 'exact'
1740
1955
 
1741
1956
    @display_command
1742
1957
    def run(self, revision=None, file_list=None, diff_options=None,
1743
 
            prefix=None, old=None, new=None, using=None):
1744
 
        from bzrlib.diff import _get_trees_to_diff, show_diff_trees
 
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)
1745
1961
 
1746
1962
        if (prefix is None) or (prefix == '0'):
1747
1963
            # diff -p0 format
1761
1977
            raise errors.BzrCommandError('bzr diff --revision takes exactly'
1762
1978
                                         ' one or two revision specifiers')
1763
1979
 
1764
 
        old_tree, new_tree, specific_files, extra_trees = \
1765
 
                _get_trees_to_diff(file_list, revision, old, new,
1766
 
                apply_view=True)
 
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)
1767
1988
        return show_diff_trees(old_tree, new_tree, sys.stdout,
1768
1989
                               specific_files=specific_files,
1769
1990
                               external_diff_options=diff_options,
1770
1991
                               old_label=old_label, new_label=new_label,
1771
 
                               extra_trees=extra_trees, using=using)
 
1992
                               extra_trees=extra_trees, using=using,
 
1993
                               format_cls=format)
1772
1994
 
1773
1995
 
1774
1996
class cmd_deleted(Command):
1775
 
    """List files deleted in the working tree.
 
1997
    __doc__ = """List files deleted in the working tree.
1776
1998
    """
1777
1999
    # TODO: Show files deleted since a previous revision, or
1778
2000
    # between two revisions.
1787
2009
    def run(self, show_ids=False):
1788
2010
        tree = WorkingTree.open_containing(u'.')[0]
1789
2011
        tree.lock_read()
1790
 
        try:
1791
 
            old = tree.basis_tree()
1792
 
            old.lock_read()
1793
 
            try:
1794
 
                for path, ie in old.inventory.iter_entries():
1795
 
                    if not tree.has_id(ie.file_id):
1796
 
                        self.outf.write(path)
1797
 
                        if show_ids:
1798
 
                            self.outf.write(' ')
1799
 
                            self.outf.write(ie.file_id)
1800
 
                        self.outf.write('\n')
1801
 
            finally:
1802
 
                old.unlock()
1803
 
        finally:
1804
 
            tree.unlock()
 
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')
1805
2023
 
1806
2024
 
1807
2025
class cmd_modified(Command):
1808
 
    """List files modified in working tree.
 
2026
    __doc__ = """List files modified in working tree.
1809
2027
    """
1810
2028
 
1811
2029
    hidden = True
1828
2046
 
1829
2047
 
1830
2048
class cmd_added(Command):
1831
 
    """List files added in working tree.
 
2049
    __doc__ = """List files added in working tree.
1832
2050
    """
1833
2051
 
1834
2052
    hidden = True
1843
2061
    def run(self, null=False):
1844
2062
        wt = WorkingTree.open_containing(u'.')[0]
1845
2063
        wt.lock_read()
1846
 
        try:
1847
 
            basis = wt.basis_tree()
1848
 
            basis.lock_read()
1849
 
            try:
1850
 
                basis_inv = basis.inventory
1851
 
                inv = wt.inventory
1852
 
                for file_id in inv:
1853
 
                    if file_id in basis_inv:
1854
 
                        continue
1855
 
                    if inv.is_root(file_id) and len(basis_inv) == 0:
1856
 
                        continue
1857
 
                    path = inv.id2path(file_id)
1858
 
                    if not os.access(osutils.abspath(path), os.F_OK):
1859
 
                        continue
1860
 
                    if null:
1861
 
                        self.outf.write(path + '\0')
1862
 
                    else:
1863
 
                        self.outf.write(osutils.quotefn(path) + '\n')
1864
 
            finally:
1865
 
                basis.unlock()
1866
 
        finally:
1867
 
            wt.unlock()
 
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')
1868
2082
 
1869
2083
 
1870
2084
class cmd_root(Command):
1871
 
    """Show the tree root directory.
 
2085
    __doc__ = """Show the tree root directory.
1872
2086
 
1873
2087
    The root is the nearest enclosing directory with a .bzr control
1874
2088
    directory."""
1898
2112
 
1899
2113
 
1900
2114
class cmd_log(Command):
1901
 
    """Show historical log for a branch or subset of a branch.
 
2115
    __doc__ = """Show historical log for a branch or subset of a branch.
1902
2116
 
1903
2117
    log is bzr's default tool for exploring the history of a branch.
1904
2118
    The branch to use is taken from the first parameter. If no parameters
1933
2147
        --show-ids  display revision-ids (and file-ids), not just revnos
1934
2148
 
1935
2149
      Note that the default number of levels to display is a function of the
1936
 
      log format. If the -n option is not used, ``short`` and ``line`` show
1937
 
      just the top level (mainline) while ``long`` shows all levels of merged
1938
 
      revisions.
 
2150
      log format. If the -n option is not used, the standard log formats show
 
2151
      just the top level (mainline).
1939
2152
 
1940
2153
      Status summaries are shown using status flags like A, M, etc. To see
1941
2154
      the changes explained using words like ``added`` and ``modified``
2016
2229
    :Tips & tricks:
2017
2230
 
2018
2231
      GUI tools and IDEs are often better at exploring history than command
2019
 
      line tools. You may prefer qlog or glog from the QBzr and Bzr-Gtk packages
2020
 
      respectively for example. (TortoiseBzr uses qlog for displaying logs.) See
2021
 
      http://bazaar-vcs.org/BzrPlugins and http://bazaar-vcs.org/IDEIntegration.
2022
 
 
2023
 
      Web interfaces are often better at exploring history than command line
2024
 
      tools, particularly for branches on servers. You may prefer Loggerhead
2025
 
      or one of its alternatives. See http://bazaar-vcs.org/WebInterface.
 
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>.  
2026
2236
 
2027
2237
      You may find it useful to add the aliases below to ``bazaar.conf``::
2028
2238
 
2029
2239
        [ALIASES]
2030
 
        tip = log -r-1 -n1
 
2240
        tip = log -r-1
2031
2241
        top = log -l10 --line
2032
 
        show = log -v -p -n1 --long
 
2242
        show = log -v -p
2033
2243
 
2034
2244
      ``bzr tip`` will then show the latest revision while ``bzr top``
2035
2245
      will show the last 10 mainline revisions. To see the details of a
2036
2246
      particular revision X,  ``bzr show -rX``.
2037
2247
 
2038
 
      As many GUI tools and Web interfaces do, you may prefer viewing
2039
 
      history collapsed initially. If you are interested in looking deeper
2040
 
      into a particular merge X, use ``bzr log -n0 -rX``. If you like
2041
 
      working this way, you may wish to either:
2042
 
 
2043
 
      * change your default log format to short (or line)
2044
 
      * add this alias: log = log -n1
 
2248
      If you are interested in looking deeper into a particular merge X,
 
2249
      use ``bzr log -n0 -rX``.
2045
2250
 
2046
2251
      ``bzr log -v`` on a branch with lots of history is currently
2047
2252
      very slow. A fix for this issue is currently under development.
2055
2260
 
2056
2261
      When exploring non-mainline history on large projects with deep
2057
2262
      history, the performance of log can be greatly improved by installing
2058
 
      the revnocache plugin. This plugin buffers historical information
 
2263
      the historycache plugin. This plugin buffers historical information
2059
2264
      trading disk space for faster speed.
2060
2265
    """
2061
2266
    takes_args = ['file*']
2092
2297
            Option('show-diff',
2093
2298
                   short_name='p',
2094
2299
                   help='Show changes made in each revision as a patch.'),
 
2300
            Option('include-merges',
 
2301
                   help='Show merged revisions like --levels 0 does.'),
2095
2302
            ]
2096
2303
    encoding_type = 'replace'
2097
2304
 
2106
2313
            levels=None,
2107
2314
            message=None,
2108
2315
            limit=None,
2109
 
            show_diff=False):
 
2316
            show_diff=False,
 
2317
            include_merges=False):
2110
2318
        from bzrlib.log import (
2111
2319
            Logger,
2112
2320
            make_log_request_dict,
2113
2321
            _get_info_for_log_files,
2114
2322
            )
2115
2323
        direction = (forward and 'forward') or 'reverse'
 
2324
        if include_merges:
 
2325
            if levels is None:
 
2326
                levels = 0
 
2327
            else:
 
2328
                raise errors.BzrCommandError(
 
2329
                    '--levels and --include-merges are mutually exclusive')
2116
2330
 
2117
2331
        if change is not None:
2118
2332
            if len(change) > 1:
2127
2341
        filter_by_dir = False
2128
2342
        if file_list:
2129
2343
            # find the file ids to log and check for directory filtering
2130
 
            b, file_info_list, rev1, rev2 = _get_info_for_log_files(revision,
2131
 
                file_list)
 
2344
            b, file_info_list, rev1, rev2 = _get_info_for_log_files(
 
2345
                revision, file_list)
 
2346
            self.add_cleanup(b.unlock)
2132
2347
            for relpath, file_id, kind in file_info_list:
2133
2348
                if file_id is None:
2134
2349
                    raise errors.BzrCommandError(
2152
2367
                location = '.'
2153
2368
            dir, relpath = bzrdir.BzrDir.open_containing(location)
2154
2369
            b = dir.open_branch()
 
2370
            b.lock_read()
 
2371
            self.add_cleanup(b.unlock)
2155
2372
            rev1, rev2 = _get_revision_range(revision, b, self.name())
2156
2373
 
2157
2374
        # Decide on the type of delta & diff filtering to use
2167
2384
        else:
2168
2385
            diff_type = 'full'
2169
2386
 
2170
 
        b.lock_read()
2171
 
        try:
2172
 
            # Build the log formatter
2173
 
            if log_format is None:
2174
 
                log_format = log.log_formatter_registry.get_default(b)
2175
 
            lf = log_format(show_ids=show_ids, to_file=self.outf,
2176
 
                            show_timezone=timezone,
2177
 
                            delta_format=get_verbosity_level(),
2178
 
                            levels=levels)
2179
 
 
2180
 
            # Choose the algorithm for doing the logging. It's annoying
2181
 
            # having multiple code paths like this but necessary until
2182
 
            # the underlying repository format is faster at generating
2183
 
            # deltas or can provide everything we need from the indices.
2184
 
            # The default algorithm - match-using-deltas - works for
2185
 
            # multiple files and directories and is faster for small
2186
 
            # amounts of history (200 revisions say). However, it's too
2187
 
            # slow for logging a single file in a repository with deep
2188
 
            # history, i.e. > 10K revisions. In the spirit of "do no
2189
 
            # evil when adding features", we continue to use the
2190
 
            # original algorithm - per-file-graph - for the "single
2191
 
            # file that isn't a directory without showing a delta" case.
2192
 
            match_using_deltas = (len(file_ids) != 1 or filter_by_dir
2193
 
                or delta_type)
2194
 
 
2195
 
            # Build the LogRequest and execute it
2196
 
            if len(file_ids) == 0:
2197
 
                file_ids = None
2198
 
            rqst = make_log_request_dict(
2199
 
                direction=direction, specific_fileids=file_ids,
2200
 
                start_revision=rev1, end_revision=rev2, limit=limit,
2201
 
                message_search=message, delta_type=delta_type,
2202
 
                diff_type=diff_type, _match_using_deltas=match_using_deltas)
2203
 
            Logger(b, rqst).show(lf)
2204
 
        finally:
2205
 
            b.unlock()
 
2387
        # Build the log formatter
 
2388
        if log_format is None:
 
2389
            log_format = log.log_formatter_registry.get_default(b)
 
2390
        # Make a non-encoding output to include the diffs - bug 328007
 
2391
        unencoded_output = ui.ui_factory.make_output_stream(encoding_type='exact')
 
2392
        lf = log_format(show_ids=show_ids, to_file=self.outf,
 
2393
                        to_exact_file=unencoded_output,
 
2394
                        show_timezone=timezone,
 
2395
                        delta_format=get_verbosity_level(),
 
2396
                        levels=levels,
 
2397
                        show_advice=levels is None)
 
2398
 
 
2399
        # Choose the algorithm for doing the logging. It's annoying
 
2400
        # having multiple code paths like this but necessary until
 
2401
        # the underlying repository format is faster at generating
 
2402
        # deltas or can provide everything we need from the indices.
 
2403
        # The default algorithm - match-using-deltas - works for
 
2404
        # multiple files and directories and is faster for small
 
2405
        # amounts of history (200 revisions say). However, it's too
 
2406
        # slow for logging a single file in a repository with deep
 
2407
        # history, i.e. > 10K revisions. In the spirit of "do no
 
2408
        # evil when adding features", we continue to use the
 
2409
        # original algorithm - per-file-graph - for the "single
 
2410
        # file that isn't a directory without showing a delta" case.
 
2411
        partial_history = revision and b.repository._format.supports_chks
 
2412
        match_using_deltas = (len(file_ids) != 1 or filter_by_dir
 
2413
            or delta_type or partial_history)
 
2414
 
 
2415
        # Build the LogRequest and execute it
 
2416
        if len(file_ids) == 0:
 
2417
            file_ids = None
 
2418
        rqst = make_log_request_dict(
 
2419
            direction=direction, specific_fileids=file_ids,
 
2420
            start_revision=rev1, end_revision=rev2, limit=limit,
 
2421
            message_search=message, delta_type=delta_type,
 
2422
            diff_type=diff_type, _match_using_deltas=match_using_deltas)
 
2423
        Logger(b, rqst).show(lf)
2206
2424
 
2207
2425
 
2208
2426
def _get_revision_range(revisionspec_list, branch, command_name):
2226
2444
            raise errors.BzrCommandError(
2227
2445
                "bzr %s doesn't accept two revisions in different"
2228
2446
                " branches." % command_name)
2229
 
        rev1 = start_spec.in_history(branch)
 
2447
        if start_spec.spec is None:
 
2448
            # Avoid loading all the history.
 
2449
            rev1 = RevisionInfo(branch, None, None)
 
2450
        else:
 
2451
            rev1 = start_spec.in_history(branch)
2230
2452
        # Avoid loading all of history when we know a missing
2231
2453
        # end of range means the last revision ...
2232
2454
        if end_spec.spec is None:
2261
2483
 
2262
2484
 
2263
2485
class cmd_touching_revisions(Command):
2264
 
    """Return revision-ids which affected a particular file.
 
2486
    __doc__ = """Return revision-ids which affected a particular file.
2265
2487
 
2266
2488
    A more user-friendly interface is "bzr log FILE".
2267
2489
    """
2272
2494
    @display_command
2273
2495
    def run(self, filename):
2274
2496
        tree, relpath = WorkingTree.open_containing(filename)
 
2497
        file_id = tree.path2id(relpath)
2275
2498
        b = tree.branch
2276
 
        file_id = tree.path2id(relpath)
2277
 
        for revno, revision_id, what in log.find_touching_revisions(b, file_id):
 
2499
        b.lock_read()
 
2500
        self.add_cleanup(b.unlock)
 
2501
        touching_revs = log.find_touching_revisions(b, file_id)
 
2502
        for revno, revision_id, what in touching_revs:
2278
2503
            self.outf.write("%6d %s\n" % (revno, what))
2279
2504
 
2280
2505
 
2281
2506
class cmd_ls(Command):
2282
 
    """List files in a tree.
 
2507
    __doc__ = """List files in a tree.
2283
2508
    """
2284
2509
 
2285
2510
    _see_also = ['status', 'cat']
2286
2511
    takes_args = ['path?']
2287
 
    # TODO: Take a revision or remote path and list that tree instead.
2288
2512
    takes_options = [
2289
2513
            'verbose',
2290
2514
            'revision',
2291
 
            Option('non-recursive',
2292
 
                   help='Don\'t recurse into subdirectories.'),
 
2515
            Option('recursive', short_name='R',
 
2516
                   help='Recurse into subdirectories.'),
2293
2517
            Option('from-root',
2294
2518
                   help='Print paths relative to the root of the branch.'),
2295
2519
            Option('unknown', help='Print unknown files.'),
2306
2530
            ]
2307
2531
    @display_command
2308
2532
    def run(self, revision=None, verbose=False,
2309
 
            non_recursive=False, from_root=False,
 
2533
            recursive=False, from_root=False,
2310
2534
            unknown=False, versioned=False, ignored=False,
2311
2535
            null=False, kind=None, show_ids=False, path=None):
2312
2536
 
2321
2545
 
2322
2546
        if path is None:
2323
2547
            fs_path = '.'
2324
 
            prefix = ''
2325
2548
        else:
2326
2549
            if from_root:
2327
2550
                raise errors.BzrCommandError('cannot specify both --from-root'
2328
2551
                                             ' and PATH')
2329
2552
            fs_path = path
2330
 
            prefix = path
2331
2553
        tree, branch, relpath = bzrdir.BzrDir.open_containing_tree_or_branch(
2332
2554
            fs_path)
 
2555
 
 
2556
        # Calculate the prefix to use
 
2557
        prefix = None
2333
2558
        if from_root:
2334
 
            relpath = u''
2335
 
        elif relpath:
2336
 
            relpath += '/'
 
2559
            if relpath:
 
2560
                prefix = relpath + '/'
 
2561
        elif fs_path != '.' and not fs_path.endswith('/'):
 
2562
            prefix = fs_path + '/'
 
2563
 
2337
2564
        if revision is not None or tree is None:
2338
2565
            tree = _get_one_revision_tree('ls', revision, branch=branch)
2339
2566
 
2343
2570
            if view_files:
2344
2571
                apply_view = True
2345
2572
                view_str = views.view_display_str(view_files)
2346
 
                note("ignoring files outside view: %s" % view_str)
 
2573
                note("Ignoring files outside view. View is %s" % view_str)
2347
2574
 
2348
2575
        tree.lock_read()
2349
 
        try:
2350
 
            for fp, fc, fkind, fid, entry in tree.list_files(include_root=False):
2351
 
                if fp.startswith(relpath):
2352
 
                    fp = osutils.pathjoin(prefix, fp[len(relpath):])
2353
 
                    if non_recursive and '/' in fp:
2354
 
                        continue
2355
 
                    if not all and not selection[fc]:
2356
 
                        continue
2357
 
                    if kind is not None and fkind != kind:
2358
 
                        continue
2359
 
                    if apply_view:
2360
 
                        try:
2361
 
                            views.check_path_in_view(tree, fp)
2362
 
                        except errors.FileOutsideView:
2363
 
                            continue
2364
 
                    kindch = entry.kind_character()
2365
 
                    outstring = fp + kindch
2366
 
                    if verbose:
2367
 
                        outstring = '%-8s %s' % (fc, outstring)
2368
 
                        if show_ids and fid is not None:
2369
 
                            outstring = "%-50s %s" % (outstring, fid)
2370
 
                        self.outf.write(outstring + '\n')
2371
 
                    elif null:
2372
 
                        self.outf.write(fp + '\0')
2373
 
                        if show_ids:
2374
 
                            if fid is not None:
2375
 
                                self.outf.write(fid)
2376
 
                            self.outf.write('\0')
2377
 
                        self.outf.flush()
2378
 
                    else:
2379
 
                        if fid is not None:
2380
 
                            my_id = fid
2381
 
                        else:
2382
 
                            my_id = ''
2383
 
                        if show_ids:
2384
 
                            self.outf.write('%-50s %s\n' % (outstring, my_id))
2385
 
                        else:
2386
 
                            self.outf.write(outstring + '\n')
2387
 
        finally:
2388
 
            tree.unlock()
 
2576
        self.add_cleanup(tree.unlock)
 
2577
        for fp, fc, fkind, fid, entry in tree.list_files(include_root=False,
 
2578
            from_dir=relpath, recursive=recursive):
 
2579
            # Apply additional masking
 
2580
            if not all and not selection[fc]:
 
2581
                continue
 
2582
            if kind is not None and fkind != kind:
 
2583
                continue
 
2584
            if apply_view:
 
2585
                try:
 
2586
                    if relpath:
 
2587
                        fullpath = osutils.pathjoin(relpath, fp)
 
2588
                    else:
 
2589
                        fullpath = fp
 
2590
                    views.check_path_in_view(tree, fullpath)
 
2591
                except errors.FileOutsideView:
 
2592
                    continue
 
2593
 
 
2594
            # Output the entry
 
2595
            if prefix:
 
2596
                fp = osutils.pathjoin(prefix, fp)
 
2597
            kindch = entry.kind_character()
 
2598
            outstring = fp + kindch
 
2599
            ui.ui_factory.clear_term()
 
2600
            if verbose:
 
2601
                outstring = '%-8s %s' % (fc, outstring)
 
2602
                if show_ids and fid is not None:
 
2603
                    outstring = "%-50s %s" % (outstring, fid)
 
2604
                self.outf.write(outstring + '\n')
 
2605
            elif null:
 
2606
                self.outf.write(fp + '\0')
 
2607
                if show_ids:
 
2608
                    if fid is not None:
 
2609
                        self.outf.write(fid)
 
2610
                    self.outf.write('\0')
 
2611
                self.outf.flush()
 
2612
            else:
 
2613
                if show_ids:
 
2614
                    if fid is not None:
 
2615
                        my_id = fid
 
2616
                    else:
 
2617
                        my_id = ''
 
2618
                    self.outf.write('%-50s %s\n' % (outstring, my_id))
 
2619
                else:
 
2620
                    self.outf.write(outstring + '\n')
2389
2621
 
2390
2622
 
2391
2623
class cmd_unknowns(Command):
2392
 
    """List unknown files.
 
2624
    __doc__ = """List unknown files.
2393
2625
    """
2394
2626
 
2395
2627
    hidden = True
2402
2634
 
2403
2635
 
2404
2636
class cmd_ignore(Command):
2405
 
    """Ignore specified files or patterns.
 
2637
    __doc__ = """Ignore specified files or patterns.
2406
2638
 
2407
2639
    See ``bzr help patterns`` for details on the syntax of patterns.
2408
2640
 
 
2641
    If a .bzrignore file does not exist, the ignore command
 
2642
    will create one and add the specified files or patterns to the newly
 
2643
    created file. The ignore command will also automatically add the 
 
2644
    .bzrignore file to be versioned. Creating a .bzrignore file without
 
2645
    the use of the ignore command will require an explicit add command.
 
2646
 
2409
2647
    To remove patterns from the ignore list, edit the .bzrignore file.
2410
2648
    After adding, editing or deleting that file either indirectly by
2411
2649
    using this command or directly by using an editor, be sure to commit
2412
2650
    it.
 
2651
    
 
2652
    Bazaar also supports a global ignore file ~/.bazaar/ignore. On Windows
 
2653
    the global ignore file can be found in the application data directory as
 
2654
    C:\\Documents and Settings\\<user>\\Application Data\\Bazaar\\2.0\\ignore.
 
2655
    Global ignores are not touched by this command. The global ignore file
 
2656
    can be edited directly using an editor.
 
2657
 
 
2658
    Patterns prefixed with '!' are exceptions to ignore patterns and take
 
2659
    precedence over regular ignores.  Such exceptions are used to specify
 
2660
    files that should be versioned which would otherwise be ignored.
 
2661
    
 
2662
    Patterns prefixed with '!!' act as regular ignore patterns, but have
 
2663
    precedence over the '!' exception patterns.
2413
2664
 
2414
2665
    Note: ignore patterns containing shell wildcards must be quoted from
2415
2666
    the shell on Unix.
2419
2670
 
2420
2671
            bzr ignore ./Makefile
2421
2672
 
2422
 
        Ignore class files in all directories::
 
2673
        Ignore .class files in all directories...::
2423
2674
 
2424
2675
            bzr ignore "*.class"
2425
2676
 
 
2677
        ...but do not ignore "special.class"::
 
2678
 
 
2679
            bzr ignore "!special.class"
 
2680
 
2426
2681
        Ignore .o files under the lib directory::
2427
2682
 
2428
2683
            bzr ignore "lib/**/*.o"
2434
2689
        Ignore everything but the "debian" toplevel directory::
2435
2690
 
2436
2691
            bzr ignore "RE:(?!debian/).*"
 
2692
        
 
2693
        Ignore everything except the "local" toplevel directory,
 
2694
        but always ignore "*~" autosave files, even under local/::
 
2695
        
 
2696
            bzr ignore "*"
 
2697
            bzr ignore "!./local"
 
2698
            bzr ignore "!!*~"
2437
2699
    """
2438
2700
 
2439
2701
    _see_also = ['status', 'ignored', 'patterns']
2440
2702
    takes_args = ['name_pattern*']
2441
2703
    takes_options = [
2442
 
        Option('old-default-rules',
2443
 
               help='Write out the ignore rules bzr < 0.9 always used.')
 
2704
        Option('default-rules',
 
2705
               help='Display the default ignore rules that bzr uses.')
2444
2706
        ]
2445
2707
 
2446
 
    def run(self, name_pattern_list=None, old_default_rules=None):
 
2708
    def run(self, name_pattern_list=None, default_rules=None):
2447
2709
        from bzrlib import ignores
2448
 
        if old_default_rules is not None:
2449
 
            # dump the rules and exit
2450
 
            for pattern in ignores.OLD_DEFAULTS:
2451
 
                print pattern
 
2710
        if default_rules is not None:
 
2711
            # dump the default rules and exit
 
2712
            for pattern in ignores.USER_DEFAULTS:
 
2713
                self.outf.write("%s\n" % pattern)
2452
2714
            return
2453
2715
        if not name_pattern_list:
2454
2716
            raise errors.BzrCommandError("ignore requires at least one "
2455
 
                                  "NAME_PATTERN or --old-default-rules")
 
2717
                "NAME_PATTERN or --default-rules.")
2456
2718
        name_pattern_list = [globbing.normalize_pattern(p)
2457
2719
                             for p in name_pattern_list]
2458
2720
        for name_pattern in name_pattern_list:
2470
2732
            if id is not None:
2471
2733
                filename = entry[0]
2472
2734
                if ignored.match(filename):
2473
 
                    matches.append(filename.encode('utf-8'))
 
2735
                    matches.append(filename)
2474
2736
        tree.unlock()
2475
2737
        if len(matches) > 0:
2476
 
            print "Warning: the following files are version controlled and" \
2477
 
                  " match your ignore pattern:\n%s" \
2478
 
                  "\nThese files will continue to be version controlled" \
2479
 
                  " unless you 'bzr remove' them." % ("\n".join(matches),)
 
2738
            self.outf.write("Warning: the following files are version controlled and"
 
2739
                  " match your ignore pattern:\n%s"
 
2740
                  "\nThese files will continue to be version controlled"
 
2741
                  " unless you 'bzr remove' them.\n" % ("\n".join(matches),))
2480
2742
 
2481
2743
 
2482
2744
class cmd_ignored(Command):
2483
 
    """List ignored files and the patterns that matched them.
 
2745
    __doc__ = """List ignored files and the patterns that matched them.
2484
2746
 
2485
2747
    List all the ignored files and the ignore pattern that caused the file to
2486
2748
    be ignored.
2497
2759
    def run(self):
2498
2760
        tree = WorkingTree.open_containing(u'.')[0]
2499
2761
        tree.lock_read()
2500
 
        try:
2501
 
            for path, file_class, kind, file_id, entry in tree.list_files():
2502
 
                if file_class != 'I':
2503
 
                    continue
2504
 
                ## XXX: Slightly inefficient since this was already calculated
2505
 
                pat = tree.is_ignored(path)
2506
 
                self.outf.write('%-50s %s\n' % (path, pat))
2507
 
        finally:
2508
 
            tree.unlock()
 
2762
        self.add_cleanup(tree.unlock)
 
2763
        for path, file_class, kind, file_id, entry in tree.list_files():
 
2764
            if file_class != 'I':
 
2765
                continue
 
2766
            ## XXX: Slightly inefficient since this was already calculated
 
2767
            pat = tree.is_ignored(path)
 
2768
            self.outf.write('%-50s %s\n' % (path, pat))
2509
2769
 
2510
2770
 
2511
2771
class cmd_lookup_revision(Command):
2512
 
    """Lookup the revision-id from a revision-number
 
2772
    __doc__ = """Lookup the revision-id from a revision-number
2513
2773
 
2514
2774
    :Examples:
2515
2775
        bzr lookup-revision 33
2522
2782
        try:
2523
2783
            revno = int(revno)
2524
2784
        except ValueError:
2525
 
            raise errors.BzrCommandError("not a valid revision-number: %r" % revno)
2526
 
 
2527
 
        print WorkingTree.open_containing(u'.')[0].branch.get_rev_id(revno)
 
2785
            raise errors.BzrCommandError("not a valid revision-number: %r"
 
2786
                                         % revno)
 
2787
        revid = WorkingTree.open_containing(u'.')[0].branch.get_rev_id(revno)
 
2788
        self.outf.write("%s\n" % revid)
2528
2789
 
2529
2790
 
2530
2791
class cmd_export(Command):
2531
 
    """Export current or past revision to a destination directory or archive.
 
2792
    __doc__ = """Export current or past revision to a destination directory or archive.
2532
2793
 
2533
2794
    If no revision is specified this exports the last committed revision.
2534
2795
 
2566
2827
        Option('root',
2567
2828
               type=str,
2568
2829
               help="Name of the root directory inside the exported file."),
 
2830
        Option('per-file-timestamps',
 
2831
               help='Set modification time of files to that of the last '
 
2832
                    'revision in which it was changed.'),
2569
2833
        ]
2570
2834
    def run(self, dest, branch_or_subdir=None, revision=None, format=None,
2571
 
        root=None, filters=False):
 
2835
        root=None, filters=False, per_file_timestamps=False):
2572
2836
        from bzrlib.export import export
2573
2837
 
2574
2838
        if branch_or_subdir is None:
2581
2845
 
2582
2846
        rev_tree = _get_one_revision_tree('export', revision, branch=b, tree=tree)
2583
2847
        try:
2584
 
            export(rev_tree, dest, format, root, subdir, filtered=filters)
 
2848
            export(rev_tree, dest, format, root, subdir, filtered=filters,
 
2849
                   per_file_timestamps=per_file_timestamps)
2585
2850
        except errors.NoSuchExportFormat, e:
2586
2851
            raise errors.BzrCommandError('Unsupported export format: %s' % e.format)
2587
2852
 
2588
2853
 
2589
2854
class cmd_cat(Command):
2590
 
    """Write the contents of a file as of a given revision to standard output.
 
2855
    __doc__ = """Write the contents of a file as of a given revision to standard output.
2591
2856
 
2592
2857
    If no revision is nominated, the last revision is used.
2593
2858
 
2614
2879
        tree, branch, relpath = \
2615
2880
            bzrdir.BzrDir.open_containing_tree_or_branch(filename)
2616
2881
        branch.lock_read()
2617
 
        try:
2618
 
            return self._run(tree, branch, relpath, filename, revision,
2619
 
                             name_from_revision, filters)
2620
 
        finally:
2621
 
            branch.unlock()
 
2882
        self.add_cleanup(branch.unlock)
 
2883
        return self._run(tree, branch, relpath, filename, revision,
 
2884
                         name_from_revision, filters)
2622
2885
 
2623
2886
    def _run(self, tree, b, relpath, filename, revision, name_from_revision,
2624
2887
        filtered):
2625
2888
        if tree is None:
2626
2889
            tree = b.basis_tree()
2627
2890
        rev_tree = _get_one_revision_tree('cat', revision, branch=b)
 
2891
        rev_tree.lock_read()
 
2892
        self.add_cleanup(rev_tree.unlock)
2628
2893
 
2629
2894
        old_file_id = rev_tree.path2id(relpath)
2630
2895
 
2665
2930
            chunks = content.splitlines(True)
2666
2931
            content = filtered_output_bytes(chunks, filters,
2667
2932
                ContentFilterContext(relpath, rev_tree))
 
2933
            self.cleanup_now()
2668
2934
            self.outf.writelines(content)
2669
2935
        else:
 
2936
            self.cleanup_now()
2670
2937
            self.outf.write(content)
2671
2938
 
2672
2939
 
2673
2940
class cmd_local_time_offset(Command):
2674
 
    """Show the offset in seconds from GMT to local time."""
 
2941
    __doc__ = """Show the offset in seconds from GMT to local time."""
2675
2942
    hidden = True
2676
2943
    @display_command
2677
2944
    def run(self):
2678
 
        print osutils.local_time_offset()
 
2945
        self.outf.write("%s\n" % osutils.local_time_offset())
2679
2946
 
2680
2947
 
2681
2948
 
2682
2949
class cmd_commit(Command):
2683
 
    """Commit changes into a new revision.
2684
 
 
2685
 
    If no arguments are given, the entire tree is committed.
2686
 
 
2687
 
    If selected files are specified, only changes to those files are
2688
 
    committed.  If a directory is specified then the directory and everything
2689
 
    within it is committed.
2690
 
 
2691
 
    When excludes are given, they take precedence over selected files.
2692
 
    For example, too commit only changes within foo, but not changes within
2693
 
    foo/bar::
2694
 
 
2695
 
      bzr commit foo -x foo/bar
2696
 
 
2697
 
    If author of the change is not the same person as the committer, you can
2698
 
    specify the author's name using the --author option. The name should be
2699
 
    in the same format as a committer-id, e.g. "John Doe <jdoe@example.com>".
2700
 
    If there is more than one author of the change you can specify the option
2701
 
    multiple times, once for each author.
2702
 
 
2703
 
    A selected-file commit may fail in some cases where the committed
2704
 
    tree would be invalid. Consider::
2705
 
 
2706
 
      bzr init foo
2707
 
      mkdir foo/bar
2708
 
      bzr add foo/bar
2709
 
      bzr commit foo -m "committing foo"
2710
 
      bzr mv foo/bar foo/baz
2711
 
      mkdir foo/bar
2712
 
      bzr add foo/bar
2713
 
      bzr commit foo/bar -m "committing bar but not baz"
2714
 
 
2715
 
    In the example above, the last commit will fail by design. This gives
2716
 
    the user the opportunity to decide whether they want to commit the
2717
 
    rename at the same time, separately first, or not at all. (As a general
2718
 
    rule, when in doubt, Bazaar has a policy of Doing the Safe Thing.)
2719
 
 
2720
 
    Note: A selected-file commit after a merge is not yet supported.
 
2950
    __doc__ = """Commit changes into a new revision.
 
2951
 
 
2952
    An explanatory message needs to be given for each commit. This is
 
2953
    often done by using the --message option (getting the message from the
 
2954
    command line) or by using the --file option (getting the message from
 
2955
    a file). If neither of these options is given, an editor is opened for
 
2956
    the user to enter the message. To see the changed files in the
 
2957
    boilerplate text loaded into the editor, use the --show-diff option.
 
2958
 
 
2959
    By default, the entire tree is committed and the person doing the
 
2960
    commit is assumed to be the author. These defaults can be overridden
 
2961
    as explained below.
 
2962
 
 
2963
    :Selective commits:
 
2964
 
 
2965
      If selected files are specified, only changes to those files are
 
2966
      committed.  If a directory is specified then the directory and
 
2967
      everything within it is committed.
 
2968
  
 
2969
      When excludes are given, they take precedence over selected files.
 
2970
      For example, to commit only changes within foo, but not changes
 
2971
      within foo/bar::
 
2972
  
 
2973
        bzr commit foo -x foo/bar
 
2974
  
 
2975
      A selective commit after a merge is not yet supported.
 
2976
 
 
2977
    :Custom authors:
 
2978
 
 
2979
      If the author of the change is not the same person as the committer,
 
2980
      you can specify the author's name using the --author option. The
 
2981
      name should be in the same format as a committer-id, e.g.
 
2982
      "John Doe <jdoe@example.com>". If there is more than one author of
 
2983
      the change you can specify the option multiple times, once for each
 
2984
      author.
 
2985
  
 
2986
    :Checks:
 
2987
 
 
2988
      A common mistake is to forget to add a new file or directory before
 
2989
      running the commit command. The --strict option checks for unknown
 
2990
      files and aborts the commit if any are found. More advanced pre-commit
 
2991
      checks can be implemented by defining hooks. See ``bzr help hooks``
 
2992
      for details.
 
2993
 
 
2994
    :Things to note:
 
2995
 
 
2996
      If you accidentially commit the wrong changes or make a spelling
 
2997
      mistake in the commit message say, you can use the uncommit command
 
2998
      to undo it. See ``bzr help uncommit`` for details.
 
2999
 
 
3000
      Hooks can also be configured to run after a commit. This allows you
 
3001
      to trigger updates to external systems like bug trackers. The --fixes
 
3002
      option can be used to record the association between a revision and
 
3003
      one or more bugs. See ``bzr help bugs`` for details.
 
3004
 
 
3005
      A selective commit may fail in some cases where the committed
 
3006
      tree would be invalid. Consider::
 
3007
  
 
3008
        bzr init foo
 
3009
        mkdir foo/bar
 
3010
        bzr add foo/bar
 
3011
        bzr commit foo -m "committing foo"
 
3012
        bzr mv foo/bar foo/baz
 
3013
        mkdir foo/bar
 
3014
        bzr add foo/bar
 
3015
        bzr commit foo/bar -m "committing bar but not baz"
 
3016
  
 
3017
      In the example above, the last commit will fail by design. This gives
 
3018
      the user the opportunity to decide whether they want to commit the
 
3019
      rename at the same time, separately first, or not at all. (As a general
 
3020
      rule, when in doubt, Bazaar has a policy of Doing the Safe Thing.)
2721
3021
    """
2722
3022
    # TODO: Run hooks on tree to-be-committed, and after commit.
2723
3023
 
2728
3028
 
2729
3029
    # XXX: verbose currently does nothing
2730
3030
 
2731
 
    _see_also = ['bugs', 'uncommit']
 
3031
    _see_also = ['add', 'bugs', 'hooks', 'uncommit']
2732
3032
    takes_args = ['selected*']
2733
3033
    takes_options = [
2734
3034
            ListOption('exclude', type=str, short_name='x',
2746
3046
             Option('strict',
2747
3047
                    help="Refuse to commit if there are unknown "
2748
3048
                    "files in the working tree."),
 
3049
             Option('commit-time', type=str,
 
3050
                    help="Manually set a commit time using commit date "
 
3051
                    "format, e.g. '2009-10-10 08:00:00 +0100'."),
2749
3052
             ListOption('fixes', type=str,
2750
3053
                    help="Mark a bug as being fixed by this revision "
2751
3054
                         "(see \"bzr help bugs\")."),
2758
3061
                         "the master branch until a normal commit "
2759
3062
                         "is performed."
2760
3063
                    ),
2761
 
              Option('show-diff',
2762
 
                     help='When no message is supplied, show the diff along'
2763
 
                     ' with the status summary in the message editor.'),
 
3064
             Option('show-diff',
 
3065
                    help='When no message is supplied, show the diff along'
 
3066
                    ' with the status summary in the message editor.'),
2764
3067
             ]
2765
3068
    aliases = ['ci', 'checkin']
2766
3069
 
2785
3088
 
2786
3089
    def run(self, message=None, file=None, verbose=False, selected_list=None,
2787
3090
            unchanged=False, strict=False, local=False, fixes=None,
2788
 
            author=None, show_diff=False, exclude=None):
 
3091
            author=None, show_diff=False, exclude=None, commit_time=None):
2789
3092
        from bzrlib.errors import (
2790
3093
            PointlessCommit,
2791
3094
            ConflictsInTree,
2797
3100
            make_commit_message_template_encoded
2798
3101
        )
2799
3102
 
 
3103
        commit_stamp = offset = None
 
3104
        if commit_time is not None:
 
3105
            try:
 
3106
                commit_stamp, offset = timestamp.parse_patch_date(commit_time)
 
3107
            except ValueError, e:
 
3108
                raise errors.BzrCommandError(
 
3109
                    "Could not parse --commit-time: " + str(e))
 
3110
 
2800
3111
        # TODO: Need a blackbox test for invoking the external editor; may be
2801
3112
        # slightly problematic to run this cross-platform.
2802
3113
 
2822
3133
        if local and not tree.branch.get_bound_location():
2823
3134
            raise errors.LocalRequiresBoundBranch()
2824
3135
 
 
3136
        if message is not None:
 
3137
            try:
 
3138
                file_exists = osutils.lexists(message)
 
3139
            except UnicodeError:
 
3140
                # The commit message contains unicode characters that can't be
 
3141
                # represented in the filesystem encoding, so that can't be a
 
3142
                # file.
 
3143
                file_exists = False
 
3144
            if file_exists:
 
3145
                warning_msg = (
 
3146
                    'The commit message is a file name: "%(f)s".\n'
 
3147
                    '(use --file "%(f)s" to take commit message from that file)'
 
3148
                    % { 'f': message })
 
3149
                ui.ui_factory.show_warning(warning_msg)
 
3150
            if '\r' in message:
 
3151
                message = message.replace('\r\n', '\n')
 
3152
                message = message.replace('\r', '\n')
 
3153
            if file:
 
3154
                raise errors.BzrCommandError(
 
3155
                    "please specify either --message or --file")
 
3156
 
2825
3157
        def get_message(commit_obj):
2826
3158
            """Callback to get commit message"""
2827
 
            my_message = message
2828
 
            if my_message is None and not file:
2829
 
                t = make_commit_message_template_encoded(tree,
 
3159
            if file:
 
3160
                my_message = codecs.open(
 
3161
                    file, 'rt', osutils.get_user_encoding()).read()
 
3162
            elif message is not None:
 
3163
                my_message = message
 
3164
            else:
 
3165
                # No message supplied: make one up.
 
3166
                # text is the status of the tree
 
3167
                text = make_commit_message_template_encoded(tree,
2830
3168
                        selected_list, diff=show_diff,
2831
3169
                        output_encoding=osutils.get_user_encoding())
 
3170
                # start_message is the template generated from hooks
 
3171
                # XXX: Warning - looks like hooks return unicode,
 
3172
                # make_commit_message_template_encoded returns user encoding.
 
3173
                # We probably want to be using edit_commit_message instead to
 
3174
                # avoid this.
2832
3175
                start_message = generate_commit_message_template(commit_obj)
2833
 
                my_message = edit_commit_message_encoded(t,
 
3176
                my_message = edit_commit_message_encoded(text,
2834
3177
                    start_message=start_message)
2835
3178
                if my_message is None:
2836
3179
                    raise errors.BzrCommandError("please specify a commit"
2837
3180
                        " message with either --message or --file")
2838
 
            elif my_message and file:
2839
 
                raise errors.BzrCommandError(
2840
 
                    "please specify either --message or --file")
2841
 
            if file:
2842
 
                my_message = codecs.open(file, 'rt',
2843
 
                                         osutils.get_user_encoding()).read()
2844
3181
            if my_message == "":
2845
3182
                raise errors.BzrCommandError("empty commit message specified")
2846
3183
            return my_message
2847
3184
 
 
3185
        # The API permits a commit with a filter of [] to mean 'select nothing'
 
3186
        # but the command line should not do that.
 
3187
        if not selected_list:
 
3188
            selected_list = None
2848
3189
        try:
2849
3190
            tree.commit(message_callback=get_message,
2850
3191
                        specific_files=selected_list,
2851
3192
                        allow_pointless=unchanged, strict=strict, local=local,
2852
3193
                        reporter=None, verbose=verbose, revprops=properties,
2853
 
                        authors=author,
 
3194
                        authors=author, timestamp=commit_stamp,
 
3195
                        timezone=offset,
2854
3196
                        exclude=safe_relpath_files(tree, exclude))
2855
3197
        except PointlessCommit:
2856
 
            # FIXME: This should really happen before the file is read in;
2857
 
            # perhaps prepare the commit; get the message; then actually commit
2858
 
            raise errors.BzrCommandError("no changes to commit."
2859
 
                              " use --unchanged to commit anyhow")
 
3198
            raise errors.BzrCommandError("No changes to commit."
 
3199
                              " Use --unchanged to commit anyhow.")
2860
3200
        except ConflictsInTree:
2861
3201
            raise errors.BzrCommandError('Conflicts detected in working '
2862
3202
                'tree.  Use "bzr conflicts" to list, "bzr resolve FILE" to'
2865
3205
            raise errors.BzrCommandError("Commit refused because there are"
2866
3206
                              " unknown files in the working tree.")
2867
3207
        except errors.BoundBranchOutOfDate, e:
2868
 
            raise errors.BzrCommandError(str(e) + "\n"
2869
 
            'To commit to master branch, run update and then commit.\n'
2870
 
            'You can also pass --local to commit to continue working '
2871
 
            'disconnected.')
 
3208
            e.extra_help = ("\n"
 
3209
                'To commit to master branch, run update and then commit.\n'
 
3210
                'You can also pass --local to commit to continue working '
 
3211
                'disconnected.')
 
3212
            raise
2872
3213
 
2873
3214
 
2874
3215
class cmd_check(Command):
2875
 
    """Validate working tree structure, branch consistency and repository history.
 
3216
    __doc__ = """Validate working tree structure, branch consistency and repository history.
2876
3217
 
2877
3218
    This command checks various invariants about branch and repository storage
2878
3219
    to detect data corruption or bzr bugs.
2880
3221
    The working tree and branch checks will only give output if a problem is
2881
3222
    detected. The output fields of the repository check are:
2882
3223
 
2883
 
        revisions: This is just the number of revisions checked.  It doesn't
2884
 
            indicate a problem.
2885
 
        versionedfiles: This is just the number of versionedfiles checked.  It
2886
 
            doesn't indicate a problem.
2887
 
        unreferenced ancestors: Texts that are ancestors of other texts, but
2888
 
            are not properly referenced by the revision ancestry.  This is a
2889
 
            subtle problem that Bazaar can work around.
2890
 
        unique file texts: This is the total number of unique file contents
2891
 
            seen in the checked revisions.  It does not indicate a problem.
2892
 
        repeated file texts: This is the total number of repeated texts seen
2893
 
            in the checked revisions.  Texts can be repeated when their file
2894
 
            entries are modified, but the file contents are not.  It does not
2895
 
            indicate a problem.
 
3224
    revisions
 
3225
        This is just the number of revisions checked.  It doesn't
 
3226
        indicate a problem.
 
3227
 
 
3228
    versionedfiles
 
3229
        This is just the number of versionedfiles checked.  It
 
3230
        doesn't indicate a problem.
 
3231
 
 
3232
    unreferenced ancestors
 
3233
        Texts that are ancestors of other texts, but
 
3234
        are not properly referenced by the revision ancestry.  This is a
 
3235
        subtle problem that Bazaar can work around.
 
3236
 
 
3237
    unique file texts
 
3238
        This is the total number of unique file contents
 
3239
        seen in the checked revisions.  It does not indicate a problem.
 
3240
 
 
3241
    repeated file texts
 
3242
        This is the total number of repeated texts seen
 
3243
        in the checked revisions.  Texts can be repeated when their file
 
3244
        entries are modified, but the file contents are not.  It does not
 
3245
        indicate a problem.
2896
3246
 
2897
3247
    If no restrictions are specified, all Bazaar data that is found at the given
2898
3248
    location will be checked.
2933
3283
 
2934
3284
 
2935
3285
class cmd_upgrade(Command):
2936
 
    """Upgrade branch storage to current format.
 
3286
    __doc__ = """Upgrade branch storage to current format.
2937
3287
 
2938
3288
    The check command or bzr developers may sometimes advise you to run
2939
3289
    this command. When the default format has changed you may also be warned
2953
3303
 
2954
3304
    def run(self, url='.', format=None):
2955
3305
        from bzrlib.upgrade import upgrade
2956
 
        if format is None:
2957
 
            format = bzrdir.format_registry.make_bzrdir('default')
2958
3306
        upgrade(url, format)
2959
3307
 
2960
3308
 
2961
3309
class cmd_whoami(Command):
2962
 
    """Show or set bzr user id.
 
3310
    __doc__ = """Show or set bzr user id.
2963
3311
 
2964
3312
    :Examples:
2965
3313
        Show the email of the current user::
3009
3357
 
3010
3358
 
3011
3359
class cmd_nick(Command):
3012
 
    """Print or set the branch nickname.
 
3360
    __doc__ = """Print or set the branch nickname.
3013
3361
 
3014
3362
    If unset, the tree root directory name is used as the nickname.
3015
3363
    To print the current nickname, execute with no argument.
3029
3377
 
3030
3378
    @display_command
3031
3379
    def printme(self, branch):
3032
 
        print branch.nick
 
3380
        self.outf.write('%s\n' % branch.nick)
3033
3381
 
3034
3382
 
3035
3383
class cmd_alias(Command):
3036
 
    """Set/unset and display aliases.
 
3384
    __doc__ = """Set/unset and display aliases.
3037
3385
 
3038
3386
    :Examples:
3039
3387
        Show the current aliases::
3103
3451
 
3104
3452
 
3105
3453
class cmd_selftest(Command):
3106
 
    """Run internal test suite.
 
3454
    __doc__ = """Run internal test suite.
3107
3455
 
3108
3456
    If arguments are given, they are regular expressions that say which tests
3109
3457
    should run.  Tests matching any expression are run, and other tests are
3136
3484
    Tests that need working space on disk use a common temporary directory,
3137
3485
    typically inside $TMPDIR or /tmp.
3138
3486
 
 
3487
    If you set BZR_TEST_PDB=1 when running selftest, failing tests will drop
 
3488
    into a pdb postmortem session.
 
3489
 
3139
3490
    :Examples:
3140
3491
        Run only tests relating to 'ignore'::
3141
3492
 
3150
3501
    def get_transport_type(typestring):
3151
3502
        """Parse and return a transport specifier."""
3152
3503
        if typestring == "sftp":
3153
 
            from bzrlib.transport.sftp import SFTPAbsoluteServer
3154
 
            return SFTPAbsoluteServer
 
3504
            from bzrlib.tests import stub_sftp
 
3505
            return stub_sftp.SFTPAbsoluteServer
3155
3506
        if typestring == "memory":
3156
 
            from bzrlib.transport.memory import MemoryServer
3157
 
            return MemoryServer
 
3507
            from bzrlib.tests import test_server
 
3508
            return memory.MemoryServer
3158
3509
        if typestring == "fakenfs":
3159
 
            from bzrlib.transport.fakenfs import FakeNFSServer
3160
 
            return FakeNFSServer
 
3510
            from bzrlib.tests import test_server
 
3511
            return test_server.FakeNFSServer
3161
3512
        msg = "No known transport type %s. Supported types are: sftp\n" %\
3162
3513
            (typestring)
3163
3514
        raise errors.BzrCommandError(msg)
3178
3529
                     Option('lsprof-timed',
3179
3530
                            help='Generate lsprof output for benchmarked'
3180
3531
                                 ' sections of code.'),
 
3532
                     Option('lsprof-tests',
 
3533
                            help='Generate lsprof output for each test.'),
3181
3534
                     Option('cache-dir', type=str,
3182
3535
                            help='Cache intermediate benchmark output in this '
3183
3536
                                 'directory.'),
3187
3540
                            ),
3188
3541
                     Option('list-only',
3189
3542
                            help='List the tests instead of running them.'),
 
3543
                     RegistryOption('parallel',
 
3544
                        help="Run the test suite in parallel.",
 
3545
                        lazy_registry=('bzrlib.tests', 'parallel_registry'),
 
3546
                        value_switches=False,
 
3547
                        ),
3190
3548
                     Option('randomize', type=str, argname="SEED",
3191
3549
                            help='Randomize the order of tests using the given'
3192
3550
                                 ' seed or "now" for the current time.'),
3218
3576
            lsprof_timed=None, cache_dir=None,
3219
3577
            first=False, list_only=False,
3220
3578
            randomize=None, exclude=None, strict=False,
3221
 
            load_list=None, debugflag=None, starting_with=None, subunit=False):
 
3579
            load_list=None, debugflag=None, starting_with=None, subunit=False,
 
3580
            parallel=None, lsprof_tests=False):
3222
3581
        from bzrlib.tests import selftest
3223
3582
        import bzrlib.benchmarks as benchmarks
3224
3583
        from bzrlib.benchmarks import tree_creator
3228
3587
 
3229
3588
        if cache_dir is not None:
3230
3589
            tree_creator.TreeCreator.CACHE_ROOT = osutils.abspath(cache_dir)
3231
 
        if not list_only:
3232
 
            print 'testing: %s' % (osutils.realpath(sys.argv[0]),)
3233
 
            print '   %s (%s python%s)' % (
3234
 
                    bzrlib.__path__[0],
3235
 
                    bzrlib.version_string,
3236
 
                    bzrlib._format_version_tuple(sys.version_info),
3237
 
                    )
3238
 
        print
3239
3590
        if testspecs_list is not None:
3240
3591
            pattern = '|'.join(testspecs_list)
3241
3592
        else:
3247
3598
                raise errors.BzrCommandError("subunit not available. subunit "
3248
3599
                    "needs to be installed to use --subunit.")
3249
3600
            self.additional_selftest_args['runner_class'] = SubUnitBzrRunner
 
3601
            # On Windows, disable automatic conversion of '\n' to '\r\n' in
 
3602
            # stdout, which would corrupt the subunit stream. 
 
3603
            if sys.platform == "win32" and sys.stdout.fileno() >= 0:
 
3604
                import msvcrt
 
3605
                msvcrt.setmode(sys.stdout.fileno(), os.O_BINARY)
 
3606
        if parallel:
 
3607
            self.additional_selftest_args.setdefault(
 
3608
                'suite_decorators', []).append(parallel)
3250
3609
        if benchmark:
3251
3610
            test_suite_factory = benchmarks.test_suite
3252
3611
            # Unless user explicitly asks for quiet, be verbose in benchmarks
3253
3612
            verbose = not is_quiet()
3254
3613
            # TODO: should possibly lock the history file...
3255
3614
            benchfile = open(".perf_history", "at", buffering=1)
 
3615
            self.add_cleanup(benchfile.close)
3256
3616
        else:
3257
3617
            test_suite_factory = None
3258
3618
            benchfile = None
3259
 
        try:
3260
 
            selftest_kwargs = {"verbose": verbose,
3261
 
                              "pattern": pattern,
3262
 
                              "stop_on_failure": one,
3263
 
                              "transport": transport,
3264
 
                              "test_suite_factory": test_suite_factory,
3265
 
                              "lsprof_timed": lsprof_timed,
3266
 
                              "bench_history": benchfile,
3267
 
                              "matching_tests_first": first,
3268
 
                              "list_only": list_only,
3269
 
                              "random_seed": randomize,
3270
 
                              "exclude_pattern": exclude,
3271
 
                              "strict": strict,
3272
 
                              "load_list": load_list,
3273
 
                              "debug_flags": debugflag,
3274
 
                              "starting_with": starting_with
3275
 
                              }
3276
 
            selftest_kwargs.update(self.additional_selftest_args)
3277
 
            result = selftest(**selftest_kwargs)
3278
 
        finally:
3279
 
            if benchfile is not None:
3280
 
                benchfile.close()
3281
 
        if result:
3282
 
            note('tests passed')
3283
 
        else:
3284
 
            note('tests failed')
 
3619
        selftest_kwargs = {"verbose": verbose,
 
3620
                          "pattern": pattern,
 
3621
                          "stop_on_failure": one,
 
3622
                          "transport": transport,
 
3623
                          "test_suite_factory": test_suite_factory,
 
3624
                          "lsprof_timed": lsprof_timed,
 
3625
                          "lsprof_tests": lsprof_tests,
 
3626
                          "bench_history": benchfile,
 
3627
                          "matching_tests_first": first,
 
3628
                          "list_only": list_only,
 
3629
                          "random_seed": randomize,
 
3630
                          "exclude_pattern": exclude,
 
3631
                          "strict": strict,
 
3632
                          "load_list": load_list,
 
3633
                          "debug_flags": debugflag,
 
3634
                          "starting_with": starting_with
 
3635
                          }
 
3636
        selftest_kwargs.update(self.additional_selftest_args)
 
3637
        result = selftest(**selftest_kwargs)
3285
3638
        return int(not result)
3286
3639
 
3287
3640
 
3288
3641
class cmd_version(Command):
3289
 
    """Show version of bzr."""
 
3642
    __doc__ = """Show version of bzr."""
3290
3643
 
3291
3644
    encoding_type = 'replace'
3292
3645
    takes_options = [
3303
3656
 
3304
3657
 
3305
3658
class cmd_rocks(Command):
3306
 
    """Statement of optimism."""
 
3659
    __doc__ = """Statement of optimism."""
3307
3660
 
3308
3661
    hidden = True
3309
3662
 
3310
3663
    @display_command
3311
3664
    def run(self):
3312
 
        print "It sure does!"
 
3665
        self.outf.write("It sure does!\n")
3313
3666
 
3314
3667
 
3315
3668
class cmd_find_merge_base(Command):
3316
 
    """Find and print a base revision for merging two branches."""
 
3669
    __doc__ = """Find and print a base revision for merging two branches."""
3317
3670
    # TODO: Options to specify revisions on either side, as if
3318
3671
    #       merging only part of the history.
3319
3672
    takes_args = ['branch', 'other']
3326
3679
        branch1 = Branch.open_containing(branch)[0]
3327
3680
        branch2 = Branch.open_containing(other)[0]
3328
3681
        branch1.lock_read()
3329
 
        try:
3330
 
            branch2.lock_read()
3331
 
            try:
3332
 
                last1 = ensure_null(branch1.last_revision())
3333
 
                last2 = ensure_null(branch2.last_revision())
3334
 
 
3335
 
                graph = branch1.repository.get_graph(branch2.repository)
3336
 
                base_rev_id = graph.find_unique_lca(last1, last2)
3337
 
 
3338
 
                print 'merge base is revision %s' % base_rev_id
3339
 
            finally:
3340
 
                branch2.unlock()
3341
 
        finally:
3342
 
            branch1.unlock()
 
3682
        self.add_cleanup(branch1.unlock)
 
3683
        branch2.lock_read()
 
3684
        self.add_cleanup(branch2.unlock)
 
3685
        last1 = ensure_null(branch1.last_revision())
 
3686
        last2 = ensure_null(branch2.last_revision())
 
3687
 
 
3688
        graph = branch1.repository.get_graph(branch2.repository)
 
3689
        base_rev_id = graph.find_unique_lca(last1, last2)
 
3690
 
 
3691
        self.outf.write('merge base is revision %s\n' % base_rev_id)
3343
3692
 
3344
3693
 
3345
3694
class cmd_merge(Command):
3346
 
    """Perform a three-way merge.
 
3695
    __doc__ = """Perform a three-way merge.
3347
3696
 
3348
3697
    The source of the merge can be specified either in the form of a branch,
3349
3698
    or in the form of a path to a file containing a merge directive generated
3378
3727
    committed to record the result of the merge.
3379
3728
 
3380
3729
    merge refuses to run if there are any uncommitted changes, unless
3381
 
    --force is given.
 
3730
    --force is given. The --force option can also be used to create a
 
3731
    merge revision which has more than two parents.
 
3732
 
 
3733
    If one would like to merge changes from the working tree of the other
 
3734
    branch without merging any committed revisions, the --uncommitted option
 
3735
    can be given.
 
3736
 
 
3737
    To select only some changes to merge, use "merge -i", which will prompt
 
3738
    you to apply each diff hunk and file change, similar to "shelve".
3382
3739
 
3383
3740
    :Examples:
3384
3741
        To merge the latest revision from bzr.dev::
3393
3750
 
3394
3751
            bzr merge -r 81..82 ../bzr.dev
3395
3752
 
3396
 
        To apply a merge directive contained in in /tmp/merge:
 
3753
        To apply a merge directive contained in /tmp/merge::
3397
3754
 
3398
3755
            bzr merge /tmp/merge
 
3756
 
 
3757
        To create a merge revision with three parents from two branches
 
3758
        feature1a and feature1b:
 
3759
 
 
3760
            bzr merge ../feature1a
 
3761
            bzr merge ../feature1b --force
 
3762
            bzr commit -m 'revision with three parents'
3399
3763
    """
3400
3764
 
3401
3765
    encoding_type = 'exact'
3423
3787
               short_name='d',
3424
3788
               type=unicode,
3425
3789
               ),
3426
 
        Option('preview', help='Instead of merging, show a diff of the merge.')
 
3790
        Option('preview', help='Instead of merging, show a diff of the'
 
3791
               ' merge.'),
 
3792
        Option('interactive', help='Select changes interactively.',
 
3793
            short_name='i')
3427
3794
    ]
3428
3795
 
3429
3796
    def run(self, location=None, revision=None, force=False,
3431
3798
            uncommitted=False, pull=False,
3432
3799
            directory=None,
3433
3800
            preview=False,
 
3801
            interactive=False,
3434
3802
            ):
3435
3803
        if merge_type is None:
3436
3804
            merge_type = _mod_merge.Merge3Merger
3442
3810
        verified = 'inapplicable'
3443
3811
        tree = WorkingTree.open_containing(directory)[0]
3444
3812
 
3445
 
        # die as quickly as possible if there are uncommitted changes
3446
3813
        try:
3447
3814
            basis_tree = tree.revision_tree(tree.last_revision())
3448
3815
        except errors.NoSuchRevision:
3449
3816
            basis_tree = tree.basis_tree()
 
3817
 
 
3818
        # die as quickly as possible if there are uncommitted changes
3450
3819
        if not force:
3451
 
            changes = tree.changes_from(basis_tree)
3452
 
            if changes.has_changed():
 
3820
            if tree.has_changes():
3453
3821
                raise errors.UncommittedChanges(tree)
3454
3822
 
3455
3823
        view_info = _get_view_info_for_change_reporter(tree)
3456
3824
        change_reporter = delta._ChangeReporter(
3457
3825
            unversioned_filter=tree.is_ignored, view_info=view_info)
3458
 
        cleanups = []
3459
 
        try:
3460
 
            pb = ui.ui_factory.nested_progress_bar()
3461
 
            cleanups.append(pb.finished)
3462
 
            tree.lock_write()
3463
 
            cleanups.append(tree.unlock)
3464
 
            if location is not None:
3465
 
                try:
3466
 
                    mergeable = bundle.read_mergeable_from_url(location,
3467
 
                        possible_transports=possible_transports)
3468
 
                except errors.NotABundle:
3469
 
                    mergeable = None
3470
 
                else:
3471
 
                    if uncommitted:
3472
 
                        raise errors.BzrCommandError('Cannot use --uncommitted'
3473
 
                            ' with bundles or merge directives.')
3474
 
 
3475
 
                    if revision is not None:
3476
 
                        raise errors.BzrCommandError(
3477
 
                            'Cannot use -r with merge directives or bundles')
3478
 
                    merger, verified = _mod_merge.Merger.from_mergeable(tree,
3479
 
                       mergeable, pb)
3480
 
 
3481
 
            if merger is None and uncommitted:
3482
 
                if revision is not None and len(revision) > 0:
3483
 
                    raise errors.BzrCommandError('Cannot use --uncommitted and'
3484
 
                        ' --revision at the same time.')
3485
 
                location = self._select_branch_location(tree, location)[0]
3486
 
                other_tree, other_path = WorkingTree.open_containing(location)
3487
 
                merger = _mod_merge.Merger.from_uncommitted(tree, other_tree,
3488
 
                    pb)
3489
 
                allow_pending = False
3490
 
                if other_path != '':
3491
 
                    merger.interesting_files = [other_path]
3492
 
 
3493
 
            if merger is None:
3494
 
                merger, allow_pending = self._get_merger_from_branch(tree,
3495
 
                    location, revision, remember, possible_transports, pb)
3496
 
 
3497
 
            merger.merge_type = merge_type
3498
 
            merger.reprocess = reprocess
3499
 
            merger.show_base = show_base
3500
 
            self.sanity_check_merger(merger)
3501
 
            if (merger.base_rev_id == merger.other_rev_id and
3502
 
                merger.other_rev_id is not None):
3503
 
                note('Nothing to do.')
 
3826
        pb = ui.ui_factory.nested_progress_bar()
 
3827
        self.add_cleanup(pb.finished)
 
3828
        tree.lock_write()
 
3829
        self.add_cleanup(tree.unlock)
 
3830
        if location is not None:
 
3831
            try:
 
3832
                mergeable = bundle.read_mergeable_from_url(location,
 
3833
                    possible_transports=possible_transports)
 
3834
            except errors.NotABundle:
 
3835
                mergeable = None
 
3836
            else:
 
3837
                if uncommitted:
 
3838
                    raise errors.BzrCommandError('Cannot use --uncommitted'
 
3839
                        ' with bundles or merge directives.')
 
3840
 
 
3841
                if revision is not None:
 
3842
                    raise errors.BzrCommandError(
 
3843
                        'Cannot use -r with merge directives or bundles')
 
3844
                merger, verified = _mod_merge.Merger.from_mergeable(tree,
 
3845
                   mergeable, None)
 
3846
 
 
3847
        if merger is None and uncommitted:
 
3848
            if revision is not None and len(revision) > 0:
 
3849
                raise errors.BzrCommandError('Cannot use --uncommitted and'
 
3850
                    ' --revision at the same time.')
 
3851
            merger = self.get_merger_from_uncommitted(tree, location, None)
 
3852
            allow_pending = False
 
3853
 
 
3854
        if merger is None:
 
3855
            merger, allow_pending = self._get_merger_from_branch(tree,
 
3856
                location, revision, remember, possible_transports, None)
 
3857
 
 
3858
        merger.merge_type = merge_type
 
3859
        merger.reprocess = reprocess
 
3860
        merger.show_base = show_base
 
3861
        self.sanity_check_merger(merger)
 
3862
        if (merger.base_rev_id == merger.other_rev_id and
 
3863
            merger.other_rev_id is not None):
 
3864
            note('Nothing to do.')
 
3865
            return 0
 
3866
        if pull:
 
3867
            if merger.interesting_files is not None:
 
3868
                raise errors.BzrCommandError('Cannot pull individual files')
 
3869
            if (merger.base_rev_id == tree.last_revision()):
 
3870
                result = tree.pull(merger.other_branch, False,
 
3871
                                   merger.other_rev_id)
 
3872
                result.report(self.outf)
3504
3873
                return 0
3505
 
            if pull:
3506
 
                if merger.interesting_files is not None:
3507
 
                    raise errors.BzrCommandError('Cannot pull individual files')
3508
 
                if (merger.base_rev_id == tree.last_revision()):
3509
 
                    result = tree.pull(merger.other_branch, False,
3510
 
                                       merger.other_rev_id)
3511
 
                    result.report(self.outf)
3512
 
                    return 0
3513
 
            merger.check_basis(False)
3514
 
            if preview:
3515
 
                return self._do_preview(merger)
3516
 
            else:
3517
 
                return self._do_merge(merger, change_reporter, allow_pending,
3518
 
                                      verified)
3519
 
        finally:
3520
 
            for cleanup in reversed(cleanups):
3521
 
                cleanup()
 
3874
        if merger.this_basis is None:
 
3875
            raise errors.BzrCommandError(
 
3876
                "This branch has no commits."
 
3877
                " (perhaps you would prefer 'bzr pull')")
 
3878
        if preview:
 
3879
            return self._do_preview(merger)
 
3880
        elif interactive:
 
3881
            return self._do_interactive(merger)
 
3882
        else:
 
3883
            return self._do_merge(merger, change_reporter, allow_pending,
 
3884
                                  verified)
 
3885
 
 
3886
    def _get_preview(self, merger):
 
3887
        tree_merger = merger.make_merger()
 
3888
        tt = tree_merger.make_preview_transform()
 
3889
        self.add_cleanup(tt.finalize)
 
3890
        result_tree = tt.get_preview_tree()
 
3891
        return result_tree
3522
3892
 
3523
3893
    def _do_preview(self, merger):
3524
3894
        from bzrlib.diff import show_diff_trees
3525
 
        tree_merger = merger.make_merger()
3526
 
        tt = tree_merger.make_preview_transform()
3527
 
        try:
3528
 
            result_tree = tt.get_preview_tree()
3529
 
            show_diff_trees(merger.this_tree, result_tree, self.outf,
3530
 
                            old_label='', new_label='')
3531
 
        finally:
3532
 
            tt.finalize()
 
3895
        result_tree = self._get_preview(merger)
 
3896
        show_diff_trees(merger.this_tree, result_tree, self.outf,
 
3897
                        old_label='', new_label='')
3533
3898
 
3534
3899
    def _do_merge(self, merger, change_reporter, allow_pending, verified):
3535
3900
        merger.change_reporter = change_reporter
3543
3908
        else:
3544
3909
            return 0
3545
3910
 
 
3911
    def _do_interactive(self, merger):
 
3912
        """Perform an interactive merge.
 
3913
 
 
3914
        This works by generating a preview tree of the merge, then using
 
3915
        Shelver to selectively remove the differences between the working tree
 
3916
        and the preview tree.
 
3917
        """
 
3918
        from bzrlib import shelf_ui
 
3919
        result_tree = self._get_preview(merger)
 
3920
        writer = bzrlib.option.diff_writer_registry.get()
 
3921
        shelver = shelf_ui.Shelver(merger.this_tree, result_tree, destroy=True,
 
3922
                                   reporter=shelf_ui.ApplyReporter(),
 
3923
                                   diff_writer=writer(sys.stdout))
 
3924
        try:
 
3925
            shelver.run()
 
3926
        finally:
 
3927
            shelver.finalize()
 
3928
 
3546
3929
    def sanity_check_merger(self, merger):
3547
3930
        if (merger.show_base and
3548
3931
            not merger.merge_type is _mod_merge.Merge3Merger):
3583
3966
            base_branch, base_path = Branch.open_containing(base_loc,
3584
3967
                possible_transports)
3585
3968
        # Find the revision ids
3586
 
        if revision is None or len(revision) < 1 or revision[-1] is None:
 
3969
        other_revision_id = None
 
3970
        base_revision_id = None
 
3971
        if revision is not None:
 
3972
            if len(revision) >= 1:
 
3973
                other_revision_id = revision[-1].as_revision_id(other_branch)
 
3974
            if len(revision) == 2:
 
3975
                base_revision_id = revision[0].as_revision_id(base_branch)
 
3976
        if other_revision_id is None:
3587
3977
            other_revision_id = _mod_revision.ensure_null(
3588
3978
                other_branch.last_revision())
3589
 
        else:
3590
 
            other_revision_id = revision[-1].as_revision_id(other_branch)
3591
 
        if (revision is not None and len(revision) == 2
3592
 
            and revision[0] is not None):
3593
 
            base_revision_id = revision[0].as_revision_id(base_branch)
3594
 
        else:
3595
 
            base_revision_id = None
3596
3979
        # Remember where we merge from
3597
3980
        if ((remember or tree.branch.get_submit_branch() is None) and
3598
3981
             user_location is not None):
3607
3990
            allow_pending = True
3608
3991
        return merger, allow_pending
3609
3992
 
 
3993
    def get_merger_from_uncommitted(self, tree, location, pb):
 
3994
        """Get a merger for uncommitted changes.
 
3995
 
 
3996
        :param tree: The tree the merger should apply to.
 
3997
        :param location: The location containing uncommitted changes.
 
3998
        :param pb: The progress bar to use for showing progress.
 
3999
        """
 
4000
        location = self._select_branch_location(tree, location)[0]
 
4001
        other_tree, other_path = WorkingTree.open_containing(location)
 
4002
        merger = _mod_merge.Merger.from_uncommitted(tree, other_tree, pb)
 
4003
        if other_path != '':
 
4004
            merger.interesting_files = [other_path]
 
4005
        return merger
 
4006
 
3610
4007
    def _select_branch_location(self, tree, user_location, revision=None,
3611
4008
                                index=None):
3612
4009
        """Select a branch location, according to possible inputs.
3656
4053
 
3657
4054
 
3658
4055
class cmd_remerge(Command):
3659
 
    """Redo a merge.
 
4056
    __doc__ = """Redo a merge.
3660
4057
 
3661
4058
    Use this if you want to try a different merge technique while resolving
3662
4059
    conflicts.  Some merge techniques are better than others, and remerge
3687
4084
 
3688
4085
    def run(self, file_list=None, merge_type=None, show_base=False,
3689
4086
            reprocess=False):
 
4087
        from bzrlib.conflicts import restore
3690
4088
        if merge_type is None:
3691
4089
            merge_type = _mod_merge.Merge3Merger
3692
4090
        tree, file_list = tree_files(file_list)
3693
4091
        tree.lock_write()
3694
 
        try:
3695
 
            parents = tree.get_parent_ids()
3696
 
            if len(parents) != 2:
3697
 
                raise errors.BzrCommandError("Sorry, remerge only works after normal"
3698
 
                                             " merges.  Not cherrypicking or"
3699
 
                                             " multi-merges.")
3700
 
            repository = tree.branch.repository
3701
 
            interesting_ids = None
3702
 
            new_conflicts = []
3703
 
            conflicts = tree.conflicts()
3704
 
            if file_list is not None:
3705
 
                interesting_ids = set()
3706
 
                for filename in file_list:
3707
 
                    file_id = tree.path2id(filename)
3708
 
                    if file_id is None:
3709
 
                        raise errors.NotVersionedError(filename)
3710
 
                    interesting_ids.add(file_id)
3711
 
                    if tree.kind(file_id) != "directory":
3712
 
                        continue
 
4092
        self.add_cleanup(tree.unlock)
 
4093
        parents = tree.get_parent_ids()
 
4094
        if len(parents) != 2:
 
4095
            raise errors.BzrCommandError("Sorry, remerge only works after normal"
 
4096
                                         " merges.  Not cherrypicking or"
 
4097
                                         " multi-merges.")
 
4098
        repository = tree.branch.repository
 
4099
        interesting_ids = None
 
4100
        new_conflicts = []
 
4101
        conflicts = tree.conflicts()
 
4102
        if file_list is not None:
 
4103
            interesting_ids = set()
 
4104
            for filename in file_list:
 
4105
                file_id = tree.path2id(filename)
 
4106
                if file_id is None:
 
4107
                    raise errors.NotVersionedError(filename)
 
4108
                interesting_ids.add(file_id)
 
4109
                if tree.kind(file_id) != "directory":
 
4110
                    continue
3713
4111
 
3714
 
                    for name, ie in tree.inventory.iter_entries(file_id):
3715
 
                        interesting_ids.add(ie.file_id)
3716
 
                new_conflicts = conflicts.select_conflicts(tree, file_list)[0]
3717
 
            else:
3718
 
                # Remerge only supports resolving contents conflicts
3719
 
                allowed_conflicts = ('text conflict', 'contents conflict')
3720
 
                restore_files = [c.path for c in conflicts
3721
 
                                 if c.typestring in allowed_conflicts]
3722
 
            _mod_merge.transform_tree(tree, tree.basis_tree(), interesting_ids)
3723
 
            tree.set_conflicts(ConflictList(new_conflicts))
3724
 
            if file_list is not None:
3725
 
                restore_files = file_list
3726
 
            for filename in restore_files:
3727
 
                try:
3728
 
                    restore(tree.abspath(filename))
3729
 
                except errors.NotConflicted:
3730
 
                    pass
3731
 
            # Disable pending merges, because the file texts we are remerging
3732
 
            # have not had those merges performed.  If we use the wrong parents
3733
 
            # list, we imply that the working tree text has seen and rejected
3734
 
            # all the changes from the other tree, when in fact those changes
3735
 
            # have not yet been seen.
3736
 
            pb = ui.ui_factory.nested_progress_bar()
3737
 
            tree.set_parent_ids(parents[:1])
 
4112
                for name, ie in tree.inventory.iter_entries(file_id):
 
4113
                    interesting_ids.add(ie.file_id)
 
4114
            new_conflicts = conflicts.select_conflicts(tree, file_list)[0]
 
4115
        else:
 
4116
            # Remerge only supports resolving contents conflicts
 
4117
            allowed_conflicts = ('text conflict', 'contents conflict')
 
4118
            restore_files = [c.path for c in conflicts
 
4119
                             if c.typestring in allowed_conflicts]
 
4120
        _mod_merge.transform_tree(tree, tree.basis_tree(), interesting_ids)
 
4121
        tree.set_conflicts(ConflictList(new_conflicts))
 
4122
        if file_list is not None:
 
4123
            restore_files = file_list
 
4124
        for filename in restore_files:
3738
4125
            try:
3739
 
                merger = _mod_merge.Merger.from_revision_ids(pb,
3740
 
                                                             tree, parents[1])
3741
 
                merger.interesting_ids = interesting_ids
3742
 
                merger.merge_type = merge_type
3743
 
                merger.show_base = show_base
3744
 
                merger.reprocess = reprocess
3745
 
                conflicts = merger.do_merge()
3746
 
            finally:
3747
 
                tree.set_parent_ids(parents)
3748
 
                pb.finished()
 
4126
                restore(tree.abspath(filename))
 
4127
            except errors.NotConflicted:
 
4128
                pass
 
4129
        # Disable pending merges, because the file texts we are remerging
 
4130
        # have not had those merges performed.  If we use the wrong parents
 
4131
        # list, we imply that the working tree text has seen and rejected
 
4132
        # all the changes from the other tree, when in fact those changes
 
4133
        # have not yet been seen.
 
4134
        tree.set_parent_ids(parents[:1])
 
4135
        try:
 
4136
            merger = _mod_merge.Merger.from_revision_ids(None, tree, parents[1])
 
4137
            merger.interesting_ids = interesting_ids
 
4138
            merger.merge_type = merge_type
 
4139
            merger.show_base = show_base
 
4140
            merger.reprocess = reprocess
 
4141
            conflicts = merger.do_merge()
3749
4142
        finally:
3750
 
            tree.unlock()
 
4143
            tree.set_parent_ids(parents)
3751
4144
        if conflicts > 0:
3752
4145
            return 1
3753
4146
        else:
3755
4148
 
3756
4149
 
3757
4150
class cmd_revert(Command):
3758
 
    """Revert files to a previous revision.
 
4151
    __doc__ = """Revert files to a previous revision.
3759
4152
 
3760
4153
    Giving a list of files will revert only those files.  Otherwise, all files
3761
4154
    will be reverted.  If the revision is not specified with '--revision', the
3775
4168
    name.  If you name a directory, all the contents of that directory will be
3776
4169
    reverted.
3777
4170
 
3778
 
    Any files that have been newly added since that revision will be deleted,
3779
 
    with a backup kept if appropriate.  Directories containing unknown files
3780
 
    will not be deleted.
 
4171
    If you have newly added files since the target revision, they will be
 
4172
    removed.  If the files to be removed have been changed, backups will be
 
4173
    created as above.  Directories containing unknown files will not be
 
4174
    deleted.
3781
4175
 
3782
 
    The working tree contains a list of pending merged revisions, which will
3783
 
    be included as parents in the next commit.  Normally, revert clears that
3784
 
    list as well as reverting the files.  If any files are specified, revert
3785
 
    leaves the pending merge list alone and reverts only the files.  Use "bzr
3786
 
    revert ." in the tree root to revert all files but keep the merge record,
3787
 
    and "bzr revert --forget-merges" to clear the pending merge list without
 
4176
    The working tree contains a list of revisions that have been merged but
 
4177
    not yet committed. These revisions will be included as additional parents
 
4178
    of the next commit.  Normally, using revert clears that list as well as
 
4179
    reverting the files.  If any files are specified, revert leaves the list
 
4180
    of uncommitted merges alone and reverts only the files.  Use ``bzr revert
 
4181
    .`` in the tree root to revert all files but keep the recorded merges,
 
4182
    and ``bzr revert --forget-merges`` to clear the pending merge list without
3788
4183
    reverting any files.
 
4184
 
 
4185
    Using "bzr revert --forget-merges", it is possible to apply all of the
 
4186
    changes from a branch in a single revision.  To do this, perform the merge
 
4187
    as desired.  Then doing revert with the "--forget-merges" option will keep
 
4188
    the content of the tree as it was, but it will clear the list of pending
 
4189
    merges.  The next commit will then contain all of the changes that are
 
4190
    present in the other branch, but without any other parent revisions.
 
4191
    Because this technique forgets where these changes originated, it may
 
4192
    cause additional conflicts on later merges involving the same source and
 
4193
    target branches.
3789
4194
    """
3790
4195
 
3791
4196
    _see_also = ['cat', 'export']
3800
4205
    def run(self, revision=None, no_backup=False, file_list=None,
3801
4206
            forget_merges=None):
3802
4207
        tree, file_list = tree_files(file_list)
3803
 
        tree.lock_write()
3804
 
        try:
3805
 
            if forget_merges:
3806
 
                tree.set_parent_ids(tree.get_parent_ids()[:1])
3807
 
            else:
3808
 
                self._revert_tree_to_revision(tree, revision, file_list, no_backup)
3809
 
        finally:
3810
 
            tree.unlock()
 
4208
        tree.lock_tree_write()
 
4209
        self.add_cleanup(tree.unlock)
 
4210
        if forget_merges:
 
4211
            tree.set_parent_ids(tree.get_parent_ids()[:1])
 
4212
        else:
 
4213
            self._revert_tree_to_revision(tree, revision, file_list, no_backup)
3811
4214
 
3812
4215
    @staticmethod
3813
4216
    def _revert_tree_to_revision(tree, revision, file_list, no_backup):
3814
4217
        rev_tree = _get_one_revision_tree('revert', revision, tree=tree)
3815
 
        pb = ui.ui_factory.nested_progress_bar()
3816
 
        try:
3817
 
            tree.revert(file_list, rev_tree, not no_backup, pb,
3818
 
                report_changes=True)
3819
 
        finally:
3820
 
            pb.finished()
 
4218
        tree.revert(file_list, rev_tree, not no_backup, None,
 
4219
            report_changes=True)
3821
4220
 
3822
4221
 
3823
4222
class cmd_assert_fail(Command):
3824
 
    """Test reporting of assertion failures"""
 
4223
    __doc__ = """Test reporting of assertion failures"""
3825
4224
    # intended just for use in testing
3826
4225
 
3827
4226
    hidden = True
3831
4230
 
3832
4231
 
3833
4232
class cmd_help(Command):
3834
 
    """Show help on a command or other topic.
 
4233
    __doc__ = """Show help on a command or other topic.
3835
4234
    """
3836
4235
 
3837
4236
    _see_also = ['topics']
3850
4249
 
3851
4250
 
3852
4251
class cmd_shell_complete(Command):
3853
 
    """Show appropriate completions for context.
 
4252
    __doc__ = """Show appropriate completions for context.
3854
4253
 
3855
4254
    For a list of all available commands, say 'bzr shell-complete'.
3856
4255
    """
3865
4264
 
3866
4265
 
3867
4266
class cmd_missing(Command):
3868
 
    """Show unmerged/unpulled revisions between two branches.
 
4267
    __doc__ = """Show unmerged/unpulled revisions between two branches.
3869
4268
 
3870
4269
    OTHER_BRANCH may be local or remote.
3871
4270
 
3872
4271
    To filter on a range of revisions, you can use the command -r begin..end
3873
4272
    -r revision requests a specific revision, -r ..end or -r begin.. are
3874
4273
    also valid.
 
4274
            
 
4275
    :Exit values:
 
4276
        1 - some missing revisions
 
4277
        0 - no missing revisions
3875
4278
 
3876
4279
    :Examples:
3877
4280
 
3915
4318
            type=_parse_revision_str,
3916
4319
            help='Filter on local branch revisions (inclusive). '
3917
4320
                'See "help revisionspec" for details.'),
3918
 
        Option('include-merges', 'Show merged revisions.'),
 
4321
        Option('include-merges',
 
4322
               'Show all revisions in addition to the mainline ones.'),
3919
4323
        ]
3920
4324
    encoding_type = 'replace'
3921
4325
 
3944
4348
            restrict = 'remote'
3945
4349
 
3946
4350
        local_branch = Branch.open_containing(u".")[0]
 
4351
        local_branch.lock_read()
 
4352
        self.add_cleanup(local_branch.unlock)
 
4353
 
3947
4354
        parent = local_branch.get_parent()
3948
4355
        if other_branch is None:
3949
4356
            other_branch = parent
3958
4365
        remote_branch = Branch.open(other_branch)
3959
4366
        if remote_branch.base == local_branch.base:
3960
4367
            remote_branch = local_branch
 
4368
        else:
 
4369
            remote_branch.lock_read()
 
4370
            self.add_cleanup(remote_branch.unlock)
3961
4371
 
3962
4372
        local_revid_range = _revision_range_to_revid_range(
3963
4373
            _get_revision_range(my_revision, local_branch,
3967
4377
            _get_revision_range(revision,
3968
4378
                remote_branch, self.name()))
3969
4379
 
3970
 
        local_branch.lock_read()
3971
 
        try:
3972
 
            remote_branch.lock_read()
3973
 
            try:
3974
 
                local_extra, remote_extra = find_unmerged(
3975
 
                    local_branch, remote_branch, restrict,
3976
 
                    backward=not reverse,
3977
 
                    include_merges=include_merges,
3978
 
                    local_revid_range=local_revid_range,
3979
 
                    remote_revid_range=remote_revid_range)
3980
 
 
3981
 
                if log_format is None:
3982
 
                    registry = log.log_formatter_registry
3983
 
                    log_format = registry.get_default(local_branch)
3984
 
                lf = log_format(to_file=self.outf,
3985
 
                                show_ids=show_ids,
3986
 
                                show_timezone='original')
3987
 
 
3988
 
                status_code = 0
3989
 
                if local_extra and not theirs_only:
3990
 
                    message("You have %d extra revision(s):\n" %
3991
 
                        len(local_extra))
3992
 
                    for revision in iter_log_revisions(local_extra,
3993
 
                                        local_branch.repository,
3994
 
                                        verbose):
3995
 
                        lf.log_revision(revision)
3996
 
                    printed_local = True
3997
 
                    status_code = 1
3998
 
                else:
3999
 
                    printed_local = False
4000
 
 
4001
 
                if remote_extra and not mine_only:
4002
 
                    if printed_local is True:
4003
 
                        message("\n\n\n")
4004
 
                    message("You are missing %d revision(s):\n" %
4005
 
                        len(remote_extra))
4006
 
                    for revision in iter_log_revisions(remote_extra,
4007
 
                                        remote_branch.repository,
4008
 
                                        verbose):
4009
 
                        lf.log_revision(revision)
4010
 
                    status_code = 1
4011
 
 
4012
 
                if mine_only and not local_extra:
4013
 
                    # We checked local, and found nothing extra
4014
 
                    message('This branch is up to date.\n')
4015
 
                elif theirs_only and not remote_extra:
4016
 
                    # We checked remote, and found nothing extra
4017
 
                    message('Other branch is up to date.\n')
4018
 
                elif not (mine_only or theirs_only or local_extra or
4019
 
                          remote_extra):
4020
 
                    # We checked both branches, and neither one had extra
4021
 
                    # revisions
4022
 
                    message("Branches are up to date.\n")
4023
 
            finally:
4024
 
                remote_branch.unlock()
4025
 
        finally:
4026
 
            local_branch.unlock()
 
4380
        local_extra, remote_extra = find_unmerged(
 
4381
            local_branch, remote_branch, restrict,
 
4382
            backward=not reverse,
 
4383
            include_merges=include_merges,
 
4384
            local_revid_range=local_revid_range,
 
4385
            remote_revid_range=remote_revid_range)
 
4386
 
 
4387
        if log_format is None:
 
4388
            registry = log.log_formatter_registry
 
4389
            log_format = registry.get_default(local_branch)
 
4390
        lf = log_format(to_file=self.outf,
 
4391
                        show_ids=show_ids,
 
4392
                        show_timezone='original')
 
4393
 
 
4394
        status_code = 0
 
4395
        if local_extra and not theirs_only:
 
4396
            message("You have %d extra revision(s):\n" %
 
4397
                len(local_extra))
 
4398
            for revision in iter_log_revisions(local_extra,
 
4399
                                local_branch.repository,
 
4400
                                verbose):
 
4401
                lf.log_revision(revision)
 
4402
            printed_local = True
 
4403
            status_code = 1
 
4404
        else:
 
4405
            printed_local = False
 
4406
 
 
4407
        if remote_extra and not mine_only:
 
4408
            if printed_local is True:
 
4409
                message("\n\n\n")
 
4410
            message("You are missing %d revision(s):\n" %
 
4411
                len(remote_extra))
 
4412
            for revision in iter_log_revisions(remote_extra,
 
4413
                                remote_branch.repository,
 
4414
                                verbose):
 
4415
                lf.log_revision(revision)
 
4416
            status_code = 1
 
4417
 
 
4418
        if mine_only and not local_extra:
 
4419
            # We checked local, and found nothing extra
 
4420
            message('This branch is up to date.\n')
 
4421
        elif theirs_only and not remote_extra:
 
4422
            # We checked remote, and found nothing extra
 
4423
            message('Other branch is up to date.\n')
 
4424
        elif not (mine_only or theirs_only or local_extra or
 
4425
                  remote_extra):
 
4426
            # We checked both branches, and neither one had extra
 
4427
            # revisions
 
4428
            message("Branches are up to date.\n")
 
4429
        self.cleanup_now()
4027
4430
        if not status_code and parent is None and other_branch is not None:
4028
4431
            local_branch.lock_write()
4029
 
            try:
4030
 
                # handle race conditions - a parent might be set while we run.
4031
 
                if local_branch.get_parent() is None:
4032
 
                    local_branch.set_parent(remote_branch.base)
4033
 
            finally:
4034
 
                local_branch.unlock()
 
4432
            self.add_cleanup(local_branch.unlock)
 
4433
            # handle race conditions - a parent might be set while we run.
 
4434
            if local_branch.get_parent() is None:
 
4435
                local_branch.set_parent(remote_branch.base)
4035
4436
        return status_code
4036
4437
 
4037
4438
 
4038
4439
class cmd_pack(Command):
4039
 
    """Compress the data within a repository."""
 
4440
    __doc__ = """Compress the data within a repository.
 
4441
 
 
4442
    This operation compresses the data within a bazaar repository. As
 
4443
    bazaar supports automatic packing of repository, this operation is
 
4444
    normally not required to be done manually.
 
4445
 
 
4446
    During the pack operation, bazaar takes a backup of existing repository
 
4447
    data, i.e. pack files. This backup is eventually removed by bazaar
 
4448
    automatically when it is safe to do so. To save disk space by removing
 
4449
    the backed up pack files, the --clean-obsolete-packs option may be
 
4450
    used.
 
4451
 
 
4452
    Warning: If you use --clean-obsolete-packs and your machine crashes
 
4453
    during or immediately after repacking, you may be left with a state
 
4454
    where the deletion has been written to disk but the new packs have not
 
4455
    been. In this case the repository may be unusable.
 
4456
    """
4040
4457
 
4041
4458
    _see_also = ['repositories']
4042
4459
    takes_args = ['branch_or_repo?']
 
4460
    takes_options = [
 
4461
        Option('clean-obsolete-packs', 'Delete obsolete packs to save disk space.'),
 
4462
        ]
4043
4463
 
4044
 
    def run(self, branch_or_repo='.'):
 
4464
    def run(self, branch_or_repo='.', clean_obsolete_packs=False):
4045
4465
        dir = bzrdir.BzrDir.open_containing(branch_or_repo)[0]
4046
4466
        try:
4047
4467
            branch = dir.open_branch()
4048
4468
            repository = branch.repository
4049
4469
        except errors.NotBranchError:
4050
4470
            repository = dir.open_repository()
4051
 
        repository.pack()
 
4471
        repository.pack(clean_obsolete_packs=clean_obsolete_packs)
4052
4472
 
4053
4473
 
4054
4474
class cmd_plugins(Command):
4055
 
    """List the installed plugins.
 
4475
    __doc__ = """List the installed plugins.
4056
4476
 
4057
4477
    This command displays the list of installed plugins including
4058
4478
    version of plugin and a short description of each.
4065
4485
    adding new commands, providing additional network transports and
4066
4486
    customizing log output.
4067
4487
 
4068
 
    See the Bazaar web site, http://bazaar-vcs.org, for further
4069
 
    information on plugins including where to find them and how to
4070
 
    install them. Instructions are also provided there on how to
4071
 
    write new plugins using the Python programming language.
 
4488
    See the Bazaar Plugin Guide <http://doc.bazaar.canonical.com/plugins/en/>
 
4489
    for further information on plugins including where to find them and how to
 
4490
    install them. Instructions are also provided there on how to write new
 
4491
    plugins using the Python programming language.
4072
4492
    """
4073
4493
    takes_options = ['verbose']
4074
4494
 
4089
4509
                doc = '(no description)'
4090
4510
            result.append((name_ver, doc, plugin.path()))
4091
4511
        for name_ver, doc, path in sorted(result):
4092
 
            print name_ver
4093
 
            print '   ', doc
 
4512
            self.outf.write("%s\n" % name_ver)
 
4513
            self.outf.write("   %s\n" % doc)
4094
4514
            if verbose:
4095
 
                print '   ', path
4096
 
            print
 
4515
                self.outf.write("   %s\n" % path)
 
4516
            self.outf.write("\n")
4097
4517
 
4098
4518
 
4099
4519
class cmd_testament(Command):
4100
 
    """Show testament (signing-form) of a revision."""
 
4520
    __doc__ = """Show testament (signing-form) of a revision."""
4101
4521
    takes_options = [
4102
4522
            'revision',
4103
4523
            Option('long', help='Produce long-format testament.'),
4116
4536
        else:
4117
4537
            b = Branch.open(branch)
4118
4538
        b.lock_read()
4119
 
        try:
4120
 
            if revision is None:
4121
 
                rev_id = b.last_revision()
4122
 
            else:
4123
 
                rev_id = revision[0].as_revision_id(b)
4124
 
            t = testament_class.from_revision(b.repository, rev_id)
4125
 
            if long:
4126
 
                sys.stdout.writelines(t.as_text_lines())
4127
 
            else:
4128
 
                sys.stdout.write(t.as_short_text())
4129
 
        finally:
4130
 
            b.unlock()
 
4539
        self.add_cleanup(b.unlock)
 
4540
        if revision is None:
 
4541
            rev_id = b.last_revision()
 
4542
        else:
 
4543
            rev_id = revision[0].as_revision_id(b)
 
4544
        t = testament_class.from_revision(b.repository, rev_id)
 
4545
        if long:
 
4546
            sys.stdout.writelines(t.as_text_lines())
 
4547
        else:
 
4548
            sys.stdout.write(t.as_short_text())
4131
4549
 
4132
4550
 
4133
4551
class cmd_annotate(Command):
4134
 
    """Show the origin of each line in a file.
 
4552
    __doc__ = """Show the origin of each line in a file.
4135
4553
 
4136
4554
    This prints out the given file with an annotation on the left side
4137
4555
    indicating which revision, author and date introduced the change.
4159
4577
            bzrdir.BzrDir.open_containing_tree_or_branch(filename)
4160
4578
        if wt is not None:
4161
4579
            wt.lock_read()
 
4580
            self.add_cleanup(wt.unlock)
4162
4581
        else:
4163
4582
            branch.lock_read()
4164
 
        try:
4165
 
            tree = _get_one_revision_tree('annotate', revision, branch=branch)
4166
 
            if wt is not None:
4167
 
                file_id = wt.path2id(relpath)
4168
 
            else:
4169
 
                file_id = tree.path2id(relpath)
4170
 
            if file_id is None:
4171
 
                raise errors.NotVersionedError(filename)
4172
 
            file_version = tree.inventory[file_id].revision
4173
 
            if wt is not None and revision is None:
4174
 
                # If there is a tree and we're not annotating historical
4175
 
                # versions, annotate the working tree's content.
4176
 
                annotate_file_tree(wt, file_id, self.outf, long, all,
4177
 
                    show_ids=show_ids)
4178
 
            else:
4179
 
                annotate_file(branch, file_version, file_id, long, all, self.outf,
4180
 
                              show_ids=show_ids)
4181
 
        finally:
4182
 
            if wt is not None:
4183
 
                wt.unlock()
4184
 
            else:
4185
 
                branch.unlock()
 
4583
            self.add_cleanup(branch.unlock)
 
4584
        tree = _get_one_revision_tree('annotate', revision, branch=branch)
 
4585
        tree.lock_read()
 
4586
        self.add_cleanup(tree.unlock)
 
4587
        if wt is not None:
 
4588
            file_id = wt.path2id(relpath)
 
4589
        else:
 
4590
            file_id = tree.path2id(relpath)
 
4591
        if file_id is None:
 
4592
            raise errors.NotVersionedError(filename)
 
4593
        file_version = tree.inventory[file_id].revision
 
4594
        if wt is not None and revision is None:
 
4595
            # If there is a tree and we're not annotating historical
 
4596
            # versions, annotate the working tree's content.
 
4597
            annotate_file_tree(wt, file_id, self.outf, long, all,
 
4598
                show_ids=show_ids)
 
4599
        else:
 
4600
            annotate_file(branch, file_version, file_id, long, all, self.outf,
 
4601
                          show_ids=show_ids)
4186
4602
 
4187
4603
 
4188
4604
class cmd_re_sign(Command):
4189
 
    """Create a digital signature for an existing revision."""
 
4605
    __doc__ = """Create a digital signature for an existing revision."""
4190
4606
    # TODO be able to replace existing ones.
4191
4607
 
4192
4608
    hidden = True # is this right ?
4200
4616
            raise errors.BzrCommandError('You must supply either --revision or a revision_id')
4201
4617
        b = WorkingTree.open_containing(u'.')[0].branch
4202
4618
        b.lock_write()
4203
 
        try:
4204
 
            return self._run(b, revision_id_list, revision)
4205
 
        finally:
4206
 
            b.unlock()
 
4619
        self.add_cleanup(b.unlock)
 
4620
        return self._run(b, revision_id_list, revision)
4207
4621
 
4208
4622
    def _run(self, b, revision_id_list, revision):
4209
4623
        import bzrlib.gpg as gpg
4254
4668
 
4255
4669
 
4256
4670
class cmd_bind(Command):
4257
 
    """Convert the current branch into a checkout of the supplied branch.
 
4671
    __doc__ = """Convert the current branch into a checkout of the supplied branch.
4258
4672
 
4259
4673
    Once converted into a checkout, commits must succeed on the master branch
4260
4674
    before they will be applied to the local branch.
4261
4675
 
4262
4676
    Bound branches use the nickname of its master branch unless it is set
4263
 
    locally, in which case binding will update the the local nickname to be
 
4677
    locally, in which case binding will update the local nickname to be
4264
4678
    that of the master.
4265
4679
    """
4266
4680
 
4278
4692
                    'This format does not remember old locations.')
4279
4693
            else:
4280
4694
                if location is None:
4281
 
                    raise errors.BzrCommandError('No location supplied and no '
4282
 
                        'previous location known')
 
4695
                    if b.get_bound_location() is not None:
 
4696
                        raise errors.BzrCommandError('Branch is already bound')
 
4697
                    else:
 
4698
                        raise errors.BzrCommandError('No location supplied '
 
4699
                            'and no previous location known')
4283
4700
        b_other = Branch.open(location)
4284
4701
        try:
4285
4702
            b.bind(b_other)
4291
4708
 
4292
4709
 
4293
4710
class cmd_unbind(Command):
4294
 
    """Convert the current checkout into a regular branch.
 
4711
    __doc__ = """Convert the current checkout into a regular branch.
4295
4712
 
4296
4713
    After unbinding, the local branch is considered independent and subsequent
4297
4714
    commits will be local only.
4308
4725
 
4309
4726
 
4310
4727
class cmd_uncommit(Command):
4311
 
    """Remove the last committed revision.
 
4728
    __doc__ = """Remove the last committed revision.
4312
4729
 
4313
4730
    --verbose will print out what is being removed.
4314
4731
    --dry-run will go through all the motions, but not actually
4355
4772
 
4356
4773
        if tree is not None:
4357
4774
            tree.lock_write()
 
4775
            self.add_cleanup(tree.unlock)
4358
4776
        else:
4359
4777
            b.lock_write()
4360
 
        try:
4361
 
            return self._run(b, tree, dry_run, verbose, revision, force,
4362
 
                             local=local)
4363
 
        finally:
4364
 
            if tree is not None:
4365
 
                tree.unlock()
4366
 
            else:
4367
 
                b.unlock()
 
4778
            self.add_cleanup(b.unlock)
 
4779
        return self._run(b, tree, dry_run, verbose, revision, force, local=local)
4368
4780
 
4369
4781
    def _run(self, b, tree, dry_run, verbose, revision, force, local=False):
4370
4782
        from bzrlib.log import log_formatter, show_log
4402
4814
                 end_revision=last_revno)
4403
4815
 
4404
4816
        if dry_run:
4405
 
            print 'Dry-run, pretending to remove the above revisions.'
4406
 
            if not force:
4407
 
                val = raw_input('Press <enter> to continue')
 
4817
            self.outf.write('Dry-run, pretending to remove'
 
4818
                            ' the above revisions.\n')
4408
4819
        else:
4409
 
            print 'The above revision(s) will be removed.'
4410
 
            if not force:
4411
 
                val = raw_input('Are you sure [y/N]? ')
4412
 
                if val.lower() not in ('y', 'yes'):
4413
 
                    print 'Canceled'
4414
 
                    return 0
 
4820
            self.outf.write('The above revision(s) will be removed.\n')
 
4821
 
 
4822
        if not force:
 
4823
            if not ui.ui_factory.get_boolean('Are you sure'):
 
4824
                self.outf.write('Canceled')
 
4825
                return 0
4415
4826
 
4416
4827
        mutter('Uncommitting from {%s} to {%s}',
4417
4828
               last_rev_id, rev_id)
4418
4829
        uncommit(b, tree=tree, dry_run=dry_run, verbose=verbose,
4419
4830
                 revno=revno, local=local)
4420
 
        note('You can restore the old tip by running:\n'
4421
 
             '  bzr pull . -r revid:%s', last_rev_id)
 
4831
        self.outf.write('You can restore the old tip by running:\n'
 
4832
             '  bzr pull . -r revid:%s\n' % last_rev_id)
4422
4833
 
4423
4834
 
4424
4835
class cmd_break_lock(Command):
4425
 
    """Break a dead lock on a repository, branch or working directory.
 
4836
    __doc__ = """Break a dead lock on a repository, branch or working directory.
4426
4837
 
4427
4838
    CAUTION: Locks should only be broken when you are sure that the process
4428
4839
    holding the lock has been stopped.
4429
4840
 
4430
 
    You can get information on what locks are open via the 'bzr info' command.
 
4841
    You can get information on what locks are open via the 'bzr info
 
4842
    [location]' command.
4431
4843
 
4432
4844
    :Examples:
4433
4845
        bzr break-lock
 
4846
        bzr break-lock bzr+ssh://example.com/bzr/foo
4434
4847
    """
4435
4848
    takes_args = ['location?']
4436
4849
 
4445
4858
 
4446
4859
 
4447
4860
class cmd_wait_until_signalled(Command):
4448
 
    """Test helper for test_start_and_stop_bzr_subprocess_send_signal.
 
4861
    __doc__ = """Test helper for test_start_and_stop_bzr_subprocess_send_signal.
4449
4862
 
4450
4863
    This just prints a line to signal when it is ready, then blocks on stdin.
4451
4864
    """
4459
4872
 
4460
4873
 
4461
4874
class cmd_serve(Command):
4462
 
    """Run the bzr server."""
 
4875
    __doc__ = """Run the bzr server."""
4463
4876
 
4464
4877
    aliases = ['server']
4465
4878
 
4466
4879
    takes_options = [
4467
4880
        Option('inet',
4468
4881
               help='Serve on stdin/out for use from inetd or sshd.'),
 
4882
        RegistryOption('protocol',
 
4883
               help="Protocol to serve.",
 
4884
               lazy_registry=('bzrlib.transport', 'transport_server_registry'),
 
4885
               value_switches=True),
4469
4886
        Option('port',
4470
4887
               help='Listen for connections on nominated port of the form '
4471
4888
                    '[hostname:]portnumber.  Passing 0 as the port number will '
4472
 
                    'result in a dynamically allocated port.  The default port is '
4473
 
                    '4155.',
 
4889
                    'result in a dynamically allocated port.  The default port '
 
4890
                    'depends on the protocol.',
4474
4891
               type=str),
4475
4892
        Option('directory',
4476
4893
               help='Serve contents of this directory.',
4478
4895
        Option('allow-writes',
4479
4896
               help='By default the server is a readonly server.  Supplying '
4480
4897
                    '--allow-writes enables write access to the contents of '
4481
 
                    'the served directory and below.'
 
4898
                    'the served directory and below.  Note that ``bzr serve`` '
 
4899
                    'does not perform authentication, so unless some form of '
 
4900
                    'external authentication is arranged supplying this '
 
4901
                    'option leads to global uncontrolled write access to your '
 
4902
                    'file system.'
4482
4903
                ),
4483
4904
        ]
4484
4905
 
4485
 
    def run_smart_server(self, smart_server):
4486
 
        """Run 'smart_server' forever, with no UI output at all."""
4487
 
        # For the duration of this server, no UI output is permitted. note
4488
 
        # that this may cause problems with blackbox tests. This should be
4489
 
        # changed with care though, as we dont want to use bandwidth sending
4490
 
        # progress over stderr to smart server clients!
4491
 
        from bzrlib import lockdir
4492
 
        old_factory = ui.ui_factory
4493
 
        old_lockdir_timeout = lockdir._DEFAULT_TIMEOUT_SECONDS
4494
 
        try:
4495
 
            ui.ui_factory = ui.SilentUIFactory()
4496
 
            lockdir._DEFAULT_TIMEOUT_SECONDS = 0
4497
 
            smart_server.serve()
4498
 
        finally:
4499
 
            ui.ui_factory = old_factory
4500
 
            lockdir._DEFAULT_TIMEOUT_SECONDS = old_lockdir_timeout
4501
 
 
4502
4906
    def get_host_and_port(self, port):
4503
4907
        """Return the host and port to run the smart server on.
4504
4908
 
4505
 
        If 'port' is None, the default host (`medium.BZR_DEFAULT_INTERFACE`)
4506
 
        and port (`medium.BZR_DEFAULT_PORT`) will be used.
 
4909
        If 'port' is None, None will be returned for the host and port.
4507
4910
 
4508
4911
        If 'port' has a colon in it, the string before the colon will be
4509
4912
        interpreted as the host.
4512
4915
        :return: A tuple of (host, port), where 'host' is a host name or IP,
4513
4916
            and port is an integer TCP/IP port.
4514
4917
        """
4515
 
        from bzrlib.smart import medium
4516
 
        host = medium.BZR_DEFAULT_INTERFACE
4517
 
        if port is None:
4518
 
            port = medium.BZR_DEFAULT_PORT
4519
 
        else:
 
4918
        host = None
 
4919
        if port is not None:
4520
4920
            if ':' in port:
4521
4921
                host, port = port.split(':')
4522
4922
            port = int(port)
4523
4923
        return host, port
4524
4924
 
4525
 
    def get_smart_server(self, transport, inet, port):
4526
 
        """Construct a smart server.
4527
 
 
4528
 
        :param transport: The base transport from which branches will be
4529
 
            served.
4530
 
        :param inet: If True, serve over stdin and stdout. Used for running
4531
 
            from inet.
4532
 
        :param port: The port to listen on. By default, it's `
4533
 
            medium.BZR_DEFAULT_PORT`. See `get_host_and_port` for more
4534
 
            information.
4535
 
        :return: A smart server.
4536
 
        """
4537
 
        from bzrlib.smart import medium, server
4538
 
        if inet:
4539
 
            smart_server = medium.SmartServerPipeStreamMedium(
4540
 
                sys.stdin, sys.stdout, transport)
4541
 
        else:
4542
 
            host, port = self.get_host_and_port(port)
4543
 
            smart_server = server.SmartTCPServer(
4544
 
                transport, host=host, port=port)
4545
 
            note('listening on port: %s' % smart_server.port)
4546
 
        return smart_server
4547
 
 
4548
 
    def run(self, port=None, inet=False, directory=None, allow_writes=False):
4549
 
        from bzrlib.transport import get_transport
4550
 
        from bzrlib.transport.chroot import ChrootServer
 
4925
    def run(self, port=None, inet=False, directory=None, allow_writes=False,
 
4926
            protocol=None):
 
4927
        from bzrlib.transport import get_transport, transport_server_registry
4551
4928
        if directory is None:
4552
4929
            directory = os.getcwd()
 
4930
        if protocol is None:
 
4931
            protocol = transport_server_registry.get()
 
4932
        host, port = self.get_host_and_port(port)
4553
4933
        url = urlutils.local_path_to_url(directory)
4554
4934
        if not allow_writes:
4555
4935
            url = 'readonly+' + url
4556
 
        chroot_server = ChrootServer(get_transport(url))
4557
 
        chroot_server.setUp()
4558
 
        t = get_transport(chroot_server.get_url())
4559
 
        smart_server = self.get_smart_server(t, inet, port)
4560
 
        self.run_smart_server(smart_server)
 
4936
        transport = get_transport(url)
 
4937
        protocol(transport, host, port, inet)
4561
4938
 
4562
4939
 
4563
4940
class cmd_join(Command):
4564
 
    """Combine a subtree into its containing tree.
 
4941
    __doc__ = """Combine a tree into its containing tree.
4565
4942
 
4566
 
    This command is for experimental use only.  It requires the target tree
4567
 
    to be in dirstate-with-subtree format, which cannot be converted into
4568
 
    earlier formats.
 
4943
    This command requires the target tree to be in a rich-root format.
4569
4944
 
4570
4945
    The TREE argument should be an independent tree, inside another tree, but
4571
4946
    not part of it.  (Such trees can be produced by "bzr split", but also by
4574
4949
    The result is a combined tree, with the subtree no longer an independant
4575
4950
    part.  This is marked as a merge of the subtree into the containing tree,
4576
4951
    and all history is preserved.
4577
 
 
4578
 
    If --reference is specified, the subtree retains its independence.  It can
4579
 
    be branched by itself, and can be part of multiple projects at the same
4580
 
    time.  But operations performed in the containing tree, such as commit
4581
 
    and merge, will recurse into the subtree.
4582
4952
    """
4583
4953
 
4584
4954
    _see_also = ['split']
4585
4955
    takes_args = ['tree']
4586
4956
    takes_options = [
4587
 
            Option('reference', help='Join by reference.'),
 
4957
            Option('reference', help='Join by reference.', hidden=True),
4588
4958
            ]
4589
 
    hidden = True
4590
4959
 
4591
4960
    def run(self, tree, reference=False):
4592
4961
        sub_tree = WorkingTree.open(tree)
4615
4984
 
4616
4985
 
4617
4986
class cmd_split(Command):
4618
 
    """Split a subdirectory of a tree into a separate tree.
 
4987
    __doc__ = """Split a subdirectory of a tree into a separate tree.
4619
4988
 
4620
4989
    This command will produce a target tree in a format that supports
4621
4990
    rich roots, like 'rich-root' or 'rich-root-pack'.  These formats cannot be
4626
4995
    branch.  Commits in the top-level tree will not apply to the new subtree.
4627
4996
    """
4628
4997
 
4629
 
    # join is not un-hidden yet
4630
 
    #_see_also = ['join']
 
4998
    _see_also = ['join']
4631
4999
    takes_args = ['tree']
4632
5000
 
4633
5001
    def run(self, tree):
4638
5006
        try:
4639
5007
            containing_tree.extract(sub_id)
4640
5008
        except errors.RootNotRich:
4641
 
            raise errors.UpgradeRequired(containing_tree.branch.base)
 
5009
            raise errors.RichRootUpgradeRequired(containing_tree.branch.base)
4642
5010
 
4643
5011
 
4644
5012
class cmd_merge_directive(Command):
4645
 
    """Generate a merge directive for auto-merge tools.
 
5013
    __doc__ = """Generate a merge directive for auto-merge tools.
4646
5014
 
4647
5015
    A directive requests a merge to be performed, and also provides all the
4648
5016
    information necessary to do so.  This means it must either include a
4741
5109
 
4742
5110
 
4743
5111
class cmd_send(Command):
4744
 
    """Mail or create a merge-directive for submitting changes.
 
5112
    __doc__ = """Mail or create a merge-directive for submitting changes.
4745
5113
 
4746
5114
    A merge directive provides many things needed for requesting merges:
4747
5115
 
4753
5121
      directly from the merge directive, without retrieving data from a
4754
5122
      branch.
4755
5123
 
4756
 
    If --no-bundle is specified, then public_branch is needed (and must be
4757
 
    up-to-date), so that the receiver can perform the merge using the
4758
 
    public_branch.  The public_branch is always included if known, so that
4759
 
    people can check it later.
4760
 
 
4761
 
    The submit branch defaults to the parent, but can be overridden.  Both
4762
 
    submit branch and public branch will be remembered if supplied.
4763
 
 
4764
 
    If a public_branch is known for the submit_branch, that public submit
4765
 
    branch is used in the merge instructions.  This means that a local mirror
4766
 
    can be used as your actual submit branch, once you have set public_branch
4767
 
    for that mirror.
 
5124
    `bzr send` creates a compact data set that, when applied using bzr
 
5125
    merge, has the same effect as merging from the source branch.  
 
5126
    
 
5127
    By default the merge directive is self-contained and can be applied to any
 
5128
    branch containing submit_branch in its ancestory without needing access to
 
5129
    the source branch.
 
5130
    
 
5131
    If --no-bundle is specified, then Bazaar doesn't send the contents of the
 
5132
    revisions, but only a structured request to merge from the
 
5133
    public_location.  In that case the public_branch is needed and it must be
 
5134
    up-to-date and accessible to the recipient.  The public_branch is always
 
5135
    included if known, so that people can check it later.
 
5136
 
 
5137
    The submit branch defaults to the parent of the source branch, but can be
 
5138
    overridden.  Both submit branch and public branch will be remembered in
 
5139
    branch.conf the first time they are used for a particular branch.  The
 
5140
    source branch defaults to that containing the working directory, but can
 
5141
    be changed using --from.
 
5142
 
 
5143
    In order to calculate those changes, bzr must analyse the submit branch.
 
5144
    Therefore it is most efficient for the submit branch to be a local mirror.
 
5145
    If a public location is known for the submit_branch, that location is used
 
5146
    in the merge directive.
 
5147
 
 
5148
    The default behaviour is to send the merge directive by mail, unless -o is
 
5149
    given, in which case it is sent to a file.
4768
5150
 
4769
5151
    Mail is sent using your preferred mail program.  This should be transparent
4770
5152
    on Windows (it uses MAPI).  On Linux, it requires the xdg-email utility.
4772
5154
 
4773
5155
    To use a specific mail program, set the mail_client configuration option.
4774
5156
    (For Thunderbird 1.5, this works around some bugs.)  Supported values for
4775
 
    specific clients are "claws", "evolution", "kmail", "mutt", and
4776
 
    "thunderbird"; generic options are "default", "editor", "emacsclient",
4777
 
    "mapi", and "xdg-email".  Plugins may also add supported clients.
 
5157
    specific clients are "claws", "evolution", "kmail", "mail.app" (MacOS X's
 
5158
    Mail.app), "mutt", and "thunderbird"; generic options are "default",
 
5159
    "editor", "emacsclient", "mapi", and "xdg-email".  Plugins may also add
 
5160
    supported clients.
4778
5161
 
4779
5162
    If mail is being sent, a to address is required.  This can be supplied
4780
5163
    either on the commandline, by setting the submit_to configuration
4789
5172
 
4790
5173
    The merge directives created by bzr send may be applied using bzr merge or
4791
5174
    bzr pull by specifying a file containing a merge directive as the location.
 
5175
 
 
5176
    bzr send makes extensive use of public locations to map local locations into
 
5177
    URLs that can be used by other people.  See `bzr help configuration` to
 
5178
    set them, and use `bzr info` to display them.
4792
5179
    """
4793
5180
 
4794
5181
    encoding_type = 'exact'
4810
5197
               short_name='f',
4811
5198
               type=unicode),
4812
5199
        Option('output', short_name='o',
4813
 
               help='Write merge directive to this file; '
 
5200
               help='Write merge directive to this file or directory; '
4814
5201
                    'use - for stdout.',
4815
5202
               type=unicode),
 
5203
        Option('strict',
 
5204
               help='Refuse to send if there are uncommitted changes in'
 
5205
               ' the working tree, --no-strict disables the check.'),
4816
5206
        Option('mail-to', help='Mail the request to this address.',
4817
5207
               type=unicode),
4818
5208
        'revision',
4819
5209
        'message',
4820
5210
        Option('body', help='Body for the email.', type=unicode),
4821
 
        RegistryOption.from_kwargs('format',
4822
 
        'Use the specified output format.',
4823
 
        **{'4': 'Bundle format 4, Merge Directive 2 (default)',
4824
 
           '0.9': 'Bundle format 0.9, Merge Directive 1',})
 
5211
        RegistryOption('format',
 
5212
                       help='Use the specified output format.',
 
5213
                       lazy_registry=('bzrlib.send', 'format_registry')),
4825
5214
        ]
4826
5215
 
4827
5216
    def run(self, submit_branch=None, public_branch=None, no_bundle=False,
4828
5217
            no_patch=False, revision=None, remember=False, output=None,
4829
 
            format='4', mail_to=None, message=None, body=None, **kwargs):
4830
 
        return self._run(submit_branch, revision, public_branch, remember,
4831
 
                         format, no_bundle, no_patch, output,
4832
 
                         kwargs.get('from', '.'), mail_to, message, body)
4833
 
 
4834
 
    def _run(self, submit_branch, revision, public_branch, remember, format,
4835
 
             no_bundle, no_patch, output, from_, mail_to, message, body):
4836
 
        from bzrlib.revision import NULL_REVISION
4837
 
        branch = Branch.open_containing(from_)[0]
4838
 
        if output is None:
4839
 
            outfile = cStringIO.StringIO()
4840
 
        elif output == '-':
4841
 
            outfile = self.outf
4842
 
        else:
4843
 
            outfile = open(output, 'wb')
4844
 
        # we may need to write data into branch's repository to calculate
4845
 
        # the data to send.
4846
 
        branch.lock_write()
4847
 
        try:
4848
 
            if output is None:
4849
 
                config = branch.get_config()
4850
 
                if mail_to is None:
4851
 
                    mail_to = config.get_user_option('submit_to')
4852
 
                mail_client = config.get_mail_client()
4853
 
                if (not getattr(mail_client, 'supports_body', False)
4854
 
                    and body is not None):
4855
 
                    raise errors.BzrCommandError(
4856
 
                        'Mail client "%s" does not support specifying body' %
4857
 
                        mail_client.__class__.__name__)
4858
 
            if remember and submit_branch is None:
4859
 
                raise errors.BzrCommandError(
4860
 
                    '--remember requires a branch to be specified.')
4861
 
            stored_submit_branch = branch.get_submit_branch()
4862
 
            remembered_submit_branch = None
4863
 
            if submit_branch is None:
4864
 
                submit_branch = stored_submit_branch
4865
 
                remembered_submit_branch = "submit"
4866
 
            else:
4867
 
                if stored_submit_branch is None or remember:
4868
 
                    branch.set_submit_branch(submit_branch)
4869
 
            if submit_branch is None:
4870
 
                submit_branch = branch.get_parent()
4871
 
                remembered_submit_branch = "parent"
4872
 
            if submit_branch is None:
4873
 
                raise errors.BzrCommandError('No submit branch known or'
4874
 
                                             ' specified')
4875
 
            if remembered_submit_branch is not None:
4876
 
                note('Using saved %s location "%s" to determine what '
4877
 
                        'changes to submit.', remembered_submit_branch,
4878
 
                        submit_branch)
4879
 
 
4880
 
            if mail_to is None:
4881
 
                submit_config = Branch.open(submit_branch).get_config()
4882
 
                mail_to = submit_config.get_user_option("child_submit_to")
4883
 
 
4884
 
            stored_public_branch = branch.get_public_branch()
4885
 
            if public_branch is None:
4886
 
                public_branch = stored_public_branch
4887
 
            elif stored_public_branch is None or remember:
4888
 
                branch.set_public_branch(public_branch)
4889
 
            if no_bundle and public_branch is None:
4890
 
                raise errors.BzrCommandError('No public branch specified or'
4891
 
                                             ' known')
4892
 
            base_revision_id = None
4893
 
            revision_id = None
4894
 
            if revision is not None:
4895
 
                if len(revision) > 2:
4896
 
                    raise errors.BzrCommandError('bzr send takes '
4897
 
                        'at most two one revision identifiers')
4898
 
                revision_id = revision[-1].as_revision_id(branch)
4899
 
                if len(revision) == 2:
4900
 
                    base_revision_id = revision[0].as_revision_id(branch)
4901
 
            if revision_id is None:
4902
 
                revision_id = branch.last_revision()
4903
 
            if revision_id == NULL_REVISION:
4904
 
                raise errors.BzrCommandError('No revisions to submit.')
4905
 
            if format == '4':
4906
 
                directive = merge_directive.MergeDirective2.from_objects(
4907
 
                    branch.repository, revision_id, time.time(),
4908
 
                    osutils.local_time_offset(), submit_branch,
4909
 
                    public_branch=public_branch, include_patch=not no_patch,
4910
 
                    include_bundle=not no_bundle, message=message,
4911
 
                    base_revision_id=base_revision_id)
4912
 
            elif format == '0.9':
4913
 
                if not no_bundle:
4914
 
                    if not no_patch:
4915
 
                        patch_type = 'bundle'
4916
 
                    else:
4917
 
                        raise errors.BzrCommandError('Format 0.9 does not'
4918
 
                            ' permit bundle with no patch')
4919
 
                else:
4920
 
                    if not no_patch:
4921
 
                        patch_type = 'diff'
4922
 
                    else:
4923
 
                        patch_type = None
4924
 
                directive = merge_directive.MergeDirective.from_objects(
4925
 
                    branch.repository, revision_id, time.time(),
4926
 
                    osutils.local_time_offset(), submit_branch,
4927
 
                    public_branch=public_branch, patch_type=patch_type,
4928
 
                    message=message)
4929
 
 
4930
 
            outfile.writelines(directive.to_lines())
4931
 
            if output is None:
4932
 
                subject = '[MERGE] '
4933
 
                if message is not None:
4934
 
                    subject += message
4935
 
                else:
4936
 
                    revision = branch.repository.get_revision(revision_id)
4937
 
                    subject += revision.get_summary()
4938
 
                basename = directive.get_disk_name(branch)
4939
 
                mail_client.compose_merge_request(mail_to, subject,
4940
 
                                                  outfile.getvalue(),
4941
 
                                                  basename, body)
4942
 
        finally:
4943
 
            if output != '-':
4944
 
                outfile.close()
4945
 
            branch.unlock()
 
5218
            format=None, mail_to=None, message=None, body=None,
 
5219
            strict=None, **kwargs):
 
5220
        from bzrlib.send import send
 
5221
        return send(submit_branch, revision, public_branch, remember,
 
5222
                    format, no_bundle, no_patch, output,
 
5223
                    kwargs.get('from', '.'), mail_to, message, body,
 
5224
                    self.outf,
 
5225
                    strict=strict)
4946
5226
 
4947
5227
 
4948
5228
class cmd_bundle_revisions(cmd_send):
4949
 
 
4950
 
    """Create a merge-directive for submitting changes.
 
5229
    __doc__ = """Create a merge-directive for submitting changes.
4951
5230
 
4952
5231
    A merge directive provides many things needed for requesting merges:
4953
5232
 
4993
5272
               type=unicode),
4994
5273
        Option('output', short_name='o', help='Write directive to this file.',
4995
5274
               type=unicode),
 
5275
        Option('strict',
 
5276
               help='Refuse to bundle revisions if there are uncommitted'
 
5277
               ' changes in the working tree, --no-strict disables the check.'),
4996
5278
        'revision',
4997
 
        RegistryOption.from_kwargs('format',
4998
 
        'Use the specified output format.',
4999
 
        **{'4': 'Bundle format 4, Merge Directive 2 (default)',
5000
 
           '0.9': 'Bundle format 0.9, Merge Directive 1',})
 
5279
        RegistryOption('format',
 
5280
                       help='Use the specified output format.',
 
5281
                       lazy_registry=('bzrlib.send', 'format_registry')),
5001
5282
        ]
5002
5283
    aliases = ['bundle']
5003
5284
 
5007
5288
 
5008
5289
    def run(self, submit_branch=None, public_branch=None, no_bundle=False,
5009
5290
            no_patch=False, revision=None, remember=False, output=None,
5010
 
            format='4', **kwargs):
 
5291
            format=None, strict=None, **kwargs):
5011
5292
        if output is None:
5012
5293
            output = '-'
5013
 
        return self._run(submit_branch, revision, public_branch, remember,
 
5294
        from bzrlib.send import send
 
5295
        return send(submit_branch, revision, public_branch, remember,
5014
5296
                         format, no_bundle, no_patch, output,
5015
 
                         kwargs.get('from', '.'), None, None, None)
 
5297
                         kwargs.get('from', '.'), None, None, None,
 
5298
                         self.outf, strict=strict)
5016
5299
 
5017
5300
 
5018
5301
class cmd_tag(Command):
5019
 
    """Create, remove or modify a tag naming a revision.
 
5302
    __doc__ = """Create, remove or modify a tag naming a revision.
5020
5303
 
5021
5304
    Tags give human-meaningful names to revisions.  Commands that take a -r
5022
5305
    (--revision) option can be given -rtag:X, where X is any previously
5030
5313
 
5031
5314
    To rename a tag (change the name but keep it on the same revsion), run ``bzr
5032
5315
    tag new-name -r tag:old-name`` and then ``bzr tag --delete oldname``.
 
5316
 
 
5317
    If no tag name is specified it will be determined through the 
 
5318
    'automatic_tag_name' hook. This can e.g. be used to automatically tag
 
5319
    upstream releases by reading configure.ac. See ``bzr help hooks`` for
 
5320
    details.
5033
5321
    """
5034
5322
 
5035
5323
    _see_also = ['commit', 'tags']
5036
 
    takes_args = ['tag_name']
 
5324
    takes_args = ['tag_name?']
5037
5325
    takes_options = [
5038
5326
        Option('delete',
5039
5327
            help='Delete this tag rather than placing it.',
5049
5337
        'revision',
5050
5338
        ]
5051
5339
 
5052
 
    def run(self, tag_name,
 
5340
    def run(self, tag_name=None,
5053
5341
            delete=None,
5054
5342
            directory='.',
5055
5343
            force=None,
5057
5345
            ):
5058
5346
        branch, relpath = Branch.open_containing(directory)
5059
5347
        branch.lock_write()
5060
 
        try:
5061
 
            if delete:
5062
 
                branch.tags.delete_tag(tag_name)
5063
 
                self.outf.write('Deleted tag %s.\n' % tag_name)
 
5348
        self.add_cleanup(branch.unlock)
 
5349
        if delete:
 
5350
            if tag_name is None:
 
5351
                raise errors.BzrCommandError("No tag specified to delete.")
 
5352
            branch.tags.delete_tag(tag_name)
 
5353
            self.outf.write('Deleted tag %s.\n' % tag_name)
 
5354
        else:
 
5355
            if revision:
 
5356
                if len(revision) != 1:
 
5357
                    raise errors.BzrCommandError(
 
5358
                        "Tags can only be placed on a single revision, "
 
5359
                        "not on a range")
 
5360
                revision_id = revision[0].as_revision_id(branch)
5064
5361
            else:
5065
 
                if revision:
5066
 
                    if len(revision) != 1:
5067
 
                        raise errors.BzrCommandError(
5068
 
                            "Tags can only be placed on a single revision, "
5069
 
                            "not on a range")
5070
 
                    revision_id = revision[0].as_revision_id(branch)
5071
 
                else:
5072
 
                    revision_id = branch.last_revision()
5073
 
                if (not force) and branch.tags.has_tag(tag_name):
5074
 
                    raise errors.TagAlreadyExists(tag_name)
5075
 
                branch.tags.set_tag(tag_name, revision_id)
5076
 
                self.outf.write('Created tag %s.\n' % tag_name)
5077
 
        finally:
5078
 
            branch.unlock()
 
5362
                revision_id = branch.last_revision()
 
5363
            if tag_name is None:
 
5364
                tag_name = branch.automatic_tag_name(revision_id)
 
5365
                if tag_name is None:
 
5366
                    raise errors.BzrCommandError(
 
5367
                        "Please specify a tag name.")
 
5368
            if (not force) and branch.tags.has_tag(tag_name):
 
5369
                raise errors.TagAlreadyExists(tag_name)
 
5370
            branch.tags.set_tag(tag_name, revision_id)
 
5371
            self.outf.write('Created tag %s.\n' % tag_name)
5079
5372
 
5080
5373
 
5081
5374
class cmd_tags(Command):
5082
 
    """List tags.
 
5375
    __doc__ = """List tags.
5083
5376
 
5084
5377
    This command shows a table of tag names and the revisions they reference.
5085
5378
    """
5113
5406
        if not tags:
5114
5407
            return
5115
5408
 
 
5409
        branch.lock_read()
 
5410
        self.add_cleanup(branch.unlock)
5116
5411
        if revision:
5117
 
            branch.lock_read()
5118
 
            try:
5119
 
                graph = branch.repository.get_graph()
5120
 
                rev1, rev2 = _get_revision_range(revision, branch, self.name())
5121
 
                revid1, revid2 = rev1.rev_id, rev2.rev_id
5122
 
                # only show revisions between revid1 and revid2 (inclusive)
5123
 
                tags = [(tag, revid) for tag, revid in tags if
5124
 
                    graph.is_between(revid, revid1, revid2)]
5125
 
            finally:
5126
 
                branch.unlock()
 
5412
            graph = branch.repository.get_graph()
 
5413
            rev1, rev2 = _get_revision_range(revision, branch, self.name())
 
5414
            revid1, revid2 = rev1.rev_id, rev2.rev_id
 
5415
            # only show revisions between revid1 and revid2 (inclusive)
 
5416
            tags = [(tag, revid) for tag, revid in tags if
 
5417
                graph.is_between(revid, revid1, revid2)]
5127
5418
        if sort == 'alpha':
5128
5419
            tags.sort()
5129
5420
        elif sort == 'time':
5139
5430
            tags.sort(key=lambda x: timestamps[x[1]])
5140
5431
        if not show_ids:
5141
5432
            # [ (tag, revid), ... ] -> [ (tag, dotted_revno), ... ]
5142
 
            revno_map = branch.get_revision_id_to_revno_map()
5143
 
            tags = [ (tag, '.'.join(map(str, revno_map.get(revid, ('?',)))))
5144
 
                        for tag, revid in tags ]
 
5433
            for index, (tag, revid) in enumerate(tags):
 
5434
                try:
 
5435
                    revno = branch.revision_id_to_dotted_revno(revid)
 
5436
                    if isinstance(revno, tuple):
 
5437
                        revno = '.'.join(map(str, revno))
 
5438
                except errors.NoSuchRevision:
 
5439
                    # Bad tag data/merges can lead to tagged revisions
 
5440
                    # which are not in this branch. Fail gracefully ...
 
5441
                    revno = '?'
 
5442
                tags[index] = (tag, revno)
 
5443
        self.cleanup_now()
5145
5444
        for tag, revspec in tags:
5146
5445
            self.outf.write('%-20s %s\n' % (tag, revspec))
5147
5446
 
5148
5447
 
5149
5448
class cmd_reconfigure(Command):
5150
 
    """Reconfigure the type of a bzr directory.
 
5449
    __doc__ = """Reconfigure the type of a bzr directory.
5151
5450
 
5152
5451
    A target configuration must be specified.
5153
5452
 
5183
5482
            ),
5184
5483
        Option('bind-to', help='Branch to bind checkout to.', type=str),
5185
5484
        Option('force',
5186
 
               help='Perform reconfiguration even if local changes'
5187
 
               ' will be lost.')
 
5485
            help='Perform reconfiguration even if local changes'
 
5486
            ' will be lost.'),
 
5487
        Option('stacked-on',
 
5488
            help='Reconfigure a branch to be stacked on another branch.',
 
5489
            type=unicode,
 
5490
            ),
 
5491
        Option('unstacked',
 
5492
            help='Reconfigure a branch to be unstacked.  This '
 
5493
                'may require copying substantial data into it.',
 
5494
            ),
5188
5495
        ]
5189
5496
 
5190
 
    def run(self, location=None, target_type=None, bind_to=None, force=False):
 
5497
    def run(self, location=None, target_type=None, bind_to=None, force=False,
 
5498
            stacked_on=None,
 
5499
            unstacked=None):
5191
5500
        directory = bzrdir.BzrDir.open(location)
 
5501
        if stacked_on and unstacked:
 
5502
            raise BzrCommandError("Can't use both --stacked-on and --unstacked")
 
5503
        elif stacked_on is not None:
 
5504
            reconfigure.ReconfigureStackedOn().apply(directory, stacked_on)
 
5505
        elif unstacked:
 
5506
            reconfigure.ReconfigureUnstacked().apply(directory)
 
5507
        # At the moment you can use --stacked-on and a different
 
5508
        # reconfiguration shape at the same time; there seems no good reason
 
5509
        # to ban it.
5192
5510
        if target_type is None:
5193
 
            raise errors.BzrCommandError('No target configuration specified')
 
5511
            if stacked_on or unstacked:
 
5512
                return
 
5513
            else:
 
5514
                raise errors.BzrCommandError('No target configuration '
 
5515
                    'specified')
5194
5516
        elif target_type == 'branch':
5195
5517
            reconfiguration = reconfigure.Reconfigure.to_branch(directory)
5196
5518
        elif target_type == 'tree':
5215
5537
 
5216
5538
 
5217
5539
class cmd_switch(Command):
5218
 
    """Set the branch of a checkout and update.
 
5540
    __doc__ = """Set the branch of a checkout and update.
5219
5541
 
5220
5542
    For lightweight checkouts, this changes the branch being referenced.
5221
5543
    For heavyweight checkouts, this checks that there are no local commits
5233
5555
    /path/to/newbranch.
5234
5556
 
5235
5557
    Bound branches use the nickname of its master branch unless it is set
5236
 
    locally, in which case switching will update the the local nickname to be
 
5558
    locally, in which case switching will update the local nickname to be
5237
5559
    that of the master.
5238
5560
    """
5239
5561
 
5240
 
    takes_args = ['to_location']
 
5562
    takes_args = ['to_location?']
5241
5563
    takes_options = [Option('force',
5242
 
                        help='Switch even if local commits will be lost.')
5243
 
                     ]
 
5564
                        help='Switch even if local commits will be lost.'),
 
5565
                     'revision',
 
5566
                     Option('create-branch', short_name='b',
 
5567
                        help='Create the target branch from this one before'
 
5568
                             ' switching to it.'),
 
5569
                    ]
5244
5570
 
5245
 
    def run(self, to_location, force=False):
 
5571
    def run(self, to_location=None, force=False, create_branch=False,
 
5572
            revision=None):
5246
5573
        from bzrlib import switch
5247
5574
        tree_location = '.'
 
5575
        revision = _get_one_revision('switch', revision)
5248
5576
        control_dir = bzrdir.BzrDir.open_containing(tree_location)[0]
5249
 
        branch = control_dir.open_branch()
 
5577
        if to_location is None:
 
5578
            if revision is None:
 
5579
                raise errors.BzrCommandError('You must supply either a'
 
5580
                                             ' revision or a location')
 
5581
            to_location = '.'
5250
5582
        try:
5251
 
            to_branch = Branch.open(to_location)
 
5583
            branch = control_dir.open_branch()
 
5584
            had_explicit_nick = branch.get_config().has_explicit_nickname()
5252
5585
        except errors.NotBranchError:
5253
 
            this_branch = control_dir.open_branch()
5254
 
            # This may be a heavy checkout, where we want the master branch
5255
 
            this_url = this_branch.get_bound_location()
5256
 
            # If not, use a local sibling
5257
 
            if this_url is None:
5258
 
                this_url = this_branch.base
5259
 
            to_branch = Branch.open(
5260
 
                urlutils.join(this_url, '..', to_location))
5261
 
        switch.switch(control_dir, to_branch, force)
5262
 
        if branch.get_config().has_explicit_nickname():
 
5586
            branch = None
 
5587
            had_explicit_nick = False
 
5588
        if create_branch:
 
5589
            if branch is None:
 
5590
                raise errors.BzrCommandError('cannot create branch without'
 
5591
                                             ' source branch')
 
5592
            to_location = directory_service.directories.dereference(
 
5593
                              to_location)
 
5594
            if '/' not in to_location and '\\' not in to_location:
 
5595
                # This path is meant to be relative to the existing branch
 
5596
                this_url = self._get_branch_location(control_dir)
 
5597
                to_location = urlutils.join(this_url, '..', to_location)
 
5598
            to_branch = branch.bzrdir.sprout(to_location,
 
5599
                                 possible_transports=[branch.bzrdir.root_transport],
 
5600
                                 source_branch=branch).open_branch()
 
5601
        else:
 
5602
            try:
 
5603
                to_branch = Branch.open(to_location)
 
5604
            except errors.NotBranchError:
 
5605
                this_url = self._get_branch_location(control_dir)
 
5606
                to_branch = Branch.open(
 
5607
                    urlutils.join(this_url, '..', to_location))
 
5608
        if revision is not None:
 
5609
            revision = revision.as_revision_id(to_branch)
 
5610
        switch.switch(control_dir, to_branch, force, revision_id=revision)
 
5611
        if had_explicit_nick:
5263
5612
            branch = control_dir.open_branch() #get the new branch!
5264
5613
            branch.nick = to_branch.nick
5265
5614
        note('Switched to branch: %s',
5266
5615
            urlutils.unescape_for_display(to_branch.base, 'utf-8'))
5267
5616
 
5268
 
 
5269
 
class cmd_guess_renames(Command):
5270
 
    """Guess which files have been have been renamed, based on their content.
5271
 
 
5272
 
    Only versioned files which have been deleted are candidates for rename
5273
 
    detection, and renames to ignored files will not be detected.
5274
 
    """
5275
 
 
5276
 
    def run(self):
5277
 
        work_tree, file_list = tree_files(None, default_branch='.')
5278
 
        work_tree.lock_write()
 
5617
    def _get_branch_location(self, control_dir):
 
5618
        """Return location of branch for this control dir."""
5279
5619
        try:
5280
 
            rename_map.RenameMap.guess_renames(work_tree)
5281
 
        finally:
5282
 
            work_tree.unlock()
 
5620
            this_branch = control_dir.open_branch()
 
5621
            # This may be a heavy checkout, where we want the master branch
 
5622
            master_location = this_branch.get_bound_location()
 
5623
            if master_location is not None:
 
5624
                return master_location
 
5625
            # If not, use a local sibling
 
5626
            return this_branch.base
 
5627
        except errors.NotBranchError:
 
5628
            format = control_dir.find_branch_format()
 
5629
            if getattr(format, 'get_reference', None) is not None:
 
5630
                return format.get_reference(control_dir)
 
5631
            else:
 
5632
                return control_dir.root_transport.base
5283
5633
 
5284
5634
 
5285
5635
class cmd_view(Command):
5286
 
    """Manage filtered views.
 
5636
    __doc__ = """Manage filtered views.
5287
5637
 
5288
5638
    Views provide a mask over the tree so that users can focus on
5289
5639
    a subset of a tree when doing their work. After creating a view,
5437
5787
 
5438
5788
 
5439
5789
class cmd_hooks(Command):
5440
 
    """Show hooks."""
 
5790
    __doc__ = """Show hooks."""
5441
5791
 
5442
5792
    hidden = True
5443
5793
 
5456
5806
                    self.outf.write("    <no hooks installed>\n")
5457
5807
 
5458
5808
 
 
5809
class cmd_remove_branch(Command):
 
5810
    __doc__ = """Remove a branch.
 
5811
 
 
5812
    This will remove the branch from the specified location but 
 
5813
    will keep any working tree or repository in place.
 
5814
 
 
5815
    :Examples:
 
5816
 
 
5817
      Remove the branch at repo/trunk::
 
5818
 
 
5819
        bzr remove-branch repo/trunk
 
5820
 
 
5821
    """
 
5822
 
 
5823
    takes_args = ["location?"]
 
5824
 
 
5825
    aliases = ["rmbranch"]
 
5826
 
 
5827
    def run(self, location=None):
 
5828
        if location is None:
 
5829
            location = "."
 
5830
        branch = Branch.open_containing(location)[0]
 
5831
        branch.bzrdir.destroy_branch()
 
5832
        
 
5833
 
5459
5834
class cmd_shelve(Command):
5460
 
    """Temporarily set aside some changes from the current tree.
 
5835
    __doc__ = """Temporarily set aside some changes from the current tree.
5461
5836
 
5462
5837
    Shelve allows you to temporarily put changes you've made "on the shelf",
5463
5838
    ie. out of the way, until a later time when you can bring them back from
5505
5880
        if writer is None:
5506
5881
            writer = bzrlib.option.diff_writer_registry.get()
5507
5882
        try:
5508
 
            Shelver.from_args(writer(sys.stdout), revision, all, file_list,
5509
 
                              message, destroy=destroy).run()
 
5883
            shelver = Shelver.from_args(writer(sys.stdout), revision, all,
 
5884
                file_list, message, destroy=destroy)
 
5885
            try:
 
5886
                shelver.run()
 
5887
            finally:
 
5888
                shelver.finalize()
5510
5889
        except errors.UserAbort:
5511
5890
            return 0
5512
5891
 
5513
5892
    def run_for_list(self):
5514
5893
        tree = WorkingTree.open_containing('.')[0]
5515
5894
        tree.lock_read()
5516
 
        try:
5517
 
            manager = tree.get_shelf_manager()
5518
 
            shelves = manager.active_shelves()
5519
 
            if len(shelves) == 0:
5520
 
                note('No shelved changes.')
5521
 
                return 0
5522
 
            for shelf_id in reversed(shelves):
5523
 
                message = manager.get_metadata(shelf_id).get('message')
5524
 
                if message is None:
5525
 
                    message = '<no message>'
5526
 
                self.outf.write('%3d: %s\n' % (shelf_id, message))
5527
 
            return 1
5528
 
        finally:
5529
 
            tree.unlock()
 
5895
        self.add_cleanup(tree.unlock)
 
5896
        manager = tree.get_shelf_manager()
 
5897
        shelves = manager.active_shelves()
 
5898
        if len(shelves) == 0:
 
5899
            note('No shelved changes.')
 
5900
            return 0
 
5901
        for shelf_id in reversed(shelves):
 
5902
            message = manager.get_metadata(shelf_id).get('message')
 
5903
            if message is None:
 
5904
                message = '<no message>'
 
5905
            self.outf.write('%3d: %s\n' % (shelf_id, message))
 
5906
        return 1
5530
5907
 
5531
5908
 
5532
5909
class cmd_unshelve(Command):
5533
 
    """Restore shelved changes.
 
5910
    __doc__ = """Restore shelved changes.
5534
5911
 
5535
5912
    By default, the most recently shelved changes are restored. However if you
5536
5913
    specify a shelf by id those changes will be restored instead.  This works
5544
5921
            enum_switch=False, value_switches=True,
5545
5922
            apply="Apply changes and remove from the shelf.",
5546
5923
            dry_run="Show changes, but do not apply or remove them.",
5547
 
            delete_only="Delete changes without applying them."
 
5924
            preview="Instead of unshelving the changes, show the diff that "
 
5925
                    "would result from unshelving.",
 
5926
            delete_only="Delete changes without applying them.",
 
5927
            keep="Apply changes but don't delete them.",
5548
5928
        )
5549
5929
    ]
5550
5930
    _see_also = ['shelve']
5551
5931
 
5552
5932
    def run(self, shelf_id=None, action='apply'):
5553
5933
        from bzrlib.shelf_ui import Unshelver
5554
 
        Unshelver.from_args(shelf_id, action).run()
 
5934
        unshelver = Unshelver.from_args(shelf_id, action)
 
5935
        try:
 
5936
            unshelver.run()
 
5937
        finally:
 
5938
            unshelver.tree.unlock()
5555
5939
 
5556
5940
 
5557
5941
class cmd_clean_tree(Command):
5558
 
    """Remove unwanted files from working tree.
 
5942
    __doc__ = """Remove unwanted files from working tree.
5559
5943
 
5560
5944
    By default, only unknown files, not ignored files, are deleted.  Versioned
5561
5945
    files are never deleted.
5588
5972
                   dry_run=dry_run, no_prompt=force)
5589
5973
 
5590
5974
 
5591
 
def _create_prefix(cur_transport):
5592
 
    needed = [cur_transport]
5593
 
    # Recurse upwards until we can create a directory successfully
5594
 
    while True:
5595
 
        new_transport = cur_transport.clone('..')
5596
 
        if new_transport.base == cur_transport.base:
5597
 
            raise errors.BzrCommandError(
5598
 
                "Failed to create path prefix for %s."
5599
 
                % cur_transport.base)
5600
 
        try:
5601
 
            new_transport.mkdir('.')
5602
 
        except errors.NoSuchFile:
5603
 
            needed.append(new_transport)
5604
 
            cur_transport = new_transport
 
5975
class cmd_reference(Command):
 
5976
    __doc__ = """list, view and set branch locations for nested trees.
 
5977
 
 
5978
    If no arguments are provided, lists the branch locations for nested trees.
 
5979
    If one argument is provided, display the branch location for that tree.
 
5980
    If two arguments are provided, set the branch location for that tree.
 
5981
    """
 
5982
 
 
5983
    hidden = True
 
5984
 
 
5985
    takes_args = ['path?', 'location?']
 
5986
 
 
5987
    def run(self, path=None, location=None):
 
5988
        branchdir = '.'
 
5989
        if path is not None:
 
5990
            branchdir = path
 
5991
        tree, branch, relpath =(
 
5992
            bzrdir.BzrDir.open_containing_tree_or_branch(branchdir))
 
5993
        if path is not None:
 
5994
            path = relpath
 
5995
        if tree is None:
 
5996
            tree = branch.basis_tree()
 
5997
        if path is None:
 
5998
            info = branch._get_all_reference_info().iteritems()
 
5999
            self._display_reference_info(tree, branch, info)
5605
6000
        else:
5606
 
            break
5607
 
    # Now we only need to create child directories
5608
 
    while needed:
5609
 
        cur_transport = needed.pop()
5610
 
        cur_transport.ensure_base()
5611
 
 
5612
 
 
5613
 
# these get imported and then picked up by the scan for cmd_*
5614
 
# TODO: Some more consistent way to split command definitions across files;
5615
 
# we do need to load at least some information about them to know of
5616
 
# aliases.  ideally we would avoid loading the implementation until the
5617
 
# details were needed.
5618
 
from bzrlib.cmd_version_info import cmd_version_info
5619
 
from bzrlib.conflicts import cmd_resolve, cmd_conflicts, restore
5620
 
from bzrlib.bundle.commands import (
5621
 
    cmd_bundle_info,
5622
 
    )
5623
 
from bzrlib.sign_my_commits import cmd_sign_my_commits
5624
 
from bzrlib.weave_commands import cmd_versionedfile_list, \
5625
 
        cmd_weave_plan_merge, cmd_weave_merge_text
 
6001
            file_id = tree.path2id(path)
 
6002
            if file_id is None:
 
6003
                raise errors.NotVersionedError(path)
 
6004
            if location is None:
 
6005
                info = [(file_id, branch.get_reference_info(file_id))]
 
6006
                self._display_reference_info(tree, branch, info)
 
6007
            else:
 
6008
                branch.set_reference_info(file_id, path, location)
 
6009
 
 
6010
    def _display_reference_info(self, tree, branch, info):
 
6011
        ref_list = []
 
6012
        for file_id, (path, location) in info:
 
6013
            try:
 
6014
                path = tree.id2path(file_id)
 
6015
            except errors.NoSuchId:
 
6016
                pass
 
6017
            ref_list.append((path, location))
 
6018
        for path, location in sorted(ref_list):
 
6019
            self.outf.write('%s %s\n' % (path, location))
 
6020
 
 
6021
 
 
6022
def _register_lazy_builtins():
 
6023
    # register lazy builtins from other modules; called at startup and should
 
6024
    # be only called once.
 
6025
    for (name, aliases, module_name) in [
 
6026
        ('cmd_bundle_info', [], 'bzrlib.bundle.commands'),
 
6027
        ('cmd_dpush', [], 'bzrlib.foreign'),
 
6028
        ('cmd_version_info', [], 'bzrlib.cmd_version_info'),
 
6029
        ('cmd_resolve', ['resolved'], 'bzrlib.conflicts'),
 
6030
        ('cmd_conflicts', [], 'bzrlib.conflicts'),
 
6031
        ('cmd_sign_my_commits', [], 'bzrlib.sign_my_commits'),
 
6032
        ]:
 
6033
        builtin_command_registry.register_lazy(name, aliases, module_name)