/brz/remove-bazaar

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

« back to all changes in this revision

Viewing changes to bzrlib/builtins.py

  • Committer: Martin Pool
  • Date: 2009-06-19 09:06:56 UTC
  • mfrom: (4463 +trunk)
  • mto: This revision was merged to the branch mainline in revision 4464.
  • Revision ID: mbp@sourcefrog.net-20090619090656-d5weqeecyscv8kqp
merge news

Show diffs side-by-side

added added

removed removed

Lines of Context:
1
 
# Copyright (C) 2005-2010 Canonical Ltd
 
1
# Copyright (C) 2004, 2005, 2006, 2007, 2008, 2009 Canonical Ltd
2
2
#
3
3
# This program is free software; you can redistribute it and/or modify
4
4
# it under the terms of the GNU General Public License as published by
31
31
    bundle,
32
32
    btree_index,
33
33
    bzrdir,
34
 
    directory_service,
35
34
    delta,
36
35
    config,
37
36
    errors,
44
43
    reconfigure,
45
44
    rename_map,
46
45
    revision as _mod_revision,
47
 
    static_tuple,
48
46
    symbol_versioning,
49
 
    timestamp,
50
47
    transport,
 
48
    tree as _mod_tree,
51
49
    ui,
52
50
    urlutils,
53
51
    views,
54
52
    )
55
53
from bzrlib.branch import Branch
56
54
from bzrlib.conflicts import ConflictList
57
 
from bzrlib.transport import memory
58
55
from bzrlib.revisionspec import RevisionSpec, RevisionInfo
59
56
from bzrlib.smtp_connection import SMTPConnection
60
57
from bzrlib.workingtree import WorkingTree
61
58
""")
62
59
 
63
 
from bzrlib.commands import (
64
 
    Command,
65
 
    builtin_command_registry,
66
 
    display_command,
67
 
    )
 
60
from bzrlib.commands import Command, display_command
68
61
from bzrlib.option import (
69
62
    ListOption,
70
63
    Option,
128
121
 
129
122
 
130
123
def _get_one_revision_tree(command_name, revisions, branch=None, tree=None):
131
 
    """Get a revision tree. Not suitable for commands that change the tree.
132
 
    
133
 
    Specifically, the basis tree in dirstate trees is coupled to the dirstate
134
 
    and doing a commit/uncommit/pull will at best fail due to changing the
135
 
    basis revision data.
136
 
 
137
 
    If tree is passed in, it should be already locked, for lifetime management
138
 
    of the trees internal cached state.
139
 
    """
140
124
    if branch is None:
141
125
        branch = tree.branch
142
126
    if revisions is None:
232
216
    return view_info
233
217
 
234
218
 
235
 
def _open_directory_or_containing_tree_or_branch(filename, directory):
236
 
    """Open the tree or branch containing the specified file, unless
237
 
    the --directory option is used to specify a different branch."""
238
 
    if directory is not None:
239
 
        return (None, Branch.open(directory), filename)
240
 
    return bzrdir.BzrDir.open_containing_tree_or_branch(filename)
241
 
 
242
 
 
243
219
# TODO: Make sure no commands unconditionally use the working directory as a
244
220
# branch.  If a filename argument is used, the first of them should be used to
245
221
# specify the branch.  (Perhaps this can be factored out into some kind of
247
223
# opens the branch?)
248
224
 
249
225
class cmd_status(Command):
250
 
    __doc__ = """Display status summary.
 
226
    """Display status summary.
251
227
 
252
228
    This reports on versioned and unknown files, reporting them
253
229
    grouped by state.  Possible states are:
273
249
    unknown
274
250
        Not versioned and not matching an ignore pattern.
275
251
 
276
 
    Additionally for directories, symlinks and files with an executable
277
 
    bit, Bazaar indicates their type using a trailing character: '/', '@'
278
 
    or '*' respectively.
279
 
 
280
252
    To see ignored files use 'bzr ignored'.  For details on the
281
253
    changes to file texts, use 'bzr diff'.
282
254
 
340
312
 
341
313
 
342
314
class cmd_cat_revision(Command):
343
 
    __doc__ = """Write out metadata for a revision.
 
315
    """Write out metadata for a revision.
344
316
 
345
317
    The revision to print can either be specified by a specific
346
318
    revision identifier, or you can use --revision.
348
320
 
349
321
    hidden = True
350
322
    takes_args = ['revision_id?']
351
 
    takes_options = ['directory', 'revision']
 
323
    takes_options = ['revision']
352
324
    # cat-revision is more for frontends so should be exact
353
325
    encoding = 'strict'
354
326
 
355
 
    def print_revision(self, revisions, revid):
356
 
        stream = revisions.get_record_stream([(revid,)], 'unordered', True)
357
 
        record = stream.next()
358
 
        if record.storage_kind == 'absent':
359
 
            raise errors.NoSuchRevision(revisions, revid)
360
 
        revtext = record.get_bytes_as('fulltext')
361
 
        self.outf.write(revtext.decode('utf-8'))
362
 
 
363
327
    @display_command
364
 
    def run(self, revision_id=None, revision=None, directory=u'.'):
 
328
    def run(self, revision_id=None, revision=None):
365
329
        if revision_id is not None and revision is not None:
366
330
            raise errors.BzrCommandError('You can only supply one of'
367
331
                                         ' revision_id or --revision')
368
332
        if revision_id is None and revision is None:
369
333
            raise errors.BzrCommandError('You must supply either'
370
334
                                         ' --revision or a revision_id')
371
 
        b = WorkingTree.open_containing(directory)[0].branch
372
 
 
373
 
        revisions = b.repository.revisions
374
 
        if revisions is None:
375
 
            raise errors.BzrCommandError('Repository %r does not support '
376
 
                'access to raw revision texts')
377
 
 
378
 
        b.repository.lock_read()
379
 
        try:
380
 
            # TODO: jam 20060112 should cat-revision always output utf-8?
381
 
            if revision_id is not None:
382
 
                revision_id = osutils.safe_revision_id(revision_id, warn=False)
383
 
                try:
384
 
                    self.print_revision(revisions, revision_id)
385
 
                except errors.NoSuchRevision:
386
 
                    msg = "The repository %s contains no revision %s." % (
387
 
                        b.repository.base, revision_id)
388
 
                    raise errors.BzrCommandError(msg)
389
 
            elif revision is not None:
390
 
                for rev in revision:
391
 
                    if rev is None:
392
 
                        raise errors.BzrCommandError(
393
 
                            'You cannot specify a NULL revision.')
394
 
                    rev_id = rev.as_revision_id(b)
395
 
                    self.print_revision(revisions, rev_id)
396
 
        finally:
397
 
            b.repository.unlock()
398
 
        
 
335
        b = WorkingTree.open_containing(u'.')[0].branch
 
336
 
 
337
        # TODO: jam 20060112 should cat-revision always output utf-8?
 
338
        if revision_id is not None:
 
339
            revision_id = osutils.safe_revision_id(revision_id, warn=False)
 
340
            try:
 
341
                self.outf.write(b.repository.get_revision_xml(revision_id).decode('utf-8'))
 
342
            except errors.NoSuchRevision:
 
343
                msg = "The repository %s contains no revision %s." % (b.repository.base,
 
344
                    revision_id)
 
345
                raise errors.BzrCommandError(msg)
 
346
        elif revision is not None:
 
347
            for rev in revision:
 
348
                if rev is None:
 
349
                    raise errors.BzrCommandError('You cannot specify a NULL'
 
350
                                                 ' revision.')
 
351
                rev_id = rev.as_revision_id(b)
 
352
                self.outf.write(b.repository.get_revision_xml(rev_id).decode('utf-8'))
 
353
 
399
354
 
400
355
class cmd_dump_btree(Command):
401
 
    __doc__ = """Dump the contents of a btree index file to stdout.
 
356
    """Dump the contents of a btree index file to stdout.
402
357
 
403
358
    PATH is a btree index file, it can be any URL. This includes things like
404
359
    .bzr/repository/pack-names, or .bzr/repository/indices/a34b3a...ca4a4.iix
468
423
        for node in bt.iter_all_entries():
469
424
            # Node is made up of:
470
425
            # (index, key, value, [references])
471
 
            try:
472
 
                refs = node[3]
473
 
            except IndexError:
474
 
                refs_as_tuples = None
475
 
            else:
476
 
                refs_as_tuples = static_tuple.as_tuples(refs)
477
 
            as_tuple = (tuple(node[1]), node[2], refs_as_tuples)
478
 
            self.outf.write('%s\n' % (as_tuple,))
 
426
            self.outf.write('%s\n' % (node[1:],))
479
427
 
480
428
 
481
429
class cmd_remove_tree(Command):
482
 
    __doc__ = """Remove the working tree from a given branch/checkout.
 
430
    """Remove the working tree from a given branch/checkout.
483
431
 
484
432
    Since a lightweight checkout is little more than a working tree
485
433
    this will refuse to run against one.
487
435
    To re-create the working tree, use "bzr checkout".
488
436
    """
489
437
    _see_also = ['checkout', 'working-trees']
490
 
    takes_args = ['location*']
 
438
    takes_args = ['location?']
491
439
    takes_options = [
492
440
        Option('force',
493
441
               help='Remove the working tree even if it has '
494
442
                    'uncommitted changes.'),
495
443
        ]
496
444
 
497
 
    def run(self, location_list, force=False):
498
 
        if not location_list:
499
 
            location_list=['.']
500
 
 
501
 
        for location in location_list:
502
 
            d = bzrdir.BzrDir.open(location)
503
 
            
504
 
            try:
505
 
                working = d.open_workingtree()
506
 
            except errors.NoWorkingTree:
507
 
                raise errors.BzrCommandError("No working tree to remove")
508
 
            except errors.NotLocalUrl:
509
 
                raise errors.BzrCommandError("You cannot remove the working tree"
510
 
                                             " of a remote path")
511
 
            if not force:
512
 
                if (working.has_changes()):
513
 
                    raise errors.UncommittedChanges(working)
514
 
 
515
 
            if working.user_url != working.branch.user_url:
516
 
                raise errors.BzrCommandError("You cannot remove the working tree"
517
 
                                             " from a lightweight checkout")
518
 
 
519
 
            d.destroy_workingtree()
 
445
    def run(self, location='.', force=False):
 
446
        d = bzrdir.BzrDir.open(location)
 
447
 
 
448
        try:
 
449
            working = d.open_workingtree()
 
450
        except errors.NoWorkingTree:
 
451
            raise errors.BzrCommandError("No working tree to remove")
 
452
        except errors.NotLocalUrl:
 
453
            raise errors.BzrCommandError("You cannot remove the working tree of a "
 
454
                                         "remote path")
 
455
        if not force:
 
456
            changes = working.changes_from(working.basis_tree())
 
457
            if changes.has_changed():
 
458
                raise errors.UncommittedChanges(working)
 
459
 
 
460
        working_path = working.bzrdir.root_transport.base
 
461
        branch_path = working.branch.bzrdir.root_transport.base
 
462
        if working_path != branch_path:
 
463
            raise errors.BzrCommandError("You cannot remove the working tree from "
 
464
                                         "a lightweight checkout")
 
465
 
 
466
        d.destroy_workingtree()
520
467
 
521
468
 
522
469
class cmd_revno(Command):
523
 
    __doc__ = """Show current revision number.
 
470
    """Show current revision number.
524
471
 
525
472
    This is equal to the number of revisions on this branch.
526
473
    """
527
474
 
528
475
    _see_also = ['info']
529
476
    takes_args = ['location?']
530
 
    takes_options = [
531
 
        Option('tree', help='Show revno of working tree'),
532
 
        ]
533
477
 
534
478
    @display_command
535
 
    def run(self, tree=False, location=u'.'):
536
 
        if tree:
537
 
            try:
538
 
                wt = WorkingTree.open_containing(location)[0]
539
 
                self.add_cleanup(wt.lock_read().unlock)
540
 
            except (errors.NoWorkingTree, errors.NotLocalUrl):
541
 
                raise errors.NoWorkingTree(location)
542
 
            revid = wt.last_revision()
543
 
            try:
544
 
                revno_t = wt.branch.revision_id_to_dotted_revno(revid)
545
 
            except errors.NoSuchRevision:
546
 
                revno_t = ('???',)
547
 
            revno = ".".join(str(n) for n in revno_t)
548
 
        else:
549
 
            b = Branch.open_containing(location)[0]
550
 
            self.add_cleanup(b.lock_read().unlock)
551
 
            revno = b.revno()
552
 
        self.cleanup_now()
553
 
        self.outf.write(str(revno) + '\n')
 
479
    def run(self, location=u'.'):
 
480
        self.outf.write(str(Branch.open_containing(location)[0].revno()))
 
481
        self.outf.write('\n')
554
482
 
555
483
 
556
484
class cmd_revision_info(Command):
557
 
    __doc__ = """Show revision number and revision id for a given revision identifier.
 
485
    """Show revision number and revision id for a given revision identifier.
558
486
    """
559
487
    hidden = True
560
488
    takes_args = ['revision_info*']
561
489
    takes_options = [
562
490
        'revision',
563
 
        custom_help('directory',
 
491
        Option('directory',
564
492
            help='Branch to examine, '
565
 
                 'rather than the one containing the working directory.'),
566
 
        Option('tree', help='Show revno of working tree'),
 
493
                 'rather than the one containing the working directory.',
 
494
            short_name='d',
 
495
            type=unicode,
 
496
            ),
567
497
        ]
568
498
 
569
499
    @display_command
570
 
    def run(self, revision=None, directory=u'.', tree=False,
571
 
            revision_info_list=[]):
 
500
    def run(self, revision=None, directory=u'.', revision_info_list=[]):
572
501
 
573
 
        try:
574
 
            wt = WorkingTree.open_containing(directory)[0]
575
 
            b = wt.branch
576
 
            self.add_cleanup(wt.lock_read().unlock)
577
 
        except (errors.NoWorkingTree, errors.NotLocalUrl):
578
 
            wt = None
579
 
            b = Branch.open_containing(directory)[0]
580
 
            self.add_cleanup(b.lock_read().unlock)
581
 
        revision_ids = []
 
502
        revs = []
582
503
        if revision is not None:
583
 
            revision_ids.extend(rev.as_revision_id(b) for rev in revision)
 
504
            revs.extend(revision)
584
505
        if revision_info_list is not None:
585
 
            for rev_str in revision_info_list:
586
 
                rev_spec = RevisionSpec.from_string(rev_str)
587
 
                revision_ids.append(rev_spec.as_revision_id(b))
588
 
        # No arguments supplied, default to the last revision
589
 
        if len(revision_ids) == 0:
590
 
            if tree:
591
 
                if wt is None:
592
 
                    raise errors.NoWorkingTree(directory)
593
 
                revision_ids.append(wt.last_revision())
594
 
            else:
595
 
                revision_ids.append(b.last_revision())
596
 
 
597
 
        revinfos = []
598
 
        maxlen = 0
599
 
        for revision_id in revision_ids:
 
506
            for rev in revision_info_list:
 
507
                revs.append(RevisionSpec.from_string(rev))
 
508
 
 
509
        b = Branch.open_containing(directory)[0]
 
510
 
 
511
        if len(revs) == 0:
 
512
            revs.append(RevisionSpec.from_string('-1'))
 
513
 
 
514
        for rev in revs:
 
515
            revision_id = rev.as_revision_id(b)
600
516
            try:
601
 
                dotted_revno = b.revision_id_to_dotted_revno(revision_id)
602
 
                revno = '.'.join(str(i) for i in dotted_revno)
 
517
                revno = '%4d' % (b.revision_id_to_revno(revision_id))
603
518
            except errors.NoSuchRevision:
604
 
                revno = '???'
605
 
            maxlen = max(maxlen, len(revno))
606
 
            revinfos.append([revno, revision_id])
607
 
 
608
 
        self.cleanup_now()
609
 
        for ri in revinfos:
610
 
            self.outf.write('%*s %s\n' % (maxlen, ri[0], ri[1]))
 
519
                dotted_map = b.get_revision_id_to_revno_map()
 
520
                revno = '.'.join(str(i) for i in dotted_map[revision_id])
 
521
            print '%s %s' % (revno, revision_id)
611
522
 
612
523
 
613
524
class cmd_add(Command):
614
 
    __doc__ = """Add specified files or directories.
 
525
    """Add specified files or directories.
615
526
 
616
527
    In non-recursive mode, all the named items are added, regardless
617
528
    of whether they were previously ignored.  A warning is given if
643
554
    branches that will be merged later (without showing the two different
644
555
    adds as a conflict). It is also useful when merging another project
645
556
    into a subdirectory of this one.
646
 
    
647
 
    Any files matching patterns in the ignore list will not be added
648
 
    unless they are explicitly mentioned.
649
557
    """
650
558
    takes_args = ['file*']
651
559
    takes_options = [
659
567
               help='Lookup file ids from this tree.'),
660
568
        ]
661
569
    encoding_type = 'replace'
662
 
    _see_also = ['remove', 'ignore']
 
570
    _see_also = ['remove']
663
571
 
664
572
    def run(self, file_list, no_recurse=False, dry_run=False, verbose=False,
665
573
            file_ids_from=None):
682
590
                should_print=(not is_quiet()))
683
591
 
684
592
        if base_tree:
685
 
            self.add_cleanup(base_tree.lock_read().unlock)
686
 
        tree, file_list = tree_files_for_add(file_list)
687
 
        added, ignored = tree.smart_add(file_list, not
688
 
            no_recurse, action=action, save=not dry_run)
689
 
        self.cleanup_now()
 
593
            base_tree.lock_read()
 
594
        try:
 
595
            file_list = self._maybe_expand_globs(file_list)
 
596
            tree, file_list = tree_files_for_add(file_list)
 
597
            added, ignored = tree.smart_add(file_list, not
 
598
                no_recurse, action=action, save=not dry_run)
 
599
        finally:
 
600
            if base_tree is not None:
 
601
                base_tree.unlock()
690
602
        if len(ignored) > 0:
691
603
            if verbose:
692
604
                for glob in sorted(ignored.keys()):
693
605
                    for path in ignored[glob]:
694
606
                        self.outf.write("ignored %s matching \"%s\"\n"
695
607
                                        % (path, glob))
 
608
            else:
 
609
                match_len = 0
 
610
                for glob, paths in ignored.items():
 
611
                    match_len += len(paths)
 
612
                self.outf.write("ignored %d file(s).\n" % match_len)
 
613
            self.outf.write("If you wish to add ignored files, "
 
614
                            "please add them explicitly by name. "
 
615
                            "(\"bzr ignored\" gives a list)\n")
696
616
 
697
617
 
698
618
class cmd_mkdir(Command):
699
 
    __doc__ = """Create a new versioned directory.
 
619
    """Create a new versioned directory.
700
620
 
701
621
    This is equivalent to creating the directory and then adding it.
702
622
    """
706
626
 
707
627
    def run(self, dir_list):
708
628
        for d in dir_list:
 
629
            os.mkdir(d)
709
630
            wt, dd = WorkingTree.open_containing(d)
710
 
            base = os.path.dirname(dd)
711
 
            id = wt.path2id(base)
712
 
            if id != None:
713
 
                os.mkdir(d)
714
 
                wt.add([dd])
715
 
                self.outf.write('added %s\n' % d)
716
 
            else:
717
 
                raise errors.NotVersionedError(path=base)
 
631
            wt.add([dd])
 
632
            self.outf.write('added %s\n' % d)
718
633
 
719
634
 
720
635
class cmd_relpath(Command):
721
 
    __doc__ = """Show path of a file relative to root"""
 
636
    """Show path of a file relative to root"""
722
637
 
723
638
    takes_args = ['filename']
724
639
    hidden = True
733
648
 
734
649
 
735
650
class cmd_inventory(Command):
736
 
    __doc__ = """Show inventory of the current working copy or a revision.
 
651
    """Show inventory of the current working copy or a revision.
737
652
 
738
653
    It is possible to limit the output to a particular entry
739
654
    type using the --kind option.  For example: --kind file.
760
675
 
761
676
        revision = _get_one_revision('inventory', revision)
762
677
        work_tree, file_list = tree_files(file_list)
763
 
        self.add_cleanup(work_tree.lock_read().unlock)
764
 
        if revision is not None:
765
 
            tree = revision.as_tree(work_tree.branch)
766
 
 
767
 
            extra_trees = [work_tree]
768
 
            self.add_cleanup(tree.lock_read().unlock)
769
 
        else:
770
 
            tree = work_tree
771
 
            extra_trees = []
772
 
 
773
 
        if file_list is not None:
774
 
            file_ids = tree.paths2ids(file_list, trees=extra_trees,
775
 
                                      require_versioned=True)
776
 
            # find_ids_across_trees may include some paths that don't
777
 
            # exist in 'tree'.
778
 
            entries = sorted((tree.id2path(file_id), tree.inventory[file_id])
779
 
                             for file_id in file_ids if file_id in tree)
780
 
        else:
781
 
            entries = tree.inventory.entries()
782
 
 
783
 
        self.cleanup_now()
 
678
        work_tree.lock_read()
 
679
        try:
 
680
            if revision is not None:
 
681
                tree = revision.as_tree(work_tree.branch)
 
682
 
 
683
                extra_trees = [work_tree]
 
684
                tree.lock_read()
 
685
            else:
 
686
                tree = work_tree
 
687
                extra_trees = []
 
688
 
 
689
            if file_list is not None:
 
690
                file_ids = tree.paths2ids(file_list, trees=extra_trees,
 
691
                                          require_versioned=True)
 
692
                # find_ids_across_trees may include some paths that don't
 
693
                # exist in 'tree'.
 
694
                entries = sorted((tree.id2path(file_id), tree.inventory[file_id])
 
695
                                 for file_id in file_ids if file_id in tree)
 
696
            else:
 
697
                entries = tree.inventory.entries()
 
698
        finally:
 
699
            tree.unlock()
 
700
            if tree is not work_tree:
 
701
                work_tree.unlock()
 
702
 
784
703
        for path, entry in entries:
785
704
            if kind and kind != entry.kind:
786
705
                continue
792
711
 
793
712
 
794
713
class cmd_mv(Command):
795
 
    __doc__ = """Move or rename a file.
 
714
    """Move or rename a file.
796
715
 
797
716
    :Usage:
798
717
        bzr mv OLDNAME NEWNAME
831
750
        if len(names_list) < 2:
832
751
            raise errors.BzrCommandError("missing file argument")
833
752
        tree, rel_names = tree_files(names_list, canonicalize=False)
834
 
        self.add_cleanup(tree.lock_tree_write().unlock)
835
 
        self._run(tree, names_list, rel_names, after)
 
753
        tree.lock_write()
 
754
        try:
 
755
            self._run(tree, names_list, rel_names, after)
 
756
        finally:
 
757
            tree.unlock()
836
758
 
837
759
    def run_auto(self, names_list, after, dry_run):
838
760
        if names_list is not None and len(names_list) > 1:
842
764
            raise errors.BzrCommandError('--after cannot be specified with'
843
765
                                         ' --auto.')
844
766
        work_tree, file_list = tree_files(names_list, default_branch='.')
845
 
        self.add_cleanup(work_tree.lock_tree_write().unlock)
846
 
        rename_map.RenameMap.guess_renames(work_tree, dry_run)
 
767
        work_tree.lock_write()
 
768
        try:
 
769
            rename_map.RenameMap.guess_renames(work_tree, dry_run)
 
770
        finally:
 
771
            work_tree.unlock()
847
772
 
848
773
    def _run(self, tree, names_list, rel_names, after):
849
774
        into_existing = osutils.isdir(names_list[-1])
870
795
            # All entries reference existing inventory items, so fix them up
871
796
            # for cicp file-systems.
872
797
            rel_names = tree.get_canonical_inventory_paths(rel_names)
873
 
            for src, dest in tree.move(rel_names[:-1], rel_names[-1], after=after):
874
 
                if not is_quiet():
875
 
                    self.outf.write("%s => %s\n" % (src, dest))
 
798
            for pair in tree.move(rel_names[:-1], rel_names[-1], after=after):
 
799
                self.outf.write("%s => %s\n" % pair)
876
800
        else:
877
801
            if len(names_list) != 2:
878
802
                raise errors.BzrCommandError('to mv multiple files the'
922
846
            dest = osutils.pathjoin(dest_parent, dest_tail)
923
847
            mutter("attempting to move %s => %s", src, dest)
924
848
            tree.rename_one(src, dest, after=after)
925
 
            if not is_quiet():
926
 
                self.outf.write("%s => %s\n" % (src, dest))
 
849
            self.outf.write("%s => %s\n" % (src, dest))
927
850
 
928
851
 
929
852
class cmd_pull(Command):
930
 
    __doc__ = """Turn this branch into a mirror of another branch.
 
853
    """Turn this branch into a mirror of another branch.
931
854
 
932
 
    By default, this command only works on branches that have not diverged.
933
 
    Branches are considered diverged if the destination branch's most recent 
934
 
    commit is one that has not been merged (directly or indirectly) into the 
935
 
    parent.
 
855
    This command only works on branches that have not diverged.  Branches are
 
856
    considered diverged if the destination branch's most recent commit is one
 
857
    that has not been merged (directly or indirectly) into the parent.
936
858
 
937
859
    If branches have diverged, you can use 'bzr merge' to integrate the changes
938
860
    from one into the other.  Once one branch has merged, the other should
939
861
    be able to pull it again.
940
862
 
941
 
    If you want to replace your local changes and just want your branch to
942
 
    match the remote one, use pull --overwrite. This will work even if the two
943
 
    branches have diverged.
 
863
    If you want to forget your local changes and just update your branch to
 
864
    match the remote one, use pull --overwrite.
944
865
 
945
866
    If there is no default location set, the first pull will set it.  After
946
867
    that, you can omit the location to use the default.  To change the
956
877
    takes_options = ['remember', 'overwrite', 'revision',
957
878
        custom_help('verbose',
958
879
            help='Show logs of pulled revisions.'),
959
 
        custom_help('directory',
 
880
        Option('directory',
960
881
            help='Branch to pull into, '
961
 
                 'rather than the one containing the working directory.'),
 
882
                 'rather than the one containing the working directory.',
 
883
            short_name='d',
 
884
            type=unicode,
 
885
            ),
962
886
        Option('local',
963
887
            help="Perform a local pull in a bound "
964
888
                 "branch.  Local pulls are not applied to "
979
903
        try:
980
904
            tree_to = WorkingTree.open_containing(directory)[0]
981
905
            branch_to = tree_to.branch
982
 
            self.add_cleanup(tree_to.lock_write().unlock)
983
906
        except errors.NoWorkingTree:
984
907
            tree_to = None
985
908
            branch_to = Branch.open_containing(directory)[0]
986
 
            self.add_cleanup(branch_to.lock_write().unlock)
987
 
 
 
909
        
988
910
        if local and not branch_to.get_bound_location():
989
911
            raise errors.LocalRequiresBoundBranch()
990
912
 
1020
942
        else:
1021
943
            branch_from = Branch.open(location,
1022
944
                possible_transports=possible_transports)
1023
 
            self.add_cleanup(branch_from.lock_read().unlock)
1024
945
 
1025
946
            if branch_to.get_parent() is None or remember:
1026
947
                branch_to.set_parent(branch_from.base)
1027
948
 
1028
 
        if revision is not None:
1029
 
            revision_id = revision.as_revision_id(branch_from)
1030
 
 
1031
 
        if tree_to is not None:
1032
 
            view_info = _get_view_info_for_change_reporter(tree_to)
1033
 
            change_reporter = delta._ChangeReporter(
1034
 
                unversioned_filter=tree_to.is_ignored,
1035
 
                view_info=view_info)
1036
 
            result = tree_to.pull(
1037
 
                branch_from, overwrite, revision_id, change_reporter,
1038
 
                possible_transports=possible_transports, local=local)
1039
 
        else:
1040
 
            result = branch_to.pull(
1041
 
                branch_from, overwrite, revision_id, local=local)
1042
 
 
1043
 
        result.report(self.outf)
1044
 
        if verbose and result.old_revid != result.new_revid:
1045
 
            log.show_branch_change(
1046
 
                branch_to, self.outf, result.old_revno,
1047
 
                result.old_revid)
 
949
        if branch_from is not branch_to:
 
950
            branch_from.lock_read()
 
951
        try:
 
952
            if revision is not None:
 
953
                revision_id = revision.as_revision_id(branch_from)
 
954
 
 
955
            branch_to.lock_write()
 
956
            try:
 
957
                if tree_to is not None:
 
958
                    view_info = _get_view_info_for_change_reporter(tree_to)
 
959
                    change_reporter = delta._ChangeReporter(
 
960
                        unversioned_filter=tree_to.is_ignored,
 
961
                        view_info=view_info)
 
962
                    result = tree_to.pull(
 
963
                        branch_from, overwrite, revision_id, change_reporter,
 
964
                        possible_transports=possible_transports, local=local)
 
965
                else:
 
966
                    result = branch_to.pull(
 
967
                        branch_from, overwrite, revision_id, local=local)
 
968
 
 
969
                result.report(self.outf)
 
970
                if verbose and result.old_revid != result.new_revid:
 
971
                    log.show_branch_change(
 
972
                        branch_to, self.outf, result.old_revno,
 
973
                        result.old_revid)
 
974
            finally:
 
975
                branch_to.unlock()
 
976
        finally:
 
977
            if branch_from is not branch_to:
 
978
                branch_from.unlock()
1048
979
 
1049
980
 
1050
981
class cmd_push(Command):
1051
 
    __doc__ = """Update a mirror of this branch.
 
982
    """Update a mirror of this branch.
1052
983
 
1053
984
    The target branch will not have its working tree populated because this
1054
985
    is both expensive, and is not supported on remote file systems.
1078
1009
        Option('create-prefix',
1079
1010
               help='Create the path leading up to the branch '
1080
1011
                    'if it does not already exist.'),
1081
 
        custom_help('directory',
 
1012
        Option('directory',
1082
1013
            help='Branch to push from, '
1083
 
                 'rather than the one containing the working directory.'),
 
1014
                 'rather than the one containing the working directory.',
 
1015
            short_name='d',
 
1016
            type=unicode,
 
1017
            ),
1084
1018
        Option('use-existing-dir',
1085
1019
               help='By default push will fail if the target'
1086
1020
                    ' directory exists, but does not already'
1096
1030
            type=unicode),
1097
1031
        Option('strict',
1098
1032
               help='Refuse to push if there are uncommitted changes in'
1099
 
               ' the working tree, --no-strict disables the check.'),
 
1033
               ' the working tree.'),
1100
1034
        ]
1101
1035
    takes_args = ['location?']
1102
1036
    encoding_type = 'replace'
1110
1044
        if directory is None:
1111
1045
            directory = '.'
1112
1046
        # Get the source branch
1113
 
        (tree, br_from,
1114
 
         _unused) = bzrdir.BzrDir.open_containing_tree_or_branch(directory)
 
1047
        tree, br_from = bzrdir.BzrDir.open_tree_or_branch(directory)
 
1048
        if strict is None:
 
1049
            strict = br_from.get_config().get_user_option('push_strict')
 
1050
            if strict is not None:
 
1051
                # FIXME: This should be better supported by config
 
1052
                # -- vila 20090611
 
1053
                bools = dict(yes=True, no=False, on=True, off=False,
 
1054
                             true=True, false=False)
 
1055
                try:
 
1056
                    strict = bools[strict.lower()]
 
1057
                except KeyError:
 
1058
                    strict = None
 
1059
        if strict:
 
1060
            changes = tree.changes_from(tree.basis_tree())
 
1061
            if changes.has_changed():
 
1062
                raise errors.UncommittedChanges(tree)
1115
1063
        # Get the tip's revision_id
1116
1064
        revision = _get_one_revision('push', revision)
1117
1065
        if revision is not None:
1118
1066
            revision_id = revision.in_history(br_from).rev_id
1119
1067
        else:
1120
1068
            revision_id = None
1121
 
        if tree is not None and revision_id is None:
1122
 
            tree.check_changed_or_out_of_date(
1123
 
                strict, 'push_strict',
1124
 
                more_error='Use --no-strict to force the push.',
1125
 
                more_warning='Uncommitted changes will not be pushed.')
 
1069
 
1126
1070
        # Get the stacked_on branch, if any
1127
1071
        if stacked_on is not None:
1128
1072
            stacked_on = urlutils.normalize_url(stacked_on)
1160
1104
 
1161
1105
 
1162
1106
class cmd_branch(Command):
1163
 
    __doc__ = """Create a new branch that is a copy of an existing branch.
 
1107
    """Create a new branch that is a copy of an existing branch.
1164
1108
 
1165
1109
    If the TO_LOCATION is omitted, the last component of the FROM_LOCATION will
1166
1110
    be used.  In other words, "branch ../foo/bar" will attempt to create ./bar.
1179
1123
        help='Hard-link working tree files where possible.'),
1180
1124
        Option('no-tree',
1181
1125
            help="Create a branch without a working-tree."),
1182
 
        Option('switch',
1183
 
            help="Switch the checkout in the current directory "
1184
 
                 "to the new branch."),
1185
1126
        Option('stacked',
1186
1127
            help='Create a stacked branch referring to the source branch. '
1187
1128
                'The new branch will depend on the availability of the source '
1188
1129
                'branch for all operations.'),
1189
1130
        Option('standalone',
1190
1131
               help='Do not use a shared repository, even if available.'),
1191
 
        Option('use-existing-dir',
1192
 
               help='By default branch will fail if the target'
1193
 
                    ' directory exists, but does not already'
1194
 
                    ' have a control directory.  This flag will'
1195
 
                    ' allow branch to proceed.'),
1196
 
        Option('bind',
1197
 
            help="Bind new branch to from location."),
1198
1132
        ]
1199
1133
    aliases = ['get', 'clone']
1200
1134
 
1201
1135
    def run(self, from_location, to_location=None, revision=None,
1202
 
            hardlink=False, stacked=False, standalone=False, no_tree=False,
1203
 
            use_existing_dir=False, switch=False, bind=False):
1204
 
        from bzrlib import switch as _mod_switch
 
1136
            hardlink=False, stacked=False, standalone=False, no_tree=False):
1205
1137
        from bzrlib.tag import _merge_tags_if_possible
 
1138
 
1206
1139
        accelerator_tree, br_from = bzrdir.BzrDir.open_tree_or_branch(
1207
1140
            from_location)
 
1141
        if (accelerator_tree is not None and
 
1142
            accelerator_tree.supports_content_filtering()):
 
1143
            accelerator_tree = None
1208
1144
        revision = _get_one_revision('branch', revision)
1209
 
        self.add_cleanup(br_from.lock_read().unlock)
1210
 
        if revision is not None:
1211
 
            revision_id = revision.as_revision_id(br_from)
1212
 
        else:
1213
 
            # FIXME - wt.last_revision, fallback to branch, fall back to
1214
 
            # None or perhaps NULL_REVISION to mean copy nothing
1215
 
            # RBC 20060209
1216
 
            revision_id = br_from.last_revision()
1217
 
        if to_location is None:
1218
 
            to_location = urlutils.derive_to_location(from_location)
1219
 
        to_transport = transport.get_transport(to_location)
 
1145
        br_from.lock_read()
1220
1146
        try:
1221
 
            to_transport.mkdir('.')
1222
 
        except errors.FileExists:
1223
 
            if not use_existing_dir:
1224
 
                raise errors.BzrCommandError('Target directory "%s" '
1225
 
                    'already exists.' % to_location)
 
1147
            if revision is not None:
 
1148
                revision_id = revision.as_revision_id(br_from)
1226
1149
            else:
1227
 
                try:
1228
 
                    bzrdir.BzrDir.open_from_transport(to_transport)
1229
 
                except errors.NotBranchError:
1230
 
                    pass
1231
 
                else:
1232
 
                    raise errors.AlreadyBranchError(to_location)
1233
 
        except errors.NoSuchFile:
1234
 
            raise errors.BzrCommandError('Parent of "%s" does not exist.'
1235
 
                                         % to_location)
1236
 
        try:
1237
 
            # preserve whatever source format we have.
1238
 
            dir = br_from.bzrdir.sprout(to_transport.base, revision_id,
1239
 
                                        possible_transports=[to_transport],
1240
 
                                        accelerator_tree=accelerator_tree,
1241
 
                                        hardlink=hardlink, stacked=stacked,
1242
 
                                        force_new_repo=standalone,
1243
 
                                        create_tree_if_local=not no_tree,
1244
 
                                        source_branch=br_from)
1245
 
            branch = dir.open_branch()
1246
 
        except errors.NoSuchRevision:
1247
 
            to_transport.delete_tree('.')
1248
 
            msg = "The branch %s has no revision %s." % (from_location,
1249
 
                revision)
1250
 
            raise errors.BzrCommandError(msg)
1251
 
        _merge_tags_if_possible(br_from, branch)
1252
 
        # If the source branch is stacked, the new branch may
1253
 
        # be stacked whether we asked for that explicitly or not.
1254
 
        # We therefore need a try/except here and not just 'if stacked:'
1255
 
        try:
1256
 
            note('Created new stacked branch referring to %s.' %
1257
 
                branch.get_stacked_on_url())
1258
 
        except (errors.NotStacked, errors.UnstackableBranchFormat,
1259
 
            errors.UnstackableRepositoryFormat), e:
1260
 
            note('Branched %d revision(s).' % branch.revno())
1261
 
        if bind:
1262
 
            # Bind to the parent
1263
 
            parent_branch = Branch.open(from_location)
1264
 
            branch.bind(parent_branch)
1265
 
            note('New branch bound to %s' % from_location)
1266
 
        if switch:
1267
 
            # Switch to the new branch
1268
 
            wt, _ = WorkingTree.open_containing('.')
1269
 
            _mod_switch.switch(wt.bzrdir, branch)
1270
 
            note('Switched to branch: %s',
1271
 
                urlutils.unescape_for_display(branch.base, 'utf-8'))
 
1150
                # FIXME - wt.last_revision, fallback to branch, fall back to
 
1151
                # None or perhaps NULL_REVISION to mean copy nothing
 
1152
                # RBC 20060209
 
1153
                revision_id = br_from.last_revision()
 
1154
            if to_location is None:
 
1155
                to_location = urlutils.derive_to_location(from_location)
 
1156
            to_transport = transport.get_transport(to_location)
 
1157
            try:
 
1158
                to_transport.mkdir('.')
 
1159
            except errors.FileExists:
 
1160
                raise errors.BzrCommandError('Target directory "%s" already'
 
1161
                                             ' exists.' % to_location)
 
1162
            except errors.NoSuchFile:
 
1163
                raise errors.BzrCommandError('Parent of "%s" does not exist.'
 
1164
                                             % to_location)
 
1165
            try:
 
1166
                # preserve whatever source format we have.
 
1167
                dir = br_from.bzrdir.sprout(to_transport.base, revision_id,
 
1168
                                            possible_transports=[to_transport],
 
1169
                                            accelerator_tree=accelerator_tree,
 
1170
                                            hardlink=hardlink, stacked=stacked,
 
1171
                                            force_new_repo=standalone,
 
1172
                                            create_tree_if_local=not no_tree,
 
1173
                                            source_branch=br_from)
 
1174
                branch = dir.open_branch()
 
1175
            except errors.NoSuchRevision:
 
1176
                to_transport.delete_tree('.')
 
1177
                msg = "The branch %s has no revision %s." % (from_location,
 
1178
                    revision)
 
1179
                raise errors.BzrCommandError(msg)
 
1180
            _merge_tags_if_possible(br_from, branch)
 
1181
            # If the source branch is stacked, the new branch may
 
1182
            # be stacked whether we asked for that explicitly or not.
 
1183
            # We therefore need a try/except here and not just 'if stacked:'
 
1184
            try:
 
1185
                note('Created new stacked branch referring to %s.' %
 
1186
                    branch.get_stacked_on_url())
 
1187
            except (errors.NotStacked, errors.UnstackableBranchFormat,
 
1188
                errors.UnstackableRepositoryFormat), e:
 
1189
                note('Branched %d revision(s).' % branch.revno())
 
1190
        finally:
 
1191
            br_from.unlock()
1272
1192
 
1273
1193
 
1274
1194
class cmd_checkout(Command):
1275
 
    __doc__ = """Create a new checkout of an existing branch.
 
1195
    """Create a new checkout of an existing branch.
1276
1196
 
1277
1197
    If BRANCH_LOCATION is omitted, checkout will reconstitute a working tree for
1278
1198
    the branch found in '.'. This is useful if you have removed the working tree
1341
1261
 
1342
1262
 
1343
1263
class cmd_renames(Command):
1344
 
    __doc__ = """Show list of renamed files.
 
1264
    """Show list of renamed files.
1345
1265
    """
1346
1266
    # TODO: Option to show renames between two historical versions.
1347
1267
 
1352
1272
    @display_command
1353
1273
    def run(self, dir=u'.'):
1354
1274
        tree = WorkingTree.open_containing(dir)[0]
1355
 
        self.add_cleanup(tree.lock_read().unlock)
1356
 
        new_inv = tree.inventory
1357
 
        old_tree = tree.basis_tree()
1358
 
        self.add_cleanup(old_tree.lock_read().unlock)
1359
 
        old_inv = old_tree.inventory
1360
 
        renames = []
1361
 
        iterator = tree.iter_changes(old_tree, include_unchanged=True)
1362
 
        for f, paths, c, v, p, n, k, e in iterator:
1363
 
            if paths[0] == paths[1]:
1364
 
                continue
1365
 
            if None in (paths):
1366
 
                continue
1367
 
            renames.append(paths)
1368
 
        renames.sort()
1369
 
        for old_name, new_name in renames:
1370
 
            self.outf.write("%s => %s\n" % (old_name, new_name))
 
1275
        tree.lock_read()
 
1276
        try:
 
1277
            new_inv = tree.inventory
 
1278
            old_tree = tree.basis_tree()
 
1279
            old_tree.lock_read()
 
1280
            try:
 
1281
                old_inv = old_tree.inventory
 
1282
                renames = []
 
1283
                iterator = tree.iter_changes(old_tree, include_unchanged=True)
 
1284
                for f, paths, c, v, p, n, k, e in iterator:
 
1285
                    if paths[0] == paths[1]:
 
1286
                        continue
 
1287
                    if None in (paths):
 
1288
                        continue
 
1289
                    renames.append(paths)
 
1290
                renames.sort()
 
1291
                for old_name, new_name in renames:
 
1292
                    self.outf.write("%s => %s\n" % (old_name, new_name))
 
1293
            finally:
 
1294
                old_tree.unlock()
 
1295
        finally:
 
1296
            tree.unlock()
1371
1297
 
1372
1298
 
1373
1299
class cmd_update(Command):
1374
 
    __doc__ = """Update a tree to have the latest code committed to its branch.
 
1300
    """Update a tree to have the latest code committed to its branch.
1375
1301
 
1376
1302
    This will perform a merge into the working tree, and may generate
1377
1303
    conflicts. If you have any local changes, you will still
1379
1305
 
1380
1306
    If you want to discard your local changes, you can just do a
1381
1307
    'bzr revert' instead of 'bzr commit' after the update.
1382
 
 
1383
 
    If the tree's branch is bound to a master branch, it will also update
1384
 
    the branch from the master.
1385
1308
    """
1386
1309
 
1387
1310
    _see_also = ['pull', 'working-trees', 'status-flags']
1388
1311
    takes_args = ['dir?']
1389
 
    takes_options = ['revision']
1390
1312
    aliases = ['up']
1391
1313
 
1392
 
    def run(self, dir='.', revision=None):
1393
 
        if revision is not None and len(revision) != 1:
1394
 
            raise errors.BzrCommandError(
1395
 
                        "bzr update --revision takes exactly one revision")
 
1314
    def run(self, dir='.'):
1396
1315
        tree = WorkingTree.open_containing(dir)[0]
1397
 
        branch = tree.branch
1398
1316
        possible_transports = []
1399
 
        master = branch.get_master_branch(
 
1317
        master = tree.branch.get_master_branch(
1400
1318
            possible_transports=possible_transports)
1401
1319
        if master is not None:
1402
 
            branch_location = master.base
1403
1320
            tree.lock_write()
1404
1321
        else:
1405
 
            branch_location = tree.branch.base
1406
1322
            tree.lock_tree_write()
1407
 
        self.add_cleanup(tree.unlock)
1408
 
        # get rid of the final '/' and be ready for display
1409
 
        branch_location = urlutils.unescape_for_display(
1410
 
            branch_location.rstrip('/'),
1411
 
            self.outf.encoding)
1412
 
        existing_pending_merges = tree.get_parent_ids()[1:]
1413
 
        if master is None:
1414
 
            old_tip = None
1415
 
        else:
1416
 
            # may need to fetch data into a heavyweight checkout
1417
 
            # XXX: this may take some time, maybe we should display a
1418
 
            # message
1419
 
            old_tip = branch.update(possible_transports)
1420
 
        if revision is not None:
1421
 
            revision_id = revision[0].as_revision_id(branch)
1422
 
        else:
1423
 
            revision_id = branch.last_revision()
1424
 
        if revision_id == _mod_revision.ensure_null(tree.last_revision()):
1425
 
            revno = branch.revision_id_to_dotted_revno(revision_id)
1426
 
            note("Tree is up to date at revision %s of branch %s" %
1427
 
                ('.'.join(map(str, revno)), branch_location))
1428
 
            return 0
1429
 
        view_info = _get_view_info_for_change_reporter(tree)
1430
 
        change_reporter = delta._ChangeReporter(
1431
 
            unversioned_filter=tree.is_ignored,
1432
 
            view_info=view_info)
1433
1323
        try:
 
1324
            existing_pending_merges = tree.get_parent_ids()[1:]
 
1325
            last_rev = _mod_revision.ensure_null(tree.last_revision())
 
1326
            if last_rev == _mod_revision.ensure_null(
 
1327
                tree.branch.last_revision()):
 
1328
                # may be up to date, check master too.
 
1329
                if master is None or last_rev == _mod_revision.ensure_null(
 
1330
                    master.last_revision()):
 
1331
                    revno = tree.branch.revision_id_to_revno(last_rev)
 
1332
                    note("Tree is up to date at revision %d." % (revno,))
 
1333
                    return 0
 
1334
            view_info = _get_view_info_for_change_reporter(tree)
1434
1335
            conflicts = tree.update(
1435
 
                change_reporter,
1436
 
                possible_transports=possible_transports,
1437
 
                revision=revision_id,
1438
 
                old_tip=old_tip)
1439
 
        except errors.NoSuchRevision, e:
1440
 
            raise errors.BzrCommandError(
1441
 
                                  "branch has no revision %s\n"
1442
 
                                  "bzr update --revision only works"
1443
 
                                  " for a revision in the branch history"
1444
 
                                  % (e.revision))
1445
 
        revno = tree.branch.revision_id_to_dotted_revno(
1446
 
            _mod_revision.ensure_null(tree.last_revision()))
1447
 
        note('Updated to revision %s of branch %s' %
1448
 
             ('.'.join(map(str, revno)), branch_location))
1449
 
        parent_ids = tree.get_parent_ids()
1450
 
        if parent_ids[1:] and parent_ids[1:] != existing_pending_merges:
1451
 
            note('Your local commits will now show as pending merges with '
1452
 
                 "'bzr status', and can be committed with 'bzr commit'.")
1453
 
        if conflicts != 0:
1454
 
            return 1
1455
 
        else:
1456
 
            return 0
 
1336
                delta._ChangeReporter(unversioned_filter=tree.is_ignored,
 
1337
                view_info=view_info), possible_transports=possible_transports)
 
1338
            revno = tree.branch.revision_id_to_revno(
 
1339
                _mod_revision.ensure_null(tree.last_revision()))
 
1340
            note('Updated to revision %d.' % (revno,))
 
1341
            if tree.get_parent_ids()[1:] != existing_pending_merges:
 
1342
                note('Your local commits will now show as pending merges with '
 
1343
                     "'bzr status', and can be committed with 'bzr commit'.")
 
1344
            if conflicts != 0:
 
1345
                return 1
 
1346
            else:
 
1347
                return 0
 
1348
        finally:
 
1349
            tree.unlock()
1457
1350
 
1458
1351
 
1459
1352
class cmd_info(Command):
1460
 
    __doc__ = """Show information about a working tree, branch or repository.
 
1353
    """Show information about a working tree, branch or repository.
1461
1354
 
1462
1355
    This command will show all known locations and formats associated to the
1463
1356
    tree, branch or repository.
1501
1394
 
1502
1395
 
