~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/builtins.py

  • Committer: Johan Walles
  • Date: 2009-05-07 05:08:46 UTC
  • mfrom: (4342 +trunk)
  • mto: This revision was merged to the branch mainline in revision 4343.
  • Revision ID: johan.walles@gmail.com-20090507050846-nkwvcyauf1eh653q
MergeĀ fromĀ upstream.

Show diffs side-by-side

added added

removed removed

Lines of Context:
1
 
# Copyright (C) 2005-2010 Canonical Ltd
 
1
# Copyright (C) 2004, 2005, 2006, 2007, 2008, 2009 Canonical Ltd
2
2
#
3
3
# This program is free software; you can redistribute it and/or modify
4
4
# it under the terms of the GNU General Public License as published by
31
31
    bundle,
32
32
    btree_index,
33
33
    bzrdir,
34
 
    directory_service,
35
34
    delta,
36
35
    config,
37
36
    errors,
44
43
    reconfigure,
45
44
    rename_map,
46
45
    revision as _mod_revision,
47
 
    static_tuple,
48
46
    symbol_versioning,
49
 
    timestamp,
50
47
    transport,
 
48
    tree as _mod_tree,
51
49
    ui,
52
50
    urlutils,
53
51
    views,
54
52
    )
55
53
from bzrlib.branch import Branch
56
54
from bzrlib.conflicts import ConflictList
57
 
from bzrlib.transport import memory
58
55
from bzrlib.revisionspec import RevisionSpec, RevisionInfo
59
56
from bzrlib.smtp_connection import SMTPConnection
60
57
from bzrlib.workingtree import WorkingTree
61
58
""")
62
59
 
63
 
from bzrlib.commands import (
64
 
    Command,
65
 
    builtin_command_registry,
66
 
    display_command,
67
 
    )
 
60
from bzrlib.commands import Command, display_command
68
61
from bzrlib.option import (
69
62
    ListOption,
70
63
    Option,
128
121
 
129
122
 
130
123
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
124
    if branch is None:
141
125
        branch = tree.branch
142
126
    if revisions is None:
239
223
# opens the branch?)
240
224
 
241
225
class cmd_status(Command):
242
 
    __doc__ = """Display status summary.
 
226
    """Display status summary.
243
227
 
244
228
    This reports on versioned and unknown files, reporting them
245
229
    grouped by state.  Possible states are:
265
249
    unknown
266
250
        Not versioned and not matching an ignore pattern.
267
251
 
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
252
    To see ignored files use 'bzr ignored'.  For details on the
273
253
    changes to file texts, use 'bzr diff'.
274
254
 
332
312
 
333
313
 
334
314
class cmd_cat_revision(Command):
335
 
    __doc__ = """Write out metadata for a revision.
 
315
    """Write out metadata for a revision.
336
316
 
337
317
    The revision to print can either be specified by a specific
338
318
    revision identifier, or you can use --revision.
344
324
    # cat-revision is more for frontends so should be exact
345
325
    encoding = 'strict'
346
326
 
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
327
    @display_command
356
328
    def run(self, revision_id=None, revision=None):
357
329
        if revision_id is not None and revision is not None:
362
334
                                         ' --revision or a revision_id')
363
335
        b = WorkingTree.open_containing(u'.')[0].branch
364
336
 
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')
 
337
        # TODO: jam 20060112 should cat-revision always output utf-8?
 
338
        if revision_id is not None:
 
339
            revision_id = osutils.safe_revision_id(revision_id, warn=False)
 
340
            try:
 
341
                self.outf.write(b.repository.get_revision_xml(revision_id).decode('utf-8'))
 
342
            except errors.NoSuchRevision:
 
343
                msg = "The repository %s contains no revision %s." % (b.repository.base,
 
344
                    revision_id)
 
345
                raise errors.BzrCommandError(msg)
 
346
        elif revision is not None:
 
347
            for rev in revision:
 
348
                if rev is None:
 
349
                    raise errors.BzrCommandError('You cannot specify a NULL'
 
350
                                                 ' revision.')
 
351
                rev_id = rev.as_revision_id(b)
 
352
                self.outf.write(b.repository.get_revision_xml(rev_id).decode('utf-8'))
369
353
 
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
354
 
392
355
class cmd_dump_btree(Command):
393
 
    __doc__ = """Dump the contents of a btree index file to stdout.
 
356
    """Dump the contents of a btree index file to stdout.
394
357
 
395
358
    PATH is a btree index file, it can be any URL. This includes things like
396
359
    .bzr/repository/pack-names, or .bzr/repository/indices/a34b3a...ca4a4.iix
460
423
        for node in bt.iter_all_entries():
461
424
            # Node is made up of:
462
425
            # (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,))
 
426
            self.outf.write('%s\n' % (node[1:],))
471
427
 
472
428
 
473
429
class cmd_remove_tree(Command):
474
 
    __doc__ = """Remove the working tree from a given branch/checkout.
 
430
    """Remove the working tree from a given branch/checkout.
475
431
 
476
432
    Since a lightweight checkout is little more than a working tree
477
433
    this will refuse to run against one.
479
435
    To re-create the working tree, use "bzr checkout".
480
436
    """
481
437
    _see_also = ['checkout', 'working-trees']
482
 
    takes_args = ['location*']
 
438
    takes_args = ['location?']
483
439
    takes_options = [
484
440
        Option('force',
485
441
               help='Remove the working tree even if it has '
486
442
                    'uncommitted changes.'),
487
443
        ]
488
444
 
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()
 
445
    def run(self, location='.', force=False):
 
446
        d = bzrdir.BzrDir.open(location)
 
447
 
 
448
        try:
 
449
            working = d.open_workingtree()
 
450
        except errors.NoWorkingTree:
 
451
            raise errors.BzrCommandError("No working tree to remove")
 
452
        except errors.NotLocalUrl:
 
453
            raise errors.BzrCommandError("You cannot remove the working tree of a "
 
454
                                         "remote path")
 
455
        if not force:
 
456
            changes = working.changes_from(working.basis_tree())
 
457
            if changes.has_changed():
 
458
                raise errors.UncommittedChanges(working)
 
459
 
 
460
        working_path = working.bzrdir.root_transport.base
 
461
        branch_path = working.branch.bzrdir.root_transport.base
 
462
        if working_path != branch_path:
 
463
            raise errors.BzrCommandError("You cannot remove the working tree from "
 
464
                                         "a lightweight checkout")
 
465
 
 
466
        d.destroy_workingtree()
512
467
 
513
468
 
514
469
class cmd_revno(Command):
515
 
    __doc__ = """Show current revision number.
 
470
    """Show current revision number.
516
471
 
517
472
    This is equal to the number of revisions on this branch.
518
473
    """
519
474
 
520
475
    _see_also = ['info']
521
476
    takes_args = ['location?']
522
 
    takes_options = [
523
 
        Option('tree', help='Show revno of working tree'),
524
 
        ]
525
477
 
526
478
    @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')
 
479
    def run(self, location=u'.'):
 
480
        self.outf.write(str(Branch.open_containing(location)[0].revno()))
 
481
        self.outf.write('\n')
546
482
 
547
483
 
548
484
class cmd_revision_info(Command):
549
 
    __doc__ = """Show revision number and revision id for a given revision identifier.
 
485
    """Show revision number and revision id for a given revision identifier.
550
486
    """
551
487
    hidden = True
552
488
    takes_args = ['revision_info*']
558
494
            short_name='d',
559
495
            type=unicode,
560
496
            ),
561
 
        Option('tree', help='Show revno of working tree'),
562
497
        ]
563
498
 
564
499
    @display_command
565
 
    def run(self, revision=None, directory=u'.', tree=False,
566
 
            revision_info_list=[]):
 
500
    def run(self, revision=None, directory=u'.', revision_info_list=[]):
567
501
 
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 = []
 
502
        revs = []
577
503
        if revision is not None:
578
 
            revision_ids.extend(rev.as_revision_id(b) for rev in revision)
 
504
            revs.extend(revision)
579
505
        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:
 
506
            for rev in revision_info_list:
 
507
                revs.append(RevisionSpec.from_string(rev))
 
508
 
 
509
        b = Branch.open_containing(directory)[0]
 
510
 
 
511
        if len(revs) == 0:
 
512
            revs.append(RevisionSpec.from_string('-1'))
 
513
 
 
514
        for rev in revs:
 
515
            revision_id = rev.as_revision_id(b)
595
516
            try:
596
 
                dotted_revno = b.revision_id_to_dotted_revno(revision_id)
597
 
                revno = '.'.join(str(i) for i in dotted_revno)
 
517
                revno = '%4d' % (b.revision_id_to_revno(revision_id))
598
518
            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]))
 
519
                dotted_map = b.get_revision_id_to_revno_map()
 
520
                revno = '.'.join(str(i) for i in dotted_map[revision_id])
 
521
            print '%s %s' % (revno, revision_id)
606
522
 
607
523
 
608
524
class cmd_add(Command):
609
 
    __doc__ = """Add specified files or directories.
 
525
    """Add specified files or directories.
610
526
 
611
527
    In non-recursive mode, all the named items are added, regardless
612
528
    of whether they were previously ignored.  A warning is given if
638
554
    branches that will be merged later (without showing the two different
639
555
    adds as a conflict). It is also useful when merging another project
640
556
    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
557
    """
645
558
    takes_args = ['file*']
646
559
    takes_options = [
654
567
               help='Lookup file ids from this tree.'),
655
568
        ]
656
569
    encoding_type = 'replace'
657
 
    _see_also = ['remove', 'ignore']
 
570
    _see_also = ['remove']
658
571
 
659
572
    def run(self, file_list, no_recurse=False, dry_run=False, verbose=False,
660
573
            file_ids_from=None):
677
590
                should_print=(not is_quiet()))
678
591
 
679
592
        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()
 
593
            base_tree.lock_read()
 
594
        try:
 
595
            file_list = self._maybe_expand_globs(file_list)
 
596
            tree, file_list = tree_files_for_add(file_list)
 
597
            added, ignored = tree.smart_add(file_list, not
 
598
                no_recurse, action=action, save=not dry_run)
 
599
        finally:
 
600
            if base_tree is not None:
 
601
                base_tree.unlock()
685
602
        if len(ignored) > 0:
686
603
            if verbose:
687
604
                for glob in sorted(ignored.keys()):
688
605
                    for path in ignored[glob]:
689
606
                        self.outf.write("ignored %s matching \"%s\"\n"
690
607
                                        % (path, glob))
 
608
            else:
 
609
                match_len = 0
 
610
                for glob, paths in ignored.items():
 
611
                    match_len += len(paths)
 
612
                self.outf.write("ignored %d file(s).\n" % match_len)
 
613
            self.outf.write("If you wish to add some of these files,"
 
614
                            " please add them by name.\n")
691
615
 
692
616
 
693
617
class cmd_mkdir(Command):
694
 
    __doc__ = """Create a new versioned directory.
 
618
    """Create a new versioned directory.
695
619
 
696
620
    This is equivalent to creating the directory and then adding it.
697
621
    """
701
625
 
702
626
    def run(self, dir_list):
703
627
        for d in dir_list:
 
628
            os.mkdir(d)
704
629
            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)
 
630
            wt.add([dd])
 
631
            self.outf.write('added %s\n' % d)
713
632
 
714
633
 
715
634
class cmd_relpath(Command):
716
 
    __doc__ = """Show path of a file relative to root"""
 
635
    """Show path of a file relative to root"""
717
636
 
718
637
    takes_args = ['filename']
719
638
    hidden = True
728
647
 
729
648
 
730
649
class cmd_inventory(Command):
731
 
    __doc__ = """Show inventory of the current working copy or a revision.
 
650
    """Show inventory of the current working copy or a revision.
732
651
 
733
652
    It is possible to limit the output to a particular entry
734
653
    type using the --kind option.  For example: --kind file.
755
674
 
756
675
        revision = _get_one_revision('inventory', revision)
757
676
        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()
 
677
        work_tree.lock_read()
 
678
        try:
 
679
            if revision is not None:
 
680
                tree = revision.as_tree(work_tree.branch)
 
681
 
 
682
                extra_trees = [work_tree]
 
683
                tree.lock_read()
 
684
            else:
 
685
                tree = work_tree
 
686
                extra_trees = []
 
687
 
 
688
            if file_list is not None:
 
689
                file_ids = tree.paths2ids(file_list, trees=extra_trees,
 
690
                                          require_versioned=True)
 
691
                # find_ids_across_trees may include some paths that don't
 
692
                # exist in 'tree'.
 
693
                entries = sorted((tree.id2path(file_id), tree.inventory[file_id])
 
694
                                 for file_id in file_ids if file_id in tree)
 
695
            else:
 
696
                entries = tree.inventory.entries()
 
697
        finally:
 
698
            tree.unlock()
 
699
            if tree is not work_tree:
 
700
                work_tree.unlock()
 
701
 
779
702
        for path, entry in entries:
780
703
            if kind and kind != entry.kind:
781
704
                continue
787
710
 
788
711
 
789
712
class cmd_mv(Command):
790
 
    __doc__ = """Move or rename a file.
 
713
    """Move or rename a file.
791
714
 
792
715
    :Usage:
793
716
        bzr mv OLDNAME NEWNAME
826
749
        if len(names_list) < 2:
827
750
            raise errors.BzrCommandError("missing file argument")
828
751
        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)
 
752
        tree.lock_write()
 
753
        try:
 
754
            self._run(tree, names_list, rel_names, after)
 
755
        finally:
 
756
            tree.unlock()
831
757
 
832
758
    def run_auto(self, names_list, after, dry_run):
833
759
        if names_list is not None and len(names_list) > 1:
837
763
            raise errors.BzrCommandError('--after cannot be specified with'
838
764
                                         ' --auto.')
839
765
        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)
 
766
        work_tree.lock_write()
 
767
        try:
 
768
            rename_map.RenameMap.guess_renames(work_tree, dry_run)
 
769
        finally:
 
770
            work_tree.unlock()
842
771
 
843
772
    def _run(self, tree, names_list, rel_names, after):
844
773
        into_existing = osutils.isdir(names_list[-1])
865
794
            # All entries reference existing inventory items, so fix them up
866
795
            # for cicp file-systems.
867
796
            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))
 
797
            for pair in tree.move(rel_names[:-1], rel_names[-1], after=after):
 
798
                self.outf.write("%s => %s\n" % pair)
871
799
        else:
872
800
            if len(names_list) != 2:
873
801
                raise errors.BzrCommandError('to mv multiple files the'
917
845
            dest = osutils.pathjoin(dest_parent, dest_tail)
918
846
            mutter("attempting to move %s => %s", src, dest)
919
847
            tree.rename_one(src, dest, after=after)
920
 
            if not is_quiet():
921
 
                self.outf.write("%s => %s\n" % (src, dest))
 
848
            self.outf.write("%s => %s\n" % (src, dest))
922
849
 
923
850
 
924
851
class cmd_pull(Command):
925
 
    __doc__ = """Turn this branch into a mirror of another branch.
 
852
    """Turn this branch into a mirror of another branch.
926
853
 
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.
 
854
    This command only works on branches that have not diverged.  Branches are
 
855
    considered diverged if the destination branch's most recent commit is one
 
856
    that has not been merged (directly or indirectly) into the parent.
931
857
 
932
858
    If branches have diverged, you can use 'bzr merge' to integrate the changes
933
859
    from one into the other.  Once one branch has merged, the other should
934
860
    be able to pull it again.
935
861
 
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.
 
862
    If you want to forget your local changes and just update your branch to
 
863
    match the remote one, use pull --overwrite.
939
864
 
940
865
    If there is no default location set, the first pull will set it.  After
941
866
    that, you can omit the location to use the default.  To change the
977
902
        try:
978
903
            tree_to = WorkingTree.open_containing(directory)[0]
979
904
            branch_to = tree_to.branch
980
 
            self.add_cleanup(tree_to.lock_write().unlock)
981
905
        except errors.NoWorkingTree:
982
906
            tree_to = None
983
907
            branch_to = Branch.open_containing(directory)[0]
984
 
            self.add_cleanup(branch_to.lock_write().unlock)
985
 
 
 
908
        
986
909
        if local and not branch_to.get_bound_location():
987
910
            raise errors.LocalRequiresBoundBranch()
988
911
 
1018
941
        else:
1019
942
            branch_from = Branch.open(location,
1020
943
                possible_transports=possible_transports)
1021
 
            self.add_cleanup(branch_from.lock_read().unlock)
1022
944
 
1023
945
            if branch_to.get_parent() is None or remember:
1024
946
                branch_to.set_parent(branch_from.base)
1026
948
        if revision is not None:
1027
949
            revision_id = revision.as_revision_id(branch_from)
1028
950
 
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)
 
