/brz/remove-bazaar

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

« back to all changes in this revision

Viewing changes to bzrlib/builtins.py

  • Committer: Aaron Bentley
  • Date: 2009-05-11 19:11:14 UTC
  • mto: This revision was merged to the branch mainline in revision 4351.
  • Revision ID: aaron@aaronbentley.com-20090511191114-g0u190bdpfou9bbw
Gracefully handle mail clients that don't support bodies.

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:
180
164
                view_str = views.view_display_str(view_files)
181
165
                note("Ignoring files outside view. View is %s" % view_str)
182
166
        return tree, file_list
183
 
    tree = WorkingTree.open_containing(file_list[0])[0]
 
167
    tree = WorkingTree.open_containing(osutils.realpath(file_list[0]))[0]
184
168
    return tree, safe_relpath_files(tree, file_list, canonicalize,
185
169
        apply_view=apply_view)
186
170
 
232
216
    return view_info
233
217
 
234
218
 
235
 
def _open_directory_or_containing_tree_or_branch(filename, directory):
236
 
    """Open the tree or branch containing the specified file, unless
237
 
    the --directory option is used to specify a different branch."""
238
 
    if directory is not None:
239
 
        return (None, Branch.open(directory), filename)
240
 
    return bzrdir.BzrDir.open_containing_tree_or_branch(filename)
241
 
 
242
 
 
243
219
# TODO: Make sure no commands unconditionally use the working directory as a
244
220
# branch.  If a filename argument is used, the first of them should be used to
245
221
# specify the branch.  (Perhaps this can be factored out into some kind of
247
223
# opens the branch?)
248
224
 
249
225
class cmd_status(Command):
250
 
    __doc__ = """Display status summary.
 
226
    """Display status summary.
251
227
 
252
228
    This reports on versioned and unknown files, reporting them
253
229
    grouped by state.  Possible states are:
273
249
    unknown
274
250
        Not versioned and not matching an ignore pattern.
275
251
 
276
 
    Additionally for directories, symlinks and files with an executable
277
 
    bit, Bazaar indicates their type using a trailing character: '/', '@'
278
 
    or '*' respectively.
279
 
 
280
252
    To see ignored files use 'bzr ignored'.  For details on the
281
253
    changes to file texts, use 'bzr diff'.
282
254
 
340
312
 
341
313
 
342
314
class cmd_cat_revision(Command):
343
 
    __doc__ = """Write out metadata for a revision.
 
315
    """Write out metadata for a revision.
344
316
 
345
317
    The revision to print can either be specified by a specific
346
318
    revision identifier, or you can use --revision.
348
320
 
349
321
    hidden = True
350
322
    takes_args = ['revision_id?']
351
 
    takes_options = ['directory', 'revision']
 
323
    takes_options = ['revision']
352
324
    # cat-revision is more for frontends so should be exact
353
325
    encoding = 'strict'
354
326
 
355
 
    def print_revision(self, revisions, revid):
356
 
        stream = revisions.get_record_stream([(revid,)], 'unordered', True)
357
 
        record = stream.next()
358
 
        if record.storage_kind == 'absent':
359
 
            raise errors.NoSuchRevision(revisions, revid)
360
 
        revtext = record.get_bytes_as('fulltext')
361
 
        self.outf.write(revtext.decode('utf-8'))
362
 
 
363
327
    @display_command
364
 
    def run(self, revision_id=None, revision=None, directory=u'.'):
 
328
    def run(self, revision_id=None, revision=None):
365
329
        if revision_id is not None and revision is not None:
366
330
            raise errors.BzrCommandError('You can only supply one of'
367
331
                                         ' revision_id or --revision')
368
332
        if revision_id is None and revision is None:
369
333
            raise errors.BzrCommandError('You must supply either'
370
334
                                         ' --revision or a revision_id')
371
 
        b = WorkingTree.open_containing(directory)[0].branch
372
 
 
373
 
        revisions = b.repository.revisions
374
 
        if revisions is None:
375
 
            raise errors.BzrCommandError('Repository %r does not support '
376
 
                'access to raw revision texts')
377
 
 
378
 
        b.repository.lock_read()
379
 
        try:
380
 
            # TODO: jam 20060112 should cat-revision always output utf-8?
381
 
            if revision_id is not None:
382
 
                revision_id = osutils.safe_revision_id(revision_id, warn=False)
383
 
                try:
384
 
                    self.print_revision(revisions, revision_id)
385
 
                except errors.NoSuchRevision:
386
 
                    msg = "The repository %s contains no revision %s." % (
387
 
                        b.repository.base, revision_id)
388
 
                    raise errors.BzrCommandError(msg)
389
 
            elif revision is not None:
390
 
                for rev in revision:
391
 
                    if rev is None:
392
 
                        raise errors.BzrCommandError(
393
 
                            'You cannot specify a NULL revision.')
394
 
                    rev_id = rev.as_revision_id(b)
395
 
                    self.print_revision(revisions, rev_id)
396
 
        finally:
397
 
            b.repository.unlock()
398
 
        
 
335
        b = WorkingTree.open_containing(u'.')[0].branch
 
336
 
 
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'))
 
353
 
399
354
 
400
355
class cmd_dump_btree(Command):
401
 
    __doc__ = """Dump the contents of a btree index file to stdout.
 
356
    """Dump the contents of a btree index file to stdout.
402
357
 
403
358
    PATH is a btree index file, it can be any URL. This includes things like
404
359
    .bzr/repository/pack-names, or .bzr/repository/indices/a34b3a...ca4a4.iix
468
423
        for node in bt.iter_all_entries():
469
424
            # Node is made up of:
470
425
            # (index, key, value, [references])
471
 
            try:
472
 
                refs = node[3]
473
 
            except IndexError:
474
 
                refs_as_tuples = None
475
 
            else:
476
 
                refs_as_tuples = static_tuple.as_tuples(refs)
477
 
            as_tuple = (tuple(node[1]), node[2], refs_as_tuples)
478
 
            self.outf.write('%s\n' % (as_tuple,))
 
426
            self.outf.write('%s\n' % (node[1:],))
479
427
 
480
428
 
481
429
class cmd_remove_tree(Command):
482
 
    __doc__ = """Remove the working tree from a given branch/checkout.
 
430
    """Remove the working tree from a given branch/checkout.
483
431
 
484
432
    Since a lightweight checkout is little more than a working tree
485
433
    this will refuse to run against one.
487
435
    To re-create the working tree, use "bzr checkout".
488
436
    """
489
437
    _see_also = ['checkout', 'working-trees']
490
 
    takes_args = ['location*']
 
438
    takes_args = ['location?']
491
439
    takes_options = [
492
440
        Option('force',
493
441
               help='Remove the working tree even if it has '
494
 
                    'uncommitted or shelved changes.'),
 
442
                    'uncommitted changes.'),
495
443
        ]
496
444
 
497
 
    def run(self, location_list, force=False):
498
 
        if not location_list:
499
 
            location_list=['.']
500
 
 
501
 
        for location in location_list:
502
 
            d = bzrdir.BzrDir.open(location)
503
 
            
504
 
            try:
505
 
                working = d.open_workingtree()
506
 
            except errors.NoWorkingTree:
507
 
                raise errors.BzrCommandError("No working tree to remove")
508
 
            except errors.NotLocalUrl:
509
 
                raise errors.BzrCommandError("You cannot remove the working tree"
510
 
                                             " of a remote path")
511
 
            if not force:
512
 
                if (working.has_changes()):
513
 
                    raise errors.UncommittedChanges(working)
514
 
                if working.get_shelf_manager().last_shelf() is not None:
515
 
                    raise errors.ShelvedChanges(working)
516
 
 
517
 
            if working.user_url != working.branch.user_url:
518
 
                raise errors.BzrCommandError("You cannot remove the working tree"
519
 
                                             " from a lightweight checkout")
520
 
 
521
 
            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()
522
467
 
523
468
 
524
469
class cmd_revno(Command):
525
 
    __doc__ = """Show current revision number.
 
470
    """Show current revision number.
526
471
 
527
472
    This is equal to the number of revisions on this branch.
528
473
    """
529
474
 
530
475
    _see_also = ['info']
531
476
    takes_args = ['location?']
532
 
    takes_options = [
533
 
        Option('tree', help='Show revno of working tree'),
534
 
        ]
535
477
 
536
478
    @display_command
537
 
    def run(self, tree=False, location=u'.'):
538
 
        if tree:
539
 
            try:
540
 
                wt = WorkingTree.open_containing(location)[0]
541
 
                self.add_cleanup(wt.lock_read().unlock)
542
 
            except (errors.NoWorkingTree, errors.NotLocalUrl):
543
 
                raise errors.NoWorkingTree(location)
544
 
            revid = wt.last_revision()
545
 
            try:
546
 
                revno_t = wt.branch.revision_id_to_dotted_revno(revid)
547
 
            except errors.NoSuchRevision:
548
 
                revno_t = ('???',)
549
 
            revno = ".".join(str(n) for n in revno_t)
550
 
        else:
551
 
            b = Branch.open_containing(location)[0]
552
 
            self.add_cleanup(b.lock_read().unlock)
553
 
            revno = b.revno()
554
 
        self.cleanup_now()
555
 
        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')
556
482
 
557
483
 
558
484
class cmd_revision_info(Command):
559
 
    __doc__ = """Show revision number and revision id for a given revision identifier.
 
485
    """Show revision number and revision id for a given revision identifier.
560
486
    """
561
487
    hidden = True
562
488
    takes_args = ['revision_info*']
563
489
    takes_options = [
564
490
        'revision',
565
 
        custom_help('directory',
 
491
        Option('directory',
566
492
            help='Branch to examine, '
567
 
                 'rather than the one containing the working directory.'),
568
 
        Option('tree', help='Show revno of working tree'),
 
493
                 'rather than the one containing the working directory.',
 
494
            short_name='d',
 
495
            type=unicode,
 
496
            ),
569
497
        ]
570
498
 
571
499
    @display_command
572
 
    def run(self, revision=None, directory=u'.', tree=False,
573
 
            revision_info_list=[]):
 
500
    def run(self, revision=None, directory=u'.', revision_info_list=[]):
574
501
 
575
 
        try:
576
 
            wt = WorkingTree.open_containing(directory)[0]
577
 
            b = wt.branch
578
 
            self.add_cleanup(wt.lock_read().unlock)
579
 
        except (errors.NoWorkingTree, errors.NotLocalUrl):
580
 
            wt = None
581
 
            b = Branch.open_containing(directory)[0]
582
 
            self.add_cleanup(b.lock_read().unlock)
583
 
        revision_ids = []
 
502
        revs = []
584
503
        if revision is not None:
585
 
            revision_ids.extend(rev.as_revision_id(b) for rev in revision)
 
504
            revs.extend(revision)
586
505
        if revision_info_list is not None:
587
 
            for rev_str in revision_info_list:
588
 
                rev_spec = RevisionSpec.from_string(rev_str)
589
 
                revision_ids.append(rev_spec.as_revision_id(b))
590
 
        # No arguments supplied, default to the last revision
591
 
        if len(revision_ids) == 0:
592
 
            if tree:
593
 
                if wt is None:
594
 
                    raise errors.NoWorkingTree(directory)
595
 
                revision_ids.append(wt.last_revision())
596
 
            else:
597
 
                revision_ids.append(b.last_revision())
598
 
 
599
 
        revinfos = []
600
 
        maxlen = 0
601
 
        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)
602
516
            try:
603
 
                dotted_revno = b.revision_id_to_dotted_revno(revision_id)
604
 
                revno = '.'.join(str(i) for i in dotted_revno)
 
517
                revno = '%4d' % (b.revision_id_to_revno(revision_id))
605
518
            except errors.NoSuchRevision:
606
 
                revno = '???'
607
 
            maxlen = max(maxlen, len(revno))
608
 
            revinfos.append([revno, revision_id])
609
 
 
610
 
        self.cleanup_now()
611
 
        for ri in revinfos:
612
 
            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)
613
522
 
614
523
 
615
524
class cmd_add(Command):
616
 
    __doc__ = """Add specified files or directories.
 
525
    """Add specified files or directories.
617
526
 
618
527
    In non-recursive mode, all the named items are added, regardless
619
528
    of whether they were previously ignored.  A warning is given if
645
554
    branches that will be merged later (without showing the two different
646
555
    adds as a conflict). It is also useful when merging another project
647
556
    into a subdirectory of this one.
648
 
    
649
 
    Any files matching patterns in the ignore list will not be added
650
 
    unless they are explicitly mentioned.
651
557
    """
652
558
    takes_args = ['file*']
653
559
    takes_options = [
661
567
               help='Lookup file ids from this tree.'),
662
568
        ]
663
569
    encoding_type = 'replace'
664
 
    _see_also = ['remove', 'ignore']
 
570
    _see_also = ['remove']
665
571
 
666
572
    def run(self, file_list, no_recurse=False, dry_run=False, verbose=False,
667
573
            file_ids_from=None):
684
590
                should_print=(not is_quiet()))
685
591
 
686
592
        if base_tree:
687
 
            self.add_cleanup(base_tree.lock_read().unlock)
688
 
        tree, file_list = tree_files_for_add(file_list)
689
 
        added, ignored = tree.smart_add(file_list, not
690
 
            no_recurse, action=action, save=not dry_run)
691
 
        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()
692
602
        if len(ignored) > 0:
693
603
            if verbose:
694
604
                for glob in sorted(ignored.keys()):
695
605
                    for path in ignored[glob]:
