~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/builtins.py

  • Committer: Andrew Bennetts
  • Date: 2009-04-02 05:53:12 UTC
  • mto: This revision was merged to the branch mainline in revision 4242.
  • Revision ID: andrew.bennetts@canonical.com-20090402055312-h7mvgumvm7e620mj
Fix nits in spelling and naming.

Show diffs side-by-side

added added

removed removed

Lines of Context:
1
 
# Copyright (C) 2005-2010 Canonical Ltd
 
1
# Copyright (C) 2004, 2005, 2006, 2007, 2008, 2009 Canonical Ltd
2
2
#
3
3
# This program is free software; you can redistribute it and/or modify
4
4
# it under the terms of the GNU General Public License as published by
31
31
    bundle,
32
32
    btree_index,
33
33
    bzrdir,
34
 
    directory_service,
35
34
    delta,
36
35
    config,
37
36
    errors,
44
43
    reconfigure,
45
44
    rename_map,
46
45
    revision as _mod_revision,
47
 
    static_tuple,
48
46
    symbol_versioning,
49
 
    timestamp,
50
47
    transport,
 
48
    tree as _mod_tree,
51
49
    ui,
52
50
    urlutils,
53
51
    views,
54
52
    )
55
53
from bzrlib.branch import Branch
56
54
from bzrlib.conflicts import ConflictList
57
 
from bzrlib.transport import memory
58
55
from bzrlib.revisionspec import RevisionSpec, RevisionInfo
59
56
from bzrlib.smtp_connection import SMTPConnection
60
57
from bzrlib.workingtree import WorkingTree
61
58
""")
62
59
 
63
 
from bzrlib.commands import (
64
 
    Command,
65
 
    builtin_command_registry,
66
 
    display_command,
67
 
    )
 
60
from bzrlib.commands import Command, display_command
68
61
from bzrlib.option import (
69
62
    ListOption,
70
63
    Option,
86
79
 
87
80
 
88
81
def tree_files_for_add(file_list):
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
    """Add handles files a bit differently so it a custom implementation."""
99
83
    if file_list:
100
 
        tree, relpath = WorkingTree.open_containing(file_list[0])
 
84
        tree = WorkingTree.open_containing(file_list[0])[0]
101
85
        if tree.supports_views():
102
86
            view_files = tree.views.lookup_view()
103
87
            if view_files:
104
88
                for filename in file_list:
105
89
                    if not osutils.is_inside_any(view_files, filename):
106
90
                        raise errors.FileOutsideView(filename, view_files)
107
 
        file_list = file_list[:]
108
 
        file_list[0] = tree.abspath(relpath)
109
91
    else:
110
92
        tree = WorkingTree.open_containing(u'.')[0]
111
93
        if tree.supports_views():
113
95
            if view_files:
114
96
                file_list = view_files
115
97
                view_str = views.view_display_str(view_files)
116
 
                note("Ignoring files outside view. View is %s" % view_str)
 
98
                note("ignoring files outside view: %s" % view_str)
117
99
    return tree, file_list
118
100
 
119
101
 
128
110
 
129
111
 
130
112
def _get_one_revision_tree(command_name, revisions, branch=None, tree=None):
131
 
    """Get a revision tree. Not suitable for commands that change the tree.
132
 
    
133
 
    Specifically, the basis tree in dirstate trees is coupled to the dirstate
134
 
    and doing a commit/uncommit/pull will at best fail due to changing the
135
 
    basis revision data.
136
 
 
137
 
    If tree is passed in, it should be already locked, for lifetime management
138
 
    of the trees internal cached state.
139
 
    """
140
113
    if branch is None:
141
114
        branch = tree.branch
142
115
    if revisions is None:
178
151
            if view_files:
179
152
                file_list = view_files
180
153
                view_str = views.view_display_str(view_files)
181
 
                note("Ignoring files outside view. View is %s" % view_str)
 
154
                note("ignoring files outside view: %s" % view_str)
182
155
        return tree, file_list
183
156
    tree = WorkingTree.open_containing(osutils.realpath(file_list[0]))[0]
184
157
    return tree, safe_relpath_files(tree, file_list, canonicalize,
239
212
# opens the branch?)
240
213
 
241
214
class cmd_status(Command):
242
 
    __doc__ = """Display status summary.
 
215
    """Display status summary.
243
216
 
244
217
    This reports on versioned and unknown files, reporting them
245
218
    grouped by state.  Possible states are:
265
238
    unknown
266
239
        Not versioned and not matching an ignore pattern.
267
240
 
268
 
    Additionally for directories, symlinks and files with an executable
269
 
    bit, Bazaar indicates their type using a trailing character: '/', '@'
270
 
    or '*' respectively.
271
 
 
272
241
    To see ignored files use 'bzr ignored'.  For details on the
273
242
    changes to file texts, use 'bzr diff'.
274
243
 
332
301
 
333
302
 
334
303
class cmd_cat_revision(Command):
335
 
    __doc__ = """Write out metadata for a revision.
 
304
    """Write out metadata for a revision.
336
305
 
337
306
    The revision to print can either be specified by a specific
338
307
    revision identifier, or you can use --revision.
344
313
    # cat-revision is more for frontends so should be exact
345
314
    encoding = 'strict'
346
315
 
347
 
    def print_revision(self, revisions, revid):
348
 
        stream = revisions.get_record_stream([(revid,)], 'unordered', True)
349
 
        record = stream.next()
350
 
        if record.storage_kind == 'absent':
351
 
            raise errors.NoSuchRevision(revisions, revid)
352
 
        revtext = record.get_bytes_as('fulltext')
353
 
        self.outf.write(revtext.decode('utf-8'))
354
 
 
355
316
    @display_command
356
317
    def run(self, revision_id=None, revision=None):
357
318
        if revision_id is not None and revision is not None:
362
323
                                         ' --revision or a revision_id')
363
324
        b = WorkingTree.open_containing(u'.')[0].branch
364
325
 
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')
 
326
        # TODO: jam 20060112 should cat-revision always output utf-8?
 
327
        if revision_id is not None:
 
328
            revision_id = osutils.safe_revision_id(revision_id, warn=False)
 
329
            try:
 
330
                self.outf.write(b.repository.get_revision_xml(revision_id).decode('utf-8'))
 
331
            except errors.NoSuchRevision:
 
332
                msg = "The repository %s contains no revision %s." % (b.repository.base,
 
333
                    revision_id)
 
334
                raise errors.BzrCommandError(msg)
 
335
        elif revision is not None:
 
336
            for rev in revision:
 
337
                if rev is None:
 
338
                    raise errors.BzrCommandError('You cannot specify a NULL'
 
339
                                                 ' revision.')
 
340
                rev_id = rev.as_revision_id(b)
 
341
                self.outf.write(b.repository.get_revision_xml(rev_id).decode('utf-8'))
369
342
 
370
 
        b.repository.lock_read()
371
 
        try:
372
 
            # TODO: jam 20060112 should cat-revision always output utf-8?
373
 
            if revision_id is not None:
374
 
                revision_id = osutils.safe_revision_id(revision_id, warn=False)
375
 
                try:
376
 
                    self.print_revision(revisions, revision_id)
377
 
                except errors.NoSuchRevision:
378
 
                    msg = "The repository %s contains no revision %s." % (
379
 
                        b.repository.base, revision_id)
380
 
                    raise errors.BzrCommandError(msg)
381
 
            elif revision is not None:
382
 
                for rev in revision:
383
 
                    if rev is None:
384
 
                        raise errors.BzrCommandError(
385
 
                            'You cannot specify a NULL revision.')
386
 
                    rev_id = rev.as_revision_id(b)
387
 
                    self.print_revision(revisions, rev_id)
388
 
        finally:
389
 
            b.repository.unlock()
390
 
        
391
343
 
392
344
class cmd_dump_btree(Command):
393
 
    __doc__ = """Dump the contents of a btree index file to stdout.
 
345
    """Dump the contents of a btree index file to stdout.
394
346
 
395
347
    PATH is a btree index file, it can be any URL. This includes things like
396
348
    .bzr/repository/pack-names, or .bzr/repository/indices/a34b3a...ca4a4.iix
460
412
        for node in bt.iter_all_entries():
461
413
            # Node is made up of:
462
414
            # (index, key, value, [references])
463
 
            try:
464
 
                refs = node[3]
465
 
            except IndexError:
466
 
                refs_as_tuples = None
467
 
            else:
468
 
                refs_as_tuples = static_tuple.as_tuples(refs)
469
 
            as_tuple = (tuple(node[1]), node[2], refs_as_tuples)
470
 
            self.outf.write('%s\n' % (as_tuple,))
 
415
            self.outf.write('%s\n' % (node[1:],))
471
416
 
472
417
 
473
418
class cmd_remove_tree(Command):
474
 
    __doc__ = """Remove the working tree from a given branch/checkout.
 
419
    """Remove the working tree from a given branch/checkout.
475
420
 
476
421
    Since a lightweight checkout is little more than a working tree
477
422
    this will refuse to run against one.
479
424
    To re-create the working tree, use "bzr checkout".
480
425
    """
481
426
    _see_also = ['checkout', 'working-trees']
482
 
    takes_args = ['location*']
 
427
    takes_args = ['location?']
483
428
    takes_options = [
484
429
        Option('force',
485
430
               help='Remove the working tree even if it has '
486
431
                    'uncommitted changes.'),
487
432
        ]
488
433
 
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()
 
434
    def run(self, location='.', force=False):
 
435
        d = bzrdir.BzrDir.open(location)
 
436
 
 
437
        try:
 
438
            working = d.open_workingtree()
 
439
        except errors.NoWorkingTree:
 
440
            raise errors.BzrCommandError("No working tree to remove")
 
441
        except errors.NotLocalUrl:
 
442
            raise errors.BzrCommandError("You cannot remove the working tree of a "
 
443
                                         "remote path")
 
444
        if not force:
 
445
            changes = working.changes_from(working.basis_tree())
 
446
            if changes.has_changed():
 
447
                raise errors.UncommittedChanges(working)
 
448
 
 
449
        working_path = working.bzrdir.root_transport.base
 
450
        branch_path = working.branch.bzrdir.root_transport.base
 
451
        if working_path != branch_path:
 
452
            raise errors.BzrCommandError("You cannot remove the working tree from "
 
453
                                         "a lightweight checkout")
 
454
 
 
455
        d.destroy_workingtree()
512
456
 
513
457
 
514
458
class cmd_revno(Command):
515
 
    __doc__ = """Show current revision number.
 
459
    """Show current revision number.
516
460
 
517
461
    This is equal to the number of revisions on this branch.
518
462
    """
519
463
 
520
464
    _see_also = ['info']
521
465
    takes_args = ['location?']
522
 
    takes_options = [
523
 
        Option('tree', help='Show revno of working tree'),
524
 
        ]
525
466
 
526
467
    @display_command
527
 
    def run(self, tree=False, location=u'.'):
528
 
        if tree:
529
 
            try:
530
 
                wt = WorkingTree.open_containing(location)[0]
531
 
                self.add_cleanup(wt.lock_read().unlock)
532
 
            except (errors.NoWorkingTree, errors.NotLocalUrl):
533
 
                raise errors.NoWorkingTree(location)
534
 
            revid = wt.last_revision()
535
 
            try:
536
 
                revno_t = wt.branch.revision_id_to_dotted_revno(revid)
537
 
            except errors.NoSuchRevision:
538
 
                revno_t = ('???',)
539
 
            revno = ".".join(str(n) for n in revno_t)
540
 
        else:
541
 
            b = Branch.open_containing(location)[0]
542
 
            self.add_cleanup(b.lock_read().unlock)
543
 
            revno = b.revno()
544
 
        self.cleanup_now()
545
 
        self.outf.write(str(revno) + '\n')
 
468
    def run(self, location=u'.'):
 
469
        self.outf.write(str(Branch.open_containing(location)[0].revno()))
 
470
        self.outf.write('\n')
546
471
 
547
472
 
548
473
class cmd_revision_info(Command):
549
 
    __doc__ = """Show revision number and revision id for a given revision identifier.
 
474
    """Show revision number and revision id for a given revision identifier.
550
475
    """
551
476
    hidden = True
552
477
    takes_args = ['revision_info*']
558
483
            short_name='d',
559
484
            type=unicode,
560
485
            ),
561
 
        Option('tree', help='Show revno of working tree'),
562
486
        ]
563
487
 
564
488
    @display_command
565
 
    def run(self, revision=None, directory=u'.', tree=False,
566
 
            revision_info_list=[]):
 
489
    def run(self, revision=None, directory=u'.', revision_info_list=[]):
567
490
 
568
 
        try:
569
 
            wt = WorkingTree.open_containing(directory)[0]
570
 
            b = wt.branch
571
 
            self.add_cleanup(wt.lock_read().unlock)
572
 
        except (errors.NoWorkingTree, errors.NotLocalUrl):
573
 
            wt = None
574
 
            b = Branch.open_containing(directory)[0]
575
 
            self.add_cleanup(b.lock_read().unlock)
576
 
        revision_ids = []
 
491
        revs = []
577
492
        if revision is not None:
578
 
            revision_ids.extend(rev.as_revision_id(b) for rev in revision)
 
493
            revs.extend(revision)
579
494
        if revision_info_list is not None:
580
 
            for rev_str in revision_info_list:
581
 
                rev_spec = RevisionSpec.from_string(rev_str)
582
 
                revision_ids.append(rev_spec.as_revision_id(b))
583
 
        # No arguments supplied, default to the last revision
584
 
        if len(revision_ids) == 0:
585
 
            if tree:
586
 
                if wt is None:
587
 
                    raise errors.NoWorkingTree(directory)
588
 
                revision_ids.append(wt.last_revision())
589
 
            else:
590
 
                revision_ids.append(b.last_revision())
591
 
 
592
 
        revinfos = []
593
 
        maxlen = 0
594
 
        for revision_id in revision_ids:
 
495
            for rev in revision_info_list:
 
496
                revs.append(RevisionSpec.from_string(rev))
 
497
 
 
498
        b = Branch.open_containing(directory)[0]
 
499
 
 
500
        if len(revs) == 0:
 
501
            revs.append(RevisionSpec.from_string('-1'))
 
502
 
 
503
        for rev in revs:
 
504
            revision_id = rev.as_revision_id(b)
595
505
            try:
596
 
                dotted_revno = b.revision_id_to_dotted_revno(revision_id)
597
 
                revno = '.'.join(str(i) for i in dotted_revno)
 
506
                revno = '%4d' % (b.revision_id_to_revno(revision_id))
598
507
            except errors.NoSuchRevision:
599
 
                revno = '???'
600
 
            maxlen = max(maxlen, len(revno))
601
 
            revinfos.append([revno, revision_id])
602
 
 
603
 
        self.cleanup_now()
604
 
        for ri in revinfos:
605
 
            self.outf.write('%*s %s\n' % (maxlen, ri[0], ri[1]))
 
508
                dotted_map = b.get_revision_id_to_revno_map()
 
509
                revno = '.'.join(str(i) for i in dotted_map[revision_id])
 
510
            print '%s %s' % (revno, revision_id)
606
511
 
607
512
 
608
513
class cmd_add(Command):
609
 
    __doc__ = """Add specified files or directories.
 
514
    """Add specified files or directories.
610
515
 
611
516
    In non-recursive mode, all the named items are added, regardless
612
517
    of whether they were previously ignored.  A warning is given if
638
543
    branches that will be merged later (without showing the two different
639
544
    adds as a conflict). It is also useful when merging another project
640
545
    into a subdirectory of this one.
641
 
    
642
 
    Any files matching patterns in the ignore list will not be added
643
 
    unless they are explicitly mentioned.
644
546
    """
645
547
    takes_args = ['file*']
646
548
    takes_options = [
654
556
               help='Lookup file ids from this tree.'),
655
557
        ]
656
558
    encoding_type = 'replace'
657
 
    _see_also = ['remove', 'ignore']
 
559
    _see_also = ['remove']
658
560
 
659
561
    def run(self, file_list, no_recurse=False, dry_run=False, verbose=False,
660
562
            file_ids_from=None):
677
579
                should_print=(not is_quiet()))
678
580
 
679
581
        if base_tree:
680
 
            self.add_cleanup(base_tree.lock_read().unlock)
681
 
        tree, file_list = tree_files_for_add(file_list)
682
 
        added, ignored = tree.smart_add(file_list, not
683
 
            no_recurse, action=action, save=not dry_run)
684
 
        self.cleanup_now()
 
582
            base_tree.lock_read()
 
583
        try:
 
584
            file_list = self._maybe_expand_globs(file_list)
 
585
            tree, file_list = tree_files_for_add(file_list)
 
586
            added, ignored = tree.smart_add(file_list, not
 
587
                no_recurse, action=action, save=not dry_run)
 
588
        finally:
 
589
            if base_tree is not None:
 
590
                base_tree.unlock()
685
591
        if len(ignored) > 0:
686
592
            if verbose:
687
593
                for glob in sorted(ignored.keys()):
688
594
                    for path in ignored[glob]:
689
595
                        self.outf.write("ignored %s matching \"%s\"\n"
690
596
                                        % (path, glob))
 
597
            else:
 
598
                match_len = 0
 
599
                for glob, paths in ignored.items():
 
600
                    match_len += len(paths)
 
601
                self.outf.write("ignored %d file(s).\n" % match_len)
 
602
            self.outf.write("If you wish to add some of these files,"
 
603
                            " please add them by name.\n")
691
604
 
692
605
 
693
606
class cmd_mkdir(Command):
694
 
    __doc__ = """Create a new versioned directory.
 
607
    """Create a new versioned directory.
695
608
 
696
609
    This is equivalent to creating the directory and then adding it.
697
610
    """
701
614
 
702
615
    def run(self, dir_list):
703
616
        for d in dir_list:
 
617
            os.mkdir(d)
704
618
            wt, dd = WorkingTree.open_containing(d)
705
 
            base = os.path.dirname(dd)
706
 
            id = wt.path2id(base)
707
 
            if id != None:
708
 
                os.mkdir(d)
709
 
                wt.add([dd])
710
 
                self.outf.write('added %s\n' % d)
711
 
            else:
712
 
                raise errors.NotVersionedError(path=base)
 
619
            wt.add([dd])
 
620
            self.outf.write('added %s\n' % d)
713
621
 
714
622
 
715
623
class cmd_relpath(Command):
716
 
    __doc__ = """Show path of a file relative to root"""
 
624
    """Show path of a file relative to root"""
717
625
 
718
626
    takes_args = ['filename']
719
627
    hidden = True
728
636
 
729
637
 
730
638
class cmd_inventory(Command):
731
 
    __doc__ = """Show inventory of the current working copy or a revision.
 
639
    """Show inventory of the current working copy or a revision.
732
640
 
733
641
    It is possible to limit the output to a particular entry
734
642
    type using the --kind option.  For example: --kind file.
755
663
 
756
664
        revision = _get_one_revision('inventory', revision)
757
665
        work_tree, file_list = tree_files(file_list)
758
 
        self.add_cleanup(work_tree.lock_read().unlock)
759
 
        if revision is not None:
760
 
            tree = revision.as_tree(work_tree.branch)
761
 
 
762
 
            extra_trees = [work_tree]
763
 
            self.add_cleanup(tree.lock_read().unlock)
764
 
        else:
765
 
            tree = work_tree
766
 
            extra_trees = []
767
 
 
768
 
        if file_list is not None:
769
 
            file_ids = tree.paths2ids(file_list, trees=extra_trees,
770
 
                                      require_versioned=True)
771
 
            # find_ids_across_trees may include some paths that don't
772
 
            # exist in 'tree'.
773
 
            entries = sorted((tree.id2path(file_id), tree.inventory[file_id])
774
 
                             for file_id in file_ids if file_id in tree)
775
 
        else:
776
 
            entries = tree.inventory.entries()
777
 
 
778
 
        self.cleanup_now()
 
666
        work_tree.lock_read()
 
667
        try:
 
668
            if revision is not None:
 
669
                tree = revision.as_tree(work_tree.branch)
 
670
 
 
671
                extra_trees = [work_tree]
 
672
                tree.lock_read()
 
673
            else:
 
674
                tree = work_tree
 
675
                extra_trees = []
 
676
 
 
677
            if file_list is not None:
 
678
                file_ids = tree.paths2ids(file_list, trees=extra_trees,
 
679
                                          require_versioned=True)
 
680
                # find_ids_across_trees may include some paths that don't
 
681
                # exist in 'tree'.
 
682
                entries = sorted((tree.id2path(file_id), tree.inventory[file_id])
 
683
                                 for file_id in file_ids if file_id in tree)
 
684
            else:
 
685
                entries = tree.inventory.entries()
 
686
        finally:
 
687
            tree.unlock()
 
688
            if tree is not work_tree:
 
689
                work_tree.unlock()
 
690
 
779
691
        for path, entry in entries:
780
692
            if kind and kind != entry.kind:
781
693
                continue
787
699
 
788
700
 
789
701
class cmd_mv(Command):
790
 
    __doc__ = """Move or rename a file.
 
702
    """Move or rename a file.
791
703
 
792
704
    :Usage:
793
705
        bzr mv OLDNAME NEWNAME
810
722
    takes_args = ['names*']
811
723
    takes_options = [Option("after", help="Move only the bzr identifier"
812
724
        " of the file, because the file has already been moved."),
813
 
        Option('auto', help='Automatically guess renames.'),
814
 
        Option('dry-run', help='Avoid making changes when guessing renames.'),
815
725
        ]
816
726
    aliases = ['move', 'rename']
817
727
    encoding_type = 'replace'
818
728
 
819
 
    def run(self, names_list, after=False, auto=False, dry_run=False):
820
 
        if auto:
821
 
            return self.run_auto(names_list, after, dry_run)
822
 
        elif dry_run:
823
 
            raise errors.BzrCommandError('--dry-run requires --auto.')
 
729
    def run(self, names_list, after=False):
824
730
        if names_list is None:
825
731
            names_list = []
 
732
 
826
733
        if len(names_list) < 2:
827
734
            raise errors.BzrCommandError("missing file argument")
828
735
        tree, rel_names = tree_files(names_list, canonicalize=False)
829
 
        self.add_cleanup(tree.lock_tree_write().unlock)
830
 
        self._run(tree, names_list, rel_names, after)
831
 
 
832
 
    def run_auto(self, names_list, after, dry_run):
833
 
        if names_list is not None and len(names_list) > 1:
834
 
            raise errors.BzrCommandError('Only one path may be specified to'
835
 
                                         ' --auto.')
836
 
        if after:
837
 
            raise errors.BzrCommandError('--after cannot be specified with'
838
 
                                         ' --auto.')
839
 
        work_tree, file_list = tree_files(names_list, default_branch='.')
840
 
        self.add_cleanup(work_tree.lock_tree_write().unlock)
841
 
        rename_map.RenameMap.guess_renames(work_tree, dry_run)
 
736
        tree.lock_write()
 
737
        try:
 
738
            self._run(tree, names_list, rel_names, after)
 
739
        finally:
 
740
            tree.unlock()
842
741
 
843
742
    def _run(self, tree, names_list, rel_names, after):
844
743
        into_existing = osutils.isdir(names_list[-1])
865
764
            # All entries reference existing inventory items, so fix them up
866
765
            # for cicp file-systems.
867
766
            rel_names = tree.get_canonical_inventory_paths(rel_names)
868
 
            for src, dest in tree.move(rel_names[:-1], rel_names[-1], after=after):
869
 
                if not is_quiet():
870
 
                    self.outf.write("%s => %s\n" % (src, dest))
 
767
            for pair in tree.move(rel_names[:-1], rel_names[-1], after=after):
 
768
                self.outf.write("%s => %s\n" % pair)
871
769
        else:
872
770
            if len(names_list) != 2:
873
771
                raise errors.BzrCommandError('to mv multiple files the'
917
815
            dest = osutils.pathjoin(dest_parent, dest_tail)
918
816
            mutter("attempting to move %s => %s", src, dest)
919
817
            tree.rename_one(src, dest, after=after)
920
 
            if not is_quiet():
921
 
                self.outf.write("%s => %s\n" % (src, dest))
 
818
            self.outf.write("%s => %s\n" % (src, dest))
922
819
 
923
820
 
924
821
class cmd_pull(Command):
925
 
    __doc__ = """Turn this branch into a mirror of another branch.
 
822
    """Turn this branch into a mirror of another branch.
926
823
 
927
 
    By default, this command only works on branches that have not diverged.
928
 
    Branches are considered diverged if the destination branch's most recent 
929
 
    commit is one that has not been merged (directly or indirectly) into the 
930
 
    parent.
 
824
    This command only works on branches that have not diverged.  Branches are
 
825
    considered diverged if the destination branch's most recent commit is one
 
826
    that has not been merged (directly or indirectly) into the parent.
931
827
 
932
828
    If branches have diverged, you can use 'bzr merge' to integrate the changes
933
829
    from one into the other.  Once one branch has merged, the other should
934
830
    be able to pull it again.
935
831
 
936
 
    If you want to replace your local changes and just want your branch to
937
 
    match the remote one, use pull --overwrite. This will work even if the two
938
 
    branches have diverged.
 
832
    If you want to forget your local changes and just update your branch to
 
833
    match the remote one, use pull --overwrite.
939
834
 
940
835
    If there is no default location set, the first pull will set it.  After
941
836
    that, you can omit the location to use the default.  To change the
957
852
            short_name='d',
958
853
            type=unicode,
959
854
            ),
960
 
        Option('local',
961
 
            help="Perform a local pull in a bound "
962
 
                 "branch.  Local pulls are not applied to "
963
 
                 "the master branch."
964
 
            ),
965
855
        ]
966
856
    takes_args = ['location?']
967
857
    encoding_type = 'replace'
968
858
 
969
859
    def run(self, location=None, remember=False, overwrite=False,
970
860
            revision=None, verbose=False,
971
 
            directory=None, local=False):
 
861
            directory=None):
972
862
        # FIXME: too much stuff is in the command class
973
863
        revision_id = None
974
864
        mergeable = None
977
867
        try:
978
868
            tree_to = WorkingTree.open_containing(directory)[0]
979
869
            branch_to = tree_to.branch
980
 
            self.add_cleanup(tree_to.lock_write().unlock)
981
870
        except errors.NoWorkingTree:
982
871
            tree_to = None
983
872
            branch_to = Branch.open_containing(directory)[0]
984
 
            self.add_cleanup(branch_to.lock_write().unlock)
985
 
 
986
 
        if local and not branch_to.get_bound_location():
987
 
            raise errors.LocalRequiresBoundBranch()
