← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/builtins.py

Merge up through 2.2.0.

Show diffs side-by-side

added added

removed removed

Lines of Context:
bzrlib/builtins.py
1
 
# Copyright (C) 2004, 2005, 2006, 2007, 2008, 2009 Canonical Ltd
 
1
# Copyright (C) 2005-2010 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,
34
35
    delta,
35
36
    config,
36
37
    errors,
43
44
    reconfigure,
44
45
    rename_map,
45
46
    revision as _mod_revision,
 
47
    static_tuple,
46
48
    symbol_versioning,
 
49
    timestamp,
47
50
    transport,
48
51
    ui,
49
52
    urlutils,
51
54
    )
52
55
from bzrlib.branch import Branch
53
56
from bzrlib.conflicts import ConflictList
 
57
from bzrlib.transport import memory
54
58
from bzrlib.revisionspec import RevisionSpec, RevisionInfo
55
59
from bzrlib.smtp_connection import SMTPConnection
56
60
from bzrlib.workingtree import WorkingTree
57
61
""")
58
62
 
59
 
from bzrlib.commands import Command, display_command
 
63
from bzrlib.commands import (
 
64
    Command,
 
65
    builtin_command_registry,
 
66
    display_command,
 
67
    )
60
68
from bzrlib.option import (
61
69
    ListOption,
62
70
    Option,
172
180
                view_str = views.view_display_str(view_files)
173
181
                note("Ignoring files outside view. View is %s" % view_str)
174
182
        return tree, file_list
175
 
    tree = WorkingTree.open_containing(osutils.realpath(file_list[0]))[0]
 
183
    tree = WorkingTree.open_containing(file_list[0])[0]
176
184
    return tree, safe_relpath_files(tree, file_list, canonicalize,
177
185
        apply_view=apply_view)
178
186
 
224
232
    return view_info
225
233
 
226
234
 
 
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
 
227
243
# TODO: Make sure no commands unconditionally use the working directory as a
228
244
# branch.  If a filename argument is used, the first of them should be used to
229
245
# specify the branch.  (Perhaps this can be factored out into some kind of
231
247
# opens the branch?)
232
248
 
233
249
class cmd_status(Command):
234
 
    """Display status summary.
 
250
    __doc__ = """Display status summary.
235
251
 
236
252
    This reports on versioned and unknown files, reporting them
237
253
    grouped by state.  Possible states are:
257
273
    unknown
258
274
        Not versioned and not matching an ignore pattern.
259
275
 
 
276
    Additionally for directories, symlinks and files with an executable
 
277
    bit, Bazaar indicates their type using a trailing character: '/', '@'
 
278
    or '*' respectively.
 
279
 
260
280
    To see ignored files use 'bzr ignored'.  For details on the
261
281
    changes to file texts, use 'bzr diff'.
262
282
 
320
340
 
321
341
 
322
342
class cmd_cat_revision(Command):
323
 
    """Write out metadata for a revision.
 
343
    __doc__ = """Write out metadata for a revision.
324
344
 
325
345
    The revision to print can either be specified by a specific
326
346
    revision identifier, or you can use --revision.
328
348
 
329
349
    hidden = True
330
350
    takes_args = ['revision_id?']
331
 
    takes_options = ['revision']
 
351
    takes_options = ['directory', 'revision']
332
352
    # cat-revision is more for frontends so should be exact
333
353
    encoding = 'strict'
334
354
 
 
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
 
335
363
    @display_command
336
 
    def run(self, revision_id=None, revision=None):
 
364
    def run(self, revision_id=None, revision=None, directory=u'.'):
337
365
        if revision_id is not None and revision is not None:
338
366
            raise errors.BzrCommandError('You can only supply one of'
339
367
                                         ' revision_id or --revision')
340
368
        if revision_id is None and revision is None:
341
369
            raise errors.BzrCommandError('You must supply either'
342
370
                                         ' --revision or a revision_id')
343
 
        b = WorkingTree.open_containing(u'.')[0].branch
344
 
 
345
 
        # TODO: jam 20060112 should cat-revision always output utf-8?
346
 
        if revision_id is not None:
347
 
            revision_id = osutils.safe_revision_id(revision_id, warn=False)
348
 
            try:
349
 
                self.outf.write(b.repository.get_revision_xml(revision_id).decode('utf-8'))
350
 
            except errors.NoSuchRevision:
351
 
                msg = "The repository %s contains no revision %s." % (b.repository.base,
352
 
                    revision_id)
353
 
                raise errors.BzrCommandError(msg)
354
 
        elif revision is not None:
355
 
            for rev in revision:
356
 
                if rev is None:
357
 
                    raise errors.BzrCommandError('You cannot specify a NULL'
358
 
                                                 ' revision.')
359
 
                rev_id = rev.as_revision_id(b)
360
 
                self.outf.write(b.repository.get_revision_xml(rev_id).decode('utf-8'))
361
 
 
 
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
        
362
399
 
363
400
class cmd_dump_btree(Command):
364
 
    """Dump the contents of a btree index file to stdout.
 
401
    __doc__ = """Dump the contents of a btree index file to stdout.
365
402
 
366
403
    PATH is a btree index file, it can be any URL. This includes things like
367
404
    .bzr/repository/pack-names, or .bzr/repository/indices/a34b3a...ca4a4.iix
431
468
        for node in bt.iter_all_entries():
432
469
            # Node is made up of:
433
470
            # (index, key, value, [references])
434
 
            self.outf.write('%s\n' % (node[1:],))
 
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,))
435
479
 
436
480
 
437
481
class cmd_remove_tree(Command):
438
 
    """Remove the working tree from a given branch/checkout.
 
482
    __doc__ = """Remove the working tree from a given branch/checkout.
439
483
 
440
484
    Since a lightweight checkout is little more than a working tree
441
485
    this will refuse to run against one.
443
487
    To re-create the working tree, use "bzr checkout".
444
488
    """
445
489
    _see_also = ['checkout', 'working-trees']
446
 
    takes_args = ['location?']
 
490
    takes_args = ['location*']
447
491
    takes_options = [
448
492
        Option('force',
449
493
               help='Remove the working tree even if it has '
450
 
                    'uncommitted changes.'),
 
494
                    'uncommitted or shelved changes.'),
451
495
        ]
452
496
 
453
 
    def run(self, location='.', force=False):
454
 
        d = bzrdir.BzrDir.open(location)
455
 
 
456
 
        try:
457
 
            working = d.open_workingtree()
458
 
        except errors.NoWorkingTree:
459
 
            raise errors.BzrCommandError("No working tree to remove")
460
 
        except errors.NotLocalUrl:
461
 
            raise errors.BzrCommandError("You cannot remove the working tree"
462
 
                                         " of a remote path")
463
 
        if not force:
464
 
            # XXX: What about pending merges ? -- vila 20090629
465
 
            if working.has_changes(working.basis_tree()):
466
 
                raise errors.UncommittedChanges(working)
467
 
 
468
 
        working_path = working.bzrdir.root_transport.base
469
 
        branch_path = working.branch.bzrdir.root_transport.base
470
 
        if working_path != branch_path:
471
 
            raise errors.BzrCommandError("You cannot remove the working tree"
472
 
                                         " from a lightweight checkout")
473
 
 
474
 
        d.destroy_workingtree()
 
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()
475
522
 
476
523
 
477
524
class cmd_revno(Command):
478
 
    """Show current revision number.
 
525
    __doc__ = """Show current revision number.
479
526
 
480
527
    This is equal to the number of revisions on this branch.
481
528
    """
491
538
        if tree:
492
539
            try:
493
540
                wt = WorkingTree.open_containing(location)[0]
494
 
                wt.lock_read()
 
541
                self.add_cleanup(wt.lock_read().unlock)
495
542
            except (errors.NoWorkingTree, errors.NotLocalUrl):
496
543
                raise errors.NoWorkingTree(location)
 
544
            revid = wt.last_revision()
497
545
            try:
498
 
                revid = wt.last_revision()
499
 
                try:
500
 
                    revno_t = wt.branch.revision_id_to_dotted_revno(revid)
501
 
                except errors.NoSuchRevision:
502
 
                    revno_t = ('???',)
503
 
                revno = ".".join(str(n) for n in revno_t)
504
 
            finally:
505
 
                wt.unlock()
 
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)
506
550
        else:
507
551
            b = Branch.open_containing(location)[0]
508
 
            b.lock_read()
509
 
            try:
510
 
                revno = b.revno()
511
 
            finally:
512
 
                b.unlock()
513
 
 
 
552
            self.add_cleanup(b.lock_read().unlock)
 
553
            revno = b.revno()
 
554
        self.cleanup_now()
514
555
        self.outf.write(str(revno) + '\n')
515
556
 
516
557
 
517
558
class cmd_revision_info(Command):
518
 
    """Show revision number and revision id for a given revision identifier.
 
559
    __doc__ = """Show revision number and revision id for a given revision identifier.
519
560
    """
520
561
    hidden = True
521
562
    takes_args = ['revision_info*']
522
563
    takes_options = [
523
564
        'revision',
524
 
        Option('directory',
 
565
        custom_help('directory',
525
566
            help='Branch to examine, '
526
 
                 'rather than the one containing the working directory.',
527
 
            short_name='d',
528
 
            type=unicode,
529
 
            ),
 
567
                 'rather than the one containing the working directory.'),
530
568
        Option('tree', help='Show revno of working tree'),
531
569
        ]
532
570
 
537
575
        try:
538
576
            wt = WorkingTree.open_containing(directory)[0]
539
577
            b = wt.branch
540
 
            wt.lock_read()
 
578
            self.add_cleanup(wt.lock_read().unlock)
541
579
        except (errors.NoWorkingTree, errors.NotLocalUrl):
542
580
            wt = None
543
581
            b = Branch.open_containing(directory)[0]
544
 
            b.lock_read()
545
 
        try:
546
 
            revision_ids = []
547
 
            if revision is not None:
548
 
                revision_ids.extend(rev.as_revision_id(b) for rev in revision)
549
 
            if revision_info_list is not None:
550
 
                for rev_str in revision_info_list:
551
 
                    rev_spec = RevisionSpec.from_string(rev_str)
552
 
                    revision_ids.append(rev_spec.as_revision_id(b))
553
 
            # No arguments supplied, default to the last revision
554
 
            if len(revision_ids) == 0:
555
 
                if tree:
556
 
                    if wt is None:
557
 
                        raise errors.NoWorkingTree(directory)
558
 
                    revision_ids.append(wt.last_revision())
559
 
                else:
560
 
                    revision_ids.append(b.last_revision())
561
 
 
562
 
            revinfos = []
563
 
            maxlen = 0
564
 
            for revision_id in revision_ids:
565
 
                try:
566
 
                    dotted_revno = b.revision_id_to_dotted_revno(revision_id)
567
 
                    revno = '.'.join(str(i) for i in dotted_revno)
568
 
                except errors.NoSuchRevision:
569
 
                    revno = '???'
570
 
                maxlen = max(maxlen, len(revno))
571
 
                revinfos.append([revno, revision_id])
572
 
        finally:
573
 
            if wt is None:
574
 
                b.unlock()
 
582
            self.add_cleanup(b.lock_read().unlock)
 
583
        revision_ids = []
 
584
        if revision is not None:
 
585
            revision_ids.extend(rev.as_revision_id(b) for rev in revision)
 
586
        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())
575
596
            else:
576
 
                wt.unlock()
577
 
 
 
597
                revision_ids.append(b.last_revision())
 
598
 
 
599
        revinfos = []
 
600
        maxlen = 0
 
601
        for revision_id in revision_ids:
 
602
            try:
 
603
                dotted_revno = b.revision_id_to_dotted_revno(revision_id)
 
604
                revno = '.'.join(str(i) for i in dotted_revno)
 
605
            except errors.NoSuchRevision:
 
606
                revno = '???'
 
607
            maxlen = max(maxlen, len(revno))
 
608
            revinfos.append([revno, revision_id])
 
609
 
 
610
        self.cleanup_now()
578
611
        for ri in revinfos:
579
612
            self.outf.write('%*s %s\n' % (maxlen, ri[0], ri[1]))
580
613
 
581
614
 
582
615
class cmd_add(Command):
583
 
    """Add specified files or directories.
 
616
    __doc__ = """Add specified files or directories.
584
617
 
585
618
    In non-recursive mode, all the named items are added, regardless
586
619
    of whether they were previously ignored.  A warning is given if
651
684
                should_print=(not is_quiet()))
652
685
 
653
686
        if base_tree:
654
 
            base_tree.lock_read()
655
 
        try:
656
 
            file_list = self._maybe_expand_globs(file_list)
657
 
            tree, file_list = tree_files_for_add(file_list)
658
 
            added, ignored = tree.smart_add(file_list, not
659
 
                no_recurse, action=action, save=not dry_run)
660
 
        finally:
661
 
            if base_tree is not None:
662
 
                base_tree.unlock()
 
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()
663
692
        if len(ignored) > 0:
664
693
            if verbose:
665
694
                for glob in sorted(ignored.keys()):
669
698
 
670
699
 
671
700
class cmd_mkdir(Command):
672
 
    """Create a new versioned directory.
 
701
    __doc__ = """Create a new versioned directory.
673
702
 
674
703
    This is equivalent to creating the directory and then adding it.
675
704
    """
679
708
 
680
709
    def run(self, dir_list):
681
710
        for d in dir_list:
682
 
            os.mkdir(d)
683
711
            wt, dd = WorkingTree.open_containing(d)
684
 
            wt.add([dd])
685
 
            self.outf.write('added %s\n' % 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)
686
720
 
687
721
 
688
722
class cmd_relpath(Command):
689
 
    """Show path of a file relative to root"""
 
723
    __doc__ = """Show path of a file relative to root"""
690
724
 
691
725
    takes_args = ['filename']
692
726
    hidden = True
701
735
 
702
736
 
703
737
class cmd_inventory(Command):
704
 
    """Show inventory of the current working copy or a revision.
 
738
    __doc__ = """Show inventory of the current working copy or a revision.
705
739
 
706
740
    It is possible to limit the output to a particular entry
707
741
    type using the --kind option.  For example: --kind file.
728
762
 
729
763
        revision = _get_one_revision('inventory', revision)
730
764
        work_tree, file_list = tree_files(file_list)
731
 
        work_tree.lock_read()
732
 
        try:
733
 
            if revision is not None:
734
 
                tree = revision.as_tree(work_tree.branch)
735
 
 
736
 
                extra_trees = [work_tree]
737
 
                tree.lock_read()
738
 
            else:
739
 
                tree = work_tree
740
 
                extra_trees = []
741
 
 
742
 
            if file_list is not None:
743
 
                file_ids = tree.paths2ids(file_list, trees=extra_trees,
744
 
                                          require_versioned=True)
745
 
                # find_ids_across_trees may include some paths that don't
746
 
                # exist in 'tree'.
747
 
                entries = sorted((tree.id2path(file_id), tree.inventory[file_id])
748
 
                                 for file_id in file_ids if file_id in tree)
749
 
            else:
750
 
                entries = tree.inventory.entries()
751
 
        finally:
752
 
            tree.unlock()
753
 
            if tree is not work_tree:
754
 
                work_tree.unlock()
755
 
 
 
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()
756
786
        for path, entry in entries:
757
787
            if kind and kind != entry.kind:
758
788
                continue
764
794
 
765
795
 
766
796
class cmd_mv(Command):
767
 
    """Move or rename a file.
 
797
    __doc__ = """Move or rename a file.
768
798
 
769
799
    :Usage:
770
800
        bzr mv OLDNAME NEWNAME
803
833
        if len(names_list) < 2:
804
834
            raise errors.BzrCommandError("missing file argument")
805
835
        tree, rel_names = tree_files(names_list, canonicalize=False)
806
 
        tree.lock_tree_write()
807
 
        try:
808
 
            self._run(tree, names_list, rel_names, after)
809
 
        finally:
810
 
            tree.unlock()
 
836
        self.add_cleanup(tree.lock_tree_write().unlock)
 
837
        self._run(tree, names_list, rel_names, after)
811
838
 
812
839
    def run_auto(self, names_list, after, dry_run):
813
840
        if names_list is not None and len(names_list) > 1:
817
844
            raise errors.BzrCommandError('--after cannot be specified with'
818
845
                                         ' --auto.')
819
846
        work_tree, file_list = tree_files(names_list, default_branch='.')
820
 
        work_tree.lock_tree_write()
821
 
        try:
822
 
            rename_map.RenameMap.guess_renames(work_tree, dry_run)
823
 
        finally:
824
 
            work_tree.unlock()
 
847
        self.add_cleanup(work_tree.lock_tree_write().unlock)
 
848
        rename_map.RenameMap.guess_renames(work_tree, dry_run)
825
849
 
826
850
    def _run(self, tree, names_list, rel_names, after):
827
851
        into_existing = osutils.isdir(names_list[-1])
848
872
            # All entries reference existing inventory items, so fix them up
849
873
            # for cicp file-systems.
850
874
            rel_names = tree.get_canonical_inventory_paths(rel_names)
851
 
            for pair in tree.move(rel_names[:-1], rel_names[-1], after=after):
852
 
                self.outf.write("%s => %s\n" % pair)
 
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))
853
878
        else:
854
879
            if len(names_list) != 2:
855
880
                raise errors.BzrCommandError('to mv multiple files the'
899
924
            dest = osutils.pathjoin(dest_parent, dest_tail)
900
925
            mutter("attempting to move %s => %s", src, dest)
901
926
            tree.rename_one(src, dest, after=after)
902
 
            self.outf.write("%s => %s\n" % (src, dest))
 
927
            if not is_quiet():
 
928
                self.outf.write("%s => %s\n" % (src, dest))
903
929
 
904
930
 
905
931
class cmd_pull(Command):
906
 
    """Turn this branch into a mirror of another branch.
 
932
    __doc__ = """Turn this branch into a mirror of another branch.
907
933
 
908
 
    This command only works on branches that have not diverged.  Branches are
909
 
    considered diverged if the destination branch's most recent commit is one
910
 
    that has not been merged (directly or indirectly) into the parent.
 
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.
911
938
 
912
939
    If branches have diverged, you can use 'bzr merge' to integrate the changes
913
940
    from one into the other.  Once one branch has merged, the other should
914
941
    be able to pull it again.
915
942
 
916
 
    If you want to forget your local changes and just update your branch to
917
 
    match the remote one, use pull --overwrite.
 
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.
918
946
 
919
947
    If there is no default location set, the first pull will set it.  After
920
948
    that, you can omit the location to use the default.  To change the
930
958
    takes_options = ['remember', 'overwrite', 'revision',
931
959
        custom_help('verbose',
932
960
            help='Show logs of pulled revisions.'),
933
 
        Option('directory',
 
961
        custom_help('directory',
934
962
            help='Branch to pull into, '
935
 
                 'rather than the one containing the working directory.',
936
 
            short_name='d',
937
 
            type=unicode,
938
 
            ),
 
963
                 'rather than the one containing the working directory.'),
939
964
        Option('local',
940
965
            help="Perform a local pull in a bound "
941
966
                 "branch.  Local pulls are not applied to "
956
981
        try:
957
982
            tree_to = WorkingTree.open_containing(directory)[0]
958
983
            branch_to = tree_to.branch
 
984
            self.add_cleanup(tree_to.lock_write().unlock)
959
985
        except errors.NoWorkingTree:
960
986
            tree_to = None
961
987
            branch_to = Branch.open_containing(directory)[0]
962
 
        
 
988
            self.add_cleanup(branch_to.lock_write().unlock)
 
989
 
963
990
        if local and not branch_to.get_bound_location():
964
991
            raise errors.LocalRequiresBoundBranch()
965
992
 
995
1022
        else:
996
1023
            branch_from = Branch.open(location,
997
1024
                possible_transports=possible_transports)
 
1025
            self.add_cleanup(branch_from.lock_read().unlock)
998
1026
 
999
1027
            if branch_to.get_parent() is None or remember:
1000
1028
                branch_to.set_parent(branch_from.base)
1001
1029
 
1002
 
        if branch_from is not branch_to:
1003
 
            branch_from.lock_read()
1004
 
        try:
1005
 
            if revision is not None:
1006
 
                revision_id = revision.as_revision_id(branch_from)
1007
 
 
1008
 
            branch_to.lock_write()
1009
 
            try:
1010
 
                if tree_to is not None:
1011
 
                    view_info = _get_view_info_for_change_reporter(tree_to)
1012
 
                    change_reporter = delta._ChangeReporter(
1013
 
                        unversioned_filter=tree_to.is_ignored,
1014
 
                        view_info=view_info)
1015
 
                    result = tree_to.pull(
1016
 
                        branch_from, overwrite, revision_id, change_reporter,
1017
 
                        possible_transports=possible_transports, local=local)
1018
 
                else:
1019
 
                    result = branch_to.pull(
1020
 
                        branch_from, overwrite, revision_id, local=local)
1021
 
 
1022
 
                result.report(self.outf)
1023
 
                if verbose and result.old_revid != result.new_revid:
1024
 
                    log.show_branch_change(
1025
 
                        branch_to, self.outf, result.old_revno,
1026
 
                        result.old_revid)
1027
 
            finally:
1028
 
                branch_to.unlock()
1029
 
        finally:
1030
 
            if branch_from is not branch_to:
1031
 
                branch_from.unlock()
 
1030
        if revision is not None:
 
1031
            revision_id = revision.as_revision_id(branch_from)
 
1032
 
 
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)
 
1044
 
 
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)
1032
1050
 
1033
1051
 
1034
1052
class cmd_push(Command):
1035
 
    """Update a mirror of this branch.
 