696
606
                        self.outf.write("ignored %s matching \"%s\"\n"
697
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")
698
615
 
699
616
 
700
617
class cmd_mkdir(Command):
701
 
    __doc__ = """Create a new versioned directory.
 
618
    """Create a new versioned directory.
702
619
 
703
620
    This is equivalent to creating the directory and then adding it.
704
621
    """
708
625
 
709
626
    def run(self, dir_list):
710
627
        for d in dir_list:
 
628
            os.mkdir(d)
711
629
            wt, dd = WorkingTree.open_containing(d)
712
 
            base = os.path.dirname(dd)
713
 
            id = wt.path2id(base)
714
 
            if id != None:
715
 
                os.mkdir(d)
716
 
                wt.add([dd])
717
 
                self.outf.write('added %s\n' % d)
718
 
            else:
719
 
                raise errors.NotVersionedError(path=base)
 
630
            wt.add([dd])
 
631
            self.outf.write('added %s\n' % d)
720
632
 
721
633
 
722
634
class cmd_relpath(Command):
723
 
    __doc__ = """Show path of a file relative to root"""
 
635
    """Show path of a file relative to root"""
724
636
 
725
637
    takes_args = ['filename']
726
638
    hidden = True
735
647
 
736
648
 
737
649
class cmd_inventory(Command):
738
 
    __doc__ = """Show inventory of the current working copy or a revision.
 
650
    """Show inventory of the current working copy or a revision.
739
651
 
740
652
    It is possible to limit the output to a particular entry
741
653
    type using the --kind option.  For example: --kind file.
762
674
 
763
675
        revision = _get_one_revision('inventory', revision)
764
676
        work_tree, file_list = tree_files(file_list)
765
 
        self.add_cleanup(work_tree.lock_read().unlock)
766
 
        if revision is not None:
767
 
            tree = revision.as_tree(work_tree.branch)
768
 
 
769
 
            extra_trees = [work_tree]
770
 
            self.add_cleanup(tree.lock_read().unlock)
771
 
        else:
772
 
            tree = work_tree
773
 
            extra_trees = []
774
 
 
775
 
        if file_list is not None:
776
 
            file_ids = tree.paths2ids(file_list, trees=extra_trees,
777
 
                                      require_versioned=True)
778
 
            # find_ids_across_trees may include some paths that don't
779
 
            # exist in 'tree'.
780
 
            entries = sorted((tree.id2path(file_id), tree.inventory[file_id])
781
 
                             for file_id in file_ids if file_id in tree)
782
 
        else:
783
 
            entries = tree.inventory.entries()
784
 
 
785
 
        self.cleanup_now()
 
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
 
786
702
        for path, entry in entries:
787
703
            if kind and kind != entry.kind:
788
704
                continue
794
710
 
795
711
 
796
712
class cmd_mv(Command):
797
 
    __doc__ = """Move or rename a file.
 
713
    """Move or rename a file.
798
714
 
799
715
    :Usage:
800
716
        bzr mv OLDNAME NEWNAME
833
749
        if len(names_list) < 2:
834
750
            raise errors.BzrCommandError("missing file argument")
835
751
        tree, rel_names = tree_files(names_list, canonicalize=False)
836
 
        self.add_cleanup(tree.lock_tree_write().unlock)
837
 
        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()
838
757
 
839
758
    def run_auto(self, names_list, after, dry_run):
840
759
        if names_list is not None and len(names_list) > 1:
844
763
            raise errors.BzrCommandError('--after cannot be specified with'
845
764
                                         ' --auto.')
846
765
        work_tree, file_list = tree_files(names_list, default_branch='.')
847
 
        self.add_cleanup(work_tree.lock_tree_write().unlock)
848
 
        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()
849
771
 
850
772
    def _run(self, tree, names_list, rel_names, after):
851
773
        into_existing = osutils.isdir(names_list[-1])
872
794
            # All entries reference existing inventory items, so fix them up
873
795
            # for cicp file-systems.
874
796
            rel_names = tree.get_canonical_inventory_paths(rel_names)
875
 
            for src, dest in tree.move(rel_names[:-1], rel_names[-1], after=after):
876
 
                if not is_quiet():
877
 
                    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)
878
799
        else:
879
800
            if len(names_list) != 2:
880
801
                raise errors.BzrCommandError('to mv multiple files the'
924
845
            dest = osutils.pathjoin(dest_parent, dest_tail)
925
846
            mutter("attempting to move %s => %s", src, dest)
926
847
            tree.rename_one(src, dest, after=after)
927
 
            if not is_quiet():
928
 
                self.outf.write("%s => %s\n" % (src, dest))
 
848
            self.outf.write("%s => %s\n" % (src, dest))
929
849
 
930
850
 
931
851
class cmd_pull(Command):
932
 
    __doc__ = """Turn this branch into a mirror of another branch.
 
852
    """Turn this branch into a mirror of another branch.
933
853
 
934
 
    By default, this command only works on branches that have not diverged.
935
 
    Branches are considered diverged if the destination branch's most recent 
936
 
    commit is one that has not been merged (directly or indirectly) into the 
937
 
    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.
938
857
 
939
858
    If branches have diverged, you can use 'bzr merge' to integrate the changes
940
859
    from one into the other.  Once one branch has merged, the other should
941
860
    be able to pull it again.
942
861
 
943
 
    If you want to replace your local changes and just want your branch to
944
 
    match the remote one, use pull --overwrite. This will work even if the two
945
 
    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.
946
864
 
947
865
    If there is no default location set, the first pull will set it.  After
948
866
    that, you can omit the location to use the default.  To change the
958
876
    takes_options = ['remember', 'overwrite', 'revision',
959
877
        custom_help('verbose',
960
878
            help='Show logs of pulled revisions.'),
961
 
        custom_help('directory',
 
879
        Option('directory',
962
880
            help='Branch to pull into, '
963
 
                 'rather than the one containing the working directory.'),
 
881
                 'rather than the one containing the working directory.',
 
882
            short_name='d',
 
883
            type=unicode,
 
884
            ),
964
885
        Option('local',
965
886
            help="Perform a local pull in a bound "
966
887
                 "branch.  Local pulls are not applied to "
981
902
        try:
982
903
            tree_to = WorkingTree.open_containing(directory)[0]
983
904
            branch_to = tree_to.branch
984
 
            self.add_cleanup(tree_to.lock_write().unlock)
985
905
        except errors.NoWorkingTree:
986
906
            tree_to = None
987
907
            branch_to = Branch.open_containing(directory)[0]
988
 
            self.add_cleanup(branch_to.lock_write().unlock)
989
 
 
 
908
        
990
909
        if local and not branch_to.get_bound_location():
991
910
            raise errors.LocalRequiresBoundBranch()
992
911
 
1022
941
        else:
1023
942
            branch_from = Branch.open(location,
1024
943
                possible_transports=possible_transports)
1025
 
            self.add_cleanup(branch_from.lock_read().unlock)
1026
944
 
1027
945
            if branch_to.get_parent() is None or remember:
1028
946
                branch_to.set_parent(branch_from.base)
1030
948
        if revision is not None:
1031
949
            revision_id = revision.as_revision_id(branch_from)
1032
950
 
1033
 
        if tree_to is not None:
1034
 
            view_info = _get_view_info_for_change_reporter(tree_to)
1035
 
            change_reporter = delta._ChangeReporter(
1036
 
                unversioned_filter=tree_to.is_ignored,
1037
 
                view_info=view_info)
1038
 
            result = tree_to.pull(
1039
 
                branch_from, overwrite, revision_id, change_reporter,
1040
 
                possible_transports=possible_transports, local=local)
1041
 
        else:
1042
 
            result = branch_to.pull(
1043
 
                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)
1044
964
 
1045
 
        result.report(self.outf)
1046
 
        if verbose and result.old_revid != result.new_revid:
1047
 
            log.show_branch_change(
1048
 
                branch_to, self.outf, result.old_revno,
1049
 
                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()
1050
971
 
1051
972
 
1052
973
class cmd_push(Command):
1053
 
    __doc__ = """Update a mirror of this branch.
 
974
    """Update a mirror of this branch.
1054
975
 
1055
976
    The target branch will not have its working tree populated because this
1056
977
    is both expensive, and is not supported on remote file systems.
1080
1001
        Option('create-prefix',
1081
1002
               help='Create the path leading up to the branch '
1082
1003
                    'if it does not already exist.'),
1083
 
        custom_help('directory',
 
1004
        Option('directory',
1084
1005
            help='Branch to push from, '
1085
 
                 'rather than the one containing the working directory.'),
 
1006
                 'rather than the one containing the working directory.',
 
1007
            short_name='d',
 
1008
            type=unicode,
 
1009
            ),
1086
1010
        Option('use-existing-dir',
1087
1011
               help='By default push will fail if the target'
1088
1012
                    ' directory exists, but does not already'
1096
1020
                'for the commit history. Only the work not present in the '
1097
1021
                'referenced branch is included in the branch created.',
1098
1022
            type=unicode),
1099
 
        Option('strict',
1100
 
               help='Refuse to push if there are uncommitted changes in'
1101
 
               ' the working tree, --no-strict disables the check.'),
1102
1023
        ]
1103
1024
    takes_args = ['location?']
1104
1025
    encoding_type = 'replace'
1106
1027
    def run(self, location=None, remember=False, overwrite=False,
1107
1028
        create_prefix=False, verbose=False, revision=None,
1108
1029
        use_existing_dir=False, directory=None, stacked_on=None,
1109
 
        stacked=False, strict=None):
 
1030
        stacked=False):
1110
1031
        from bzrlib.push import _show_push_branch
1111
1032
 
 
1033
        # Get the source branch and revision_id
1112
1034
        if directory is None:
1113
1035
            directory = '.'
1114
 
        # Get the source branch
1115
 
        (tree, br_from,
1116
 
         _unused) = bzrdir.BzrDir.open_containing_tree_or_branch(directory)
1117
 
        # Get the tip's revision_id
 
1036
        br_from = Branch.open_containing(directory)[0]
1118
1037
        revision = _get_one_revision('push', revision)
1119
1038
        if revision is not None:
1120
1039
            revision_id = revision.in_history(br_from).rev_id
1121
1040
        else:
1122
1041
            revision_id = None
1123
 
        if tree is not None and revision_id is None:
1124
 
            tree.check_changed_or_out_of_date(
1125
 
                strict, 'push_strict',
1126
 
                more_error='Use --no-strict to force the push.',
1127
 
                more_warning='Uncommitted changes will not be pushed.')
 
1042
 
1128
1043
        # Get the stacked_on branch, if any
1129
1044
        if stacked_on is not None:
1130
1045
            stacked_on = urlutils.normalize_url(stacked_on)
1162
1077
 
1163
1078
 
1164
1079
class cmd_branch(Command):
1165
 
    __doc__ = """Create a new branch that is a copy of an existing branch.
 
1080
    """Create a new copy of a branch.
1166
1081
 
1167
1082
    If the TO_LOCATION is omitted, the last component of the FROM_LOCATION will
1168
1083
    be used.  In other words, "branch ../foo/bar" will attempt to create ./bar.
1181
1096
        help='Hard-link working tree files where possible.'),
1182
1097
        Option('no-tree',
1183
1098
            help="Create a branch without a working-tree."),
1184
 
        Option('switch',
1185
 
            help="Switch the checkout in the current directory "
1186
 
                 "to the new branch."),
1187
1099
        Option('stacked',
1188
1100
            help='Create a stacked branch referring to the source branch. '
1189
1101
                'The new branch will depend on the availability of the source '
1190
1102
                'branch for all operations.'),
1191
1103
        Option('standalone',
1192
1104
               help='Do not use a shared repository, even if available.'),
1193
 
        Option('use-existing-dir',
1194
 
               help='By default branch will fail if the target'
1195
 
                    ' directory exists, but does not already'
1196
 
                    ' have a control directory.  This flag will'
1197
 
                    ' allow branch to proceed.'),
1198
 
        Option('bind',
1199
 
            help="Bind new branch to from location."),
1200
1105
        ]
1201
1106
    aliases = ['get', 'clone']
1202
1107
 
1203
1108
    def run(self, from_location, to_location=None, revision=None,
1204
 
            hardlink=False, stacked=False, standalone=False, no_tree=False,
1205
 
            use_existing_dir=False, switch=False, bind=False):
1206
 
        from bzrlib import switch as _mod_switch
 
1109
            hardlink=False, stacked=False, standalone=False, no_tree=False):
1207
1110
        from bzrlib.tag import _merge_tags_if_possible
 
1111
 
1208
1112
        accelerator_tree, br_from = bzrdir.BzrDir.open_tree_or_branch(
1209
1113
            from_location)
1210
1114
        revision = _get_one_revision('branch', revision)
1211
 
        self.add_cleanup(br_from.lock_read().unlock)
1212
 
        if revision is not None:
1213
 
            revision_id = revision.as_revision_id(br_from)
1214
 
        else:
1215
 
            # FIXME - wt.last_revision, fallback to branch, fall back to
1216
 
            # None or perhaps NULL_REVISION to mean copy nothing
1217
 
            # RBC 20060209
1218
 
            revision_id = br_from.last_revision()
1219
 
        if to_location is None:
1220
 
            to_location = urlutils.derive_to_location(from_location)
1221
 
        to_transport = transport.get_transport(to_location)
 
1115
        br_from.lock_read()
1222
1116
        try:
1223
 
            to_transport.mkdir('.')
1224
 
        except errors.FileExists:
1225
 
            if not use_existing_dir:
1226
 
                raise errors.BzrCommandError('Target directory "%s" '
1227
 
                    'already exists.' % to_location)
 
1117
            if revision is not None:
 
1118
                revision_id = revision.as_revision_id(br_from)
1228
1119
            else:
1229
 
                try:
1230
 
                    bzrdir.BzrDir.open_from_transport(to_transport)
1231
 
                except errors.NotBranchError:
1232
 
                    pass
1233
 
                else:
1234
 
                    raise errors.AlreadyBranchError(to_location)
1235
 
        except errors.NoSuchFile:
1236
 
            raise errors.BzrCommandError('Parent of "%s" does not exist.'
1237
 
                                         % to_location)
1238
 
        try:
1239
 
            # preserve whatever source format we have.
1240
 
            dir = br_from.bzrdir.sprout(to_transport.base, revision_id,
1241
 
                                        possible_transports=[to_transport],
1242
 
                                        accelerator_tree=accelerator_tree,
1243
 
                                        hardlink=hardlink, stacked=stacked,
1244
 
                                        force_new_repo=standalone,
1245
 
                                        create_tree_if_local=not no_tree,
1246
 
                                        source_branch=br_from)
1247
 
            branch = dir.open_branch()
1248
 
        except errors.NoSuchRevision:
1249
 
            to_transport.delete_tree('.')
1250
 
            msg = "The branch %s has no revision %s." % (from_location,
1251
 
                revision)
1252
 
            raise errors.BzrCommandError(msg)
1253
 
        _merge_tags_if_possible(br_from, branch)
1254
 
        # If the source branch is stacked, the new branch may
1255
 
        # be stacked whether we asked for that explicitly or not.
1256
 
        # We therefore need a try/except here and not just 'if stacked:'
1257
 
        try:
1258
 
            note('Created new stacked branch referring to %s.' %
1259
 
                branch.get_stacked_on_url())
1260
 
        except (errors.NotStacked, errors.UnstackableBranchFormat,
1261
 
            errors.UnstackableRepositoryFormat), e:
1262
 
            note('Branched %d revision(s).' % branch.revno())
1263
 
        if bind:
1264
 
            # Bind to the parent
1265
 
            parent_branch = Branch.open(from_location)
1266
 
            branch.bind(parent_branch)
1267
 
            note('New branch bound to %s' % from_location)
1268
 
        if switch:
1269
 
            # Switch to the new branch
1270
 
            wt, _ = WorkingTree.open_containing('.')
1271
 
            _mod_switch.switch(wt.bzrdir, branch)
1272
 
            note('Switched to branch: %s',
1273
 
                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()
1274
1162
 
1275
1163
 
1276
1164
class cmd_checkout(Command):
1277
 
    __doc__ = """Create a new checkout of an existing branch.
 
1165
    """Create a new checkout of an existing branch.
1278
1166
 
1279
1167
    If BRANCH_LOCATION is omitted, checkout will reconstitute a working tree for
1280
1168
    the branch found in '.'. This is useful if you have removed the working tree
1343
1231
 
1344
1232
 
1345
1233
class cmd_renames(Command):
1346
 
    __doc__ = """Show list of renamed files.
 
1234
    """Show list of renamed files.
1347
1235
    """
1348
1236
    # TODO: Option to show renames between two historical versions.
1349
1237
 
1354
1242
    @display_command
1355
1243
    def run(self, dir=u'.'):
1356
1244
        tree = WorkingTree.open_containing(dir)[0]
1357
 
        self.add_cleanup(tree.lock_read().unlock)
1358
 
        new_inv = tree.inventory
1359
 
        old_tree = tree.basis_tree()
1360
 
        self.add_cleanup(old_tree.lock_read().unlock)
1361
 
        old_inv = old_tree.inventory
1362
 
        renames = []
1363
 
        iterator = tree.iter_changes(old_tree, include_unchanged=True)
1364
 
        for f, paths, c, v, p, n, k, e in iterator:
1365
 
            if paths[0] == paths[1]:
1366
 
                continue
1367
 
            if None in (paths):
1368
 
                continue
1369
 
            renames.append(paths)
1370
 
        renames.sort()
1371
 
        for old_name, new_name in renames:
1372
 
            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()
1373
1267
 
1374
1268
 
1375
1269
class cmd_update(Command):
1376
 
    __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.
1377
1271
 
1378
1272
    This will perform a merge into the working tree, and may generate
1379
1273
    conflicts. If you have any local changes, you will still
1381
1275
 
1382
1276
    If you want to discard your local changes, you can just do a
1383
1277
    'bzr revert' instead of 'bzr commit' after the update.
1384
 
 
1385
 
    If the tree's branch is bound to a master branch, it will also update
1386
 
    the branch from the master.
1387
1278
    """
1388
1279
 
1389
1280
    _see_also = ['pull', 'working-trees', 'status-flags']
1390
1281
    takes_args = ['dir?']
1391
 
    takes_options = ['revision']
1392
1282
    aliases = ['up']
1393
1283
 
1394
 
    def run(self, dir='.', revision=None):
1395
 
        if revision is not None and len(revision) != 1:
1396
 
            raise errors.BzrCommandError(
1397
 
                        "bzr update --revision takes exactly one revision")
 
1284
    def run(self, dir='.'):
1398
1285
        tree = WorkingTree.open_containing(dir)[0]
1399
 
        branch = tree.branch
1400
1286
        possible_transports = []
1401
 
        master = branch.get_master_branch(
 
1287
        master = tree.branch.get_master_branch(
1402
1288
            possible_transports=possible_transports)
1403
1289
        if master is not None:
1404
 
            branch_location = master.base
1405
1290
            tree.lock_write()
1406
1291
        else:
1407
 
            branch_location = tree.branch.base
1408
1292
            tree.lock_tree_write()
1409
 
        self.add_cleanup(tree.unlock)
1410
 
        # get rid of the final '/' and be ready for display
1411
 
        branch_location = urlutils.unescape_for_display(
1412
 
            branch_location.rstrip('/'),
1413
 
            self.outf.encoding)
1414
 
        existing_pending_merges = tree.get_parent_ids()[1:]
1415
 
        if master is None:
1416
 
            old_tip = None
1417
 
        else:
1418
 
            # may need to fetch data into a heavyweight checkout
1419
 
            # XXX: this may take some time, maybe we should display a
1420
 
            # message
1421
 
            old_tip = branch.update(possible_transports)
1422
 
        if revision is not None:
1423
 
            revision_id = revision[0].as_revision_id(branch)
1424
 
        else:
1425
 
            revision_id = branch.last_revision()
1426
 
        if revision_id == _mod_revision.ensure_null(tree.last_revision()):
1427
 
            revno = branch.revision_id_to_dotted_revno(revision_id)
1428
 
            note("Tree is up to date at revision %s of branch %s" %
1429
 
                ('.'.join(map(str, revno)), branch_location))
1430
 
            return 0
1431
 
        view_info = _get_view_info_for_change_reporter(tree)
1432
 
        change_reporter = delta._ChangeReporter(
1433
 
            unversioned_filter=tree.is_ignored,
1434
 
            view_info=view_info)
1435
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)
1436
1305
            conflicts = tree.update(
1437
 
                change_reporter,
1438
 
                possible_transports=possible_transports,
1439
 
                revision=revision_id,
1440
 
                old_tip=old_tip)
1441
 
        except errors.NoSuchRevision, e:
1442
 
            raise errors.BzrCommandError(
1443
 
                                  "branch has no revision %s\n"
1444
 
                                  "bzr update --revision only works"
1445
 
                                  " for a revision in the branch history"
1446
 
                                  % (e.revision))
1447
 
        revno = tree.branch.revision_id_to_dotted_revno(
1448
 
            _mod_revision.ensure_null(tree.last_revision()))
1449
 
        note('Updated to revision %s of branch %s' %
1450
 
             ('.'.join(map(str, revno)), branch_location))
1451
 
        parent_ids = tree.get_parent_ids()
1452
 
        if parent_ids[1:] and parent_ids[1:] != existing_pending_merges:
1453
 
            note('Your local commits will now show as pending merges with '
1454
 
                 "'bzr status', and can be committed with 'bzr commit'.")
1455
 
        if conflicts != 0:
1456
 
            return 1
1457
 
        else:
1458
 
            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()
1459
1320
 
1460
1321
 
1461
1322
class cmd_info(Command):
1462
 
    __doc__ = """Show information about a working tree, branch or repository.
 
1323
    """Show information about a working tree, branch or repository.
1463
1324
 
1464
1325
    This command will show all known locations and formats associated to the
1465
1326
    tree, branch or repository.
1503
1364
 
1504
1365
 
1505
1366
class cmd_remove(Command):
1506
 
    __doc__ = """Remove files or directories.
 
1367
    """Remove files or directories.
1507
1368
 
1508
1369
    This makes bzr stop tracking changes to the specified files. bzr will delete
1509
1370
    them if they can easily be recovered using revert. If no options or
1518
1379
            title='Deletion Strategy', value_switches=True, enum_switch=False,
1519
1380
            safe='Only delete files if they can be'
1520
1381
                 ' safely recovered (default).',
1521
 
            keep='Delete from bzr but leave the working copy.',
 
1382
            keep="Don't delete any files.",
1522
1383
            force='Delete all the specified files, even if they can not be '
1523
1384
                'recovered and even if they are non-empty directories.')]
1524
1385
    aliases = ['rm', 'del']
1531
1392
        if file_list is not None:
1532
1393
            file_list = [f for f in file_list]
1533
1394
 
1534
 
        self.add_cleanup(tree.lock_write().unlock)
1535
 
        # Heuristics should probably all move into tree.remove_smart or
1536
 
        # some such?
1537
 
        if new:
1538
 
            added = tree.changes_from(tree.basis_tree(),
1539
 
                specific_files=file_list).added
1540
 
            file_list = sorted([f[0] for f in added], reverse=True)
1541
 
            if len(file_list) == 0:
1542
 
                raise errors.BzrCommandError('No matching files.')
1543
 
        elif file_list is None:
1544
 
            # missing files show up in iter_changes(basis) as
1545
 
            # versioned-with-no-kind.
1546
 
            missing = []
1547
 
            for change in tree.iter_changes(tree.basis_tree()):
1548
 
                # Find paths in the working tree that have no kind:
1549
 
                if change[1][1] is not None and change[6][1] is None:
1550
 
                    missing.append(change[1][1])
1551
 
            file_list = sorted(missing, reverse=True)
1552
 
            file_deletion_strategy = 'keep'
1553
 
        tree.remove(file_list, verbose=verbose, to_file=self.outf,
1554
 
            keep_files=file_deletion_strategy=='keep',
1555
 
            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()
1556
1420
 
1557
1421
 
1558
1422
class cmd_file_id(Command):
1559
 
    __doc__ = """Print file_id of a particular file or directory.
 
1423
    """Print file_id of a particular file or directory.
1560
1424
 
1561
1425
    The file_id is assigned when the file is first added and remains the
1562
1426
    same through all revisions where the file exists, even when it is
1578
1442
 
1579
1443
 
1580
1444
class cmd_file_path(Command):
1581
 
    __doc__ = """Print path of file_ids to a file or directory.
 
1445
    """Print path of file_ids to a file or directory.
1582
1446
 
1583
1447
    This prints one line for each directory down to the target,
1584
1448
    starting at the branch root.
1600
1464
 
1601
1465
 
1602
1466
class cmd_reconcile(Command):
1603
 
    __doc__ = """Reconcile bzr metadata in a branch.
 
1467
    """Reconcile bzr metadata in a branch.
1604
1468
 
1605
1469
    This can correct data mismatches that may have been caused by
1606
1470
    previous ghost operations or bzr upgrades. You should only
1628
1492
 
1629
1493
 
1630
1494
class cmd_revision_history(Command):
1631
 
    __doc__ = """Display the list of revision ids on a branch."""
 
1495
    """Display the list of revision ids on a branch."""
1632
1496
 
1633
1497
    _see_also = ['log']
1634
1498
    takes_args = ['location?']
1644
1508
 
1645
1509
 
1646
1510
class cmd_ancestry(Command):
1647
 
    __doc__ = """List all revisions merged into this branch."""
 
1511
    """List all revisions merged into this branch."""
1648
1512
 
1649
1513
    _see_also = ['log', 'revision-history']
1650
1514
    takes_args = ['location?']
1669
1533
 
1670
1534
 
1671
1535
class cmd_init(Command):
1672
 
    __doc__ = """Make a directory into a versioned branch.
 
1536
    """Make a directory into a versioned branch.
1673
1537
 
1674
1538
    Use this to create an empty branch, or before importing an
1675
1539
    existing project.
1703
1567
                lazy_registry=('bzrlib.bzrdir', 'format_registry'),
1704
1568
                converter=lambda name: bzrdir.format_registry.make_bzrdir(name),
1705
1569
                value_switches=True,
1706
 
                title="Branch format",
 
1570
                title="Branch Format",
1707
1571
                ),
1708
1572
         Option('append-revisions-only',
1709
1573
                help='Never change revnos or the existing log.'
1756
1620
                branch.set_append_revisions_only(True)
1757
1621
            except errors.UpgradeRequired:
1758
1622
                raise errors.BzrCommandError('This branch format cannot be set'
1759
 
                    ' to append-revisions-only.  Try --default.')
 
1623
                    ' to append-revisions-only.  Try --experimental-branch6')
1760
1624
        if not is_quiet():
1761
1625
            from bzrlib.info import describe_layout, describe_format
1762
1626
            try:
1778
1642
 
1779
1643
 
1780
1644
class cmd_init_repository(Command):
1781
 
    __doc__ = """Create a shared repository for branches to share storage space.
 
1645
    """Create a shared repository to hold branches.
1782
1646
 
1783
1647
    New branches created under the repository directory will store their
1784
 
    revisions in the repository, not in the branch directory.  For branches
1785
 
    with shared history, this reduces the amount of storage needed and 
1786
 
    speeds up the creation of new branches.
 
1648
    revisions in the repository, not in the branch directory.
1787
1649
 
1788
 
    If the --no-trees option is given then the branches in the repository
1789
 
    will not have working trees by default.  They will still exist as 
1790
 
    directories on disk, but they will not have separate copies of the 
1791
 
    files at a certain revision.  This can be useful for repositories that
1792
 
    store branches which are interacted with through checkouts or remote
1793
 
    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.
1794
1652
 
1795
1653
    :Examples:
1796
 
        Create a shared repository holding just branches::
 
1654
        Create a shared repositories holding just branches::
1797
1655
 
1798
1656
            bzr init-repo --no-trees repo
1799
1657
            bzr init repo/trunk
1838
1696
 
1839
1697
 
1840
1698
class cmd_diff(Command):
1841
 
    __doc__ = """Show differences in the working tree, between revisions or branches.
 
1699
    """Show differences in the working tree, between revisions or branches.
1842
1700
 
1843
1701
    If no arguments are given, all changes for the current tree are listed.
1844
1702
    If files are given, only the changes in those files are listed.
1865
1723
 
1866
1724
            bzr diff -r1
1867
1725
 
1868
 
        Difference between revision 3 and revision 1::
1869
 
 
1870
 
            bzr diff -r1..3
1871
 
 
1872
 
        Difference between revision 3 and revision 1 for branch xxx::
1873
 
 
1874
 
            bzr diff -r1..3 xxx
1875
 
 
1876
 
        To see the changes introduced in revision X::
1877
 
        
1878
 
            bzr diff -cX
1879
 
 
1880
 
        Note that in the case of a merge, the -c option shows the changes
1881
 
        compared to the left hand parent. To see the changes against
1882
 
        another parent, use::
1883
 
 
1884
 
            bzr diff -r<chosen_parent>..X
1885
 
 
1886
 
        The changes introduced by revision 2 (equivalent to -r1..2)::
1887
 
 
1888
 
            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
1889
1733
 
1890
1734
        Show just the differences for file NEWS::
1891
1735
 
1930
1774
            help='Use this command to compare files.',
1931
1775
            type=unicode,
1932
1776
            ),
1933
 
        RegistryOption('format',
1934
 
            help='Diff format to use.',
1935
 
            lazy_registry=('bzrlib.diff', 'format_registry'),
1936
 
            value_switches=False, title='Diff format'),
1937
1777
        ]
1938
1778
    aliases = ['di', 'dif']
1939
1779
    encoding_type = 'exact'
1940
1780
 
1941
1781
    @display_command
1942
1782
    def run(self, revision=None, file_list=None, diff_options=None,
1943
 
            prefix=None, old=None, new=None, using=None, format=None):
1944
 
        from bzrlib.diff import (get_trees_and_branches_to_diff_locked,
1945
 
            show_diff_trees)
 
1783
            prefix=None, old=None, new=None, using=None):
 
1784
        from bzrlib.diff import _get_trees_to_diff, show_diff_trees
1946
1785
 
1947
1786
        if (prefix is None) or (prefix == '0'):
1948
1787
            # diff -p0 format
1962
1801
            raise errors.BzrCommandError('bzr diff --revision takes exactly'
1963
1802
                                         ' one or two revision specifiers')
1964
1803
 
1965
 
        if using is not None and format is not None:
1966
 
            raise errors.BzrCommandError('--using and --format are mutually '
1967
 
                'exclusive.')
1968
 
 
1969
 
        (old_tree, new_tree,
1970
 
         old_branch, new_branch,
1971
 
         specific_files, extra_trees) = get_trees_and_branches_to_diff_locked(
1972
 
            file_list, revision, old, new, self.add_cleanup, apply_view=True)
1973
 
        # GNU diff on Windows uses ANSI encoding for filenames
1974
 
        path_encoding = osutils.get_diff_header_encoding()
 
1804
        old_tree, new_tree, specific_files, extra_trees = \
 
1805
                _get_trees_to_diff(file_list, revision, old, new,
 
1806
                apply_view=True)
1975
1807
        return show_diff_trees(old_tree, new_tree, sys.stdout,
1976
1808
                               specific_files=specific_files,
1977
1809
                               external_diff_options=diff_options,
1978
1810
                               old_label=old_label, new_label=new_label,
1979
 
                               extra_trees=extra_trees,
1980
 
                               path_encoding=path_encoding,
1981
 
                               using=using,
1982
 
                               format_cls=format)
 
1811
                               extra_trees=extra_trees, using=using)
1983
1812
 
1984
1813
 
1985
1814
class cmd_deleted(Command):
1986
 
    __doc__ = """List files deleted in the working tree.
 
1815
    """List files deleted in the working tree.
1987
1816
    """
1988
1817
    # TODO: Show files deleted since a previous revision, or
1989
1818
    # between two revisions.
1992
1821
    # level of effort but possibly much less IO.  (Or possibly not,
1993
1822
    # if the directories are very large...)
1994
1823
    _see_also = ['status', 'ls']
1995
 
    takes_options = ['directory', 'show-ids']
 
1824
    takes_options = ['show-ids']
1996
1825
 
1997
1826
    @display_command
1998
 
    def run(self, show_ids=False, directory=u'.'):
1999
 
        tree = WorkingTree.open_containing(directory)[0]
2000
 
        self.add_cleanup(tree.lock_read().unlock)
2001
 
        old = tree.basis_tree()
2002
 
        self.add_cleanup(old.lock_read().unlock)
2003
 
        for path, ie in old.inventory.iter_entries():
2004
 
            if not tree.has_id(ie.file_id):
2005
 
                self.outf.write(path)
2006
 
                if show_ids:
2007
 
                    self.outf.write(' ')
2008
 
                    self.outf.write(ie.file_id)
2009
 
                self.outf.write('\n')
 
1827
    def run(self, show_ids=False):
 
1828
        tree = WorkingTree.open_containing(u'.')[0]
 
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()
2010
1845
 
2011
1846
 
2012
1847
class cmd_modified(Command):
2013
 
    __doc__ = """List files modified in working tree.
 
1848
    """List files modified in working tree.
2014
1849
    """
2015
1850
 
2016
1851
    hidden = True
2017
1852
    _see_also = ['status', 'ls']
2018
 
    takes_options = ['directory', 'null']
 
1853
    takes_options = [
 
1854
            Option('null',
 
1855
                   help='Write an ascii NUL (\\0) separator '
 
1856
                   'between files rather than a newline.')
 
1857
            ]
2019
1858
 
2020
1859
    @display_command
2021
 
    def run(self, null=False, directory=u'.'):
2022
 
        tree = WorkingTree.open_containing(directory)[0]
 
1860
    def run(self, null=False):
 
1861
        tree = WorkingTree.open_containing(u'.')[0]
2023
1862
        td = tree.changes_from(tree.basis_tree())
2024
1863
        for path, id, kind, text_modified, meta_modified in td.modified:
2025
1864
            if null:
2029
1868
 
2030
1869
 
2031
1870
class cmd_added(Command):
2032
 
    __doc__ = """List files added in working tree.
 
1871
    """List files added in working tree.
2033
1872
    """
2034
1873
 
2035
1874
    hidden = True
2036
1875
    _see_also = ['status', 'ls']
2037
 
    takes_options = ['directory', 'null']
 
1876
    takes_options = [
 
1877
            Option('null',
 
1878
                   help='Write an ascii NUL (\\0) separator '
 
1879
                   'between files rather than a newline.')
 
1880
            ]
2038
1881
 
2039
1882
    @display_command
2040
 
    def run(self, null=False, directory=u'.'):
2041
 
        wt = WorkingTree.open_containing(directory)[0]
2042
 
        self.add_cleanup(wt.lock_read().unlock)
2043
 
        basis = wt.basis_tree()
2044
 
        self.add_cleanup(basis.lock_read().unlock)
2045
 
        basis_inv = basis.inventory
2046
 
        inv = wt.inventory
2047
 
        for file_id in inv:
2048
 
            if file_id in basis_inv:
2049
 
                continue
2050
 
            if inv.is_root(file_id) and len(basis_inv) == 0:
2051
 
                continue
2052
 
            path = inv.id2path(file_id)
2053
 
            if not os.access(osutils.pathjoin(wt.basedir, path), os.F_OK):
2054
 
                continue
2055
 
            if null:
2056
 
                self.outf.write(path + '\0')
2057
 
            else:
2058
 
                self.outf.write(osutils.quotefn(path) + '\n')
 
1883
    def run(self, null=False):
 
1884
        wt = WorkingTree.open_containing(u'.')[0]
 
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()
2059
1908
 
2060
1909
 
2061
1910
class cmd_root(Command):
2062
 
    __doc__ = """Show the tree root directory.
 
1911
    """Show the tree root directory.
2063
1912
 
2064
1913
    The root is the nearest enclosing directory with a .bzr control
2065
1914
    directory."""
2089
1938
 
2090
1939
 
2091
1940
class cmd_log(Command):
2092
 
    __doc__ = """Show historical log for a branch or subset of a branch.
 
1941
    """Show historical log for a branch or subset of a branch.
2093
1942
 
2094
1943
    log is bzr's default tool for exploring the history of a branch.
2095
1944
    The branch to use is taken from the first parameter. If no parameters
2206
2055
    :Tips & tricks:
2207
2056
 
2208
2057
      GUI tools and IDEs are often better at exploring history than command
2209
 
      line tools: you may prefer qlog or viz from qbzr or bzr-gtk, the
2210
 
      bzr-explorer shell, or the Loggerhead web interface.  See the Plugin
2211
 
      Guide <http://doc.bazaar.canonical.com/plugins/en/> and
2212
 
      <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.
2213
2065
 
2214
2066
      You may find it useful to add the aliases below to ``bazaar.conf``::
2215
2067
 
2237
2089
 
2238
2090
      When exploring non-mainline history on large projects with deep
2239
2091
      history, the performance of log can be greatly improved by installing
2240
 
      the historycache plugin. This plugin buffers historical information
 
2092
      the revnocache plugin. This plugin buffers historical information
2241
2093
      trading disk space for faster speed.
2242
2094
    """
2243
2095
    takes_args = ['file*']
2256
2108
                   help='Show just the specified revision.'
2257
2109
                   ' See also "help revisionspec".'),
