/brz/remove-bazaar

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

« back to all changes in this revision

Viewing changes to bzrlib/builtins.py

  • Committer: Robert Collins
  • Date: 2010-05-06 11:08:10 UTC
  • mto: This revision was merged to the branch mainline in revision 5223.
  • Revision ID: robertc@robertcollins.net-20100506110810-h3j07fh5gmw54s25
Cleaner matcher matching revised unlocking protocol.

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