← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/builtins.py

  • Committer: Canonical.com Patch Queue Manager
  • Date: 2010-07-16 20:52:54 UTC
  • mfrom: (5193.5.9 cleanup)
  • Revision ID: pqm@pqm.ubuntu.com-20100716205254-j0m65wckb90rj54w
(vila) Cleanup some bogus rest constructs in the doc. (Vincent Ladeuil)

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,
120
128
 
121
129
 
122
130
def _get_one_revision_tree(command_name, revisions, branch=None, tree=None):
 
131
    """Get a revision tree. Not suitable for commands that change the tree.
 
132
    
 
133
    Specifically, the basis tree in dirstate trees is coupled to the dirstate
 
134
    and doing a commit/uncommit/pull will at best fail due to changing the
 
135
    basis revision data.
 
136
 
 
137
    If tree is passed in, it should be already locked, for lifetime management
 
138
    of the trees internal cached state.
 
139
    """
123
140
    if branch is None:
124
141
        branch = tree.branch
125
142
    if revisions is None:
215
232
    return view_info
216
233
 
217
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
 
218
243
# TODO: Make sure no commands unconditionally use the working directory as a
219
244
# branch.  If a filename argument is used, the first of them should be used to
220
245
# specify the branch.  (Perhaps this can be factored out into some kind of
222
247
# opens the branch?)
223
248
 
224
249
class cmd_status(Command):
225
 
    """Display status summary.
 
250
    __doc__ = """Display status summary.
226
251
 
227
252
    This reports on versioned and unknown files, reporting them
228
253
    grouped by state.  Possible states are:
248
273
    unknown
249
274
        Not versioned and not matching an ignore pattern.
250
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
 
251
280
    To see ignored files use 'bzr ignored'.  For details on the
252
281
    changes to file texts, use 'bzr diff'.
253
282
 
311
340
 
312
341
 
313
342
class cmd_cat_revision(Command):
314
 
    """Write out metadata for a revision.
 
343
    __doc__ = """Write out metadata for a revision.
315
344
 
316
345
    The revision to print can either be specified by a specific
317
346
    revision identifier, or you can use --revision.
319
348
 
320
349
    hidden = True
321
350
    takes_args = ['revision_id?']
322
 
    takes_options = ['revision']
 
351
    takes_options = ['directory', 'revision']
323
352
    # cat-revision is more for frontends so should be exact
324
353
    encoding = 'strict'
325
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
 
326
363
    @display_command
327
 
    def run(self, revision_id=None, revision=None):
 
364
    def run(self, revision_id=None, revision=None, directory=u'.'):
328
365
        if revision_id is not None and revision is not None:
329
366
            raise errors.BzrCommandError('You can only supply one of'
330
367
                                         ' revision_id or --revision')
331
368
        if revision_id is None and revision is None:
332
369
            raise errors.BzrCommandError('You must supply either'
333
370
                                         ' --revision or a revision_id')
334
 
        b = WorkingTree.open_containing(u'.')[0].branch
335
 
 
336
 
        # TODO: jam 20060112 should cat-revision always output utf-8?
337
 
        if revision_id is not None:
338
 
            revision_id = osutils.safe_revision_id(revision_id, warn=False)
339
 
            try:
340
 
                self.outf.write(b.repository.get_revision_xml(revision_id).decode('utf-8'))
341
 
            except errors.NoSuchRevision:
342
 
                msg = "The repository %s contains no revision %s." % (b.repository.base,
343
 
                    revision_id)
344
 
                raise errors.BzrCommandError(msg)
345
 
        elif revision is not None:
346
 
            for rev in revision:
347
 
                if rev is None:
348
 
                    raise errors.BzrCommandError('You cannot specify a NULL'
349
 
                                                 ' revision.')
350
 
                rev_id = rev.as_revision_id(b)
351
 
                self.outf.write(b.repository.get_revision_xml(rev_id).decode('utf-8'))
352
 
 
 
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
        
353
399
 
354
400
class cmd_dump_btree(Command):
355
 
    """Dump the contents of a btree index file to stdout.
 
401
    __doc__ = """Dump the contents of a btree index file to stdout.
356
402
 
357
403
    PATH is a btree index file, it can be any URL. This includes things like
358
404
    .bzr/repository/pack-names, or .bzr/repository/indices/a34b3a...ca4a4.iix
422
468
        for node in bt.iter_all_entries():
423
469
            # Node is made up of:
424
470
            # (index, key, value, [references])
425
 
            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,))
426
479
 
427
480
 
428
481
class cmd_remove_tree(Command):
429
 
    """Remove the working tree from a given branch/checkout.
 
482
    __doc__ = """Remove the working tree from a given branch/checkout.
430
483
 
431
484
    Since a lightweight checkout is little more than a working tree
432
485
    this will refuse to run against one.
434
487
    To re-create the working tree, use "bzr checkout".
435
488
    """
436
489
    _see_also = ['checkout', 'working-trees']
437
 
    takes_args = ['location?']
 
490
    takes_args = ['location*']
438
491
    takes_options = [
439
492
        Option('force',
440
493
               help='Remove the working tree even if it has '
441
 
                    'uncommitted changes.'),
 
494
                    'uncommitted or shelved changes.'),
442
495
        ]
443
496
 
444
 
    def run(self, location='.', force=False):
445
 
        d = bzrdir.BzrDir.open(location)
446
 
 
447
 
        try:
448
 
            working = d.open_workingtree()
449
 
        except errors.NoWorkingTree:
450
 
            raise errors.BzrCommandError("No working tree to remove")
451
 
        except errors.NotLocalUrl:
452
 
            raise errors.BzrCommandError("You cannot remove the working tree"
453
 
                                         " of a remote path")
454
 
        if not force:
455
 
            # XXX: What about pending merges ? -- vila 20090629
456
 
            if working.has_changes(working.basis_tree()):
457
 
                raise errors.UncommittedChanges(working)
458
 
 
459
 
        working_path = working.bzrdir.root_transport.base
460
 
        branch_path = working.branch.bzrdir.root_transport.base
461
 
        if working_path != branch_path:
462
 
            raise errors.BzrCommandError("You cannot remove the working tree"
463
 
                                         " from a lightweight checkout")
464
 
 
465
 
        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()
466
522
 
467
523
 
468
524
class cmd_revno(Command):
469
 
    """Show current revision number.
 
525
    __doc__ = """Show current revision number.
470
526
 
471
527
    This is equal to the number of revisions on this branch.
472
528
    """
482
538
        if tree:
483
539
            try:
484
540
                wt = WorkingTree.open_containing(location)[0]
485
 
                wt.lock_read()
 
541
                self.add_cleanup(wt.lock_read().unlock)
486
542
            except (errors.NoWorkingTree, errors.NotLocalUrl):
487
543
                raise errors.NoWorkingTree(location)
 
544
            revid = wt.last_revision()
488
545
            try:
489
 
                revid = wt.last_revision()
490
 
                try:
491
 
                    revno_t = wt.branch.revision_id_to_dotted_revno(revid)
492
 
                except errors.NoSuchRevision:
493
 
                    revno_t = ('???',)
494
 
                revno = ".".join(str(n) for n in revno_t)
495
 
            finally:
496
 
                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)
497
550
        else:
498
551
            b = Branch.open_containing(location)[0]
499
 
            b.lock_read()
500
 
            try:
501
 
                revno = b.revno()
502
 
            finally:
503
 
                b.unlock()
504
 
 
 
552
            self.add_cleanup(b.lock_read().unlock)
 
553
            revno = b.revno()
 
554
        self.cleanup_now()
505
555
        self.outf.write(str(revno) + '\n')
506
556
 
507
557
 
508
558
class cmd_revision_info(Command):
509
 
    """Show revision number and revision id for a given revision identifier.
 
559
    __doc__ = """Show revision number and revision id for a given revision identifier.
510
560
    """
511
561
    hidden = True
512
562
    takes_args = ['revision_info*']
513
563
    takes_options = [
514
564
        'revision',
515
 
        Option('directory',
 
565
        custom_help('directory',
516
566
            help='Branch to examine, '
517
 
                 'rather than the one containing the working directory.',
518
 
            short_name='d',
519
 
            type=unicode,
520
 
            ),
 
567
                 'rather than the one containing the working directory.'),
521
568
        Option('tree', help='Show revno of working tree'),
522
569
        ]
523
570
 
528
575
        try:
529
576
            wt = WorkingTree.open_containing(directory)[0]
530
577
            b = wt.branch
531
 
            wt.lock_read()
 
578
            self.add_cleanup(wt.lock_read().unlock)
532
579
        except (errors.NoWorkingTree, errors.NotLocalUrl):
533
580
            wt = None
534
581
            b = Branch.open_containing(directory)[0]
535
 
            b.lock_read()
536
 
        try:
537
 
            revision_ids = []
538
 
            if revision is not None:
539
 
                revision_ids.extend(rev.as_revision_id(b) for rev in revision)
540
 
            if revision_info_list is not None:
541
 
                for rev_str in revision_info_list:
542
 
                    rev_spec = RevisionSpec.from_string(rev_str)
543
 
                    revision_ids.append(rev_spec.as_revision_id(b))
544
 
            # No arguments supplied, default to the last revision
545
 
            if len(revision_ids) == 0:
546
 
                if tree:
547
 
                    if wt is None:
548
 
                        raise errors.NoWorkingTree(directory)
549
 
                    revision_ids.append(wt.last_revision())
550
 
                else:
551
 
                    revision_ids.append(b.last_revision())
552
 
 
553
 
            revinfos = []
554
 
            maxlen = 0
555
 
            for revision_id in revision_ids:
556
 
                try:
557
 
                    dotted_revno = b.revision_id_to_dotted_revno(revision_id)
558
 
                    revno = '.'.join(str(i) for i in dotted_revno)
559
 
                except errors.NoSuchRevision:
560
 
                    revno = '???'
561
 
                maxlen = max(maxlen, len(revno))
562
 
                revinfos.append([revno, revision_id])
563
 
        finally:
564
 
            if wt is None:
565
 
                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())
566
596
            else:
567
 
                wt.unlock()
568
 
 
 
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()
569
611
        for ri in revinfos:
570
612
            self.outf.write('%*s %s\n' % (maxlen, ri[0], ri[1]))
571
613
 
572
614
 
573
615
class cmd_add(Command):
574
 
    """Add specified files or directories.
 
616
    __doc__ = """Add specified files or directories.
575
617
 
576
618
    In non-recursive mode, all the named items are added, regardless
577
619
    of whether they were previously ignored.  A warning is given if
603
645
    branches that will be merged later (without showing the two different
604
646
    adds as a conflict). It is also useful when merging another project
605
647
    into a subdirectory of this one.
 
648
    
 
649
    Any files matching patterns in the ignore list will not be added
 
650
    unless they are explicitly mentioned.
606
651
    """
607
652
    takes_args = ['file*']
608
653
    takes_options = [
616
661
               help='Lookup file ids from this tree.'),
617
662
        ]
618
663
    encoding_type = 'replace'
619
 
    _see_also = ['remove']
 
664
    _see_also = ['remove', 'ignore']
620
665
 
621
666
    def run(self, file_list, no_recurse=False, dry_run=False, verbose=False,
622
667
            file_ids_from=None):
639
684
                should_print=(not is_quiet()))
640
685
 
641
686
        if base_tree:
642
 
            base_tree.lock_read()
643
 
        try:
644
 
            file_list = self._maybe_expand_globs(file_list)
645
 
            tree, file_list = tree_files_for_add(file_list)
646
 
            added, ignored = tree.smart_add(file_list, not
647
 
                no_recurse, action=action, save=not dry_run)
648
 
        finally:
649
 
            if base_tree is not None:
650
 
                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()
651
692
        if len(ignored) > 0:
652
693
            if verbose:
653
694
                for glob in sorted(ignored.keys()):
654
695
                    for path in ignored[glob]:
655
696
                        self.outf.write("ignored %s matching \"%s\"\n"
656
697
                                        % (path, glob))
657
 
            else:
658
 
                match_len = 0
659
 
                for glob, paths in ignored.items():
660
 
                    match_len += len(paths)
661
 
                self.outf.write("ignored %d file(s).\n" % match_len)
662
 
            self.outf.write("If you wish to add ignored files, "
663
 
                            "please add them explicitly by name. "
664
 
                            "(\"bzr ignored\" gives a list)\n")
665
698
 
666
699
 
667
700
class cmd_mkdir(Command):
668
 
    """Create a new versioned directory.
 
701
    __doc__ = """Create a new versioned directory.
669
702
 
670
703
    This is equivalent to creating the directory and then adding it.
671
704
    """
675
708
 
676
709
    def run(self, dir_list):
677
710
        for d in dir_list:
678
 
            os.mkdir(d)
679
711
            wt, dd = WorkingTree.open_containing(d)
680
 
            wt.add([dd])
681
 
            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)
682
720
 
683
721
 
684
722
class cmd_relpath(Command):
685
 
    """Show path of a file relative to root"""
 
723
    __doc__ = """Show path of a file relative to root"""
686
724
 
687
725
    takes_args = ['filename']
688
726
    hidden = True
697
735
 
698
736
 
699
737
class cmd_inventory(Command):
700
 
    """Show inventory of the current working copy or a revision.
 
738
    __doc__ = """Show inventory of the current working copy or a revision.
701
739
 
702
740
    It is possible to limit the output to a particular entry
703
741
    type using the --kind option.  For example: --kind file.
724
762
 
725
763
        revision = _get_one_revision('inventory', revision)
726
764
        work_tree, file_list = tree_files(file_list)
727
 
        work_tree.lock_read()
728
 
        try:
729
 
            if revision is not None:
730
 
                tree = revision.as_tree(work_tree.branch)
731
 
 
732
 
                extra_trees = [work_tree]
733
 
                tree.lock_read()
734
 
            else:
735
 
                tree = work_tree
736
 
                extra_trees = []
737
 
 
738
 
            if file_list is not None:
739
 
                file_ids = tree.paths2ids(file_list, trees=extra_trees,
740
 
                                          require_versioned=True)
741
 
                # find_ids_across_trees may include some paths that don't
742
 
                # exist in 'tree'.
743
 
                entries = sorted((tree.id2path(file_id), tree.inventory[file_id])
744
 
                                 for file_id in file_ids if file_id in tree)
745
 
            else:
746
 
                entries = tree.inventory.entries()
747
 
        finally:
748
 
            tree.unlock()
749
 
            if tree is not work_tree:
750
 
                work_tree.unlock()
751
 
 
 
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()
752
786
        for path, entry in entries:
753
787
            if kind and kind != entry.kind:
754
788
                continue
760
794
 
761
795
 
762
796
class cmd_mv(Command):
763
 
    """Move or rename a file.
 
797
    __doc__ = """Move or rename a file.
764
798
 
765
799
    :Usage:
766
800
        bzr mv OLDNAME NEWNAME
799
833
        if len(names_list) < 2:
800
834
            raise errors.BzrCommandError("missing file argument")
801
835
        tree, rel_names = tree_files(names_list, canonicalize=False)
802
 
        tree.lock_tree_write()
803
 
        try:
804
 
            self._run(tree, names_list, rel_names, after)
805
 
        finally:
806
 
            tree.unlock()
 
836
        self.add_cleanup(tree.lock_tree_write().unlock)
 
837
        self._run(tree, names_list, rel_names, after)
807
838
 
808
839
    def run_auto(self, names_list, after, dry_run):
809
840
        if names_list is not None and len(names_list) > 1:
813
844
            raise errors.BzrCommandError('--after cannot be specified with'
814
845
                                         ' --auto.')
815
846
        work_tree, file_list = tree_files(names_list, default_branch='.')
816
 
        work_tree.lock_tree_write()
817
 
        try:
818
 
            rename_map.RenameMap.guess_renames(work_tree, dry_run)
819
 
        finally:
820
 
            work_tree.unlock()
 
847
        self.add_cleanup(work_tree.lock_tree_write().unlock)
 
848
        rename_map.RenameMap.guess_renames(work_tree, dry_run)
821
849
 
822
850
    def _run(self, tree, names_list, rel_names, after):
823
851
        into_existing = osutils.isdir(names_list[-1])
844
872
            # All entries reference existing inventory items, so fix them up
845
873
            # for cicp file-systems.
846
874
            rel_names = tree.get_canonical_inventory_paths(rel_names)
847
 
            for pair in tree.move(rel_names[:-1], rel_names[-1], after=after):
848
 
                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))
849
878
        else:
850
879
            if len(names_list) != 2:
851
880
                raise errors.BzrCommandError('to mv multiple files the'
895
924
            dest = osutils.pathjoin(dest_parent, dest_tail)
896
925
            mutter("attempting to move %s => %s", src, dest)
897
926
            tree.rename_one(src, dest, after=after)
898
 
            self.outf.write("%s => %s\n" % (src, dest))
 
927
            if not is_quiet():
 
928
                self.outf.write("%s => %s\n" % (src, dest))
899
929
 
900
930
 
901
931
class cmd_pull(Command):
902
 
    """Turn this branch into a mirror of another branch.
 
932
    __doc__ = """Turn this branch into a mirror of another branch.
903
933
 
904
 
    This command only works on branches that have not diverged.  Branches are
905
 
    considered diverged if the destination branch's most recent commit is one
906
 
    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.
907
938
 
908
939
    If branches have diverged, you can use 'bzr merge' to integrate the changes
909
940
    from one into the other.  Once one branch has merged, the other should
910
941
    be able to pull it again.
911
942
 
912
 
    If you want to forget your local changes and just update your branch to
913
 
    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.
914
946
 
915
947
    If there is no default location set, the first pull will set it.  After
916
948
    that, you can omit the location to use the default.  To change the
926
958
    takes_options = ['remember', 'overwrite', 'revision',
927
959
        custom_help('verbose',
928
960
            help='Show logs of pulled revisions.'),
929
 
        Option('directory',
 
961
        custom_help('directory',
930
962
            help='Branch to pull into, '
931
 
                 'rather than the one containing the working directory.',
932
 
            short_name='d',
933
 
            type=unicode,
934
 
            ),
 
963
                 'rather than the one containing the working directory.'),
935
964
        Option('local',
936
965
            help="Perform a local pull in a bound "
937
966
                 "branch.  Local pulls are not applied to "
952
981
        try:
953
982
            tree_to = WorkingTree.open_containing(directory)[0]
954
983
            branch_to = tree_to.branch
 
984
            self.add_cleanup(tree_to.lock_write().unlock)
955
985
        except errors.NoWorkingTree:
956
986
            tree_to = None
957
987
            branch_to = Branch.open_containing(directory)[0]
958
 
        
 
988
            self.add_cleanup(branch_to.lock_write().unlock)
 
989
 
959
990
        if local and not branch_to.get_bound_location():
960
991
            raise errors.LocalRequiresBoundBranch()
961
992
 
991
1022
        else:
992
1023
            branch_from = Branch.open(location,
993
1024
                possible_transports=possible_transports)
 
1025
            self.add_cleanup(branch_from.lock_read().unlock)
994
1026
 
995
1027
            if branch_to.get_parent() is None or remember:
996
1028
                branch_to.set_parent(branch_from.base)
997
1029
 
998
 
        if branch_from is not branch_to:
999
 
            branch_from.lock_read()
1000
 
        try:
1001
 
            if revision is not None:
1002
 
                revision_id = revision.as_revision_id(branch_from)
1003
 
 
1004
 
            branch_to.lock_write()
1005
 
            try:
1006
 
                if tree_to is not None:
1007
 
                    view_info = _get_view_info_for_change_reporter(tree_to)
1008
 
                    change_reporter = delta._ChangeReporter(
1009
 
                        unversioned_filter=tree_to.is_ignored,
1010
 
                        view_info=view_info)
1011
 
                    result = tree_to.pull(
1012
 
                        branch_from, overwrite, revision_id, change_reporter,
1013
 
                        possible_transports=possible_transports, local=local)
1014
 
                else:
1015
 
                    result = branch_to.pull(
1016
 
                        branch_from, overwrite, revision_id, local=local)
1017
 
 
1018
 
                result.report(self.outf)
1019
 
                if verbose and result.old_revid != result.new_revid:
1020
 
                    log.show_branch_change(
1021
 
                        branch_to, self.outf, result.old_revno,
1022
 
                        result.old_revid)
1023
 
            finally:
1024
 
                branch_to.unlock()
1025
 
        finally:
1026
 
            if branch_from is not branch_to:
1027
 
                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)
1028
1050
 
1029
1051
 
1030
1052
class cmd_push(Command):
1031
 
    """Update a mirror of this branch.
 
