← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/builtins.py

  • Committer: Martin Pool
  • Date: 2010-08-13 07:56:06 UTC
  • mfrom: (5050.17.4 2.2)
  • mto: (5050.17.6 2.2)
  • mto: This revision was merged to the branch mainline in revision 5379.
  • Revision ID: mbp@sourcefrog.net-20100813075606-8zgmov3ezwans2zo
merge bzr 2.2

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:
163
180
                view_str = views.view_display_str(view_files)
164
181
                note("Ignoring files outside view. View is %s" % view_str)
165
182
        return tree, file_list
166
 
    tree = WorkingTree.open_containing(osutils.realpath(file_list[0]))[0]
 
183
    tree = WorkingTree.open_containing(file_list[0])[0]
167
184
    return tree, safe_relpath_files(tree, file_list, canonicalize,
168
185
        apply_view=apply_view)
169
186
 
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
642
684
                should_print=(not is_quiet()))
643
685
 
644
686
        if base_tree:
645
 
            base_tree.lock_read()
646
 
        try:
647
 
            file_list = self._maybe_expand_globs(file_list)
648
 
            tree, file_list = tree_files_for_add(file_list)
649
 
            added, ignored = tree.smart_add(file_list, not
650
 
                no_recurse, action=action, save=not dry_run)
651
 
        finally:
652
 
            if base_tree is not None:
653
 
                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()
654
692
        if len(ignored) > 0:
655
693
            if verbose:
656
694
                for glob in sorted(ignored.keys()):
660
698
 
661
699
 
662
700
class cmd_mkdir(Command):
663
 
    """Create a new versioned directory.
 
701
    __doc__ = """Create a new versioned directory.
664
702
 
665
703
    This is equivalent to creating the directory and then adding it.
666
704
    """
670
708
 
671
709
    def run(self, dir_list):
672
710
        for d in dir_list:
673
 
            os.mkdir(d)
674
711
            wt, dd = WorkingTree.open_containing(d)
675
 
            wt.add([dd])
676
 
            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)
677
720
 
678
721
 
679
722
class cmd_relpath(Command):
680
 
    """Show path of a file relative to root"""
 
723
    __doc__ = """Show path of a file relative to root"""
681
724
 
682
725
    takes_args = ['filename']
683
726
    hidden = True
692
735
 
693
736
 
694
737
class cmd_inventory(Command):
695
 
    """Show inventory of the current working copy or a revision.
 
738
    __doc__ = """Show inventory of the current working copy or a revision.
696
739
 
697
740
    It is possible to limit the output to a particular entry
698
741
    type using the --kind option.  For example: --kind file.
719
762
 
720
763
        revision = _get_one_revision('inventory', revision)
721
764
        work_tree, file_list = tree_files(file_list)
722
 
        work_tree.lock_read()
723
 
        try:
724
 
            if revision is not None:
725
 
                tree = revision.as_tree(work_tree.branch)
726
 
 
727
 
                extra_trees = [work_tree]
728
 
                tree.lock_read()
729
 
            else:
730
 
                tree = work_tree
731
 
                extra_trees = []
732
 
 
733
 
            if file_list is not None:
734
 
                file_ids = tree.paths2ids(file_list, trees=extra_trees,
735
 
                                          require_versioned=True)
736
 
                # find_ids_across_trees may include some paths that don't
737
 
                # exist in 'tree'.
738
 
                entries = sorted((tree.id2path(file_id), tree.inventory[file_id])
739
 
                                 for file_id in file_ids if file_id in tree)
740
 
            else:
741
 
                entries = tree.inventory.entries()
742
 
        finally:
743
 
            tree.unlock()
744
 
            if tree is not work_tree:
745
 
                work_tree.unlock()
746
 
 
 
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()
747
786
        for path, entry in entries:
748
787
            if kind and kind != entry.kind:
749
788
                continue
755
794
 
756
795
 
757
796
class cmd_mv(Command):
758
 
    """Move or rename a file.
 
797
    __doc__ = """Move or rename a file.
759
798
 
760
799
    :Usage:
761
800
        bzr mv OLDNAME NEWNAME
794
833
        if len(names_list) < 2:
795
834
            raise errors.BzrCommandError("missing file argument")
796
835
        tree, rel_names = tree_files(names_list, canonicalize=False)
797
 
        tree.lock_tree_write()
798
 
        try:
799
 
            self._run(tree, names_list, rel_names, after)
800
 
        finally:
801
 
            tree.unlock()
 
836
        self.add_cleanup(tree.lock_tree_write().unlock)
 
837
        self._run(tree, names_list, rel_names, after)
802
838
 
803
839
    def run_auto(self, names_list, after, dry_run):
804
840
        if names_list is not None and len(names_list) > 1:
808
844
            raise errors.BzrCommandError('--after cannot be specified with'
809
845
                                         ' --auto.')
810
846
        work_tree, file_list = tree_files(names_list, default_branch='.')
811
 
        work_tree.lock_tree_write()
812
 
        try:
813
 
            rename_map.RenameMap.guess_renames(work_tree, dry_run)
814
 
        finally:
815
 
            work_tree.unlock()
 
847
        self.add_cleanup(work_tree.lock_tree_write().unlock)
 
848
        rename_map.RenameMap.guess_renames(work_tree, dry_run)
816
849
 
817
850
    def _run(self, tree, names_list, rel_names, after):
818
851
        into_existing = osutils.isdir(names_list[-1])
839
872
            # All entries reference existing inventory items, so fix them up
840
873
            # for cicp file-systems.
841
874
            rel_names = tree.get_canonical_inventory_paths(rel_names)
842
 
            for pair in tree.move(rel_names[:-1], rel_names[-1], after=after):
843
 
                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))
844
878
        else:
845
879
            if len(names_list) != 2:
846
880
                raise errors.BzrCommandError('to mv multiple files the'
890
924
            dest = osutils.pathjoin(dest_parent, dest_tail)
891
925
            mutter("attempting to move %s => %s", src, dest)
892
926
            tree.rename_one(src, dest, after=after)
893
 
            self.outf.write("%s => %s\n" % (src, dest))
 
927
            if not is_quiet():
 
928
                self.outf.write("%s => %s\n" % (src, dest))
894
929
 
895
930
 
896
931
class cmd_pull(Command):
897
 
    """Turn this branch into a mirror of another branch.
 
932
    __doc__ = """Turn this branch into a mirror of another branch.
898
933
 
899
 
    This command only works on branches that have not diverged.  Branches are
900
 
    considered diverged if the destination branch's most recent commit is one
901
 
    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.
902
938
 
903
939
    If branches have diverged, you can use 'bzr merge' to integrate the changes
904
940
    from one into the other.  Once one branch has merged, the other should
905
941
    be able to pull it again.
906
942
 
907
 
    If you want to forget your local changes and just update your branch to
908
 
    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.
909
946
 
910
947
    If there is no default location set, the first pull will set it.  After
911
948
    that, you can omit the location to use the default.  To change the
921
958
    takes_options = ['remember', 'overwrite', 'revision',
922
959
        custom_help('verbose',
923
960
            help='Show logs of pulled revisions.'),
924
 
        Option('directory',
 
961
        custom_help('directory',
925
962
            help='Branch to pull into, '
926
 
                 'rather than the one containing the working directory.',
927
 
            short_name='d',
928
 
            type=unicode,
929
 
            ),
 
963
                 'rather than the one containing the working directory.'),
930
964
        Option('local',
931
965
            help="Perform a local pull in a bound "
932
966
                 "branch.  Local pulls are not applied to "
947
981
        try:
948
982
            tree_to = WorkingTree.open_containing(directory)[0]
949
983
            branch_to = tree_to.branch
 
984
            self.add_cleanup(tree_to.lock_write().unlock)
950
985
        except errors.NoWorkingTree:
951
986
            tree_to = None
952
987
            branch_to = Branch.open_containing(directory)[0]
953
 
        
 
988
            self.add_cleanup(branch_to.lock_write().unlock)
 
989
 
954
990
        if local and not branch_to.get_bound_location():
955
991
            raise errors.LocalRequiresBoundBranch()
956
992
 
986
1022
        else:
987
1023
            branch_from = Branch.open(location,
988
1024
                possible_transports=possible_transports)
 
1025
            self.add_cleanup(branch_from.lock_read().unlock)
989
1026
 
990
1027
            if branch_to.get_parent() is None or remember:
991
1028
                branch_to.set_parent(branch_from.base)
992
1029
 
993
 
        if branch_from is not branch_to:
994
 
            branch_from.lock_read()
995
 
        try:
996
 
            if revision is not None:
997
 
                revision_id = revision.as_revision_id(branch_from)
998
 
 
999
 
            branch_to.lock_write()
1000
 
            try:
1001
 
                if tree_to is not None:
1002
 
                    view_info = _get_view_info_for_change_reporter(tree_to)
1003
 
                    change_reporter = delta._ChangeReporter(
1004
 
                        unversioned_filter=tree_to.is_ignored,
1005
 
                        view_info=view_info)
1006
 
                    result = tree_to.pull(
1007
 
                        branch_from, overwrite, revision_id, change_reporter,
1008
 
                        possible_transports=possible_transports, local=local)
1009
 
                else:
1010
 
                    result = branch_to.pull(
1011
 
                        branch_from, overwrite, revision_id, local=local)
1012
 
 
1013
 
                result.report(self.outf)
1014
 
                if verbose and result.old_revid != result.new_revid:
1015
 
                    log.show_branch_change(
1016
 
                        branch_to, self.outf, result.old_revno,
1017
 
                        result.old_revid)
1018
 
            finally:
1019
 
                branch_to.unlock()
1020
 
        finally:
1021
 
            if branch_from is not branch_to:
1022
 
                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)
1023
1050
 
1024
1051
 
1025
1052
class cmd_push(Command):
1026
 
    """Update a mirror of this branch.
 
1053
    __doc__ = """Update a mirror of this branch.
1027
1054
 
1028
1055
    The target branch will not have its working tree populated because this
1029
1056
    is both expensive, and is not supported on remote file systems.
1053
1080
        Option('create-prefix',
1054
1081
               help='Create the path leading up to the branch '
1055
1082
                    'if it does not already exist.'),
1056
 
        Option('directory',
 
1083
        custom_help('directory',
1057
1084
            help='Branch to push from, '
1058
 
                 'rather than the one containing the working directory.',
1059
 
            short_name='d',
1060
 
            type=unicode,
1061
 
            ),
 
1085
                 'rather than the one containing the working directory.'),
1062
1086
        Option('use-existing-dir',
1063
1087
               help='By default push will fail if the target'
1064
1088
                    ' directory exists, but does not already'
1090
1114
        # Get the source branch
1091
1115
        (tree, br_from,
1092
1116
         _unused) = bzrdir.BzrDir.open_containing_tree_or_branch(directory)
1093
 
        if strict is None:
1094
 
            strict = br_from.get_config().get_user_option_as_bool('push_strict')
1095
 
        if strict is None: strict = True # default value
1096
1117
        # Get the tip's revision_id
1097
1118
        revision = _get_one_revision('push', revision)
1098
1119
        if revision is not None:
1099
1120
            revision_id = revision.in_history(br_from).rev_id
1100
1121
        else:
1101
1122
            revision_id = None
1102
 
        if strict and tree is not None and revision_id is None:
1103
 
            if (tree.has_changes(tree.basis_tree())
1104
 
                or len(tree.get_parent_ids()) > 1):
1105
 
                raise errors.UncommittedChanges(
1106
 
                    tree, more='Use --no-strict to force the push.')
1107
 
            if tree.last_revision() != tree.branch.last_revision():
1108
 
                # The tree has lost sync with its branch, there is little
1109
 
                # chance that the user is aware of it but he can still force
1110
 
                # the push with --no-strict
1111
 
                raise errors.OutOfDateTree(
1112
 
                    tree, more='Use --no-strict to force the push.')
1113
 
 
 
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.')
1114
1128
        # Get the stacked_on branch, if any
1115
1129
        if stacked_on is not None:
1116
1130
            stacked_on = urlutils.normalize_url(stacked_on)
1148
1162
 
1149
1163
 
1150
1164
class cmd_branch(Command):
1151
 
    """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.
1152
1166
 
1153
1167
    If the TO_LOCATION is omitted, the last component of the FROM_LOCATION will
1154
1168
    be used.  In other words, "branch ../foo/bar" will attempt to create ./bar.
1167
1181
        help='Hard-link working tree files where possible.'),
1168
1182
        Option('no-tree',
1169
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."),
1170
1187
        Option('stacked',
1171
1188
            help='Create a stacked branch referring to the source branch. '
1172
1189
                'The new branch will depend on the availability of the source '
1178
1195
                    ' directory exists, but does not already'
1179
1196
                    ' have a control directory.  This flag will'
1180
1197
                    ' allow branch to proceed.'),
 
1198
        Option('bind',
 
1199
            help="Bind new branch to from location."),
1181
1200
        ]
1182
1201
    aliases = ['get', 'clone']
1183
1202
 
1184
1203
    def run(self, from_location, to_location=None, revision=None,
1185
1204
            hardlink=False, stacked=False, standalone=False, no_tree=False,
1186
 
            use_existing_dir=False):
 
1205
            use_existing_dir=False, switch=False, bind=False):
 
1206
        from bzrlib import switch as _mod_switch
1187
1207
        from bzrlib.tag import _merge_tags_if_possible
1188
 
 
1189
1208
        accelerator_tree, br_from = bzrdir.BzrDir.open_tree_or_branch(
1190
1209
            from_location)
1191
 
        if (accelerator_tree is not None and
1192
 
            accelerator_tree.supports_content_filtering()):
1193
 
            accelerator_tree = None
1194
1210
        revision = _get_one_revision('branch', revision)
1195
 
        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)
1196
1222
        try:
1197
 
            if revision is not None:
1198
 
                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)
1199
1228
            else:
1200
 
                # FIXME - wt.last_revision, fallback to branch, fall back to
1201
 
                # None or perhaps NULL_REVISION to mean copy nothing
1202
 
                # RBC 20060209
1203
 
                revision_id = br_from.last_revision()
1204
 
            if to_location is None:
1205
 
                to_location = urlutils.derive_to_location(from_location)
1206
 
            to_transport = transport.get_transport(to_location)
1207
 
            try:
1208
 
                to_transport.mkdir('.')
1209
 
            except errors.FileExists:
1210
 
                if not use_existing_dir:
1211
 
                    raise errors.BzrCommandError('Target directory "%s" '
1212
 
                        'already exists.' % to_location)
 
1229
                try:
 
1230
                    bzrdir.BzrDir.open_from_transport(to_transport)
 
1231
                except errors.NotBranchError:
 
1232
                    pass
1213
1233
                else:
1214
 
                    try:
1215
 
                        bzrdir.BzrDir.open_from_transport(to_transport)
1216
 
                    except errors.NotBranchError:
1217
 
                        pass
1218
 
                    else:
1219
 
                        raise errors.AlreadyBranchError(to_location)
1220
 
            except errors.NoSuchFile:
1221
 
                raise errors.BzrCommandError('Parent of "%s" does not exist.'
1222
 
                                             % to_location)
1223
 
            try:
1224
 
                # preserve whatever source format we have.
1225
 
                dir = br_from.bzrdir.sprout(to_transport.base, revision_id,
1226
 
                                            possible_transports=[to_transport],
1227
 
                                            accelerator_tree=accelerator_tree,
1228
 
                                            hardlink=hardlink, stacked=stacked,
1229
 
                                            force_new_repo=standalone,
1230
 
                                            create_tree_if_local=not no_tree,
1231
 
                                            source_branch=br_from)
1232
 
                branch = dir.open_branch()
1233
 
            except errors.NoSuchRevision:
1234
 
                to_transport.delete_tree('.')
1235
 
                msg = "The branch %s has no revision %s." % (from_location,
1236
 
                    revision)
1237
 
                raise errors.BzrCommandError(msg)
1238
 
            _merge_tags_if_possible(br_from, branch)
1239
 
            # If the source branch is stacked, the new branch may
1240
 
            # be stacked whether we asked for that explicitly or not.
1241
 
            # We therefore need a try/except here and not just 'if stacked:'
1242
 
            try:
1243
 
                note('Created new stacked branch referring to %s.' %
1244
 
                    branch.get_stacked_on_url())
1245
 
            except (errors.NotStacked, errors.UnstackableBranchFormat,
1246
 
                errors.UnstackableRepositoryFormat), e:
1247
 
                note('Branched %d revision(s).' % branch.revno())
1248
 
        finally:
1249
 
            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'))
1250
1274
 
1251
1275
 
1252
1276
class cmd_checkout(Command):
1253
 
    """Create a new checkout of an existing branch.
 
1277
    __doc__ = """Create a new checkout of an existing branch.
1254
1278
 
1255
1279
    If BRANCH_LOCATION is omitted, checkout will reconstitute a working tree for
1256
1280
    the branch found in '.'. This is useful if you have removed the working tree
1319
1343
 
1320
1344
 
1321
1345
class cmd_renames(Command):
1322
 
    """Show list of renamed files.
 
1346
    __doc__ = """Show list of renamed files.
1323
1347
    """
1324
1348
    # TODO: Option to show renames between two historical versions.
1325
1349
 
1330
1354
    @display_command
1331
1355
    def run(self, dir=u'.'):
1332
1356
        tree = WorkingTree.open_containing(dir)[0]
1333
 
        tree.lock_read()
1334
 
        try:
1335
 
            new_inv = tree.inventory
1336
 
            old_tree = tree.basis_tree()
1337
 
            old_tree.lock_read()
1338
 
            try:
1339
 
                old_inv = old_tree.inventory
1340
 
                renames = []
1341
 
                iterator = tree.iter_changes(old_tree, include_unchanged=True)
1342
 
                for f, paths, c, v, p, n, k, e in iterator:
1343
 
                    if paths[0] == paths[1]:
1344
 
                        continue
1345
 
                    if None in (paths):
1346
 
                        continue
1347
 
                    renames.append(paths)
1348
 
                renames.sort()
1349
 
                for old_name, new_name in renames:
1350
 
                    self.outf.write("%s => %s\n" % (old_name, new_name))
1351
 
            finally:
1352
 
                old_tree.unlock()
1353
 
        finally:
1354
 
            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))
1355
1373
 
1356
1374
 
1357
1375
class cmd_update(Command):
1358
 
    """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.
1359
1377
 
1360
1378
    This will perform a merge into the working tree, and may generate
1361
1379
    conflicts. If you have any local changes, you will still
1363
1381
 
1364
1382
    If you want to discard your local changes, you can just do a