1503
1396
class cmd_remove(Command):
1504
 
    __doc__ = """Remove files or directories.
 
1397
    """Remove files or directories.
1505
1398
 
1506
1399
    This makes bzr stop tracking changes to the specified files. bzr will delete
1507
1400
    them if they can easily be recovered using revert. If no options or
1516
1409
            title='Deletion Strategy', value_switches=True, enum_switch=False,
1517
1410
            safe='Only delete files if they can be'
1518
1411
                 ' safely recovered (default).',
1519
 
            keep='Delete from bzr but leave the working copy.',
 
1412
            keep="Don't delete any files.",
1520
1413
            force='Delete all the specified files, even if they can not be '
1521
1414
                'recovered and even if they are non-empty directories.')]
1522
1415
    aliases = ['rm', 'del']
1529
1422
        if file_list is not None:
1530
1423
            file_list = [f for f in file_list]
1531
1424
 
1532
 
        self.add_cleanup(tree.lock_write().unlock)
1533
 
        # Heuristics should probably all move into tree.remove_smart or
1534
 
        # some such?
1535
 
        if new:
1536
 
            added = tree.changes_from(tree.basis_tree(),
1537
 
                specific_files=file_list).added
1538
 
            file_list = sorted([f[0] for f in added], reverse=True)
1539
 
            if len(file_list) == 0:
1540
 
                raise errors.BzrCommandError('No matching files.')
1541
 
        elif file_list is None:
1542
 
            # missing files show up in iter_changes(basis) as
1543
 
            # versioned-with-no-kind.
1544
 
            missing = []
1545
 
            for change in tree.iter_changes(tree.basis_tree()):
1546
 
                # Find paths in the working tree that have no kind:
1547
 
                if change[1][1] is not None and change[6][1] is None:
1548
 
                    missing.append(change[1][1])
1549
 
            file_list = sorted(missing, reverse=True)
1550
 
            file_deletion_strategy = 'keep'
1551
 
        tree.remove(file_list, verbose=verbose, to_file=self.outf,
1552
 
            keep_files=file_deletion_strategy=='keep',
1553
 
            force=file_deletion_strategy=='force')
 
1425
        tree.lock_write()
 
1426
        try:
 
1427
            # Heuristics should probably all move into tree.remove_smart or
 
1428
            # some such?
 
1429
            if new:
 
1430
                added = tree.changes_from(tree.basis_tree(),
 
1431
                    specific_files=file_list).added
 
1432
                file_list = sorted([f[0] for f in added], reverse=True)
 
1433
                if len(file_list) == 0:
 
1434
                    raise errors.BzrCommandError('No matching files.')
 
1435
            elif file_list is None:
 
1436
                # missing files show up in iter_changes(basis) as
 
1437
                # versioned-with-no-kind.
 
1438
                missing = []
 
1439
                for change in tree.iter_changes(tree.basis_tree()):
 
1440
                    # Find paths in the working tree that have no kind:
 
1441
                    if change[1][1] is not None and change[6][1] is None:
 
1442
                        missing.append(change[1][1])
 
1443
                file_list = sorted(missing, reverse=True)
 
1444
                file_deletion_strategy = 'keep'
 
1445
            tree.remove(file_list, verbose=verbose, to_file=self.outf,
 
1446
                keep_files=file_deletion_strategy=='keep',
 
1447
                force=file_deletion_strategy=='force')
 
1448
        finally:
 
1449
            tree.unlock()
1554
1450
 
1555
1451
 
1556
1452
class cmd_file_id(Command):
1557
 
    __doc__ = """Print file_id of a particular file or directory.
 
1453
    """Print file_id of a particular file or directory.
1558
1454
 
1559
1455
    The file_id is assigned when the file is first added and remains the
1560
1456
    same through all revisions where the file exists, even when it is
1576
1472
 
1577
1473
 
1578
1474
class cmd_file_path(Command):
1579
 
    __doc__ = """Print path of file_ids to a file or directory.
 
1475
    """Print path of file_ids to a file or directory.
1580
1476
 
1581
1477
    This prints one line for each directory down to the target,
1582
1478
    starting at the branch root.
1598
1494
 
1599
1495
 
1600
1496
class cmd_reconcile(Command):
1601
 
    __doc__ = """Reconcile bzr metadata in a branch.
 
1497
    """Reconcile bzr metadata in a branch.
1602
1498
 
1603
1499
    This can correct data mismatches that may have been caused by
1604
1500
    previous ghost operations or bzr upgrades. You should only
1626
1522
 
1627
1523
 
1628
1524
class cmd_revision_history(Command):
1629
 
    __doc__ = """Display the list of revision ids on a branch."""
 
1525
    """Display the list of revision ids on a branch."""
1630
1526
 
1631
1527
    _see_also = ['log']
1632
1528
    takes_args = ['location?']
1642
1538
 
1643
1539
 
1644
1540
class cmd_ancestry(Command):
1645
 
    __doc__ = """List all revisions merged into this branch."""
 
1541
    """List all revisions merged into this branch."""
1646
1542
 
1647
1543
    _see_also = ['log', 'revision-history']
1648
1544
    takes_args = ['location?']
1667
1563
 
1668
1564
 
1669
1565
class cmd_init(Command):
1670
 
    __doc__ = """Make a directory into a versioned branch.
 
1566
    """Make a directory into a versioned branch.
1671
1567
 
1672
1568
    Use this to create an empty branch, or before importing an
1673
1569
    existing project.
1701
1597
                lazy_registry=('bzrlib.bzrdir', 'format_registry'),
1702
1598
                converter=lambda name: bzrdir.format_registry.make_bzrdir(name),
1703
1599
                value_switches=True,
1704
 
                title="Branch format",
 
1600
                title="Branch Format",
1705
1601
                ),
1706
1602
         Option('append-revisions-only',
1707
1603
                help='Never change revnos or the existing log.'
1776
1672
 
1777
1673
 
1778
1674
class cmd_init_repository(Command):
1779
 
    __doc__ = """Create a shared repository for branches to share storage space.
 
1675
    """Create a shared repository to hold branches.
1780
1676
 
1781
1677
    New branches created under the repository directory will store their
1782
 
    revisions in the repository, not in the branch directory.  For branches
1783
 
    with shared history, this reduces the amount of storage needed and 
1784
 
    speeds up the creation of new branches.
 
1678
    revisions in the repository, not in the branch directory.
1785
1679
 
1786
 
    If the --no-trees option is given then the branches in the repository
1787
 
    will not have working trees by default.  They will still exist as 
1788
 
    directories on disk, but they will not have separate copies of the 
1789
 
    files at a certain revision.  This can be useful for repositories that
1790
 
    store branches which are interacted with through checkouts or remote
1791
 
    branches, such as on a server.
 
1680
    If the --no-trees option is used then the branches in the repository
 
1681
    will not have working trees by default.
1792
1682
 
1793
1683
    :Examples:
1794
 
        Create a shared repository holding just branches::
 
1684
        Create a shared repositories holding just branches::
1795
1685
 
1796
1686
            bzr init-repo --no-trees repo
1797
1687
            bzr init repo/trunk
1836
1726
 
1837
1727
 
1838
1728
class cmd_diff(Command):
1839
 
    __doc__ = """Show differences in the working tree, between revisions or branches.
 
1729
    """Show differences in the working tree, between revisions or branches.
1840
1730
 
1841
1731
    If no arguments are given, all changes for the current tree are listed.
1842
1732
    If files are given, only the changes in those files are listed.
1863
1753
 
1864
1754
            bzr diff -r1
1865
1755
 
1866
 
        Difference between revision 3 and revision 1::
1867
 
 
1868
 
            bzr diff -r1..3
1869
 
 
1870
 
        Difference between revision 3 and revision 1 for branch xxx::
1871
 
 
1872
 
            bzr diff -r1..3 xxx
1873
 
 
1874
 
        To see the changes introduced in revision X::
1875
 
        
1876
 
            bzr diff -cX
1877
 
 
1878
 
        Note that in the case of a merge, the -c option shows the changes
1879
 
        compared to the left hand parent. To see the changes against
1880
 
        another parent, use::
1881
 
 
1882
 
            bzr diff -r<chosen_parent>..X
1883
 
 
1884
 
        The changes introduced by revision 2 (equivalent to -r1..2)::
1885
 
 
1886
 
            bzr diff -c2
 
1756
        Difference between revision 2 and revision 1::
 
1757
 
 
1758
            bzr diff -r1..2
 
1759
 
 
1760
        Difference between revision 2 and revision 1 for branch xxx::
 
1761
 
 
1762
            bzr diff -r1..2 xxx
1887
1763
 
1888
1764
        Show just the differences for file NEWS::
1889
1765
 
1928
1804
            help='Use this command to compare files.',
1929
1805
            type=unicode,
1930
1806
            ),
1931
 
        RegistryOption('format',
1932
 
            help='Diff format to use.',
1933
 
            lazy_registry=('bzrlib.diff', 'format_registry'),
1934
 
            value_switches=False, title='Diff format'),
1935
1807
        ]
1936
1808
    aliases = ['di', 'dif']
1937
1809
    encoding_type = 'exact'
1938
1810
 
1939
1811
    @display_command
1940
1812
    def run(self, revision=None, file_list=None, diff_options=None,
1941
 
            prefix=None, old=None, new=None, using=None, format=None):
1942
 
        from bzrlib.diff import (get_trees_and_branches_to_diff_locked,
1943
 
            show_diff_trees)
 
1813
            prefix=None, old=None, new=None, using=None):
 
1814
        from bzrlib.diff import _get_trees_to_diff, show_diff_trees
1944
1815
 
1945
1816
        if (prefix is None) or (prefix == '0'):
1946
1817
            # diff -p0 format
1960
1831
            raise errors.BzrCommandError('bzr diff --revision takes exactly'
1961
1832
                                         ' one or two revision specifiers')
1962
1833
 
1963
 
        if using is not None and format is not None:
1964
 
            raise errors.BzrCommandError('--using and --format are mutually '
1965
 
                'exclusive.')
1966
 
 
1967
 
        (old_tree, new_tree,
1968
 
         old_branch, new_branch,
1969
 
         specific_files, extra_trees) = get_trees_and_branches_to_diff_locked(
1970
 
            file_list, revision, old, new, self.add_cleanup, apply_view=True)
 
1834
        old_tree, new_tree, specific_files, extra_trees = \
 
1835
                _get_trees_to_diff(file_list, revision, old, new,
 
1836
                apply_view=True)
1971
1837
        return show_diff_trees(old_tree, new_tree, sys.stdout,
1972
1838
                               specific_files=specific_files,
1973
1839
                               external_diff_options=diff_options,
1974
1840
                               old_label=old_label, new_label=new_label,
1975
 
                               extra_trees=extra_trees, using=using,
1976
 
                               format_cls=format)
 
1841
                               extra_trees=extra_trees, using=using)
1977
1842
 
1978
1843
 
1979
1844
class cmd_deleted(Command):
1980
 
    __doc__ = """List files deleted in the working tree.
 
1845
    """List files deleted in the working tree.
1981
1846
    """
1982
1847
    # TODO: Show files deleted since a previous revision, or
1983
1848
    # between two revisions.
1986
1851
    # level of effort but possibly much less IO.  (Or possibly not,
1987
1852
    # if the directories are very large...)
1988
1853
    _see_also = ['status', 'ls']
1989
 
    takes_options = ['directory', 'show-ids']
 
1854
    takes_options = ['show-ids']
1990
1855
 
1991
1856
    @display_command
1992
 
    def run(self, show_ids=False, directory=u'.'):
1993
 
        tree = WorkingTree.open_containing(directory)[0]
1994
 
        self.add_cleanup(tree.lock_read().unlock)
1995
 
        old = tree.basis_tree()
1996
 
        self.add_cleanup(old.lock_read().unlock)
1997
 
        for path, ie in old.inventory.iter_entries():
1998
 
            if not tree.has_id(ie.file_id):
1999
 
                self.outf.write(path)
2000
 
                if show_ids:
2001
 
                    self.outf.write(' ')
2002
 
                    self.outf.write(ie.file_id)
2003
 
                self.outf.write('\n')
 
1857
    def run(self, show_ids=False):
 
1858
        tree = WorkingTree.open_containing(u'.')[0]
 
1859
        tree.lock_read()
 
1860
        try:
 
1861
            old = tree.basis_tree()
 
1862
            old.lock_read()
 
1863
            try:
 
1864
                for path, ie in old.inventory.iter_entries():
 
1865
                    if not tree.has_id(ie.file_id):
 
1866
                        self.outf.write(path)
 
1867
                        if show_ids:
 
1868
                            self.outf.write(' ')
 
1869
                            self.outf.write(ie.file_id)
 
1870
                        self.outf.write('\n')
 
1871
            finally:
 
1872
                old.unlock()
 
1873
        finally:
 
1874
            tree.unlock()
2004
1875
 
2005
1876
 
2006
1877
class cmd_modified(Command):
2007
 
    __doc__ = """List files modified in working tree.
 
1878
    """List files modified in working tree.
2008
1879
    """
2009
1880
 
2010
1881
    hidden = True
2011
1882
    _see_also = ['status', 'ls']
2012
 
    takes_options = ['directory', 'null']
 
1883
    takes_options = [
 
1884
            Option('null',
 
1885
                   help='Write an ascii NUL (\\0) separator '
 
1886
                   'between files rather than a newline.')
 
1887
            ]
2013
1888
 
2014
1889
    @display_command
2015
 
    def run(self, null=False, directory=u'.'):
2016
 
        tree = WorkingTree.open_containing(directory)[0]
 
1890
    def run(self, null=False):
 
1891
        tree = WorkingTree.open_containing(u'.')[0]
2017
1892
        td = tree.changes_from(tree.basis_tree())
2018
1893
        for path, id, kind, text_modified, meta_modified in td.modified:
2019
1894
            if null:
2023
1898
 
2024
1899
 
2025
1900
class cmd_added(Command):
2026
 
    __doc__ = """List files added in working tree.
 
1901
    """List files added in working tree.
2027
1902
    """
2028
1903
 
2029
1904
    hidden = True
2030
1905
    _see_also = ['status', 'ls']
2031
 
    takes_options = ['directory', 'null']
 
1906
    takes_options = [
 
1907
            Option('null',
 
1908
                   help='Write an ascii NUL (\\0) separator '
 
1909
                   'between files rather than a newline.')
 
1910
            ]
2032
1911
 
2033
1912
    @display_command
2034
 
    def run(self, null=False, directory=u'.'):
2035
 
        wt = WorkingTree.open_containing(directory)[0]
2036
 
        self.add_cleanup(wt.lock_read().unlock)
2037
 
        basis = wt.basis_tree()
2038
 
        self.add_cleanup(basis.lock_read().unlock)
2039
 
        basis_inv = basis.inventory
2040
 
        inv = wt.inventory
2041
 
        for file_id in inv:
2042
 
            if file_id in basis_inv:
2043
 
                continue
2044
 
            if inv.is_root(file_id) and len(basis_inv) == 0:
2045
 
                continue
2046
 
            path = inv.id2path(file_id)
2047
 
            if not os.access(osutils.pathjoin(wt.basedir, path), os.F_OK):
2048
 
                continue
2049
 
            if null:
2050
 
                self.outf.write(path + '\0')
2051
 
            else:
2052
 
                self.outf.write(osutils.quotefn(path) + '\n')
 
1913
    def run(self, null=False):
 
1914
        wt = WorkingTree.open_containing(u'.')[0]
 
1915
        wt.lock_read()
 
1916
        try:
 
1917
            basis = wt.basis_tree()
 
1918
            basis.lock_read()
 
1919
            try:
 
1920
                basis_inv = basis.inventory
 
1921
                inv = wt.inventory
 
1922
                for file_id in inv:
 
1923
                    if file_id in basis_inv:
 
1924
                        continue
 
1925
                    if inv.is_root(file_id) and len(basis_inv) == 0:
 
1926
                        continue
 
1927
                    path = inv.id2path(file_id)
 
1928
                    if not os.access(osutils.abspath(path), os.F_OK):
 
1929
                        continue
 
1930
                    if null:
 
1931
                        self.outf.write(path + '\0')
 
1932
                    else:
 
1933
                        self.outf.write(osutils.quotefn(path) + '\n')
 
1934
            finally:
 
1935
                basis.unlock()
 
1936
        finally:
 
1937
            wt.unlock()
2053
1938
 
2054
1939
 
2055
1940
class cmd_root(Command):
2056
 
    __doc__ = """Show the tree root directory.
 
1941
    """Show the tree root directory.
2057
1942
 
2058
1943
    The root is the nearest enclosing directory with a .bzr control
2059
1944
    directory."""
2083
1968
 
2084
1969
 
2085
1970
class cmd_log(Command):
2086
 
    __doc__ = """Show historical log for a branch or subset of a branch.
 
1971
    """Show historical log for a branch or subset of a branch.
2087
1972
 
2088
1973
    log is bzr's default tool for exploring the history of a branch.
2089
1974
    The branch to use is taken from the first parameter. If no parameters
2200
2085
    :Tips & tricks:
2201
2086
 
2202
2087
      GUI tools and IDEs are often better at exploring history than command
2203
 
      line tools: you may prefer qlog or viz from qbzr or bzr-gtk, the
2204
 
      bzr-explorer shell, or the Loggerhead web interface.  See the Plugin
2205
 
      Guide <http://doc.bazaar.canonical.com/plugins/en/> and
2206
 
      <http://wiki.bazaar.canonical.com/IDEIntegration>.  
 
2088
      line tools. You may prefer qlog or glog from the QBzr and Bzr-Gtk packages
 
2089
      respectively for example. (TortoiseBzr uses qlog for displaying logs.) See
 
2090
      http://bazaar-vcs.org/BzrPlugins and http://bazaar-vcs.org/IDEIntegration.
 
2091
 
 
2092
      Web interfaces are often better at exploring history than command line
 
2093
      tools, particularly for branches on servers. You may prefer Loggerhead
 
2094
      or one of its alternatives. See http://bazaar-vcs.org/WebInterface.
2207
2095
 
2208
2096
      You may find it useful to add the aliases below to ``bazaar.conf``::
2209
2097
 
2250
2138
                   help='Show just the specified revision.'
2251
2139
                   ' See also "help revisionspec".'),
2252
2140
            'log-format',
2253
 
            RegistryOption('authors',
2254
 
                'What names to list as authors - first, all or committer.',
2255
 
                title='Authors',
2256
 
                lazy_registry=('bzrlib.log', 'author_list_registry'),
2257
 
            ),
2258
2141
            Option('levels',
2259
2142
                   short_name='n',
2260
2143
                   help='Number of levels to display - 0 for all, 1 for flat.',
2275
2158
                   help='Show changes made in each revision as a patch.'),
2276
2159
            Option('include-merges',
2277
2160
                   help='Show merged revisions like --levels 0 does.'),
2278
 
            Option('exclude-common-ancestry',
2279
 
                   help='Display only the revisions that are not part'
2280
 
                   ' of both ancestries (require -rX..Y)'
2281
 
                   )
2282
2161
            ]
2283
2162
    encoding_type = 'replace'
2284
2163
 
2294
2173
            message=None,
2295
2174
            limit=None,
2296
2175
            show_diff=False,
2297
 
            include_merges=False,
2298
 
            authors=None,
2299
 
            exclude_common_ancestry=False,
2300
 
            ):
 
2176
            include_merges=False):
2301
2177
        from bzrlib.log import (
2302
2178
            Logger,
2303
2179
            make_log_request_dict,
2304
2180
            _get_info_for_log_files,
2305
2181
            )
2306
2182
        direction = (forward and 'forward') or 'reverse'
2307
 
        if (exclude_common_ancestry
2308
 
            and (revision is None or len(revision) != 2)):
2309
 
            raise errors.BzrCommandError(
2310
 
                '--exclude-common-ancestry requires -r with two revisions')
2311
2183
        if include_merges:
2312
2184
            if levels is None:
2313
2185
                levels = 0
2328
2200
        filter_by_dir = False
2329
2201
        if file_list:
2330
2202
            # find the file ids to log and check for directory filtering
2331
 
            b, file_info_list, rev1, rev2 = _get_info_for_log_files(
2332
 
                revision, file_list, self.add_cleanup)
 
2203
            b, file_info_list, rev1, rev2 = _get_info_for_log_files(revision,
 
2204
                file_list)
2333
2205
            for relpath, file_id, kind in file_info_list:
2334
2206
                if file_id is None:
2335
2207
                    raise errors.BzrCommandError(
2353
2225
                location = '.'
2354
2226
            dir, relpath = bzrdir.BzrDir.open_containing(location)
2355
2227
            b = dir.open_branch()
2356
 
            self.add_cleanup(b.lock_read().unlock)
2357
2228
            rev1, rev2 = _get_revision_range(revision, b, self.name())
2358
2229
 
2359
2230
        # Decide on the type of delta & diff filtering to use
2369
2240
        else:
2370
2241
            diff_type = 'full'
2371
2242
 
2372
 
        # Build the log formatter
2373
 
        if log_format is None:
2374
 
            log_format = log.log_formatter_registry.get_default(b)
2375
 
        # Make a non-encoding output to include the diffs - bug 328007
2376
 
        unencoded_output = ui.ui_factory.make_output_stream(encoding_type='exact')
2377
 
        lf = log_format(show_ids=show_ids, to_file=self.outf,
2378
 
                        to_exact_file=unencoded_output,
2379
 
                        show_timezone=timezone,
2380
 
                        delta_format=get_verbosity_level(),
2381
 
                        levels=levels,
2382
 
                        show_advice=levels is None,
2383
 
                        author_list_handler=authors)
2384
 
 
2385
 
        # Choose the algorithm for doing the logging. It's annoying
2386
 
        # having multiple code paths like this but necessary until
2387
 
        # the underlying repository format is faster at generating
2388
 
        # deltas or can provide everything we need from the indices.
2389
 
        # The default algorithm - match-using-deltas - works for
2390
 
        # multiple files and directories and is faster for small
2391
 
        # amounts of history (200 revisions say). However, it's too
2392
 
        # slow for logging a single file in a repository with deep
2393
 
        # history, i.e. > 10K revisions. In the spirit of "do no
2394
 
        # evil when adding features", we continue to use the
2395
 
        # original algorithm - per-file-graph - for the "single
2396
 
        # file that isn't a directory without showing a delta" case.
2397
 
        partial_history = revision and b.repository._format.supports_chks
2398
 
        match_using_deltas = (len(file_ids) != 1 or filter_by_dir
2399
 
            or delta_type or partial_history)
2400
 
 
2401
 
        # Build the LogRequest and execute it
2402
 
        if len(file_ids) == 0:
2403
 
            file_ids = None
2404
 
        rqst = make_log_request_dict(
2405
 
            direction=direction, specific_fileids=file_ids,
2406
 
            start_revision=rev1, end_revision=rev2, limit=limit,
2407
 
            message_search=message, delta_type=delta_type,
2408
 
            diff_type=diff_type, _match_using_deltas=match_using_deltas,
2409
 
            exclude_common_ancestry=exclude_common_ancestry,
2410
 
            )
2411
 
        Logger(b, rqst).show(lf)
 
2243
        b.lock_read()
 
2244
        try:
 
2245
            # Build the log formatter
 
2246
            if log_format is None:
 
2247
                log_format = log.log_formatter_registry.get_default(b)
 
2248
            lf = log_format(show_ids=show_ids, to_file=self.outf,
 
2249
                            show_timezone=timezone,
 
2250
                            delta_format=get_verbosity_level(),
 
2251
                            levels=levels,
 
2252
                            show_advice=levels is None)
 
2253
 
 
2254
            # Choose the algorithm for doing the logging. It's annoying
 
2255
            # having multiple code paths like this but necessary until
 
2256
            # the underlying repository format is faster at generating
 
2257
            # deltas or can provide everything we need from the indices.
 
2258
            # The default algorithm - match-using-deltas - works for
 
2259
            # multiple files and directories and is faster for small
 
2260
            # amounts of history (200 revisions say). However, it's too
 
2261
            # slow for logging a single file in a repository with deep
 
2262
            # history, i.e. > 10K revisions. In the spirit of "do no
 
2263
            # evil when adding features", we continue to use the
 
2264
            # original algorithm - per-file-graph - for the "single
 
2265
            # file that isn't a directory without showing a delta" case.
 
2266
            partial_history = revision and b.repository._format.supports_chks
 
2267
            match_using_deltas = (len(file_ids) != 1 or filter_by_dir
 
2268
                or delta_type or partial_history)
 
2269
 
 
2270
            # Build the LogRequest and execute it
 
2271
            if len(file_ids) == 0:
 
2272
                file_ids = None
 
2273
            rqst = make_log_request_dict(
 
2274
                direction=direction, specific_fileids=file_ids,
 
2275
                start_revision=rev1, end_revision=rev2, limit=limit,
 
2276
                message_search=message, delta_type=delta_type,
 
2277
                diff_type=diff_type, _match_using_deltas=match_using_deltas)
 
2278
            Logger(b, rqst).show(lf)
 
2279
        finally:
 
2280
            b.unlock()
2412
2281
 
2413
2282
 
2414
2283
def _get_revision_range(revisionspec_list, branch, command_name):
2432
2301
            raise errors.BzrCommandError(
2433
2302
                "bzr %s doesn't accept two revisions in different"
2434
2303
                " branches." % command_name)
2435
 
        if start_spec.spec is None:
2436
 
            # Avoid loading all the history.
2437
 
            rev1 = RevisionInfo(branch, None, None)
2438
 
        else:
2439
 
            rev1 = start_spec.in_history(branch)
 
2304
        rev1 = start_spec.in_history(branch)
2440
2305
        # Avoid loading all of history when we know a missing
2441
2306
        # end of range means the last revision ...
2442
2307
        if end_spec.spec is None:
2471
2336
 
2472
2337
 
2473
2338
class cmd_touching_revisions(Command):
2474
 
    __doc__ = """Return revision-ids which affected a particular file.
 
2339
    """Return revision-ids which affected a particular file.
2475
2340
 
2476
2341
    A more user-friendly interface is "bzr log FILE".
2477
2342
    """
2482
2347
    @display_command
2483
2348
    def run(self, filename):
2484
2349
        tree, relpath = WorkingTree.open_containing(filename)
 
2350
        b = tree.branch
2485
2351
        file_id = tree.path2id(relpath)
2486
 
        b = tree.branch
2487
 
        self.add_cleanup(b.lock_read().unlock)
2488
 
        touching_revs = log.find_touching_revisions(b, file_id)
2489
 
        for revno, revision_id, what in touching_revs:
 
2352
        for revno, revision_id, what in log.find_touching_revisions(b, file_id):
2490
2353
            self.outf.write("%6d %s\n" % (revno, what))
2491
2354
 
2492
2355
 
2493
2356
class cmd_ls(Command):
2494
 
    __doc__ = """List files in a tree.
 
2357
    """List files in a tree.
2495
2358
    """
2496
2359
 
2497
2360
    _see_also = ['status', 'cat']
2503
2366
                   help='Recurse into subdirectories.'),