951
        branch_to.lock_write()
 
952
        try:
 
953
            if tree_to is not None:
 
954
                view_info = _get_view_info_for_change_reporter(tree_to)
 
955
                change_reporter = delta._ChangeReporter(
 
956
                    unversioned_filter=tree_to.is_ignored, view_info=view_info)
 
957
                result = tree_to.pull(branch_from, overwrite, revision_id,
 
958
                                      change_reporter,
 
959
                                      possible_transports=possible_transports,
 
960
                                      local=local)
 
961
            else:
 
962
                result = branch_to.pull(branch_from, overwrite, revision_id,
 
963
                                      local=local)
1040
964
 
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)
 
965
            result.report(self.outf)
 
966
            if verbose and result.old_revid != result.new_revid:
 
967
                log.show_branch_change(branch_to, self.outf, result.old_revno,
 
968
                                       result.old_revid)
 
969
        finally:
 
970
            branch_to.unlock()
1046
971
 
1047
972
 
1048
973
class cmd_push(Command):
1049
 
    __doc__ = """Update a mirror of this branch.
 
974
    """Update a mirror of this branch.
1050
975
 
1051
976
    The target branch will not have its working tree populated because this
1052
977
    is both expensive, and is not supported on remote file systems.
1095
1020
                'for the commit history. Only the work not present in the '
1096
1021
                'referenced branch is included in the branch created.',
1097
1022
            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
1023
        ]
1102
1024
    takes_args = ['location?']
1103
1025
    encoding_type = 'replace'
1105
1027
    def run(self, location=None, remember=False, overwrite=False,
1106
1028
        create_prefix=False, verbose=False, revision=None,
1107
1029
        use_existing_dir=False, directory=None, stacked_on=None,
1108
 
        stacked=False, strict=None):
 
1030
        stacked=False):
1109
1031
        from bzrlib.push import _show_push_branch
1110
1032
 
 
1033
        # Get the source branch and revision_id
1111
1034
        if directory is None:
1112
1035
            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
 
1036
        br_from = Branch.open_containing(directory)[0]
1117
1037
        revision = _get_one_revision('push', revision)
1118
1038
        if revision is not None:
1119
1039
            revision_id = revision.in_history(br_from).rev_id
1120
1040
        else:
1121
1041
            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.')
 
1042
 
1127
1043
        # Get the stacked_on branch, if any
1128
1044
        if stacked_on is not None:
1129
1045
            stacked_on = urlutils.normalize_url(stacked_on)
1161
1077
 
1162
1078
 
1163
1079
class cmd_branch(Command):
1164
 
    __doc__ = """Create a new branch that is a copy of an existing branch.
 
1080
    """Create a new copy of a branch.
1165
1081
 
1166
1082
    If the TO_LOCATION is omitted, the last component of the FROM_LOCATION will
1167
1083
    be used.  In other words, "branch ../foo/bar" will attempt to create ./bar.
1180
1096
        help='Hard-link working tree files where possible.'),
1181
1097
        Option('no-tree',
1182
1098
            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
1099
        Option('stacked',
1187
1100
            help='Create a stacked branch referring to the source branch. '
1188
1101
                'The new branch will depend on the availability of the source '
1189
1102
                'branch for all operations.'),
1190
1103
        Option('standalone',
1191
1104
               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
1105
        ]
1200
1106
    aliases = ['get', 'clone']
1201
1107
 
1202
1108
    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
 
1109
            hardlink=False, stacked=False, standalone=False, no_tree=False):
1206
1110
        from bzrlib.tag import _merge_tags_if_possible
 
1111
 
1207
1112
        accelerator_tree, br_from = bzrdir.BzrDir.open_tree_or_branch(
1208
1113
            from_location)
1209
1114
        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)
 
1115
        br_from.lock_read()
1221
1116
        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)
 
1117
            if revision is not None:
 
1118
                revision_id = revision.as_revision_id(br_from)
1227
1119
            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'))
 
1120
                # FIXME - wt.last_revision, fallback to branch, fall back to
 
1121
                # None or perhaps NULL_REVISION to mean copy nothing
 
1122
                # RBC 20060209
 
1123
                revision_id = br_from.last_revision()
 
1124
            if to_location is None:
 
1125
                to_location = urlutils.derive_to_location(from_location)
 
1126
            to_transport = transport.get_transport(to_location)
 
1127
            try:
 
1128
                to_transport.mkdir('.')
 
1129
            except errors.FileExists:
 
1130
                raise errors.BzrCommandError('Target directory "%s" already'
 
1131
                                             ' exists.' % to_location)
 
1132
            except errors.NoSuchFile:
 
1133
                raise errors.BzrCommandError('Parent of "%s" does not exist.'
 
1134
                                             % to_location)
 
1135
            try:
 
1136
                # preserve whatever source format we have.
 
1137
                dir = br_from.bzrdir.sprout(to_transport.base, revision_id,
 
1138
                                            possible_transports=[to_transport],
 
1139
                                            accelerator_tree=accelerator_tree,
 
1140
                                            hardlink=hardlink, stacked=stacked,
 
1141
                                            force_new_repo=standalone,
 
1142
                                            create_tree_if_local=not no_tree,
 
1143
                                            source_branch=br_from)
 
1144
                branch = dir.open_branch()
 
1145
            except errors.NoSuchRevision:
 
1146
                to_transport.delete_tree('.')
 
1147
                msg = "The branch %s has no revision %s." % (from_location,
 
1148
                    revision)
 
1149
                raise errors.BzrCommandError(msg)
 
1150
            _merge_tags_if_possible(br_from, branch)
 
1151
            # If the source branch is stacked, the new branch may
 
1152
            # be stacked whether we asked for that explicitly or not.
 
1153
            # We therefore need a try/except here and not just 'if stacked:'
 
1154
            try:
 
1155
                note('Created new stacked branch referring to %s.' %
 
1156
                    branch.get_stacked_on_url())
 
1157
            except (errors.NotStacked, errors.UnstackableBranchFormat,
 
1158
                errors.UnstackableRepositoryFormat), e:
 
1159
                note('Branched %d revision(s).' % branch.revno())
 
1160
        finally:
 
1161
            br_from.unlock()
1273
1162
 
1274
1163
 
1275
1164
class cmd_checkout(Command):
1276
 
    __doc__ = """Create a new checkout of an existing branch.
 
1165
    """Create a new checkout of an existing branch.
1277
1166
 
1278
1167
    If BRANCH_LOCATION is omitted, checkout will reconstitute a working tree for
1279
1168
    the branch found in '.'. This is useful if you have removed the working tree
1342
1231
 
1343
1232
 
1344
1233
class cmd_renames(Command):
1345
 
    __doc__ = """Show list of renamed files.
 
1234
    """Show list of renamed files.
1346
1235
    """
1347
1236
    # TODO: Option to show renames between two historical versions.
1348
1237
 
1353
1242
    @display_command
1354
1243
    def run(self, dir=u'.'):
1355
1244
        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))
 
1245
        tree.lock_read()
 
1246
        try:
 
1247
            new_inv = tree.inventory
 
1248
            old_tree = tree.basis_tree()
 
1249
            old_tree.lock_read()
 
1250
            try:
 
1251
                old_inv = old_tree.inventory
 
1252
                renames = []
 
1253
                iterator = tree.iter_changes(old_tree, include_unchanged=True)
 
1254
                for f, paths, c, v, p, n, k, e in iterator:
 
1255
                    if paths[0] == paths[1]:
 
1256
                        continue
 
1257
                    if None in (paths):
 
1258
                        continue
 
1259
                    renames.append(paths)
 
1260
                renames.sort()
 
1261
                for old_name, new_name in renames:
 
1262
                    self.outf.write("%s => %s\n" % (old_name, new_name))
 
1263
            finally:
 
1264
                old_tree.unlock()
 
1265
        finally:
 
1266
            tree.unlock()
1372
1267
 
1373
1268
 
1374
1269
class cmd_update(Command):
1375
 
    __doc__ = """Update a tree to have the latest code committed to its branch.
 
1270
    """Update a tree to have the latest code committed to its branch.
1376
1271
 
1377
1272
    This will perform a merge into the working tree, and may generate
1378
1273
    conflicts. If you have any local changes, you will still
1380
1275
 
1381
1276
    If you want to discard your local changes, you can just do a
1382
1277
    '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
1278
    """
1387
1279
 
1388
1280
    _see_also = ['pull', 'working-trees', 'status-flags']
1389
1281
    takes_args = ['dir?']
1390
 
    takes_options = ['revision']
1391
1282
    aliases = ['up']
1392
1283
 
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")
 
1284
    def run(self, dir='.'):
1397
1285
        tree = WorkingTree.open_containing(dir)[0]
1398
 
        branch = tree.branch
1399
1286
        possible_transports = []
1400
 
        master = branch.get_master_branch(
 
1287
        master = tree.branch.get_master_branch(
1401
1288
            possible_transports=possible_transports)
1402
1289
        if master is not None:
1403
 
            branch_location = master.base
1404
1290
            tree.lock_write()
1405
1291
        else:
1406
 
            branch_location = tree.branch.base
1407
1292
            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
1293
        try:
 
1294
            existing_pending_merges = tree.get_parent_ids()[1:]
 
1295
            last_rev = _mod_revision.ensure_null(tree.last_revision())
 
1296
            if last_rev == _mod_revision.ensure_null(
 
1297
                tree.branch.last_revision()):
 
1298
                # may be up to date, check master too.
 
1299
                if master is None or last_rev == _mod_revision.ensure_null(
 
1300
                    master.last_revision()):
 
1301
                    revno = tree.branch.revision_id_to_revno(last_rev)
 
1302
                    note("Tree is up to date at revision %d." % (revno,))
 
1303
                    return 0
 
1304
            view_info = _get_view_info_for_change_reporter(tree)
1435
1305
            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
 
1306
                delta._ChangeReporter(unversioned_filter=tree.is_ignored,
 
1307
                view_info=view_info), possible_transports=possible_transports)
 
1308
            revno = tree.branch.revision_id_to_revno(
 
1309
                _mod_revision.ensure_null(tree.last_revision()))
 
1310
            note('Updated to revision %d.' % (revno,))
 
1311
            if tree.get_parent_ids()[1:] != existing_pending_merges:
 
1312
                note('Your local commits will now show as pending merges with '
 
1313
                     "'bzr status', and can be committed with 'bzr commit'.")
 
1314
            if conflicts != 0:
 
1315
                return 1
 
1316
            else:
 
1317
                return 0
 
1318
        finally:
 
1319
            tree.unlock()
1458
1320
 
1459
1321
 
1460
1322
class cmd_info(Command):
1461
 
    __doc__ = """Show information about a working tree, branch or repository.
 
1323
    """Show information about a working tree, branch or repository.
1462
1324
 
1463
1325
    This command will show all known locations and formats associated to the
1464
1326
    tree, branch or repository.
1502
1364
 
1503
1365
 
1504
1366
class cmd_remove(Command):
1505
 
    __doc__ = """Remove files or directories.
 
1367
    """Remove files or directories.
1506
1368
 
1507
1369
    This makes bzr stop tracking changes to the specified files. bzr will delete
1508
1370
    them if they can easily be recovered using revert. If no options or
1517
1379
            title='Deletion Strategy', value_switches=True, enum_switch=False,
1518
1380
            safe='Only delete files if they can be'
1519
1381
                 ' safely recovered (default).',
1520
 
            keep='Delete from bzr but leave the working copy.',
 
1382
            keep="Don't delete any files.",
1521
1383
            force='Delete all the specified files, even if they can not be '
1522
1384
                'recovered and even if they are non-empty directories.')]
1523
1385
    aliases = ['rm', 'del']
1530
1392
        if file_list is not None:
1531
1393
            file_list = [f for f in file_list]
1532
1394
 
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')
 
1395
        tree.lock_write()
 
1396
        try:
 
1397
            # Heuristics should probably all move into tree.remove_smart or
 
1398
            # some such?
 
1399
            if new:
 
1400
                added = tree.changes_from(tree.basis_tree(),
 
1401
                    specific_files=file_list).added
 
1402
                file_list = sorted([f[0] for f in added], reverse=True)
 
1403
                if len(file_list) == 0:
 
1404
                    raise errors.BzrCommandError('No matching files.')
 
1405
            elif file_list is None:
 
1406
                # missing files show up in iter_changes(basis) as
 
1407
                # versioned-with-no-kind.
 
1408
                missing = []
 
1409
                for change in tree.iter_changes(tree.basis_tree()):
 
1410
                    # Find paths in the working tree that have no kind:
 
1411
                    if change[1][1] is not None and change[6][1] is None:
 
1412
                        missing.append(change[1][1])
 
1413
                file_list = sorted(missing, reverse=True)
 
1414
                file_deletion_strategy = 'keep'
 
1415
            tree.remove(file_list, verbose=verbose, to_file=self.outf,
 
1416
                keep_files=file_deletion_strategy=='keep',
 
1417
                force=file_deletion_strategy=='force')
 
1418
        finally:
 
1419
            tree.unlock()
1555
1420
 
1556
1421
 
1557
1422
class cmd_file_id(Command):
1558
 
    __doc__ = """Print file_id of a particular file or directory.
 
1423
    """Print file_id of a particular file or directory.
1559
1424
 
1560
1425
    The file_id is assigned when the file is first added and remains the
1561
1426
    same through all revisions where the file exists, even when it is
1577
1442
 
1578
1443
 
1579
1444
class cmd_file_path(Command):
1580
 
    __doc__ = """Print path of file_ids to a file or directory.
 
1445
    """Print path of file_ids to a file or directory.
1581
1446
 
1582
1447
    This prints one line for each directory down to the target,
1583
1448
    starting at the branch root.
1599
1464
 
1600
1465
 
1601
1466
class cmd_reconcile(Command):
1602
 
    __doc__ = """Reconcile bzr metadata in a branch.
 
1467
    """Reconcile bzr metadata in a branch.
1603
1468
 
1604
1469
    This can correct data mismatches that may have been caused by
1605
1470
    previous ghost operations or bzr upgrades. You should only
1627
1492
 
1628
1493
 
1629
1494
class cmd_revision_history(Command):
1630
 
    __doc__ = """Display the list of revision ids on a branch."""
 
1495
    """Display the list of revision ids on a branch."""
1631
1496
 
1632
1497
    _see_also = ['log']
1633
1498
    takes_args = ['location?']
1643
1508
 
1644
1509
 
1645
1510
class cmd_ancestry(Command):
1646
 
    __doc__ = """List all revisions merged into this branch."""
 
1511
    """List all revisions merged into this branch."""
1647
1512
 
1648
1513
    _see_also = ['log', 'revision-history']
1649
1514
    takes_args = ['location?']
1668
1533
 
1669
1534
 
1670
1535
class cmd_init(Command):
1671
 
    __doc__ = """Make a directory into a versioned branch.
 
1536
    """Make a directory into a versioned branch.
1672
1537
 
1673
1538
    Use this to create an empty branch, or before importing an
1674
1539
    existing project.
1702
1567
                lazy_registry=('bzrlib.bzrdir', 'format_registry'),
1703
1568
                converter=lambda name: bzrdir.format_registry.make_bzrdir(name),
1704
1569
                value_switches=True,
1705
 
                title="Branch format",
 
1570
                title="Branch Format",
1706
1571
                ),
1707
1572
         Option('append-revisions-only',
1708
1573
                help='Never change revnos or the existing log.'
1755
1620
                branch.set_append_revisions_only(True)
1756
1621
            except errors.UpgradeRequired:
1757
1622
                raise errors.BzrCommandError('This branch format cannot be set'
1758
 
                    ' to append-revisions-only.  Try --default.')
 
1623
                    ' to append-revisions-only.  Try --experimental-branch6')