988
873
 
989
874
        possible_transports = []
990
875
        if location is not None:
1018
903
        else:
1019
904
            branch_from = Branch.open(location,
1020
905
                possible_transports=possible_transports)
1021
 
            self.add_cleanup(branch_from.lock_read().unlock)
1022
906
 
1023
907
            if branch_to.get_parent() is None or remember:
1024
908
                branch_to.set_parent(branch_from.base)
1026
910
        if revision is not None:
1027
911
            revision_id = revision.as_revision_id(branch_from)
1028
912
 
1029
 
        if tree_to is not None:
1030
 
            view_info = _get_view_info_for_change_reporter(tree_to)
1031
 
            change_reporter = delta._ChangeReporter(
1032
 
                unversioned_filter=tree_to.is_ignored,
1033
 
                view_info=view_info)
1034
 
            result = tree_to.pull(
1035
 
                branch_from, overwrite, revision_id, change_reporter,
1036
 
                possible_transports=possible_transports, local=local)
1037
 
        else:
1038
 
            result = branch_to.pull(
1039
 
                branch_from, overwrite, revision_id, local=local)
 
913
        branch_to.lock_write()
 
914
        try:
 
915
            if tree_to is not None:
 
916
                view_info = _get_view_info_for_change_reporter(tree_to)
 
917
                change_reporter = delta._ChangeReporter(
 
918
                    unversioned_filter=tree_to.is_ignored, view_info=view_info)
 
919
                result = tree_to.pull(branch_from, overwrite, revision_id,
 
920
                                      change_reporter,
 
921
                                      possible_transports=possible_transports)
 
922
            else:
 
923
                result = branch_to.pull(branch_from, overwrite, revision_id)
1040
924
 
1041
 
        result.report(self.outf)
1042
 
        if verbose and result.old_revid != result.new_revid:
1043
 
            log.show_branch_change(
1044
 
                branch_to, self.outf, result.old_revno,
1045
 
                result.old_revid)
 
925
            result.report(self.outf)
 
926
            if verbose and result.old_revid != result.new_revid:
 
927
                log.show_branch_change(branch_to, self.outf, result.old_revno,
 
928
                                       result.old_revid)
 
929
        finally:
 
930
            branch_to.unlock()
1046
931
 
1047
932
 
1048
933
class cmd_push(Command):
1049
 
    __doc__ = """Update a mirror of this branch.
 
934
    """Update a mirror of this branch.
1050
935
 
1051
936
    The target branch will not have its working tree populated because this
1052
937
    is both expensive, and is not supported on remote file systems.
1095
980
                'for the commit history. Only the work not present in the '
1096
981
                'referenced branch is included in the branch created.',
1097
982
            type=unicode),
1098
 
        Option('strict',
1099
 
               help='Refuse to push if there are uncommitted changes in'
1100
 
               ' the working tree, --no-strict disables the check.'),
1101
983
        ]
1102
984
    takes_args = ['location?']
1103
985
    encoding_type = 'replace'
1105
987
    def run(self, location=None, remember=False, overwrite=False,
1106
988
        create_prefix=False, verbose=False, revision=None,
1107
989
        use_existing_dir=False, directory=None, stacked_on=None,
1108
 
        stacked=False, strict=None):
 
990
        stacked=False):
1109
991
        from bzrlib.push import _show_push_branch
1110
992
 
 
993
        # Get the source branch and revision_id
1111
994
        if directory is None:
1112
995
            directory = '.'
1113
 
        # Get the source branch
1114
 
        (tree, br_from,
1115
 
         _unused) = bzrdir.BzrDir.open_containing_tree_or_branch(directory)
1116
 
        # Get the tip's revision_id
 
996
        br_from = Branch.open_containing(directory)[0]
1117
997
        revision = _get_one_revision('push', revision)
1118
998
        if revision is not None:
1119
999
            revision_id = revision.in_history(br_from).rev_id
1120
1000
        else:
1121
 
            revision_id = None
1122
 
        if tree is not None and revision_id is None:
1123
 
            tree.check_changed_or_out_of_date(
1124
 
                strict, 'push_strict',
1125
 
                more_error='Use --no-strict to force the push.',
1126
 
                more_warning='Uncommitted changes will not be pushed.')
 
1001
            revision_id = br_from.last_revision()
 
1002
 
1127
1003
        # Get the stacked_on branch, if any
1128
1004
        if stacked_on is not None:
1129
1005
            stacked_on = urlutils.normalize_url(stacked_on)
1161
1037
 
1162
1038
 
1163
1039
class cmd_branch(Command):
1164
 
    __doc__ = """Create a new branch that is a copy of an existing branch.
 
1040
    """Create a new copy of a branch.
1165
1041
 
1166
1042
    If the TO_LOCATION is omitted, the last component of the FROM_LOCATION will
1167
1043
    be used.  In other words, "branch ../foo/bar" will attempt to create ./bar.
1180
1056
        help='Hard-link working tree files where possible.'),
1181
1057
        Option('no-tree',
1182
1058
            help="Create a branch without a working-tree."),
1183
 
        Option('switch',
1184
 
            help="Switch the checkout in the current directory "
1185
 
                 "to the new branch."),
1186
1059
        Option('stacked',
1187
1060
            help='Create a stacked branch referring to the source branch. '
1188
1061
                'The new branch will depend on the availability of the source '
1189
1062
                'branch for all operations.'),
1190
1063
        Option('standalone',
1191
1064
               help='Do not use a shared repository, even if available.'),
1192
 
        Option('use-existing-dir',
1193
 
               help='By default branch will fail if the target'
1194
 
                    ' directory exists, but does not already'
1195
 
                    ' have a control directory.  This flag will'
1196
 
                    ' allow branch to proceed.'),
1197
 
        Option('bind',
1198
 
            help="Bind new branch to from location."),
1199
1065
        ]
1200
1066
    aliases = ['get', 'clone']
1201
1067
 
1202
1068
    def run(self, from_location, to_location=None, revision=None,
1203
 
            hardlink=False, stacked=False, standalone=False, no_tree=False,
1204
 
            use_existing_dir=False, switch=False, bind=False):
1205
 
        from bzrlib import switch as _mod_switch
 
1069
            hardlink=False, stacked=False, standalone=False, no_tree=False):
1206
1070
        from bzrlib.tag import _merge_tags_if_possible
 
1071
 
1207
1072
        accelerator_tree, br_from = bzrdir.BzrDir.open_tree_or_branch(
1208
1073
            from_location)
1209
1074
        revision = _get_one_revision('branch', revision)
1210
 
        self.add_cleanup(br_from.lock_read().unlock)
1211
 
        if revision is not None:
1212
 
            revision_id = revision.as_revision_id(br_from)
1213
 
        else:
1214
 
            # FIXME - wt.last_revision, fallback to branch, fall back to
1215
 
            # None or perhaps NULL_REVISION to mean copy nothing
1216
 
            # RBC 20060209
1217
 
            revision_id = br_from.last_revision()
1218
 
        if to_location is None:
1219
 
            to_location = urlutils.derive_to_location(from_location)
1220
 
        to_transport = transport.get_transport(to_location)
 
1075
        br_from.lock_read()
1221
1076
        try:
1222
 
            to_transport.mkdir('.')
1223
 
        except errors.FileExists:
1224
 
            if not use_existing_dir:
1225
 
                raise errors.BzrCommandError('Target directory "%s" '
1226
 
                    'already exists.' % to_location)
 
1077
            if revision is not None:
 
1078
                revision_id = revision.as_revision_id(br_from)
1227
1079
            else:
1228
 
                try:
1229
 
                    bzrdir.BzrDir.open_from_transport(to_transport)
1230
 
                except errors.NotBranchError:
1231
 
                    pass
1232
 
                else:
1233
 
                    raise errors.AlreadyBranchError(to_location)
1234
 
        except errors.NoSuchFile:
1235
 
            raise errors.BzrCommandError('Parent of "%s" does not exist.'
1236
 
                                         % to_location)
1237
 
        try:
1238
 
            # preserve whatever source format we have.
1239
 
            dir = br_from.bzrdir.sprout(to_transport.base, revision_id,
1240
 
                                        possible_transports=[to_transport],
1241
 
                                        accelerator_tree=accelerator_tree,
1242
 
                                        hardlink=hardlink, stacked=stacked,
1243
 
                                        force_new_repo=standalone,
1244
 
                                        create_tree_if_local=not no_tree,
1245
 
                                        source_branch=br_from)
1246
 
            branch = dir.open_branch()
1247
 
        except errors.NoSuchRevision:
1248
 
            to_transport.delete_tree('.')
1249
 
            msg = "The branch %s has no revision %s." % (from_location,
1250
 
                revision)
1251
 
            raise errors.BzrCommandError(msg)
1252
 
        _merge_tags_if_possible(br_from, branch)
1253
 
        # If the source branch is stacked, the new branch may
1254
 
        # be stacked whether we asked for that explicitly or not.
1255
 
        # We therefore need a try/except here and not just 'if stacked:'
1256
 
        try:
1257
 
            note('Created new stacked branch referring to %s.' %
1258
 
                branch.get_stacked_on_url())
1259
 
        except (errors.NotStacked, errors.UnstackableBranchFormat,
1260
 
            errors.UnstackableRepositoryFormat), e:
1261
 
            note('Branched %d revision(s).' % branch.revno())
1262
 
        if bind:
1263
 
            # Bind to the parent
1264
 
            parent_branch = Branch.open(from_location)
1265
 
            branch.bind(parent_branch)
1266
 
            note('New branch bound to %s' % from_location)
1267
 
        if switch:
1268
 
            # Switch to the new branch
1269
 
            wt, _ = WorkingTree.open_containing('.')
1270
 
            _mod_switch.switch(wt.bzrdir, branch)
1271
 
            note('Switched to branch: %s',
1272
 
                urlutils.unescape_for_display(branch.base, 'utf-8'))
 
1080
                # FIXME - wt.last_revision, fallback to branch, fall back to
 
1081
                # None or perhaps NULL_REVISION to mean copy nothing
 
1082
                # RBC 20060209
 
1083
                revision_id = br_from.last_revision()
 
1084
            if to_location is None:
 
1085
                to_location = urlutils.derive_to_location(from_location)
 
1086
            to_transport = transport.get_transport(to_location)
 
1087
            try:
 
1088
                to_transport.mkdir('.')
 
1089
            except errors.FileExists:
 
1090
                raise errors.BzrCommandError('Target directory "%s" already'
 
1091
                                             ' exists.' % to_location)
 
1092
            except errors.NoSuchFile:
 
1093
                raise errors.BzrCommandError('Parent of "%s" does not exist.'
 
1094
                                             % to_location)
 
1095
            try:
 
1096
                # preserve whatever source format we have.
 
1097
                dir = br_from.bzrdir.sprout(to_transport.base, revision_id,
 
1098
                                            possible_transports=[to_transport],
 
1099
                                            accelerator_tree=accelerator_tree,
 
1100
                                            hardlink=hardlink, stacked=stacked,
 
1101
                                            force_new_repo=standalone,
 
1102
                                            create_tree_if_local=not no_tree,
 
1103
                                            source_branch=br_from)
 
1104
                branch = dir.open_branch()
 
1105
            except errors.NoSuchRevision:
 
1106
                to_transport.delete_tree('.')
 
1107
                msg = "The branch %s has no revision %s." % (from_location,
 
1108
                    revision)
 
1109
                raise errors.BzrCommandError(msg)
 
1110
            _merge_tags_if_possible(br_from, branch)
 
1111
            # If the source branch is stacked, the new branch may
 
1112
            # be stacked whether we asked for that explicitly or not.
 
1113
            # We therefore need a try/except here and not just 'if stacked:'
 
1114
            try:
 
1115
                note('Created new stacked branch referring to %s.' %
 
1116
                    branch.get_stacked_on_url())
 
1117
            except (errors.NotStacked, errors.UnstackableBranchFormat,
 
1118
                errors.UnstackableRepositoryFormat), e:
 
1119
                note('Branched %d revision(s).' % branch.revno())
 
1120
        finally:
 
1121
            br_from.unlock()
1273
1122
 
1274
1123
 
1275
1124
class cmd_checkout(Command):
1276
 
    __doc__ = """Create a new checkout of an existing branch.
 
1125
    """Create a new checkout of an existing branch.
1277
1126
 
1278
1127
    If BRANCH_LOCATION is omitted, checkout will reconstitute a working tree for
1279
1128
    the branch found in '.'. This is useful if you have removed the working tree
1342
1191
 
1343
1192
 
1344
1193
class cmd_renames(Command):
1345
 
    __doc__ = """Show list of renamed files.
 
1194
    """Show list of renamed files.
1346
1195
    """
1347
1196
    # TODO: Option to show renames between two historical versions.
1348
1197
 
1353
1202
    @display_command
1354
1203
    def run(self, dir=u'.'):
1355
1204
        tree = WorkingTree.open_containing(dir)[0]
1356
 
        self.add_cleanup(tree.lock_read().unlock)
1357
 
        new_inv = tree.inventory
1358
 
        old_tree = tree.basis_tree()
1359
 
        self.add_cleanup(old_tree.lock_read().unlock)
1360
 
        old_inv = old_tree.inventory
1361
 
        renames = []
1362
 
        iterator = tree.iter_changes(old_tree, include_unchanged=True)
1363
 
        for f, paths, c, v, p, n, k, e in iterator:
1364
 
            if paths[0] == paths[1]:
1365
 
                continue
1366
 
            if None in (paths):
1367
 
                continue
1368
 
            renames.append(paths)
1369
 
        renames.sort()
1370
 
        for old_name, new_name in renames:
1371
 
            self.outf.write("%s => %s\n" % (old_name, new_name))
 
1205
        tree.lock_read()
 
1206
        try:
 
1207
            new_inv = tree.inventory
 
1208
            old_tree = tree.basis_tree()
 
1209
            old_tree.lock_read()
 
1210
            try:
 
1211
                old_inv = old_tree.inventory
 
1212
                renames = []
 
1213
                iterator = tree.iter_changes(old_tree, include_unchanged=True)
 
1214
                for f, paths, c, v, p, n, k, e in iterator:
 
1215
                    if paths[0] == paths[1]:
 
1216
                        continue
 
1217
                    if None in (paths):
 
1218
                        continue
 
1219
                    renames.append(paths)
 
1220
                renames.sort()
 
1221
                for old_name, new_name in renames:
 
1222
                    self.outf.write("%s => %s\n" % (old_name, new_name))
 
1223
            finally:
 
1224
                old_tree.unlock()
 
1225
        finally:
 
1226
            tree.unlock()
1372
1227
 
1373
1228
 
1374
1229
class cmd_update(Command):
1375
 
    __doc__ = """Update a tree to have the latest code committed to its branch.
 
1230
    """Update a tree to have the latest code committed to its branch.
1376
1231
 
1377
1232
    This will perform a merge into the working tree, and may generate
1378
1233
    conflicts. If you have any local changes, you will still
1380
1235
 
1381
1236
    If you want to discard your local changes, you can just do a
1382
1237
    'bzr revert' instead of 'bzr commit' after the update.
1383
 
 
1384
 
    If the tree's branch is bound to a master branch, it will also update
1385
 
    the branch from the master.
1386
1238
    """
1387
1239
 
1388
1240
    _see_also = ['pull', 'working-trees', 'status-flags']
1389
1241
    takes_args = ['dir?']
1390
 
    takes_options = ['revision']
1391
1242
    aliases = ['up']
1392
1243
 
1393
 
    def run(self, dir='.', revision=None):
1394
 
        if revision is not None and len(revision) != 1:
1395
 
            raise errors.BzrCommandError(
1396
 
                        "bzr update --revision takes exactly one revision")
 
1244
    def run(self, dir='.'):
1397
1245
        tree = WorkingTree.open_containing(dir)[0]
1398
 
        branch = tree.branch
1399
1246
        possible_transports = []
1400
 
        master = branch.get_master_branch(
 
1247
        master = tree.branch.get_master_branch(
1401
1248
            possible_transports=possible_transports)
1402
1249
        if master is not None:
1403
 
            branch_location = master.base
1404
1250
            tree.lock_write()
1405
1251
        else:
1406
 
            branch_location = tree.branch.base
1407
1252
            tree.lock_tree_write()
1408
 
        self.add_cleanup(tree.unlock)
1409
 
        # get rid of the final '/' and be ready for display
1410
 
        branch_location = urlutils.unescape_for_display(
1411
 
            branch_location.rstrip('/'),
1412
 
            self.outf.encoding)
1413
 
        existing_pending_merges = tree.get_parent_ids()[1:]
1414
 
        if master is None:
1415
 
            old_tip = None
1416
 
        else:
1417
 
            # may need to fetch data into a heavyweight checkout
1418
 
            # XXX: this may take some time, maybe we should display a
1419
 
            # message
1420
 
            old_tip = branch.update(possible_transports)
1421
 
        if revision is not None:
1422
 
            revision_id = revision[0].as_revision_id(branch)
1423
 
        else:
1424
 
            revision_id = branch.last_revision()
1425
 
        if revision_id == _mod_revision.ensure_null(tree.last_revision()):
1426
 
            revno = branch.revision_id_to_dotted_revno(revision_id)
1427
 
            note("Tree is up to date at revision %s of branch %s" %
1428
 
                ('.'.join(map(str, revno)), branch_location))
1429
 
            return 0
1430
 
        view_info = _get_view_info_for_change_reporter(tree)
1431
 
        change_reporter = delta._ChangeReporter(
1432
 
            unversioned_filter=tree.is_ignored,
1433
 
            view_info=view_info)
1434
1253
        try:
 
1254
            existing_pending_merges = tree.get_parent_ids()[1:]
 
1255
            last_rev = _mod_revision.ensure_null(tree.last_revision())
 
1256
            if last_rev == _mod_revision.ensure_null(
 
1257
                tree.branch.last_revision()):
 
1258
                # may be up to date, check master too.
 
1259
                if master is None or last_rev == _mod_revision.ensure_null(
 
1260
                    master.last_revision()):
 
1261
                    revno = tree.branch.revision_id_to_revno(last_rev)
 
1262
                    note("Tree is up to date at revision %d." % (revno,))
 
1263
                    return 0
 
1264
            view_info = _get_view_info_for_change_reporter(tree)
1435
1265
            conflicts = tree.update(
1436
 
                change_reporter,
1437
 
                possible_transports=possible_transports,
1438
 
                revision=revision_id,
1439
 
                old_tip=old_tip)
1440
 
        except errors.NoSuchRevision, e:
1441
 
            raise errors.BzrCommandError(
1442
 
                                  "branch has no revision %s\n"
1443
 
                                  "bzr update --revision only works"
1444
 
                                  " for a revision in the branch history"
1445
 
                                  % (e.revision))
1446
 
        revno = tree.branch.revision_id_to_dotted_revno(
1447
 
            _mod_revision.ensure_null(tree.last_revision()))
1448
 
        note('Updated to revision %s of branch %s' %
1449
 
             ('.'.join(map(str, revno)), branch_location))
1450
 
        parent_ids = tree.get_parent_ids()
1451
 
        if parent_ids[1:] and parent_ids[1:] != existing_pending_merges:
1452
 
            note('Your local commits will now show as pending merges with '
1453
 
                 "'bzr status', and can be committed with 'bzr commit'.")
1454
 
        if conflicts != 0:
1455
 
            return 1
1456
 
        else:
1457
 
            return 0
 
1266
                delta._ChangeReporter(unversioned_filter=tree.is_ignored,
 
1267
                view_info=view_info), possible_transports=possible_transports)
 
1268
            revno = tree.branch.revision_id_to_revno(
 
1269
                _mod_revision.ensure_null(tree.last_revision()))
 
1270
            note('Updated to revision %d.' % (revno,))
 
1271
            if tree.get_parent_ids()[1:] != existing_pending_merges:
 
1272
                note('Your local commits will now show as pending merges with '
 
1273
                     "'bzr status', and can be committed with 'bzr commit'.")
 
1274
            if conflicts != 0:
 
1275
                return 1
 
1276
            else:
 
1277
                return 0
 
1278
        finally:
 
1279
            tree.unlock()
1458
1280
 
1459
1281
 
1460
1282
class cmd_info(Command):
1461
 
    __doc__ = """Show information about a working tree, branch or repository.
 
1283
    """Show information about a working tree, branch or repository.
1462
1284
 
1463
1285
    This command will show all known locations and formats associated to the
1464
1286
    tree, branch or repository.
1479
1301
      basic statistics (like the number of files in the working tree and
1480
1302
      number of revisions in the branch and repository):
1481
1303
 
1482
 
        bzr info -v
 
1304
        bzr -v info
1483
1305
 
1484
1306
      Display the above together with number of committers to the branch:
1485
1307
 
1486
 
        bzr info -vv
 
1308
        bzr -vv info
1487
1309
    """
1488
1310
    _see_also = ['revno', 'working-trees', 'repositories']
1489
1311
    takes_args = ['location?']
1502
1324
 
1503
1325
 
1504
1326
class cmd_remove(Command):
1505
 
    __doc__ = """Remove files or directories.
 
1327
    """Remove files or directories.
1506
1328
 
1507
1329
    This makes bzr stop tracking changes to the specified files. bzr will delete
1508
1330
    them if they can easily be recovered using revert. If no options or
1517
1339
            title='Deletion Strategy', value_switches=True, enum_switch=False,
1518
1340
            safe='Only delete files if they can be'
1519
1341
                 ' safely recovered (default).',
1520
 
            keep='Delete from bzr but leave the working copy.',
 
1342
            keep="Don't delete any files.",
1521
1343
            force='Delete all the specified files, even if they can not be '
1522
1344
                'recovered and even if they are non-empty directories.')]
1523
1345
    aliases = ['rm', 'del']
1530
1352
        if file_list is not None:
1531
1353
            file_list = [f for f in file_list]
1532
1354
 
1533
 
        self.add_cleanup(tree.lock_write().unlock)
1534
 
        # Heuristics should probably all move into tree.remove_smart or
1535
 
        # some such?
1536
 
        if new:
1537
 
            added = tree.changes_from(tree.basis_tree(),
1538
 
                specific_files=file_list).added
1539
 
            file_list = sorted([f[0] for f in added], reverse=True)
1540
 
            if len(file_list) == 0:
1541
 
                raise errors.BzrCommandError('No matching files.')
1542
 
        elif file_list is None:
1543
 
            # missing files show up in iter_changes(basis) as
1544
 
            # versioned-with-no-kind.
1545
 
            missing = []
1546
 
            for change in tree.iter_changes(tree.basis_tree()):
1547
 
                # Find paths in the working tree that have no kind:
1548
 
                if change[1][1] is not None and change[6][1] is None:
1549
 
                    missing.append(change[1][1])
1550
 
            file_list = sorted(missing, reverse=True)
1551
 
            file_deletion_strategy = 'keep'
1552
 
        tree.remove(file_list, verbose=verbose, to_file=self.outf,
1553
 
            keep_files=file_deletion_strategy=='keep',
1554
 
            force=file_deletion_strategy=='force')
 
1355
        tree.lock_write()
 
1356
        try:
 
1357
            # Heuristics should probably all move into tree.remove_smart or
 
1358
            # some such?
 
1359
            if new:
 
1360
                added = tree.changes_from(tree.basis_tree(),
 
1361
                    specific_files=file_list).added
 
1362
                file_list = sorted([f[0] for f in added], reverse=True)
 
1363
                if len(file_list) == 0:
 
1364
                    raise errors.BzrCommandError('No matching files.')
 
1365
            elif file_list is None:
 
1366
                # missing files show up in iter_changes(basis) as
 
1367
                # versioned-with-no-kind.
 
1368
                missing = []
 
1369
                for change in tree.iter_changes(tree.basis_tree()):
 
1370
                    # Find paths in the working tree that have no kind:
 
1371
                    if change[1][1] is not None and change[6][1] is None:
 
1372
                        missing.append(change[1][1])
 
1373
                file_list = sorted(missing, reverse=True)
 
1374
                file_deletion_strategy = 'keep'
 
1375
            tree.remove(file_list, verbose=verbose, to_file=self.outf,
 
1376
                keep_files=file_deletion_strategy=='keep',
 
1377
                force=file_deletion_strategy=='force')
 
1378
        finally:
 
1379
            tree.unlock()
1555
1380
 
1556
1381
 
1557
1382
class cmd_file_id(Command):
1558
 
    __doc__ = """Print file_id of a particular file or directory.
 
1383
    """Print file_id of a particular file or directory.
1559
1384
 
1560
1385
    The file_id is assigned when the file is first added and remains the
1561
1386
    same through all revisions where the file exists, even when it is
1577
1402
 
1578
1403
 
1579
1404
class cmd_file_path(Command):
1580
 
    __doc__ = """Print path of file_ids to a file or directory.
 
1405
    """Print path of file_ids to a file or directory.
1581
1406
 
1582
1407
    This prints one line for each directory down to the target,
1583
1408
    starting at the branch root.
1599
1424
 
1600
1425
 
1601
1426
class cmd_reconcile(Command):
1602
 
    __doc__ = """Reconcile bzr metadata in a branch.
 
1427
    """Reconcile bzr metadata in a branch.
1603
1428
 
1604
1429
    This can correct data mismatches that may have been caused by
1605
1430
    previous ghost operations or bzr upgrades. You should only
1627
1452
 
1628
1453
 
1629
1454
class cmd_revision_history(Command):
1630
 
    __doc__ = """Display the list of revision ids on a branch."""
 
1455
    """Display the list of revision ids on a branch."""
1631
1456
 
1632
1457
    _see_also = ['log']
1633
1458
    takes_args = ['location?']
1643
1468
 
1644
1469
 
1645
1470
class cmd_ancestry(Command):
1646
 
    __doc__ = """List all revisions merged into this branch."""
 
1471
    """List all revisions merged into this branch."""
1647
1472
 
1648
1473
    _see_also = ['log', 'revision-history']
1649
1474
    takes_args = ['location?']
1668
1493
 
1669
1494
 
1670
1495
class cmd_init(Command):
1671
 
    __doc__ = """Make a directory into a versioned branch.
 