2504
2367
            Option('from-root',
2505
2368
                   help='Print paths relative to the root of the branch.'),
2506
 
            Option('unknown', short_name='u',
2507
 
                help='Print unknown files.'),
 
2369
            Option('unknown', help='Print unknown files.'),
2508
2370
            Option('versioned', help='Print versioned files.',
2509
2371
                   short_name='V'),
2510
 
            Option('ignored', short_name='i',
2511
 
                help='Print ignored files.'),
2512
 
            Option('kind', short_name='k',
 
2372
            Option('ignored', help='Print ignored files.'),
 
2373
            Option('null',
 
2374
                   help='Write an ascii NUL (\\0) separator '
 
2375
                   'between files rather than a newline.'),
 
2376
            Option('kind',
2513
2377
                   help='List entries of a particular kind: file, directory, symlink.',
2514
2378
                   type=unicode),
2515
 
            'null',
2516
2379
            'show-ids',
2517
 
            'directory',
2518
2380
            ]
2519
2381
    @display_command
2520
2382
    def run(self, revision=None, verbose=False,
2521
2383
            recursive=False, from_root=False,
2522
2384
            unknown=False, versioned=False, ignored=False,
2523
 
            null=False, kind=None, show_ids=False, path=None, directory=None):
 
2385
            null=False, kind=None, show_ids=False, path=None):
2524
2386
 
2525
2387
        if kind and kind not in ('file', 'directory', 'symlink'):
2526
2388
            raise errors.BzrCommandError('invalid kind specified')
2538
2400
                raise errors.BzrCommandError('cannot specify both --from-root'
2539
2401
                                             ' and PATH')
2540
2402
            fs_path = path
2541
 
        tree, branch, relpath = \
2542
 
            _open_directory_or_containing_tree_or_branch(fs_path, directory)
 
2403
        tree, branch, relpath = bzrdir.BzrDir.open_containing_tree_or_branch(
 
2404
            fs_path)
2543
2405
 
2544
2406
        # Calculate the prefix to use
2545
2407
        prefix = None
2546
2408
        if from_root:
2547
2409
            if relpath:
2548
2410
                prefix = relpath + '/'
2549
 
        elif fs_path != '.' and not fs_path.endswith('/'):
 
2411
        elif fs_path != '.':
2550
2412
            prefix = fs_path + '/'
2551
2413
 
2552
2414
        if revision is not None or tree is None:
2560
2422
                view_str = views.view_display_str(view_files)
2561
2423
                note("Ignoring files outside view. View is %s" % view_str)
2562
2424
 
2563
 
        self.add_cleanup(tree.lock_read().unlock)
2564
 
        for fp, fc, fkind, fid, entry in tree.list_files(include_root=False,
2565
 
            from_dir=relpath, recursive=recursive):
2566
 
            # Apply additional masking
2567
 
            if not all and not selection[fc]:
2568
 
                continue
2569
 
            if kind is not None and fkind != kind:
2570
 
                continue
2571
 
            if apply_view:
2572
 
                try:
2573
 
                    if relpath:
2574
 
                        fullpath = osutils.pathjoin(relpath, fp)
2575
 
                    else:
2576
 
                        fullpath = fp
2577
 
                    views.check_path_in_view(tree, fullpath)
2578
 
                except errors.FileOutsideView:
2579
 
                    continue
 
2425
        tree.lock_read()
 
2426
        try:
 
2427
            for fp, fc, fkind, fid, entry in tree.list_files(include_root=False,
 
2428
                from_dir=relpath, recursive=recursive):
 
2429
                # Apply additional masking
 
2430
                if not all and not selection[fc]:
 
2431
                    continue
 
2432
                if kind is not None and fkind != kind:
 
2433
                    continue
 
2434
                if apply_view:
 
2435
                    try:
 
2436
                        if relpath:
 
2437
                            fullpath = osutils.pathjoin(relpath, fp)
 
2438
                        else:
 
2439
                            fullpath = fp
 
2440
                        views.check_path_in_view(tree, fullpath)
 
2441
                    except errors.FileOutsideView:
 
2442
                        continue
2580
2443
 
2581
 
            # Output the entry
2582
 
            if prefix:
2583
 
                fp = osutils.pathjoin(prefix, fp)
2584
 
            kindch = entry.kind_character()
2585
 
            outstring = fp + kindch
2586
 
            ui.ui_factory.clear_term()
2587
 
            if verbose:
2588
 
                outstring = '%-8s %s' % (fc, outstring)
2589
 
                if show_ids and fid is not None:
2590
 
                    outstring = "%-50s %s" % (outstring, fid)
2591
 
                self.outf.write(outstring + '\n')
2592
 
            elif null:
2593
 
                self.outf.write(fp + '\0')
2594
 
                if show_ids:
2595
 
                    if fid is not None:
2596
 
                        self.outf.write(fid)
2597
 
                    self.outf.write('\0')
2598
 
                self.outf.flush()
2599
 
            else:
2600
 
                if show_ids:
2601
 
                    if fid is not None:
2602
 
                        my_id = fid
2603
 
                    else:
2604
 
                        my_id = ''
2605
 
                    self.outf.write('%-50s %s\n' % (outstring, my_id))
2606
 
                else:
 
2444
                # Output the entry
 
2445
                if prefix:
 
2446
                    fp = osutils.pathjoin(prefix, fp)
 
2447
                kindch = entry.kind_character()
 
2448
                outstring = fp + kindch
 
2449
                ui.ui_factory.clear_term()
 
2450
                if verbose:
 
2451
                    outstring = '%-8s %s' % (fc, outstring)
 
2452
                    if show_ids and fid is not None:
 
2453
                        outstring = "%-50s %s" % (outstring, fid)
2607
2454
                    self.outf.write(outstring + '\n')
 
2455
                elif null:
 
2456
                    self.outf.write(fp + '\0')
 
2457
                    if show_ids:
 
2458
                        if fid is not None:
 
2459
                            self.outf.write(fid)
 
2460
                        self.outf.write('\0')
 
2461
                    self.outf.flush()
 
2462
                else:
 
2463
                    if show_ids:
 
2464
                        if fid is not None:
 
2465
                            my_id = fid
 
2466
                        else:
 
2467
                            my_id = ''
 
2468
                        self.outf.write('%-50s %s\n' % (outstring, my_id))
 
2469
                    else:
 
2470
                        self.outf.write(outstring + '\n')
 
2471
        finally:
 
2472
            tree.unlock()
2608
2473
 
2609
2474
 
2610
2475
class cmd_unknowns(Command):
2611
 
    __doc__ = """List unknown files.
 
2476
    """List unknown files.
2612
2477
    """
2613
2478
 
2614
2479
    hidden = True
2615
2480
    _see_also = ['ls']
2616
 
    takes_options = ['directory']
2617
2481
 
2618
2482
    @display_command
2619
 
    def run(self, directory=u'.'):
2620
 
        for f in WorkingTree.open_containing(directory)[0].unknowns():
 
2483
    def run(self):
 
2484
        for f in WorkingTree.open_containing(u'.')[0].unknowns():
2621
2485
            self.outf.write(osutils.quotefn(f) + '\n')
2622
2486
 
2623
2487
 
2624
2488
class cmd_ignore(Command):
2625
 
    __doc__ = """Ignore specified files or patterns.
 
2489
    """Ignore specified files or patterns.
2626
2490
 
2627
2491
    See ``bzr help patterns`` for details on the syntax of patterns.
2628
2492
 
2629
 
    If a .bzrignore file does not exist, the ignore command
2630
 
    will create one and add the specified files or patterns to the newly
2631
 
    created file. The ignore command will also automatically add the 
2632
 
    .bzrignore file to be versioned. Creating a .bzrignore file without
2633
 
    the use of the ignore command will require an explicit add command.
2634
 
 
2635
2493
    To remove patterns from the ignore list, edit the .bzrignore file.
2636
2494
    After adding, editing or deleting that file either indirectly by
2637
2495
    using this command or directly by using an editor, be sure to commit
2638
2496
    it.
2639
 
    
2640
 
    Bazaar also supports a global ignore file ~/.bazaar/ignore. On Windows
2641
 
    the global ignore file can be found in the application data directory as
2642
 
    C:\\Documents and Settings\\<user>\\Application Data\\Bazaar\\2.0\\ignore.
2643
 
    Global ignores are not touched by this command. The global ignore file
2644
 
    can be edited directly using an editor.
2645
 
 
2646
 
    Patterns prefixed with '!' are exceptions to ignore patterns and take
2647
 
    precedence over regular ignores.  Such exceptions are used to specify
2648
 
    files that should be versioned which would otherwise be ignored.
2649
 
    
2650
 
    Patterns prefixed with '!!' act as regular ignore patterns, but have
2651
 
    precedence over the '!' exception patterns.
2652
2497
 
2653
2498
    Note: ignore patterns containing shell wildcards must be quoted from
2654
2499
    the shell on Unix.
2658
2503
 
2659
2504
            bzr ignore ./Makefile
2660
2505
 
2661
 
        Ignore .class files in all directories...::
 
2506
        Ignore class files in all directories::
2662
2507
 
2663
2508
            bzr ignore "*.class"
2664
2509
 
2665
 
        ...but do not ignore "special.class"::
2666
 
 
2667
 
            bzr ignore "!special.class"
2668
 
 
2669
2510
        Ignore .o files under the lib directory::
2670
2511
 
2671
2512
            bzr ignore "lib/**/*.o"
2677
2518
        Ignore everything but the "debian" toplevel directory::
2678
2519
 
2679
2520
            bzr ignore "RE:(?!debian/).*"
2680
 
        
2681
 
        Ignore everything except the "local" toplevel directory,
2682
 
        but always ignore "*~" autosave files, even under local/::
2683
 
        
2684
 
            bzr ignore "*"
2685
 
            bzr ignore "!./local"
2686
 
            bzr ignore "!!*~"
2687
2521
    """
2688
2522
 
2689
2523
    _see_also = ['status', 'ignored', 'patterns']
2690
2524
    takes_args = ['name_pattern*']
2691
 
    takes_options = ['directory',
2692
 
        Option('default-rules',
2693
 
               help='Display the default ignore rules that bzr uses.')
 
2525
    takes_options = [
 
2526
        Option('old-default-rules',
 
2527
               help='Write out the ignore rules bzr < 0.9 always used.')
2694
2528
        ]
2695
2529
 
2696
 
    def run(self, name_pattern_list=None, default_rules=None,
2697
 
            directory=u'.'):
 
2530
    def run(self, name_pattern_list=None, old_default_rules=None):
2698
2531
        from bzrlib import ignores
2699
 
        if default_rules is not None:
2700
 
            # dump the default rules and exit
2701
 
            for pattern in ignores.USER_DEFAULTS:
2702
 
                self.outf.write("%s\n" % pattern)
 
2532
        if old_default_rules is not None:
 
2533
            # dump the rules and exit
 
2534
            for pattern in ignores.OLD_DEFAULTS:
 
2535
                print pattern
2703
2536
            return
2704
2537
        if not name_pattern_list:
2705
2538
            raise errors.BzrCommandError("ignore requires at least one "
2706
 
                "NAME_PATTERN or --default-rules.")
 
2539
                                  "NAME_PATTERN or --old-default-rules")
2707
2540
        name_pattern_list = [globbing.normalize_pattern(p)
2708
2541
                             for p in name_pattern_list]
2709
2542
        for name_pattern in name_pattern_list:
2711
2544
                (len(name_pattern) > 1 and name_pattern[1] == ':')):
2712
2545
                raise errors.BzrCommandError(
2713
2546
                    "NAME_PATTERN should not be an absolute path")
2714
 
        tree, relpath = WorkingTree.open_containing(directory)
 
2547
        tree, relpath = WorkingTree.open_containing(u'.')
2715
2548
        ignores.tree_ignores_add_patterns(tree, name_pattern_list)
2716
2549
        ignored = globbing.Globster(name_pattern_list)
2717
2550
        matches = []
2721
2554
            if id is not None:
2722
2555
                filename = entry[0]
2723
2556
                if ignored.match(filename):
2724
 
                    matches.append(filename)
 
2557
                    matches.append(filename.encode('utf-8'))
2725
2558
        tree.unlock()
2726
2559
        if len(matches) > 0:
2727
 
            self.outf.write("Warning: the following files are version controlled and"
2728
 
                  " match your ignore pattern:\n%s"
2729
 
                  "\nThese files will continue to be version controlled"
2730
 
                  " unless you 'bzr remove' them.\n" % ("\n".join(matches),))
 
2560
            print "Warning: the following files are version controlled and" \
 
2561
                  " match your ignore pattern:\n%s" \
 
2562
                  "\nThese files will continue to be version controlled" \
 
2563
                  " unless you 'bzr remove' them." % ("\n".join(matches),)
2731
2564
 
2732
2565
 
2733
2566
class cmd_ignored(Command):
2734
 
    __doc__ = """List ignored files and the patterns that matched them.
 
2567
    """List ignored files and the patterns that matched them.
2735
2568
 
2736
2569
    List all the ignored files and the ignore pattern that caused the file to
2737
2570
    be ignored.
2743
2576
 
2744
2577
    encoding_type = 'replace'
2745
2578
    _see_also = ['ignore', 'ls']
2746
 
    takes_options = ['directory']
2747
2579
 
2748
2580
    @display_command
2749
 
    def run(self, directory=u'.'):
2750
 
        tree = WorkingTree.open_containing(directory)[0]
2751
 
        self.add_cleanup(tree.lock_read().unlock)
2752
 
        for path, file_class, kind, file_id, entry in tree.list_files():
2753
 
            if file_class != 'I':
2754
 
                continue
2755
 
            ## XXX: Slightly inefficient since this was already calculated
2756
 
            pat = tree.is_ignored(path)
2757
 
            self.outf.write('%-50s %s\n' % (path, pat))
 
2581
    def run(self):
 
2582
        tree = WorkingTree.open_containing(u'.')[0]
 
2583
        tree.lock_read()
 
2584
        try:
 
2585
            for path, file_class, kind, file_id, entry in tree.list_files():
 
2586
                if file_class != 'I':
 
2587
                    continue
 
2588
                ## XXX: Slightly inefficient since this was already calculated
 
2589
                pat = tree.is_ignored(path)
 
2590
                self.outf.write('%-50s %s\n' % (path, pat))
 
2591
        finally:
 
2592
            tree.unlock()
2758
2593
 
2759
2594
 
2760
2595
class cmd_lookup_revision(Command):
2761
 
    __doc__ = """Lookup the revision-id from a revision-number
 
2596
    """Lookup the revision-id from a revision-number
2762
2597
 
2763
2598
    :Examples:
2764
2599
        bzr lookup-revision 33
2765
2600
    """
2766
2601
    hidden = True
2767
2602
    takes_args = ['revno']
2768
 
    takes_options = ['directory']
2769
2603
 
2770
2604
    @display_command
2771
 
    def run(self, revno, directory=u'.'):
 
2605
    def run(self, revno):
2772
2606
        try:
2773
2607
            revno = int(revno)
2774
2608
        except ValueError:
2775
 
            raise errors.BzrCommandError("not a valid revision-number: %r"
2776
 
                                         % revno)
2777
 
        revid = WorkingTree.open_containing(directory)[0].branch.get_rev_id(revno)
2778
 
        self.outf.write("%s\n" % revid)
 
2609
            raise errors.BzrCommandError("not a valid revision-number: %r" % revno)
 
2610
 
 
2611
        print WorkingTree.open_containing(u'.')[0].branch.get_rev_id(revno)
2779
2612
 
2780
2613
 
2781
2614
class cmd_export(Command):
2782
 
    __doc__ = """Export current or past revision to a destination directory or archive.
 
2615
    """Export current or past revision to a destination directory or archive.
2783
2616
 
2784
2617
    If no revision is specified this exports the last committed revision.
2785
2618
 
2807
2640
      =================       =========================
2808
2641
    """
2809
2642
    takes_args = ['dest', 'branch_or_subdir?']
2810
 
    takes_options = ['directory',
 
2643
    takes_options = [
2811
2644
        Option('format',
2812
2645
               help="Type of file to export to.",
2813
2646
               type=unicode),
2817
2650
        Option('root',
2818
2651
               type=str,
2819
2652
               help="Name of the root directory inside the exported file."),
2820
 
        Option('per-file-timestamps',
2821
 
               help='Set modification time of files to that of the last '
2822
 
                    'revision in which it was changed.'),
2823
2653
        ]
2824
2654
    def run(self, dest, branch_or_subdir=None, revision=None, format=None,
2825
 
        root=None, filters=False, per_file_timestamps=False, directory=u'.'):
 
2655
        root=None, filters=False):
2826
2656
        from bzrlib.export import export
2827
2657
 
2828
2658
        if branch_or_subdir is None:
2829
 
            tree = WorkingTree.open_containing(directory)[0]
 
2659
            tree = WorkingTree.open_containing(u'.')[0]
2830
2660
            b = tree.branch
2831
2661
            subdir = None
2832
2662
        else:
2835
2665
 
2836
2666
        rev_tree = _get_one_revision_tree('export', revision, branch=b, tree=tree)
2837
2667
        try:
2838
 
            export(rev_tree, dest, format, root, subdir, filtered=filters,
2839
 
                   per_file_timestamps=per_file_timestamps)
 
2668
            export(rev_tree, dest, format, root, subdir, filtered=filters)
2840
2669
        except errors.NoSuchExportFormat, e:
2841
2670
            raise errors.BzrCommandError('Unsupported export format: %s' % e.format)
2842
2671
 
2843
2672
 
2844
2673
class cmd_cat(Command):
2845
 
    __doc__ = """Write the contents of a file as of a given revision to standard output.
 
2674
    """Write the contents of a file as of a given revision to standard output.
2846
2675
 
2847
2676
    If no revision is nominated, the last revision is used.
2848
2677
 
2851
2680
    """
2852
2681
 
2853
2682
    _see_also = ['ls']
2854
 
    takes_options = ['directory',
 
2683
    takes_options = [
2855
2684
        Option('name-from-revision', help='The path name in the old tree.'),
2856
2685
        Option('filters', help='Apply content filters to display the '
2857
2686
                'convenience form.'),
2862
2691
 
2863
2692
    @display_command
2864
2693
    def run(self, filename, revision=None, name_from_revision=False,
2865
 
            filters=False, directory=None):
 
2694
            filters=False):
2866
2695
        if revision is not None and len(revision) != 1:
2867
2696
            raise errors.BzrCommandError("bzr cat --revision takes exactly"
2868
2697
                                         " one revision specifier")
2869
2698
        tree, branch, relpath = \
2870
 
            _open_directory_or_containing_tree_or_branch(filename, directory)
2871
 
        self.add_cleanup(branch.lock_read().unlock)
2872
 
        return self._run(tree, branch, relpath, filename, revision,
2873
 
                         name_from_revision, filters)
 
2699
            bzrdir.BzrDir.open_containing_tree_or_branch(filename)
 
2700
        branch.lock_read()
 
2701
        try:
 
2702
            return self._run(tree, branch, relpath, filename, revision,
 
2703
                             name_from_revision, filters)
 
2704
        finally:
 
2705
            branch.unlock()
2874
2706
 
2875
2707
    def _run(self, tree, b, relpath, filename, revision, name_from_revision,
2876
2708
        filtered):
2877
2709
        if tree is None:
2878
2710
            tree = b.basis_tree()
2879
2711
        rev_tree = _get_one_revision_tree('cat', revision, branch=b)
2880
 
        self.add_cleanup(rev_tree.lock_read().unlock)
2881
2712
 
2882
2713
        old_file_id = rev_tree.path2id(relpath)
2883
2714
 
2918
2749
            chunks = content.splitlines(True)
2919
2750
            content = filtered_output_bytes(chunks, filters,
2920
2751
                ContentFilterContext(relpath, rev_tree))
2921
 
            self.cleanup_now()
2922
2752
            self.outf.writelines(content)
2923
2753
        else:
2924
 
            self.cleanup_now()
2925
2754
            self.outf.write(content)
2926
2755
 
2927
2756
 
2928
2757
class cmd_local_time_offset(Command):
2929
 
    __doc__ = """Show the offset in seconds from GMT to local time."""
 
2758
    """Show the offset in seconds from GMT to local time."""
2930
2759
    hidden = True
2931
2760
    @display_command
2932
2761
    def run(self):
2933
 
        self.outf.write("%s\n" % osutils.local_time_offset())
 
2762
        print osutils.local_time_offset()
2934
2763
 
2935
2764
 
2936
2765
 
2937
2766
class cmd_commit(Command):
2938
 
    __doc__ = """Commit changes into a new revision.
 