1759
1624
        if not is_quiet():
1760
1625
            from bzrlib.info import describe_layout, describe_format
1761
1626
            try:
1777
1642
 
1778
1643
 
1779
1644
class cmd_init_repository(Command):
1780
 
    __doc__ = """Create a shared repository for branches to share storage space.
 
1645
    """Create a shared repository to hold branches.
1781
1646
 
1782
1647
    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.
 
1648
    revisions in the repository, not in the branch directory.
1786
1649
 
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.
 
1650
    If the --no-trees option is used then the branches in the repository
 
1651
    will not have working trees by default.
1793
1652
 
1794
1653
    :Examples:
1795
 
        Create a shared repository holding just branches::
 
1654
        Create a shared repositories holding just branches::
1796
1655
 
1797
1656
            bzr init-repo --no-trees repo
1798
1657
            bzr init repo/trunk
1837
1696
 
1838
1697
 
1839
1698
class cmd_diff(Command):
1840
 
    __doc__ = """Show differences in the working tree, between revisions or branches.
 
1699
    """Show differences in the working tree, between revisions or branches.
1841
1700
 
1842
1701
    If no arguments are given, all changes for the current tree are listed.
1843
1702
    If files are given, only the changes in those files are listed.
1864
1723
 
1865
1724
            bzr diff -r1
1866
1725
 
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
 
1726
        Difference between revision 2 and revision 1::
 
1727
 
 
1728
            bzr diff -r1..2
 
1729
 
 
1730
        Difference between revision 2 and revision 1 for branch xxx::
 
1731
 
 
1732
            bzr diff -r1..2 xxx
1888
1733
 
1889
1734
        Show just the differences for file NEWS::
1890
1735
 
1929
1774
            help='Use this command to compare files.',
1930
1775
            type=unicode,
1931
1776
            ),
1932
 
        RegistryOption('format',
1933
 
            help='Diff format to use.',
1934
 
            lazy_registry=('bzrlib.diff', 'format_registry'),
1935
 
            value_switches=False, title='Diff format'),
1936
1777
        ]
1937
1778
    aliases = ['di', 'dif']
1938
1779
    encoding_type = 'exact'
1939
1780
 
1940
1781
    @display_command
1941
1782
    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)
 
1783
            prefix=None, old=None, new=None, using=None):
 
1784
        from bzrlib.diff import _get_trees_to_diff, show_diff_trees
1945
1785
 
1946
1786
        if (prefix is None) or (prefix == '0'):
1947
1787
            # diff -p0 format
1961
1801
            raise errors.BzrCommandError('bzr diff --revision takes exactly'
1962
1802
                                         ' one or two revision specifiers')
1963
1803
 
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)
 
1804
        old_tree, new_tree, specific_files, extra_trees = \
 
1805
                _get_trees_to_diff(file_list, revision, old, new,
 
1806
                apply_view=True)
1972
1807
        return show_diff_trees(old_tree, new_tree, sys.stdout,
1973
1808
                               specific_files=specific_files,
1974
1809
                               external_diff_options=diff_options,
1975
1810
                               old_label=old_label, new_label=new_label,
1976
 
                               extra_trees=extra_trees, using=using,
1977
 
                               format_cls=format)
 
1811
                               extra_trees=extra_trees, using=using)
1978
1812
 
1979
1813
 
1980
1814
class cmd_deleted(Command):
1981
 
    __doc__ = """List files deleted in the working tree.
 
1815
    """List files deleted in the working tree.
1982
1816
    """
1983
1817
    # TODO: Show files deleted since a previous revision, or
1984
1818
    # between two revisions.
1992
1826
    @display_command
1993
1827
    def run(self, show_ids=False):
1994
1828
        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')
 
1829
        tree.lock_read()
 
1830
        try:
 
1831
            old = tree.basis_tree()
 
1832
            old.lock_read()
 
1833
            try:
 
1834
                for path, ie in old.inventory.iter_entries():
 
1835
                    if not tree.has_id(ie.file_id):
 
1836
                        self.outf.write(path)
 
1837
                        if show_ids:
 
1838
                            self.outf.write(' ')
 
1839
                            self.outf.write(ie.file_id)
 
1840
                        self.outf.write('\n')
 
1841
            finally:
 
1842
                old.unlock()
 
1843
        finally:
 
1844
            tree.unlock()
2005
1845
 
2006
1846
 
2007
1847
class cmd_modified(Command):
2008
 
    __doc__ = """List files modified in working tree.
 
1848
    """List files modified in working tree.
2009
1849
    """
2010
1850
 
2011
1851
    hidden = True
2028
1868
 
2029
1869
 
2030
1870
class cmd_added(Command):
2031
 
    __doc__ = """List files added in working tree.
 
1871
    """List files added in working tree.
2032
1872
    """
2033
1873
 
2034
1874
    hidden = True
2042
1882
    @display_command
2043
1883
    def run(self, null=False):
2044
1884
        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')
 
1885
        wt.lock_read()
 
1886
        try:
 
1887
            basis = wt.basis_tree()
 
1888
            basis.lock_read()
 
1889
            try:
 
1890
                basis_inv = basis.inventory
 
1891
                inv = wt.inventory
 
1892
                for file_id in inv:
 
1893
                    if file_id in basis_inv:
 
1894
                        continue
 
1895
                    if inv.is_root(file_id) and len(basis_inv) == 0:
 
1896
                        continue
 
1897
                    path = inv.id2path(file_id)
 
1898
                    if not os.access(osutils.abspath(path), os.F_OK):
 
1899
                        continue
 
1900
                    if null:
 
1901
                        self.outf.write(path + '\0')
 
1902
                    else:
 
1903
                        self.outf.write(osutils.quotefn(path) + '\n')
 
1904
            finally:
 
1905
                basis.unlock()
 
1906
        finally:
 
1907
            wt.unlock()
2062
1908
 
2063
1909
 
2064
1910
class cmd_root(Command):
2065
 
    __doc__ = """Show the tree root directory.
 
1911
    """Show the tree root directory.
2066
1912
 
2067
1913
    The root is the nearest enclosing directory with a .bzr control
2068
1914
    directory."""
2092
1938
 
2093
1939
 
2094
1940
class cmd_log(Command):
2095
 
    __doc__ = """Show historical log for a branch or subset of a branch.
 
1941
    """Show historical log for a branch or subset of a branch.
2096
1942
 
2097
1943
    log is bzr's default tool for exploring the history of a branch.
2098
1944
    The branch to use is taken from the first parameter. If no parameters
2209
2055
    :Tips & tricks:
2210
2056
 
2211
2057
      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>.  
 
2058
      line tools. You may prefer qlog or glog from the QBzr and Bzr-Gtk packages
 
2059
      respectively for example. (TortoiseBzr uses qlog for displaying logs.) See
 
2060
      http://bazaar-vcs.org/BzrPlugins and http://bazaar-vcs.org/IDEIntegration.
 
2061
 
 
2062
      Web interfaces are often better at exploring history than command line
 
2063
      tools, particularly for branches on servers. You may prefer Loggerhead
 
2064
      or one of its alternatives. See http://bazaar-vcs.org/WebInterface.
2216
2065
 
2217
2066
      You may find it useful to add the aliases below to ``bazaar.conf``::
2218
2067
 
2240
2089
 
2241
2090
      When exploring non-mainline history on large projects with deep
2242
2091
      history, the performance of log can be greatly improved by installing
2243
 
      the historycache plugin. This plugin buffers historical information
 
2092
      the revnocache plugin. This plugin buffers historical information
2244
2093
      trading disk space for faster speed.
2245
2094
    """
2246
2095
    takes_args = ['file*']
2279
2128
                   help='Show changes made in each revision as a patch.'),
2280
2129
            Option('include-merges',
2281
2130
                   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
2131
            ]
2287
2132
    encoding_type = 'replace'
2288
2133
 
2298
2143
            message=None,
2299
2144
            limit=None,
2300
2145
            show_diff=False,
2301
 
            include_merges=False,
2302
 
            exclude_common_ancestry=False,
2303
 
            ):
 
2146
            include_merges=False):
2304
2147
        from bzrlib.log import (
2305
2148
            Logger,
2306
2149
            make_log_request_dict,
2307
2150
            _get_info_for_log_files,
2308
2151
            )
2309
2152
        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
2153
        if include_merges:
2315
2154
            if levels is None:
2316
2155
                levels = 0
2331
2170
        filter_by_dir = False
2332
2171
        if file_list:
2333
2172
            # 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)
 
2173
            b, file_info_list, rev1, rev2 = _get_info_for_log_files(revision,
 
2174
                file_list)
2336
2175
            for relpath, file_id, kind in file_info_list:
2337
2176
                if file_id is None:
2338
2177
                    raise errors.BzrCommandError(
2356
2195
                location = '.'
2357
2196
            dir, relpath = bzrdir.BzrDir.open_containing(location)
2358
2197
            b = dir.open_branch()
2359
 
            self.add_cleanup(b.lock_read().unlock)
2360
2198
            rev1, rev2 = _get_revision_range(revision, b, self.name())
2361
2199
 
2362
2200
        # Decide on the type of delta & diff filtering to use
2372
2210
        else:
2373
2211
            diff_type = 'full'
2374
2212
 
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)
 
2213
        b.lock_read()
 
2214
        try:
 
2215
            # Build the log formatter
 
2216
            if log_format is None:
 
2217
                log_format = log.log_formatter_registry.get_default(b)
 
2218
            lf = log_format(show_ids=show_ids, to_file=self.outf,
 
2219
                            show_timezone=timezone,
 
2220
                            delta_format=get_verbosity_level(),
 
2221
                            levels=levels,
 
2222
                            show_advice=levels is None)
 
2223
 
 
2224
            # Choose the algorithm for doing the logging. It's annoying
 
2225
            # having multiple code paths like this but necessary until
 
2226
            # the underlying repository format is faster at generating
 
2227
            # deltas or can provide everything we need from the indices.
 
2228
            # The default algorithm - match-using-deltas - works for
 
2229
            # multiple files and directories and is faster for small
 
2230
            # amounts of history (200 revisions say). However, it's too
 
2231
            # slow for logging a single file in a repository with deep
 
2232
            # history, i.e. > 10K revisions. In the spirit of "do no
 
2233
            # evil when adding features", we continue to use the
 
2234
            # original algorithm - per-file-graph - for the "single
 
2235
            # file that isn't a directory without showing a delta" case.
 
2236
            partial_history = revision and b.repository._format.supports_chks
 
2237
            match_using_deltas = (len(file_ids) != 1 or filter_by_dir
 
2238
                or delta_type or partial_history)
 
2239
 
 
2240
            # Build the LogRequest and execute it
 
2241
            if len(file_ids) == 0:
 
2242
                file_ids = None
 
2243
            rqst = make_log_request_dict(
 
2244
                direction=direction, specific_fileids=file_ids,
 
2245
                start_revision=rev1, end_revision=rev2, limit=limit,
 
2246
                message_search=message, delta_type=delta_type,
 
2247
                diff_type=diff_type, _match_using_deltas=match_using_deltas)
 
2248
            Logger(b, rqst).show(lf)
 
2249
        finally:
 
2250
            b.unlock()
2414
2251
 
2415
2252
 
2416
2253
def _get_revision_range(revisionspec_list, branch, command_name):
2434
2271
            raise errors.BzrCommandError(
2435
2272
                "bzr %s doesn't accept two revisions in different"
2436
2273
                " 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)
 
2274
        rev1 = start_spec.in_history(branch)
2442
2275
        # Avoid loading all of history when we know a missing
2443
2276
        # end of range means the last revision ...
2444
2277
        if end_spec.spec is None:
2473
2306
 
2474
2307
 
2475
2308
class cmd_touching_revisions(Command):
2476
 
    __doc__ = """Return revision-ids which affected a particular file.
 
2309
    """Return revision-ids which affected a particular file.
2477
2310
 
2478
2311
    A more user-friendly interface is "bzr log FILE".
2479
2312
    """
2484
2317
    @display_command
2485
2318
    def run(self, filename):
2486
2319
        tree, relpath = WorkingTree.open_containing(filename)
 
2320
        b = tree.branch
2487
2321
        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:
 
2322
        for revno, revision_id, what in log.find_touching_revisions(b, file_id):
2492
2323
            self.outf.write("%6d %s\n" % (revno, what))
2493
2324
 
2494
2325
 
2495
2326
class cmd_ls(Command):
2496
 
    __doc__ = """List files in a tree.
 
2327
    """List files in a tree.
2497
2328
    """
2498
2329
 
2499
2330
    _see_also = ['status', 'cat']
2534
2365
 
2535
2366
        if path is None:
2536
2367
            fs_path = '.'
 
2368
            prefix = ''
2537
2369
        else:
2538
2370
            if from_root:
2539
2371
                raise errors.BzrCommandError('cannot specify both --from-root'
2540
2372
                                             ' and PATH')
2541
2373
            fs_path = path
 
2374
            prefix = path
2542
2375
        tree, branch, relpath = bzrdir.BzrDir.open_containing_tree_or_branch(
2543
2376
            fs_path)
2544
 
 
2545
 
        # Calculate the prefix to use
2546
 
        prefix = None
2547
2377
        if from_root:
2548
 
            if relpath:
2549
 
                prefix = relpath + '/'
2550
 
        elif fs_path != '.' and not fs_path.endswith('/'):
2551
 
            prefix = fs_path + '/'
2552
 
 
 
2378
            relpath = u''
 
2379
        elif relpath:
 
2380
            relpath += '/'
2553
2381
        if revision is not None or tree is None:
2554
2382
            tree = _get_one_revision_tree('ls', revision, branch=branch)
2555
2383
 
2561
2389
                view_str = views.view_display_str(view_files)
2562
2390
                note("Ignoring files outside view. View is %s" % view_str)
2563
2391
 
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')
 
2392
        tree.lock_read()
 
2393
        try:
 
2394
            for fp, fc, fkind, fid, entry in tree.list_files(include_root=False):
 
2395
                if fp.startswith(relpath):
 
2396
                    rp = fp[len(relpath):]
 
2397
                    fp = osutils.pathjoin(prefix, rp)
 
2398
                    if not recursive and '/' in rp:
 
2399
                        continue
 
2400
                    if not all and not selection[fc]:
 
2401
                        continue
 
2402
                    if kind is not None and fkind != kind:
 
2403
                        continue
 
2404
                    if apply_view:
 
2405
                        try:
 
2406
                            views.check_path_in_view(tree, fp)
 
2407
                        except errors.FileOutsideView:
 
2408
                            continue
 
2409
                    kindch = entry.kind_character()
 
2410
                    outstring = fp + kindch
 
2411
                    if verbose:
 
2412
                        outstring = '%-8s %s' % (fc, outstring)
 
2413
                        if show_ids and fid is not None:
 
2414
                            outstring = "%-50s %s" % (outstring, fid)
 
2415
                        self.outf.write(outstring + '\n')
 
2416
                    elif null:
 
2417
                        self.outf.write(fp + '\0')
 
2418
                        if show_ids:
 
2419
                            if fid is not None:
 
2420
                                self.outf.write(fid)
 
2421
                            self.outf.write('\0')
 
2422
                        self.outf.flush()
 
2423
                    else:
 
2424
                        if fid is not None:
 
2425
                            my_id = fid
 
2426
                        else:
 
2427
                            my_id = ''
 
2428
                        if show_ids:
 
2429
                            self.outf.write('%-50s %s\n' % (outstring, my_id))
 
2430
                        else:
 
2431
                            self.outf.write(outstring + '\n')
 
2432
        finally:
 
2433
            tree.unlock()
2609
2434
 
2610
2435
 
2611
2436
class cmd_unknowns(Command):
2612
 
    __doc__ = """List unknown files.
 
2437
    """List unknown files.
2613
2438
    """
2614
2439
 
2615
2440
    hidden = True
2622
2447
 
2623
2448
 
2624
2449
class cmd_ignore(Command):
2625
 
    __doc__ = """Ignore specified files or patterns.
 
2450
    """Ignore specified files or patterns.
2626
2451
 
2627
2452
    See ``bzr help patterns`` for details on the syntax of patterns.