1496
    """Make a directory into a versioned branch.
1672
1497
 
1673
1498
    Use this to create an empty branch, or before importing an
1674
1499
    existing project.
1702
1527
                lazy_registry=('bzrlib.bzrdir', 'format_registry'),
1703
1528
                converter=lambda name: bzrdir.format_registry.make_bzrdir(name),
1704
1529
                value_switches=True,
1705
 
                title="Branch format",
 
1530
                title="Branch Format",
1706
1531
                ),
1707
1532
         Option('append-revisions-only',
1708
1533
                help='Never change revnos or the existing log.'
1731
1556
                    "\nYou may supply --create-prefix to create all"
1732
1557
                    " leading parent directories."
1733
1558
                    % location)
1734
 
            to_transport.create_prefix()
 
1559
            _create_prefix(to_transport)
1735
1560
 
1736
1561
        try:
1737
1562
            a_bzrdir = bzrdir.BzrDir.open_from_transport(to_transport)
1755
1580
                branch.set_append_revisions_only(True)
1756
1581
            except errors.UpgradeRequired:
1757
1582
                raise errors.BzrCommandError('This branch format cannot be set'
1758
 
                    ' to append-revisions-only.  Try --default.')
 
1583
                    ' to append-revisions-only.  Try --experimental-branch6')
1759
1584
        if not is_quiet():
1760
1585
            from bzrlib.info import describe_layout, describe_format
1761
1586
            try:
1777
1602
 
1778
1603
 
1779
1604
class cmd_init_repository(Command):
1780
 
    __doc__ = """Create a shared repository for branches to share storage space.
 
1605
    """Create a shared repository to hold branches.
1781
1606
 
1782
1607
    New branches created under the repository directory will store their
1783
 
    revisions in the repository, not in the branch directory.  For branches
1784
 
    with shared history, this reduces the amount of storage needed and 
1785
 
    speeds up the creation of new branches.
 
1608
    revisions in the repository, not in the branch directory.
1786
1609
 
1787
 
    If the --no-trees option is given then the branches in the repository
1788
 
    will not have working trees by default.  They will still exist as 
1789
 
    directories on disk, but they will not have separate copies of the 
1790
 
    files at a certain revision.  This can be useful for repositories that
1791
 
    store branches which are interacted with through checkouts or remote
1792
 
    branches, such as on a server.
 
1610
    If the --no-trees option is used then the branches in the repository
 
1611
    will not have working trees by default.
1793
1612
 
1794
1613
    :Examples:
1795
 
        Create a shared repository holding just branches::
 
1614
        Create a shared repositories holding just branches::
1796
1615
 
1797
1616
            bzr init-repo --no-trees repo
1798
1617
            bzr init repo/trunk
1837
1656
 
1838
1657
 
1839
1658
class cmd_diff(Command):
1840
 
    __doc__ = """Show differences in the working tree, between revisions or branches.
 
1659
    """Show differences in the working tree, between revisions or branches.
1841
1660
 
1842
1661
    If no arguments are given, all changes for the current tree are listed.
1843
1662
    If files are given, only the changes in those files are listed.
1864
1683
 
1865
1684
            bzr diff -r1
1866
1685
 
1867
 
        Difference between revision 3 and revision 1::
1868
 
 
1869
 
            bzr diff -r1..3
1870
 
 
1871
 
        Difference between revision 3 and revision 1 for branch xxx::
1872
 
 
1873
 
            bzr diff -r1..3 xxx
1874
 
 
1875
 
        To see the changes introduced in revision X::
1876
 
        
1877
 
            bzr diff -cX
1878
 
 
1879
 
        Note that in the case of a merge, the -c option shows the changes
1880
 
        compared to the left hand parent. To see the changes against
1881
 
        another parent, use::
1882
 
 
1883
 
            bzr diff -r<chosen_parent>..X
1884
 
 
1885
 
        The changes introduced by revision 2 (equivalent to -r1..2)::
1886
 
 
1887
 
            bzr diff -c2
 
1686
        Difference between revision 2 and revision 1::
 
1687
 
 
1688
            bzr diff -r1..2
 
1689
 
 
1690
        Difference between revision 2 and revision 1 for branch xxx::
 
1691
 
 
1692
            bzr diff -r1..2 xxx
1888
1693
 
1889
1694
        Show just the differences for file NEWS::
1890
1695
 
1929
1734
            help='Use this command to compare files.',
1930
1735
            type=unicode,
1931
1736
            ),
1932
 
        RegistryOption('format',
1933
 
            help='Diff format to use.',
1934
 
            lazy_registry=('bzrlib.diff', 'format_registry'),
1935
 
            value_switches=False, title='Diff format'),
1936
1737
        ]
1937
1738
    aliases = ['di', 'dif']
1938
1739
    encoding_type = 'exact'
1939
1740
 
1940
1741
    @display_command
1941
1742
    def run(self, revision=None, file_list=None, diff_options=None,
1942
 
            prefix=None, old=None, new=None, using=None, format=None):
1943
 
        from bzrlib.diff import (get_trees_and_branches_to_diff_locked,
1944
 
            show_diff_trees)
 
1743
            prefix=None, old=None, new=None, using=None):
 
1744
        from bzrlib.diff import _get_trees_to_diff, show_diff_trees
1945
1745
 
1946
1746
        if (prefix is None) or (prefix == '0'):
1947
1747
            # diff -p0 format
1961
1761
            raise errors.BzrCommandError('bzr diff --revision takes exactly'
1962
1762
                                         ' one or two revision specifiers')
1963
1763
 
1964
 
        if using is not None and format is not None:
1965
 
            raise errors.BzrCommandError('--using and --format are mutually '
1966
 
                'exclusive.')
1967
 
 
1968
 
        (old_tree, new_tree,
1969
 
         old_branch, new_branch,
1970
 
         specific_files, extra_trees) = get_trees_and_branches_to_diff_locked(
1971
 
            file_list, revision, old, new, self.add_cleanup, apply_view=True)
 
1764
        old_tree, new_tree, specific_files, extra_trees = \
 
1765
                _get_trees_to_diff(file_list, revision, old, new,
 
1766
                apply_view=True)
1972
1767
        return show_diff_trees(old_tree, new_tree, sys.stdout,
1973
1768
                               specific_files=specific_files,
1974
1769
                               external_diff_options=diff_options,
1975
1770
                               old_label=old_label, new_label=new_label,
1976
 
                               extra_trees=extra_trees, using=using,
1977
 
                               format_cls=format)
 
1771
                               extra_trees=extra_trees, using=using)
1978
1772
 
1979
1773
 
1980
1774
class cmd_deleted(Command):
1981
 
    __doc__ = """List files deleted in the working tree.
 
1775
    """List files deleted in the working tree.
1982
1776
    """
1983
1777
    # TODO: Show files deleted since a previous revision, or
1984
1778
    # between two revisions.
1992
1786
    @display_command
1993
1787
    def run(self, show_ids=False):
1994
1788
        tree = WorkingTree.open_containing(u'.')[0]
1995
 
        self.add_cleanup(tree.lock_read().unlock)
1996
 
        old = tree.basis_tree()
1997
 
        self.add_cleanup(old.lock_read().unlock)
1998
 
        for path, ie in old.inventory.iter_entries():
1999
 
            if not tree.has_id(ie.file_id):
2000
 
                self.outf.write(path)
2001
 
                if show_ids:
2002
 
                    self.outf.write(' ')
2003
 
                    self.outf.write(ie.file_id)
2004
 
                self.outf.write('\n')
 
1789
        tree.lock_read()
 
1790
        try:
 
1791
            old = tree.basis_tree()
 
1792
            old.lock_read()
 
1793
            try:
 
1794
                for path, ie in old.inventory.iter_entries():
 
1795
                    if not tree.has_id(ie.file_id):
 
1796
                        self.outf.write(path)
 
1797
                        if show_ids:
 
1798
                            self.outf.write(' ')
 
1799
                            self.outf.write(ie.file_id)
 
1800
                        self.outf.write('\n')
 
1801
            finally:
 
1802
                old.unlock()
 
1803
        finally:
 
1804
            tree.unlock()
2005
1805
 
2006
1806
 
2007
1807
class cmd_modified(Command):
2008
 
    __doc__ = """List files modified in working tree.
 
1808
    """List files modified in working tree.
2009
1809
    """
2010
1810
 
2011
1811
    hidden = True
2028
1828
 
2029
1829
 
2030
1830
class cmd_added(Command):
2031
 
    __doc__ = """List files added in working tree.
 
1831
    """List files added in working tree.
2032
1832
    """
2033
1833
 
2034
1834
    hidden = True
2042
1842
    @display_command
2043
1843
    def run(self, null=False):
2044
1844
        wt = WorkingTree.open_containing(u'.')[0]
2045
 
        self.add_cleanup(wt.lock_read().unlock)
2046
 
        basis = wt.basis_tree()
2047
 
        self.add_cleanup(basis.lock_read().unlock)
2048
 
        basis_inv = basis.inventory
2049
 
        inv = wt.inventory
2050
 
        for file_id in inv:
2051
 
            if file_id in basis_inv:
2052
 
                continue
2053
 
            if inv.is_root(file_id) and len(basis_inv) == 0:
2054
 
                continue
2055
 
            path = inv.id2path(file_id)
2056
 
            if not os.access(osutils.abspath(path), os.F_OK):
2057
 
                continue
2058
 
            if null:
2059
 
                self.outf.write(path + '\0')
2060
 
            else:
2061
 
                self.outf.write(osutils.quotefn(path) + '\n')
 
1845
        wt.lock_read()
 
1846
        try:
 
1847
            basis = wt.basis_tree()
 
1848
            basis.lock_read()
 
1849
            try:
 
1850
                basis_inv = basis.inventory
 
1851
                inv = wt.inventory
 
1852
                for file_id in inv:
 
1853
                    if file_id in basis_inv:
 
1854
                        continue
 
1855
                    if inv.is_root(file_id) and len(basis_inv) == 0:
 
1856
                        continue
 
1857
                    path = inv.id2path(file_id)
 
1858
                    if not os.access(osutils.abspath(path), os.F_OK):
 
1859
                        continue
 
1860
                    if null:
 
1861
                        self.outf.write(path + '\0')
 
1862
                    else:
 
1863
                        self.outf.write(osutils.quotefn(path) + '\n')
 
1864
            finally:
 
1865
                basis.unlock()
 
1866
        finally:
 
1867
            wt.unlock()
2062
1868
 
2063
1869
 
2064
1870
class cmd_root(Command):
2065
 
    __doc__ = """Show the tree root directory.
 
1871
    """Show the tree root directory.
2066
1872
 
2067
1873
    The root is the nearest enclosing directory with a .bzr control
2068
1874
    directory."""
2092
1898
 
2093
1899
 
2094
1900
class cmd_log(Command):
2095
 
    __doc__ = """Show historical log for a branch or subset of a branch.
 
1901
    """Show historical log for a branch or subset of a branch.
2096
1902
 
2097
1903
    log is bzr's default tool for exploring the history of a branch.
2098
1904
    The branch to use is taken from the first parameter. If no parameters
2127
1933
        --show-ids  display revision-ids (and file-ids), not just revnos
2128
1934
 
2129
1935
      Note that the default number of levels to display is a function of the
2130
 
      log format. If the -n option is not used, the standard log formats show
2131
 
      just the top level (mainline).
 
1936
      log format. If the -n option is not used, ``short`` and ``line`` show
 
1937
      just the top level (mainline) while ``long`` shows all levels of merged
 
1938
      revisions.
2132
1939
 
2133
1940
      Status summaries are shown using status flags like A, M, etc. To see
2134
1941
      the changes explained using words like ``added`` and ``modified``
2170
1977
 
2171
1978
    :Path filtering:
2172
1979
 
2173
 
      If parameters are given and the first one is not a branch, the log
2174
 
      will be filtered to show only those revisions that changed the
2175
 
      nominated files or directories.
 
1980
      If a parameter is given and it's not a branch, the log will be filtered
 
1981
      to show only those revisions that changed the nominated file or
 
1982
      directory.
2176
1983
 
2177
1984
      Filenames are interpreted within their historical context. To log a
2178
1985
      deleted file, specify a revision range so that the file existed at
2201
2008
      explicitly ask for this (and no way to stop logging a file back
2202
2009
      until it was last renamed).
2203
2010
 
 
2011
      Note: If the path is a directory, only revisions that directly changed
 
2012
      that directory object are currently shown. This is considered a bug.
 
2013
      (Support for filtering against multiple files and for files within a
 
2014
      directory is under development.)
 
2015
 
2204
2016
    :Other filtering:
2205
2017
 
2206
2018
      The --message option can be used for finding revisions that match a
2209
2021
    :Tips & tricks:
2210
2022
 
2211
2023
      GUI tools and IDEs are often better at exploring history than command
2212
 
      line tools: you may prefer qlog or viz from qbzr or bzr-gtk, the
2213
 
      bzr-explorer shell, or the Loggerhead web interface.  See the Plugin
2214
 
      Guide <http://doc.bazaar.canonical.com/plugins/en/> and
2215
 
      <http://wiki.bazaar.canonical.com/IDEIntegration>.  
 
2024
      line tools. You may prefer qlog or glog from the QBzr and Bzr-Gtk packages
 
2025
      respectively for example. (TortoiseBzr uses qlog for displaying logs.) See
 
2026
      http://bazaar-vcs.org/BzrPlugins and http://bazaar-vcs.org/IDEIntegration.
 
2027
 
 
2028
      Web interfaces are often better at exploring history than command line
 
2029
      tools, particularly for branches on servers. You may prefer Loggerhead
 
2030
      or one of its alternatives. See http://bazaar-vcs.org/WebInterface.
2216
2031
 
2217
2032
      You may find it useful to add the aliases below to ``bazaar.conf``::
2218
2033
 
2219
2034
        [ALIASES]
2220
 
        tip = log -r-1
2221
 
        top = log -l10 --line
2222
 
        show = log -v -p
 
2035
        tip = log -r-1 -n1
 
2036
        top = log -r-10.. --short --forward
 
2037
        show = log -v -p -n1 --long
2223
2038
 
2224
2039
      ``bzr tip`` will then show the latest revision while ``bzr top``
2225
2040
      will show the last 10 mainline revisions. To see the details of a
2226
2041
      particular revision X,  ``bzr show -rX``.
2227
2042
 
2228
 
      If you are interested in looking deeper into a particular merge X,
2229
 
      use ``bzr log -n0 -rX``.
 
2043
      As many GUI tools and Web interfaces do, you may prefer viewing
 
2044
      history collapsed initially. If you are interested in looking deeper
 
2045
      into a particular merge X, use ``bzr log -n0 -rX``. If you like
 
2046
      working this way, you may wish to either:
 
2047
 
 
2048
      * change your default log format to short (or line)
 
2049
      * add this alias: log = log -n1
2230
2050
 
2231
2051
      ``bzr log -v`` on a branch with lots of history is currently
2232
2052
      very slow. A fix for this issue is currently under development.
2240
2060
 
2241
2061
      When exploring non-mainline history on large projects with deep
2242
2062
      history, the performance of log can be greatly improved by installing
2243
 
      the historycache plugin. This plugin buffers historical information
 
2063
      the revnocache plugin. This plugin buffers historical information
2244
2064
      trading disk space for faster speed.
2245
2065
    """
2246
 
    takes_args = ['file*']
 
2066
    takes_args = ['location?']
2247
2067
    _see_also = ['log-formats', 'revisionspec']
2248
2068
    takes_options = [
2249
2069
            Option('forward',
2277
2097
            Option('show-diff',
2278
2098
                   short_name='p',
2279
2099
                   help='Show changes made in each revision as a patch.'),
2280
 
            Option('include-merges',
2281
 
                   help='Show merged revisions like --levels 0 does.'),
2282
 
            Option('exclude-common-ancestry',
2283
 
                   help='Display only the revisions that are not part'
2284
 
                   ' of both ancestries (require -rX..Y)'
2285
 
                   )
2286
2100
            ]
2287
2101
    encoding_type = 'replace'
2288
2102
 
2289
2103
    @display_command
2290
 
    def run(self, file_list=None, timezone='original',
 
2104
    def run(self, location=None, timezone='original',
2291
2105
            verbose=False,
2292
2106
            show_ids=False,
2293
2107
            forward=False,
2297
2111
            levels=None,
2298
2112
            message=None,
2299
2113
            limit=None,
2300
 
            show_diff=False,
2301
 
            include_merges=False,
2302
 
            exclude_common_ancestry=False,
2303
 
            ):
2304
 
        from bzrlib.log import (
2305
 
            Logger,
2306
 
            make_log_request_dict,
2307
 
            _get_info_for_log_files,
2308
 
            )
 
2114
            show_diff=False):
 
2115
        from bzrlib.log import show_log, _get_fileid_to_log
2309
2116
        direction = (forward and 'forward') or 'reverse'
2310
 
        if (exclude_common_ancestry
2311
 
            and (revision is None or len(revision) != 2)):
2312
 
            raise errors.BzrCommandError(
2313
 
                '--exclude-common-ancestry requires -r with two revisions')
2314
 
        if include_merges:
2315
 
            if levels is None:
2316
 
                levels = 0
2317
 
            else:
2318
 
                raise errors.BzrCommandError(
2319
 
                    '--levels and --include-merges are mutually exclusive')
2320
2117
 
2321
2118
        if change is not None:
2322
2119
            if len(change) > 1:
2327
2124
            else:
2328
2125
                revision = change
2329
2126
 
2330
 
        file_ids = []
2331
 
        filter_by_dir = False
2332
 
        if file_list:
2333
 
            # find the file ids to log and check for directory filtering
2334
 
            b, file_info_list, rev1, rev2 = _get_info_for_log_files(
2335
 
                revision, file_list, self.add_cleanup)
2336
 
            for relpath, file_id, kind in file_info_list:
 
2127
        # log everything
 
2128
        file_id = None
 
2129
        if location:
 
2130
            # find the file id to log:
 
2131
 
 
2132
            tree, b, fp = bzrdir.BzrDir.open_containing_tree_or_branch(
 
2133
                location)
 
2134
            if fp != '':
 
2135
                file_id = _get_fileid_to_log(revision, tree, b, fp)
2337
2136
                if file_id is None:
2338
2137
                    raise errors.BzrCommandError(
2339
2138
                        "Path unknown at end or start of revision range: %s" %
2340
 
                        relpath)
2341
 
                # If the relpath is the top of the tree, we log everything
2342
 
                if relpath == '':
2343
 
                    file_ids = []
2344
 
                    break
2345
 
                else:
2346
 
                    file_ids.append(file_id)
2347
 
                filter_by_dir = filter_by_dir or (
2348
 
                    kind in ['directory', 'tree-reference'])
 
2139
                        location)
2349
2140
        else:
2350
 
            # log everything
 
2141
            # local dir only
2351
2142
            # FIXME ? log the current subdir only RBC 20060203
2352
2143
            if revision is not None \
2353
2144
                    and len(revision) > 0 and revision[0].get_branch():
2356
2147
                location = '.'
2357
2148
            dir, relpath = bzrdir.BzrDir.open_containing(location)
2358
2149
            b = dir.open_branch()
2359
 
            self.add_cleanup(b.lock_read().unlock)
 
2150
 
 
2151
        b.lock_read()
 
2152
        try:
2360
2153
            rev1, rev2 = _get_revision_range(revision, b, self.name())
2361
 
 
2362
 
        # Decide on the type of delta & diff filtering to use
2363
 
        # TODO: add an --all-files option to make this configurable & consistent
2364
 
        if not verbose:
2365
 
            delta_type = None
2366
 
        else:
2367
 
            delta_type = 'full'
2368
 
        if not show_diff:
2369
 
            diff_type = None
2370
 
        elif file_ids:
2371
 
            diff_type = 'partial'
2372
 
        else:
2373
 
            diff_type = 'full'
2374
 
 
2375
 
        # Build the log formatter
2376
 
        if log_format is None:
2377
 
            log_format = log.log_formatter_registry.get_default(b)
2378
 
        # Make a non-encoding output to include the diffs - bug 328007
2379
 
        unencoded_output = ui.ui_factory.make_output_stream(encoding_type='exact')
2380
 
        lf = log_format(show_ids=show_ids, to_file=self.outf,
2381
 
                        to_exact_file=unencoded_output,
2382
 
                        show_timezone=timezone,
2383
 
                        delta_format=get_verbosity_level(),
2384
 
                        levels=levels,
2385
 
                        show_advice=levels is None)
2386
 
 
2387
 
        # Choose the algorithm for doing the logging. It's annoying
2388
 
        # having multiple code paths like this but necessary until
2389
 
        # the underlying repository format is faster at generating
2390
 
        # deltas or can provide everything we need from the indices.
2391
 
        # The default algorithm - match-using-deltas - works for
2392
 
        # multiple files and directories and is faster for small
2393
 
        # amounts of history (200 revisions say). However, it's too
2394
 
        # slow for logging a single file in a repository with deep
2395
 
        # history, i.e. > 10K revisions. In the spirit of "do no
2396
 
        # evil when adding features", we continue to use the
2397
 
        # original algorithm - per-file-graph - for the "single
2398
 
        # file that isn't a directory without showing a delta" case.
2399
 
        partial_history = revision and b.repository._format.supports_chks
2400
 
        match_using_deltas = (len(file_ids) != 1 or filter_by_dir
2401
 
            or delta_type or partial_history)
2402
 
 
2403
 
        # Build the LogRequest and execute it
2404
 
        if len(file_ids) == 0:
2405
 
            file_ids = None
2406
 
        rqst = make_log_request_dict(
2407
 
            direction=direction, specific_fileids=file_ids,
2408
 
            start_revision=rev1, end_revision=rev2, limit=limit,
2409
 
            message_search=message, delta_type=delta_type,
2410
 
            diff_type=diff_type, _match_using_deltas=match_using_deltas,
2411
 
            exclude_common_ancestry=exclude_common_ancestry,
2412
 
            )
2413
 
        Logger(b, rqst).show(lf)
 
2154
            if log_format is None:
 
2155
                log_format = log.log_formatter_registry.get_default(b)
 
2156
 
 
2157
            lf = log_format(show_ids=show_ids, to_file=self.outf,
 
2158
                            show_timezone=timezone,
 
2159
                            delta_format=get_verbosity_level(),
 
2160
                            levels=levels)
 
2161
 
 
2162
            show_log(b,
 
2163
                     lf,
 
2164
                     file_id,
 
2165
                     verbose=verbose,
 
2166
                     direction=direction,
 
2167
                     start_revision=rev1,
 
2168
                     end_revision=rev2,
 
2169
                     search=message,
 
2170
                     limit=limit,
 
2171
                     show_diff=show_diff)
 
2172
        finally:
 
2173
            b.unlock()
2414
2174
 
2415
2175
 
2416
2176
def _get_revision_range(revisionspec_list, branch, command_name):
2417
2177
    """Take the input of a revision option and turn it into a revision range.
2418
2178
 
2419
2179
    It returns RevisionInfo objects which can be used to obtain the rev_id's
2420
 
    of the desired revisions. It does some user input validations.
 
2180
    of the desired revisons. It does some user input validations.
2421
2181
    """
2422
2182
    if revisionspec_list is None:
2423
2183
        rev1 = None
2434
2194
            raise errors.BzrCommandError(
2435
2195
                "bzr %s doesn't accept two revisions in different"
2436
2196
                " branches." % command_name)
2437
 
        if start_spec.spec is None:
2438
 
            # Avoid loading all the history.
2439
 
            rev1 = RevisionInfo(branch, None, None)
2440
 
        else:
2441
 
            rev1 = start_spec.in_history(branch)
 
2197
        rev1 = start_spec.in_history(branch)
2442
2198
        # Avoid loading all of history when we know a missing
2443
2199
        # end of range means the last revision ...
2444
2200
        if end_spec.spec is None:
2473
2229
 
2474
2230
 
2475
2231
class cmd_touching_revisions(Command):
2476
 
    __doc__ = """Return revision-ids which affected a particular file.
 
2232
    """Return revision-ids which affected a particular file.
2477
2233
 
2478
2234
    A more user-friendly interface is "bzr log FILE".
2479
2235
    """
2484
2240
    @display_command
2485
2241
    def run(self, filename):
2486
2242
        tree, relpath = WorkingTree.open_containing(filename)
 
2243
        b = tree.branch
2487
2244
        file_id = tree.path2id(relpath)
2488
 
        b = tree.branch
2489
 
        self.add_cleanup(b.lock_read().unlock)
2490
 
        touching_revs = log.find_touching_revisions(b, file_id)
2491
 
        for revno, revision_id, what in touching_revs:
 
2245
        for revno, revision_id, what in log.find_touching_revisions(b, file_id):
2492
2246
            self.outf.write("%6d %s\n" % (revno, what))
2493
2247
 
2494
2248
 
2495
2249
class cmd_ls(Command):
2496
 
    __doc__ = """List files in a tree.
 
2250
    """List files in a tree.
2497
2251
    """
2498
2252
 
2499
2253
    _see_also = ['status', 'cat']
2500
2254
    takes_args = ['path?']
 
2255
    # TODO: Take a revision or remote path and list that tree instead.
2501
2256
    takes_options = [
2502
2257
            'verbose',
2503
2258
            'revision',
2504
 
            Option('recursive', short_name='R',
2505
 
                   help='Recurse into subdirectories.'),
 
2259
            Option('non-recursive',
 
2260
                   help='Don\'t recurse into subdirectories.'),
2506
2261
            Option('from-root',
2507
2262
                   help='Print paths relative to the root of the branch.'),
2508
2263
            Option('unknown', help='Print unknown files.'),
2519
2274
            ]
2520
2275
    @display_command
2521
2276
    def run(self, revision=None, verbose=False,
2522
 
            recursive=False, from_root=False,
 
2277
            non_recursive=False, from_root=False,
2523
2278
            unknown=False, versioned=False, ignored=False,
2524
2279
            null=False, kind=None, show_ids=False, path=None):
2525
2280
 
2534
2289
 
2535
2290
        if path is None:
2536
2291
            fs_path = '.'
 
2292
            prefix = ''
2537
2293
        else:
2538
2294
            if from_root:
2539
2295
                raise errors.BzrCommandError('cannot specify both --from-root'
2540
2296
                                             ' and PATH')
2541
2297
            fs_path = path
 
2298
            prefix = path
2542
2299
        tree, branch, relpath = bzrdir.BzrDir.open_containing_tree_or_branch(
2543
2300
            fs_path)
2544
 
 
2545
 
        # Calculate the prefix to use
2546
 
        prefix = None
2547
2301
        if from_root:
2548
 
            if relpath:
2549
 
                prefix = relpath + '/'
2550
 
        elif fs_path != '.' and not fs_path.endswith('/'):
2551
 
            prefix = fs_path + '/'
2552
 
 
 
2302
            relpath = u''
 
2303
        elif relpath:
 
2304
            relpath += '/'
2553
2305
        if revision is not None or tree is None:
2554
2306
            tree = _get_one_revision_tree('ls', revision, branch=branch)
2555
2307
 
2559
2311
            if view_files:
2560
2312
                apply_view = True
2561
2313
                view_str = views.view_display_str(view_files)
2562
 
                note("Ignoring files outside view. View is %s" % view_str)
2563
 
 
2564
 
        self.add_cleanup(tree.lock_read().unlock)
2565
 
        for fp, fc, fkind, fid, entry in tree.list_files(include_root=False,
2566
 
            from_dir=relpath, recursive=recursive):
2567
 
            # Apply additional masking
2568
 
            if not all and not selection[fc]:
2569
 
                continue
2570
 
            if kind is not None and fkind != kind:
2571
 
                continue
2572
 
            if apply_view:
2573
 
                try:
2574
 
                    if relpath:
2575
 
                        fullpath = osutils.pathjoin(relpath, fp)
2576
 
                    else:
2577
 
                        fullpath = fp
2578
 
                    views.check_path_in_view(tree, fullpath)
2579
 
                except errors.FileOutsideView:
2580
 
                    continue
2581
 
 
2582
 
            # Output the entry
2583
 
            if prefix:
2584
 
                fp = osutils.pathjoin(prefix, fp)
2585
 
            kindch = entry.kind_character()
2586
 
            outstring = fp + kindch
2587
 
            ui.ui_factory.clear_term()
2588
 
            if verbose:
2589
 
                outstring = '%-8s %s' % (fc, outstring)
2590
 
                if show_ids and fid is not None:
2591
 
                    outstring = "%-50s %s" % (outstring, fid)
2592
 
                self.outf.write(outstring + '\n')
2593
 
            elif null:
2594
 
                self.outf.write(fp + '\0')
2595
 
                if show_ids:
2596
 
                    if fid is not None:
2597
 
                        self.outf.write(fid)
2598
 
                    self.outf.write('\0')
2599
 
                self.outf.flush()
2600
 
            else:
2601
 
                if show_ids:
2602
 
                    if fid is not None:
2603
 
                        my_id = fid
2604
 
                    else:
2605
 
                        my_id = ''
2606
 
                    self.outf.write('%-50s %s\n' % (outstring, my_id))
2607
 
                else:
2608
 
                    self.outf.write(outstring + '\n')
 
2314
                note("ignoring files outside view: %s" % view_str)
 
2315
 
 
2316
        tree.lock_read()
 
2317
        try:
 
2318
            for fp, fc, fkind, fid, entry in tree.list_files(include_root=False):
 
2319
                if fp.startswith(relpath):
 
2320
                    fp = osutils.pathjoin(prefix, fp[len(relpath):])
 
2321
                    if non_recursive and '/' in fp:
 
2322
                        continue
 
2323
                    if not all and not selection[fc]:
 
2324
                        continue
 
2325
                    if kind is not None and fkind != kind:
 
2326
                        continue
 
2327
                    if apply_view:
 
2328
                        try:
 
2329
                            views.check_path_in_view(tree, fp)
 
2330
                        except errors.FileOutsideView:
 
2331
                            continue
 
2332
                    kindch = entry.kind_character()
 
2333
                    outstring = fp + kindch
 
2334
                    if verbose:
 
2335
                        outstring = '%-8s %s' % (fc, outstring)
 
2336
                        if show_ids and fid is not None:
 
2337
                            outstring = "%-50s %s" % (outstring, fid)
 
2338
                        self.outf.write(outstring + '\n')
 
2339
                    elif null:
 
2340
                        self.outf.write(fp + '\0')
 
2341
                        if show_ids:
 
2342
                            if fid is not None:
 
2343
                                self.outf.write(fid)
 
2344
                            self.outf.write('\0')
 
2345
                        self.outf.flush()
 
2346
                    else:
 
2347
                        if fid is not None:
 
2348
                            my_id = fid
 
2349
                        else:
 
2350
                            my_id = ''
 
2351
                        if show_ids:
 
2352
                            self.outf.write('%-50s %s\n' % (outstring, my_id))
 
2353
                        else:
 
2354
                            self.outf.write(outstring + '\n')
 
2355
        finally:
 
2356
            tree.unlock()
2609
2357
 
2610
2358
 
2611
2359
class cmd_unknowns(Command):
2612
 
    __doc__ = """List unknown files.
 
2360
    """List unknown files.
2613
2361
    """
2614
2362
 
2615
2363
    hidden = True
2622
2370
 
2623
2371
 
2624
2372
class cmd_ignore(Command):
2625
 
    __doc__ = """Ignore specified files or patterns.
 
2373
    """Ignore specified files or patterns.
2626
2374
 
2627
2375
    See ``bzr help patterns`` for details on the syntax of patterns.
2628
2376
 
2629
 
    If a .bzrignore file does not exist, the ignore command
2630
 
    will create one and add the specified files or patterns to the newly
2631
 
    created file. The ignore command will also automatically add the 
2632
 
    .bzrignore file to be versioned. Creating a .bzrignore file without
2633
 
    the use of the ignore command will require an explicit add command.
2634
 
 
2635
2377
    To remove patterns from the ignore list, edit the .bzrignore file.
2636
2378
    After adding, editing or deleting that file either indirectly by
2637
2379
    using this command or directly by using an editor, be sure to commit
2638
2380
    it.
2639
 
    
2640
 
    Bazaar also supports a global ignore file ~/.bazaar/ignore. On Windows
2641
 
    the global ignore file can be found in the application data directory as
2642
 
    C:\\Documents and Settings\\<user>\\Application Data\\Bazaar\\2.0\\ignore.
2643
 
    Global ignores are not touched by this command. The global ignore file
2644
 
    can be edited directly using an editor.
2645
 
 
2646
 
    Patterns prefixed with '!' are exceptions to ignore patterns and take
2647
 
    precedence over regular ignores.  Such exceptions are used to specify
2648
 
    files that should be versioned which would otherwise be ignored.
2649
 
    
2650
 
    Patterns prefixed with '!!' act as regular ignore patterns, but have
2651
 
    precedence over the '!' exception patterns.
2652
2381
 
2653
2382
    Note: ignore patterns containing shell wildcards must be quoted from
2654
2383
    the shell on Unix.
2658
2387
 
2659
2388
            bzr ignore ./Makefile
2660
2389
 
2661
 
        Ignore .class files in all directories...::
 
2390
        Ignore class files in all directories::
2662
2391
 
2663
2392
            bzr ignore "*.class"
2664
2393
 
2665
 
        ...but do not ignore "special.class"::
2666
 
 
2667
 
            bzr ignore "!special.class"
2668
 
 
2669
2394
        Ignore .o files under the lib directory::
2670
2395
 
2671
2396
            bzr ignore "lib/**/*.o"
2677
2402
        Ignore everything but the "debian" toplevel directory::
2678
2403
 
2679
2404
            bzr ignore "RE:(?!debian/).*"
2680
 
        
2681
 
        Ignore everything except the "local" toplevel directory,
2682
 
        but always ignore "*~" autosave files, even under local/::
2683
 
        
2684
 
            bzr ignore "*"
2685
 
            bzr ignore "!./local"
2686
 
            bzr ignore "!!*~"
2687
2405
    """
2688
2406
 
2689
2407
    _see_also = ['status', 'ignored', 'patterns']
2690
2408
    takes_args = ['name_pattern*']
2691
2409
    takes_options = [
2692
 
        Option('default-rules',
2693
 
               help='Display the default ignore rules that bzr uses.')
 
2410
        Option('old-default-rules',
 
2411
               help='Write out the ignore rules bzr < 0.9 always used.')
2694
2412
        ]
2695
2413
 
2696
 
    def run(self, name_pattern_list=None, default_rules=None):
 
2414
    def run(self, name_pattern_list=None, old_default_rules=None):
2697
2415
        from bzrlib import ignores
2698
 
        if default_rules is not None:
2699
 
            # dump the default rules and exit
2700
 
            for pattern in ignores.USER_DEFAULTS:
2701
 
                self.outf.write("%s\n" % pattern)
 
2416
        if old_default_rules is not None:
 
2417
            # dump the rules and exit
 
2418
            for pattern in ignores.OLD_DEFAULTS:
 
2419
                print pattern
2702
2420
            return
2703
2421
        if not name_pattern_list:
2704
2422
            raise errors.BzrCommandError("ignore requires at least one "
2705
 
                "NAME_PATTERN or --default-rules.")
 
2423
                                  "NAME_PATTERN or --old-default-rules")
2706
2424
        name_pattern_list = [globbing.normalize_pattern(p)
2707
2425
                             for p in name_pattern_list]
2708
2426
        for name_pattern in name_pattern_list:
2720
2438
            if id is not None:
2721
2439
                filename = entry[0]
2722
2440
                if ignored.match(filename):
2723
 
                    matches.append(filename)
 
2441
                    matches.append(filename.encode('utf-8'))
2724
2442
        tree.unlock()
2725
2443
        if len(matches) > 0:
2726
 
            self.outf.write("Warning: the following files are version controlled and"
2727
 
                  " match your ignore pattern:\n%s"
2728
 
                  "\nThese files will continue to be version controlled"
2729
 
                  " unless you 'bzr remove' them.\n" % ("\n".join(matches),))
 
2444
            print "Warning: the following files are version controlled and" \
 
2445
                  " match your ignore pattern:\n%s" \
 
2446
                  "\nThese files will continue to be version controlled" \
 
2447
                  " unless you 'bzr remove' them." % ("\n".join(matches),)
2730
2448
 
2731
2449
 
2732
2450
class cmd_ignored(Command):
2733
 
    __doc__ = """List ignored files and the patterns that matched them.
 
2451
    """List ignored files and the patterns that matched them.
2734
2452
 
2735
2453
    List all the ignored files and the ignore pattern that caused the file to
2736
2454
    be ignored.
2746
2464
    @display_command
2747
2465
    def run(self):
2748
2466
        tree = WorkingTree.open_containing(u'.')[0]
2749
 
        self.add_cleanup(tree.lock_read().unlock)
2750
 
        for path, file_class, kind, file_id, entry in tree.list_files():
2751
 
            if file_class != 'I':
2752
 
                continue
2753
 
            ## XXX: Slightly inefficient since this was already calculated
2754
 
            pat = tree.is_ignored(path)
2755
 
            self.outf.write('%-50s %s\n' % (path, pat))
 
2467
        tree.lock_read()
 
2468
        try:
 
2469
            for path, file_class, kind, file_id, entry in tree.list_files():
 
2470
                if file_class != 'I':
 
2471
                    continue
 
2472
                ## XXX: Slightly inefficient since this was already calculated
 
2473
                pat = tree.is_ignored(path)
 
2474
                self.outf.write('%-50s %s\n' % (path, pat))
 
2475
        finally:
 
2476
            tree.unlock()
2756
2477
 
2757
2478
 
2758
2479
class cmd_lookup_revision(Command):
2759
 
    __doc__ = """Lookup the revision-id from a revision-number
 
2480
    """Lookup the revision-id from a revision-number
2760
2481
 
2761
2482
    :Examples:
2762
2483
        bzr lookup-revision 33
2769
2490
        try:
2770
2491
            revno = int(revno)
2771
2492
        except ValueError:
2772
 
            raise errors.BzrCommandError("not a valid revision-number: %r"
2773
 
                                         % revno)
2774
 
        revid = WorkingTree.open_containing(u'.')[0].branch.get_rev_id(revno)
2775
 
        self.outf.write("%s\n" % revid)
 
2493
            raise errors.BzrCommandError("not a valid revision-number: %r" % revno)
 
2494
 
 
2495
        print WorkingTree.open_containing(u'.')[0].branch.get_rev_id(revno)
2776
2496
 
2777
2497
 
2778
2498
class cmd_export(Command):
2779
 
    __doc__ = """Export current or past revision to a destination directory or archive.
 
2499
    """Export current or past revision to a destination directory or archive.
2780
2500
 
2781
2501
    If no revision is specified this exports the last committed revision.
2782
2502
 
2814
2534
        Option('root',
2815
2535
               type=str,
2816
2536
               help="Name of the root directory inside the exported file."),
2817
 
        Option('per-file-timestamps',
2818
 
               help='Set modification time of files to that of the last '
2819
 
                    'revision in which it was changed.'),
2820
2537
        ]
2821
2538
    def run(self, dest, branch_or_subdir=None, revision=None, format=None,
2822
 
        root=None, filters=False, per_file_timestamps=False):
 
2539
        root=None, filters=False):
2823
2540
        from bzrlib.export import export
2824
2541
 
2825
2542
        if branch_or_subdir is None:
2832
2549
 
2833
2550
        rev_tree = _get_one_revision_tree('export', revision, branch=b, tree=tree)
2834
2551
        try:
2835
 
            export(rev_tree, dest, format, root, subdir, filtered=filters,
2836
 
                   per_file_timestamps=per_file_timestamps)
 
2552
            export(rev_tree, dest, format, root, subdir, filtered=filters)
2837
2553
        except errors.NoSuchExportFormat, e:
2838
2554
            raise errors.BzrCommandError('Unsupported export format: %s' % e.format)
2839
2555
 
2840
2556
 
2841
2557
class cmd_cat(Command):
2842
 
    __doc__ = """Write the contents of a file as of a given revision to standard output.
 
2558
    """Write the contents of a file as of a given revision to standard output.
2843
2559
 
2844
2560
    If no revision is nominated, the last revision is used.
2845
2561
 
2865
2581
                                         " one revision specifier")
2866
2582
        tree, branch, relpath = \
2867
2583
            bzrdir.BzrDir.open_containing_tree_or_branch(filename)
2868
 
        self.add_cleanup(branch.lock_read().unlock)
2869
 
        return self._run(tree, branch, relpath, filename, revision,
2870
 
                         name_from_revision, filters)
 
2584
        branch.lock_read()
 
2585
        try:
 
2586
            return self._run(tree, branch, relpath, filename, revision,
 
2587
                             name_from_revision, filters)
 
2588
        finally:
 
2589
            branch.unlock()
2871
2590
 
2872
2591
    def _run(self, tree, b, relpath, filename, revision, name_from_revision,
2873
2592
        filtered):
2874
2593
        if tree is None:
2875
2594
            tree = b.basis_tree()
2876
2595
        rev_tree = _get_one_revision_tree('cat', revision, branch=b)
2877
 
        self.add_cleanup(rev_tree.lock_read().unlock)
2878
2596
 
2879
2597
        old_file_id = rev_tree.path2id(relpath)
2880
2598
 
2915
2633
            chunks = content.splitlines(True)
2916
2634
            content = filtered_output_bytes(chunks, filters,
2917
2635
                ContentFilterContext(relpath, rev_tree))
2918
 
            self.cleanup_now()
2919
2636
            self.outf.writelines(content)
2920
2637
        else:
2921
 
            self.cleanup_now()
2922
2638
            self.outf.write(content)
2923
2639
 
2924
2640
 
2925
2641
class cmd_local_time_offset(Command):
2926
 
    __doc__ = """Show the offset in seconds from GMT to local time."""
 
2642
    """Show the offset in seconds from GMT to local time."""
2927
2643
    hidden = True
2928
2644
    @display_command
2929
2645
    def run(self):
2930
 
        self.outf.write("%s\n" % osutils.local_time_offset())
 
2646
        print osutils.local_time_offset()
2931
2647
 
2932
2648
 
2933
2649
 
2934
2650
class cmd_commit(Command):
2935
 
    __doc__ = """Commit changes into a new revision.
2936
 
 
2937
 
    An explanatory message needs to be given for each commit. This is
2938
 
    often done by using the --message option (getting the message from the
2939
 
    command line) or by using the --file option (getting the message from
2940
 
    a file). If neither of these options is given, an editor is opened for
2941
 
    the user to enter the message. To see the changed files in the
2942
 
    boilerplate text loaded into the editor, use the --show-diff option.
2943
 
 
2944
 
    By default, the entire tree is committed and the person doing the
2945
 
    commit is assumed to be the author. These defaults can be overridden
2946
 
    as explained below.
2947
 
 
2948
 
    :Selective commits:
2949
 
 
2950
 
      If selected files are specified, only changes to those files are
2951
 
      committed.  If a directory is specified then the directory and
2952
 
      everything within it is committed.
2953
 
  
2954
 
      When excludes are given, they take precedence over selected files.
2955
 
      For example, to commit only changes within foo, but not changes
2956
 
      within foo/bar::
2957
 
  
2958
 
        bzr commit foo -x foo/bar
2959
 
  
2960
 
      A selective commit after a merge is not yet supported.
2961
 
 
2962
 
    :Custom authors:
2963
 
 
2964
 
      If the author of the change is not the same person as the committer,
2965
 
      you can specify the author's name using the --author option. The
2966
 
      name should be in the same format as a committer-id, e.g.
2967
 
      "John Doe <jdoe@example.com>". If there is more than one author of
2968
 
      the change you can specify the option multiple times, once for each
2969
 
      author.
2970
 
  
2971
 
    :Checks:
2972
 
 
2973
 
      A common mistake is to forget to add a new file or directory before
2974
 
      running the commit command. The --strict option checks for unknown
2975
 
      files and aborts the commit if any are found. More advanced pre-commit
2976
 
      checks can be implemented by defining hooks. See ``bzr help hooks``
2977
 
      for details.
2978
 
 
2979
 
    :Things to note:
2980
 
 
2981
 
      If you accidentially commit the wrong changes or make a spelling
2982
 
      mistake in the commit message say, you can use the uncommit command
2983
 
      to undo it. See ``bzr help uncommit`` for details.
2984
 
 
2985
 
      Hooks can also be configured to run after a commit. This allows you
2986
 
      to trigger updates to external systems like bug trackers. The --fixes
2987
 
      option can be used to record the association between a revision and
2988
 
      one or more bugs. See ``bzr help bugs`` for details.
2989
 
 
2990
 
      A selective commit may fail in some cases where the committed
2991
 
      tree would be invalid. Consider::
2992
 
  
2993
 
        bzr init foo
2994
 
        mkdir foo/bar
2995
 
        bzr add foo/bar
2996
 
        bzr commit foo -m "committing foo"
2997
 
        bzr mv foo/bar foo/baz
2998
 
        mkdir foo/bar
2999
 
        bzr add foo/bar
3000
 
        bzr commit foo/bar -m "committing bar but not baz"
3001
 
  
3002
 
      In the example above, the last commit will fail by design. This gives
3003
 
      the user the opportunity to decide whether they want to commit the
3004
 
      rename at the same time, separately first, or not at all. (As a general
3005
 
      rule, when in doubt, Bazaar has a policy of Doing the Safe Thing.)
 
2651
    """Commit changes into a new revision.
 
2652
 
 
2653
    If no arguments are given, the entire tree is committed.
 
2654
 
 
2655
    If selected files are specified, only changes to those files are
 
2656
    committed.  If a directory is specified then the directory and everything
 
2657
    within it is committed.
 
2658
 
 
2659
    When excludes are given, they take precedence over selected files.
 
2660
    For example, too commit only changes within foo, but not changes within
 
2661
    foo/bar::
 
2662
 
 
2663
      bzr commit foo -x foo/bar
 
2664
 
 
2665
    If author of the change is not the same person as the committer, you can
 
2666
    specify the author's name using the --author option. The name should be
 
2667
    in the same format as a committer-id, e.g. "John Doe <jdoe@example.com>".
 
2668
    If there is more than one author of the change you can specify the option
 
2669
    multiple times, once for each author.
 
2670
 
 
2671
    A selected-file commit may fail in some cases where the committed
 
2672
    tree would be invalid. Consider::
 
2673
 
 
2674
      bzr init foo
 
2675
      mkdir foo/bar
 
2676
      bzr add foo/bar
 
2677
      bzr commit foo -m "committing foo"
 
2678
      bzr mv foo/bar foo/baz
 
2679
      mkdir foo/bar
 
2680
      bzr add foo/bar
 
2681
      bzr commit foo/bar -m "committing bar but not baz"
 
2682
 
 
2683
    In the example above, the last commit will fail by design. This gives
 
2684
    the user the opportunity to decide whether they want to commit the
 
2685
    rename at the same time, separately first, or not at all. (As a general
 
2686
    rule, when in doubt, Bazaar has a policy of Doing the Safe Thing.)
 
2687
 
 
2688
    Note: A selected-file commit after a merge is not yet supported.
3006
2689
    """
3007
2690
    # TODO: Run hooks on tree to-be-committed, and after commit.
3008
2691
 
3013
2696
 
3014
2697
    # XXX: verbose currently does nothing
3015
2698
 
3016
 
    _see_also = ['add', 'bugs', 'hooks', 'uncommit']
 
2699
    _see_also = ['bugs', 'uncommit']
3017
2700
    takes_args = ['selected*']
3018
2701
    takes_options = [
3019
2702
            ListOption('exclude', type=str, short_name='x',
3031
2714
             Option('strict',
3032
2715
                    help="Refuse to commit if there are unknown "
3033
2716
                    "files in the working tree."),
3034
 
             Option('commit-time', type=str,
3035
 
                    help="Manually set a commit time using commit date "
3036
 
                    "format, e.g. '2009-10-10 08:00:00 +0100'."),
3037
2717
             ListOption('fixes', type=str,
3038
2718
                    help="Mark a bug as being fixed by this revision "
3039
2719
                         "(see \"bzr help bugs\")."),
3046
2726
                         "the master branch until a normal commit "
3047
2727
                         "is performed."
3048
2728
                    ),
3049
 
             Option('show-diff', short_name='p',
3050
 
                    help='When no message is supplied, show the diff along'
3051
 
                    ' with the status summary in the message editor.'),
 
2729
              Option('show-diff',
 
2730
                     help='When no message is supplied, show the diff along'
 
2731
                     ' with the status summary in the message editor.'),
3052
2732
             ]
3053
2733
    aliases = ['ci', 'checkin']
3054
2734
 
3073
2753
 
3074
2754
    def run(self, message=None, file=None, verbose=False, selected_list=None,
3075
2755
            unchanged=False, strict=False, local=False, fixes=None,
3076
 
            author=None, show_diff=False, exclude=None, commit_time=None):
 
2756
            author=None, show_diff=False, exclude=None):
3077
2757
        from bzrlib.errors import (
3078
2758
            PointlessCommit,
3079
2759
            ConflictsInTree,
3085
2765
            make_commit_message_template_encoded
3086
2766
        )
3087
2767
 
3088
 
        commit_stamp = offset = None
3089
 
        if commit_time is not None:
3090
 
            try:
3091
 
                commit_stamp, offset = timestamp.parse_patch_date(commit_time)
3092
 
            except ValueError, e:
3093
 
                raise errors.BzrCommandError(
3094
 
                    "Could not parse --commit-time: " + str(e))
3095
 
 
3096
2768
        # TODO: Need a blackbox test for invoking the external editor; may be
3097
2769
        # slightly problematic to run this cross-platform.
3098
2770
 
3118
2790
        if local and not tree.branch.get_bound_location():
3119
2791
            raise errors.LocalRequiresBoundBranch()
3120
2792
 
3121
 
        if message is not None:
3122
 
            try:
3123
 
                file_exists = osutils.lexists(message)
3124
 
            except UnicodeError:
3125
 
                # The commit message contains unicode characters that can't be
3126
 
                # represented in the filesystem encoding, so that can't be a
3127
 
                # file.
3128
 
                file_exists = False
3129
 
            if file_exists:
3130
 
                warning_msg = (
3131
 
                    'The commit message is a file name: "%(f)s".\n'
3132
 
                    '(use --file "%(f)s" to take commit message from that file)'
3133
 
                    % { 'f': message })
3134
 
                ui.ui_factory.show_warning(warning_msg)
3135
 
            if '\r' in message:
3136
 
                message = message.replace('\r\n', '\n')
3137
 
                message = message.replace('\r', '\n')
3138
 
            if file:
3139
 
                raise errors.BzrCommandError(
3140
 
                    "please specify either --message or --file")
3141
 
 
3142
2793
        def get_message(commit_obj):
3143
2794
            """Callback to get commit message"""
3144
 
            if file:
3145
 
                my_message = codecs.open(
3146
 
                    file, 'rt', osutils.get_user_encoding()).read()
3147
 
            elif message is not None:
3148
 
                my_message = message
3149
 
            else:
3150
 
                # No message supplied: make one up.
3151
 
                # text is the status of the tree
3152
 
                text = make_commit_message_template_encoded(tree,
 
2795
            my_message = message
 
2796
            if my_message is None and not file:
 
2797
                t = make_commit_message_template_encoded(tree,
3153
2798
                        selected_list, diff=show_diff,
3154
2799
                        output_encoding=osutils.get_user_encoding())
3155
 
                # start_message is the template generated from hooks
3156
 
                # XXX: Warning - looks like hooks return unicode,
3157
 
                # make_commit_message_template_encoded returns user encoding.
3158
 
                # We probably want to be using edit_commit_message instead to
3159
 
                # avoid this.
3160
2800
                start_message = generate_commit_message_template(commit_obj)
3161
 
                my_message = edit_commit_message_encoded(text,
 
2801
                my_message = edit_commit_message_encoded(t,
3162
2802
                    start_message=start_message)
3163
2803
                if my_message is None:
3164
2804
                    raise errors.BzrCommandError("please specify a commit"
3165
2805
                        " message with either --message or --file")
 
2806
            elif my_message and file:
 
2807
                raise errors.BzrCommandError(
 
2808
                    "please specify either --message or --file")
 
2809
            if file:
 
2810
                my_message = codecs.open(file, 'rt',
 
2811
                                         osutils.get_user_encoding()).read()
3166
2812
            if my_message == "":
3167
2813
                raise errors.BzrCommandError("empty commit message specified")
3168
2814
            return my_message
3169
2815
 
3170
 
        # The API permits a commit with a filter of [] to mean 'select nothing'
3171
 
        # but the command line should not do that.
3172
 
        if not selected_list:
3173
 
            selected_list = None
3174
2816
        try:
3175
2817
            tree.commit(message_callback=get_message,
3176
2818
                        specific_files=selected_list,
3177
2819
                        allow_pointless=unchanged, strict=strict, local=local,
3178
2820
                        reporter=None, verbose=verbose, revprops=properties,
3179
 
                        authors=author, timestamp=commit_stamp,
3180
 
                        timezone=offset,
 
2821
                        authors=author,
3181
2822
                        exclude=safe_relpath_files(tree, exclude))
3182
2823
        except PointlessCommit:
3183
 
            raise errors.BzrCommandError("No changes to commit."
3184
 
                              " Use --unchanged to commit anyhow.")
 
2824
            # FIXME: This should really happen before the file is read in;
 
2825
            # perhaps prepare the commit; get the message; then actually commit
 
2826
            raise errors.BzrCommandError("no changes to commit."
 
2827
                              " use --unchanged to commit anyhow")
3185
2828
        except ConflictsInTree:
3186
2829
            raise errors.BzrCommandError('Conflicts detected in working '
3187
2830
                'tree.  Use "bzr conflicts" to list, "bzr resolve FILE" to'
3190
2833
            raise errors.BzrCommandError("Commit refused because there are"
3191
2834
                              " unknown files in the working tree.")
3192
2835
        except errors.BoundBranchOutOfDate, e:
3193
 
            e.extra_help = ("\n"
3194
 
                'To commit to master branch, run update and then commit.\n'
3195
 
                'You can also pass --local to commit to continue working '
3196
 
                'disconnected.')
3197
 
            raise
 
2836
            raise errors.BzrCommandError(str(e) + "\n"
 
2837
            'To commit to master branch, run update and then commit.\n'
 
2838
            'You can also pass --local to commit to continue working '
 
2839
            'disconnected.')
3198
2840
 
3199
2841
 
3200
2842
class cmd_check(Command):
3201
 
    __doc__ = """Validate working tree structure, branch consistency and repository history.
 