1053
    __doc__ = """Update a mirror of this branch.
1032
1054
 
1033
1055
    The target branch will not have its working tree populated because this
1034
1056
    is both expensive, and is not supported on remote file systems.
1058
1080
        Option('create-prefix',
1059
1081
               help='Create the path leading up to the branch '
1060
1082
                    'if it does not already exist.'),
1061
 
        Option('directory',
 
1083
        custom_help('directory',
1062
1084
            help='Branch to push from, '
1063
 
                 'rather than the one containing the working directory.',
1064
 
            short_name='d',
1065
 
            type=unicode,
1066
 
            ),
 
1085
                 'rather than the one containing the working directory.'),
1067
1086
        Option('use-existing-dir',
1068
1087
               help='By default push will fail if the target'
1069
1088
                    ' directory exists, but does not already'
1095
1114
        # Get the source branch
1096
1115
        (tree, br_from,
1097
1116
         _unused) = bzrdir.BzrDir.open_containing_tree_or_branch(directory)
1098
 
        if strict is None:
1099
 
            strict = br_from.get_config().get_user_option_as_bool('push_strict')
1100
 
        if strict is None: strict = True # default value
1101
1117
        # Get the tip's revision_id
1102
1118
        revision = _get_one_revision('push', revision)
1103
1119
        if revision is not None:
1104
1120
            revision_id = revision.in_history(br_from).rev_id
1105
1121
        else:
1106
1122
            revision_id = None
1107
 
        if strict and tree is not None and revision_id is None:
1108
 
            if (tree.has_changes(tree.basis_tree())
1109
 
                or len(tree.get_parent_ids()) > 1):
1110
 
                raise errors.UncommittedChanges(
1111
 
                    tree, more='Use --no-strict to force the push.')
1112
 
            if tree.last_revision() != tree.branch.last_revision():
1113
 
                # The tree has lost sync with its branch, there is little
1114
 
                # chance that the user is aware of it but he can still force
1115
 
                # the push with --no-strict
1116
 
                raise errors.OutOfDateTree(
1117
 
                    tree, more='Use --no-strict to force the push.')
1118
 
 
 
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.')
1119
1128
        # Get the stacked_on branch, if any
1120
1129
        if stacked_on is not None:
1121
1130
            stacked_on = urlutils.normalize_url(stacked_on)
1153
1162
 
1154
1163
 
1155
1164
class cmd_branch(Command):
1156
 
    """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.
1157
1166
 
1158
1167
    If the TO_LOCATION is omitted, the last component of the FROM_LOCATION will
1159
1168
    be used.  In other words, "branch ../foo/bar" will attempt to create ./bar.
1172
1181
        help='Hard-link working tree files where possible.'),
1173
1182
        Option('no-tree',
1174
1183
            help="Create a branch without a working-tree."),
 
1184
        Option('switch',
 
1185
            help="Switch the checkout in the current directory "
 
1186
                 "to the new branch."),
1175
1187
        Option('stacked',
1176
1188
            help='Create a stacked branch referring to the source branch. '
1177
1189
                'The new branch will depend on the availability of the source '
1183
1195
                    ' directory exists, but does not already'
1184
1196
                    ' have a control directory.  This flag will'
1185
1197
                    ' allow branch to proceed.'),
 
1198
        Option('bind',
 
1199
            help="Bind new branch to from location."),
1186
1200
        ]
1187
1201
    aliases = ['get', 'clone']
1188
1202
 
1189
1203
    def run(self, from_location, to_location=None, revision=None,
1190
1204
            hardlink=False, stacked=False, standalone=False, no_tree=False,
1191
 
            use_existing_dir=False):
 
1205
            use_existing_dir=False, switch=False, bind=False):
 
1206
        from bzrlib import switch as _mod_switch
1192
1207
        from bzrlib.tag import _merge_tags_if_possible
1193
 
 
1194
1208
        accelerator_tree, br_from = bzrdir.BzrDir.open_tree_or_branch(
1195
1209
            from_location)
1196
 
        if (accelerator_tree is not None and
1197
 
            accelerator_tree.supports_content_filtering()):
1198
 
            accelerator_tree = None
1199
1210
        revision = _get_one_revision('branch', revision)
1200
 
        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)
1201
1222
        try:
1202
 
            if revision is not None:
1203
 
                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)
1204
1228
            else:
1205
 
                # FIXME - wt.last_revision, fallback to branch, fall back to
1206
 
                # None or perhaps NULL_REVISION to mean copy nothing
1207
 
                # RBC 20060209
1208
 
                revision_id = br_from.last_revision()
1209
 
            if to_location is None:
1210
 
                to_location = urlutils.derive_to_location(from_location)
1211
 
            to_transport = transport.get_transport(to_location)
1212
 
            try:
1213
 
                to_transport.mkdir('.')
1214
 
            except errors.FileExists:
1215
 
                if not use_existing_dir:
1216
 
                    raise errors.BzrCommandError('Target directory "%s" '
1217
 
                        'already exists.' % to_location)
 
1229
                try:
 
1230
                    bzrdir.BzrDir.open_from_transport(to_transport)
 
1231
                except errors.NotBranchError:
 
1232
                    pass
1218
1233
                else:
1219
 
                    try:
1220
 
                        bzrdir.BzrDir.open_from_transport(to_transport)
1221
 
                    except errors.NotBranchError:
1222
 
                        pass
1223
 
                    else:
1224
 
                        raise errors.AlreadyBranchError(to_location)
1225
 
            except errors.NoSuchFile:
1226
 
                raise errors.BzrCommandError('Parent of "%s" does not exist.'
1227
 
                                             % to_location)
1228
 
            try:
1229
 
                # preserve whatever source format we have.
1230
 
                dir = br_from.bzrdir.sprout(to_transport.base, revision_id,
1231
 
                                            possible_transports=[to_transport],
1232
 
                                            accelerator_tree=accelerator_tree,
1233
 
                                            hardlink=hardlink, stacked=stacked,
1234
 
                                            force_new_repo=standalone,
1235
 
                                            create_tree_if_local=not no_tree,
1236
 
                                            source_branch=br_from)
1237
 
                branch = dir.open_branch()
1238
 
            except errors.NoSuchRevision:
1239
 
                to_transport.delete_tree('.')
1240
 
                msg = "The branch %s has no revision %s." % (from_location,
1241
 
                    revision)
1242
 
                raise errors.BzrCommandError(msg)
1243
 
            _merge_tags_if_possible(br_from, branch)
1244
 
            # If the source branch is stacked, the new branch may
1245
 
            # be stacked whether we asked for that explicitly or not.
1246
 
            # We therefore need a try/except here and not just 'if stacked:'
1247
 
            try:
1248
 
                note('Created new stacked branch referring to %s.' %
1249
 
                    branch.get_stacked_on_url())
1250
 
            except (errors.NotStacked, errors.UnstackableBranchFormat,
1251
 
                errors.UnstackableRepositoryFormat), e:
1252
 
                note('Branched %d revision(s).' % branch.revno())
1253
 
        finally:
1254
 
            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'))
1255
1274
 
1256
1275
 
1257
1276
class cmd_checkout(Command):
1258
 
    """Create a new checkout of an existing branch.
 
1277
    __doc__ = """Create a new checkout of an existing branch.
1259
1278
 
1260
1279
    If BRANCH_LOCATION is omitted, checkout will reconstitute a working tree for
1261
1280
    the branch found in '.'. This is useful if you have removed the working tree
1324
1343
 
1325
1344
 
1326
1345
class cmd_renames(Command):
1327
 
    """Show list of renamed files.
 
1346
    __doc__ = """Show list of renamed files.
1328
1347
    """
1329
1348
    # TODO: Option to show renames between two historical versions.
1330
1349
 
1335
1354
    @display_command
1336
1355
    def run(self, dir=u'.'):
1337
1356
        tree = WorkingTree.open_containing(dir)[0]
1338
 
        tree.lock_read()
1339
 
        try:
1340
 
            new_inv = tree.inventory
1341
 
            old_tree = tree.basis_tree()
1342
 
            old_tree.lock_read()
1343
 
            try:
1344
 
                old_inv = old_tree.inventory
1345
 
                renames = []
1346
 
                iterator = tree.iter_changes(old_tree, include_unchanged=True)
1347
 
                for f, paths, c, v, p, n, k, e in iterator:
1348
 
                    if paths[0] == paths[1]:
1349
 
                        continue
1350
 
                    if None in (paths):
1351
 
                        continue
1352
 
                    renames.append(paths)
1353
 
                renames.sort()
1354
 
                for old_name, new_name in renames:
1355
 
                    self.outf.write("%s => %s\n" % (old_name, new_name))
1356
 
            finally:
1357
 
                old_tree.unlock()
1358
 
        finally:
1359
 
            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))
1360
1373
 
1361
1374
 
1362
1375
class cmd_update(Command):
1363
 
    """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.
1364
1377
 
1365
1378
    This will perform a merge into the working tree, and may generate
1366
1379
    conflicts. If you have any local changes, you will still
1368
1381
 
1369
1382
    If you want to discard your local changes, you can just do a
1370
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.
1371
1387
    """
1372
1388
 
1373
1389
    _see_also = ['pull', 'working-trees', 'status-flags']
1374
1390
    takes_args = ['dir?']
 
1391
    takes_options = ['revision']
1375
1392
    aliases = ['up']
1376
1393
 
1377
 
    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")
1378
1398
        tree = WorkingTree.open_containing(dir)[0]
 
1399
        branch = tree.branch
1379
1400
        possible_transports = []
1380
 
        master = tree.branch.get_master_branch(
 
1401
        master = branch.get_master_branch(
1381
1402
            possible_transports=possible_transports)
1382
1403
        if master is not None:
 
1404
            branch_location = master.base
1383
1405
            tree.lock_write()
1384
1406
        else:
 
1407
            branch_location = tree.branch.base
1385
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)
1386
1435
        try:
1387
 
            existing_pending_merges = tree.get_parent_ids()[1:]
1388
 
            last_rev = _mod_revision.ensure_null(tree.last_revision())
1389
 
            if last_rev == _mod_revision.ensure_null(
1390
 
                tree.branch.last_revision()):
1391
 
                # may be up to date, check master too.
1392
 
                if master is None or last_rev == _mod_revision.ensure_null(
1393
 
                    master.last_revision()):
1394
 
                    revno = tree.branch.revision_id_to_revno(last_rev)
1395
 
                    note("Tree is up to date at revision %d." % (revno,))
1396
 
                    return 0
1397
 
            view_info = _get_view_info_for_change_reporter(tree)
1398
1436
            conflicts = tree.update(
1399
 
                delta._ChangeReporter(unversioned_filter=tree.is_ignored,
1400
 
                view_info=view_info), possible_transports=possible_transports)
1401
 
            revno = tree.branch.revision_id_to_revno(
1402
 
                _mod_revision.ensure_null(tree.last_revision()))
1403
 
            note('Updated to revision %d.' % (revno,))
1404
 
            if tree.get_parent_ids()[1:] != existing_pending_merges:
1405
 
                note('Your local commits will now show as pending merges with '
1406
 
                     "'bzr status', and can be committed with 'bzr commit'.")
1407
 
            if conflicts != 0:
1408
 
                return 1
1409
 
            else:
1410
 
                return 0
1411
 
        finally:
1412
 
            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
1413
1459
 
1414
1460
 
1415
1461
class cmd_info(Command):
1416
 
    """Show information about a working tree, branch or repository.
 
1462
    __doc__ = """Show information about a working tree, branch or repository.
1417
1463
 
1418
1464
    This command will show all known locations and formats associated to the
1419
1465
    tree, branch or repository.
1457
1503
 
1458
1504
 
1459
1505
class cmd_remove(Command):
1460
 
    """Remove files or directories.
 
1506
    __doc__ = """Remove files or directories.
1461
1507
 
1462
1508
    This makes bzr stop tracking changes to the specified files. bzr will delete
1463
1509
    them if they can easily be recovered using revert. If no options or
1485
1531
        if file_list is not None:
1486
1532
            file_list = [f for f in file_list]
1487
1533
 
1488
 
        tree.lock_write()
1489
 
        try:
1490
 
            # Heuristics should probably all move into tree.remove_smart or
1491
 
            # some such?
1492
 
            if new:
1493
 
                added = tree.changes_from(tree.basis_tree(),
1494
 
                    specific_files=file_list).added
1495
 
                file_list = sorted([f[0] for f in added], reverse=True)
1496
 
                if len(file_list) == 0:
1497
 
                    raise errors.BzrCommandError('No matching files.')
1498
 
            elif file_list is None:
1499
 
                # missing files show up in iter_changes(basis) as
1500
 
                # versioned-with-no-kind.
1501
 
                missing = []
1502
 
                for change in tree.iter_changes(tree.basis_tree()):
1503
 
                    # Find paths in the working tree that have no kind:
1504
 
                    if change[1][1] is not None and change[6][1] is None:
1505
 
                        missing.append(change[1][1])
1506
 
                file_list = sorted(missing, reverse=True)
1507
 
                file_deletion_strategy = 'keep'
1508
 
            tree.remove(file_list, verbose=verbose, to_file=self.outf,
1509
 
                keep_files=file_deletion_strategy=='keep',
1510
 
                force=file_deletion_strategy=='force')
1511
 
        finally:
1512
 
            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')
1513
1556
 
1514
1557
 
1515
1558
class cmd_file_id(Command):
1516
 
    """Print file_id of a particular file or directory.
 
1559
    __doc__ = """Print file_id of a particular file or directory.
1517
1560
 
1518
1561
    The file_id is assigned when the file is first added and remains the
1519
1562
    same through all revisions where the file exists, even when it is
1535
1578
 
1536
1579
 
1537
1580
class cmd_file_path(Command):
1538
 
    """Print path of file_ids to a file or directory.
 
1581
    __doc__ = """Print path of file_ids to a file or directory.
1539
1582
 
1540
1583
    This prints one line for each directory down to the target,
1541
1584
    starting at the branch root.
1557
1600
 
1558
1601
 
1559
1602
class cmd_reconcile(Command):
1560
 
    """Reconcile bzr metadata in a branch.
 
1603
    __doc__ = """Reconcile bzr metadata in a branch.
1561
1604
 
1562
1605
    This can correct data mismatches that may have been caused by
1563
1606
    previous ghost operations or bzr upgrades. You should only
1585
1628
 
1586
1629
 
1587
1630
class cmd_revision_history(Command):
1588
 
    """Display the list of revision ids on a branch."""
 
1631
    __doc__ = """Display the list of revision ids on a branch."""
1589
1632
 
1590
1633
    _see_also = ['log']
1591
1634
    takes_args = ['location?']
1601
1644
 
1602
1645
 
1603
1646
class cmd_ancestry(Command):
1604
 
    """List all revisions merged into this branch."""
 
1647
    __doc__ = """List all revisions merged into this branch."""
1605
1648
 
1606
1649
    _see_also = ['log', 'revision-history']
1607
1650
    takes_args = ['location?']
1626
1669
 
1627
1670
 
1628
1671
class cmd_init(Command):
1629
 
    """Make a directory into a versioned branch.
 
1672
    __doc__ = """Make a directory into a versioned branch.
1630
1673
 
1631
1674
    Use this to create an empty branch, or before importing an
1632
1675
    existing project.
1660
1703
                lazy_registry=('bzrlib.bzrdir', 'format_registry'),
1661
1704
                converter=lambda name: bzrdir.format_registry.make_bzrdir(name),
1662
1705
                value_switches=True,
1663
 
                title="Branch Format",
 
1706
                title="Branch format",
1664
1707
                ),
1665
1708
         Option('append-revisions-only',
1666
1709
                help='Never change revnos or the existing log.'
1735
1778
 
1736
1779
 
1737
1780
class cmd_init_repository(Command):
1738
 
    """Create a shared repository to hold branches.
 
1781
    __doc__ = """Create a shared repository for branches to share storage space.
1739
1782
 
1740
1783
    New branches created under the repository directory will store their
1741
 
    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.
1742
1787
 
1743
 
    If the --no-trees option is used then the branches in the repository
1744
 
    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.
1745
1794
 
1746
1795
    :Examples:
1747
 
        Create a shared repositories holding just branches::
 
1796
        Create a shared repository holding just branches::
1748
1797
 
1749
1798
            bzr init-repo --no-trees repo
1750
1799
            bzr init repo/trunk
1789
1838
 
1790
1839
 
1791
1840
class cmd_diff(Command):
1792
 
    """Show differences in the working tree, between revisions or branches.
 
1841
    __doc__ = """Show differences in the working tree, between revisions or branches.
1793
1842
 
1794
1843
    If no arguments are given, all changes for the current tree are listed.
1795
1844
    If files are given, only the changes in those files are listed.
1816
1865
 
1817
1866
            bzr diff -r1
1818
1867
 
1819
 
        Difference between revision 2 and revision 1::
1820
 
 
1821
 
            bzr diff -r1..2
1822
 
 
1823
 
        Difference between revision 2 and revision 1 for branch xxx::
1824
 
 
1825
 
            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
1826
1889
 
1827
1890
        Show just the differences for file NEWS::
1828
1891
 
1867
1930
            help='Use this command to compare files.',
1868
1931
            type=unicode,
1869
1932
            ),
 
1933
        RegistryOption('format',
 
1934
            help='Diff format to use.',
 
1935
            lazy_registry=('bzrlib.diff', 'format_registry'),
 
1936
            value_switches=False, title='Diff format'),
1870
1937
        ]
1871
1938
    aliases = ['di', 'dif']
1872
1939
    encoding_type = 'exact'
1873
1940
 
1874
1941
    @display_command
1875
1942
    def run(self, revision=None, file_list=None, diff_options=None,
1876
 
            prefix=None, old=None, new=None, using=None):
1877
 
        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)
1878
1946
 
1879
1947
        if (prefix is None) or (prefix == '0'):
1880
1948
            # diff -p0 format
1894
1962
            raise errors.BzrCommandError('bzr diff --revision takes exactly'
1895
1963
                                         ' one or two revision specifiers')
1896
1964
 
1897
 
        old_tree, new_tree, specific_files, extra_trees = \
1898
 
                _get_trees_to_diff(file_list, revision, old, new,
1899
 
                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()
1900
1975
        return show_diff_trees(old_tree, new_tree, sys.stdout,
1901
1976
                               specific_files=specific_files,
1902
1977
                               external_diff_options=diff_options,
1903
1978
                               old_label=old_label, new_label=new_label,
1904
 
                               extra_trees=extra_trees, using=using)
 
1979
                               extra_trees=extra_trees,
 
1980
                               path_encoding=path_encoding,
 
1981
                               using=using,
 
1982
                               format_cls=format)
1905
1983
 
1906
1984
 
1907
1985
class cmd_deleted(Command):
1908
 
    """List files deleted in the working tree.
 
1986
    __doc__ = """List files deleted in the working tree.
1909
1987
    """
1910
1988
    # TODO: Show files deleted since a previous revision, or
1911
1989
    # between two revisions.
1914
1992
    # level of effort but possibly much less IO.  (Or possibly not,
1915
1993
    # if the directories are very large...)
1916
1994
    _see_also = ['status', 'ls']
1917
 
    takes_options = ['show-ids']
 
1995
    takes_options = ['directory', 'show-ids']
1918
1996
 
1919
1997
    @display_command
1920
 
    def run(self, show_ids=False):
1921
 
        tree = WorkingTree.open_containing(u'.')[0]
1922
 
        tree.lock_read()
1923
 
        try:
1924
 
            old = tree.basis_tree()
1925
 
            old.lock_read()
1926
 
            try:
1927
 
                for path, ie in old.inventory.iter_entries():
1928
 
                    if not tree.has_id(ie.file_id):
1929
 
                        self.outf.write(path)
1930
 
                        if show_ids:
1931
 
                            self.outf.write(' ')
1932
 
                            self.outf.write(ie.file_id)
1933
 
                        self.outf.write('\n')
1934
 
            finally:
1935
 
                old.unlock()
1936
 
        finally:
1937
 
            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')
1938
2010
 
1939
2011
 
1940
2012
class cmd_modified(Command):
1941
 
    """List files modified in working tree.
 
2013
    __doc__ = """List files modified in working tree.
