← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/builtins.py

  • Committer: Canonical.com Patch Queue Manager
  • Date: 2009-08-14 05:49:27 UTC
  • mfrom: (4476.3.86 inventory-delta)
  • Revision ID: pqm@pqm.ubuntu.com-20090814054927-k0k18dn46ax4b91f
(andrew) Add inventory-delta streaming for cross-format fetch.

Show diffs side-by-side

added added

removed removed

Lines of Context:
bzrlib/builtins.py
1
 
# Copyright (C) 2005-2010 Canonical Ltd
 
1
# Copyright (C) 2004, 2005, 2006, 2007, 2008, 2009 Canonical Ltd
2
2
#
3
3
# This program is free software; you can redistribute it and/or modify
4
4
# it under the terms of the GNU General Public License as published by
31
31
    bundle,
32
32
    btree_index,
33
33
    bzrdir,
34
 
    directory_service,
35
34
    delta,
36
35
    config,
37
36
    errors,
44
43
    reconfigure,
45
44
    rename_map,
46
45
    revision as _mod_revision,
47
 
    static_tuple,
48
46
    symbol_versioning,
49
 
    timestamp,
50
47
    transport,
51
48
    ui,
52
49
    urlutils,
54
51
    )
55
52
from bzrlib.branch import Branch
56
53
from bzrlib.conflicts import ConflictList
57
 
from bzrlib.transport import memory
58
54
from bzrlib.revisionspec import RevisionSpec, RevisionInfo
59
55
from bzrlib.smtp_connection import SMTPConnection
60
56
from bzrlib.workingtree import WorkingTree
61
57
""")
62
58
 
63
 
from bzrlib.commands import (
64
 
    Command,
65
 
    builtin_command_registry,
66
 
    display_command,
67
 
    )
 
59
from bzrlib.commands import Command, display_command
68
60
from bzrlib.option import (
69
61
    ListOption,
70
62
    Option,
128
120
 
129
121
 
130
122
def _get_one_revision_tree(command_name, revisions, branch=None, tree=None):
131
 
    """Get a revision tree. Not suitable for commands that change the tree.
132
 
    
133
 
    Specifically, the basis tree in dirstate trees is coupled to the dirstate
134
 
    and doing a commit/uncommit/pull will at best fail due to changing the
135
 
    basis revision data.
136
 
 
137
 
    If tree is passed in, it should be already locked, for lifetime management
138
 
    of the trees internal cached state.
139
 
    """
140
123
    if branch is None:
141
124
        branch = tree.branch
142
125
    if revisions is None:
180
163
                view_str = views.view_display_str(view_files)
181
164
                note("Ignoring files outside view. View is %s" % view_str)
182
165
        return tree, file_list
183
 
    tree = WorkingTree.open_containing(file_list[0])[0]
 
166
    tree = WorkingTree.open_containing(osutils.realpath(file_list[0]))[0]
184
167
    return tree, safe_relpath_files(tree, file_list, canonicalize,
185
168
        apply_view=apply_view)
186
169
 
232
215
    return view_info
233
216
 
234
217
 
235
 
def _open_directory_or_containing_tree_or_branch(filename, directory):
236
 
    """Open the tree or branch containing the specified file, unless
237
 
    the --directory option is used to specify a different branch."""
238
 
    if directory is not None:
239
 
        return (None, Branch.open(directory), filename)
240
 
    return bzrdir.BzrDir.open_containing_tree_or_branch(filename)
241
 
 
242
 
 
243
218
# TODO: Make sure no commands unconditionally use the working directory as a
244
219
# branch.  If a filename argument is used, the first of them should be used to
245
220
# specify the branch.  (Perhaps this can be factored out into some kind of
247
222
# opens the branch?)
248
223
 
249
224
class cmd_status(Command):
250
 
    __doc__ = """Display status summary.
 
225
    """Display status summary.
251
226
 
252
227
    This reports on versioned and unknown files, reporting them
253
228
    grouped by state.  Possible states are:
273
248
    unknown
274
249
        Not versioned and not matching an ignore pattern.
275
250
 
276
 
    Additionally for directories, symlinks and files with an executable
277
 
    bit, Bazaar indicates their type using a trailing character: '/', '@'
278
 
    or '*' respectively.
279
 
 
280
251
    To see ignored files use 'bzr ignored'.  For details on the
281
252
    changes to file texts, use 'bzr diff'.
282
253
 
340
311
 
341
312
 
342
313
class cmd_cat_revision(Command):
343
 
    __doc__ = """Write out metadata for a revision.
 
314
    """Write out metadata for a revision.
344
315
 
345
316
    The revision to print can either be specified by a specific
346
317
    revision identifier, or you can use --revision.
348
319
 
349
320
    hidden = True
350
321
    takes_args = ['revision_id?']
351
 
    takes_options = ['directory', 'revision']
 
322
    takes_options = ['revision']
352
323
    # cat-revision is more for frontends so should be exact
353
324
    encoding = 'strict'
354
325
 
355
 
    def print_revision(self, revisions, revid):
356
 
        stream = revisions.get_record_stream([(revid,)], 'unordered', True)
357
 
        record = stream.next()
358
 
        if record.storage_kind == 'absent':
359
 
            raise errors.NoSuchRevision(revisions, revid)
360
 
        revtext = record.get_bytes_as('fulltext')
361
 
        self.outf.write(revtext.decode('utf-8'))
362
 
 
363
326
    @display_command
364
 
    def run(self, revision_id=None, revision=None, directory=u'.'):
 
327
    def run(self, revision_id=None, revision=None):
365
328
        if revision_id is not None and revision is not None:
366
329
            raise errors.BzrCommandError('You can only supply one of'
367
330
                                         ' revision_id or --revision')
368
331
        if revision_id is None and revision is None:
369
332
            raise errors.BzrCommandError('You must supply either'
370
333
                                         ' --revision or a revision_id')
371
 
        b = WorkingTree.open_containing(directory)[0].branch
372
 
 
373
 
        revisions = b.repository.revisions
374
 
        if revisions is None:
375
 
            raise errors.BzrCommandError('Repository %r does not support '
376
 
                'access to raw revision texts')
377
 
 
378
 
        b.repository.lock_read()
379
 
        try:
380
 
            # TODO: jam 20060112 should cat-revision always output utf-8?
381
 
            if revision_id is not None:
382
 
                revision_id = osutils.safe_revision_id(revision_id, warn=False)
383
 
                try:
384
 
                    self.print_revision(revisions, revision_id)
385
 
                except errors.NoSuchRevision:
386
 
                    msg = "The repository %s contains no revision %s." % (
387
 
                        b.repository.base, revision_id)
388
 
                    raise errors.BzrCommandError(msg)
389
 
            elif revision is not None:
390
 
                for rev in revision:
391
 
                    if rev is None:
392
 
                        raise errors.BzrCommandError(
393
 
                            'You cannot specify a NULL revision.')
394
 
                    rev_id = rev.as_revision_id(b)
395
 
                    self.print_revision(revisions, rev_id)
396
 
        finally:
397
 
            b.repository.unlock()
398
 
        
 
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
 
399
353
 
400
354
class cmd_dump_btree(Command):
401
 
    __doc__ = """Dump the contents of a btree index file to stdout.
 
355
    """Dump the contents of a btree index file to stdout.
402
356
 
403
357
    PATH is a btree index file, it can be any URL. This includes things like
404
358
    .bzr/repository/pack-names, or .bzr/repository/indices/a34b3a...ca4a4.iix
468
422
        for node in bt.iter_all_entries():
469
423
            # Node is made up of:
470
424
            # (index, key, value, [references])
471
 
            try:
472
 
                refs = node[3]
473
 
            except IndexError:
474
 
                refs_as_tuples = None
475
 
            else:
476
 
                refs_as_tuples = static_tuple.as_tuples(refs)
477
 
            as_tuple = (tuple(node[1]), node[2], refs_as_tuples)
478
 
            self.outf.write('%s\n' % (as_tuple,))
 
425
            self.outf.write('%s\n' % (node[1:],))
479
426
 
480
427
 
481
428
class cmd_remove_tree(Command):
482
 
    __doc__ = """Remove the working tree from a given branch/checkout.
 
429
    """Remove the working tree from a given branch/checkout.
483
430
 
484
431
    Since a lightweight checkout is little more than a working tree
485
432
    this will refuse to run against one.
487
434
    To re-create the working tree, use "bzr checkout".
488
435
    """
489
436
    _see_also = ['checkout', 'working-trees']
490
 
    takes_args = ['location*']
 
437
    takes_args = ['location?']
491
438
    takes_options = [
492
439
        Option('force',
493
440
               help='Remove the working tree even if it has '
494
 
                    'uncommitted or shelved changes.'),
 
441
                    'uncommitted changes.'),
495
442
        ]
496
443
 
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()
 
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()
522
466
 
523
467
 
524
468
class cmd_revno(Command):
525
 
    __doc__ = """Show current revision number.
 
469
    """Show current revision number.
526
470
 
527
471
    This is equal to the number of revisions on this branch.
528
472
    """
538
482
        if tree:
539
483
            try:
540
484
                wt = WorkingTree.open_containing(location)[0]
541
 
                self.add_cleanup(wt.lock_read().unlock)
 
485
                wt.lock_read()
542
486
            except (errors.NoWorkingTree, errors.NotLocalUrl):
543
487
                raise errors.NoWorkingTree(location)
544
 
            revid = wt.last_revision()
545
488
            try:
546
 
                revno_t = wt.branch.revision_id_to_dotted_revno(revid)
547
 
            except errors.NoSuchRevision:
548
 
                revno_t = ('???',)
549
 
            revno = ".".join(str(n) for n in revno_t)
 
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()
550
497
        else:
551
498
            b = Branch.open_containing(location)[0]
552
 
            self.add_cleanup(b.lock_read().unlock)
553
 
            revno = b.revno()
554
 
        self.cleanup_now()
 
499
            b.lock_read()
 
500
            try:
 
501
                revno = b.revno()
 
502
            finally:
 
503
                b.unlock()
 
504
 
555
505
        self.outf.write(str(revno) + '\n')
556
506
 
557
507
 
558
508
class cmd_revision_info(Command):
559
 
    __doc__ = """Show revision number and revision id for a given revision identifier.
 
509
    """Show revision number and revision id for a given revision identifier.
560
510
    """
561
511
    hidden = True
562
512
    takes_args = ['revision_info*']
563
513
    takes_options = [
564
514
        'revision',
565
 
        custom_help('directory',
 
515
        Option('directory',
566
516
            help='Branch to examine, '
567
 
                 'rather than the one containing the working directory.'),
 
517
                 'rather than the one containing the working directory.',
 
518
            short_name='d',
 
519
            type=unicode,
 
520
            ),
568
521
        Option('tree', help='Show revno of working tree'),
569
522
        ]
570
523
 
575
528
        try:
576
529
            wt = WorkingTree.open_containing(directory)[0]
577
530
            b = wt.branch
578
 
            self.add_cleanup(wt.lock_read().unlock)
 
531
            wt.lock_read()
579
532
        except (errors.NoWorkingTree, errors.NotLocalUrl):
580
533
            wt = None
581
534
            b = Branch.open_containing(directory)[0]
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())
 
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()
596
566
            else:
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()
 
567
                wt.unlock()
 
568
 
611
569
        for ri in revinfos:
612
570
            self.outf.write('%*s %s\n' % (maxlen, ri[0], ri[1]))
613
571
 
614
572
 
615
573
class cmd_add(Command):
616
 
    __doc__ = """Add specified files or directories.
 
574
    """Add specified files or directories.
617
575
 
618
576
    In non-recursive mode, all the named items are added, regardless
619
577
    of whether they were previously ignored.  A warning is given if
684
642
                should_print=(not is_quiet()))
685
643
 
686
644
        if base_tree:
687
 
            self.add_cleanup(base_tree.lock_read().unlock)
688
 
        tree, file_list = tree_files_for_add(file_list)
689
 
        added, ignored = tree.smart_add(file_list, not
690
 
            no_recurse, action=action, save=not dry_run)
691
 
        self.cleanup_now()
 
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()
692
654
        if len(ignored) > 0:
693
655
            if verbose:
694
656
                for glob in sorted(ignored.keys()):
698
660
 
699
661
 
700
662
class cmd_mkdir(Command):
701
 
    __doc__ = """Create a new versioned directory.
 
663
    """Create a new versioned directory.
702
664
 
703
665
    This is equivalent to creating the directory and then adding it.
704
666
    """
708
670
 
709
671
    def run(self, dir_list):
710
672
        for d in dir_list:
 
673
            os.mkdir(d)
711
674
            wt, dd = WorkingTree.open_containing(d)
712
 
            base = os.path.dirname(dd)
713
 
            id = wt.path2id(base)
714
 
            if id != None:
715
 
                os.mkdir(d)
716
 
                wt.add([dd])
717
 
                self.outf.write('added %s\n' % d)
718
 
            else:
719
 
                raise errors.NotVersionedError(path=base)
 
675
            wt.add([dd])
 
676
            self.outf.write('added %s\n' % d)
720
677
 
721
678
 
722
679
class cmd_relpath(Command):
723
 
    __doc__ = """Show path of a file relative to root"""
 
680
    """Show path of a file relative to root"""
724
681
 
725
682
    takes_args = ['filename']
726
683
    hidden = True
735
692
 
736
693
 
737
694
class cmd_inventory(Command):
738
 
    __doc__ = """Show inventory of the current working copy or a revision.
 
695
    """Show inventory of the current working copy or a revision.
739
696
 
740
697
    It is possible to limit the output to a particular entry
741
698
    type using the --kind option.  For example: --kind file.
762
719
 
763
720
        revision = _get_one_revision('inventory', revision)
764
721
        work_tree, file_list = tree_files(file_list)
765
 
        self.add_cleanup(work_tree.lock_read().unlock)
766
 
        if revision is not None:
767
 
            tree = revision.as_tree(work_tree.branch)
768
 
 
769
 
            extra_trees = [work_tree]
770
 
            self.add_cleanup(tree.lock_read().unlock)
771
 
        else:
772
 
            tree = work_tree
773
 
            extra_trees = []
774
 
 
775
 
        if file_list is not None:
776
 
            file_ids = tree.paths2ids(file_list, trees=extra_trees,
777
 
                                      require_versioned=True)
778
 
            # find_ids_across_trees may include some paths that don't
779
 
            # exist in 'tree'.
780
 
            entries = sorted((tree.id2path(file_id), tree.inventory[file_id])
781
 
                             for file_id in file_ids if file_id in tree)
782
 
        else:
783
 
            entries = tree.inventory.entries()
784
 
 
785
 
        self.cleanup_now()
 
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
 
786
747
        for path, entry in entries:
787
748
            if kind and kind != entry.kind:
788
749
                continue
794
755
 
795
756
 
796
757
class cmd_mv(Command):
797
 
    __doc__ = """Move or rename a file.
 
758
    """Move or rename a file.
798
759
 
799
760
    :Usage:
800
761
        bzr mv OLDNAME NEWNAME
833
794
        if len(names_list) < 2:
834
795
            raise errors.BzrCommandError("missing file argument")
835
796
        tree, rel_names = tree_files(names_list, canonicalize=False)
836
 
        self.add_cleanup(tree.lock_tree_write().unlock)
837
 
        self._run(tree, names_list, rel_names, after)
 
797
        tree.lock_tree_write()
 
798
        try:
 
799
            self._run(tree, names_list, rel_names, after)
 
800
        finally:
 
801
            tree.unlock()
838
802
 
839
803
    def run_auto(self, names_list, after, dry_run):
840
804
        if names_list is not None and len(names_list) > 1:
844
808
            raise errors.BzrCommandError('--after cannot be specified with'
845
809
                                         ' --auto.')
846
810
        work_tree, file_list = tree_files(names_list, default_branch='.')
847
 
        self.add_cleanup(work_tree.lock_tree_write().unlock)
848
 
        rename_map.RenameMap.guess_renames(work_tree, dry_run)
 
811
        work_tree.lock_tree_write()
 
812
        try:
 
813
            rename_map.RenameMap.guess_renames(work_tree, dry_run)
 
814
        finally:
 
815
            work_tree.unlock()
849
816
 
850
817
    def _run(self, tree, names_list, rel_names, after):
851
818
        into_existing = osutils.isdir(names_list[-1])
872
839
            # All entries reference existing inventory items, so fix them up
873
840
            # for cicp file-systems.
874
841
            rel_names = tree.get_canonical_inventory_paths(rel_names)
875
 
            for src, dest in tree.move(rel_names[:-1], rel_names[-1], after=after):
876
 
                if not is_quiet():
877
 
                    self.outf.write("%s => %s\n" % (src, dest))
 
842
            for pair in tree.move(rel_names[:-1], rel_names[-1], after=after):
 
843
                self.outf.write("%s => %s\n" % pair)
878
844
        else:
879
845
            if len(names_list) != 2:
880
846
                raise errors.BzrCommandError('to mv multiple files the'
924
890
            dest = osutils.pathjoin(dest_parent, dest_tail)
925
891
            mutter("attempting to move %s => %s", src, dest)
926
892
            tree.rename_one(src, dest, after=after)
927
 
            if not is_quiet():
928
 
                self.outf.write("%s => %s\n" % (src, dest))
 
893
            self.outf.write("%s => %s\n" % (src, dest))
929
894
 
930
895
 
931
896
class cmd_pull(Command):
932
 
    __doc__ = """Turn this branch into a mirror of another branch.
 