2628
2453
 
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
2454
    To remove patterns from the ignore list, edit the .bzrignore file.
2636
2455
    After adding, editing or deleting that file either indirectly by
2637
2456
    using this command or directly by using an editor, be sure to commit
2638
2457
    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
2458
 
2653
2459
    Note: ignore patterns containing shell wildcards must be quoted from
2654
2460
    the shell on Unix.
2658
2464
 
2659
2465
            bzr ignore ./Makefile
2660
2466
 
2661
 
        Ignore .class files in all directories...::
 
2467
        Ignore class files in all directories::
2662
2468
 
2663
2469
            bzr ignore "*.class"
2664
2470
 
2665
 
        ...but do not ignore "special.class"::
2666
 
 
2667
 
            bzr ignore "!special.class"
2668
 
 
2669
2471
        Ignore .o files under the lib directory::
2670
2472
 
2671
2473
            bzr ignore "lib/**/*.o"
2677
2479
        Ignore everything but the "debian" toplevel directory::
2678
2480
 
2679
2481
            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
2482
    """
2688
2483
 
2689
2484
    _see_also = ['status', 'ignored', 'patterns']
2690
2485
    takes_args = ['name_pattern*']
2691
2486
    takes_options = [
2692
 
        Option('default-rules',
2693
 
               help='Display the default ignore rules that bzr uses.')
 
2487
        Option('old-default-rules',
 
2488
               help='Write out the ignore rules bzr < 0.9 always used.')
2694
2489
        ]
2695
2490
 
2696
 
    def run(self, name_pattern_list=None, default_rules=None):
 
2491
    def run(self, name_pattern_list=None, old_default_rules=None):
2697
2492
        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)
 
2493
        if old_default_rules is not None:
 
2494
            # dump the rules and exit
 
2495
            for pattern in ignores.OLD_DEFAULTS:
 
2496
                print pattern
2702
2497
            return
2703
2498
        if not name_pattern_list:
2704
2499
            raise errors.BzrCommandError("ignore requires at least one "
2705
 
                "NAME_PATTERN or --default-rules.")
 
2500
                                  "NAME_PATTERN or --old-default-rules")
2706
2501
        name_pattern_list = [globbing.normalize_pattern(p)
2707
2502
                             for p in name_pattern_list]
2708
2503
        for name_pattern in name_pattern_list:
2720
2515
            if id is not None:
2721
2516
                filename = entry[0]
2722
2517
                if ignored.match(filename):
2723
 
                    matches.append(filename)
 
2518
                    matches.append(filename.encode('utf-8'))
2724
2519
        tree.unlock()
2725
2520
        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),))
 
2521
            print "Warning: the following files are version controlled and" \
 
2522
                  " match your ignore pattern:\n%s" \
 
2523
                  "\nThese files will continue to be version controlled" \
 
2524
                  " unless you 'bzr remove' them." % ("\n".join(matches),)
2730
2525
 
2731
2526
 
2732
2527
class cmd_ignored(Command):
2733
 
    __doc__ = """List ignored files and the patterns that matched them.
 
2528
    """List ignored files and the patterns that matched them.
2734
2529
 
2735
2530
    List all the ignored files and the ignore pattern that caused the file to
2736
2531
    be ignored.
2746
2541
    @display_command
2747
2542
    def run(self):
2748
2543
        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))
 
2544
        tree.lock_read()
 
2545
        try:
 
2546
            for path, file_class, kind, file_id, entry in tree.list_files():
 
2547
                if file_class != 'I':
 
2548
                    continue
 
2549
                ## XXX: Slightly inefficient since this was already calculated
 
2550
                pat = tree.is_ignored(path)
 
2551
                self.outf.write('%-50s %s\n' % (path, pat))
 
2552
        finally:
 
2553
            tree.unlock()
2756
2554
 
2757
2555
 
2758
2556
class cmd_lookup_revision(Command):
2759
 
    __doc__ = """Lookup the revision-id from a revision-number
 
2557
    """Lookup the revision-id from a revision-number
2760
2558
 
2761
2559
    :Examples:
2762
2560
        bzr lookup-revision 33
2769
2567
        try:
2770
2568
            revno = int(revno)
2771
2569
        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)
 
2570
            raise errors.BzrCommandError("not a valid revision-number: %r" % revno)
 
2571
 
 
2572
        print WorkingTree.open_containing(u'.')[0].branch.get_rev_id(revno)
2776
2573
 
2777
2574
 
2778
2575
class cmd_export(Command):
2779
 
    __doc__ = """Export current or past revision to a destination directory or archive.
 
2576
    """Export current or past revision to a destination directory or archive.
2780
2577
 
2781
2578
    If no revision is specified this exports the last committed revision.
2782
2579
 
2814
2611
        Option('root',
2815
2612
               type=str,
2816
2613
               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
2614
        ]
2821
2615
    def run(self, dest, branch_or_subdir=None, revision=None, format=None,
2822
 
        root=None, filters=False, per_file_timestamps=False):
 
2616
        root=None, filters=False):
2823
2617
        from bzrlib.export import export
2824
2618
 
2825
2619
        if branch_or_subdir is None:
2832
2626
 
2833
2627
        rev_tree = _get_one_revision_tree('export', revision, branch=b, tree=tree)
2834
2628
        try:
2835
 
            export(rev_tree, dest, format, root, subdir, filtered=filters,
2836
 
                   per_file_timestamps=per_file_timestamps)
 
2629
            export(rev_tree, dest, format, root, subdir, filtered=filters)
2837
2630
        except errors.NoSuchExportFormat, e:
2838
2631
            raise errors.BzrCommandError('Unsupported export format: %s' % e.format)
2839
2632
 
2840
2633
 
2841
2634
class cmd_cat(Command):
2842
 
    __doc__ = """Write the contents of a file as of a given revision to standard output.
 
2635
    """Write the contents of a file as of a given revision to standard output.
2843
2636
 
2844
2637
    If no revision is nominated, the last revision is used.
2845
2638
 
2865
2658
                                         " one revision specifier")
2866
2659
        tree, branch, relpath = \
2867
2660
            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)
 
2661
        branch.lock_read()
 
2662
        try:
 
2663
            return self._run(tree, branch, relpath, filename, revision,
 
2664
                             name_from_revision, filters)
 
2665
        finally:
 
2666
            branch.unlock()
2871
2667
 
2872
2668
    def _run(self, tree, b, relpath, filename, revision, name_from_revision,
2873
2669
        filtered):
2874
2670
        if tree is None:
2875
2671
            tree = b.basis_tree()
2876
2672
        rev_tree = _get_one_revision_tree('cat', revision, branch=b)
2877
 
        self.add_cleanup(rev_tree.lock_read().unlock)
2878
2673
 
2879
2674
        old_file_id = rev_tree.path2id(relpath)
2880
2675
 
2915
2710
            chunks = content.splitlines(True)
2916
2711
            content = filtered_output_bytes(chunks, filters,
2917
2712
                ContentFilterContext(relpath, rev_tree))
2918
 
            self.cleanup_now()
2919
2713
            self.outf.writelines(content)
2920
2714
        else:
2921
 
            self.cleanup_now()
2922
2715
            self.outf.write(content)
2923
2716
 
2924
2717
 
2925
2718
class cmd_local_time_offset(Command):
2926
 
    __doc__ = """Show the offset in seconds from GMT to local time."""
 
2719
    """Show the offset in seconds from GMT to local time."""
2927
2720
    hidden = True
2928
2721
    @display_command
2929
2722
    def run(self):
2930
 
        self.outf.write("%s\n" % osutils.local_time_offset())
 
2723
        print osutils.local_time_offset()
2931
2724
 
2932
2725
 
2933
2726
 
2934
2727
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.)
 
2728
    """Commit changes into a new revision.
 
2729
 
 
2730
    If no arguments are given, the entire tree is committed.
 
2731
 
 
2732
    If selected files are specified, only changes to those files are
 
2733
    committed.  If a directory is specified then the directory and everything
 
2734
    within it is committed.
 
2735
 
 
2736
    When excludes are given, they take precedence over selected files.
 
2737
    For example, too commit only changes within foo, but not changes within
 
2738
    foo/bar::
 
2739
 
 
2740
      bzr commit foo -x foo/bar
 
2741
 
 
2742
    If author of the change is not the same person as the committer, you can
 
2743
    specify the author's name using the --author option. The name should be
 
2744
    in the same format as a committer-id, e.g. "John Doe <jdoe@example.com>".
 
2745
    If there is more than one author of the change you can specify the option
 
2746
    multiple times, once for each author.
 
2747
 
 
2748
    A selected-file commit may fail in some cases where the committed
 
2749
    tree would be invalid. Consider::
 
2750
 
 
2751
      bzr init foo
 
2752
      mkdir foo/bar
 
2753
      bzr add foo/bar
 
2754
      bzr commit foo -m "committing foo"
 
2755
      bzr mv foo/bar foo/baz
 
2756
      mkdir foo/bar
 
2757
      bzr add foo/bar
 
2758
      bzr commit foo/bar -m "committing bar but not baz"
 
2759
 
 
2760
    In the example above, the last commit will fail by design. This gives
 
2761
    the user the opportunity to decide whether they want to commit the
 
2762
    rename at the same time, separately first, or not at all. (As a general
 
2763
    rule, when in doubt, Bazaar has a policy of Doing the Safe Thing.)
 
2764
 
 
2765
    Note: A selected-file commit after a merge is not yet supported.
3006
2766
    """
3007
2767
    # TODO: Run hooks on tree to-be-committed, and after commit.
3008
2768
 
3013
2773
 
3014
2774
    # XXX: verbose currently does nothing
3015
2775
 
3016
 
    _see_also = ['add', 'bugs', 'hooks', 'uncommit']
 
2776
    _see_also = ['bugs', 'uncommit']
3017
2777
    takes_args = ['selected*']
3018
2778
    takes_options = [
3019
2779
            ListOption('exclude', type=str, short_name='x',
3031
2791
             Option('strict',
3032
2792
                    help="Refuse to commit if there are unknown "
3033
2793
                    "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
2794
             ListOption('fixes', type=str,
3038
2795
                    help="Mark a bug as being fixed by this revision "
3039
2796
                         "(see \"bzr help bugs\")."),
3046
2803
                         "the master branch until a normal commit "
3047
2804
                         "is performed."
3048
2805
                    ),
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.'),
 
2806
              Option('show-diff',
 
2807
                     help='When no message is supplied, show the diff along'
 
2808
                     ' with the status summary in the message editor.'),
3052
2809
             ]
3053
2810
    aliases = ['ci', 'checkin']
3054
2811
 
3073
2830
 
3074
2831
    def run(self, message=None, file=None, verbose=False, selected_list=None,
3075
2832
            unchanged=False, strict=False, local=False, fixes=None,
3076
 
            author=None, show_diff=False, exclude=None, commit_time=None):
 
2833
            author=None, show_diff=False, exclude=None):
3077
2834
        from bzrlib.errors import (
3078
2835
            PointlessCommit,
3079
2836
            ConflictsInTree,
3085
2842
            make_commit_message_template_encoded
3086
2843
        )
3087
2844
 
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
2845
        # TODO: Need a blackbox test for invoking the external editor; may be
3097
2846
        # slightly problematic to run this cross-platform.
3098
2847
 
3118
2867
        if local and not tree.branch.get_bound_location():
3119
2868
            raise errors.LocalRequiresBoundBranch()
3120
2869
 
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
2870
        def get_message(commit_obj):
3143
2871
            """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,
 
2872
            my_message = message
 
2873
            if my_message is None and not file:
 
2874
                t = make_commit_message_template_encoded(tree,
3153
2875
                        selected_list, diff=show_diff,
3154
2876
                        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
2877
                start_message = generate_commit_message_template(commit_obj)
3161
 
                my_message = edit_commit_message_encoded(text,
 
2878
                my_message = edit_commit_message_encoded(t,
3162
2879
                    start_message=start_message)
3163
2880
                if my_message is None:
3164
2881
                    raise errors.BzrCommandError("please specify a commit"
3165
2882
                        " message with either --message or --file")
 
2883
            elif my_message and file:
 
2884
                raise errors.BzrCommandError(
 
2885
                    "please specify either --message or --file")
 
2886
            if file:
 
2887
                my_message = codecs.open(file, 'rt',
 
2888
                                         osutils.get_user_encoding()).read()
3166
2889
            if my_message == "":
3167
2890
                raise errors.BzrCommandError("empty commit message specified")
3168
2891
            return my_message
3169
2892
 
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
2893
        try:
3175
2894
            tree.commit(message_callback=get_message,
3176
2895
                        specific_files=selected_list,
3177
2896
                        allow_pointless=unchanged, strict=strict, local=local,
3178
2897
                        reporter=None, verbose=verbose, revprops=properties,
3179
 
                        authors=author, timestamp=commit_stamp,
3180
 
                        timezone=offset,
 
2898
                        authors=author,
3181
2899
                        exclude=safe_relpath_files(tree, exclude))
3182
2900
        except PointlessCommit:
3183
 
            raise errors.BzrCommandError("No changes to commit."
3184
 
                              " Use --unchanged to commit anyhow.")
 
2901
            # FIXME: This should really happen before the file is read in;
 
2902
            # perhaps prepare the commit; get the message; then actually commit
 
2903
            raise errors.BzrCommandError("no changes to commit."
 
2904
                              " use --unchanged to commit anyhow")
3185
2905
        except ConflictsInTree:
3186
2906
            raise errors.BzrCommandError('Conflicts detected in working '
3187
2907
                'tree.  Use "bzr conflicts" to list, "bzr resolve FILE" to'
3190
2910
            raise errors.BzrCommandError("Commit refused because there are"
3191
2911
                              " unknown files in the working tree.")
3192
2912
        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
 
2913
            raise errors.BzrCommandError(str(e) + "\n"
 
2914
            'To commit to master branch, run update and then commit.\n'
 
2915
            'You can also pass --local to commit to continue working '
 
2916
            'disconnected.')
3198
2917
 
3199
2918
 
3200
2919
class cmd_check(Command):
3201
 
    __doc__ = """Validate working tree structure, branch consistency and repository history.
 
2920
    """Validate working tree structure, branch consistency and repository history.
3202
2921
 
3203
2922
    This command checks various invariants about branch and repository storage
3204
2923
    to detect data corruption or bzr bugs.
3206
2925
    The working tree and branch checks will only give output if a problem is
3207
2926
    detected. The output fields of the repository check are:
3208
2927
 
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.
 
2928
        revisions: This is just the number of revisions checked.  It doesn't
 
2929
            indicate a problem.
 
2930
        versionedfiles: This is just the number of versionedfiles checked.  It
 
2931
            doesn't indicate a problem.
 
2932
        unreferenced ancestors: Texts that are ancestors of other texts, but
 
2933
            are not properly referenced by the revision ancestry.  This is a
 
2934
            subtle problem that Bazaar can work around.
 
2935
        unique file texts: This is the total number of unique file contents
 
2936
            seen in the checked revisions.  It does not indicate a problem.
 
2937
        repeated file texts: This is the total number of repeated texts seen
 
2938
            in the checked revisions.  Texts can be repeated when their file
 
2939
            entries are modified, but the file contents are not.  It does not
 
2940
            indicate a problem.
3231
2941
 
3232
2942
    If no restrictions are specified, all Bazaar data that is found at the given
3233
2943
    location will be checked.
3268
2978
 
3269
2979
 
3270
2980
class cmd_upgrade(Command):
3271
 
    __doc__ = """Upgrade branch storage to current format.
 
2981
    """Upgrade branch storage to current format.
3272
2982
 
3273
2983
    The check command or bzr developers may sometimes advise you to run
3274
2984
    this command. When the default format has changed you may also be warned
3292
3002
 
3293
3003
 
3294
3004
class cmd_whoami(Command):
3295
 
    __doc__ = """Show or set bzr user id.
 
3005
    """Show or set bzr user id.
3296
3006
 
3297
3007
    :Examples:
3298
3008
        Show the email of the current user::
3342
3052
 
3343
3053
 
3344
3054
class cmd_nick(Command):
3345
 
    __doc__ = """Print or set the branch nickname.
 
3055
    """Print or set the branch nickname.
3346
3056
 
3347
3057
    If unset, the tree root directory name is used as the nickname.
3348
3058
    To print the current nickname, execute with no argument.
3362
3072
 
3363
3073
    @display_command
3364
3074
    def printme(self, branch):
3365
 
        self.outf.write('%s\n' % branch.nick)
 
3075
        print branch.nick
3366
3076
 
3367
3077
 
3368
3078
class cmd_alias(Command):
3369
 
    __doc__ = """Set/unset and display aliases.
 
3079
    """Set/unset and display aliases.
3370
3080
 
3371
3081
    :Examples:
3372
3082
        Show the current aliases::
3436
3146
 
3437
3147
 
3438
3148
class cmd_selftest(Command):
3439
 
    __doc__ = """Run internal test suite.
 
3149
    """Run internal test suite.
3440
3150
 
3441
3151
    If arguments are given, they are regular expressions that say which tests
3442
3152
    should run.  Tests matching any expression are run, and other tests are
3469
3179
    Tests that need working space on disk use a common temporary directory,
3470
3180
    typically inside $TMPDIR or /tmp.
3471
3181
 
3472
 
    If you set BZR_TEST_PDB=1 when running selftest, failing tests will drop
3473
 
    into a pdb postmortem session.
3474
 
 
3475
3182
    :Examples:
3476
3183
        Run only tests relating to 'ignore'::
3477
3184
 
3486
3193
    def get_transport_type(typestring):
3487
3194
        """Parse and return a transport specifier."""
3488
3195
        if typestring == "sftp":
3489
 
            from bzrlib.tests import stub_sftp
3490
 
            return stub_sftp.SFTPAbsoluteServer
 
3196
            from bzrlib.transport.sftp import SFTPAbsoluteServer
 
3197
            return SFTPAbsoluteServer
3491
3198
        if typestring == "memory":
3492
 
            from bzrlib.tests import test_server
3493
 
            return memory.MemoryServer
 
3199
            from bzrlib.transport.memory import MemoryServer
 
3200
            return MemoryServer
3494
3201
        if typestring == "fakenfs":
3495
 
            from bzrlib.tests import test_server
3496
 
            return test_server.FakeNFSServer
 
3202
            from bzrlib.transport.fakenfs import FakeNFSServer
 
3203
            return FakeNFSServer
3497
3204
        msg = "No known transport type %s. Supported types are: sftp\n" %\
3498
3205
            (typestring)
3499
3206
        raise errors.BzrCommandError(msg)
3514
3221
                     Option('lsprof-timed',
3515
3222
                            help='Generate lsprof output for benchmarked'
3516
3223
                                 ' sections of code.'),
3517
 
                     Option('lsprof-tests',
3518
 
                            help='Generate lsprof output for each test.'),
3519
3224
                     Option('cache-dir', type=str,
3520
3225
                            help='Cache intermediate benchmark output in this '
3521
3226
                                 'directory.'),
3562
3267
            first=False, list_only=False,
3563
3268
            randomize=None, exclude=None, strict=False,
3564
3269
            load_list=None, debugflag=None, starting_with=None, subunit=False,
3565
 
            parallel=None, lsprof_tests=False):
 
3270
            parallel=None):
3566
3271
        from bzrlib.tests import selftest
3567
3272
        import bzrlib.benchmarks as benchmarks
3568
3273
        from bzrlib.benchmarks import tree_creator
3583
3288
                raise errors.BzrCommandError("subunit not available. subunit "
3584
3289
                    "needs to be installed to use --subunit.")
3585
3290
            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
3291
        if parallel:
3592
3292
            self.additional_selftest_args.setdefault(
3593
3293
                'suite_decorators', []).append(parallel)
3597
3297
            verbose = not is_quiet()
3598
3298
            # TODO: should possibly lock the history file...
3599
3299
            benchfile = open(".perf_history", "at", buffering=1)
3600
 
            self.add_cleanup(benchfile.close)
3601
3300
        else:
3602
3301
            test_suite_factory = None
3603
3302
            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)
 