1365
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.
1366
1387
    """
1367
1388
 
1368
1389
    _see_also = ['pull', 'working-trees', 'status-flags']
1369
1390
    takes_args = ['dir?']
 
1391
    takes_options = ['revision']
1370
1392
    aliases = ['up']
1371
1393
 
1372
 
    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")
1373
1398
        tree = WorkingTree.open_containing(dir)[0]
 
1399
        branch = tree.branch
1374
1400
        possible_transports = []
1375
 
        master = tree.branch.get_master_branch(
 
1401
        master = branch.get_master_branch(
1376
1402
            possible_transports=possible_transports)
1377
1403
        if master is not None:
 
1404
            branch_location = master.base
1378
1405
            tree.lock_write()
1379
1406
        else:
 
1407
            branch_location = tree.branch.base
1380
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)
1381
1435
        try:
1382
 
            existing_pending_merges = tree.get_parent_ids()[1:]
1383
 
            last_rev = _mod_revision.ensure_null(tree.last_revision())
1384
 
            if last_rev == _mod_revision.ensure_null(
1385
 
                tree.branch.last_revision()):
1386
 
                # may be up to date, check master too.
1387
 
                if master is None or last_rev == _mod_revision.ensure_null(
1388
 
                    master.last_revision()):
1389
 
                    revno = tree.branch.revision_id_to_revno(last_rev)
1390
 
                    note("Tree is up to date at revision %d." % (revno,))
1391
 
                    return 0
1392
 
            view_info = _get_view_info_for_change_reporter(tree)
1393
1436
            conflicts = tree.update(
1394
 
                delta._ChangeReporter(unversioned_filter=tree.is_ignored,
1395
 
                view_info=view_info), possible_transports=possible_transports)
1396
 
            revno = tree.branch.revision_id_to_revno(
1397
 
                _mod_revision.ensure_null(tree.last_revision()))
1398
 
            note('Updated to revision %d.' % (revno,))
1399
 
            if tree.get_parent_ids()[1:] != existing_pending_merges:
1400
 
                note('Your local commits will now show as pending merges with '
1401
 
                     "'bzr status', and can be committed with 'bzr commit'.")
1402
 
            if conflicts != 0:
1403
 
                return 1
1404
 
            else:
1405
 
                return 0
1406
 
        finally:
1407
 
            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
1408
1459
 
1409
1460
 
1410
1461
class cmd_info(Command):
1411
 
    """Show information about a working tree, branch or repository.
 
1462
    __doc__ = """Show information about a working tree, branch or repository.
1412
1463
 
1413
1464
    This command will show all known locations and formats associated to the
1414
1465
    tree, branch or repository.
1452
1503
 
1453
1504
 
1454
1505
class cmd_remove(Command):
1455
 
    """Remove files or directories.
 
1506
    __doc__ = """Remove files or directories.
1456
1507
 
1457
1508
    This makes bzr stop tracking changes to the specified files. bzr will delete
1458
1509
    them if they can easily be recovered using revert. If no options or
1480
1531
        if file_list is not None:
1481
1532
            file_list = [f for f in file_list]
1482
1533
 
1483
 
        tree.lock_write()
1484
 
        try:
1485
 
            # Heuristics should probably all move into tree.remove_smart or
1486
 
            # some such?
1487
 
            if new:
1488
 
                added = tree.changes_from(tree.basis_tree(),
1489
 
                    specific_files=file_list).added
1490
 
                file_list = sorted([f[0] for f in added], reverse=True)
1491
 
                if len(file_list) == 0:
1492
 
                    raise errors.BzrCommandError('No matching files.')
1493
 
            elif file_list is None:
1494
 
                # missing files show up in iter_changes(basis) as
1495
 
                # versioned-with-no-kind.
1496
 
                missing = []
1497
 
                for change in tree.iter_changes(tree.basis_tree()):
1498
 
                    # Find paths in the working tree that have no kind:
1499
 
                    if change[1][1] is not None and change[6][1] is None:
1500
 
                        missing.append(change[1][1])
1501
 
                file_list = sorted(missing, reverse=True)
1502
 
                file_deletion_strategy = 'keep'
1503
 
            tree.remove(file_list, verbose=verbose, to_file=self.outf,
1504
 
                keep_files=file_deletion_strategy=='keep',
1505
 
                force=file_deletion_strategy=='force')
1506
 
        finally:
1507
 
            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')
1508
1556
 
1509
1557
 
1510
1558
class cmd_file_id(Command):
1511
 
    """Print file_id of a particular file or directory.
 
1559
    __doc__ = """Print file_id of a particular file or directory.
1512
1560
 
1513
1561
    The file_id is assigned when the file is first added and remains the
1514
1562
    same through all revisions where the file exists, even when it is
1530
1578
 
1531
1579
 
1532
1580
class cmd_file_path(Command):
1533
 
    """Print path of file_ids to a file or directory.
 
1581
    __doc__ = """Print path of file_ids to a file or directory.
1534
1582
 
1535
1583
    This prints one line for each directory down to the target,
1536
1584
    starting at the branch root.
1552
1600
 
1553
1601
 
1554
1602
class cmd_reconcile(Command):
1555
 
    """Reconcile bzr metadata in a branch.
 
1603
    __doc__ = """Reconcile bzr metadata in a branch.
1556
1604
 
1557
1605
    This can correct data mismatches that may have been caused by
1558
1606
    previous ghost operations or bzr upgrades. You should only
1580
1628
 
1581
1629
 
1582
1630
class cmd_revision_history(Command):
1583
 
    """Display the list of revision ids on a branch."""
 
1631
    __doc__ = """Display the list of revision ids on a branch."""
1584
1632
 
1585
1633
    _see_also = ['log']
1586
1634
    takes_args = ['location?']
1596
1644
 
1597
1645
 
1598
1646
class cmd_ancestry(Command):
1599
 
    """List all revisions merged into this branch."""
 
1647
    __doc__ = """List all revisions merged into this branch."""
1600
1648
 
1601
1649
    _see_also = ['log', 'revision-history']
1602
1650
    takes_args = ['location?']
1621
1669
 
1622
1670
 
1623
1671
class cmd_init(Command):
1624
 
    """Make a directory into a versioned branch.
 
1672
    __doc__ = """Make a directory into a versioned branch.
1625
1673
 
1626
1674
    Use this to create an empty branch, or before importing an
1627
1675
    existing project.
1655
1703
                lazy_registry=('bzrlib.bzrdir', 'format_registry'),
1656
1704
                converter=lambda name: bzrdir.format_registry.make_bzrdir(name),
1657
1705
                value_switches=True,
1658
 
                title="Branch Format",
 
1706
                title="Branch format",
1659
1707
                ),
1660
1708
         Option('append-revisions-only',
1661
1709
                help='Never change revnos or the existing log.'
1730
1778
 
1731
1779
 
1732
1780
class cmd_init_repository(Command):
1733
 
    """Create a shared repository to hold branches.
 
1781
    __doc__ = """Create a shared repository for branches to share storage space.
1734
1782
 
1735
1783
    New branches created under the repository directory will store their
1736
 
    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.
1737
1787
 
1738
 
    If the --no-trees option is used then the branches in the repository
1739
 
    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.
1740
1794
 
1741
1795
    :Examples:
1742
 
        Create a shared repositories holding just branches::
 
1796
        Create a shared repository holding just branches::
1743
1797
 
1744
1798
            bzr init-repo --no-trees repo
1745
1799
            bzr init repo/trunk
1784
1838
 
1785
1839
 
1786
1840
class cmd_diff(Command):
1787
 
    """Show differences in the working tree, between revisions or branches.
 
1841
    __doc__ = """Show differences in the working tree, between revisions or branches.
1788
1842
 
1789
1843
    If no arguments are given, all changes for the current tree are listed.
1790
1844
    If files are given, only the changes in those files are listed.
1811
1865
 
1812
1866
            bzr diff -r1
1813
1867
 
1814
 
        Difference between revision 2 and revision 1::
1815
 
 
1816
 
            bzr diff -r1..2
1817
 
 
1818
 
        Difference between revision 2 and revision 1 for branch xxx::
1819
 
 
1820
 
            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
1821
1889
 
1822
1890
        Show just the differences for file NEWS::
1823
1891
 
1862
1930
            help='Use this command to compare files.',
1863
1931
            type=unicode,
1864
1932
            ),
 
1933
        RegistryOption('format',
 
1934
            help='Diff format to use.',
 
1935
            lazy_registry=('bzrlib.diff', 'format_registry'),
 
1936
            value_switches=False, title='Diff format'),
1865
1937
        ]
1866
1938
    aliases = ['di', 'dif']
1867
1939
    encoding_type = 'exact'
1868
1940
 
1869
1941
    @display_command
1870
1942
    def run(self, revision=None, file_list=None, diff_options=None,
1871
 
            prefix=None, old=None, new=None, using=None):
1872
 
        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)
1873
1946
 
1874
1947
        if (prefix is None) or (prefix == '0'):
1875
1948
            # diff -p0 format
1889
1962
            raise errors.BzrCommandError('bzr diff --revision takes exactly'
1890
1963
                                         ' one or two revision specifiers')
1891
1964
 
1892
 
        old_tree, new_tree, specific_files, extra_trees = \
1893
 
                _get_trees_to_diff(file_list, revision, old, new,
1894
 
                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()
1895
1975
        return show_diff_trees(old_tree, new_tree, sys.stdout,
1896
1976
                               specific_files=specific_files,
1897
1977
                               external_diff_options=diff_options,
1898
1978
                               old_label=old_label, new_label=new_label,
1899
 
                               extra_trees=extra_trees, using=using)
 
1979
                               extra_trees=extra_trees,
 
1980
                               path_encoding=path_encoding,
 
1981
                               using=using,
 
1982
                               format_cls=format)
1900
1983
 
1901
1984
 
1902
1985
class cmd_deleted(Command):
1903
 
    """List files deleted in the working tree.
 
1986
    __doc__ = """List files deleted in the working tree.
1904
1987
    """
1905
1988
    # TODO: Show files deleted since a previous revision, or
1906
1989
    # between two revisions.
1909
1992
    # level of effort but possibly much less IO.  (Or possibly not,
1910
1993
    # if the directories are very large...)
1911
1994
    _see_also = ['status', 'ls']
1912
 
    takes_options = ['show-ids']
 
1995
    takes_options = ['directory', 'show-ids']
1913
1996
 
1914
1997
    @display_command
1915
 
    def run(self, show_ids=False):
1916
 
        tree = WorkingTree.open_containing(u'.')[0]
1917
 
        tree.lock_read()
1918
 
        try:
1919
 
            old = tree.basis_tree()
1920
 
            old.lock_read()
1921
 
            try:
1922
 
                for path, ie in old.inventory.iter_entries():
1923
 
                    if not tree.has_id(ie.file_id):
1924
 
                        self.outf.write(path)
1925
 
                        if show_ids:
1926
 
                            self.outf.write(' ')
1927
 
                            self.outf.write(ie.file_id)
1928
 
                        self.outf.write('\n')
1929
 
            finally:
1930
 
                old.unlock()
1931
 
        finally:
1932
 
            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')
1933
2010
 
1934
2011
 
1935
2012
class cmd_modified(Command):
1936
 
    """List files modified in working tree.
 
2013
    __doc__ = """List files modified in working tree.
1937
2014
    """
1938
2015
 
1939
2016
    hidden = True
1940
2017
    _see_also = ['status', 'ls']
1941
 
    takes_options = [
1942
 
            Option('null',
1943
 
                   help='Write an ascii NUL (\\0) separator '
1944
 
                   'between files rather than a newline.')
1945
 
            ]
 
2018
    takes_options = ['directory', 'null']
1946
2019
 
1947
2020
    @display_command
1948
 
    def run(self, null=False):
1949
 
        tree = WorkingTree.open_containing(u'.')[0]
 
2021
    def run(self, null=False, directory=u'.'):
 
2022
        tree = WorkingTree.open_containing(directory)[0]
1950
2023
        td = tree.changes_from(tree.basis_tree())
1951
2024
        for path, id, kind, text_modified, meta_modified in td.modified:
1952
2025
            if null:
1956
2029
 
1957
2030
 
1958
2031
class cmd_added(Command):
1959
 
    """List files added in working tree.
 
2032
    __doc__ = """List files added in working tree.
1960
2033
    """
1961
2034
 
1962
2035
    hidden = True
1963
2036
    _see_also = ['status', 'ls']
1964
 
    takes_options = [
1965
 
            Option('null',
1966
 
                   help='Write an ascii NUL (\\0) separator '
1967
 
                   'between files rather than a newline.')
1968
 
            ]
 
2037
    takes_options = ['directory', 'null']
1969
2038
 
1970
2039
    @display_command
1971
 
    def run(self, null=False):
1972
 
        wt = WorkingTree.open_containing(u'.')[0]
1973
 
        wt.lock_read()
1974
 
        try:
1975
 
            basis = wt.basis_tree()
1976
 
            basis.lock_read()
1977
 
            try:
1978
 
                basis_inv = basis.inventory
1979
 
                inv = wt.inventory
1980
 
                for file_id in inv:
1981
 
                    if file_id in basis_inv:
1982
 
                        continue
1983
 
                    if inv.is_root(file_id) and len(basis_inv) == 0:
1984
 
                        continue
1985
 
                    path = inv.id2path(file_id)
1986
 
                    if not os.access(osutils.abspath(path), os.F_OK):
1987
 
                        continue
1988
 
                    if null:
1989
 
                        self.outf.write(path + '\0')
1990
 
                    else:
1991
 
                        self.outf.write(osutils.quotefn(path) + '\n')
1992
 
            finally:
1993
 
                basis.unlock()
1994
 
        finally:
1995
 
            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')
1996
2059
 
1997
2060
 
1998
2061
class cmd_root(Command):
1999
 
    """Show the tree root directory.
 
2062
    __doc__ = """Show the tree root directory.
2000
2063
 
2001
2064
    The root is the nearest enclosing directory with a .bzr control
2002
2065
    directory."""
2026
2089
 
2027
2090
 
2028
2091
class cmd_log(Command):
2029
 
    """Show historical log for a branch or subset of a branch.
 
2092
    __doc__ = """Show historical log for a branch or subset of a branch.
2030
2093
 
2031
2094
    log is bzr's default tool for exploring the history of a branch.
2032
2095
    The branch to use is taken from the first parameter. If no parameters
2143
2206
    :Tips & tricks:
2144
2207
 
2145
2208
      GUI tools and IDEs are often better at exploring history than command
2146
 
      line tools. You may prefer qlog or glog from the QBzr and Bzr-Gtk packages
2147
 
      respectively for example. (TortoiseBzr uses qlog for displaying logs.) See
2148
 
      http://bazaar-vcs.org/BzrPlugins and http://bazaar-vcs.org/IDEIntegration.
2149
 
 
2150
 
      Web interfaces are often better at exploring history than command line
2151
 
      tools, particularly for branches on servers. You may prefer Loggerhead
2152
 
      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>.  
2153
2213
 
2154
2214
      You may find it useful to add the aliases below to ``bazaar.conf``::
2155
2215
 
2196
2256
                   help='Show just the specified revision.'
2197
2257
                   ' See also "help revisionspec".'),
2198
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
            ),
2199
2264
            Option('levels',
2200
2265
                   short_name='n',
2201
2266
                   help='Number of levels to display - 0 for all, 1 for flat.',
2216
2281
                   help='Show changes made in each revision as a patch.'),
2217
2282
            Option('include-merges',
2218
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
                   )
2219
2288
            ]
2220
2289
    encoding_type = 'replace'
2221
2290
 
2231
2300
            message=None,
2232
2301
            limit=None,
2233
2302
            show_diff=False,
2234
 
            include_merges=False):
 
2303
            include_merges=False,
 
2304
            authors=None,
 
2305
            exclude_common_ancestry=False,
 
2306
            ):
2235
2307
        from bzrlib.log import (
2236
2308
            Logger,
2237
2309
            make_log_request_dict,
2238
2310
            _get_info_for_log_files,
2239
2311
            )
2240
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')
2241
2317
        if include_merges:
2242
2318
            if levels is None:
2243
2319
                levels = 0
2258
2334
        filter_by_dir = False
2259
2335
        if file_list:
2260
2336
            # find the file ids to log and check for directory filtering
2261
 
            b, file_info_list, rev1, rev2 = _get_info_for_log_files(revision,
2262
 
                file_list)
 
2337
            b, file_info_list, rev1, rev2 = _get_info_for_log_files(
 
2338
                revision, file_list, self.add_cleanup)
2263
2339
            for relpath, file_id, kind in file_info_list:
2264
2340
                if file_id is None:
2265
2341
                    raise errors.BzrCommandError(
2283
2359
                location = '.'
2284
2360
            dir, relpath = bzrdir.BzrDir.open_containing(location)
2285
2361
            b = dir.open_branch()
 
2362
            self.add_cleanup(b.lock_read().unlock)
2286
2363
            rev1, rev2 = _get_revision_range(revision, b, self.name())
2287
2364
 
2288
2365
        # Decide on the type of delta & diff filtering to use
2298
2375
        else:
2299
2376
            diff_type = 'full'
2300
2377
 
2301
 
        b.lock_read()
2302
 
        try:
2303
 
            # Build the log formatter
2304
 
            if log_format is None:
2305
 
                log_format = log.log_formatter_registry.get_default(b)
2306
 
            lf = log_format(show_ids=show_ids, to_file=self.outf,
2307
 
                            show_timezone=timezone,
2308
 
                            delta_format=get_verbosity_level(),
2309
 
                            levels=levels,
2310
 
                            show_advice=levels is None)
2311
 
 
2312
 
            # Choose the algorithm for doing the logging. It's annoying
2313
 
            # having multiple code paths like this but necessary until
2314
 
            # the underlying repository format is faster at generating
2315
 
            # deltas or can provide everything we need from the indices.
2316
 
            # The default algorithm - match-using-deltas - works for
2317
 
            # multiple files and directories and is faster for small
2318
 
            # amounts of history (200 revisions say). However, it's too
2319
 
            # slow for logging a single file in a repository with deep
2320
 
            # history, i.e. > 10K revisions. In the spirit of "do no
2321
 
            # evil when adding features", we continue to use the
2322
 
            # original algorithm - per-file-graph - for the "single
2323
 
            # file that isn't a directory without showing a delta" case.
2324
 
            partial_history = revision and b.repository._format.supports_chks
2325
 
            match_using_deltas = (len(file_ids) != 1 or filter_by_dir
2326
 
                or delta_type or partial_history)
2327
 
 
2328
 
            # Build the LogRequest and execute it
2329
 
            if len(file_ids) == 0:
2330
 
                file_ids = None
2331
 
            rqst = make_log_request_dict(
2332
 
                direction=direction, specific_fileids=file_ids,
2333
 
                start_revision=rev1, end_revision=rev2, limit=limit,
2334
 
                message_search=message, delta_type=delta_type,
2335
 
                diff_type=diff_type, _match_using_deltas=match_using_deltas)
2336
 
            Logger(b, rqst).show(lf)
2337
 
        finally:
2338
 
            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)
2339
2418
 
2340
2419
 
2341
2420
def _get_revision_range(revisionspec_list, branch, command_name):
2359
2438
            raise errors.BzrCommandError(
2360
2439
                "bzr %s doesn't accept two revisions in different"
2361
2440
                " branches." % command_name)
2362
 
        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)
2363
2446
        # Avoid loading all of history when we know a missing
2364
2447
        # end of range means the last revision ...
2365
2448
        if end_spec.spec is None:
2394
2477
 
2395
2478
 
2396
2479
class cmd_touching_revisions(Command):
2397
 
    """Return revision-ids which affected a particular file.
 
2480
    __doc__ = """Return revision-ids which affected a particular file.
2398
2481
 
2399
2482
    A more user-friendly interface is "bzr log FILE".
2400
2483
    """
2405
2488
    @display_command
2406
2489
    def run(self, filename):
2407
2490
        tree, relpath = WorkingTree.open_containing(filename)
 
2491
        file_id = tree.path2id(relpath)
2408
2492
        b = tree.branch
2409
 
        file_id = tree.path2id(relpath)
2410
 
        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:
2411
2496
            self.outf.write("%6d %s\n" % (revno, what))
2412
2497
 
2413
2498
 
2414
2499
class cmd_ls(Command):
2415
 
    """List files in a tree.
 
2500
    __doc__ = """List files in a tree.