2258
2110
            'log-format',
2259
 
            RegistryOption('authors',
2260
 
                'What names to list as authors - first, all or committer.',
2261
 
                title='Authors',
2262
 
                lazy_registry=('bzrlib.log', 'author_list_registry'),
2263
 
            ),
2264
2111
            Option('levels',
2265
2112
                   short_name='n',
2266
2113
                   help='Number of levels to display - 0 for all, 1 for flat.',
2281
2128
                   help='Show changes made in each revision as a patch.'),
2282
2129
            Option('include-merges',
2283
2130
                   help='Show merged revisions like --levels 0 does.'),
2284
 
            Option('exclude-common-ancestry',
2285
 
                   help='Display only the revisions that are not part'
2286
 
                   ' of both ancestries (require -rX..Y)'
2287
 
                   )
2288
2131
            ]
2289
2132
    encoding_type = 'replace'
2290
2133
 
2300
2143
            message=None,
2301
2144
            limit=None,
2302
2145
            show_diff=False,
2303
 
            include_merges=False,
2304
 
            authors=None,
2305
 
            exclude_common_ancestry=False,
2306
 
            ):
 
2146
            include_merges=False):
2307
2147
        from bzrlib.log import (
2308
2148
            Logger,
2309
2149
            make_log_request_dict,
2310
2150
            _get_info_for_log_files,
2311
2151
            )
2312
2152
        direction = (forward and 'forward') or 'reverse'
2313
 
        if (exclude_common_ancestry
2314
 
            and (revision is None or len(revision) != 2)):
2315
 
            raise errors.BzrCommandError(
2316
 
                '--exclude-common-ancestry requires -r with two revisions')
2317
2153
        if include_merges:
2318
2154
            if levels is None:
2319
2155
                levels = 0
2334
2170
        filter_by_dir = False
2335
2171
        if file_list:
2336
2172
            # find the file ids to log and check for directory filtering
2337
 
            b, file_info_list, rev1, rev2 = _get_info_for_log_files(
2338
 
                revision, file_list, self.add_cleanup)
 
2173
            b, file_info_list, rev1, rev2 = _get_info_for_log_files(revision,
 
2174
                file_list)
2339
2175
            for relpath, file_id, kind in file_info_list:
2340
2176
                if file_id is None:
2341
2177
                    raise errors.BzrCommandError(
2359
2195
                location = '.'
2360
2196
            dir, relpath = bzrdir.BzrDir.open_containing(location)
2361
2197
            b = dir.open_branch()
2362
 
            self.add_cleanup(b.lock_read().unlock)
2363
2198
            rev1, rev2 = _get_revision_range(revision, b, self.name())
2364
2199
 
2365
2200
        # Decide on the type of delta & diff filtering to use
2375
2210
        else:
2376
2211
            diff_type = 'full'
2377
2212
 
2378
 
        # Build the log formatter
2379
 
        if log_format is None:
2380
 
            log_format = log.log_formatter_registry.get_default(b)
2381
 
        # Make a non-encoding output to include the diffs - bug 328007
2382
 
        unencoded_output = ui.ui_factory.make_output_stream(encoding_type='exact')
2383
 
        lf = log_format(show_ids=show_ids, to_file=self.outf,
2384
 
                        to_exact_file=unencoded_output,
2385
 
                        show_timezone=timezone,
2386
 
                        delta_format=get_verbosity_level(),
2387
 
                        levels=levels,
2388
 
                        show_advice=levels is None,
2389
 
                        author_list_handler=authors)
2390
 
 
2391
 
        # Choose the algorithm for doing the logging. It's annoying
2392
 
        # having multiple code paths like this but necessary until
2393
 
        # the underlying repository format is faster at generating
2394
 
        # deltas or can provide everything we need from the indices.
2395
 
        # The default algorithm - match-using-deltas - works for
2396
 
        # multiple files and directories and is faster for small
2397
 
        # amounts of history (200 revisions say). However, it's too
2398
 
        # slow for logging a single file in a repository with deep
2399
 
        # history, i.e. > 10K revisions. In the spirit of "do no
2400
 
        # evil when adding features", we continue to use the
2401
 
        # original algorithm - per-file-graph - for the "single
2402
 
        # file that isn't a directory without showing a delta" case.
2403
 
        partial_history = revision and b.repository._format.supports_chks
2404
 
        match_using_deltas = (len(file_ids) != 1 or filter_by_dir
2405
 
            or delta_type or partial_history)
2406
 
 
2407
 
        # Build the LogRequest and execute it
2408
 
        if len(file_ids) == 0:
2409
 
            file_ids = None
2410
 
        rqst = make_log_request_dict(
2411
 
            direction=direction, specific_fileids=file_ids,
2412
 
            start_revision=rev1, end_revision=rev2, limit=limit,
2413
 
            message_search=message, delta_type=delta_type,
2414
 
            diff_type=diff_type, _match_using_deltas=match_using_deltas,
2415
 
            exclude_common_ancestry=exclude_common_ancestry,
2416
 
            )
2417
 
        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()
2418
2251
 
2419
2252
 
2420
2253
def _get_revision_range(revisionspec_list, branch, command_name):
2438
2271
            raise errors.BzrCommandError(
2439
2272
                "bzr %s doesn't accept two revisions in different"
2440
2273
                " branches." % command_name)
2441
 
        if start_spec.spec is None:
2442
 
            # Avoid loading all the history.
2443
 
            rev1 = RevisionInfo(branch, None, None)
2444
 
        else:
2445
 
            rev1 = start_spec.in_history(branch)
 
2274
        rev1 = start_spec.in_history(branch)
2446
2275
        # Avoid loading all of history when we know a missing
2447
2276
        # end of range means the last revision ...
2448
2277
        if end_spec.spec is None:
2477
2306
 
2478
2307
 
2479
2308
class cmd_touching_revisions(Command):
2480
 
    __doc__ = """Return revision-ids which affected a particular file.
 
2309
    """Return revision-ids which affected a particular file.
2481
2310
 
2482
2311
    A more user-friendly interface is "bzr log FILE".
2483
2312
    """
2488
2317
    @display_command
2489
2318
    def run(self, filename):
2490
2319
        tree, relpath = WorkingTree.open_containing(filename)
 
2320
        b = tree.branch
2491
2321
        file_id = tree.path2id(relpath)
2492
 
        b = tree.branch
2493
 
        self.add_cleanup(b.lock_read().unlock)
2494
 
        touching_revs = log.find_touching_revisions(b, file_id)
2495
 
        for revno, revision_id, what in touching_revs:
 
2322
        for revno, revision_id, what in log.find_touching_revisions(b, file_id):
2496
2323
            self.outf.write("%6d %s\n" % (revno, what))
2497
2324
 
2498
2325
 
2499
2326
class cmd_ls(Command):
2500
 
    __doc__ = """List files in a tree.
 
2327
    """List files in a tree.
2501
2328
    """
2502
2329
 
2503
2330
    _see_also = ['status', 'cat']
2509
2336
                   help='Recurse into subdirectories.'),
2510
2337
            Option('from-root',
2511
2338
                   help='Print paths relative to the root of the branch.'),
2512
 
            Option('unknown', short_name='u',
2513
 
                help='Print unknown files.'),
 
2339
            Option('unknown', help='Print unknown files.'),
2514
2340
            Option('versioned', help='Print versioned files.',
2515
2341
                   short_name='V'),
2516
 
            Option('ignored', short_name='i',
2517
 
                help='Print ignored files.'),
2518
 
            Option('kind', short_name='k',
 
2342
            Option('ignored', help='Print ignored files.'),
 
2343
            Option('null',
 
2344
                   help='Write an ascii NUL (\\0) separator '
 
2345
                   'between files rather than a newline.'),
 
2346
            Option('kind',
2519
2347
                   help='List entries of a particular kind: file, directory, symlink.',
2520
2348
                   type=unicode),
2521
 
            'null',
2522
2349
            'show-ids',
2523
 
            'directory',
2524
2350
            ]
2525
2351
    @display_command
2526
2352
    def run(self, revision=None, verbose=False,
2527
2353
            recursive=False, from_root=False,
2528
2354
            unknown=False, versioned=False, ignored=False,
2529
 
            null=False, kind=None, show_ids=False, path=None, directory=None):
 
2355
            null=False, kind=None, show_ids=False, path=None):
2530
2356
 
2531
2357
        if kind and kind not in ('file', 'directory', 'symlink'):
2532
2358
            raise errors.BzrCommandError('invalid kind specified')
2539
2365
 
2540
2366
        if path is None:
2541
2367
            fs_path = '.'
 
2368
            prefix = ''
2542
2369
        else:
2543
2370
            if from_root:
2544
2371
                raise errors.BzrCommandError('cannot specify both --from-root'
2545
2372
                                             ' and PATH')
2546
2373
            fs_path = path
2547
 
        tree, branch, relpath = \
2548
 
            _open_directory_or_containing_tree_or_branch(fs_path, directory)
2549
 
 
2550
 
        # Calculate the prefix to use
2551
 
        prefix = None
 
2374
            prefix = path
 
2375
        tree, branch, relpath = bzrdir.BzrDir.open_containing_tree_or_branch(
 
2376
            fs_path)
2552
2377
        if from_root:
2553
 
            if relpath:
2554
 
                prefix = relpath + '/'
2555
 
        elif fs_path != '.' and not fs_path.endswith('/'):
2556
 
            prefix = fs_path + '/'
2557
 
 
 
2378
            relpath = u''
 
2379
        elif relpath:
 
2380
            relpath += '/'
2558
2381
        if revision is not None or tree is None:
2559
2382
            tree = _get_one_revision_tree('ls', revision, branch=branch)
2560
2383
 
2566
2389
                view_str = views.view_display_str(view_files)
2567
2390
                note("Ignoring files outside view. View is %s" % view_str)
2568
2391
 
2569
 
        self.add_cleanup(tree.lock_read().unlock)
2570
 
        for fp, fc, fkind, fid, entry in tree.list_files(include_root=False,
2571
 
            from_dir=relpath, recursive=recursive):
2572
 
            # Apply additional masking
2573
 
            if not all and not selection[fc]:
2574
 
                continue
2575
 
            if kind is not None and fkind != kind:
2576
 
                continue
2577
 
            if apply_view:
2578
 
                try:
2579
 
                    if relpath:
2580
 
                        fullpath = osutils.pathjoin(relpath, fp)
2581
 
                    else:
2582
 
                        fullpath = fp
2583
 
                    views.check_path_in_view(tree, fullpath)
2584
 
                except errors.FileOutsideView:
2585
 
                    continue
2586
 
 
2587
 
            # Output the entry
2588
 
            if prefix:
2589
 
                fp = osutils.pathjoin(prefix, fp)
2590
 
            kindch = entry.kind_character()
2591
 
            outstring = fp + kindch
2592
 
            ui.ui_factory.clear_term()
2593
 
            if verbose:
2594
 
                outstring = '%-8s %s' % (fc, outstring)
2595
 
                if show_ids and fid is not None:
2596
 
                    outstring = "%-50s %s" % (outstring, fid)
2597
 
                self.outf.write(outstring + '\n')
2598
 
            elif null:
2599
 
                self.outf.write(fp + '\0')
2600
 
                if show_ids:
2601
 
                    if fid is not None:
2602
 
                        self.outf.write(fid)
2603
 
                    self.outf.write('\0')
2604
 
                self.outf.flush()
2605
 
            else:
2606
 
                if show_ids:
2607
 
                    if fid is not None:
2608
 
                        my_id = fid
2609
 
                    else:
2610
 
                        my_id = ''
2611
 
                    self.outf.write('%-50s %s\n' % (outstring, my_id))
2612
 
                else:
2613
 
                    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()
2614
2434
 
2615
2435
 
2616
2436
class cmd_unknowns(Command):
2617
 
    __doc__ = """List unknown files.
 
2437
    """List unknown files.
2618
2438
    """
2619
2439
 
2620
2440
    hidden = True
2621
2441
    _see_also = ['ls']
2622
 
    takes_options = ['directory']
2623
2442
 
2624
2443
    @display_command
2625
 
    def run(self, directory=u'.'):
2626
 
        for f in WorkingTree.open_containing(directory)[0].unknowns():
 
2444
    def run(self):
 
2445
        for f in WorkingTree.open_containing(u'.')[0].unknowns():
2627
2446
            self.outf.write(osutils.quotefn(f) + '\n')
2628
2447
 
2629
2448
 
2630
2449
class cmd_ignore(Command):
2631
 
    __doc__ = """Ignore specified files or patterns.
 
2450
    """Ignore specified files or patterns.
2632
2451
 
2633
2452
    See ``bzr help patterns`` for details on the syntax of patterns.
2634
2453
 
2635
 
    If a .bzrignore file does not exist, the ignore command
2636
 
    will create one and add the specified files or patterns to the newly
2637
 
    created file. The ignore command will also automatically add the 
2638
 
    .bzrignore file to be versioned. Creating a .bzrignore file without
2639
 
    the use of the ignore command will require an explicit add command.
2640
 
 
2641
2454
    To remove patterns from the ignore list, edit the .bzrignore file.
2642
2455
    After adding, editing or deleting that file either indirectly by
2643
2456
    using this command or directly by using an editor, be sure to commit
2644
2457
    it.
2645
 
    
2646
 
    Bazaar also supports a global ignore file ~/.bazaar/ignore. On Windows
2647
 
    the global ignore file can be found in the application data directory as
2648
 
    C:\\Documents and Settings\\<user>\\Application Data\\Bazaar\\2.0\\ignore.
2649
 
    Global ignores are not touched by this command. The global ignore file
2650
 
    can be edited directly using an editor.
2651
 
 
2652
 
    Patterns prefixed with '!' are exceptions to ignore patterns and take
2653
 
    precedence over regular ignores.  Such exceptions are used to specify
2654
 
    files that should be versioned which would otherwise be ignored.
2655
 
    
2656
 
    Patterns prefixed with '!!' act as regular ignore patterns, but have
2657
 
    precedence over the '!' exception patterns.
2658
2458
 
2659
2459
    Note: ignore patterns containing shell wildcards must be quoted from
2660
2460
    the shell on Unix.
2664
2464
 
2665
2465
            bzr ignore ./Makefile
2666
2466
 
2667
 
        Ignore .class files in all directories...::
 
2467
        Ignore class files in all directories::
2668
2468
 
2669
2469
            bzr ignore "*.class"
2670
2470
 
2671
 
        ...but do not ignore "special.class"::
2672
 
 
2673
 
            bzr ignore "!special.class"
2674
 
 
2675
2471
        Ignore .o files under the lib directory::
2676
2472
 
2677
2473
            bzr ignore "lib/**/*.o"
2683
2479
        Ignore everything but the "debian" toplevel directory::
2684
2480
 
2685
2481
            bzr ignore "RE:(?!debian/).*"
2686
 
        
2687
 
        Ignore everything except the "local" toplevel directory,
2688
 
        but always ignore "*~" autosave files, even under local/::
2689
 
        
2690
 
            bzr ignore "*"
2691
 
            bzr ignore "!./local"
2692
 
            bzr ignore "!!*~"
2693
2482
    """