897
    """Turn this branch into a mirror of another branch.
933
898
 
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.
 
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.
938
902
 
939
903
    If branches have diverged, you can use 'bzr merge' to integrate the changes
940
904
    from one into the other.  Once one branch has merged, the other should
941
905
    be able to pull it again.
942
906
 
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.
 
907
    If you want to forget your local changes and just update your branch to
 
908
    match the remote one, use pull --overwrite.
946
909
 
947
910
    If there is no default location set, the first pull will set it.  After
948
911
    that, you can omit the location to use the default.  To change the
958
921
    takes_options = ['remember', 'overwrite', 'revision',
959
922
        custom_help('verbose',
960
923
            help='Show logs of pulled revisions.'),
961
 
        custom_help('directory',
 
924
        Option('directory',
962
925
            help='Branch to pull into, '
963
 
                 'rather than the one containing the working directory.'),
 
926
                 'rather than the one containing the working directory.',
 
927
            short_name='d',
 
928
            type=unicode,
 
929
            ),
964
930
        Option('local',
965
931
            help="Perform a local pull in a bound "
966
932
                 "branch.  Local pulls are not applied to "
981
947
        try:
982
948
            tree_to = WorkingTree.open_containing(directory)[0]
983
949
            branch_to = tree_to.branch
984
 
            self.add_cleanup(tree_to.lock_write().unlock)
985
950
        except errors.NoWorkingTree:
986
951
            tree_to = None
987
952
            branch_to = Branch.open_containing(directory)[0]
988
 
            self.add_cleanup(branch_to.lock_write().unlock)
989
 
 
 
953
        
990
954
        if local and not branch_to.get_bound_location():
991
955
            raise errors.LocalRequiresBoundBranch()
992
956
 
1022
986
        else:
1023
987
            branch_from = Branch.open(location,
1024
988
                possible_transports=possible_transports)
1025
 
            self.add_cleanup(branch_from.lock_read().unlock)
1026
989
 
1027
990
            if branch_to.get_parent() is None or remember:
1028
991
                branch_to.set_parent(branch_from.base)
1029
992
 
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)
 
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()
1050
1023
 
1051
1024
 
1052
1025
class cmd_push(Command):
1053
 
    __doc__ = """Update a mirror of this branch.
 
1026
    """Update a mirror of this branch.
1054
1027
 
1055
1028
    The target branch will not have its working tree populated because this
1056
1029
    is both expensive, and is not supported on remote file systems.
1080
1053
        Option('create-prefix',
1081
1054
               help='Create the path leading up to the branch '
1082
1055
                    'if it does not already exist.'),
1083
 
        custom_help('directory',
 
1056
        Option('directory',
1084
1057
            help='Branch to push from, '
1085
 
                 'rather than the one containing the working directory.'),
 
1058
                 'rather than the one containing the working directory.',
 
1059
            short_name='d',
 
1060
            type=unicode,
 
1061
            ),
1086
1062
        Option('use-existing-dir',
1087
1063
               help='By default push will fail if the target'
1088
1064
                    ' directory exists, but does not already'
1114
1090
        # Get the source branch
1115
1091
        (tree, br_from,
1116
1092
         _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
1117
1096
        # Get the tip's revision_id
1118
1097
        revision = _get_one_revision('push', revision)
1119
1098
        if revision is not None:
1120
1099
            revision_id = revision.in_history(br_from).rev_id
1121
1100
        else:
1122
1101
            revision_id = None
1123
 
        if tree is not None and revision_id is None:
1124
 
            tree.check_changed_or_out_of_date(
1125
 
                strict, 'push_strict',
1126
 
                more_error='Use --no-strict to force the push.',
1127
 
                more_warning='Uncommitted changes will not be pushed.')
 
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
 
1128
1114
        # Get the stacked_on branch, if any
1129
1115
        if stacked_on is not None:
1130
1116
            stacked_on = urlutils.normalize_url(stacked_on)
1162
1148
 
1163
1149
 
1164
1150
class cmd_branch(Command):
1165
 
    __doc__ = """Create a new branch that is a copy of an existing branch.
 
1151
    """Create a new branch that is a copy of an existing branch.
1166
1152
 
1167
1153
    If the TO_LOCATION is omitted, the last component of the FROM_LOCATION will
1168
1154
    be used.  In other words, "branch ../foo/bar" will attempt to create ./bar.
1181
1167
        help='Hard-link working tree files where possible.'),
1182
1168
        Option('no-tree',
1183
1169
            help="Create a branch without a working-tree."),
1184
 
        Option('switch',
1185
 
            help="Switch the checkout in the current directory "
1186
 
                 "to the new branch."),
1187
1170
        Option('stacked',
1188
1171
            help='Create a stacked branch referring to the source branch. '
1189
1172
                'The new branch will depend on the availability of the source '
1195
1178
                    ' directory exists, but does not already'
1196
1179
                    ' have a control directory.  This flag will'
1197
1180
                    ' allow branch to proceed.'),
1198
 
        Option('bind',
1199
 
            help="Bind new branch to from location."),
1200
1181
        ]
1201
1182
    aliases = ['get', 'clone']
1202
1183
 
1203
1184
    def run(self, from_location, to_location=None, revision=None,
1204
1185
            hardlink=False, stacked=False, standalone=False, no_tree=False,
1205
 
            use_existing_dir=False, switch=False, bind=False):
1206
 
        from bzrlib import switch as _mod_switch
 
1186
            use_existing_dir=False):
1207
1187
        from bzrlib.tag import _merge_tags_if_possible
 
1188
 
1208
1189
        accelerator_tree, br_from = bzrdir.BzrDir.open_tree_or_branch(
1209
1190
            from_location)
 
1191
        if (accelerator_tree is not None and
 
1192
            accelerator_tree.supports_content_filtering()):
 
1193
            accelerator_tree = None
1210
1194
        revision = _get_one_revision('branch', revision)
1211
 
        self.add_cleanup(br_from.lock_read().unlock)
1212
 
        if revision is not None:
1213
 
            revision_id = revision.as_revision_id(br_from)
1214
 
        else:
1215
 
            # FIXME - wt.last_revision, fallback to branch, fall back to
1216
 
            # None or perhaps NULL_REVISION to mean copy nothing
1217
 
            # RBC 20060209
1218
 
            revision_id = br_from.last_revision()
1219
 
        if to_location is None:
1220
 
            to_location = urlutils.derive_to_location(from_location)
1221
 
        to_transport = transport.get_transport(to_location)
 
1195
        br_from.lock_read()
1222
1196
        try:
1223
 
            to_transport.mkdir('.')
1224
 
        except errors.FileExists:
1225
 
            if not use_existing_dir:
1226
 
                raise errors.BzrCommandError('Target directory "%s" '
1227
 
                    'already exists.' % to_location)
 
1197
            if revision is not None:
 
1198
                revision_id = revision.as_revision_id(br_from)
1228
1199
            else:
1229
 
                try:
1230
 
                    bzrdir.BzrDir.open_from_transport(to_transport)
1231
 
                except errors.NotBranchError:
1232
 
                    pass
 
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)
1233
1213
                else:
1234
 
                    raise errors.AlreadyBranchError(to_location)
1235
 
        except errors.NoSuchFile:
1236
 
            raise errors.BzrCommandError('Parent of "%s" does not exist.'
1237
 
                                         % to_location)
1238
 
        try:
1239
 
            # preserve whatever source format we have.
1240
 
            dir = br_from.bzrdir.sprout(to_transport.base, revision_id,
1241
 
                                        possible_transports=[to_transport],
1242
 
                                        accelerator_tree=accelerator_tree,
1243
 
                                        hardlink=hardlink, stacked=stacked,
1244
 
                                        force_new_repo=standalone,
1245
 
                                        create_tree_if_local=not no_tree,
1246
 
                                        source_branch=br_from)
1247
 
            branch = dir.open_branch()
1248
 
        except errors.NoSuchRevision:
1249
 
            to_transport.delete_tree('.')
1250
 
            msg = "The branch %s has no revision %s." % (from_location,
1251
 
                revision)
1252
 
            raise errors.BzrCommandError(msg)
1253
 
        _merge_tags_if_possible(br_from, branch)
1254
 
        # If the source branch is stacked, the new branch may
1255
 
        # be stacked whether we asked for that explicitly or not.
1256
 
        # We therefore need a try/except here and not just 'if stacked:'
1257
 
        try:
1258
 
            note('Created new stacked branch referring to %s.' %
1259
 
                branch.get_stacked_on_url())
1260
 
        except (errors.NotStacked, errors.UnstackableBranchFormat,
1261
 
            errors.UnstackableRepositoryFormat), e:
1262
 
            note('Branched %d revision(s).' % branch.revno())
1263
 
        if bind:
1264
 
            # Bind to the parent
1265
 
            parent_branch = Branch.open(from_location)
1266
 
            branch.bind(parent_branch)
1267
 
            note('New branch bound to %s' % from_location)
1268
 
        if switch:
1269
 
            # Switch to the new branch
1270
 
            wt, _ = WorkingTree.open_containing('.')
1271
 
            _mod_switch.switch(wt.bzrdir, branch)
1272
 
            note('Switched to branch: %s',
1273
 
                urlutils.unescape_for_display(branch.base, 'utf-8'))
 
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()
1274
1250
 
1275
1251
 
1276
1252
class cmd_checkout(Command):
1277
 
    __doc__ = """Create a new checkout of an existing branch.
 
1253
    """Create a new checkout of an existing branch.
1278
1254
 
1279
1255
    If BRANCH_LOCATION is omitted, checkout will reconstitute a working tree for
1280
1256
    the branch found in '.'. This is useful if you have removed the working tree
1343
1319
 
1344
1320
 
1345
1321
class cmd_renames(Command):
1346
 
    __doc__ = """Show list of renamed files.
 
1322
    """Show list of renamed files.
1347
1323
    """
1348
1324
    # TODO: Option to show renames between two historical versions.
1349
1325
 
1354
1330
    @display_command
1355
1331
    def run(self, dir=u'.'):
1356
1332
        tree = WorkingTree.open_containing(dir)[0]
1357
 
        self.add_cleanup(tree.lock_read().unlock)
1358
 
        new_inv = tree.inventory
1359
 
        old_tree = tree.basis_tree()
1360
 
        self.add_cleanup(old_tree.lock_read().unlock)
1361
 
        old_inv = old_tree.inventory
1362
 
        renames = []
1363
 
        iterator = tree.iter_changes(old_tree, include_unchanged=True)
1364
 
        for f, paths, c, v, p, n, k, e in iterator:
1365
 
            if paths[0] == paths[1]:
1366
 
                continue
1367
 
            if None in (paths):
1368
 
                continue
1369
 
            renames.append(paths)
1370
 
        renames.sort()
1371
 
        for old_name, new_name in renames:
1372
 
            self.outf.write("%s => %s\n" % (old_name, new_name))
 
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()
1373
1355
 
1374
1356
 
1375
1357
class cmd_update(Command):
1376
 
    __doc__ = """Update a tree to have the latest code committed to its branch.
 
1358
    """Update a tree to have the latest code committed to its branch.
1377
1359
 
1378
1360
    This will perform a merge into the working tree, and may generate
1379
1361
    conflicts. If you have any local changes, you will still
1381
1363
 
1382
1364
    If you want to discard your local changes, you can just do a
1383
1365
    'bzr revert' instead of 'bzr commit' after the update.
1384
 
 
1385
 
    If the tree's branch is bound to a master branch, it will also update
1386
 
    the branch from the master.
1387
1366
    """
1388
1367
 
1389
1368
    _see_also = ['pull', 'working-trees', 'status-flags']
1390
1369
    takes_args = ['dir?']
1391
 
    takes_options = ['revision']
1392
1370
    aliases = ['up']
1393
1371
 
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")
 
1372
    def run(self, dir='.'):
1398
1373
        tree = WorkingTree.open_containing(dir)[0]
1399
 
        branch = tree.branch
1400
1374
        possible_transports = []
1401
 
        master = branch.get_master_branch(
 
1375
        master = tree.branch.get_master_branch(
1402
1376
            possible_transports=possible_transports)
1403
1377
        if master is not None:
1404
 
            branch_location = master.base
1405
1378
            tree.lock_write()
1406
1379
        else:
1407
 
            branch_location = tree.branch.base
1408
1380
            tree.lock_tree_write()
1409
 
        self.add_cleanup(tree.unlock)
1410
 
        # get rid of the final '/' and be ready for display
1411
 
        branch_location = urlutils.unescape_for_display(
1412
 
            branch_location.rstrip('/'),
1413
 
            self.outf.encoding)
1414
 
        existing_pending_merges = tree.get_parent_ids()[1:]
1415
 
        if master is None:
1416
 
            old_tip = None
1417
 
        else:
1418
 
            # may need to fetch data into a heavyweight checkout
1419
 
            # XXX: this may take some time, maybe we should display a
1420
 
            # message
1421
 
            old_tip = branch.update(possible_transports)
1422
 
        if revision is not None:
1423
 
            revision_id = revision[0].as_revision_id(branch)
1424
 
        else:
1425
 
            revision_id = branch.last_revision()
1426
 
        if revision_id == _mod_revision.ensure_null(tree.last_revision()):
1427
 
            revno = branch.revision_id_to_dotted_revno(revision_id)
1428
 
            note("Tree is up to date at revision %s of branch %s" %
1429
 
                ('.'.join(map(str, revno)), branch_location))
1430
 
            return 0
1431
 
        view_info = _get_view_info_for_change_reporter(tree)
1432
 
        change_reporter = delta._ChangeReporter(
1433
 
            unversioned_filter=tree.is_ignored,
1434
 
            view_info=view_info)
1435
1381
        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)
1436
1393
            conflicts = tree.update(
1437
 
                change_reporter,
1438
 
                possible_transports=possible_transports,
1439
 
                revision=revision_id,
1440
 
                old_tip=old_tip)
1441
 
        except errors.NoSuchRevision, e:
1442
 
            raise errors.BzrCommandError(
1443
 
                                  "branch has no revision %s\n"
1444
 
                                  "bzr update --revision only works"
1445
 
                                  " for a revision in the branch history"
1446
 
                                  % (e.revision))
1447
 
        revno = tree.branch.revision_id_to_dotted_revno(
1448
 
            _mod_revision.ensure_null(tree.last_revision()))
1449
 
        note('Updated to revision %s of branch %s' %
1450
 
             ('.'.join(map(str, revno)), branch_location))
1451
 
        parent_ids = tree.get_parent_ids()
1452
 
        if parent_ids[1:] and parent_ids[1:] != existing_pending_merges:
1453
 
            note('Your local commits will now show as pending merges with '
1454
 
                 "'bzr status', and can be committed with 'bzr commit'.")
1455
 
        if conflicts != 0:
1456
 
            return 1
1457
 
        else:
1458
 
            return 0
 
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()
1459
1408
 
1460
1409
 
1461
1410
class cmd_info(Command):
1462
 
    __doc__ = """Show information about a working tree, branch or repository.
 
1411
    """Show information about a working tree, branch or repository.
1463
1412
 
1464
1413
    This command will show all known locations and formats associated to the
1465
1414
    tree, branch or repository.
1503
1452
 
1504
1453
 
1505
1454
class cmd_remove(Command):
1506
 
    __doc__ = """Remove files or directories.
 
1455
    """Remove files or directories.
1507
1456
 
1508
1457
    This makes bzr stop tracking changes to the specified files. bzr will delete
1509
1458
    them if they can easily be recovered using revert. If no options or
1531
1480
        if file_list is not None:
1532
1481
            file_list = [f for f in file_list]
1533
1482
 
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')
 
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()
1556
1508
 
1557
1509
 
1558
1510
class cmd_file_id(Command):
1559
 
    __doc__ = """Print file_id of a particular file or directory.
 
1511
    """Print file_id of a particular file or directory.
1560
1512
 
1561
1513
    The file_id is assigned when the file is first added and remains the
1562
1514
    same through all revisions where the file exists, even when it is
1578
1530
 
1579
1531
 
1580
1532
class cmd_file_path(Command):
1581
 
    __doc__ = """Print path of file_ids to a file or directory.
 
1533
    """Print path of file_ids to a file or directory.
1582
1534
 
1583
1535
    This prints one line for each directory down to the target,
1584
1536
    starting at the branch root.
1600
1552
 
1601
1553
 
1602
1554
class cmd_reconcile(Command):
1603
 
    __doc__ = """Reconcile bzr metadata in a branch.
 