2416
2501
    """
2417
2502
 
2418
2503
    _see_also = ['status', 'cat']
2424
2509
                   help='Recurse into subdirectories.'),
2425
2510
            Option('from-root',
2426
2511
                   help='Print paths relative to the root of the branch.'),
2427
 
            Option('unknown', help='Print unknown files.'),
 
2512
            Option('unknown', short_name='u',
 
2513
                help='Print unknown files.'),
2428
2514
            Option('versioned', help='Print versioned files.',
2429
2515
                   short_name='V'),
2430
 
            Option('ignored', help='Print ignored files.'),
2431
 
            Option('null',
2432
 
                   help='Write an ascii NUL (\\0) separator '
2433
 
                   'between files rather than a newline.'),
2434
 
            Option('kind',
 
2516
            Option('ignored', short_name='i',
 
2517
                help='Print ignored files.'),
 
2518
            Option('kind', short_name='k',
2435
2519
                   help='List entries of a particular kind: file, directory, symlink.',
2436
2520
                   type=unicode),
 
2521
            'null',
2437
2522
            'show-ids',
 
2523
            'directory',
2438
2524
            ]
2439
2525
    @display_command
2440
2526
    def run(self, revision=None, verbose=False,
2441
2527
            recursive=False, from_root=False,
2442
2528
            unknown=False, versioned=False, ignored=False,
2443
 
            null=False, kind=None, show_ids=False, path=None):
 
2529
            null=False, kind=None, show_ids=False, path=None, directory=None):
2444
2530
 
2445
2531
        if kind and kind not in ('file', 'directory', 'symlink'):
2446
2532
            raise errors.BzrCommandError('invalid kind specified')
2458
2544
                raise errors.BzrCommandError('cannot specify both --from-root'
2459
2545
                                             ' and PATH')
2460
2546
            fs_path = path
2461
 
        tree, branch, relpath = bzrdir.BzrDir.open_containing_tree_or_branch(
2462
 
            fs_path)
 
2547
        tree, branch, relpath = \
 
2548
            _open_directory_or_containing_tree_or_branch(fs_path, directory)
2463
2549
 
2464
2550
        # Calculate the prefix to use
2465
2551
        prefix = None
2466
2552
        if from_root:
2467
2553
            if relpath:
2468
2554
                prefix = relpath + '/'
2469
 
        elif fs_path != '.':
 
2555
        elif fs_path != '.' and not fs_path.endswith('/'):
2470
2556
            prefix = fs_path + '/'
2471
2557
 
2472
2558
        if revision is not None or tree is None:
2480
2566
                view_str = views.view_display_str(view_files)
2481
2567
                note("Ignoring files outside view. View is %s" % view_str)
2482
2568
 
2483
 
        tree.lock_read()
2484
 
        try:
2485
 
            for fp, fc, fkind, fid, entry in tree.list_files(include_root=False,
2486
 
                from_dir=relpath, recursive=recursive):
2487
 
                # Apply additional masking
2488
 
                if not all and not selection[fc]:
2489
 
                    continue
2490
 
                if kind is not None and fkind != kind:
2491
 
                    continue
2492
 
                if apply_view:
2493
 
                    try:
2494
 
                        if relpath:
2495
 
                            fullpath = osutils.pathjoin(relpath, fp)
2496
 
                        else:
2497
 
                            fullpath = fp
2498
 
                        views.check_path_in_view(tree, fullpath)
2499
 
                    except errors.FileOutsideView:
2500
 
                        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
2501
2586
 
2502
 
                # Output the entry
2503
 
                if prefix:
2504
 
                    fp = osutils.pathjoin(prefix, fp)
2505
 
                kindch = entry.kind_character()
2506
 
                outstring = fp + kindch
2507
 
                ui.ui_factory.clear_term()
2508
 
                if verbose:
2509
 
                    outstring = '%-8s %s' % (fc, outstring)
2510
 
                    if show_ids and fid is not None:
2511
 
                        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:
2512
2613
                    self.outf.write(outstring + '\n')
2513
 
                elif null:
2514
 
                    self.outf.write(fp + '\0')
2515
 
                    if show_ids:
2516
 
                        if fid is not None:
2517
 
                            self.outf.write(fid)
2518
 
                        self.outf.write('\0')
2519
 
                    self.outf.flush()
2520
 
                else:
2521
 
                    if show_ids:
2522
 
                        if fid is not None:
2523
 
                            my_id = fid
2524
 
                        else:
2525
 
                            my_id = ''
2526
 
                        self.outf.write('%-50s %s\n' % (outstring, my_id))
2527
 
                    else:
2528
 
                        self.outf.write(outstring + '\n')
2529
 
        finally:
2530
 
            tree.unlock()
2531
2614
 
2532
2615
 
2533
2616
class cmd_unknowns(Command):
2534
 
    """List unknown files.
 
2617
    __doc__ = """List unknown files.
2535
2618
    """
2536
2619
 
2537
2620
    hidden = True
2538
2621
    _see_also = ['ls']
 
2622
    takes_options = ['directory']
2539
2623
 
2540
2624
    @display_command
2541
 
    def run(self):
2542
 
        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():
2543
2627
            self.outf.write(osutils.quotefn(f) + '\n')
2544
2628
 
2545
2629
 
2546
2630
class cmd_ignore(Command):
2547
 
    """Ignore specified files or patterns.
 
2631
    __doc__ = """Ignore specified files or patterns.
2548
2632
 
2549
2633
    See ``bzr help patterns`` for details on the syntax of patterns.
2550
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
 
2551
2641
    To remove patterns from the ignore list, edit the .bzrignore file.
2552
2642
    After adding, editing or deleting that file either indirectly by
2553
2643
    using this command or directly by using an editor, be sure to commit
2554
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.
2555
2658
 
2556
2659
    Note: ignore patterns containing shell wildcards must be quoted from
2557
2660
    the shell on Unix.
2561
2664
 
2562
2665
            bzr ignore ./Makefile
2563
2666
 
2564
 
        Ignore class files in all directories::
 
2667
        Ignore .class files in all directories...::
2565
2668
 
2566
2669
            bzr ignore "*.class"
2567
2670
 
 
2671
        ...but do not ignore "special.class"::
 
2672
 
 
2673
            bzr ignore "!special.class"
 
2674
 
2568
2675
        Ignore .o files under the lib directory::
2569
2676
 
2570
2677
            bzr ignore "lib/**/*.o"
2576
2683
        Ignore everything but the "debian" toplevel directory::
2577
2684
 
2578
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 "!!*~"
2579
2693
    """
2580
2694
 
2581
2695
    _see_also = ['status', 'ignored', 'patterns']
2582
2696
    takes_args = ['name_pattern*']
2583
 
    takes_options = [
2584
 
        Option('old-default-rules',
2585
 
               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.')
2586
2700
        ]
2587
2701
 
2588
 
    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'.'):
2589
2704
        from bzrlib import ignores
2590
 
        if old_default_rules is not None:
2591
 
            # dump the rules and exit
2592
 
            for pattern in ignores.OLD_DEFAULTS:
2593
 
                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)
2594
2709
            return
2595
2710
        if not name_pattern_list:
2596
2711
            raise errors.BzrCommandError("ignore requires at least one "
2597
 
                                  "NAME_PATTERN or --old-default-rules")
 
2712
                "NAME_PATTERN or --default-rules.")
2598
2713
        name_pattern_list = [globbing.normalize_pattern(p)
2599
2714
                             for p in name_pattern_list]
 
2715
        bad_patterns = ''
 
2716
        for p in name_pattern_list:
 
2717
            if not globbing.Globster.is_pattern_valid(p):
 
2718
                bad_patterns += ('\n  %s' % p)
 
2719
        if bad_patterns:
 
2720
            msg = ('Invalid ignore pattern(s) found. %s' % bad_patterns)
 
2721
            ui.ui_factory.show_error(msg)
 
2722
            raise errors.InvalidPattern('')
2600
2723
        for name_pattern in name_pattern_list:
2601
2724
            if (name_pattern[0] == '/' or
2602
2725
                (len(name_pattern) > 1 and name_pattern[1] == ':')):
2603
2726
                raise errors.BzrCommandError(
2604
2727
                    "NAME_PATTERN should not be an absolute path")
2605
 
        tree, relpath = WorkingTree.open_containing(u'.')
 
2728
        tree, relpath = WorkingTree.open_containing(directory)
2606
2729
        ignores.tree_ignores_add_patterns(tree, name_pattern_list)
2607
2730
        ignored = globbing.Globster(name_pattern_list)
2608
2731
        matches = []
2609
 
        tree.lock_read()
 
2732
        self.add_cleanup(tree.lock_read().unlock)
2610
2733
        for entry in tree.list_files():
2611
2734
            id = entry[3]
2612
2735
            if id is not None:
2613
2736
                filename = entry[0]
2614
2737
                if ignored.match(filename):
2615
 
                    matches.append(filename.encode('utf-8'))
2616
 
        tree.unlock()
 
2738
                    matches.append(filename)
2617
2739
        if len(matches) > 0:
2618
 
            print "Warning: the following files are version controlled and" \
2619
 
                  " match your ignore pattern:\n%s" \
2620
 
                  "\nThese files will continue to be version controlled" \
2621
 
                  " unless you 'bzr remove' them." % ("\n".join(matches),)
 
2740
            self.outf.write("Warning: the following files are version controlled and"
 
2741
                  " match your ignore pattern:\n%s"
 
2742
                  "\nThese files will continue to be version controlled"
 
2743
                  " unless you 'bzr remove' them.\n" % ("\n".join(matches),))
2622
2744
 
2623
2745
 
2624
2746
class cmd_ignored(Command):
2625
 
    """List ignored files and the patterns that matched them.
 
2747
    __doc__ = """List ignored files and the patterns that matched them.
2626
2748
 
2627
2749
    List all the ignored files and the ignore pattern that caused the file to
2628
2750
    be ignored.
2634
2756
 
2635
2757
    encoding_type = 'replace'
2636
2758
    _see_also = ['ignore', 'ls']
 
2759
    takes_options = ['directory']
2637
2760
 
2638
2761
    @display_command
2639
 
    def run(self):
2640
 
        tree = WorkingTree.open_containing(u'.')[0]
2641
 
        tree.lock_read()
2642
 
        try:
2643
 
            for path, file_class, kind, file_id, entry in tree.list_files():
2644
 
                if file_class != 'I':
2645
 
                    continue
2646
 
                ## XXX: Slightly inefficient since this was already calculated
2647
 
                pat = tree.is_ignored(path)
2648
 
                self.outf.write('%-50s %s\n' % (path, pat))
2649
 
        finally:
2650
 
            tree.unlock()
 
2762
    def run(self, directory=u'.'):
 
2763
        tree = WorkingTree.open_containing(directory)[0]
 
2764
        self.add_cleanup(tree.lock_read().unlock)
 
2765
        for path, file_class, kind, file_id, entry in tree.list_files():
 
2766
            if file_class != 'I':
 
2767
                continue
 
2768
            ## XXX: Slightly inefficient since this was already calculated
 
2769
            pat = tree.is_ignored(path)
 
2770
            self.outf.write('%-50s %s\n' % (path, pat))
2651
2771
 
2652
2772
 
2653
2773
class cmd_lookup_revision(Command):
2654
 
    """Lookup the revision-id from a revision-number
 
2774
    __doc__ = """Lookup the revision-id from a revision-number
2655
2775
 
2656
2776
    :Examples:
2657
2777
        bzr lookup-revision 33
2658
2778
    """
2659
2779
    hidden = True
2660
2780
    takes_args = ['revno']
 
2781
    takes_options = ['directory']
2661
2782
 
2662
2783
    @display_command
2663
 
    def run(self, revno):
 
2784
    def run(self, revno, directory=u'.'):
2664
2785
        try:
2665
2786
            revno = int(revno)
2666
2787
        except ValueError:
2667
 
            raise errors.BzrCommandError("not a valid revision-number: %r" % revno)
2668
 
 
2669
 
        print WorkingTree.open_containing(u'.')[0].branch.get_rev_id(revno)
 
2788
            raise errors.BzrCommandError("not a valid revision-number: %r"
 
2789
                                         % revno)
 
2790
        revid = WorkingTree.open_containing(directory)[0].branch.get_rev_id(revno)
 
2791
        self.outf.write("%s\n" % revid)
2670
2792
 
2671
2793
 
2672
2794
class cmd_export(Command):
2673
 
    """Export current or past revision to a destination directory or archive.
 
2795
    __doc__ = """Export current or past revision to a destination directory or archive.
2674
2796
 
2675
2797
    If no revision is specified this exports the last committed revision.
2676
2798
 
2698
2820
      =================       =========================
2699
2821
    """
2700
2822
    takes_args = ['dest', 'branch_or_subdir?']
2701
 
    takes_options = [
 
2823
    takes_options = ['directory',
2702
2824
        Option('format',
2703
2825
               help="Type of file to export to.",
2704
2826
               type=unicode),
2708
2830
        Option('root',
2709
2831
               type=str,
2710
2832
               help="Name of the root directory inside the exported file."),
 
2833
        Option('per-file-timestamps',
 
2834
               help='Set modification time of files to that of the last '
 
2835
                    'revision in which it was changed.'),
2711
2836
        ]
2712
2837
    def run(self, dest, branch_or_subdir=None, revision=None, format=None,
2713
 
        root=None, filters=False):
 
2838
        root=None, filters=False, per_file_timestamps=False, directory=u'.'):
2714
2839
        from bzrlib.export import export
2715
2840
 
2716
2841
        if branch_or_subdir is None:
2717
 
            tree = WorkingTree.open_containing(u'.')[0]
 
2842
            tree = WorkingTree.open_containing(directory)[0]
2718
2843
            b = tree.branch
2719
2844
            subdir = None
2720
2845
        else:
2723
2848
 
2724
2849
        rev_tree = _get_one_revision_tree('export', revision, branch=b, tree=tree)
2725
2850
        try:
2726
 
            export(rev_tree, dest, format, root, subdir, filtered=filters)
 
2851
            export(rev_tree, dest, format, root, subdir, filtered=filters,
 
2852
                   per_file_timestamps=per_file_timestamps)
2727
2853
        except errors.NoSuchExportFormat, e:
2728
2854
            raise errors.BzrCommandError('Unsupported export format: %s' % e.format)
2729
2855
 
2730
2856
 
2731
2857
class cmd_cat(Command):
2732
 
    """Write the contents of a file as of a given revision to standard output.
 
2858
    __doc__ = """Write the contents of a file as of a given revision to standard output.
2733
2859
 
2734
2860
    If no revision is nominated, the last revision is used.
2735
2861
 
2738
2864
    """
2739
2865
 
2740
2866
    _see_also = ['ls']
2741
 
    takes_options = [
 
2867
    takes_options = ['directory',
2742
2868
        Option('name-from-revision', help='The path name in the old tree.'),
2743
2869
        Option('filters', help='Apply content filters to display the '
2744
2870
                'convenience form.'),
2749
2875
 
2750
2876
    @display_command
2751
2877
    def run(self, filename, revision=None, name_from_revision=False,
2752
 
            filters=False):
 
2878
            filters=False, directory=None):
2753
2879
        if revision is not None and len(revision) != 1:
2754
2880
            raise errors.BzrCommandError("bzr cat --revision takes exactly"
2755
2881
                                         " one revision specifier")
2756
2882
        tree, branch, relpath = \
2757
 
            bzrdir.BzrDir.open_containing_tree_or_branch(filename)
2758
 
        branch.lock_read()
2759
 
        try:
2760
 
            return self._run(tree, branch, relpath, filename, revision,
2761
 
                             name_from_revision, filters)
2762
 
        finally:
2763
 
            branch.unlock()
 
2883
            _open_directory_or_containing_tree_or_branch(filename, directory)
 
2884
        self.add_cleanup(branch.lock_read().unlock)
 
2885
        return self._run(tree, branch, relpath, filename, revision,
 
2886
                         name_from_revision, filters)
2764
2887
 
2765
2888
    def _run(self, tree, b, relpath, filename, revision, name_from_revision,
2766
2889
        filtered):
2767
2890
        if tree is None:
2768
2891
            tree = b.basis_tree()
2769
2892
        rev_tree = _get_one_revision_tree('cat', revision, branch=b)
 
2893
        self.add_cleanup(rev_tree.lock_read().unlock)
2770
2894
 
2771
2895
        old_file_id = rev_tree.path2id(relpath)
2772
2896
 
2807
2931
            chunks = content.splitlines(True)
2808
2932
            content = filtered_output_bytes(chunks, filters,
2809
2933
                ContentFilterContext(relpath, rev_tree))
 
2934
            self.cleanup_now()
2810
2935
            self.outf.writelines(content)
2811
2936
        else:
 
2937
            self.cleanup_now()
2812
2938
            self.outf.write(content)
2813
2939
 
2814
2940
 
2815
2941
class cmd_local_time_offset(Command):
2816
 
    """Show the offset in seconds from GMT to local time."""
 
2942
    __doc__ = """Show the offset in seconds from GMT to local time."""
2817
2943
    hidden = True
2818
2944
    @display_command
2819
2945
    def run(self):
2820
 
        print osutils.local_time_offset()
 
2946
        self.outf.write("%s\n" % osutils.local_time_offset())
2821
2947
 
2822
2948
 
2823
2949
 
2824
2950
class cmd_commit(Command):
2825
 
    """Commit changes into a new revision.
 
2951
    __doc__ = """Commit changes into a new revision.
2826
2952
 
2827
2953
    An explanatory message needs to be given for each commit. This is
2828
2954
    often done by using the --message option (getting the message from the
2921
3047
             Option('strict',
2922
3048
                    help="Refuse to commit if there are unknown "
2923
3049
                    "files in the working tree."),
 
3050
             Option('commit-time', type=str,
 
3051
                    help="Manually set a commit time using commit date "
 
3052
                    "format, e.g. '2009-10-10 08:00:00 +0100'."),
2924
3053
             ListOption('fixes', type=str,
2925
3054
                    help="Mark a bug as being fixed by this revision "
2926
3055
                         "(see \"bzr help bugs\")."),
2933
3062
                         "the master branch until a normal commit "
2934
3063
                         "is performed."
2935
3064
                    ),
2936
 
              Option('show-diff',
2937
 
                     help='When no message is supplied, show the diff along'
2938
 
                     ' with the status summary in the message editor.'),
 
3065
             Option('show-diff', short_name='p',
 
3066
                    help='When no message is supplied, show the diff along'
 
3067
                    ' with the status summary in the message editor.'),
2939
3068
             ]
2940
3069
    aliases = ['ci', 'checkin']
2941
3070
 
2960
3089
 
2961
3090
    def run(self, message=None, file=None, verbose=False, selected_list=None,
2962
3091
            unchanged=False, strict=False, local=False, fixes=None,
2963
 
            author=None, show_diff=False, exclude=None):
 
3092
            author=None, show_diff=False, exclude=None, commit_time=None):
2964
3093
        from bzrlib.errors import (
2965
3094
            PointlessCommit,
2966
3095
            ConflictsInTree,
2972
3101
            make_commit_message_template_encoded
2973
3102
        )
2974
3103
 
 
3104
        commit_stamp = offset = None
 
3105
        if commit_time is not None:
 
3106
            try:
 
3107
                commit_stamp, offset = timestamp.parse_patch_date(commit_time)
 
3108
            except ValueError, e:
 
