/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: Jelmer Vernooij
  • Date: 2009-04-03 21:50:40 UTC
  • mto: This revision was merged to the branch mainline in revision 4253.
  • Revision ID: jelmer@samba.org-20090403215040-lz70cjc4i8bfg9xd
Review from Aaron: 
- move generic serializer tests to bzrlib.tests.test_serializer.
- fix some formatting
- add NEWS item

Show diffs side-by-side

added added

removed removed

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