/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: James Westby
  • Date: 2009-03-12 06:04:54 UTC
  • mto: This revision was merged to the branch mainline in revision 4139.
  • Revision ID: james.westby@canonical.com-20090312060454-f04pmpufns32zyk6
Move the shelve docs from bzrtools to the main help.

Also change them to document the new "shelve" rather than the old one.

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