2767
    """Commit changes into a new revision.
2939
2768
 
2940
2769
    An explanatory message needs to be given for each commit. This is
2941
2770
    often done by using the --message option (getting the message from the
3034
2863
             Option('strict',
3035
2864
                    help="Refuse to commit if there are unknown "
3036
2865
                    "files in the working tree."),
3037
 
             Option('commit-time', type=str,
3038
 
                    help="Manually set a commit time using commit date "
3039
 
                    "format, e.g. '2009-10-10 08:00:00 +0100'."),
3040
2866
             ListOption('fixes', type=str,
3041
2867
                    help="Mark a bug as being fixed by this revision "
3042
2868
                         "(see \"bzr help bugs\")."),
3049
2875
                         "the master branch until a normal commit "
3050
2876
                         "is performed."
3051
2877
                    ),
3052
 
             Option('show-diff', short_name='p',
3053
 
                    help='When no message is supplied, show the diff along'
3054
 
                    ' with the status summary in the message editor.'),
 
2878
              Option('show-diff',
 
2879
                     help='When no message is supplied, show the diff along'
 
2880
                     ' with the status summary in the message editor.'),
3055
2881
             ]
3056
2882
    aliases = ['ci', 'checkin']
3057
2883
 
3076
2902
 
3077
2903
    def run(self, message=None, file=None, verbose=False, selected_list=None,
3078
2904
            unchanged=False, strict=False, local=False, fixes=None,
3079
 
            author=None, show_diff=False, exclude=None, commit_time=None):
 
2905
            author=None, show_diff=False, exclude=None):
3080
2906
        from bzrlib.errors import (
3081
2907
            PointlessCommit,
3082
2908
            ConflictsInTree,
3088
2914
            make_commit_message_template_encoded
3089
2915
        )
3090
2916
 
3091
 
        commit_stamp = offset = None
3092
 
        if commit_time is not None:
3093
 
            try:
3094
 
                commit_stamp, offset = timestamp.parse_patch_date(commit_time)
3095
 
            except ValueError, e:
3096
 
                raise errors.BzrCommandError(
3097
 
                    "Could not parse --commit-time: " + str(e))
3098
 
 
3099
2917
        # TODO: Need a blackbox test for invoking the external editor; may be
3100
2918
        # slightly problematic to run this cross-platform.
3101
2919
 
3121
2939
        if local and not tree.branch.get_bound_location():
3122
2940
            raise errors.LocalRequiresBoundBranch()
3123
2941
 
3124
 
        if message is not None:
3125
 
            try:
3126
 
                file_exists = osutils.lexists(message)
3127
 
            except UnicodeError:
3128
 
                # The commit message contains unicode characters that can't be
3129
 
                # represented in the filesystem encoding, so that can't be a
3130
 
                # file.
3131
 
                file_exists = False
3132
 
            if file_exists:
3133
 
                warning_msg = (
3134
 
                    'The commit message is a file name: "%(f)s".\n'
3135
 
                    '(use --file "%(f)s" to take commit message from that file)'
3136
 
                    % { 'f': message })
3137
 
                ui.ui_factory.show_warning(warning_msg)
3138
 
            if '\r' in message:
3139
 
                message = message.replace('\r\n', '\n')
3140
 
                message = message.replace('\r', '\n')
3141
 
            if file:
3142
 
                raise errors.BzrCommandError(
3143
 
                    "please specify either --message or --file")
3144
 
 
3145
2942
        def get_message(commit_obj):
3146
2943
            """Callback to get commit message"""
3147
 
            if file:
3148
 
                f = codecs.open(file, 'rt', osutils.get_user_encoding())
3149
 
                try:
3150
 
                    my_message = f.read()
3151
 
                finally:
3152
 
                    f.close()
3153
 
            elif message is not None:
3154
 
                my_message = message
3155
 
            else:
3156
 
                # No message supplied: make one up.
3157
 
                # text is the status of the tree
3158
 
                text = make_commit_message_template_encoded(tree,
 
2944
            my_message = message
 
2945
            if my_message is None and not file:
 
2946
                t = make_commit_message_template_encoded(tree,
3159
2947
                        selected_list, diff=show_diff,
3160
2948
                        output_encoding=osutils.get_user_encoding())
3161
 
                # start_message is the template generated from hooks
3162
 
                # XXX: Warning - looks like hooks return unicode,
3163
 
                # make_commit_message_template_encoded returns user encoding.
3164
 
                # We probably want to be using edit_commit_message instead to
3165
 
                # avoid this.
3166
2949
                start_message = generate_commit_message_template(commit_obj)
3167
 
                my_message = edit_commit_message_encoded(text,
 
2950
                my_message = edit_commit_message_encoded(t,
3168
2951
                    start_message=start_message)
3169
2952
                if my_message is None:
3170
2953
                    raise errors.BzrCommandError("please specify a commit"
3171
2954
                        " message with either --message or --file")
 
2955
            elif my_message and file:
 
2956
                raise errors.BzrCommandError(
 
2957
                    "please specify either --message or --file")
 
2958
            if file:
 
2959
                my_message = codecs.open(file, 'rt',
 
2960
                                         osutils.get_user_encoding()).read()
3172
2961
            if my_message == "":
3173
2962
                raise errors.BzrCommandError("empty commit message specified")
3174
2963
            return my_message
3175
2964
 
3176
 
        # The API permits a commit with a filter of [] to mean 'select nothing'
3177
 
        # but the command line should not do that.
3178
 
        if not selected_list:
3179
 
            selected_list = None
3180
2965
        try:
3181
2966
            tree.commit(message_callback=get_message,
3182
2967
                        specific_files=selected_list,
3183
2968
                        allow_pointless=unchanged, strict=strict, local=local,
3184
2969
                        reporter=None, verbose=verbose, revprops=properties,
3185
 
                        authors=author, timestamp=commit_stamp,
3186
 
                        timezone=offset,
 
2970
                        authors=author,
3187
2971
                        exclude=safe_relpath_files(tree, exclude))
3188
2972
        except PointlessCommit:
 
2973
            # FIXME: This should really happen before the file is read in;
 
2974
            # perhaps prepare the commit; get the message; then actually commit
3189
2975
            raise errors.BzrCommandError("No changes to commit."
3190
2976
                              " Use --unchanged to commit anyhow.")
3191
2977
        except ConflictsInTree:
3196
2982
            raise errors.BzrCommandError("Commit refused because there are"
3197
2983
                              " unknown files in the working tree.")
3198
2984
        except errors.BoundBranchOutOfDate, e:
3199
 
            e.extra_help = ("\n"
3200
 
                'To commit to master branch, run update and then commit.\n'
3201
 
                'You can also pass --local to commit to continue working '
3202
 
                'disconnected.')
3203
 
            raise
 
2985
            raise errors.BzrCommandError(str(e) + "\n"
 
2986
            'To commit to master branch, run update and then commit.\n'
 
2987
            'You can also pass --local to commit to continue working '
 
2988
            'disconnected.')
3204
2989
 
3205
2990
 
3206
2991
class cmd_check(Command):
3207
 
    __doc__ = """Validate working tree structure, branch consistency and repository history.
 
2992
    """Validate working tree structure, branch consistency and repository history.
3208
2993
 
3209
2994
    This command checks various invariants about branch and repository storage
3210
2995
    to detect data corruption or bzr bugs.
3274
3059
 
3275
3060
 
3276
3061
class cmd_upgrade(Command):
3277
 
    __doc__ = """Upgrade branch storage to current format.
 
3062
    """Upgrade branch storage to current format.
3278
3063
 
3279
3064
    The check command or bzr developers may sometimes advise you to run
3280
3065
    this command. When the default format has changed you may also be warned
3298
3083
 
3299
3084
 
3300
3085
class cmd_whoami(Command):
3301
 
    __doc__ = """Show or set bzr user id.
 
3086
    """Show or set bzr user id.
3302
3087
 
3303
3088
    :Examples:
3304
3089
        Show the email of the current user::
3348
3133
 
3349
3134
 
3350
3135
class cmd_nick(Command):
3351
 
    __doc__ = """Print or set the branch nickname.
 
3136
    """Print or set the branch nickname.
3352
3137
 
3353
3138
    If unset, the tree root directory name is used as the nickname.
3354
3139
    To print the current nickname, execute with no argument.
3359
3144
 
3360
3145
    _see_also = ['info']
3361
3146
    takes_args = ['nickname?']
3362
 
    takes_options = ['directory']
3363
 
    def run(self, nickname=None, directory=u'.'):
3364
 
        branch = Branch.open_containing(directory)[0]
 
3147
    def run(self, nickname=None):
 
3148
        branch = Branch.open_containing(u'.')[0]
3365
3149
        if nickname is None:
3366
3150
            self.printme(branch)
3367
3151
        else:
3369
3153
 
3370
3154
    @display_command
3371
3155
    def printme(self, branch):
3372
 
        self.outf.write('%s\n' % branch.nick)
 
3156
        print branch.nick
3373
3157
 
3374
3158
 
3375
3159
class cmd_alias(Command):
3376
 
    __doc__ = """Set/unset and display aliases.
 
3160
    """Set/unset and display aliases.
3377
3161
 
3378
3162
    :Examples:
3379
3163
        Show the current aliases::
3443
3227
 
3444
3228
 
3445
3229
class cmd_selftest(Command):
3446
 
    __doc__ = """Run internal test suite.
 
3230
    """Run internal test suite.
3447
3231
 
3448
3232
    If arguments are given, they are regular expressions that say which tests
3449
3233
    should run.  Tests matching any expression are run, and other tests are
3476
3260
    Tests that need working space on disk use a common temporary directory,
3477
3261
    typically inside $TMPDIR or /tmp.
3478
3262
 
3479
 
    If you set BZR_TEST_PDB=1 when running selftest, failing tests will drop
3480
 
    into a pdb postmortem session.
3481
 
 
3482
3263
    :Examples:
3483
3264
        Run only tests relating to 'ignore'::
3484
3265
 
3493
3274
    def get_transport_type(typestring):
3494
3275
        """Parse and return a transport specifier."""
3495
3276
        if typestring == "sftp":
3496
 
            from bzrlib.tests import stub_sftp
3497
 
            return stub_sftp.SFTPAbsoluteServer
 
3277
            from bzrlib.transport.sftp import SFTPAbsoluteServer
 
3278
            return SFTPAbsoluteServer
3498
3279
        if typestring == "memory":
3499
 
            from bzrlib.tests import test_server
3500
 
            return memory.MemoryServer
 
3280
            from bzrlib.transport.memory import MemoryServer
 
3281
            return MemoryServer
3501
3282
        if typestring == "fakenfs":
3502
 
            from bzrlib.tests import test_server
3503
 
            return test_server.FakeNFSServer
 
3283
            from bzrlib.transport.fakenfs import FakeNFSServer
 
3284
            return FakeNFSServer
3504
3285
        msg = "No known transport type %s. Supported types are: sftp\n" %\
3505
3286
            (typestring)
3506
3287
        raise errors.BzrCommandError(msg)
3521
3302
                     Option('lsprof-timed',
3522
3303
                            help='Generate lsprof output for benchmarked'
3523
3304
                                 ' sections of code.'),
3524
 
                     Option('lsprof-tests',
3525
 
                            help='Generate lsprof output for each test.'),
3526
3305
                     Option('cache-dir', type=str,
3527
3306
                            help='Cache intermediate benchmark output in this '
3528
3307
                                 'directory.'),
3569
3348
            first=False, list_only=False,
3570
3349
            randomize=None, exclude=None, strict=False,
3571
3350
            load_list=None, debugflag=None, starting_with=None, subunit=False,
3572
 
            parallel=None, lsprof_tests=False):
 
3351
            parallel=None):
3573
3352
        from bzrlib.tests import selftest
3574
3353
        import bzrlib.benchmarks as benchmarks
3575
3354
        from bzrlib.benchmarks import tree_creator
3590
3369
                raise errors.BzrCommandError("subunit not available. subunit "
3591
3370
                    "needs to be installed to use --subunit.")
3592
3371
            self.additional_selftest_args['runner_class'] = SubUnitBzrRunner
3593
 
            # On Windows, disable automatic conversion of '\n' to '\r\n' in
3594
 
            # stdout, which would corrupt the subunit stream. 
3595
 
            # FIXME: This has been fixed in subunit trunk (>0.0.5) so the
3596
 
            # following code can be deleted when it's sufficiently deployed
3597
 
            # -- vila/mgz 20100514
3598
 
            if (sys.platform == "win32"
3599
 
                and getattr(sys.stdout, 'fileno', None) is not None):
3600
 
                import msvcrt
3601
 
                msvcrt.setmode(sys.stdout.fileno(), os.O_BINARY)
3602
3372
        if parallel:
3603
3373
            self.additional_selftest_args.setdefault(
3604
3374
                'suite_decorators', []).append(parallel)
3608
3378
            verbose = not is_quiet()
3609
3379
            # TODO: should possibly lock the history file...
3610
3380
            benchfile = open(".perf_history", "at", buffering=1)
3611
 
            self.add_cleanup(benchfile.close)
3612
3381
        else:
3613
3382
            test_suite_factory = None
3614
3383
            benchfile = None
3615
 
        selftest_kwargs = {"verbose": verbose,
3616
 
                          "pattern": pattern,
3617
 
                          "stop_on_failure": one,
3618
 
                          "transport": transport,
3619
 
                          "test_suite_factory": test_suite_factory,
3620
 
                          "lsprof_timed": lsprof_timed,
3621
 
                          "lsprof_tests": lsprof_tests,
3622
 
                          "bench_history": benchfile,
3623
 
                          "matching_tests_first": first,
3624
 
                          "list_only": list_only,
3625
 
                          "random_seed": randomize,
3626
 
                          "exclude_pattern": exclude,
3627
 
                          "strict": strict,
3628
 
                          "load_list": load_list,
3629
 
                          "debug_flags": debugflag,
3630
 
                          "starting_with": starting_with
3631
 
                          }
3632
 
        selftest_kwargs.update(self.additional_selftest_args)
3633
 
        result = selftest(**selftest_kwargs)
 
3384
        try:
 
3385
            selftest_kwargs = {"verbose": verbose,
 
3386
                              "pattern": pattern,
 
3387
                              "stop_on_failure": one,
 
3388
                              "transport": transport,
 
3389
                              "test_suite_factory": test_suite_factory,
 
3390
                              "lsprof_timed": lsprof_timed,
 
3391
                              "bench_history": benchfile,
 
3392
                              "matching_tests_first": first,
 
3393
                              "list_only": list_only,
 
3394
                              "random_seed": randomize,
 
3395
                              "exclude_pattern": exclude,
 
3396
                              "strict": strict,
 
3397
                              "load_list": load_list,
 
3398
                              "debug_flags": debugflag,
 
3399
                              "starting_with": starting_with
 
3400
                              }
 
3401
            selftest_kwargs.update(self.additional_selftest_args)
 
3402
            result = selftest(**selftest_kwargs)
 
3403
        finally:
 
3404
            if benchfile is not None:
 
3405
                benchfile.close()
3634
3406
        return int(not result)
3635
3407
 
3636
3408
 
3637
3409
class cmd_version(Command):
3638
 
    __doc__ = """Show version of bzr."""
 
3410
    """Show version of bzr."""
3639
3411
 
3640
3412
    encoding_type = 'replace'
3641
3413
    takes_options = [
3652
3424
 
3653
3425
 
3654
3426
class cmd_rocks(Command):
3655
 
    __doc__ = """Statement of optimism."""
 
3427
    """Statement of optimism."""
3656
3428
 
3657
3429
    hidden = True
3658
3430
 
3659
3431
    @display_command
3660
3432
    def run(self):
3661
 
        self.outf.write("It sure does!\n")
 
3433
        print "It sure does!"
3662
3434
 
3663
3435
 
3664
3436
class cmd_find_merge_base(Command):
3665
 
    __doc__ = """Find and print a base revision for merging two branches."""
 
3437
    """Find and print a base revision for merging two branches."""
3666
3438
    # TODO: Options to specify revisions on either side, as if
3667
3439
    #       merging only part of the history.
3668
3440
    takes_args = ['branch', 'other']
3674
3446
 
3675
3447
        branch1 = Branch.open_containing(branch)[0]
3676
3448
        branch2 = Branch.open_containing(other)[0]
3677
 
        self.add_cleanup(branch1.lock_read().unlock)
3678
 
        self.add_cleanup(branch2.lock_read().unlock)
3679
 
        last1 = ensure_null(branch1.last_revision())
3680
 
        last2 = ensure_null(branch2.last_revision())
3681
 
 
3682
 
        graph = branch1.repository.get_graph(branch2.repository)
3683
 
        base_rev_id = graph.find_unique_lca(last1, last2)
3684
 
 
3685
 
        self.outf.write('merge base is revision %s\n' % base_rev_id)
 
3449
        branch1.lock_read()
 
3450
        try:
 
3451
            branch2.lock_read()
 
3452
            try:
 
3453
                last1 = ensure_null(branch1.last_revision())
 
3454
                last2 = ensure_null(branch2.last_revision())
 
3455
 
 
3456
                graph = branch1.repository.get_graph(branch2.repository)
 
3457
                base_rev_id = graph.find_unique_lca(last1, last2)
 
3458
 
 
3459
                print 'merge base is revision %s' % base_rev_id
 
3460
            finally:
 
3461
                branch2.unlock()
 
3462
        finally:
 
3463
            branch1.unlock()
3686
3464
 
3687
3465
 
3688
3466
class cmd_merge(Command):
3689
 
    __doc__ = """Perform a three-way merge.
 
3467
    """Perform a three-way merge.
3690
3468
 
3691
3469
    The source of the merge can be specified either in the form of a branch,
3692
3470
    or in the form of a path to a file containing a merge directive generated
3721
3499
    committed to record the result of the merge.
3722
3500
 
3723
3501
    merge refuses to run if there are any uncommitted changes, unless
3724
 
    --force is given. The --force option can also be used to create a
3725
 
    merge revision which has more than two parents.
3726
 
 
3727
 
    If one would like to merge changes from the working tree of the other
3728
 
    branch without merging any committed revisions, the --uncommitted option
3729
 
    can be given.
3730
 
 
3731
 
    To select only some changes to merge, use "merge -i", which will prompt
3732
 
    you to apply each diff hunk and file change, similar to "shelve".
 
3502
    --force is given.
3733
3503
 
3734
3504
    :Examples:
3735
3505
        To merge the latest revision from bzr.dev::
3744
3514
 
3745
3515
            bzr merge -r 81..82 ../bzr.dev
3746
3516
 
3747
 
        To apply a merge directive contained in /tmp/merge::
 
3517
        To apply a merge directive contained in /tmp/merge:
3748
3518
 
3749
3519
            bzr merge /tmp/merge
3750
 
 
3751
 
        To create a merge revision with three parents from two branches
3752
 
        feature1a and feature1b:
3753
 
 
3754
 
            bzr merge ../feature1a
3755
 
            bzr merge ../feature1b --force
3756
 
            bzr commit -m 'revision with three parents'
3757
3520
    """
3758
3521
 
3759
3522
    encoding_type = 'exact'
3775
3538
                ' completely merged into the source, pull from the'
3776
3539
                ' source rather than merging.  When this happens,'
3777
3540
                ' you do not need to commit the result.'),
3778
 
        custom_help('directory',
 
3541
        Option('directory',
3779
3542
               help='Branch to merge into, '
3780
 
                    'rather than the one containing the working directory.'),
3781
 
        Option('preview', help='Instead of merging, show a diff of the'
3782
 
               ' merge.'),
3783
 
        Option('interactive', help='Select changes interactively.',
3784
 
            short_name='i')
 
3543
                    'rather than the one containing the working directory.',
 
3544
               short_name='d',
 
3545
               type=unicode,
 
3546
               ),
 
3547
        Option('preview', help='Instead of merging, show a diff of the merge.')
3785
3548
    ]
3786
3549
 
3787
3550
    def run(self, location=None, revision=None, force=False,
3789
3552
            uncommitted=False, pull=False,
3790
3553
            directory=None,
3791
3554
            preview=False,
3792
 
            interactive=False,
3793
3555
            ):
3794
3556
        if merge_type is None:
3795
3557
            merge_type = _mod_merge.Merge3Merger
3801
3563
        verified = 'inapplicable'
3802
3564
        tree = WorkingTree.open_containing(directory)[0]
3803
3565
 
 
3566
        # die as quickly as possible if there are uncommitted changes
3804
3567
        try:
3805
3568
            basis_tree = tree.revision_tree(tree.last_revision())
3806
3569
        except errors.NoSuchRevision:
3807
3570
            basis_tree = tree.basis_tree()
3808
 
 
3809
 
        # die as quickly as possible if there are uncommitted changes
3810
3571
        if not force:
3811
 
            if tree.has_changes():
 
3572
            changes = tree.changes_from(basis_tree)
 
3573
            if changes.has_changed():
3812
3574
                raise errors.UncommittedChanges(tree)
3813
3575
 
3814
3576
        view_info = _get_view_info_for_change_reporter(tree)
3815
3577
        change_reporter = delta._ChangeReporter(
3816
3578
            unversioned_filter=tree.is_ignored, view_info=view_info)
3817
 
        pb = ui.ui_factory.nested_progress_bar()
3818
 
        self.add_cleanup(pb.finished)
3819
 
        self.add_cleanup(tree.lock_write().unlock)
3820
 
        if location is not None:
3821
 
            try:
3822
 
                mergeable = bundle.read_mergeable_from_url(location,
3823
 
                    possible_transports=possible_transports)
3824
 
            except errors.NotABundle:
3825
 
                mergeable = None
 
3579
        cleanups = []
 
3580
        try:
 
3581
            pb = ui.ui_factory.nested_progress_bar()
 
3582
            cleanups.append(pb.finished)
 
3583
            tree.lock_write()
 
3584
            cleanups.append(tree.unlock)
 
3585
            if location is not None:
 
3586
                try:
 
3587
                    mergeable = bundle.read_mergeable_from_url(location,
 
3588
                        possible_transports=possible_transports)
 
3589
                except errors.NotABundle:
 
3590
                    mergeable = None
 
3591
                else:
 
3592
                    if uncommitted:
 
3593
                        raise errors.BzrCommandError('Cannot use --uncommitted'
 
3594
                            ' with bundles or merge directives.')
 
3595
 
 
3596
                    if revision is not None:
 
3597
                        raise errors.BzrCommandError(
 
3598
                            'Cannot use -r with merge directives or bundles')
 
3599
                    merger, verified = _mod_merge.Merger.from_mergeable(tree,
 
3600
                       mergeable, pb)
 
3601
 
 
3602
            if merger is None and uncommitted:
 
3603
                if revision is not None and len(revision) > 0:
 
3604
                    raise errors.BzrCommandError('Cannot use --uncommitted and'
 
3605
                        ' --revision at the same time.')
 
3606
                location = self._select_branch_location(tree, location)[0]
 
3607
                other_tree, other_path = WorkingTree.open_containing(location)
 
3608
                merger = _mod_merge.Merger.from_uncommitted(tree, other_tree,
 
3609
                    pb)
 
3610
                allow_pending = False
 
3611
                if other_path != '':
 
3612
                    merger.interesting_files = [other_path]
 
3613
 
 
3614
            if merger is None:
 
3615
                merger, allow_pending = self._get_merger_from_branch(tree,
 
3616
                    location, revision, remember, possible_transports, pb)
 
3617
 
 
3618
            merger.merge_type = merge_type
 
3619
            merger.reprocess = reprocess
 
3620
            merger.show_base = show_base
 
3621
            self.sanity_check_merger(merger)
 
3622
            if (merger.base_rev_id == merger.other_rev_id and
 
3623
                merger.other_rev_id is not None):
 
3624
                note('Nothing to do.')
 
3625
                return 0
 
3626
            if pull:
 
3627
                if merger.interesting_files is not None:
 
3628
                    raise errors.BzrCommandError('Cannot pull individual files')
 
3629
                if (merger.base_rev_id == tree.last_revision()):
 
3630
                    result = tree.pull(merger.other_branch, False,
 
3631
                                       merger.other_rev_id)
 
3632
                    result.report(self.outf)
 
3633
                    return 0
 
3634
            merger.check_basis(False)
 
3635
            if preview:
 
3636
                return self._do_preview(merger)
3826
3637
            else:
3827
 
                if uncommitted:
3828
 
                    raise errors.BzrCommandError('Cannot use --uncommitted'
3829
 
                        ' with bundles or merge directives.')
3830
 
 
3831
 
                if revision is not None:
3832
 
                    raise errors.BzrCommandError(
3833
 
                        'Cannot use -r with merge directives or bundles')
3834
 
                merger, verified = _mod_merge.Merger.from_mergeable(tree,
3835
 
                   mergeable, None)
3836
 
 
3837
 
        if merger is None and uncommitted:
3838
 
            if revision is not None and len(revision) > 0:
3839
 
                raise errors.BzrCommandError('Cannot use --uncommitted and'
3840
 
                    ' --revision at the same time.')
3841
 
            merger = self.get_merger_from_uncommitted(tree, location, None)
3842
 
            allow_pending = False
3843
 
 
3844
 
        if merger is None:
3845
 
            merger, allow_pending = self._get_merger_from_branch(tree,
3846
 
                location, revision, remember, possible_transports, None)
3847
 
 
3848
 
        merger.merge_type = merge_type
3849
 
        merger.reprocess = reprocess
3850
 
        merger.show_base = show_base
3851
 
        self.sanity_check_merger(merger)