1053
    __doc__ = """Update a mirror of this branch.
1036
1054
 
1037
1055
    The target branch will not have its working tree populated because this
1038
1056
    is both expensive, and is not supported on remote file systems.
1062
1080
        Option('create-prefix',
1063
1081
               help='Create the path leading up to the branch '
1064
1082
                    'if it does not already exist.'),
1065
 
        Option('directory',
 
1083
        custom_help('directory',
1066
1084
            help='Branch to push from, '
1067
 
                 'rather than the one containing the working directory.',
1068
 
            short_name='d',
1069
 
            type=unicode,
1070
 
            ),
 
1085
                 'rather than the one containing the working directory.'),
1071
1086
        Option('use-existing-dir',
1072
1087
               help='By default push will fail if the target'
1073
1088
                    ' directory exists, but does not already'
1099
1114
        # Get the source branch
1100
1115
        (tree, br_from,
1101
1116
         _unused) = bzrdir.BzrDir.open_containing_tree_or_branch(directory)
1102
 
        if strict is None:
1103
 
            strict = br_from.get_config().get_user_option_as_bool('push_strict')
1104
 
        if strict is None: strict = True # default value
1105
1117
        # Get the tip's revision_id
1106
1118
        revision = _get_one_revision('push', revision)
1107
1119
        if revision is not None:
1108
1120
            revision_id = revision.in_history(br_from).rev_id
1109
1121
        else:
1110
1122
            revision_id = None
1111
 
        if strict and tree is not None and revision_id is None:
1112
 
            if (tree.has_changes(tree.basis_tree())
1113
 
                or len(tree.get_parent_ids()) > 1):
1114
 
                raise errors.UncommittedChanges(
1115
 
                    tree, more='Use --no-strict to force the push.')
1116
 
            if tree.last_revision() != tree.branch.last_revision():
1117
 
                # The tree has lost sync with its branch, there is little
1118
 
                # chance that the user is aware of it but he can still force
1119
 
                # the push with --no-strict
1120
 
                raise errors.OutOfDateTree(
1121
 
                    tree, more='Use --no-strict to force the push.')
1122
 
 
 
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.')
1123
1128
        # Get the stacked_on branch, if any
1124
1129
        if stacked_on is not None:
1125
1130
            stacked_on = urlutils.normalize_url(stacked_on)
1157
1162
 
1158
1163
 
1159
1164
class cmd_branch(Command):
1160
 
    """Create a new branch that is a copy of an existing branch.
 
1165
    __doc__ = """Create a new branch that is a copy of an existing branch.
1161
1166
 
1162
1167
    If the TO_LOCATION is omitted, the last component of the FROM_LOCATION will
1163
1168
    be used.  In other words, "branch ../foo/bar" will attempt to create ./bar.
1190
1195
                    ' directory exists, but does not already'
1191
1196
                    ' have a control directory.  This flag will'
1192
1197
                    ' allow branch to proceed.'),
 
1198
        Option('bind',
 
1199
            help="Bind new branch to from location."),
1193
1200
        ]
1194
1201
    aliases = ['get', 'clone']
1195
1202
 
1196
1203
    def run(self, from_location, to_location=None, revision=None,
1197
1204
            hardlink=False, stacked=False, standalone=False, no_tree=False,
1198
 
            use_existing_dir=False, switch=False):
 
1205
            use_existing_dir=False, switch=False, bind=False):
1199
1206
        from bzrlib import switch as _mod_switch
1200
1207
        from bzrlib.tag import _merge_tags_if_possible
1201
1208
        accelerator_tree, br_from = bzrdir.BzrDir.open_tree_or_branch(
1202
1209
            from_location)
1203
 
        if (accelerator_tree is not None and
1204
 
            accelerator_tree.supports_content_filtering()):
1205
 
            accelerator_tree = None
1206
1210
        revision = _get_one_revision('branch', revision)
1207
 
        br_from.lock_read()
 
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)
1208
1222
        try:
1209
 
            if revision is not None:
1210
 
                revision_id = revision.as_revision_id(br_from)
 
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)
1211
1228
            else:
1212
 
                # FIXME - wt.last_revision, fallback to branch, fall back to
1213
 
                # None or perhaps NULL_REVISION to mean copy nothing
1214
 
                # RBC 20060209
1215
 
                revision_id = br_from.last_revision()
1216
 
            if to_location is None:
1217
 
                to_location = urlutils.derive_to_location(from_location)
1218
 
            to_transport = transport.get_transport(to_location)
1219
 
            try:
1220
 
                to_transport.mkdir('.')
1221
 
            except errors.FileExists:
1222
 
                if not use_existing_dir:
1223
 
                    raise errors.BzrCommandError('Target directory "%s" '
1224
 
                        'already exists.' % to_location)
 
1229
                try:
 
1230
                    bzrdir.BzrDir.open_from_transport(to_transport)
 
1231
                except errors.NotBranchError:
 
1232
                    pass
1225
1233
                else:
1226
 
                    try:
1227
 
                        bzrdir.BzrDir.open_from_transport(to_transport)
1228
 
                    except errors.NotBranchError:
1229
 
                        pass
1230
 
                    else:
1231
 
                        raise errors.AlreadyBranchError(to_location)
1232
 
            except errors.NoSuchFile:
1233
 
                raise errors.BzrCommandError('Parent of "%s" does not exist.'
1234
 
                                             % to_location)
1235
 
            try:
1236
 
                # preserve whatever source format we have.
1237
 
                dir = br_from.bzrdir.sprout(to_transport.base, revision_id,
1238
 
                                            possible_transports=[to_transport],
1239
 
                                            accelerator_tree=accelerator_tree,
1240
 
                                            hardlink=hardlink, stacked=stacked,
1241
 
                                            force_new_repo=standalone,
1242
 
                                            create_tree_if_local=not no_tree,
1243
 
                                            source_branch=br_from)
1244
 
                branch = dir.open_branch()
1245
 
            except errors.NoSuchRevision:
1246
 
                to_transport.delete_tree('.')
1247
 
                msg = "The branch %s has no revision %s." % (from_location,
1248
 
                    revision)
1249
 
                raise errors.BzrCommandError(msg)
1250
 
            _merge_tags_if_possible(br_from, branch)
1251
 
            # If the source branch is stacked, the new branch may
1252
 
            # be stacked whether we asked for that explicitly or not.
1253
 
            # We therefore need a try/except here and not just 'if stacked:'
1254
 
            try:
1255
 
                note('Created new stacked branch referring to %s.' %
1256
 
                    branch.get_stacked_on_url())
1257
 
            except (errors.NotStacked, errors.UnstackableBranchFormat,
1258
 
                errors.UnstackableRepositoryFormat), e:
1259
 
                note('Branched %d revision(s).' % branch.revno())
1260
 
            if switch:
1261
 
                # Switch to the new branch
1262
 
                wt, _ = WorkingTree.open_containing('.')
1263
 
                _mod_switch.switch(wt.bzrdir, branch)
1264
 
                note('Switched to branch: %s',
1265
 
                    urlutils.unescape_for_display(branch.base, 'utf-8'))
1266
 
        finally:
1267
 
            br_from.unlock()
 
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'))
1268
1274
 
1269
1275
 
1270
1276
class cmd_checkout(Command):
1271
 
    """Create a new checkout of an existing branch.
 
1277
    __doc__ = """Create a new checkout of an existing branch.
1272
1278
 
1273
1279
    If BRANCH_LOCATION is omitted, checkout will reconstitute a working tree for
1274
1280
    the branch found in '.'. This is useful if you have removed the working tree
1337
1343
 
1338
1344
 
1339
1345
class cmd_renames(Command):
1340
 
    """Show list of renamed files.
 
1346
    __doc__ = """Show list of renamed files.
1341
1347
    """
1342
1348
    # TODO: Option to show renames between two historical versions.
1343
1349
 
1348
1354
    @display_command
1349
1355
    def run(self, dir=u'.'):
1350
1356
        tree = WorkingTree.open_containing(dir)[0]
1351
 
        tree.lock_read()
1352
 
        try:
1353
 
            new_inv = tree.inventory
1354
 
            old_tree = tree.basis_tree()
1355
 
            old_tree.lock_read()
1356
 
            try:
1357
 
                old_inv = old_tree.inventory
1358
 
                renames = []
1359
 
                iterator = tree.iter_changes(old_tree, include_unchanged=True)
1360
 
                for f, paths, c, v, p, n, k, e in iterator:
1361
 
                    if paths[0] == paths[1]:
1362
 
                        continue
1363
 
                    if None in (paths):
1364
 
                        continue
1365
 
                    renames.append(paths)
1366
 
                renames.sort()
1367
 
                for old_name, new_name in renames:
1368
 
                    self.outf.write("%s => %s\n" % (old_name, new_name))
1369
 
            finally:
1370
 
                old_tree.unlock()
1371
 
        finally:
1372
 
            tree.unlock()
 
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))
1373
1373
 
1374
1374
 
1375
1375
class cmd_update(Command):
1376
 
    """Update a tree to have the latest code committed to its branch.
 
1376
    __doc__ = """Update a tree to have the latest code committed to its branch.
1377
1377
 
1378
1378
    This will perform a merge into the working tree, and may generate
1379
1379
    conflicts. If you have any local changes, you will still
1381
1381
 
1382
1382
    If you want to discard your local changes, you can just do a
1383
1383
    '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.
1384
1387
    """
1385
1388
 
1386
1389
    _see_also = ['pull', 'working-trees', 'status-flags']
1387
1390
    takes_args = ['dir?']
 
1391
    takes_options = ['revision']
1388
1392
    aliases = ['up']
1389
1393
 
1390
 
    def run(self, dir='.'):
 
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")
1391
1398
        tree = WorkingTree.open_containing(dir)[0]
 
1399
        branch = tree.branch
1392
1400
        possible_transports = []
1393
 
        master = tree.branch.get_master_branch(
 
1401
        master = branch.get_master_branch(
1394
1402
            possible_transports=possible_transports)
1395
1403
        if master is not None:
 
1404
            branch_location = master.base
1396
1405
            tree.lock_write()
1397
1406
        else:
 
1407
            branch_location = tree.branch.base
1398
1408
            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)
1399
1435
        try:
1400
 
            existing_pending_merges = tree.get_parent_ids()[1:]
1401
 
            last_rev = _mod_revision.ensure_null(tree.last_revision())
1402
 
            if last_rev == _mod_revision.ensure_null(
1403
 
                tree.branch.last_revision()):
1404
 
                # may be up to date, check master too.
1405
 
                if master is None or last_rev == _mod_revision.ensure_null(
1406
 
                    master.last_revision()):
1407
 
                    revno = tree.branch.revision_id_to_revno(last_rev)
1408
 
                    note("Tree is up to date at revision %d." % (revno,))
1409
 
                    return 0
1410
 
            view_info = _get_view_info_for_change_reporter(tree)
1411
1436
            conflicts = tree.update(
1412
 
                delta._ChangeReporter(unversioned_filter=tree.is_ignored,
1413
 
                view_info=view_info), possible_transports=possible_transports)
1414
 
            revno = tree.branch.revision_id_to_revno(
1415
 
                _mod_revision.ensure_null(tree.last_revision()))
1416
 
            note('Updated to revision %d.' % (revno,))
1417
 
            if tree.get_parent_ids()[1:] != existing_pending_merges:
1418
 
                note('Your local commits will now show as pending merges with '
1419
 
                     "'bzr status', and can be committed with 'bzr commit'.")
1420
 
            if conflicts != 0:
1421
 
                return 1
1422
 
            else:
1423
 
                return 0
1424
 
        finally:
1425
 
            tree.unlock()
 
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
1426
1459
 
1427
1460
 
1428
1461
class cmd_info(Command):
1429
 
    """Show information about a working tree, branch or repository.
 
1462
    __doc__ = """Show information about a working tree, branch or repository.
1430
1463
 
1431
1464
    This command will show all known locations and formats associated to the
1432
1465
    tree, branch or repository.
1470
1503
 
1471
1504
 
1472
1505
class cmd_remove(Command):
1473
 
    """Remove files or directories.
 
1506
    __doc__ = """Remove files or directories.
1474
1507
 
1475
1508
    This makes bzr stop tracking changes to the specified files. bzr will delete
1476
1509
    them if they can easily be recovered using revert. If no options or
1498
1531
        if file_list is not None:
1499
1532
            file_list = [f for f in file_list]
1500
1533
 
1501
 
        tree.lock_write()
1502
 
        try:
1503
 
            # Heuristics should probably all move into tree.remove_smart or
1504
 
            # some such?
1505
 
            if new:
1506
 
                added = tree.changes_from(tree.basis_tree(),
1507
 
                    specific_files=file_list).added
1508
 
                file_list = sorted([f[0] for f in added], reverse=True)
1509
 
                if len(file_list) == 0:
1510
 
                    raise errors.BzrCommandError('No matching files.')
1511
 
            elif file_list is None:
1512
 
                # missing files show up in iter_changes(basis) as
1513
 
                # versioned-with-no-kind.
1514
 
                missing = []
1515
 
                for change in tree.iter_changes(tree.basis_tree()):
1516
 
                    # Find paths in the working tree that have no kind:
1517
 
                    if change[1][1] is not None and change[6][1] is None:
1518
 
                        missing.append(change[1][1])
1519
 
                file_list = sorted(missing, reverse=True)
1520
 
                file_deletion_strategy = 'keep'
1521
 
            tree.remove(file_list, verbose=verbose, to_file=self.outf,
1522
 
                keep_files=file_deletion_strategy=='keep',
1523
 
                force=file_deletion_strategy=='force')
1524
 
        finally:
1525
 
            tree.unlock()
 
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')
1526
1556
 
1527
1557
 
1528
1558
class cmd_file_id(Command):
1529
 
    """Print file_id of a particular file or directory.
 
1559
    __doc__ = """Print file_id of a particular file or directory.
1530
1560
 
1531
1561
    The file_id is assigned when the file is first added and remains the
1532
1562
    same through all revisions where the file exists, even when it is
1548
1578
 
1549
1579
 
1550
1580
class cmd_file_path(Command):
1551
 
    """Print path of file_ids to a file or directory.
 
1581
    __doc__ = """Print path of file_ids to a file or directory.
1552
1582
 
1553
1583
    This prints one line for each directory down to the target,
1554
1584
    starting at the branch root.
1570
1600
 
1571
1601
 
1572
1602
class cmd_reconcile(Command):
1573
 
    """Reconcile bzr metadata in a branch.
 
1603
    __doc__ = """Reconcile bzr metadata in a branch.
1574
1604
 
1575
1605
    This can correct data mismatches that may have been caused by
1576
1606
    previous ghost operations or bzr upgrades. You should only
1598
1628
 
1599
1629
 
1600
1630
class cmd_revision_history(Command):
1601
 
    """Display the list of revision ids on a branch."""
 
1631
    __doc__ = """Display the list of revision ids on a branch."""
1602
1632
 
1603
1633
    _see_also = ['log']
1604
1634
    takes_args = ['location?']
1614
1644
 
1615
1645
 
1616
1646
class cmd_ancestry(Command):
1617
 
    """List all revisions merged into this branch."""
 
1647
    __doc__ = """List all revisions merged into this branch."""
1618
1648
 
1619
1649
    _see_also = ['log', 'revision-history']
1620
1650
    takes_args = ['location?']
1639
1669
 
1640
1670
 
1641
1671
class cmd_init(Command):
1642
 
    """Make a directory into a versioned branch.
 
1672
    __doc__ = """Make a directory into a versioned branch.
1643
1673
 
1644
1674
    Use this to create an empty branch, or before importing an
1645
1675
    existing project.
1673
1703
                lazy_registry=('bzrlib.bzrdir', 'format_registry'),
1674
1704
                converter=lambda name: bzrdir.format_registry.make_bzrdir(name),
1675
1705
                value_switches=True,
1676
 
                title="Branch Format",
 
1706
                title="Branch format",
1677
1707
                ),
1678
1708
         Option('append-revisions-only',
1679
1709
                help='Never change revnos or the existing log.'
1748
1778
 
1749
1779
 
1750
1780
class cmd_init_repository(Command):
1751
 
    """Create a shared repository to hold branches.
 
1781
    __doc__ = """Create a shared repository for branches to share storage space.
1752
1782
 
1753
1783
    New branches created under the repository directory will store their
1754
 
    revisions in the repository, not in the branch directory.
 
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.
1755
1787
 
1756
 
    If the --no-trees option is used then the branches in the repository
1757
 
    will not have working trees by default.
 
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.
1758
1794
 
1759
1795
    :Examples:
1760
 
        Create a shared repositories holding just branches::
 
1796
        Create a shared repository holding just branches::
1761
1797
 
1762
1798
            bzr init-repo --no-trees repo
1763
1799
            bzr init repo/trunk
1802
1838
 
1803
1839
 
1804
1840
class cmd_diff(Command):
1805
 
    """Show differences in the working tree, between revisions or branches.
 
1841
    __doc__ = """Show differences in the working tree, between revisions or branches.
1806
1842
 
1807
1843
    If no arguments are given, all changes for the current tree are listed.
1808
1844
    If files are given, only the changes in those files are listed.
1829
1865
 
1830
1866
            bzr diff -r1
1831
1867
 
1832
 
        Difference between revision 2 and revision 1::
1833
 
 
1834
 
            bzr diff -r1..2
1835
 
 
1836
 
        Difference between revision 2 and revision 1 for branch xxx::
1837
 
 
1838
 
            bzr diff -r1..2 xxx
 
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
1839
1889
 
1840
1890
        Show just the differences for file NEWS::
1841
1891
 
1880
1930
            help='Use this command to compare files.',
1881
1931
            type=unicode,
1882
1932
            ),
 
1933
        RegistryOption('format',
 
1934
            help='Diff format to use.',
 
1935
            lazy_registry=('bzrlib.diff', 'format_registry'),
 
1936
            value_switches=False, title='Diff format'),
1883
1937
        ]
1884
1938
    aliases = ['di', 'dif']
1885
1939
    encoding_type = 'exact'
1886
1940
 
1887
1941
    @display_command
1888
1942
    def run(self, revision=None, file_list=None, diff_options=None,
1889
 
            prefix=None, old=None, new=None, using=None):
1890
 
        from bzrlib.diff import _get_trees_to_diff, show_diff_trees
 
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)
1891
1946
 
1892
1947
        if (prefix is None) or (prefix == '0'):
1893
1948
            # diff -p0 format
1907
1962
            raise errors.BzrCommandError('bzr diff --revision takes exactly'
1908
1963
                                         ' one or two revision specifiers')
1909
1964
 
1910
 
        old_tree, new_tree, specific_files, extra_trees = \
1911
 
                _get_trees_to_diff(file_list, revision, old, new,
1912
 
                apply_view=True)
 
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()
1913
1975
        return show_diff_trees(old_tree, new_tree, sys.stdout,
1914
1976
                               specific_files=specific_files,
1915
1977
                               external_diff_options=diff_options,
1916
1978
                               old_label=old_label, new_label=new_label,
1917
 
                               extra_trees=extra_trees, using=using)
 
1979
                               extra_trees=extra_trees,
 
1980
                               path_encoding=path_encoding,
 
1981
                               using=using,
 
1982
                               format_cls=format)
1918
1983
 
1919
1984
 
1920
1985
class cmd_deleted(Command):
1921
 
    """List files deleted in the working tree.
 
1986
    __doc__ = """List files deleted in the working tree.
1922
1987
    """