3303
        try:
 
3304
            selftest_kwargs = {"verbose": verbose,
 
3305
                              "pattern": pattern,
 
3306
                              "stop_on_failure": one,
 
3307
                              "transport": transport,
 
3308
                              "test_suite_factory": test_suite_factory,
 
3309
                              "lsprof_timed": lsprof_timed,
 
3310
                              "bench_history": benchfile,
 
3311
                              "matching_tests_first": first,
 
3312
                              "list_only": list_only,
 
3313
                              "random_seed": randomize,
 
3314
                              "exclude_pattern": exclude,
 
3315
                              "strict": strict,
 
3316
                              "load_list": load_list,
 
3317
                              "debug_flags": debugflag,
 
3318
                              "starting_with": starting_with
 
3319
                              }
 
3320
            selftest_kwargs.update(self.additional_selftest_args)
 
3321
            result = selftest(**selftest_kwargs)
 
3322
        finally:
 
3323
            if benchfile is not None:
 
3324
                benchfile.close()
3623
3325
        return int(not result)
3624
3326
 
3625
3327
 
3626
3328
class cmd_version(Command):
3627
 
    __doc__ = """Show version of bzr."""
 
3329
    """Show version of bzr."""
3628
3330
 
3629
3331
    encoding_type = 'replace'
3630
3332
    takes_options = [
3641
3343
 
3642
3344
 
3643
3345
class cmd_rocks(Command):
3644
 
    __doc__ = """Statement of optimism."""
 
3346
    """Statement of optimism."""
3645
3347
 
3646
3348
    hidden = True
3647
3349
 
3648
3350
    @display_command
3649
3351
    def run(self):
3650
 
        self.outf.write("It sure does!\n")
 
3352
        print "It sure does!"
3651
3353
 
3652
3354
 
3653
3355
class cmd_find_merge_base(Command):
3654
 
    __doc__ = """Find and print a base revision for merging two branches."""
 
3356
    """Find and print a base revision for merging two branches."""
3655
3357
    # TODO: Options to specify revisions on either side, as if
3656
3358
    #       merging only part of the history.
3657
3359
    takes_args = ['branch', 'other']
3663
3365
 
3664
3366
        branch1 = Branch.open_containing(branch)[0]
3665
3367
        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)
 
3368
        branch1.lock_read()
 
3369
        try:
 
3370
            branch2.lock_read()
 
3371
            try:
 
3372
                last1 = ensure_null(branch1.last_revision())
 
3373
                last2 = ensure_null(branch2.last_revision())
 
3374
 
 
3375
                graph = branch1.repository.get_graph(branch2.repository)
 
3376
                base_rev_id = graph.find_unique_lca(last1, last2)
 
3377
 
 
3378
                print 'merge base is revision %s' % base_rev_id
 
3379
            finally:
 
3380
                branch2.unlock()
 
3381
        finally:
 
3382
            branch1.unlock()
3675
3383
 
3676
3384
 
3677
3385
class cmd_merge(Command):
3678
 
    __doc__ = """Perform a three-way merge.
 
3386
    """Perform a three-way merge.
3679
3387
 
3680
3388
    The source of the merge can be specified either in the form of a branch,
3681
3389
    or in the form of a path to a file containing a merge directive generated
3710
3418
    committed to record the result of the merge.
3711
3419
 
3712
3420
    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".
 
3421
    --force is given.
3722
3422
 
3723
3423
    :Examples:
3724
3424
        To merge the latest revision from bzr.dev::
3733
3433
 
3734
3434
            bzr merge -r 81..82 ../bzr.dev
3735
3435
 
3736
 
        To apply a merge directive contained in /tmp/merge::
 
3436
        To apply a merge directive contained in /tmp/merge:
3737
3437
 
3738
3438
            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
3439
    """
3747
3440
 
3748
3441
    encoding_type = 'exact'
3770
3463
               short_name='d',
3771
3464
               type=unicode,
3772
3465
               ),
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')
 
3466
        Option('preview', help='Instead of merging, show a diff of the merge.')
3777
3467
    ]
3778
3468
 
3779
3469
    def run(self, location=None, revision=None, force=False,
3781
3471
            uncommitted=False, pull=False,
3782
3472
            directory=None,
3783
3473
            preview=False,
3784
 
            interactive=False,
3785
3474
            ):
3786
3475
        if merge_type is None:
3787
3476
            merge_type = _mod_merge.Merge3Merger
3793
3482
        verified = 'inapplicable'
3794
3483
        tree = WorkingTree.open_containing(directory)[0]
3795
3484
 
 
3485
        # die as quickly as possible if there are uncommitted changes
3796
3486
        try:
3797
3487
            basis_tree = tree.revision_tree(tree.last_revision())
3798
3488
        except errors.NoSuchRevision:
3799
3489
            basis_tree = tree.basis_tree()
3800
 
 
3801
 
        # die as quickly as possible if there are uncommitted changes
3802
3490
        if not force:
3803
 
            if tree.has_changes():
 
3491
            changes = tree.changes_from(basis_tree)
 
3492
            if changes.has_changed():
3804
3493
                raise errors.UncommittedChanges(tree)
3805
3494
 
3806
3495
        view_info = _get_view_info_for_change_reporter(tree)
3807
3496
        change_reporter = delta._ChangeReporter(
3808
3497
            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
 
3498
        cleanups = []
 
3499
        try:
 
3500
            pb = ui.ui_factory.nested_progress_bar()
 
3501
            cleanups.append(pb.finished)
 
3502
            tree.lock_write()
 
3503
            cleanups.append(tree.unlock)
 
3504
            if location is not None:
 
3505
                try:
 
3506
                    mergeable = bundle.read_mergeable_from_url(location,
 
3507
                        possible_transports=possible_transports)
 
3508
                except errors.NotABundle:
 
3509
                    mergeable = None
 
3510
                else:
 
3511
                    if uncommitted:
 
3512
                        raise errors.BzrCommandError('Cannot use --uncommitted'
 
3513
                            ' with bundles or merge directives.')
 
3514
 
 
3515
                    if revision is not None:
 
3516
                        raise errors.BzrCommandError(
 
3517
                            'Cannot use -r with merge directives or bundles')
 
3518
                    merger, verified = _mod_merge.Merger.from_mergeable(tree,
 
3519
                       mergeable, pb)
 
3520
 
 
3521
            if merger is None and uncommitted:
 
3522
                if revision is not None and len(revision) > 0:
 
3523
                    raise errors.BzrCommandError('Cannot use --uncommitted and'
 
3524
                        ' --revision at the same time.')
 
3525
                location = self._select_branch_location(tree, location)[0]
 
3526
                other_tree, other_path = WorkingTree.open_containing(location)
 
3527
                merger = _mod_merge.Merger.from_uncommitted(tree, other_tree,
 
3528
                    pb)
 
3529
                allow_pending = False
 
3530
                if other_path != '':
 
3531
                    merger.interesting_files = [other_path]
 
3532
 
 
3533
            if merger is None:
 
3534
                merger, allow_pending = self._get_merger_from_branch(tree,
 
3535
                    location, revision, remember, possible_transports, pb)
 
3536
 
 
3537
            merger.merge_type = merge_type
 
3538
            merger.reprocess = reprocess
 
3539
            merger.show_base = show_base
 
3540
            self.sanity_check_merger(merger)
 
3541
            if (merger.base_rev_id == merger.other_rev_id and
 
3542
                merger.other_rev_id is not None):
 
3543
                note('Nothing to do.')
 
3544
                return 0
 
3545
            if pull:
 
3546
                if merger.interesting_files is not None:
 
3547
                    raise errors.BzrCommandError('Cannot pull individual files')
 
3548
                if (merger.base_rev_id == tree.last_revision()):
 
3549
                    result = tree.pull(merger.other_branch, False,
 
3550
                                       merger.other_rev_id)
 
3551
                    result.report(self.outf)
 
3552
                    return 0
 
3553
            merger.check_basis(False)
 
3554
            if preview:
 
3555
                return self._do_preview(merger)
3818
3556
            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):
 
3557
                return self._do_merge(merger, change_reporter, allow_pending,
 
3558
                                      verified)
 
3559
        finally:
 
3560
            for cleanup in reversed(cleanups):
 
3561
                cleanup()
 
3562
 
 
3563
    def _do_preview(self, merger):
 
3564
        from bzrlib.diff import show_diff_trees
3869
3565
        tree_merger = merger.make_merger()
3870
3566
        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='')
 
3567
        try:
 
3568
            result_tree = tt.get_preview_tree()
 
3569
            show_diff_trees(merger.this_tree, result_tree, self.outf,
 
3570
                            old_label='', new_label='')
 
3571
        finally:
 
3572
            tt.finalize()
3880
3573
 
3881
3574
    def _do_merge(self, merger, change_reporter, allow_pending, verified):
3882
3575
        merger.change_reporter = change_reporter
3890
3583
        else:
3891
3584
            return 0
3892
3585
 
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
3586
    def sanity_check_merger(self, merger):
3912
3587
        if (merger.show_base and
3913
3588
            not merger.merge_type is _mod_merge.Merge3Merger):
3948
3623
            base_branch, base_path = Branch.open_containing(base_loc,
3949
3624
                possible_transports)
3950
3625
        # 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:
 
3626
        if revision is None or len(revision) < 1 or revision[-1] is None:
3959
3627
            other_revision_id = _mod_revision.ensure_null(
3960
3628
                other_branch.last_revision())
 
3629
        else:
 
3630
            other_revision_id = revision[-1].as_revision_id(other_branch)
 
3631
        if (revision is not None and len(revision) == 2
 
3632
            and revision[0] is not None):
 
3633
            base_revision_id = revision[0].as_revision_id(base_branch)
 
3634
        else:
 
3635
            base_revision_id = None
3961
3636
        # Remember where we merge from
3962
3637
        if ((remember or tree.branch.get_submit_branch() is None) and
3963
3638
             user_location is not None):
3972
3647
            allow_pending = True
3973
3648
        return merger, allow_pending
3974
3649
 
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
3650
    def _select_branch_location(self, tree, user_location, revision=None,
3990
3651
                                index=None):
3991
3652
        """Select a branch location, according to possible inputs.
4035
3696
 
4036
3697
 
4037
3698
class cmd_remerge(Command):
4038
 
    __doc__ = """Redo a merge.
 
3699
    """Redo a merge.
4039
3700
 
4040
3701
    Use this if you want to try a different merge technique while resolving
4041
3702
    conflicts.  Some merge techniques are better than others, and remerge
4066
3727
 
4067
3728
    def run(self, file_list=None, merge_type=None, show_base=False,
4068
3729
            reprocess=False):
4069
 
        from bzrlib.conflicts import restore
4070
3730
        if merge_type is None:
4071
3731
            merge_type = _mod_merge.Merge3Merger
4072
3732
        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
 
3733
        tree.lock_write()
 
3734
        try:
 
3735
            parents = tree.get_parent_ids()
 
3736
            if len(parents) != 2:
 
3737
                raise errors.BzrCommandError("Sorry, remerge only works after normal"
 
3738
                                             " merges.  Not cherrypicking or"
 
3739
                                             " multi-merges.")
 
3740
            repository = tree.branch.repository
 
3741
            interesting_ids = None
 
3742
            new_conflicts = []
 
3743
            conflicts = tree.conflicts()
 
3744
            if file_list is not None:
 
3745
                interesting_ids = set()
 
3746
                for filename in file_list:
 
3747
                    file_id = tree.path2id(filename)
 
3748
                    if file_id is None:
 
3749
                        raise errors.NotVersionedError(filename)
 
3750
                    interesting_ids.add(file_id)
 
3751
                    if tree.kind(file_id) != "directory":
 
3752
                        continue
4092
3753
 
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:
 
3754
                    for name, ie in tree.inventory.iter_entries(file_id):
 
3755
                        interesting_ids.add(ie.file_id)
 
3756
                new_conflicts = conflicts.select_conflicts(tree, file_list)[0]
 
3757
            else:
 
3758
                # Remerge only supports resolving contents conflicts
 
3759
                allowed_conflicts = ('text conflict', 'contents conflict')
 
3760
                restore_files = [c.path for c in conflicts
 
3761
                                 if c.typestring in allowed_conflicts]
 
3762
            _mod_merge.transform_tree(tree, tree.basis_tree(), interesting_ids)
 