1942
2014
    """
1943
2015
 
1944
2016
    hidden = True
1945
2017
    _see_also = ['status', 'ls']
1946
 
    takes_options = [
1947
 
            Option('null',
1948
 
                   help='Write an ascii NUL (\\0) separator '
1949
 
                   'between files rather than a newline.')
1950
 
            ]
 
2018
    takes_options = ['directory', 'null']
1951
2019
 
1952
2020
    @display_command
1953
 
    def run(self, null=False):
1954
 
        tree = WorkingTree.open_containing(u'.')[0]
 
2021
    def run(self, null=False, directory=u'.'):
 
2022
        tree = WorkingTree.open_containing(directory)[0]
1955
2023
        td = tree.changes_from(tree.basis_tree())
1956
2024
        for path, id, kind, text_modified, meta_modified in td.modified:
1957
2025
            if null:
1961
2029
 
1962
2030
 
1963
2031
class cmd_added(Command):
1964
 
    """List files added in working tree.
 
2032
    __doc__ = """List files added in working tree.
1965
2033
    """
1966
2034
 
1967
2035
    hidden = True
1968
2036
    _see_also = ['status', 'ls']
1969
 
    takes_options = [
1970
 
            Option('null',
1971
 
                   help='Write an ascii NUL (\\0) separator '
1972
 
                   'between files rather than a newline.')
1973
 
            ]
 
2037
    takes_options = ['directory', 'null']
1974
2038
 
1975
2039
    @display_command
1976
 
    def run(self, null=False):
1977
 
        wt = WorkingTree.open_containing(u'.')[0]
1978
 
        wt.lock_read()
1979
 
        try:
1980
 
            basis = wt.basis_tree()
1981
 
            basis.lock_read()
1982
 
            try:
1983
 
                basis_inv = basis.inventory
1984
 
                inv = wt.inventory
1985
 
                for file_id in inv:
1986
 
                    if file_id in basis_inv:
1987
 
                        continue
1988
 
                    if inv.is_root(file_id) and len(basis_inv) == 0:
1989
 
                        continue
1990
 
                    path = inv.id2path(file_id)
1991
 
                    if not os.access(osutils.abspath(path), os.F_OK):
1992
 
                        continue
1993
 
                    if null:
1994
 
                        self.outf.write(path + '\0')
1995
 
                    else:
1996
 
                        self.outf.write(osutils.quotefn(path) + '\n')
1997
 
            finally:
1998
 
                basis.unlock()
1999
 
        finally:
2000
 
            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')
2001
2059
 
2002
2060
 
2003
2061
class cmd_root(Command):
2004
 
    """Show the tree root directory.
 
2062
    __doc__ = """Show the tree root directory.
2005
2063
 
2006
2064
    The root is the nearest enclosing directory with a .bzr control
2007
2065
    directory."""
2031
2089
 
2032
2090
 
2033
2091
class cmd_log(Command):
2034
 
    """Show historical log for a branch or subset of a branch.
 
2092
    __doc__ = """Show historical log for a branch or subset of a branch.
2035
2093
 
2036
2094
    log is bzr's default tool for exploring the history of a branch.
2037
2095
    The branch to use is taken from the first parameter. If no parameters
2148
2206
    :Tips & tricks:
2149
2207
 
2150
2208
      GUI tools and IDEs are often better at exploring history than command
2151
 
      line tools. You may prefer qlog or glog from the QBzr and Bzr-Gtk packages
2152
 
      respectively for example. (TortoiseBzr uses qlog for displaying logs.) See
2153
 
      http://bazaar-vcs.org/BzrPlugins and http://bazaar-vcs.org/IDEIntegration.
2154
 
 
2155
 
      Web interfaces are often better at exploring history than command line
2156
 
      tools, particularly for branches on servers. You may prefer Loggerhead
2157
 
      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>.  
2158
2213
 
2159
2214
      You may find it useful to add the aliases below to ``bazaar.conf``::
2160
2215
 
2201
2256
                   help='Show just the specified revision.'
2202
2257
                   ' See also "help revisionspec".'),
2203
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
            ),
2204
2264
            Option('levels',
2205
2265
                   short_name='n',
2206
2266
                   help='Number of levels to display - 0 for all, 1 for flat.',
2221
2281
                   help='Show changes made in each revision as a patch.'),
2222
2282
            Option('include-merges',
2223
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
                   )
2224
2288
            ]
2225
2289
    encoding_type = 'replace'
2226
2290
 
2236
2300
            message=None,
2237
2301
            limit=None,
2238
2302
            show_diff=False,
2239
 
            include_merges=False):
 
2303
            include_merges=False,
 
2304
            authors=None,
 
2305
            exclude_common_ancestry=False,
 
2306
            ):
2240
2307
        from bzrlib.log import (
2241
2308
            Logger,
2242
2309
            make_log_request_dict,
2243
2310
            _get_info_for_log_files,
2244
2311
            )
2245
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')
2246
2317
        if include_merges:
2247
2318
            if levels is None:
2248
2319
                levels = 0
2263
2334
        filter_by_dir = False
2264
2335
        if file_list:
2265
2336
            # find the file ids to log and check for directory filtering
2266
 
            b, file_info_list, rev1, rev2 = _get_info_for_log_files(revision,
2267
 
                file_list)
 
2337
            b, file_info_list, rev1, rev2 = _get_info_for_log_files(
 
2338
                revision, file_list, self.add_cleanup)
2268
2339
            for relpath, file_id, kind in file_info_list:
2269
2340
                if file_id is None:
2270
2341
                    raise errors.BzrCommandError(
2288
2359
                location = '.'
2289
2360
            dir, relpath = bzrdir.BzrDir.open_containing(location)
2290
2361
            b = dir.open_branch()
 
2362
            self.add_cleanup(b.lock_read().unlock)
2291
2363
            rev1, rev2 = _get_revision_range(revision, b, self.name())
2292
2364
 
2293
2365
        # Decide on the type of delta & diff filtering to use
2303
2375
        else:
2304
2376
            diff_type = 'full'
2305
2377
 
2306
 
        b.lock_read()
2307
 
        try:
2308
 
            # Build the log formatter
2309
 
            if log_format is None:
2310
 
                log_format = log.log_formatter_registry.get_default(b)
2311
 
            lf = log_format(show_ids=show_ids, to_file=self.outf,
2312
 
                            show_timezone=timezone,
2313
 
                            delta_format=get_verbosity_level(),
2314
 
                            levels=levels,
2315
 
                            show_advice=levels is None)
2316
 
 
2317
 
            # Choose the algorithm for doing the logging. It's annoying
2318
 
            # having multiple code paths like this but necessary until
2319
 
            # the underlying repository format is faster at generating
2320
 
            # deltas or can provide everything we need from the indices.
2321
 
            # The default algorithm - match-using-deltas - works for
2322
 
            # multiple files and directories and is faster for small
2323
 
            # amounts of history (200 revisions say). However, it's too
2324
 
            # slow for logging a single file in a repository with deep
2325
 
            # history, i.e. > 10K revisions. In the spirit of "do no
2326
 
            # evil when adding features", we continue to use the
2327
 
            # original algorithm - per-file-graph - for the "single
2328
 
            # file that isn't a directory without showing a delta" case.
2329
 
            partial_history = revision and b.repository._format.supports_chks
2330
 
            match_using_deltas = (len(file_ids) != 1 or filter_by_dir
2331
 
                or delta_type or partial_history)
2332
 
 
2333
 
            # Build the LogRequest and execute it
2334
 
            if len(file_ids) == 0:
2335
 
                file_ids = None
2336
 
            rqst = make_log_request_dict(
2337
 
                direction=direction, specific_fileids=file_ids,
2338
 
                start_revision=rev1, end_revision=rev2, limit=limit,
2339
 
                message_search=message, delta_type=delta_type,
2340
 
                diff_type=diff_type, _match_using_deltas=match_using_deltas)
2341
 
            Logger(b, rqst).show(lf)
2342
 
        finally:
2343
 
            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)
2344
2418
 
2345
2419
 
2346
2420
def _get_revision_range(revisionspec_list, branch, command_name):
2364
2438
            raise errors.BzrCommandError(
2365
2439
                "bzr %s doesn't accept two revisions in different"
2366
2440
                " branches." % command_name)
2367
 
        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)
2368
2446
        # Avoid loading all of history when we know a missing
2369
2447
        # end of range means the last revision ...
2370
2448
        if end_spec.spec is None:
2399
2477
 
2400
2478
 
2401
2479
class cmd_touching_revisions(Command):
2402
 
    """Return revision-ids which affected a particular file.
 
2480
    __doc__ = """Return revision-ids which affected a particular file.
2403
2481
 
2404
2482
    A more user-friendly interface is "bzr log FILE".
2405
2483
    """
2410
2488
    @display_command
2411
2489
    def run(self, filename):
2412
2490
        tree, relpath = WorkingTree.open_containing(filename)
 
2491
        file_id = tree.path2id(relpath)
2413
2492
        b = tree.branch
2414
 
        file_id = tree.path2id(relpath)
2415
 
        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:
2416
2496
            self.outf.write("%6d %s\n" % (revno, what))
2417
2497
 
2418
2498
 
2419
2499
class cmd_ls(Command):
2420
 
    """List files in a tree.
 
2500
    __doc__ = """List files in a tree.
2421
2501
    """
2422
2502
 
2423
2503
    _see_also = ['status', 'cat']
2429
2509
                   help='Recurse into subdirectories.'),
2430
2510
            Option('from-root',
2431
2511
                   help='Print paths relative to the root of the branch.'),
2432
 
            Option('unknown', help='Print unknown files.'),
 
2512
            Option('unknown', short_name='u',
 
2513
                help='Print unknown files.'),
2433
2514
            Option('versioned', help='Print versioned files.',
2434
2515
                   short_name='V'),
2435
 
            Option('ignored', help='Print ignored files.'),
2436
 
            Option('null',
2437
 
                   help='Write an ascii NUL (\\0) separator '
2438
 
                   'between files rather than a newline.'),
2439
 
            Option('kind',
 
2516
            Option('ignored', short_name='i',
 
2517
                help='Print ignored files.'),
 
2518
            Option('kind', short_name='k',
2440
2519
                   help='List entries of a particular kind: file, directory, symlink.',
2441
2520
                   type=unicode),
 
2521
            'null',
2442
2522
            'show-ids',
 
2523
            'directory',
2443
2524
            ]
2444
2525
    @display_command
2445
2526
    def run(self, revision=None, verbose=False,
2446
2527
            recursive=False, from_root=False,
2447
2528
            unknown=False, versioned=False, ignored=False,
2448
 
            null=False, kind=None, show_ids=False, path=None):
 
2529
            null=False, kind=None, show_ids=False, path=None, directory=None):
2449
2530
 
2450
2531
        if kind and kind not in ('file', 'directory', 'symlink'):
2451
2532
            raise errors.BzrCommandError('invalid kind specified')
2463
2544
                raise errors.BzrCommandError('cannot specify both --from-root'
2464
2545
                                             ' and PATH')
2465
2546
            fs_path = path
2466
 
        tree, branch, relpath = bzrdir.BzrDir.open_containing_tree_or_branch(
2467
 
            fs_path)
 
2547
        tree, branch, relpath = \
 
2548
            _open_directory_or_containing_tree_or_branch(fs_path, directory)
2468
2549
 
2469
2550
        # Calculate the prefix to use
2470
2551
        prefix = None
2471
2552
        if from_root:
2472
2553
            if relpath:
2473
2554
                prefix = relpath + '/'
2474
 
        elif fs_path != '.':
 
2555
        elif fs_path != '.' and not fs_path.endswith('/'):
2475
2556
            prefix = fs_path + '/'
2476
2557
 
2477
2558
        if revision is not None or tree is None:
2485
2566
                view_str = views.view_display_str(view_files)
2486
2567
                note("Ignoring files outside view. View is %s" % view_str)
2487
2568
 
2488
 
        tree.lock_read()
2489
 
        try:
2490
 
            for fp, fc, fkind, fid, entry in tree.list_files(include_root=False,
2491
 
                from_dir=relpath, recursive=recursive):
2492
 
                # Apply additional masking
2493
 
                if not all and not selection[fc]:
2494
 
                    continue
2495
 
                if kind is not None and fkind != kind:
2496
 
                    continue
2497
 
                if apply_view:
2498
 
                    try:
2499
 
                        if relpath:
2500
 
                            fullpath = osutils.pathjoin(relpath, fp)
2501
 
                        else:
2502
 
                            fullpath = fp
2503
 
                        views.check_path_in_view(tree, fullpath)
2504
 
                    except errors.FileOutsideView:
2505
 
                        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
2506
2586
 
2507
 
                # Output the entry
2508
 
                if prefix:
2509
 
                    fp = osutils.pathjoin(prefix, fp)
2510
 
                kindch = entry.kind_character()
2511
 
                outstring = fp + kindch
2512
 
                ui.ui_factory.clear_term()
2513
 
                if verbose:
2514
 
                    outstring = '%-8s %s' % (fc, outstring)
2515
 
                    if show_ids and fid is not None:
2516
 
                        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:
2517
2613
                    self.outf.write(outstring + '\n')
2518
 
                elif null:
2519
 
                    self.outf.write(fp + '\0')
2520
 
                    if show_ids:
2521
 
                        if fid is not None:
2522
 
                            self.outf.write(fid)
2523
 
                        self.outf.write('\0')
2524
 
                    self.outf.flush()
2525
 
                else:
2526
 
                    if show_ids:
2527
 
                        if fid is not None:
2528
 
                            my_id = fid
2529
 
                        else:
2530
 
                            my_id = ''
2531
 
                        self.outf.write('%-50s %s\n' % (outstring, my_id))
2532
 
                    else:
2533
 
                        self.outf.write(outstring + '\n')
2534
 
        finally:
2535
 
            tree.unlock()
2536
2614
 
2537
2615
 
2538
2616
class cmd_unknowns(Command):
2539
 
    """List unknown files.
 
2617
    __doc__ = """List unknown files.
2540
2618
    """
2541
2619
 
2542
2620
    hidden = True
2543
2621
    _see_also = ['ls']
 
2622
    takes_options = ['directory']
2544
2623
 
2545
2624
    @display_command
2546
 
    def run(self):
2547
 
        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():
2548
2627
            self.outf.write(osutils.quotefn(f) + '\n')
2549
2628
 
2550
2629
 
2551
2630
class cmd_ignore(Command):
2552
 
    """Ignore specified files or patterns.
 
2631
    __doc__ = """Ignore specified files or patterns.
2553
2632
 
2554
2633
    See ``bzr help patterns`` for details on the syntax of patterns.
2555
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
 
2556
2641
    To remove patterns from the ignore list, edit the .bzrignore file.
2557
2642
    After adding, editing or deleting that file either indirectly by
2558
2643
    using this command or directly by using an editor, be sure to commit
2559
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.
2560
2658
 
2561
2659
    Note: ignore patterns containing shell wildcards must be quoted from
2562
2660
    the shell on Unix.
2566
2664
 
2567
2665
            bzr ignore ./Makefile
2568
2666
 
2569
 
        Ignore class files in all directories::
 
2667
        Ignore .class files in all directories...::
2570
2668
 
2571
2669
            bzr ignore "*.class"
2572
2670
 
 
2671
        ...but do not ignore "special.class"::
 
2672
 
 
2673
            bzr ignore "!special.class"
 
2674
 
2573
2675
        Ignore .o files under the lib directory::
2574
2676
 
2575
2677
            bzr ignore "lib/**/*.o"
2581
2683
        Ignore everything but the "debian" toplevel directory::
2582
2684
 
2583
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 "!!*~"
2584
2693
    """
2585
2694
 
2586
2695
    _see_also = ['status', 'ignored', 'patterns']
2587
2696
    takes_args = ['name_pattern*']
2588
 
    takes_options = [
2589
 
        Option('old-default-rules',
2590
 
               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.')
2591
2700
        ]
2592
2701
 
2593
 
    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'.'):
2594
2704
        from bzrlib import ignores
2595
 
        if old_default_rules is not None:
2596
 
            # dump the rules and exit
2597
 
            for pattern in ignores.OLD_DEFAULTS:
2598
 
                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)
2599
2709
            return
2600
2710
        if not name_pattern_list:
2601
2711
            raise errors.BzrCommandError("ignore requires at least one "
2602
 
                                  "NAME_PATTERN or --old-default-rules")
 
2712
                "NAME_PATTERN or --default-rules.")
2603
2713
        name_pattern_list = [globbing.normalize_pattern(p)
2604
2714
                             for p in name_pattern_list]
2605
2715
        for name_pattern in name_pattern_list:
2607
2717
                (len(name_pattern) > 1 and name_pattern[1] == ':')):
2608
2718
                raise errors.BzrCommandError(
2609
2719
                    "NAME_PATTERN should not be an absolute path")
2610
 
        tree, relpath = WorkingTree.open_containing(u'.')
 
2720
        tree, relpath = WorkingTree.open_containing(directory)
2611
2721
        ignores.tree_ignores_add_patterns(tree, name_pattern_list)
2612
2722
        ignored = globbing.Globster(name_pattern_list)
2613
2723
        matches = []
2614
 
        tree.lock_read()
 
2724
        self.add_cleanup(tree.lock_read().unlock)
2615
2725
        for entry in tree.list_files():
2616
2726
            id = entry[3]
2617
2727
            if id is not None:
2618
2728
                filename = entry[0]
2619
2729
                if ignored.match(filename):
2620
 
                    matches.append(filename.encode('utf-8'))
2621
 
        tree.unlock()
 
2730
                    matches.append(filename)
2622
2731
        if len(matches) > 0:
2623
 
            print "Warning: the following files are version controlled and" \
2624
 
                  " match your ignore pattern:\n%s" \
2625
 
                  "\nThese files will continue to be version controlled" \
2626
 
                  " unless you 'bzr remove' them." % ("\n".join(matches),)
 
2732
            self.outf.write("Warning: the following files are version controlled and"
 
2733
                  " match your ignore pattern:\n%s"
 
2734
                  "\nThese files will continue to be version controlled"
 
2735
                  " unless you 'bzr remove' them.\n" % ("\n".join(matches),))
2627
2736
 
2628
2737
 
2629
2738
class cmd_ignored(Command):
2630
 
    """List ignored files and the patterns that matched them.
 
2739
    __doc__ = """List ignored files and the patterns that matched them.
2631
2740
 
2632
2741
    List all the ignored files and the ignore pattern that caused the file to
2633
2742
    be ignored.
2639
2748
 
2640
2749
    encoding_type = 'replace'
2641
2750
    _see_also = ['ignore', 'ls']
 
2751
    takes_options = ['directory']
2642
2752
 
2643
2753
    @display_command
2644
 
    def run(self):
2645
 
        tree = WorkingTree.open_containing(u'.')[0]
2646
 
        tree.lock_read()
2647
 
        try:
2648
 
            for path, file_class, kind, file_id, entry in tree.list_files():
2649
 
                if file_class != 'I':
2650
 
                    continue
2651
 
                ## XXX: Slightly inefficient since this was already calculated
2652
 
                pat = tree.is_ignored(path)
2653
 
                self.outf.write('%-50s %s\n' % (path, pat))
2654
 
        finally:
2655
 
            tree.unlock()
 
2754
    def run(self, directory=u'.'):
 
2755
        tree = WorkingTree.open_containing(directory)[0]
 
2756
        self.add_cleanup(tree.lock_read().unlock)
 
2757
        for path, file_class, kind, file_id, entry in tree.list_files():
 
2758
            if file_class != 'I':
 
2759
                continue
 
2760
            ## XXX: Slightly inefficient since this was already calculated
 
2761
            pat = tree.is_ignored(path)
 
2762
            self.outf.write('%-50s %s\n' % (path, pat))
2656
2763
 
2657
2764
 
2658
2765
class cmd_lookup_revision(Command):
2659
 
    """Lookup the revision-id from a revision-number
 
2766
    __doc__ = """Lookup the revision-id from a revision-number
2660
2767
 
2661
2768
    :Examples:
2662
2769
        bzr lookup-revision 33
2663
2770
    """
2664
2771
    hidden = True
2665
2772
    takes_args = ['revno']
 
2773
    takes_options = ['directory']
2666
2774
 
2667
2775
    @display_command
2668
 
    def run(self, revno):
 
2776
    def run(self, revno, directory=u'.'):
2669
2777
        try:
2670
2778
            revno = int(revno)
2671
2779
        except ValueError:
2672
 
            raise errors.BzrCommandError("not a valid revision-number: %r" % revno)
2673
 
 
2674
 
        print WorkingTree.open_containing(u'.')[0].branch.get_rev_id(revno)
 
2780
            raise errors.BzrCommandError("not a valid revision-number: %r"
 
2781
                                         % revno)
 
2782
        revid = WorkingTree.open_containing(directory)[0].branch.get_rev_id(revno)
 
2783
        self.outf.write("%s\n" % revid)
2675
2784
 
2676
2785
 