1923
1988
    # TODO: Show files deleted since a previous revision, or
1924
1989
    # between two revisions.
1927
1992
    # level of effort but possibly much less IO.  (Or possibly not,
1928
1993
    # if the directories are very large...)
1929
1994
    _see_also = ['status', 'ls']
1930
 
    takes_options = ['show-ids']
 
1995
    takes_options = ['directory', 'show-ids']
1931
1996
 
1932
1997
    @display_command
1933
 
    def run(self, show_ids=False):
1934
 
        tree = WorkingTree.open_containing(u'.')[0]
1935
 
        tree.lock_read()
1936
 
        try:
1937
 
            old = tree.basis_tree()
1938
 
            old.lock_read()
1939
 
            try:
1940
 
                for path, ie in old.inventory.iter_entries():
1941
 
                    if not tree.has_id(ie.file_id):
1942
 
                        self.outf.write(path)
1943
 
                        if show_ids:
1944
 
                            self.outf.write(' ')
1945
 
                            self.outf.write(ie.file_id)
1946
 
                        self.outf.write('\n')
1947
 
            finally:
1948
 
                old.unlock()
1949
 
        finally:
1950
 
            tree.unlock()
 
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')
1951
2010
 
1952
2011
 
1953
2012
class cmd_modified(Command):
1954
 
    """List files modified in working tree.
 
2013
    __doc__ = """List files modified in working tree.
1955
2014
    """
1956
2015
 
1957
2016
    hidden = True
1958
2017
    _see_also = ['status', 'ls']
1959
 
    takes_options = [
1960
 
            Option('null',
1961
 
                   help='Write an ascii NUL (\\0) separator '
1962
 
                   'between files rather than a newline.')
1963
 
            ]
 
2018
    takes_options = ['directory', 'null']
1964
2019
 
1965
2020
    @display_command
1966
 
    def run(self, null=False):
1967
 
        tree = WorkingTree.open_containing(u'.')[0]
 
2021
    def run(self, null=False, directory=u'.'):
 
2022
        tree = WorkingTree.open_containing(directory)[0]
1968
2023
        td = tree.changes_from(tree.basis_tree())
1969
2024
        for path, id, kind, text_modified, meta_modified in td.modified:
1970
2025
            if null:
1974
2029
 
1975
2030
 
1976
2031
class cmd_added(Command):
1977
 
    """List files added in working tree.
 
2032
    __doc__ = """List files added in working tree.
1978
2033
    """
1979
2034
 
1980
2035
    hidden = True
1981
2036
    _see_also = ['status', 'ls']
1982
 
    takes_options = [
1983
 
            Option('null',
1984
 
                   help='Write an ascii NUL (\\0) separator '
1985
 
                   'between files rather than a newline.')
1986
 
            ]
 
2037
    takes_options = ['directory', 'null']
1987
2038
 
1988
2039
    @display_command
1989
 
    def run(self, null=False):
1990
 
        wt = WorkingTree.open_containing(u'.')[0]
1991
 
        wt.lock_read()
1992
 
        try:
1993
 
            basis = wt.basis_tree()
1994
 
            basis.lock_read()
1995
 
            try:
1996
 
                basis_inv = basis.inventory
1997
 
                inv = wt.inventory
1998
 
                for file_id in inv:
1999
 
                    if file_id in basis_inv:
2000
 
                        continue
2001
 
                    if inv.is_root(file_id) and len(basis_inv) == 0:
2002
 
                        continue
2003
 
                    path = inv.id2path(file_id)
2004
 
                    if not os.access(osutils.abspath(path), os.F_OK):
2005
 
                        continue
2006
 
                    if null:
2007
 
                        self.outf.write(path + '\0')
2008
 
                    else:
2009
 
                        self.outf.write(osutils.quotefn(path) + '\n')
2010
 
            finally:
2011
 
                basis.unlock()
2012
 
        finally:
2013
 
            wt.unlock()
 
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')
2014
2059
 
2015
2060
 
2016
2061
class cmd_root(Command):
2017
 
    """Show the tree root directory.
 
2062
    __doc__ = """Show the tree root directory.
2018
2063
 
2019
2064
    The root is the nearest enclosing directory with a .bzr control
2020
2065
    directory."""
2044
2089
 
2045
2090
 
2046
2091
class cmd_log(Command):
2047
 
    """Show historical log for a branch or subset of a branch.
 
2092
    __doc__ = """Show historical log for a branch or subset of a branch.
2048
2093
 
2049
2094
    log is bzr's default tool for exploring the history of a branch.
2050
2095
    The branch to use is taken from the first parameter. If no parameters
2161
2206
    :Tips & tricks:
2162
2207
 
2163
2208
      GUI tools and IDEs are often better at exploring history than command
2164
 
      line tools. You may prefer qlog or glog from the QBzr and Bzr-Gtk packages
2165
 
      respectively for example. (TortoiseBzr uses qlog for displaying logs.) See
2166
 
      http://bazaar-vcs.org/BzrPlugins and http://bazaar-vcs.org/IDEIntegration.
2167
 
 
2168
 
      Web interfaces are often better at exploring history than command line
2169
 
      tools, particularly for branches on servers. You may prefer Loggerhead
2170
 
      or one of its alternatives. See http://bazaar-vcs.org/WebInterface.
 
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>.  
2171
2213
 
2172
2214
      You may find it useful to add the aliases below to ``bazaar.conf``::
2173
2215
 
2214
2256
                   help='Show just the specified revision.'
2215
2257
                   ' See also "help revisionspec".'),
2216
2258
            '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
            ),
2217
2264
            Option('levels',
2218
2265
                   short_name='n',
2219
2266
                   help='Number of levels to display - 0 for all, 1 for flat.',
2234
2281
                   help='Show changes made in each revision as a patch.'),
2235
2282
            Option('include-merges',
2236
2283
                   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
                   )
2237
2288
            ]
2238
2289
    encoding_type = 'replace'
2239
2290
 
2249
2300
            message=None,
2250
2301
            limit=None,
2251
2302
            show_diff=False,
2252
 
            include_merges=False):
 
2303
            include_merges=False,
 
2304
            authors=None,
 
2305
            exclude_common_ancestry=False,
 
2306
            ):
2253
2307
        from bzrlib.log import (
2254
2308
            Logger,
2255
2309
            make_log_request_dict,
2256
2310
            _get_info_for_log_files,
2257
2311
            )
2258
2312
        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')
2259
2317
        if include_merges:
2260
2318
            if levels is None:
2261
2319
                levels = 0
2276
2334
        filter_by_dir = False
2277
2335
        if file_list:
2278
2336
            # find the file ids to log and check for directory filtering
2279
 
            b, file_info_list, rev1, rev2 = _get_info_for_log_files(revision,
2280
 
                file_list)
 
2337
            b, file_info_list, rev1, rev2 = _get_info_for_log_files(
 
2338
                revision, file_list, self.add_cleanup)
2281
2339
            for relpath, file_id, kind in file_info_list:
2282
2340
                if file_id is None:
2283
2341
                    raise errors.BzrCommandError(
2301
2359
                location = '.'
2302
2360
            dir, relpath = bzrdir.BzrDir.open_containing(location)
2303
2361
            b = dir.open_branch()
 
2362
            self.add_cleanup(b.lock_read().unlock)
2304
2363
            rev1, rev2 = _get_revision_range(revision, b, self.name())
2305
2364
 
2306
2365
        # Decide on the type of delta & diff filtering to use
2316
2375
        else:
2317
2376
            diff_type = 'full'
2318
2377
 
2319
 
        b.lock_read()
2320
 
        try:
2321
 
            # Build the log formatter
2322
 
            if log_format is None:
2323
 
                log_format = log.log_formatter_registry.get_default(b)
2324
 
            lf = log_format(show_ids=show_ids, to_file=self.outf,
2325
 
                            show_timezone=timezone,
2326
 
                            delta_format=get_verbosity_level(),
2327
 
                            levels=levels,
2328
 
                            show_advice=levels is None)
2329
 
 
2330
 
            # Choose the algorithm for doing the logging. It's annoying
2331
 
            # having multiple code paths like this but necessary until
2332
 
            # the underlying repository format is faster at generating
2333
 
            # deltas or can provide everything we need from the indices.
2334
 
            # The default algorithm - match-using-deltas - works for
2335
 
            # multiple files and directories and is faster for small
2336
 
            # amounts of history (200 revisions say). However, it's too
2337
 
            # slow for logging a single file in a repository with deep
2338
 
            # history, i.e. > 10K revisions. In the spirit of "do no
2339
 
            # evil when adding features", we continue to use the
2340
 
            # original algorithm - per-file-graph - for the "single
2341
 
            # file that isn't a directory without showing a delta" case.
2342
 
            partial_history = revision and b.repository._format.supports_chks
2343
 
            match_using_deltas = (len(file_ids) != 1 or filter_by_dir
2344
 
                or delta_type or partial_history)
2345
 
 
2346
 
            # Build the LogRequest and execute it
2347
 
            if len(file_ids) == 0:
2348
 
                file_ids = None
2349
 
            rqst = make_log_request_dict(
2350
 
                direction=direction, specific_fileids=file_ids,
2351
 
                start_revision=rev1, end_revision=rev2, limit=limit,
2352
 
                message_search=message, delta_type=delta_type,
2353
 
                diff_type=diff_type, _match_using_deltas=match_using_deltas)
2354
 
            Logger(b, rqst).show(lf)
2355
 
        finally:
2356
 
            b.unlock()
 
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)
2357
2418
 
2358
2419
 
2359
2420
def _get_revision_range(revisionspec_list, branch, command_name):
2377
2438
            raise errors.BzrCommandError(
2378
2439
                "bzr %s doesn't accept two revisions in different"
2379
2440
                " branches." % command_name)
2380
 
        rev1 = start_spec.in_history(branch)
 
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)
2381
2446
        # Avoid loading all of history when we know a missing
2382
2447
        # end of range means the last revision ...
2383
2448
        if end_spec.spec is None:
2412
2477
 
2413
2478
 
2414
2479
class cmd_touching_revisions(Command):
2415
 
    """Return revision-ids which affected a particular file.
 
2480
    __doc__ = """Return revision-ids which affected a particular file.
2416
2481
 
2417
2482
    A more user-friendly interface is "bzr log FILE".
2418
2483
    """
2423
2488
    @display_command
2424
2489
    def run(self, filename):
2425
2490
        tree, relpath = WorkingTree.open_containing(filename)
 
2491
        file_id = tree.path2id(relpath)
2426
2492
        b = tree.branch
2427
 
        file_id = tree.path2id(relpath)
2428
 
        for revno, revision_id, what in log.find_touching_revisions(b, file_id):
 
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:
2429
2496
            self.outf.write("%6d %s\n" % (revno, what))
2430
2497
 
2431
2498
 
2432
2499
class cmd_ls(Command):
2433
 
    """List files in a tree.
 
2500
    __doc__ = """List files in a tree.
2434
2501
    """
2435
2502
 
2436
2503
    _see_also = ['status', 'cat']
2442
2509
                   help='Recurse into subdirectories.'),
2443
2510
            Option('from-root',
2444
2511
                   help='Print paths relative to the root of the branch.'),
2445
 
            Option('unknown', help='Print unknown files.'),
 
2512
            Option('unknown', short_name='u',
 
2513
                help='Print unknown files.'),
2446
2514
            Option('versioned', help='Print versioned files.',
2447
2515
                   short_name='V'),
2448
 
            Option('ignored', help='Print ignored files.'),
2449
 
            Option('null',
2450
 
                   help='Write an ascii NUL (\\0) separator '
2451
 
                   'between files rather than a newline.'),
2452
 
            Option('kind',
 
2516
            Option('ignored', short_name='i',
 
2517
                help='Print ignored files.'),
 
2518
            Option('kind', short_name='k',
2453
2519
                   help='List entries of a particular kind: file, directory, symlink.',
2454
2520
                   type=unicode),
 
2521
            'null',
2455
2522
            'show-ids',
 
2523
            'directory',
2456
2524
            ]
2457
2525
    @display_command
2458
2526
    def run(self, revision=None, verbose=False,
2459
2527
            recursive=False, from_root=False,
2460
2528
            unknown=False, versioned=False, ignored=False,
2461
 
            null=False, kind=None, show_ids=False, path=None):
 
2529
            null=False, kind=None, show_ids=False, path=None, directory=None):
2462
2530
 
2463
2531
        if kind and kind not in ('file', 'directory', 'symlink'):
2464
2532
            raise errors.BzrCommandError('invalid kind specified')
2476
2544
                raise errors.BzrCommandError('cannot specify both --from-root'
2477
2545
                                             ' and PATH')
2478
2546
            fs_path = path
2479
 
        tree, branch, relpath = bzrdir.BzrDir.open_containing_tree_or_branch(
2480
 
            fs_path)
 
2547
        tree, branch, relpath = \
 
2548
            _open_directory_or_containing_tree_or_branch(fs_path, directory)
2481
2549
 
2482
2550
        # Calculate the prefix to use
2483
2551
        prefix = None
2484
2552
        if from_root:
2485
2553
            if relpath:
2486
2554
                prefix = relpath + '/'
2487
 
        elif fs_path != '.':
 
2555
        elif fs_path != '.' and not fs_path.endswith('/'):
2488
2556
            prefix = fs_path + '/'
2489
2557
 
2490
2558
        if revision is not None or tree is None:
2498
2566
                view_str = views.view_display_str(view_files)
2499
2567
                note("Ignoring files outside view. View is %s" % view_str)
2500
2568
 
2501
 
        tree.lock_read()
2502
 
        try:
2503
 
            for fp, fc, fkind, fid, entry in tree.list_files(include_root=False,
2504
 
                from_dir=relpath, recursive=recursive):
2505
 
                # Apply additional masking
2506
 
                if not all and not selection[fc]:
2507
 
                    continue
2508
 
                if kind is not None and fkind != kind:
2509
 
                    continue
2510
 
                if apply_view:
2511
 
                    try:
2512
 
                        if relpath:
2513
 
                            fullpath = osutils.pathjoin(relpath, fp)
2514
 
                        else:
2515
 
                            fullpath = fp
2516
 
                        views.check_path_in_view(tree, fullpath)
2517
 
                    except errors.FileOutsideView:
2518
 
                        continue
 
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
2519
2586
 
2520
 
                # Output the entry
2521
 
                if prefix:
2522
 
                    fp = osutils.pathjoin(prefix, fp)
2523
 
                kindch = entry.kind_character()
2524
 
                outstring = fp + kindch
2525
 
                ui.ui_factory.clear_term()
2526
 
                if verbose:
2527
 
                    outstring = '%-8s %s' % (fc, outstring)
2528
 
                    if show_ids and fid is not None:
2529
 
                        outstring = "%-50s %s" % (outstring, fid)
 
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:
2530
2613
                    self.outf.write(outstring + '\n')
2531
 
                elif null:
2532
 
                    self.outf.write(fp + '\0')
2533
 
                    if show_ids:
2534
 
                        if fid is not None:
2535
 
                            self.outf.write(fid)
2536
 
                        self.outf.write('\0')
2537
 
                    self.outf.flush()
2538
 
                else:
2539
 
                    if show_ids:
2540
 
                        if fid is not None:
2541
 
                            my_id = fid
2542
 
                        else:
2543
 
                            my_id = ''
2544
 
                        self.outf.write('%-50s %s\n' % (outstring, my_id))
2545
 
                    else:
2546
 
                        self.outf.write(outstring + '\n')
2547
 
        finally:
2548
 
            tree.unlock()
2549
2614
 
2550
2615
 
2551
2616
class cmd_unknowns(Command):
2552
 
    """List unknown files.
 
2617
    __doc__ = """List unknown files.
2553
2618
    """
2554
2619
 
2555
2620
    hidden = True
2556
2621
    _see_also = ['ls']
 
2622
    takes_options = ['directory']
2557
2623
 
2558
2624
    @display_command
2559
 
    def run(self):
2560
 
        for f in WorkingTree.open_containing(u'.')[0].unknowns():
 
2625
    def run(self, directory=u'.'):
 
2626
        for f in WorkingTree.open_containing(directory)[0].unknowns():
2561
2627
            self.outf.write(osutils.quotefn(f) + '\n')
2562
2628
 
2563
2629
 
2564
2630
class cmd_ignore(Command):
2565
 
    """Ignore specified files or patterns.
 
2631
    __doc__ = """Ignore specified files or patterns.
2566
2632
 
2567
2633
    See ``bzr help patterns`` for details on the syntax of patterns.
2568
2634
 
 
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
 
2569
2641
    To remove patterns from the ignore list, edit the .bzrignore file.
2570
2642
    After adding, editing or deleting that file either indirectly by
2571
2643
    using this command or directly by using an editor, be sure to commit
2572
2644
    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.
2573
2658
 
2574
2659
    Note: ignore patterns containing shell wildcards must be quoted from
2575
2660
    the shell on Unix.
2579
2664
 
2580
2665
            bzr ignore ./Makefile
2581
2666
 
2582
 
        Ignore class files in all directories::
 
2667
        Ignore .class files in all directories...::
2583
2668
 
2584
2669
            bzr ignore "*.class"
2585
2670
 
 
2671
        ...but do not ignore "special.class"::
 
2672
 
 
2673
            bzr ignore "!special.class"
 
2674
 
2586
2675
        Ignore .o files under the lib directory::
2587
2676
 
2588
2677
            bzr ignore "lib/**/*.o"
2594
2683
        Ignore everything but the "debian" toplevel directory::
2595
2684
 
2596
2685
            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 "!!*~"
2597
2693
    """
2598
2694
 
2599
2695
    _see_also = ['status', 'ignored', 'patterns']
2600
2696
    takes_args = ['name_pattern*']
2601
 
    takes_options = [
2602
 
        Option('old-default-rules',
2603
 
               help='Write out the ignore rules bzr < 0.9 always used.')
 
2697
    takes_options = ['directory',
 
2698
        Option('default-rules',
 
2699
               help='Display the default ignore rules that bzr uses.')
2604
2700
        ]
2605
2701
 
2606
 
    def run(self, name_pattern_list=None, old_default_rules=None):
 
2702
    def run(self, name_pattern_list=None, default_rules=None,
 
2703
            directory=u'.'):
2607
2704
        from bzrlib import ignores
2608
 
        if old_default_rules is not None:
2609
 
            # dump the rules and exit
2610
 
            for pattern in ignores.OLD_DEFAULTS:
2611
 
                print pattern
 
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)
2612
2709
            return
2613
2710
        if not name_pattern_list:
2614
2711
            raise errors.BzrCommandError("ignore requires at least one "
2615
 
                                  "NAME_PATTERN or --old-default-rules")
 
2712
                "NAME_PATTERN or --default-rules.")
2616
2713
        name_pattern_list = [globbing.normalize_pattern(p)
2617
2714
                             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('')
2618
2723
        for name_pattern in name_pattern_list:
2619
2724
            if (name_pattern[0] == '/' or
2620
2725
                (len(name_pattern) > 1 and name_pattern[1] == ':')):
2621
2726
                raise errors.BzrCommandError(
2622
2727
                    "NAME_PATTERN should not be an absolute path")
2623
 
        tree, relpath = WorkingTree.open_containing(u'.')
 
2728
        tree, relpath = WorkingTree.open_containing(directory)
2624
2729
        ignores.tree_ignores_add_patterns(tree, name_pattern_list)
2625
2730
        ignored = globbing.Globster(name_pattern_list)
2626
2731
        matches = []
2627
 
        tree.lock_read()
 
2732
        self.add_cleanup(tree.lock_read().unlock)
2628
2733
        for entry in tree.list_files():
2629
2734
            id = entry[3]
2630
2735
            if id is not None:
2631
2736
                filename = entry[0]
2632
2737
                if ignored.match(filename):
2633
 
                    matches.append(filename.encode('utf-8'))
2634
 
        tree.unlock()
 
2738
                    matches.append(filename)
2635
2739
        if len(matches) > 0:
2636
 
            print "Warning: the following files are version controlled and" \
2637
 
                  " match your ignore pattern:\n%s" \
2638
 
                  "\nThese files will continue to be version controlled" \
2639
 
                  " unless you 'bzr remove' them." % ("\n".join(matches),)
 
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),))
2640
2744
 
2641
2745
 
2642
2746
class cmd_ignored(Command):
2643
 
    """List ignored files and the patterns that matched them.
 