2694
2483
 
2695
2484
    _see_also = ['status', 'ignored', 'patterns']
2696
2485
    takes_args = ['name_pattern*']
2697
 
    takes_options = ['directory',
2698
 
        Option('default-rules',
2699
 
               help='Display the default ignore rules that bzr uses.')
 
2486
    takes_options = [
 
2487
        Option('old-default-rules',
 
2488
               help='Write out the ignore rules bzr < 0.9 always used.')
2700
2489
        ]
2701
2490
 
2702
 
    def run(self, name_pattern_list=None, default_rules=None,
2703
 
            directory=u'.'):
 
2491
    def run(self, name_pattern_list=None, old_default_rules=None):
2704
2492
        from bzrlib import ignores
2705
 
        if default_rules is not None:
2706
 
            # dump the default rules and exit
2707
 
            for pattern in ignores.USER_DEFAULTS:
2708
 
                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
2709
2497
            return
2710
2498
        if not name_pattern_list:
2711
2499
            raise errors.BzrCommandError("ignore requires at least one "
2712
 
                "NAME_PATTERN or --default-rules.")
 
2500
                                  "NAME_PATTERN or --old-default-rules")
2713
2501
        name_pattern_list = [globbing.normalize_pattern(p)
2714
2502
                             for p in name_pattern_list]
2715
 
        bad_patterns = ''
2716
 
        for p in name_pattern_list:
2717
 
            if not globbing.Globster.is_pattern_valid(p):
2718
 
                bad_patterns += ('\n  %s' % p)
2719
 
        if bad_patterns:
2720
 
            msg = ('Invalid ignore pattern(s) found. %s' % bad_patterns)
2721
 
            ui.ui_factory.show_error(msg)
2722
 
            raise errors.InvalidPattern('')
2723
2503
        for name_pattern in name_pattern_list:
2724
2504
            if (name_pattern[0] == '/' or
2725
2505
                (len(name_pattern) > 1 and name_pattern[1] == ':')):
2726
2506
                raise errors.BzrCommandError(
2727
2507
                    "NAME_PATTERN should not be an absolute path")
2728
 
        tree, relpath = WorkingTree.open_containing(directory)
 
2508
        tree, relpath = WorkingTree.open_containing(u'.')
2729
2509
        ignores.tree_ignores_add_patterns(tree, name_pattern_list)
2730
2510
        ignored = globbing.Globster(name_pattern_list)
2731
2511
        matches = []
2732
 
        self.add_cleanup(tree.lock_read().unlock)
 
2512
        tree.lock_read()
2733
2513
        for entry in tree.list_files():
2734
2514
            id = entry[3]
2735
2515
            if id is not None:
2736
2516
                filename = entry[0]
2737
2517
                if ignored.match(filename):
2738
 
                    matches.append(filename)
 
2518
                    matches.append(filename.encode('utf-8'))
 
2519
        tree.unlock()
2739
2520
        if len(matches) > 0:
2740
 
            self.outf.write("Warning: the following files are version controlled and"
2741
 
                  " match your ignore pattern:\n%s"
2742
 
                  "\nThese files will continue to be version controlled"
2743
 
                  " 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),)
2744
2525
 
2745
2526
 
2746
2527
class cmd_ignored(Command):
2747
 
    __doc__ = """List ignored files and the patterns that matched them.
 
2528
    """List ignored files and the patterns that matched them.
2748
2529
 
2749
2530
    List all the ignored files and the ignore pattern that caused the file to
2750
2531
    be ignored.
2756
2537
 
2757
2538
    encoding_type = 'replace'
2758
2539
    _see_also = ['ignore', 'ls']
2759
 
    takes_options = ['directory']
2760
2540
 
2761
2541
    @display_command
2762
 
    def run(self, directory=u'.'):
2763
 
        tree = WorkingTree.open_containing(directory)[0]
2764
 
        self.add_cleanup(tree.lock_read().unlock)
2765
 
        for path, file_class, kind, file_id, entry in tree.list_files():
2766
 
            if file_class != 'I':
2767
 
                continue
2768
 
            ## XXX: Slightly inefficient since this was already calculated
2769
 
            pat = tree.is_ignored(path)
2770
 
            self.outf.write('%-50s %s\n' % (path, pat))
 
2542
    def run(self):
 
2543
        tree = WorkingTree.open_containing(u'.')[0]
 
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()
2771
2554
 
2772
2555
 
2773
2556
class cmd_lookup_revision(Command):
2774
 
    __doc__ = """Lookup the revision-id from a revision-number
 
2557
    """Lookup the revision-id from a revision-number
2775
2558
 
2776
2559
    :Examples:
2777
2560
        bzr lookup-revision 33
2778
2561
    """
2779
2562
    hidden = True
2780
2563
    takes_args = ['revno']
2781
 
    takes_options = ['directory']
2782
2564
 
2783
2565
    @display_command
2784
 
    def run(self, revno, directory=u'.'):
 
2566
    def run(self, revno):
2785
2567
        try:
2786
2568
            revno = int(revno)
2787
2569
        except ValueError:
2788
 
            raise errors.BzrCommandError("not a valid revision-number: %r"
2789
 
                                         % revno)
2790
 
        revid = WorkingTree.open_containing(directory)[0].branch.get_rev_id(revno)
2791
 
        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)
2792
2573
 
2793
2574
 
2794
2575
class cmd_export(Command):
2795
 
    __doc__ = """Export current or past revision to a destination directory or archive.
 
2576
    """Export current or past revision to a destination directory or archive.
2796
2577
 
2797
2578
    If no revision is specified this exports the last committed revision.
2798
2579
 
2820
2601
      =================       =========================
2821
2602
    """
2822
2603
    takes_args = ['dest', 'branch_or_subdir?']
2823
 
    takes_options = ['directory',
 
2604
    takes_options = [
2824
2605
        Option('format',
2825
2606
               help="Type of file to export to.",
2826
2607
               type=unicode),
2830
2611
        Option('root',
2831
2612
               type=str,
2832
2613
               help="Name of the root directory inside the exported file."),
2833
 
        Option('per-file-timestamps',
2834
 
               help='Set modification time of files to that of the last '
2835
 
                    'revision in which it was changed.'),
2836
2614
        ]
2837
2615
    def run(self, dest, branch_or_subdir=None, revision=None, format=None,
2838
 
        root=None, filters=False, per_file_timestamps=False, directory=u'.'):
 
2616
        root=None, filters=False):
2839
2617
        from bzrlib.export import export
2840
2618
 
2841
2619
        if branch_or_subdir is None:
2842
 
            tree = WorkingTree.open_containing(directory)[0]
 
2620
            tree = WorkingTree.open_containing(u'.')[0]
2843
2621
            b = tree.branch
2844
2622
            subdir = None
2845
2623
        else:
2848
2626
 
2849
2627
        rev_tree = _get_one_revision_tree('export', revision, branch=b, tree=tree)
2850
2628
        try:
2851
 
            export(rev_tree, dest, format, root, subdir, filtered=filters,
2852
 
                   per_file_timestamps=per_file_timestamps)
 
2629
            export(rev_tree, dest, format, root, subdir, filtered=filters)
2853
2630
        except errors.NoSuchExportFormat, e:
2854
2631
            raise errors.BzrCommandError('Unsupported export format: %s' % e.format)
2855
2632
 
2856
2633
 
2857
2634
class cmd_cat(Command):
2858
 
    __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.
2859
2636
 
2860
2637
    If no revision is nominated, the last revision is used.
2861
2638
 
2864
2641
    """
2865
2642
 
2866
2643
    _see_also = ['ls']
2867
 
    takes_options = ['directory',
 
2644
    takes_options = [
2868
2645
        Option('name-from-revision', help='The path name in the old tree.'),
2869
2646
        Option('filters', help='Apply content filters to display the '
2870
2647
                'convenience form.'),
2875
2652
 
2876
2653
    @display_command
2877
2654
    def run(self, filename, revision=None, name_from_revision=False,
2878
 
            filters=False, directory=None):
 
2655
            filters=False):
2879
2656
        if revision is not None and len(revision) != 1:
2880
2657
            raise errors.BzrCommandError("bzr cat --revision takes exactly"
2881
2658
                                         " one revision specifier")
2882
2659
        tree, branch, relpath = \
2883
 
            _open_directory_or_containing_tree_or_branch(filename, directory)
2884
 
        self.add_cleanup(branch.lock_read().unlock)
2885
 
        return self._run(tree, branch, relpath, filename, revision,
2886
 
                         name_from_revision, filters)
 
2660
            bzrdir.BzrDir.open_containing_tree_or_branch(filename)
 
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()
2887
2667
 
2888
2668
    def _run(self, tree, b, relpath, filename, revision, name_from_revision,
2889
2669
        filtered):
2890
2670
        if tree is None:
2891
2671
            tree = b.basis_tree()
2892
2672
        rev_tree = _get_one_revision_tree('cat', revision, branch=b)
2893
 
        self.add_cleanup(rev_tree.lock_read().unlock)
2894
2673
 
2895
2674
        old_file_id = rev_tree.path2id(relpath)
2896
2675
 
2931
2710
            chunks = content.splitlines(True)
2932
2711
            content = filtered_output_bytes(chunks, filters,
2933
2712
                ContentFilterContext(relpath, rev_tree))
2934
 
            self.cleanup_now()
2935
2713
            self.outf.writelines(content)
2936
2714
        else:
2937
 
            self.cleanup_now()
2938
2715
            self.outf.write(content)
2939
2716
 
2940
2717
 
2941
2718
class cmd_local_time_offset(Command):
2942
 
    __doc__ = """Show the offset in seconds from GMT to local time."""
 
2719
    """Show the offset in seconds from GMT to local time."""
2943
2720
    hidden = True
2944
2721
    @display_command
2945
2722
    def run(self):
2946
 
        self.outf.write("%s\n" % osutils.local_time_offset())
 
2723
        print osutils.local_time_offset()
2947
2724
 
2948
2725
 
2949
2726
 
2950
2727
class cmd_commit(Command):
2951
 
    __doc__ = """Commit changes into a new revision.
2952
 
 
2953
 
    An explanatory message needs to be given for each commit. This is
2954
 
    often done by using the --message option (getting the message from the
2955
 
    command line) or by using the --file option (getting the message from
2956
 
    a file). If neither of these options is given, an editor is opened for
2957
 
    the user to enter the message. To see the changed files in the
2958
 
    boilerplate text loaded into the editor, use the --show-diff option.
2959
 
 
2960
 
    By default, the entire tree is committed and the person doing the
2961
 
    commit is assumed to be the author. These defaults can be overridden
2962
 
    as explained below.
2963
 
 
2964
 
    :Selective commits:
2965
 
 
2966
 
      If selected files are specified, only changes to those files are
2967
 
      committed.  If a directory is specified then the directory and
2968
 
      everything within it is committed.
2969
 
  
2970
 
      When excludes are given, they take precedence over selected files.
2971
 
      For example, to commit only changes within foo, but not changes
2972
 
      within foo/bar::
2973
 
  
2974
 
        bzr commit foo -x foo/bar
2975
 
  
2976
 
      A selective commit after a merge is not yet supported.
2977
 
 
2978
 
    :Custom authors:
2979
 
 
2980
 
      If the author of the change is not the same person as the committer,
2981
 
      you can specify the author's name using the --author option. The
2982
 
      name should be in the same format as a committer-id, e.g.
2983
 
      "John Doe <jdoe@example.com>". If there is more than one author of
2984
 
      the change you can specify the option multiple times, once for each
2985
 
      author.
2986
 
  
2987
 
    :Checks:
2988
 
 
2989
 
      A common mistake is to forget to add a new file or directory before
2990
 
      running the commit command. The --strict option checks for unknown
2991
 
      files and aborts the commit if any are found. More advanced pre-commit
2992
 
      checks can be implemented by defining hooks. See ``bzr help hooks``
2993
 
      for details.
2994
 
 
2995
 
    :Things to note:
2996
 
 
2997
 
      If you accidentially commit the wrong changes or make a spelling
2998
 
      mistake in the commit message say, you can use the uncommit command
2999
 
      to undo it. See ``bzr help uncommit`` for details.
3000
 
 
3001
 
      Hooks can also be configured to run after a commit. This allows you
3002
 
      to trigger updates to external systems like bug trackers. The --fixes
3003
 
      option can be used to record the association between a revision and
3004
 
      one or more bugs. See ``bzr help bugs`` for details.
3005
 
 
3006
 
      A selective commit may fail in some cases where the committed
3007
 
      tree would be invalid. Consider::
3008
 
  
3009
 
        bzr init foo
3010
 
        mkdir foo/bar
3011
 
        bzr add foo/bar
3012
 
        bzr commit foo -m "committing foo"
3013
 
        bzr mv foo/bar foo/baz
3014
 
        mkdir foo/bar
3015
 
        bzr add foo/bar
3016
 
        bzr commit foo/bar -m "committing bar but not baz"
3017
 
  
3018
 
      In the example above, the last commit will fail by design. This gives
3019
 
      the user the opportunity to decide whether they want to commit the
3020
 
      rename at the same time, separately first, or not at all. (As a general
3021
 
      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.
3022
2766
    """
3023
2767
    # TODO: Run hooks on tree to-be-committed, and after commit.
3024
2768
 
3029
2773
 
3030
2774
    # XXX: verbose currently does nothing
3031
2775
 
3032
 
    _see_also = ['add', 'bugs', 'hooks', 'uncommit']
 
2776
    _see_also = ['bugs', 'uncommit']
3033
2777
    takes_args = ['selected*']
3034
2778
    takes_options = [
3035
2779
            ListOption('exclude', type=str, short_name='x',
3047
2791
             Option('strict',
3048
2792
                    help="Refuse to commit if there are unknown "
3049
2793
                    "files in the working tree."),
3050
 
             Option('commit-time', type=str,
3051
 
                    help="Manually set a commit time using commit date "
3052
 
                    "format, e.g. '2009-10-10 08:00:00 +0100'."),
3053
2794
             ListOption('fixes', type=str,
3054
2795
                    help="Mark a bug as being fixed by this revision "
3055
2796
                         "(see \"bzr help bugs\")."),
3062
2803
                         "the master branch until a normal commit "
3063
2804
                         "is performed."
3064
2805
                    ),
3065
 
             Option('show-diff', short_name='p',
3066
 
                    help='When no message is supplied, show the diff along'
3067
 
                    ' 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.'),
3068
2809
             ]
3069
2810
    aliases = ['ci', 'checkin']
3070
2811
 
3089
2830
 
3090
2831
    def run(self, message=None, file=None, verbose=False, selected_list=None,
3091
2832
            unchanged=False, strict=False, local=False, fixes=None,
3092
 
            author=None, show_diff=False, exclude=None, commit_time=None):
 
2833
            author=None, show_diff=False, exclude=None):
3093
2834
        from bzrlib.errors import (
3094
2835
            PointlessCommit,
3095
2836
            ConflictsInTree,
3101
2842
            make_commit_message_template_encoded
3102
2843
        )
3103
2844
 
3104
 
        commit_stamp = offset = None
3105
 
        if commit_time is not None:
3106
 
            try:
3107
 
                commit_stamp, offset = timestamp.parse_patch_date(commit_time)
3108
 
            except ValueError, e:
3109
 
                raise errors.BzrCommandError(
3110
 
                    "Could not parse --commit-time: " + str(e))
3111
 
 
3112
2845
        # TODO: Need a blackbox test for invoking the external editor; may be
3113
2846
        # slightly problematic to run this cross-platform.
3114
2847
 
3134
2867
        if local and not tree.branch.get_bound_location():
3135
2868
            raise errors.LocalRequiresBoundBranch()
3136
2869
 
3137
 
        if message is not None:
3138
 
            try:
3139
 
                file_exists = osutils.lexists(message)
3140
 
            except UnicodeError:
3141
 
                # The commit message contains unicode characters that can't be
3142
 
                # represented in the filesystem encoding, so that can't be a
3143
 
                # file.
3144
 
                file_exists = False
3145
 
            if file_exists:
3146
 
                warning_msg = (
3147
 
                    'The commit message is a file name: "%(f)s".\n'
3148
 
                    '(use --file "%(f)s" to take commit message from that file)'
3149
 
                    % { 'f': message })
3150
 
                ui.ui_factory.show_warning(warning_msg)
3151
 
            if '\r' in message:
3152
 
                message = message.replace('\r\n', '\n')
3153
 
                message = message.replace('\r', '\n')
3154
 
            if file:
3155
 
                raise errors.BzrCommandError(
3156
 
                    "please specify either --message or --file")
3157
 
 
3158
2870
        def get_message(commit_obj):
3159
2871
            """Callback to get commit message"""
3160
 
            if file:
3161
 
                f = codecs.open(file, 'rt', osutils.get_user_encoding())
3162
 
                try:
3163
 
                    my_message = f.read()
3164
 
                finally:
3165
 
                    f.close()
3166
 
            elif message is not None:
3167
 
                my_message = message
3168
 
            else:
3169
 
                # No message supplied: make one up.
3170
 
                # text is the status of the tree
3171
 
                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,
3172
2875
                        selected_list, diff=show_diff,
3173
2876
                        output_encoding=osutils.get_user_encoding())
3174
 
                # start_message is the template generated from hooks
3175
 
                # XXX: Warning - looks like hooks return unicode,
3176
 
                # make_commit_message_template_encoded returns user encoding.
3177
 
                # We probably want to be using edit_commit_message instead to
3178
 
                # avoid this.
3179
2877
                start_message = generate_commit_message_template(commit_obj)
3180
 
                my_message = edit_commit_message_encoded(text,
 
2878
                my_message = edit_commit_message_encoded(t,
3181
2879
                    start_message=start_message)
3182
2880
                if my_message is None:
3183
2881
                    raise errors.BzrCommandError("please specify a commit"
3184
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()
3185
2889
            if my_message == "":
3186
2890
                raise errors.BzrCommandError("empty commit message specified")
3187
2891
            return my_message
3188
2892
 
3189
 
        # The API permits a commit with a filter of [] to mean 'select nothing'
3190
 
        # but the command line should not do that.
3191
 
        if not selected_list:
3192
 
            selected_list = None
3193
2893
        try:
3194
2894
            tree.commit(message_callback=get_message,
3195
2895
                        specific_files=selected_list,
3196
2896
                        allow_pointless=unchanged, strict=strict, local=local,
3197
2897
                        reporter=None, verbose=verbose, revprops=properties,
3198
 
                        authors=author, timestamp=commit_stamp,
3199
 
                        timezone=offset,
 
2898
                        authors=author,
3200
2899
                        exclude=safe_relpath_files(tree, exclude))
3201
2900
        except PointlessCommit:
3202
 
            raise errors.BzrCommandError("No changes to commit."
3203
 
                              " 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")
3204
2905
        except ConflictsInTree:
3205
2906
            raise errors.BzrCommandError('Conflicts detected in working '
3206
2907
                'tree.  Use "bzr conflicts" to list, "bzr resolve FILE" to'
3209
2910
            raise errors.BzrCommandError("Commit refused because there are"
3210
2911
                              " unknown files in the working tree.")
3211
2912
        except errors.BoundBranchOutOfDate, e:
3212
 
            e.extra_help = ("\n"
3213
 
                'To commit to master branch, run update and then commit.\n'
3214
 
                'You can also pass --local to commit to continue working '
3215
 
                'disconnected.')
3216
 
            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.')
3217
2917
 
3218
2918
 
3219
2919
class cmd_check(Command):
3220
 
    __doc__ = """Validate working tree structure, branch consistency and repository history.
 
2920
    """Validate working tree structure, branch consistency and repository history.
3221
2921
 
3222
2922
    This command checks various invariants about branch and repository storage
3223
2923
    to detect data corruption or bzr bugs.
3225
2925
    The working tree and branch checks will only give output if a problem is
3226
2926
    detected. The output fields of the repository check are:
3227
2927
 
3228
 
    revisions
3229
 
        This is just the number of revisions checked.  It doesn't
3230
 
        indicate a problem.
3231
 
 
3232
 
    versionedfiles
3233
 
        This is just the number of versionedfiles checked.  It
3234
 
        doesn't indicate a problem.
3235
 
 
3236
 
    unreferenced ancestors
3237
 
        Texts that are ancestors of other texts, but
3238
 
        are not properly referenced by the revision ancestry.  This is a
3239
 
        subtle problem that Bazaar can work around.
3240
 
 
3241
 
    unique file texts
3242
 
        This is the total number of unique file contents
3243
 
        seen in the checked revisions.  It does not indicate a problem.
3244
 
 
3245
 
    repeated file texts
3246
 
        This is the total number of repeated texts seen
3247
 
        in the checked revisions.  Texts can be repeated when their file
3248
 
        entries are modified, but the file contents are not.  It does not
3249
 
        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.
3250
2941
 
3251
2942
    If no restrictions are specified, all Bazaar data that is found at the given
3252
2943
    location will be checked.
3287
2978
 
3288
2979
 
3289
2980
class cmd_upgrade(Command):
3290
 
    __doc__ = """Upgrade branch storage to current format.
 
2981
    """Upgrade branch storage to current format.
3291
2982
 
3292
2983
    The check command or bzr developers may sometimes advise you to run
3293
2984
    this command. When the default format has changed you may also be warned
3311
3002
 
3312
3003
 
3313
3004
class cmd_whoami(Command):
3314
 
    __doc__ = """Show or set bzr user id.
 
3005
    """Show or set bzr user id.
3315
3006
 
3316
3007
    :Examples:
3317
3008
        Show the email of the current user::
3322
3013
 
3323
3014
            bzr whoami "Frank Chu <fchu@example.com>"
3324
3015
    """
3325
 
    takes_options = [ 'directory',
3326
 
                      Option('email',
 
3016
    takes_options = [ Option('email',
3327
3017
                             help='Display email address only.'),
3328
3018
                      Option('branch',
3329
3019
                             help='Set identity for the current branch instead of '
3333
3023
    encoding_type = 'replace'
3334
3024
 
3335
3025
    @display_command
3336
 
    def run(self, email=False, branch=False, name=None, directory=None):
 
3026
    def run(self, email=False, branch=False, name=None):
3337
3027
        if name is None:
3338
 
            if directory is None:
3339
 
                # use branch if we're inside one; otherwise global config
3340
 
                try:
3341
 
                    c = Branch.open_containing(u'.')[0].get_config()
3342
 
                except errors.NotBranchError:
3343
 
                    c = config.GlobalConfig()
3344
 
            else:
3345
 
                c = Branch.open(directory).get_config()
 
3028
            # use branch if we're inside one; otherwise global config
 
3029
            try:
 
3030
                c = Branch.open_containing('.')[0].get_config()
 
3031
            except errors.NotBranchError:
 
3032
                c = config.GlobalConfig()
3346
3033
            if email:
3347
3034
                self.outf.write(c.user_email() + '\n')
3348
3035
            else:
3358
3045
 
3359
3046
        # use global config unless --branch given
3360
3047
        if branch:
3361
 
            if directory is None:
3362
 
                c = Branch.open_containing(u'.')[0].get_config()
3363
 
            else:
3364
 
                c = Branch.open(directory).get_config()
 
3048
            c = Branch.open_containing('.')[0].get_config()
3365
3049
        else:
3366
3050
            c = config.GlobalConfig()
3367
3051
        c.set_user_option('email', name)
3368
3052
 
3369
3053
 
3370
3054
class cmd_nick(Command):
3371
 
    __doc__ = """Print or set the branch nickname.
 
3055
    """Print or set the branch nickname.
3372
3056
 
3373
3057
    If unset, the tree root directory name is used as the nickname.
3374
3058
    To print the current nickname, execute with no argument.
3379
3063
 
3380
3064
    _see_also = ['info']
3381
3065
    takes_args = ['nickname?']
3382
 
    takes_options = ['directory']
3383
 
    def run(self, nickname=None, directory=u'.'):
3384
 
        branch = Branch.open_containing(directory)[0]
 
3066
    def run(self, nickname=None):
 
3067
        branch = Branch.open_containing(u'.')[0]
3385
3068
        if nickname is None:
3386
3069
            self.printme(branch)
3387
3070
        else:
3389
3072
 
3390
3073
    @display_command
3391
3074
    def printme(self, branch):
3392
 
        self.outf.write('%s\n' % branch.nick)
 
3075
        print branch.nick
3393
3076
 
3394
3077
 
3395
3078
class cmd_alias(Command):
3396
 
    __doc__ = """Set/unset and display aliases.
 
3079
    """Set/unset and display aliases.
3397
3080
 
3398
3081
    :Examples:
3399
3082
        Show the current aliases::
3463
3146
 
3464
3147
 
3465
3148
class cmd_selftest(Command):
3466
 
    __doc__ = """Run internal test suite.
 
3149
    """Run internal test suite.
3467
3150
 
3468
3151
    If arguments are given, they are regular expressions that say which tests
3469
3152
    should run.  Tests matching any expression are run, and other tests are
3496
3179
    Tests that need working space on disk use a common temporary directory,
3497
3180
    typically inside $TMPDIR or /tmp.
3498
3181
 
3499
 
    If you set BZR_TEST_PDB=1 when running selftest, failing tests will drop
3500
 
    into a pdb postmortem session.
3501
 
 
3502
3182
    :Examples:
3503
3183
        Run only tests relating to 'ignore'::
3504
3184
 
3513
3193
    def get_transport_type(typestring):
3514
3194
        """Parse and return a transport specifier."""
3515
3195
        if typestring == "sftp":
3516
 
            from bzrlib.tests import stub_sftp
3517
 
            return stub_sftp.SFTPAbsoluteServer
 
3196
            from bzrlib.transport.sftp import SFTPAbsoluteServer
 
3197
            return SFTPAbsoluteServer
3518
3198
        if typestring == "memory":
3519
 
            from bzrlib.tests import test_server
3520
 
            return memory.MemoryServer
 
3199
            from bzrlib.transport.memory import MemoryServer
 
3200
            return MemoryServer
3521
3201
        if typestring == "fakenfs":
3522
 
            from bzrlib.tests import test_server
3523
 
            return test_server.FakeNFSServer
 
3202
            from bzrlib.transport.fakenfs import FakeNFSServer
 
3203
            return FakeNFSServer
3524
3204
        msg = "No known transport type %s. Supported types are: sftp\n" %\
3525
3205
            (typestring)
3526
3206
        raise errors.BzrCommandError(msg)
3537
3217
                                 'throughout the test suite.',
3538
3218
                            type=get_transport_type),
3539
3219
                     Option('benchmark',
3540
 
                            help='Run the benchmarks rather than selftests.',
3541
 
                            hidden=True),
 
3220
                            help='Run the benchmarks rather than selftests.'),
3542
3221
                     Option('lsprof-timed',
3543
3222
                            help='Generate lsprof output for benchmarked'
3544
3223
                                 ' sections of code.'),
3545
 
                     Option('lsprof-tests',
3546
 
                            help='Generate lsprof output for each test.'),
 
3224
                     Option('cache-dir', type=str,
 
3225
                            help='Cache intermediate benchmark output in this '
 
3226
                                 'directory.'),
3547
3227
                     Option('first',
3548
3228
                            help='Run all tests, but run specified tests first.',
3549
3229
                            short_name='f',
3583
3263
 
3584
3264
    def run(self, testspecs_list=None, verbose=False, one=False,
3585
3265
            transport=None, benchmark=None,
3586
 
            lsprof_timed=None,
 
3266
            lsprof_timed=None, cache_dir=None,
3587
3267
            first=False, list_only=False,
3588
3268
            randomize=None, exclude=None, strict=False,
3589
3269
            load_list=None, debugflag=None, starting_with=None, subunit=False,
3590
 
            parallel=None, lsprof_tests=False):
 
3270
            parallel=None):
3591
3271
        from bzrlib.tests import selftest
 
3272
        import bzrlib.benchmarks as benchmarks
 
3273
        from bzrlib.benchmarks import tree_creator
3592
3274
 
3593
3275
        # Make deprecation warnings visible, unless -Werror is set
3594
3276
        symbol_versioning.activate_deprecation_warnings(override=False)
3595
3277
 
 
3278
        if cache_dir is not None:
 
3279
            tree_creator.TreeCreator.CACHE_ROOT = osutils.abspath(cache_dir)
3596
3280
        if testspecs_list is not None:
3597
3281
            pattern = '|'.join(testspecs_list)
3598
3282
        else:
3604
3288
                raise errors.BzrCommandError("subunit not available. subunit "
3605
3289
                    "needs to be installed to use --subunit.")
3606
3290
            self.additional_selftest_args['runner_class'] = SubUnitBzrRunner
3607
 
            # On Windows, disable automatic conversion of '\n' to '\r\n' in
3608
 
            # stdout, which would corrupt the subunit stream. 
3609
 
            # FIXME: This has been fixed in subunit trunk (>0.0.5) so the
3610
 
            # following code can be deleted when it's sufficiently deployed
3611
 
            # -- vila/mgz 20100514
3612
 
            if (sys.platform == "win32"
3613
 
                and getattr(sys.stdout, 'fileno', None) is not None):
3614
 
                import msvcrt
3615
 
                msvcrt.setmode(sys.stdout.fileno(), os.O_BINARY)
3616
3291
        if parallel:
3617
3292
            self.additional_selftest_args.setdefault(
3618
3293
                'suite_decorators', []).append(parallel)
3619
3294
        if benchmark:
3620
 
            raise errors.BzrCommandError(
3621
 
                "--benchmark is no longer supported from bzr 2.2; "
3622
 
                "use bzr-usertest instead")
3623
 
        test_suite_factory = None
3624
 
        selftest_kwargs = {"verbose": verbose,
3625
 
                          "pattern": pattern,
3626
 
                          "stop_on_failure": one,
3627
 
                          "transport": transport,
3628
 
                          "test_suite_factory": test_suite_factory,
3629
 
                          "lsprof_timed": lsprof_timed,
3630
 
                          "lsprof_tests": lsprof_tests,
3631
 
                          "matching_tests_first": first,
3632
 
                          "list_only": list_only,
3633
 
                          "random_seed": randomize,
3634
 
                          "exclude_pattern": exclude,
3635
 
                          "strict": strict,
3636
 
                          "load_list": load_list,
3637
 
                          "debug_flags": debugflag,
3638
 
                          "starting_with": starting_with
3639
 
                          }
3640
 
        selftest_kwargs.update(self.additional_selftest_args)
3641
 
        result = selftest(**selftest_kwargs)
 
3295
            test_suite_factory = benchmarks.test_suite
 
3296
            # Unless user explicitly asks for quiet, be verbose in benchmarks
 
3297
            verbose = not is_quiet()
 
3298
            # TODO: should possibly lock the history file...
 
3299
            benchfile = open(".perf_history", "at", buffering=1)
 
3300
        else:
 
3301
            test_suite_factory = None
 
3302
            benchfile = None
 
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()
3642
3325
        return int(not result)
3643
3326
 
3644
3327
 
3645
3328
class cmd_version(Command):
3646
 
    __doc__ = """Show version of bzr."""
 
3329
    """Show version of bzr."""
3647
3330
 
3648
3331
    encoding_type = 'replace'
3649
3332
    takes_options = [
3660
3343
 
3661
3344
 
3662
3345
class cmd_rocks(Command):
3663
 
    __doc__ = """Statement of optimism."""
 
3346
    """Statement of optimism."""
3664
3347
 
3665
3348
    hidden = True
3666
3349
 
3667
3350
    @display_command
3668
3351
    def run(self):
3669
 
        self.outf.write("It sure does!\n")
 
3352
        print "It sure does!"
3670
3353
 
3671
3354
 
3672
3355
class cmd_find_merge_base(Command):
3673
 
    __doc__ = """Find and print a base revision for merging two branches."""
 
3356
    """Find and print a base revision for merging two branches."""
3674
3357
    # TODO: Options to specify revisions on either side, as if
3675
3358
    #       merging only part of the history.
3676
3359
    takes_args = ['branch', 'other']
3682
3365
 
3683
3366
        branch1 = Branch.open_containing(branch)[0]
3684
3367
        branch2 = Branch.open_containing(other)[0]
3685
 
        self.add_cleanup(branch1.lock_read().unlock)
3686
 
        self.add_cleanup(branch2.lock_read().unlock)
3687
 
        last1 = ensure_null(branch1.last_revision())
3688
 
        last2 = ensure_null(branch2.last_revision())
3689
 
 
3690
 
        graph = branch1.repository.get_graph(branch2.repository)
3691
 
        base_rev_id = graph.find_unique_lca(last1, last2)
3692
 
 
3693
 
        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()
3694
3383
 
3695
3384
 
3696
3385
class cmd_merge(Command):
3697
 
    __doc__ = """Perform a three-way merge.
 
3386
    """Perform a three-way merge.
3698
3387
 
3699
3388
    The source of the merge can be specified either in the form of a branch,
3700
3389
    or in the form of a path to a file containing a merge directive generated
3729
3418
    committed to record the result of the merge.
3730
3419
 
3731
3420
    merge refuses to run if there are any uncommitted changes, unless
3732
 
    --force is given. The --force option can also be used to create a
3733
 
    merge revision which has more than two parents.
3734
 
 
3735
 
    If one would like to merge changes from the working tree of the other
3736
 
    branch without merging any committed revisions, the --uncommitted option
3737
 
    can be given.
3738
 
 
3739
 
    To select only some changes to merge, use "merge -i", which will prompt
3740
 
    you to apply each diff hunk and file change, similar to "shelve".
 
3421
    --force is given.
3741
3422
 
3742
3423
    :Examples:
3743
3424
        To merge the latest revision from bzr.dev::
3752
3433
 
3753
3434
            bzr merge -r 81..82 ../bzr.dev
3754
3435
 
3755
 
        To apply a merge directive contained in /tmp/merge::
 
3436
        To apply a merge directive contained in /tmp/merge:
3756
3437
 
3757
3438
            bzr merge /tmp/merge
3758
 
 
3759
 
        To create a merge revision with three parents from two branches
3760
 
        feature1a and feature1b:
3761
 
 
3762
 
            bzr merge ../feature1a
3763
 
            bzr merge ../feature1b --force
3764
 
            bzr commit -m 'revision with three parents'
3765
3439
    """
3766
3440
 
3767
3441
    encoding_type = 'exact'
3783
3457
                ' completely merged into the source, pull from the'
3784
3458
                ' source rather than merging.  When this happens,'
3785
3459
                ' you do not need to commit the result.'),
3786
 
        custom_help('directory',
 
3460
        Option('directory',
3787
3461
               help='Branch to merge into, '
3788
 
                    'rather than the one containing the working directory.'),
3789
 
        Option('preview', help='Instead of merging, show a diff of the'
3790
 
               ' merge.'),
3791
 
        Option('interactive', help='Select changes interactively.',
3792
 
            short_name='i')
 
3462
                    'rather than the one containing the working directory.',
 
3463
               short_name='d',
 
3464
               type=unicode,
 
3465
               ),
 
3466
        Option('preview', help='Instead of merging, show a diff of the merge.')
3793
3467
    ]
3794
3468
 
3795
3469
    def run(self, location=None, revision=None, force=False,
3797
3471
            uncommitted=False, pull=False,
3798
3472
            directory=None,
3799
3473
            preview=False,
3800
 
            interactive=False,
3801
3474
            ):
3802
3475
        if merge_type is None:
3803
3476
            merge_type = _mod_merge.Merge3Merger
3809
3482
        verified = 'inapplicable'
3810
3483
        tree = WorkingTree.open_containing(directory)[0]
3811
3484
 
 
3485
        # die as quickly as possible if there are uncommitted changes
3812
3486
        try:
3813
3487
            basis_tree = tree.revision_tree(tree.last_revision())
3814
3488
        except errors.NoSuchRevision:
3815
3489
            basis_tree = tree.basis_tree()
3816
 
 
3817
 
        # die as quickly as possible if there are uncommitted changes
3818
3490
        if not force:
3819
 
            if tree.has_changes():
 
3491
            changes = tree.changes_from(basis_tree)
 
3492
            if changes.has_changed():
3820
3493
                raise errors.UncommittedChanges(tree)
3821
3494
 
3822
3495
        view_info = _get_view_info_for_change_reporter(tree)
3823
3496
        change_reporter = delta._ChangeReporter(
3824
3497
            unversioned_filter=tree.is_ignored, view_info=view_info)
3825
 
        pb = ui.ui_factory.nested_progress_bar()
3826
 
        self.add_cleanup(pb.finished)
3827
 
        self.add_cleanup(tree.lock_write().unlock)
3828
 
        if location is not None:
3829
 
            try:
3830
 
                mergeable = bundle.read_mergeable_from_url(location,
3831
 
                    possible_transports=possible_transports)
3832
 
            except errors.NotABundle:
3833
 
                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)
3834
3556
            else:
3835
 
                if uncommitted:
3836
 
                    raise errors.BzrCommandError('Cannot use --uncommitted'
3837
 
                        ' with bundles or merge directives.')
3838
 
 
3839
 
                if revision is not None:
3840
 
                    raise errors.BzrCommandError(
3841
 
                        'Cannot use -r with merge directives or bundles')
3842
 
                merger, verified = _mod_merge.Merger.from_mergeable(tree,
3843
 
                   mergeable, None)
3844
 
 
3845
 
        if merger is None and uncommitted:
3846
 
            if revision is not None and len(revision) > 0:
3847
 
                raise errors.BzrCommandError('Cannot use --uncommitted and'
3848
 
                    ' --revision at the same time.')
3849
 
            merger = self.get_merger_from_uncommitted(tree, location, None)
3850
 
            allow_pending = False
3851
 
 
3852
 
        if merger is None:
3853
 
            merger, allow_pending = self._get_merger_from_branch(tree,
3854
 
                location, revision, remember, possible_transports, None)
3855
 
 
3856
 
        merger.merge_type = merge_type
3857
 
        merger.reprocess = reprocess
3858
 
        merger.show_base = show_base
3859
 
        self.sanity_check_merger(merger)
3860
 
        if (merger.base_rev_id == merger.other_rev_id and
3861
 
            merger.other_rev_id is not None):
3862
 
            note('Nothing to do.')
3863
 
            return 0
3864
 
        if pull:
3865
 
            if merger.interesting_files is not None:
3866
 
                raise errors.BzrCommandError('Cannot pull individual files')
3867
 
            if (merger.base_rev_id == tree.last_revision()):
3868
 
                result = tree.pull(merger.other_branch, False,
3869
 
                                   merger.other_rev_id)
3870
 
                result.report(self.outf)
3871
 
                return 0
3872
 
        if merger.this_basis is None:
3873
 
            raise errors.BzrCommandError(
3874
 
                "This branch has no commits."
3875
 
                " (perhaps you would prefer 'bzr pull')")
3876
 
        if preview:
3877
 
            return self._do_preview(merger)
3878
 
        elif interactive:
3879
 
            return self._do_interactive(merger)
3880
 
        else:
3881
 
            return self._do_merge(merger, change_reporter, allow_pending,
3882
 
                                  verified)
3883
 
 
3884
 
    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
3885
3565
        tree_merger = merger.make_merger()
3886
3566
        tt = tree_merger.make_preview_transform()
3887
 
        self.add_cleanup(tt.finalize)
3888
 
        result_tree = tt.get_preview_tree()
3889
 
        return result_tree
3890
 
 
3891
 
    def _do_preview(self, merger):
3892
 
        from bzrlib.diff import show_diff_trees
3893
 
        result_tree = self._get_preview(merger)
3894
 
        path_encoding = osutils.get_diff_header_encoding()
3895
 
        show_diff_trees(merger.this_tree, result_tree, self.outf,
3896
 
                        old_label='', new_label='',
3897
 
                        path_encoding=path_encoding)
 
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()
3898
3573
 
3899
3574
    def _do_merge(self, merger, change_reporter, allow_pending, verified):
3900
3575
        merger.change_reporter = change_reporter
3908
3583
        else:
3909
3584
            return 0
3910
3585
 
3911
 
    def _do_interactive(self, merger):
3912
 
        """Perform an interactive merge.
3913
 
 
3914
 
        This works by generating a preview tree of the merge, then using
3915
 
        Shelver to selectively remove the differences between the working tree
3916
 
        and the preview tree.
3917
 
        """
3918
 
        from bzrlib import shelf_ui
3919
 
        result_tree = self._get_preview(merger)
3920
 
        writer = bzrlib.option.diff_writer_registry.get()
3921
 
        shelver = shelf_ui.Shelver(merger.this_tree, result_tree, destroy=True,
3922
 
                                   reporter=shelf_ui.ApplyReporter(),
3923
 
                                   diff_writer=writer(sys.stdout))
3924
 
        try:
3925
 
            shelver.run()
3926
 
        finally:
3927
 
            shelver.finalize()
3928
 
 
3929
3586
    def sanity_check_merger(self, merger):
3930
3587
        if (merger.show_base and
3931
3588
            not merger.merge_type is _mod_merge.Merge3Merger):
3966
3623
            base_branch, base_path = Branch.open_containing(base_loc,
3967
3624
                possible_transports)
3968
3625
        # Find the revision ids
3969
 
        other_revision_id = None
3970
 
        base_revision_id = None
3971
 
        if revision is not None:
3972
 
            if len(revision) >= 1:
3973
 
                other_revision_id = revision[-1].as_revision_id(other_branch)
3974
 
            if len(revision) == 2:
3975
 
                base_revision_id = revision[0].as_revision_id(base_branch)
3976
 
        if other_revision_id is None:
 
3626
        if revision is None or len(revision) < 1 or revision[-1] is None:
3977
3627
            other_revision_id = _mod_revision.ensure_null(
3978
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
3979
3636
        # Remember where we merge from
3980
3637
        if ((remember or tree.branch.get_submit_branch() is None) and
3981
3638
             user_location is not None):
3990
3647
            allow_pending = True
3991
3648
        return merger, allow_pending
3992
3649
 
3993
 
    def get_merger_from_uncommitted(self, tree, location, pb):
3994
 
        """Get a merger for uncommitted changes.
3995
 
 
3996
 
        :param tree: The tree the merger should apply to.
3997
 
        :param location: The location containing uncommitted changes.
3998
 
        :param pb: The progress bar to use for showing progress.
3999
 
        """
4000
 
        location = self._select_branch_location(tree, location)[0]
4001
 
        other_tree, other_path = WorkingTree.open_containing(location)
4002
 
        merger = _mod_merge.Merger.from_uncommitted(tree, other_tree, pb)
4003
 
        if other_path != '':
4004
 
            merger.interesting_files = [other_path]
4005
 
        return merger
4006
 
 
4007
3650
    def _select_branch_location(self, tree, user_location, revision=None,
4008
3651
                                index=None):
4009
3652
        """Select a branch location, according to possible inputs.
4053
3696
 
4054
3697
 
4055
3698
class cmd_remerge(Command):
4056
 
    __doc__ = """Redo a merge.
 
3699
    """Redo a merge.
4057
3700
 
4058
3701
    Use this if you want to try a different merge technique while resolving
4059
3702
    conflicts.  Some merge techniques are better than others, and remerge
4084
3727
 
4085
3728
    def run(self, file_list=None, merge_type=None, show_base=False,
4086
3729
            reprocess=False):
4087
 
        from bzrlib.conflicts import restore
4088
3730
        if merge_type is None:
4089
3731
            merge_type = _mod_merge.Merge3Merger
4090
3732
        tree, file_list = tree_files(file_list)
4091
 
        self.add_cleanup(tree.lock_write().unlock)
4092
 
        parents = tree.get_parent_ids()
4093
 
        if len(parents) != 2:
4094
 
            raise errors.BzrCommandError("Sorry, remerge only works after normal"
4095
 
                                         " merges.  Not cherrypicking or"
4096
 
                                         " multi-merges.")
4097
 
        repository = tree.branch.repository
4098
 
        interesting_ids = None
4099
 
        new_conflicts = []
4100
 
        conflicts = tree.conflicts()
4101
 
        if file_list is not None:
4102
 
            interesting_ids = set()
4103
 
            for filename in file_list:
4104
 
                file_id = tree.path2id(filename)
4105
 
                if file_id is None:
4106
 
                    raise errors.NotVersionedError(filename)
4107
 
                interesting_ids.add(file_id)
4108
 
                if tree.kind(file_id) != "directory":
4109
 
                    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
4110
3753
 
4111
 
                for name, ie in tree.inventory.iter_entries(file_id):
4112
 
                    interesting_ids.add(ie.file_id)
4113
 
            new_conflicts = conflicts.select_conflicts(tree, file_list)[0]
4114
 
        else:
4115
 
            # Remerge only supports resolving contents conflicts
4116
 
            allowed_conflicts = ('text conflict', 'contents conflict')
4117
 
            restore_files = [c.path for c in conflicts
4118
 
                             if c.typestring in allowed_conflicts]
4119
 
        _mod_merge.transform_tree(tree, tree.basis_tree(), interesting_ids)
4120
 
        tree.set_conflicts(ConflictList(new_conflicts))
4121
 
        if file_list is not None:
4122
 
            restore_files = file_list
4123
 
        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])
4124
3778
            try:
4125
 
                restore(tree.abspath(filename))
4126
 
            except errors.NotConflicted:
4127
 
                pass
4128
 
        # Disable pending merges, because the file texts we are remerging
4129
 
        # have not had those merges performed.  If we use the wrong parents
4130
 
        # list, we imply that the working tree text has seen and rejected
4131
 
        # all the changes from the other tree, when in fact those changes
4132
 
        # have not yet been seen.
4133
 
        tree.set_parent_ids(parents[:1])
4134
 
        try:
4135
 
            merger = _mod_merge.Merger.from_revision_ids(None, tree, parents[1])
4136
 
            merger.interesting_ids = interesting_ids
4137
 
            merger.merge_type = merge_type
4138
 
            merger.show_base = show_base
4139
 
            merger.reprocess = reprocess
4140
 
            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()
4141
3789
        finally:
4142
 
            tree.set_parent_ids(parents)
 
3790
            tree.unlock()
4143
3791
        if conflicts > 0:
4144
3792
            return 1
4145
3793
        else:
4147
3795
 
4148
3796
 
4149
3797
class cmd_revert(Command):
4150
 
    __doc__ = """Revert files to a previous revision.
 
3798
    """Revert files to a previous revision.
4151
3799
 
4152
3800
    Giving a list of files will revert only those files.  Otherwise, all files
4153
3801
    will be reverted.  If the revision is not specified with '--revision', the
4167
3815
    name.  If you name a directory, all the contents of that directory will be
4168
3816
    reverted.
4169
3817
 
4170
 
    If you have newly added files since the target revision, they will be
4171
 
    removed.  If the files to be removed have been changed, backups will be
4172
 
    created as above.  Directories containing unknown files will not be
4173
 
    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.
4174
3821
 
4175
 
    The working tree contains a list of revisions that have been merged but
4176
 
    not yet committed. These revisions will be included as additional parents
4177
 
    of the next commit.  Normally, using revert clears that list as well as
4178
 
    reverting the files.  If any files are specified, revert leaves the list
4179
 
    of uncommitted merges alone and reverts only the files.  Use ``bzr revert
4180
 
    .`` in the tree root to revert all files but keep the recorded merges,
4181
 
    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
4182
3828
    reverting any files.
4183
 
 
4184
 
    Using "bzr revert --forget-merges", it is possible to apply all of the
4185
 
    changes from a branch in a single revision.  To do this, perform the merge
4186
 
    as desired.  Then doing revert with the "--forget-merges" option will keep
4187
 
    the content of the tree as it was, but it will clear the list of pending
4188
 
    merges.  The next commit will then contain all of the changes that are
4189
 
    present in the other branch, but without any other parent revisions.
4190
 
    Because this technique forgets where these changes originated, it may
4191
 
    cause additional conflicts on later merges involving the same source and
4192
 
    target branches.
4193
3829
    """
4194
3830
 
4195
3831
    _see_also = ['cat', 'export']
4204
3840
    def run(self, revision=None, no_backup=False, file_list=None,
4205
3841
            forget_merges=None):
4206
3842
        tree, file_list = tree_files(file_list)
4207
 
        self.add_cleanup(tree.lock_tree_write().unlock)
4208
 
        if forget_merges:
4209
 
            tree.set_parent_ids(tree.get_parent_ids()[:1])
4210
 
        else:
4211
 
            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()
4212
3851
 
4213
3852
    @staticmethod
4214
3853
    def _revert_tree_to_revision(tree, revision, file_list, no_backup):
4215
3854
        rev_tree = _get_one_revision_tree('revert', revision, tree=tree)
4216
 
        tree.revert(file_list, rev_tree, not no_backup, None,
4217
 
            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()
4218
3861
 
4219
3862
 
4220
3863
class cmd_assert_fail(Command):
4221
 
    __doc__ = """Test reporting of assertion failures"""
 
3864
    """Test reporting of assertion failures"""
4222
3865
    # intended just for use in testing
4223
3866
 
4224
3867
    hidden = True
4228
3871
 
4229
3872
 
4230
3873
class cmd_help(Command):
4231
 
    __doc__ = """Show help on a command or other topic.
 
3874
    """Show help on a command or other topic.
4232
3875
    """
4233
3876
 
4234
3877
    _see_also = ['topics']
4247
3890
 
4248
3891
 
4249
3892
class cmd_shell_complete(Command):
4250
 
    __doc__ = """Show appropriate completions for context.
 
3893
    """Show appropriate completions for context.
4251
3894
 
4252
3895
    For a list of all available commands, say 'bzr shell-complete'.
4253
3896
    """
4262
3905
 
4263
3906
 
4264
3907
class cmd_missing(Command):
4265
 
    __doc__ = """Show unmerged/unpulled revisions between two branches.
 
3908
    """Show unmerged/unpulled revisions between two branches.
4266
3909
 
4267
3910
    OTHER_BRANCH may be local or remote.
4268
3911
 
4269
3912
    To filter on a range of revisions, you can use the command -r begin..end
4270
3913
    -r revision requests a specific revision, -r ..end or -r begin.. are
4271
3914
    also valid.
4272
 
            
4273
 
    :Exit values:
4274
 
        1 - some missing revisions
4275
 
        0 - no missing revisions
4276
3915
 
4277
3916
    :Examples:
4278
3917
 
4299
3938
    _see_also = ['merge', 'pull']
4300
3939
    takes_args = ['other_branch?']
4301
3940
    takes_options = [
4302
 
        'directory',
4303
3941
        Option('reverse', 'Reverse the order of revisions.'),
4304
3942
        Option('mine-only',
4305
3943
               'Display changes in the local branch only.'),
4327
3965
            theirs_only=False,
4328
3966
            log_format=None, long=False, short=False, line=False,
4329
3967
            show_ids=False, verbose=False, this=False, other=False,
4330
 
            include_merges=False, revision=None, my_revision=None,
4331
 
            directory=u'.'):
 
3968
            include_merges=False, revision=None, my_revision=None):
4332
3969
        from bzrlib.missing import find_unmerged, iter_log_revisions
4333
3970
        def message(s):
4334
3971
            if not is_quiet():
4347
3984
        elif theirs_only:
4348
3985
            restrict = 'remote'
4349
3986
 
4350
 
        local_branch = Branch.open_containing(directory)[0]
4351
 
        self.add_cleanup(local_branch.lock_read().unlock)
4352
 
 
 
3987
        local_branch = Branch.open_containing(u".")[0]
4353
3988
        parent = local_branch.get_parent()
4354
3989
        if other_branch is None:
4355
3990
            other_branch = parent
4364
3999
        remote_branch = Branch.open(other_branch)
4365
4000
        if remote_branch.base == local_branch.base:
4366
4001
            remote_branch = local_branch
4367
 
        else:
4368
 
            self.add_cleanup(remote_branch.lock_read().unlock)
4369
4002
 
4370
4003
        local_revid_range = _revision_range_to_revid_range(
4371
4004
            _get_revision_range(my_revision, local_branch,
4375
4008
            _get_revision_range(revision,
4376
4009
                remote_branch, self.name()))
4377
4010
 
4378
 
        local_extra, remote_extra = find_unmerged(
4379
 
            local_branch, remote_branch, restrict,
4380
 
            backward=not reverse,
4381
 
            include_merges=include_merges,
4382
 
            local_revid_range=local_revid_range,
4383
 
            remote_revid_range=remote_revid_range)
4384
 
 
4385
 
        if log_format is None:
4386
 
            registry = log.log_formatter_registry
4387
 
            log_format = registry.get_default(local_branch)
4388
 
        lf = log_format(to_file=self.outf,
4389
 
                        show_ids=show_ids,
4390
 
                        show_timezone='original')
4391
 
 
4392
 
        status_code = 0
4393
 
        if local_extra and not theirs_only:
4394
 
            message("You have %d extra revision(s):\n" %
4395
 
                len(local_extra))
4396
 
            for revision in iter_log_revisions(local_extra,
4397
 
                                local_branch.repository,
4398
 
                                verbose):
4399
 
                lf.log_revision(revision)
4400
 
            printed_local = True
4401
 
            status_code = 1
4402
 
        else:
4403
 
            printed_local = False
4404
 
 
4405
 
        if remote_extra and not mine_only:
4406
 
            if printed_local is True:
4407
 
                message("\n\n\n")
4408
 
            message("You are missing %d revision(s):\n" %
4409
 
                len(remote_extra))
4410
 
            for revision in iter_log_revisions(remote_extra,
4411
 
                                remote_branch.repository,
4412
 
                                verbose):
4413
 
                lf.log_revision(revision)
4414
 
            status_code = 1
4415
 
 
4416
 
        if mine_only and not local_extra:
4417
 
            # We checked local, and found nothing extra
4418
 
            message('This branch is up to date.\n')
4419
 
        elif theirs_only and not remote_extra:
4420
 
            # We checked remote, and found nothing extra
4421
 
            message('Other branch is up to date.\n')
4422
 
        elif not (mine_only or theirs_only or local_extra or
4423
 
                  remote_extra):
4424
 
            # We checked both branches, and neither one had extra
4425
 
            # revisions
4426
 
            message("Branches are up to date.\n")
4427
 
        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()
4428
4068
        if not status_code and parent is None and other_branch is not None:
4429
 
            self.add_cleanup(local_branch.lock_write().unlock)
4430
 
            # handle race conditions - a parent might be set while we run.
4431
 
            if local_branch.get_parent() is None:
4432
 
                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()
4433
4076
        return status_code
4434
4077
 
4435
4078
 
4436
4079
class cmd_pack(Command):
4437
 
    __doc__ = """Compress the data within a repository.
4438
 
 
4439
 
    This operation compresses the data within a bazaar repository. As
4440
 
    bazaar supports automatic packing of repository, this operation is
4441
 
    normally not required to be done manually.
4442
 
 
4443
 
    During the pack operation, bazaar takes a backup of existing repository
4444
 
    data, i.e. pack files. This backup is eventually removed by bazaar
4445
 
    automatically when it is safe to do so. To save disk space by removing
4446
 
    the backed up pack files, the --clean-obsolete-packs option may be
4447
 
    used.
4448
 
 
4449
 
    Warning: If you use --clean-obsolete-packs and your machine crashes
4450
 
    during or immediately after repacking, you may be left with a state
4451
 
    where the deletion has been written to disk but the new packs have not
4452
 
    been. In this case the repository may be unusable.
4453
 
    """
 
4080
    """Compress the data within a repository."""
4454
4081
 
4455
4082
    _see_also = ['repositories']
4456
4083
    takes_args = ['branch_or_repo?']
4457
 
    takes_options = [
4458
 
        Option('clean-obsolete-packs', 'Delete obsolete packs to save disk space.'),
4459
 
        ]
4460
4084
 
4461
 
    def run(self, branch_or_repo='.', clean_obsolete_packs=False):
 
4085
    def run(self, branch_or_repo='.'):
4462
4086
        dir = bzrdir.BzrDir.open_containing(branch_or_repo)[0]
4463
4087
        try:
4464
4088
            branch = dir.open_branch()
4465
4089
            repository = branch.repository
4466
4090
        except errors.NotBranchError:
4467
4091
            repository = dir.open_repository()
4468
 
        repository.pack(clean_obsolete_packs=clean_obsolete_packs)
 
4092
        repository.pack()
4469
4093
 
4470
4094
 
4471
4095
class cmd_plugins(Command):
4472
 
    __doc__ = """List the installed plugins.
 
4096
    """List the installed plugins.
4473
4097
 
4474
4098
    This command displays the list of installed plugins including
4475
4099
    version of plugin and a short description of each.
4482
4106
    adding new commands, providing additional network transports and
4483
4107
    customizing log output.
4484
4108
 
4485
 
    See the Bazaar Plugin Guide <http://doc.bazaar.canonical.com/plugins/en/>
4486
 
    for further information on plugins including where to find them and how to
4487
 
    install them. Instructions are also provided there on how to write new
4488
 
    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.
4489
4113
    """
4490
4114
    takes_options = ['verbose']
4491
4115
 
4506
4130
                doc = '(no description)'
4507
4131
            result.append((name_ver, doc, plugin.path()))
4508
4132
        for name_ver, doc, path in sorted(result):
4509
 
            self.outf.write("%s\n" % name_ver)
4510
 
            self.outf.write("   %s\n" % doc)
 
4133
            print name_ver
 
4134
            print '   ', doc
4511
4135
            if verbose:
4512
 
                self.outf.write("   %s\n" % path)
4513
 
            self.outf.write("\n")
 
4136
                print '   ', path
 
4137
            print
4514
4138
 
4515
4139
 
4516
4140
class cmd_testament(Command):
4517
 
    __doc__ = """Show testament (signing-form) of a revision."""
 
4141
    """Show testament (signing-form) of a revision."""
4518
4142
    takes_options = [
4519
4143
            'revision',
4520
4144
            Option('long', help='Produce long-format testament.'),
4532
4156
            b = Branch.open_containing(branch)[0]
4533
4157
        else:
4534
4158
            b = Branch.open(branch)
4535
 
        self.add_cleanup(b.lock_read().unlock)
4536
 
        if revision is None:
4537
 
            rev_id = b.last_revision()
4538
 
        else:
4539
 
            rev_id = revision[0].as_revision_id(b)
4540
 
        t = testament_class.from_revision(b.repository, rev_id)
4541
 
        if long:
4542
 
            sys.stdout.writelines(t.as_text_lines())
4543
 
        else:
4544
 
            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()
4545
4172
 
4546
4173
 
4547
4174
class cmd_annotate(Command):
4548
 
    __doc__ = """Show the origin of each line in a file.
 
4175
    """Show the origin of each line in a file.
4549
4176
 
4550
4177
    This prints out the given file with an annotation on the left side
4551
4178
    indicating which revision, author and date introduced the change.
4562
4189
                     Option('long', help='Show commit date in annotations.'),
4563
4190
                     'revision',
4564
4191
                     'show-ids',
4565
 
                     'directory',
4566
4192
                     ]
4567
4193
    encoding_type = 'exact'
4568
4194
 
4569
4195
    @display_command
4570
4196
    def run(self, filename, all=False, long=False, revision=None,
4571
 
            show_ids=False, directory=None):
 
4197
            show_ids=False):
4572
4198
        from bzrlib.annotate import annotate_file, annotate_file_tree
4573
4199
        wt, branch, relpath = \
4574
 
            _open_directory_or_containing_tree_or_branch(filename, directory)
4575
 
        if wt is not None:
4576
 
            self.add_cleanup(wt.lock_read().unlock)
4577
 
        else:
4578
 
            self.add_cleanup(branch.lock_read().unlock)
4579
 
        tree = _get_one_revision_tree('annotate', revision, branch=branch)
4580
 
        self.add_cleanup(tree.lock_read().unlock)
4581
 
        if wt is not None:
4582
 
            file_id = wt.path2id(relpath)
4583
 
        else:
4584
 
            file_id = tree.path2id(relpath)
4585
 
        if file_id is None:
4586
 
            raise errors.NotVersionedError(filename)
4587
 
        file_version = tree.inventory[file_id].revision
4588
 
        if wt is not None and revision is None:
4589
 
            # If there is a tree and we're not annotating historical
4590
 
            # versions, annotate the working tree's content.
4591
 
            annotate_file_tree(wt, file_id, self.outf, long, all,
4592
 
                show_ids=show_ids)
4593
 
        else:
4594
 
            annotate_file(branch, file_version, file_id, long, all, self.outf,
4595
 
                          show_ids=show_ids)
 
4200
            bzrdir.BzrDir.open_containing_tree_or_branch(filename)
 
4201
        if wt is not None:
 
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()
4596
4227
 
4597
4228
 
4598
4229
class cmd_re_sign(Command):
4599
 
    __doc__ = """Create a digital signature for an existing revision."""
 
4230
    """Create a digital signature for an existing revision."""
4600
4231
    # TODO be able to replace existing ones.
4601
4232
 
4602
4233
    hidden = True # is this right ?
4603
4234
    takes_args = ['revision_id*']
4604
 
    takes_options = ['directory', 'revision']
 
4235
    takes_options = ['revision']
4605
4236
 
4606
 
    def run(self, revision_id_list=None, revision=None, directory=u'.'):
 
4237
    def run(self, revision_id_list=None, revision=None):
4607
4238
        if revision_id_list is not None and revision is not None:
4608
4239
            raise errors.BzrCommandError('You can only supply one of revision_id or --revision')
4609
4240
        if revision_id_list is None and revision is None:
4610
4241
            raise errors.BzrCommandError('You must supply either --revision or a revision_id')
4611
 
        b = WorkingTree.open_containing(directory)[0].branch
4612
 
        self.add_cleanup(b.lock_write().unlock)
4613
 
        return self._run(b, revision_id_list, revision)
 
4242
        b = WorkingTree.open_containing(u'.')[0].branch
 
4243
        b.lock_write()
 
4244
        try:
 
4245
            return self._run(b, revision_id_list, revision)
 
4246
        finally:
 
4247
            b.unlock()
4614
4248
 
4615
4249
    def _run(self, b, revision_id_list, revision):
4616
4250
        import bzrlib.gpg as gpg
4661
4295
 
4662
4296
 
4663
4297
class cmd_bind(Command):
4664
 
    __doc__ = """Convert the current branch into a checkout of the supplied branch.
4665
 
    If no branch is supplied, rebind to the last bound location.
 
4298
    """Convert the current branch into a checkout of the supplied branch.
4666
4299
 
4667
4300
    Once converted into a checkout, commits must succeed on the master branch
4668
4301
    before they will be applied to the local branch.
4669
4302
 
4670
4303
    Bound branches use the nickname of its master branch unless it is set
4671
 
    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
4672
4305
    that of the master.
4673
4306
    """
4674
4307
 
4675
4308
    _see_also = ['checkouts', 'unbind']
4676
4309
    takes_args = ['location?']
4677
 
    takes_options = ['directory']
 
4310
    takes_options = []
4678
4311
 
4679
 
    def run(self, location=None, directory=u'.'):
4680
 
        b, relpath = Branch.open_containing(directory)
 
4312
    def run(self, location=None):
 
4313
        b, relpath = Branch.open_containing(u'.')
4681
4314
        if location is None:
4682
4315
            try:
4683
4316
                location = b.get_old_bound_location()
4686
4319
                    'This format does not remember old locations.')
4687
4320
            else:
4688
4321
                if location is None:
4689
 
                    if b.get_bound_location() is not None:
4690
 
                        raise errors.BzrCommandError('Branch is already bound')
4691
 
                    else:
4692
 
                        raise errors.BzrCommandError('No location supplied '
4693
 
                            'and no previous location known')
 
4322
                    raise errors.BzrCommandError('No location supplied and no '
 
4323
                        'previous location known')
4694
4324
        b_other = Branch.open(location)
4695
4325
        try:
4696
4326
            b.bind(b_other)
4702
4332
 
4703
4333
 
4704
4334
class cmd_unbind(Command):
4705
 
    __doc__ = """Convert the current checkout into a regular branch.
 
4335
    """Convert the current checkout into a regular branch.
4706
4336
 
4707
4337
    After unbinding, the local branch is considered independent and subsequent
4708
4338
    commits will be local only.
4710
4340
 
4711
4341
    _see_also = ['checkouts', 'bind']
4712
4342
    takes_args = []
4713
 
    takes_options = ['directory']
 
4343
    takes_options = []
4714
4344
 
4715
 
    def run(self, directory=u'.'):
4716
 
        b, relpath = Branch.open_containing(directory)
 
4345
    def run(self):
 
4346
        b, relpath = Branch.open_containing(u'.')
4717
4347
        if not b.unbind():
4718
4348
            raise errors.BzrCommandError('Local branch is not bound')
4719
4349
 
4720
4350
 
4721
4351
class cmd_uncommit(Command):
4722
 
    __doc__ = """Remove the last committed revision.
 
4352
    """Remove the last committed revision.
4723
4353
 
4724
4354
    --verbose will print out what is being removed.
4725
4355
    --dry-run will go through all the motions, but not actually
4765
4395
            b = control.open_branch()
4766
4396
 
4767
4397
        if tree is not None:
4768
 
            self.add_cleanup(tree.lock_write().unlock)
 
4398
            tree.lock_write()
4769
4399
        else:
4770
 
            self.add_cleanup(b.lock_write().unlock)
4771
 
        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()
4772
4409
 
4773
4410
    def _run(self, b, tree, dry_run, verbose, revision, force, local=False):
4774
4411
        from bzrlib.log import log_formatter, show_log
4806
4443
                 end_revision=last_revno)
4807
4444
 
4808
4445
        if dry_run:
4809
 
            self.outf.write('Dry-run, pretending to remove'
4810
 
                            ' 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')
4811
4449
        else:
4812
 
            self.outf.write('The above revision(s) will be removed.\n')
4813
 
 
4814
 
        if not force:
4815
 
            if not ui.ui_factory.get_boolean('Are you sure'):
4816
 
                self.outf.write('Canceled')
4817
 
                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
4818
4456
 
4819
4457
        mutter('Uncommitting from {%s} to {%s}',
4820
4458
               last_rev_id, rev_id)
4821
4459
        uncommit(b, tree=tree, dry_run=dry_run, verbose=verbose,
4822
4460
                 revno=revno, local=local)
4823
 
        self.outf.write('You can restore the old tip by running:\n'
4824
 
             '  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)
4825
4463
 
4826
4464
 
4827
4465
class cmd_break_lock(Command):
4828
 
    __doc__ = """Break a dead lock on a repository, branch or working directory.
 
4466
    """Break a dead lock on a repository, branch or working directory.
4829
4467
 
4830
4468
    CAUTION: Locks should only be broken when you are sure that the process
4831
4469
    holding the lock has been stopped.
4832
4470
 
4833
 
    You can get information on what locks are open via the 'bzr info
4834
 
    [location]' command.
 
4471
    You can get information on what locks are open via the 'bzr info' command.
4835
4472
 
4836
4473
    :Examples:
4837
4474
        bzr break-lock
4838
 
        bzr break-lock bzr+ssh://example.com/bzr/foo
4839
4475
    """
4840
4476
    takes_args = ['location?']
4841
4477
 
4850
4486
 
4851
4487
 
4852
4488
class cmd_wait_until_signalled(Command):
4853
 
    __doc__ = """Test helper for test_start_and_stop_bzr_subprocess_send_signal.
 
4489
    """Test helper for test_start_and_stop_bzr_subprocess_send_signal.
4854
4490
 
4855
4491
    This just prints a line to signal when it is ready, then blocks on stdin.
4856
4492
    """
4864
4500
 
4865
4501
 
4866
4502
class cmd_serve(Command):
4867
 
    __doc__ = """Run the bzr server."""
 
4503
    """Run the bzr server."""
4868
4504
 
4869
4505
    aliases = ['server']
4870
4506
 
4871
4507
    takes_options = [
4872
4508
        Option('inet',
4873
4509
               help='Serve on stdin/out for use from inetd or sshd.'),
4874
 
        RegistryOption('protocol',
4875
 
               help="Protocol to serve.",
4876
 
               lazy_registry=('bzrlib.transport', 'transport_server_registry'),
4877
 
               value_switches=True),
4878
4510
        Option('port',
4879
4511
               help='Listen for connections on nominated port of the form '
4880
4512
                    '[hostname:]portnumber.  Passing 0 as the port number will '
4881
 
                    'result in a dynamically allocated port.  The default port '
4882
 
                    'depends on the protocol.',
 
4513
                    'result in a dynamically allocated port.  The default port is '
 
4514
                    '4155.',
4883
4515
               type=str),
4884
 
        custom_help('directory',
4885
 
               help='Serve contents of this directory.'),
 
4516
        Option('directory',
 
4517
               help='Serve contents of this directory.',
 
4518
               type=unicode),
4886
4519
        Option('allow-writes',
4887
4520
               help='By default the server is a readonly server.  Supplying '
4888
4521
                    '--allow-writes enables write access to the contents of '
4889
 
                    'the served directory and below.  Note that ``bzr serve`` '
4890
 
                    'does not perform authentication, so unless some form of '
4891
 
                    'external authentication is arranged supplying this '
4892
 
                    'option leads to global uncontrolled write access to your '
4893
 
                    'file system.'
 
4522
                    'the served directory and below.'
4894
4523
                ),
4895
4524
        ]
4896
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
 
4897
4543
    def get_host_and_port(self, port):
4898
4544
        """Return the host and port to run the smart server on.
4899
4545
 
4900
 
        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.
4901
4548
 
4902
4549
        If 'port' has a colon in it, the string before the colon will be
4903
4550
        interpreted as the host.
4906
4553
        :return: A tuple of (host, port), where 'host' is a host name or IP,
4907
4554
            and port is an integer TCP/IP port.
4908
4555
        """
4909
 
        host = None
4910
 
        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:
4911
4561
            if ':' in port:
4912
4562
                host, port = port.split(':')
4913
4563
            port = int(port)
4914
4564
        return host, port
4915
4565
 
4916
 
    def run(self, port=None, inet=False, directory=None, allow_writes=False,
4917
 
            protocol=None):
4918
 
        from bzrlib import transport
 
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
4919
4592
        if directory is None:
4920
4593
            directory = os.getcwd()
4921
 
        if protocol is None:
4922
 
            protocol = transport.transport_server_registry.get()
4923
 
        host, port = self.get_host_and_port(port)
4924
4594
        url = urlutils.local_path_to_url(directory)
4925
4595
        if not allow_writes:
4926
4596
            url = 'readonly+' + url
4927
 
        t = transport.get_transport(url)
4928
 
        protocol(t, 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)
4929
4602
 
4930
4603
 
4931
4604
class cmd_join(Command):
4932
 
    __doc__ = """Combine a tree into its containing tree.
 
4605
    """Combine a tree into its containing tree.
4933
4606
 
4934
4607
    This command requires the target tree to be in a rich-root format.
4935
4608
 
4975
4648
 
4976
4649
 
4977
4650
class cmd_split(Command):
4978
 
    __doc__ = """Split a subdirectory of a tree into a separate tree.
 
4651
    """Split a subdirectory of a tree into a separate tree.
4979
4652
 
4980
4653
    This command will produce a target tree in a format that supports
4981
4654
    rich roots, like 'rich-root' or 'rich-root-pack'.  These formats cannot be
4997
4670
        try:
4998
4671
            containing_tree.extract(sub_id)
4999
4672
        except errors.RootNotRich:
5000
 
            raise errors.RichRootUpgradeRequired(containing_tree.branch.base)
 
4673
            raise errors.UpgradeRequired(containing_tree.branch.base)
5001
4674
 
5002
4675
 
5003
4676
class cmd_merge_directive(Command):
5004
 
    __doc__ = """Generate a merge directive for auto-merge tools.
 
4677
    """Generate a merge directive for auto-merge tools.
5005
4678
 
5006
4679
    A directive requests a merge to be performed, and also provides all the
5007
4680
    information necessary to do so.  This means it must either include a
5024
4697
    _see_also = ['send']
5025
4698
 
5026
4699
    takes_options = [
5027
 
        'directory',
5028
4700
        RegistryOption.from_kwargs('patch-type',
5029
4701
            'The type of patch to include in the directive.',
5030
4702
            title='Patch type',
5043
4715
    encoding_type = 'exact'
5044
4716
 
5045
4717
    def run(self, submit_branch=None, public_branch=None, patch_type='bundle',
5046
 
            sign=False, revision=None, mail_to=None, message=None,
5047
 
            directory=u'.'):
 
4718
            sign=False, revision=None, mail_to=None, message=None):
5048
4719
        from bzrlib.revision import ensure_null, NULL_REVISION
5049
4720
        include_patch, include_bundle = {
5050
4721
            'plain': (False, False),
5051
4722
            'diff': (True, False),
5052
4723
            'bundle': (True, True),
5053
4724
            }[patch_type]
5054
 
        branch = Branch.open(directory)
 
4725
        branch = Branch.open('.')
5055
4726
        stored_submit_branch = branch.get_submit_branch()
5056
4727
        if submit_branch is None:
5057
4728
            submit_branch = stored_submit_branch
5102
4773
 
5103
4774
 
5104
4775
class cmd_send(Command):
5105
 
    __doc__ = """Mail or create a merge-directive for submitting changes.
 
4776
    """Mail or create a merge-directive for submitting changes.
5106
4777
 
5107
4778
    A merge directive provides many things needed for requesting merges:
5108
4779
 
5114
4785
      directly from the merge directive, without retrieving data from a
5115
4786
      branch.
5116
4787
 
5117
 
    `bzr send` creates a compact data set that, when applied using bzr
5118
 
    merge, has the same effect as merging from the source branch.  
5119
 
    
5120
 
    By default the merge directive is self-contained and can be applied to any
5121
 
    branch containing submit_branch in its ancestory without needing access to
5122
 
    the source branch.
5123
 
    
5124
 
    If --no-bundle is specified, then Bazaar doesn't send the contents of the
5125
 
    revisions, but only a structured request to merge from the
5126
 
    public_location.  In that case the public_branch is needed and it must be
5127
 
    up-to-date and accessible to the recipient.  The public_branch is always
5128
 
    included if known, so that people can check it later.
5129
 
 
5130
 
    The submit branch defaults to the parent of the source branch, but can be
5131
 
    overridden.  Both submit branch and public branch will be remembered in
5132
 
    branch.conf the first time they are used for a particular branch.  The
5133
 
    source branch defaults to that containing the working directory, but can
5134
 
    be changed using --from.
5135
 
 
5136
 
    In order to calculate those changes, bzr must analyse the submit branch.
5137
 
    Therefore it is most efficient for the submit branch to be a local mirror.
5138
 
    If a public location is known for the submit_branch, that location is used
5139
 
    in the merge directive.
5140
 
 
5141
 
    The default behaviour is to send the merge directive by mail, unless -o is
5142
 
    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.
5143
4800
 
5144
4801
    Mail is sent using your preferred mail program.  This should be transparent
5145
 
    on Windows (it uses MAPI).  On Unix, it requires the xdg-email utility.
 
4802
    on Windows (it uses MAPI).  On Linux, it requires the xdg-email utility.
5146
4803
    If the preferred client can't be found (or used), your editor will be used.
5147
4804
 
5148
4805
    To use a specific mail program, set the mail_client configuration option.
5149
4806
    (For Thunderbird 1.5, this works around some bugs.)  Supported values for
5150
 
    specific clients are "claws", "evolution", "kmail", "mail.app" (MacOS X's
5151
 
    Mail.app), "mutt", and "thunderbird"; generic options are "default",
5152
 
    "editor", "emacsclient", "mapi", and "xdg-email".  Plugins may also add
5153
 
    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.
5154
4810
 
5155
4811
    If mail is being sent, a to address is required.  This can be supplied
5156
4812
    either on the commandline, by setting the submit_to configuration
5165
4821
 
5166
4822
    The merge directives created by bzr send may be applied using bzr merge or
5167
4823
    bzr pull by specifying a file containing a merge directive as the location.
5168
 
 
5169
 
    bzr send makes extensive use of public locations to map local locations into
5170
 
    URLs that can be used by other people.  See `bzr help configuration` to
5171
 
    set them, and use `bzr info` to display them.
5172
4824
    """
5173
4825
 
5174
4826
    encoding_type = 'exact'
5190
4842
               short_name='f',
5191
4843
               type=unicode),
5192
4844
        Option('output', short_name='o',
5193
 
               help='Write merge directive to this file or directory; '
 
4845
               help='Write merge directive to this file; '
5194
4846
                    'use - for stdout.',
5195
4847
               type=unicode),
5196
 
        Option('strict',
5197
 
               help='Refuse to send if there are uncommitted changes in'
5198
 
               ' the working tree, --no-strict disables the check.'),
5199
4848
        Option('mail-to', help='Mail the request to this address.',
5200
4849
               type=unicode),
5201
4850
        'revision',
5202
4851
        'message',
5203
4852
        Option('body', help='Body for the email.', type=unicode),
5204
 
        RegistryOption('format',
5205
 
                       help='Use the specified output format.',
5206
 
                       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',})
5207
4857
        ]
5208
4858
 
5209
4859
    def run(self, submit_branch=None, public_branch=None, no_bundle=False,
5210
4860
            no_patch=False, revision=None, remember=False, output=None,
5211
 
            format=None, mail_to=None, message=None, body=None,
5212
 
            strict=None, **kwargs):
5213
 
        from bzrlib.send import send
5214
 
        return send(submit_branch, revision, public_branch, remember,
5215
 
                    format, no_bundle, no_patch, output,
5216
 
                    kwargs.get('from', '.'), mail_to, message, body,
5217
 
                    self.outf,
5218
 
                    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
        tree, branch = bzrdir.BzrDir.open_containing_tree_or_branch(from_)[:2]
 
4870
        # we may need to write data into branch's repository to calculate
 
4871
        # the data to send.
 
4872
        branch.lock_write()
 
4873
        try:
 
4874
            if output is None:
 
4875
                config = branch.get_config()
 
4876
                if mail_to is None:
 
4877
                    mail_to = config.get_user_option('submit_to')
 
4878
                mail_client = config.get_mail_client()
 
4879
                if (not getattr(mail_client, 'supports_body', False)
 
4880
                    and body is not None):
 
4881
                    raise errors.BzrCommandError(
 
4882
                        'Mail client "%s" does not support specifying body' %
 
4883
                        mail_client.__class__.__name__)
 
4884
            if remember and submit_branch is None:
 
4885
                raise errors.BzrCommandError(
 
4886
                    '--remember requires a branch to be specified.')
 
4887
            stored_submit_branch = branch.get_submit_branch()
 
4888
            remembered_submit_branch = None
 
4889
            if submit_branch is None:
 
4890
                submit_branch = stored_submit_branch
 
4891
                remembered_submit_branch = "submit"
 
4892
            else:
 
4893
                if stored_submit_branch is None or remember:
 
4894
                    branch.set_submit_branch(submit_branch)
 
4895
            if submit_branch is None:
 
4896
                submit_branch = branch.get_parent()
 
4897
                remembered_submit_branch = "parent"
 
4898
            if submit_branch is None:
 
4899
                raise errors.BzrCommandError('No submit branch known or'
 
4900
                                             ' specified')
 
4901
            if remembered_submit_branch is not None:
 
4902
                note('Using saved %s location "%s" to determine what '
 
4903
                        'changes to submit.', remembered_submit_branch,
 
4904
                        submit_branch)
 
4905
 
 
4906
            if mail_to is None:
 
4907
                submit_config = Branch.open(submit_branch).get_config()
 
4908
                mail_to = submit_config.get_user_option("child_submit_to")
 
4909
 
 
4910
            stored_public_branch = branch.get_public_branch()
 
4911
            if public_branch is None:
 
4912
                public_branch = stored_public_branch
 
4913
            elif stored_public_branch is None or remember:
 
4914
                branch.set_public_branch(public_branch)
 
4915
            if no_bundle and public_branch is None:
 
4916
                raise errors.BzrCommandError('No public branch specified or'
 
4917
                                             ' known')
 
4918
            base_revision_id = None
 
4919
            revision_id = None
 
4920
            if revision is not None:
 
4921
                if len(revision) > 2:
 
4922
                    raise errors.BzrCommandError('bzr send takes '
 
4923
                        'at most two one revision identifiers')
 
4924
                revision_id = revision[-1].as_revision_id(branch)
 
4925
                if len(revision) == 2:
 
4926
                    base_revision_id = revision[0].as_revision_id(branch)
 
4927
            if revision_id is None:
 
4928
                revision_id = branch.last_revision()
 
4929
            if revision_id == NULL_REVISION:
 
4930
                raise errors.BzrCommandError('No revisions to submit.')
 
4931
            if format == '4':
 
4932
                directive = merge_directive.MergeDirective2.from_objects(
 
4933
                    branch.repository, revision_id, time.time(),
 
4934
                    osutils.local_time_offset(), submit_branch,
 
4935
                    public_branch=public_branch, include_patch=not no_patch,
 
4936
                    include_bundle=not no_bundle, message=message,
 
4937
                    base_revision_id=base_revision_id)
 
4938
            elif format == '0.9':
 
4939
                if not no_bundle:
 
4940
                    if not no_patch:
 
4941
                        patch_type = 'bundle'
 
4942
                    else:
 
4943
                        raise errors.BzrCommandError('Format 0.9 does not'
 
4944
                            ' permit bundle with no patch')
 
4945
                else:
 
4946
                    if not no_patch:
 
4947
                        patch_type = 'diff'
 
4948
                    else:
 
4949
                        patch_type = None
 
4950
                directive = merge_directive.MergeDirective.from_objects(
 
4951
                    branch.repository, revision_id, time.time(),
 
4952
                    osutils.local_time_offset(), submit_branch,
 
4953
                    public_branch=public_branch, patch_type=patch_type,
 
4954
                    message=message)
 
4955
 
 
4956
            if output is None:
 
4957
                directive.compose_merge_request(mail_client, mail_to, body,
 
4958
                                                branch, tree)
 
4959
            else:
 
4960
                if output == '-':
 
4961
                    outfile = self.outf
 
4962
                else:
 
4963
                    outfile = open(output, 'wb')
 
4964
                try:
 
4965
                    outfile.writelines(directive.to_lines())
 
4966
                finally:
 
4967
                    if outfile is not self.outf:
 
4968
                        outfile.close()
 
4969
        finally:
 
4970
            branch.unlock()
5219
4971
 
5220
4972
 
5221
4973
class cmd_bundle_revisions(cmd_send):
5222
 
    __doc__ = """Create a merge-directive for submitting changes.
 
4974
 
 
4975
    """Create a merge-directive for submitting changes.
5223
4976
 
5224
4977
    A merge directive provides many things needed for requesting merges:
5225
4978
 
5265
5018
               type=unicode),
5266
5019
        Option('output', short_name='o', help='Write directive to this file.',
5267
5020
               type=unicode),
5268
 
        Option('strict',
5269
 
               help='Refuse to bundle revisions if there are uncommitted'
5270
 
               ' changes in the working tree, --no-strict disables the check.'),
5271
5021
        'revision',
5272
 
        RegistryOption('format',
5273
 
                       help='Use the specified output format.',
5274
 
                       lazy_registry=('bzrlib.send', 'format_registry')),
 
5022
        RegistryOption.from_kwargs('format',
 
5023
        'Use the specified output format.',
 
5024
        **{'4': 'Bundle format 4, Merge Directive 2 (default)',
 
5025
           '0.9': 'Bundle format 0.9, Merge Directive 1',})
5275
5026
        ]