3852
 
        if (merger.base_rev_id == merger.other_rev_id and
3853
 
            merger.other_rev_id is not None):
3854
 
            note('Nothing to do.')
3855
 
            return 0
3856
 
        if pull:
3857
 
            if merger.interesting_files is not None:
3858
 
                raise errors.BzrCommandError('Cannot pull individual files')
3859
 
            if (merger.base_rev_id == tree.last_revision()):
3860
 
                result = tree.pull(merger.other_branch, False,
3861
 
                                   merger.other_rev_id)
3862
 
                result.report(self.outf)
3863
 
                return 0
3864
 
        if merger.this_basis is None:
3865
 
            raise errors.BzrCommandError(
3866
 
                "This branch has no commits."
3867
 
                " (perhaps you would prefer 'bzr pull')")
3868
 
        if preview:
3869
 
            return self._do_preview(merger)
3870
 
        elif interactive:
3871
 
            return self._do_interactive(merger)
3872
 
        else:
3873
 
            return self._do_merge(merger, change_reporter, allow_pending,
3874
 
                                  verified)
3875
 
 
3876
 
    def _get_preview(self, merger):
 
3638
                return self._do_merge(merger, change_reporter, allow_pending,
 
3639
                                      verified)
 
3640
        finally:
 
3641
            for cleanup in reversed(cleanups):
 
3642
                cleanup()
 
3643
 
 
3644
    def _do_preview(self, merger):
 
3645
        from bzrlib.diff import show_diff_trees
3877
3646
        tree_merger = merger.make_merger()
3878
3647
        tt = tree_merger.make_preview_transform()
3879
 
        self.add_cleanup(tt.finalize)
3880
 
        result_tree = tt.get_preview_tree()
3881
 
        return result_tree
3882
 
 
3883
 
    def _do_preview(self, merger):
3884
 
        from bzrlib.diff import show_diff_trees
3885
 
        result_tree = self._get_preview(merger)
3886
 
        show_diff_trees(merger.this_tree, result_tree, self.outf,
3887
 
                        old_label='', new_label='')
 
3648
        try:
 
3649
            result_tree = tt.get_preview_tree()
 
3650
            show_diff_trees(merger.this_tree, result_tree, self.outf,
 
3651
                            old_label='', new_label='')
 
3652
        finally:
 
3653
            tt.finalize()
3888
3654
 
3889
3655
    def _do_merge(self, merger, change_reporter, allow_pending, verified):
3890
3656
        merger.change_reporter = change_reporter
3898
3664
        else:
3899
3665
            return 0
3900
3666
 
3901
 
    def _do_interactive(self, merger):
3902
 
        """Perform an interactive merge.
3903
 
 
3904
 
        This works by generating a preview tree of the merge, then using
3905
 
        Shelver to selectively remove the differences between the working tree
3906
 
        and the preview tree.
3907
 
        """
3908
 
        from bzrlib import shelf_ui
3909
 
        result_tree = self._get_preview(merger)
3910
 
        writer = bzrlib.option.diff_writer_registry.get()
3911
 
        shelver = shelf_ui.Shelver(merger.this_tree, result_tree, destroy=True,
3912
 
                                   reporter=shelf_ui.ApplyReporter(),
3913
 
                                   diff_writer=writer(sys.stdout))
3914
 
        try:
3915
 
            shelver.run()
3916
 
        finally:
3917
 
            shelver.finalize()
3918
 
 
3919
3667
    def sanity_check_merger(self, merger):
3920
3668
        if (merger.show_base and
3921
3669
            not merger.merge_type is _mod_merge.Merge3Merger):
3956
3704
            base_branch, base_path = Branch.open_containing(base_loc,
3957
3705
                possible_transports)
3958
3706
        # Find the revision ids
3959
 
        other_revision_id = None
3960
 
        base_revision_id = None
3961
 
        if revision is not None:
3962
 
            if len(revision) >= 1:
3963
 
                other_revision_id = revision[-1].as_revision_id(other_branch)
3964
 
            if len(revision) == 2:
3965
 
                base_revision_id = revision[0].as_revision_id(base_branch)
3966
 
        if other_revision_id is None:
 
3707
        if revision is None or len(revision) < 1 or revision[-1] is None:
3967
3708
            other_revision_id = _mod_revision.ensure_null(
3968
3709
                other_branch.last_revision())
 
3710
        else:
 
3711
            other_revision_id = revision[-1].as_revision_id(other_branch)
 
3712
        if (revision is not None and len(revision) == 2
 
3713
            and revision[0] is not None):
 
3714
            base_revision_id = revision[0].as_revision_id(base_branch)
 
3715
        else:
 
3716
            base_revision_id = None
3969
3717
        # Remember where we merge from
3970
3718
        if ((remember or tree.branch.get_submit_branch() is None) and
3971
3719
             user_location is not None):
3980
3728
            allow_pending = True
3981
3729
        return merger, allow_pending
3982
3730
 
3983
 
    def get_merger_from_uncommitted(self, tree, location, pb):
3984
 
        """Get a merger for uncommitted changes.
3985
 
 
3986
 
        :param tree: The tree the merger should apply to.
3987
 
        :param location: The location containing uncommitted changes.
3988
 
        :param pb: The progress bar to use for showing progress.
3989
 
        """
3990
 
        location = self._select_branch_location(tree, location)[0]
3991
 
        other_tree, other_path = WorkingTree.open_containing(location)
3992
 
        merger = _mod_merge.Merger.from_uncommitted(tree, other_tree, pb)
3993
 
        if other_path != '':
3994
 
            merger.interesting_files = [other_path]
3995
 
        return merger
3996
 
 
3997
3731
    def _select_branch_location(self, tree, user_location, revision=None,
3998
3732
                                index=None):
3999
3733
        """Select a branch location, according to possible inputs.
4043
3777
 
4044
3778
 
4045
3779
class cmd_remerge(Command):
4046
 
    __doc__ = """Redo a merge.
 
3780
    """Redo a merge.
4047
3781
 
4048
3782
    Use this if you want to try a different merge technique while resolving
4049
3783
    conflicts.  Some merge techniques are better than others, and remerge
4074
3808
 
4075
3809
    def run(self, file_list=None, merge_type=None, show_base=False,
4076
3810
            reprocess=False):
4077
 
        from bzrlib.conflicts import restore
4078
3811
        if merge_type is None:
4079
3812
            merge_type = _mod_merge.Merge3Merger
4080
3813
        tree, file_list = tree_files(file_list)
4081
 
        self.add_cleanup(tree.lock_write().unlock)
4082
 
        parents = tree.get_parent_ids()
4083
 
        if len(parents) != 2:
4084
 
            raise errors.BzrCommandError("Sorry, remerge only works after normal"
4085
 
                                         " merges.  Not cherrypicking or"
4086
 
                                         " multi-merges.")
4087
 
        repository = tree.branch.repository
4088
 
        interesting_ids = None
4089
 
        new_conflicts = []
4090
 
        conflicts = tree.conflicts()
4091
 
        if file_list is not None:
4092
 
            interesting_ids = set()
4093
 
            for filename in file_list:
4094
 
                file_id = tree.path2id(filename)
4095
 
                if file_id is None:
4096
 
                    raise errors.NotVersionedError(filename)
4097
 
                interesting_ids.add(file_id)
4098
 
                if tree.kind(file_id) != "directory":
4099
 
                    continue
 
3814
        tree.lock_write()
 
3815
        try:
 
3816
            parents = tree.get_parent_ids()
 
3817
            if len(parents) != 2:
 
3818
                raise errors.BzrCommandError("Sorry, remerge only works after normal"
 
3819
                                             " merges.  Not cherrypicking or"
 
3820
                                             " multi-merges.")
 
3821
            repository = tree.branch.repository
 
3822
            interesting_ids = None
 
3823
            new_conflicts = []
 
3824
            conflicts = tree.conflicts()
 
3825
            if file_list is not None:
 
3826
                interesting_ids = set()
 
3827
                for filename in file_list:
 
3828
                    file_id = tree.path2id(filename)
 
3829
                    if file_id is None:
 
3830
                        raise errors.NotVersionedError(filename)
 
3831
                    interesting_ids.add(file_id)
 
3832
                    if tree.kind(file_id) != "directory":
 
3833
                        continue
4100
3834
 
4101
 
                for name, ie in tree.inventory.iter_entries(file_id):
4102
 
                    interesting_ids.add(ie.file_id)
4103
 
            new_conflicts = conflicts.select_conflicts(tree, file_list)[0]
4104
 
        else:
4105
 
            # Remerge only supports resolving contents conflicts
4106
 
            allowed_conflicts = ('text conflict', 'contents conflict')
4107
 
            restore_files = [c.path for c in conflicts
4108
 
                             if c.typestring in allowed_conflicts]
4109
 
        _mod_merge.transform_tree(tree, tree.basis_tree(), interesting_ids)
4110
 
        tree.set_conflicts(ConflictList(new_conflicts))
4111
 
        if file_list is not None:
4112
 
            restore_files = file_list
4113
 
        for filename in restore_files:
 
3835
                    for name, ie in tree.inventory.iter_entries(file_id):
 
3836
                        interesting_ids.add(ie.file_id)
 
3837
                new_conflicts = conflicts.select_conflicts(tree, file_list)[0]
 
3838
            else:
 
3839
                # Remerge only supports resolving contents conflicts
 
3840
                allowed_conflicts = ('text conflict', 'contents conflict')
 
3841
                restore_files = [c.path for c in conflicts
 
3842
                                 if c.typestring in allowed_conflicts]
 
3843
            _mod_merge.transform_tree(tree, tree.basis_tree(), interesting_ids)
 
3844
            tree.set_conflicts(ConflictList(new_conflicts))
 
3845
            if file_list is not None:
 
3846
                restore_files = file_list
 
3847
            for filename in restore_files:
 
3848
                try:
 
3849
                    restore(tree.abspath(filename))
 
3850
                except errors.NotConflicted:
 
3851
                    pass
 
3852
            # Disable pending merges, because the file texts we are remerging
 
3853
            # have not had those merges performed.  If we use the wrong parents
 
3854
            # list, we imply that the working tree text has seen and rejected
 
3855
            # all the changes from the other tree, when in fact those changes
 
3856
            # have not yet been seen.
 
3857
            pb = ui.ui_factory.nested_progress_bar()
 
3858
            tree.set_parent_ids(parents[:1])
4114
3859
            try:
4115
 
                restore(tree.abspath(filename))
4116
 
            except errors.NotConflicted:
4117
 
                pass
4118
 
        # Disable pending merges, because the file texts we are remerging
4119
 
        # have not had those merges performed.  If we use the wrong parents
4120
 
        # list, we imply that the working tree text has seen and rejected
4121
 
        # all the changes from the other tree, when in fact those changes
4122
 
        # have not yet been seen.
4123
 
        tree.set_parent_ids(parents[:1])
4124
 
        try:
4125
 
            merger = _mod_merge.Merger.from_revision_ids(None, tree, parents[1])
4126
 
            merger.interesting_ids = interesting_ids
4127
 
            merger.merge_type = merge_type
4128
 
            merger.show_base = show_base
4129
 
            merger.reprocess = reprocess
4130
 
            conflicts = merger.do_merge()
 
3860
                merger = _mod_merge.Merger.from_revision_ids(pb,
 
3861
                                                             tree, parents[1])
 
3862
                merger.interesting_ids = interesting_ids
 
3863
                merger.merge_type = merge_type
 
3864
                merger.show_base = show_base
 
3865
                merger.reprocess = reprocess
 
3866
                conflicts = merger.do_merge()
 
3867
            finally:
 
3868
                tree.set_parent_ids(parents)
 
3869
                pb.finished()
4131
3870
        finally:
4132
 
            tree.set_parent_ids(parents)
 
3871
            tree.unlock()
4133
3872
        if conflicts > 0:
4134
3873
            return 1
4135
3874
        else:
4137
3876
 
4138
3877
 
4139
3878
class cmd_revert(Command):
4140
 
    __doc__ = """Revert files to a previous revision.
 
3879
    """Revert files to a previous revision.
4141
3880
 
4142
3881
    Giving a list of files will revert only those files.  Otherwise, all files
4143
3882
    will be reverted.  If the revision is not specified with '--revision', the
4157
3896
    name.  If you name a directory, all the contents of that directory will be
4158
3897
    reverted.
4159
3898
 
4160
 
    If you have newly added files since the target revision, they will be
4161
 
    removed.  If the files to be removed have been changed, backups will be
4162
 
    created as above.  Directories containing unknown files will not be
4163
 
    deleted.
 
3899
    Any files that have been newly added since that revision will be deleted,
 
3900
    with a backup kept if appropriate.  Directories containing unknown files
 
3901
    will not be deleted.
4164
3902
 
4165
 
    The working tree contains a list of revisions that have been merged but
4166
 
    not yet committed. These revisions will be included as additional parents
4167
 
    of the next commit.  Normally, using revert clears that list as well as
4168
 
    reverting the files.  If any files are specified, revert leaves the list
4169
 
    of uncommitted merges alone and reverts only the files.  Use ``bzr revert
4170
 
    .`` in the tree root to revert all files but keep the recorded merges,
4171
 
    and ``bzr revert --forget-merges`` to clear the pending merge list without
 
3903
    The working tree contains a list of pending merged revisions, which will
 
3904
    be included as parents in the next commit.  Normally, revert clears that
 
3905
    list as well as reverting the files.  If any files are specified, revert
 
3906
    leaves the pending merge list alone and reverts only the files.  Use "bzr
 
3907
    revert ." in the tree root to revert all files but keep the merge record,
 
3908
    and "bzr revert --forget-merges" to clear the pending merge list without
4172
3909
    reverting any files.
4173
 
 
4174
 
    Using "bzr revert --forget-merges", it is possible to apply all of the
4175
 
    changes from a branch in a single revision.  To do this, perform the merge
4176
 
    as desired.  Then doing revert with the "--forget-merges" option will keep
4177
 
    the content of the tree as it was, but it will clear the list of pending
4178
 
    merges.  The next commit will then contain all of the changes that are
4179
 
    present in the other branch, but without any other parent revisions.
4180
 
    Because this technique forgets where these changes originated, it may
4181
 
    cause additional conflicts on later merges involving the same source and
4182
 
    target branches.
4183
3910
    """
4184
3911
 
4185
3912
    _see_also = ['cat', 'export']
4194
3921
    def run(self, revision=None, no_backup=False, file_list=None,
4195
3922
            forget_merges=None):
4196
3923
        tree, file_list = tree_files(file_list)
4197
 
        self.add_cleanup(tree.lock_tree_write().unlock)
4198
 
        if forget_merges:
4199
 
            tree.set_parent_ids(tree.get_parent_ids()[:1])
4200
 
        else:
4201
 
            self._revert_tree_to_revision(tree, revision, file_list, no_backup)
 
3924
        tree.lock_write()
 
3925
        try:
 
3926
            if forget_merges:
 
3927
                tree.set_parent_ids(tree.get_parent_ids()[:1])
 
3928
            else:
 
3929
                self._revert_tree_to_revision(tree, revision, file_list, no_backup)
 
3930
        finally:
 
3931
            tree.unlock()
4202
3932
 
4203
3933
    @staticmethod
4204
3934
    def _revert_tree_to_revision(tree, revision, file_list, no_backup):
4205
3935
        rev_tree = _get_one_revision_tree('revert', revision, tree=tree)
4206
 
        tree.revert(file_list, rev_tree, not no_backup, None,
4207
 
            report_changes=True)
 
3936
        pb = ui.ui_factory.nested_progress_bar()
 
3937
        try:
 
3938
            tree.revert(file_list, rev_tree, not no_backup, pb,
 
3939
                report_changes=True)
 
3940
        finally:
 
3941
            pb.finished()
4208
3942
 
4209
3943
 
4210
3944
class cmd_assert_fail(Command):
4211
 
    __doc__ = """Test reporting of assertion failures"""
 
3945
    """Test reporting of assertion failures"""
4212
3946
    # intended just for use in testing
4213
3947
 
4214
3948
    hidden = True
4218
3952
 
4219
3953
 
4220
3954
class cmd_help(Command):
4221
 
    __doc__ = """Show help on a command or other topic.
 
3955
    """Show help on a command or other topic.
4222
3956
    """
4223
3957
 
4224
3958
    _see_also = ['topics']
4237
3971
 
4238
3972
 
4239
3973
class cmd_shell_complete(Command):
4240
 
    __doc__ = """Show appropriate completions for context.
 
3974
    """Show appropriate completions for context.
4241
3975
 
4242
3976
    For a list of all available commands, say 'bzr shell-complete'.
4243
3977
    """
4252
3986
 
4253
3987
 
4254
3988
class cmd_missing(Command):
4255
 
    __doc__ = """Show unmerged/unpulled revisions between two branches.
 
3989
    """Show unmerged/unpulled revisions between two branches.
4256
3990
 
4257
3991
    OTHER_BRANCH may be local or remote.
4258
3992
 
4259
3993
    To filter on a range of revisions, you can use the command -r begin..end
4260
3994
    -r revision requests a specific revision, -r ..end or -r begin.. are
4261
3995
    also valid.
4262
 
            
4263
 
    :Exit values:
4264
 
        1 - some missing revisions
4265
 
        0 - no missing revisions
4266
3996
 
4267
3997
    :Examples:
4268
3998
 
4336
4066
            restrict = 'remote'
4337
4067
 
4338
4068
        local_branch = Branch.open_containing(u".")[0]
4339
 
        self.add_cleanup(local_branch.lock_read().unlock)
4340
 
 
4341
4069
        parent = local_branch.get_parent()
4342
4070
        if other_branch is None:
4343
4071
            other_branch = parent
4352
4080
        remote_branch = Branch.open(other_branch)
4353
4081
        if remote_branch.base == local_branch.base:
4354
4082
            remote_branch = local_branch
4355
 
        else:
4356
 
            self.add_cleanup(remote_branch.lock_read().unlock)
4357
4083
 