2747
    __doc__ = """List ignored files and the patterns that matched them.
2644
2748
 
2645
2749
    List all the ignored files and the ignore pattern that caused the file to
2646
2750
    be ignored.
2652
2756
 
2653
2757
    encoding_type = 'replace'
2654
2758
    _see_also = ['ignore', 'ls']
 
2759
    takes_options = ['directory']
2655
2760
 
2656
2761
    @display_command
2657
 
    def run(self):
2658
 
        tree = WorkingTree.open_containing(u'.')[0]
2659
 
        tree.lock_read()
2660
 
        try:
2661
 
            for path, file_class, kind, file_id, entry in tree.list_files():
2662
 
                if file_class != 'I':
2663
 
                    continue
2664
 
                ## XXX: Slightly inefficient since this was already calculated
2665
 
                pat = tree.is_ignored(path)
2666
 
                self.outf.write('%-50s %s\n' % (path, pat))
2667
 
        finally:
2668
 
            tree.unlock()
 
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))
2669
2771
 
2670
2772
 
2671
2773
class cmd_lookup_revision(Command):
2672
 
    """Lookup the revision-id from a revision-number
 
2774
    __doc__ = """Lookup the revision-id from a revision-number
2673
2775
 
2674
2776
    :Examples:
2675
2777
        bzr lookup-revision 33
2676
2778
    """
2677
2779
    hidden = True
2678
2780
    takes_args = ['revno']
 
2781
    takes_options = ['directory']
2679
2782
 
2680
2783
    @display_command
2681
 
    def run(self, revno):
 
2784
    def run(self, revno, directory=u'.'):
2682
2785
        try:
2683
2786
            revno = int(revno)
2684
2787
        except ValueError:
2685
 
            raise errors.BzrCommandError("not a valid revision-number: %r" % revno)
2686
 
 
2687
 
        print WorkingTree.open_containing(u'.')[0].branch.get_rev_id(revno)
 
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)
2688
2792
 
2689
2793
 
2690
2794
class cmd_export(Command):
2691
 
    """Export current or past revision to a destination directory or archive.
 
2795
    __doc__ = """Export current or past revision to a destination directory or archive.
2692
2796
 
2693
2797
    If no revision is specified this exports the last committed revision.
2694
2798
 
2716
2820
      =================       =========================
2717
2821
    """
2718
2822
    takes_args = ['dest', 'branch_or_subdir?']
2719
 
    takes_options = [
 
2823
    takes_options = ['directory',
2720
2824
        Option('format',
2721
2825
               help="Type of file to export to.",
2722
2826
               type=unicode),
2726
2830
        Option('root',
2727
2831
               type=str,
2728
2832
               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.'),
2729
2836
        ]
2730
2837
    def run(self, dest, branch_or_subdir=None, revision=None, format=None,
2731
 
        root=None, filters=False):
 
2838
        root=None, filters=False, per_file_timestamps=False, directory=u'.'):
2732
2839
        from bzrlib.export import export
2733
2840
 
2734
2841
        if branch_or_subdir is None:
2735
 
            tree = WorkingTree.open_containing(u'.')[0]
 
2842
            tree = WorkingTree.open_containing(directory)[0]
2736
2843
            b = tree.branch
2737
2844
            subdir = None
2738
2845
        else:
2741
2848
 
2742
2849
        rev_tree = _get_one_revision_tree('export', revision, branch=b, tree=tree)
2743
2850
        try:
2744
 
            export(rev_tree, dest, format, root, subdir, filtered=filters)
 
2851
            export(rev_tree, dest, format, root, subdir, filtered=filters,
 
2852
                   per_file_timestamps=per_file_timestamps)
2745
2853
        except errors.NoSuchExportFormat, e:
2746
2854
            raise errors.BzrCommandError('Unsupported export format: %s' % e.format)
2747
2855
 
2748
2856
 
2749
2857
class cmd_cat(Command):
2750
 
    """Write the contents of a file as of a given revision to standard output.
 
2858
    __doc__ = """Write the contents of a file as of a given revision to standard output.
2751
2859
 
2752
2860
    If no revision is nominated, the last revision is used.
2753
2861
 
2756
2864
    """
2757
2865
 
2758
2866
    _see_also = ['ls']
2759
 
    takes_options = [
 
2867
    takes_options = ['directory',
2760
2868
        Option('name-from-revision', help='The path name in the old tree.'),
2761
2869
        Option('filters', help='Apply content filters to display the '
2762
2870
                'convenience form.'),
2767
2875
 
2768
2876
    @display_command
2769
2877
    def run(self, filename, revision=None, name_from_revision=False,
2770
 
            filters=False):
 
2878
            filters=False, directory=None):
2771
2879
        if revision is not None and len(revision) != 1:
2772
2880
            raise errors.BzrCommandError("bzr cat --revision takes exactly"
2773
2881
                                         " one revision specifier")
2774
2882
        tree, branch, relpath = \
2775
 
            bzrdir.BzrDir.open_containing_tree_or_branch(filename)
2776
 
        branch.lock_read()
2777
 
        try:
2778
 
            return self._run(tree, branch, relpath, filename, revision,
2779
 
                             name_from_revision, filters)
2780
 
        finally:
2781
 
            branch.unlock()
 
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)
2782
2887
 
2783
2888
    def _run(self, tree, b, relpath, filename, revision, name_from_revision,
2784
2889
        filtered):
2785
2890
        if tree is None:
2786
2891
            tree = b.basis_tree()
2787
2892
        rev_tree = _get_one_revision_tree('cat', revision, branch=b)
 
2893
        self.add_cleanup(rev_tree.lock_read().unlock)
2788
2894
 
2789
2895
        old_file_id = rev_tree.path2id(relpath)
2790
2896
 
2825
2931
            chunks = content.splitlines(True)
2826
2932
            content = filtered_output_bytes(chunks, filters,
2827
2933
                ContentFilterContext(relpath, rev_tree))
 
2934
            self.cleanup_now()
2828
2935
            self.outf.writelines(content)
2829
2936
        else:
 
2937
            self.cleanup_now()
2830
2938
            self.outf.write(content)
2831
2939
 
2832
2940
 
2833
2941
class cmd_local_time_offset(Command):
2834
 
    """Show the offset in seconds from GMT to local time."""
 
2942
    __doc__ = """Show the offset in seconds from GMT to local time."""
2835
2943
    hidden = True
2836
2944
    @display_command
2837
2945
    def run(self):
2838
 
        print osutils.local_time_offset()
 
2946
        self.outf.write("%s\n" % osutils.local_time_offset())
2839
2947
 
2840
2948
 
2841
2949
 
2842
2950
class cmd_commit(Command):
2843
 
    """Commit changes into a new revision.
 
2951
    __doc__ = """Commit changes into a new revision.
2844
2952
 
2845
2953
    An explanatory message needs to be given for each commit. This is
2846
2954
    often done by using the --message option (getting the message from the
2939
3047
             Option('strict',
2940
3048
                    help="Refuse to commit if there are unknown "
2941
3049
                    "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'."),
2942
3053
             ListOption('fixes', type=str,
2943
3054
                    help="Mark a bug as being fixed by this revision "
2944
3055
                         "(see \"bzr help bugs\")."),
2951
3062
                         "the master branch until a normal commit "
2952
3063
                         "is performed."
2953
3064
                    ),
2954
 
              Option('show-diff',
2955
 
                     help='When no message is supplied, show the diff along'
2956
 
                     ' with the status summary in the message editor.'),
 
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.'),
2957
3068
             ]
2958
3069
    aliases = ['ci', 'checkin']
2959
3070
 
2978
3089
 
2979
3090
    def run(self, message=None, file=None, verbose=False, selected_list=None,
2980
3091
            unchanged=False, strict=False, local=False, fixes=None,
2981
 
            author=None, show_diff=False, exclude=None):
 
3092
            author=None, show_diff=False, exclude=None, commit_time=None):
2982
3093
        from bzrlib.errors import (
2983
3094
            PointlessCommit,
2984
3095
            ConflictsInTree,
2990
3101
            make_commit_message_template_encoded
2991
3102
        )
2992
3103
 
 
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
 
2993
3112
        # TODO: Need a blackbox test for invoking the external editor; may be
2994
3113
        # slightly problematic to run this cross-platform.
2995
3114
 
3015
3134
        if local and not tree.branch.get_bound_location():
3016
3135
            raise errors.LocalRequiresBoundBranch()
3017
3136
 
 
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
 
3018
3158
        def get_message(commit_obj):
3019
3159
            """Callback to get commit message"""
3020
 
            my_message = message
3021
 
            if my_message is None and not file:
3022
 
                t = make_commit_message_template_encoded(tree,
 
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,
3023
3172
                        selected_list, diff=show_diff,
3024
3173
                        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.
3025
3179
                start_message = generate_commit_message_template(commit_obj)
3026
 
                my_message = edit_commit_message_encoded(t,
 
3180
                my_message = edit_commit_message_encoded(text,
3027
3181
                    start_message=start_message)
3028
3182
                if my_message is None:
3029
3183
                    raise errors.BzrCommandError("please specify a commit"
3030
3184
                        " message with either --message or --file")
3031
 
            elif my_message and file:
3032
 
                raise errors.BzrCommandError(
3033
 
                    "please specify either --message or --file")
3034
 
            if file:
3035
 
                my_message = codecs.open(file, 'rt',
3036
 
                                         osutils.get_user_encoding()).read()
3037
3185
            if my_message == "":
3038
3186
                raise errors.BzrCommandError("empty commit message specified")
3039
3187
            return my_message
3047
3195
                        specific_files=selected_list,
3048
3196
                        allow_pointless=unchanged, strict=strict, local=local,
3049
3197
                        reporter=None, verbose=verbose, revprops=properties,
3050
 
                        authors=author,
 
3198
                        authors=author, timestamp=commit_stamp,
 
3199
                        timezone=offset,
3051
3200
                        exclude=safe_relpath_files(tree, exclude))
3052
3201
        except PointlessCommit:
3053
 
            # FIXME: This should really happen before the file is read in;
3054
 
            # perhaps prepare the commit; get the message; then actually commit
3055
3202
            raise errors.BzrCommandError("No changes to commit."
3056
3203
                              " Use --unchanged to commit anyhow.")
3057
3204
        except ConflictsInTree:
3062
3209
            raise errors.BzrCommandError("Commit refused because there are"
3063
3210
                              " unknown files in the working tree.")
3064
3211
        except errors.BoundBranchOutOfDate, e:
3065
 
            raise errors.BzrCommandError(str(e) + "\n"
3066
 
            'To commit to master branch, run update and then commit.\n'
3067
 
            'You can also pass --local to commit to continue working '
3068
 
            'disconnected.')
 
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
3069
3217
 
3070
3218
 
3071
3219
class cmd_check(Command):
3072
 
    """Validate working tree structure, branch consistency and repository history.
 
3220
    __doc__ = """Validate working tree structure, branch consistency and repository history.
3073
3221
 
3074
3222
    This command checks various invariants about branch and repository storage
3075
3223
    to detect data corruption or bzr bugs.
3139
3287
 
3140
3288
 
3141
3289
class cmd_upgrade(Command):
3142
 
    """Upgrade a repository, branch or working tree to a newer format.
 
3290
    __doc__ = """Upgrade a repository, branch or working tree to a newer format.
3143
3291
 
3144
3292
    When the default format has changed after a major new release of
3145
3293
    Bazaar, you may be informed during certain operations that you
3198
3346
 
3199
3347
 
3200
3348
class cmd_whoami(Command):
3201
 
    """Show or set bzr user id.
 
3349
    __doc__ = """Show or set bzr user id.
3202
3350
 
3203
3351
    :Examples:
3204
3352
        Show the email of the current user::
3209
3357
 
3210
3358
            bzr whoami "Frank Chu <fchu@example.com>"
3211
3359
    """
3212
 
    takes_options = [ Option('email',
 
3360
    takes_options = [ 'directory',
 
3361
                      Option('email',
3213
3362
                             help='Display email address only.'),
3214
3363
                      Option('branch',
3215
3364
                             help='Set identity for the current branch instead of '
3219
3368
    encoding_type = 'replace'
3220
3369
 
3221
3370
    @display_command
3222
 
    def run(self, email=False, branch=False, name=None):
 
3371
    def run(self, email=False, branch=False, name=None, directory=None):
3223
3372
        if name is None:
3224
 
            # use branch if we're inside one; otherwise global config
3225
 
            try:
3226
 
                c = Branch.open_containing('.')[0].get_config()
3227
 
            except errors.NotBranchError:
3228
 
                c = config.GlobalConfig()
 
3373
            if directory is None:
 
3374
                # use branch if we're inside one; otherwise global config
 
3375
                try:
 
3376
                    c = Branch.open_containing(u'.')[0].get_config()
 
3377
                except errors.NotBranchError:
 
3378
                    c = config.GlobalConfig()
 
3379
            else:
 
3380
                c = Branch.open(directory).get_config()
3229
3381
            if email:
3230
3382
                self.outf.write(c.user_email() + '\n')
3231
3383
            else:
3241
3393
 
3242
3394
        # use global config unless --branch given
3243
3395
        if branch:
3244
 
            c = Branch.open_containing('.')[0].get_config()
 
3396
            if directory is None:
 
3397
                c = Branch.open_containing(u'.')[0].get_config()
 
3398
            else:
 
3399
                c = Branch.open(directory).get_config()
3245
3400
        else:
3246
3401
            c = config.GlobalConfig()
3247
3402
        c.set_user_option('email', name)
3248
3403
 
3249
3404
 
3250
3405
class cmd_nick(Command):
3251
 
    """Print or set the branch nickname.
 
3406
    __doc__ = """Print or set the branch nickname.
3252
3407
 
3253
3408
    If unset, the tree root directory name is used as the nickname.
3254
3409
    To print the current nickname, execute with no argument.
3259
3414
 
3260
3415
    _see_also = ['info']
3261
3416
    takes_args = ['nickname?']
3262
 
    def run(self, nickname=None):
3263
 
        branch = Branch.open_containing(u'.')[0]
 
3417
    takes_options = ['directory']
 
3418
    def run(self, nickname=None, directory=u'.'):
 
3419
        branch = Branch.open_containing(directory)[0]
3264
3420
        if nickname is None:
3265
3421
            self.printme(branch)
3266
3422
        else:
3268
3424
 
3269
3425
    @display_command
3270
3426
    def printme(self, branch):
3271
 
        print branch.nick
 
3427
        self.outf.write('%s\n' % branch.nick)
3272
3428
 
3273
3429
 
3274
3430
class cmd_alias(Command):
3275
 
    """Set/unset and display aliases.
 
3431
    __doc__ = """Set/unset and display aliases.
3276
3432
 
3277
3433
    :Examples:
3278
3434
        Show the current aliases::
3342
3498
 
3343
3499
 
3344
3500
class cmd_selftest(Command):
3345
 
    """Run internal test suite.
 
3501
    __doc__ = """Run internal test suite.
3346
3502
 
3347
3503
    If arguments are given, they are regular expressions that say which tests
3348
3504
    should run.  Tests matching any expression are run, and other tests are
3375
3531
    Tests that need working space on disk use a common temporary directory,
3376
3532
    typically inside $TMPDIR or /tmp.
3377
3533
 
 
3534
    If you set BZR_TEST_PDB=1 when running selftest, failing tests will drop
 
3535
    into a pdb postmortem session.
 
3536
 
3378
3537
    :Examples:
3379
3538
        Run only tests relating to 'ignore'::
3380
3539
 
3389
3548
    def get_transport_type(typestring):
3390
3549
        """Parse and return a transport specifier."""
3391
3550
        if typestring == "sftp":
3392
 
            from bzrlib.transport.sftp import SFTPAbsoluteServer
3393
 
            return SFTPAbsoluteServer
 
3551
            from bzrlib.tests import stub_sftp
 
3552
            return stub_sftp.SFTPAbsoluteServer
3394
3553
        if typestring == "memory":
3395
 
            from bzrlib.transport.memory import MemoryServer
3396
 
            return MemoryServer
 
3554
            from bzrlib.tests import test_server
 
3555
            return memory.MemoryServer
3397
3556
        if typestring == "fakenfs":
3398
 
            from bzrlib.transport.fakenfs import FakeNFSServer
3399
 
            return FakeNFSServer
 
3557
            from bzrlib.tests import test_server
 
3558
            return test_server.FakeNFSServer
3400
3559
        msg = "No known transport type %s. Supported types are: sftp\n" %\
3401
3560
            (typestring)
3402
3561
        raise errors.BzrCommandError(msg)
3413
3572
                                 'throughout the test suite.',
3414
3573
                            type=get_transport_type),
3415
3574
                     Option('benchmark',
3416
 
                            help='Run the benchmarks rather than selftests.'),
 
3575
                            help='Run the benchmarks rather than selftests.',
 
3576
                            hidden=True),
3417
3577
                     Option('lsprof-timed',
3418
3578
                            help='Generate lsprof output for benchmarked'
3419
3579
                                 ' sections of code.'),
3420
 
                     Option('cache-dir', type=str,
3421
 
                            help='Cache intermediate benchmark output in this '
3422
 
                                 'directory.'),
 
3580
                     Option('lsprof-tests',
 
3581
                            help='Generate lsprof output for each test.'),
3423
3582
                     Option('first',
3424
3583
                            help='Run all tests, but run specified tests first.',
3425
3584
                            short_name='f',
3459
3618
 
3460
3619
    def run(self, testspecs_list=None, verbose=False, one=False,
3461
3620
            transport=None, benchmark=None,
3462
 
            lsprof_timed=None, cache_dir=None,
 
3621
            lsprof_timed=None,
3463
3622
            first=False, list_only=False,
3464
3623
            randomize=None, exclude=None, strict=False,
3465
3624
            load_list=None, debugflag=None, starting_with=None, subunit=False,
3466
 
            parallel=None):
 
3625
            parallel=None, lsprof_tests=False):
3467
3626
        from bzrlib.tests import selftest
3468
 
        import bzrlib.benchmarks as benchmarks
3469
 
        from bzrlib.benchmarks import tree_creator
3470
3627
 
3471
3628
        # Make deprecation warnings visible, unless -Werror is set
3472
3629
        symbol_versioning.activate_deprecation_warnings(override=False)
3473
3630
 
3474
 
        if cache_dir is not None:
3475
 
            tree_creator.TreeCreator.CACHE_ROOT = osutils.abspath(cache_dir)
3476
3631
        if testspecs_list is not None:
3477
3632
            pattern = '|'.join(testspecs_list)
3478
3633
        else:
3484
3639
                raise errors.BzrCommandError("subunit not available. subunit "
3485
3640
                    "needs to be installed to use --subunit.")
3486
3641
            self.additional_selftest_args['runner_class'] = SubUnitBzrRunner
 
3642
            # On Windows, disable automatic conversion of '\n' to '\r\n' in
 
3643
            # stdout, which would corrupt the subunit stream. 
 
3644
            # FIXME: This has been fixed in subunit trunk (>0.0.5) so the
 
3645
            # following code can be deleted when it's sufficiently deployed
 
3646
            # -- vila/mgz 20100514
 
3647
            if (sys.platform == "win32"
 
3648
                and getattr(sys.stdout, 'fileno', None) is not None):
 
3649
                import msvcrt
 
3650
                msvcrt.setmode(sys.stdout.fileno(), os.O_BINARY)
3487
3651
        if parallel:
3488
3652
            self.additional_selftest_args.setdefault(
3489
3653
                'suite_decorators', []).append(parallel)
3490
3654
        if benchmark:
3491
 
            test_suite_factory = benchmarks.test_suite
3492
 
            # Unless user explicitly asks for quiet, be verbose in benchmarks
3493
 
            verbose = not is_quiet()
3494
 
            # TODO: should possibly lock the history file...
3495
 
            benchfile = open(".perf_history", "at", buffering=1)
3496
 
        else:
3497
 
            test_suite_factory = None
3498
 
            benchfile = None
3499
 
        try:
3500
 
            selftest_kwargs = {"verbose": verbose,
3501
 
                              "pattern": pattern,
3502
 
                              "stop_on_failure": one,
3503
 
                              "transport": transport,
3504
 
                              "test_suite_factory": test_suite_factory,
3505
 
                              "lsprof_timed": lsprof_timed,
3506
 
                              "bench_history": benchfile,
3507
 
                              "matching_tests_first": first,
3508
 
                              "list_only": list_only,
3509
 
                              "random_seed": randomize,
3510
 
                              "exclude_pattern": exclude,
3511
 
                              "strict": strict,
3512
 
                              "load_list": load_list,
3513
 
                              "debug_flags": debugflag,
3514
 
                              "starting_with": starting_with
3515
 
                              }
3516
 
            selftest_kwargs.update(self.additional_selftest_args)
3517
 
            result = selftest(**selftest_kwargs)
3518
 
        finally:
3519
 
            if benchfile is not None:
3520
 
                benchfile.close()
 
3655
            raise errors.BzrCommandError(
 
3656
                "--benchmark is no longer supported from bzr 2.2; "
 
3657
                "use bzr-usertest instead")
 
3658
        test_suite_factory = None
 
3659
        selftest_kwargs = {"verbose": verbose,
 
3660
                          "pattern": pattern,
 
3661
                          "stop_on_failure": one,
 
3662
                          "transport": transport,
 
3663
                          "test_suite_factory": test_suite_factory,
 
3664
                          "lsprof_timed": lsprof_timed,
 
3665
                          "lsprof_tests": lsprof_tests,
 
3666
                          "matching_tests_first": first,
 
3667
                          "list_only": list_only,
 
3668
                          "random_seed": randomize,
 
3669
                          "exclude_pattern": exclude,
 
3670
                          "strict": strict,
 
3671
                          "load_list": load_list,
 
3672
                          "debug_flags": debugflag,
 
3673
                          "starting_with": starting_with
 
3674
                          }
 
3675
        selftest_kwargs.update(self.additional_selftest_args)
 
3676
        result = selftest(**selftest_kwargs)
3521
3677
        return int(not result)
3522
3678
 
3523
3679
 
3524
3680
class cmd_version(Command):
3525
 
    """Show version of bzr."""
 
3681
    __doc__ = """Show version of bzr."""
3526
3682
 
3527
3683
    encoding_type = 'replace'
3528
3684
    takes_options = [
3539
3695
 
3540
3696
 
3541
3697
class cmd_rocks(Command):
3542
 
    """Statement of optimism."""
 
3698
    __doc__ = """Statement of optimism."""
3543
3699
 
3544
3700
    hidden = True
3545
3701
 
3546
3702
    @display_command
3547
3703
    def run(self):
3548
 
        print "It sure does!"
 
3704
        self.outf.write("It sure does!\n")
3549
3705
 
3550
3706
 
3551
3707
class cmd_find_merge_base(Command):
3552
 
    """Find and print a base revision for merging two branches."""
 
3708
    __doc__ = """Find and print a base revision for merging two branches."""
3553
3709
    # TODO: Options to specify revisions on either side, as if
3554
3710
    #       merging only part of the history.
3555
3711
    takes_args = ['branch', 'other']
3561
3717
 
3562
3718
        branch1 = Branch.open_containing(branch)[0]
3563
3719
        branch2 = Branch.open_containing(other)[0]
3564
 
        branch1.lock_read()
3565
 
        try:
3566
 
            branch2.lock_read()
3567
 
            try:
3568
 
                last1 = ensure_null(branch1.last_revision())
3569
 
                last2 = ensure_null(branch2.last_revision())
3570
 
 
3571
 
                graph = branch1.repository.get_graph(branch2.repository)
3572
 
                base_rev_id = graph.find_unique_lca(last1, last2)
3573
 
 
3574
 
                print 'merge base is revision %s' % base_rev_id
3575
 
            finally:
3576
 
                branch2.unlock()
3577
 
        finally:
3578
 
            branch1.unlock()
 
3720
        self.add_cleanup(branch1.lock_read().unlock)
 
3721
        self.add_cleanup(branch2.lock_read().unlock)
 
3722
        last1 = ensure_null(branch1.last_revision())
 
3723
        last2 = ensure_null(branch2.last_revision())
 
3724
 
 
3725
        graph = branch1.repository.get_graph(branch2.repository)
 
3726
        base_rev_id = graph.find_unique_lca(last1, last2)
 
3727
 
 
3728
        self.outf.write('merge base is revision %s\n' % base_rev_id)
3579
3729
 
3580
3730
 
3581
3731
class cmd_merge(Command):
3582
 
    """Perform a three-way merge.
 
3732
    __doc__ = """Perform a three-way merge.
3583
3733
 
3584
3734
    The source of the merge can be specified either in the form of a branch,
3585
3735
    or in the form of a path to a file containing a merge directive generated
3614
3764
    committed to record the result of the merge.
3615
3765
 
3616
3766
    merge refuses to run if there are any uncommitted changes, unless
3617
 
    --force is given.
 
3767
    --force is given. The --force option can also be used to create a
 
3768
    merge revision which has more than two parents.
 
3769
 
 
3770
    If one would like to merge changes from the working tree of the other
 
3771
    branch without merging any committed revisions, the --uncommitted option
 
3772
    can be given.
3618
3773
 
3619
3774
    To select only some changes to merge, use "merge -i", which will prompt
3620
3775
    you to apply each diff hunk and file change, similar to "shelve".
3632
3787
 
3633
3788
            bzr merge -r 81..82 ../bzr.dev
3634
3789
 
3635
 
        To apply a merge directive contained in /tmp/merge:
 
3790
        To apply a merge directive contained in /tmp/merge::
3636
3791
 
3637
3792
            bzr merge /tmp/merge
 
3793
 
 
3794
        To create a merge revision with three parents from two branches
 
3795
        feature1a and feature1b:
 
3796
 
 
3797
            bzr merge ../feature1a
 
3798
            bzr merge ../feature1b --force
 
3799
            bzr commit -m 'revision with three parents'
3638
3800
    """
3639
3801
 
3640
3802
    encoding_type = 'exact'
3656
3818
                ' completely merged into the source, pull from the'
3657
3819
                ' source rather than merging.  When this happens,'
3658
3820
                ' you do not need to commit the result.'),