1555
    """Reconcile bzr metadata in a branch.
1604
1556
 
1605
1557
    This can correct data mismatches that may have been caused by
1606
1558
    previous ghost operations or bzr upgrades. You should only
1628
1580
 
1629
1581
 
1630
1582
class cmd_revision_history(Command):
1631
 
    __doc__ = """Display the list of revision ids on a branch."""
 
1583
    """Display the list of revision ids on a branch."""
1632
1584
 
1633
1585
    _see_also = ['log']
1634
1586
    takes_args = ['location?']
1644
1596
 
1645
1597
 
1646
1598
class cmd_ancestry(Command):
1647
 
    __doc__ = """List all revisions merged into this branch."""
 
1599
    """List all revisions merged into this branch."""
1648
1600
 
1649
1601
    _see_also = ['log', 'revision-history']
1650
1602
    takes_args = ['location?']
1669
1621
 
1670
1622
 
1671
1623
class cmd_init(Command):
1672
 
    __doc__ = """Make a directory into a versioned branch.
 
1624
    """Make a directory into a versioned branch.
1673
1625
 
1674
1626
    Use this to create an empty branch, or before importing an
1675
1627
    existing project.
1703
1655
                lazy_registry=('bzrlib.bzrdir', 'format_registry'),
1704
1656
                converter=lambda name: bzrdir.format_registry.make_bzrdir(name),
1705
1657
                value_switches=True,
1706
 
                title="Branch format",
 
1658
                title="Branch Format",
1707
1659
                ),
1708
1660
         Option('append-revisions-only',
1709
1661
                help='Never change revnos or the existing log.'
1778
1730
 
1779
1731
 
1780
1732
class cmd_init_repository(Command):
1781
 
    __doc__ = """Create a shared repository for branches to share storage space.
 
1733
    """Create a shared repository to hold branches.
1782
1734
 
1783
1735
    New branches created under the repository directory will store their
1784
 
    revisions in the repository, not in the branch directory.  For branches
1785
 
    with shared history, this reduces the amount of storage needed and 
1786
 
    speeds up the creation of new branches.
 
1736
    revisions in the repository, not in the branch directory.
1787
1737
 
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.
 
1738
    If the --no-trees option is used then the branches in the repository
 
1739
    will not have working trees by default.
1794
1740
 
1795
1741
    :Examples:
1796
 
        Create a shared repository holding just branches::
 
1742
        Create a shared repositories holding just branches::
1797
1743
 
1798
1744
            bzr init-repo --no-trees repo
1799
1745
            bzr init repo/trunk
1838
1784
 
1839
1785
 
1840
1786
class cmd_diff(Command):
1841
 
    __doc__ = """Show differences in the working tree, between revisions or branches.
 
1787
    """Show differences in the working tree, between revisions or branches.
1842
1788
 
1843
1789
    If no arguments are given, all changes for the current tree are listed.
1844
1790
    If files are given, only the changes in those files are listed.
1865
1811
 
1866
1812
            bzr diff -r1
1867
1813
 
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
 
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
1889
1821
 
1890
1822
        Show just the differences for file NEWS::
1891
1823
 
1930
1862
            help='Use this command to compare files.',
1931
1863
            type=unicode,
1932
1864
            ),
1933
 
        RegistryOption('format',
1934
 
            help='Diff format to use.',
1935
 
            lazy_registry=('bzrlib.diff', 'format_registry'),
1936
 
            value_switches=False, title='Diff format'),
1937
1865
        ]
1938
1866
    aliases = ['di', 'dif']
1939
1867
    encoding_type = 'exact'
1940
1868
 
1941
1869
    @display_command
1942
1870
    def run(self, revision=None, file_list=None, diff_options=None,
1943
 
            prefix=None, old=None, new=None, using=None, format=None):
1944
 
        from bzrlib.diff import (get_trees_and_branches_to_diff_locked,
1945
 
            show_diff_trees)
 
1871
            prefix=None, old=None, new=None, using=None):
 
1872
        from bzrlib.diff import _get_trees_to_diff, show_diff_trees
1946
1873
 
1947
1874
        if (prefix is None) or (prefix == '0'):
1948
1875
            # diff -p0 format
1962
1889
            raise errors.BzrCommandError('bzr diff --revision takes exactly'
1963
1890
                                         ' one or two revision specifiers')
1964
1891
 
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()
 
1892
        old_tree, new_tree, specific_files, extra_trees = \
 
1893
                _get_trees_to_diff(file_list, revision, old, new,
 
1894
                apply_view=True)
1975
1895
        return show_diff_trees(old_tree, new_tree, sys.stdout,
1976
1896
                               specific_files=specific_files,
1977
1897
                               external_diff_options=diff_options,
1978
1898
                               old_label=old_label, new_label=new_label,
1979
 
                               extra_trees=extra_trees,
1980
 
                               path_encoding=path_encoding,
1981
 
                               using=using,
1982
 
                               format_cls=format)
 
1899
                               extra_trees=extra_trees, using=using)
1983
1900
 
1984
1901
 
1985
1902
class cmd_deleted(Command):
1986
 
    __doc__ = """List files deleted in the working tree.
 
1903
    """List files deleted in the working tree.
1987
1904
    """
1988
1905
    # TODO: Show files deleted since a previous revision, or
1989
1906
    # between two revisions.
1992
1909
    # level of effort but possibly much less IO.  (Or possibly not,
1993
1910
    # if the directories are very large...)
1994
1911
    _see_also = ['status', 'ls']
1995
 
    takes_options = ['directory', 'show-ids']
 
1912
    takes_options = ['show-ids']
1996
1913
 
1997
1914
    @display_command
1998
 
    def run(self, show_ids=False, directory=u'.'):
1999
 
        tree = WorkingTree.open_containing(directory)[0]
2000
 
        self.add_cleanup(tree.lock_read().unlock)
2001
 
        old = tree.basis_tree()
2002
 
        self.add_cleanup(old.lock_read().unlock)
2003
 
        for path, ie in old.inventory.iter_entries():
2004
 
            if not tree.has_id(ie.file_id):
2005
 
                self.outf.write(path)
2006
 
                if show_ids:
2007
 
                    self.outf.write(' ')
2008
 
                    self.outf.write(ie.file_id)
2009
 
                self.outf.write('\n')
 
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()
2010
1933
 
2011
1934
 
2012
1935
class cmd_modified(Command):
2013
 
    __doc__ = """List files modified in working tree.
 
1936
    """List files modified in working tree.
2014
1937
    """
2015
1938
 
2016
1939
    hidden = True
2017
1940
    _see_also = ['status', 'ls']
2018
 
    takes_options = ['directory', 'null']
 
1941
    takes_options = [
 
1942
            Option('null',
 
1943
                   help='Write an ascii NUL (\\0) separator '
 
1944
                   'between files rather than a newline.')
 
1945
            ]
2019
1946
 
2020
1947
    @display_command
2021
 
    def run(self, null=False, directory=u'.'):
2022
 
        tree = WorkingTree.open_containing(directory)[0]
 
1948
    def run(self, null=False):
 
1949
        tree = WorkingTree.open_containing(u'.')[0]
2023
1950
        td = tree.changes_from(tree.basis_tree())
2024
1951
        for path, id, kind, text_modified, meta_modified in td.modified:
2025
1952
            if null:
2029
1956
 
2030
1957
 
2031
1958
class cmd_added(Command):
2032
 
    __doc__ = """List files added in working tree.
 
1959
    """List files added in working tree.
2033
1960
    """
2034
1961
 
2035
1962
    hidden = True
2036
1963
    _see_also = ['status', 'ls']
2037
 
    takes_options = ['directory', 'null']
 
1964
    takes_options = [
 
1965
            Option('null',
 
1966
                   help='Write an ascii NUL (\\0) separator '
 
1967
                   'between files rather than a newline.')
 
1968
            ]
2038
1969
 
2039
1970
    @display_command
2040
 
    def run(self, null=False, directory=u'.'):
2041
 
        wt = WorkingTree.open_containing(directory)[0]
2042
 
        self.add_cleanup(wt.lock_read().unlock)
2043
 
        basis = wt.basis_tree()
2044
 
        self.add_cleanup(basis.lock_read().unlock)
2045
 
        basis_inv = basis.inventory
2046
 
        inv = wt.inventory
2047
 
        for file_id in inv:
2048
 
            if file_id in basis_inv:
2049
 
                continue
2050
 
            if inv.is_root(file_id) and len(basis_inv) == 0:
2051
 
                continue
2052
 
            path = inv.id2path(file_id)
2053
 
            if not os.access(osutils.pathjoin(wt.basedir, path), os.F_OK):
2054
 
                continue
2055
 
            if null:
2056
 
                self.outf.write(path + '\0')
2057
 
            else:
2058
 
                self.outf.write(osutils.quotefn(path) + '\n')
 
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()
2059
1996
 
2060
1997
 
2061
1998
class cmd_root(Command):
2062
 
    __doc__ = """Show the tree root directory.
 
1999
    """Show the tree root directory.
2063
2000
 
2064
2001
    The root is the nearest enclosing directory with a .bzr control
2065
2002
    directory."""
2089
2026
 
2090
2027
 
2091
2028
class cmd_log(Command):
2092
 
    __doc__ = """Show historical log for a branch or subset of a branch.
 
2029
    """Show historical log for a branch or subset of a branch.
2093
2030
 
2094
2031
    log is bzr's default tool for exploring the history of a branch.
2095
2032
    The branch to use is taken from the first parameter. If no parameters
2206
2143
    :Tips & tricks:
2207
2144
 
2208
2145
      GUI tools and IDEs are often better at exploring history than command
2209
 
      line tools: you may prefer qlog or viz from qbzr or bzr-gtk, the
2210
 
      bzr-explorer shell, or the Loggerhead web interface.  See the Plugin
2211
 
      Guide <http://doc.bazaar.canonical.com/plugins/en/> and
2212
 
      <http://wiki.bazaar.canonical.com/IDEIntegration>.  
 
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.
2213
2153
 
2214
2154
      You may find it useful to add the aliases below to ``bazaar.conf``::
2215
2155
 
2256
2196
                   help='Show just the specified revision.'
2257
2197
                   ' See also "help revisionspec".'),
2258
2198
            'log-format',
2259
 
            RegistryOption('authors',
2260
 
                'What names to list as authors - first, all or committer.',
2261
 
                title='Authors',
2262
 
                lazy_registry=('bzrlib.log', 'author_list_registry'),
2263
 
            ),
2264
2199
            Option('levels',
2265
2200
                   short_name='n',
2266
2201
                   help='Number of levels to display - 0 for all, 1 for flat.',
2281
2216
                   help='Show changes made in each revision as a patch.'),
2282
2217
            Option('include-merges',
2283
2218
                   help='Show merged revisions like --levels 0 does.'),
2284
 
            Option('exclude-common-ancestry',
2285
 
                   help='Display only the revisions that are not part'
2286
 
                   ' of both ancestries (require -rX..Y)'
2287
 
                   )
2288
2219
            ]
2289
2220
    encoding_type = 'replace'
2290
2221
 
2300
2231
            message=None,
2301
2232
            limit=None,
2302
2233
            show_diff=False,
2303
 
            include_merges=False,
2304
 
            authors=None,
2305
 
            exclude_common_ancestry=False,
2306
 
            ):
 
2234
            include_merges=False):
2307
2235
        from bzrlib.log import (
2308
2236
            Logger,
2309
2237
            make_log_request_dict,
2310
2238
            _get_info_for_log_files,
2311
2239
            )
2312
2240
        direction = (forward and 'forward') or 'reverse'
2313
 
        if (exclude_common_ancestry
2314
 
            and (revision is None or len(revision) != 2)):
2315
 
            raise errors.BzrCommandError(
2316
 
                '--exclude-common-ancestry requires -r with two revisions')
2317
2241
        if include_merges:
2318
2242
            if levels is None:
2319
2243
                levels = 0
2334
2258
        filter_by_dir = False
2335
2259
        if file_list:
2336
2260
            # find the file ids to log and check for directory filtering
2337
 
            b, file_info_list, rev1, rev2 = _get_info_for_log_files(
2338
 
                revision, file_list, self.add_cleanup)
 
2261
            b, file_info_list, rev1, rev2 = _get_info_for_log_files(revision,
 
2262
                file_list)
2339
2263
            for relpath, file_id, kind in file_info_list:
2340
2264
                if file_id is None:
2341
2265
                    raise errors.BzrCommandError(
2359
2283
                location = '.'
2360
2284
            dir, relpath = bzrdir.BzrDir.open_containing(location)
2361
2285
            b = dir.open_branch()
2362
 
            self.add_cleanup(b.lock_read().unlock)
2363
2286
            rev1, rev2 = _get_revision_range(revision, b, self.name())
2364
2287
 
2365
2288
        # Decide on the type of delta & diff filtering to use
2375
2298
        else:
2376
2299
            diff_type = 'full'
2377
2300
 
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)
 
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()
2418
2339
 
2419
2340
 
2420
2341
def _get_revision_range(revisionspec_list, branch, command_name):
2438
2359
            raise errors.BzrCommandError(
2439
2360
                "bzr %s doesn't accept two revisions in different"
2440
2361
                " branches." % command_name)
2441
 
        if start_spec.spec is None:
2442
 
            # Avoid loading all the history.
2443
 
            rev1 = RevisionInfo(branch, None, None)
2444
 
        else:
2445
 
            rev1 = start_spec.in_history(branch)
 
2362
        rev1 = start_spec.in_history(branch)
2446
2363
        # Avoid loading all of history when we know a missing
2447
2364
        # end of range means the last revision ...
2448
2365
        if end_spec.spec is None:
2477
2394
 
2478
2395
 
2479
2396
class cmd_touching_revisions(Command):
2480
 
    __doc__ = """Return revision-ids which affected a particular file.
 
2397
    """Return revision-ids which affected a particular file.
2481
2398
 
2482
2399
    A more user-friendly interface is "bzr log FILE".
2483
2400
    """
2488
2405
    @display_command
2489
2406
    def run(self, filename):
2490
2407
        tree, relpath = WorkingTree.open_containing(filename)
 
2408
        b = tree.branch
2491
2409
        file_id = tree.path2id(relpath)
2492
 
        b = tree.branch
2493
 
        self.add_cleanup(b.lock_read().unlock)
2494
 
        touching_revs = log.find_touching_revisions(b, file_id)
2495
 
        for revno, revision_id, what in touching_revs:
 
2410
        for revno, revision_id, what in log.find_touching_revisions(b, file_id):
2496
2411
            self.outf.write("%6d %s\n" % (revno, what))
2497
2412
 
2498
2413
 
2499
2414
class cmd_ls(Command):
2500
 
    __doc__ = """List files in a tree.
 
2415
    """List files in a tree.
2501
2416
    """
2502
2417
 
2503
2418
    _see_also = ['status', 'cat']
2509
2424
                   help='Recurse into subdirectories.'),
2510
2425
            Option('from-root',
2511
2426
                   help='Print paths relative to the root of the branch.'),
2512
 
            Option('unknown', short_name='u',
2513
 
                help='Print unknown files.'),
 
2427
            Option('unknown', help='Print unknown files.'),
2514
2428
            Option('versioned', help='Print versioned files.',
2515
2429
                   short_name='V'),
2516
 
            Option('ignored', short_name='i',
2517
 
                help='Print ignored files.'),
2518
 
            Option('kind', short_name='k',
 
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',
2519
2435
                   help='List entries of a particular kind: file, directory, symlink.',
2520
2436
                   type=unicode),
2521
 
            'null',
2522
2437
            'show-ids',
2523
 
            'directory',
2524
2438
            ]
2525
2439
    @display_command
2526
2440
    def run(self, revision=None, verbose=False,
2527
2441
            recursive=False, from_root=False,
2528
2442
            unknown=False, versioned=False, ignored=False,
2529
 
            null=False, kind=None, show_ids=False, path=None, directory=None):
 
2443
            null=False, kind=None, show_ids=False, path=None):
2530
2444
 
2531
2445
        if kind and kind not in ('file', 'directory', 'symlink'):
2532
2446
            raise errors.BzrCommandError('invalid kind specified')
2544
2458
                raise errors.BzrCommandError('cannot specify both --from-root'
2545
2459
                                             ' and PATH')
2546
2460
            fs_path = path
2547
 
        tree, branch, relpath = \
2548
 
            _open_directory_or_containing_tree_or_branch(fs_path, directory)
 
2461
        tree, branch, relpath = bzrdir.BzrDir.open_containing_tree_or_branch(
 
2462
            fs_path)
2549
2463
 
2550
2464
        # Calculate the prefix to use
2551
2465
        prefix = None
2552
2466
        if from_root:
2553
2467
            if relpath:
2554
2468
                prefix = relpath + '/'
2555
 
        elif fs_path != '.' and not fs_path.endswith('/'):
 
2469
        elif fs_path != '.':
2556
2470
            prefix = fs_path + '/'
2557
2471
 
2558
2472
        if revision is not None or tree is None:
2566
2480
                view_str = views.view_display_str(view_files)
2567
2481
                note("Ignoring files outside view. View is %s" % view_str)
2568
2482
 
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
 
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
2586
2501
 
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:
 
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)
2613
2512
                    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()
2614
2531
 
2615
2532
 
2616
2533
class cmd_unknowns(Command):
2617
 
    __doc__ = """List unknown files.
 