5276
5027
    aliases = ['bundle']
5277
5028
 
5281
5032
 
5282
5033
    def run(self, submit_branch=None, public_branch=None, no_bundle=False,
5283
5034
            no_patch=False, revision=None, remember=False, output=None,
5284
 
            format=None, strict=None, **kwargs):
 
5035
            format='4', **kwargs):
5285
5036
        if output is None:
5286
5037
            output = '-'
5287
 
        from bzrlib.send import send
5288
 
        return send(submit_branch, revision, public_branch, remember,
 
5038
        return self._run(submit_branch, revision, public_branch, remember,
5289
5039
                         format, no_bundle, no_patch, output,
5290
 
                         kwargs.get('from', '.'), None, None, None,
5291
 
                         self.outf, strict=strict)
 
5040
                         kwargs.get('from', '.'), None, None, None)
5292
5041
 
5293
5042
 
5294
5043
class cmd_tag(Command):
5295
 
    __doc__ = """Create, remove or modify a tag naming a revision.
 
5044
    """Create, remove or modify a tag naming a revision.
5296
5045
 
5297
5046
    Tags give human-meaningful names to revisions.  Commands that take a -r
5298
5047
    (--revision) option can be given -rtag:X, where X is any previously
5306
5055
 
5307
5056
    To rename a tag (change the name but keep it on the same revsion), run ``bzr