3659
 
        Option('directory',
 
3821
        custom_help('directory',
3660
3822
               help='Branch to merge into, '
3661
 
                    'rather than the one containing the working directory.',
3662
 
               short_name='d',
3663
 
               type=unicode,
3664
 
               ),
 
3823
                    'rather than the one containing the working directory.'),
3665
3824
        Option('preview', help='Instead of merging, show a diff of the'
3666
3825
               ' merge.'),
3667
3826
        Option('interactive', help='Select changes interactively.',
3685
3844
        verified = 'inapplicable'
3686
3845
        tree = WorkingTree.open_containing(directory)[0]
3687
3846
 
3688
 
        # die as quickly as possible if there are uncommitted changes
3689
3847
        try:
3690
3848
            basis_tree = tree.revision_tree(tree.last_revision())
3691
3849
        except errors.NoSuchRevision:
3692
3850
            basis_tree = tree.basis_tree()
 
3851
 
 
3852
        # die as quickly as possible if there are uncommitted changes
3693
3853
        if not force:
3694
 
            if tree.has_changes(basis_tree):
 
3854
            if tree.has_changes():
3695
3855
                raise errors.UncommittedChanges(tree)
3696
3856
 
3697
3857
        view_info = _get_view_info_for_change_reporter(tree)
3698
3858
        change_reporter = delta._ChangeReporter(
3699
3859
            unversioned_filter=tree.is_ignored, view_info=view_info)
3700
 
        cleanups = []
3701
 
        try:
3702
 
            pb = ui.ui_factory.nested_progress_bar()
3703
 
            cleanups.append(pb.finished)
3704
 
            tree.lock_write()
3705
 
            cleanups.append(tree.unlock)
3706
 
            if location is not None:
3707
 
                try:
3708
 
                    mergeable = bundle.read_mergeable_from_url(location,
3709
 
                        possible_transports=possible_transports)
3710
 
                except errors.NotABundle:
3711
 
                    mergeable = None
3712
 
                else:
3713
 
                    if uncommitted:
3714
 
                        raise errors.BzrCommandError('Cannot use --uncommitted'
3715
 
                            ' with bundles or merge directives.')
3716
 
 
3717
 
                    if revision is not None:
3718
 
                        raise errors.BzrCommandError(
3719
 
                            'Cannot use -r with merge directives or bundles')
3720
 
                    merger, verified = _mod_merge.Merger.from_mergeable(tree,
3721
 
                       mergeable, pb)
3722
 
 
3723
 
            if merger is None and uncommitted:
3724
 
                if revision is not None and len(revision) > 0:
3725
 
                    raise errors.BzrCommandError('Cannot use --uncommitted and'
3726
 
                        ' --revision at the same time.')
3727
 
                merger = self.get_merger_from_uncommitted(tree, location, pb,
3728
 
                                                          cleanups)
3729
 
                allow_pending = False
3730
 
 
3731
 
            if merger is None:
3732
 
                merger, allow_pending = self._get_merger_from_branch(tree,
3733
 
                    location, revision, remember, possible_transports, pb)
3734
 
 
3735
 
            merger.merge_type = merge_type
3736
 
            merger.reprocess = reprocess
3737
 
            merger.show_base = show_base
3738
 
            self.sanity_check_merger(merger)
3739
 
            if (merger.base_rev_id == merger.other_rev_id and
3740
 
                merger.other_rev_id is not None):
3741
 
                note('Nothing to do.')
 
3860
        pb = ui.ui_factory.nested_progress_bar()
 
3861
        self.add_cleanup(pb.finished)
 
3862
        self.add_cleanup(tree.lock_write().unlock)
 
3863
        if location is not None:
 
3864
            try:
 
3865
                mergeable = bundle.read_mergeable_from_url(location,
 
3866
                    possible_transports=possible_transports)
 
3867
            except errors.NotABundle:
 
3868
                mergeable = None
 
3869
            else:
 
3870
                if uncommitted:
 
3871
                    raise errors.BzrCommandError('Cannot use --uncommitted'
 
3872
                        ' with bundles or merge directives.')
 
3873
 
 
3874
                if revision is not None:
 
3875
                    raise errors.BzrCommandError(
 
3876
                        'Cannot use -r with merge directives or bundles')
 
3877
                merger, verified = _mod_merge.Merger.from_mergeable(tree,
 
3878
                   mergeable, None)
 
3879
 
 
3880
        if merger is None and uncommitted:
 
3881
            if revision is not None and len(revision) > 0:
 
3882
                raise errors.BzrCommandError('Cannot use --uncommitted and'
 
3883
                    ' --revision at the same time.')
 
3884
            merger = self.get_merger_from_uncommitted(tree, location, None)
 
3885
            allow_pending = False
 
3886
 
 
3887
        if merger is None:
 
3888
            merger, allow_pending = self._get_merger_from_branch(tree,
 
3889
                location, revision, remember, possible_transports, None)
 
3890
 
 
3891
        merger.merge_type = merge_type
 
3892
        merger.reprocess = reprocess
 
3893
        merger.show_base = show_base
 
3894
        self.sanity_check_merger(merger)
 
3895
        if (merger.base_rev_id == merger.other_rev_id and
 
3896
            merger.other_rev_id is not None):
 
3897
            note('Nothing to do.')
 
3898
            return 0
 
3899
        if pull:
 
3900
            if merger.interesting_files is not None:
 
3901
                raise errors.BzrCommandError('Cannot pull individual files')
 
3902
            if (merger.base_rev_id == tree.last_revision()):
 
3903
                result = tree.pull(merger.other_branch, False,
 
3904
                                   merger.other_rev_id)
 
3905
                result.report(self.outf)
3742
3906
                return 0
3743
 
            if pull:
3744
 
                if merger.interesting_files is not None:
3745
 
                    raise errors.BzrCommandError('Cannot pull individual files')
3746
 
                if (merger.base_rev_id == tree.last_revision()):
3747
 
                    result = tree.pull(merger.other_branch, False,
3748
 
                                       merger.other_rev_id)
3749
 
                    result.report(self.outf)
3750
 
                    return 0
3751
 
            merger.check_basis(False)
3752
 
            if preview:
3753
 
                return self._do_preview(merger, cleanups)
3754
 
            elif interactive:
3755
 
                return self._do_interactive(merger, cleanups)
3756
 
            else:
3757
 
                return self._do_merge(merger, change_reporter, allow_pending,
3758
 
                                      verified)
3759
 
        finally:
3760
 
            for cleanup in reversed(cleanups):
3761
 
                cleanup()
 
3907
        if merger.this_basis is None:
 
3908
            raise errors.BzrCommandError(
 
3909
                "This branch has no commits."
 
3910
                " (perhaps you would prefer 'bzr pull')")
 
3911
        if preview:
 
3912
            return self._do_preview(merger)
 
3913
        elif interactive:
 
3914
            return self._do_interactive(merger)
 
3915
        else:
 
3916
            return self._do_merge(merger, change_reporter, allow_pending,
 
3917
                                  verified)
3762
3918
 
3763
 
    def _get_preview(self, merger, cleanups):
 
3919
    def _get_preview(self, merger):
3764
3920
        tree_merger = merger.make_merger()
3765
3921
        tt = tree_merger.make_preview_transform()
3766
 
        cleanups.append(tt.finalize)
 
3922
        self.add_cleanup(tt.finalize)
3767
3923
        result_tree = tt.get_preview_tree()
3768
3924
        return result_tree
3769
3925
 
3770
 
    def _do_preview(self, merger, cleanups):
 
3926
    def _do_preview(self, merger):
3771
3927
        from bzrlib.diff import show_diff_trees
3772
 
        result_tree = self._get_preview(merger, cleanups)
 
3928
        result_tree = self._get_preview(merger)
 
3929
        path_encoding = osutils.get_diff_header_encoding()
3773
3930
        show_diff_trees(merger.this_tree, result_tree, self.outf,
3774
 
                        old_label='', new_label='')
 
3931
                        old_label='', new_label='',
 
3932
                        path_encoding=path_encoding)
3775
3933
 
3776
3934
    def _do_merge(self, merger, change_reporter, allow_pending, verified):
3777
3935
        merger.change_reporter = change_reporter
3785
3943
        else:
3786
3944
            return 0
3787
3945
 
3788
 
    def _do_interactive(self, merger, cleanups):
 
3946
    def _do_interactive(self, merger):
3789
3947
        """Perform an interactive merge.
3790
3948
 
3791
3949
        This works by generating a preview tree of the merge, then using
3793
3951
        and the preview tree.
3794
3952
        """
3795
3953
        from bzrlib import shelf_ui
3796
 
        result_tree = self._get_preview(merger, cleanups)
 
3954
        result_tree = self._get_preview(merger)
3797
3955
        writer = bzrlib.option.diff_writer_registry.get()
3798
3956
        shelver = shelf_ui.Shelver(merger.this_tree, result_tree, destroy=True,
3799
3957
                                   reporter=shelf_ui.ApplyReporter(),
3800
3958
                                   diff_writer=writer(sys.stdout))
3801
 
        shelver.run()
 
3959
        try:
 
3960
            shelver.run()
 
3961
        finally:
 
3962
            shelver.finalize()
3802
3963
 
3803
3964
    def sanity_check_merger(self, merger):