2677
2786
class cmd_export(Command):
2678
 
    """Export current or past revision to a destination directory or archive.
 
2787
    __doc__ = """Export current or past revision to a destination directory or archive.
2679
2788
 
2680
2789
    If no revision is specified this exports the last committed revision.
2681
2790
 
2703
2812
      =================       =========================
2704
2813
    """
2705
2814
    takes_args = ['dest', 'branch_or_subdir?']
2706
 
    takes_options = [
 
2815
    takes_options = ['directory',
2707
2816
        Option('format',
2708
2817
               help="Type of file to export to.",
2709
2818
               type=unicode),
2713
2822
        Option('root',
2714
2823
               type=str,
2715
2824
               help="Name of the root directory inside the exported file."),
 
2825
        Option('per-file-timestamps',
 
2826
               help='Set modification time of files to that of the last '
 
2827
                    'revision in which it was changed.'),
2716
2828
        ]
2717
2829
    def run(self, dest, branch_or_subdir=None, revision=None, format=None,
2718
 
        root=None, filters=False):
 
2830
        root=None, filters=False, per_file_timestamps=False, directory=u'.'):
2719
2831
        from bzrlib.export import export
2720
2832
 
2721
2833
        if branch_or_subdir is None:
2722
 
            tree = WorkingTree.open_containing(u'.')[0]
 
2834
            tree = WorkingTree.open_containing(directory)[0]
2723
2835
            b = tree.branch
2724
2836
            subdir = None
2725
2837
        else:
2728
2840
 
2729
2841
        rev_tree = _get_one_revision_tree('export', revision, branch=b, tree=tree)
2730
2842
        try:
2731
 
            export(rev_tree, dest, format, root, subdir, filtered=filters)
 
2843
            export(rev_tree, dest, format, root, subdir, filtered=filters,
 
2844
                   per_file_timestamps=per_file_timestamps)
2732
2845
        except errors.NoSuchExportFormat, e:
2733
2846
            raise errors.BzrCommandError('Unsupported export format: %s' % e.format)
2734
2847
 
2735
2848
 
2736
2849
class cmd_cat(Command):
2737
 
    """Write the contents of a file as of a given revision to standard output.
 
2850
    __doc__ = """Write the contents of a file as of a given revision to standard output.
2738
2851
 
2739
2852
    If no revision is nominated, the last revision is used.
2740
2853
 
2743
2856
    """
2744
2857
 
2745
2858
    _see_also = ['ls']
2746
 
    takes_options = [
 
2859
    takes_options = ['directory',
2747
2860
        Option('name-from-revision', help='The path name in the old tree.'),
2748
2861
        Option('filters', help='Apply content filters to display the '
2749
2862
                'convenience form.'),
2754
2867
 
2755
2868
    @display_command
2756
2869
    def run(self, filename, revision=None, name_from_revision=False,
2757
 
            filters=False):
 
2870
            filters=False, directory=None):
2758
2871
        if revision is not None and len(revision) != 1:
2759
2872
            raise errors.BzrCommandError("bzr cat --revision takes exactly"
2760
2873
                                         " one revision specifier")
2761
2874
        tree, branch, relpath = \
2762
 
            bzrdir.BzrDir.open_containing_tree_or_branch(filename)
2763
 
        branch.lock_read()
2764
 
        try:
2765
 
            return self._run(tree, branch, relpath, filename, revision,
2766
 
                             name_from_revision, filters)
2767
 
        finally:
2768
 
            branch.unlock()
 
2875
            _open_directory_or_containing_tree_or_branch(filename, directory)
 
2876
        self.add_cleanup(branch.lock_read().unlock)
 
2877
        return self._run(tree, branch, relpath, filename, revision,
 
2878
                         name_from_revision, filters)
2769
2879
 
2770
2880
    def _run(self, tree, b, relpath, filename, revision, name_from_revision,
2771
2881
        filtered):
2772
2882
        if tree is None:
2773
2883
            tree = b.basis_tree()
2774
2884
        rev_tree = _get_one_revision_tree('cat', revision, branch=b)
 
2885
        self.add_cleanup(rev_tree.lock_read().unlock)
2775
2886
 
2776
2887
        old_file_id = rev_tree.path2id(relpath)
2777
2888
 
2812
2923
            chunks = content.splitlines(True)
2813
2924
            content = filtered_output_bytes(chunks, filters,
2814
2925
                ContentFilterContext(relpath, rev_tree))
 
2926
            self.cleanup_now()
2815
2927
            self.outf.writelines(content)
2816
2928
        else:
 
2929
            self.cleanup_now()
2817
2930
            self.outf.write(content)
2818
2931
 
2819
2932
 
2820
2933
class cmd_local_time_offset(Command):
2821
 
    """Show the offset in seconds from GMT to local time."""
 
2934
    __doc__ = """Show the offset in seconds from GMT to local time."""
2822
2935
    hidden = True
2823
2936
    @display_command
2824
2937
    def run(self):
2825
 
        print osutils.local_time_offset()
 
2938
        self.outf.write("%s\n" % osutils.local_time_offset())
2826
2939
 
2827
2940
 
2828
2941
 
2829
2942
class cmd_commit(Command):
2830
 
    """Commit changes into a new revision.
 
2943
    __doc__ = """Commit changes into a new revision.
2831
2944
 
2832
2945
    An explanatory message needs to be given for each commit. This is
2833
2946
    often done by using the --message option (getting the message from the
2926
3039
             Option('strict',
2927
3040
                    help="Refuse to commit if there are unknown "
2928
3041
                    "files in the working tree."),
 
3042
             Option('commit-time', type=str,
 
3043
                    help="Manually set a commit time using commit date "
 
3044
                    "format, e.g. '2009-10-10 08:00:00 +0100'."),
2929
3045
             ListOption('fixes', type=str,
2930
3046
                    help="Mark a bug as being fixed by this revision "
2931
3047
                         "(see \"bzr help bugs\")."),
2938
3054
                         "the master branch until a normal commit "
2939
3055
                         "is performed."
2940
3056
                    ),
2941
 
              Option('show-diff',
2942
 
                     help='When no message is supplied, show the diff along'
2943
 
                     ' with the status summary in the message editor.'),
 
3057
             Option('show-diff', short_name='p',
 
3058
                    help='When no message is supplied, show the diff along'
 
3059
                    ' with the status summary in the message editor.'),
2944
3060
             ]
2945
3061
    aliases = ['ci', 'checkin']
2946
3062
 
2965
3081
 
2966
3082
    def run(self, message=None, file=None, verbose=False, selected_list=None,
2967
3083
            unchanged=False, strict=False, local=False, fixes=None,
2968
 
            author=None, show_diff=False, exclude=None):
 
3084
            author=None, show_diff=False, exclude=None, commit_time=None):
2969
3085
        from bzrlib.errors import (
2970
3086
            PointlessCommit,
2971
3087
            ConflictsInTree,
2977
3093
            make_commit_message_template_encoded
2978
3094
        )
2979
3095
 
 
3096
        commit_stamp = offset = None
 
3097
        if commit_time is not None:
 
3098
            try:
 
3099
                commit_stamp, offset = timestamp.parse_patch_date(commit_time)
 
3100
            except ValueError, e:
 
3101
                raise errors.BzrCommandError(
 
3102
                    "Could not parse --commit-time: " + str(e))
 
3103
 
2980
3104
        # TODO: Need a blackbox test for invoking the external editor; may be
2981
3105
        # slightly problematic to run this cross-platform.
2982
3106
 
3002
3126
        if local and not tree.branch.get_bound_location():
3003
3127
            raise errors.LocalRequiresBoundBranch()
3004
3128
 
 
3129
        if message is not None:
 
3130
            try:
 
3131
                file_exists = osutils.lexists(message)
 
3132
            except UnicodeError:
 
3133
                # The commit message contains unicode characters that can't be
 
3134
                # represented in the filesystem encoding, so that can't be a
 
3135
                # file.
 
3136
                file_exists = False
 
3137
            if file_exists:
 
3138
                warning_msg = (
 
3139
                    'The commit message is a file name: "%(f)s".\n'
 
3140
                    '(use --file "%(f)s" to take commit message from that file)'
 
3141
                    % { 'f': message })
 
3142
                ui.ui_factory.show_warning(warning_msg)
 
3143
            if '\r' in message:
 
3144
                message = message.replace('\r\n', '\n')
 
3145
                message = message.replace('\r', '\n')
 
3146
            if file:
 
3147
                raise errors.BzrCommandError(
 
3148
                    "please specify either --message or --file")
 
3149
 
3005
3150
        def get_message(commit_obj):
3006
3151
            """Callback to get commit message"""
3007
 
            my_message = message
3008
 
            if my_message is None and not file:
3009
 
                t = make_commit_message_template_encoded(tree,
 
3152
            if file:
 
3153
                f = codecs.open(file, 'rt', osutils.get_user_encoding())
 
3154
                try:
 
3155
                    my_message = f.read()
 
3156
                finally:
 
3157
                    f.close()
 
3158
            elif message is not None:
 
3159
                my_message = message
 
3160
            else:
 
3161
                # No message supplied: make one up.
 
3162
                # text is the status of the tree
 
3163
                text = make_commit_message_template_encoded(tree,
3010
3164
                        selected_list, diff=show_diff,
3011
3165
                        output_encoding=osutils.get_user_encoding())
 
3166
                # start_message is the template generated from hooks
 
3167
                # XXX: Warning - looks like hooks return unicode,
 
3168
                # make_commit_message_template_encoded returns user encoding.
 
3169
                # We probably want to be using edit_commit_message instead to
 
3170
                # avoid this.
3012
3171
                start_message = generate_commit_message_template(commit_obj)
3013
 
                my_message = edit_commit_message_encoded(t,
 
3172
                my_message = edit_commit_message_encoded(text,
3014
3173
                    start_message=start_message)
3015
3174
                if my_message is None:
3016
3175
                    raise errors.BzrCommandError("please specify a commit"
3017
3176
                        " message with either --message or --file")
3018
 
            elif my_message and file:
3019
 
                raise errors.BzrCommandError(
3020
 
                    "please specify either --message or --file")
3021
 
            if file:
3022
 
                my_message = codecs.open(file, 'rt',
3023
 
                                         osutils.get_user_encoding()).read()
3024
3177
            if my_message == "":
3025
3178
                raise errors.BzrCommandError("empty commit message specified")
3026
3179
            return my_message
3027
3180
 
 
3181
        # The API permits a commit with a filter of [] to mean 'select nothing'
 
3182
        # but the command line should not do that.
 
3183
        if not selected_list:
 
3184
            selected_list = None
3028
3185
        try:
3029
3186
            tree.commit(message_callback=get_message,
3030
3187
                        specific_files=selected_list,
3031
3188
                        allow_pointless=unchanged, strict=strict, local=local,
3032
3189
                        reporter=None, verbose=verbose, revprops=properties,
3033
 
                        authors=author,
 
3190
                        authors=author, timestamp=commit_stamp,
 
3191
                        timezone=offset,
3034
3192
                        exclude=safe_relpath_files(tree, exclude))
3035
3193
        except PointlessCommit:
3036
 
            # FIXME: This should really happen before the file is read in;
3037
 
            # perhaps prepare the commit; get the message; then actually commit
3038
3194
            raise errors.BzrCommandError("No changes to commit."
3039
3195
                              " Use --unchanged to commit anyhow.")
3040
3196
        except ConflictsInTree:
3045
3201
            raise errors.BzrCommandError("Commit refused because there are"
3046
3202
                              " unknown files in the working tree.")
3047
3203
        except errors.BoundBranchOutOfDate, e:
3048
 
            raise errors.BzrCommandError(str(e) + "\n"
3049
 
            'To commit to master branch, run update and then commit.\n'
3050
 
            'You can also pass --local to commit to continue working '
3051
 
            'disconnected.')
 
3204
            e.extra_help = ("\n"
 
3205
                'To commit to master branch, run update and then commit.\n'
 
3206
                'You can also pass --local to commit to continue working '
 
3207
                'disconnected.')
 
3208
            raise
3052
3209
 
3053
3210
 
3054
3211
class cmd_check(Command):
3055
 
    """Validate working tree structure, branch consistency and repository history.
 
3212
    __doc__ = """Validate working tree structure, branch consistency and repository history.
3056
3213
 
3057
3214
    This command checks various invariants about branch and repository storage
3058
3215
    to detect data corruption or bzr bugs.
3122
3279
 
3123
3280
 
3124
3281
class cmd_upgrade(Command):
3125
 
    """Upgrade branch storage to current format.
 
3282
    __doc__ = """Upgrade branch storage to current format.
3126
3283
 
3127
3284
    The check command or bzr developers may sometimes advise you to run
3128
3285
    this command. When the default format has changed you may also be warned
3146
3303
 
3147
3304
 
3148
3305
class cmd_whoami(Command):
3149
 
    """Show or set bzr user id.
 
3306
    __doc__ = """Show or set bzr user id.
3150
3307
 
3151
3308
    :Examples:
3152
3309
        Show the email of the current user::
3157
3314
 
3158
3315
            bzr whoami "Frank Chu <fchu@example.com>"
3159
3316
    """
3160
 
    takes_options = [ Option('email',
 
3317
    takes_options = [ 'directory',
 
3318
                      Option('email',
3161
3319
                             help='Display email address only.'),
3162
3320
                      Option('branch',
3163
3321
                             help='Set identity for the current branch instead of '
3167
3325
    encoding_type = 'replace'
3168
3326
 
3169
3327
    @display_command
3170
 
    def run(self, email=False, branch=False, name=None):
 
3328
    def run(self, email=False, branch=False, name=None, directory=None):
3171
3329
        if name is None:
3172
 
            # use branch if we're inside one; otherwise global config
3173
 
            try:
3174
 
                c = Branch.open_containing('.')[0].get_config()
3175
 
            except errors.NotBranchError:
3176
 
                c = config.GlobalConfig()
 
3330
            if directory is None:
 
3331
                # use branch if we're inside one; otherwise global config
 
3332
                try:
 
3333
                    c = Branch.open_containing(u'.')[0].get_config()
 
3334
                except errors.NotBranchError:
 
3335
                    c = config.GlobalConfig()
 
3336
            else:
 
3337
                c = Branch.open(directory).get_config()
3177
3338
            if email:
3178
3339
                self.outf.write(c.user_email() + '\n')
3179
3340
            else:
3189
3350
 
3190
3351
        # use global config unless --branch given
3191
3352
        if branch:
3192
 
            c = Branch.open_containing('.')[0].get_config()
 
3353
            if directory is None:
 
3354
                c = Branch.open_containing(u'.')[0].get_config()
 
3355
            else:
 
3356
                c = Branch.open(directory).get_config()
3193
3357
        else:
3194
3358
            c = config.GlobalConfig()
3195
3359
        c.set_user_option('email', name)
3196
3360
 
3197
3361
 
3198
3362
class cmd_nick(Command):
3199
 
    """Print or set the branch nickname.
 
3363
    __doc__ = """Print or set the branch nickname.
3200
3364
 
3201
3365
    If unset, the tree root directory name is used as the nickname.
3202
3366
    To print the current nickname, execute with no argument.
3207
3371
 
3208
3372
    _see_also = ['info']
3209
3373
    takes_args = ['nickname?']
3210
 
    def run(self, nickname=None):
3211
 
        branch = Branch.open_containing(u'.')[0]
 
3374
    takes_options = ['directory']
 
3375
    def run(self, nickname=None, directory=u'.'):
 
3376
        branch = Branch.open_containing(directory)[0]
3212
3377
        if nickname is None:
3213
3378
            self.printme(branch)
3214
3379
        else:
3216
3381
 
3217
3382
    @display_command
3218
3383
    def printme(self, branch):
3219
 
        print branch.nick
 
3384
        self.outf.write('%s\n' % branch.nick)
3220
3385
 
3221
3386
 
3222
3387
class cmd_alias(Command):
3223
 
    """Set/unset and display aliases.
 
3388
    __doc__ = """Set/unset and display aliases.
3224
3389
 
3225
3390
    :Examples:
3226
3391
        Show the current aliases::
3290
3455
 
3291
3456
 
3292
3457
class cmd_selftest(Command):
3293
 
    """Run internal test suite.
 
3458
    __doc__ = """Run internal test suite.
3294
3459
 
3295
3460
    If arguments are given, they are regular expressions that say which tests
3296
3461
    should run.  Tests matching any expression are run, and other tests are
3323
3488
    Tests that need working space on disk use a common temporary directory,
3324
3489
    typically inside $TMPDIR or /tmp.
3325
3490
 
 
3491
    If you set BZR_TEST_PDB=1 when running selftest, failing tests will drop
 
3492
    into a pdb postmortem session.
 
3493
 
3326
3494
    :Examples:
3327
3495
        Run only tests relating to 'ignore'::
3328
3496
 
3337
3505
    def get_transport_type(typestring):
3338
3506
        """Parse and return a transport specifier."""
3339
3507
        if typestring == "sftp":
3340
 
            from bzrlib.transport.sftp import SFTPAbsoluteServer
3341
 
            return SFTPAbsoluteServer
 
3508
            from bzrlib.tests import stub_sftp
 
3509
            return stub_sftp.SFTPAbsoluteServer
3342
3510
        if typestring == "memory":
3343
 
            from bzrlib.transport.memory import MemoryServer
3344
 
            return MemoryServer
 
3511
            from bzrlib.tests import test_server
 
3512
            return memory.MemoryServer
3345
3513
        if typestring == "fakenfs":
3346
 
            from bzrlib.transport.fakenfs import FakeNFSServer
3347
 
            return FakeNFSServer
 
3514
            from bzrlib.tests import test_server
 
3515
            return test_server.FakeNFSServer
3348
3516
        msg = "No known transport type %s. Supported types are: sftp\n" %\
3349
3517
            (typestring)
3350
3518
        raise errors.BzrCommandError(msg)
3365
3533
                     Option('lsprof-timed',
3366
3534
                            help='Generate lsprof output for benchmarked'
3367
3535
                                 ' sections of code.'),
 
3536
                     Option('lsprof-tests',
 
3537
                            help='Generate lsprof output for each test.'),
3368
3538
                     Option('cache-dir', type=str,
3369
3539
                            help='Cache intermediate benchmark output in this '
3370
3540
                                 'directory.'),
3411
3581
            first=False, list_only=False,
3412
3582
            randomize=None, exclude=None, strict=False,
3413
3583
            load_list=None, debugflag=None, starting_with=None, subunit=False,
3414
 
            parallel=None):
 
3584
            parallel=None, lsprof_tests=False):
3415
3585
        from bzrlib.tests import selftest
3416
3586
        import bzrlib.benchmarks as benchmarks
3417
3587
        from bzrlib.benchmarks import tree_creator
3432
3602
                raise errors.BzrCommandError("subunit not available. subunit "
3433
3603
                    "needs to be installed to use --subunit.")
3434
3604
            self.additional_selftest_args['runner_class'] = SubUnitBzrRunner
 
3605
            # On Windows, disable automatic conversion of '\n' to '\r\n' in
 
3606
            # stdout, which would corrupt the subunit stream. 
 
3607
            # FIXME: This has been fixed in subunit trunk (>0.0.5) so the
 
3608
            # following code can be deleted when it's sufficiently deployed
 
3609
            # -- vila/mgz 20100514
 
3610
            if (sys.platform == "win32"
 
3611
                and getattr(sys.stdout, 'fileno', None) is not None):
 
3612
                import msvcrt
 
3613
                msvcrt.setmode(sys.stdout.fileno(), os.O_BINARY)
3435
3614
        if parallel:
3436
3615
            self.additional_selftest_args.setdefault(
3437
3616
                'suite_decorators', []).append(parallel)
3441
3620
            verbose = not is_quiet()
3442
3621
            # TODO: should possibly lock the history file...
3443
3622
            benchfile = open(".perf_history", "at", buffering=1)
 
3623
            self.add_cleanup(benchfile.close)
3444
3624
        else:
3445
3625
            test_suite_factory = None
3446
3626
            benchfile = None
3447
 
        try:
3448
 
            selftest_kwargs = {"verbose": verbose,
3449
 
                              "pattern": pattern,
3450
 
                              "stop_on_failure": one,
3451
 
                              "transport": transport,
3452
 
                              "test_suite_factory": test_suite_factory,
3453
 
                              "lsprof_timed": lsprof_timed,
3454
 
                              "bench_history": benchfile,
3455
 
                              "matching_tests_first": first,
3456
 
                              "list_only": list_only,
3457
 
                              "random_seed": randomize,
3458
 
                              "exclude_pattern": exclude,
3459
 
                              "strict": strict,
3460
 
                              "load_list": load_list,
3461
 
                              "debug_flags": debugflag,
3462
 
                              "starting_with": starting_with
3463
 
                              }
3464
 
            selftest_kwargs.update(self.additional_selftest_args)
3465
 
            result = selftest(**selftest_kwargs)
3466
 
        finally:
3467
 
            if benchfile is not None:
3468
 
                benchfile.close()
 
3627
        selftest_kwargs = {"verbose": verbose,
 
3628
                          "pattern": pattern,
 
3629
                          "stop_on_failure": one,
 
3630
                          "transport": transport,
 
3631
                          "test_suite_factory": test_suite_factory,
 
3632
                          "lsprof_timed": lsprof_timed,
 
3633
                          "lsprof_tests": lsprof_tests,
 
3634
                          "bench_history": benchfile,
 
3635
                          "matching_tests_first": first,
 
3636
                          "list_only": list_only,
 
3637
                          "random_seed": randomize,
 
3638
                          "exclude_pattern": exclude,
 
3639
                          "strict": strict,
 
3640
                          "load_list": load_list,
 
3641
                          "debug_flags": debugflag,
 
3642
                          "starting_with": starting_with
 
3643
                          }
 
3644
        selftest_kwargs.update(self.additional_selftest_args)
 
3645
        result = selftest(**selftest_kwargs)
3469
3646
        return int(not result)
3470
3647
 
3471
3648
 
3472
3649
class cmd_version(Command):
3473
 
    """Show version of bzr."""
 
3650
    __doc__ = """Show version of bzr."""
3474
3651
 
3475
3652
    encoding_type = 'replace'
3476
3653
    takes_options = [
3487
3664
 
3488
3665
 
3489
3666
class cmd_rocks(Command):
3490
 
    """Statement of optimism."""
 
3667
    __doc__ = """Statement of optimism."""
3491
3668
 
3492
3669
    hidden = True
3493
3670
 
3494
3671
    @display_command
3495
3672
    def run(self):
3496
 
        print "It sure does!"
 
3673
        self.outf.write("It sure does!\n")
3497
3674
 
3498
3675
 
3499
3676
class cmd_find_merge_base(Command):
3500
 
    """Find and print a base revision for merging two branches."""
 
3677
    __doc__ = """Find and print a base revision for merging two branches."""
3501
3678
    # TODO: Options to specify revisions on either side, as if
3502
3679
    #       merging only part of the history.
3503
3680
    takes_args = ['branch', 'other']
3509
3686
 
3510
3687
        branch1 = Branch.open_containing(branch)[0]
3511
3688
        branch2 = Branch.open_containing(other)[0]
3512
 
        branch1.lock_read()
3513
 
        try:
3514
 
            branch2.lock_read()
3515
 
            try:
3516
 
                last1 = ensure_null(branch1.last_revision())
3517
 
                last2 = ensure_null(branch2.last_revision())
3518
 
 
3519
 
                graph = branch1.repository.get_graph(branch2.repository)
3520
 
                base_rev_id = graph.find_unique_lca(last1, last2)
3521
 
 
3522
 
                print 'merge base is revision %s' % base_rev_id
3523
 
            finally:
3524
 
                branch2.unlock()
3525
 
        finally:
3526
 
            branch1.unlock()
 
3689
        self.add_cleanup(branch1.lock_read().unlock)
 
3690
        self.add_cleanup(branch2.lock_read().unlock)
 
3691
        last1 = ensure_null(branch1.last_revision())
 
3692
        last2 = ensure_null(branch2.last_revision())
 
3693
 
 
3694
        graph = branch1.repository.get_graph(branch2.repository)
 
3695
        base_rev_id = graph.find_unique_lca(last1, last2)
 
3696
 
 
3697
        self.outf.write('merge base is revision %s\n' % base_rev_id)
3527
3698
 
3528
3699
 
3529
3700
class cmd_merge(Command):
3530
 
    """Perform a three-way merge.
 
3701
    __doc__ = """Perform a three-way merge.
3531
3702
 
3532
3703
    The source of the merge can be specified either in the form of a branch,
3533
3704
    or in the form of a path to a file containing a merge directive generated
3562
3733
    committed to record the result of the merge.
3563
3734
 
3564
3735
    merge refuses to run if there are any uncommitted changes, unless
3565
 
    --force is given.
 
3736
    --force is given. The --force option can also be used to create a
 
3737
    merge revision which has more than two parents.
 
3738
 
 
3739
    If one would like to merge changes from the working tree of the other
 
3740
    branch without merging any committed revisions, the --uncommitted option
 
3741
    can be given.
3566
3742
 
3567
3743
    To select only some changes to merge, use "merge -i", which will prompt
3568
3744
    you to apply each diff hunk and file change, similar to "shelve".
3580
3756
 
3581
3757
            bzr merge -r 81..82 ../bzr.dev
3582
3758
 
3583
 
        To apply a merge directive contained in /tmp/merge:
 
3759
        To apply a merge directive contained in /tmp/merge::
3584
3760
 
3585
3761
            bzr merge /tmp/merge
 
3762
 
 
3763
        To create a merge revision with three parents from two branches
 
3764
        feature1a and feature1b:
 
3765
 
 
3766
            bzr merge ../feature1a
 
3767
            bzr merge ../feature1b --force
 
3768
            bzr commit -m 'revision with three parents'
3586
3769
    """
3587
3770
 
3588
3771
    encoding_type = 'exact'
3604
3787
                ' completely merged into the source, pull from the'
3605
3788
                ' source rather than merging.  When this happens,'
3606
3789
                ' you do not need to commit the result.'),
3607
 
        Option('directory',
 
3790
        custom_help('directory',
3608
3791
               help='Branch to merge into, '
3609
 
                    'rather than the one containing the working directory.',
3610
 
               short_name='d',
3611
 
               type=unicode,
3612
 
               ),
 
3792
                    'rather than the one containing the working directory.'),
3613
3793
        Option('preview', help='Instead of merging, show a diff of the'
3614
3794
               ' merge.'),
3615
3795
        Option('interactive', help='Select changes interactively.',
3633
3813
        verified = 'inapplicable'
3634
3814
        tree = WorkingTree.open_containing(directory)[0]
3635
3815
 
3636
 
        # die as quickly as possible if there are uncommitted changes
3637
3816
        try:
3638
3817
            basis_tree = tree.revision_tree(tree.last_revision())
3639
3818
        except errors.NoSuchRevision:
3640
3819
            basis_tree = tree.basis_tree()
 
3820
 
 
3821
        # die as quickly as possible if there are uncommitted changes
3641
3822
        if not force:
3642
 
            if tree.has_changes(basis_tree):
 
3823
            if tree.has_changes():
3643
3824
                raise errors.UncommittedChanges(tree)
3644
3825
 
3645
3826
        view_info = _get_view_info_for_change_reporter(tree)
3646
3827
        change_reporter = delta._ChangeReporter(
3647
3828
            unversioned_filter=tree.is_ignored, view_info=view_info)
3648
 
        cleanups = []
3649
 
        try:
3650
 
            pb = ui.ui_factory.nested_progress_bar()
3651
 
            cleanups.append(pb.finished)
3652
 
            tree.lock_write()
3653
 
            cleanups.append(tree.unlock)
3654
 
            if location is not None:
3655
 
                try:
3656
 
                    mergeable = bundle.read_mergeable_from_url(location,
3657
 
                        possible_transports=possible_transports)
3658
 
                except errors.NotABundle:
3659
 
                    mergeable = None
3660
 
                else:
3661
 
                    if uncommitted:
3662
 
                        raise errors.BzrCommandError('Cannot use --uncommitted'
3663
 
                            ' with bundles or merge directives.')
3664
 
 
3665
 
                    if revision is not None:
3666
 
                        raise errors.BzrCommandError(
3667
 
                            'Cannot use -r with merge directives or bundles')
3668
 
                    merger, verified = _mod_merge.Merger.from_mergeable(tree,
3669
 
                       mergeable, pb)
3670
 
 
3671
 
            if merger is None and uncommitted:
3672
 
                if revision is not None and len(revision) > 0:
3673
 
                    raise errors.BzrCommandError('Cannot use --uncommitted and'
3674
 
                        ' --revision at the same time.')
3675
 
                merger = self.get_merger_from_uncommitted(tree, location, pb,
3676
 
                                                          cleanups)
3677
 
                allow_pending = False
3678
 
 
3679
 
            if merger is None:
3680
 
                merger, allow_pending = self._get_merger_from_branch(tree,
3681
 
                    location, revision, remember, possible_transports, pb)
3682
 
 
3683
 
            merger.merge_type = merge_type
3684
 
            merger.reprocess = reprocess
3685
 
            merger.show_base = show_base
3686
 
            self.sanity_check_merger(merger)
3687
 
            if (merger.base_rev_id == merger.other_rev_id and
3688
 
                merger.other_rev_id is not None):
3689
 
                note('Nothing to do.')
 
3829
        pb = ui.ui_factory.nested_progress_bar()
 
3830
        self.add_cleanup(pb.finished)
 
3831
        self.add_cleanup(tree.lock_write().unlock)
 
3832
        if location is not None:
 
3833
            try:
 
3834
                mergeable = bundle.read_mergeable_from_url(location,
 
3835
                    possible_transports=possible_transports)
 
3836
            except errors.NotABundle:
 
3837
                mergeable = None
 
3838
            else:
 
3839
                if uncommitted:
 
3840
                    raise errors.BzrCommandError('Cannot use --uncommitted'
 
3841
                        ' with bundles or merge directives.')
 
3842
 
 
3843
                if revision is not None:
 
3844
                    raise errors.BzrCommandError(
 
3845
                        'Cannot use -r with merge directives or bundles')
 
3846
                merger, verified = _mod_merge.Merger.from_mergeable(tree,
 
3847
                   mergeable, None)
 
3848
 
 
3849
        if merger is None and uncommitted:
 
3850
            if revision is not None and len(revision) > 0:
 
3851
                raise errors.BzrCommandError('Cannot use --uncommitted and'
 
3852
                    ' --revision at the same time.')
 
3853
            merger = self.get_merger_from_uncommitted(tree, location, None)
 
3854
            allow_pending = False
 
3855
 
 
3856
        if merger is None:
 
3857
            merger, allow_pending = self._get_merger_from_branch(tree,
 
3858
                location, revision, remember, possible_transports, None)
 
3859
 
 
3860
        merger.merge_type = merge_type
 
3861
        merger.reprocess = reprocess
 
3862
        merger.show_base = show_base
 
3863
        self.sanity_check_merger(merger)
 
3864
        if (merger.base_rev_id == merger.other_rev_id and
 
3865
            merger.other_rev_id is not None):
 
3866
            note('Nothing to do.')
 
3867
            return 0
 
3868
        if pull:
 
3869
            if merger.interesting_files is not None:
 
3870
                raise errors.BzrCommandError('Cannot pull individual files')
 
3871
            if (merger.base_rev_id == tree.last_revision()):
 
3872
                result = tree.pull(merger.other_branch, False,
 
3873
                                   merger.other_rev_id)
 
3874
                result.report(self.outf)
3690
3875
                return 0
3691
 
            if pull:
3692
 
                if merger.interesting_files is not None:
3693
 
                    raise errors.BzrCommandError('Cannot pull individual files')
3694
 
                if (merger.base_rev_id == tree.last_revision()):
3695
 
                    result = tree.pull(merger.other_branch, False,
3696
 
                                       merger.other_rev_id)
3697
 
                    result.report(self.outf)
3698
 
                    return 0
3699
 
            merger.check_basis(False)
3700
 
            if preview:
3701
 
                return self._do_preview(merger, cleanups)
3702
 
            elif interactive:
3703
 
                return self._do_interactive(merger, cleanups)
3704
 
            else:
3705
 
                return self._do_merge(merger, change_reporter, allow_pending,
3706
 
                                      verified)
3707
 
        finally:
3708
 
            for cleanup in reversed(cleanups):
3709
 
                cleanup()
 
3876
        if merger.this_basis is None:
 
3877
            raise errors.BzrCommandError(
 
3878
                "This branch has no commits."
 
3879
                " (perhaps you would prefer 'bzr pull')")
 
3880
        if preview:
 
3881
            return self._do_preview(merger)
 
3882
        elif interactive:
 
3883
            return self._do_interactive(merger)
 
3884
        else:
 
3885
            return self._do_merge(merger, change_reporter, allow_pending,
 
3886
                                  verified)
3710
3887
 
3711
 
    def _get_preview(self, merger, cleanups):
 
3888
    def _get_preview(self, merger):
3712
3889
        tree_merger = merger.make_merger()
3713
3890
        tt = tree_merger.make_preview_transform()
3714
 
        cleanups.append(tt.finalize)
 
3891
        self.add_cleanup(tt.finalize)
3715
3892
        result_tree = tt.get_preview_tree()
3716
3893
        return result_tree
3717
3894
 
3718
 
    def _do_preview(self, merger, cleanups):
 
3895
    def _do_preview(self, merger):
3719
3896
        from bzrlib.diff import show_diff_trees
3720
 
        result_tree = self._get_preview(merger, cleanups)
 
3897
        result_tree = self._get_preview(merger)
 
3898
        path_encoding = osutils.get_diff_header_encoding()
3721
3899
        show_diff_trees(merger.this_tree, result_tree, self.outf,
3722
 
                        old_label='', new_label='')
 
3900
                        old_label='', new_label='',
 
3901
                        path_encoding=path_encoding)
3723
3902
 
3724
3903
    def _do_merge(self, merger, change_reporter, allow_pending, verified):
3725
3904
        merger.change_reporter = change_reporter
3733
3912
        else:
3734
3913
            return 0
3735
3914
 
3736
 
    def _do_interactive(self, merger, cleanups):
 
3915
    def _do_interactive(self, merger):
3737
3916
        """Perform an interactive merge.
3738
3917
 
3739
3918
        This works by generating a preview tree of the merge, then using
3741
3920
        and the preview tree.
3742
3921
        """
3743
3922
        from bzrlib import shelf_ui
3744
 
        result_tree = self._get_preview(merger, cleanups)
 
3923
        result_tree = self._get_preview(merger)
3745
3924
        writer = bzrlib.option.diff_writer_registry.get()
3746
3925
        shelver = shelf_ui.Shelver(merger.this_tree, result_tree, destroy=True,
3747
3926
                                   reporter=shelf_ui.ApplyReporter(),
3748
3927
                                   diff_writer=writer(sys.stdout))
3749
 
        shelver.run()
 
3928
        try:
 
3929
            shelver.run()
 
3930
        finally:
 
3931
            shelver.finalize()
3750
3932
 
3751
3933
    def sanity_check_merger(self, merger):
3752
3934
        if (merger.show_base and
3812
3994
            allow_pending = True
3813
3995
        return merger, allow_pending
3814
3996
 
3815
 
    def get_merger_from_uncommitted(self, tree, location, pb, cleanups):
 
3997
    def get_merger_from_uncommitted(self, tree, location, pb):
3816
3998
        """Get a merger for uncommitted changes.
3817
3999
 
3818
4000
        :param tree: The tree the merger should apply to.
3819
4001
        :param location: The location containing uncommitted changes.
3820
4002
        :param pb: The progress bar to use for showing progress.
3821
 
        :param cleanups: A list of operations to perform to clean up the
3822
 
            temporary directories, unfinalized objects, etc.
3823
4003
        """
3824
4004
        location = self._select_branch_location(tree, location)[0]
3825
4005
        other_tree, other_path = WorkingTree.open_containing(location)
3877
4057
 
3878
4058
 
3879
4059
class cmd_remerge(Command):
3880
 
    """Redo a merge.
 
4060
    __doc__ = """Redo a merge.
3881
4061
 
3882
4062
    Use this if you want to try a different merge technique while resolving
3883
4063
    conflicts.  Some merge techniques are better than others, and remerge
3908
4088
 
3909
4089
    def run(self, file_list=None, merge_type=None, show_base=False,
3910
4090
            reprocess=False):
 
4091
        from bzrlib.conflicts import restore
3911
4092
        if merge_type is None:
3912
4093
            merge_type = _mod_merge.Merge3Merger
3913
4094
        tree, file_list = tree_files(file_list)
3914
 
        tree.lock_write()
3915
 
        try:
3916
 
            parents = tree.get_parent_ids()
3917
 
            if len(parents) != 2:
3918
 
                raise errors.BzrCommandError("Sorry, remerge only works after normal"
3919
 
                                             " merges.  Not cherrypicking or"
3920
 
                                             " multi-merges.")
3921
 
            repository = tree.branch.repository
3922
 
            interesting_ids = None
3923
 
            new_conflicts = []
3924
 
            conflicts = tree.conflicts()
3925
 
            if file_list is not None:
3926
 
                interesting_ids = set()
3927
 
                for filename in file_list:
3928
 
                    file_id = tree.path2id(filename)
3929
 
                    if file_id is None:
3930
 
                        raise errors.NotVersionedError(filename)
3931
 
                    interesting_ids.add(file_id)
3932
 
                    if tree.kind(file_id) != "directory":
3933
 
                        continue
 
4095
        self.add_cleanup(tree.lock_write().unlock)
 
4096
        parents = tree.get_parent_ids()
 
4097
        if len(parents) != 2:
 
4098
            raise errors.BzrCommandError("Sorry, remerge only works after normal"
 
4099
                                         " merges.  Not cherrypicking or"
 
4100
                                         " multi-merges.")
 
4101
        repository = tree.branch.repository
 
4102
        interesting_ids = None
 
4103
        new_conflicts = []
 
4104
        conflicts = tree.conflicts()
 
4105
        if file_list is not None:
 
4106
            interesting_ids = set()
 
4107
            for filename in file_list:
 
4108
                file_id = tree.path2id(filename)
 
4109
                if file_id is None:
 
4110
                    raise errors.NotVersionedError(filename)
 
4111
                interesting_ids.add(file_id)
 
4112
                if tree.kind(file_id) != "directory":
 
4113
                    continue
3934
4114
 
3935
 
                    for name, ie in tree.inventory.iter_entries(file_id):
3936
 
                        interesting_ids.add(ie.file_id)
3937
 
                new_conflicts = conflicts.select_conflicts(tree, file_list)[0]
3938
 
            else:
3939
 
                # Remerge only supports resolving contents conflicts
3940
 
                allowed_conflicts = ('text conflict', 'contents conflict')
3941
 
                restore_files = [c.path for c in conflicts
3942
 
                                 if c.typestring in allowed_conflicts]
3943
 
            _mod_merge.transform_tree(tree, tree.basis_tree(), interesting_ids)
3944
 
            tree.set_conflicts(ConflictList(new_conflicts))
3945
 
            if file_list is not None:
3946
 
                restore_files = file_list
3947
 
            for filename in restore_files:
3948
 
                try:
3949
 
                    restore(tree.abspath(filename))
3950
 
                except errors.NotConflicted:
3951
 
                    pass
3952
 
            # Disable pending merges, because the file texts we are remerging
3953
 
            # have not had those merges performed.  If we use the wrong parents
3954
 
            # list, we imply that the working tree text has seen and rejected
3955
 
            # all the changes from the other tree, when in fact those changes
3956
 
            # have not yet been seen.
3957
 
            pb = ui.ui_factory.nested_progress_bar()
3958
 
            tree.set_parent_ids(parents[:1])
 
4115
                for name, ie in tree.inventory.iter_entries(file_id):
 
4116
                    interesting_ids.add(ie.file_id)
 
4117
            new_conflicts = conflicts.select_conflicts(tree, file_list)[0]
 
4118
        else:
 
4119
            # Remerge only supports resolving contents conflicts
 
4120
            allowed_conflicts = ('text conflict', 'contents conflict')
 
4121
            restore_files = [c.path for c in conflicts
 
4122
                             if c.typestring in allowed_conflicts]
 
4123
        _mod_merge.transform_tree(tree, tree.basis_tree(), interesting_ids)
 
4124
        tree.set_conflicts(ConflictList(new_conflicts))
 
4125
        if file_list is not None:
 
4126
            restore_files = file_list
 
4127
        for filename in restore_files:
3959
4128
            try:
3960
 
                merger = _mod_merge.Merger.from_revision_ids(pb,
3961
 
                                                             tree, parents[1])
3962
 
                merger.interesting_ids = interesting_ids
3963
 
                merger.merge_type = merge_type
3964
 
                merger.show_base = show_base
3965
 
                merger.reprocess = reprocess
3966
 
                conflicts = merger.do_merge()
3967
 
            finally:
3968
 
                tree.set_parent_ids(parents)
3969
 
                pb.finished()
 
4129
                restore(tree.abspath(filename))
 
4130
            except errors.NotConflicted:
 
4131
                pass
 
4132
        # Disable pending merges, because the file texts we are remerging
 
4133
        # have not had those merges performed.  If we use the wrong parents
 
4134
        # list, we imply that the working tree text has seen and rejected
 
4135
        # all the changes from the other tree, when in fact those changes
 
4136
        # have not yet been seen.
 
4137
        tree.set_parent_ids(parents[:1])
 
4138
        try:
 
4139
            merger = _mod_merge.Merger.from_revision_ids(None, tree, parents[1])
 
4140
            merger.interesting_ids = interesting_ids
 
4141
            merger.merge_type = merge_type
 
4142
            merger.show_base = show_base
 
4143
            merger.reprocess = reprocess
 
4144
            conflicts = merger.do_merge()
3970
4145
        finally:
3971
 
            tree.unlock()
 
4146
            tree.set_parent_ids(parents)
3972
4147
        if conflicts > 0:
3973
4148
            return 1
3974
4149
        else:
3976
4151
 
3977
4152
 
3978
4153
class cmd_revert(Command):
3979
 
    """Revert files to a previous revision.
 
4154
    __doc__ = """Revert files to a previous revision.
3980
4155
 
3981
4156
    Giving a list of files will revert only those files.  Otherwise, all files
3982
4157
    will be reverted.  If the revision is not specified with '--revision', the
3996
4171
    name.  If you name a directory, all the contents of that directory will be
3997
4172
    reverted.
3998
4173
 
3999
 
    Any files that have been newly added since that revision will be deleted,
4000
 
    with a backup kept if appropriate.  Directories containing unknown files
4001
 
    will not be deleted.
 
4174
    If you have newly added files since the target revision, they will be
 
4175
    removed.  If the files to be removed have been changed, backups will be
 
4176
    created as above.  Directories containing unknown files will not be
 
4177
    deleted.
4002
4178
 
4003
 
    The working tree contains a list of pending merged revisions, which will
4004
 
    be included as parents in the next commit.  Normally, revert clears that
4005
 
    list as well as reverting the files.  If any files are specified, revert
4006
 
    leaves the pending merge list alone and reverts only the files.  Use "bzr
4007
 
    revert ." in the tree root to revert all files but keep the merge record,
4008
 
    and "bzr revert --forget-merges" to clear the pending merge list without
 
4179
    The working tree contains a list of revisions that have been merged but
 
4180
    not yet committed. These revisions will be included as additional parents
 
4181
    of the next commit.  Normally, using revert clears that list as well as
 
4182
    reverting the files.  If any files are specified, revert leaves the list
 
4183
    of uncommitted merges alone and reverts only the files.  Use ``bzr revert
 
4184
    .`` in the tree root to revert all files but keep the recorded merges,
 
4185
    and ``bzr revert --forget-merges`` to clear the pending merge list without
4009
4186
    reverting any files.
 
4187
 
 
4188
    Using "bzr revert --forget-merges", it is possible to apply all of the
 
4189
    changes from a branch in a single revision.  To do this, perform the merge
 
4190
    as desired.  Then doing revert with the "--forget-merges" option will keep
 
4191
    the content of the tree as it was, but it will clear the list of pending
 
4192
    merges.  The next commit will then contain all of the changes that are
 
4193
    present in the other branch, but without any other parent revisions.
 
4194
    Because this technique forgets where these changes originated, it may
 
4195
    cause additional conflicts on later merges involving the same source and
 
4196
    target branches.
4010
4197
    """
4011
4198
 
4012
4199
    _see_also = ['cat', 'export']
4021
4208
    def run(self, revision=None, no_backup=False, file_list=None,
4022
4209
            forget_merges=None):
4023
4210
        tree, file_list = tree_files(file_list)
4024
 
        tree.lock_write()
4025
 
        try:
4026
 
            if forget_merges:
4027
 
                tree.set_parent_ids(tree.get_parent_ids()[:1])
4028
 
            else:
4029
 
                self._revert_tree_to_revision(tree, revision, file_list, no_backup)
4030
 
        finally:
4031
 
            tree.unlock()
 
4211
        self.add_cleanup(tree.lock_tree_write().unlock)
 
4212
        if forget_merges:
 
4213
            tree.set_parent_ids(tree.get_parent_ids()[:1])
 
4214
        else:
 
4215
            self._revert_tree_to_revision(tree, revision, file_list, no_backup)
4032
4216
 
4033
4217
    @staticmethod
4034
4218
    def _revert_tree_to_revision(tree, revision, file_list, no_backup):
4035
4219
        rev_tree = _get_one_revision_tree('revert', revision, tree=tree)
4036
 
        pb = ui.ui_factory.nested_progress_bar()
4037
 
        try:
4038
 
            tree.revert(file_list, rev_tree, not no_backup, pb,
4039
 
                report_changes=True)
4040
 
        finally:
4041
 
            pb.finished()
 
4220
        tree.revert(file_list, rev_tree, not no_backup, None,
 
4221
            report_changes=True)
4042
4222
 
4043
4223
 
4044
4224
class cmd_assert_fail(Command):
4045
 
    """Test reporting of assertion failures"""
 
4225
    __doc__ = """Test reporting of assertion failures"""
4046
4226
    # intended just for use in testing
4047
4227
 
4048
4228
    hidden = True
4052
4232
 
4053
4233
 
4054
4234
class cmd_help(Command):
4055
 
    """Show help on a command or other topic.
 
4235
    __doc__ = """Show help on a command or other topic.
4056
4236
    """
4057
4237
 
4058
4238
    _see_also = ['topics']
4071
4251
 
4072
4252
 
4073
4253
class cmd_shell_complete(Command):
4074
 
    """Show appropriate completions for context.
 
4254
    __doc__ = """Show appropriate completions for context.
4075
4255
 
4076
4256
    For a list of all available commands, say 'bzr shell-complete'.
4077
4257
    """
4086
4266
 
4087
4267
 
4088
4268
class cmd_missing(Command):
4089
 
    """Show unmerged/unpulled revisions between two branches.
 
4269
    __doc__ = """Show unmerged/unpulled revisions between two branches.
4090
4270
 
4091
4271
    OTHER_BRANCH may be local or remote.
4092
4272
 
4093
4273
    To filter on a range of revisions, you can use the command -r begin..end
4094
4274
    -r revision requests a specific revision, -r ..end or -r begin.. are
4095
4275
    also valid.
 
4276
            
 
4277
    :Exit values:
 
4278
        1 - some missing revisions
 
4279
        0 - no missing revisions
4096
4280
 
4097
4281
    :Examples:
4098
4282
 
4119
4303
    _see_also = ['merge', 'pull']
4120
4304
    takes_args = ['other_branch?']
4121
4305
    takes_options = [
 
4306
        'directory',
4122
4307
        Option('reverse', 'Reverse the order of revisions.'),
4123
4308
        Option('mine-only',
4124
4309
               'Display changes in the local branch only.'),
4146
4331
            theirs_only=False,
4147
4332
            log_format=None, long=False, short=False, line=False,
4148
4333
            show_ids=False, verbose=False, this=False, other=False,
4149
 
            include_merges=False, revision=None, my_revision=None):
 
4334
            include_merges=False, revision=None, my_revision=None,
 
4335
            directory=u'.'):
4150
4336
        from bzrlib.missing import find_unmerged, iter_log_revisions
4151
4337
        def message(s):
4152
4338
            if not is_quiet():
4165
4351
        elif theirs_only:
4166
4352
            restrict = 'remote'
4167
4353
 
4168
 
        local_branch = Branch.open_containing(u".")[0]
 
4354
        local_branch = Branch.open_containing(directory)[0]
 
4355
        self.add_cleanup(local_branch.lock_read().unlock)
 
4356
 
4169
4357
        parent = local_branch.get_parent()
4170
4358
        if other_branch is None:
4171
4359
            other_branch = parent
4180
4368
        remote_branch = Branch.open(other_branch)
4181
4369
        if remote_branch.base == local_branch.base:
4182
4370
            remote_branch = local_branch
 
4371
        else:
 
4372
            self.add_cleanup(remote_branch.lock_read().unlock)
4183
4373
 
4184
4374
        local_revid_range = _revision_range_to_revid_range(
4185
4375
            _get_revision_range(my_revision, local_branch,
4189
4379
            _get_revision_range(revision,
4190
4380
                remote_branch, self.name()))
4191
4381
 
4192
 
        local_branch.lock_read()
4193
 
        try:
4194
 
            remote_branch.lock_read()
4195
 
            try:
4196
 
                local_extra, remote_extra = find_unmerged(
4197
 
                    local_branch, remote_branch, restrict,
4198
 
                    backward=not reverse,
4199
 
                    include_merges=include_merges,
4200
 
                    local_revid_range=local_revid_range,
4201
 
                    remote_revid_range=remote_revid_range)
4202
 
 
4203
 
                if log_format is None:
4204
 
                    registry = log.log_formatter_registry
4205
 
                    log_format = registry.get_default(local_branch)
4206
 
                lf = log_format(to_file=self.outf,
4207
 
                                show_ids=show_ids,
4208
 
                                show_timezone='original')
4209
 
 
4210
 
                status_code = 0
4211
 
                if local_extra and not theirs_only:
4212
 
                    message("You have %d extra revision(s):\n" %
4213
 
                        len(local_extra))
4214
 
                    for revision in iter_log_revisions(local_extra,
4215
 
                                        local_branch.repository,
4216
 
                                        verbose):
4217
 
                        lf.log_revision(revision)
4218
 
                    printed_local = True
4219
 
                    status_code = 1
4220
 
                else:
4221
 
                    printed_local = False
4222
 
 
4223
 
                if remote_extra and not mine_only:
4224
 
                    if printed_local is True:
4225
 
                        message("\n\n\n")
4226
 
                    message("You are missing %d revision(s):\n" %
4227
 
                        len(remote_extra))
4228
 
                    for revision in iter_log_revisions(remote_extra,
4229
 
                                        remote_branch.repository,
4230
 
                                        verbose):
4231
 
                        lf.log_revision(revision)
4232
 
                    status_code = 1
4233
 
 
4234
 
                if mine_only and not local_extra:
4235
 
                    # We checked local, and found nothing extra
4236
 
                    message('This branch is up to date.\n')
4237
 
                elif theirs_only and not remote_extra:
4238
 
                    # We checked remote, and found nothing extra
4239
 
                    message('Other branch is up to date.\n')
4240
 
                elif not (mine_only or theirs_only or local_extra or
4241
 
                          remote_extra):
4242
 
                    # We checked both branches, and neither one had extra
4243
 
                    # revisions
4244
 
                    message("Branches are up to date.\n")
4245
 
            finally:
4246
 
                remote_branch.unlock()
4247
 
        finally:
4248
 
            local_branch.unlock()
 
4382
        local_extra, remote_extra = find_unmerged(
 
4383
            local_branch, remote_branch, restrict,
 
4384
            backward=not reverse,
 
4385
            include_merges=include_merges,
 
4386
            local_revid_range=local_revid_range,
 
4387
            remote_revid_range=remote_revid_range)
 
4388
 
 
4389
        if log_format is None:
 
4390
            registry = log.log_formatter_registry
 
4391
            log_format = registry.get_default(local_branch)
 
4392
        lf = log_format(to_file=self.outf,
 
4393
                        show_ids=show_ids,
 
4394
                        show_timezone='original')
 
4395
 
 
4396
        status_code = 0
 
4397
        if local_extra and not theirs_only:
 
4398
            message("You have %d extra revision(s):\n" %
 
4399
                len(local_extra))
 
4400
            for revision in iter_log_revisions(local_extra,
 
4401
                                local_branch.repository,
 
4402
                                verbose):
 
4403
                lf.log_revision(revision)
 
4404
            printed_local = True
 
4405
            status_code = 1
 
4406
        else:
 
4407
            printed_local = False
 
4408
 
 
4409
        if remote_extra and not mine_only:
 
4410
            if printed_local is True:
 
4411
                message("\n\n\n")
 
4412
            message("You are missing %d revision(s):\n" %
 
4413
                len(remote_extra))
 
4414
            for revision in iter_log_revisions(remote_extra,
 
4415
                                remote_branch.repository,
 
4416
                                verbose):
 
4417
                lf.log_revision(revision)
 
4418
            status_code = 1
 
4419
 
 
4420
        if mine_only and not local_extra:
 
4421
            # We checked local, and found nothing extra
 
4422
            message('This branch is up to date.\n')
 
4423
        elif theirs_only and not remote_extra:
 
4424
            # We checked remote, and found nothing extra
 
4425
            message('Other branch is up to date.\n')
 
4426
        elif not (mine_only or theirs_only or local_extra or
 
4427
                  remote_extra):
 
4428
            # We checked both branches, and neither one had extra
 
4429
            # revisions
 
4430
            message("Branches are up to date.\n")
 
4431
        self.cleanup_now()
4249
4432
        if not status_code and parent is None and other_branch is not None:
4250
 
            local_branch.lock_write()
4251
 
            try:
4252
 
                # handle race conditions - a parent might be set while we run.
4253
 
                if local_branch.get_parent() is None:
4254
 
                    local_branch.set_parent(remote_branch.base)
4255
 
            finally:
4256
 
                local_branch.unlock()
 
4433
            self.add_cleanup(local_branch.lock_write().unlock)
 
4434
            # handle race conditions - a parent might be set while we run.
 
4435
            if local_branch.get_parent() is None:
 
4436
                local_branch.set_parent(remote_branch.base)
4257
4437
        return status_code
4258
4438
 
4259
4439
 
4260
4440
class cmd_pack(Command):
4261
 
    """Compress the data within a repository."""
 
4441
    __doc__ = """Compress the data within a repository.
 
4442
 
 
4443
    This operation compresses the data within a bazaar repository. As
 
4444
    bazaar supports automatic packing of repository, this operation is
 
4445
    normally not required to be done manually.
 
4446
 
 
4447
    During the pack operation, bazaar takes a backup of existing repository
 
4448
    data, i.e. pack files. This backup is eventually removed by bazaar
 
4449
    automatically when it is safe to do so. To save disk space by removing
 
4450
    the backed up pack files, the --clean-obsolete-packs option may be
 
4451
    used.
 
4452
 
 
4453
    Warning: If you use --clean-obsolete-packs and your machine crashes
 
4454
    during or immediately after repacking, you may be left with a state
 
4455
    where the deletion has been written to disk but the new packs have not
 
4456
    been. In this case the repository may be unusable.
 
4457
    """
4262
4458
 
4263
4459
    _see_also = ['repositories']
4264
4460
    takes_args = ['branch_or_repo?']
 
4461
    takes_options = [
 
4462
        Option('clean-obsolete-packs', 'Delete obsolete packs to save disk space.'),
 
4463
        ]
4265
4464
 
4266
 
    def run(self, branch_or_repo='.'):
 
4465
    def run(self, branch_or_repo='.', clean_obsolete_packs=False):
4267
4466
        dir = bzrdir.BzrDir.open_containing(branch_or_repo)[0]
4268
4467
        try:
4269
4468
            branch = dir.open_branch()
4270
4469
            repository = branch.repository
4271
4470
        except errors.NotBranchError:
4272
4471
            repository = dir.open_repository()
4273
 
        repository.pack()
 
4472
        repository.pack(clean_obsolete_packs=clean_obsolete_packs)
4274
4473
 
4275
4474
 
4276
4475
class cmd_plugins(Command):
4277
 
    """List the installed plugins.
 
4476
    __doc__ = """List the installed plugins.
4278
4477
 
4279
4478
    This command displays the list of installed plugins including
4280
4479
    version of plugin and a short description of each.
4287
4486
    adding new commands, providing additional network transports and
4288
4487
    customizing log output.
4289
4488
 
4290
 
    See the Bazaar web site, http://bazaar-vcs.org, for further
4291
 
    information on plugins including where to find them and how to
4292
 
    install them. Instructions are also provided there on how to
4293
 
    write new plugins using the Python programming language.
 
4489
    See the Bazaar Plugin Guide <http://doc.bazaar.canonical.com/plugins/en/>
 
4490
    for further information on plugins including where to find them and how to
 
4491
    install them. Instructions are also provided there on how to write new
 
4492
    plugins using the Python programming language.
4294
4493
    """
4295
4494
    takes_options = ['verbose']
4296
4495
 
4311
4510
                doc = '(no description)'
4312
4511
            result.append((name_ver, doc, plugin.path()))
4313
4512
        for name_ver, doc, path in sorted(result):
4314
 
            print name_ver
4315
 
            print '   ', doc
 
4513
            self.outf.write("%s\n" % name_ver)
 
4514
            self.outf.write("   %s\n" % doc)
4316
4515
            if verbose:
4317
 
                print '   ', path
4318
 
            print
 
4516
                self.outf.write("   %s\n" % path)
 
4517
            self.outf.write("\n")
4319
4518
 
4320
4519
 
4321
4520
class cmd_testament(Command):
4322
 
    """Show testament (signing-form) of a revision."""
 
4521
    __doc__ = """Show testament (signing-form) of a revision."""
4323
4522
    takes_options = [
4324
4523
            'revision',
4325
4524
            Option('long', help='Produce long-format testament.'),
4337
4536
            b = Branch.open_containing(branch)[0]
4338
4537
        else:
4339
4538
            b = Branch.open(branch)
4340
 
        b.lock_read()
4341
 
        try:
4342
 
            if revision is None:
4343
 
                rev_id = b.last_revision()
4344
 
            else:
4345
 
                rev_id = revision[0].as_revision_id(b)
4346
 
            t = testament_class.from_revision(b.repository, rev_id)
4347
 
            if long:
4348
 
                sys.stdout.writelines(t.as_text_lines())
4349
 
            else:
4350
 
                sys.stdout.write(t.as_short_text())
4351
 
        finally:
4352
 
            b.unlock()
 
4539
        self.add_cleanup(b.lock_read().unlock)
 
4540
        if revision is None:
 
4541
            rev_id = b.last_revision()
 
4542
        else:
 
4543
            rev_id = revision[0].as_revision_id(b)
 
4544
        t = testament_class.from_revision(b.repository, rev_id)
 
4545
        if long:
 
4546
            sys.stdout.writelines(t.as_text_lines())
 
4547
        else:
 
4548
            sys.stdout.write(t.as_short_text())
4353
4549
 
4354
4550
 
4355
4551
class cmd_annotate(Command):
4356
 
    """Show the origin of each line in a file.
 
4552
    __doc__ = """Show the origin of each line in a file.
4357
4553
 
4358
4554
    This prints out the given file with an annotation on the left side
4359
4555
    indicating which revision, author and date introduced the change.
4370
4566
                     Option('long', help='Show commit date in annotations.'),
4371
4567
                     'revision',
4372
4568
                     'show-ids',
 
4569
                     'directory',
4373
4570
                     ]
4374
4571
    encoding_type = 'exact'
4375
4572
 
4376
4573
    @display_command
4377
4574
    def run(self, filename, all=False, long=False, revision=None,
4378
 
            show_ids=False):
 
4575
            show_ids=False, directory=None):
4379
4576
        from bzrlib.annotate import annotate_file, annotate_file_tree
4380
4577
        wt, branch, relpath = \
4381
 
            bzrdir.BzrDir.open_containing_tree_or_branch(filename)
4382
 
        if wt is not None:
4383
 
            wt.lock_read()
4384
 
        else:
4385
 
            branch.lock_read()
4386
 
        try:
4387
 
            tree = _get_one_revision_tree('annotate', revision, branch=branch)
4388
 
            if wt is not None:
4389
 
                file_id = wt.path2id(relpath)
4390
 
            else:
4391
 
                file_id = tree.path2id(relpath)
4392
 
            if file_id is None:
4393
 
                raise errors.NotVersionedError(filename)
4394
 
            file_version = tree.inventory[file_id].revision
4395
 
            if wt is not None and revision is None:
4396
 
                # If there is a tree and we're not annotating historical
4397
 
                # versions, annotate the working tree's content.
4398
 
                annotate_file_tree(wt, file_id, self.outf, long, all,
4399
 
                    show_ids=show_ids)
4400
 
            else:
4401
 
                annotate_file(branch, file_version, file_id, long, all, self.outf,
4402
 
                              show_ids=show_ids)
4403
 
        finally:
4404
 
            if wt is not None:
4405
 
                wt.unlock()
4406
 
            else:
4407
 
                branch.unlock()
 
4578
            _open_directory_or_containing_tree_or_branch(filename, directory)
 
4579
        if wt is not None:
 
4580
            self.add_cleanup(wt.lock_read().unlock)
 
4581
        else:
 
4582
            self.add_cleanup(branch.lock_read().unlock)
 
4583
        tree = _get_one_revision_tree('annotate', revision, branch=branch)
 
4584
        self.add_cleanup(tree.lock_read().unlock)
 
4585
        if wt is not None:
 
4586
            file_id = wt.path2id(relpath)
 
4587
        else:
 
4588
            file_id = tree.path2id(relpath)
 
4589
        if file_id is None:
 
4590
            raise errors.NotVersionedError(filename)
 
4591
        file_version = tree.inventory[file_id].revision
 
4592
        if wt is not None and revision is None:
 
4593
            # If there is a tree and we're not annotating historical
 
4594
            # versions, annotate the working tree's content.
 
4595
            annotate_file_tree(wt, file_id, self.outf, long, all,
 
4596
                show_ids=show_ids)
 
4597
        else:
 
4598
            annotate_file(branch, file_version, file_id, long, all, self.outf,
 
4599
                          show_ids=show_ids)
4408
4600
 
4409
4601
 
4410
4602
class cmd_re_sign(Command):
4411
 
    """Create a digital signature for an existing revision."""
 
4603
    __doc__ = """Create a digital signature for an existing revision."""
4412
4604
    # TODO be able to replace existing ones.
4413
4605
 
4414
4606
    hidden = True # is this right ?
4415
4607
    takes_args = ['revision_id*']
4416
 
    takes_options = ['revision']
 
4608
    takes_options = ['directory', 'revision']
4417
4609
 
4418
 
    def run(self, revision_id_list=None, revision=None):
 
4610
    def run(self, revision_id_list=None, revision=None, directory=u'.'):
4419
4611
        if revision_id_list is not None and revision is not None:
4420
4612
            raise errors.BzrCommandError('You can only supply one of revision_id or --revision')
4421
4613
        if revision_id_list is None and revision is None:
4422
4614
            raise errors.BzrCommandError('You must supply either --revision or a revision_id')
4423
 
        b = WorkingTree.open_containing(u'.')[0].branch
4424
 
        b.lock_write()
4425
 
        try:
4426
 
            return self._run(b, revision_id_list, revision)
4427
 
        finally:
4428
 
            b.unlock()
 
4615
        b = WorkingTree.open_containing(directory)[0].branch
 
4616
        self.add_cleanup(b.lock_write().unlock)
 
4617
        return self._run(b, revision_id_list, revision)
4429
4618
 
4430
4619
    def _run(self, b, revision_id_list, revision):
4431
4620
        import bzrlib.gpg as gpg
4476
4665
 
4477
4666
 
4478
4667
class cmd_bind(Command):
4479
 
    """Convert the current branch into a checkout of the supplied branch.
 
4668
    __doc__ = """Convert the current branch into a checkout of the supplied branch.
 
4669
    If no branch is supplied, rebind to the last bound location.
4480
4670
 
4481
4671
    Once converted into a checkout, commits must succeed on the master branch
4482
4672
    before they will be applied to the local branch.
4483
4673
 
4484
4674
    Bound branches use the nickname of its master branch unless it is set
4485
 
    locally, in which case binding will update the the local nickname to be
 
4675
    locally, in which case binding will update the local nickname to be
4486
4676
    that of the master.
4487
4677
    """
4488
4678
 
4489
4679
    _see_also = ['checkouts', 'unbind']
4490
4680
    takes_args = ['location?']
4491
 
    takes_options = []
 
4681
    takes_options = ['directory']
4492
4682
 
4493
 
    def run(self, location=None):
4494
 
        b, relpath = Branch.open_containing(u'.')
 
4683
    def run(self, location=None, directory=u'.'):
 
4684
        b, relpath = Branch.open_containing(directory)
4495
4685
        if location is None:
4496
4686
            try:
4497
4687
                location = b.get_old_bound_location()
4500
4690
                    'This format does not remember old locations.')
4501
4691
            else:
4502
4692
                if location is None:
4503
 
                    raise errors.BzrCommandError('No location supplied and no '
4504
 
                        'previous location known')
 
4693
                    if b.get_bound_location() is not None:
 
4694
                        raise errors.BzrCommandError('Branch is already bound')
 
4695
                    else:
 
4696
                        raise errors.BzrCommandError('No location supplied '
 
4697
                            'and no previous location known')
4505
4698
        b_other = Branch.open(location)
4506
4699
        try:
4507
4700
            b.bind(b_other)
4513
4706
 
4514
4707
 
4515
4708
class cmd_unbind(Command):
4516
 
    """Convert the current checkout into a regular branch.
 
4709
    __doc__ = """Convert the current checkout into a regular branch.
4517
4710
 
4518
4711
    After unbinding, the local branch is considered independent and subsequent
4519
4712
    commits will be local only.
4521
4714
 
4522
4715
    _see_also = ['checkouts', 'bind']
4523
4716
    takes_args = []
4524
 
    takes_options = []
 
4717
    takes_options = ['directory']
4525
4718
 
4526
 
    def run(self):
4527
 
        b, relpath = Branch.open_containing(u'.')
 
4719
    def run(self, directory=u'.'):
 
4720
        b, relpath = Branch.open_containing(directory)
4528
4721
        if not b.unbind():
4529
4722
            raise errors.BzrCommandError('Local branch is not bound')
4530
4723
 
4531
4724
 
4532
4725
class cmd_uncommit(Command):
4533
 
    """Remove the last committed revision.
 
4726
    __doc__ = """Remove the last committed revision.
4534
4727
 
4535
4728
    --verbose will print out what is being removed.
4536
4729
    --dry-run will go through all the motions, but not actually
4576
4769
            b = control.open_branch()
4577
4770
 
4578
4771
        if tree is not None:
4579
 
            tree.lock_write()
 
4772
            self.add_cleanup(tree.lock_write().unlock)
4580
4773
        else:
4581
 
            b.lock_write()
4582
 
        try:
4583
 
            return self._run(b, tree, dry_run, verbose, revision, force,
4584
 
                             local=local)
4585
 
        finally:
4586
 
            if tree is not None:
4587
 
                tree.unlock()
4588
 
            else:
4589
 
                b.unlock()
 
4774
            self.add_cleanup(b.lock_write().unlock)
 
4775
        return self._run(b, tree, dry_run, verbose, revision, force, local=local)
4590
4776
 
4591
4777
    def _run(self, b, tree, dry_run, verbose, revision, force, local=False):
4592
4778
        from bzrlib.log import log_formatter, show_log
4624
4810
                 end_revision=last_revno)
4625
4811
 
4626
4812
        if dry_run:
4627
 
            print 'Dry-run, pretending to remove the above revisions.'
4628
 
            if not force:
4629
 
                val = raw_input('Press <enter> to continue')
 
4813
            self.outf.write('Dry-run, pretending to remove'
 
4814
                            ' the above revisions.\n')
4630
4815
        else:
4631
 
            print 'The above revision(s) will be removed.'
4632
 
            if not force:
4633
 
                val = raw_input('Are you sure [y/N]? ')
4634
 
                if val.lower() not in ('y', 'yes'):
4635
 
                    print 'Canceled'
4636
 
                    return 0
 
4816
            self.outf.write('The above revision(s) will be removed.\n')
 
4817
 
 
4818
        if not force:
 
4819
            if not ui.ui_factory.get_boolean('Are you sure'):
 
4820
                self.outf.write('Canceled')
 
4821
                return 0
4637
4822
 
4638
4823
        mutter('Uncommitting from {%s} to {%s}',
4639
4824
               last_rev_id, rev_id)
4640
4825
        uncommit(b, tree=tree, dry_run=dry_run, verbose=verbose,
4641
4826
                 revno=revno, local=local)
4642
 
        note('You can restore the old tip by running:\n'
4643
 
             '  bzr pull . -r revid:%s', last_rev_id)
 
4827
        self.outf.write('You can restore the old tip by running:\n'
 
4828
             '  bzr pull . -r revid:%s\n' % last_rev_id)
4644
4829
 
4645
4830
 
4646
4831
class cmd_break_lock(Command):
4647
 
    """Break a dead lock on a repository, branch or working directory.
 
4832
    __doc__ = """Break a dead lock on a repository, branch or working directory.
4648
4833
 
4649
4834
    CAUTION: Locks should only be broken when you are sure that the process
4650
4835
    holding the lock has been stopped.
4651
4836
 
4652
 
    You can get information on what locks are open via the 'bzr info' command.
 
4837
    You can get information on what locks are open via the 'bzr info
 
4838
    [location]' command.
4653
4839
 
4654
4840
    :Examples:
4655
4841
        bzr break-lock
 
4842
        bzr break-lock bzr+ssh://example.com/bzr/foo
4656
4843
    """
4657
4844
    takes_args = ['location?']
4658
4845
 
4667
4854
 
4668
4855
 
4669
4856
class cmd_wait_until_signalled(Command):
4670
 
    """Test helper for test_start_and_stop_bzr_subprocess_send_signal.
 
4857
    __doc__ = """Test helper for test_start_and_stop_bzr_subprocess_send_signal.
4671
4858
 
4672
4859
    This just prints a line to signal when it is ready, then blocks on stdin.
4673
4860
    """
4681
4868
 
4682
4869
 
4683
4870
class cmd_serve(Command):
4684
 
    """Run the bzr server."""
 
4871
    __doc__ = """Run the bzr server."""
4685
4872
 
4686
4873
    aliases = ['server']
4687
4874
 
4688
4875
    takes_options = [
4689
4876
        Option('inet',
4690
4877
               help='Serve on stdin/out for use from inetd or sshd.'),
4691
 
        RegistryOption('protocol', 
4692
 
               help="Protocol to serve.", 
 
4878
        RegistryOption('protocol',
 
4879
               help="Protocol to serve.",
4693
4880
               lazy_registry=('bzrlib.transport', 'transport_server_registry'),
4694
4881
               value_switches=True),
4695
4882
        Option('port',
4698
4885
                    'result in a dynamically allocated port.  The default port '
4699
4886
                    'depends on the protocol.',
4700
4887
               type=str),
4701
 
        Option('directory',
4702
 
               help='Serve contents of this directory.',
4703
 
               type=unicode),
 
4888
        custom_help('directory',
 
4889
               help='Serve contents of this directory.'),
4704
4890
        Option('allow-writes',
4705
4891
               help='By default the server is a readonly server.  Supplying '
4706
4892
                    '--allow-writes enables write access to the contents of '
4707
 
                    'the served directory and below.'
 
4893
                    'the served directory and below.  Note that ``bzr serve`` '
 
4894
                    'does not perform authentication, so unless some form of '
 
4895
                    'external authentication is arranged supplying this '
 
4896
                    'option leads to global uncontrolled write access to your '
 
4897
                    'file system.'
4708
4898
                ),
4709
4899
        ]
4710
4900
 
4729
4919
 
4730
4920
    def run(self, port=None, inet=False, directory=None, allow_writes=False,
4731
4921
            protocol=None):
4732
 
        from bzrlib.transport import get_transport, transport_server_registry
 
4922
        from bzrlib import transport
4733
4923
        if directory is None:
4734
4924
            directory = os.getcwd()
4735
4925
        if protocol is None:
4736
 
            protocol = transport_server_registry.get()
 
4926
            protocol = transport.transport_server_registry.get()
4737
4927
        host, port = self.get_host_and_port(port)
4738
4928
        url = urlutils.local_path_to_url(directory)
4739
4929
        if not allow_writes:
4740
4930
            url = 'readonly+' + url
4741
 
        transport = get_transport(url)
4742
 
        protocol(transport, host, port, inet)
 
4931
        t = transport.get_transport(url)
 
4932
        protocol(t, host, port, inet)
4743
4933
 
4744
4934
 
4745
4935
class cmd_join(Command):
4746
 
    """Combine a tree into its containing tree.
 
4936
    __doc__ = """Combine a tree into its containing tree.
4747
4937
 
4748
4938
    This command requires the target tree to be in a rich-root format.
4749
4939
 
4789
4979
 
4790
4980
 
4791
4981
class cmd_split(Command):
4792
 
    """Split a subdirectory of a tree into a separate tree.
 
4982
    __doc__ = """Split a subdirectory of a tree into a separate tree.
4793
4983
 
4794
4984
    This command will produce a target tree in a format that supports
4795
4985
    rich roots, like 'rich-root' or 'rich-root-pack'.  These formats cannot be
4815
5005
 
4816
5006
 
4817
5007
class cmd_merge_directive(Command):
4818
 
    """Generate a merge directive for auto-merge tools.
 
5008
    __doc__ = """Generate a merge directive for auto-merge tools.
4819
5009
 
4820
5010
    A directive requests a merge to be performed, and also provides all the
4821
5011
    information necessary to do so.  This means it must either include a
4838
5028
    _see_also = ['send']
4839
5029
 
4840
5030
    takes_options = [
 
5031
        'directory',
4841
5032
        RegistryOption.from_kwargs('patch-type',
4842
5033
            'The type of patch to include in the directive.',
4843
5034
            title='Patch type',
4856
5047
    encoding_type = 'exact'
4857
5048
 
4858
5049
    def run(self, submit_branch=None, public_branch=None, patch_type='bundle',
4859
 
            sign=False, revision=None, mail_to=None, message=None):
 
5050
            sign=False, revision=None, mail_to=None, message=None,
 
5051
            directory=u'.'):
4860
5052
        from bzrlib.revision import ensure_null, NULL_REVISION
4861
5053
        include_patch, include_bundle = {
4862
5054
            'plain': (False, False),
4863
5055
            'diff': (True, False),
4864
5056
            'bundle': (True, True),
4865
5057
            }[patch_type]
4866
 
        branch = Branch.open('.')
 
5058
        branch = Branch.open(directory)
4867
5059
        stored_submit_branch = branch.get_submit_branch()
4868
5060
        if submit_branch is None:
4869
5061
            submit_branch = stored_submit_branch
4914
5106
 
4915
5107
 
4916
5108
class cmd_send(Command):
4917
 
    """Mail or create a merge-directive for submitting changes.
 
5109
    __doc__ = """Mail or create a merge-directive for submitting changes.
4918
5110
 
4919
5111
    A merge directive provides many things needed for requesting merges:
4920
5112
 
4926
5118
      directly from the merge directive, without retrieving data from a
4927
5119
      branch.
4928
5120
 
4929
 
    If --no-bundle is specified, then public_branch is needed (and must be
4930
 
    up-to-date), so that the receiver can perform the merge using the
4931
 
    public_branch.  The public_branch is always included if known, so that
4932
 
    people can check it later.
4933
 
 
4934
 
    The submit branch defaults to the parent, but can be overridden.  Both
4935
 
    submit branch and public branch will be remembered if supplied.
4936
 
 
4937
 
    If a public_branch is known for the submit_branch, that public submit
4938
 
    branch is used in the merge instructions.  This means that a local mirror
4939
 
    can be used as your actual submit branch, once you have set public_branch
4940
 
    for that mirror.
 
5121
    `bzr send` creates a compact data set that, when applied using bzr
 
5122
    merge, has the same effect as merging from the source branch.  
 
5123
    
 
5124
    By default the merge directive is self-contained and can be applied to any
 
5125
    branch containing submit_branch in its ancestory without needing access to
 
5126
    the source branch.
 
5127
    
 
5128
    If --no-bundle is specified, then Bazaar doesn't send the contents of the
 
5129
    revisions, but only a structured request to merge from the
 
5130
    public_location.  In that case the public_branch is needed and it must be
 
5131
    up-to-date and accessible to the recipient.  The public_branch is always
 
5132
    included if known, so that people can check it later.
 
5133
 
 
5134
    The submit branch defaults to the parent of the source branch, but can be
 
5135
    overridden.  Both submit branch and public branch will be remembered in
 
5136
    branch.conf the first time they are used for a particular branch.  The
 
5137
    source branch defaults to that containing the working directory, but can
 
5138
    be changed using --from.
 
5139
 
 
5140
    In order to calculate those changes, bzr must analyse the submit branch.
 
5141
    Therefore it is most efficient for the submit branch to be a local mirror.
 
5142
    If a public location is known for the submit_branch, that location is used
 
5143
    in the merge directive.
 
5144
 
 
5145
    The default behaviour is to send the merge directive by mail, unless -o is
 
5146
    given, in which case it is sent to a file.
4941
5147
 
4942
5148
    Mail is sent using your preferred mail program.  This should be transparent
4943
 
    on Windows (it uses MAPI).  On Linux, it requires the xdg-email utility.
 
5149
    on Windows (it uses MAPI).  On Unix, it requires the xdg-email utility.
4944
5150
    If the preferred client can't be found (or used), your editor will be used.
4945
5151
 
4946
5152
    To use a specific mail program, set the mail_client configuration option.
4947
5153
    (For Thunderbird 1.5, this works around some bugs.)  Supported values for
4948
 
    specific clients are "claws", "evolution", "kmail", "mutt", and
4949
 
    "thunderbird"; generic options are "default", "editor", "emacsclient",
4950
 
    "mapi", and "xdg-email".  Plugins may also add supported clients.
 
5154
    specific clients are "claws", "evolution", "kmail", "mail.app" (MacOS X's
 
5155
    Mail.app), "mutt", and "thunderbird"; generic options are "default",
 
5156
    "editor", "emacsclient", "mapi", and "xdg-email".  Plugins may also add
 
5157
    supported clients.
4951
5158
 
4952
5159
    If mail is being sent, a to address is required.  This can be supplied
4953
5160
    either on the commandline, by setting the submit_to configuration
4962
5169
 
4963
5170
    The merge directives created by bzr send may be applied using bzr merge or
4964
5171
    bzr pull by specifying a file containing a merge directive as the location.
 
5172
 
 
5173
    bzr send makes extensive use of public locations to map local locations into
 
5174
    URLs that can be used by other people.  See `bzr help configuration` to
 
5175
    set them, and use `bzr info` to display them.
4965
5176
    """
4966
5177
 
4967
5178
    encoding_type = 'exact'
4983
5194
               short_name='f',
4984
5195
               type=unicode),