2534
    """List unknown files.
2618
2535
    """
2619
2536
 
2620
2537
    hidden = True
2621
2538
    _see_also = ['ls']
2622
 
    takes_options = ['directory']
2623
2539
 
2624
2540
    @display_command
2625
 
    def run(self, directory=u'.'):
2626
 
        for f in WorkingTree.open_containing(directory)[0].unknowns():
 
2541
    def run(self):
 
2542
        for f in WorkingTree.open_containing(u'.')[0].unknowns():
2627
2543
            self.outf.write(osutils.quotefn(f) + '\n')
2628
2544
 
2629
2545
 
2630
2546
class cmd_ignore(Command):
2631
 
    __doc__ = """Ignore specified files or patterns.
 
2547
    """Ignore specified files or patterns.
2632
2548
 
2633
2549
    See ``bzr help patterns`` for details on the syntax of patterns.
2634
2550
 
2635
 
    If a .bzrignore file does not exist, the ignore command
2636
 
    will create one and add the specified files or patterns to the newly
2637
 
    created file. The ignore command will also automatically add the 
2638
 
    .bzrignore file to be versioned. Creating a .bzrignore file without
2639
 
    the use of the ignore command will require an explicit add command.
2640
 
 
2641
2551
    To remove patterns from the ignore list, edit the .bzrignore file.
2642
2552
    After adding, editing or deleting that file either indirectly by
2643
2553
    using this command or directly by using an editor, be sure to commit
2644
2554
    it.
2645
 
    
2646
 
    Bazaar also supports a global ignore file ~/.bazaar/ignore. On Windows
2647
 
    the global ignore file can be found in the application data directory as
2648
 
    C:\\Documents and Settings\\<user>\\Application Data\\Bazaar\\2.0\\ignore.
2649
 
    Global ignores are not touched by this command. The global ignore file
2650
 
    can be edited directly using an editor.
2651
 
 
2652
 
    Patterns prefixed with '!' are exceptions to ignore patterns and take
2653
 
    precedence over regular ignores.  Such exceptions are used to specify
2654
 
    files that should be versioned which would otherwise be ignored.
2655
 
    
2656
 
    Patterns prefixed with '!!' act as regular ignore patterns, but have
2657
 
    precedence over the '!' exception patterns.
2658
2555
 
2659
2556
    Note: ignore patterns containing shell wildcards must be quoted from
2660
2557
    the shell on Unix.
2664
2561
 
2665
2562
            bzr ignore ./Makefile
2666
2563
 
2667
 
        Ignore .class files in all directories...::
 
2564
        Ignore class files in all directories::
2668
2565
 
2669
2566
            bzr ignore "*.class"
2670
2567
 
2671
 
        ...but do not ignore "special.class"::
2672
 
 
2673
 
            bzr ignore "!special.class"
2674
 
 
2675
2568
        Ignore .o files under the lib directory::
2676
2569
 
2677
2570
            bzr ignore "lib/**/*.o"
2683
2576
        Ignore everything but the "debian" toplevel directory::
2684
2577
 
2685
2578
            bzr ignore "RE:(?!debian/).*"
2686
 
        
2687
 
        Ignore everything except the "local" toplevel directory,
2688
 
        but always ignore "*~" autosave files, even under local/::
2689
 
        
2690
 
            bzr ignore "*"
2691
 
            bzr ignore "!./local"
2692
 
            bzr ignore "!!*~"
2693
2579
    """
2694
2580
 
2695
2581
    _see_also = ['status', 'ignored', 'patterns']
2696
2582
    takes_args = ['name_pattern*']
2697
 
    takes_options = ['directory',
2698
 
        Option('default-rules',
2699
 
               help='Display the default ignore rules that bzr uses.')
 
2583
    takes_options = [
 
2584
        Option('old-default-rules',
 
2585
               help='Write out the ignore rules bzr < 0.9 always used.')
2700
2586
        ]
2701
2587
 
2702
 
    def run(self, name_pattern_list=None, default_rules=None,
2703
 
            directory=u'.'):
 
2588
    def run(self, name_pattern_list=None, old_default_rules=None):
2704
2589
        from bzrlib import ignores
2705
 
        if default_rules is not None:
2706
 
            # dump the default rules and exit
2707
 
            for pattern in ignores.USER_DEFAULTS:
2708
 
                self.outf.write("%s\n" % pattern)
 
2590
        if old_default_rules is not None:
 
2591
            # dump the rules and exit
 
2592
            for pattern in ignores.OLD_DEFAULTS:
 
2593
                print pattern
2709
2594
            return
2710
2595
        if not name_pattern_list:
2711
2596
            raise errors.BzrCommandError("ignore requires at least one "
2712
 
                "NAME_PATTERN or --default-rules.")
 
2597
                                  "NAME_PATTERN or --old-default-rules")
2713
2598
        name_pattern_list = [globbing.normalize_pattern(p)
2714
2599
                             for p in name_pattern_list]
2715
 
        bad_patterns = ''
2716
 
        for p in name_pattern_list:
2717
 
            if not globbing.Globster.is_pattern_valid(p):
2718
 
                bad_patterns += ('\n  %s' % p)
2719
 
        if bad_patterns:
2720
 
            msg = ('Invalid ignore pattern(s) found. %s' % bad_patterns)
2721
 
            ui.ui_factory.show_error(msg)
2722
 
            raise errors.InvalidPattern('')
2723
2600
        for name_pattern in name_pattern_list:
2724
2601
            if (name_pattern[0] == '/' or
2725
2602
                (len(name_pattern) > 1 and name_pattern[1] == ':')):
2726
2603
                raise errors.BzrCommandError(
2727
2604
                    "NAME_PATTERN should not be an absolute path")
2728
 
        tree, relpath = WorkingTree.open_containing(directory)
 
2605
        tree, relpath = WorkingTree.open_containing(u'.')
2729
2606
        ignores.tree_ignores_add_patterns(tree, name_pattern_list)
2730
2607
        ignored = globbing.Globster(name_pattern_list)
2731
2608
        matches = []
2732
 
        self.add_cleanup(tree.lock_read().unlock)
 
2609
        tree.lock_read()
2733
2610
        for entry in tree.list_files():
2734
2611
            id = entry[3]
2735
2612
            if id is not None:
2736
2613
                filename = entry[0]
2737
2614
                if ignored.match(filename):
2738
 
                    matches.append(filename)
 
2615
                    matches.append(filename.encode('utf-8'))
 
2616
        tree.unlock()
2739
2617
        if len(matches) > 0:
2740
 
            self.outf.write("Warning: the following files are version controlled and"
2741
 
                  " match your ignore pattern:\n%s"
2742
 
                  "\nThese files will continue to be version controlled"
2743
 
                  " unless you 'bzr remove' them.\n" % ("\n".join(matches),))
 
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),)
2744
2622
 
2745
2623
 
2746
2624
class cmd_ignored(Command):
2747
 
    __doc__ = """List ignored files and the patterns that matched them.
 
2625
    """List ignored files and the patterns that matched them.
2748
2626
 
2749
2627
    List all the ignored files and the ignore pattern that caused the file to
2750
2628
    be ignored.
2756
2634
 
2757
2635
    encoding_type = 'replace'
2758
2636
    _see_also = ['ignore', 'ls']
2759
 
    takes_options = ['directory']
2760
2637
 
2761
2638
    @display_command
2762
 
    def run(self, directory=u'.'):
2763
 
        tree = WorkingTree.open_containing(directory)[0]
2764
 
        self.add_cleanup(tree.lock_read().unlock)
2765
 
        for path, file_class, kind, file_id, entry in tree.list_files():
2766
 
            if file_class != 'I':
2767
 
                continue
2768
 
            ## XXX: Slightly inefficient since this was already calculated
2769
 
            pat = tree.is_ignored(path)
2770
 
            self.outf.write('%-50s %s\n' % (path, pat))
 
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()
2771
2651
 
2772
2652
 
2773
2653
class cmd_lookup_revision(Command):
2774
 
    __doc__ = """Lookup the revision-id from a revision-number
 
2654
    """Lookup the revision-id from a revision-number
2775
2655
 
2776
2656
    :Examples:
2777
2657
        bzr lookup-revision 33
2778
2658
    """
2779
2659
    hidden = True
2780
2660
    takes_args = ['revno']
2781
 
    takes_options = ['directory']
2782
2661
 
2783
2662
    @display_command
2784
 
    def run(self, revno, directory=u'.'):
 
2663
    def run(self, revno):
2785
2664
        try:
2786
2665
            revno = int(revno)
2787
2666
        except ValueError:
2788
 
            raise errors.BzrCommandError("not a valid revision-number: %r"
2789
 
                                         % revno)
2790
 
        revid = WorkingTree.open_containing(directory)[0].branch.get_rev_id(revno)
2791
 
        self.outf.write("%s\n" % revid)
 
2667
            raise errors.BzrCommandError("not a valid revision-number: %r" % revno)
 
2668
 
 
2669
        print WorkingTree.open_containing(u'.')[0].branch.get_rev_id(revno)
2792
2670
 
2793
2671
 
2794
2672
class cmd_export(Command):
2795
 
    __doc__ = """Export current or past revision to a destination directory or archive.
 
2673
    """Export current or past revision to a destination directory or archive.
2796
2674
 
2797
2675
    If no revision is specified this exports the last committed revision.
2798
2676
 
2820
2698
      =================       =========================
2821
2699
    """
2822
2700
    takes_args = ['dest', 'branch_or_subdir?']
2823
 
    takes_options = ['directory',
 
2701
    takes_options = [
2824
2702
        Option('format',
2825
2703
               help="Type of file to export to.",
2826
2704
               type=unicode),
2830
2708
        Option('root',
2831
2709
               type=str,
2832
2710
               help="Name of the root directory inside the exported file."),
2833
 
        Option('per-file-timestamps',
2834
 
               help='Set modification time of files to that of the last '
2835
 
                    'revision in which it was changed.'),
2836
2711
        ]
2837
2712
    def run(self, dest, branch_or_subdir=None, revision=None, format=None,
2838
 
        root=None, filters=False, per_file_timestamps=False, directory=u'.'):
 
2713
        root=None, filters=False):
2839
2714
        from bzrlib.export import export
2840
2715
 
2841
2716
        if branch_or_subdir is None:
2842
 
            tree = WorkingTree.open_containing(directory)[0]
 
2717
            tree = WorkingTree.open_containing(u'.')[0]
2843
2718
            b = tree.branch
2844
2719
            subdir = None
2845
2720
        else:
2848
2723
 
2849
2724
        rev_tree = _get_one_revision_tree('export', revision, branch=b, tree=tree)
2850
2725
        try:
2851
 
            export(rev_tree, dest, format, root, subdir, filtered=filters,
2852
 
                   per_file_timestamps=per_file_timestamps)
 
2726
            export(rev_tree, dest, format, root, subdir, filtered=filters)
2853
2727
        except errors.NoSuchExportFormat, e:
2854
2728
            raise errors.BzrCommandError('Unsupported export format: %s' % e.format)
2855
2729
 
2856
2730
 
2857
2731
class cmd_cat(Command):
2858
 
    __doc__ = """Write the contents of a file as of a given revision to standard output.
 
2732
    """Write the contents of a file as of a given revision to standard output.
2859
2733
 
2860
2734
    If no revision is nominated, the last revision is used.
2861
2735
 
2864
2738
    """
2865
2739
 
2866
2740
    _see_also = ['ls']
2867
 
    takes_options = ['directory',
 
2741
    takes_options = [
2868
2742
        Option('name-from-revision', help='The path name in the old tree.'),
2869
2743
        Option('filters', help='Apply content filters to display the '
2870
2744
                'convenience form.'),
2875
2749
 
2876
2750
    @display_command
2877
2751
    def run(self, filename, revision=None, name_from_revision=False,
2878
 
            filters=False, directory=None):
 
2752
            filters=False):
2879
2753
        if revision is not None and len(revision) != 1:
2880
2754
            raise errors.BzrCommandError("bzr cat --revision takes exactly"
2881
2755
                                         " one revision specifier")
2882
2756
        tree, branch, relpath = \
2883
 
            _open_directory_or_containing_tree_or_branch(filename, directory)
2884
 
        self.add_cleanup(branch.lock_read().unlock)
2885
 
        return self._run(tree, branch, relpath, filename, revision,
2886
 
                         name_from_revision, filters)
 
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()
2887
2764
 
2888
2765
    def _run(self, tree, b, relpath, filename, revision, name_from_revision,
2889
2766
        filtered):
2890
2767
        if tree is None:
2891
2768
            tree = b.basis_tree()
2892
2769
        rev_tree = _get_one_revision_tree('cat', revision, branch=b)
2893
 
        self.add_cleanup(rev_tree.lock_read().unlock)
2894
2770
 
2895
2771
        old_file_id = rev_tree.path2id(relpath)
2896
2772
 
2931
2807
            chunks = content.splitlines(True)
2932
2808
            content = filtered_output_bytes(chunks, filters,
2933
2809
                ContentFilterContext(relpath, rev_tree))
2934
 
            self.cleanup_now()
2935
2810
            self.outf.writelines(content)
2936
2811
        else:
2937
 
            self.cleanup_now()
2938
2812
            self.outf.write(content)
2939
2813
 
2940
2814
 
2941
2815
class cmd_local_time_offset(Command):
2942
 
    __doc__ = """Show the offset in seconds from GMT to local time."""
 
2816
    """Show the offset in seconds from GMT to local time."""
2943
2817
    hidden = True
2944
2818
    @display_command
2945
2819
    def run(self):
2946
 
        self.outf.write("%s\n" % osutils.local_time_offset())
 
2820
        print osutils.local_time_offset()
2947
2821
 
2948
2822
 
2949
2823
 
2950
2824
class cmd_commit(Command):
2951
 
    __doc__ = """Commit changes into a new revision.
 
2825
    """Commit changes into a new revision.
2952
2826
 
2953
2827
    An explanatory message needs to be given for each commit. This is
2954
2828
    often done by using the --message option (getting the message from the
3047
2921
             Option('strict',
3048
2922
                    help="Refuse to commit if there are unknown "
3049
2923
                    "files in the working tree."),
3050
 
             Option('commit-time', type=str,
3051
 
                    help="Manually set a commit time using commit date "
3052
 
                    "format, e.g. '2009-10-10 08:00:00 +0100'."),
3053
2924
             ListOption('fixes', type=str,
3054
2925
                    help="Mark a bug as being fixed by this revision "
3055
2926
                         "(see \"bzr help bugs\")."),
3062
2933
                         "the master branch until a normal commit "
3063
2934
                         "is performed."
3064
2935
                    ),
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.'),
 
2936
              Option('show-diff',
 
2937
                     help='When no message is supplied, show the diff along'
 
2938
                     ' with the status summary in the message editor.'),
3068
2939
             ]
3069
2940
    aliases = ['ci', 'checkin']
3070
2941
 
3089
2960
 
3090
2961
    def run(self, message=None, file=None, verbose=False, selected_list=None,
3091
2962
            unchanged=False, strict=False, local=False, fixes=None,
3092
 
            author=None, show_diff=False, exclude=None, commit_time=None):
 
2963
            author=None, show_diff=False, exclude=None):
3093
2964
        from bzrlib.errors import (
3094
2965
            PointlessCommit,
3095
2966
            ConflictsInTree,
3101
2972
            make_commit_message_template_encoded
3102
2973
        )
3103
2974
 
3104
 
        commit_stamp = offset = None
3105
 
        if commit_time is not None:
3106
 
            try:
3107
 
                commit_stamp, offset = timestamp.parse_patch_date(commit_time)
3108
 
            except ValueError, e:
3109
 
                raise errors.BzrCommandError(
3110
 
                    "Could not parse --commit-time: " + str(e))
3111
 
 
3112
2975
        # TODO: Need a blackbox test for invoking the external editor; may be
3113
2976
        # slightly problematic to run this cross-platform.
3114
2977
 
3134
2997
        if local and not tree.branch.get_bound_location():
3135
2998
            raise errors.LocalRequiresBoundBranch()
3136
2999
 
3137
 
        if message is not None:
3138
 
            try:
3139
 
                file_exists = osutils.lexists(message)
3140
 
            except UnicodeError:
3141
 
                # The commit message contains unicode characters that can't be
3142
 
                # represented in the filesystem encoding, so that can't be a
3143
 
                # file.
3144
 
                file_exists = False
3145
 
            if file_exists:
3146
 
                warning_msg = (
3147
 
                    'The commit message is a file name: "%(f)s".\n'
3148
 
                    '(use --file "%(f)s" to take commit message from that file)'
3149
 
                    % { 'f': message })
3150
 
                ui.ui_factory.show_warning(warning_msg)
3151
 
            if '\r' in message:
3152
 
                message = message.replace('\r\n', '\n')