4358
4084
        local_revid_range = _revision_range_to_revid_range(
4359
4085
            _get_revision_range(my_revision, local_branch,
4363
4089
            _get_revision_range(revision,
4364
4090
                remote_branch, self.name()))
4365
4091
 
4366
 
        local_extra, remote_extra = find_unmerged(
4367
 
            local_branch, remote_branch, restrict,
4368
 
            backward=not reverse,
4369
 
            include_merges=include_merges,
4370
 
            local_revid_range=local_revid_range,
4371
 
            remote_revid_range=remote_revid_range)
4372
 
 
4373
 
        if log_format is None:
4374
 
            registry = log.log_formatter_registry
4375
 
            log_format = registry.get_default(local_branch)
4376
 
        lf = log_format(to_file=self.outf,
4377
 
                        show_ids=show_ids,
4378
 
                        show_timezone='original')
4379
 
 
4380
 
        status_code = 0
4381
 
        if local_extra and not theirs_only:
4382
 
            message("You have %d extra revision(s):\n" %
4383
 
                len(local_extra))
4384
 
            for revision in iter_log_revisions(local_extra,
4385
 
                                local_branch.repository,
4386
 
                                verbose):
4387
 
                lf.log_revision(revision)
4388
 
            printed_local = True
4389
 
            status_code = 1
4390
 
        else:
4391
 
            printed_local = False
4392
 
 
4393
 
        if remote_extra and not mine_only:
4394
 
            if printed_local is True:
4395
 
                message("\n\n\n")
4396
 
            message("You are missing %d revision(s):\n" %
4397
 
                len(remote_extra))
4398
 
            for revision in iter_log_revisions(remote_extra,
4399
 
                                remote_branch.repository,
4400
 
                                verbose):
4401
 
                lf.log_revision(revision)
4402
 
            status_code = 1
4403
 
 
4404
 
        if mine_only and not local_extra:
4405
 
            # We checked local, and found nothing extra
4406
 
            message('This branch is up to date.\n')
4407
 
        elif theirs_only and not remote_extra:
4408
 
            # We checked remote, and found nothing extra
4409
 
            message('Other branch is up to date.\n')
4410
 
        elif not (mine_only or theirs_only or local_extra or
4411
 
                  remote_extra):
4412
 
            # We checked both branches, and neither one had extra
4413
 
            # revisions
4414
 
            message("Branches are up to date.\n")
4415
 
        self.cleanup_now()
 
4092
        local_branch.lock_read()
 
4093
        try:
 
4094
            remote_branch.lock_read()
 
4095
            try:
 
4096
                local_extra, remote_extra = find_unmerged(
 
4097
                    local_branch, remote_branch, restrict,
 
4098
                    backward=not reverse,
 
4099
                    include_merges=include_merges,
 
4100
                    local_revid_range=local_revid_range,
 
4101
                    remote_revid_range=remote_revid_range)
 
4102
 
 
4103
                if log_format is None:
 
4104
                    registry = log.log_formatter_registry
 
4105
                    log_format = registry.get_default(local_branch)
 
4106
                lf = log_format(to_file=self.outf,
 
4107
                                show_ids=show_ids,
 
4108
                                show_timezone='original')
 
4109
 
 
4110
                status_code = 0
 
4111
                if local_extra and not theirs_only:
 
4112
                    message("You have %d extra revision(s):\n" %
 
4113
                        len(local_extra))
 
4114
                    for revision in iter_log_revisions(local_extra,
 
4115
                                        local_branch.repository,
 
4116
                                        verbose):
 
4117
                        lf.log_revision(revision)
 
4118
                    printed_local = True
 
4119
                    status_code = 1
 
4120
                else:
 
4121
                    printed_local = False
 
4122
 
 
4123
                if remote_extra and not mine_only:
 
4124
                    if printed_local is True:
 
4125
                        message("\n\n\n")
 
4126
                    message("You are missing %d revision(s):\n" %
 
4127
                        len(remote_extra))
 
4128
                    for revision in iter_log_revisions(remote_extra,
 
4129
                                        remote_branch.repository,
 
4130
                                        verbose):
 
4131
                        lf.log_revision(revision)
 
4132
                    status_code = 1
 
4133
 
 
4134
                if mine_only and not local_extra:
 
4135
                    # We checked local, and found nothing extra
 
4136
                    message('This branch is up to date.\n')
 
4137
                elif theirs_only and not remote_extra:
 
4138
                    # We checked remote, and found nothing extra
 
4139
                    message('Other branch is up to date.\n')
 
4140
                elif not (mine_only or theirs_only or local_extra or
 
4141
                          remote_extra):
 
4142
                    # We checked both branches, and neither one had extra
 
4143
                    # revisions
 
4144
                    message("Branches are up to date.\n")
 
4145
            finally:
 
4146
                remote_branch.unlock()
 
4147
        finally:
 
4148
            local_branch.unlock()
4416
4149
        if not status_code and parent is None and other_branch is not None:
4417
 
            self.add_cleanup(local_branch.lock_write().unlock)
4418
 
            # handle race conditions - a parent might be set while we run.
4419
 
            if local_branch.get_parent() is None:
4420
 
                local_branch.set_parent(remote_branch.base)
 
4150
            local_branch.lock_write()
 
4151
            try:
 
4152
                # handle race conditions - a parent might be set while we run.
 
4153
                if local_branch.get_parent() is None:
 
4154
                    local_branch.set_parent(remote_branch.base)
 
4155
            finally:
 
4156
                local_branch.unlock()
4421
4157
        return status_code
4422
4158
 
4423
4159
 
4424
4160
class cmd_pack(Command):
4425
 
    __doc__ = """Compress the data within a repository.
4426
 
 
4427
 
    This operation compresses the data within a bazaar repository. As
4428
 
    bazaar supports automatic packing of repository, this operation is
4429
 
    normally not required to be done manually.
4430
 
 
4431
 
    During the pack operation, bazaar takes a backup of existing repository
4432
 
    data, i.e. pack files. This backup is eventually removed by bazaar
4433
 
    automatically when it is safe to do so. To save disk space by removing
4434
 
    the backed up pack files, the --clean-obsolete-packs option may be
4435
 
    used.
4436
 
 
4437
 
    Warning: If you use --clean-obsolete-packs and your machine crashes
4438
 
    during or immediately after repacking, you may be left with a state
4439
 
    where the deletion has been written to disk but the new packs have not
4440
 
    been. In this case the repository may be unusable.
4441
 
    """
 
4161
    """Compress the data within a repository."""
4442
4162
 
4443
4163
    _see_also = ['repositories']
4444
4164
    takes_args = ['branch_or_repo?']
4445
 
    takes_options = [
4446
 
        Option('clean-obsolete-packs', 'Delete obsolete packs to save disk space.'),
4447
 
        ]
4448
4165
 
4449
 
    def run(self, branch_or_repo='.', clean_obsolete_packs=False):
 
4166
    def run(self, branch_or_repo='.'):
4450
4167
        dir = bzrdir.BzrDir.open_containing(branch_or_repo)[0]
4451
4168
        try:
4452
4169
            branch = dir.open_branch()
4453
4170
            repository = branch.repository
4454
4171
        except errors.NotBranchError:
4455
4172
            repository = dir.open_repository()
4456
 
        repository.pack(clean_obsolete_packs=clean_obsolete_packs)
 
4173
        repository.pack()
4457
4174
 
4458
4175
 
4459
4176
class cmd_plugins(Command):
4460
 
    __doc__ = """List the installed plugins.
 
4177
    """List the installed plugins.
4461
4178
 
4462
4179
    This command displays the list of installed plugins including
4463
4180
    version of plugin and a short description of each.
4470
4187
    adding new commands, providing additional network transports and
4471
4188
    customizing log output.
4472
4189
 
4473
 
    See the Bazaar Plugin Guide <http://doc.bazaar.canonical.com/plugins/en/>
4474
 
    for further information on plugins including where to find them and how to
4475
 
    install them. Instructions are also provided there on how to write new
4476
 
    plugins using the Python programming language.
 
4190
    See the Bazaar web site, http://bazaar-vcs.org, for further
 
4191
    information on plugins including where to find them and how to
 
4192
    install them. Instructions are also provided there on how to
 
4193
    write new plugins using the Python programming language.
4477
4194
    """
4478
4195
    takes_options = ['verbose']
4479
4196
 
4494
4211
                doc = '(no description)'
4495
4212
            result.append((name_ver, doc, plugin.path()))
4496
4213
        for name_ver, doc, path in sorted(result):
4497
 
            self.outf.write("%s\n" % name_ver)
4498
 
            self.outf.write("   %s\n" % doc)
 
4214
            print name_ver
 
4215
            print '   ', doc
4499
4216
            if verbose:
4500
 
                self.outf.write("   %s\n" % path)
4501
 
            self.outf.write("\n")
 
4217
                print '   ', path
 
4218
            print
4502
4219
 
4503
4220
 
4504
4221
class cmd_testament(Command):
4505
 
    __doc__ = """Show testament (signing-form) of a revision."""
 
4222
    """Show testament (signing-form) of a revision."""
4506
4223
    takes_options = [
4507
4224
            'revision',
4508
4225
            Option('long', help='Produce long-format testament.'),
4520
4237
            b = Branch.open_containing(branch)[0]
4521
4238
        else:
4522
4239
            b = Branch.open(branch)
4523
 
        self.add_cleanup(b.lock_read().unlock)
4524
 
        if revision is None:
4525
 
            rev_id = b.last_revision()
4526
 
        else:
4527
 
            rev_id = revision[0].as_revision_id(b)
4528
 
        t = testament_class.from_revision(b.repository, rev_id)
4529
 
        if long:
4530
 
            sys.stdout.writelines(t.as_text_lines())
4531
 
        else:
4532
 
            sys.stdout.write(t.as_short_text())
 
4240
        b.lock_read()
 
4241
        try:
 
4242
            if revision is None:
 
4243
                rev_id = b.last_revision()
 
4244
            else:
 
4245
                rev_id = revision[0].as_revision_id(b)
 
4246
            t = testament_class.from_revision(b.repository, rev_id)
 
4247
            if long:
 
4248
                sys.stdout.writelines(t.as_text_lines())
 
4249
            else:
 
4250
                sys.stdout.write(t.as_short_text())
 
4251
        finally:
 
4252
            b.unlock()
4533
4253
 
4534
4254
 
4535
4255
class cmd_annotate(Command):
4536
 
    __doc__ = """Show the origin of each line in a file.
 
4256
    """Show the origin of each line in a file.
4537
4257
 
4538
4258
    This prints out the given file with an annotation on the left side
4539
4259
    indicating which revision, author and date introduced the change.
4550
4270
                     Option('long', help='Show commit date in annotations.'),
4551
4271
                     'revision',
4552
4272
                     'show-ids',
4553
 
                     'directory',
4554
4273
                     ]
4555
4274
    encoding_type = 'exact'
4556
4275
 
4557
4276
    @display_command
4558
4277
    def run(self, filename, all=False, long=False, revision=None,
4559
 
            show_ids=False, directory=None):
 
4278
            show_ids=False):
4560
4279
        from bzrlib.annotate import annotate_file, annotate_file_tree
4561
4280
        wt, branch, relpath = \
4562
 
            _open_directory_or_containing_tree_or_branch(filename, directory)
4563
 
        if wt is not None:
4564
 
            self.add_cleanup(wt.lock_read().unlock)
4565
 
        else:
4566
 
            self.add_cleanup(branch.lock_read().unlock)
4567
 
        tree = _get_one_revision_tree('annotate', revision, branch=branch)
4568
 
        self.add_cleanup(tree.lock_read().unlock)
4569
 
        if wt is not None:
4570
 
            file_id = wt.path2id(relpath)
4571
 
        else:
4572
 
            file_id = tree.path2id(relpath)
4573
 
        if file_id is None:
4574
 
            raise errors.NotVersionedError(filename)
4575
 
        file_version = tree.inventory[file_id].revision
4576
 
        if wt is not None and revision is None:
4577
 
            # If there is a tree and we're not annotating historical
4578
 
            # versions, annotate the working tree's content.
4579
 
            annotate_file_tree(wt, file_id, self.outf, long, all,
4580
 
                show_ids=show_ids)
4581
 
        else:
4582
 
            annotate_file(branch, file_version, file_id, long, all, self.outf,
4583
 
                          show_ids=show_ids)
 
4281
            bzrdir.BzrDir.open_containing_tree_or_branch(filename)
 
4282
        if wt is not None:
 
4283
            wt.lock_read()
 
4284
        else:
 
4285
            branch.lock_read()
 
4286
        try:
 
4287
            tree = _get_one_revision_tree('annotate', revision, branch=branch)
 
4288
            if wt is not None:
 
4289
                file_id = wt.path2id(relpath)
 
4290
            else:
 
4291
                file_id = tree.path2id(relpath)
 
4292
            if file_id is None:
 
4293
                raise errors.NotVersionedError(filename)
 
4294
            file_version = tree.inventory[file_id].revision
 
4295
            if wt is not None and revision is None:
 
4296
                # If there is a tree and we're not annotating historical
 
4297
                # versions, annotate the working tree's content.
 
4298
                annotate_file_tree(wt, file_id, self.outf, long, all,
 
4299
                    show_ids=show_ids)
 
4300
            else:
 
4301
                annotate_file(branch, file_version, file_id, long, all, self.outf,
 
4302
                              show_ids=show_ids)
 
4303
        finally:
 
4304
            if wt is not None:
 
4305
                wt.unlock()
 
4306
            else:
 
4307
                branch.unlock()
4584
4308
 
4585
4309
 
4586
4310
class cmd_re_sign(Command):
4587
 
    __doc__ = """Create a digital signature for an existing revision."""
 
4311
    """Create a digital signature for an existing revision."""
4588
4312
    # TODO be able to replace existing ones.
4589
4313
 
4590
4314
    hidden = True # is this right ?
4591
4315
    takes_args = ['revision_id*']
4592
 
    takes_options = ['directory', 'revision']
 
4316
    takes_options = ['revision']
4593
4317
 
4594
 
    def run(self, revision_id_list=None, revision=None, directory=u'.'):
 
4318
    def run(self, revision_id_list=None, revision=None):
4595
4319
        if revision_id_list is not None and revision is not None:
4596
4320
            raise errors.BzrCommandError('You can only supply one of revision_id or --revision')
4597
4321
        if revision_id_list is None and revision is None:
4598
4322
            raise errors.BzrCommandError('You must supply either --revision or a revision_id')
4599
 
        b = WorkingTree.open_containing(directory)[0].branch
4600
 
        self.add_cleanup(b.lock_write().unlock)
4601
 
        return self._run(b, revision_id_list, revision)
 
4323
        b = WorkingTree.open_containing(u'.')[0].branch
 
4324
        b.lock_write()
 
4325
        try:
 
4326
            return self._run(b, revision_id_list, revision)
 
4327
        finally:
 
4328
            b.unlock()
4602
4329
 
4603
4330
    def _run(self, b, revision_id_list, revision):
4604
4331
        import bzrlib.gpg as gpg
4649
4376
 
4650
4377
 
4651
4378
class cmd_bind(Command):
4652
 
    __doc__ = """Convert the current branch into a checkout of the supplied branch.
4653
 
    If no branch is supplied, rebind to the last bound location.
 
4379
    """Convert the current branch into a checkout of the supplied branch.
4654
4380
 
4655
4381
    Once converted into a checkout, commits must succeed on the master branch
4656
4382
    before they will be applied to the local branch.
4657
4383
 
4658
4384
    Bound branches use the nickname of its master branch unless it is set
4659
 
    locally, in which case binding will update the local nickname to be
 
4385
    locally, in which case binding will update the the local nickname to be
4660
4386
    that of the master.
4661
4387
    """
4662
4388
 
4663
4389
    _see_also = ['checkouts', 'unbind']
4664
4390
    takes_args = ['location?']
4665
 
    takes_options = ['directory']
 
4391
    takes_options = []
4666
4392
 
4667
 
    def run(self, location=None, directory=u'.'):
4668
 
        b, relpath = Branch.open_containing(directory)
 
4393
    def run(self, location=None):
 
4394
        b, relpath = Branch.open_containing(u'.')
4669
4395
        if location is None:
4670
4396
            try:
4671
4397
                location = b.get_old_bound_location()
4674
4400
                    'This format does not remember old locations.')
4675
4401
            else:
4676
4402
                if location is None:
4677
 
                    if b.get_bound_location() is not None:
4678
 
                        raise errors.BzrCommandError('Branch is already bound')
4679
 
                    else:
4680
 
                        raise errors.BzrCommandError('No location supplied '
4681
 
                            'and no previous location known')
 
4403
                    raise errors.BzrCommandError('No location supplied and no '
 
4404
                        'previous location known')
4682
4405
        b_other = Branch.open(location)
4683
4406
        try:
4684
4407
            b.bind(b_other)
4690
4413
 
4691
4414
 
4692
4415
class cmd_unbind(Command):
4693
 
    __doc__ = """Convert the current checkout into a regular branch.
 
4416
    """Convert the current checkout into a regular branch.
4694
4417
 
4695
4418
    After unbinding, the local branch is considered independent and subsequent
4696
4419
    commits will be local only.
4698
4421
 
4699
4422
    _see_also = ['checkouts', 'bind']
4700
4423
    takes_args = []
4701
 
    takes_options = ['directory']
 
4424
    takes_options = []
4702
4425
 
4703
 
    def run(self, directory=u'.'):
4704
 
        b, relpath = Branch.open_containing(directory)
 
4426
    def run(self):
 
4427
        b, relpath = Branch.open_containing(u'.')
4705
4428
        if not b.unbind():
4706
4429
            raise errors.BzrCommandError('Local branch is not bound')
4707
4430
 
4708
4431
 
4709
4432
class cmd_uncommit(Command):
4710
 
    __doc__ = """Remove the last committed revision.
 
4433
    """Remove the last committed revision.
4711
4434
 
4712
4435
    --verbose will print out what is being removed.
4713
4436
    --dry-run will go through all the motions, but not actually
4753
4476
            b = control.open_branch()
4754
4477
 
4755
4478
        if tree is not None:
4756
 
            self.add_cleanup(tree.lock_write().unlock)
 
4479
            tree.lock_write()
4757
4480
        else:
4758
 
            self.add_cleanup(b.lock_write().unlock)
4759
 
        return self._run(b, tree, dry_run, verbose, revision, force, local=local)
 
4481
            b.lock_write()
 
4482
        try:
 
4483
            return self._run(b, tree, dry_run, verbose, revision, force,
 
4484
                             local=local)
 
4485
        finally:
 
4486
            if tree is not None:
 
4487
                tree.unlock()
 
4488
            else:
 
4489
                b.unlock()
4760
4490
 
4761
4491
    def _run(self, b, tree, dry_run, verbose, revision, force, local=False):
4762
4492
        from bzrlib.log import log_formatter, show_log
4794
4524
                 end_revision=last_revno)
4795
4525
 
4796
4526
        if dry_run:
4797
 
            self.outf.write('Dry-run, pretending to remove'
4798
 
                            ' the above revisions.\n')
 
4527
            print 'Dry-run, pretending to remove the above revisions.'
 
4528
            if not force:
 
4529
                val = raw_input('Press <enter> to continue')
4799
4530
        else:
4800
 
            self.outf.write('The above revision(s) will be removed.\n')
4801
 
 
4802
 
        if not force:
4803
 
            if not ui.ui_factory.get_boolean('Are you sure'):
4804
 
                self.outf.write('Canceled')
4805
 
                return 0
 
4531
            print 'The above revision(s) will be removed.'
 
4532
            if not force:
 
4533
                val = raw_input('Are you sure [y/N]? ')
 
4534
                if val.lower() not in ('y', 'yes'):
 
4535
                    print 'Canceled'
 
4536
                    return 0
4806
4537
 
4807
4538
        mutter('Uncommitting from {%s} to {%s}',
4808
4539
               last_rev_id, rev_id)
4809
4540
        uncommit(b, tree=tree, dry_run=dry_run, verbose=verbose,
4810
4541
                 revno=revno, local=local)
4811
 
        self.outf.write('You can restore the old tip by running:\n'
4812
 
             '  bzr pull . -r revid:%s\n' % last_rev_id)
 
4542
        note('You can restore the old tip by running:\n'
 
4543
             '  bzr pull . -r revid:%s', last_rev_id)
4813
4544
 
4814
4545
 
4815
4546
class cmd_break_lock(Command):
4816
 
    __doc__ = """Break a dead lock on a repository, branch or working directory.
 
4547
    """Break a dead lock on a repository, branch or working directory.
4817
4548
 
4818
4549
    CAUTION: Locks should only be broken when you are sure that the process
4819
4550
    holding the lock has been stopped.
4820
4551
 
4821
 
    You can get information on what locks are open via the 'bzr info
4822
 
    [location]' command.
 
4552
    You can get information on what locks are open via the 'bzr info' command.
4823
4553
 
4824
4554
    :Examples:
4825
4555
        bzr break-lock
4826
 
        bzr break-lock bzr+ssh://example.com/bzr/foo
4827
4556
    """
4828
4557
    takes_args = ['location?']
4829
4558
 
4838
4567
 
4839
4568
 
4840
4569
class cmd_wait_until_signalled(Command):
4841
 
    __doc__ = """Test helper for test_start_and_stop_bzr_subprocess_send_signal.
 
4570
    """Test helper for test_start_and_stop_bzr_subprocess_send_signal.
4842
4571
 
4843
4572
    This just prints a line to signal when it is ready, then blocks on stdin.
4844
4573
    """
4852
4581
 
4853
4582
 
4854
4583
class cmd_serve(Command):
4855
 
    __doc__ = """Run the bzr server."""
 
4584
    """Run the bzr server."""
4856
4585
 
4857
4586
    aliases = ['server']
4858
4587
 