2843
    """Validate working tree structure, branch consistency and repository history.
3202
2844
 
3203
2845
    This command checks various invariants about branch and repository storage
3204
2846
    to detect data corruption or bzr bugs.
3206
2848
    The working tree and branch checks will only give output if a problem is
3207
2849
    detected. The output fields of the repository check are:
3208
2850
 
3209
 
    revisions
3210
 
        This is just the number of revisions checked.  It doesn't
3211
 
        indicate a problem.
3212
 
 
3213
 
    versionedfiles
3214
 
        This is just the number of versionedfiles checked.  It
3215
 
        doesn't indicate a problem.
3216
 
 
3217
 
    unreferenced ancestors
3218
 
        Texts that are ancestors of other texts, but
3219
 
        are not properly referenced by the revision ancestry.  This is a
3220
 
        subtle problem that Bazaar can work around.
3221
 
 
3222
 
    unique file texts
3223
 
        This is the total number of unique file contents
3224
 
        seen in the checked revisions.  It does not indicate a problem.
3225
 
 
3226
 
    repeated file texts
3227
 
        This is the total number of repeated texts seen
3228
 
        in the checked revisions.  Texts can be repeated when their file
3229
 
        entries are modified, but the file contents are not.  It does not
3230
 
        indicate a problem.
 
2851
        revisions: This is just the number of revisions checked.  It doesn't
 
2852
            indicate a problem.
 
2853
        versionedfiles: This is just the number of versionedfiles checked.  It
 
2854
            doesn't indicate a problem.
 
2855
        unreferenced ancestors: Texts that are ancestors of other texts, but
 
2856
            are not properly referenced by the revision ancestry.  This is a
 
2857
            subtle problem that Bazaar can work around.
 
2858
        unique file texts: This is the total number of unique file contents
 
2859
            seen in the checked revisions.  It does not indicate a problem.
 
2860
        repeated file texts: This is the total number of repeated texts seen
 
2861
            in the checked revisions.  Texts can be repeated when their file
 
2862
            entries are modified, but the file contents are not.  It does not
 
2863
            indicate a problem.
3231
2864
 
3232
2865
    If no restrictions are specified, all Bazaar data that is found at the given
3233
2866
    location will be checked.
3268
2901
 
3269
2902
 
3270
2903
class cmd_upgrade(Command):
3271
 
    __doc__ = """Upgrade branch storage to current format.
 
2904
    """Upgrade branch storage to current format.
3272
2905
 
3273
2906
    The check command or bzr developers may sometimes advise you to run
3274
2907
    this command. When the default format has changed you may also be warned
3288
2921
 
3289
2922
    def run(self, url='.', format=None):
3290
2923
        from bzrlib.upgrade import upgrade
 
2924
        if format is None:
 
2925
            format = bzrdir.format_registry.make_bzrdir('default')
3291
2926
        upgrade(url, format)
3292
2927
 
3293
2928
 
3294
2929
class cmd_whoami(Command):
3295
 
    __doc__ = """Show or set bzr user id.
 
2930
    """Show or set bzr user id.
3296
2931
 
3297
2932
    :Examples:
3298
2933
        Show the email of the current user::
3342
2977
 
3343
2978
 
3344
2979
class cmd_nick(Command):
3345
 
    __doc__ = """Print or set the branch nickname.
 
2980
    """Print or set the branch nickname.
3346
2981
 
3347
2982
    If unset, the tree root directory name is used as the nickname.
3348
2983
    To print the current nickname, execute with no argument.
3362
2997
 
3363
2998
    @display_command
3364
2999
    def printme(self, branch):
3365
 
        self.outf.write('%s\n' % branch.nick)
 
3000
        print branch.nick
3366
3001
 
3367
3002
 
3368
3003
class cmd_alias(Command):
3369
 
    __doc__ = """Set/unset and display aliases.
 
3004
    """Set/unset and display aliases.
3370
3005
 
3371
3006
    :Examples:
3372
3007
        Show the current aliases::
3436
3071
 
3437
3072
 
3438
3073
class cmd_selftest(Command):
3439
 
    __doc__ = """Run internal test suite.
 
3074
    """Run internal test suite.
3440
3075
 
3441
3076
    If arguments are given, they are regular expressions that say which tests
3442
3077
    should run.  Tests matching any expression are run, and other tests are
3469
3104
    Tests that need working space on disk use a common temporary directory,
3470
3105
    typically inside $TMPDIR or /tmp.
3471
3106
 
3472
 
    If you set BZR_TEST_PDB=1 when running selftest, failing tests will drop
3473
 
    into a pdb postmortem session.
3474
 
 
3475
3107
    :Examples:
3476
3108
        Run only tests relating to 'ignore'::
3477
3109
 
3486
3118
    def get_transport_type(typestring):
3487
3119
        """Parse and return a transport specifier."""
3488
3120
        if typestring == "sftp":
3489
 
            from bzrlib.tests import stub_sftp
3490
 
            return stub_sftp.SFTPAbsoluteServer
 
3121
            from bzrlib.transport.sftp import SFTPAbsoluteServer
 
3122
            return SFTPAbsoluteServer
3491
3123
        if typestring == "memory":
3492
 
            from bzrlib.tests import test_server
3493
 
            return memory.MemoryServer
 
3124
            from bzrlib.transport.memory import MemoryServer
 
3125
            return MemoryServer
3494
3126
        if typestring == "fakenfs":
3495
 
            from bzrlib.tests import test_server
3496
 
            return test_server.FakeNFSServer
 
3127
            from bzrlib.transport.fakenfs import FakeNFSServer
 
3128
            return FakeNFSServer
3497
3129
        msg = "No known transport type %s. Supported types are: sftp\n" %\
3498
3130
            (typestring)
3499
3131
        raise errors.BzrCommandError(msg)
3514
3146
                     Option('lsprof-timed',
3515
3147
                            help='Generate lsprof output for benchmarked'
3516
3148
                                 ' sections of code.'),
3517
 
                     Option('lsprof-tests',
3518
 
                            help='Generate lsprof output for each test.'),
3519
3149
                     Option('cache-dir', type=str,
3520
3150
                            help='Cache intermediate benchmark output in this '
3521
3151
                                 'directory.'),
3525
3155
                            ),
3526
3156
                     Option('list-only',
3527
3157
                            help='List the tests instead of running them.'),
3528
 
                     RegistryOption('parallel',
3529
 
                        help="Run the test suite in parallel.",
3530
 
                        lazy_registry=('bzrlib.tests', 'parallel_registry'),
3531
 
                        value_switches=False,
3532
 
                        ),
3533
3158
                     Option('randomize', type=str, argname="SEED",
3534
3159
                            help='Randomize the order of tests using the given'
3535
3160
                                 ' seed or "now" for the current time.'),
3561
3186
            lsprof_timed=None, cache_dir=None,
3562
3187
            first=False, list_only=False,
3563
3188
            randomize=None, exclude=None, strict=False,
3564
 
            load_list=None, debugflag=None, starting_with=None, subunit=False,
3565
 
            parallel=None, lsprof_tests=False):
 
3189
            load_list=None, debugflag=None, starting_with=None, subunit=False):
3566
3190
        from bzrlib.tests import selftest
3567
3191
        import bzrlib.benchmarks as benchmarks
3568
3192
        from bzrlib.benchmarks import tree_creator
3572
3196
 
3573
3197
        if cache_dir is not None:
3574
3198
            tree_creator.TreeCreator.CACHE_ROOT = osutils.abspath(cache_dir)
 
3199
        if not list_only:
 
3200
            print 'testing: %s' % (osutils.realpath(sys.argv[0]),)
 
3201
            print '   %s (%s python%s)' % (
 
3202
                    bzrlib.__path__[0],
 
3203
                    bzrlib.version_string,
 
3204
                    bzrlib._format_version_tuple(sys.version_info),
 
3205
                    )
 
3206
        print
3575
3207
        if testspecs_list is not None:
3576
3208
            pattern = '|'.join(testspecs_list)
3577
3209
        else:
3583
3215
                raise errors.BzrCommandError("subunit not available. subunit "
3584
3216
                    "needs to be installed to use --subunit.")
3585
3217
            self.additional_selftest_args['runner_class'] = SubUnitBzrRunner
3586
 
            # On Windows, disable automatic conversion of '\n' to '\r\n' in
3587
 
            # stdout, which would corrupt the subunit stream. 
3588
 
            if sys.platform == "win32" and sys.stdout.fileno() >= 0:
3589
 
                import msvcrt
3590
 
                msvcrt.setmode(sys.stdout.fileno(), os.O_BINARY)
3591
 
        if parallel:
3592
 
            self.additional_selftest_args.setdefault(
3593
 
                'suite_decorators', []).append(parallel)
3594
3218
        if benchmark:
3595
3219
            test_suite_factory = benchmarks.test_suite
3596
3220
            # Unless user explicitly asks for quiet, be verbose in benchmarks
3597
3221
            verbose = not is_quiet()
3598
3222
            # TODO: should possibly lock the history file...
3599
3223
            benchfile = open(".perf_history", "at", buffering=1)
3600
 
            self.add_cleanup(benchfile.close)
3601
3224
        else:
3602
3225
            test_suite_factory = None
3603
3226
            benchfile = None
3604
 
        selftest_kwargs = {"verbose": verbose,
3605
 
                          "pattern": pattern,
3606
 
                          "stop_on_failure": one,
3607
 
                          "transport": transport,
3608
 
                          "test_suite_factory": test_suite_factory,
3609
 
                          "lsprof_timed": lsprof_timed,
3610
 
                          "lsprof_tests": lsprof_tests,
3611
 
                          "bench_history": benchfile,
3612
 
                          "matching_tests_first": first,
3613
 
                          "list_only": list_only,
3614
 
                          "random_seed": randomize,
3615
 
                          "exclude_pattern": exclude,
3616
 
                          "strict": strict,
3617
 
                          "load_list": load_list,
3618
 
                          "debug_flags": debugflag,
3619
 
                          "starting_with": starting_with
3620
 
                          }
3621
 
        selftest_kwargs.update(self.additional_selftest_args)
3622
 
        result = selftest(**selftest_kwargs)
 
3227
        try:
 
3228
            selftest_kwargs = {"verbose": verbose,
 
3229
                              "pattern": pattern,
 
3230
                              "stop_on_failure": one,
 
3231
                              "transport": transport,
 
3232
                              "test_suite_factory": test_suite_factory,
 
3233
                              "lsprof_timed": lsprof_timed,
 
3234
                              "bench_history": benchfile,
 
3235
                              "matching_tests_first": first,
 
3236
                              "list_only": list_only,
 
3237
                              "random_seed": randomize,
 
3238
                              "exclude_pattern": exclude,
 
3239
                              "strict": strict,
 
3240
                              "load_list": load_list,
 
3241
                              "debug_flags": debugflag,
 
3242
                              "starting_with": starting_with
 
3243
                              }
 
3244
            selftest_kwargs.update(self.additional_selftest_args)
 
3245
            result = selftest(**selftest_kwargs)
 
3246
        finally:
 
3247
            if benchfile is not None:
 
3248
                benchfile.close()
 
3249
        if result:
 
3250
            note('tests passed')
 
3251
        else:
 
3252
            note('tests failed')
3623
3253
        return int(not result)
3624
3254
 
3625
3255
 
3626
3256
class cmd_version(Command):
3627
 
    __doc__ = """Show version of bzr."""
 
3257
    """Show version of bzr."""
3628
3258
 
3629
3259
    encoding_type = 'replace'
3630
3260
    takes_options = [
3641
3271
 
3642
3272
 
3643
3273
class cmd_rocks(Command):
3644
 
    __doc__ = """Statement of optimism."""
 
3274
    """Statement of optimism."""
3645
3275
 
3646
3276
    hidden = True
3647
3277
 
3648
3278
    @display_command
3649
3279
    def run(self):
3650
 
        self.outf.write("It sure does!\n")
 
3280
        print "It sure does!"
3651
3281
 
3652
3282
 
3653
3283
class cmd_find_merge_base(Command):
3654
 
    __doc__ = """Find and print a base revision for merging two branches."""
 
3284
    """Find and print a base revision for merging two branches."""
3655
3285
    # TODO: Options to specify revisions on either side, as if
3656
3286
    #       merging only part of the history.
3657
3287
    takes_args = ['branch', 'other']
3663
3293
 
3664
3294
        branch1 = Branch.open_containing(branch)[0]
3665
3295
        branch2 = Branch.open_containing(other)[0]
3666
 
        self.add_cleanup(branch1.lock_read().unlock)
3667
 
        self.add_cleanup(branch2.lock_read().unlock)
3668
 
        last1 = ensure_null(branch1.last_revision())
3669
 
        last2 = ensure_null(branch2.last_revision())
3670
 
 
3671
 
        graph = branch1.repository.get_graph(branch2.repository)
3672
 
        base_rev_id = graph.find_unique_lca(last1, last2)
3673
 
 
3674
 
        self.outf.write('merge base is revision %s\n' % base_rev_id)
 
3296
        branch1.lock_read()
 
3297
        try:
 
3298
            branch2.lock_read()
 
3299
            try:
 
3300
                last1 = ensure_null(branch1.last_revision())
 
3301
                last2 = ensure_null(branch2.last_revision())
 
3302
 
 
3303
                graph = branch1.repository.get_graph(branch2.repository)
 
3304
                base_rev_id = graph.find_unique_lca(last1, last2)
 
3305
 
 
3306
                print 'merge base is revision %s' % base_rev_id
 
3307
            finally:
 
3308
                branch2.unlock()
 
3309
        finally:
 
3310
            branch1.unlock()
3675
3311
 
3676
3312
 
3677
3313
class cmd_merge(Command):
3678
 
    __doc__ = """Perform a three-way merge.
 
3314
    """Perform a three-way merge.
3679
3315
 
3680
3316
    The source of the merge can be specified either in the form of a branch,
3681
3317
    or in the form of a path to a file containing a merge directive generated
3710
3346
    committed to record the result of the merge.
3711
3347
 
3712
3348
    merge refuses to run if there are any uncommitted changes, unless
3713
 
    --force is given. The --force option can also be used to create a
3714
 
    merge revision which has more than two parents.
3715
 
 
3716
 
    If one would like to merge changes from the working tree of the other
3717
 
    branch without merging any committed revisions, the --uncommitted option
3718
 
    can be given.
3719
 
 
3720
 
    To select only some changes to merge, use "merge -i", which will prompt
3721
 
    you to apply each diff hunk and file change, similar to "shelve".
 
3349
    --force is given.
3722
3350
 
3723
3351
    :Examples:
3724
3352
        To merge the latest revision from bzr.dev::
3733
3361
 
3734
3362
            bzr merge -r 81..82 ../bzr.dev
3735
3363
 
3736
 
        To apply a merge directive contained in /tmp/merge::
 
3364
        To apply a merge directive contained in in /tmp/merge:
3737
3365
 
3738
3366
            bzr merge /tmp/merge
3739
 
 
3740
 
        To create a merge revision with three parents from two branches
3741
 
        feature1a and feature1b:
3742
 
 
3743
 
            bzr merge ../feature1a
3744
 
            bzr merge ../feature1b --force
3745
 
            bzr commit -m 'revision with three parents'
3746
3367
    """
3747
3368
 
3748
3369
    encoding_type = 'exact'
3770
3391
               short_name='d',
3771
3392
               type=unicode,
3772
3393
               ),
3773
 
        Option('preview', help='Instead of merging, show a diff of the'
3774
 
               ' merge.'),
3775
 
        Option('interactive', help='Select changes interactively.',
3776
 
            short_name='i')
 
3394
        Option('preview', help='Instead of merging, show a diff of the merge.')
3777
3395
    ]
3778
3396
 
3779
3397
    def run(self, location=None, revision=None, force=False,
3781
3399
            uncommitted=False, pull=False,
3782
3400
            directory=None,
3783
3401
            preview=False,
3784
 
            interactive=False,
3785
3402
            ):
3786
3403
        if merge_type is None:
3787
3404
            merge_type = _mod_merge.Merge3Merger
3793
3410
        verified = 'inapplicable'
3794
3411
        tree = WorkingTree.open_containing(directory)[0]
3795
3412
 
 
3413
        # die as quickly as possible if there are uncommitted changes
3796
3414
        try:
3797
3415
            basis_tree = tree.revision_tree(tree.last_revision())
3798
3416
        except errors.NoSuchRevision:
3799
3417
            basis_tree = tree.basis_tree()
3800
 
 
3801
 
        # die as quickly as possible if there are uncommitted changes
3802
3418
        if not force:
3803
 
            if tree.has_changes():
 
3419
            changes = tree.changes_from(basis_tree)
 
3420
            if changes.has_changed():
3804
3421
                raise errors.UncommittedChanges(tree)
3805
3422
 
3806
3423
        view_info = _get_view_info_for_change_reporter(tree)
3807
3424
        change_reporter = delta._ChangeReporter(
3808
3425
            unversioned_filter=tree.is_ignored, view_info=view_info)
3809
 
        pb = ui.ui_factory.nested_progress_bar()
3810
 
        self.add_cleanup(pb.finished)
3811
 
        self.add_cleanup(tree.lock_write().unlock)
3812
 
        if location is not None:
3813
 
            try:
3814
 
                mergeable = bundle.read_mergeable_from_url(location,
3815
 
                    possible_transports=possible_transports)
3816
 
            except errors.NotABundle:
3817
 
                mergeable = None
 
3426
        cleanups = []
 
3427
        try:
 
3428
            pb = ui.ui_factory.nested_progress_bar()
 
3429
            cleanups.append(pb.finished)
 
3430
            tree.lock_write()
 
3431
            cleanups.append(tree.unlock)
 
3432
            if location is not None:
 
3433
                try:
 
3434
                    mergeable = bundle.read_mergeable_from_url(location,
 
3435
                        possible_transports=possible_transports)
 
3436
                except errors.NotABundle:
 
3437
                    mergeable = None
 
3438
                else:
 
3439
                    if uncommitted:
 
3440
                        raise errors.BzrCommandError('Cannot use --uncommitted'
 
3441
                            ' with bundles or merge directives.')
 
3442
 
 
3443
                    if revision is not None:
 
3444
                        raise errors.BzrCommandError(
 
3445
                            'Cannot use -r with merge directives or bundles')
 
3446
                    merger, verified = _mod_merge.Merger.from_mergeable(tree,
 
3447
                       mergeable, pb)
 
3448
 
 
3449
            if merger is None and uncommitted:
 
3450
                if revision is not None and len(revision) > 0:
 
3451
                    raise errors.BzrCommandError('Cannot use --uncommitted and'
 
3452
                        ' --revision at the same time.')
 
3453
                location = self._select_branch_location(tree, location)[0]
 
3454
                other_tree, other_path = WorkingTree.open_containing(location)
 
3455
                merger = _mod_merge.Merger.from_uncommitted(tree, other_tree,
 
3456
                    pb)
 
3457
                allow_pending = False
 
3458
                if other_path != '':
 
3459
                    merger.interesting_files = [other_path]
 
3460
 
 
3461
            if merger is None:
 
3462
                merger, allow_pending = self._get_merger_from_branch(tree,
 
3463
                    location, revision, remember, possible_transports, pb)
 
3464
 
 
3465
            merger.merge_type = merge_type
 
3466
            merger.reprocess = reprocess
 
3467
            merger.show_base = show_base
 
3468
            self.sanity_check_merger(merger)
 
3469
            if (merger.base_rev_id == merger.other_rev_id and
 
3470
                merger.other_rev_id is not None):
 
3471
                note('Nothing to do.')
 
3472
                return 0
 
3473
            if pull:
 
3474
                if merger.interesting_files is not None:
 
3475
                    raise errors.BzrCommandError('Cannot pull individual files')
 
3476
                if (merger.base_rev_id == tree.last_revision()):
 
3477
                    result = tree.pull(merger.other_branch, False,
 
3478
                                       merger.other_rev_id)
 
3479
                    result.report(self.outf)
 
3480
                    return 0
 
3481
            merger.check_basis(False)
 
3482
            if preview:
 
3483
                return self._do_preview(merger)
3818
3484
            else:
3819
 
                if uncommitted:
3820
 
                    raise errors.BzrCommandError('Cannot use --uncommitted'
3821
 
                        ' with bundles or merge directives.')
3822
 
 
3823
 
                if revision is not None:
3824
 
                    raise errors.BzrCommandError(
3825
 
                        'Cannot use -r with merge directives or bundles')
3826
 
                merger, verified = _mod_merge.Merger.from_mergeable(tree,
3827
 
                   mergeable, None)
3828
 
 
3829
 
        if merger is None and uncommitted:
3830
 
            if revision is not None and len(revision) > 0:
3831
 
                raise errors.BzrCommandError('Cannot use --uncommitted and'
3832
 
                    ' --revision at the same time.')
3833
 
            merger = self.get_merger_from_uncommitted(tree, location, None)
3834
 
            allow_pending = False
3835
 
 
3836
 
        if merger is None:
3837
 
            merger, allow_pending = self._get_merger_from_branch(tree,
3838
 
                location, revision, remember, possible_transports, None)
3839
 
 
3840
 
        merger.merge_type = merge_type
3841
 
        merger.reprocess = reprocess
3842
 
        merger.show_base = show_base
3843
 
        self.sanity_check_merger(merger)
3844
 
        if (merger.base_rev_id == merger.other_rev_id and
3845
 
            merger.other_rev_id is not None):
3846
 
            note('Nothing to do.')
3847
 
            return 0
3848
 
        if pull:
3849
 
            if merger.interesting_files is not None:
3850
 
                raise errors.BzrCommandError('Cannot pull individual files')
3851
 
            if (merger.base_rev_id == tree.last_revision()):
3852
 
                result = tree.pull(merger.other_branch, False,
3853
 
                                   merger.other_rev_id)
3854
 
                result.report(self.outf)
3855
 
                return 0
3856
 
        if merger.this_basis is None:
3857
 
            raise errors.BzrCommandError(
3858
 
                "This branch has no commits."
3859
 
                " (perhaps you would prefer 'bzr pull')")
3860
 
        if preview:
3861
 
            return self._do_preview(merger)
3862
 
        elif interactive:
3863
 
            return self._do_interactive(merger)
3864
 
        else:
3865
 
            return self._do_merge(merger, change_reporter, allow_pending,
3866
 
                                  verified)
3867
 
 
3868
 
    def _get_preview(self, merger):
 
3485
                return self._do_merge(merger, change_reporter, allow_pending,
 
3486
                                      verified)
 
3487
        finally:
 
3488
            for cleanup in reversed(cleanups):
 
3489
                cleanup()
 
3490
 
 
3491
    def _do_preview(self, merger):
 
3492
        from bzrlib.diff import show_diff_trees
3869
3493
        tree_merger = merger.make_merger()
3870
3494
        tt = tree_merger.make_preview_transform()
3871
 
        self.add_cleanup(tt.finalize)
3872
 
        result_tree = tt.get_preview_tree()
3873
 
        return result_tree
3874
 
 
3875
 
    def _do_preview(self, merger):
3876
 
        from bzrlib.diff import show_diff_trees
3877
 
        result_tree = self._get_preview(merger)
3878
 
        show_diff_trees(merger.this_tree, result_tree, self.outf,
3879
 
                        old_label='', new_label='')
 
3495
        try:
 
3496
            result_tree = tt.get_preview_tree()
 
3497
            show_diff_trees(merger.this_tree, result_tree, self.outf,
 
3498
                            old_label='', new_label='')
 
3499
        finally:
 
3500
            tt.finalize()
3880
3501
 
3881
3502
    def _do_merge(self, merger, change_reporter, allow_pending, verified):
3882
3503
        merger.change_reporter = change_reporter
3890
3511
        else:
3891
3512
            return 0
3892
3513
 
3893
 
    def _do_interactive(self, merger):
3894
 
        """Perform an interactive merge.
3895
 
 
3896
 
        This works by generating a preview tree of the merge, then using
3897
 
        Shelver to selectively remove the differences between the working tree
3898
 
        and the preview tree.
3899
 
        """
3900
 
        from bzrlib import shelf_ui
3901
 
        result_tree = self._get_preview(merger)
3902
 
        writer = bzrlib.option.diff_writer_registry.get()
3903
 
        shelver = shelf_ui.Shelver(merger.this_tree, result_tree, destroy=True,
3904
 
                                   reporter=shelf_ui.ApplyReporter(),
3905
 
                                   diff_writer=writer(sys.stdout))
3906
 
        try:
3907
 
            shelver.run()
3908
 
        finally:
3909
 
            shelver.finalize()
3910
 
 
3911
3514
    def sanity_check_merger(self, merger):
3912
3515
        if (merger.show_base and
3913
3516
            not merger.merge_type is _mod_merge.Merge3Merger):
3948
3551
            base_branch, base_path = Branch.open_containing(base_loc,
3949
3552
                possible_transports)
3950
3553
        # Find the revision ids
3951
 
        other_revision_id = None
3952
 
        base_revision_id = None
3953
 
        if revision is not None:
3954
 
            if len(revision) >= 1:
3955
 
                other_revision_id = revision[-1].as_revision_id(other_branch)
3956
 
            if len(revision) == 2:
3957
 
                base_revision_id = revision[0].as_revision_id(base_branch)
3958
 
        if other_revision_id is None:
 