3804
3965
        if (merger.show_base and
3864
4025
            allow_pending = True
3865
4026
        return merger, allow_pending
3866
4027
 
3867
 
    def get_merger_from_uncommitted(self, tree, location, pb, cleanups):
 
4028
    def get_merger_from_uncommitted(self, tree, location, pb):
3868
4029
        """Get a merger for uncommitted changes.
3869
4030
 
3870
4031
        :param tree: The tree the merger should apply to.
3871
4032
        :param location: The location containing uncommitted changes.
3872
4033
        :param pb: The progress bar to use for showing progress.
3873
 
        :param cleanups: A list of operations to perform to clean up the
3874
 
            temporary directories, unfinalized objects, etc.
3875
4034
        """
3876
4035
        location = self._select_branch_location(tree, location)[0]
3877
4036
        other_tree, other_path = WorkingTree.open_containing(location)
3929
4088
 
3930
4089
 
3931
4090
class cmd_remerge(Command):
3932
 
    """Redo a merge.
 
4091
    __doc__ = """Redo a merge.
3933
4092
 
3934
4093
    Use this if you want to try a different merge technique while resolving
3935
4094
    conflicts.  Some merge techniques are better than others, and remerge
3960
4119
 
3961
4120
    def run(self, file_list=None, merge_type=None, show_base=False,
3962
4121
            reprocess=False):
 
4122
        from bzrlib.conflicts import restore
3963
4123
        if merge_type is None:
3964
4124
            merge_type = _mod_merge.Merge3Merger
3965
4125
        tree, file_list = tree_files(file_list)
3966
 
        tree.lock_write()
3967
 
        try:
3968
 
            parents = tree.get_parent_ids()
3969
 
            if len(parents) != 2:
3970
 
                raise errors.BzrCommandError("Sorry, remerge only works after normal"
3971
 
                                             " merges.  Not cherrypicking or"
3972
 
                                             " multi-merges.")
3973
 
            repository = tree.branch.repository
3974
 
            interesting_ids = None
3975
 
            new_conflicts = []
3976
 
            conflicts = tree.conflicts()
3977
 
            if file_list is not None:
3978
 
                interesting_ids = set()
3979
 
                for filename in file_list:
3980
 
                    file_id = tree.path2id(filename)
3981
 
                    if file_id is None:
3982
 
                        raise errors.NotVersionedError(filename)
3983
 
                    interesting_ids.add(file_id)
3984
 
                    if tree.kind(file_id) != "directory":
3985
 
                        continue
 
4126
        self.add_cleanup(tree.lock_write().unlock)
 
4127
        parents = tree.get_parent_ids()
 
4128
        if len(parents) != 2:
 
4129
            raise errors.BzrCommandError("Sorry, remerge only works after normal"
 
4130
                                         " merges.  Not cherrypicking or"
 
4131
                                         " multi-merges.")
 
4132
        repository = tree.branch.repository
 
4133
        interesting_ids = None
 
4134
        new_conflicts = []
 
4135
        conflicts = tree.conflicts()
 
4136
        if file_list is not None:
 
4137
            interesting_ids = set()
 
4138
            for filename in file_list:
 
4139
                file_id = tree.path2id(filename)
 
4140
                if file_id is None:
 
4141
                    raise errors.NotVersionedError(filename)
 
4142
                interesting_ids.add(file_id)
 
4143
                if tree.kind(file_id) != "directory":
 
4144
                    continue
3986
4145
 
3987
 
                    for name, ie in tree.inventory.iter_entries(file_id):
3988
 
                        interesting_ids.add(ie.file_id)
3989
 
                new_conflicts = conflicts.select_conflicts(tree, file_list)[0]
3990
 
            else:
3991
 
                # Remerge only supports resolving contents conflicts
3992
 
                allowed_conflicts = ('text conflict', 'contents conflict')
3993
 
                restore_files = [c.path for c in conflicts
3994
 
                                 if c.typestring in allowed_conflicts]
3995
 
            _mod_merge.transform_tree(tree, tree.basis_tree(), interesting_ids)
3996
 
            tree.set_conflicts(ConflictList(new_conflicts))
3997
 
            if file_list is not None:
3998
 
                restore_files = file_list
3999
 
            for filename in restore_files:
4000
 
                try:
4001
 
                    restore(tree.abspath(filename))
4002
 
                except errors.NotConflicted:
4003
 
                    pass
4004
 
            # Disable pending merges, because the file texts we are remerging
4005
 
            # have not had those merges performed.  If we use the wrong parents
4006
 
            # list, we imply that the working tree text has seen and rejected
4007
 
            # all the changes from the other tree, when in fact those changes
4008
 
            # have not yet been seen.
4009
 
            pb = ui.ui_factory.nested_progress_bar()
4010
 
            tree.set_parent_ids(parents[:1])
 
4146
                for name, ie in tree.inventory.iter_entries(file_id):
 
4147
                    interesting_ids.add(ie.file_id)
 
4148
            new_conflicts = conflicts.select_conflicts(tree, file_list)[0]
 
4149
        else:
 
4150
            # Remerge only supports resolving contents conflicts
 
4151
            allowed_conflicts = ('text conflict', 'contents conflict')
 
4152
            restore_files = [c.path for c in conflicts
 
4153
                             if c.typestring in allowed_conflicts]
 
4154
        _mod_merge.transform_tree(tree, tree.basis_tree(), interesting_ids)
 
4155
        tree.set_conflicts(ConflictList(new_conflicts))
 
4156
        if file_list is not None:
 
4157
            restore_files = file_list
 
4158
        for filename in restore_files:
4011
4159
            try:
4012
 
                merger = _mod_merge.Merger.from_revision_ids(pb,
4013
 
                                                             tree, parents[1])
4014
 
                merger.interesting_ids = interesting_ids
4015
 
                merger.merge_type = merge_type
4016
 
                merger.show_base = show_base
4017
 
                merger.reprocess = reprocess
4018
 
                conflicts = merger.do_merge()
4019
 
            finally:
4020
 
                tree.set_parent_ids(parents)
4021
 
                pb.finished()
 
4160
                restore(tree.abspath(filename))
 
4161
            except errors.NotConflicted:
 
4162
                pass
 
4163
        # Disable pending merges, because the file texts we are remerging
 
4164
        # have not had those merges performed.  If we use the wrong parents
 
4165
        # list, we imply that the working tree text has seen and rejected
 
4166
        # all the changes from the other tree, when in fact those changes
 
4167
        # have not yet been seen.
 
4168
        tree.set_parent_ids(parents[:1])
 
4169
        try:
 
4170
            merger = _mod_merge.Merger.from_revision_ids(None, tree, parents[1])
 
4171
            merger.interesting_ids = interesting_ids
 
4172
            merger.merge_type = merge_type
 
4173
            merger.show_base = show_base
 
4174
            merger.reprocess = reprocess
 
4175
            conflicts = merger.do_merge()
4022
4176
        finally:
4023
 
            tree.unlock()
 
4177
            tree.set_parent_ids(parents)
4024
4178
        if conflicts > 0:
4025
4179
            return 1
4026
4180
        else:
4028
4182
 
4029
4183
 
4030
4184
class cmd_revert(Command):
4031
 
    """Revert files to a previous revision.
 
4185
    __doc__ = """Revert files to a previous revision.
4032
4186
 
4033
4187
    Giving a list of files will revert only those files.  Otherwise, all files
4034
4188
    will be reverted.  If the revision is not specified with '--revision', the
4048
4202
    name.  If you name a directory, all the contents of that directory will be
4049
4203
    reverted.
4050
4204
 
4051
 
    Any files that have been newly added since that revision will be deleted,
4052
 
    with a backup kept if appropriate.  Directories containing unknown files
4053
 
    will not be deleted.
 
4205
    If you have newly added files since the target revision, they will be
 
4206
    removed.  If the files to be removed have been changed, backups will be
 
4207
    created as above.  Directories containing unknown files will not be
 
4208
    deleted.
4054
4209
 
4055
 
    The working tree contains a list of pending merged revisions, which will
4056
 
    be included as parents in the next commit.  Normally, revert clears that
4057
 
    list as well as reverting the files.  If any files are specified, revert
4058
 
    leaves the pending merge list alone and reverts only the files.  Use "bzr
4059
 
    revert ." in the tree root to revert all files but keep the merge record,
4060
 
    and "bzr revert --forget-merges" to clear the pending merge list without
 
4210
    The working tree contains a list of revisions that have been merged but
 
4211
    not yet committed. These revisions will be included as additional parents
 
4212
    of the next commit.  Normally, using revert clears that list as well as
 
4213
    reverting the files.  If any files are specified, revert leaves the list
 
4214
    of uncommitted merges alone and reverts only the files.  Use ``bzr revert
 
4215
    .`` in the tree root to revert all files but keep the recorded merges,
 
4216
    and ``bzr revert --forget-merges`` to clear the pending merge list without
4061
4217
    reverting any files.
 
4218
 
 
4219
    Using "bzr revert --forget-merges", it is possible to apply all of the
 
4220
    changes from a branch in a single revision.  To do this, perform the merge
 
4221
    as desired.  Then doing revert with the "--forget-merges" option will keep
 
4222
    the content of the tree as it was, but it will clear the list of pending
 
4223
    merges.  The next commit will then contain all of the changes that are
 
4224
    present in the other branch, but without any other parent revisions.
 
4225
    Because this technique forgets where these changes originated, it may
 
4226
    cause additional conflicts on later merges involving the same source and
 
4227
    target branches.
4062
4228
    """
4063
4229
 
4064
4230
    _see_also = ['cat', 'export']
4073
4239
    def run(self, revision=None, no_backup=False, file_list=None,
4074
4240
            forget_merges=None):
4075
4241
        tree, file_list = tree_files(file_list)
4076
 
        tree.lock_write()
4077
 
        try:
4078
 
            if forget_merges:
4079
 
                tree.set_parent_ids(tree.get_parent_ids()[:1])
4080
 
            else:
4081
 
                self._revert_tree_to_revision(tree, revision, file_list, no_backup)
4082
 
        finally:
4083
 
            tree.unlock()
 
4242
        self.add_cleanup(tree.lock_tree_write().unlock)
 
4243
        if forget_merges:
 
4244
            tree.set_parent_ids(tree.get_parent_ids()[:1])
 
4245
        else:
 
4246
            self._revert_tree_to_revision(tree, revision, file_list, no_backup)
4084
4247
 
4085
4248
    @staticmethod
4086
4249
    def _revert_tree_to_revision(tree, revision, file_list, no_backup):
4087
4250
        rev_tree = _get_one_revision_tree('revert', revision, tree=tree)
4088
 
        pb = ui.ui_factory.nested_progress_bar()
4089
 
        try:
4090
 
            tree.revert(file_list, rev_tree, not no_backup, pb,
4091
 
                report_changes=True)
4092
 
        finally:
4093
 
            pb.finished()
 
4251
        tree.revert(file_list, rev_tree, not no_backup, None,
 
4252
            report_changes=True)
4094
4253
 
4095
4254
 
4096
4255
class cmd_assert_fail(Command):
4097
 
    """Test reporting of assertion failures"""
 
4256
    __doc__ = """Test reporting of assertion failures"""
4098
4257
    # intended just for use in testing
4099
4258
 
4100
4259
    hidden = True
4104
4263
 
4105
4264
 
4106
4265
class cmd_help(Command):
4107
 
    """Show help on a command or other topic.
 
4266
    __doc__ = """Show help on a command or other topic.
4108
4267
    """
4109
4268
 
4110
4269
    _see_also = ['topics']
4123
4282
 
4124
4283
 
4125
4284
class cmd_shell_complete(Command):
4126
 
    """Show appropriate completions for context.
 
4285
    __doc__ = """Show appropriate completions for context.
4127
4286
 
4128
4287
    For a list of all available commands, say 'bzr shell-complete'.
4129
4288
    """
4138
4297
 
4139
4298
 
4140
4299
class cmd_missing(Command):
4141
 
    """Show unmerged/unpulled revisions between two branches.
 
4300
    __doc__ = """Show unmerged/unpulled revisions between two branches.
4142
4301
 
4143
4302
    OTHER_BRANCH may be local or remote.
4144
4303
 
4145
4304
    To filter on a range of revisions, you can use the command -r begin..end
4146
4305
    -r revision requests a specific revision, -r ..end or -r begin.. are
4147
4306
    also valid.
 
4307
            
 
4308
    :Exit values:
 
4309
        1 - some missing revisions
 
4310
        0 - no missing revisions
4148
4311
 
4149
4312
    :Examples:
4150
4313
 
4171
4334
    _see_also = ['merge', 'pull']
4172
4335
    takes_args = ['other_branch?']
4173
4336
    takes_options = [
 
4337
        'directory',
4174
4338
        Option('reverse', 'Reverse the order of revisions.'),
4175
4339
        Option('mine-only',
4176
4340
               'Display changes in the local branch only.'),
4198
4362
            theirs_only=False,
4199
4363
            log_format=None, long=False, short=False, line=False,
4200
4364
            show_ids=False, verbose=False, this=False, other=False,
4201
 
            include_merges=False, revision=None, my_revision=None):
 
4365
            include_merges=False, revision=None, my_revision=None,
 
4366
            directory=u'.'):
4202
4367
        from bzrlib.missing import find_unmerged, iter_log_revisions
4203
4368
        def message(s):
4204
4369
            if not is_quiet():
4217
4382
        elif theirs_only:
4218
4383
            restrict = 'remote'
4219
4384
 
4220
 
        local_branch = Branch.open_containing(u".")[0]
 
4385
        local_branch = Branch.open_containing(directory)[0]
 
4386
        self.add_cleanup(local_branch.lock_read().unlock)
 
4387
 
4221
4388
        parent = local_branch.get_parent()
4222
4389
        if other_branch is None:
4223
4390
            other_branch = parent
4232
4399
        remote_branch = Branch.open(other_branch)
4233
4400
        if remote_branch.base == local_branch.base:
4234
4401
            remote_branch = local_branch
 
4402
        else:
 
4403
            self.add_cleanup(remote_branch.lock_read().unlock)
4235
4404
 
4236
4405
        local_revid_range = _revision_range_to_revid_range(
4237
4406
            _get_revision_range(my_revision, local_branch,
4241
4410
            _get_revision_range(revision,
4242
4411
                remote_branch, self.name()))
4243
4412
 
4244
 
        local_branch.lock_read()
4245
 
        try:
4246
 
            remote_branch.lock_read()
4247
 
            try:
4248
 
                local_extra, remote_extra = find_unmerged(
4249
 
                    local_branch, remote_branch, restrict,
4250
 
                    backward=not reverse,
4251
 
                    include_merges=include_merges,
4252
 
                    local_revid_range=local_revid_range,
4253
 
                    remote_revid_range=remote_revid_range)
4254
 
 
4255
 
                if log_format is None:
4256
 
                    registry = log.log_formatter_registry
4257
 
                    log_format = registry.get_default(local_branch)
4258
 
                lf = log_format(to_file=self.outf,
4259
 
                                show_ids=show_ids,
4260
 
                                show_timezone='original')
4261
 
 
4262
 
                status_code = 0
4263
 
                if local_extra and not theirs_only:
4264
 
                    message("You have %d extra revision(s):\n" %
4265
 
                        len(local_extra))
4266
 
                    for revision in iter_log_revisions(local_extra,
4267
 
                                        local_branch.repository,
4268
 
                                        verbose):
4269
 
                        lf.log_revision(revision)
4270
 
                    printed_local = True
4271
 
                    status_code = 1
4272
 
                else:
4273
 
                    printed_local = False
4274
 
 
4275
 
                if remote_extra and not mine_only:
4276
 
                    if printed_local is True:
4277
 
                        message("\n\n\n")
4278
 
                    message("You are missing %d revision(s):\n" %
4279
 
                        len(remote_extra))
4280
 
                    for revision in iter_log_revisions(remote_extra,
4281
 
                                        remote_branch.repository,
4282
 
                                        verbose):
4283
 
                        lf.log_revision(revision)
4284
 
                    status_code = 1
4285
 
 
4286
 
                if mine_only and not local_extra:
4287
 
                    # We checked local, and found nothing extra
4288
 
                    message('This branch is up to date.\n')
4289
 
                elif theirs_only and not remote_extra:
4290
 
                    # We checked remote, and found nothing extra
4291
 
                    message('Other branch is up to date.\n')
4292
 
                elif not (mine_only or theirs_only or local_extra or
4293
 
                          remote_extra):
4294
 
                    # We checked both branches, and neither one had extra
4295
 
                    # revisions
4296
 
                    message("Branches are up to date.\n")
4297
 
            finally:
4298
 
                remote_branch.unlock()
4299
 
        finally:
4300
 
            local_branch.unlock()
 
4413
        local_extra, remote_extra = find_unmerged(
 
4414
            local_branch, remote_branch, restrict,
 
4415
            backward=not reverse,
 
4416
            include_merges=include_merges,
 
4417
            local_revid_range=local_revid_range,
 
4418
            remote_revid_range=remote_revid_range)
 
4419
 
 
4420
        if log_format is None:
 
4421
            registry = log.log_formatter_registry
 
4422
            log_format = registry.get_default(local_branch)
 
4423
        lf = log_format(to_file=self.outf,
 
4424
                        show_ids=show_ids,
 
4425
                        show_timezone='original')
 
4426
 
 
4427
        status_code = 0
 
4428
        if local_extra and not theirs_only:
 
4429
            message("You have %d extra revision(s):\n" %
 
4430
                len(local_extra))
 
4431
            for revision in iter_log_revisions(local_extra,
 
4432
                                local_branch.repository,
 
4433
                                verbose):
 
4434
                lf.log_revision(revision)
 
4435
            printed_local = True
 
4436
            status_code = 1
 
4437
        else:
 
4438
            printed_local = False
 
4439
 
 
4440
        if remote_extra and not mine_only:
 
4441
            if printed_local is True:
 
4442
                message("\n\n\n")
 
4443
            message("You are missing %d revision(s):\n" %
 
4444
                len(remote_extra))
 
4445
            for revision in iter_log_revisions(remote_extra,
 
4446
                                remote_branch.repository,
 
4447
                                verbose):
 
4448
                lf.log_revision(revision)
 
4449
            status_code = 1
 
4450
 
 
4451
        if mine_only and not local_extra:
 
4452
            # We checked local, and found nothing extra
 
4453
            message('This branch is up to date.\n')
 
4454
        elif theirs_only and not remote_extra:
 
4455
            # We checked remote, and found nothing extra
 
4456
            message('Other branch is up to date.\n')
 
4457
        elif not (mine_only or theirs_only or local_extra or
 
4458
                  remote_extra):
 
4459
            # We checked both branches, and neither one had extra
 
4460
            # revisions
 
4461
            message("Branches are up to date.\n")
 
4462
        self.cleanup_now()
4301
4463
        if not status_code and parent is None and other_branch is not None:
4302
 
            local_branch.lock_write()
4303
 
            try:
4304
 
                # handle race conditions - a parent might be set while we run.
4305
 
                if local_branch.get_parent() is None:
4306
 
                    local_branch.set_parent(remote_branch.base)
4307
 
            finally:
4308
 
                local_branch.unlock()
 
4464
            self.add_cleanup(local_branch.lock_write().unlock)
 
4465
            # handle race conditions - a parent might be set while we run.
 
4466
            if local_branch.get_parent() is None:
 
4467
                local_branch.set_parent(remote_branch.base)
4309
4468
        return status_code
4310
4469
 
4311
4470
 
4312
4471
class cmd_pack(Command):
4313
 
    """Compress the data within a repository."""
 
4472
    __doc__ = """Compress the data within a repository.
 
4473
 
 
4474
    This operation compresses the data within a bazaar repository. As
 
4475
    bazaar supports automatic packing of repository, this operation is
 
4476
    normally not required to be done manually.
 
4477
 
 
4478
    During the pack operation, bazaar takes a backup of existing repository
 
4479
    data, i.e. pack files. This backup is eventually removed by bazaar
 
4480
    automatically when it is safe to do so. To save disk space by removing
 
4481
    the backed up pack files, the --clean-obsolete-packs option may be
 
4482
    used.
 
4483
 
 
4484
    Warning: If you use --clean-obsolete-packs and your machine crashes
 
4485
    during or immediately after repacking, you may be left with a state
 
4486
    where the deletion has been written to disk but the new packs have not
 
4487
    been. In this case the repository may be unusable.
 
4488
    """
4314
4489
 
4315
4490
    _see_also = ['repositories']
4316
4491
    takes_args = ['branch_or_repo?']
 
4492
    takes_options = [
 
4493
        Option('clean-obsolete-packs', 'Delete obsolete packs to save disk space.'),
 
4494
        ]
4317
4495
 
4318
 
    def run(self, branch_or_repo='.'):
 
4496
    def run(self, branch_or_repo='.', clean_obsolete_packs=False):
4319
4497
        dir = bzrdir.BzrDir.open_containing(branch_or_repo)[0]
4320
4498
        try:
4321
4499
            branch = dir.open_branch()
4322
4500
            repository = branch.repository
4323
4501
        except errors.NotBranchError:
4324
4502
            repository = dir.open_repository()
4325
 
        repository.pack()
 
4503
        repository.pack(clean_obsolete_packs=clean_obsolete_packs)
4326
4504
 
4327
4505
 
4328
4506
class cmd_plugins(Command):
4329
 
    """List the installed plugins.
 
4507
    __doc__ = """List the installed plugins.
4330
4508
 
4331
4509
    This command displays the list of installed plugins including
4332
4510
    version of plugin and a short description of each.
4339
4517
    adding new commands, providing additional network transports and
4340
4518
    customizing log output.
4341
4519
 
4342
 
    See the Bazaar web site, http://bazaar-vcs.org, for further
4343
 
    information on plugins including where to find them and how to
4344
 
    install them. Instructions are also provided there on how to
4345
 
    write new plugins using the Python programming language.
 
4520
    See the Bazaar Plugin Guide <http://doc.bazaar.canonical.com/plugins/en/>
 
4521
    for further information on plugins including where to find them and how to
 
4522
    install them. Instructions are also provided there on how to write new
 
4523
    plugins using the Python programming language.
4346
4524
    """
4347
4525
    takes_options = ['verbose']
4348
4526
 
4363
4541
                doc = '(no description)'
4364
4542
            result.append((name_ver, doc, plugin.path()))
4365
4543
        for name_ver, doc, path in sorted(result):
4366
 
            print name_ver
4367
 
            print '   ', doc
 
4544
            self.outf.write("%s\n" % name_ver)
 
4545
            self.outf.write("   %s\n" % doc)
4368
4546
            if verbose:
4369
 
                print '   ', path
4370
 
            print
 
4547
                self.outf.write("   %s\n" % path)
 
4548
            self.outf.write("\n")
4371
4549
 
4372
4550
 
4373
4551
class cmd_testament(Command):
4374
 
    """Show testament (signing-form) of a revision."""
 
4552
    __doc__ = """Show testament (signing-form) of a revision."""
4375
4553
    takes_options = [
4376
4554
            'revision',
4377
4555
            Option('long', help='Produce long-format testament.'),
4389
4567
            b = Branch.open_containing(branch)[0]
4390
4568
        else:
4391
4569
            b = Branch.open(branch)
4392
 
        b.lock_read()
4393
 
        try:
4394
 
            if revision is None:
4395
 
                rev_id = b.last_revision()
4396
 
            else:
4397
 
                rev_id = revision[0].as_revision_id(b)
4398
 
            t = testament_class.from_revision(b.repository, rev_id)
4399
 
            if long:
4400
 
                sys.stdout.writelines(t.as_text_lines())
4401
 
            else:
4402
 
                sys.stdout.write(t.as_short_text())
4403
 
        finally:
4404
 
            b.unlock()
 
4570
        self.add_cleanup(b.lock_read().unlock)
 
4571
        if revision is None:
 
4572
            rev_id = b.last_revision()
 
4573
        else:
 
4574
            rev_id = revision[0].as_revision_id(b)
 
4575
        t = testament_class.from_revision(b.repository, rev_id)
 
4576
        if long:
 
4577
            sys.stdout.writelines(t.as_text_lines())
 
4578
        else:
 
4579
            sys.stdout.write(t.as_short_text())
4405
4580
 
4406
4581
 
4407
4582
class cmd_annotate(Command):
4408
 
    """Show the origin of each line in a file.
 
4583
    __doc__ = """Show the origin of each line in a file.
4409
4584
 
4410
4585
    This prints out the given file with an annotation on the left side
4411
4586
    indicating which revision, author and date introduced the change.
4422
4597
                     Option('long', help='Show commit date in annotations.'),
4423
4598
                     'revision',
4424
4599
                     'show-ids',
 
4600
                     'directory',
4425
4601
                     ]
4426
4602
    encoding_type = 'exact'
4427
4603
 
4428
4604
    @display_command
4429
4605
    def run(self, filename, all=False, long=False, revision=None,
4430
 
            show_ids=False):
 
4606
            show_ids=False, directory=None):
4431
4607
        from bzrlib.annotate import annotate_file, annotate_file_tree
4432
4608
        wt, branch, relpath = \
4433
 
            bzrdir.BzrDir.open_containing_tree_or_branch(filename)
4434
 
        if wt is not None:
4435
 
            wt.lock_read()
4436
 
        else:
4437
 
            branch.lock_read()
4438
 
        try:
4439
 
            tree = _get_one_revision_tree('annotate', revision, branch=branch)
4440
 
            if wt is not None:
4441
 
                file_id = wt.path2id(relpath)
4442
 
            else:
4443
 
                file_id = tree.path2id(relpath)
4444
 
            if file_id is None:
4445
 
                raise errors.NotVersionedError(filename)
4446
 
            file_version = tree.inventory[file_id].revision
4447
 
            if wt is not None and revision is None:
4448
 
                # If there is a tree and we're not annotating historical
4449
 
                # versions, annotate the working tree's content.
4450
 
                annotate_file_tree(wt, file_id, self.outf, long, all,
4451
 
                    show_ids=show_ids)
4452
 
            else:
4453
 
                annotate_file(branch, file_version, file_id, long, all, self.outf,
4454
 
                              show_ids=show_ids)
4455
 
        finally:
4456
 
            if wt is not None:
4457
 
                wt.unlock()
4458
 
            else:
4459
 
                branch.unlock()
 
4609
            _open_directory_or_containing_tree_or_branch(filename, directory)
 
4610
        if wt is not None:
 