3109
                raise errors.BzrCommandError(
 
3110
                    "Could not parse --commit-time: " + str(e))
 
3111
 
2975
3112
        # TODO: Need a blackbox test for invoking the external editor; may be
2976
3113
        # slightly problematic to run this cross-platform.
2977
3114
 
2997
3134
        if local and not tree.branch.get_bound_location():
2998
3135
            raise errors.LocalRequiresBoundBranch()
2999
3136
 
 
3137
        if message is not None:
 
3138
            try:
 
3139
                file_exists = osutils.lexists(message)
 
3140
            except UnicodeError:
 
3141
                # The commit message contains unicode characters that can't be
 
3142
                # represented in the filesystem encoding, so that can't be a
 
3143
                # file.
 
3144
                file_exists = False
 
3145
            if file_exists:
 
3146
                warning_msg = (
 
3147
                    'The commit message is a file name: "%(f)s".\n'
 
3148
                    '(use --file "%(f)s" to take commit message from that file)'
 
3149
                    % { 'f': message })
 
3150
                ui.ui_factory.show_warning(warning_msg)
 
3151
            if '\r' in message:
 
3152
                message = message.replace('\r\n', '\n')
 
3153
                message = message.replace('\r', '\n')
 
3154
            if file:
 
3155
                raise errors.BzrCommandError(
 
3156
                    "please specify either --message or --file")
 
3157
 
3000
3158
        def get_message(commit_obj):
3001
3159
            """Callback to get commit message"""
3002
 
            my_message = message
3003
 
            if my_message is None and not file:
3004
 
                t = make_commit_message_template_encoded(tree,
 
3160
            if file:
 
3161
                f = codecs.open(file, 'rt', osutils.get_user_encoding())
 
3162
                try:
 
3163
                    my_message = f.read()
 
3164
                finally:
 
3165
                    f.close()
 
3166
            elif message is not None:
 
3167
                my_message = message
 
3168
            else:
 
3169
                # No message supplied: make one up.
 
3170
                # text is the status of the tree
 
3171
                text = make_commit_message_template_encoded(tree,
3005
3172
                        selected_list, diff=show_diff,
3006
3173
                        output_encoding=osutils.get_user_encoding())
 
3174
                # start_message is the template generated from hooks
 
3175
                # XXX: Warning - looks like hooks return unicode,
 
3176
                # make_commit_message_template_encoded returns user encoding.
 
3177
                # We probably want to be using edit_commit_message instead to
 
3178
                # avoid this.
3007
3179
                start_message = generate_commit_message_template(commit_obj)
3008
 
                my_message = edit_commit_message_encoded(t,
 
3180
                my_message = edit_commit_message_encoded(text,
3009
3181
                    start_message=start_message)
3010
3182
                if my_message is None:
3011
3183
                    raise errors.BzrCommandError("please specify a commit"
3012
3184
                        " message with either --message or --file")
3013
 
            elif my_message and file:
3014
 
                raise errors.BzrCommandError(
3015
 
                    "please specify either --message or --file")
3016
 
            if file:
3017
 
                my_message = codecs.open(file, 'rt',
3018
 
                                         osutils.get_user_encoding()).read()
3019
3185
            if my_message == "":
3020
3186
                raise errors.BzrCommandError("empty commit message specified")
3021
3187
            return my_message
3022
3188
 
 
3189
        # The API permits a commit with a filter of [] to mean 'select nothing'
 
3190
        # but the command line should not do that.
 
3191
        if not selected_list:
 
3192
            selected_list = None
3023
3193
        try:
3024
3194
            tree.commit(message_callback=get_message,
3025
3195
                        specific_files=selected_list,
3026
3196
                        allow_pointless=unchanged, strict=strict, local=local,
3027
3197
                        reporter=None, verbose=verbose, revprops=properties,
3028
 
                        authors=author,
 
3198
                        authors=author, timestamp=commit_stamp,
 
3199
                        timezone=offset,
3029
3200
                        exclude=safe_relpath_files(tree, exclude))
3030
3201
        except PointlessCommit:
3031
 
            # FIXME: This should really happen before the file is read in;
3032
 
            # perhaps prepare the commit; get the message; then actually commit
3033
3202
            raise errors.BzrCommandError("No changes to commit."
3034
3203
                              " Use --unchanged to commit anyhow.")
3035
3204
        except ConflictsInTree:
3040
3209
            raise errors.BzrCommandError("Commit refused because there are"
3041
3210
                              " unknown files in the working tree.")
3042
3211
        except errors.BoundBranchOutOfDate, e:
3043
 
            raise errors.BzrCommandError(str(e) + "\n"
3044
 
            'To commit to master branch, run update and then commit.\n'
3045
 
            'You can also pass --local to commit to continue working '
3046
 
            'disconnected.')
 
3212
            e.extra_help = ("\n"
 
3213
                'To commit to master branch, run update and then commit.\n'
 
3214
                'You can also pass --local to commit to continue working '
 
3215
                'disconnected.')
 
3216
            raise
3047
3217
 
3048
3218
 
3049
3219
class cmd_check(Command):
3050
 
    """Validate working tree structure, branch consistency and repository history.
 
3220
    __doc__ = """Validate working tree structure, branch consistency and repository history.
3051
3221
 
3052
3222
    This command checks various invariants about branch and repository storage
3053
3223
    to detect data corruption or bzr bugs.
3117
3287
 
3118
3288
 
3119
3289
class cmd_upgrade(Command):
3120
 
    """Upgrade branch storage to current format.
 
3290
    __doc__ = """Upgrade branch storage to current format.
3121
3291
 
3122
3292
    The check command or bzr developers may sometimes advise you to run
3123
3293
    this command. When the default format has changed you may also be warned
3141
3311
 
3142
3312
 
3143
3313
class cmd_whoami(Command):
3144
 
    """Show or set bzr user id.
 
3314
    __doc__ = """Show or set bzr user id.
3145
3315
 
3146
3316
    :Examples:
3147
3317
        Show the email of the current user::
3152
3322
 
3153
3323
            bzr whoami "Frank Chu <fchu@example.com>"
3154
3324
    """
3155
 
    takes_options = [ Option('email',
 
3325
    takes_options = [ 'directory',
 
3326
                      Option('email',
3156
3327
                             help='Display email address only.'),
3157
3328
                      Option('branch',
3158
3329
                             help='Set identity for the current branch instead of '
3162
3333
    encoding_type = 'replace'
3163
3334
 
3164
3335
    @display_command
3165
 
    def run(self, email=False, branch=False, name=None):
 
3336
    def run(self, email=False, branch=False, name=None, directory=None):
3166
3337
        if name is None:
3167
 
            # use branch if we're inside one; otherwise global config
3168
 
            try:
3169
 
                c = Branch.open_containing('.')[0].get_config()
3170
 
            except errors.NotBranchError:
3171
 
                c = config.GlobalConfig()
 
3338
            if directory is None:
 
3339
                # use branch if we're inside one; otherwise global config
 
3340
                try:
 
3341
                    c = Branch.open_containing(u'.')[0].get_config()
 
3342
                except errors.NotBranchError:
 
3343
                    c = config.GlobalConfig()
 
3344
            else:
 
3345
                c = Branch.open(directory).get_config()
3172
3346
            if email:
3173
3347
                self.outf.write(c.user_email() + '\n')
3174
3348
            else:
3184
3358
 
3185
3359
        # use global config unless --branch given
3186
3360
        if branch:
3187
 
            c = Branch.open_containing('.')[0].get_config()
 
3361
            if directory is None:
 
3362
                c = Branch.open_containing(u'.')[0].get_config()
 
3363
            else:
 
3364
                c = Branch.open(directory).get_config()
3188
3365
        else:
3189
3366
            c = config.GlobalConfig()
3190
3367
        c.set_user_option('email', name)
3191
3368
 
3192
3369
 
3193
3370
class cmd_nick(Command):
3194
 
    """Print or set the branch nickname.
 
3371
    __doc__ = """Print or set the branch nickname.
3195
3372
 
3196
3373
    If unset, the tree root directory name is used as the nickname.
3197
3374
    To print the current nickname, execute with no argument.
3202
3379
 
3203
3380
    _see_also = ['info']
3204
3381
    takes_args = ['nickname?']
3205
 
    def run(self, nickname=None):
3206
 
        branch = Branch.open_containing(u'.')[0]
 
3382
    takes_options = ['directory']
 
3383
    def run(self, nickname=None, directory=u'.'):
 
3384
        branch = Branch.open_containing(directory)[0]
3207
3385
        if nickname is None:
3208
3386
            self.printme(branch)
3209
3387
        else:
3211
3389
 
3212
3390
    @display_command
3213
3391
    def printme(self, branch):
3214
 
        print branch.nick
 
3392
        self.outf.write('%s\n' % branch.nick)
3215
3393
 
3216
3394
 
3217
3395
class cmd_alias(Command):
3218
 
    """Set/unset and display aliases.
 
3396
    __doc__ = """Set/unset and display aliases.
3219
3397
 
3220
3398
    :Examples:
3221
3399
        Show the current aliases::
3285
3463
 
3286
3464
 
3287
3465
class cmd_selftest(Command):
3288
 
    """Run internal test suite.
 
3466
    __doc__ = """Run internal test suite.
3289
3467
 
3290
3468
    If arguments are given, they are regular expressions that say which tests
3291
3469
    should run.  Tests matching any expression are run, and other tests are
3318
3496
    Tests that need working space on disk use a common temporary directory,
3319
3497
    typically inside $TMPDIR or /tmp.
3320
3498
 
 
3499
    If you set BZR_TEST_PDB=1 when running selftest, failing tests will drop
 
3500
    into a pdb postmortem session.
 
3501
 
3321
3502
    :Examples:
3322
3503
        Run only tests relating to 'ignore'::
3323
3504
 
3332
3513
    def get_transport_type(typestring):
3333
3514
        """Parse and return a transport specifier."""
3334
3515
        if typestring == "sftp":
3335
 
            from bzrlib.transport.sftp import SFTPAbsoluteServer
3336
 
            return SFTPAbsoluteServer
 
3516
            from bzrlib.tests import stub_sftp
 
3517
            return stub_sftp.SFTPAbsoluteServer
3337
3518
        if typestring == "memory":
3338
 
            from bzrlib.transport.memory import MemoryServer
3339
 
            return MemoryServer
 
3519
            from bzrlib.tests import test_server
 
3520
            return memory.MemoryServer
3340
3521
        if typestring == "fakenfs":
3341
 
            from bzrlib.transport.fakenfs import FakeNFSServer
3342
 
            return FakeNFSServer
 
3522
            from bzrlib.tests import test_server
 
3523
            return test_server.FakeNFSServer
3343
3524
        msg = "No known transport type %s. Supported types are: sftp\n" %\
3344
3525
            (typestring)
3345
3526
        raise errors.BzrCommandError(msg)
3356
3537
                                 'throughout the test suite.',
3357
3538
                            type=get_transport_type),
3358
3539
                     Option('benchmark',
3359
 
                            help='Run the benchmarks rather than selftests.'),
 
3540
                            help='Run the benchmarks rather than selftests.',
 
3541
                            hidden=True),
3360
3542
                     Option('lsprof-timed',
3361
3543
                            help='Generate lsprof output for benchmarked'
3362
3544
                                 ' sections of code.'),
3363
 
                     Option('cache-dir', type=str,
3364
 
                            help='Cache intermediate benchmark output in this '
3365
 
                                 'directory.'),
 
3545
                     Option('lsprof-tests',
 
3546
                            help='Generate lsprof output for each test.'),
3366
3547
                     Option('first',
3367
3548
                            help='Run all tests, but run specified tests first.',
3368
3549
                            short_name='f',
3402
3583
 
3403
3584
    def run(self, testspecs_list=None, verbose=False, one=False,
3404
3585
            transport=None, benchmark=None,
3405
 
            lsprof_timed=None, cache_dir=None,
 
3586
            lsprof_timed=None,
3406
3587
            first=False, list_only=False,
3407
3588
            randomize=None, exclude=None, strict=False,
3408
3589
            load_list=None, debugflag=None, starting_with=None, subunit=False,
3409
 
            parallel=None):
 
3590
            parallel=None, lsprof_tests=False):
3410
3591
        from bzrlib.tests import selftest
3411
 
        import bzrlib.benchmarks as benchmarks
3412
 
        from bzrlib.benchmarks import tree_creator
3413
3592
 
3414
3593
        # Make deprecation warnings visible, unless -Werror is set
3415
3594
        symbol_versioning.activate_deprecation_warnings(override=False)
3416
3595
 
3417
 
        if cache_dir is not None:
3418
 
            tree_creator.TreeCreator.CACHE_ROOT = osutils.abspath(cache_dir)
3419
3596
        if testspecs_list is not None:
3420
3597
            pattern = '|'.join(testspecs_list)
3421
3598
        else:
3427
3604
                raise errors.BzrCommandError("subunit not available. subunit "
3428
3605
                    "needs to be installed to use --subunit.")
3429
3606
            self.additional_selftest_args['runner_class'] = SubUnitBzrRunner
 
3607
            # On Windows, disable automatic conversion of '\n' to '\r\n' in
 
3608
            # stdout, which would corrupt the subunit stream. 
 
3609
            # FIXME: This has been fixed in subunit trunk (>0.0.5) so the
 
3610
            # following code can be deleted when it's sufficiently deployed
 
3611
            # -- vila/mgz 20100514
 
3612
            if (sys.platform == "win32"
 
3613
                and getattr(sys.stdout, 'fileno', None) is not None):
 
3614
                import msvcrt
 
3615
                msvcrt.setmode(sys.stdout.fileno(), os.O_BINARY)
3430
3616
        if parallel:
3431
3617
            self.additional_selftest_args.setdefault(
3432
3618
                'suite_decorators', []).append(parallel)
3433
3619
        if benchmark:
3434
 
            test_suite_factory = benchmarks.test_suite
3435
 
            # Unless user explicitly asks for quiet, be verbose in benchmarks
3436
 
            verbose = not is_quiet()
3437
 
            # TODO: should possibly lock the history file...
3438
 
            benchfile = open(".perf_history", "at", buffering=1)
3439
 
        else:
3440
 
            test_suite_factory = None
3441
 
            benchfile = None
3442
 
        try:
3443
 
            selftest_kwargs = {"verbose": verbose,
3444
 
                              "pattern": pattern,
3445
 
                              "stop_on_failure": one,
3446
 
                              "transport": transport,
3447
 
                              "test_suite_factory": test_suite_factory,
3448
 
                              "lsprof_timed": lsprof_timed,
3449
 
                              "bench_history": benchfile,
3450
 
                              "matching_tests_first": first,
3451
 
                              "list_only": list_only,
3452
 
                              "random_seed": randomize,
3453
 
                              "exclude_pattern": exclude,
3454
 
                              "strict": strict,
3455
 
                              "load_list": load_list,
3456
 
                              "debug_flags": debugflag,
3457
 
                              "starting_with": starting_with
3458
 
                              }
3459
 
            selftest_kwargs.update(self.additional_selftest_args)
3460
 
            result = selftest(**selftest_kwargs)
3461
 
        finally:
3462
 
            if benchfile is not None:
3463
 
                benchfile.close()
 
3620
            raise errors.BzrCommandError(
 
3621
                "--benchmark is no longer supported from bzr 2.2; "
 
3622
                "use bzr-usertest instead")
 
3623
        test_suite_factory = None
 
3624
        selftest_kwargs = {"verbose": verbose,
 
3625
                          "pattern": pattern,
 
3626
                          "stop_on_failure": one,
 
3627
                          "transport": transport,
 
3628
                          "test_suite_factory": test_suite_factory,
 
3629
                          "lsprof_timed": lsprof_timed,
 
3630
                          "lsprof_tests": lsprof_tests,
 
3631
                          "matching_tests_first": first,
 
3632
                          "list_only": list_only,
 
3633
                          "random_seed": randomize,
 
3634
                          "exclude_pattern": exclude,
 
3635
                          "strict": strict,
 
3636
                          "load_list": load_list,
 
3637
                          "debug_flags": debugflag,
 
3638
                          "starting_with": starting_with
 
3639
                          }
 
3640
        selftest_kwargs.update(self.additional_selftest_args)
 
3641
        result = selftest(**selftest_kwargs)
3464
3642
        return int(not result)
3465
3643
 
3466
3644
 
3467
3645
class cmd_version(Command):
3468
 
    """Show version of bzr."""
 
3646
    __doc__ = """Show version of bzr."""
3469
3647
 
3470
3648
    encoding_type = 'replace'
3471
3649
    takes_options = [
3482
3660
 
3483
3661
 
3484
3662
class cmd_rocks(Command):
3485
 
    """Statement of optimism."""
 
3663
    __doc__ = """Statement of optimism."""
3486
3664
 
3487
3665
    hidden = True
3488
3666
 
3489
3667
    @display_command
3490
3668
    def run(self):
3491
 
        print "It sure does!"
 
3669
        self.outf.write("It sure does!\n")
3492
3670
 
3493
3671
 
3494
3672
class cmd_find_merge_base(Command):
3495
 
    """Find and print a base revision for merging two branches."""
 
3673
    __doc__ = """Find and print a base revision for merging two branches."""
3496
3674
    # TODO: Options to specify revisions on either side, as if
3497
3675
    #       merging only part of the history.
3498
3676
    takes_args = ['branch', 'other']
3504
3682
 
3505
3683
        branch1 = Branch.open_containing(branch)[0]
3506
3684
        branch2 = Branch.open_containing(other)[0]
3507
 
        branch1.lock_read()
3508
 
        try:
3509
 
            branch2.lock_read()
3510
 
            try:
3511
 
                last1 = ensure_null(branch1.last_revision())
3512
 
                last2 = ensure_null(branch2.last_revision())
3513
 
 
3514
 
                graph = branch1.repository.get_graph(branch2.repository)
3515
 
                base_rev_id = graph.find_unique_lca(last1, last2)
3516
 
 
3517
 
                print 'merge base is revision %s' % base_rev_id
3518
 
            finally:
3519
 
                branch2.unlock()
3520
 
        finally:
3521
 
            branch1.unlock()
 
3685
        self.add_cleanup(branch1.lock_read().unlock)
 
3686
        self.add_cleanup(branch2.lock_read().unlock)
 
3687
        last1 = ensure_null(branch1.last_revision())
 
3688
        last2 = ensure_null(branch2.last_revision())
 
3689
 
 
3690
        graph = branch1.repository.get_graph(branch2.repository)
 
3691
        base_rev_id = graph.find_unique_lca(last1, last2)
 
3692
 
 
3693
        self.outf.write('merge base is revision %s\n' % base_rev_id)
3522
3694
 
3523
3695
 
3524
3696
class cmd_merge(Command):
3525
 
    """Perform a three-way merge.
 
3697
    __doc__ = """Perform a three-way merge.
3526
3698
 
3527
3699
    The source of the merge can be specified either in the form of a branch,
3528
3700
    or in the form of a path to a file containing a merge directive generated
3557
3729
    committed to record the result of the merge.
3558
3730
 
3559
3731
    merge refuses to run if there are any uncommitted changes, unless
3560
 
    --force is given.
 
3732
    --force is given. The --force option can also be used to create a
 
3733
    merge revision which has more than two parents.
 
3734
 
 
3735
    If one would like to merge changes from the working tree of the other
 
3736
    branch without merging any committed revisions, the --uncommitted option
 
3737
    can be given.
3561
3738
 
3562
3739
    To select only some changes to merge, use "merge -i", which will prompt
3563
3740
    you to apply each diff hunk and file change, similar to "shelve".
3575
3752
 
3576
3753
            bzr merge -r 81..82 ../bzr.dev
3577
3754
 
3578
 
        To apply a merge directive contained in /tmp/merge:
 
3755
        To apply a merge directive contained in /tmp/merge::
3579
3756
 
3580
3757
            bzr merge /tmp/merge
 
3758
 
 
3759
        To create a merge revision with three parents from two branches
 
3760
        feature1a and feature1b:
 
3761
 
 
3762
            bzr merge ../feature1a
 
3763
            bzr merge ../feature1b --force
 
3764
            bzr commit -m 'revision with three parents'
3581
3765
    """
3582
3766
 
3583
3767
    encoding_type = 'exact'
3599
3783
                ' completely merged into the source, pull from the'
3600
3784
                ' source rather than merging.  When this happens,'
3601
3785
                ' you do not need to commit the result.'),
3602
 
        Option('directory',
 
3786
        custom_help('directory',
3603
3787
               help='Branch to merge into, '
3604
 
                    'rather than the one containing the working directory.',
3605
 
               short_name='d',
3606
 
               type=unicode,
3607
 
               ),
 
3788
                    'rather than the one containing the working directory.'),
3608
3789
        Option('preview', help='Instead of merging, show a diff of the'
3609
3790
               ' merge.'),
3610
3791
        Option('interactive', help='Select changes interactively.',
3628
3809
        verified = 'inapplicable'
3629
3810
        tree = WorkingTree.open_containing(directory)[0]
3630
3811
 
3631
 
        # die as quickly as possible if there are uncommitted changes
3632
3812
        try:
3633
3813
            basis_tree = tree.revision_tree(tree.last_revision())
3634
3814
        except errors.NoSuchRevision:
3635
3815
            basis_tree = tree.basis_tree()
 
3816
 
 
3817
        # die as quickly as possible if there are uncommitted changes
3636
3818
        if not force:
3637
 
            if tree.has_changes(basis_tree):
 
3819
            if tree.has_changes():
3638
3820
                raise errors.UncommittedChanges(tree)
3639
3821
 
3640
3822
        view_info = _get_view_info_for_change_reporter(tree)
3641
3823
        change_reporter = delta._ChangeReporter(
3642
3824
            unversioned_filter=tree.is_ignored, view_info=view_info)
3643
 
        cleanups = []
3644
 
        try:
3645
 
            pb = ui.ui_factory.nested_progress_bar()
3646
 
            cleanups.append(pb.finished)
3647
 
            tree.lock_write()
3648
 
            cleanups.append(tree.unlock)
3649
 
            if location is not None:
3650
 
                try:
3651
 
                    mergeable = bundle.read_mergeable_from_url(location,
3652
 
                        possible_transports=possible_transports)
3653
 
                except errors.NotABundle:
3654
 
                    mergeable = None
3655
 
                else:
3656
 
                    if uncommitted:
3657
 
                        raise errors.BzrCommandError('Cannot use --uncommitted'
3658
 
                            ' with bundles or merge directives.')
3659
 
 
3660
 
                    if revision is not None:
3661
 
                        raise errors.BzrCommandError(
3662
 
                            'Cannot use -r with merge directives or bundles')
3663
 
                    merger, verified = _mod_merge.Merger.from_mergeable(tree,
3664
 
                       mergeable, pb)
3665
 
 
3666
 
            if merger is None and uncommitted:
3667
 
                if revision is not None and len(revision) > 0:
3668
 
                    raise errors.BzrCommandError('Cannot use --uncommitted and'
3669
 
                        ' --revision at the same time.')
3670
 
                merger = self.get_merger_from_uncommitted(tree, location, pb,
3671
 
                                                          cleanups)
3672
 
                allow_pending = False
3673
 
 
3674
 
            if merger is None:
3675
 
                merger, allow_pending = self._get_merger_from_branch(tree,
3676
 
                    location, revision, remember, possible_transports, pb)
3677
 
 
3678
 
            merger.merge_type = merge_type
3679
 
            merger.reprocess = reprocess
3680
 
            merger.show_base = show_base
3681
 
            self.sanity_check_merger(merger)
3682
 
            if (merger.base_rev_id == merger.other_rev_id and
3683
 
                merger.other_rev_id is not None):
3684
 
                note('Nothing to do.')
 
3825
        pb = ui.ui_factory.nested_progress_bar()
 
3826
        self.add_cleanup(pb.finished)
 
3827
        self.add_cleanup(tree.lock_write().unlock)
 
3828
        if location is not None:
 
3829
            try:
 
3830
                mergeable = bundle.read_mergeable_from_url(location,
 
3831
                    possible_transports=possible_transports)
 
3832
            except errors.NotABundle:
 
3833
                mergeable = None
 
3834
            else:
 
3835
                if uncommitted:
 
3836
                    raise errors.BzrCommandError('Cannot use --uncommitted'
 
3837
                        ' with bundles or merge directives.')
 
3838
 
 
3839
                if revision is not None:
 
3840
                    raise errors.BzrCommandError(
 
3841
                        'Cannot use -r with merge directives or bundles')
 
3842
                merger, verified = _mod_merge.Merger.from_mergeable(tree,
 
3843
                   mergeable, None)
 
3844
 
 
3845
        if merger is None and uncommitted:
 
3846
            if revision is not None and len(revision) > 0:
 
3847
                raise errors.BzrCommandError('Cannot use --uncommitted and'
 
3848
                    ' --revision at the same time.')
 
3849
            merger = self.get_merger_from_uncommitted(tree, location, None)
 
3850
            allow_pending = False
 
3851
 
 
3852
        if merger is None:
 
3853
            merger, allow_pending = self._get_merger_from_branch(tree,
 
3854
                location, revision, remember, possible_transports, None)
 
3855
 
 
3856
        merger.merge_type = merge_type
 
3857
        merger.reprocess = reprocess
 
3858
        merger.show_base = show_base
 
3859
        self.sanity_check_merger(merger)
 
3860
        if (merger.base_rev_id == merger.other_rev_id and
 
3861
            merger.other_rev_id is not None):
 
3862
            note('Nothing to do.')
 
3863
            return 0
 
3864
        if pull:
 
3865
            if merger.interesting_files is not None:
 
3866
                raise errors.BzrCommandError('Cannot pull individual files')
 
3867
            if (merger.base_rev_id == tree.last_revision()):
 
3868
                result = tree.pull(merger.other_branch, False,
 
3869
                                   merger.other_rev_id)
 
3870
                result.report(self.outf)
3685
3871
                return 0
3686
 
            if pull:
3687
 
                if merger.interesting_files is not None:
3688
 
                    raise errors.BzrCommandError('Cannot pull individual files')
3689
 
                if (merger.base_rev_id == tree.last_revision()):
3690
 
                    result = tree.pull(merger.other_branch, False,
3691
 
                                       merger.other_rev_id)
3692
 
                    result.report(self.outf)
3693
 
                    return 0
3694
 
            merger.check_basis(False)
3695
 
            if preview:
3696
 
                return self._do_preview(merger, cleanups)
3697
 
            elif interactive:
3698
 
                return self._do_interactive(merger, cleanups)
3699
 
            else:
3700
 
                return self._do_merge(merger, change_reporter, allow_pending,
3701
 
                                      verified)
3702
 
        finally:
3703
 
            for cleanup in reversed(cleanups):
3704
 
                cleanup()
 
3872
        if merger.this_basis is None:
 
3873
            raise errors.BzrCommandError(
 
3874
                "This branch has no commits."
 
3875
                " (perhaps you would prefer 'bzr pull')")
 
3876
        if preview:
 
3877
            return self._do_preview(merger)
 
3878
        elif interactive:
 
3879
            return self._do_interactive(merger)
 
3880
        else:
 
3881
            return self._do_merge(merger, change_reporter, allow_pending,
 
3882
                                  verified)
3705
3883
 
3706
 
    def _get_preview(self, merger, cleanups):
 
3884
    def _get_preview(self, merger):
3707
3885
        tree_merger = merger.make_merger()
3708
3886
        tt = tree_merger.make_preview_transform()
3709
 
        cleanups.append(tt.finalize)
 
3887
        self.add_cleanup(tt.finalize)
3710
3888
        result_tree = tt.get_preview_tree()
3711
3889
        return result_tree
3712
3890
 
3713
 
    def _do_preview(self, merger, cleanups):
 
3891
    def _do_preview(self, merger):
3714
3892
        from bzrlib.diff import show_diff_trees
3715
 
        result_tree = self._get_preview(merger, cleanups)
 
3893
        result_tree = self._get_preview(merger)
 
3894
        path_encoding = osutils.get_diff_header_encoding()
3716
3895
        show_diff_trees(merger.this_tree, result_tree, self.outf,
3717
 
                        old_label='', new_label='')
 
3896
                        old_label='', new_label='',
 
3897
                        path_encoding=path_encoding)
3718
3898
 
3719
3899
    def _do_merge(self, merger, change_reporter, allow_pending, verified):
3720
3900
        merger.change_reporter = change_reporter
3728
3908
        else:
3729
3909
            return 0
3730
3910
 
3731
 
    def _do_interactive(self, merger, cleanups):
 
3911
    def _do_interactive(self, merger):
3732
3912
        """Perform an interactive merge.
3733
3913
 
3734
3914
        This works by generating a preview tree of the merge, then using
3736
3916
        and the preview tree.
3737
3917
        """
3738
3918
        from bzrlib import shelf_ui
3739
 
        result_tree = self._get_preview(merger, cleanups)
 
3919
        result_tree = self._get_preview(merger)
3740
3920
        writer = bzrlib.option.diff_writer_registry.get()
3741
3921
        shelver = shelf_ui.Shelver(merger.this_tree, result_tree, destroy=True,
3742
3922
                                   reporter=shelf_ui.ApplyReporter(),
3743
3923
                                   diff_writer=writer(sys.stdout))
3744
 
        shelver.run()
 
3924
        try:
 
3925
            shelver.run()
 
3926
        finally:
 
3927
            shelver.finalize()
3745
3928
 
3746
3929
    def sanity_check_merger(self, merger):
3747
3930
        if (merger.show_base and
3807
3990
            allow_pending = True
3808
3991
        return merger, allow_pending
3809
3992
 
3810
 
    def get_merger_from_uncommitted(self, tree, location, pb, cleanups):
 
3993
    def get_merger_from_uncommitted(self, tree, location, pb):
3811
3994
        """Get a merger for uncommitted changes.
3812
3995
 
3813
3996
        :param tree: The tree the merger should apply to.
3814
3997
        :param location: The location containing uncommitted changes.
3815
3998
        :param pb: The progress bar to use for showing progress.
3816
 
        :param cleanups: A list of operations to perform to clean up the
3817
 
            temporary directories, unfinalized objects, etc.
3818
3999
        """
3819
4000
        location = self._select_branch_location(tree, location)[0]
3820
4001
        other_tree, other_path = WorkingTree.open_containing(location)
3872
4053
 
3873
4054
 
3874
4055
class cmd_remerge(Command):
3875
 
    """Redo a merge.
 
4056
    __doc__ = """Redo a merge.
3876
4057
 
3877
4058
    Use this if you want to try a different merge technique while resolving
3878
4059
    conflicts.  Some merge techniques are better than others, and remerge
3903
4084
 
3904
4085
    def run(self, file_list=None, merge_type=None, show_base=False,
3905
4086
            reprocess=False):
 
4087
        from bzrlib.conflicts import restore
3906
4088
        if merge_type is None:
3907
4089
            merge_type = _mod_merge.Merge3Merger
3908
4090
        tree, file_list = tree_files(file_list)
3909
 
        tree.lock_write()
3910
 
        try:
3911
 
            parents = tree.get_parent_ids()
3912
 
            if len(parents) != 2:
3913
 
                raise errors.BzrCommandError("Sorry, remerge only works after normal"
3914
 
                                             " merges.  Not cherrypicking or"
3915
 
                                             " multi-merges.")
3916
 
            repository = tree.branch.repository
3917
 
            interesting_ids = None
3918
 
            new_conflicts = []
3919
 
            conflicts = tree.conflicts()
3920
 
            if file_list is not None:
3921
 
                interesting_ids = set()
3922
 
                for filename in file_list:
3923
 
                    file_id = tree.path2id(filename)
3924
 
                    if file_id is None:
3925
 
                        raise errors.NotVersionedError(filename)
3926
 
                    interesting_ids.add(file_id)
3927
 
                    if tree.kind(file_id) != "directory":
3928
 
                        continue
 
4091
        self.add_cleanup(tree.lock_write().unlock)
 
4092
        parents = tree.get_parent_ids()
 
4093
        if len(parents) != 2:
 
4094
            raise errors.BzrCommandError("Sorry, remerge only works after normal"
 
4095
                                         " merges.  Not cherrypicking or"
 
4096
                                         " multi-merges.")
 
4097
        repository = tree.branch.repository
 
4098
        interesting_ids = None
 
4099
        new_conflicts = []
 
4100
        conflicts = tree.conflicts()
 
4101
        if file_list is not None:
 
4102
            interesting_ids = set()
 
4103
            for filename in file_list:
 
4104
                file_id = tree.path2id(filename)
 
4105
                if file_id is None:
 
4106
                    raise errors.NotVersionedError(filename)
 
4107
                interesting_ids.add(file_id)
 
4108
                if tree.kind(file_id) != "directory":
 
4109
                    continue
3929
4110
 
3930
 
                    for name, ie in tree.inventory.iter_entries(file_id):
3931
 
                        interesting_ids.add(ie.file_id)
3932
 
                new_conflicts = conflicts.select_conflicts(tree, file_list)[0]
3933
 
            else:
3934
 
                # Remerge only supports resolving contents conflicts
3935
 
                allowed_conflicts = ('text conflict', 'contents conflict')
3936
 
                restore_files = [c.path for c in conflicts
3937
 
                                 if c.typestring in allowed_conflicts]
3938
 
            _mod_merge.transform_tree(tree, tree.basis_tree(), interesting_ids)
3939
 
            tree.set_conflicts(ConflictList(new_conflicts))
3940
 
            if file_list is not None:
3941
 
                restore_files = file_list
3942
 
            for filename in restore_files:
3943
 
                try:
3944
 
                    restore(tree.abspath(filename))
3945
 
                except errors.NotConflicted:
3946
 
                    pass
3947
 
            # Disable pending merges, because the file texts we are remerging
3948
 
            # have not had those merges performed.  If we use the wrong parents
3949
 
            # list, we imply that the working tree text has seen and rejected
3950
 
            # all the changes from the other tree, when in fact those changes
3951
 
            # have not yet been seen.
3952
 
            pb = ui.ui_factory.nested_progress_bar()
3953
 
            tree.set_parent_ids(parents[:1])
 
4111
                for name, ie in tree.inventory.iter_entries(file_id):
 
4112
                    interesting_ids.add(ie.file_id)
 
4113
            new_conflicts = conflicts.select_conflicts(tree, file_list)[0]
 
4114
        else:
 
4115
            # Remerge only supports resolving contents conflicts
 
4116
            allowed_conflicts = ('text conflict', 'contents conflict')
 
4117
            restore_files = [c.path for c in conflicts
 
4118
                             if c.typestring in allowed_conflicts]
 
4119
        _mod_merge.transform_tree(tree, tree.basis_tree(), interesting_ids)
 
4120
        tree.set_conflicts(ConflictList(new_conflicts))
 
4121
        if file_list is not None:
 
4122
            restore_files = file_list
 
4123
        for filename in restore_files:
3954
4124
            try:
3955
 
                merger = _mod_merge.Merger.from_revision_ids(pb,
3956
 
                                                             tree, parents[1])
3957
 
                merger.interesting_ids = interesting_ids
3958
 
                merger.merge_type = merge_type
3959
 
                merger.show_base = show_base
3960
 
                merger.reprocess = reprocess
3961
 
                conflicts = merger.do_merge()
3962
 
            finally:
3963
 
                tree.set_parent_ids(parents)
3964
 
                pb.finished()
 
4125
                restore(tree.abspath(filename))
 
4126
            except errors.NotConflicted:
 
4127
                pass
 
4128
        # Disable pending merges, because the file texts we are remerging
 
4129
        # have not had those merges performed.  If we use the wrong parents
 
4130
        # list, we imply that the working tree text has seen and rejected
 
4131
        # all the changes from the other tree, when in fact those changes
 
4132
        # have not yet been seen.
 
4133
        tree.set_parent_ids(parents[:1])
 
4134
        try:
 
4135
            merger = _mod_merge.Merger.from_revision_ids(None, tree, parents[1])
 
4136
            merger.interesting_ids = interesting_ids
 
4137
            merger.merge_type = merge_type
 
4138
            merger.show_base = show_base
 
4139
            merger.reprocess = reprocess
 
4140
            conflicts = merger.do_merge()
3965
4141
        finally:
3966
 
            tree.unlock()
 
4142
            tree.set_parent_ids(parents)
3967
4143
        if conflicts > 0:
3968
4144
            return 1
3969
4145
        else:
3971
4147
 
3972
4148
 
3973
4149
class cmd_revert(Command):
3974
 
    """Revert files to a previous revision.
 
4150
    __doc__ = """Revert files to a previous revision.
3975
4151
 
3976
4152
    Giving a list of files will revert only those files.  Otherwise, all files
3977
4153
    will be reverted.  If the revision is not specified with '--revision', the
3991
4167
    name.  If you name a directory, all the contents of that directory will be
3992
4168
    reverted.
3993
4169
 
3994
 
    Any files that have been newly added since that revision will be deleted,
3995
 
    with a backup kept if appropriate.  Directories containing unknown files
3996
 
    will not be deleted.
 
4170
    If you have newly added files since the target revision, they will be
 
4171
    removed.  If the files to be removed have been changed, backups will be
 
4172
    created as above.  Directories containing unknown files will not be
 
4173
    deleted.
3997
4174
 
3998
 
    The working tree contains a list of pending merged revisions, which will
3999
 
    be included as parents in the next commit.  Normally, revert clears that
4000
 
    list as well as reverting the files.  If any files are specified, revert
4001
 
    leaves the pending merge list alone and reverts only the files.  Use "bzr
4002
 
    revert ." in the tree root to revert all files but keep the merge record,
4003
 
    and "bzr revert --forget-merges" to clear the pending merge list without
 
4175
    The working tree contains a list of revisions that have been merged but
 
4176
    not yet committed. These revisions will be included as additional parents
 
4177
    of the next commit.  Normally, using revert clears that list as well as
 
4178
    reverting the files.  If any files are specified, revert leaves the list
 
4179
    of uncommitted merges alone and reverts only the files.  Use ``bzr revert
 
4180
    .`` in the tree root to revert all files but keep the recorded merges,
 
4181
    and ``bzr revert --forget-merges`` to clear the pending merge list without
4004
4182
    reverting any files.
 
4183
 
 
4184
    Using "bzr revert --forget-merges", it is possible to apply all of the
 
4185
    changes from a branch in a single revision.  To do this, perform the merge
 
4186
    as desired.  Then doing revert with the "--forget-merges" option will keep
 
4187
    the content of the tree as it was, but it will clear the list of pending
 
4188
    merges.  The next commit will then contain all of the changes that are
 
4189
    present in the other branch, but without any other parent revisions.
 
4190
    Because this technique forgets where these changes originated, it may
 
4191
    cause additional conflicts on later merges involving the same source and
 
4192
    target branches.
4005
4193
    """
4006
4194
 
4007
4195
    _see_also = ['cat', 'export']
4016
4204
    def run(self, revision=None, no_backup=False, file_list=None,
4017
4205
            forget_merges=None):
4018
4206
        tree, file_list = tree_files(file_list)
4019
 
        tree.lock_write()
4020
 
        try:
4021
 
            if forget_merges:
4022
 
                tree.set_parent_ids(tree.get_parent_ids()[:1])
4023
 
            else:
4024
 
                self._revert_tree_to_revision(tree, revision, file_list, no_backup)
4025
 
        finally:
4026
 
            tree.unlock()
 
4207
        self.add_cleanup(tree.lock_tree_write().unlock)
 
4208
        if forget_merges:
 
4209
            tree.set_parent_ids(tree.get_parent_ids()[:1])
 
4210
        else:
 
4211
            self._revert_tree_to_revision(tree, revision, file_list, no_backup)
4027
4212
 
4028
4213
    @staticmethod
4029
4214
    def _revert_tree_to_revision(tree, revision, file_list, no_backup):
4030
4215
        rev_tree = _get_one_revision_tree('revert', revision, tree=tree)
4031
 
        pb = ui.ui_factory.nested_progress_bar()
4032
 
        try:
4033
 
            tree.revert(file_list, rev_tree, not no_backup, pb,
4034
 
                report_changes=True)
4035
 
        finally:
4036
 
            pb.finished()
 
4216
        tree.revert(file_list, rev_tree, not no_backup, None,
 
4217
            report_changes=True)
4037
4218
 
4038
4219
 
4039
4220
class cmd_assert_fail(Command):
4040
 
    """Test reporting of assertion failures"""
 
4221
    __doc__ = """Test reporting of assertion failures"""
4041
4222
    # intended just for use in testing
4042
4223
 
4043
4224
    hidden = True
4047
4228
 
4048
4229
 
4049
4230
class cmd_help(Command):
4050
 
    """Show help on a command or other topic.
 
4231
    __doc__ = """Show help on a command or other topic.
4051
4232
    """
4052
4233
 
4053
4234
    _see_also = ['topics']
4066
4247
 
4067
4248
 
4068
4249
class cmd_shell_complete(Command):
4069
 
    """Show appropriate completions for context.
 
4250
    __doc__ = """Show appropriate completions for context.
4070
4251
 
4071
4252
    For a list of all available commands, say 'bzr shell-complete'.
4072
4253
    """
4081
4262
 
4082
4263
 
4083
4264
class cmd_missing(Command):
4084
 
    """Show unmerged/unpulled revisions between two branches.
 
4265
    __doc__ = """Show unmerged/unpulled revisions between two branches.
4085
4266
 
4086
4267
    OTHER_BRANCH may be local or remote.
4087
4268
 
4088
4269
    To filter on a range of revisions, you can use the command -r begin..end
4089
4270
    -r revision requests a specific revision, -r ..end or -r begin.. are
4090
4271
    also valid.
 
4272
            
 
4273
    :Exit values:
 
4274
        1 - some missing revisions
 
4275
        0 - no missing revisions
4091
4276
 
4092
4277
    :Examples:
4093
4278
 
4114
4299
    _see_also = ['merge', 'pull']
4115
4300
    takes_args = ['other_branch?']
4116
4301
    takes_options = [
 
4302
        'directory',
4117
4303
        Option('reverse', 'Reverse the order of revisions.'),
4118
4304
        Option('mine-only',
4119
4305
               'Display changes in the local branch only.'),
4141
4327
            theirs_only=False,
4142
4328
            log_format=None, long=False, short=False, line=False,
4143
4329
            show_ids=False, verbose=False, this=False, other=False,
4144
 
            include_merges=False, revision=None, my_revision=None):
 
4330
            include_merges=False, revision=None, my_revision=None,
 
4331
            directory=u'.'):
4145
4332
        from bzrlib.missing import find_unmerged, iter_log_revisions
4146
4333
        def message(s):
4147
4334
            if not is_quiet():
4160
4347
        elif theirs_only:
4161
4348
            restrict = 'remote'
4162
4349
 
4163
 
        local_branch = Branch.open_containing(u".")[0]
 
4350
        local_branch = Branch.open_containing(directory)[0]
 
4351
        self.add_cleanup(local_branch.lock_read().unlock)
 
4352
 
4164
4353
        parent = local_branch.get_parent()
4165
4354
        if other_branch is None:
4166
4355
            other_branch = parent
4175
4364
        remote_branch = Branch.open(other_branch)
4176
4365
        if remote_branch.base == local_branch.base:
4177
4366
            remote_branch = local_branch
 
4367
        else:
 
4368
            self.add_cleanup(remote_branch.lock_read().unlock)
4178
4369
 
4179
4370
        local_revid_range = _revision_range_to_revid_range(
4180
4371
            _get_revision_range(my_revision, local_branch,
4184
4375
            _get_revision_range(revision,
4185
4376
                remote_branch, self.name()))
4186
4377
 
4187
 
        local_branch.lock_read()
4188
 
        try:
4189
 
            remote_branch.lock_read()
4190
 
            try:
4191
 
                local_extra, remote_extra = find_unmerged(
4192
 
                    local_branch, remote_branch, restrict,
4193
 
                    backward=not reverse,
4194
 
                    include_merges=include_merges,
4195
 
                    local_revid_range=local_revid_range,
4196
 
                    remote_revid_range=remote_revid_range)
4197
 
 
4198
 
                if log_format is None:
4199
 
                    registry = log.log_formatter_registry
4200
 
                    log_format = registry.get_default(local_branch)
4201
 
                lf = log_format(to_file=self.outf,
4202
 
                                show_ids=show_ids,
4203
 
                                show_timezone='original')
4204
 
 
4205
 
                status_code = 0
4206
 
                if local_extra and not theirs_only:
4207
 
                    message("You have %d extra revision(s):\n" %
4208
 
                        len(local_extra))
4209
 
                    for revision in iter_log_revisions(local_extra,
4210
 
                                        local_branch.repository,
4211
 
                                        verbose):
4212
 
                        lf.log_revision(revision)
4213
 
                    printed_local = True
4214
 
                    status_code = 1
4215
 
                else:
4216
 
                    printed_local = False
4217
 
 
4218
 
                if remote_extra and not mine_only:
4219
 
                    if printed_local is True:
4220
 
                        message("\n\n\n")
4221
 
                    message("You are missing %d revision(s):\n" %
4222
 
                        len(remote_extra))
4223
 
                    for revision in iter_log_revisions(remote_extra,
4224
 
                                        remote_branch.repository,
4225
 
                                        verbose):
4226
 
                        lf.log_revision(revision)
4227
 
                    status_code = 1
4228
 
 
4229
 
                if mine_only and not local_extra:
4230
 
                    # We checked local, and found nothing extra
4231
 
                    message('This branch is up to date.\n')
4232
 
                elif theirs_only and not remote_extra:
4233
 
                    # We checked remote, and found nothing extra
4234
 
                    message('Other branch is up to date.\n')
4235
 
                elif not (mine_only or theirs_only or local_extra or
4236
 
                          remote_extra):
4237
 
                    # We checked both branches, and neither one had extra
4238
 
                    # revisions
4239
 
                    message("Branches are up to date.\n")
4240
 
            finally:
4241
 
                remote_branch.unlock()
4242
 
        finally:
4243
 
            local_branch.unlock()
 
4378
        local_extra, remote_extra = find_unmerged(
 
4379
            local_branch, remote_branch, restrict,
 
4380
            backward=not reverse,
 
4381
            include_merges=include_merges,
 
4382
            local_revid_range=local_revid_range,
 
4383
            remote_revid_range=remote_revid_range)
 
4384
 
 
4385
        if log_format is None:
 
4386
            registry = log.log_formatter_registry
 
4387
            log_format = registry.get_default(local_branch)
 
4388
        lf = log_format(to_file=self.outf,
 
4389
                        show_ids=show_ids,
 
4390
                        show_timezone='original')
 
4391
 
 
4392
        status_code = 0
 
4393
        if local_extra and not theirs_only:
 
4394
            message("You have %d extra revision(s):\n" %
 
4395
                len(local_extra))
 
4396
            for revision in iter_log_revisions(local_extra,
 
4397
                                local_branch.repository,
 
4398
                                verbose):
 
4399
                lf.log_revision(revision)
 
4400
            printed_local = True
 
4401
            status_code = 1
 
4402
        else:
 
4403
            printed_local = False
 
4404
 
 
4405
        if remote_extra and not mine_only:
 
4406
            if printed_local is True:
 
4407
                message("\n\n\n")
 
4408
            message("You are missing %d revision(s):\n" %
 
4409
                len(remote_extra))
 
4410
            for revision in iter_log_revisions(remote_extra,
 
4411
                                remote_branch.repository,
 
4412
                                verbose):
 
4413
                lf.log_revision(revision)
 
4414
            status_code = 1
 
4415
 
 
4416
        if mine_only and not local_extra:
 
4417
            # We checked local, and found nothing extra
 
4418
            message('This branch is up to date.\n')
 
4419
        elif theirs_only and not remote_extra:
 
4420
            # We checked remote, and found nothing extra
 
4421
            message('Other branch is up to date.\n')
 
4422
        elif not (mine_only or theirs_only or local_extra or
 
4423
                  remote_extra):
 
4424
            # We checked both branches, and neither one had extra
 
4425
            # revisions
 
4426
            message("Branches are up to date.\n")
 
4427
        self.cleanup_now()
4244
4428
        if not status_code and parent is None and other_branch is not None:
4245
 
            local_branch.lock_write()
4246
 
            try:
4247
 
                # handle race conditions - a parent might be set while we run.
4248
 
                if local_branch.get_parent() is None:
4249
 
                    local_branch.set_parent(remote_branch.base)
4250
 
            finally:
4251
 
                local_branch.unlock()
 
4429
            self.add_cleanup(local_branch.lock_write().unlock)
 
4430
            # handle race conditions - a parent might be set while we run.
 
4431
            if local_branch.get_parent() is None:
 
4432
                local_branch.set_parent(remote_branch.base)
4252
4433
        return status_code
4253
4434
 
4254
4435
 
4255
4436
class cmd_pack(Command):
4256
 
    """Compress the data within a repository."""
 
4437
    __doc__ = """Compress the data within a repository.
 
4438
 
 
4439
    This operation compresses the data within a bazaar repository. As
 
4440
    bazaar supports automatic packing of repository, this operation is
 
4441
    normally not required to be done manually.
 
4442
 
 
4443
    During the pack operation, bazaar takes a backup of existing repository
 
4444
    data, i.e. pack files. This backup is eventually removed by bazaar
 
4445
    automatically when it is safe to do so. To save disk space by removing
 
4446
    the backed up pack files, the --clean-obsolete-packs option may be
 
4447
    used.
 
4448
 
 
4449
    Warning: If you use --clean-obsolete-packs and your machine crashes
 
4450
    during or immediately after repacking, you may be left with a state
 
4451
    where the deletion has been written to disk but the new packs have not
 
4452
    been. In this case the repository may be unusable.
 
4453
    """
4257
4454
 
4258
4455
    _see_also = ['repositories']
4259
4456
    takes_args = ['branch_or_repo?']
 
4457
    takes_options = [
 
4458
        Option('clean-obsolete-packs', 'Delete obsolete packs to save disk space.'),
 
4459
        ]
4260
4460
 
4261
 
    def run(self, branch_or_repo='.'):
 
4461
    def run(self, branch_or_repo='.', clean_obsolete_packs=False):
4262
4462
        dir = bzrdir.BzrDir.open_containing(branch_or_repo)[0]
4263
4463
        try:
4264
4464
            branch = dir.open_branch()
4265
4465
            repository = branch.repository
4266
4466
        except errors.NotBranchError:
4267
4467
            repository = dir.open_repository()
4268
 
        repository.pack()
 
4468
        repository.pack(clean_obsolete_packs=clean_obsolete_packs)
4269
4469
 
4270
4470
 
4271
4471
class cmd_plugins(Command):
4272
 
    """List the installed plugins.
 
4472
    __doc__ = """List the installed plugins.
4273
4473
 
4274
4474
    This command displays the list of installed plugins including
4275
4475
    version of plugin and a short description of each.
4282
4482
    adding new commands, providing additional network transports and
4283
4483
    customizing log output.
4284
4484
 
4285
 
    See the Bazaar web site, http://bazaar-vcs.org, for further
4286
 
    information on plugins including where to find them and how to
4287
 
    install them. Instructions are also provided there on how to
4288
 
    write new plugins using the Python programming language.
 
4485
    See the Bazaar Plugin Guide <http://doc.bazaar.canonical.com/plugins/en/>
 
4486
    for further information on plugins including where to find them and how to
 
4487
    install them. Instructions are also provided there on how to write new
 
4488
    plugins using the Python programming language.
4289
4489
    """
4290
4490
    takes_options = ['verbose']
4291
4491
 
4306
4506
                doc = '(no description)'
4307
4507
            result.append((name_ver, doc, plugin.path()))
4308
4508
        for name_ver, doc, path in sorted(result):
4309
 
            print name_ver
4310
 
            print '   ', doc
 
4509
            self.outf.write("%s\n" % name_ver)
 
4510
            self.outf.write("   %s\n" % doc)
4311
4511
            if verbose:
4312
 
                print '   ', path
4313
 
            print
 
4512
                self.outf.write("   %s\n" % path)
 
4513
            self.outf.write("\n")
4314
4514
 
4315
4515
 
4316
4516
class cmd_testament(Command):
4317
 
    """Show testament (signing-form) of a revision."""
 
4517
    __doc__ = """Show testament (signing-form) of a revision."""
4318
4518
    takes_options = [
4319
4519
            'revision',
4320
4520
            Option('long', help='Produce long-format testament.'),
4332
4532
            b = Branch.open_containing(branch)[0]
4333
4533
        else:
4334
4534
            b = Branch.open(branch)
4335
 
        b.lock_read()
4336
 
        try:
4337
 
            if revision is None:
4338
 
                rev_id = b.last_revision()
4339
 
            else:
4340
 
                rev_id = revision[0].as_revision_id(b)
4341
 
            t = testament_class.from_revision(b.repository, rev_id)
4342
 
            if long:
4343
 
                sys.stdout.writelines(t.as_text_lines())
4344
 
            else:
4345
 
                sys.stdout.write(t.as_short_text())
4346
 
        finally:
4347
 
            b.unlock()
 
4535
        self.add_cleanup(b.lock_read().unlock)
 
4536
        if revision is None:
 
4537
            rev_id = b.last_revision()
 
4538
        else:
 
4539
            rev_id = revision[0].as_revision_id(b)
 
4540
        t = testament_class.from_revision(b.repository, rev_id)
 
4541
        if long:
 
4542
            sys.stdout.writelines(t.as_text_lines())
 
4543
        else:
 
4544
            sys.stdout.write(t.as_short_text())
4348
4545
 
4349
4546
 
4350
4547
class cmd_annotate(Command):
4351
 
    """Show the origin of each line in a file.
 
4548
    __doc__ = """Show the origin of each line in a file.
4352
4549
 
4353
4550
    This prints out the given file with an annotation on the left side
4354
4551
    indicating which revision, author and date introduced the change.
4365
4562
                     Option('long', help='Show commit date in annotations.'),
4366
4563
                     'revision',
4367
4564
                     'show-ids',
 
4565
                     'directory',
4368
4566
                     ]
4369
4567
    encoding_type = 'exact'
4370
4568
 
4371
4569
    @display_command
4372
4570
    def run(self, filename, all=False, long=False, revision=None,
4373
 
            show_ids=False):
 
4571
            show_ids=False, directory=None):
4374
4572
        from bzrlib.annotate import annotate_file, annotate_file_tree
4375
4573
        wt, branch, relpath = \
4376
 
            bzrdir.BzrDir.open_containing_tree_or_branch(filename)
4377
 
        if wt is not None:
4378
 
            wt.lock_read()
4379
 
        else:
4380
 
            branch.lock_read()
4381
 
        try:
4382
 
            tree = _get_one_revision_tree('annotate', revision, branch=branch)
4383
 
            if wt is not None:
4384
 
                file_id = wt.path2id(relpath)
4385
 
            else:
4386
 
                file_id = tree.path2id(relpath)
4387
 
            if file_id is None:
4388
 
                raise errors.NotVersionedError(filename)
4389
 
            file_version = tree.inventory[file_id].revision
4390
 
            if wt is not None and revision is None:
4391
 
                # If there is a tree and we're not annotating historical
4392
 
                # versions, annotate the working tree's content.
4393
 
                annotate_file_tree(wt, file_id, self.outf, long, all,
4394
 
                    show_ids=show_ids)
4395
 
            else:
4396
 
                annotate_file(branch, file_version, file_id, long, all, self.outf,
4397
 
                              show_ids=show_ids)
4398
 
        finally:
4399
 
            if wt is not None:
4400
 
                wt.unlock()
4401
 
            else:
4402
 
                branch.unlock()
 
4574
            _open_directory_or_containing_tree_or_branch(filename, directory)
 
4575
        if wt is not None:
 
4576
            self.add_cleanup(wt.lock_read().unlock)
 
4577
        else:
 
4578
            self.add_cleanup(branch.lock_read().unlock)
 
4579
        tree = _get_one_revision_tree('annotate', revision, branch=branch)
 
4580
        self.add_cleanup(tree.lock_read().unlock)
 
4581
        if wt is not None:
 
4582
            file_id = wt.path2id(relpath)
 
4583
        else:
 
4584
            file_id = tree.path2id(relpath)
 
4585
        if file_id is None:
 
4586
            raise errors.NotVersionedError(filename)
 
4587
        file_version = tree.inventory[file_id].revision
 
4588
        if wt is not None and revision is None:
 
4589
            # If there is a tree and we're not annotating historical
 
4590
            # versions, annotate the working tree's content.
 
4591
            annotate_file_tree(wt, file_id, self.outf, long, all,
 
4592
                show_ids=show_ids)
 
4593
        else:
 
4594
            annotate_file(branch, file_version, file_id, long, all, self.outf,
 
4595
                          show_ids=show_ids)
4403
4596
 
4404
4597
 
4405
4598
class cmd_re_sign(Command):
4406
 
    """Create a digital signature for an existing revision."""
 
4599
    __doc__ = """Create a digital signature for an existing revision."""
4407
4600
    # TODO be able to replace existing ones.
4408
4601
 
4409
4602
    hidden = True # is this right ?
4410
4603
    takes_args = ['revision_id*']
4411
 
    takes_options = ['revision']
 
4604
    takes_options = ['directory', 'revision']
4412
4605
 
4413
 
    def run(self, revision_id_list=None, revision=None):
 
4606
    def run(self, revision_id_list=None, revision=None, directory=u'.'):
4414
4607
        if revision_id_list is not None and revision is not None:
4415
4608
            raise errors.BzrCommandError('You can only supply one of revision_id or --revision')
4416
4609
        if revision_id_list is None and revision is None:
4417
4610
            raise errors.BzrCommandError('You must supply either --revision or a revision_id')
4418
 
        b = WorkingTree.open_containing(u'.')[0].branch
4419
 
        b.lock_write()
4420
 
        try:
4421
 
            return self._run(b, revision_id_list, revision)
4422
 
        finally:
4423
 
            b.unlock()
 
4611
        b = WorkingTree.open_containing(directory)[0].branch
 
4612
        self.add_cleanup(b.lock_write().unlock)
 
4613
        return self._run(b, revision_id_list, revision)
4424
4614
 
4425
4615
    def _run(self, b, revision_id_list, revision):
4426
4616
        import bzrlib.gpg as gpg
4471
4661
 
4472
4662
 
4473
4663
class cmd_bind(Command):
4474
 
    """Convert the current branch into a checkout of the supplied branch.
 
4664
    __doc__ = """Convert the current branch into a checkout of the supplied branch.
 
4665
    If no branch is supplied, rebind to the last bound location.
4475
4666
 
4476
4667
    Once converted into a checkout, commits must succeed on the master branch
4477
4668
    before they will be applied to the local branch.
4478
4669
 
4479
4670
    Bound branches use the nickname of its master branch unless it is set
4480
 
    locally, in which case binding will update the the local nickname to be
 
4671
    locally, in which case binding will update the local nickname to be
4481
4672
    that of the master.
4482
4673
    """
4483
4674
 
4484
4675
    _see_also = ['checkouts', 'unbind']
4485
4676
    takes_args = ['location?']
4486
 
    takes_options = []
 
4677
    takes_options = ['directory']
4487
4678
 
4488
 
    def run(self, location=None):
4489
 
        b, relpath = Branch.open_containing(u'.')
 
4679
    def run(self, location=None, directory=u'.'):
 
4680
        b, relpath = Branch.open_containing(directory)
4490
4681
        if location is None:
4491
4682
            try:
4492
4683
                location = b.get_old_bound_location()
4495
4686
                    'This format does not remember old locations.')
4496
4687
            else:
4497
4688
                if location is None:
4498
 
                    raise errors.BzrCommandError('No location supplied and no '
4499
 
                        'previous location known')
 
4689
                    if b.get_bound_location() is not None:
 
4690
                        raise errors.BzrCommandError('Branch is already bound')
 
4691
                    else:
 
4692
                        raise errors.BzrCommandError('No location supplied '
 
4693
                            'and no previous location known')
4500
4694
        b_other = Branch.open(location)
4501
4695
        try:
4502
4696
            b.bind(b_other)
4508
4702
 
4509
4703
 
4510
4704
class cmd_unbind(Command):
4511
 
    """Convert the current checkout into a regular branch.
 
4705
    __doc__ = """Convert the current checkout into a regular branch.
4512
4706
 
4513
4707
    After unbinding, the local branch is considered independent and subsequent
4514
4708
    commits will be local only.
4516
4710
 
4517
4711
    _see_also = ['checkouts', 'bind']
4518
4712
    takes_args = []
4519
 
    takes_options = []
 
4713
    takes_options = ['directory']
4520
4714
 
4521
 
    def run(self):
4522
 
        b, relpath = Branch.open_containing(u'.')
 
4715
    def run(self, directory=u'.'):
 
4716
        b, relpath = Branch.open_containing(directory)
4523
4717
        if not b.unbind():
4524
4718
            raise errors.BzrCommandError('Local branch is not bound')
4525
4719
 
4526
4720
 
4527
4721
class cmd_uncommit(Command):
4528
 
    """Remove the last committed revision.
 
4722
    __doc__ = """Remove the last committed revision.
4529
4723
 
4530
4724
    --verbose will print out what is being removed.
4531
4725
    --dry-run will go through all the motions, but not actually
4571
4765
            b = control.open_branch()
4572
4766
 
4573
4767
        if tree is not None:
4574
 
            tree.lock_write()
 
4768
            self.add_cleanup(tree.lock_write().unlock)
4575
4769
        else:
4576
 
            b.lock_write()
4577
 
        try:
4578
 
            return self._run(b, tree, dry_run, verbose, revision, force,
4579
 
                             local=local)
4580
 
        finally:
4581
 
            if tree is not None:
4582
 
                tree.unlock()
4583
 
            else:
4584
 
                b.unlock()
 
4770
            self.add_cleanup(b.lock_write().unlock)
 
4771
        return self._run(b, tree, dry_run, verbose, revision, force, local=local)
4585
4772
 
4586
4773
    def _run(self, b, tree, dry_run, verbose, revision, force, local=False):
4587
4774
        from bzrlib.log import log_formatter, show_log
4619
4806
                 end_revision=last_revno)
4620
4807
 
4621
4808
        if dry_run:
4622
 
            print 'Dry-run, pretending to remove the above revisions.'
4623
 
            if not force:
4624
 
                val = raw_input('Press <enter> to continue')
 
4809
            self.outf.write('Dry-run, pretending to remove'
 
4810
                            ' the above revisions.\n')
4625
4811
        else:
4626
 
            print 'The above revision(s) will be removed.'
4627
 
            if not force:
4628
 
                val = raw_input('Are you sure [y/N]? ')
4629
 
                if val.lower() not in ('y', 'yes'):
4630
 
                    print 'Canceled'
4631
 
                    return 0
 
4812
            self.outf.write('The above revision(s) will be removed.\n')
 
4813
 
 
4814
        if not force:
 
4815
            if not ui.ui_factory.get_boolean('Are you sure'):
 
4816
                self.outf.write('Canceled')
 
4817
                return 0
4632
4818
 
4633
4819
        mutter('Uncommitting from {%s} to {%s}',
4634
4820
               last_rev_id, rev_id)
4635
4821
        uncommit(b, tree=tree, dry_run=dry_run, verbose=verbose,
4636
4822
                 revno=revno, local=local)
4637
 
        note('You can restore the old tip by running:\n'
4638
 
             '  bzr pull . -r revid:%s', last_rev_id)
 
4823
        self.outf.write('You can restore the old tip by running:\n'
 
4824
             '  bzr pull . -r revid:%s\n' % last_rev_id)
4639
4825
 
4640
4826
 
4641
4827
class cmd_break_lock(Command):
4642
 
    """Break a dead lock on a repository, branch or working directory.
 
4828
    __doc__ = """Break a dead lock on a repository, branch or working directory.
4643
4829
 
4644
4830
    CAUTION: Locks should only be broken when you are sure that the process
4645
4831
    holding the lock has been stopped.
4646
4832
 
4647
 
    You can get information on what locks are open via the 'bzr info' command.
 
4833
    You can get information on what locks are open via the 'bzr info
 
4834
    [location]' command.
4648
4835
 
4649
4836
    :Examples:
4650
4837
        bzr break-lock
 
4838
        bzr break-lock bzr+ssh://example.com/bzr/foo
4651
4839
    """
4652
4840
    takes_args = ['location?']
4653
4841
 
4662
4850
 
4663
4851
 
4664
4852
class cmd_wait_until_signalled(Command):
4665
 
    """Test helper for test_start_and_stop_bzr_subprocess_send_signal.
 
4853
    __doc__ = """Test helper for test_start_and_stop_bzr_subprocess_send_signal.
4666
4854
 
4667
4855
    This just prints a line to signal when it is ready, then blocks on stdin.
4668
4856
    """
4676
4864
 
4677
4865
 
4678
4866
class cmd_serve(Command):
4679
 
    """Run the bzr server."""
 
4867
    __doc__ = """Run the bzr server."""
4680
4868
 
4681
4869
    aliases = ['server']
4682
4870
 
4683
4871
    takes_options = [
4684
4872
        Option('inet',
4685
4873
               help='Serve on stdin/out for use from inetd or sshd.'),
4686
 
        RegistryOption('protocol', 
4687
 
               help="Protocol to serve.", 
 
4874
        RegistryOption('protocol',
 
4875
               help="Protocol to serve.",
4688
4876
               lazy_registry=('bzrlib.transport', 'transport_server_registry'),
4689
4877
               value_switches=True),
4690
4878
        Option('port',
4693
4881
                    'result in a dynamically allocated port.  The default port '
4694
4882
                    'depends on the protocol.',
4695
4883
               type=str),
4696
 
        Option('directory',
4697
 
               help='Serve contents of this directory.',
4698
 
               type=unicode),
 
4884
        custom_help('directory',
 
4885
               help='Serve contents of this directory.'),
4699
4886
        Option('allow-writes',
4700
4887
               help='By default the server is a readonly server.  Supplying '
4701
4888
                    '--allow-writes enables write access to the contents of '
4702
 
                    'the served directory and below.'
 
4889
                    'the served directory and below.  Note that ``bzr serve`` '
 
4890
                    'does not perform authentication, so unless some form of '
 
4891
                    'external authentication is arranged supplying this '
 
4892
                    'option leads to global uncontrolled write access to your '
 
4893
                    'file system.'
4703
4894
                ),
4704
4895
        ]
4705
4896
 
4724
4915
 
4725
4916
    def run(self, port=None, inet=False, directory=None, allow_writes=False,
4726
4917
            protocol=None):
4727
 
        from bzrlib.transport import get_transport, transport_server_registry
 
4918
        from bzrlib import transport
4728
4919
        if directory is None:
4729
4920
            directory = os.getcwd()
4730
4921
        if protocol is None:
4731
 
            protocol = transport_server_registry.get()
 
4922
            protocol = transport.transport_server_registry.get()
4732
4923
        host, port = self.get_host_and_port(port)
4733
4924
        url = urlutils.local_path_to_url(directory)
4734
4925
        if not allow_writes:
4735
4926
            url = 'readonly+' + url
4736
 
        transport = get_transport(url)
4737
 
        protocol(transport, host, port, inet)
 
4927
        t = transport.get_transport(url)
 
4928
        protocol(t, host, port, inet)
4738
4929
 
4739
4930
 
4740
4931
class cmd_join(Command):
4741
 
    """Combine a tree into its containing tree.
 
4932
    __doc__ = """Combine a tree into its containing tree.
4742
4933
 
4743
4934
    This command requires the target tree to be in a rich-root format.
4744
4935
 
4784
4975
 
4785
4976
 
4786
4977
class cmd_split(Command):
4787
 
    """Split a subdirectory of a tree into a separate tree.
 
4978
    __doc__ = """Split a subdirectory of a tree into a separate tree.
4788
4979
 
4789
4980
    This command will produce a target tree in a format that supports
4790
4981
    rich roots, like 'rich-root' or 'rich-root-pack'.  These formats cannot be
4810
5001
 
4811
5002
 
4812
5003
class cmd_merge_directive(Command):
4813
 
    """Generate a merge directive for auto-merge tools.
 
5004
    __doc__ = """Generate a merge directive for auto-merge tools.
4814
5005
 
4815
5006
    A directive requests a merge to be performed, and also provides all the
4816
5007
    information necessary to do so.  This means it must either include a
4833
5024
    _see_also = ['send']
4834
5025
 
4835
5026
    takes_options = [
 
5027
        'directory',
4836
5028
        RegistryOption.from_kwargs('patch-type',
4837
5029
            'The type of patch to include in the directive.',
4838
5030
            title='Patch type',
4851
5043
    encoding_type = 'exact'
4852
5044
 
4853
5045
    def run(self, submit_branch=None, public_branch=None, patch_type='bundle',
4854
 
            sign=False, revision=None, mail_to=None, message=None):
 
5046
            sign=False, revision=None, mail_to=None, message=None,
 
5047
            directory=u'.'):
4855
5048
        from bzrlib.revision import ensure_null, NULL_REVISION
4856
5049
        include_patch, include_bundle = {
4857
5050
            'plain': (False, False),
4858
5051
            'diff': (True, False),
4859
5052
            'bundle': (True, True),
4860
5053
            }[patch_type]
4861
 
        branch = Branch.open('.')
 
5054
        branch = Branch.open(directory)
4862
5055
        stored_submit_branch = branch.get_submit_branch()
4863
5056
        if submit_branch is None:
4864
5057
            submit_branch = stored_submit_branch
4909
5102
 
4910
5103
 
4911
5104
class cmd_send(Command):
4912
 
    """Mail or create a merge-directive for submitting changes.
 
5105
    __doc__ = """Mail or create a merge-directive for submitting changes.
4913
5106
 
4914
5107
    A merge directive provides many things needed for requesting merges:
4915
5108
 
4921
5114
      directly from the merge directive, without retrieving data from a
4922
5115
      branch.
4923
5116
 
4924
 
    If --no-bundle is specified, then public_branch is needed (and must be
4925
 
    up-to-date), so that the receiver can perform the merge using the
4926
 
    public_branch.  The public_branch is always included if known, so that
4927
 
    people can check it later.
4928
 
 
4929
 
    The submit branch defaults to the parent, but can be overridden.  Both
4930
 
    submit branch and public branch will be remembered if supplied.
4931
 
 
4932
 
    If a public_branch is known for the submit_branch, that public submit
4933
 
    branch is used in the merge instructions.  This means that a local mirror
4934
 
    can be used as your actual submit branch, once you have set public_branch
4935
 
    for that mirror.
 
5117
    `bzr send` creates a compact data set that, when applied using bzr
 
5118
    merge, has the same effect as merging from the source branch.  
 
5119
    
 
5120
    By default the merge directive is self-contained and can be applied to any
 
5121
    branch containing submit_branch in its ancestory without needing access to
 
5122
    the source branch.
 
5123
    
 
5124
    If --no-bundle is specified, then Bazaar doesn't send the contents of the
 
5125
    revisions, but only a structured request to merge from the
 
5126
    public_location.  In that case the public_branch is needed and it must be
 
5127
    up-to-date and accessible to the recipient.  The public_branch is always
 
5128
    included if known, so that people can check it later.
 
5129
 
 
5130
    The submit branch defaults to the parent of the source branch, but can be
 
5131
    overridden.  Both submit branch and public branch will be remembered in
 
5132
    branch.conf the first time they are used for a particular branch.  The
 
5133
    source branch defaults to that containing the working directory, but can
 
5134
    be changed using --from.
 
5135
 
 
5136
    In order to calculate those changes, bzr must analyse the submit branch.
 
5137
    Therefore it is most efficient for the submit branch to be a local mirror.
 
5138
    If a public location is known for the submit_branch, that location is used
 
5139
    in the merge directive.
 
5140
 
 
5141
    The default behaviour is to send the merge directive by mail, unless -o is
 
5142
    given, in which case it is sent to a file.
4936
5143
 
4937
5144
    Mail is sent using your preferred mail program.  This should be transparent
4938
 
    on Windows (it uses MAPI).  On Linux, it requires the xdg-email utility.
 
5145
    on Windows (it uses MAPI).  On Unix, it requires the xdg-email utility.
4939
5146
    If the preferred client can't be found (or used), your editor will be used.
4940
5147
 
4941
5148
    To use a specific mail program, set the mail_client configuration option.
4942
5149
    (For Thunderbird 1.5, this works around some bugs.)  Supported values for
4943
 
    specific clients are "claws", "evolution", "kmail", "mutt", and
4944
 
    "thunderbird"; generic options are "default", "editor", "emacsclient",
4945
 
    "mapi", and "xdg-email".  Plugins may also add supported clients.
 
5150
    specific clients are "claws", "evolution", "kmail", "mail.app" (MacOS X's
 
5151
    Mail.app), "mutt", and "thunderbird"; generic options are "default",
 
5152
    "editor", "emacsclient", "mapi", and "xdg-email".  Plugins may also add
 
5153
    supported clients.
4946
5154
 
4947
5155
    If mail is being sent, a to address is required.  This can be supplied
4948
5156
    either on the commandline, by setting the submit_to configuration
4957
5165
 
4958
5166
    The merge directives created by bzr send may be applied using bzr merge or
4959
5167
    bzr pull by specifying a file containing a merge directive as the location.
 
5168
 
 
5169
    bzr send makes extensive use of public locations to map local locations into
 
5170
    URLs that can be used by other people.  See `bzr help configuration` to
 
5171
    set them, and use `bzr info` to display them.
4960
5172
    """
4961
5173
 
4962
5174
    encoding_type = 'exact'
4978
5190
               short_name='f',
4979
5191
               type=unicode),