4985
5196
        Option('output', short_name='o',
4986
 
               help='Write merge directive to this file; '
 
5197
               help='Write merge directive to this file or directory; '
4987
5198
                    'use - for stdout.',
4988
5199
               type=unicode),
4989
5200
        Option('strict',
5012
5223
 
5013
5224
 
5014
5225
class cmd_bundle_revisions(cmd_send):
5015
 
    """Create a merge-directive for submitting changes.
 
5226
    __doc__ = """Create a merge-directive for submitting changes.
5016
5227
 
5017
5228
    A merge directive provides many things needed for requesting merges:
5018
5229
 
5085
5296
 
5086
5297
 
5087
5298
class cmd_tag(Command):
5088
 
    """Create, remove or modify a tag naming a revision.
 
5299
    __doc__ = """Create, remove or modify a tag naming a revision.
5089
5300
 
5090
5301
    Tags give human-meaningful names to revisions.  Commands that take a -r
5091
5302
    (--revision) option can be given -rtag:X, where X is any previously
5099
5310
 
5100
5311
    To rename a tag (change the name but keep it on the same revsion), run ``bzr
5101
5312
    tag new-name -r tag:old-name`` and then ``bzr tag --delete oldname``.
 
5313
 
 
5314
    If no tag name is specified it will be determined through the 
 
5315
    'automatic_tag_name' hook. This can e.g. be used to automatically tag
 
5316
    upstream releases by reading configure.ac. See ``bzr help hooks`` for
 
5317
    details.
5102
5318
    """
5103
5319
 
5104
5320
    _see_also = ['commit', 'tags']
5105
 
    takes_args = ['tag_name']
 
5321
    takes_args = ['tag_name?']
5106
5322
    takes_options = [
5107
5323
        Option('delete',
5108
5324
            help='Delete this tag rather than placing it.',
5109
5325
            ),
5110
 
        Option('directory',
5111
 
            help='Branch in which to place the tag.',
5112
 
            short_name='d',
5113
 
            type=unicode,
5114
 
            ),
 
5326
        custom_help('directory',
 
5327
            help='Branch in which to place the tag.'),
5115
5328
        Option('force',
5116
5329
            help='Replace existing tags.',
5117
5330
            ),
5118
5331
        'revision',
5119
5332
        ]
5120
5333
 
5121
 
    def run(self, tag_name,
 
5334
    def run(self, tag_name=None,
5122
5335
            delete=None,
5123
5336
            directory='.',
5124
5337
            force=None,
5125
5338
            revision=None,
5126
5339
            ):
5127
5340
        branch, relpath = Branch.open_containing(directory)
5128
 
        branch.lock_write()
5129
 
        try:
5130
 
            if delete:
5131
 
                branch.tags.delete_tag(tag_name)
5132
 
                self.outf.write('Deleted tag %s.\n' % tag_name)
 
5341
        self.add_cleanup(branch.lock_write().unlock)
 
5342
        if delete:
 
5343
            if tag_name is None:
 
5344
                raise errors.BzrCommandError("No tag specified to delete.")
 
5345
            branch.tags.delete_tag(tag_name)
 
5346
            self.outf.write('Deleted tag %s.\n' % tag_name)
 
5347
        else:
 
5348
            if revision:
 
5349
                if len(revision) != 1:
 
5350
                    raise errors.BzrCommandError(
 
5351
                        "Tags can only be placed on a single revision, "
 
5352
                        "not on a range")
 
5353
                revision_id = revision[0].as_revision_id(branch)
5133
5354
            else:
5134
 
                if revision:
5135
 
                    if len(revision) != 1:
5136
 
                        raise errors.BzrCommandError(
5137
 
                            "Tags can only be placed on a single revision, "
5138
 
                            "not on a range")
5139
 
                    revision_id = revision[0].as_revision_id(branch)
5140
 
                else:
5141
 
                    revision_id = branch.last_revision()
5142
 
                if (not force) and branch.tags.has_tag(tag_name):
5143
 
                    raise errors.TagAlreadyExists(tag_name)
5144
 
                branch.tags.set_tag(tag_name, revision_id)
5145
 
                self.outf.write('Created tag %s.\n' % tag_name)
5146
 
        finally:
5147
 
            branch.unlock()
 
5355
                revision_id = branch.last_revision()
 
5356
            if tag_name is None:
 
5357
                tag_name = branch.automatic_tag_name(revision_id)
 
5358
                if tag_name is None:
 
5359
                    raise errors.BzrCommandError(
 
5360
                        "Please specify a tag name.")
 
5361
            if (not force) and branch.tags.has_tag(tag_name):
 
5362
                raise errors.TagAlreadyExists(tag_name)
 
5363
            branch.tags.set_tag(tag_name, revision_id)
 
5364
            self.outf.write('Created tag %s.\n' % tag_name)
5148
5365
 
5149
5366
 
5150
5367
class cmd_tags(Command):
5151
 
    """List tags.
 
5368
    __doc__ = """List tags.
5152
5369
 
5153
5370
    This command shows a table of tag names and the revisions they reference.
5154
5371
    """
5155
5372
 
5156
5373
    _see_also = ['tag']
5157
5374
    takes_options = [
5158
 
        Option('directory',
5159
 
            help='Branch whose tags should be displayed.',
5160
 
            short_name='d',
5161
 
            type=unicode,
5162
 
            ),
 
5375
        custom_help('directory',
 
5376
            help='Branch whose tags should be displayed.'),
5163
5377
        RegistryOption.from_kwargs('sort',
5164
5378
            'Sort tags by different criteria.', title='Sorting',
5165
5379
            alpha='Sort tags lexicographically (default).',
5182
5396
        if not tags:
5183
5397
            return
5184
5398
 
5185
 
        branch.lock_read()
5186
 
        try:
5187
 
            if revision:
5188
 
                graph = branch.repository.get_graph()
5189
 
                rev1, rev2 = _get_revision_range(revision, branch, self.name())
5190
 
                revid1, revid2 = rev1.rev_id, rev2.rev_id
5191
 
                # only show revisions between revid1 and revid2 (inclusive)
5192
 
                tags = [(tag, revid) for tag, revid in tags if
5193
 
                    graph.is_between(revid, revid1, revid2)]
5194
 
            if sort == 'alpha':
5195
 
                tags.sort()
5196
 
            elif sort == 'time':
5197
 
                timestamps = {}
5198
 
                for tag, revid in tags:
5199
 
                    try:
5200
 
                        revobj = branch.repository.get_revision(revid)
5201
 
                    except errors.NoSuchRevision:
5202
 
                        timestamp = sys.maxint # place them at the end
5203
 
                    else:
5204
 
                        timestamp = revobj.timestamp
5205
 
                    timestamps[revid] = timestamp
5206
 
                tags.sort(key=lambda x: timestamps[x[1]])
5207
 
            if not show_ids:
5208
 
                # [ (tag, revid), ... ] -> [ (tag, dotted_revno), ... ]
5209
 
                for index, (tag, revid) in enumerate(tags):
5210
 
                    try:
5211
 
                        revno = branch.revision_id_to_dotted_revno(revid)
5212
 
                        if isinstance(revno, tuple):
5213
 
                            revno = '.'.join(map(str, revno))
5214
 
                    except errors.NoSuchRevision:
5215
 
                        # Bad tag data/merges can lead to tagged revisions
5216
 
                        # which are not in this branch. Fail gracefully ...
5217
 
                        revno = '?'
5218
 
                    tags[index] = (tag, revno)
5219
 
        finally:
5220
 
            branch.unlock()
 
5399
        self.add_cleanup(branch.lock_read().unlock)
 
5400
        if revision:
 
5401
            graph = branch.repository.get_graph()
 
5402
            rev1, rev2 = _get_revision_range(revision, branch, self.name())
 
5403
            revid1, revid2 = rev1.rev_id, rev2.rev_id
 
5404
            # only show revisions between revid1 and revid2 (inclusive)
 
5405
            tags = [(tag, revid) for tag, revid in tags if
 
5406
                graph.is_between(revid, revid1, revid2)]
 
5407
        if sort == 'alpha':
 
5408
            tags.sort()
 
5409
        elif sort == 'time':
 
5410
            timestamps = {}
 
5411
            for tag, revid in tags:
 
5412
                try:
 
5413
                    revobj = branch.repository.get_revision(revid)
 
5414
                except errors.NoSuchRevision:
 
5415
                    timestamp = sys.maxint # place them at the end
 
5416
                else:
 
5417
                    timestamp = revobj.timestamp
 
5418
                timestamps[revid] = timestamp
 
5419
            tags.sort(key=lambda x: timestamps[x[1]])
 
5420
        if not show_ids:
 
5421
            # [ (tag, revid), ... ] -> [ (tag, dotted_revno), ... ]
 
5422
            for index, (tag, revid) in enumerate(tags):
 
5423
                try:
 
5424
                    revno = branch.revision_id_to_dotted_revno(revid)
 
5425
                    if isinstance(revno, tuple):
 
5426
                        revno = '.'.join(map(str, revno))
 
5427
                except errors.NoSuchRevision:
 
5428
                    # Bad tag data/merges can lead to tagged revisions
 
5429
                    # which are not in this branch. Fail gracefully ...
 
5430
                    revno = '?'
 
5431
                tags[index] = (tag, revno)
 
5432
        self.cleanup_now()
5221
5433
        for tag, revspec in tags:
5222
5434
            self.outf.write('%-20s %s\n' % (tag, revspec))
5223
5435
 
5224
5436
 
5225
5437
class cmd_reconfigure(Command):
5226
 
    """Reconfigure the type of a bzr directory.
 
5438
    __doc__ = """Reconfigure the type of a bzr directory.
5227
5439
 
5228
5440
    A target configuration must be specified.
5229
5441
 
5314
5526
 
5315
5527
 
5316
5528
class cmd_switch(Command):
5317
 
    """Set the branch of a checkout and update.
 
5529
    __doc__ = """Set the branch of a checkout and update.
5318
5530
 
5319
5531
    For lightweight checkouts, this changes the branch being referenced.
5320
5532
    For heavyweight checkouts, this checks that there are no local commits
5332
5544
    /path/to/newbranch.
5333
5545
 
5334
5546
    Bound branches use the nickname of its master branch unless it is set
5335
 
    locally, in which case switching will update the the local nickname to be
 
5547
    locally, in which case switching will update the local nickname to be
5336
5548
    that of the master.
5337
5549
    """
5338
5550
 
5339
 
    takes_args = ['to_location']
5340
 
    takes_options = [Option('force',
 
5551
    takes_args = ['to_location?']
 
5552
    takes_options = ['directory',
 
5553
                     Option('force',
5341
5554
                        help='Switch even if local commits will be lost.'),
 
5555
                     'revision',
5342
5556
                     Option('create-branch', short_name='b',
5343
5557
                        help='Create the target branch from this one before'
5344
5558
                             ' switching to it.'),
5345
 
                     ]
 
5559
                    ]
5346
5560
 
5347
 
    def run(self, to_location, force=False, create_branch=False):
 
5561
    def run(self, to_location=None, force=False, create_branch=False,
 
5562
            revision=None, directory=u'.'):
5348
5563
        from bzrlib import switch
5349
 
        tree_location = '.'
 
5564
        tree_location = directory
 
5565
        revision = _get_one_revision('switch', revision)
5350
5566
        control_dir = bzrdir.BzrDir.open_containing(tree_location)[0]
 
5567
        if to_location is None:
 
5568
            if revision is None:
 
5569
                raise errors.BzrCommandError('You must supply either a'
 
5570
                                             ' revision or a location')
 
5571
            to_location = tree_location
5351
5572
        try:
5352
5573
            branch = control_dir.open_branch()
5353
5574
            had_explicit_nick = branch.get_config().has_explicit_nickname()
5358
5579
            if branch is None:
5359
5580
                raise errors.BzrCommandError('cannot create branch without'
5360
5581
                                             ' source branch')
 
5582
            to_location = directory_service.directories.dereference(
 
5583
                              to_location)
5361
5584
            if '/' not in to_location and '\\' not in to_location:
5362
5585
                # This path is meant to be relative to the existing branch
5363
5586
                this_url = self._get_branch_location(control_dir)
5365
5588
            to_branch = branch.bzrdir.sprout(to_location,
5366
5589
                                 possible_transports=[branch.bzrdir.root_transport],
5367
5590
                                 source_branch=branch).open_branch()
5368
 
            # try:
5369
 
            #     from_branch = control_dir.open_branch()
5370
 
            # except errors.NotBranchError:
5371
 
            #     raise BzrCommandError('Cannot create a branch from this'
5372
 
            #         ' location when we cannot open this branch')
5373
 
            # from_branch.bzrdir.sprout(
5374
 
            pass
5375
5591
        else:
5376
5592
            try:
5377
5593
                to_branch = Branch.open(to_location)
5379
5595
                this_url = self._get_branch_location(control_dir)
5380
5596
                to_branch = Branch.open(
5381
5597
                    urlutils.join(this_url, '..', to_location))
5382
 
        switch.switch(control_dir, to_branch, force)
 
5598
        if revision is not None:
 
5599
            revision = revision.as_revision_id(to_branch)
 
5600
        switch.switch(control_dir, to_branch, force, revision_id=revision)
5383
5601
        if had_explicit_nick:
5384
5602
            branch = control_dir.open_branch() #get the new branch!
5385
5603
            branch.nick = to_branch.nick
5405
5623
 
5406
5624
 
5407
5625
class cmd_view(Command):
5408
 
    """Manage filtered views.
 
5626
    __doc__ = """Manage filtered views.
5409
5627
 
5410
5628
    Views provide a mask over the tree so that users can focus on
5411
5629
    a subset of a tree when doing their work. After creating a view,
5559
5777
 
5560
5778
 
5561
5779
class cmd_hooks(Command):
5562
 
    """Show hooks."""
 
5780
    __doc__ = """Show hooks."""
5563
5781
 
5564
5782
    hidden = True
5565
5783
 
5578
5796
                    self.outf.write("    <no hooks installed>\n")
5579
5797
 
5580
5798
 
 
5799
class cmd_remove_branch(Command):
 
5800
    __doc__ = """Remove a branch.
 
5801
 
 
5802
    This will remove the branch from the specified location but 
 
5803
    will keep any working tree or repository in place.
 
5804
 
 
5805
    :Examples:
 
5806
 
 
5807
      Remove the branch at repo/trunk::
 
5808
 
 
5809
        bzr remove-branch repo/trunk
 
5810
 
 
5811
    """
 
5812
 
 
5813
    takes_args = ["location?"]
 
5814
 
 
5815
    aliases = ["rmbranch"]
 
5816
 
 
5817
    def run(self, location=None):
 
5818
        if location is None:
 
5819
            location = "."
 
5820
        branch = Branch.open_containing(location)[0]
 
5821
        branch.bzrdir.destroy_branch()
 
5822
        
 
5823
 
5581
5824
class cmd_shelve(Command):
5582
 
    """Temporarily set aside some changes from the current tree.
 
5825
    __doc__ = """Temporarily set aside some changes from the current tree.
5583
5826
 
5584
5827
    Shelve allows you to temporarily put changes you've made "on the shelf",
5585
5828
    ie. out of the way, until a later time when you can bring them back from
5606
5849
    takes_args = ['file*']
5607
5850
 
5608
5851
    takes_options = [
 
5852
        'directory',
5609
5853
        'revision',
5610
5854
        Option('all', help='Shelve all changes.'),
5611
5855
        'message',
5620
5864
    _see_also = ['unshelve']
5621
5865
 
5622
5866
    def run(self, revision=None, all=False, file_list=None, message=None,
5623
 
            writer=None, list=False, destroy=False):
 
5867
            writer=None, list=False, destroy=False, directory=u'.'):
5624
5868
        if list:
5625
5869
            return self.run_for_list()
5626
5870
        from bzrlib.shelf_ui import Shelver
5627
5871
        if writer is None:
5628
5872
            writer = bzrlib.option.diff_writer_registry.get()
5629
5873
        try:
5630
 
            Shelver.from_args(writer(sys.stdout), revision, all, file_list,
5631
 
                              message, destroy=destroy).run()
 
5874
            shelver = Shelver.from_args(writer(sys.stdout), revision, all,
 
5875
                file_list, message, destroy=destroy, directory=directory)
 
5876
            try:
 
5877
                shelver.run()
 
5878
            finally:
 
5879
                shelver.finalize()
5632
5880
        except errors.UserAbort:
5633
5881
            return 0
5634
5882
 
5635
5883
    def run_for_list(self):
5636
5884
        tree = WorkingTree.open_containing('.')[0]
5637
 
        tree.lock_read()
5638
 
        try:
5639
 
            manager = tree.get_shelf_manager()
5640
 
            shelves = manager.active_shelves()
5641
 
            if len(shelves) == 0:
5642
 
                note('No shelved changes.')
5643
 
                return 0
5644
 
            for shelf_id in reversed(shelves):
5645
 
                message = manager.get_metadata(shelf_id).get('message')
5646
 
                if message is None:
5647
 
                    message = '<no message>'
5648
 
                self.outf.write('%3d: %s\n' % (shelf_id, message))
5649
 
            return 1
5650
 
        finally:
5651
 
            tree.unlock()
 
5885
        self.add_cleanup(tree.lock_read().unlock)
 
5886
        manager = tree.get_shelf_manager()
 
5887
        shelves = manager.active_shelves()
 
5888
        if len(shelves) == 0:
 
5889
            note('No shelved changes.')
 
5890
            return 0
 
5891
        for shelf_id in reversed(shelves):
 
5892
            message = manager.get_metadata(shelf_id).get('message')
 
5893
            if message is None:
 
5894
                message = '<no message>'
 
5895
            self.outf.write('%3d: %s\n' % (shelf_id, message))
 
5896
        return 1
5652
5897
 
5653
5898
 
5654
5899
class cmd_unshelve(Command):
5655
 
    """Restore shelved changes.
 
5900
    __doc__ = """Restore shelved changes.
5656
5901
 
5657
5902
    By default, the most recently shelved changes are restored. However if you
5658
5903
    specify a shelf by id those changes will be restored instead.  This works
5661
5906
 
5662
5907
    takes_args = ['shelf_id?']
5663
5908
    takes_options = [
 
5909
        'directory',
5664
5910
        RegistryOption.from_kwargs(
5665
5911
            'action', help="The action to perform.",
5666
5912
            enum_switch=False, value_switches=True,
5667
5913
            apply="Apply changes and remove from the shelf.",
5668
5914
            dry_run="Show changes, but do not apply or remove them.",
5669
 
            delete_only="Delete changes without applying them."
 
5915
            preview="Instead of unshelving the changes, show the diff that "
 
5916
                    "would result from unshelving.",
 
5917
            delete_only="Delete changes without applying them.",
 
5918
            keep="Apply changes but don't delete them.",
5670
5919
        )
5671
5920
    ]
5672
5921
    _see_also = ['shelve']
5673
5922
 
5674
 
    def run(self, shelf_id=None, action='apply'):
 
5923
    def run(self, shelf_id=None, action='apply', directory=u'.'):
5675
5924
        from bzrlib.shelf_ui import Unshelver
5676
 
        Unshelver.from_args(shelf_id, action).run()
 
5925
        unshelver = Unshelver.from_args(shelf_id, action, directory=directory)
 
5926
        try:
 
5927
            unshelver.run()
 
5928
        finally:
 
5929
            unshelver.tree.unlock()
5677
5930
 
5678
5931
 
5679
5932
class cmd_clean_tree(Command):
5680
 
    """Remove unwanted files from working tree.
 
5933
    __doc__ = """Remove unwanted files from working tree.
5681
5934
 
5682
5935
    By default, only unknown files, not ignored files, are deleted.  Versioned
5683
5936
    files are never deleted.
5691
5944
 
5692
5945
    To check what clean-tree will do, use --dry-run.
5693
5946
    """
5694
 
    takes_options = [Option('ignored', help='Delete all ignored files.'),
 
5947
    takes_options = ['directory',
 
5948
                     Option('ignored', help='Delete all ignored files.'),
5695
5949
                     Option('detritus', help='Delete conflict files, merge'
5696
5950
                            ' backups, and failed selftest dirs.'),
5697
5951
                     Option('unknown',
5700
5954
                            ' deleting them.'),
5701
5955
                     Option('force', help='Do not prompt before deleting.')]
5702
5956
    def run(self, unknown=False, ignored=False, detritus=False, dry_run=False,
5703
 
            force=False):
 
5957
            force=False, directory=u'.'):
5704
5958
        from bzrlib.clean_tree import clean_tree
5705
5959
        if not (unknown or ignored or detritus):
5706
5960
            unknown = True
5707
5961
        if dry_run:
5708
5962
            force = True
5709
 
        clean_tree('.', unknown=unknown, ignored=ignored, detritus=detritus,
5710
 
                   dry_run=dry_run, no_prompt=force)
 
5963
        clean_tree(directory, unknown=unknown, ignored=ignored,
 
5964
                   detritus=detritus, dry_run=dry_run, no_prompt=force)
5711
5965
 
5712
5966
 
5713
5967
class cmd_reference(Command):
5714
 
    """list, view and set branch locations for nested trees.
 
5968
    __doc__ = """list, view and set branch locations for nested trees.
5715
5969
 
5716
5970
    If no arguments are provided, lists the branch locations for nested trees.
5717
5971
    If one argument is provided, display the branch location for that tree.
5757
6011
            self.outf.write('%s %s\n' % (path, location))
5758
6012
 
5759
6013
 
5760
 
# these get imported and then picked up by the scan for cmd_*
5761
 
# TODO: Some more consistent way to split command definitions across files;
5762
 
# we do need to load at least some information about them to know of
5763
 
# aliases.  ideally we would avoid loading the implementation until the
5764
 
# details were needed.
5765
 
from bzrlib.cmd_version_info import cmd_version_info
5766
 
from bzrlib.conflicts import cmd_resolve, cmd_conflicts, restore
5767
 
from bzrlib.bundle.commands import (
5768
 
    cmd_bundle_info,
5769
 
    )
5770
 
from bzrlib.foreign import cmd_dpush
5771
 
from bzrlib.sign_my_commits import cmd_sign_my_commits
5772
 
from bzrlib.weave_commands import cmd_versionedfile_list, \
5773
 
        cmd_weave_plan_merge, cmd_weave_merge_text
 
6014
def _register_lazy_builtins():
 
6015
    # register lazy builtins from other modules; called at startup and should
 
6016
    # be only called once.
 
6017
    for (name, aliases, module_name) in [
 
6018
        ('cmd_bundle_info', [], 'bzrlib.bundle.commands'),
 
6019
        ('cmd_dpush', [], 'bzrlib.foreign'),
 
6020
        ('cmd_version_info', [], 'bzrlib.cmd_version_info'),
 
6021
        ('cmd_resolve', ['resolved'], 'bzrlib.conflicts'),
 
6022
        ('cmd_conflicts', [], 'bzrlib.conflicts'),
 
6023
        ('cmd_sign_my_commits', [], 'bzrlib.sign_my_commits'),
 
6024
        ]:
 
6025
        builtin_command_registry.register_lazy(name, aliases, module_name)