4611
            self.add_cleanup(wt.lock_read().unlock)
 
4612
        else:
 
4613
            self.add_cleanup(branch.lock_read().unlock)
 
4614
        tree = _get_one_revision_tree('annotate', revision, branch=branch)
 
4615
        self.add_cleanup(tree.lock_read().unlock)
 
4616
        if wt is not None:
 
4617
            file_id = wt.path2id(relpath)
 
4618
        else:
 
4619
            file_id = tree.path2id(relpath)
 
4620
        if file_id is None:
 
4621
            raise errors.NotVersionedError(filename)
 
4622
        file_version = tree.inventory[file_id].revision
 
4623
        if wt is not None and revision is None:
 
4624
            # If there is a tree and we're not annotating historical
 
4625
            # versions, annotate the working tree's content.
 
4626
            annotate_file_tree(wt, file_id, self.outf, long, all,
 
4627
                show_ids=show_ids)
 
4628
        else:
 
4629
            annotate_file(branch, file_version, file_id, long, all, self.outf,
 
4630
                          show_ids=show_ids)
4460
4631
 
4461
4632
 
4462
4633
class cmd_re_sign(Command):
4463
 
    """Create a digital signature for an existing revision."""
 
4634
    __doc__ = """Create a digital signature for an existing revision."""
4464
4635
    # TODO be able to replace existing ones.
4465
4636
 
4466
4637
    hidden = True # is this right ?
4467
4638
    takes_args = ['revision_id*']
4468
 
    takes_options = ['revision']
 
4639
    takes_options = ['directory', 'revision']
4469
4640
 
4470
 
    def run(self, revision_id_list=None, revision=None):
 
4641
    def run(self, revision_id_list=None, revision=None, directory=u'.'):
4471
4642
        if revision_id_list is not None and revision is not None:
4472
4643
            raise errors.BzrCommandError('You can only supply one of revision_id or --revision')
4473
4644
        if revision_id_list is None and revision is None:
4474
4645
            raise errors.BzrCommandError('You must supply either --revision or a revision_id')
4475
 
        b = WorkingTree.open_containing(u'.')[0].branch
4476
 
        b.lock_write()
4477
 
        try:
4478
 
            return self._run(b, revision_id_list, revision)
4479
 
        finally:
4480
 
            b.unlock()
 
4646
        b = WorkingTree.open_containing(directory)[0].branch
 
4647
        self.add_cleanup(b.lock_write().unlock)
 
4648
        return self._run(b, revision_id_list, revision)
4481
4649
 
4482
4650
    def _run(self, b, revision_id_list, revision):
4483
4651
        import bzrlib.gpg as gpg
4528
4696
 
4529
4697
 
4530
4698
class cmd_bind(Command):
4531
 
    """Convert the current branch into a checkout of the supplied branch.
 
4699
    __doc__ = """Convert the current branch into a checkout of the supplied branch.
 
4700
    If no branch is supplied, rebind to the last bound location.
4532
4701
 
4533
4702
    Once converted into a checkout, commits must succeed on the master branch
4534
4703
    before they will be applied to the local branch.
4535
4704
 
4536
4705
    Bound branches use the nickname of its master branch unless it is set
4537
 
    locally, in which case binding will update the the local nickname to be
 
4706
    locally, in which case binding will update the local nickname to be
4538
4707
    that of the master.
4539
4708
    """
4540
4709
 
4541
4710
    _see_also = ['checkouts', 'unbind']
4542
4711
    takes_args = ['location?']
4543
 
    takes_options = []
 
4712
    takes_options = ['directory']
4544
4713
 
4545
 
    def run(self, location=None):
4546
 
        b, relpath = Branch.open_containing(u'.')
 
4714
    def run(self, location=None, directory=u'.'):
 
4715
        b, relpath = Branch.open_containing(directory)
4547
4716
        if location is None:
4548
4717
            try:
4549
4718
                location = b.get_old_bound_location()
4552
4721
                    'This format does not remember old locations.')
4553
4722
            else:
4554
4723
                if location is None:
4555
 
                    raise errors.BzrCommandError('No location supplied and no '
4556
 
                        'previous location known')
 
4724
                    if b.get_bound_location() is not None:
 
4725
                        raise errors.BzrCommandError('Branch is already bound')
 
4726
                    else:
 
4727
                        raise errors.BzrCommandError('No location supplied '
 
4728
                            'and no previous location known')
4557
4729
        b_other = Branch.open(location)
4558
4730
        try:
4559
4731
            b.bind(b_other)
4565
4737
 
4566
4738
 
4567
4739
class cmd_unbind(Command):
4568
 
    """Convert the current checkout into a regular branch.
 
4740
    __doc__ = """Convert the current checkout into a regular branch.
4569
4741
 
4570
4742
    After unbinding, the local branch is considered independent and subsequent
4571
4743
    commits will be local only.
4573
4745
 
4574
4746
    _see_also = ['checkouts', 'bind']
4575
4747
    takes_args = []
4576
 
    takes_options = []
 
4748
    takes_options = ['directory']
4577
4749
 
4578
 
    def run(self):
4579
 
        b, relpath = Branch.open_containing(u'.')
 
4750
    def run(self, directory=u'.'):
 
4751
        b, relpath = Branch.open_containing(directory)
4580
4752
        if not b.unbind():
4581
4753
            raise errors.BzrCommandError('Local branch is not bound')
4582
4754
 
4583
4755
 
4584
4756
class cmd_uncommit(Command):
4585
 
    """Remove the last committed revision.
 
4757
    __doc__ = """Remove the last committed revision.
4586
4758
 
4587
4759
    --verbose will print out what is being removed.
4588
4760
    --dry-run will go through all the motions, but not actually
4628
4800
            b = control.open_branch()
4629
4801
 
4630
4802
        if tree is not None:
4631
 
            tree.lock_write()
 
4803
            self.add_cleanup(tree.lock_write().unlock)
4632
4804
        else:
4633
 
            b.lock_write()
4634
 
        try:
4635
 
            return self._run(b, tree, dry_run, verbose, revision, force,
4636
 
                             local=local)
4637
 
        finally:
4638
 
            if tree is not None:
4639
 
                tree.unlock()
4640
 
            else:
4641
 
                b.unlock()
 
4805
            self.add_cleanup(b.lock_write().unlock)
 
4806
        return self._run(b, tree, dry_run, verbose, revision, force, local=local)
4642
4807
 
4643
4808
    def _run(self, b, tree, dry_run, verbose, revision, force, local=False):
4644
4809
        from bzrlib.log import log_formatter, show_log
4676
4841
                 end_revision=last_revno)
4677
4842
 
4678
4843
        if dry_run:
4679
 
            print 'Dry-run, pretending to remove the above revisions.'
4680
 
            if not force:
4681
 
                val = raw_input('Press <enter> to continue')
 
4844
            self.outf.write('Dry-run, pretending to remove'
 
4845
                            ' the above revisions.\n')
4682
4846
        else:
4683
 
            print 'The above revision(s) will be removed.'
4684
 
            if not force:
4685
 
                val = raw_input('Are you sure [y/N]? ')
4686
 
                if val.lower() not in ('y', 'yes'):
4687
 
                    print 'Canceled'
4688
 
                    return 0
 
4847
            self.outf.write('The above revision(s) will be removed.\n')
 
4848
 
 
4849
        if not force:
 
4850
            if not ui.ui_factory.get_boolean('Are you sure'):
 
4851
                self.outf.write('Canceled')
 
4852
                return 0
4689
4853
 
4690
4854
        mutter('Uncommitting from {%s} to {%s}',
4691
4855
               last_rev_id, rev_id)
4692
4856
        uncommit(b, tree=tree, dry_run=dry_run, verbose=verbose,
4693
4857
                 revno=revno, local=local)
4694
 
        note('You can restore the old tip by running:\n'
4695
 
             '  bzr pull . -r revid:%s', last_rev_id)
 
4858
        self.outf.write('You can restore the old tip by running:\n'
 
4859
             '  bzr pull . -r revid:%s\n' % last_rev_id)
4696
4860
 
4697
4861
 
4698
4862
class cmd_break_lock(Command):
4699
 
    """Break a dead lock on a repository, branch or working directory.
 
4863
    __doc__ = """Break a dead lock on a repository, branch or working directory.
4700
4864
 
4701
4865
    CAUTION: Locks should only be broken when you are sure that the process
4702
4866
    holding the lock has been stopped.
4703
4867
 
4704
 
    You can get information on what locks are open via the 'bzr info' command.
 
4868
    You can get information on what locks are open via the 'bzr info
 
4869
    [location]' command.
4705
4870
 
4706
4871
    :Examples:
4707
4872
        bzr break-lock
 
4873
        bzr break-lock bzr+ssh://example.com/bzr/foo
4708
4874
    """
4709
4875
    takes_args = ['location?']
4710
4876
 
4719
4885
 
4720
4886
 
4721
4887
class cmd_wait_until_signalled(Command):
4722
 
    """Test helper for test_start_and_stop_bzr_subprocess_send_signal.
 
4888
    __doc__ = """Test helper for test_start_and_stop_bzr_subprocess_send_signal.
4723
4889
 
4724
4890
    This just prints a line to signal when it is ready, then blocks on stdin.
4725
4891
    """
4733
4899
 
4734
4900
 
4735
4901
class cmd_serve(Command):
4736
 
    """Run the bzr server."""
 
4902
    __doc__ = """Run the bzr server."""
4737
4903
 
4738
4904
    aliases = ['server']
4739
4905
 
4740
4906
    takes_options = [
4741
4907
        Option('inet',
4742
4908
               help='Serve on stdin/out for use from inetd or sshd.'),
4743
 
        RegistryOption('protocol', 
4744
 
               help="Protocol to serve.", 
 
4909
        RegistryOption('protocol',
 
4910
               help="Protocol to serve.",
4745
4911
               lazy_registry=('bzrlib.transport', 'transport_server_registry'),
4746
4912
               value_switches=True),
4747
4913
        Option('port',
4750
4916
                    'result in a dynamically allocated port.  The default port '
4751
4917
                    'depends on the protocol.',
4752
4918
               type=str),
4753
 
        Option('directory',
4754
 
               help='Serve contents of this directory.',
4755
 
               type=unicode),
 
4919
        custom_help('directory',
 
4920
               help='Serve contents of this directory.'),
4756
4921
        Option('allow-writes',
4757
4922
               help='By default the server is a readonly server.  Supplying '
4758
4923
                    '--allow-writes enables write access to the contents of '
4759
 
                    'the served directory and below.'
 
4924
                    'the served directory and below.  Note that ``bzr serve`` '
 
4925
                    'does not perform authentication, so unless some form of '
 
4926
                    'external authentication is arranged supplying this '
 
4927
                    'option leads to global uncontrolled write access to your '
 
4928
                    'file system.'
4760
4929
                ),
4761
4930
        ]
4762
4931
 
4781
4950
 
4782
4951
    def run(self, port=None, inet=False, directory=None, allow_writes=False,
4783
4952
            protocol=None):
4784
 
        from bzrlib.transport import get_transport, transport_server_registry
 
4953
        from bzrlib import transport
4785
4954
        if directory is None:
4786
4955
            directory = os.getcwd()
4787
4956
        if protocol is None:
4788
 
            protocol = transport_server_registry.get()
 
4957
            protocol = transport.transport_server_registry.get()
4789
4958
        host, port = self.get_host_and_port(port)
4790
4959
        url = urlutils.local_path_to_url(directory)
4791
4960
        if not allow_writes:
4792
4961
            url = 'readonly+' + url
4793
 
        transport = get_transport(url)
4794
 
        protocol(transport, host, port, inet)
 
4962
        t = transport.get_transport(url)
 
4963
        protocol(t, host, port, inet)
4795
4964
 
4796
4965
 
4797
4966
class cmd_join(Command):
4798
 
    """Combine a tree into its containing tree.
 
4967
    __doc__ = """Combine a tree into its containing tree.
4799
4968
 
4800
4969
    This command requires the target tree to be in a rich-root format.
4801
4970
 
4841
5010
 
4842
5011
 
4843
5012
class cmd_split(Command):
4844
 
    """Split a subdirectory of a tree into a separate tree.
 
5013
    __doc__ = """Split a subdirectory of a tree into a separate tree.
4845
5014
 
4846
5015
    This command will produce a target tree in a format that supports
4847
5016
    rich roots, like 'rich-root' or 'rich-root-pack'.  These formats cannot be
4867
5036
 
4868
5037
 
4869
5038
class cmd_merge_directive(Command):
4870
 
    """Generate a merge directive for auto-merge tools.
 
5039
    __doc__ = """Generate a merge directive for auto-merge tools.
4871
5040
 
4872
5041
    A directive requests a merge to be performed, and also provides all the
4873
5042
    information necessary to do so.  This means it must either include a
4890
5059
    _see_also = ['send']
4891
5060
 
4892
5061
    takes_options = [
 
5062
        'directory',
4893
5063
        RegistryOption.from_kwargs('patch-type',
4894
5064
            'The type of patch to include in the directive.',
4895
5065
            title='Patch type',
4908
5078
    encoding_type = 'exact'
4909
5079
 
4910
5080
    def run(self, submit_branch=None, public_branch=None, patch_type='bundle',
4911
 
            sign=False, revision=None, mail_to=None, message=None):
 
5081
            sign=False, revision=None, mail_to=None, message=None,
 
5082
            directory=u'.'):
4912
5083
        from bzrlib.revision import ensure_null, NULL_REVISION
4913
5084
        include_patch, include_bundle = {
4914
5085
            'plain': (False, False),
4915
5086
            'diff': (True, False),
4916
5087
            'bundle': (True, True),
4917
5088
            }[patch_type]
4918
 
        branch = Branch.open('.')
 
5089
        branch = Branch.open(directory)
4919
5090
        stored_submit_branch = branch.get_submit_branch()
4920
5091
        if submit_branch is None:
4921
5092
            submit_branch = stored_submit_branch
4966
5137
 
4967
5138
 
4968
5139
class cmd_send(Command):
4969
 
    """Mail or create a merge-directive for submitting changes.
 
5140
    __doc__ = """Mail or create a merge-directive for submitting changes.
4970
5141
 
4971
5142
    A merge directive provides many things needed for requesting merges:
4972
5143
 
4978
5149
      directly from the merge directive, without retrieving data from a
4979
5150
      branch.
4980
5151
 
4981
 
    If --no-bundle is specified, then public_branch is needed (and must be
4982
 
    up-to-date), so that the receiver can perform the merge using the
4983
 
    public_branch.  The public_branch is always included if known, so that
4984
 
    people can check it later.
4985
 
 
4986
 
    The submit branch defaults to the parent, but can be overridden.  Both
4987
 
    submit branch and public branch will be remembered if supplied.
4988
 
 
4989
 
    If a public_branch is known for the submit_branch, that public submit
4990
 
    branch is used in the merge instructions.  This means that a local mirror
4991
 
    can be used as your actual submit branch, once you have set public_branch
4992
 
    for that mirror.
 
5152
    `bzr send` creates a compact data set that, when applied using bzr
 
5153
    merge, has the same effect as merging from the source branch.  
 
5154
    
 
5155
    By default the merge directive is self-contained and can be applied to any
 
5156
    branch containing submit_branch in its ancestory without needing access to
 
5157
    the source branch.
 
5158
    
 
5159
    If --no-bundle is specified, then Bazaar doesn't send the contents of the
 
5160
    revisions, but only a structured request to merge from the
 
5161
    public_location.  In that case the public_branch is needed and it must be
 
5162
    up-to-date and accessible to the recipient.  The public_branch is always
 
5163
    included if known, so that people can check it later.
 
5164
 
 
5165
    The submit branch defaults to the parent of the source branch, but can be
 
5166
    overridden.  Both submit branch and public branch will be remembered in
 
5167
    branch.conf the first time they are used for a particular branch.  The
 
5168
    source branch defaults to that containing the working directory, but can
 
5169
    be changed using --from.
 
5170
 
 
5171
    In order to calculate those changes, bzr must analyse the submit branch.
 
5172
    Therefore it is most efficient for the submit branch to be a local mirror.
 
5173
    If a public location is known for the submit_branch, that location is used
 
5174
    in the merge directive.
 
5175
 
 
5176
    The default behaviour is to send the merge directive by mail, unless -o is
 
5177
    given, in which case it is sent to a file.
4993
5178
 
4994
5179
    Mail is sent using your preferred mail program.  This should be transparent
4995
 
    on Windows (it uses MAPI).  On Linux, it requires the xdg-email utility.
 
5180
    on Windows (it uses MAPI).  On Unix, it requires the xdg-email utility.
4996
5181
    If the preferred client can't be found (or used), your editor will be used.
4997
5182
 
4998
5183
    To use a specific mail program, set the mail_client configuration option.
4999
5184
    (For Thunderbird 1.5, this works around some bugs.)  Supported values for
5000
 
    specific clients are "claws", "evolution", "kmail", "mutt", and
5001
 
    "thunderbird"; generic options are "default", "editor", "emacsclient",
5002
 
    "mapi", and "xdg-email".  Plugins may also add supported clients.
 
5185
    specific clients are "claws", "evolution", "kmail", "mail.app" (MacOS X's
 
5186
    Mail.app), "mutt", and "thunderbird"; generic options are "default",
 
5187
    "editor", "emacsclient", "mapi", and "xdg-email".  Plugins may also add
 
5188
    supported clients.
5003
5189
 
5004
5190
    If mail is being sent, a to address is required.  This can be supplied
5005
5191
    either on the commandline, by setting the submit_to configuration
5014
5200
 
5015
5201
    The merge directives created by bzr send may be applied using bzr merge or
5016
5202
    bzr pull by specifying a file containing a merge directive as the location.
 
5203
 
 
5204
    bzr send makes extensive use of public locations to map local locations into
 
5205
    URLs that can be used by other people.  See `bzr help configuration` to
 
5206
    set them, and use `bzr info` to display them.
5017
5207
    """
5018
5208
 
5019
5209
    encoding_type = 'exact'
5035
5225
               short_name='f',
5036
5226
               type=unicode),
5037
5227
        Option('output', short_name='o',
5038
 
               help='Write merge directive to this file; '
 
5228
               help='Write merge directive to this file or directory; '
5039
5229
                    'use - for stdout.',
5040
5230
               type=unicode),