4980
5192
        Option('output', short_name='o',
4981
 
               help='Write merge directive to this file; '
 
5193
               help='Write merge directive to this file or directory; '
4982
5194
                    'use - for stdout.',
4983
5195
               type=unicode),
4984
5196
        Option('strict',
5007
5219
 
5008
5220
 
5009
5221
class cmd_bundle_revisions(cmd_send):
5010
 
    """Create a merge-directive for submitting changes.
 
5222
    __doc__ = """Create a merge-directive for submitting changes.
5011
5223
 
5012
5224
    A merge directive provides many things needed for requesting merges:
5013
5225
 
5080
5292
 
5081
5293
 
5082
5294
class cmd_tag(Command):
5083
 
    """Create, remove or modify a tag naming a revision.
 
5295
    __doc__ = """Create, remove or modify a tag naming a revision.
5084
5296
 
5085
5297
    Tags give human-meaningful names to revisions.  Commands that take a -r
5086
5298
    (--revision) option can be given -rtag:X, where X is any previously
5094
5306
 
5095
5307
    To rename a tag (change the name but keep it on the same revsion), run ``bzr
5096
5308
    tag new-name -r tag:old-name`` and then ``bzr tag --delete oldname``.
 
5309
 
 
5310
    If no tag name is specified it will be determined through the 
 
5311
    'automatic_tag_name' hook. This can e.g. be used to automatically tag
 
5312
    upstream releases by reading configure.ac. See ``bzr help hooks`` for
 
5313
    details.
5097
5314
    """
5098
5315
 
5099
5316
    _see_also = ['commit', 'tags']
5100
 
    takes_args = ['tag_name']
 
5317
    takes_args = ['tag_name?']
5101
5318
    takes_options = [
5102
5319
        Option('delete',
5103
5320
            help='Delete this tag rather than placing it.',
5104
5321
            ),
5105
 
        Option('directory',
5106
 
            help='Branch in which to place the tag.',
5107
 
            short_name='d',
5108
 
            type=unicode,
5109
 
            ),
 
5322
        custom_help('directory',
 
5323
            help='Branch in which to place the tag.'),
5110
5324
        Option('force',
5111
5325
            help='Replace existing tags.',
5112
5326
            ),
5113
5327
        'revision',
5114
5328
        ]
5115
5329
 
5116
 
    def run(self, tag_name,
 
5330
    def run(self, tag_name=None,
5117
5331
            delete=None,
5118
5332
            directory='.',
5119
5333
            force=None,
5120
5334
            revision=None,
5121
5335
            ):
5122
5336
        branch, relpath = Branch.open_containing(directory)
5123
 
        branch.lock_write()
5124
 
        try:
5125
 
            if delete:
5126
 
                branch.tags.delete_tag(tag_name)
5127
 
                self.outf.write('Deleted tag %s.\n' % tag_name)
 
5337
        self.add_cleanup(branch.lock_write().unlock)
 
5338
        if delete:
 
5339
            if tag_name is None:
 
5340
                raise errors.BzrCommandError("No tag specified to delete.")
 
5341
            branch.tags.delete_tag(tag_name)
 
5342
            self.outf.write('Deleted tag %s.\n' % tag_name)
 
5343
        else:
 
5344
            if revision:
 
5345
                if len(revision) != 1:
 
5346
                    raise errors.BzrCommandError(
 
5347
                        "Tags can only be placed on a single revision, "
 
5348
                        "not on a range")
 
5349
                revision_id = revision[0].as_revision_id(branch)
5128
5350
            else:
5129
 
                if revision:
5130
 
                    if len(revision) != 1:
5131
 
                        raise errors.BzrCommandError(
5132
 
                            "Tags can only be placed on a single revision, "
5133
 
                            "not on a range")
5134
 
                    revision_id = revision[0].as_revision_id(branch)
5135
 
                else:
5136
 
                    revision_id = branch.last_revision()
5137
 
                if (not force) and branch.tags.has_tag(tag_name):
5138
 
                    raise errors.TagAlreadyExists(tag_name)
5139
 
                branch.tags.set_tag(tag_name, revision_id)
5140
 
                self.outf.write('Created tag %s.\n' % tag_name)
5141
 
        finally:
5142
 
            branch.unlock()
 
5351
                revision_id = branch.last_revision()
 
5352
            if tag_name is None:
 
5353
                tag_name = branch.automatic_tag_name(revision_id)
 
5354
                if tag_name is None:
 
5355
                    raise errors.BzrCommandError(
 
5356
                        "Please specify a tag name.")
 
5357
            if (not force) and branch.tags.has_tag(tag_name):
 
5358
                raise errors.TagAlreadyExists(tag_name)
 
5359
            branch.tags.set_tag(tag_name, revision_id)
 
5360
            self.outf.write('Created tag %s.\n' % tag_name)
5143
5361
 
5144
5362
 
5145
5363
class cmd_tags(Command):
5146
 
    """List tags.
 
5364
    __doc__ = """List tags.
5147
5365
 
5148
5366
    This command shows a table of tag names and the revisions they reference.
5149
5367
    """
5150
5368
 
5151
5369
    _see_also = ['tag']
5152
5370
    takes_options = [
5153
 
        Option('directory',
5154
 
            help='Branch whose tags should be displayed.',
5155
 
            short_name='d',
5156
 
            type=unicode,
5157
 
            ),
 
5371
        custom_help('directory',
 
5372
            help='Branch whose tags should be displayed.'),
5158
5373
        RegistryOption.from_kwargs('sort',
5159
5374
            'Sort tags by different criteria.', title='Sorting',
5160
5375
            alpha='Sort tags lexicographically (default).',
5177
5392
        if not tags:
5178
5393
            return
5179
5394
 
5180
 
        branch.lock_read()
5181
 
        try:
5182
 
            if revision:
5183
 
                graph = branch.repository.get_graph()
5184
 
                rev1, rev2 = _get_revision_range(revision, branch, self.name())
5185
 
                revid1, revid2 = rev1.rev_id, rev2.rev_id
5186
 
                # only show revisions between revid1 and revid2 (inclusive)
5187
 
                tags = [(tag, revid) for tag, revid in tags if
5188
 
                    graph.is_between(revid, revid1, revid2)]
5189
 
            if sort == 'alpha':
5190
 
                tags.sort()
5191
 
            elif sort == 'time':
5192
 
                timestamps = {}
5193
 
                for tag, revid in tags:
5194
 
                    try:
5195
 
                        revobj = branch.repository.get_revision(revid)
5196
 
                    except errors.NoSuchRevision:
5197
 
                        timestamp = sys.maxint # place them at the end
5198
 
                    else:
5199
 
                        timestamp = revobj.timestamp
5200
 
                    timestamps[revid] = timestamp
5201
 
                tags.sort(key=lambda x: timestamps[x[1]])
5202
 
            if not show_ids:
5203
 
                # [ (tag, revid), ... ] -> [ (tag, dotted_revno), ... ]
5204
 
                for index, (tag, revid) in enumerate(tags):
5205
 
                    try:
5206
 
                        revno = branch.revision_id_to_dotted_revno(revid)
5207
 
                        if isinstance(revno, tuple):
5208
 
                            revno = '.'.join(map(str, revno))
5209
 
                    except errors.NoSuchRevision:
5210
 
                        # Bad tag data/merges can lead to tagged revisions
5211
 
                        # which are not in this branch. Fail gracefully ...
5212
 
                        revno = '?'
5213
 
                    tags[index] = (tag, revno)
5214
 
        finally:
5215
 
            branch.unlock()
 
5395
        self.add_cleanup(branch.lock_read().unlock)
 
5396
        if revision:
 
5397
            graph = branch.repository.get_graph()
 
5398
            rev1, rev2 = _get_revision_range(revision, branch, self.name())
 
5399
            revid1, revid2 = rev1.rev_id, rev2.rev_id
 
5400
            # only show revisions between revid1 and revid2 (inclusive)
 
5401
            tags = [(tag, revid) for tag, revid in tags if
 
5402
                graph.is_between(revid, revid1, revid2)]
 
5403
        if sort == 'alpha':
 
5404
            tags.sort()
 
5405
        elif sort == 'time':
 
5406
            timestamps = {}
 
5407
            for tag, revid in tags:
 
5408
                try:
 
5409
                    revobj = branch.repository.get_revision(revid)
 
5410
                except errors.NoSuchRevision:
 
5411
                    timestamp = sys.maxint # place them at the end
 
5412
                else:
 
5413
                    timestamp = revobj.timestamp
 
5414
                timestamps[revid] = timestamp
 
5415
            tags.sort(key=lambda x: timestamps[x[1]])
 
5416
        if not show_ids:
 
5417
            # [ (tag, revid), ... ] -> [ (tag, dotted_revno), ... ]
 
5418
            for index, (tag, revid) in enumerate(tags):
 
5419
                try:
 
5420
                    revno = branch.revision_id_to_dotted_revno(revid)
 
5421
                    if isinstance(revno, tuple):
 
5422
                        revno = '.'.join(map(str, revno))
 
5423
                except errors.NoSuchRevision:
 
5424
                    # Bad tag data/merges can lead to tagged revisions
 
5425
                    # which are not in this branch. Fail gracefully ...
 
5426
                    revno = '?'
 
5427
                tags[index] = (tag, revno)
 
5428
        self.cleanup_now()
5216
5429
        for tag, revspec in tags:
5217
5430
            self.outf.write('%-20s %s\n' % (tag, revspec))
5218
5431
 
5219
5432
 
5220
5433
class cmd_reconfigure(Command):
5221
 
    """Reconfigure the type of a bzr directory.
 
5434
    __doc__ = """Reconfigure the type of a bzr directory.
5222
5435
 
5223
5436
    A target configuration must be specified.
5224
5437
 
5309
5522
 
5310
5523
 
5311
5524
class cmd_switch(Command):
5312
 
    """Set the branch of a checkout and update.
 
5525
    __doc__ = """Set the branch of a checkout and update.
5313
5526
 
5314
5527
    For lightweight checkouts, this changes the branch being referenced.
5315
5528
    For heavyweight checkouts, this checks that there are no local commits
5327
5540
    /path/to/newbranch.
5328
5541
 
5329
5542
    Bound branches use the nickname of its master branch unless it is set
5330
 
    locally, in which case switching will update the the local nickname to be
 
5543
    locally, in which case switching will update the local nickname to be
5331
5544
    that of the master.
5332
5545
    """
5333
5546
 
5334
 
    takes_args = ['to_location']
5335
 
    takes_options = [Option('force',
 
5547
    takes_args = ['to_location?']
 
5548
    takes_options = ['directory',
 
5549
                     Option('force',
5336
5550
                        help='Switch even if local commits will be lost.'),
 
5551
                     'revision',
5337
5552
                     Option('create-branch', short_name='b',
5338
5553
                        help='Create the target branch from this one before'
5339
5554
                             ' switching to it.'),
5340
 
                     ]
 
5555
                    ]
5341
5556
 
5342
 
    def run(self, to_location, force=False, create_branch=False):
 
5557
    def run(self, to_location=None, force=False, create_branch=False,
 
5558
            revision=None, directory=u'.'):
5343
5559
        from bzrlib import switch
5344
 
        tree_location = '.'
 
5560
        tree_location = directory
 
5561
        revision = _get_one_revision('switch', revision)
5345
5562
        control_dir = bzrdir.BzrDir.open_containing(tree_location)[0]
 
5563
        if to_location is None:
 
5564
            if revision is None:
 
5565
                raise errors.BzrCommandError('You must supply either a'
 
5566
                                             ' revision or a location')
 
5567
            to_location = tree_location
5346
5568
        try:
5347
5569
            branch = control_dir.open_branch()
5348
5570
            had_explicit_nick = branch.get_config().has_explicit_nickname()
5353
5575
            if branch is None:
5354
5576
                raise errors.BzrCommandError('cannot create branch without'
5355
5577
                                             ' source branch')
 
5578
            to_location = directory_service.directories.dereference(
 
5579
                              to_location)
5356
5580
            if '/' not in to_location and '\\' not in to_location:
5357
5581
                # This path is meant to be relative to the existing branch
5358
5582
                this_url = self._get_branch_location(control_dir)
5360
5584
            to_branch = branch.bzrdir.sprout(to_location,
5361
5585
                                 possible_transports=[branch.bzrdir.root_transport],
5362
5586
                                 source_branch=branch).open_branch()
5363
 
            # try:
5364
 
            #     from_branch = control_dir.open_branch()
5365
 
            # except errors.NotBranchError:
5366
 
            #     raise BzrCommandError('Cannot create a branch from this'
5367
 
            #         ' location when we cannot open this branch')
5368
 
            # from_branch.bzrdir.sprout(
5369
 
            pass
5370
5587
        else:
5371
5588
            try:
5372
5589
                to_branch = Branch.open(to_location)
5374
5591
                this_url = self._get_branch_location(control_dir)
5375
5592
                to_branch = Branch.open(
5376
5593
                    urlutils.join(this_url, '..', to_location))
5377
 
        switch.switch(control_dir, to_branch, force)
 
5594
        if revision is not None:
 
5595
            revision = revision.as_revision_id(to_branch)
 
5596
        switch.switch(control_dir, to_branch, force, revision_id=revision)
5378
5597
        if had_explicit_nick:
5379
5598
            branch = control_dir.open_branch() #get the new branch!
5380
5599
            branch.nick = to_branch.nick
5400
5619
 
5401
5620
 
5402
5621
class cmd_view(Command):
5403
 
    """Manage filtered views.
 
5622
    __doc__ = """Manage filtered views.
5404
5623
 
5405
5624
    Views provide a mask over the tree so that users can focus on
5406
5625
    a subset of a tree when doing their work. After creating a view,
5554
5773
 
5555
5774
 
5556
5775
class cmd_hooks(Command):
5557
 
    """Show hooks."""
 
5776
    __doc__ = """Show hooks."""
5558
5777
 
5559
5778
    hidden = True
5560
5779
 
5573
5792
                    self.outf.write("    <no hooks installed>\n")
5574
5793
 
5575
5794
 
 
5795
class cmd_remove_branch(Command):
 
5796
    __doc__ = """Remove a branch.
 
5797
 
 
5798
    This will remove the branch from the specified location but 
 
5799
    will keep any working tree or repository in place.
 
5800
 
 
5801
    :Examples:
 
5802
 
 
5803
      Remove the branch at repo/trunk::
 
5804
 
 
5805
        bzr remove-branch repo/trunk
 
5806
 
 
5807
    """
 
5808
 
 
5809
    takes_args = ["location?"]
 
5810
 
 
5811
    aliases = ["rmbranch"]
 
5812
 
 
5813
    def run(self, location=None):
 
5814
        if location is None:
 
5815
            location = "."
 
5816
        branch = Branch.open_containing(location)[0]
 
5817
        branch.bzrdir.destroy_branch()
 
5818
        
 
5819
 
5576
5820
class cmd_shelve(Command):
5577
 
    """Temporarily set aside some changes from the current tree.
 
5821
    __doc__ = """Temporarily set aside some changes from the current tree.
5578
5822
 
5579
5823
    Shelve allows you to temporarily put changes you've made "on the shelf",
5580
5824
    ie. out of the way, until a later time when you can bring them back from
5601
5845
    takes_args = ['file*']
5602
5846
 
5603
5847
    takes_options = [
 
5848
        'directory',
5604
5849
        'revision',
5605
5850
        Option('all', help='Shelve all changes.'),
5606
5851
        'message',
5615
5860
    _see_also = ['unshelve']
5616
5861
 
5617
5862
    def run(self, revision=None, all=False, file_list=None, message=None,
5618
 
            writer=None, list=False, destroy=False):
 
5863
            writer=None, list=False, destroy=False, directory=u'.'):
5619
5864
        if list:
5620
5865
            return self.run_for_list()
5621
5866
        from bzrlib.shelf_ui import Shelver
5622
5867
        if writer is None:
5623
5868
            writer = bzrlib.option.diff_writer_registry.get()
5624
5869
        try:
5625
 
            Shelver.from_args(writer(sys.stdout), revision, all, file_list,
5626
 
                              message, destroy=destroy).run()
 
5870
            shelver = Shelver.from_args(writer(sys.stdout), revision, all,
 
5871
                file_list, message, destroy=destroy, directory=directory)
 
5872
            try:
 
5873
                shelver.run()
 
5874
            finally:
 
5875
                shelver.finalize()
5627
5876
        except errors.UserAbort:
5628
5877
            return 0
5629
5878
 
5630
5879
    def run_for_list(self):
5631
5880
        tree = WorkingTree.open_containing('.')[0]
5632
 
        tree.lock_read()
5633
 
        try:
5634
 
            manager = tree.get_shelf_manager()
5635
 
            shelves = manager.active_shelves()
5636
 
            if len(shelves) == 0:
5637
 
                note('No shelved changes.')
5638
 
                return 0
5639
 
            for shelf_id in reversed(shelves):
5640
 
                message = manager.get_metadata(shelf_id).get('message')
5641
 
                if message is None:
5642
 
                    message = '<no message>'
5643
 
                self.outf.write('%3d: %s\n' % (shelf_id, message))
5644
 
            return 1
5645
 
        finally:
5646
 
            tree.unlock()
 
5881
        self.add_cleanup(tree.lock_read().unlock)
 
5882
        manager = tree.get_shelf_manager()
 
5883
        shelves = manager.active_shelves()
 
5884
        if len(shelves) == 0:
 
5885
            note('No shelved changes.')
 
5886
            return 0
 
5887
        for shelf_id in reversed(shelves):
 
5888
            message = manager.get_metadata(shelf_id).get('message')
 
5889
            if message is None:
 
5890
                message = '<no message>'
 
5891
            self.outf.write('%3d: %s\n' % (shelf_id, message))
 
5892
        return 1
5647
5893
 
5648
5894
 
5649
5895
class cmd_unshelve(Command):
5650
 
    """Restore shelved changes.
 
5896
    __doc__ = """Restore shelved changes.
5651
5897
 
5652
5898
    By default, the most recently shelved changes are restored. However if you
5653
5899
    specify a shelf by id those changes will be restored instead.  This works
5656
5902
 
5657
5903
    takes_args = ['shelf_id?']
5658
5904
    takes_options = [
 
5905
        'directory',
5659
5906
        RegistryOption.from_kwargs(
5660
5907
            'action', help="The action to perform.",
5661
5908
            enum_switch=False, value_switches=True,
5662
5909
            apply="Apply changes and remove from the shelf.",
5663
5910
            dry_run="Show changes, but do not apply or remove them.",
5664
 
            delete_only="Delete changes without applying them."
 
5911
            preview="Instead of unshelving the changes, show the diff that "
 
5912
                    "would result from unshelving.",
 
5913
            delete_only="Delete changes without applying them.",
 
5914
            keep="Apply changes but don't delete them.",
5665
5915
        )
5666
5916
    ]
5667
5917
    _see_also = ['shelve']
5668
5918
 
5669
 
    def run(self, shelf_id=None, action='apply'):
 
5919
    def run(self, shelf_id=None, action='apply', directory=u'.'):
5670
5920
        from bzrlib.shelf_ui import Unshelver
5671
 
        Unshelver.from_args(shelf_id, action).run()
 
5921
        unshelver = Unshelver.from_args(shelf_id, action, directory=directory)
 
5922
        try:
 
5923
            unshelver.run()
 
5924
        finally:
 
5925
            unshelver.tree.unlock()
5672
5926
 
5673
5927
 
5674
5928
class cmd_clean_tree(Command):
5675
 
    """Remove unwanted files from working tree.
 
5929
    __doc__ = """Remove unwanted files from working tree.
5676
5930
 
5677
5931
    By default, only unknown files, not ignored files, are deleted.  Versioned
5678
5932
    files are never deleted.
5686
5940
 
5687
5941
    To check what clean-tree will do, use --dry-run.
5688
5942
    """
5689
 
    takes_options = [Option('ignored', help='Delete all ignored files.'),
 
5943
    takes_options = ['directory',
 
5944
                     Option('ignored', help='Delete all ignored files.'),
5690
5945
                     Option('detritus', help='Delete conflict files, merge'
5691
5946
                            ' backups, and failed selftest dirs.'),
5692
5947
                     Option('unknown',
5695
5950
                            ' deleting them.'),
5696
5951
                     Option('force', help='Do not prompt before deleting.')]
5697
5952
    def run(self, unknown=False, ignored=False, detritus=False, dry_run=False,
5698
 
            force=False):
 
5953
            force=False, directory=u'.'):
5699
5954
        from bzrlib.clean_tree import clean_tree
5700
5955
        if not (unknown or ignored or detritus):
5701
5956
            unknown = True
5702
5957
        if dry_run:
5703
5958
            force = True
5704
 
        clean_tree('.', unknown=unknown, ignored=ignored, detritus=detritus,
5705
 
                   dry_run=dry_run, no_prompt=force)
 
5959
        clean_tree(directory, unknown=unknown, ignored=ignored,
 
5960
                   detritus=detritus, dry_run=dry_run, no_prompt=force)
5706
5961
 
5707
5962
 
5708
5963
class cmd_reference(Command):
5709
 
    """list, view and set branch locations for nested trees.
 
5964
    __doc__ = """list, view and set branch locations for nested trees.
5710
5965
 
5711
5966
    If no arguments are provided, lists the branch locations for nested trees.
5712
5967
    If one argument is provided, display the branch location for that tree.
5752
6007
            self.outf.write('%s %s\n' % (path, location))
5753
6008
 
5754
6009
 
5755
 
# these get imported and then picked up by the scan for cmd_*
5756
 
# TODO: Some more consistent way to split command definitions across files;
5757
 
# we do need to load at least some information about them to know of
5758
 
# aliases.  ideally we would avoid loading the implementation until the
5759
 
# details were needed.
5760
 
from bzrlib.cmd_version_info import cmd_version_info
5761
 
from bzrlib.conflicts import cmd_resolve, cmd_conflicts, restore
5762
 
from bzrlib.bundle.commands import (
5763
 
    cmd_bundle_info,
5764
 
    )
5765
 
from bzrlib.foreign import cmd_dpush
5766
 
from bzrlib.sign_my_commits import cmd_sign_my_commits
5767
 
from bzrlib.weave_commands import cmd_versionedfile_list, \
5768
 
        cmd_weave_plan_merge, cmd_weave_merge_text
 
6010
def _register_lazy_builtins():
 
6011
    # register lazy builtins from other modules; called at startup and should
 
6012
    # be only called once.
 
6013
    for (name, aliases, module_name) in [
 
6014
        ('cmd_bundle_info', [], 'bzrlib.bundle.commands'),
 
6015
        ('cmd_dpush', [], 'bzrlib.foreign'),
 
6016
        ('cmd_version_info', [], 'bzrlib.cmd_version_info'),
 
6017
        ('cmd_resolve', ['resolved'], 'bzrlib.conflicts'),
 
6018
        ('cmd_conflicts', [], 'bzrlib.conflicts'),
 
6019
        ('cmd_sign_my_commits', [], 'bzrlib.sign_my_commits'),
 
6020
        ]:
 
6021
        builtin_command_registry.register_lazy(name, aliases, module_name)