/brz/remove-bazaar

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

« back to all changes in this revision

Viewing changes to bzrlib/builtins.py

  • Committer: Sabin Iacob
  • Date: 2009-03-23 14:59:43 UTC
  • mto: (4189.1.1 integration)
  • mto: This revision was merged to the branch mainline in revision 4193.
  • Revision ID: iacobs@m0n5t3r.info-20090323145943-3s3p1px5q1rkh2e5
update FSF mailing address

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