3153
 
                message = message.replace('\r', '\n')
3154
 
            if file:
3155
 
                raise errors.BzrCommandError(
3156
 
                    "please specify either --message or --file")
3157
 
 
3158
3000
        def get_message(commit_obj):
3159
3001
            """Callback to get commit message"""
3160
 
            if file:
3161
 
                f = codecs.open(file, 'rt', osutils.get_user_encoding())
3162
 
                try:
3163
 
                    my_message = f.read()
3164
 
                finally:
3165
 
                    f.close()
3166
 
            elif message is not None:
3167
 
                my_message = message
3168
 
            else:
3169
 
                # No message supplied: make one up.
3170
 
                # text is the status of the tree
3171
 
                text = make_commit_message_template_encoded(tree,
 
3002
            my_message = message
 
3003
            if my_message is None and not file:
 
3004
                t = make_commit_message_template_encoded(tree,
3172
3005
                        selected_list, diff=show_diff,
3173
3006
                        output_encoding=osutils.get_user_encoding())
3174
 
                # start_message is the template generated from hooks
3175
 
                # XXX: Warning - looks like hooks return unicode,
3176
 
                # make_commit_message_template_encoded returns user encoding.
3177
 
                # We probably want to be using edit_commit_message instead to
3178
 
                # avoid this.
3179
3007
                start_message = generate_commit_message_template(commit_obj)
3180
 
                my_message = edit_commit_message_encoded(text,
 
3008
                my_message = edit_commit_message_encoded(t,
3181
3009
                    start_message=start_message)
3182
3010
                if my_message is None:
3183
3011
                    raise errors.BzrCommandError("please specify a commit"
3184
3012
                        " 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()
3185
3019
            if my_message == "":
3186
3020
                raise errors.BzrCommandError("empty commit message specified")
3187
3021
            return my_message
3188
3022
 
3189
 
        # The API permits a commit with a filter of [] to mean 'select nothing'
3190
 
        # but the command line should not do that.
3191
 
        if not selected_list:
3192
 
            selected_list = None
3193
3023
        try:
3194
3024
            tree.commit(message_callback=get_message,
3195
3025
                        specific_files=selected_list,
3196
3026
                        allow_pointless=unchanged, strict=strict, local=local,
3197
3027
                        reporter=None, verbose=verbose, revprops=properties,
3198
 
                        authors=author, timestamp=commit_stamp,
3199
 
                        timezone=offset,
 
3028
                        authors=author,
3200
3029
                        exclude=safe_relpath_files(tree, exclude))
3201
3030
        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
3202
3033
            raise errors.BzrCommandError("No changes to commit."
3203
3034
                              " Use --unchanged to commit anyhow.")
3204
3035
        except ConflictsInTree:
3209
3040
            raise errors.BzrCommandError("Commit refused because there are"
3210
3041
                              " unknown files in the working tree.")
3211
3042
        except errors.BoundBranchOutOfDate, e:
3212
 
            e.extra_help = ("\n"
3213
 
                'To commit to master branch, run update and then commit.\n'
3214
 
                'You can also pass --local to commit to continue working '
3215
 
                'disconnected.')
3216
 
            raise
 
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.')
3217
3047
 
3218
3048
 
3219
3049
class cmd_check(Command):
3220
 
    __doc__ = """Validate working tree structure, branch consistency and repository history.
 
3050
    """Validate working tree structure, branch consistency and repository history.
3221
3051
 
3222
3052
    This command checks various invariants about branch and repository storage
3223
3053
    to detect data corruption or bzr bugs.
3287
3117
 
3288
3118
 
3289
3119
class cmd_upgrade(Command):
3290
 
    __doc__ = """Upgrade branch storage to current format.
 
3120
    """Upgrade branch storage to current format.
3291
3121
 
3292
3122
    The check command or bzr developers may sometimes advise you to run
3293
3123
    this command. When the default format has changed you may also be warned
3311
3141
 
3312
3142
 
3313
3143
class cmd_whoami(Command):
3314
 
    __doc__ = """Show or set bzr user id.
 
3144
    """Show or set bzr user id.
3315
3145
 
3316
3146
    :Examples:
3317
3147
        Show the email of the current user::
3322
3152
 
3323
3153
            bzr whoami "Frank Chu <fchu@example.com>"
3324
3154
    """
3325
 
    takes_options = [ 'directory',
3326
 
                      Option('email',
 
3155
    takes_options = [ Option('email',
3327
3156
                             help='Display email address only.'),
3328
3157
                      Option('branch',
3329
3158
                             help='Set identity for the current branch instead of '
3333
3162
    encoding_type = 'replace'
3334
3163
 
3335
3164
    @display_command
3336
 
    def run(self, email=False, branch=False, name=None, directory=None):
 
3165
    def run(self, email=False, branch=False, name=None):
3337
3166
        if name is None:
3338
 
            if directory is None:
3339
 
                # use branch if we're inside one; otherwise global config
3340
 
                try:
3341
 
                    c = Branch.open_containing(u'.')[0].get_config()
3342
 
                except errors.NotBranchError:
3343
 
                    c = config.GlobalConfig()
3344
 
            else:
3345
 
                c = Branch.open(directory).get_config()
 
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()
3346
3172
            if email:
3347
3173
                self.outf.write(c.user_email() + '\n')
3348
3174
            else:
3358
3184
 
3359
3185
        # use global config unless --branch given
3360
3186
        if branch:
3361
 
            if directory is None:
3362
 
                c = Branch.open_containing(u'.')[0].get_config()
3363
 
            else:
3364
 
                c = Branch.open(directory).get_config()
 
3187
            c = Branch.open_containing('.')[0].get_config()
3365
3188
        else:
3366
3189
            c = config.GlobalConfig()
3367
3190
        c.set_user_option('email', name)
3368
3191
 
3369
3192
 
3370
3193
class cmd_nick(Command):
3371
 
    __doc__ = """Print or set the branch nickname.
 
3194
    """Print or set the branch nickname.
3372
3195
 
3373
3196
    If unset, the tree root directory name is used as the nickname.
3374
3197
    To print the current nickname, execute with no argument.
3379
3202
 
3380
3203
    _see_also = ['info']
3381
3204
    takes_args = ['nickname?']
3382
 
    takes_options = ['directory']
3383
 
    def run(self, nickname=None, directory=u'.'):
3384
 
        branch = Branch.open_containing(directory)[0]
 
3205
    def run(self, nickname=None):
 
3206
        branch = Branch.open_containing(u'.')[0]
3385
3207
        if nickname is None:
3386
3208
            self.printme(branch)
3387
3209
        else:
3389
3211
 
3390
3212
    @display_command
3391
3213
    def printme(self, branch):
3392
 
        self.outf.write('%s\n' % branch.nick)
 
3214
        print branch.nick
3393
3215
 
3394
3216
 
3395
3217
class cmd_alias(Command):
3396
 
    __doc__ = """Set/unset and display aliases.
 
3218
    """Set/unset and display aliases.
3397
3219
 
3398
3220
    :Examples:
3399
3221
        Show the current aliases::
3463
3285
 
3464
3286
 
3465
3287
class cmd_selftest(Command):
3466
 
    __doc__ = """Run internal test suite.
 
3288
    """Run internal test suite.
3467
3289
 
3468
3290
    If arguments are given, they are regular expressions that say which tests
3469
3291
    should run.  Tests matching any expression are run, and other tests are
3496
3318
    Tests that need working space on disk use a common temporary directory,
3497
3319
    typically inside $TMPDIR or /tmp.
3498
3320
 
3499
 
    If you set BZR_TEST_PDB=1 when running selftest, failing tests will drop
3500
 
    into a pdb postmortem session.
3501
 
 
3502
3321
    :Examples:
3503
3322
        Run only tests relating to 'ignore'::
3504
3323
 
3513
3332
    def get_transport_type(typestring):
3514
3333
        """Parse and return a transport specifier."""
3515
3334
        if typestring == "sftp":
3516
 
            from bzrlib.tests import stub_sftp
3517
 
            return stub_sftp.SFTPAbsoluteServer
 
3335
            from bzrlib.transport.sftp import SFTPAbsoluteServer
 
3336
            return SFTPAbsoluteServer
3518
3337
        if typestring == "memory":
3519
 
            from bzrlib.tests import test_server
3520
 
            return memory.MemoryServer
 
3338
            from bzrlib.transport.memory import MemoryServer
 
3339
            return MemoryServer
3521
3340
        if typestring == "fakenfs":
3522
 
            from bzrlib.tests import test_server
3523
 
            return test_server.FakeNFSServer
 
3341
            from bzrlib.transport.fakenfs import FakeNFSServer
 
3342
            return FakeNFSServer
3524
3343
        msg = "No known transport type %s. Supported types are: sftp\n" %\
3525
3344
            (typestring)
3526
3345
        raise errors.BzrCommandError(msg)
3537
3356
                                 'throughout the test suite.',
3538
3357
                            type=get_transport_type),
3539
3358
                     Option('benchmark',
3540
 
                            help='Run the benchmarks rather than selftests.',
3541
 
                            hidden=True),
 
3359
                            help='Run the benchmarks rather than selftests.'),
3542
3360
                     Option('lsprof-timed',
3543
3361
                            help='Generate lsprof output for benchmarked'
3544
3362
                                 ' sections of code.'),
3545
 
                     Option('lsprof-tests',
3546
 
                            help='Generate lsprof output for each test.'),
 
3363
                     Option('cache-dir', type=str,
 
3364
                            help='Cache intermediate benchmark output in this '
 
3365
                                 'directory.'),
3547
3366
                     Option('first',
3548
3367
                            help='Run all tests, but run specified tests first.',
3549
3368
                            short_name='f',
3583
3402
 
3584
3403
    def run(self, testspecs_list=None, verbose=False, one=False,
3585
3404
            transport=None, benchmark=None,
3586
 
            lsprof_timed=None,
 
3405
            lsprof_timed=None, cache_dir=None,
3587
3406
            first=False, list_only=False,
3588
3407
            randomize=None, exclude=None, strict=False,
3589
3408
            load_list=None, debugflag=None, starting_with=None, subunit=False,
3590
 
            parallel=None, lsprof_tests=False):
 
3409
            parallel=None):
3591
3410
        from bzrlib.tests import selftest
 
3411
        import bzrlib.benchmarks as benchmarks
 
3412
        from bzrlib.benchmarks import tree_creator
3592
3413
 
3593
3414
        # Make deprecation warnings visible, unless -Werror is set
3594
3415
        symbol_versioning.activate_deprecation_warnings(override=False)
3595
3416
 
 
3417
        if cache_dir is not None:
 
3418
            tree_creator.TreeCreator.CACHE_ROOT = osutils.abspath(cache_dir)
3596
3419
        if testspecs_list is not None:
3597
3420
            pattern = '|'.join(testspecs_list)
3598
3421
        else:
3604
3427
                raise errors.BzrCommandError("subunit not available. subunit "
3605
3428
                    "needs to be installed to use --subunit.")
3606
3429
            self.additional_selftest_args['runner_class'] = SubUnitBzrRunner
3607
 
            # On Windows, disable automatic conversion of '\n' to '\r\n' in
3608
 
            # stdout, which would corrupt the subunit stream. 
3609
 
            # FIXME: This has been fixed in subunit trunk (>0.0.5) so the
3610
 
            # following code can be deleted when it's sufficiently deployed
3611
 
            # -- vila/mgz 20100514
3612
 
            if (sys.platform == "win32"
3613
 
                and getattr(sys.stdout, 'fileno', None) is not None):
3614
 
                import msvcrt
3615
 
                msvcrt.setmode(sys.stdout.fileno(), os.O_BINARY)
3616
3430
        if parallel:
3617
3431
            self.additional_selftest_args.setdefault(
3618
3432
                'suite_decorators', []).append(parallel)
3619
3433
        if benchmark:
3620
 
            raise errors.BzrCommandError(
3621
 
                "--benchmark is no longer supported from bzr 2.2; "
3622
 
                "use bzr-usertest instead")
3623
 
        test_suite_factory = None
3624
 
        selftest_kwargs = {"verbose": verbose,
3625
 
                          "pattern": pattern,
3626
 
                          "stop_on_failure": one,
3627
 
                          "transport": transport,
3628
 
                          "test_suite_factory": test_suite_factory,
3629
 
                          "lsprof_timed": lsprof_timed,
3630
 
                          "lsprof_tests": lsprof_tests,
3631
 
                          "matching_tests_first": first,
3632
 
                          "list_only": list_only,
3633
 
                          "random_seed": randomize,
3634
 
                          "exclude_pattern": exclude,
3635
 
                          "strict": strict,
3636
 
                          "load_list": load_list,
3637
 
                          "debug_flags": debugflag,
3638
 
                          "starting_with": starting_with
3639
 
                          }
3640
 
        selftest_kwargs.update(self.additional_selftest_args)
3641
 
        result = selftest(**selftest_kwargs)
 
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()
3642
3464
        return int(not result)
3643
3465
 
3644
3466
 
3645
3467
class cmd_version(Command):
3646
 
    __doc__ = """Show version of bzr."""
 
3468
    """Show version of bzr."""
3647
3469
 
3648
3470
    encoding_type = 'replace'
3649
3471
    takes_options = [
3660
3482
 
3661
3483
 
3662
3484
class cmd_rocks(Command):
3663
 
    __doc__ = """Statement of optimism."""
 
3485
    """Statement of optimism."""
3664
3486
 
3665
3487
    hidden = True
3666
3488
 
3667
3489
    @display_command
3668
3490
    def run(self):
3669
 
        self.outf.write("It sure does!\n")
 
3491
        print "It sure does!"
3670
3492
 
3671
3493
 
3672
3494
class cmd_find_merge_base(Command):
3673
 
    __doc__ = """Find and print a base revision for merging two branches."""
 
3495
    """Find and print a base revision for merging two branches."""
3674
3496
    # TODO: Options to specify revisions on either side, as if
3675
3497
    #       merging only part of the history.
3676
3498
    takes_args = ['branch', 'other']
3682
3504
 
3683
3505
        branch1 = Branch.open_containing(branch)[0]
3684
3506
        branch2 = Branch.open_containing(other)[0]
3685
 
        self.add_cleanup(branch1.lock_read().unlock)
3686
 
        self.add_cleanup(branch2.lock_read().unlock)
3687
 
        last1 = ensure_null(branch1.last_revision())
3688
 
        last2 = ensure_null(branch2.last_revision())
3689
 
 
3690
 
        graph = branch1.repository.get_graph(branch2.repository)
3691
 
        base_rev_id = graph.find_unique_lca(last1, last2)
3692
 
 
3693
 
        self.outf.write('merge base is revision %s\n' % base_rev_id)
 
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()
3694
3522
 
3695
3523
 
3696
3524
class cmd_merge(Command):
3697
 
    __doc__ = """Perform a three-way merge.
 
3525
    """Perform a three-way merge.
3698
3526
 
3699
3527
    The source of the merge can be specified either in the form of a branch,
3700
3528
    or in the form of a path to a file containing a merge directive generated
3729
3557
    committed to record the result of the merge.
3730
3558
 
3731
3559
    merge refuses to run if there are any uncommitted changes, unless
3732
 
    --force is given. The --force option can also be used to create a
3733
 
    merge revision which has more than two parents.
3734
 
 
3735
 
    If one would like to merge changes from the working tree of the other
3736
 
    branch without merging any committed revisions, the --uncommitted option
3737
 
    can be given.
 
3560
    --force is given.
3738
3561
 
3739
3562
    To select only some changes to merge, use "merge -i", which will prompt
3740
3563
    you to apply each diff hunk and file change, similar to "shelve".
3752
3575
 
3753
3576
            bzr merge -r 81..82 ../bzr.dev
3754
3577
 
3755
 
        To apply a merge directive contained in /tmp/merge::
 
3578
        To apply a merge directive contained in /tmp/merge:
3756
3579
 
3757
3580
            bzr merge /tmp/merge
3758
 
 
3759
 
        To create a merge revision with three parents from two branches
3760
 
        feature1a and feature1b:
3761
 
 
3762
 
            bzr merge ../feature1a
3763
 
            bzr merge ../feature1b --force
3764
 
            bzr commit -m 'revision with three parents'
3765
3581
    """
3766
3582
 
3767
3583
    encoding_type = 'exact'
3783
3599
                ' completely merged into the source, pull from the'
3784
3600
                ' source rather than merging.  When this happens,'
3785
3601
                ' you do not need to commit the result.'),
3786
 
        custom_help('directory',
 
3602
        Option('directory',
3787
3603
               help='Branch to merge into, '
3788
 
                    'rather than the one containing the working directory.'),
 
3604
                    'rather than the one containing the working directory.',
 
3605
               short_name='d',
 
3606
               type=unicode,
 
3607
               ),
3789
3608
        Option('preview', help='Instead of merging, show a diff of the'
3790
3609
               ' merge.'),
3791
3610
        Option('interactive', help='Select changes interactively.',
3809
3628
        verified = 'inapplicable'
3810
3629
        tree = WorkingTree.open_containing(directory)[0]
3811
3630
 
 
3631
        # die as quickly as possible if there are uncommitted changes
3812
3632
        try:
3813
3633
            basis_tree = tree.revision_tree(tree.last_revision())
3814
3634
        except errors.NoSuchRevision:
3815
3635
            basis_tree = tree.basis_tree()
3816
 
 
3817
 
        # die as quickly as possible if there are uncommitted changes
3818
3636
        if not force:
3819
 
            if tree.has_changes():
 
3637
            if tree.has_changes(basis_tree):
3820
3638
                raise errors.UncommittedChanges(tree)
3821
3639
 
3822
3640
        view_info = _get_view_info_for_change_reporter(tree)
3823
3641
        change_reporter = delta._ChangeReporter(
3824
3642
            unversioned_filter=tree.is_ignored, view_info=view_info)
3825
 
        pb = ui.ui_factory.nested_progress_bar()
3826
 
        self.add_cleanup(pb.finished)
3827
 
        self.add_cleanup(tree.lock_write().unlock)
3828
 
        if location is not None:
3829
 
            try:
3830
 
                mergeable = bundle.read_mergeable_from_url(location,
3831
 
                    possible_transports=possible_transports)
3832
 
            except errors.NotABundle:
3833
 
                mergeable = None
 
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.')
 
3685
                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)
3834
3699
            else:
3835
 
                if uncommitted:
3836
 
                    raise errors.BzrCommandError('Cannot use --uncommitted'
3837
 
                        ' with bundles or merge directives.')
3838
 
 
3839
 
                if revision is not None:
3840
 
                    raise errors.BzrCommandError(
3841
 
                        'Cannot use -r with merge directives or bundles')
3842
 
                merger, verified = _mod_merge.Merger.from_mergeable(tree,
3843
 
                   mergeable, None)
3844
 
 
3845
 
        if merger is None and uncommitted:
3846
 
            if revision is not None and len(revision) > 0:
3847
 
                raise errors.BzrCommandError('Cannot use --uncommitted and'
3848
 
                    ' --revision at the same time.')
3849
 
            merger = self.get_merger_from_uncommitted(tree, location, None)
3850
 
            allow_pending = False
3851
 
 
3852
 
        if merger is None:
3853
 
            merger, allow_pending = self._get_merger_from_branch(tree,
3854
 
                location, revision, remember, possible_transports, None)
3855
 
 
3856
 
        merger.merge_type = merge_type
3857
 
        merger.reprocess = reprocess
3858
 
        merger.show_base = show_base
3859
 
        self.sanity_check_merger(merger)
3860
 
        if (merger.base_rev_id == merger.other_rev_id and
3861
 
            merger.other_rev_id is not None):
3862
 
            note('Nothing to do.')
3863
 
            return 0
3864
 
        if pull:
3865
 
            if merger.interesting_files is not None:
3866
 
                raise errors.BzrCommandError('Cannot pull individual files')
3867
 
            if (merger.base_rev_id == tree.last_revision()):
3868
 
                result = tree.pull(merger.other_branch, False,
3869
 
                                   merger.other_rev_id)
3870
 
                result.report(self.outf)
3871
 
                return 0
3872
 
        if merger.this_basis is None:
3873
 
            raise errors.BzrCommandError(
3874
 
                "This branch has no commits."
3875
 
                " (perhaps you would prefer 'bzr pull')")
3876
 
        if preview:
3877
 
            return self._do_preview(merger)
3878
 
        elif interactive:
3879
 
            return self._do_interactive(merger)
3880
 
        else:
3881
 
            return self._do_merge(merger, change_reporter, allow_pending,
3882
 
                                  verified)
3883
 
 
3884
 
    def _get_preview(self, merger):
 
3700
                return self._do_merge(merger, change_reporter, allow_pending,
 
3701
                                      verified)
 
3702
        finally:
 
3703
            for cleanup in reversed(cleanups):
 
3704
                cleanup()
 
3705
 
 
3706
    def _get_preview(self, merger, cleanups):
3885
3707
        tree_merger = merger.make_merger()
3886
3708
        tt = tree_merger.make_preview_transform()
3887
 
        self.add_cleanup(tt.finalize)
 
3709
        cleanups.append(tt.finalize)
3888
3710
        result_tree = tt.get_preview_tree()
3889
3711
        return result_tree
3890
3712
 
3891
 
    def _do_preview(self, merger):
 
3713
    def _do_preview(self, merger, cleanups):
3892
3714
        from bzrlib.diff import show_diff_trees
3893
 
        result_tree = self._get_preview(merger)
3894
 
        path_encoding = osutils.get_diff_header_encoding()
 
3715
        result_tree = self._get_preview(merger, cleanups)
3895
3716
        show_diff_trees(merger.this_tree, result_tree, self.outf,
3896
 
                        old_label='', new_label='',
3897
 
                        path_encoding=path_encoding)
 
3717
                        old_label='', new_label='')
3898
3718
 
3899
3719
    def _do_merge(self, merger, change_reporter, allow_pending, verified):
3900
3720
        merger.change_reporter = change_reporter
3908
3728
        else:
3909
3729
            return 0
3910
3730
 
3911
 
    def _do_interactive(self, merger):
 
3731
    def _do_interactive(self, merger, cleanups):
3912
3732
        """Perform an interactive merge.
3913
3733
 
3914
3734
        This works by generating a preview tree of the merge, then using
3916
3736
        and the preview tree.
3917
3737
        """
3918
3738
        from bzrlib import shelf_ui
3919
 
        result_tree = self._get_preview(merger)
 
3739
        result_tree = self._get_preview(merger, cleanups)
3920
3740
        writer = bzrlib.option.diff_writer_registry.get()
3921
3741
        shelver = shelf_ui.Shelver(merger.this_tree, result_tree, destroy=True,
3922
3742
                                   reporter=shelf_ui.ApplyReporter(),
3923
3743
                                   diff_writer=writer(sys.stdout))
3924
 
        try:
3925
 
            shelver.run()
3926
 
        finally:
3927
 
            shelver.finalize()
 
3744
        shelver.run()
3928
3745
 
3929
3746
    def sanity_check_merger(self, merger):
3930
3747
        if (merger.show_base and
3990
3807
            allow_pending = True
3991
3808
        return merger, allow_pending
3992
3809
 
3993
 
    def get_merger_from_uncommitted(self, tree, location, pb):
 
3810
    def get_merger_from_uncommitted(self, tree, location, pb, cleanups):
3994
3811
        """Get a merger for uncommitted changes.
3995
3812
 
3996
3813
        :param tree: The tree the merger should apply to.
3997
3814
        :param location: The location containing uncommitted changes.
3998
3815
        :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.
3999
3818
        """
4000
3819
        location = self._select_branch_location(tree, location)[0]
4001
3820
        other_tree, other_path = WorkingTree.open_containing(location)
4053
3872
 
4054
3873
 
4055
3874
class cmd_remerge(Command):
4056
 
    __doc__ = """Redo a merge.
 
3875
    """Redo a merge.
4057
3876
 
4058
3877
    Use this if you want to try a different merge technique while resolving
4059
3878
    conflicts.  Some merge techniques are better than others, and remerge
4084
3903
 
4085
3904
    def run(self, file_list=None, merge_type=None, show_base=False,
4086
3905
            reprocess=False):
4087
 
        from bzrlib.conflicts import restore
4088
3906
        if merge_type is None:
4089
3907
            merge_type = _mod_merge.Merge3Merger
4090
3908
        tree, file_list = tree_files(file_list)
4091
 
        self.add_cleanup(tree.lock_write().unlock)
4092
 
        parents = tree.get_parent_ids()
4093
 
        if len(parents) != 2:
4094
 
            raise errors.BzrCommandError("Sorry, remerge only works after normal"
4095
 
                                         " merges.  Not cherrypicking or"
4096
 
                                         " multi-merges.")
4097
 
        repository = tree.branch.repository
4098
 
        interesting_ids = None
4099
 
        new_conflicts = []
4100
 
        conflicts = tree.conflicts()
4101
 
        if file_list is not None:
4102
 
            interesting_ids = set()
4103
 
            for filename in file_list:
4104
 
                file_id = tree.path2id(filename)
4105
 
                if file_id is None:
4106
 
                    raise errors.NotVersionedError(filename)
4107
 
                interesting_ids.add(file_id)
4108
 
                if tree.kind(file_id) != "directory":
4109
 
                    continue
 
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
4110
3929
 
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:
 
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])
4124
3954
            try:
4125
 
                restore(tree.abspath(filename))
4126
 
            except errors.NotConflicted:
4127
 
                pass
4128
 
        # Disable pending merges, because the file texts we are remerging
4129
 
        # have not had those merges performed.  If we use the wrong parents
4130
 
        # list, we imply that the working tree text has seen and rejected
4131
 
        # all the changes from the other tree, when in fact those changes
4132
 
        # have not yet been seen.
4133
 
        tree.set_parent_ids(parents[:1])
4134
 
        try:
4135
 
            merger = _mod_merge.Merger.from_revision_ids(None, tree, parents[1])
4136
 
            merger.interesting_ids = interesting_ids
4137
 
            merger.merge_type = merge_type
4138
 
            merger.show_base = show_base
4139
 
            merger.reprocess = reprocess
4140
 
            conflicts = merger.do_merge()
 
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()
4141
3965
        finally:
4142
 
            tree.set_parent_ids(parents)
 
3966
            tree.unlock()
4143
3967
        if conflicts > 0:
4144
3968
            return 1
4145
3969
        else:
4147
3971
 
4148
3972
 
4149
3973
class cmd_revert(Command):
4150
 
    __doc__ = """Revert files to a previous revision.
 
3974
    """Revert files to a previous revision.
4151
3975
 
4152
3976
    Giving a list of files will revert only those files.  Otherwise, all files
4153
3977
    will be reverted.  If the revision is not specified with '--revision', the
4167
3991
    name.  If you name a directory, all the contents of that directory will be
4168
3992
    reverted.
4169
3993
 
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.
 
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.
4174
3997
 
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
 
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
4182
4004
    reverting any files.
4183
 
 
4184
 
    Using "bzr revert --forget-merges", it is possible to apply all of the
4185
 
    changes from a branch in a single revision.  To do this, perform the merge
4186
 
    as desired.  Then doing revert with the "--forget-merges" option will keep
4187
 
    the content of the tree as it was, but it will clear the list of pending
4188
 
    merges.  The next commit will then contain all of the changes that are
4189
 
    present in the other branch, but without any other parent revisions.
4190
 
    Because this technique forgets where these changes originated, it may
4191
 
    cause additional conflicts on later merges involving the same source and
4192
 
    target branches.
4193
4005
    """
4194
4006
 
4195
4007
    _see_also = ['cat', 'export']
4204
4016
    def run(self, revision=None, no_backup=False, file_list=None,
4205
4017
            forget_merges=None):
4206
4018
        tree, file_list = tree_files(file_list)
4207
 
        self.add_cleanup(tree.lock_tree_write().unlock)
4208
 
        if forget_merges:
4209
 
            tree.set_parent_ids(tree.get_parent_ids()[:1])
4210
 
        else:
4211
 
            self._revert_tree_to_revision(tree, revision, file_list, no_backup)
 
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()
4212
4027
 
4213
4028
    @staticmethod
4214
4029
    def _revert_tree_to_revision(tree, revision, file_list, no_backup):
4215
4030
        rev_tree = _get_one_revision_tree('revert', revision, tree=tree)
4216
 
        tree.revert(file_list, rev_tree, not no_backup, None,
4217
 
            report_changes=True)
 
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()
4218
4037
 
4219
4038
 
4220
4039
class cmd_assert_fail(Command):
4221
 
    __doc__ = """Test reporting of assertion failures"""
 
4040
    """Test reporting of assertion failures"""
4222
4041
    # intended just for use in testing
4223
4042
 
4224
4043
    hidden = True
4228
4047
 
4229
4048
 
4230
4049
class cmd_help(Command):
4231
 
    __doc__ = """Show help on a command or other topic.
 
4050
    """Show help on a command or other topic.
4232
4051
    """
4233
4052
 
4234
4053
    _see_also = ['topics']
4247
4066
 
4248
4067
 
4249
4068
class cmd_shell_complete(Command):
4250
 
    __doc__ = """Show appropriate completions for context.
 
4069
    """Show appropriate completions for context.
4251
4070
 
4252
4071
    For a list of all available commands, say 'bzr shell-complete'.
4253
4072
    """
4262
4081
 
4263
4082
 
4264
4083
class cmd_missing(Command):
4265
 
    __doc__ = """Show unmerged/unpulled revisions between two branches.
 
4084
    """Show unmerged/unpulled revisions between two branches.
4266
4085
 
4267
4086
    OTHER_BRANCH may be local or remote.
4268
4087
 
4269
4088
    To filter on a range of revisions, you can use the command -r begin..end
4270
4089
    -r revision requests a specific revision, -r ..end or -r begin.. are
4271
4090
    also valid.
4272
 
            
4273
 
    :Exit values:
4274
 
        1 - some missing revisions
4275
 
        0 - no missing revisions
4276
4091
 
4277
4092
    :Examples:
4278
4093
 
4299
4114
    _see_also = ['merge', 'pull']
4300
4115
    takes_args = ['other_branch?']
4301
4116
    takes_options = [
4302
 
        'directory',
4303
4117
        Option('reverse', 'Reverse the order of revisions.'),
4304
4118
        Option('mine-only',
4305
4119
               'Display changes in the local branch only.'),
4327
4141
            theirs_only=False,
4328
4142
            log_format=None, long=False, short=False, line=False,
4329
4143
            show_ids=False, verbose=False, this=False, other=False,
4330
 
            include_merges=False, revision=None, my_revision=None,
4331
 
            directory=u'.'):
 
4144
            include_merges=False, revision=None, my_revision=None):
4332
4145
        from bzrlib.missing import find_unmerged, iter_log_revisions
4333
4146
        def message(s):
4334
4147
            if not is_quiet():
4347
4160
        elif theirs_only:
4348
4161
            restrict = 'remote'
4349
4162
 
4350
 
        local_branch = Branch.open_containing(directory)[0]
4351
 
        self.add_cleanup(local_branch.lock_read().unlock)
4352
 
 
 
4163
        local_branch = Branch.open_containing(u".")[0]
4353
4164
        parent = local_branch.get_parent()
4354
4165
        if other_branch is None:
4355
4166
            other_branch = parent
4364
4175
        remote_branch = Branch.open(other_branch)
4365
4176
        if remote_branch.base == local_branch.base:
4366
4177
            remote_branch = local_branch
4367
 
        else:
4368
 
            self.add_cleanup(remote_branch.lock_read().unlock)
4369
4178
 
4370
4179
        local_revid_range = _revision_range_to_revid_range(
4371
4180
            _get_revision_range(my_revision, local_branch,
4375
4184
            _get_revision_range(revision,
4376
4185
                remote_branch, self.name()))
4377
4186
 
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()
 
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()
4428
4244
        if not status_code and parent is None and other_branch is not None:
4429
 
            self.add_cleanup(local_branch.lock_write().unlock)
4430
 
            # handle race conditions - a parent might be set while we run.
4431
 
            if local_branch.get_parent() is None:
4432
 
                local_branch.set_parent(remote_branch.base)
 
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()
4433
4252
        return status_code
4434
4253
 
4435
4254
 
4436
4255
class cmd_pack(Command):
4437
 
    __doc__ = """Compress the data within a repository.
4438
 
 
4439
 
    This operation compresses the data within a bazaar repository. As
4440
 
    bazaar supports automatic packing of repository, this operation is
4441
 
    normally not required to be done manually.
4442
 
 
4443
 
    During the pack operation, bazaar takes a backup of existing repository
4444
 
    data, i.e. pack files. This backup is eventually removed by bazaar
4445
 
    automatically when it is safe to do so. To save disk space by removing
4446
 
    the backed up pack files, the --clean-obsolete-packs option may be
4447
 
    used.
4448
 
 
4449
 
    Warning: If you use --clean-obsolete-packs and your machine crashes
4450
 
    during or immediately after repacking, you may be left with a state
4451
 
    where the deletion has been written to disk but the new packs have not
4452
 
    been. In this case the repository may be unusable.
4453
 
    """
 
4256
    """Compress the data within a repository."""
4454
4257
 
4455
4258
    _see_also = ['repositories']
4456
4259
    takes_args = ['branch_or_repo?']
4457
 
    takes_options = [
4458
 
        Option('clean-obsolete-packs', 'Delete obsolete packs to save disk space.'),
4459
 
        ]
4460
4260
 
4461
 
    def run(self, branch_or_repo='.', clean_obsolete_packs=False):
 
4261
    def run(self, branch_or_repo='.'):
4462
4262
        dir = bzrdir.BzrDir.open_containing(branch_or_repo)[0]
4463
4263
        try:
4464
4264
            branch = dir.open_branch()
4465
4265
            repository = branch.repository
4466
4266
        except errors.NotBranchError:
4467
4267
            repository = dir.open_repository()
4468
 
        repository.pack(clean_obsolete_packs=clean_obsolete_packs)
 
4268
        repository.pack()
4469
4269
 
4470
4270
 
4471
4271
class cmd_plugins(Command):
4472
 
    __doc__ = """List the installed plugins.
 