3554
        if revision is None or len(revision) < 1 or revision[-1] is None:
3959
3555
            other_revision_id = _mod_revision.ensure_null(
3960
3556
                other_branch.last_revision())
 
3557
        else:
 
3558
            other_revision_id = revision[-1].as_revision_id(other_branch)
 
3559
        if (revision is not None and len(revision) == 2
 
3560
            and revision[0] is not None):
 
3561
            base_revision_id = revision[0].as_revision_id(base_branch)
 
3562
        else:
 
3563
            base_revision_id = None
3961
3564
        # Remember where we merge from
3962
3565
        if ((remember or tree.branch.get_submit_branch() is None) and
3963
3566
             user_location is not None):
3972
3575
            allow_pending = True
3973
3576
        return merger, allow_pending
3974
3577
 
3975
 
    def get_merger_from_uncommitted(self, tree, location, pb):
3976
 
        """Get a merger for uncommitted changes.
3977
 
 
3978
 
        :param tree: The tree the merger should apply to.
3979
 
        :param location: The location containing uncommitted changes.
3980
 
        :param pb: The progress bar to use for showing progress.
3981
 
        """
3982
 
        location = self._select_branch_location(tree, location)[0]
3983
 
        other_tree, other_path = WorkingTree.open_containing(location)
3984
 
        merger = _mod_merge.Merger.from_uncommitted(tree, other_tree, pb)
3985
 
        if other_path != '':
3986
 
            merger.interesting_files = [other_path]
3987
 
        return merger
3988
 
 
3989
3578
    def _select_branch_location(self, tree, user_location, revision=None,
3990
3579
                                index=None):
3991
3580
        """Select a branch location, according to possible inputs.
4035
3624
 
4036
3625
 
4037
3626
class cmd_remerge(Command):
4038
 
    __doc__ = """Redo a merge.
 
3627
    """Redo a merge.
4039
3628
 
4040
3629
    Use this if you want to try a different merge technique while resolving
4041
3630
    conflicts.  Some merge techniques are better than others, and remerge
4066
3655
 
4067
3656
    def run(self, file_list=None, merge_type=None, show_base=False,
4068
3657
            reprocess=False):
4069
 
        from bzrlib.conflicts import restore
4070
3658
        if merge_type is None:
4071
3659
            merge_type = _mod_merge.Merge3Merger
4072
3660
        tree, file_list = tree_files(file_list)
4073
 
        self.add_cleanup(tree.lock_write().unlock)
4074
 
        parents = tree.get_parent_ids()
4075
 
        if len(parents) != 2:
4076
 
            raise errors.BzrCommandError("Sorry, remerge only works after normal"
4077
 
                                         " merges.  Not cherrypicking or"
4078
 
                                         " multi-merges.")
4079
 
        repository = tree.branch.repository
4080
 
        interesting_ids = None
4081
 
        new_conflicts = []
4082
 
        conflicts = tree.conflicts()
4083
 
        if file_list is not None:
4084
 
            interesting_ids = set()
4085
 
            for filename in file_list:
4086
 
                file_id = tree.path2id(filename)
4087
 
                if file_id is None:
4088
 
                    raise errors.NotVersionedError(filename)
4089
 
                interesting_ids.add(file_id)
4090
 
                if tree.kind(file_id) != "directory":
4091
 
                    continue
 
3661
        tree.lock_write()
 
3662
        try:
 
3663
            parents = tree.get_parent_ids()
 
3664
            if len(parents) != 2:
 
3665
                raise errors.BzrCommandError("Sorry, remerge only works after normal"
 
3666
                                             " merges.  Not cherrypicking or"
 
3667
                                             " multi-merges.")
 
3668
            repository = tree.branch.repository
 
3669
            interesting_ids = None
 
3670
            new_conflicts = []
 
3671
            conflicts = tree.conflicts()
 
3672
            if file_list is not None:
 
3673
                interesting_ids = set()
 
3674
                for filename in file_list:
 
3675
                    file_id = tree.path2id(filename)
 
3676
                    if file_id is None:
 
3677
                        raise errors.NotVersionedError(filename)
 
3678
                    interesting_ids.add(file_id)
 
3679
                    if tree.kind(file_id) != "directory":
 
3680
                        continue
4092
3681
 
4093
 
                for name, ie in tree.inventory.iter_entries(file_id):
4094
 
                    interesting_ids.add(ie.file_id)
4095
 
            new_conflicts = conflicts.select_conflicts(tree, file_list)[0]
4096
 
        else:
4097
 
            # Remerge only supports resolving contents conflicts
4098
 
            allowed_conflicts = ('text conflict', 'contents conflict')
4099
 
            restore_files = [c.path for c in conflicts
4100
 
                             if c.typestring in allowed_conflicts]
4101
 
        _mod_merge.transform_tree(tree, tree.basis_tree(), interesting_ids)
4102
 
        tree.set_conflicts(ConflictList(new_conflicts))
4103
 
        if file_list is not None:
4104
 
            restore_files = file_list
4105
 
        for filename in restore_files:
 
3682
                    for name, ie in tree.inventory.iter_entries(file_id):
 
3683
                        interesting_ids.add(ie.file_id)
 
3684
                new_conflicts = conflicts.select_conflicts(tree, file_list)[0]
 
3685
            else:
 
3686
                # Remerge only supports resolving contents conflicts
 
3687
                allowed_conflicts = ('text conflict', 'contents conflict')
 
3688
                restore_files = [c.path for c in conflicts
 
3689
                                 if c.typestring in allowed_conflicts]
 
3690
            _mod_merge.transform_tree(tree, tree.basis_tree(), interesting_ids)
 
3691
            tree.set_conflicts(ConflictList(new_conflicts))
 
3692
            if file_list is not None:
 
3693
                restore_files = file_list
 
3694
            for filename in restore_files:
 
3695
                try:
 
3696
                    restore(tree.abspath(filename))
 
3697
                except errors.NotConflicted:
 
3698
                    pass
 
3699
            # Disable pending merges, because the file texts we are remerging
 
3700
            # have not had those merges performed.  If we use the wrong parents
 
3701
            # list, we imply that the working tree text has seen and rejected
 
3702
            # all the changes from the other tree, when in fact those changes
 
3703
            # have not yet been seen.
 
3704
            pb = ui.ui_factory.nested_progress_bar()
 
3705
            tree.set_parent_ids(parents[:1])
4106
3706
            try:
4107
 
                restore(tree.abspath(filename))
4108
 
            except errors.NotConflicted:
4109
 
                pass
4110
 
        # Disable pending merges, because the file texts we are remerging
4111
 
        # have not had those merges performed.  If we use the wrong parents
4112
 
        # list, we imply that the working tree text has seen and rejected
4113
 
        # all the changes from the other tree, when in fact those changes
4114
 
        # have not yet been seen.
4115
 
        tree.set_parent_ids(parents[:1])
4116
 
        try:
4117
 
            merger = _mod_merge.Merger.from_revision_ids(None, tree, parents[1])
4118
 
            merger.interesting_ids = interesting_ids
4119
 
            merger.merge_type = merge_type
4120
 
            merger.show_base = show_base
4121
 
            merger.reprocess = reprocess
4122
 
            conflicts = merger.do_merge()
 
3707
                merger = _mod_merge.Merger.from_revision_ids(pb,
 
3708
                                                             tree, parents[1])
 
3709
                merger.interesting_ids = interesting_ids
 
3710
                merger.merge_type = merge_type
 
3711
                merger.show_base = show_base
 
3712
                merger.reprocess = reprocess
 
3713
                conflicts = merger.do_merge()
 
3714
            finally:
 
3715
                tree.set_parent_ids(parents)
 
3716
                pb.finished()
4123
3717
        finally:
4124
 
            tree.set_parent_ids(parents)
 
3718
            tree.unlock()
4125
3719
        if conflicts > 0:
4126
3720
            return 1
4127
3721
        else:
4129
3723
 
4130
3724
 
4131
3725
class cmd_revert(Command):
4132
 
    __doc__ = """Revert files to a previous revision.
 
3726
    """Revert files to a previous revision.
4133
3727
 
4134
3728
    Giving a list of files will revert only those files.  Otherwise, all files
4135
3729
    will be reverted.  If the revision is not specified with '--revision', the
4149
3743
    name.  If you name a directory, all the contents of that directory will be
4150
3744
    reverted.
4151
3745
 
4152
 
    If you have newly added files since the target revision, they will be
4153
 
    removed.  If the files to be removed have been changed, backups will be
4154
 
    created as above.  Directories containing unknown files will not be
4155
 
    deleted.
 
3746
    Any files that have been newly added since that revision will be deleted,
 
3747
    with a backup kept if appropriate.  Directories containing unknown files
 
3748
    will not be deleted.
4156
3749
 
4157
 
    The working tree contains a list of revisions that have been merged but
4158
 
    not yet committed. These revisions will be included as additional parents
4159
 
    of the next commit.  Normally, using revert clears that list as well as
4160
 
    reverting the files.  If any files are specified, revert leaves the list
4161
 
    of uncommitted merges alone and reverts only the files.  Use ``bzr revert
4162
 
    .`` in the tree root to revert all files but keep the recorded merges,
4163
 
    and ``bzr revert --forget-merges`` to clear the pending merge list without
 
3750
    The working tree contains a list of pending merged revisions, which will
 
3751
    be included as parents in the next commit.  Normally, revert clears that
 
3752
    list as well as reverting the files.  If any files are specified, revert
 
3753
    leaves the pending merge list alone and reverts only the files.  Use "bzr
 
3754
    revert ." in the tree root to revert all files but keep the merge record,
 
3755
    and "bzr revert --forget-merges" to clear the pending merge list without
4164
3756
    reverting any files.
4165
 
 
4166
 
    Using "bzr revert --forget-merges", it is possible to apply all of the
4167
 
    changes from a branch in a single revision.  To do this, perform the merge
4168
 
    as desired.  Then doing revert with the "--forget-merges" option will keep
4169
 
    the content of the tree as it was, but it will clear the list of pending
4170
 
    merges.  The next commit will then contain all of the changes that are
4171
 
    present in the other branch, but without any other parent revisions.
4172
 
    Because this technique forgets where these changes originated, it may
4173
 
    cause additional conflicts on later merges involving the same source and
4174
 
    target branches.
4175
3757
    """
4176
3758
 
4177
3759
    _see_also = ['cat', 'export']
4186
3768
    def run(self, revision=None, no_backup=False, file_list=None,
4187
3769
            forget_merges=None):
4188
3770
        tree, file_list = tree_files(file_list)
4189
 
        self.add_cleanup(tree.lock_tree_write().unlock)
4190
 
        if forget_merges:
4191
 
            tree.set_parent_ids(tree.get_parent_ids()[:1])
4192
 
        else:
4193
 
            self._revert_tree_to_revision(tree, revision, file_list, no_backup)
 
3771
        tree.lock_write()
 
3772
        try:
 
3773
            if forget_merges:
 
3774
                tree.set_parent_ids(tree.get_parent_ids()[:1])
 
3775
            else:
 
3776
                self._revert_tree_to_revision(tree, revision, file_list, no_backup)
 
3777
        finally:
 
3778
            tree.unlock()
4194
3779
 
4195
3780
    @staticmethod
4196
3781
    def _revert_tree_to_revision(tree, revision, file_list, no_backup):
4197
3782
        rev_tree = _get_one_revision_tree('revert', revision, tree=tree)
4198
 
        tree.revert(file_list, rev_tree, not no_backup, None,
4199
 
            report_changes=True)
 
3783
        pb = ui.ui_factory.nested_progress_bar()
 
3784
        try:
 
3785
            tree.revert(file_list, rev_tree, not no_backup, pb,
 
3786
                report_changes=True)
 
3787
        finally:
 
3788
            pb.finished()
4200
3789
 
4201
3790
 
4202
3791
class cmd_assert_fail(Command):
4203
 
    __doc__ = """Test reporting of assertion failures"""
 
3792
    """Test reporting of assertion failures"""
4204
3793
    # intended just for use in testing
4205
3794
 
4206
3795
    hidden = True
4210
3799
 
4211
3800
 
4212
3801
class cmd_help(Command):
4213
 
    __doc__ = """Show help on a command or other topic.
 
3802
    """Show help on a command or other topic.
4214
3803
    """
4215
3804
 
4216
3805
    _see_also = ['topics']
4229
3818
 
4230
3819
 
4231
3820
class cmd_shell_complete(Command):
4232
 
    __doc__ = """Show appropriate completions for context.
 
3821
    """Show appropriate completions for context.
4233
3822
 
4234
3823
    For a list of all available commands, say 'bzr shell-complete'.
4235
3824
    """
4244
3833
 
4245
3834
 
4246
3835
class cmd_missing(Command):
4247
 
    __doc__ = """Show unmerged/unpulled revisions between two branches.
 
3836
    """Show unmerged/unpulled revisions between two branches.
4248
3837
 
4249
3838
    OTHER_BRANCH may be local or remote.
4250
3839
 
4251
3840
    To filter on a range of revisions, you can use the command -r begin..end
4252
3841
    -r revision requests a specific revision, -r ..end or -r begin.. are
4253
3842
    also valid.
4254
 
            
4255
 
    :Exit values:
4256
 
        1 - some missing revisions
4257
 
        0 - no missing revisions
4258
3843
 
4259
3844
    :Examples:
4260
3845
 
4298
3883
            type=_parse_revision_str,
4299
3884
            help='Filter on local branch revisions (inclusive). '
4300
3885
                'See "help revisionspec" for details.'),
4301
 
        Option('include-merges',
4302
 
               'Show all revisions in addition to the mainline ones.'),
 
3886
        Option('include-merges', 'Show merged revisions.'),
4303
3887
        ]
4304
3888
    encoding_type = 'replace'
4305
3889
 
4328
3912
            restrict = 'remote'
4329
3913
 
4330
3914
        local_branch = Branch.open_containing(u".")[0]
4331
 
        self.add_cleanup(local_branch.lock_read().unlock)
4332
 
 
4333
3915
        parent = local_branch.get_parent()
4334
3916
        if other_branch is None:
4335
3917
            other_branch = parent
4344
3926
        remote_branch = Branch.open(other_branch)
4345
3927
        if remote_branch.base == local_branch.base:
4346
3928
            remote_branch = local_branch
4347
 
        else:
4348
 
            self.add_cleanup(remote_branch.lock_read().unlock)
4349
3929
 
4350
3930
        local_revid_range = _revision_range_to_revid_range(
4351
3931
            _get_revision_range(my_revision, local_branch,
4355
3935
            _get_revision_range(revision,
4356
3936
                remote_branch, self.name()))
4357
3937
 
4358
 
        local_extra, remote_extra = find_unmerged(
4359
 
            local_branch, remote_branch, restrict,
4360
 
            backward=not reverse,
4361
 
            include_merges=include_merges,
4362
 
            local_revid_range=local_revid_range,
4363
 
            remote_revid_range=remote_revid_range)
4364
 
 
4365
 
        if log_format is None:
4366
 
            registry = log.log_formatter_registry
4367
 
            log_format = registry.get_default(local_branch)
4368
 
        lf = log_format(to_file=self.outf,
4369
 
                        show_ids=show_ids,
4370
 
                        show_timezone='original')
4371
 
 
4372
 
        status_code = 0
4373
 
        if local_extra and not theirs_only:
4374
 
            message("You have %d extra revision(s):\n" %
4375
 
                len(local_extra))
4376
 
            for revision in iter_log_revisions(local_extra,
4377
 
                                local_branch.repository,
4378
 
                                verbose):
4379
 
                lf.log_revision(revision)
4380
 
            printed_local = True
4381
 
            status_code = 1
4382
 
        else:
4383
 
            printed_local = False
4384
 
 
4385
 
        if remote_extra and not mine_only:
4386
 
            if printed_local is True:
4387
 
                message("\n\n\n")
4388
 
            message("You are missing %d revision(s):\n" %
4389
 
                len(remote_extra))
4390
 
            for revision in iter_log_revisions(remote_extra,
4391
 
                                remote_branch.repository,
4392
 
                                verbose):
4393
 
                lf.log_revision(revision)
4394
 
            status_code = 1
4395
 
 
4396
 
        if mine_only and not local_extra:
4397
 
            # We checked local, and found nothing extra
4398
 
            message('This branch is up to date.\n')
4399
 
        elif theirs_only and not remote_extra:
4400
 
            # We checked remote, and found nothing extra
4401
 
            message('Other branch is up to date.\n')
4402
 
        elif not (mine_only or theirs_only or local_extra or
4403
 
                  remote_extra):
4404
 
            # We checked both branches, and neither one had extra
4405
 
            # revisions
4406
 
            message("Branches are up to date.\n")
4407
 
        self.cleanup_now()
 
3938
        local_branch.lock_read()
 
3939
        try:
 
3940
            remote_branch.lock_read()
 
3941
            try:
 
3942
                local_extra, remote_extra = find_unmerged(
 
3943
                    local_branch, remote_branch, restrict,
 
3944
                    backward=not reverse,
 
3945
                    include_merges=include_merges,
 
3946
                    local_revid_range=local_revid_range,
 
3947
                    remote_revid_range=remote_revid_range)
 
3948
 
 
3949
                if log_format is None:
 
3950
                    registry = log.log_formatter_registry
 
3951
                    log_format = registry.get_default(local_branch)
 
3952
                lf = log_format(to_file=self.outf,
 
3953
                                show_ids=show_ids,
 
3954
                                show_timezone='original')
 
3955
 
 
3956
                status_code = 0
 
3957
                if local_extra and not theirs_only:
 
3958
                    message("You have %d extra revision(s):\n" %
 
3959
                        len(local_extra))
 
3960
                    for revision in iter_log_revisions(local_extra,
 
3961
                                        local_branch.repository,
 
3962
                                        verbose):
 
3963
                        lf.log_revision(revision)
 
3964
                    printed_local = True
 
3965
                    status_code = 1
 
3966
                else:
 
3967
                    printed_local = False
 
3968
 
 
3969
                if remote_extra and not mine_only:
 
3970
                    if printed_local is True:
 
3971
                        message("\n\n\n")
 
3972
                    message("You are missing %d revision(s):\n" %
 
3973
                        len(remote_extra))
 
3974
                    for revision in iter_log_revisions(remote_extra,
 
3975
                                        remote_branch.repository,
 
3976
                                        verbose):
 
3977
                        lf.log_revision(revision)
 
3978
                    status_code = 1
 
3979
 
 
3980
                if mine_only and not local_extra:
 
3981
                    # We checked local, and found nothing extra
 
3982
                    message('This branch is up to date.\n')
 
3983
                elif theirs_only and not remote_extra:
 
3984
                    # We checked remote, and found nothing extra
 
3985
                    message('Other branch is up to date.\n')
 
3986
                elif not (mine_only or theirs_only or local_extra or
 
3987
                          remote_extra):
 
3988
                    # We checked both branches, and neither one had extra
 
3989
                    # revisions
 
3990
                    message("Branches are up to date.\n")
 
3991
            finally:
 
3992
                remote_branch.unlock()
 
3993
        finally:
 
3994
            local_branch.unlock()
4408
3995
        if not status_code and parent is None and other_branch is not None:
4409
 
            self.add_cleanup(local_branch.lock_write().unlock)
4410
 
            # handle race conditions - a parent might be set while we run.
4411
 
            if local_branch.get_parent() is None:
4412
 
                local_branch.set_parent(remote_branch.base)
 
3996
            local_branch.lock_write()
 
3997
            try:
 
3998
                # handle race conditions - a parent might be set while we run.
 
3999
                if local_branch.get_parent() is None:
 
4000
                    local_branch.set_parent(remote_branch.base)
 
4001
            finally:
 
4002
                local_branch.unlock()
4413
4003
        return status_code
4414
4004
 
4415
4005
 
4416
4006
class cmd_pack(Command):
4417
 
    __doc__ = """Compress the data within a repository.
4418
 
 
4419
 
    This operation compresses the data within a bazaar repository. As
4420
 
    bazaar supports automatic packing of repository, this operation is
4421
 
    normally not required to be done manually.
4422
 
 
4423
 
    During the pack operation, bazaar takes a backup of existing repository
4424
 
    data, i.e. pack files. This backup is eventually removed by bazaar
4425
 
    automatically when it is safe to do so. To save disk space by removing
4426
 
    the backed up pack files, the --clean-obsolete-packs option may be
4427
 
    used.
4428
 
 
4429
 
    Warning: If you use --clean-obsolete-packs and your machine crashes
4430
 
    during or immediately after repacking, you may be left with a state
4431
 
    where the deletion has been written to disk but the new packs have not
4432
 
    been. In this case the repository may be unusable.
4433
 
    """
 
4007
    """Compress the data within a repository."""
4434
4008
 
4435
4009
    _see_also = ['repositories']
4436
4010
    takes_args = ['branch_or_repo?']
4437
 
    takes_options = [
4438
 
        Option('clean-obsolete-packs', 'Delete obsolete packs to save disk space.'),
4439
 
        ]
4440
4011
 
4441
 
    def run(self, branch_or_repo='.', clean_obsolete_packs=False):
 
4012
    def run(self, branch_or_repo='.'):
4442
4013
        dir = bzrdir.BzrDir.open_containing(branch_or_repo)[0]
4443
4014
        try:
4444
4015
            branch = dir.open_branch()
4445
4016
            repository = branch.repository
4446
4017
        except errors.NotBranchError:
4447
4018
            repository = dir.open_repository()
4448
 
        repository.pack(clean_obsolete_packs=clean_obsolete_packs)
 
4019
        repository.pack()
4449
4020
 
4450
4021
 
4451
4022
class cmd_plugins(Command):
4452
 
    __doc__ = """List the installed plugins.
 
4023
    """List the installed plugins.
4453
4024
 
4454
4025
    This command displays the list of installed plugins including
4455
4026
    version of plugin and a short description of each.
4462
4033
    adding new commands, providing additional network transports and
4463
4034
    customizing log output.
4464
4035
 
4465
 
    See the Bazaar Plugin Guide <http://doc.bazaar.canonical.com/plugins/en/>
4466
 
    for further information on plugins including where to find them and how to
4467
 
    install them. Instructions are also provided there on how to write new
4468
 
    plugins using the Python programming language.
 
4036
    See the Bazaar web site, http://bazaar-vcs.org, for further
 
4037
    information on plugins including where to find them and how to
 
4038
    install them. Instructions are also provided there on how to
 
4039
    write new plugins using the Python programming language.
4469
4040
    """
4470
4041
    takes_options = ['verbose']
4471
4042
 
4486
4057
                doc = '(no description)'
4487
4058
            result.append((name_ver, doc, plugin.path()))
4488
4059
        for name_ver, doc, path in sorted(result):
4489
 
            self.outf.write("%s\n" % name_ver)
4490
 
            self.outf.write("   %s\n" % doc)
 
4060
            print name_ver
 
4061
            print '   ', doc
4491
4062
            if verbose:
4492
 
                self.outf.write("   %s\n" % path)
4493
 
            self.outf.write("\n")
 
4063
                print '   ', path
 
4064
            print
4494
4065
 
4495
4066
 
4496
4067
class cmd_testament(Command):
4497
 
    __doc__ = """Show testament (signing-form) of a revision."""
 
4068
    """Show testament (signing-form) of a revision."""
4498
4069
    takes_options = [
4499
4070
            'revision',
4500
4071
            Option('long', help='Produce long-format testament.'),
4512
4083
            b = Branch.open_containing(branch)[0]
4513
4084
        else:
4514
4085
            b = Branch.open(branch)
4515
 
        self.add_cleanup(b.lock_read().unlock)
4516
 
        if revision is None:
4517
 
            rev_id = b.last_revision()
4518
 
        else:
4519
 
            rev_id = revision[0].as_revision_id(b)
4520
 
        t = testament_class.from_revision(b.repository, rev_id)
4521
 
        if long:
4522
 
            sys.stdout.writelines(t.as_text_lines())
4523
 
        else:
4524
 
            sys.stdout.write(t.as_short_text())
 
4086
        b.lock_read()
 
4087
        try:
 
4088
            if revision is None:
 
4089
                rev_id = b.last_revision()
 
4090
            else:
 
4091
                rev_id = revision[0].as_revision_id(b)
 
4092
            t = testament_class.from_revision(b.repository, rev_id)
 
4093
            if long:
 
4094
                sys.stdout.writelines(t.as_text_lines())
 
4095
            else:
 
4096
                sys.stdout.write(t.as_short_text())
 
4097
        finally:
 
4098
            b.unlock()
4525
4099
 
4526
4100
 
4527
4101
class cmd_annotate(Command):
4528
 
    __doc__ = """Show the origin of each line in a file.
 
4102
    """Show the origin of each line in a file.
4529
4103
 
4530
4104
    This prints out the given file with an annotation on the left side
4531
4105
    indicating which revision, author and date introduced the change.
4552
4126
        wt, branch, relpath = \
4553
4127
            bzrdir.BzrDir.open_containing_tree_or_branch(filename)
4554
4128
        if wt is not None:
4555
 
            self.add_cleanup(wt.lock_read().unlock)
4556
 
        else:
4557
 
            self.add_cleanup(branch.lock_read().unlock)
4558
 
        tree = _get_one_revision_tree('annotate', revision, branch=branch)
4559
 
        self.add_cleanup(tree.lock_read().unlock)
4560
 
        if wt is not None:
4561
 
            file_id = wt.path2id(relpath)
4562
 
        else:
4563
 
            file_id = tree.path2id(relpath)
4564
 
        if file_id is None:
4565
 
            raise errors.NotVersionedError(filename)
4566
 
        file_version = tree.inventory[file_id].revision
4567
 
        if wt is not None and revision is None:
4568
 
            # If there is a tree and we're not annotating historical
4569
 
            # versions, annotate the working tree's content.
4570
 
            annotate_file_tree(wt, file_id, self.outf, long, all,
4571
 
                show_ids=show_ids)
4572
 
        else:
4573
 
            annotate_file(branch, file_version, file_id, long, all, self.outf,
4574
 
                          show_ids=show_ids)
 
4129
            wt.lock_read()
 
4130
        else:
 
4131
            branch.lock_read()
 
4132
        try:
 
4133
            tree = _get_one_revision_tree('annotate', revision, branch=branch)
 
4134
            if wt is not None:
 
4135
                file_id = wt.path2id(relpath)
 
4136
            else:
 
4137
                file_id = tree.path2id(relpath)
 
4138
            if file_id is None:
 
4139
                raise errors.NotVersionedError(filename)
 
4140
            file_version = tree.inventory[file_id].revision
 
4141
            if wt is not None and revision is None:
 
4142
                # If there is a tree and we're not annotating historical
 
4143
                # versions, annotate the working tree's content.
 
4144
                annotate_file_tree(wt, file_id, self.outf, long, all,
 
4145
                    show_ids=show_ids)
 
4146
            else:
 
4147
                annotate_file(branch, file_version, file_id, long, all, self.outf,
 
4148
                              show_ids=show_ids)
 
4149
        finally:
 
4150
            if wt is not None:
 
4151
                wt.unlock()
 
4152
            else:
 
4153
                branch.unlock()
4575
4154
 
4576
4155
 
4577
4156
class cmd_re_sign(Command):
4578
 
    __doc__ = """Create a digital signature for an existing revision."""
 
4157
    """Create a digital signature for an existing revision."""
4579
4158
    # TODO be able to replace existing ones.
4580
4159
 
4581
4160
    hidden = True # is this right ?
4588
4167
        if revision_id_list is None and revision is None:
4589
4168
            raise errors.BzrCommandError('You must supply either --revision or a revision_id')
4590
4169
        b = WorkingTree.open_containing(u'.')[0].branch
4591
 
        self.add_cleanup(b.lock_write().unlock)
4592
 
        return self._run(b, revision_id_list, revision)
 
4170
        b.lock_write()
 
4171
        try:
 
4172
            return self._run(b, revision_id_list, revision)
 
4173
        finally:
 
4174
            b.unlock()
4593
4175
 
4594
4176
    def _run(self, b, revision_id_list, revision):
4595
4177
        import bzrlib.gpg as gpg
4640
4222
 
4641
4223
 
4642
4224
class cmd_bind(Command):
4643
 
    __doc__ = """Convert the current branch into a checkout of the supplied branch.
4644
 
    If no branch is supplied, rebind to the last bound location.
 
4225
    """Convert the current branch into a checkout of the supplied branch.
4645
4226
 
4646
4227
    Once converted into a checkout, commits must succeed on the master branch
4647
4228
    before they will be applied to the local branch.
4648
4229
 
4649
4230
    Bound branches use the nickname of its master branch unless it is set
4650
 
    locally, in which case binding will update the local nickname to be
 
4231
    locally, in which case binding will update the the local nickname to be
4651
4232
    that of the master.
4652
4233
    """
4653
4234
 
4665
4246
                    'This format does not remember old locations.')