4859
4588
    takes_options = [
4860
4589
        Option('inet',
4861
4590
               help='Serve on stdin/out for use from inetd or sshd.'),
4862
 
        RegistryOption('protocol',
4863
 
               help="Protocol to serve.",
 
4591
        RegistryOption('protocol', 
 
4592
               help="Protocol to serve.", 
4864
4593
               lazy_registry=('bzrlib.transport', 'transport_server_registry'),
4865
4594
               value_switches=True),
4866
4595
        Option('port',
4869
4598
                    'result in a dynamically allocated port.  The default port '
4870
4599
                    'depends on the protocol.',
4871
4600
               type=str),
4872
 
        custom_help('directory',
4873
 
               help='Serve contents of this directory.'),
 
4601
        Option('directory',
 
4602
               help='Serve contents of this directory.',
 
4603
               type=unicode),
4874
4604
        Option('allow-writes',
4875
4605
               help='By default the server is a readonly server.  Supplying '
4876
4606
                    '--allow-writes enables write access to the contents of '
4877
 
                    'the served directory and below.  Note that ``bzr serve`` '
4878
 
                    'does not perform authentication, so unless some form of '
4879
 
                    'external authentication is arranged supplying this '
4880
 
                    'option leads to global uncontrolled write access to your '
4881
 
                    'file system.'
 
4607
                    'the served directory and below.'
4882
4608
                ),
4883
4609
        ]
4884
4610
 
4917
4643
 
4918
4644
 
4919
4645
class cmd_join(Command):
4920
 
    __doc__ = """Combine a tree into its containing tree.
 
4646
    """Combine a tree into its containing tree.
4921
4647
 
4922
4648
    This command requires the target tree to be in a rich-root format.
4923
4649
 
4963
4689
 
4964
4690
 
4965
4691
class cmd_split(Command):
4966
 
    __doc__ = """Split a subdirectory of a tree into a separate tree.
 
4692
    """Split a subdirectory of a tree into a separate tree.
4967
4693
 
4968
4694
    This command will produce a target tree in a format that supports
4969
4695
    rich roots, like 'rich-root' or 'rich-root-pack'.  These formats cannot be
4989
4715
 
4990
4716
 
4991
4717
class cmd_merge_directive(Command):
4992
 
    __doc__ = """Generate a merge directive for auto-merge tools.
 
4718
    """Generate a merge directive for auto-merge tools.
4993
4719
 
4994
4720
    A directive requests a merge to be performed, and also provides all the
4995
4721
    information necessary to do so.  This means it must either include a
5088
4814
 
5089
4815
 
5090
4816
class cmd_send(Command):
5091
 
    __doc__ = """Mail or create a merge-directive for submitting changes.
 
4817
    """Mail or create a merge-directive for submitting changes.
5092
4818
 
5093
4819
    A merge directive provides many things needed for requesting merges:
5094
4820
 
5100
4826
      directly from the merge directive, without retrieving data from a
5101
4827
      branch.
5102
4828
 
5103
 
    `bzr send` creates a compact data set that, when applied using bzr
5104
 
    merge, has the same effect as merging from the source branch.  
5105
 
    
5106
 
    By default the merge directive is self-contained and can be applied to any
5107
 
    branch containing submit_branch in its ancestory without needing access to
5108
 
    the source branch.
5109
 
    
5110
 
    If --no-bundle is specified, then Bazaar doesn't send the contents of the
5111
 
    revisions, but only a structured request to merge from the
5112
 
    public_location.  In that case the public_branch is needed and it must be
5113
 
    up-to-date and accessible to the recipient.  The public_branch is always
5114
 
    included if known, so that people can check it later.
5115
 
 
5116
 
    The submit branch defaults to the parent of the source branch, but can be
5117
 
    overridden.  Both submit branch and public branch will be remembered in
5118
 
    branch.conf the first time they are used for a particular branch.  The
5119
 
    source branch defaults to that containing the working directory, but can
5120
 
    be changed using --from.
5121
 
 
5122
 
    In order to calculate those changes, bzr must analyse the submit branch.
5123
 
    Therefore it is most efficient for the submit branch to be a local mirror.
5124
 
    If a public location is known for the submit_branch, that location is used
5125
 
    in the merge directive.
5126
 
 
5127
 
    The default behaviour is to send the merge directive by mail, unless -o is
5128
 
    given, in which case it is sent to a file.
 
4829
    If --no-bundle is specified, then public_branch is needed (and must be
 
4830
    up-to-date), so that the receiver can perform the merge using the
 
4831
    public_branch.  The public_branch is always included if known, so that
 
4832
    people can check it later.
 
4833
 
 
4834
    The submit branch defaults to the parent, but can be overridden.  Both
 
4835
    submit branch and public branch will be remembered if supplied.
 
4836
 
 
4837
    If a public_branch is known for the submit_branch, that public submit
 
4838
    branch is used in the merge instructions.  This means that a local mirror
 
4839
    can be used as your actual submit branch, once you have set public_branch
 
4840
    for that mirror.
5129
4841
 
5130
4842
    Mail is sent using your preferred mail program.  This should be transparent
5131
 
    on Windows (it uses MAPI).  On Unix, it requires the xdg-email utility.
 
4843
    on Windows (it uses MAPI).  On Linux, it requires the xdg-email utility.
5132
4844
    If the preferred client can't be found (or used), your editor will be used.
5133
4845
 
5134
4846
    To use a specific mail program, set the mail_client configuration option.
5135
4847
    (For Thunderbird 1.5, this works around some bugs.)  Supported values for
5136
 
    specific clients are "claws", "evolution", "kmail", "mail.app" (MacOS X's
5137
 
    Mail.app), "mutt", and "thunderbird"; generic options are "default",
5138
 
    "editor", "emacsclient", "mapi", and "xdg-email".  Plugins may also add
5139
 
    supported clients.
 
4848
    specific clients are "claws", "evolution", "kmail", "mutt", and
 
4849
    "thunderbird"; generic options are "default", "editor", "emacsclient",
 
4850
    "mapi", and "xdg-email".  Plugins may also add supported clients.
5140
4851
 
5141
4852
    If mail is being sent, a to address is required.  This can be supplied
5142
4853
    either on the commandline, by setting the submit_to configuration
5151
4862
 
5152
4863
    The merge directives created by bzr send may be applied using bzr merge or
5153
4864
    bzr pull by specifying a file containing a merge directive as the location.
5154
 
 
5155
 
    bzr send makes extensive use of public locations to map local locations into
5156
 
    URLs that can be used by other people.  See `bzr help configuration` to
5157
 
    set them, and use `bzr info` to display them.
5158
4865
    """
5159
4866
 
5160
4867
    encoding_type = 'exact'
5176
4883
               short_name='f',
5177
4884
               type=unicode),
5178
4885
        Option('output', short_name='o',
5179
 
               help='Write merge directive to this file or directory; '
 
4886
               help='Write merge directive to this file; '
5180
4887
                    'use - for stdout.',
5181
4888
               type=unicode),
5182
 
        Option('strict',
5183
 
               help='Refuse to send if there are uncommitted changes in'
5184
 
               ' the working tree, --no-strict disables the check.'),
5185
4889
        Option('mail-to', help='Mail the request to this address.',
5186
4890
               type=unicode),
5187
4891
        'revision',
5188
4892
        'message',
5189
4893
        Option('body', help='Body for the email.', type=unicode),
5190
4894
        RegistryOption('format',
5191
 
                       help='Use the specified output format.',
5192
 
                       lazy_registry=('bzrlib.send', 'format_registry')),
 
4895
                       help='Use the specified output format.', 
 
4896
                       lazy_registry=('bzrlib.send', 'format_registry'))
5193
4897
        ]
5194
4898
 
5195
4899
    def run(self, submit_branch=None, public_branch=None, no_bundle=False,
5196
4900
            no_patch=False, revision=None, remember=False, output=None,
5197
 
            format=None, mail_to=None, message=None, body=None,
5198
 
            strict=None, **kwargs):
 
4901
            format=None, mail_to=None, message=None, body=None, **kwargs):
5199
4902
        from bzrlib.send import send
5200
4903
        return send(submit_branch, revision, public_branch, remember,
5201
 
                    format, no_bundle, no_patch, output,
5202
 
                    kwargs.get('from', '.'), mail_to, message, body,
5203
 
                    self.outf,
5204
 
                    strict=strict)
 
4904
                         format, no_bundle, no_patch, output,
 
4905
                         kwargs.get('from', '.'), mail_to, message, body,
 
4906
                         self.outf)
5205
4907
 
5206
4908
 
5207
4909
class cmd_bundle_revisions(cmd_send):
5208
 
    __doc__ = """Create a merge-directive for submitting changes.
 
4910
    """Create a merge-directive for submitting changes.
5209
4911
 
5210
4912
    A merge directive provides many things needed for requesting merges:
5211
4913
 
5251
4953
               type=unicode),
5252
4954
        Option('output', short_name='o', help='Write directive to this file.',
5253
4955
               type=unicode),
5254
 
        Option('strict',
5255
 
               help='Refuse to bundle revisions if there are uncommitted'
5256
 
               ' changes in the working tree, --no-strict disables the check.'),
5257
4956
        'revision',
5258
4957
        RegistryOption('format',
5259
4958
                       help='Use the specified output format.',
5267
4966
 
5268
4967
    def run(self, submit_branch=None, public_branch=None, no_bundle=False,
5269
4968
            no_patch=False, revision=None, remember=False, output=None,
5270
 
            format=None, strict=None, **kwargs):
 
4969
            format=None, **kwargs):
5271
4970
        if output is None:
5272
4971
            output = '-'
5273
4972
        from bzrlib.send import send
5274
4973
        return send(submit_branch, revision, public_branch, remember,
5275
4974
                         format, no_bundle, no_patch, output,
5276
4975
                         kwargs.get('from', '.'), None, None, None,
5277
 
                         self.outf, strict=strict)
 
4976
                         self.outf)
5278
4977
 
5279
4978
 
5280
4979
class cmd_tag(Command):
5281
 
    __doc__ = """Create, remove or modify a tag naming a revision.
 
4980
    """Create, remove or modify a tag naming a revision.
5282
4981
 
5283
4982
    Tags give human-meaningful names to revisions.  Commands that take a -r
5284
4983
    (--revision) option can be given -rtag:X, where X is any previously
5292
4991
 
5293
4992
    To rename a tag (change the name but keep it on the same revsion), run ``bzr
5294
4993
    tag new-name -r tag:old-name`` and then ``bzr tag --delete oldname``.
5295
 
 
5296
 
    If no tag name is specified it will be determined through the 
5297
 
    'automatic_tag_name' hook. This can e.g. be used to automatically tag
5298
 
    upstream releases by reading configure.ac. See ``bzr help hooks`` for
5299
 
    details.
5300
4994
    """
5301
4995
 
5302
4996
    _see_also = ['commit', 'tags']
5303
 
    takes_args = ['tag_name?']
 
4997
    takes_args = ['tag_name']
5304
4998
    takes_options = [
5305
4999
        Option('delete',
5306
5000
            help='Delete this tag rather than placing it.',
5307
5001
            ),
5308
 
        custom_help('directory',
5309
 
            help='Branch in which to place the tag.'),
 
5002
        Option('directory',
 
5003
            help='Branch in which to place the tag.',
 
5004
            short_name='d',
 
5005
            type=unicode,
 
5006
            ),
5310
5007
        Option('force',
5311
5008
            help='Replace existing tags.',
5312
5009
            ),
5313
5010
        'revision',
5314
5011
        ]
5315
5012
 
5316
 
    def run(self, tag_name=None,
 
5013
    def run(self, tag_name,
5317
5014
            delete=None,
5318
5015
            directory='.',
5319
5016
            force=None,
5320
5017
            revision=None,
5321
5018
            ):
5322
5019
        branch, relpath = Branch.open_containing(directory)
5323
 
        self.add_cleanup(branch.lock_write().unlock)
5324
 
        if delete:
5325
 
            if tag_name is None:
5326
 
                raise errors.BzrCommandError("No tag specified to delete.")
5327
 
            branch.tags.delete_tag(tag_name)
5328
 
            self.outf.write('Deleted tag %s.\n' % tag_name)
5329
 
        else:
5330
 
            if revision:
5331
 
                if len(revision) != 1:
5332
 
                    raise errors.BzrCommandError(
5333
 
                        "Tags can only be placed on a single revision, "
5334
 
                        "not on a range")
5335
 
                revision_id = revision[0].as_revision_id(branch)
 
5020
        branch.lock_write()
 
5021
        try:
 
5022
            if delete:
 
5023
                branch.tags.delete_tag(tag_name)
 
5024
                self.outf.write('Deleted tag %s.\n' % tag_name)
5336
5025
            else:
5337
 
                revision_id = branch.last_revision()
5338
 
            if tag_name is None:
5339
 
                tag_name = branch.automatic_tag_name(revision_id)
5340
 
                if tag_name is None:
5341
 
                    raise errors.BzrCommandError(
5342
 
                        "Please specify a tag name.")
5343
 
            if (not force) and branch.tags.has_tag(tag_name):
5344
 
                raise errors.TagAlreadyExists(tag_name)
5345
 
            branch.tags.set_tag(tag_name, revision_id)
5346
 
            self.outf.write('Created tag %s.\n' % tag_name)
 
5026
                if revision:
 
5027
                    if len(revision) != 1:
 
5028
                        raise errors.BzrCommandError(
 
5029
                            "Tags can only be placed on a single revision, "
 
5030
                            "not on a range")
 
5031
                    revision_id = revision[0].as_revision_id(branch)
 
5032
                else:
 
5033
                    revision_id = branch.last_revision()
 
5034
                if (not force) and branch.tags.has_tag(tag_name):
 
5035
                    raise errors.TagAlreadyExists(tag_name)
 
5036
                branch.tags.set_tag(tag_name, revision_id)
 
5037
                self.outf.write('Created tag %s.\n' % tag_name)
 
5038
        finally:
 
5039
            branch.unlock()
5347
5040
 
5348
5041
 
5349
5042
class cmd_tags(Command):
5350
 
    __doc__ = """List tags.
 
5043
    """List tags.
5351
5044
 
5352
5045
    This command shows a table of tag names and the revisions they reference.
5353
5046
    """
5354
5047
 
5355
5048
    _see_also = ['tag']
5356
5049
    takes_options = [
5357
 
        custom_help('directory',
5358
 
            help='Branch whose tags should be displayed.'),
 
5050
        Option('directory',
 
5051
            help='Branch whose tags should be displayed.',
 
5052
            short_name='d',
 
5053
            type=unicode,
 
5054
            ),
5359
5055
        RegistryOption.from_kwargs('sort',
5360
5056
            'Sort tags by different criteria.', title='Sorting',
5361
5057
            alpha='Sort tags lexicographically (default).',
5378
5074
        if not tags:
5379
5075
            return
5380
5076
 
5381
 
        self.add_cleanup(branch.lock_read().unlock)
5382
 
        if revision:
5383
 
            graph = branch.repository.get_graph()
5384
 
            rev1, rev2 = _get_revision_range(revision, branch, self.name())
5385
 
            revid1, revid2 = rev1.rev_id, rev2.rev_id
5386
 
            # only show revisions between revid1 and revid2 (inclusive)
5387
 
            tags = [(tag, revid) for tag, revid in tags if
5388
 
                graph.is_between(revid, revid1, revid2)]
5389
 
        if sort == 'alpha':
5390
 
            tags.sort()
5391
 
        elif sort == 'time':
5392
 
            timestamps = {}
5393
 
            for tag, revid in tags:
5394
 
                try:
5395
 
                    revobj = branch.repository.get_revision(revid)
5396
 
                except errors.NoSuchRevision:
5397
 
                    timestamp = sys.maxint # place them at the end
5398
 
                else:
5399
 
                    timestamp = revobj.timestamp
5400
 
                timestamps[revid] = timestamp
5401
 
            tags.sort(key=lambda x: timestamps[x[1]])
5402
 
        if not show_ids:
5403
 
            # [ (tag, revid), ... ] -> [ (tag, dotted_revno), ... ]
5404
 
            for index, (tag, revid) in enumerate(tags):
5405
 
                try:
5406
 
                    revno = branch.revision_id_to_dotted_revno(revid)
5407
 
                    if isinstance(revno, tuple):
5408
 
                        revno = '.'.join(map(str, revno))
5409
 
                except errors.NoSuchRevision:
5410
 
                    # Bad tag data/merges can lead to tagged revisions
5411
 
                    # which are not in this branch. Fail gracefully ...
5412
 
                    revno = '?'
5413
 
                tags[index] = (tag, revno)
5414
 
        self.cleanup_now()
 
5077
        branch.lock_read()
 
5078
        try:
 
5079
            if revision:
 
5080
                graph = branch.repository.get_graph()
 
5081
                rev1, rev2 = _get_revision_range(revision, branch, self.name())
 
5082
                revid1, revid2 = rev1.rev_id, rev2.rev_id
 
5083
                # only show revisions between revid1 and revid2 (inclusive)
 
5084
                tags = [(tag, revid) for tag, revid in tags if
 
5085
                    graph.is_between(revid, revid1, revid2)]
 
5086
            if sort == 'alpha':
 
5087
                tags.sort()
 
5088
            elif sort == 'time':
 
5089
                timestamps = {}
 
5090
                for tag, revid in tags:
 
5091
                    try:
 
5092
                        revobj = branch.repository.get_revision(revid)
 
5093
                    except errors.NoSuchRevision:
 
5094
                        timestamp = sys.maxint # place them at the end
 
5095
                    else:
 
5096
                        timestamp = revobj.timestamp
 
5097
                    timestamps[revid] = timestamp
 
5098
                tags.sort(key=lambda x: timestamps[x[1]])
 
5099
            if not show_ids:
 
5100
                # [ (tag, revid), ... ] -> [ (tag, dotted_revno), ... ]
 
5101
                for index, (tag, revid) in enumerate(tags):
 
5102
                    try:
 
5103
                        revno = branch.revision_id_to_dotted_revno(revid)
 
5104
                        if isinstance(revno, tuple):
 
5105
                            revno = '.'.join(map(str, revno))
 
5106
                    except errors.NoSuchRevision:
 
5107
                        # Bad tag data/merges can lead to tagged revisions
 
5108
                        # which are not in this branch. Fail gracefully ...
 
5109
                        revno = '?'
 
5110
                    tags[index] = (tag, revno)
 
5111
        finally:
 
5112
            branch.unlock()
5415
5113
        for tag, revspec in tags:
5416
5114
            self.outf.write('%-20s %s\n' % (tag, revspec))
5417
5115
 
5418
5116
 
5419
5117
class cmd_reconfigure(Command):
5420
 
    __doc__ = """Reconfigure the type of a bzr directory.
 
5118
    """Reconfigure the type of a bzr directory.
5421
5119
 
5422
5120
    A target configuration must be specified.
5423
5121
 
5453
5151
            ),
5454
5152
        Option('bind-to', help='Branch to bind checkout to.', type=str),
5455
5153
        Option('force',
5456
 
            help='Perform reconfiguration even if local changes'
5457
 
            ' will be lost.'),
5458
 
        Option('stacked-on',
5459
 
            help='Reconfigure a branch to be stacked on another branch.',
5460
 
            type=unicode,
5461
 
            ),
5462
 
        Option('unstacked',
5463
 
            help='Reconfigure a branch to be unstacked.  This '
5464
 
                'may require copying substantial data into it.',
5465
 
            ),
 
5154
               help='Perform reconfiguration even if local changes'
 
5155
               ' will be lost.')
5466
5156
        ]
5467
5157
 
5468
 
    def run(self, location=None, target_type=None, bind_to=None, force=False,
5469
 
            stacked_on=None,
5470
 
            unstacked=None):
 
5158
    def run(self, location=None, target_type=None, bind_to=None, force=False):
5471
5159
        directory = bzrdir.BzrDir.open(location)
5472
 
        if stacked_on and unstacked:
5473
 
            raise BzrCommandError("Can't use both --stacked-on and --unstacked")
5474
 
        elif stacked_on is not None:
5475
 
            reconfigure.ReconfigureStackedOn().apply(directory, stacked_on)
5476
 
        elif unstacked:
5477
 
            reconfigure.ReconfigureUnstacked().apply(directory)
5478
 
        # At the moment you can use --stacked-on and a different
5479
 
        # reconfiguration shape at the same time; there seems no good reason
5480
 
        # to ban it.
5481
5160
        if target_type is None:
5482
 
            if stacked_on or unstacked:
5483
 
                return
5484
 
            else:
5485
 
                raise errors.BzrCommandError('No target configuration '
5486
 
                    'specified')
 
5161
            raise errors.BzrCommandError('No target configuration specified')
5487
5162
        elif target_type == 'branch':
5488
5163
            reconfiguration = reconfigure.Reconfigure.to_branch(directory)
5489
5164
        elif target_type == 'tree':
5508
5183
 
5509
5184
 
5510
5185
class cmd_switch(Command):
5511
 
    __doc__ = """Set the branch of a checkout and update.
 
5186
    """Set the branch of a checkout and update.
5512
5187
 
5513
5188
    For lightweight checkouts, this changes the branch being referenced.
5514
5189
    For heavyweight checkouts, this checks that there are no local commits
5526
5201
    /path/to/newbranch.
5527
5202
 
5528
5203
    Bound branches use the nickname of its master branch unless it is set
5529
 
    locally, in which case switching will update the local nickname to be
 
5204
    locally, in which case switching will update the the local nickname to be
5530
5205
    that of the master.
5531
5206
    """
5532
5207
 
5533
 
    takes_args = ['to_location?']
 
5208
    takes_args = ['to_location']
5534
5209
    takes_options = [Option('force',
5535
 
                        help='Switch even if local commits will be lost.'),
5536
 
                     'revision',
5537
 
                     Option('create-branch', short_name='b',
5538
 
                        help='Create the target branch from this one before'
5539
 
                             ' switching to it.'),
5540
 
                    ]
 
5210
                        help='Switch even if local commits will be lost.')
 
5211
                     ]
5541
5212
 
5542
 
    def run(self, to_location=None, force=False, create_branch=False,
5543
 
            revision=None):
 
5213
    def run(self, to_location, force=False):
5544
5214
        from bzrlib import switch
5545
5215
        tree_location = '.'
5546
 
        revision = _get_one_revision('switch', revision)
5547
5216
        control_dir = bzrdir.BzrDir.open_containing(tree_location)[0]
5548
 
        if to_location is None:
5549
 
            if revision is None:
5550
 
                raise errors.BzrCommandError('You must supply either a'
5551
 
                                             ' revision or a location')
5552
 
            to_location = '.'
5553
5217
        try:
5554
5218
            branch = control_dir.open_branch()
5555
5219
            had_explicit_nick = branch.get_config().has_explicit_nickname()
5556
5220
        except errors.NotBranchError:
5557
 
            branch = None
5558
5221
            had_explicit_nick = False
5559
 
        if create_branch:
5560
 
            if branch is None:
5561
 
                raise errors.BzrCommandError('cannot create branch without'
5562
 
                                             ' source branch')
5563
 
            to_location = directory_service.directories.dereference(
5564
 
                              to_location)
5565
 
            if '/' not in to_location and '\\' not in to_location:
5566
 
                # This path is meant to be relative to the existing branch
5567
 
                this_url = self._get_branch_location(control_dir)
5568
 
                to_location = urlutils.join(this_url, '..', to_location)
5569
 
            to_branch = branch.bzrdir.sprout(to_location,
5570
 
                                 possible_transports=[branch.bzrdir.root_transport],
5571
 
                                 source_branch=branch).open_branch()
5572
 
        else:
5573
 
            try:
5574
 
                to_branch = Branch.open(to_location)
5575
 
            except errors.NotBranchError:
5576
 
                this_url = self._get_branch_location(control_dir)
5577
 
                to_branch = Branch.open(
5578
 
                    urlutils.join(this_url, '..', to_location))
5579
 
        if revision is not None:
5580
 
            revision = revision.as_revision_id(to_branch)
5581
 
        switch.switch(control_dir, to_branch, force, revision_id=revision)
 
5222
        try:
 
5223
            to_branch = Branch.open(to_location)
 
5224
        except errors.NotBranchError:
 
5225
            this_url = self._get_branch_location(control_dir)
 
5226
            to_branch = Branch.open(
 
5227
                urlutils.join(this_url, '..', to_location))
 
5228
        switch.switch(control_dir, to_branch, force)
5582
5229
        if had_explicit_nick:
5583
5230
            branch = control_dir.open_branch() #get the new branch!
5584
5231
            branch.nick = to_branch.nick
5604
5251
 
5605
5252
 
5606
5253
class cmd_view(Command):
5607
 
    __doc__ = """Manage filtered views.
 
5254
    """Manage filtered views.
5608
5255
 
5609
5256
    Views provide a mask over the tree so that users can focus on
5610
5257
    a subset of a tree when doing their work. After creating a view,
5758
5405
 
5759
5406
 
5760
5407
class cmd_hooks(Command):
5761
 
    __doc__ = """Show hooks."""
 
5408
    """Show hooks."""
5762
5409
 
5763
5410
    hidden = True
5764
5411
 
5777
5424
                    self.outf.write("    <no hooks installed>\n")
5778
5425
 
5779
5426
 
5780
 
class cmd_remove_branch(Command):
5781
 
    __doc__ = """Remove a branch.
5782
 
 
5783
 
    This will remove the branch from the specified location but 
5784
 
    will keep any working tree or repository in place.
5785
 
 
5786
 
    :Examples:
5787
 
 
5788
 
      Remove the branch at repo/trunk::
5789
 
 
5790
 
        bzr remove-branch repo/trunk
5791
 
 
5792
 
    """
5793
 
 
5794
 
    takes_args = ["location?"]
5795
 
 
5796
 
    aliases = ["rmbranch"]
5797
 
 
5798
 
    def run(self, location=None):
5799
 
        if location is None:
5800
 
            location = "."
5801
 
        branch = Branch.open_containing(location)[0]
5802
 
        branch.bzrdir.destroy_branch()
5803
 
        
5804
 
 
5805
5427
class cmd_shelve(Command):
5806
 
    __doc__ = """Temporarily set aside some changes from the current tree.
 
5428
    """Temporarily set aside some changes from the current tree.
5807
5429
 
5808
5430
    Shelve allows you to temporarily put changes you've made "on the shelf",
5809
5431
    ie. out of the way, until a later time when you can bring them back from
5851
5473
        if writer is None:
5852
5474
            writer = bzrlib.option.diff_writer_registry.get()
5853
5475
        try:
5854
 
            shelver = Shelver.from_args(writer(sys.stdout), revision, all,
5855
 
                file_list, message, destroy=destroy)
5856
 
            try:
5857
 
                shelver.run()
5858
 
            finally:
5859
 
                shelver.finalize()
 
5476
            Shelver.from_args(writer(sys.stdout), revision, all, file_list,
 
5477
                              message, destroy=destroy).run()
5860
5478
        except errors.UserAbort:
5861
5479
            return 0
5862
5480
 
5863
5481
    def run_for_list(self):
5864
5482
        tree = WorkingTree.open_containing('.')[0]
5865
 
        self.add_cleanup(tree.lock_read().unlock)
5866
 
        manager = tree.get_shelf_manager()
5867
 
        shelves = manager.active_shelves()
5868
 
        if len(shelves) == 0:
5869
 
            note('No shelved changes.')
5870
 
            return 0
5871
 
        for shelf_id in reversed(shelves):
5872
 
            message = manager.get_metadata(shelf_id).get('message')
5873
 
            if message is None:
5874
 
                message = '<no message>'
5875
 
            self.outf.write('%3d: %s\n' % (shelf_id, message))
5876
 
        return 1
 
5483
        tree.lock_read()
 
5484
        try:
 
5485
            manager = tree.get_shelf_manager()
 
5486
            shelves = manager.active_shelves()
 
5487
            if len(shelves) == 0:
 
5488
                note('No shelved changes.')
 
5489
                return 0
 
5490
            for shelf_id in reversed(shelves):
 
5491
                message = manager.get_metadata(shelf_id).get('message')
 
5492
                if message is None:
 
5493
                    message = '<no message>'
 
5494
                self.outf.write('%3d: %s\n' % (shelf_id, message))
 
5495
            return 1
 
5496
        finally:
 
5497
            tree.unlock()
5877
5498
 
5878
5499
 
5879
5500
class cmd_unshelve(Command):
5880
 
    __doc__ = """Restore shelved changes.
 
5501
    """Restore shelved changes.
5881
5502
 
5882
5503
    By default, the most recently shelved changes are restored. However if you
5883
5504
    specify a shelf by id those changes will be restored instead.  This works
5891
5512
            enum_switch=False, value_switches=True,
5892
5513
            apply="Apply changes and remove from the shelf.",
5893
5514
            dry_run="Show changes, but do not apply or remove them.",
5894
 
            preview="Instead of unshelving the changes, show the diff that "
5895
 
                    "would result from unshelving.",
5896
 
            delete_only="Delete changes without applying them.",
5897
 
            keep="Apply changes but don't delete them.",
 
5515
            delete_only="Delete changes without applying them."
5898
5516
        )
5899
5517
    ]
5900
5518
    _see_also = ['shelve']
5901
5519
 
5902
5520
    def run(self, shelf_id=None, action='apply'):
5903
5521
        from bzrlib.shelf_ui import Unshelver
5904
 
        unshelver = Unshelver.from_args(shelf_id, action)
5905
 
        try:
5906
 
            unshelver.run()
5907
 
        finally:
5908
 
            unshelver.tree.unlock()
 
5522
        Unshelver.from_args(shelf_id, action).run()
5909
5523
 
5910
5524
 
5911
5525
class cmd_clean_tree(Command):
5912
 
    __doc__ = """Remove unwanted files from working tree.
 
5526
    """Remove unwanted files from working tree.
5913
5527
 
5914
5528
    By default, only unknown files, not ignored files, are deleted.  Versioned
5915
5529
    files are never deleted.
5923
5537
 
5924
5538
    To check what clean-tree will do, use --dry-run.
5925
5539
    """
5926
 
    takes_options = ['directory',
5927
 
                     Option('ignored', help='Delete all ignored files.'),
 
5540
    takes_options = [Option('ignored', help='Delete all ignored files.'),
5928
5541
                     Option('detritus', help='Delete conflict files, merge'
5929
5542
                            ' backups, and failed selftest dirs.'),
5930
5543
                     Option('unknown',
5933
5546
                            ' deleting them.'),
5934
5547
                     Option('force', help='Do not prompt before deleting.')]
5935
5548
    def run(self, unknown=False, ignored=False, detritus=False, dry_run=False,
5936
 
            force=False, directory=u'.'):
 
5549
            force=False):
5937
5550
        from bzrlib.clean_tree import clean_tree
5938
5551
        if not (unknown or ignored or detritus):
5939
5552
            unknown = True
5940
5553
        if dry_run:
5941
5554
            force = True
5942
 
        clean_tree(directory, unknown=unknown, ignored=ignored,
5943
 
                   detritus=detritus, dry_run=dry_run, no_prompt=force)
 
5555
        clean_tree('.', unknown=unknown, ignored=ignored, detritus=detritus,
 
5556
                   dry_run=dry_run, no_prompt=force)
5944
5557
 
5945
5558
 
5946
5559
class cmd_reference(Command):
5947
 
    __doc__ = """list, view and set branch locations for nested trees.
 
5560
    """list, view and set branch locations for nested trees.
5948
5561
 
5949
5562
    If no arguments are provided, lists the branch locations for nested trees.
5950
5563
    If one argument is provided, display the branch location for that tree.
5990
5603
            self.outf.write('%s %s\n' % (path, location))
5991
5604
 
5992
5605
 
5993
 
def _register_lazy_builtins():
5994
 
    # register lazy builtins from other modules; called at startup and should
5995
 
    # be only called once.
5996
 
    for (name, aliases, module_name) in [
5997
 
        ('cmd_bundle_info', [], 'bzrlib.bundle.commands'),
5998
 
        ('cmd_dpush', [], 'bzrlib.foreign'),
5999
 
        ('cmd_version_info', [], 'bzrlib.cmd_version_info'),
6000
 
        ('cmd_resolve', ['resolved'], 'bzrlib.conflicts'),
6001
 
        ('cmd_conflicts', [], 'bzrlib.conflicts'),
6002
 
        ('cmd_sign_my_commits', [], 'bzrlib.sign_my_commits'),
6003
 
        ]:
6004
 
        builtin_command_registry.register_lazy(name, aliases, module_name)
 
5606
# these get imported and then picked up by the scan for cmd_*
 
5607
# TODO: Some more consistent way to split command definitions across files;
 
5608
# we do need to load at least some information about them to know of
 
5609
# aliases.  ideally we would avoid loading the implementation until the
 
5610
# details were needed.
 
5611
from bzrlib.cmd_version_info import cmd_version_info
 
5612
from bzrlib.conflicts import cmd_resolve, cmd_conflicts, restore
 
5613
from bzrlib.bundle.commands import (
 
5614
    cmd_bundle_info,
 
5615
    )
 
5616
from bzrlib.foreign import cmd_dpush
 
5617
from bzrlib.sign_my_commits import cmd_sign_my_commits
 
5618
from bzrlib.weave_commands import cmd_versionedfile_list, \
 
5619
        cmd_weave_plan_merge, cmd_weave_merge_text