5308
5057
    tag new-name -r tag:old-name`` and then ``bzr tag --delete oldname``.
5309
 
 
5310
 
    If no tag name is specified it will be determined through the 
5311
 
    'automatic_tag_name' hook. This can e.g. be used to automatically tag
5312
 
    upstream releases by reading configure.ac. See ``bzr help hooks`` for
5313
 
    details.
5314
5058
    """
5315
5059
 
5316
5060
    _see_also = ['commit', 'tags']
5317
 
    takes_args = ['tag_name?']
 
5061
    takes_args = ['tag_name']
5318
5062
    takes_options = [
5319
5063
        Option('delete',
5320
5064
            help='Delete this tag rather than placing it.',
5321
5065
            ),
5322
 
        custom_help('directory',
5323
 
            help='Branch in which to place the tag.'),
 
5066
        Option('directory',
 
5067
            help='Branch in which to place the tag.',
 
5068
            short_name='d',
 
5069
            type=unicode,
 
5070
            ),
5324
5071
        Option('force',
5325
5072
            help='Replace existing tags.',
5326
5073
            ),
5327
5074
        'revision',
5328
5075
        ]
5329
5076
 
5330
 
    def run(self, tag_name=None,
 
5077
    def run(self, tag_name,
5331
5078
            delete=None,
5332
5079
            directory='.',
5333
5080
            force=None,
5334
5081
            revision=None,
5335
5082
            ):
5336
5083
        branch, relpath = Branch.open_containing(directory)
5337
 
        self.add_cleanup(branch.lock_write().unlock)
5338
 
        if delete:
5339
 
            if tag_name is None:
5340
 
                raise errors.BzrCommandError("No tag specified to delete.")
5341
 
            branch.tags.delete_tag(tag_name)
5342
 
            self.outf.write('Deleted tag %s.\n' % tag_name)
5343
 
        else:
5344
 
            if revision:
5345
 
                if len(revision) != 1:
5346
 
                    raise errors.BzrCommandError(
5347
 
                        "Tags can only be placed on a single revision, "
5348
 
                        "not on a range")
5349
 
                revision_id = revision[0].as_revision_id(branch)
 
5084
        branch.lock_write()
 
5085
        try:
 
5086
            if delete:
 
5087
                branch.tags.delete_tag(tag_name)
 
5088
                self.outf.write('Deleted tag %s.\n' % tag_name)
5350
5089
            else:
5351
 
                revision_id = branch.last_revision()
5352
 
            if tag_name is None:
5353
 
                tag_name = branch.automatic_tag_name(revision_id)
5354
 
                if tag_name is None:
5355
 
                    raise errors.BzrCommandError(
5356
 
                        "Please specify a tag name.")
5357
 
            if (not force) and branch.tags.has_tag(tag_name):
5358
 
                raise errors.TagAlreadyExists(tag_name)
5359
 
            branch.tags.set_tag(tag_name, revision_id)
5360
 
            self.outf.write('Created tag %s.\n' % tag_name)
 
5090
                if revision:
 
5091
                    if len(revision) != 1:
 
5092
                        raise errors.BzrCommandError(
 
5093
                            "Tags can only be placed on a single revision, "
 
5094
                            "not on a range")
 
5095
                    revision_id = revision[0].as_revision_id(branch)
 
5096
                else:
 
5097
                    revision_id = branch.last_revision()
 
5098
                if (not force) and branch.tags.has_tag(tag_name):
 
5099
                    raise errors.TagAlreadyExists(tag_name)
 
5100
                branch.tags.set_tag(tag_name, revision_id)
 
5101
                self.outf.write('Created tag %s.\n' % tag_name)
 
5102
        finally:
 
5103
            branch.unlock()
5361
5104
 
5362
5105
 
5363
5106
class cmd_tags(Command):
5364
 
    __doc__ = """List tags.
 