4666
4247
            else:
4667
4248
                if location is None:
4668
 
                    if b.get_bound_location() is not None:
4669
 
                        raise errors.BzrCommandError('Branch is already bound')
4670
 
                    else:
4671
 
                        raise errors.BzrCommandError('No location supplied '
4672
 
                            'and no previous location known')
 
4249
                    raise errors.BzrCommandError('No location supplied and no '
 
4250
                        'previous location known')
4673
4251
        b_other = Branch.open(location)
4674
4252
        try:
4675
4253
            b.bind(b_other)
4681
4259
 
4682
4260
 
4683
4261
class cmd_unbind(Command):
4684
 
    __doc__ = """Convert the current checkout into a regular branch.
 
4262
    """Convert the current checkout into a regular branch.
4685
4263
 
4686
4264
    After unbinding, the local branch is considered independent and subsequent
4687
4265
    commits will be local only.
4698
4276
 
4699
4277
 
4700
4278
class cmd_uncommit(Command):
4701
 
    __doc__ = """Remove the last committed revision.
 
4279
    """Remove the last committed revision.
4702
4280
 
4703
4281
    --verbose will print out what is being removed.
4704
4282
    --dry-run will go through all the motions, but not actually
4744
4322
            b = control.open_branch()
4745
4323
 
4746
4324
        if tree is not None:
4747
 
            self.add_cleanup(tree.lock_write().unlock)
 
4325
            tree.lock_write()
4748
4326
        else:
4749
 
            self.add_cleanup(b.lock_write().unlock)
4750
 
        return self._run(b, tree, dry_run, verbose, revision, force, local=local)
 
4327
            b.lock_write()
 
4328
        try:
 
4329
            return self._run(b, tree, dry_run, verbose, revision, force,
 
4330
                             local=local)
 
4331
        finally:
 
4332
            if tree is not None:
 
4333
                tree.unlock()
 
4334
            else:
 
4335
                b.unlock()
4751
4336
 
4752
4337
    def _run(self, b, tree, dry_run, verbose, revision, force, local=False):
4753
4338
        from bzrlib.log import log_formatter, show_log
4785
4370
                 end_revision=last_revno)
4786
4371
 
4787
4372
        if dry_run:
4788
 
            self.outf.write('Dry-run, pretending to remove'
4789
 
                            ' the above revisions.\n')
 
4373
            print 'Dry-run, pretending to remove the above revisions.'
 
4374
            if not force:
 
4375
                val = raw_input('Press <enter> to continue')
4790
4376
        else:
4791
 
            self.outf.write('The above revision(s) will be removed.\n')
4792
 
 
4793
 
        if not force:
4794
 
            if not ui.ui_factory.get_boolean('Are you sure'):
4795
 
                self.outf.write('Canceled')
4796
 
                return 0
 
4377
            print 'The above revision(s) will be removed.'
 
4378
            if not force:
 
4379
                val = raw_input('Are you sure [y/N]? ')
 
4380
                if val.lower() not in ('y', 'yes'):
 
4381
                    print 'Canceled'
 
4382
                    return 0
4797
4383
 
4798
4384
        mutter('Uncommitting from {%s} to {%s}',
4799
4385
               last_rev_id, rev_id)
4800
4386
        uncommit(b, tree=tree, dry_run=dry_run, verbose=verbose,
4801
4387
                 revno=revno, local=local)
4802
 
        self.outf.write('You can restore the old tip by running:\n'
4803
 
             '  bzr pull . -r revid:%s\n' % last_rev_id)
 
4388
        note('You can restore the old tip by running:\n'
 
4389
             '  bzr pull . -r revid:%s', last_rev_id)
4804
4390
 
4805
4391
 
4806
4392
class cmd_break_lock(Command):
4807
 
    __doc__ = """Break a dead lock on a repository, branch or working directory.
 
4393
    """Break a dead lock on a repository, branch or working directory.
4808
4394
 
4809
4395
    CAUTION: Locks should only be broken when you are sure that the process
4810
4396
    holding the lock has been stopped.
4811
4397
 
4812
 
    You can get information on what locks are open via the 'bzr info
4813
 
    [location]' command.
 
4398
    You can get information on what locks are open via the 'bzr info' command.
4814
4399
 
4815
4400
    :Examples:
4816
4401
        bzr break-lock
4817
 
        bzr break-lock bzr+ssh://example.com/bzr/foo
4818
4402
    """
4819
4403
    takes_args = ['location?']
4820
4404
 
4829
4413
 
4830
4414
 
4831
4415
class cmd_wait_until_signalled(Command):
4832
 
    __doc__ = """Test helper for test_start_and_stop_bzr_subprocess_send_signal.
 
4416
    """Test helper for test_start_and_stop_bzr_subprocess_send_signal.
4833
4417
 
4834
4418
    This just prints a line to signal when it is ready, then blocks on stdin.
4835
4419
    """
4843
4427
 
4844
4428
 
4845
4429
class cmd_serve(Command):
4846
 
    __doc__ = """Run the bzr server."""
 
4430
    """Run the bzr server."""
4847
4431
 
4848
4432
    aliases = ['server']
4849
4433
 