4272
    """List the installed plugins.
4473
4273
 
4474
4274
    This command displays the list of installed plugins including
4475
4275
    version of plugin and a short description of each.
4482
4282
    adding new commands, providing additional network transports and
4483
4283
    customizing log output.
4484
4284
 
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.
 
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.
4489
4289
    """
4490
4290
    takes_options = ['verbose']
4491
4291
 
4506
4306
                doc = '(no description)'
4507
4307
            result.append((name_ver, doc, plugin.path()))
4508
4308
        for name_ver, doc, path in sorted(result):
4509
 
            self.outf.write("%s\n" % name_ver)
4510
 
            self.outf.write("   %s\n" % doc)
 
4309
            print name_ver
 
4310
            print '   ', doc
4511
4311
            if verbose:
4512
 
                self.outf.write("   %s\n" % path)
4513
 
            self.outf.write("\n")
 
4312
                print '   ', path
 
4313
            print
4514
4314
 
4515
4315
 
4516
4316
class cmd_testament(Command):
4517
 
    __doc__ = """Show testament (signing-form) of a revision."""
 
4317
    """Show testament (signing-form) of a revision."""
4518
4318
    takes_options = [
4519
4319
            'revision',
4520
4320
            Option('long', help='Produce long-format testament.'),
4532
4332
            b = Branch.open_containing(branch)[0]
4533
4333
        else:
4534
4334
            b = Branch.open(branch)
4535
 
        self.add_cleanup(b.lock_read().unlock)
4536
 
        if revision is None:
4537
 
            rev_id = b.last_revision()
4538
 
        else:
4539
 
            rev_id = revision[0].as_revision_id(b)
4540
 
        t = testament_class.from_revision(b.repository, rev_id)
4541
 
        if long:
4542
 
            sys.stdout.writelines(t.as_text_lines())
4543
 
        else:
4544
 
            sys.stdout.write(t.as_short_text())
 
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()
4545
4348
 
4546
4349
 
4547
4350
class cmd_annotate(Command):
4548
 
    __doc__ = """Show the origin of each line in a file.
 
4351
    """Show the origin of each line in a file.
4549
4352
 
4550
4353
    This prints out the given file with an annotation on the left side
4551
4354
    indicating which revision, author and date introduced the change.
4562
4365
                     Option('long', help='Show commit date in annotations.'),
4563
4366
                     'revision',
4564
4367
                     'show-ids',
4565
 
                     'directory',
4566
4368
                     ]
4567
4369
    encoding_type = 'exact'
4568
4370
 
4569
4371
    @display_command
4570
4372
    def run(self, filename, all=False, long=False, revision=None,
4571
 
            show_ids=False, directory=None):
 
4373
            show_ids=False):
4572
4374
        from bzrlib.annotate import annotate_file, annotate_file_tree
4573
4375
        wt, branch, relpath = \
4574
 
            _open_directory_or_containing_tree_or_branch(filename, directory)
4575
 
        if wt is not None:
4576
 
            self.add_cleanup(wt.lock_read().unlock)
4577
 
        else:
4578
 
            self.add_cleanup(branch.lock_read().unlock)
4579
 
        tree = _get_one_revision_tree('annotate', revision, branch=branch)
4580
 
        self.add_cleanup(tree.lock_read().unlock)
4581
 
        if wt is not None:
4582
 
            file_id = wt.path2id(relpath)
4583
 
        else:
4584
 
            file_id = tree.path2id(relpath)
4585
 
        if file_id is None:
4586
 
            raise errors.NotVersionedError(filename)
4587
 
        file_version = tree.inventory[file_id].revision
4588
 
        if wt is not None and revision is None:
4589
 
            # If there is a tree and we're not annotating historical
4590
 
            # versions, annotate the working tree's content.
4591
 
            annotate_file_tree(wt, file_id, self.outf, long, all,
4592
 
                show_ids=show_ids)
4593
 
        else:
4594
 
            annotate_file(branch, file_version, file_id, long, all, self.outf,
4595
 
                          show_ids=show_ids)
 
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()
4596
4403
 
4597
4404
 
4598
4405
class cmd_re_sign(Command):
4599
 
    __doc__ = """Create a digital signature for an existing revision."""
 
4406
    """Create a digital signature for an existing revision."""
4600
4407
    # TODO be able to replace existing ones.
4601
4408
 
4602
4409
    hidden = True # is this right ?
4603
4410
    takes_args = ['revision_id*']
4604
 
    takes_options = ['directory', 'revision']
 
4411
    takes_options = ['revision']
4605
4412
 
4606
 
    def run(self, revision_id_list=None, revision=None, directory=u'.'):
 
4413
    def run(self, revision_id_list=None, revision=None):
4607
4414
        if revision_id_list is not None and revision is not None:
4608
4415
            raise errors.BzrCommandError('You can only supply one of revision_id or --revision')
4609
4416
        if revision_id_list is None and revision is None:
4610
4417
            raise errors.BzrCommandError('You must supply either --revision or a revision_id')
4611
 
        b = WorkingTree.open_containing(directory)[0].branch
4612
 
        self.add_cleanup(b.lock_write().unlock)
4613
 
        return self._run(b, revision_id_list, revision)
 
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()
4614
4424
 
4615
4425
    def _run(self, b, revision_id_list, revision):
4616
4426
        import bzrlib.gpg as gpg
4661
4471
 
4662
4472
 
4663
4473
class cmd_bind(Command):
4664
 
    __doc__ = """Convert the current branch into a checkout of the supplied branch.
4665
 
    If no branch is supplied, rebind to the last bound location.
 
4474
    """Convert the current branch into a checkout of the supplied branch.
4666
4475
 
4667
4476
    Once converted into a checkout, commits must succeed on the master branch
4668
4477
    before they will be applied to the local branch.
4669
4478
 
4670
4479
    Bound branches use the nickname of its master branch unless it is set
4671
 
    locally, in which case binding will update the local nickname to be
 
4480
    locally, in which case binding will update the the local nickname to be
4672
4481
    that of the master.
4673
4482
    """
4674
4483
 
4675
4484
    _see_also = ['checkouts', 'unbind']
4676
4485
    takes_args = ['location?']
4677
 
    takes_options = ['directory']
 
4486
    takes_options = []
4678
4487
 
4679
 
    def run(self, location=None, directory=u'.'):
4680
 
        b, relpath = Branch.open_containing(directory)
 
4488
    def run(self, location=None):
 
4489
        b, relpath = Branch.open_containing(u'.')
4681
4490
        if location is None:
4682
4491
            try:
4683
4492
                location = b.get_old_bound_location()
4686
4495
                    'This format does not remember old locations.')
4687
4496
            else:
4688
4497
                if location is None:
4689
 
                    if b.get_bound_location() is not None:
4690
 
                        raise errors.BzrCommandError('Branch is already bound')
4691
 
                    else:
4692
 
                        raise errors.BzrCommandError('No location supplied '
4693
 
                            'and no previous location known')
 
4498
                    raise errors.BzrCommandError('No location supplied and no '
 
4499
                        'previous location known')
4694
4500
        b_other = Branch.open(location)
4695
4501
        try:
4696
4502
            b.bind(b_other)
4702
4508
 
4703
4509
 
4704
4510
class cmd_unbind(Command):
4705
 
    __doc__ = """Convert the current checkout into a regular branch.
 
4511
    """Convert the current checkout into a regular branch.
4706
4512
 
4707
4513
    After unbinding, the local branch is considered independent and subsequent
4708
4514
    commits will be local only.
4710
4516
 
4711
4517
    _see_also = ['checkouts', 'bind']
4712
4518
    takes_args = []
4713
 
    takes_options = ['directory']
 
4519
    takes_options = []
4714
4520
 
4715
 
    def run(self, directory=u'.'):
4716
 
        b, relpath = Branch.open_containing(directory)
 
4521
    def run(self):
 
4522
        b, relpath = Branch.open_containing(u'.')
4717
4523
        if not b.unbind():
4718
4524
            raise errors.BzrCommandError('Local branch is not bound')
4719
4525
 
4720
4526
 
4721
4527
class cmd_uncommit(Command):
4722
 
    __doc__ = """Remove the last committed revision.
 
4528
    """Remove the last committed revision.
4723
4529
 
4724
4530
    --verbose will print out what is being removed.
4725
4531
    --dry-run will go through all the motions, but not actually
4765
4571
            b = control.open_branch()
4766
4572
 
4767
4573
        if tree is not None:
4768
 
            self.add_cleanup(tree.lock_write().unlock)
 
4574
            tree.lock_write()
4769
4575
        else:
4770
 
            self.add_cleanup(b.lock_write().unlock)
4771
 
        return self._run(b, tree, dry_run, verbose, revision, force, local=local)
 
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()
4772
4585
 
4773
4586
    def _run(self, b, tree, dry_run, verbose, revision, force, local=False):
4774
4587
        from bzrlib.log import log_formatter, show_log
4806
4619
                 end_revision=last_revno)
4807
4620
 
4808
4621
        if dry_run:
4809
 
            self.outf.write('Dry-run, pretending to remove'
4810
 
                            ' the above revisions.\n')
 
4622
            print 'Dry-run, pretending to remove the above revisions.'
 
4623
            if not force:
 
4624
                val = raw_input('Press <enter> to continue')
4811
4625
        else:
4812
 
            self.outf.write('The above revision(s) will be removed.\n')
4813
 
 
4814
 
        if not force:
4815
 
            if not ui.ui_factory.get_boolean('Are you sure'):
4816
 
                self.outf.write('Canceled')
4817
 
                return 0
 
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
4818
4632
 
4819
4633
        mutter('Uncommitting from {%s} to {%s}',
4820
4634
               last_rev_id, rev_id)
4821
4635
        uncommit(b, tree=tree, dry_run=dry_run, verbose=verbose,
4822
4636
                 revno=revno, local=local)
4823
 
        self.outf.write('You can restore the old tip by running:\n'
4824
 
             '  bzr pull . -r revid:%s\n' % last_rev_id)
 
4637
        note('You can restore the old tip by running:\n'
 
4638
             '  bzr pull . -r revid:%s', last_rev_id)
4825
4639
 
4826
4640
 
4827
4641
class cmd_break_lock(Command):
4828
 
    __doc__ = """Break a dead lock on a repository, branch or working directory.
 
4642
    """Break a dead lock on a repository, branch or working directory.
4829
4643
 
4830
4644
    CAUTION: Locks should only be broken when you are sure that the process
4831
4645
    holding the lock has been stopped.
4832
4646
 
4833
 
    You can get information on what locks are open via the 'bzr info
4834
 
    [location]' command.
 
4647
    You can get information on what locks are open via the 'bzr info' command.
4835
4648
 
4836
4649
    :Examples:
4837
4650
        bzr break-lock
4838
 
        bzr break-lock bzr+ssh://example.com/bzr/foo
4839
4651
    """
4840
4652
    takes_args = ['location?']
4841
4653
 
4850
4662
 
4851
4663
 
4852
4664
class cmd_wait_until_signalled(Command):
4853
 
    __doc__ = """Test helper for test_start_and_stop_bzr_subprocess_send_signal.
 
4665
    """Test helper for test_start_and_stop_bzr_subprocess_send_signal.
4854
4666
 
4855
4667
    This just prints a line to signal when it is ready, then blocks on stdin.
4856
4668
    """
4864
4676
 
4865
4677
 
4866
4678
class cmd_serve(Command):
4867
 
    __doc__ = """Run the bzr server."""
 
4679
    """Run the bzr server."""
4868
4680
 
4869
4681
    aliases = ['server']
4870
4682
 
4871
4683
    takes_options = [
4872
4684
        Option('inet',
4873
4685
               help='Serve on stdin/out for use from inetd or sshd.'),
4874
 
        RegistryOption('protocol',
4875
 
               help="Protocol to serve.",
 
4686
        RegistryOption('protocol', 
 
4687
               help="Protocol to serve.", 
4876
4688
               lazy_registry=('bzrlib.transport', 'transport_server_registry'),
4877
4689
               value_switches=True),
4878
4690
        Option('port',
4881
4693
                    'result in a dynamically allocated port.  The default port '
4882
4694
                    'depends on the protocol.',
4883
4695
               type=str),
4884
 
        custom_help('directory',
4885
 
               help='Serve contents of this directory.'),
 
4696
        Option('directory',
 
4697
               help='Serve contents of this directory.',
 
4698
               type=unicode),
4886
4699
        Option('allow-writes',
4887
4700
               help='By default the server is a readonly server.  Supplying '
4888
4701
                    '--allow-writes enables write access to the contents of '
4889
 
                    'the served directory and below.  Note that ``bzr serve`` '
4890
 
                    'does not perform authentication, so unless some form of '
4891
 
                    'external authentication is arranged supplying this '
4892
 
                    'option leads to global uncontrolled write access to your '
4893
 
                    'file system.'
 
4702
                    'the served directory and below.'
4894
4703
                ),
4895
4704
        ]
4896
4705
 
4915
4724
 
4916
4725
    def run(self, port=None, inet=False, directory=None, allow_writes=False,
4917
4726
            protocol=None):
4918
 
        from bzrlib import transport
 
4727
        from bzrlib.transport import get_transport, transport_server_registry
4919
4728
        if directory is None:
4920
4729
            directory = os.getcwd()
4921
4730
        if protocol is None:
4922
 
            protocol = transport.transport_server_registry.get()
 
4731
            protocol = transport_server_registry.get()
4923
4732
        host, port = self.get_host_and_port(port)
4924
4733
        url = urlutils.local_path_to_url(directory)
4925
4734
        if not allow_writes:
4926
4735
            url = 'readonly+' + url
4927
 
        t = transport.get_transport(url)
4928
 
        protocol(t, host, port, inet)
 
4736
        transport = get_transport(url)
 
4737
        protocol(transport, host, port, inet)
4929
4738
 
4930
4739
 
4931
4740
class cmd_join(Command):
4932
 
    __doc__ = """Combine a tree into its containing tree.
 
4741
    """Combine a tree into its containing tree.
4933
4742
 
4934
4743
    This command requires the target tree to be in a rich-root format.
4935
4744
 
4975
4784
 
4976
4785
 
4977
4786
class cmd_split(Command):
4978
 
    __doc__ = """Split a subdirectory of a tree into a separate tree.
 
4787
    """Split a subdirectory of a tree into a separate tree.
4979
4788
 
4980
4789
    This command will produce a target tree in a format that supports
4981
4790
    rich roots, like 'rich-root' or 'rich-root-pack'.  These formats cannot be
5001
4810
 
5002
4811
 
5003
4812
class cmd_merge_directive(Command):
5004
 
    __doc__ = """Generate a merge directive for auto-merge tools.
 
4813
    """Generate a merge directive for auto-merge tools.
5005
4814
 
5006
4815
    A directive requests a merge to be performed, and also provides all the
5007
4816
    information necessary to do so.  This means it must either include a
5024
4833
    _see_also = ['send']
5025
4834
 
5026
4835
    takes_options = [
5027
 
        'directory',
5028
4836
        RegistryOption.from_kwargs('patch-type',
5029
4837
            'The type of patch to include in the directive.',
5030
4838
            title='Patch type',
5043
4851
    encoding_type = 'exact'
5044
4852
 
5045
4853
    def run(self, submit_branch=None, public_branch=None, patch_type='bundle',
5046
 
            sign=False, revision=None, mail_to=None, message=None,
5047
 
            directory=u'.'):
 
4854
            sign=False, revision=None, mail_to=None, message=None):
5048
4855
        from bzrlib.revision import ensure_null, NULL_REVISION
5049
4856
        include_patch, include_bundle = {
5050
4857
            'plain': (False, False),
5051
4858
            'diff': (True, False),
5052
4859
            'bundle': (True, True),
5053
4860
            }[patch_type]
5054
 
        branch = Branch.open(directory)
 
4861
        branch = Branch.open('.')
5055
4862
        stored_submit_branch = branch.get_submit_branch()
5056
4863
        if submit_branch is None:
5057
4864
            submit_branch = stored_submit_branch
5102
4909
 
5103
4910
 
5104
4911
class cmd_send(Command):
5105
 
    __doc__ = """Mail or create a merge-directive for submitting changes.
 