3763
            tree.set_conflicts(ConflictList(new_conflicts))
 
3764
            if file_list is not None:
 
3765
                restore_files = file_list
 
3766
            for filename in restore_files:
 
3767
                try:
 
3768
                    restore(tree.abspath(filename))
 
3769
                except errors.NotConflicted:
 
3770
                    pass
 
3771
            # Disable pending merges, because the file texts we are remerging
 
3772
            # have not had those merges performed.  If we use the wrong parents
 
3773
            # list, we imply that the working tree text has seen and rejected
 
3774
            # all the changes from the other tree, when in fact those changes
 
3775
            # have not yet been seen.
 
3776
            pb = ui.ui_factory.nested_progress_bar()
 
3777
            tree.set_parent_ids(parents[:1])
4106
3778
            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()
 
3779
                merger = _mod_merge.Merger.from_revision_ids(pb,
 
3780
                                                             tree, parents[1])
 
3781
                merger.interesting_ids = interesting_ids
 
3782
                merger.merge_type = merge_type
 
3783
                merger.show_base = show_base
 
3784
                merger.reprocess = reprocess
 
3785
                conflicts = merger.do_merge()
 
3786
            finally:
 
3787
                tree.set_parent_ids(parents)
 
3788
                pb.finished()
4123
3789
        finally:
4124
 
            tree.set_parent_ids(parents)
 
3790
            tree.unlock()
4125
3791
        if conflicts > 0:
4126
3792
            return 1
4127
3793
        else:
4129
3795
 
4130
3796
 
4131
3797
class cmd_revert(Command):
4132
 
    __doc__ = """Revert files to a previous revision.
 
3798
    """Revert files to a previous revision.
4133
3799
 
4134
3800
    Giving a list of files will revert only those files.  Otherwise, all files
4135
3801
    will be reverted.  If the revision is not specified with '--revision', the
4149
3815
    name.  If you name a directory, all the contents of that directory will be
4150
3816
    reverted.
4151
3817
 
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.
 
3818
    Any files that have been newly added since that revision will be deleted,
 
3819
    with a backup kept if appropriate.  Directories containing unknown files
 
3820
    will not be deleted.
4156
3821
 
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
 
3822
    The working tree contains a list of pending merged revisions, which will
 
3823
    be included as parents in the next commit.  Normally, revert clears that
 
3824
    list as well as reverting the files.  If any files are specified, revert
 
3825
    leaves the pending merge list alone and reverts only the files.  Use "bzr
 
3826
    revert ." in the tree root to revert all files but keep the merge record,
 
3827
    and "bzr revert --forget-merges" to clear the pending merge list without
4164
3828
    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
3829
    """
4176
3830
 
4177
3831
    _see_also = ['cat', 'export']
4186
3840
    def run(self, revision=None, no_backup=False, file_list=None,
4187
3841
            forget_merges=None):
4188
3842
        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)
 
3843
        tree.lock_write()
 
3844
        try:
 
3845
            if forget_merges:
 
3846
                tree.set_parent_ids(tree.get_parent_ids()[:1])
 
3847
            else:
 
3848
                self._revert_tree_to_revision(tree, revision, file_list, no_backup)
 
3849
        finally:
 
3850
            tree.unlock()
4194
3851
 
4195
3852
    @staticmethod
4196
3853
    def _revert_tree_to_revision(tree, revision, file_list, no_backup):
4197
3854
        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)
 
3855
        pb = ui.ui_factory.nested_progress_bar()
 
3856
        try:
 
3857
            tree.revert(file_list, rev_tree, not no_backup, pb,
 
3858
                report_changes=True)
 
3859
        finally:
 
3860
            pb.finished()
4200
3861
 
4201
3862
 
4202
3863
class cmd_assert_fail(Command):
4203
 
    __doc__ = """Test reporting of assertion failures"""
 
3864
    """Test reporting of assertion failures"""
4204
3865
    # intended just for use in testing
4205
3866
 
4206
3867
    hidden = True
4210
3871
 
4211
3872
 
4212
3873
class cmd_help(Command):
4213
 
    __doc__ = """Show help on a command or other topic.
 
3874
    """Show help on a command or other topic.
4214
3875
    """
4215
3876
 
4216
3877
    _see_also = ['topics']
4229
3890
 
4230
3891
 
4231
3892
class cmd_shell_complete(Command):
4232
 
    __doc__ = """Show appropriate completions for context.
 
3893
    """Show appropriate completions for context.
4233
3894
 
4234
3895
    For a list of all available commands, say 'bzr shell-complete'.
4235
3896
    """
4244
3905
 
4245
3906
 
4246
3907
class cmd_missing(Command):
4247
 
    __doc__ = """Show unmerged/unpulled revisions between two branches.
 
3908
    """Show unmerged/unpulled revisions between two branches.
4248
3909
 
4249
3910
    OTHER_BRANCH may be local or remote.
4250
3911
 
4251
3912
    To filter on a range of revisions, you can use the command -r begin..end
4252
3913
    -r revision requests a specific revision, -r ..end or -r begin.. are
4253
3914
    also valid.
4254
 
            
4255
 
    :Exit values:
4256
 
        1 - some missing revisions
4257
 
        0 - no missing revisions
4258
3915
 
4259
3916
    :Examples:
4260
3917
 
4328
3985
            restrict = 'remote'
4329
3986
 
4330
3987
        local_branch = Branch.open_containing(u".")[0]
4331
 
        self.add_cleanup(local_branch.lock_read().unlock)
4332
 
 
4333
3988
        parent = local_branch.get_parent()
4334
3989
        if other_branch is None:
4335
3990
            other_branch = parent
4344
3999
        remote_branch = Branch.open(other_branch)
4345
4000
        if remote_branch.base == local_branch.base:
4346
4001
            remote_branch = local_branch
4347
 
        else:
4348
 
            self.add_cleanup(remote_branch.lock_read().unlock)
4349
4002
 
4350
4003
        local_revid_range = _revision_range_to_revid_range(
4351
4004
            _get_revision_range(my_revision, local_branch,
4355
4008
            _get_revision_range(revision,
4356
4009
                remote_branch, self.name()))
4357
4010
 
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()
 
4011
        local_branch.lock_read()
 
4012
        try:
 
4013
            remote_branch.lock_read()
 
4014
            try:
 
4015
                local_extra, remote_extra = find_unmerged(
 
4016
                    local_branch, remote_branch, restrict,
 
4017
                    backward=not reverse,
 
4018
                    include_merges=include_merges,
 
4019
                    local_revid_range=local_revid_range,
 
4020
                    remote_revid_range=remote_revid_range)
 
4021
 
 
4022
                if log_format is None:
 
4023
                    registry = log.log_formatter_registry
 
4024
                    log_format = registry.get_default(local_branch)
 
4025
                lf = log_format(to_file=self.outf,
 
4026
                                show_ids=show_ids,
 
4027
                                show_timezone='original')
 
4028
 
 
4029
                status_code = 0
 
4030
                if local_extra and not theirs_only:
 
4031
                    message("You have %d extra revision(s):\n" %
 
4032
                        len(local_extra))
 
4033
                    for revision in iter_log_revisions(local_extra,
 
4034
                                        local_branch.repository,
 
4035
                                        verbose):
 
4036
                        lf.log_revision(revision)
 
4037
                    printed_local = True
 
4038
                    status_code = 1
 
4039
                else:
 
4040
                    printed_local = False
 
4041
 
 
4042
                if remote_extra and not mine_only:
 
4043
                    if printed_local is True:
 
4044
                        message("\n\n\n")
 
4045
                    message("You are missing %d revision(s):\n" %
 
4046
                        len(remote_extra))
 
4047
                    for revision in iter_log_revisions(remote_extra,
 
4048
                                        remote_branch.repository,
 
4049
                                        verbose):
 
4050
                        lf.log_revision(revision)
 
4051
                    status_code = 1
 
4052
 
 
4053
                if mine_only and not local_extra:
 
4054
                    # We checked local, and found nothing extra
 
4055
                    message('This branch is up to date.\n')
 
4056
                elif theirs_only and not remote_extra:
 
4057
                    # We checked remote, and found nothing extra
 
4058
                    message('Other branch is up to date.\n')
 
4059
                elif not (mine_only or theirs_only or local_extra or
 
4060
                          remote_extra):
 
4061
                    # We checked both branches, and neither one had extra
 
4062
                    # revisions
 
4063
                    message("Branches are up to date.\n")
 
4064
            finally:
 
4065
                remote_branch.unlock()
 
4066
        finally:
 
4067
            local_branch.unlock()
4408
4068
        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)
 
4069
            local_branch.lock_write()
 
4070
            try:
 
4071
                # handle race conditions - a parent might be set while we run.
 
4072
                if local_branch.get_parent() is None:
 
4073
                    local_branch.set_parent(remote_branch.base)
 
4074
            finally:
 
4075
                local_branch.unlock()
4413
4076
        return status_code
4414
4077
 
4415
4078
 
4416
4079
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
 
    """
 
4080
    """Compress the data within a repository."""
4434
4081
 
4435
4082
    _see_also = ['repositories']
4436
4083
    takes_args = ['branch_or_repo?']
4437
 
    takes_options = [
4438
 
        Option('clean-obsolete-packs', 'Delete obsolete packs to save disk space.'),
4439
 
        ]
4440
4084
 
4441
 
    def run(self, branch_or_repo='.', clean_obsolete_packs=False):
 
4085
    def run(self, branch_or_repo='.'):
4442
4086
        dir = bzrdir.BzrDir.open_containing(branch_or_repo)[0]
4443
4087
        try:
4444
4088
            branch = dir.open_branch()
4445
4089
            repository = branch.repository
4446
4090
        except errors.NotBranchError:
4447
4091
            repository = dir.open_repository()
4448
 
        repository.pack(clean_obsolete_packs=clean_obsolete_packs)
 
4092
        repository.pack()
4449
4093
 
4450
4094
 
4451
4095
class cmd_plugins(Command):
4452
 
    __doc__ = """List the installed plugins.
 
4096
    """List the installed plugins.
4453
4097
 
4454
4098
    This command displays the list of installed plugins including
4455
4099
    version of plugin and a short description of each.
4462
4106
    adding new commands, providing additional network transports and
4463
4107
    customizing log output.
4464
4108
 
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.
 
4109
    See the Bazaar web site, http://bazaar-vcs.org, for further
 
4110
    information on plugins including where to find them and how to
 
4111
    install them. Instructions are also provided there on how to
 
4112
    write new plugins using the Python programming language.
4469
4113
    """
4470
4114
    takes_options = ['verbose']
4471
4115
 
4486
4130
                doc = '(no description)'
4487
4131
            result.append((name_ver, doc, plugin.path()))
4488
4132
        for name_ver, doc, path in sorted(result):
4489
 
            self.outf.write("%s\n" % name_ver)
4490
 
            self.outf.write("   %s\n" % doc)
 
4133
            print name_ver
 
4134
            print '   ', doc
4491
4135
            if verbose:
4492
 
                self.outf.write("   %s\n" % path)
4493
 
            self.outf.write("\n")
 
4136
                print '   ', path
 
4137
            print
4494
4138
 
4495
4139
 
4496
4140
class cmd_testament(Command):
4497
 
    __doc__ = """Show testament (signing-form) of a revision."""
 
4141
    """Show testament (signing-form) of a revision."""
4498
4142
    takes_options = [
4499
4143
            'revision',
4500
4144
            Option('long', help='Produce long-format testament.'),
4512
4156
            b = Branch.open_containing(branch)[0]
4513
4157
        else:
4514
4158
            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())
 
4159
        b.lock_read()
 
4160
        try:
 
4161
            if revision is None:
 
4162
                rev_id = b.last_revision()
 
4163
            else:
 
4164
                rev_id = revision[0].as_revision_id(b)
 
4165
            t = testament_class.from_revision(b.repository, rev_id)
 
4166
            if long:
 
4167
                sys.stdout.writelines(t.as_text_lines())
 
4168
            else:
 
4169
                sys.stdout.write(t.as_short_text())
 
4170
        finally:
 
4171
            b.unlock()
4525
4172
 
4526
4173
 
4527
4174
class cmd_annotate(Command):
4528
 
    __doc__ = """Show the origin of each line in a file.
 
4175
    """Show the origin of each line in a file.
4529
4176
 
4530
4177
    This prints out the given file with an annotation on the left side
4531
4178
    indicating which revision, author and date introduced the change.
4552
4199
        wt, branch, relpath = \
4553
4200
            bzrdir.BzrDir.open_containing_tree_or_branch(filename)
4554
4201
        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)
 
4202
            wt.lock_read()
 
4203
        else:
 
4204
            branch.lock_read()
 
4205
        try:
 
4206
            tree = _get_one_revision_tree('annotate', revision, branch=branch)
 
4207
            if wt is not None:
 
4208
                file_id = wt.path2id(relpath)
 
4209
            else:
 
4210
                file_id = tree.path2id(relpath)
 
4211
            if file_id is None:
 
4212
                raise errors.NotVersionedError(filename)
 
4213
            file_version = tree.inventory[file_id].revision
 
4214
            if wt is not None and revision is None:
 
4215
                # If there is a tree and we're not annotating historical
 
4216
                # versions, annotate the working tree's content.
 
4217
                annotate_file_tree(wt, file_id, self.outf, long, all,
 
4218
                    show_ids=show_ids)
 
4219
            else:
 
4220
                annotate_file(branch, file_version, file_id, long, all, self.outf,
 
4221
                              show_ids=show_ids)
 
4222
        finally:
 
4223
            if wt is not None:
 
4224
                wt.unlock()
 
4225
            else:
 
4226
                branch.unlock()
4575
4227
 
4576
4228
 
4577
4229
class cmd_re_sign(Command):
4578
 
    __doc__ = """Create a digital signature for an existing revision."""
 
4230
    """Create a digital signature for an existing revision."""
4579
4231
    # TODO be able to replace existing ones.
4580
4232
 
4581
4233
    hidden = True # is this right ?
4588
4240
        if revision_id_list is None and revision is None:
4589
4241
            raise errors.BzrCommandError('You must supply either --revision or a revision_id')
4590
4242
        b = WorkingTree.open_containing(u'.')[0].branch
4591
 
        self.add_cleanup(b.lock_write().unlock)
4592
 
        return self._run(b, revision_id_list, revision)
 
4243
        b.lock_write()
 
4244
        try:
 
4245
            return self._run(b, revision_id_list, revision)
 
4246
        finally:
 
4247
            b.unlock()
4593
4248
 
4594
4249
    def _run(self, b, revision_id_list, revision):
4595
4250
        import bzrlib.gpg as gpg
4640
4295
 
4641
4296
 
4642
4297
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.
 
4298
    """Convert the current branch into a checkout of the supplied branch.
4645
4299
 
4646
4300
    Once converted into a checkout, commits must succeed on the master branch
4647
4301
    before they will be applied to the local branch.
4648
4302
 
4649
4303
    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
 
4304
    locally, in which case binding will update the the local nickname to be
4651
4305
    that of the master.
4652
4306
    """
4653
4307
 
4665
4319
                    'This format does not remember old locations.')
4666
4320
            else:
4667
4321
                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')
 
4322
                    raise errors.BzrCommandError('No location supplied and no '
 
4323
                        'previous location known')
4673
4324
        b_other = Branch.open(location)
4674
4325
        try:
4675
4326
            b.bind(b_other)
4681
4332
 
4682
4333
 
4683
4334
class cmd_unbind(Command):
4684
 
    __doc__ = """Convert the current checkout into a regular branch.
 
4335
    """Convert the current checkout into a regular branch.
4685
4336
 
4686
4337
    After unbinding, the local branch is considered independent and subsequent
4687
4338
    commits will be local only.
4698
4349
 
4699
4350
 
4700
4351
class cmd_uncommit(Command):
4701
 
    __doc__ = """Remove the last committed revision.
 