5107
    """List tags.
5365
5108
 
5366
5109
    This command shows a table of tag names and the revisions they reference.
5367
5110
    """
5368
5111
 
5369
5112
    _see_also = ['tag']
5370
5113
    takes_options = [
5371
 
        custom_help('directory',
5372
 
            help='Branch whose tags should be displayed.'),
 
5114
        Option('directory',
 
5115
            help='Branch whose tags should be displayed.',
 
5116
            short_name='d',
 
5117
            type=unicode,
 
5118
            ),
5373
5119
        RegistryOption.from_kwargs('sort',
5374
5120
            'Sort tags by different criteria.', title='Sorting',
5375
5121
            alpha='Sort tags lexicographically (default).',
5392
5138
        if not tags:
5393
5139
            return
5394
5140
 
5395
 
        self.add_cleanup(branch.lock_read().unlock)
5396
5141
        if revision:
5397
 
            graph = branch.repository.get_graph()
5398
 
            rev1, rev2 = _get_revision_range(revision, branch, self.name())
5399
 
            revid1, revid2 = rev1.rev_id, rev2.rev_id
5400
 
            # only show revisions between revid1 and revid2 (inclusive)
5401
 
            tags = [(tag, revid) for tag, revid in tags if
5402
 
                graph.is_between(revid, revid1, revid2)]
 
5142
            branch.lock_read()
 
5143
            try:
 
5144
                graph = branch.repository.get_graph()
 
5145
                rev1, rev2 = _get_revision_range(revision, branch, self.name())
 
5146
                revid1, revid2 = rev1.rev_id, rev2.rev_id
 
5147
                # only show revisions between revid1 and revid2 (inclusive)
 
5148
                tags = [(tag, revid) for tag, revid in tags if
 
5149
                    graph.is_between(revid, revid1, revid2)]
 
5150
            finally:
 
5151
                branch.unlock()
5403
5152
        if sort == 'alpha':
5404
5153
            tags.sort()
5405
5154
        elif sort == 'time':
5415
5164
            tags.sort(key=lambda x: timestamps[x[1]])
5416
5165
        if not show_ids:
5417
5166
            # [ (tag, revid), ... ] -> [ (tag, dotted_revno), ... ]
5418
 
            for index, (tag, revid) in enumerate(tags):
5419
 
                try:
5420
 
                    revno = branch.revision_id_to_dotted_revno(revid)
5421
 
                    if isinstance(revno, tuple):
5422
 
                        revno = '.'.join(map(str, revno))
5423
 
                except errors.NoSuchRevision:
5424
 
                    # Bad tag data/merges can lead to tagged revisions
5425
 
                    # which are not in this branch. Fail gracefully ...
5426
 
                    revno = '?'
5427
 
                tags[index] = (tag, revno)
5428
 
        self.cleanup_now()
 
5167
            revno_map = branch.get_revision_id_to_revno_map()
 
5168
            tags = [ (tag, '.'.join(map(str, revno_map.get(revid, ('?',)))))
 
5169
                        for tag, revid in tags ]
5429
5170
        for tag, revspec in tags:
5430
5171
            self.outf.write('%-20s %s\n' % (tag, revspec))
5431
5172
 
5432
5173
 
5433
5174
class cmd_reconfigure(Command):
5434
 
    __doc__ = """Reconfigure the type of a bzr directory.
 
5175
    """Reconfigure the type of a bzr directory.
5435
5176
 
5436
5177
    A target configuration must be specified.
5437
5178
 
5467
5208
            ),
5468
5209
        Option('bind-to', help='Branch to bind checkout to.', type=str),
5469
5210
        Option('force',
5470
 
            help='Perform reconfiguration even if local changes'
5471
 
            ' will be lost.'),
5472
 
        Option('stacked-on',
5473
 
            help='Reconfigure a branch to be stacked on another branch.',
5474
 
            type=unicode,
5475
 
            ),
5476
 
        Option('unstacked',
5477
 
            help='Reconfigure a branch to be unstacked.  This '
5478
 
                'may require copying substantial data into it.',
5479
 
            ),
 
5211
               help='Perform reconfiguration even if local changes'
 
5212
               ' will be lost.')
5480
5213
        ]
5481
5214
 
5482
 
    def run(self, location=None, target_type=None, bind_to=None, force=False,
5483
 
            stacked_on=None,
5484
 
            unstacked=None):
 
5215
    def run(self, location=None, target_type=None, bind_to=None, force=False):
5485
5216
        directory = bzrdir.BzrDir.open(location)
5486
 
        if stacked_on and unstacked:
5487
 
            raise BzrCommandError("Can't use both --stacked-on and --unstacked")
5488
 
        elif stacked_on is not None:
5489
 
            reconfigure.ReconfigureStackedOn().apply(directory, stacked_on)
5490
 
        elif unstacked:
5491
 
            reconfigure.ReconfigureUnstacked().apply(directory)
5492
 
        # At the moment you can use --stacked-on and a different
5493
 
        # reconfiguration shape at the same time; there seems no good reason
5494
 
        # to ban it.
5495
5217
        if target_type is None:
5496
 
            if stacked_on or unstacked:
5497
 
                return
5498
 
            else:
5499
 
                raise errors.BzrCommandError('No target configuration '
5500
 
                    'specified')
 
5218
            raise errors.BzrCommandError('No target configuration specified')
5501
5219
        elif target_type == 'branch':
5502
5220
            reconfiguration = reconfigure.Reconfigure.to_branch(directory)
5503
5221
        elif target_type == 'tree':
5522
5240
 
5523
5241
 
5524
5242
class cmd_switch(Command):
5525
 
    __doc__ = """Set the branch of a checkout and update.
 
5243
    """Set the branch of a checkout and update.
5526
5244
 
5527
5245
    For lightweight checkouts, this changes the branch being referenced.
5528
5246
    For heavyweight checkouts, this checks that there are no local commits
5540
5258
    /path/to/newbranch.
5541
5259
 
5542
5260
    Bound branches use the nickname of its master branch unless it is set
5543
 
    locally, in which case switching will update the local nickname to be
 
5261
    locally, in which case switching will update the the local nickname to be
5544
5262
    that of the master.
5545
5263
    """
5546
5264
 
5547
 
    takes_args = ['to_location?']
5548
 
    takes_options = ['directory',
5549
 
                     Option('force',
5550
 
                        help='Switch even if local commits will be lost.'),
5551
 
                     'revision',
5552
 
                     Option('create-branch', short_name='b',
5553
 
                        help='Create the target branch from this one before'
5554
 
                             ' switching to it.'),
5555
 
                    ]
 
5265
    takes_args = ['to_location']
 
5266
    takes_options = [Option('force',
 
5267
                        help='Switch even if local commits will be lost.')
 
5268
                     ]
5556
5269
 
5557
 
    def run(self, to_location=None, force=False, create_branch=False,
5558
 
            revision=None, directory=u'.'):
 
5270
    def run(self, to_location, force=False):
5559
5271
        from bzrlib import switch
5560
 
        tree_location = directory
5561
 
        revision = _get_one_revision('switch', revision)
 
5272
        tree_location = '.'
5562
5273
        control_dir = bzrdir.BzrDir.open_containing(tree_location)[0]
5563
 
        if to_location is None:
5564
 
            if revision is None:
5565
 
                raise errors.BzrCommandError('You must supply either a'
5566
 
                                             ' revision or a location')
5567
 
            to_location = tree_location
 
5274
        branch = control_dir.open_branch()
5568
5275
        try:
5569
 
            branch = control_dir.open_branch()
5570
 
            had_explicit_nick = branch.get_config().has_explicit_nickname()
 
5276
            to_branch = Branch.open(to_location)
5571
5277
        except errors.NotBranchError:
5572
 
            branch = None
5573
 
            had_explicit_nick = False
5574
 
        if create_branch:
5575
 
            if branch is None:
5576
 
                raise errors.BzrCommandError('cannot create branch without'
5577
 
                                             ' source branch')
5578
 
            to_location = directory_service.directories.dereference(
5579
 
                              to_location)
5580
 
            if '/' not in to_location and '\\' not in to_location:
5581
 
                # This path is meant to be relative to the existing branch
5582
 
                this_url = self._get_branch_location(control_dir)
5583
 
                to_location = urlutils.join(this_url, '..', to_location)
5584
 
            to_branch = branch.bzrdir.sprout(to_location,
5585
 
                                 possible_transports=[branch.bzrdir.root_transport],
5586
 
                                 source_branch=branch).open_branch()
5587
 
        else:
5588
 
            try:
5589
 
                to_branch = Branch.open(to_location)
5590
 
            except errors.NotBranchError:
5591
 
                this_url = self._get_branch_location(control_dir)
5592
 
                to_branch = Branch.open(
5593
 
                    urlutils.join(this_url, '..', to_location))
5594
 
        if revision is not None:
5595
 
            revision = revision.as_revision_id(to_branch)
5596
 
        switch.switch(control_dir, to_branch, force, revision_id=revision)
5597
 
        if had_explicit_nick:
 
5278
            this_branch = control_dir.open_branch()
 
5279
            # This may be a heavy checkout, where we want the master branch
 
5280
            this_url = this_branch.get_bound_location()
 
5281
            # If not, use a local sibling
 
5282
            if this_url is None:
 
5283
                this_url = this_branch.base
 
5284
            to_branch = Branch.open(
 
5285
                urlutils.join(this_url, '..', to_location))
 
5286
        switch.switch(control_dir, to_branch, force)
 
5287
        if branch.get_config().has_explicit_nickname():
5598
5288
            branch = control_dir.open_branch() #get the new branch!
5599
5289
            branch.nick = to_branch.nick
5600
5290
        note('Switched to branch: %s',
5601
5291
            urlutils.unescape_for_display(to_branch.base, 'utf-8'))
5602
5292
 
5603
 
    def _get_branch_location(self, control_dir):
5604
 
        """Return location of branch for this control dir."""
5605
 
        try:
5606
 
            this_branch = control_dir.open_branch()
5607
 
            # This may be a heavy checkout, where we want the master branch
5608
 
            master_location = this_branch.get_bound_location()
5609
 
            if master_location is not None:
5610
 
                return master_location
5611
 
            # If not, use a local sibling
5612
 
            return this_branch.base
5613
 
        except errors.NotBranchError:
5614
 
            format = control_dir.find_branch_format()
5615
 
            if getattr(format, 'get_reference', None) is not None:
5616
 
                return format.get_reference(control_dir)
5617
 
            else:
5618
 
                return control_dir.root_transport.base
5619
 
 
5620
5293
 
5621
5294
class cmd_view(Command):
5622
 
    __doc__ = """Manage filtered views.
 
5295
    """Manage filtered views.
5623
5296
 
5624
5297
    Views provide a mask over the tree so that users can focus on
5625
5298
    a subset of a tree when doing their work. After creating a view,
5773
5446
 
5774
5447
 
5775
5448
class cmd_hooks(Command):
5776
 
    __doc__ = """Show hooks."""
 
5449
    """Show hooks."""
5777
5450
 
5778
5451
    hidden = True
5779
5452
 
5792
5465
                    self.outf.write("    <no hooks installed>\n")
5793
5466
 
5794
5467
 
5795
 
class cmd_remove_branch(Command):
5796
 
    __doc__ = """Remove a branch.
5797
 
 
5798
 
    This will remove the branch from the specified location but 
5799
 
    will keep any working tree or repository in place.
5800
 
 
5801
 
    :Examples:
5802
 
 
5803
 
      Remove the branch at repo/trunk::
5804
 
 
5805
 
        bzr remove-branch repo/trunk
5806
 
 
5807
 
    """
5808
 
 
5809
 
    takes_args = ["location?"]
5810
 
 
5811
 
    aliases = ["rmbranch"]
5812
 
 
5813
 
    def run(self, location=None):
5814
 
        if location is None:
5815
 
            location = "."
5816
 
        branch = Branch.open_containing(location)[0]
5817
 
        branch.bzrdir.destroy_branch()
5818
 
        
5819
 
 
5820
5468
class cmd_shelve(Command):
5821
 
    __doc__ = """Temporarily set aside some changes from the current tree.
 
5469
    """Temporarily set aside some changes from the current tree.
5822
5470
 
5823
5471
    Shelve allows you to temporarily put changes you've made "on the shelf",
5824
5472
    ie. out of the way, until a later time when you can bring them back from
5845
5493
    takes_args = ['file*']
5846
5494
 
5847
5495
    takes_options = [
5848
 
        'directory',
5849
5496
        'revision',
5850
5497
        Option('all', help='Shelve all changes.'),
5851
5498
        'message',
5860
5507
    _see_also = ['unshelve']
5861
5508
 
5862
5509
    def run(self, revision=None, all=False, file_list=None, message=None,
5863
 
            writer=None, list=False, destroy=False, directory=u'.'):
 
5510
            writer=None, list=False, destroy=False):
5864
5511
        if list:
5865
5512
            return self.run_for_list()
5866
5513
        from bzrlib.shelf_ui import Shelver
5867
5514
        if writer is None:
5868
5515
            writer = bzrlib.option.diff_writer_registry.get()
5869
5516
        try:
5870
 
            shelver = Shelver.from_args(writer(sys.stdout), revision, all,
5871
 
                file_list, message, destroy=destroy, directory=directory)
5872
 
            try:
5873
 
                shelver.run()
5874
 
            finally:
5875
 
                shelver.finalize()
 
5517
            Shelver.from_args(writer(sys.stdout), revision, all, file_list,
 
5518
                              message, destroy=destroy).run()
5876
5519
        except errors.UserAbort:
5877
5520
            return 0
5878
5521
 
5879
5522
    def run_for_list(self):
5880
5523
        tree = WorkingTree.open_containing('.')[0]
5881
 
        self.add_cleanup(tree.lock_read().unlock)
5882
 
        manager = tree.get_shelf_manager()
5883
 
        shelves = manager.active_shelves()
5884
 
        if len(shelves) == 0:
5885
 
            note('No shelved changes.')
5886
 
            return 0
5887
 
        for shelf_id in reversed(shelves):
5888
 
            message = manager.get_metadata(shelf_id).get('message')
5889
 
            if message is None:
5890
 
                message = '<no message>'
5891
 
            self.outf.write('%3d: %s\n' % (shelf_id, message))
5892
 
        return 1
 
5524
        tree.lock_read()
 
5525
        try:
 
5526
            manager = tree.get_shelf_manager()
 
5527
            shelves = manager.active_shelves()
 
5528
            if len(shelves) == 0:
 
5529
                note('No shelved changes.')
 
5530
                return 0
 
5531
            for shelf_id in reversed(shelves):
 
5532
                message = manager.get_metadata(shelf_id).get('message')
 
5533
                if message is None:
 
5534
                    message = '<no message>'
 
5535
                self.outf.write('%3d: %s\n' % (shelf_id, message))
 
5536
            return 1
 
5537
        finally:
 
5538
            tree.unlock()
5893
5539
 
5894
5540
 
5895
5541
class cmd_unshelve(Command):
5896
 
    __doc__ = """Restore shelved changes.
 
5542
    """Restore shelved changes.
5897
5543
 
5898
5544
    By default, the most recently shelved changes are restored. However if you
5899
5545
    specify a shelf by id those changes will be restored instead.  This works
5902
5548
 
5903
5549
    takes_args = ['shelf_id?']
5904
5550
    takes_options = [
5905
 
        'directory',
5906
5551
        RegistryOption.from_kwargs(
5907
5552
            'action', help="The action to perform.",
5908
5553
            enum_switch=False, value_switches=True,
5909
5554
            apply="Apply changes and remove from the shelf.",
5910
5555
            dry_run="Show changes, but do not apply or remove them.",
5911
 
            preview="Instead of unshelving the changes, show the diff that "
5912
 
                    "would result from unshelving.",
5913
 
            delete_only="Delete changes without applying them.",
5914
 
            keep="Apply changes but don't delete them.",
 
5556
            delete_only="Delete changes without applying them."
5915
5557
        )
5916
5558
    ]
5917
5559
    _see_also = ['shelve']
5918
5560
 
5919
 
    def run(self, shelf_id=None, action='apply', directory=u'.'):
 
5561
    def run(self, shelf_id=None, action='apply'):
5920
5562
        from bzrlib.shelf_ui import Unshelver
5921
 
        unshelver = Unshelver.from_args(shelf_id, action, directory=directory)
5922
 
        try:
5923
 
            unshelver.run()
5924
 
        finally:
5925
 
            unshelver.tree.unlock()
 
5563
        Unshelver.from_args(shelf_id, action).run()
5926
5564
 
5927
5565
 
5928
5566
class cmd_clean_tree(Command):
5929
 
    __doc__ = """Remove unwanted files from working tree.
 
5567
    """Remove unwanted files from working tree.
5930
5568
 
5931
5569
    By default, only unknown files, not ignored files, are deleted.  Versioned
5932
5570
    files are never deleted.
5940
5578
 
5941
5579
    To check what clean-tree will do, use --dry-run.
5942
5580
    """
5943
 
    takes_options = ['directory',
5944
 
                     Option('ignored', help='Delete all ignored files.'),
 
5581
    takes_options = [Option('ignored', help='Delete all ignored files.'),
5945
5582
                     Option('detritus', help='Delete conflict files, merge'
5946
5583
                            ' backups, and failed selftest dirs.'),
5947
5584
                     Option('unknown',
5950
5587
                            ' deleting them.'),
5951
5588
                     Option('force', help='Do not prompt before deleting.')]
5952
5589
    def run(self, unknown=False, ignored=False, detritus=False, dry_run=False,
5953
 
            force=False, directory=u'.'):
 
5590
            force=False):
5954
5591
        from bzrlib.clean_tree import clean_tree
5955
5592
        if not (unknown or ignored or detritus):
5956
5593
            unknown = True
5957
5594
        if dry_run:
5958
5595
            force = True
5959
 
        clean_tree(directory, unknown=unknown, ignored=ignored,
5960
 
                   detritus=detritus, dry_run=dry_run, no_prompt=force)
 
5596
        clean_tree('.', unknown=unknown, ignored=ignored, detritus=detritus,
 
5597
                   dry_run=dry_run, no_prompt=force)
5961
5598
 
5962
5599
 
5963
5600
class cmd_reference(Command):
5964
 
    __doc__ = """list, view and set branch locations for nested trees.
 
5601
    """list, view and set branch locations for nested trees.
5965
5602
 
5966
5603
    If no arguments are provided, lists the branch locations for nested trees.
5967
5604
    If one argument is provided, display the branch location for that tree.
6007
5644
            self.outf.write('%s %s\n' % (path, location))
6008
5645
 
6009
5646
 
6010
 
def _register_lazy_builtins():
6011
 
    # register lazy builtins from other modules; called at startup and should
6012
 
    # be only called once.
6013
 
    for (name, aliases, module_name) in [
6014
 
        ('cmd_bundle_info', [], 'bzrlib.bundle.commands'),
6015
 
        ('cmd_dpush', [], 'bzrlib.foreign'),
6016
 
        ('cmd_version_info', [], 'bzrlib.cmd_version_info'),
6017
 
        ('cmd_resolve', ['resolved'], 'bzrlib.conflicts'),
6018
 
        ('cmd_conflicts', [], 'bzrlib.conflicts'),
6019
 
        ('cmd_sign_my_commits', [], 'bzrlib.sign_my_commits'),
6020
 
        ]:
6021
 
        builtin_command_registry.register_lazy(name, aliases, module_name)
 
5647
# these get imported and then picked up by the scan for cmd_*
 
5648
# TODO: Some more consistent way to split command definitions across files;
 
5649
# we do need to load at least some information about them to know of
 
5650
# aliases.  ideally we would avoid loading the implementation until the
 
5651
# details were needed.
 
5652
from bzrlib.cmd_version_info import cmd_version_info
 
5653
from bzrlib.conflicts import cmd_resolve, cmd_conflicts, restore
 
5654
from bzrlib.bundle.commands import (
 
5655
    cmd_bundle_info,
 
5656
    )
 
5657
from bzrlib.foreign import cmd_dpush
 
5658
from bzrlib.sign_my_commits import cmd_sign_my_commits
 
5659
from bzrlib.weave_commands import cmd_versionedfile_list, \
 
5660
        cmd_weave_plan_merge, cmd_weave_merge_text