4912
    """Mail or create a merge-directive for submitting changes.
5106
4913
 
5107
4914
    A merge directive provides many things needed for requesting merges:
5108
4915
 
5114
4921
      directly from the merge directive, without retrieving data from a
5115
4922
      branch.
5116
4923
 
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.
 
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.
5143
4936
 
5144
4937
    Mail is sent using your preferred mail program.  This should be transparent
5145
 
    on Windows (it uses MAPI).  On Unix, it requires the xdg-email utility.
 
4938
    on Windows (it uses MAPI).  On Linux, it requires the xdg-email utility.
5146
4939
    If the preferred client can't be found (or used), your editor will be used.
5147
4940
 
5148
4941
    To use a specific mail program, set the mail_client configuration option.
5149
4942
    (For Thunderbird 1.5, this works around some bugs.)  Supported values for
5150
 
    specific clients are "claws", "evolution", "kmail", "mail.app" (MacOS X's
5151
 
    Mail.app), "mutt", and "thunderbird"; generic options are "default",
5152
 
    "editor", "emacsclient", "mapi", and "xdg-email".  Plugins may also add
5153
 
    supported clients.
 
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.
5154
4946
 
5155
4947
    If mail is being sent, a to address is required.  This can be supplied
5156
4948
    either on the commandline, by setting the submit_to configuration
5165
4957
 
5166
4958
    The merge directives created by bzr send may be applied using bzr merge or
5167
4959
    bzr pull by specifying a file containing a merge directive as the location.
5168
 
 
5169
 
    bzr send makes extensive use of public locations to map local locations into
5170
 
    URLs that can be used by other people.  See `bzr help configuration` to
5171
 
    set them, and use `bzr info` to display them.
5172
4960
    """
5173
4961
 
5174
4962
    encoding_type = 'exact'
5190
4978
               short_name='f',
5191
4979
               type=unicode),
5192
4980
        Option('output', short_name='o',
5193
 
               help='Write merge directive to this file or directory; '
 
4981
               help='Write merge directive to this file; '
5194
4982
                    'use - for stdout.',
5195
4983
               type=unicode),
5196
4984
        Option('strict',
5219
5007
 
5220
5008
 
5221
5009
class cmd_bundle_revisions(cmd_send):
5222
 
    __doc__ = """Create a merge-directive for submitting changes.
 
5010
    """Create a merge-directive for submitting changes.
5223
5011
 
5224
5012
    A merge directive provides many things needed for requesting merges:
5225
5013
 
5292
5080
 
5293
5081
 
5294
5082
class cmd_tag(Command):
5295
 
    __doc__ = """Create, remove or modify a tag naming a revision.
 
5083
    """Create, remove or modify a tag naming a revision.
5296
5084
 
5297
5085
    Tags give human-meaningful names to revisions.  Commands that take a -r
5298
5086
    (--revision) option can be given -rtag:X, where X is any previously
5306
5094
 
5307
5095
    To rename a tag (change the name but keep it on the same revsion), run ``bzr
5308
5096
    tag new-name -r tag:old-name`` and then ``bzr tag --delete oldname``.
5309
 
 
5310
 
    If no tag name is specified it will be determined through the 
5311
 
    'automatic_tag_name' hook. This can e.g. be used to automatically tag
5312
 
    upstream releases by reading configure.ac. See ``bzr help hooks`` for
5313
 
    details.
5314
5097
    """
5315
5098
 
5316
5099
    _see_also = ['commit', 'tags']
5317
 
    takes_args = ['tag_name?']
 
5100
    takes_args = ['tag_name']
5318
5101
    takes_options = [
5319
5102
        Option('delete',
5320
5103
            help='Delete this tag rather than placing it.',
5321
5104
            ),
5322
 
        custom_help('directory',
5323
 
            help='Branch in which to place the tag.'),
 
5105
        Option('directory',
 
5106
            help='Branch in which to place the tag.',
 
5107
            short_name='d',
 
5108
            type=unicode,
 
5109
            ),
5324
5110
        Option('force',
5325
5111
            help='Replace existing tags.',
5326
5112
            ),
5327
5113
        'revision',
5328
5114
        ]
5329
5115
 
5330
 
    def run(self, tag_name=None,
 
5116
    def run(self, tag_name,
5331
5117
            delete=None,
5332
5118
            directory='.',
5333
5119
            force=None,
5334
5120
            revision=None,
5335
5121
            ):
5336
5122
        branch, relpath = Branch.open_containing(directory)
5337
 
        self.add_cleanup(branch.lock_write().unlock)
5338
 
        if delete:
5339
 
            if tag_name is None:
5340
 
                raise errors.BzrCommandError("No tag specified to delete.")
5341
 
            branch.tags.delete_tag(tag_name)
5342
 
            self.outf.write('Deleted tag %s.\n' % tag_name)
5343
 
        else:
5344
 
            if revision:
5345
 
                if len(revision) != 1:
5346
 
                    raise errors.BzrCommandError(
5347
 
                        "Tags can only be placed on a single revision, "
5348
 
                        "not on a range")
5349
 
                revision_id = revision[0].as_revision_id(branch)
 
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)
5350
5128
            else:
5351
 
                revision_id = branch.last_revision()
5352
 
            if tag_name is None:
5353
 
                tag_name = branch.automatic_tag_name(revision_id)
5354
 
                if tag_name is None:
5355
 
                    raise errors.BzrCommandError(
5356
 
                        "Please specify a tag name.")
5357
 
            if (not force) and branch.tags.has_tag(tag_name):
5358
 
                raise errors.TagAlreadyExists(tag_name)
5359
 
            branch.tags.set_tag(tag_name, revision_id)
5360
 
            self.outf.write('Created tag %s.\n' % tag_name)
 
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()
5361
5143
 
5362
5144
 
5363
5145
class cmd_tags(Command):
5364
 
    __doc__ = """List tags.
 
5146
    """List tags.
5365
5147
 
5366
5148
    This command shows a table of tag names and the revisions they reference.
5367
5149
    """
5368
5150
 
5369
5151
    _see_also = ['tag']
5370
5152
    takes_options = [
5371
 
        custom_help('directory',
5372
 
            help='Branch whose tags should be displayed.'),
 
5153
        Option('directory',
 
5154
            help='Branch whose tags should be displayed.',
 
5155
            short_name='d',
 
5156
            type=unicode,
 
5157
            ),
5373
5158
        RegistryOption.from_kwargs('sort',
5374
5159
            'Sort tags by different criteria.', title='Sorting',
5375
5160
            alpha='Sort tags lexicographically (default).',
5392
5177
        if not tags:
5393
5178
            return
5394
5179
 
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()
 
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()
5429
5216
        for tag, revspec in tags:
5430
5217
            self.outf.write('%-20s %s\n' % (tag, revspec))
5431
5218
 
5432
5219
 
5433
5220
class cmd_reconfigure(Command):
5434
 
    __doc__ = """Reconfigure the type of a bzr directory.
 
5221
    """Reconfigure the type of a bzr directory.
5435
5222
 
5436
5223
    A target configuration must be specified.
5437
5224
 
5522
5309
 
5523
5310
 
5524
5311
class cmd_switch(Command):
5525
 
    __doc__ = """Set the branch of a checkout and update.
 
5312
    """Set the branch of a checkout and update.
5526
5313
 
5527
5314
    For lightweight checkouts, this changes the branch being referenced.
5528
5315
    For heavyweight checkouts, this checks that there are no local commits
5540
5327
    /path/to/newbranch.
5541
5328
 
5542
5329
    Bound branches use the nickname of its master branch unless it is set
5543
 
    locally, in which case switching will update the local nickname to be
 
5330
    locally, in which case switching will update the the local nickname to be
5544
5331
    that of the master.
5545
5332
    """
5546
5333
 
5547
 
    takes_args = ['to_location?']
5548
 
    takes_options = ['directory',
5549
 
                     Option('force',
 
5334
    takes_args = ['to_location']
 
5335
    takes_options = [Option('force',
5550
5336
                        help='Switch even if local commits will be lost.'),
5551
 
                     'revision',
5552
5337
                     Option('create-branch', short_name='b',
5553
5338
                        help='Create the target branch from this one before'
5554
5339
                             ' switching to it.'),
5555
 
                    ]
 
5340
                     ]
5556
5341
 
5557
 
    def run(self, to_location=None, force=False, create_branch=False,
5558
 
            revision=None, directory=u'.'):
 
5342
    def run(self, to_location, force=False, create_branch=False):
5559
5343
        from bzrlib import switch
5560
 
        tree_location = directory
5561
 
        revision = _get_one_revision('switch', revision)
 
5344
        tree_location = '.'
5562
5345
        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
5568
5346
        try:
5569
5347
            branch = control_dir.open_branch()
5570
5348
            had_explicit_nick = branch.get_config().has_explicit_nickname()
5575
5353
            if branch is None:
5576
5354
                raise errors.BzrCommandError('cannot create branch without'
5577
5355
                                             ' source branch')
5578
 
            to_location = directory_service.directories.dereference(
5579
 
                              to_location)
5580
5356
            if '/' not in to_location and '\\' not in to_location:
5581
5357
                # This path is meant to be relative to the existing branch
5582
5358
                this_url = self._get_branch_location(control_dir)
5584
5360
            to_branch = branch.bzrdir.sprout(to_location,
5585
5361
                                 possible_transports=[branch.bzrdir.root_transport],
5586
5362
                                 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
5587
5370
        else:
5588
5371
            try:
5589
5372
                to_branch = Branch.open(to_location)
5591
5374
                this_url = self._get_branch_location(control_dir)
5592
5375
                to_branch = Branch.open(
5593
5376
                    urlutils.join(this_url, '..', to_location))
5594
 
        if revision is not None:
5595
 
            revision = revision.as_revision_id(to_branch)
5596
 
        switch.switch(control_dir, to_branch, force, revision_id=revision)
 
5377
        switch.switch(control_dir, to_branch, force)
5597
5378
        if had_explicit_nick:
5598
5379
            branch = control_dir.open_branch() #get the new branch!
5599
5380
            branch.nick = to_branch.nick
5619
5400
 
5620
5401
 
5621
5402
class cmd_view(Command):
5622
 
    __doc__ = """Manage filtered views.
 
5403
    """Manage filtered views.
5623
5404
 
5624
5405
    Views provide a mask over the tree so that users can focus on
5625
5406
    a subset of a tree when doing their work. After creating a view,
5773
5554
 
5774
5555
 
5775
5556
class cmd_hooks(Command):
5776
 
    __doc__ = """Show hooks."""
 
5557
    """Show hooks."""
5777
5558
 
5778
5559
    hidden = True
5779
5560
 
5792
5573
                    self.outf.write("    <no hooks installed>\n")
5793
5574
 
5794
5575
 
5795
 
class cmd_remove_branch(Command):
5796
 
    __doc__ = """Remove a branch.
5797
 
 
5798
 
    This will remove the branch from the specified location but 
5799
 
    will keep any working tree or repository in place.
5800
 
 
5801
 
    :Examples:
5802
 
 
5803
 
      Remove the branch at repo/trunk::
5804
 
 
5805
 
        bzr remove-branch repo/trunk
5806
 
 
5807
 
    """
5808
 
 
5809
 
    takes_args = ["location?"]
5810
 
 
5811
 
    aliases = ["rmbranch"]
5812
 
 
5813
 
    def run(self, location=None):
5814
 
        if location is None:
5815
 
            location = "."
5816
 
        branch = Branch.open_containing(location)[0]
5817
 
        branch.bzrdir.destroy_branch()
5818
 
        
5819
 
 
5820
5576
class cmd_shelve(Command):
5821
 
    __doc__ = """Temporarily set aside some changes from the current tree.
 
5577
    """Temporarily set aside some changes from the current tree.
5822
5578
 
5823
5579
    Shelve allows you to temporarily put changes you've made "on the shelf",
5824
5580
    ie. out of the way, until a later time when you can bring them back from
5845
5601
    takes_args = ['file*']
5846
5602
 
5847
5603
    takes_options = [
5848
 
        'directory',
5849
5604
        'revision',
5850
5605
        Option('all', help='Shelve all changes.'),
5851
5606
        'message',
5860
5615
    _see_also = ['unshelve']
5861
5616
 
5862
5617
    def run(self, revision=None, all=False, file_list=None, message=None,
5863
 
            writer=None, list=False, destroy=False, directory=u'.'):
 
5618
            writer=None, list=False, destroy=False):
5864
5619
        if list:
5865
5620
            return self.run_for_list()
5866
5621
        from bzrlib.shelf_ui import Shelver
5867
5622
        if writer is None:
5868
5623
            writer = bzrlib.option.diff_writer_registry.get()
5869
5624
        try:
5870
 
            shelver = Shelver.from_args(writer(sys.stdout), revision, all,
5871
 
                file_list, message, destroy=destroy, directory=directory)
5872
 
            try:
5873
 
                shelver.run()
5874
 
            finally:
5875
 
                shelver.finalize()
 
5625
            Shelver.from_args(writer(sys.stdout), revision, all, file_list,
 
5626
                              message, destroy=destroy).run()
5876
5627
        except errors.UserAbort:
5877
5628
            return 0
5878
5629
 
5879
5630
    def run_for_list(self):
5880
5631
        tree = WorkingTree.open_containing('.')[0]
5881
 
        self.add_cleanup(tree.lock_read().unlock)
5882
 
        manager = tree.get_shelf_manager()
5883
 
        shelves = manager.active_shelves()
5884
 
        if len(shelves) == 0:
5885
 
            note('No shelved changes.')
5886
 
            return 0
5887
 
        for shelf_id in reversed(shelves):
5888
 
            message = manager.get_metadata(shelf_id).get('message')
5889
 
            if message is None:
5890
 
                message = '<no message>'
5891
 
            self.outf.write('%3d: %s\n' % (shelf_id, message))
5892
 
        return 1
 
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()
5893
5647
 
5894
5648
 
5895
5649
class cmd_unshelve(Command):
5896
 
    __doc__ = """Restore shelved changes.
 
5650
    """Restore shelved changes.
5897
5651
 
5898
5652
    By default, the most recently shelved changes are restored. However if you
5899
5653
    specify a shelf by id those changes will be restored instead.  This works
5902
5656
 
5903
5657
    takes_args = ['shelf_id?']
5904
5658
    takes_options = [
5905
 
        'directory',
5906
5659
        RegistryOption.from_kwargs(
5907
5660
            'action', help="The action to perform.",
5908
5661
            enum_switch=False, value_switches=True,
5909
5662
            apply="Apply changes and remove from the shelf.",
5910
5663
            dry_run="Show changes, but do not apply or remove them.",
5911
 
            preview="Instead of unshelving the changes, show the diff that "
5912
 
                    "would result from unshelving.",
5913
 
            delete_only="Delete changes without applying them.",
5914
 
            keep="Apply changes but don't delete them.",
 
5664
            delete_only="Delete changes without applying them."
5915
5665
        )
5916
5666
    ]
5917
5667
    _see_also = ['shelve']
5918
5668
 
5919
 
    def run(self, shelf_id=None, action='apply', directory=u'.'):
 
5669
    def run(self, shelf_id=None, action='apply'):
5920
5670
        from bzrlib.shelf_ui import Unshelver
5921
 
        unshelver = Unshelver.from_args(shelf_id, action, directory=directory)
5922
 
        try:
5923
 
            unshelver.run()
5924
 
        finally:
5925
 
            unshelver.tree.unlock()
 
5671
        Unshelver.from_args(shelf_id, action).run()
5926
5672
 
5927
5673
 
5928
5674
class cmd_clean_tree(Command):
5929
 
    __doc__ = """Remove unwanted files from working tree.
 
5675
    """Remove unwanted files from working tree.
5930
5676
 
5931
5677
    By default, only unknown files, not ignored files, are deleted.  Versioned
5932
5678
    files are never deleted.
5940
5686
 
5941
5687
    To check what clean-tree will do, use --dry-run.
5942
5688
    """
5943
 
    takes_options = ['directory',
5944
 
                     Option('ignored', help='Delete all ignored files.'),
 
5689
    takes_options = [Option('ignored', help='Delete all ignored files.'),
5945
5690
                     Option('detritus', help='Delete conflict files, merge'
5946
5691
                            ' backups, and failed selftest dirs.'),
5947
5692
                     Option('unknown',
5950
5695
                            ' deleting them.'),
5951
5696
                     Option('force', help='Do not prompt before deleting.')]
5952
5697
    def run(self, unknown=False, ignored=False, detritus=False, dry_run=False,
5953
 
            force=False, directory=u'.'):
 
5698
            force=False):
5954
5699
        from bzrlib.clean_tree import clean_tree
5955
5700
        if not (unknown or ignored or detritus):
5956
5701
            unknown = True
5957
5702
        if dry_run:
5958
5703
            force = True
5959
 
        clean_tree(directory, unknown=unknown, ignored=ignored,
5960
 
                   detritus=detritus, dry_run=dry_run, no_prompt=force)
 
5704
        clean_tree('.', unknown=unknown, ignored=ignored, detritus=detritus,
 
5705
                   dry_run=dry_run, no_prompt=force)
5961
5706
 
5962
5707
 
5963
5708
class cmd_reference(Command):
5964
 
    __doc__ = """list, view and set branch locations for nested trees.
 
5709
    """list, view and set branch locations for nested trees.
5965
5710
 
5966
5711
    If no arguments are provided, lists the branch locations for nested trees.
5967
5712
    If one argument is provided, display the branch location for that tree.
6007
5752
            self.outf.write('%s %s\n' % (path, location))
6008
5753
 
6009
5754
 
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)
 
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