4352
    """Remove the last committed revision.
4702
4353
 
4703
4354
    --verbose will print out what is being removed.
4704
4355
    --dry-run will go through all the motions, but not actually
4744
4395
            b = control.open_branch()
4745
4396
 
4746
4397
        if tree is not None:
4747
 
            self.add_cleanup(tree.lock_write().unlock)
 
4398
            tree.lock_write()
4748
4399
        else:
4749
 
            self.add_cleanup(b.lock_write().unlock)
4750
 
        return self._run(b, tree, dry_run, verbose, revision, force, local=local)
 
4400
            b.lock_write()
 
4401
        try:
 
4402
            return self._run(b, tree, dry_run, verbose, revision, force,
 
4403
                             local=local)
 
4404
        finally:
 
4405
            if tree is not None:
 
4406
                tree.unlock()
 
4407
            else:
 
4408
                b.unlock()
4751
4409
 
4752
4410
    def _run(self, b, tree, dry_run, verbose, revision, force, local=False):
4753
4411
        from bzrlib.log import log_formatter, show_log
4785
4443
                 end_revision=last_revno)
4786
4444
 
4787
4445
        if dry_run:
4788
 
            self.outf.write('Dry-run, pretending to remove'
4789
 
                            ' the above revisions.\n')
 
4446
            print 'Dry-run, pretending to remove the above revisions.'
 
4447
            if not force:
 
4448
                val = raw_input('Press <enter> to continue')
4790
4449
        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
 
4450
            print 'The above revision(s) will be removed.'
 
4451
            if not force:
 
4452
                val = raw_input('Are you sure [y/N]? ')
 
4453
                if val.lower() not in ('y', 'yes'):
 
4454
                    print 'Canceled'
 
4455
                    return 0
4797
4456
 
4798
4457
        mutter('Uncommitting from {%s} to {%s}',
4799
4458
               last_rev_id, rev_id)
4800
4459
        uncommit(b, tree=tree, dry_run=dry_run, verbose=verbose,
4801
4460
                 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)
 
4461
        note('You can restore the old tip by running:\n'
 
4462
             '  bzr pull . -r revid:%s', last_rev_id)
4804
4463
 
4805
4464
 
4806
4465
class cmd_break_lock(Command):
4807
 
    __doc__ = """Break a dead lock on a repository, branch or working directory.
 
4466
    """Break a dead lock on a repository, branch or working directory.
4808
4467
 
4809
4468
    CAUTION: Locks should only be broken when you are sure that the process
4810
4469
    holding the lock has been stopped.
4811
4470
 
4812
 
    You can get information on what locks are open via the 'bzr info
4813
 
    [location]' command.
 
4471
    You can get information on what locks are open via the 'bzr info' command.
4814
4472
 
4815
4473
    :Examples:
4816
4474
        bzr break-lock
4817
 
        bzr break-lock bzr+ssh://example.com/bzr/foo
4818
4475
    """
4819
4476
    takes_args = ['location?']
4820
4477
 
4829
4486
 
4830
4487
 
4831
4488
class cmd_wait_until_signalled(Command):
4832
 
    __doc__ = """Test helper for test_start_and_stop_bzr_subprocess_send_signal.
 
4489
    """Test helper for test_start_and_stop_bzr_subprocess_send_signal.
4833
4490
 
4834
4491
    This just prints a line to signal when it is ready, then blocks on stdin.
4835
4492
    """
4843
4500
 
4844
4501
 
4845
4502
class cmd_serve(Command):
4846
 
    __doc__ = """Run the bzr server."""
 
4503
    """Run the bzr server."""
4847
4504
 
4848
4505
    aliases = ['server']
4849
4506
 
4850
4507
    takes_options = [
4851
4508
        Option('inet',
4852
4509
               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
4510
        Option('port',
4858
4511
               help='Listen for connections on nominated port of the form '
4859
4512
                    '[hostname:]portnumber.  Passing 0 as the port number will '
4860
 
                    'result in a dynamically allocated port.  The default port '
4861
 
                    'depends on the protocol.',
 
4513
                    'result in a dynamically allocated port.  The default port is '
 
4514
                    '4155.',
4862
4515
               type=str),
4863
4516
        Option('directory',
4864
4517
               help='Serve contents of this directory.',
4866
4519
        Option('allow-writes',
4867
4520
               help='By default the server is a readonly server.  Supplying '
4868
4521
                    '--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.'
 
4522
                    'the served directory and below.'
4874
4523
                ),
4875
4524
        ]
4876
4525
 
 
4526
    def run_smart_server(self, smart_server):
 
4527
        """Run 'smart_server' forever, with no UI output at all."""
 
4528
        # For the duration of this server, no UI output is permitted. note
 
4529
        # that this may cause problems with blackbox tests. This should be
 
4530
        # changed with care though, as we dont want to use bandwidth sending
 
4531
        # progress over stderr to smart server clients!
 
4532
        from bzrlib import lockdir
 
4533
        old_factory = ui.ui_factory
 
4534
        old_lockdir_timeout = lockdir._DEFAULT_TIMEOUT_SECONDS
 
4535
        try:
 
4536
            ui.ui_factory = ui.SilentUIFactory()
 
4537
            lockdir._DEFAULT_TIMEOUT_SECONDS = 0
 
4538
            smart_server.serve()
 
4539
        finally:
 
4540
            ui.ui_factory = old_factory
 
4541
            lockdir._DEFAULT_TIMEOUT_SECONDS = old_lockdir_timeout
 
4542
 
4877
4543
    def get_host_and_port(self, port):
4878
4544
        """Return the host and port to run the smart server on.
4879
4545
 
4880
 
        If 'port' is None, None will be returned for the host and port.
 
4546
        If 'port' is None, the default host (`medium.BZR_DEFAULT_INTERFACE`)
 
4547
        and port (`medium.BZR_DEFAULT_PORT`) will be used.
4881
4548
 
4882
4549
        If 'port' has a colon in it, the string before the colon will be
4883
4550
        interpreted as the host.
4886
4553
        :return: A tuple of (host, port), where 'host' is a host name or IP,
4887
4554
            and port is an integer TCP/IP port.
4888
4555
        """
4889
 
        host = None
4890
 
        if port is not None:
 
4556
        from bzrlib.smart import medium
 
4557
        host = medium.BZR_DEFAULT_INTERFACE
 
4558
        if port is None:
 
4559
            port = medium.BZR_DEFAULT_PORT
 
4560
        else:
4891
4561
            if ':' in port:
4892
4562
                host, port = port.split(':')
4893
4563
            port = int(port)
4894
4564
        return host, port
4895
4565
 
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
 
4566
    def get_smart_server(self, transport, inet, port):
 
4567
        """Construct a smart server.
 
4568
 
 
4569
        :param transport: The base transport from which branches will be
 
4570
            served.
 
4571
        :param inet: If True, serve over stdin and stdout. Used for running
 
4572
            from inet.
 
4573
        :param port: The port to listen on. By default, it's `
 
