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