4850
4434
    takes_options = [
4851
4435
        Option('inet',
4852
4436
               help='Serve on stdin/out for use from inetd or sshd.'),
4853
 
        RegistryOption('protocol',
4854
 
               help="Protocol to serve.",
4855
 
               lazy_registry=('bzrlib.transport', 'transport_server_registry'),
4856
 
               value_switches=True),
4857
4437
        Option('port',
4858
4438
               help='Listen for connections on nominated port of the form '
4859
4439
                    '[hostname:]portnumber.  Passing 0 as the port number will '
4860
 
                    'result in a dynamically allocated port.  The default port '
4861
 
                    'depends on the protocol.',
 
4440
                    'result in a dynamically allocated port.  The default port is '
 
4441
                    '4155.',
4862
4442
               type=str),
4863
4443
        Option('directory',
4864
4444
               help='Serve contents of this directory.',
4866
4446
        Option('allow-writes',
4867
4447
               help='By default the server is a readonly server.  Supplying '
4868
4448
                    '--allow-writes enables write access to the contents of '
4869
 
                    'the served directory and below.  Note that ``bzr serve`` '
4870
 
                    'does not perform authentication, so unless some form of '
4871
 
                    'external authentication is arranged supplying this '
4872
 
                    'option leads to global uncontrolled write access to your '
4873
 
                    'file system.'
 
4449
                    'the served directory and below.'
4874
4450
                ),
4875
4451
        ]
4876
4452
 
 
4453
    def run_smart_server(self, smart_server):
 
4454
        """Run 'smart_server' forever, with no UI output at all."""
 
4455
        # For the duration of this server, no UI output is permitted. note
 
4456
        # that this may cause problems with blackbox tests. This should be
 
4457
        # changed with care though, as we dont want to use bandwidth sending
 
4458
        # progress over stderr to smart server clients!
 
4459
        from bzrlib import lockdir
 
4460
        old_factory = ui.ui_factory
 
4461
        old_lockdir_timeout = lockdir._DEFAULT_TIMEOUT_SECONDS
 
4462
        try:
 
4463
            ui.ui_factory = ui.SilentUIFactory()
 
4464
            lockdir._DEFAULT_TIMEOUT_SECONDS = 0
 
4465
            smart_server.serve()
 
4466
        finally:
 
4467
            ui.ui_factory = old_factory
 
4468
            lockdir._DEFAULT_TIMEOUT_SECONDS = old_lockdir_timeout
 
4469
 
4877
4470
    def get_host_and_port(self, port):
4878
4471
        """Return the host and port to run the smart server on.
4879
4472
 
4880
 
        If 'port' is None, None will be returned for the host and port.
 
4473
        If 'port' is None, the default host (`medium.BZR_DEFAULT_INTERFACE`)
 
4474
        and port (`medium.BZR_DEFAULT_PORT`) will be used.
4881
4475
 
4882
4476
        If 'port' has a colon in it, the string before the colon will be
4883
4477
        interpreted as the host.
4886
4480
        :return: A tuple of (host, port), where 'host' is a host name or IP,
4887
4481
            and port is an integer TCP/IP port.
4888
4482
        """
4889
 
        host = None
4890
 
        if port is not None:
 
4483
        from bzrlib.smart import medium
 
4484
        host = medium.BZR_DEFAULT_INTERFACE
 
4485
        if port is None:
 
4486
            port = medium.BZR_DEFAULT_PORT
 
4487
        else:
4891
4488
            if ':' in port:
4892
4489
                host, port = port.split(':')
4893
4490
            port = int(port)
4894
4491
        return host, port
4895
4492
 
4896
 
    def run(self, port=None, inet=False, directory=None, allow_writes=False,
4897
 
            protocol=None):
4898
 
        from bzrlib.transport import get_transport, transport_server_registry
 
4493
    def get_smart_server(self, transport, inet, port):
 
4494
        """Construct a smart server.
 
4495
 
 
4496
        :param transport: The base transport from which branches will be
 
4497
            served.
 
4498
        :param inet: If True, serve over stdin and stdout. Used for running
 
4499
            from inet.
 
4500
        :param port: The port to listen on. By default, it's `
 
4501
            medium.BZR_DEFAULT_PORT`. See `get_host_and_port` for more
 
4502
            information.
 
4503
        :return: A smart server.
 
4504
        """
 
4505
        from bzrlib.smart import medium, server
 
4506
        if inet:
 
4507
            smart_server = medium.SmartServerPipeStreamMedium(
 
4508
                sys.stdin, sys.stdout, transport)
 
4509
        else:
 
4510
            host, port = self.get_host_and_port(port)
 
4511
            smart_server = server.SmartTCPServer(
 
4512
                transport, host=host, port=port)
 
4513
            note('listening on port: %s' % smart_server.port)
 
4514
        return smart_server
 
4515
 
 
4516
    def run(self, port=None, inet=False, directory=None, allow_writes=False):
 
4517
        from bzrlib.transport import get_transport
 
4518
        from bzrlib.transport.chroot import ChrootServer
4899
4519
        if directory is None:
4900
4520
            directory = os.getcwd()
4901
 
        if protocol is None:
4902
 
            protocol = transport_server_registry.get()
4903
 
        host, port = self.get_host_and_port(port)
4904
4521
        url = urlutils.local_path_to_url(directory)
4905
4522
        if not allow_writes:
4906
4523
            url = 'readonly+' + url
4907
 
        transport = get_transport(url)
4908
 
        protocol(transport, host, port, inet)
 
4524
        chroot_server = ChrootServer(get_transport(url))
 
4525
        chroot_server.setUp()
 
4526
        t = get_transport(chroot_server.get_url())
 
4527
        smart_server = self.get_smart_server(t, inet, port)
 
4528
        self.run_smart_server(smart_server)
4909
4529
 
4910
4530
 
4911
4531
class cmd_join(Command):
4912
 
    __doc__ = """Combine a tree into its containing tree.
 
4532
    """Combine a subtree into its containing tree.
4913
4533
 
4914
 
    This command requires the target tree to be in a rich-root format.
 
4534
    This command is for experimental use only.  It requires the target tree
 
4535
    to be in dirstate-with-subtree format, which cannot be converted into
 
4536
    earlier formats.
4915
4537
 
4916
4538
    The TREE argument should be an independent tree, inside another tree, but
4917
4539
    not part of it.  (Such trees can be produced by "bzr split", but also by
4920
4542
    The result is a combined tree, with the subtree no longer an independant
4921
4543
    part.  This is marked as a merge of the subtree into the containing tree,
4922
4544
    and all history is preserved.
 
4545
 
 
4546
    If --reference is specified, the subtree retains its independence.  It can
 
4547
    be branched by itself, and can be part of multiple projects at the same
 
4548
    time.  But operations performed in the containing tree, such as commit
 
4549
    and merge, will recurse into the subtree.
4923
4550
    """
4924
4551
 
4925
4552
    _see_also = ['split']
4926
4553
    takes_args = ['tree']
4927
4554
    takes_options = [
4928
 
            Option('reference', help='Join by reference.', hidden=True),
 
4555
            Option('reference', help='Join by reference.'),
4929
4556
            ]
 
4557
    hidden = True
4930
4558
 
4931
4559
    def run(self, tree, reference=False):
4932
4560
        sub_tree = WorkingTree.open(tree)
4955
4583
 
4956
4584
 
4957
4585
class cmd_split(Command):
4958
 
    __doc__ = """Split a subdirectory of a tree into a separate tree.
 
4586
    """Split a subdirectory of a tree into a separate tree.
4959
4587
 
4960
4588
    This command will produce a target tree in a format that supports
4961
4589
    rich roots, like 'rich-root' or 'rich-root-pack'.  These formats cannot be
4966
4594
    branch.  Commits in the top-level tree will not apply to the new subtree.
4967
4595
    """
4968
4596
 
4969
 
    _see_also = ['join']
 
4597
    # join is not un-hidden yet
 
4598
    #_see_also = ['join']
4970
4599
    takes_args = ['tree']
4971
4600
 
4972
4601
    def run(self, tree):
4977
4606
        try:
4978
4607
            containing_tree.extract(sub_id)
4979
4608
        except errors.RootNotRich:
4980
 
            raise errors.RichRootUpgradeRequired(containing_tree.branch.base)
 
4609
            raise errors.UpgradeRequired(containing_tree.branch.base)
4981
4610
 
4982
4611
 
4983
4612
class cmd_merge_directive(Command):
4984
 
    __doc__ = """Generate a merge directive for auto-merge tools.
 
4613
    """Generate a merge directive for auto-merge tools.
4985
4614
 
4986
4615
    A directive requests a merge to be performed, and also provides all the
4987
4616
    information necessary to do so.  This means it must either include a
5080
4709
 
5081
4710
 
5082
4711
class cmd_send(Command):
5083
 
    __doc__ = """Mail or create a merge-directive for submitting changes.
 
4712
    """Mail or create a merge-directive for submitting changes.
5084
4713
 
5085
4714
    A merge directive provides many things needed for requesting merges:
5086
4715
 
5092
4721
      directly from the merge directive, without retrieving data from a
5093
4722
      branch.
5094
4723
 
5095
 
    `bzr send` creates a compact data set that, when applied using bzr
5096
 
    merge, has the same effect as merging from the source branch.  
5097
 
    
5098
 
    By default the merge directive is self-contained and can be applied to any
5099
 
    branch containing submit_branch in its ancestory without needing access to
5100
 
    the source branch.
5101
 
    
5102
 
    If --no-bundle is specified, then Bazaar doesn't send the contents of the
5103
 
    revisions, but only a structured request to merge from the
5104
 
    public_location.  In that case the public_branch is needed and it must be
5105
 
    up-to-date and accessible to the recipient.  The public_branch is always
5106
 
    included if known, so that people can check it later.
5107
 
 
5108
 
    The submit branch defaults to the parent of the source branch, but can be
5109
 
    overridden.  Both submit branch and public branch will be remembered in
5110
 
    branch.conf the first time they are used for a particular branch.  The
5111
 
    source branch defaults to that containing the working directory, but can
5112
 
    be changed using --from.
5113
 
 
5114
 
    In order to calculate those changes, bzr must analyse the submit branch.
5115
 
    Therefore it is most efficient for the submit branch to be a local mirror.
5116
 
    If a public location is known for the submit_branch, that location is used
5117
 
    in the merge directive.
5118
 
 
5119
 
    The default behaviour is to send the merge directive by mail, unless -o is
5120
 
    given, in which case it is sent to a file.
 
4724
    If --no-bundle is specified, then public_branch is needed (and must be
 
4725
    up-to-date), so that the receiver can perform the merge using the
 
4726
    public_branch.  The public_branch is always included if known, so that
 
4727
    people can check it later.
 
4728
 
 
4729
    The submit branch defaults to the parent, but can be overridden.  Both
 
4730
    submit branch and public branch will be remembered if supplied.
 
4731
 
 
4732
    If a public_branch is known for the submit_branch, that public submit
 
4733
    branch is used in the merge instructions.  This means that a local mirror
 
4734
    can be used as your actual submit branch, once you have set public_branch
 
4735
    for that mirror.
5121
4736
 
5122
4737
    Mail is sent using your preferred mail program.  This should be transparent
5123
4738
    on Windows (it uses MAPI).  On Linux, it requires the xdg-email utility.
5125
4740
 
5126
4741
    To use a specific mail program, set the mail_client configuration option.
5127
4742
    (For Thunderbird 1.5, this works around some bugs.)  Supported values for
5128
 
    specific clients are "claws", "evolution", "kmail", "mail.app" (MacOS X's
5129
 
    Mail.app), "mutt", and "thunderbird"; generic options are "default",
5130
 
    "editor", "emacsclient", "mapi", and "xdg-email".  Plugins may also add
5131
 
    supported clients.
 
4743
    specific clients are "claws", "evolution", "kmail", "mutt", and
 
4744
    "thunderbird"; generic options are "default", "editor", "emacsclient",
 
4745
    "mapi", and "xdg-email".  Plugins may also add supported clients.
5132
4746
 
5133
4747
    If mail is being sent, a to address is required.  This can be supplied
5134
4748
    either on the commandline, by setting the submit_to configuration
5143
4757
 
5144
4758
    The merge directives created by bzr send may be applied using bzr merge or
5145
4759
    bzr pull by specifying a file containing a merge directive as the location.
5146
 
 
5147
 
    bzr send makes extensive use of public locations to map local locations into
5148
 
    URLs that can be used by other people.  See `bzr help configuration` to
5149
 
    set them, and use `bzr info` to display them.
5150
4760
    """
5151
4761
 
5152
4762
    encoding_type = 'exact'
5168
4778
               short_name='f',
5169
4779
               type=unicode),
5170
4780
        Option('output', short_name='o',
5171
 
               help='Write merge directive to this file or directory; '
 
4781
               help='Write merge directive to this file; '
5172
4782
                    'use - for stdout.',
5173
4783
               type=unicode),
5174
 
        Option('strict',
5175
 
               help='Refuse to send if there are uncommitted changes in'
5176
 
               ' the working tree, --no-strict disables the check.'),
5177
4784
        Option('mail-to', help='Mail the request to this address.',
5178
4785
               type=unicode),
5179
4786
        'revision',
5180
4787
        'message',
5181
4788
        Option('body', help='Body for the email.', type=unicode),
5182
 
        RegistryOption('format',
5183
 
                       help='Use the specified output format.',
5184
 
                       lazy_registry=('bzrlib.send', 'format_registry')),
 
4789
        RegistryOption.from_kwargs('format',
 
4790
        'Use the specified output format.',
 
4791
        **{'4': 'Bundle format 4, Merge Directive 2 (default)',
 
4792
           '0.9': 'Bundle format 0.9, Merge Directive 1',})
5185
4793
        ]
5186
4794
 
5187
4795
    def run(self, submit_branch=None, public_branch=None, no_bundle=False,
5188
4796
            no_patch=False, revision=None, remember=False, output=None,
5189
 
            format=None, mail_to=None, message=None, body=None,
5190
 
            strict=None, **kwargs):
5191
 
        from bzrlib.send import send
5192
 
        return send(submit_branch, revision, public_branch, remember,
5193
 
                    format, no_bundle, no_patch, output,
5194
 
                    kwargs.get('from', '.'), mail_to, message, body,
5195
 
                    self.outf,
5196
 
                    strict=strict)
 
4797
            format='4', mail_to=None, message=None, body=None, **kwargs):
 
4798
        return self._run(submit_branch, revision, public_branch, remember,
 
4799
                         format, no_bundle, no_patch, output,
 
4800
                         kwargs.get('from', '.'), mail_to, message, body)
 
4801
 
 
4802
    def _run(self, submit_branch, revision, public_branch, remember, format,
 
4803
             no_bundle, no_patch, output, from_, mail_to, message, body):
 
4804
        from bzrlib.revision import NULL_REVISION
 
4805
        branch = Branch.open_containing(from_)[0]
 
4806
        if output is None:
 
4807
            outfile = cStringIO.StringIO()
 
4808
        elif output == '-':
 
4809
            outfile = self.outf
 
4810
        else:
 
4811
            outfile = open(output, 'wb')
 
4812
        # we may need to write data into branch's repository to calculate
 
4813
        # the data to send.
 
4814
        branch.lock_write()
 
4815
        try:
 
4816
            if output is None:
 
4817
                config = branch.get_config()
 
4818
                if mail_to is None:
 
4819
                    mail_to = config.get_user_option('submit_to')
 
4820
                mail_client = config.get_mail_client()
 
4821
                if (not getattr(mail_client, 'supports_body', False)
 
4822
                    and body is not None):
 
4823
                    raise errors.BzrCommandError(
 
4824
                        'Mail client "%s" does not support specifying body' %
 
4825
                        mail_client.__class__.__name__)
 
4826
            if remember and submit_branch is None:
 
4827
                raise errors.BzrCommandError(
 
4828
                    '--remember requires a branch to be specified.')
 
4829
            stored_submit_branch = branch.get_submit_branch()
 
4830
            remembered_submit_branch = None
 
4831
            if submit_branch is None:
 
4832
                submit_branch = stored_submit_branch
 
4833
                remembered_submit_branch = "submit"
 
4834
            else:
 
4835
                if stored_submit_branch is None or remember:
 
4836
                    branch.set_submit_branch(submit_branch)
 
4837
            if submit_branch is None:
 
4838
                submit_branch = branch.get_parent()
 
4839
                remembered_submit_branch = "parent"
 
4840
            if submit_branch is None:
 
4841
                raise errors.BzrCommandError('No submit branch known or'
 
4842
                                             ' specified')
 
4843
            if remembered_submit_branch is not None:
 
4844
                note('Using saved %s location "%s" to determine what '
 
4845
                        'changes to submit.', remembered_submit_branch,
 
4846
                        submit_branch)
 
4847
 
 
4848
            if mail_to is None:
 
4849
                submit_config = Branch.open(submit_branch).get_config()
 
4850
                mail_to = submit_config.get_user_option("child_submit_to")
 
4851
 
 
4852
            stored_public_branch = branch.get_public_branch()
 
4853
            if public_branch is None:
 
4854
                public_branch = stored_public_branch
 
4855
            elif stored_public_branch is None or remember:
 
4856
                branch.set_public_branch(public_branch)
 
4857
            if no_bundle and public_branch is None:
 
4858
                raise errors.BzrCommandError('No public branch specified or'
 
4859
                                             ' known')
 
4860
            base_revision_id = None
 
4861
            revision_id = None
 
4862
            if revision is not None:
 
4863
                if len(revision) > 2:
 
4864
                    raise errors.BzrCommandError('bzr send takes '
 
4865
                        'at most two one revision identifiers')
 
4866
                revision_id = revision[-1].as_revision_id(branch)
 
4867
                if len(revision) == 2:
 
4868
                    base_revision_id = revision[0].as_revision_id(branch)
 
4869
            if revision_id is None:
 
4870
                revision_id = branch.last_revision()
 
4871
            if revision_id == NULL_REVISION:
 
4872
                raise errors.BzrCommandError('No revisions to submit.')
 
4873
            if format == '4':
 
4874
                directive = merge_directive.MergeDirective2.from_objects(
 
4875
                    branch.repository, revision_id, time.time(),
 
4876
                    osutils.local_time_offset(), submit_branch,
 
4877
                    public_branch=public_branch, include_patch=not no_patch,
 
4878
                    include_bundle=not no_bundle, message=message,
 
4879
                    base_revision_id=base_revision_id)
 
4880
            elif format == '0.9':
 
4881
                if not no_bundle:
 
4882
                    if not no_patch:
 
4883
                        patch_type = 'bundle'
 
4884
                    else:
 
4885
                        raise errors.BzrCommandError('Format 0.9 does not'
 
4886
                            ' permit bundle with no patch')
 
4887
                else:
 
4888
                    if not no_patch:
 
4889
                        patch_type = 'diff'
 
4890
                    else:
 
4891
                        patch_type = None
 
4892
                directive = merge_directive.MergeDirective.from_objects(
 
4893
                    branch.repository, revision_id, time.time(),
 
4894
                    osutils.local_time_offset(), submit_branch,
 
4895
                    public_branch=public_branch, patch_type=patch_type,
 
4896
                    message=message)
 
4897
 
 
4898
            outfile.writelines(directive.to_lines())
 
4899
            if output is None:
 
4900
                subject = '[MERGE] '
 
4901
                if message is not None:
 
4902
                    subject += message
 
4903
                else:
 
4904
                    revision = branch.repository.get_revision(revision_id)
 
4905
                    subject += revision.get_summary()
 
4906
                basename = directive.get_disk_name(branch)
 
4907
                mail_client.compose_merge_request(mail_to, subject,
 
4908
                                                  outfile.getvalue(),
 
4909
                                                  basename, body)
 
4910
        finally:
 
4911
            if output != '-':
 
4912
                outfile.close()
 
4913
            branch.unlock()
5197
4914
 
5198
4915
 
5199
4916
class cmd_bundle_revisions(cmd_send):
5200
 
    __doc__ = """Create a merge-directive for submitting changes.
 
4917
 
 
4918
    """Create a merge-directive for submitting changes.
5201
4919
 
5202
4920
    A merge directive provides many things needed for requesting merges:
5203
4921
 
5243
4961
               type=unicode),
5244
4962
        Option('output', short_name='o', help='Write directive to this file.',
5245
4963
               type=unicode),
5246
 
        Option('strict',
5247
 
               help='Refuse to bundle revisions if there are uncommitted'
5248
 
               ' changes in the working tree, --no-strict disables the check.'),
5249
4964
        'revision',
5250
 
        RegistryOption('format',
5251
 
                       help='Use the specified output format.',
5252
 
                       lazy_registry=('bzrlib.send', 'format_registry')),
 
4965
        RegistryOption.from_kwargs('format',
 
4966
        'Use the specified output format.',
 
4967
        **{'4': 'Bundle format 4, Merge Directive 2 (default)',
 
4968
           '0.9': 'Bundle format 0.9, Merge Directive 1',})
5253
4969
        ]
5254
4970
    aliases = ['bundle']
5255
4971
 
5259
4975
 
5260
4976
    def run(self, submit_branch=None, public_branch=None, no_bundle=False,
5261
4977
            no_patch=False, revision=None, remember=False, output=None,
5262
 
            format=None, strict=None, **kwargs):
 
4978
            format='4', **kwargs):
5263
4979
        if output is None:
5264
4980
            output = '-'
5265
 
        from bzrlib.send import send
5266
 
        return send(submit_branch, revision, public_branch, remember,
 
4981
        return self._run(submit_branch, revision, public_branch, remember,
5267
4982
                         format, no_bundle, no_patch, output,
5268
 
                         kwargs.get('from', '.'), None, None, None,
5269
 
                         self.outf, strict=strict)
 
4983
                         kwargs.get('from', '.'), None, None, None)
5270
4984
 
5271
4985
 
5272
4986
class cmd_tag(Command):
5273
 
    __doc__ = """Create, remove or modify a tag naming a revision.
 
4987
    """Create, remove or modify a tag naming a revision.
5274
4988
 
5275
4989
    Tags give human-meaningful names to revisions.  Commands that take a -r
5276
4990
    (--revision) option can be given -rtag:X, where X is any previously
5284
4998
 
5285
4999
    To rename a tag (change the name but keep it on the same revsion), run ``bzr
5286
5000
    tag new-name -r tag:old-name`` and then ``bzr tag --delete oldname``.
5287
 
 
5288
 
    If no tag name is specified it will be determined through the 
5289
 
    'automatic_tag_name' hook. This can e.g. be used to automatically tag
5290
 
    upstream releases by reading configure.ac. See ``bzr help hooks`` for
5291
 
    details.
5292
5001
    """
5293
5002
 
5294
5003
    _see_also = ['commit', 'tags']
5295
 
    takes_args = ['tag_name?']
 
5004
    takes_args = ['tag_name']
5296
5005
    takes_options = [
5297
5006
        Option('delete',
5298
5007
            help='Delete this tag rather than placing it.',
5308
5017
        'revision',
5309
5018
        ]
5310
5019
 
5311
 
    def run(self, tag_name=None,
 
5020
    def run(self, tag_name,
5312
5021
            delete=None,
5313
5022
            directory='.',
5314
5023
            force=None,
5315
5024
            revision=None,
5316
5025
            ):
5317
5026
        branch, relpath = Branch.open_containing(directory)
5318
 
        self.add_cleanup(branch.lock_write().unlock)
5319
 
        if delete:
5320
 
            if tag_name is None:
5321
 
                raise errors.BzrCommandError("No tag specified to delete.")
5322
 
            branch.tags.delete_tag(tag_name)
5323
 
            self.outf.write('Deleted tag %s.\n' % tag_name)
5324
 
        else:
5325
 
            if revision:
5326
 
                if len(revision) != 1:
5327
 
                    raise errors.BzrCommandError(
5328
 
                        "Tags can only be placed on a single revision, "
5329
 
                        "not on a range")
5330
 
                revision_id = revision[0].as_revision_id(branch)
 
5027
        branch.lock_write()
 
5028
        try:
 
5029
            if delete:
 
5030
                branch.tags.delete_tag(tag_name)
 
5031
                self.outf.write('Deleted tag %s.\n' % tag_name)
5331
5032
            else:
5332
 
                revision_id = branch.last_revision()
5333
 
            if tag_name is None:
5334
 
                tag_name = branch.automatic_tag_name(revision_id)
5335
 
                if tag_name is None:
5336
 
                    raise errors.BzrCommandError(
5337
 
                        "Please specify a tag name.")
5338
 
            if (not force) and branch.tags.has_tag(tag_name):
5339
 
                raise errors.TagAlreadyExists(tag_name)
5340
 
            branch.tags.set_tag(tag_name, revision_id)
5341
 
            self.outf.write('Created tag %s.\n' % tag_name)
 
5033
                if revision:
 
5034
                    if len(revision) != 1:
 
5035
                        raise errors.BzrCommandError(
 
5036
                            "Tags can only be placed on a single revision, "
 
5037
                            "not on a range")
 
5038
                    revision_id = revision[0].as_revision_id(branch)
 
5039
                else:
 
5040
                    revision_id = branch.last_revision()
 
5041
                if (not force) and branch.tags.has_tag(tag_name):
 
5042
                    raise errors.TagAlreadyExists(tag_name)
 
5043
                branch.tags.set_tag(tag_name, revision_id)
 
5044
                self.outf.write('Created tag %s.\n' % tag_name)
 
5045
        finally:
 
5046
            branch.unlock()
5342
5047
 
5343
5048
 
5344
5049
class cmd_tags(Command):
5345
 
    __doc__ = """List tags.
 
5050
    """List tags.
5346
5051
 
5347
5052
    This command shows a table of tag names and the revisions they reference.
5348
5053
    """
5376
5081
        if not tags:
5377
5082
            return
5378
5083
 
5379
 
        self.add_cleanup(branch.lock_read().unlock)
5380
5084
        if revision:
5381
 
            graph = branch.repository.get_graph()
5382
 
            rev1, rev2 = _get_revision_range(revision, branch, self.name())
5383
 
            revid1, revid2 = rev1.rev_id, rev2.rev_id
5384
 
            # only show revisions between revid1 and revid2 (inclusive)
5385
 
            tags = [(tag, revid) for tag, revid in tags if
5386
 
                graph.is_between(revid, revid1, revid2)]
 
5085
            branch.lock_read()
 
5086
            try:
 
5087
                graph = branch.repository.get_graph()
 
5088
                rev1, rev2 = _get_revision_range(revision, branch, self.name())
 
5089
                revid1, revid2 = rev1.rev_id, rev2.rev_id
 
5090
                # only show revisions between revid1 and revid2 (inclusive)
 
5091
                tags = [(tag, revid) for tag, revid in tags if
 
5092
                    graph.is_between(revid, revid1, revid2)]
 
5093
            finally:
 
5094
                branch.unlock()
5387
5095
        if sort == 'alpha':
5388
5096
            tags.sort()
5389
5097
        elif sort == 'time':
5399
5107
            tags.sort(key=lambda x: timestamps[x[1]])
5400
5108
        if not show_ids:
5401
5109
            # [ (tag, revid), ... ] -> [ (tag, dotted_revno), ... ]
5402
 
            for index, (tag, revid) in enumerate(tags):
5403
 
                try:
5404
 
                    revno = branch.revision_id_to_dotted_revno(revid)
5405
 
                    if isinstance(revno, tuple):
5406
 
                        revno = '.'.join(map(str, revno))
5407
 
                except errors.NoSuchRevision:
5408
 
                    # Bad tag data/merges can lead to tagged revisions
5409
 
                    # which are not in this branch. Fail gracefully ...
5410
 
                    revno = '?'
5411
 
                tags[index] = (tag, revno)
5412
 
        self.cleanup_now()
 
5110
            revno_map = branch.get_revision_id_to_revno_map()
 
5111
            tags = [ (tag, '.'.join(map(str, revno_map.get(revid, ('?',)))))
 
5112
                        for tag, revid in tags ]
5413
5113
        for tag, revspec in tags:
5414
5114
            self.outf.write('%-20s %s\n' % (tag, revspec))
5415
5115
 
5416
5116
 
5417
5117
class cmd_reconfigure(Command):
5418
 
    __doc__ = """Reconfigure the type of a bzr directory.
 
5118
    """Reconfigure the type of a bzr directory.
5419
5119
 
5420
5120
    A target configuration must be specified.
5421
5121
 
5451
5151
            ),
5452
5152
        Option('bind-to', help='Branch to bind checkout to.', type=str),
5453
5153
        Option('force',
5454
 
            help='Perform reconfiguration even if local changes'
5455
 
            ' will be lost.'),
5456
 
        Option('stacked-on',
5457
 
            help='Reconfigure a branch to be stacked on another branch.',
5458
 
            type=unicode,
5459
 
            ),
5460
 
        Option('unstacked',
5461
 
            help='Reconfigure a branch to be unstacked.  This '
5462
 
                'may require copying substantial data into it.',
5463
 
            ),
 
5154
               help='Perform reconfiguration even if local changes'
 
5155
               ' will be lost.')
5464
5156
        ]
5465
5157
 
5466
 
    def run(self, location=None, target_type=None, bind_to=None, force=False,
5467
 
            stacked_on=None,
5468
 
            unstacked=None):
 
5158
    def run(self, location=None, target_type=None, bind_to=None, force=False):
5469
5159
        directory = bzrdir.BzrDir.open(location)
5470
 
        if stacked_on and unstacked:
5471
 
            raise BzrCommandError("Can't use both --stacked-on and --unstacked")
5472
 
        elif stacked_on is not None:
5473
 
            reconfigure.ReconfigureStackedOn().apply(directory, stacked_on)
5474
 
        elif unstacked:
5475
 
            reconfigure.ReconfigureUnstacked().apply(directory)
5476
 
        # At the moment you can use --stacked-on and a different
5477
 
        # reconfiguration shape at the same time; there seems no good reason
5478
 
        # to ban it.
5479
5160
        if target_type is None:
5480
 
            if stacked_on or unstacked:
5481
 
                return
5482
 
            else:
5483
 
                raise errors.BzrCommandError('No target configuration '
5484
 
                    'specified')
 
5161
            raise errors.BzrCommandError('No target configuration specified')
5485
5162
        elif target_type == 'branch':
5486
5163
            reconfiguration = reconfigure.Reconfigure.to_branch(directory)
5487
5164
        elif target_type == 'tree':
5506
5183
 
5507
5184
 
5508
5185
class cmd_switch(Command):
5509
 
    __doc__ = """Set the branch of a checkout and update.
 
5186
    """Set the branch of a checkout and update.
5510
5187
 
5511
5188
    For lightweight checkouts, this changes the branch being referenced.
5512
5189
    For heavyweight checkouts, this checks that there are no local commits
5524
5201
    /path/to/newbranch.
5525
5202
 
5526
5203
    Bound branches use the nickname of its master branch unless it is set
5527
 
    locally, in which case switching will update the local nickname to be
 
5204
    locally, in which case switching will update the the local nickname to be
5528
5205
    that of the master.
5529
5206
    """
5530
5207
 
5531
 
    takes_args = ['to_location?']
 
5208
    takes_args = ['to_location']
5532
5209
    takes_options = [Option('force',
5533
 
                        help='Switch even if local commits will be lost.'),
5534
 
                     'revision',
5535
 
                     Option('create-branch', short_name='b',
5536
 
                        help='Create the target branch from this one before'
5537
 
                             ' switching to it.'),
5538
 
                    ]
 
5210
                        help='Switch even if local commits will be lost.')
 
5211
                     ]
5539
5212
 
5540
 
    def run(self, to_location=None, force=False, create_branch=False,
5541
 
            revision=None):
 
5213
    def run(self, to_location, force=False):
5542
5214
        from bzrlib import switch
5543
5215
        tree_location = '.'
5544
 
        revision = _get_one_revision('switch', revision)
5545
5216
        control_dir = bzrdir.BzrDir.open_containing(tree_location)[0]
5546
 
        if to_location is None:
5547
 
            if revision is None:
5548
 
                raise errors.BzrCommandError('You must supply either a'
5549
 
                                             ' revision or a location')
5550
 
            to_location = '.'
 
5217
        branch = control_dir.open_branch()
5551
5218
        try:
5552
 
            branch = control_dir.open_branch()
5553
 
            had_explicit_nick = branch.get_config().has_explicit_nickname()
 
5219
            to_branch = Branch.open(to_location)
5554
5220
        except errors.NotBranchError:
5555
 
            branch = None
5556
 
            had_explicit_nick = False
5557
 
        if create_branch:
5558
 
            if branch is None:
5559
 
                raise errors.BzrCommandError('cannot create branch without'
5560
 
                                             ' source branch')
5561
 
            to_location = directory_service.directories.dereference(
5562
 
                              to_location)
5563
 
            if '/' not in to_location and '\\' not in to_location:
5564
 
                # This path is meant to be relative to the existing branch
5565
 
                this_url = self._get_branch_location(control_dir)
5566
 
                to_location = urlutils.join(this_url, '..', to_location)
5567
 
            to_branch = branch.bzrdir.sprout(to_location,
5568
 
                                 possible_transports=[branch.bzrdir.root_transport],
5569
 
                                 source_branch=branch).open_branch()
5570
 
        else:
5571
 
            try:
5572
 
                to_branch = Branch.open(to_location)
5573
 
            except errors.NotBranchError:
5574
 
                this_url = self._get_branch_location(control_dir)
5575
 
                to_branch = Branch.open(
5576
 
                    urlutils.join(this_url, '..', to_location))
5577
 
        if revision is not None:
5578
 
            revision = revision.as_revision_id(to_branch)
5579
 
        switch.switch(control_dir, to_branch, force, revision_id=revision)
5580
 
        if had_explicit_nick:
 
5221
            this_branch = control_dir.open_branch()
 
5222
            # This may be a heavy checkout, where we want the master branch
 
5223
            this_url = this_branch.get_bound_location()
 
5224
            # If not, use a local sibling
 
5225
            if this_url is None:
 
5226
                this_url = this_branch.base
 
5227
            to_branch = Branch.open(
 
5228
                urlutils.join(this_url, '..', to_location))
 
5229
        switch.switch(control_dir, to_branch, force)
 
5230
        if branch.get_config().has_explicit_nickname():
5581
5231
            branch = control_dir.open_branch() #get the new branch!
5582
5232
            branch.nick = to_branch.nick
5583
5233
        note('Switched to branch: %s',
5584
5234
            urlutils.unescape_for_display(to_branch.base, 'utf-8'))
5585
5235
 
5586
 
    def _get_branch_location(self, control_dir):
5587
 
        """Return location of branch for this control dir."""
 
5236
 
 
5237
class cmd_guess_renames(Command):
 
5238
    """Guess which files have been have been renamed, based on their content.
 
5239
 
 
5240
    Only versioned files which have been deleted are candidates for rename
 
5241
    detection, and renames to ignored files will not be detected.
 
5242
    """
 
5243
 
 
5244
    def run(self):
 
5245
        work_tree, file_list = tree_files(None, default_branch='.')
 
5246
        work_tree.lock_write()
5588
5247
        try:
5589
 
            this_branch = control_dir.open_branch()
5590
 
            # This may be a heavy checkout, where we want the master branch
5591
 
            master_location = this_branch.get_bound_location()
5592
 
            if master_location is not None:
5593
 
                return master_location
5594
 
            # If not, use a local sibling
5595
 
            return this_branch.base
5596
 
        except errors.NotBranchError:
5597
 
            format = control_dir.find_branch_format()
5598
 
            if getattr(format, 'get_reference', None) is not None:
5599
 
                return format.get_reference(control_dir)
5600
 
            else:
5601
 
                return control_dir.root_transport.base
 
5248
            rename_map.RenameMap.guess_renames(work_tree)
 
5249
        finally:
 
5250
            work_tree.unlock()
5602
5251
 
5603
5252
 
5604
5253
class cmd_view(Command):
5605
 
    __doc__ = """Manage filtered views.
 
5254
    """Manage filtered views.
5606
5255
 
5607
5256
    Views provide a mask over the tree so that users can focus on
5608
5257
    a subset of a tree when doing their work. After creating a view,
5756
5405
 
5757
5406
 
5758
5407
class cmd_hooks(Command):
5759
 
    __doc__ = """Show hooks."""
 
5408
    """Show hooks."""
5760
5409
 
5761
5410
    hidden = True
5762
5411
 
5775
5424
                    self.outf.write("    <no hooks installed>\n")
5776
5425
 
5777
5426
 
5778
 
class cmd_remove_branch(Command):
5779
 
    __doc__ = """Remove a branch.
5780
 
 
5781
 
    This will remove the branch from the specified location but 
5782
 
    will keep any working tree or repository in place.
5783
 
 
5784
 
    :Examples:
5785
 
 
5786
 
      Remove the branch at repo/trunk::
5787
 
 
5788
 
        bzr remove-branch repo/trunk
5789
 
 
5790
 
    """
5791
 
 
5792
 
    takes_args = ["location?"]
5793
 
 
5794
 
    aliases = ["rmbranch"]
5795
 
 
5796
 
    def run(self, location=None):
5797
 
        if location is None:
5798
 
            location = "."
5799
 
        branch = Branch.open_containing(location)[0]
5800
 
        branch.bzrdir.destroy_branch()
5801
 
        
5802
 
 
5803
5427
class cmd_shelve(Command):
5804
 
    __doc__ = """Temporarily set aside some changes from the current tree.
 
5428
    """Temporarily set aside some changes from the current tree.
5805
5429
 
5806
5430
    Shelve allows you to temporarily put changes you've made "on the shelf",
5807
5431
    ie. out of the way, until a later time when you can bring them back from
5849
5473
        if writer is None:
5850
5474
            writer = bzrlib.option.diff_writer_registry.get()
5851
5475
        try:
5852
 
            shelver = Shelver.from_args(writer(sys.stdout), revision, all,
5853
 
                file_list, message, destroy=destroy)
5854
 
            try:
5855
 
                shelver.run()
5856
 
            finally:
5857
 
                shelver.finalize()
 
5476
            Shelver.from_args(writer(sys.stdout), revision, all, file_list,
 
5477
                              message, destroy=destroy).run()
5858
5478
        except errors.UserAbort:
5859
5479
            return 0
5860
5480
 
5861
5481
    def run_for_list(self):
5862
5482
        tree = WorkingTree.open_containing('.')[0]
5863
 
        self.add_cleanup(tree.lock_read().unlock)
5864
 
        manager = tree.get_shelf_manager()
5865
 
        shelves = manager.active_shelves()
5866
 
        if len(shelves) == 0:
5867
 
            note('No shelved changes.')
5868
 
            return 0
5869
 
        for shelf_id in reversed(shelves):
5870
 
            message = manager.get_metadata(shelf_id).get('message')
5871
 
            if message is None:
5872
 
                message = '<no message>'
5873
 
            self.outf.write('%3d: %s\n' % (shelf_id, message))
5874
 
        return 1
 
5483
        tree.lock_read()
 
5484
        try:
 
5485
            manager = tree.get_shelf_manager()
 
5486
            shelves = manager.active_shelves()
 
5487
            if len(shelves) == 0:
 
5488
                note('No shelved changes.')
 
5489
                return 0
 
5490
            for shelf_id in reversed(shelves):
 
5491
                message = manager.get_metadata(shelf_id).get('message')
 
5492
                if message is None:
 
5493
                    message = '<no message>'
 
5494
                self.outf.write('%3d: %s\n' % (shelf_id, message))
 
5495
            return 1
 
5496
        finally:
 
5497
            tree.unlock()
5875
5498
 
5876
5499
 
5877
5500
class cmd_unshelve(Command):
5878
 
    __doc__ = """Restore shelved changes.
 
5501
    """Restore shelved changes.
5879
5502
 
5880
5503
    By default, the most recently shelved changes are restored. However if you
5881
5504
    specify a shelf by id those changes will be restored instead.  This works
5889
5512
            enum_switch=False, value_switches=True,
5890
5513
            apply="Apply changes and remove from the shelf.",
5891
5514
            dry_run="Show changes, but do not apply or remove them.",
5892
 
            preview="Instead of unshelving the changes, show the diff that "
5893
 
                    "would result from unshelving.",
5894
 
            delete_only="Delete changes without applying them.",
5895
 
            keep="Apply changes but don't delete them.",
 
5515
            delete_only="Delete changes without applying them."
5896
5516
        )
5897
5517
    ]
5898
5518
    _see_also = ['shelve']
5899
5519
 
5900
5520
    def run(self, shelf_id=None, action='apply'):
5901
5521
        from bzrlib.shelf_ui import Unshelver
5902
 
        unshelver = Unshelver.from_args(shelf_id, action)
5903
 
        try:
5904
 
            unshelver.run()
5905
 
        finally:
5906
 
            unshelver.tree.unlock()
 
5522
        Unshelver.from_args(shelf_id, action).run()
5907
5523
 
5908
5524
 
5909
5525
class cmd_clean_tree(Command):
5910
 
    __doc__ = """Remove unwanted files from working tree.
 
5526
    """Remove unwanted files from working tree.
5911
5527
 
5912
5528
    By default, only unknown files, not ignored files, are deleted.  Versioned
5913
5529
    files are never deleted.
5940
5556
                   dry_run=dry_run, no_prompt=force)
5941
5557
 
5942
5558
 
5943
 
class cmd_reference(Command):
5944
 
    __doc__ = """list, view and set branch locations for nested trees.
5945
 
 
5946
 
    If no arguments are provided, lists the branch locations for nested trees.
5947
 
    If one argument is provided, display the branch location for that tree.
5948
 
    If two arguments are provided, set the branch location for that tree.
5949
 
    """
5950
 
 
5951
 
    hidden = True
5952
 
 
5953
 
    takes_args = ['path?', 'location?']
5954
 
 
5955
 
    def run(self, path=None, location=None):
5956
 
        branchdir = '.'
5957
 
        if path is not None:
5958
 
            branchdir = path
5959
 
        tree, branch, relpath =(
5960
 
            bzrdir.BzrDir.open_containing_tree_or_branch(branchdir))
5961
 
        if path is not None:
5962
 
            path = relpath
5963
 
        if tree is None:
5964
 
            tree = branch.basis_tree()
5965
 
        if path is None:
5966
 
            info = branch._get_all_reference_info().iteritems()
5967
 
            self._display_reference_info(tree, branch, info)
 
5559
def _create_prefix(cur_transport):
 
5560
    needed = [cur_transport]
 
5561
    # Recurse upwards until we can create a directory successfully
 
5562
    while True:
 
5563
        new_transport = cur_transport.clone('..')
 
5564
        if new_transport.base == cur_transport.base:
 
5565
            raise errors.BzrCommandError(
 
5566
                "Failed to create path prefix for %s."
 
5567
                % cur_transport.base)
 
5568
        try:
 
5569
            new_transport.mkdir('.')
 
5570
        except errors.NoSuchFile:
 
5571
            needed.append(new_transport)
 
5572
            cur_transport = new_transport
5968
5573
        else:
5969
 
            file_id = tree.path2id(path)
5970
 
            if file_id is None:
5971
 
                raise errors.NotVersionedError(path)
5972
 
            if location is None:
5973
 
                info = [(file_id, branch.get_reference_info(file_id))]
5974
 
                self._display_reference_info(tree, branch, info)
5975
 
            else:
5976
 
                branch.set_reference_info(file_id, path, location)
5977
 
 
5978
 
    def _display_reference_info(self, tree, branch, info):
5979
 
        ref_list = []
5980
 
        for file_id, (path, location) in info:
5981
 
            try:
5982
 
                path = tree.id2path(file_id)
5983
 
            except errors.NoSuchId:
5984
 
                pass
5985
 
            ref_list.append((path, location))
5986
 
        for path, location in sorted(ref_list):
5987
 
            self.outf.write('%s %s\n' % (path, location))
5988
 
 
5989
 
 
5990
 
def _register_lazy_builtins():
5991
 
    # register lazy builtins from other modules; called at startup and should
5992
 
    # be only called once.
5993
 
    for (name, aliases, module_name) in [
5994
 
        ('cmd_bundle_info', [], 'bzrlib.bundle.commands'),
5995
 
        ('cmd_dpush', [], 'bzrlib.foreign'),
5996
 
        ('cmd_version_info', [], 'bzrlib.cmd_version_info'),
5997
 
        ('cmd_resolve', ['resolved'], 'bzrlib.conflicts'),
5998
 
        ('cmd_conflicts', [], 'bzrlib.conflicts'),
5999
 
        ('cmd_sign_my_commits', [], 'bzrlib.sign_my_commits'),
6000
 
        ]:
6001
 
        builtin_command_registry.register_lazy(name, aliases, module_name)
 
5574
            break
 
5575
    # Now we only need to create child directories
 
5576
    while needed:
 
5577
        cur_transport = needed.pop()
 
5578
        cur_transport.ensure_base()
 
5579
 
 
5580
 
 
5581
# these get imported and then picked up by the scan for cmd_*
 
5582
# TODO: Some more consistent way to split command definitions across files;
 
5583
# we do need to load at least some information about them to know of
 
5584
# aliases.  ideally we would avoid loading the implementation until the
 
5585
# details were needed.
 
5586
from bzrlib.cmd_version_info import cmd_version_info
 
5587
from bzrlib.conflicts import cmd_resolve, cmd_conflicts, restore
 
5588
from bzrlib.bundle.commands import (
 
5589
    cmd_bundle_info,
 
5590
    )
 
5591
from bzrlib.sign_my_commits import cmd_sign_my_commits
 
5592
from bzrlib.weave_commands import cmd_versionedfile_list, \
 
5593
        cmd_weave_plan_merge, cmd_weave_merge_text