4574
            medium.BZR_DEFAULT_PORT`. See `get_host_and_port` for more
 
4575
            information.
 
4576
        :return: A smart server.
 
4577
        """
 
4578
        from bzrlib.smart import medium, server
 
4579
        if inet:
 
4580
            smart_server = medium.SmartServerPipeStreamMedium(
 
4581
                sys.stdin, sys.stdout, transport)
 
4582
        else:
 
4583
            host, port = self.get_host_and_port(port)
 
4584
            smart_server = server.SmartTCPServer(
 
4585
                transport, host=host, port=port)
 
4586
            note('listening on port: %s' % smart_server.port)
 
4587
        return smart_server
 
4588
 
 
4589
    def run(self, port=None, inet=False, directory=None, allow_writes=False):
 
4590
        from bzrlib.transport import get_transport
 
4591
        from bzrlib.transport.chroot import ChrootServer
4899
4592
        if directory is None:
4900
4593
            directory = os.getcwd()
4901
 
        if protocol is None:
4902
 
            protocol = transport_server_registry.get()
4903
 
        host, port = self.get_host_and_port(port)
4904
4594
        url = urlutils.local_path_to_url(directory)
4905
4595
        if not allow_writes:
4906
4596
            url = 'readonly+' + url
4907
 
        transport = get_transport(url)
4908
 
        protocol(transport, host, port, inet)
 
4597
        chroot_server = ChrootServer(get_transport(url))
 
4598
        chroot_server.setUp()
 
4599
        t = get_transport(chroot_server.get_url())
 
4600
        smart_server = self.get_smart_server(t, inet, port)
 
4601
        self.run_smart_server(smart_server)
4909
4602
 
4910
4603
 
4911
4604
class cmd_join(Command):
4912
 
    __doc__ = """Combine a tree into its containing tree.
 
4605
    """Combine a tree into its containing tree.
4913
4606
 
4914
4607
    This command requires the target tree to be in a rich-root format.
4915
4608
 
4955
4648
 
4956
4649
 
4957
4650
class cmd_split(Command):
4958
 
    __doc__ = """Split a subdirectory of a tree into a separate tree.
 
4651
    """Split a subdirectory of a tree into a separate tree.
4959
4652
 
4960
4653
    This command will produce a target tree in a format that supports
4961
4654
    rich roots, like 'rich-root' or 'rich-root-pack'.  These formats cannot be
4977
4670
        try:
4978
4671
            containing_tree.extract(sub_id)
4979
4672
        except errors.RootNotRich:
4980
 
            raise errors.RichRootUpgradeRequired(containing_tree.branch.base)
 
4673
            raise errors.UpgradeRequired(containing_tree.branch.base)
4981
4674
 
4982
4675
 
4983
4676
class cmd_merge_directive(Command):
4984
 
    __doc__ = """Generate a merge directive for auto-merge tools.
 
4677
    """Generate a merge directive for auto-merge tools.
4985
4678
 
4986
4679
    A directive requests a merge to be performed, and also provides all the
4987
4680
    information necessary to do so.  This means it must either include a
5080
4773
 
5081
4774
 
5082
4775
class cmd_send(Command):
5083
 
    __doc__ = """Mail or create a merge-directive for submitting changes.
 
4776
    """Mail or create a merge-directive for submitting changes.
5084
4777
 
5085
4778
    A merge directive provides many things needed for requesting merges:
5086
4779
 
5092
4785
      directly from the merge directive, without retrieving data from a
5093
4786
      branch.
5094
4787
 
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.
 
4788
    If --no-bundle is specified, then public_branch is needed (and must be
 
4789
    up-to-date), so that the receiver can perform the merge using the
 
4790
    public_branch.  The public_branch is always included if known, so that
 
4791
    people can check it later.
 
4792
 
 
4793
    The submit branch defaults to the parent, but can be overridden.  Both
 
4794
    submit branch and public branch will be remembered if supplied.
 
4795
 
 
4796
    If a public_branch is known for the submit_branch, that public submit
 
4797
    branch is used in the merge instructions.  This means that a local mirror
 
4798
    can be used as your actual submit branch, once you have set public_branch
 
4799
    for that mirror.
5121
4800
 
5122
4801
    Mail is sent using your preferred mail program.  This should be transparent
5123
4802
    on Windows (it uses MAPI).  On Linux, it requires the xdg-email utility.
5125
4804
 
5126
4805
    To use a specific mail program, set the mail_client configuration option.
5127
4806
    (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.
 
4807
    specific clients are "claws", "evolution", "kmail", "mutt", and
 
4808
    "thunderbird"; generic options are "default", "editor", "emacsclient",
 
4809
    "mapi", and "xdg-email".  Plugins may also add supported clients.
5132
4810
 
5133
4811
    If mail is being sent, a to address is required.  This can be supplied
5134
4812
    either on the commandline, by setting the submit_to configuration
5143
4821
 
5144
4822
    The merge directives created by bzr send may be applied using bzr merge or
5145
4823
    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
4824
    """
5151
4825
 
5152
4826
    encoding_type = 'exact'
5168
4842
               short_name='f',
5169
4843
               type=unicode),
5170
4844
        Option('output', short_name='o',
5171
 
               help='Write merge directive to this file or directory; '
 
4845
               help='Write merge directive to this file; '
5172
4846
                    'use - for stdout.',
5173
4847
               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
4848
        Option('mail-to', help='Mail the request to this address.',
5178
4849
               type=unicode),
5179
4850
        'revision',
5180
4851
        'message',
5181
4852
        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')),
 
4853
        RegistryOption.from_kwargs('format',
 
4854
        'Use the specified output format.',
 
4855
        **{'4': 'Bundle format 4, Merge Directive 2 (default)',
 
4856
           '0.9': 'Bundle format 0.9, Merge Directive 1',})
5185
4857
        ]
5186
4858
 
5187
4859
    def run(self, submit_branch=None, public_branch=None, no_bundle=False,
5188
4860
            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)
 
4861
            format='4', mail_to=None, message=None, body=None, **kwargs):
 
4862
        return self._run(submit_branch, revision, public_branch, remember,
 
4863
                         format, no_bundle, no_patch, output,
 
4864
                         kwargs.get('from', '.'), mail_to, message, body)
 
4865
 
 
4866
    def _run(self, submit_branch, revision, public_branch, remember, format,
 
4867
             no_bundle, no_patch, output, from_, mail_to, message, body):
 
4868
        from bzrlib.revision import NULL_REVISION
 
4869
        branch = Branch.open_containing(from_)[0]
 
4870
        if output is None:
 
4871
            outfile = cStringIO.StringIO()
 
4872
        elif output == '-':
 
4873
            outfile = self.outf
 
4874
        else:
 
4875
            outfile = open(output, 'wb')
 
4876
        # we may need to write data into branch's repository to calculate
 
4877
        # the data to send.
 
4878
        branch.lock_write()
 
4879
        try:
 
4880
            if output is None:
 
4881
                config = branch.get_config()
 
4882
                if mail_to is None:
 
4883
                    mail_to = config.get_user_option('submit_to')
 
4884
                mail_client = config.get_mail_client()
 
4885
                if (not getattr(mail_client, 'supports_body', False)
 
4886
                    and body is not None):
 
4887
                    raise errors.BzrCommandError(
 
4888
                        'Mail client "%s" does not support specifying body' %
 
4889
                        mail_client.__class__.__name__)
 
4890
            if remember and submit_branch is None:
 
4891
                raise errors.BzrCommandError(
 
4892
                    '--remember requires a branch to be specified.')
 
4893
            stored_submit_branch = branch.get_submit_branch()
 
4894
            remembered_submit_branch = None
 
4895
            if submit_branch is None:
 
4896
                submit_branch = stored_submit_branch
 
4897
                remembered_submit_branch = "submit"
 
4898
            else:
 
4899
                if stored_submit_branch is None or remember:
 
4900
                    branch.set_submit_branch(submit_branch)
 
4901
            if submit_branch is None:
 
4902
                submit_branch = branch.get_parent()
 
4903
                remembered_submit_branch = "parent"
 
4904
            if submit_branch is None:
 
4905
                raise errors.BzrCommandError('No submit branch known or'
 
4906
                                             ' specified')
 
4907
            if remembered_submit_branch is not None:
 
4908
                note('Using saved %s location "%s" to determine what '
 
4909
                        'changes to submit.', remembered_submit_branch,
 
4910
                        submit_branch)
 
4911
 
 
4912
            if mail_to is None:
 
4913
                submit_config = Branch.open(submit_branch).get_config()
 
4914
                mail_to = submit_config.get_user_option("child_submit_to")
 
4915
 
 
4916
            stored_public_branch = branch.get_public_branch()
 
4917
            if public_branch is None:
 
4918
                public_branch = stored_public_branch
 
4919
            elif stored_public_branch is None or remember:
 
4920
                branch.set_public_branch(public_branch)
 
4921
            if no_bundle and public_branch is None:
 
4922
                raise errors.BzrCommandError('No public branch specified or'
 
4923
                                             ' known')
 
4924
            base_revision_id = None
 
4925
            revision_id = None
 
4926
            if revision is not None:
 
4927
                if len(revision) > 2:
 
4928
                    raise errors.BzrCommandError('bzr send takes '
 
4929
                        'at most two one revision identifiers')
 
4930
                revision_id = revision[-1].as_revision_id(branch)
 
4931
                if len(revision) == 2:
 
4932
                    base_revision_id = revision[0].as_revision_id(branch)
 
4933
            if revision_id is None:
 
4934
                revision_id = branch.last_revision()
 
4935
            if revision_id == NULL_REVISION:
 
4936
                raise errors.BzrCommandError('No revisions to submit.')
 
4937
            if format == '4':
 
4938
                directive = merge_directive.MergeDirective2.from_objects(
 
4939
                    branch.repository, revision_id, time.time(),
 
4940
                    osutils.local_time_offset(), submit_branch,
 
4941
                    public_branch=public_branch, include_patch=not no_patch,
 
4942
                    include_bundle=not no_bundle, message=message,
 
4943
                    base_revision_id=base_revision_id)
 
4944
            elif format == '0.9':
 
4945
                if not no_bundle:
 
4946
                    if not no_patch:
 
4947
                        patch_type = 'bundle'
 
4948
                    else:
 
4949
                        raise errors.BzrCommandError('Format 0.9 does not'
 
4950
                            ' permit bundle with no patch')
 
4951
                else:
 
4952
                    if not no_patch:
 
4953
                        patch_type = 'diff'
 
4954
                    else:
 
4955
                        patch_type = None
 
4956
                directive = merge_directive.MergeDirective.from_objects(
 
4957
                    branch.repository, revision_id, time.time(),
 
4958
                    osutils.local_time_offset(), submit_branch,
 
4959
                    public_branch=public_branch, patch_type=patch_type,
 
4960
                    message=message)
 
4961
 
 
4962
            outfile.writelines(directive.to_lines())
 
4963
            if output is None:
 
4964
                subject = '[MERGE] '
 
4965
                if message is not None:
 
4966
                    subject += message
 
4967
                else:
 
4968
                    revision = branch.repository.get_revision(revision_id)
 
4969
                    subject += revision.get_summary()
 
4970
                basename = directive.get_disk_name(branch)
 
4971
                mail_client.compose_merge_request(mail_to, subject,
 
4972
                                                  outfile.getvalue(),
 
4973
                                                  basename, body)
 
4974
        finally:
 
4975
            if output != '-':
 
4976
                outfile.close()
 
4977
            branch.unlock()
5197
4978
 
5198
4979
 
5199
4980
class cmd_bundle_revisions(cmd_send):
5200
 
    __doc__ = """Create a merge-directive for submitting changes.
 
4981
 
 
4982
    """Create a merge-directive for submitting changes.
5201
4983
 
5202
4984
    A merge directive provides many things needed for requesting merges:
5203
4985
 
5243
5025
               type=unicode),
5244
5026
        Option('output', short_name='o', help='Write directive to this file.',
5245
5027
               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
5028
        'revision',
5250
 
        RegistryOption('format',
5251
 
                       help='Use the specified output format.',
5252
 
                       lazy_registry=('bzrlib.send', 'format_registry')),
 
5029
        RegistryOption.from_kwargs('format',
 
5030
        'Use the specified output format.',
 
5031
        **{'4': 'Bundle format 4, Merge Directive 2 (default)',
 
5032
           '0.9': 'Bundle format 0.9, Merge Directive 1',})
5253
5033
        ]
5254
5034
    aliases = ['bundle']
5255
5035
 
5259
5039
 
5260
5040
    def run(self, submit_branch=None, public_branch=None, no_bundle=False,
5261
5041
            no_patch=False, revision=None, remember=False, output=None,
5262
 
            format=None, strict=None, **kwargs):
 
5042
            format='4', **kwargs):
5263
5043
        if output is None:
5264
5044
            output = '-'
5265
 
        from bzrlib.send import send
5266
 
        return send(submit_branch, revision, public_branch, remember,
 
5045
        return self._run(submit_branch, revision, public_branch, remember,
5267
5046
                         format, no_bundle, no_patch, output,
5268
 
                         kwargs.get('from', '.'), None, None, None,
5269
 
                         self.outf, strict=strict)
 
5047
                         kwargs.get('from', '.'), None, None, None)
5270
5048
 
5271
5049
 
5272
5050
class cmd_tag(Command):
5273
 
    __doc__ = """Create, remove or modify a tag naming a revision.
 
5051
    """Create, remove or modify a tag naming a revision.
5274
5052
 
5275
5053
    Tags give human-meaningful names to revisions.  Commands that take a -r
5276
5054
    (--revision) option can be given -rtag:X, where X is any previously
5284
5062
 
5285
5063
    To rename a tag (change the name but keep it on the same revsion), run ``bzr
5286
5064
    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
5065
    """
5293
5066
 
5294
5067
    _see_also = ['commit', 'tags']
5295
 
    takes_args = ['tag_name?']
 
5068
    takes_args = ['tag_name']
5296
5069
    takes_options = [
5297
5070
        Option('delete',
5298
5071
            help='Delete this tag rather than placing it.',
5308
5081
        'revision',
5309
5082
        ]
5310
5083
 
5311
 
    def run(self, tag_name=None,
 
5084
    def run(self, tag_name,
5312
5085
            delete=None,
5313
5086
            directory='.',
5314
5087
            force=None,
5315
5088
            revision=None,
5316
5089
            ):
5317
5090
        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)
 
5091
        branch.lock_write()
 
5092
        try:
 
5093
            if delete:
 
5094
                branch.tags.delete_tag(tag_name)
 
5095
                self.outf.write('Deleted tag %s.\n' % tag_name)
5331
5096
            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)
 
5097
                if revision:
 
5098
                    if len(revision) != 1:
 
5099
                        raise errors.BzrCommandError(
 
5100
                            "Tags can only be placed on a single revision, "
 
5101
                            "not on a range")
 
5102
                    revision_id = revision[0].as_revision_id(branch)
 
5103
                else:
 
5104
                    revision_id = branch.last_revision()
 
5105
                if (not force) and branch.tags.has_tag(tag_name):
 
5106
                    raise errors.TagAlreadyExists(tag_name)
 
5107
                branch.tags.set_tag(tag_name, revision_id)
 
5108
                self.outf.write('Created tag %s.\n' % tag_name)
 
5109
        finally:
 
5110
            branch.unlock()
5342
5111
 
5343
5112
 
5344
5113
class cmd_tags(Command):
5345
 
    __doc__ = """List tags.
 
5114
    """List tags.
5346
5115
 
5347
5116
    This command shows a table of tag names and the revisions they reference.
5348
5117
    """
5376
5145
        if not tags:
5377
5146
            return
5378
5147
 
5379
 
        self.add_cleanup(branch.lock_read().unlock)
5380
5148
        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)]
 
5149
            branch.lock_read()
 
5150
            try:
 
5151
                graph = branch.repository.get_graph()
 
5152
                rev1, rev2 = _get_revision_range(revision, branch, self.name())
 
5153
                revid1, revid2 = rev1.rev_id, rev2.rev_id
 
5154
                # only show revisions between revid1 and revid2 (inclusive)
 
5155
                tags = [(tag, revid) for tag, revid in tags if
 
5156
                    graph.is_between(revid, revid1, revid2)]
 
5157
            finally:
 
5158
                branch.unlock()
5387
5159
        if sort == 'alpha':
5388
5160
            tags.sort()
5389
5161
        elif sort == 'time':
5399
5171
            tags.sort(key=lambda x: timestamps[x[1]])
5400
5172
        if not show_ids:
5401
5173
            # [ (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()
 
5174
            revno_map = branch.get_revision_id_to_revno_map()
 
5175
            tags = [ (tag, '.'.join(map(str, revno_map.get(revid, ('?',)))))
 
5176
                        for tag, revid in tags ]
5413
5177
        for tag, revspec in tags:
5414
5178
            self.outf.write('%-20s %s\n' % (tag, revspec))
5415
5179
 
5416
5180
 
5417
5181
class cmd_reconfigure(Command):
5418
 
    __doc__ = """Reconfigure the type of a bzr directory.
 
5182
    """Reconfigure the type of a bzr directory.
5419
5183
 
5420
5184
    A target configuration must be specified.
5421
5185
 
5451
5215
            ),
5452
5216
        Option('bind-to', help='Branch to bind checkout to.', type=str),
5453
5217
        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
 
            ),
 
5218
               help='Perform reconfiguration even if local changes'
 
5219
               ' will be lost.')
5464
5220
        ]
5465
5221
 
5466
 
    def run(self, location=None, target_type=None, bind_to=None, force=False,
5467
 
            stacked_on=None,
5468
 
            unstacked=None):
 
5222
    def run(self, location=None, target_type=None, bind_to=None, force=False):
5469
5223
        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
5224
        if target_type is None:
5480
 
            if stacked_on or unstacked:
5481
 
                return
5482
 
            else:
5483
 
                raise errors.BzrCommandError('No target configuration '
5484
 
                    'specified')
 
5225
            raise errors.BzrCommandError('No target configuration specified')
5485
5226
        elif target_type == 'branch':
5486
5227
            reconfiguration = reconfigure.Reconfigure.to_branch(directory)
5487
5228
        elif target_type == 'tree':
5506
5247
 
5507
5248
 
5508
5249
class cmd_switch(Command):
5509
 
    __doc__ = """Set the branch of a checkout and update.
 
5250
    """Set the branch of a checkout and update.
5510
5251
 
5511
5252
    For lightweight checkouts, this changes the branch being referenced.
5512
5253
    For heavyweight checkouts, this checks that there are no local commits
5524
5265
    /path/to/newbranch.
5525
5266
 
5526
5267
    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
 
5268
    locally, in which case switching will update the the local nickname to be
5528
5269
    that of the master.
5529
5270
    """
5530
5271
 
5531
 
    takes_args = ['to_location?']
 
5272
    takes_args = ['to_location']
5532
5273
    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
 
                    ]
 
5274
                        help='Switch even if local commits will be lost.')
 
5275
                     ]
5539
5276
 
5540
 
    def run(self, to_location=None, force=False, create_branch=False,
5541
 
            revision=None):
 
5277
    def run(self, to_location, force=False):
5542
5278
        from bzrlib import switch
5543
5279
        tree_location = '.'
5544
 
        revision = _get_one_revision('switch', revision)
5545
5280
        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 = '.'
 
5281
        branch = control_dir.open_branch()
5551
5282
        try:
5552
 
            branch = control_dir.open_branch()
5553
 
            had_explicit_nick = branch.get_config().has_explicit_nickname()
 
5283
            to_branch = Branch.open(to_location)
5554
5284
        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:
 
5285
            this_branch = control_dir.open_branch()
 
5286
            # This may be a heavy checkout, where we want the master branch
 
5287
            this_url = this_branch.get_bound_location()
 
5288
            # If not, use a local sibling
 
5289
            if this_url is None:
 
5290
                this_url = this_branch.base
 
5291
            to_branch = Branch.open(
 
5292
                urlutils.join(this_url, '..', to_location))
 
5293
        switch.switch(control_dir, to_branch, force)
 
5294
        if branch.get_config().has_explicit_nickname():
5581
5295
            branch = control_dir.open_branch() #get the new branch!
5582
5296
            branch.nick = to_branch.nick
5583
5297
        note('Switched to branch: %s',
5584
5298
            urlutils.unescape_for_display(to_branch.base, 'utf-8'))
5585
5299
 
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
5300
 
5604
5301
class cmd_view(Command):
5605
 
    __doc__ = """Manage filtered views.
 
5302
    """Manage filtered views.
5606
5303
 
5607
5304
    Views provide a mask over the tree so that users can focus on
5608
5305
    a subset of a tree when doing their work. After creating a view,
5756
5453
 
5757
5454
 
5758
5455
class cmd_hooks(Command):
5759
 
    __doc__ = """Show hooks."""
 
5456
    """Show hooks."""
5760
5457
 
5761
5458
    hidden = True
5762
5459
 
5775
5472
                    self.outf.write("    <no hooks installed>\n")
5776
5473
 
5777
5474
 
5778
 
class cmd_remove_branch(Command):
5779
 
    __doc__ = """Remove a branch.
5780
 
 
5781
 
    This will remove the branch from the specified location but 
5782
 
    will keep any working tree or repository in place.
5783
 
 
5784
 
    :Examples:
5785
 
 
5786
 
      Remove the branch at repo/trunk::
5787
 
 
5788
 
        bzr remove-branch repo/trunk
5789
 
 
5790
 
    """
5791
 
 
5792
 
    takes_args = ["location?"]
5793
 
 
5794
 
    aliases = ["rmbranch"]
5795
 
 
5796
 
    def run(self, location=None):
5797
 
        if location is None:
5798
 
            location = "."
5799
 
        branch = Branch.open_containing(location)[0]
5800
 
        branch.bzrdir.destroy_branch()
5801
 
        
5802
 
 
5803
5475
class cmd_shelve(Command):
5804
 
    __doc__ = """Temporarily set aside some changes from the current tree.
 
5476
    """Temporarily set aside some changes from the current tree.
5805
5477
 
5806
5478
    Shelve allows you to temporarily put changes you've made "on the shelf",
5807
5479
    ie. out of the way, until a later time when you can bring them back from
5849
5521
        if writer is None:
5850
5522
            writer = bzrlib.option.diff_writer_registry.get()
5851
5523
        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()
 
5524
            Shelver.from_args(writer(sys.stdout), revision, all, file_list,
 
5525
                              message, destroy=destroy).run()
5858
5526
        except errors.UserAbort:
5859
5527
            return 0
5860
5528
 
5861
5529
    def run_for_list(self):
5862
5530
        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
 
5531
        tree.lock_read()
 
5532
        try:
 
5533
            manager = tree.get_shelf_manager()
 
5534
            shelves = manager.active_shelves()
 
5535
            if len(shelves) == 0:
 
5536
                note('No shelved changes.')
 
5537
                return 0
 
5538
            for shelf_id in reversed(shelves):
 
5539
                message = manager.get_metadata(shelf_id).get('message')
 
5540
                if message is None:
 
5541
                    message = '<no message>'
 
5542
                self.outf.write('%3d: %s\n' % (shelf_id, message))
 
5543
            return 1
 
5544
        finally:
 
5545
            tree.unlock()
5875
5546
 
5876
5547
 
5877
5548
class cmd_unshelve(Command):
5878
 
    __doc__ = """Restore shelved changes.
 
5549
    """Restore shelved changes.
5879
5550
 
5880
5551
    By default, the most recently shelved changes are restored. However if you
5881
5552
    specify a shelf by id those changes will be restored instead.  This works
5889
5560
            enum_switch=False, value_switches=True,
5890
5561
            apply="Apply changes and remove from the shelf.",
5891
5562
            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.",
 
5563
            delete_only="Delete changes without applying them."
5896
5564
        )
5897
5565
    ]
5898
5566
    _see_also = ['shelve']
5899
5567
 
5900
5568
    def run(self, shelf_id=None, action='apply'):
5901
5569
        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()
 
5570
        Unshelver.from_args(shelf_id, action).run()
5907
5571
 
5908
5572
 
5909
5573
class cmd_clean_tree(Command):
5910
 
    __doc__ = """Remove unwanted files from working tree.
 
5574
    """Remove unwanted files from working tree.
5911
5575
 
5912
5576
    By default, only unknown files, not ignored files, are deleted.  Versioned
5913
5577
    files are never deleted.
5941
5605
 
5942
5606
 
5943
5607
class cmd_reference(Command):
5944
 
    __doc__ = """list, view and set branch locations for nested trees.
 
5608
    """list, view and set branch locations for nested trees.
5945
5609
 
5946
5610
    If no arguments are provided, lists the branch locations for nested trees.
5947
5611
    If one argument is provided, display the branch location for that tree.
5987
5651
            self.outf.write('%s %s\n' % (path, location))
5988
5652
 
5989
5653
 
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)
 
5654
# these get imported and then picked up by the scan for cmd_*
 
5655
# TODO: Some more consistent way to split command definitions across files;
 
5656
# we do need to load at least some information about them to know of
 
5657
# aliases.  ideally we would avoid loading the implementation until the
 
5658
# details were needed.
 
5659
from bzrlib.cmd_version_info import cmd_version_info
 
5660
from bzrlib.conflicts import cmd_resolve, cmd_conflicts, restore
 
5661
from bzrlib.bundle.commands import (
 
5662
    cmd_bundle_info,
 
5663
    )
 
5664
from bzrlib.foreign import cmd_dpush
 
5665
from bzrlib.sign_my_commits import cmd_sign_my_commits
 
5666
from bzrlib.weave_commands import cmd_versionedfile_list, \
 
5667
        cmd_weave_plan_merge, cmd_weave_merge_text