5041
5231
        Option('strict',
5064
5254
 
5065
5255
 
5066
5256
class cmd_bundle_revisions(cmd_send):
5067
 
    """Create a merge-directive for submitting changes.
 
5257
    __doc__ = """Create a merge-directive for submitting changes.
5068
5258
 
5069
5259
    A merge directive provides many things needed for requesting merges:
5070
5260
 
5137
5327
 
5138
5328
 
5139
5329
class cmd_tag(Command):
5140
 
    """Create, remove or modify a tag naming a revision.
 
5330
    __doc__ = """Create, remove or modify a tag naming a revision.
5141
5331
 
5142
5332
    Tags give human-meaningful names to revisions.  Commands that take a -r
5143
5333
    (--revision) option can be given -rtag:X, where X is any previously
5151
5341
 
5152
5342
    To rename a tag (change the name but keep it on the same revsion), run ``bzr
5153
5343
    tag new-name -r tag:old-name`` and then ``bzr tag --delete oldname``.
 
5344
 
 
5345
    If no tag name is specified it will be determined through the 
 
5346
    'automatic_tag_name' hook. This can e.g. be used to automatically tag
 
5347
    upstream releases by reading configure.ac. See ``bzr help hooks`` for
 
5348
    details.
5154
5349
    """
5155
5350
 
5156
5351
    _see_also = ['commit', 'tags']
5157
 
    takes_args = ['tag_name']
 
5352
    takes_args = ['tag_name?']
5158
5353
    takes_options = [
5159
5354
        Option('delete',
5160
5355
            help='Delete this tag rather than placing it.',
5161
5356
            ),
5162
 
        Option('directory',
5163
 
            help='Branch in which to place the tag.',
5164
 
            short_name='d',
5165
 
            type=unicode,
5166
 
            ),
 
5357
        custom_help('directory',
 
5358
            help='Branch in which to place the tag.'),
5167
5359
        Option('force',
5168
5360
            help='Replace existing tags.',
5169
5361
            ),
5170
5362
        'revision',
5171
5363
        ]
5172
5364
 
5173
 
    def run(self, tag_name,
 
5365
    def run(self, tag_name=None,
5174
5366
            delete=None,
5175
5367
            directory='.',
5176
5368
            force=None,
5177
5369
            revision=None,
5178
5370
            ):
5179
5371
        branch, relpath = Branch.open_containing(directory)
5180
 
        branch.lock_write()
5181
 
        try:
5182
 
            if delete:
5183
 
                branch.tags.delete_tag(tag_name)
5184
 
                self.outf.write('Deleted tag %s.\n' % tag_name)
 
5372
        self.add_cleanup(branch.lock_write().unlock)
 
5373
        if delete:
 
5374
            if tag_name is None:
 
5375
                raise errors.BzrCommandError("No tag specified to delete.")
 
5376
            branch.tags.delete_tag(tag_name)
 
5377
            self.outf.write('Deleted tag %s.\n' % tag_name)
 
5378
        else:
 
5379
            if revision:
 
5380
                if len(revision) != 1:
 
5381
                    raise errors.BzrCommandError(
 
5382
                        "Tags can only be placed on a single revision, "
 
5383
                        "not on a range")
 
5384
                revision_id = revision[0].as_revision_id(branch)
5185
5385
            else:
5186
 
                if revision:
5187
 
                    if len(revision) != 1:
5188
 
                        raise errors.BzrCommandError(
5189
 
                            "Tags can only be placed on a single revision, "
5190
 
                            "not on a range")
5191
 
                    revision_id = revision[0].as_revision_id(branch)
5192
 
                else:
5193
 
                    revision_id = branch.last_revision()
5194
 
                if (not force) and branch.tags.has_tag(tag_name):
5195
 
                    raise errors.TagAlreadyExists(tag_name)
5196
 
                branch.tags.set_tag(tag_name, revision_id)
5197
 
                self.outf.write('Created tag %s.\n' % tag_name)
5198
 
        finally:
5199
 
            branch.unlock()
 
5386
                revision_id = branch.last_revision()
 
5387
            if tag_name is None:
 
5388
                tag_name = branch.automatic_tag_name(revision_id)
 
5389
                if tag_name is None:
 
5390
                    raise errors.BzrCommandError(
 
5391
                        "Please specify a tag name.")
 
5392
            if (not force) and branch.tags.has_tag(tag_name):
 
5393
                raise errors.TagAlreadyExists(tag_name)
 
5394
            branch.tags.set_tag(tag_name, revision_id)
 
5395
            self.outf.write('Created tag %s.\n' % tag_name)
5200
5396
 
5201
5397
 
5202
5398
class cmd_tags(Command):
5203
 
    """List tags.
 
5399
    __doc__ = """List tags.
5204
5400
 
5205
5401
    This command shows a table of tag names and the revisions they reference.
5206
5402
    """
5207
5403
 
5208
5404
    _see_also = ['tag']
5209
5405
    takes_options = [
5210
 
        Option('directory',
5211
 
            help='Branch whose tags should be displayed.',
5212
 
            short_name='d',
5213
 
            type=unicode,
5214
 
            ),
 
5406
        custom_help('directory',
 
5407
            help='Branch whose tags should be displayed.'),
5215
5408
        RegistryOption.from_kwargs('sort',
5216
5409
            'Sort tags by different criteria.', title='Sorting',
5217
5410
            alpha='Sort tags lexicographically (default).',
5234
5427
        if not tags:
5235
5428
            return
5236
5429
 
5237
 
        branch.lock_read()
5238
 
        try:
5239
 
            if revision:
5240
 
                graph = branch.repository.get_graph()
5241
 
                rev1, rev2 = _get_revision_range(revision, branch, self.name())
5242
 
                revid1, revid2 = rev1.rev_id, rev2.rev_id
5243
 
                # only show revisions between revid1 and revid2 (inclusive)
5244
 
                tags = [(tag, revid) for tag, revid in tags if
5245
 
                    graph.is_between(revid, revid1, revid2)]
5246
 
            if sort == 'alpha':
5247
 
                tags.sort()
5248
 
            elif sort == 'time':
5249
 
                timestamps = {}
5250
 
                for tag, revid in tags:
5251
 
                    try:
5252
 
                        revobj = branch.repository.get_revision(revid)
5253
 
                    except errors.NoSuchRevision:
5254
 
                        timestamp = sys.maxint # place them at the end
5255
 
                    else:
5256
 
                        timestamp = revobj.timestamp
5257
 
                    timestamps[revid] = timestamp
5258
 
                tags.sort(key=lambda x: timestamps[x[1]])
5259
 
            if not show_ids:
5260
 
                # [ (tag, revid), ... ] -> [ (tag, dotted_revno), ... ]
5261
 
                for index, (tag, revid) in enumerate(tags):
5262
 
                    try:
5263
 
                        revno = branch.revision_id_to_dotted_revno(revid)
5264
 
                        if isinstance(revno, tuple):
5265
 
                            revno = '.'.join(map(str, revno))
5266
 
                    except errors.NoSuchRevision:
5267
 
                        # Bad tag data/merges can lead to tagged revisions
5268
 
                        # which are not in this branch. Fail gracefully ...
5269
 
                        revno = '?'
5270
 
                    tags[index] = (tag, revno)
5271
 
        finally:
5272
 
            branch.unlock()
 
5430
        self.add_cleanup(branch.lock_read().unlock)
 
5431
        if revision:
 
5432
            graph = branch.repository.get_graph()
 
5433
            rev1, rev2 = _get_revision_range(revision, branch, self.name())
 
5434
            revid1, revid2 = rev1.rev_id, rev2.rev_id
 
5435
            # only show revisions between revid1 and revid2 (inclusive)
 
5436
            tags = [(tag, revid) for tag, revid in tags if
 
5437
                graph.is_between(revid, revid1, revid2)]
 
5438
        if sort == 'alpha':
 
5439
            tags.sort()
 
5440
        elif sort == 'time':
 
5441
            timestamps = {}
 
5442
            for tag, revid in tags:
 
5443
                try:
 
5444
                    revobj = branch.repository.get_revision(revid)
 
5445
                except errors.NoSuchRevision:
 
5446
                    timestamp = sys.maxint # place them at the end
 
5447
                else:
 
5448
                    timestamp = revobj.timestamp
 
5449
                timestamps[revid] = timestamp
 
5450
            tags.sort(key=lambda x: timestamps[x[1]])
 
5451
        if not show_ids:
 
5452
            # [ (tag, revid), ... ] -> [ (tag, dotted_revno), ... ]
 
5453
            for index, (tag, revid) in enumerate(tags):
 
5454
                try:
 
5455
                    revno = branch.revision_id_to_dotted_revno(revid)
 
5456
                    if isinstance(revno, tuple):
 
5457
                        revno = '.'.join(map(str, revno))
 
5458
                except errors.NoSuchRevision:
 
5459
                    # Bad tag data/merges can lead to tagged revisions
 
5460
                    # which are not in this branch. Fail gracefully ...
 
5461
                    revno = '?'
 
5462
                tags[index] = (tag, revno)
 
5463
        self.cleanup_now()
5273
5464
        for tag, revspec in tags:
5274
5465
            self.outf.write('%-20s %s\n' % (tag, revspec))
5275
5466
 
5276
5467
 
5277
5468
class cmd_reconfigure(Command):
5278
 
    """Reconfigure the type of a bzr directory.
 
5469
    __doc__ = """Reconfigure the type of a bzr directory.
5279
5470
 
5280
5471
    A target configuration must be specified.
5281
5472
 
5366
5557
 
5367
5558
 
5368
5559
class cmd_switch(Command):
5369
 
    """Set the branch of a checkout and update.
 
5560
    __doc__ = """Set the branch of a checkout and update.
5370
5561
 
5371
5562
    For lightweight checkouts, this changes the branch being referenced.
5372
5563
    For heavyweight checkouts, this checks that there are no local commits
5384
5575
    /path/to/newbranch.
5385
5576
 
5386
5577
    Bound branches use the nickname of its master branch unless it is set
5387
 
    locally, in which case switching will update the the local nickname to be
 
5578
    locally, in which case switching will update the local nickname to be
5388
5579
    that of the master.
5389
5580
    """
5390
5581
 
5391
 
    takes_args = ['to_location']
5392
 
    takes_options = [Option('force',
 
5582
    takes_args = ['to_location?']
 
5583
    takes_options = ['directory',
 
5584
                     Option('force',
5393
5585
                        help='Switch even if local commits will be lost.'),
 
5586
                     'revision',
5394
5587
                     Option('create-branch', short_name='b',
5395
5588
                        help='Create the target branch from this one before'
5396
5589
                             ' switching to it.'),
5397
 
                     ]
 
5590
                    ]
5398
5591
 
5399
 
    def run(self, to_location, force=False, create_branch=False):
 
5592
    def run(self, to_location=None, force=False, create_branch=False,
 
5593
            revision=None, directory=u'.'):
5400
5594
        from bzrlib import switch
5401
 
        tree_location = '.'
 
5595
        tree_location = directory
 
5596
        revision = _get_one_revision('switch', revision)
5402
5597
        control_dir = bzrdir.BzrDir.open_containing(tree_location)[0]
 
5598
        if to_location is None:
 
5599
            if revision is None:
 
5600
                raise errors.BzrCommandError('You must supply either a'
 
5601
                                             ' revision or a location')
 
5602
            to_location = tree_location
5403
5603
        try:
5404
5604
            branch = control_dir.open_branch()
5405
5605
            had_explicit_nick = branch.get_config().has_explicit_nickname()
5410
5610
            if branch is None:
5411
5611
                raise errors.BzrCommandError('cannot create branch without'
5412
5612
                                             ' source branch')
 
5613
            to_location = directory_service.directories.dereference(
 
5614
                              to_location)
5413
5615
            if '/' not in to_location and '\\' not in to_location:
5414
5616
                # This path is meant to be relative to the existing branch
5415
5617
                this_url = self._get_branch_location(control_dir)
5417
5619
            to_branch = branch.bzrdir.sprout(to_location,
5418
5620
                                 possible_transports=[branch.bzrdir.root_transport],
5419
5621
                                 source_branch=branch).open_branch()
5420
 
            # try:
5421
 
            #     from_branch = control_dir.open_branch()
5422
 
            # except errors.NotBranchError:
5423
 
            #     raise BzrCommandError('Cannot create a branch from this'
5424
 
            #         ' location when we cannot open this branch')
5425
 
            # from_branch.bzrdir.sprout(
5426
 
            pass
5427
5622
        else:
5428
5623
            try:
5429
5624
                to_branch = Branch.open(to_location)
5431
5626
                this_url = self._get_branch_location(control_dir)
5432
5627
                to_branch = Branch.open(
5433
5628
                    urlutils.join(this_url, '..', to_location))
5434
 
        switch.switch(control_dir, to_branch, force)
 
5629
        if revision is not None:
 
5630
            revision = revision.as_revision_id(to_branch)
 
5631
        switch.switch(control_dir, to_branch, force, revision_id=revision)
5435
5632
        if had_explicit_nick:
5436
5633
            branch = control_dir.open_branch() #get the new branch!
5437
5634
            branch.nick = to_branch.nick
5457
5654
 
5458
5655
 
5459
5656
class cmd_view(Command):
5460
 
    """Manage filtered views.
 
5657
    __doc__ = """Manage filtered views.
5461
5658
 
5462
5659
    Views provide a mask over the tree so that users can focus on
5463
5660
    a subset of a tree when doing their work. After creating a view,
5611
5808
 
5612
5809
 
5613
5810
class cmd_hooks(Command):
5614
 
    """Show hooks."""
 
5811
    __doc__ = """Show hooks."""
5615
5812
 
5616
5813
    hidden = True
5617
5814
 
5630
5827
                    self.outf.write("    <no hooks installed>\n")
5631
5828
 
5632
5829
 
 
5830
class cmd_remove_branch(Command):
 
5831
    __doc__ = """Remove a branch.
 
5832
 
 
5833
    This will remove the branch from the specified location but 
 
5834
    will keep any working tree or repository in place.
 
5835
 
 
5836
    :Examples:
 
5837
 
 
5838
      Remove the branch at repo/trunk::
 
5839
 
 
5840
        bzr remove-branch repo/trunk
 
5841
 
 
5842
    """
 
5843
 
 
5844
    takes_args = ["location?"]
 
5845
 
 
5846
    aliases = ["rmbranch"]
 
5847
 
 
5848
    def run(self, location=None):
 
5849
        if location is None:
 
5850
            location = "."
 
5851
        branch = Branch.open_containing(location)[0]
 
5852
        branch.bzrdir.destroy_branch()
 
5853
        
 
5854
 
5633
5855
class cmd_shelve(Command):
5634
 
    """Temporarily set aside some changes from the current tree.
 
5856
    __doc__ = """Temporarily set aside some changes from the current tree.
5635
5857
 
5636
5858
    Shelve allows you to temporarily put changes you've made "on the shelf",
5637
5859
    ie. out of the way, until a later time when you can bring them back from
5658
5880
    takes_args = ['file*']
5659
5881
 
5660
5882
    takes_options = [
 
5883
        'directory',
5661
5884
        'revision',
5662
5885
        Option('all', help='Shelve all changes.'),
5663
5886
        'message',
5672
5895
    _see_also = ['unshelve']
5673
5896
 
5674
5897
    def run(self, revision=None, all=False, file_list=None, message=None,
5675
 
            writer=None, list=False, destroy=False):
 
5898
            writer=None, list=False, destroy=False, directory=u'.'):
5676
5899
        if list:
5677
5900
            return self.run_for_list()
5678
5901
        from bzrlib.shelf_ui import Shelver
5680
5903
            writer = bzrlib.option.diff_writer_registry.get()
5681
5904
        try:
5682
5905
            shelver = Shelver.from_args(writer(sys.stdout), revision, all,
5683
 
                file_list, message, destroy=destroy)
 
5906
                file_list, message, destroy=destroy, directory=directory)
5684
5907
            try:
5685
5908
                shelver.run()
5686
5909
            finally:
5687
 
                shelver.work_tree.unlock()
 
5910
                shelver.finalize()
5688
5911
        except errors.UserAbort:
5689
5912
            return 0
5690
5913
 
5691
5914
    def run_for_list(self):
5692
5915
        tree = WorkingTree.open_containing('.')[0]
5693
 
        tree.lock_read()
5694
 
        try:
5695
 
            manager = tree.get_shelf_manager()
5696
 
            shelves = manager.active_shelves()
5697
 
            if len(shelves) == 0:
5698
 
                note('No shelved changes.')
5699
 
                return 0
5700
 
            for shelf_id in reversed(shelves):
5701
 
                message = manager.get_metadata(shelf_id).get('message')
5702
 
                if message is None:
5703
 
                    message = '<no message>'
5704
 
                self.outf.write('%3d: %s\n' % (shelf_id, message))
5705
 
            return 1
5706
 
        finally:
5707
 
            tree.unlock()
 
5916
        self.add_cleanup(tree.lock_read().unlock)
 
5917
        manager = tree.get_shelf_manager()
 
5918
        shelves = manager.active_shelves()
 
5919
        if len(shelves) == 0:
 
5920
            note('No shelved changes.')
 
5921
            return 0
 
5922
        for shelf_id in reversed(shelves):
 
5923
            message = manager.get_metadata(shelf_id).get('message')
 
5924
            if message is None:
 
5925
                message = '<no message>'
 
5926
            self.outf.write('%3d: %s\n' % (shelf_id, message))
 
5927
        return 1
5708
5928
 
5709
5929
 
5710
5930
class cmd_unshelve(Command):
5711
 
    """Restore shelved changes.
 
5931
    __doc__ = """Restore shelved changes.
5712
5932
 
5713
5933
    By default, the most recently shelved changes are restored. However if you
5714
5934
    specify a shelf by id those changes will be restored instead.  This works
5717
5937
 
5718
5938
    takes_args = ['shelf_id?']
5719
5939
    takes_options = [
 
5940
        'directory',
5720
5941
        RegistryOption.from_kwargs(
5721
5942
            'action', help="The action to perform.",
5722
5943
            enum_switch=False, value_switches=True,
5723
5944
            apply="Apply changes and remove from the shelf.",
5724
5945
            dry_run="Show changes, but do not apply or remove them.",
5725
 
            delete_only="Delete changes without applying them."
 
5946
            preview="Instead of unshelving the changes, show the diff that "
 
5947
                    "would result from unshelving.",
 
5948
            delete_only="Delete changes without applying them.",
 
5949
            keep="Apply changes but don't delete them.",
5726
5950
        )
5727
5951
    ]
5728
5952
    _see_also = ['shelve']
5729
5953
 
5730
 
    def run(self, shelf_id=None, action='apply'):
 
5954
    def run(self, shelf_id=None, action='apply', directory=u'.'):
5731
5955
        from bzrlib.shelf_ui import Unshelver
5732
 
        unshelver = Unshelver.from_args(shelf_id, action)
 
5956
        unshelver = Unshelver.from_args(shelf_id, action, directory=directory)
5733
5957
        try:
5734
5958
            unshelver.run()
5735
5959
        finally:
5737
5961
 
5738
5962
 
5739
5963
class cmd_clean_tree(Command):
5740
 
    """Remove unwanted files from working tree.
 
5964
    __doc__ = """Remove unwanted files from working tree.
5741
5965
 
5742
5966
    By default, only unknown files, not ignored files, are deleted.  Versioned
5743
5967
    files are never deleted.
5751
5975
 
5752
5976
    To check what clean-tree will do, use --dry-run.
5753
5977
    """
5754
 
    takes_options = [Option('ignored', help='Delete all ignored files.'),
 
5978
    takes_options = ['directory',
 
5979
                     Option('ignored', help='Delete all ignored files.'),
5755
5980
                     Option('detritus', help='Delete conflict files, merge'
5756
5981
                            ' backups, and failed selftest dirs.'),
5757
5982
                     Option('unknown',
5760
5985
                            ' deleting them.'),
5761
5986
                     Option('force', help='Do not prompt before deleting.')]
5762
5987
    def run(self, unknown=False, ignored=False, detritus=False, dry_run=False,
5763
 
            force=False):
 
5988
            force=False, directory=u'.'):
5764
5989
        from bzrlib.clean_tree import clean_tree
5765
5990
        if not (unknown or ignored or detritus):
5766
5991
            unknown = True
5767
5992
        if dry_run:
5768
5993
            force = True
5769
 
        clean_tree('.', unknown=unknown, ignored=ignored, detritus=detritus,
5770
 
                   dry_run=dry_run, no_prompt=force)
 
5994
        clean_tree(directory, unknown=unknown, ignored=ignored,
 
5995
                   detritus=detritus, dry_run=dry_run, no_prompt=force)
5771
5996
 
5772
5997
 
5773
5998
class cmd_reference(Command):
5774
 
    """list, view and set branch locations for nested trees.
 
5999
    __doc__ = """list, view and set branch locations for nested trees.
5775
6000
 
5776
6001
    If no arguments are provided, lists the branch locations for nested trees.
5777
6002
    If one argument is provided, display the branch location for that tree.
5817
6042
            self.outf.write('%s %s\n' % (path, location))
5818
6043
 
5819
6044
 
5820
 
# these get imported and then picked up by the scan for cmd_*
5821
 
# TODO: Some more consistent way to split command definitions across files;
5822
 
# we do need to load at least some information about them to know of
5823
 
# aliases.  ideally we would avoid loading the implementation until the
5824
 
# details were needed.
5825
 
from bzrlib.cmd_version_info import cmd_version_info
5826
 
from bzrlib.conflicts import cmd_resolve, cmd_conflicts, restore
5827
 
from bzrlib.bundle.commands import (
5828
 
    cmd_bundle_info,
5829
 
    )
5830
 
from bzrlib.foreign import cmd_dpush
5831
 
from bzrlib.sign_my_commits import cmd_sign_my_commits
5832
 
from bzrlib.weave_commands import cmd_versionedfile_list, \
5833
 
        cmd_weave_plan_merge, cmd_weave_merge_text
 
6045
def _register_lazy_builtins():
 
6046
    # register lazy builtins from other modules; called at startup and should
 
6047
    # be only called once.
 
6048
    for (name, aliases, module_name) in [
 
6049
        ('cmd_bundle_info', [], 'bzrlib.bundle.commands'),
 
6050
        ('cmd_dpush', [], 'bzrlib.foreign'),
 
6051
        ('cmd_version_info', [], 'bzrlib.cmd_version_info'),
 
6052
        ('cmd_resolve', ['resolved'], 'bzrlib.conflicts'),
 
6053
        ('cmd_conflicts', [], 'bzrlib.conflicts'),
 
6054
        ('cmd_sign_my_commits', [], 'bzrlib.sign_my_commits'),
 
6055
        ]:
 
6056
        builtin_command_registry.register_lazy(name, aliases, module_name)