/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: Sidnei da Silva
  • Date: 2009-06-05 01:37:21 UTC
  • mto: (4531.1.1 integration)
  • mto: This revision was merged to the branch mainline in revision 4532.
  • Revision ID: sidnei.da.silva@canonical.com-20090605013721-w0urfus3il6tbxoi
- Start of a batch file

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)
1028
949
        if revision is not None:
1029
950
            revision_id = revision.as_revision_id(branch_from)
1030
951
 
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)
 
952
        branch_to.lock_write()
 
953
        try:
 
954
            if tree_to is not None:
 
955
                view_info = _get_view_info_for_change_reporter(tree_to)
 
956
                change_reporter = delta._ChangeReporter(
 
957
                    unversioned_filter=tree_to.is_ignored, view_info=view_info)
 
958
                result = tree_to.pull(branch_from, overwrite, revision_id,
 
959
                                      change_reporter,
 
960
                                      possible_transports=possible_transports,
 
961
                                      local=local)
 
962
            else:
 
963
                result = branch_to.pull(branch_from, overwrite, revision_id,
 
964
                                      local=local)
1042
965
 
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)
 
966
            result.report(self.outf)
 
967
            if verbose and result.old_revid != result.new_revid:
 
968
                log.show_branch_change(branch_to, self.outf, result.old_revno,
 
969
                                       result.old_revid)
 
970
        finally:
 
971
            branch_to.unlock()
1048
972
 
1049
973
 
1050
974
class cmd_push(Command):
1051
 
    __doc__ = """Update a mirror of this branch.
 
975
    """Update a mirror of this branch.
1052
976
 
1053
977
    The target branch will not have its working tree populated because this
1054
978
    is both expensive, and is not supported on remote file systems.
1078
1002
        Option('create-prefix',
1079
1003
               help='Create the path leading up to the branch '
1080
1004
                    'if it does not already exist.'),
1081
 
        custom_help('directory',
 
1005
        Option('directory',
1082
1006
            help='Branch to push from, '
1083
 
                 'rather than the one containing the working directory.'),
 
1007
                 'rather than the one containing the working directory.',
 
1008
            short_name='d',
 
1009
            type=unicode,
 
1010
            ),
1084
1011
        Option('use-existing-dir',
1085
1012
               help='By default push will fail if the target'
1086
1013
                    ' directory exists, but does not already'
1094
1021
                'for the commit history. Only the work not present in the '
1095
1022
                'referenced branch is included in the branch created.',
1096
1023
            type=unicode),
1097
 
        Option('strict',
1098
 
               help='Refuse to push if there are uncommitted changes in'
1099
 
               ' the working tree, --no-strict disables the check.'),
1100
1024
        ]
1101
1025
    takes_args = ['location?']
1102
1026
    encoding_type = 'replace'
1104
1028
    def run(self, location=None, remember=False, overwrite=False,
1105
1029
        create_prefix=False, verbose=False, revision=None,
1106
1030
        use_existing_dir=False, directory=None, stacked_on=None,
1107
 
        stacked=False, strict=None):
 
1031
        stacked=False):
1108
1032
        from bzrlib.push import _show_push_branch
1109
1033
 
 
1034
        # Get the source branch and revision_id
1110
1035
        if directory is None:
1111
1036
            directory = '.'
1112
 
        # Get the source branch
1113
 
        (tree, br_from,
1114
 
         _unused) = bzrdir.BzrDir.open_containing_tree_or_branch(directory)
1115
 
        # Get the tip's revision_id
 
1037
        br_from = Branch.open_containing(directory)[0]
1116
1038
        revision = _get_one_revision('push', revision)
1117
1039
        if revision is not None:
1118
1040
            revision_id = revision.in_history(br_from).rev_id
1119
1041
        else:
1120
1042
            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.')
 
1043
 
1126
1044
        # Get the stacked_on branch, if any
1127
1045
        if stacked_on is not None:
1128
1046
            stacked_on = urlutils.normalize_url(stacked_on)
1160
1078
 
1161
1079
 
1162
1080
class cmd_branch(Command):
1163
 
    __doc__ = """Create a new branch that is a copy of an existing branch.
 
1081
    """Create a new copy of a branch.
1164
1082
 
1165
1083
    If the TO_LOCATION is omitted, the last component of the FROM_LOCATION will
1166
1084
    be used.  In other words, "branch ../foo/bar" will attempt to create ./bar.
1179
1097
        help='Hard-link working tree files where possible.'),
1180
1098
        Option('no-tree',
1181
1099
            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
1100
        Option('stacked',
1186
1101
            help='Create a stacked branch referring to the source branch. '
1187
1102
                'The new branch will depend on the availability of the source '
1188
1103
                'branch for all operations.'),
1189
1104
        Option('standalone',
1190
1105
               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
1106
        ]
1199
1107
    aliases = ['get', 'clone']
1200
1108
 
1201
1109
    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
 
1110
            hardlink=False, stacked=False, standalone=False, no_tree=False):
1205
1111
        from bzrlib.tag import _merge_tags_if_possible
 
1112
 
1206
1113
        accelerator_tree, br_from = bzrdir.BzrDir.open_tree_or_branch(
1207
1114
            from_location)
1208
1115
        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)
 
1116
        br_from.lock_read()
1220
1117
        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)
 
1118
            if revision is not None:
 
1119
                revision_id = revision.as_revision_id(br_from)
1226
1120
            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'))
 
1121
                # FIXME - wt.last_revision, fallback to branch, fall back to
 
1122
                # None or perhaps NULL_REVISION to mean copy nothing
 
1123
                # RBC 20060209
 
1124
                revision_id = br_from.last_revision()
 
1125
            if to_location is None:
 
1126
                to_location = urlutils.derive_to_location(from_location)
 
1127
            to_transport = transport.get_transport(to_location)
 
1128
            try:
 
1129
                to_transport.mkdir('.')
 
1130
            except errors.FileExists:
 
1131
                raise errors.BzrCommandError('Target directory "%s" already'
 
1132
                                             ' exists.' % to_location)
 
1133
            except errors.NoSuchFile:
 
1134
                raise errors.BzrCommandError('Parent of "%s" does not exist.'
 
1135
                                             % to_location)
 
1136
            try:
 
1137
                # preserve whatever source format we have.
 
1138
                dir = br_from.bzrdir.sprout(to_transport.base, revision_id,
 
1139
                                            possible_transports=[to_transport],
 
1140
                                            accelerator_tree=accelerator_tree,
 
1141
                                            hardlink=hardlink, stacked=stacked,
 
1142
                                            force_new_repo=standalone,
 
1143
                                            create_tree_if_local=not no_tree,
 
1144
                                            source_branch=br_from)
 
1145
                branch = dir.open_branch()
 
1146
            except errors.NoSuchRevision:
 
1147
                to_transport.delete_tree('.')
 
1148
                msg = "The branch %s has no revision %s." % (from_location,
 
1149
                    revision)
 
1150
                raise errors.BzrCommandError(msg)
 
1151
            _merge_tags_if_possible(br_from, branch)
 
1152
            # If the source branch is stacked, the new branch may
 
1153
            # be stacked whether we asked for that explicitly or not.
 
1154
            # We therefore need a try/except here and not just 'if stacked:'
 
1155
            try:
 
1156
                note('Created new stacked branch referring to %s.' %
 
1157
                    branch.get_stacked_on_url())
 
1158
            except (errors.NotStacked, errors.UnstackableBranchFormat,
 
1159
                errors.UnstackableRepositoryFormat), e:
 
1160
                note('Branched %d revision(s).' % branch.revno())
 
1161
        finally:
 
1162
            br_from.unlock()
1272
1163
 
1273
1164
 
1274
1165
class cmd_checkout(Command):
1275
 
    __doc__ = """Create a new checkout of an existing branch.
 
1166
    """Create a new checkout of an existing branch.
1276
1167
 
1277
1168
    If BRANCH_LOCATION is omitted, checkout will reconstitute a working tree for
1278
1169
    the branch found in '.'. This is useful if you have removed the working tree
1336
1227
            except errors.NoWorkingTree:
1337
1228
                source.bzrdir.create_workingtree(revision_id)
1338
1229
                return
1339
 
 
1340
 
        if not lightweight:
1341
 
            message = ('Copying history to "%s". '
1342
 
                'To checkout without local history use --lightweight.' % to_location)
1343
 
            ui.ui_factory.show_message(message)
1344
1230
        source.create_checkout(to_location, revision_id, lightweight,
1345
1231
                               accelerator_tree, hardlink)
1346
1232
 
1347
1233
 
1348
1234
class cmd_renames(Command):
1349
 
    __doc__ = """Show list of renamed files.
 
1235
    """Show list of renamed files.
1350
1236
    """
1351
1237
    # TODO: Option to show renames between two historical versions.
1352
1238
 
1357
1243
    @display_command
1358
1244
    def run(self, dir=u'.'):
1359
1245
        tree = WorkingTree.open_containing(dir)[0]
1360
 
        self.add_cleanup(tree.lock_read().unlock)
1361
 
        new_inv = tree.inventory
1362
 
        old_tree = tree.basis_tree()
1363
 
        self.add_cleanup(old_tree.lock_read().unlock)
1364
 
        old_inv = old_tree.inventory
1365
 
        renames = []
1366
 
        iterator = tree.iter_changes(old_tree, include_unchanged=True)
1367
 
        for f, paths, c, v, p, n, k, e in iterator:
1368
 
            if paths[0] == paths[1]:
1369
 
                continue
1370
 
            if None in (paths):
1371
 
                continue
1372
 
            renames.append(paths)
1373
 
        renames.sort()
1374
 
        for old_name, new_name in renames:
1375
 
            self.outf.write("%s => %s\n" % (old_name, new_name))
 
1246
        tree.lock_read()
 
1247
        try:
 
1248
            new_inv = tree.inventory
 
1249
            old_tree = tree.basis_tree()
 
1250
            old_tree.lock_read()
 
1251
            try:
 
1252
                old_inv = old_tree.inventory
 
1253
                renames = []
 
1254
                iterator = tree.iter_changes(old_tree, include_unchanged=True)
 
1255
                for f, paths, c, v, p, n, k, e in iterator:
 
1256
                    if paths[0] == paths[1]:
 
1257
                        continue
 
1258
                    if None in (paths):
 
1259
                        continue
 
1260
                    renames.append(paths)
 
1261
                renames.sort()
 
1262
                for old_name, new_name in renames:
 
1263
                    self.outf.write("%s => %s\n" % (old_name, new_name))
 
1264
            finally:
 
1265
                old_tree.unlock()
 
1266
        finally:
 
1267
            tree.unlock()
1376
1268
 
1377
1269
 
1378
1270
class cmd_update(Command):
1379
 
    __doc__ = """Update a tree to have the latest code committed to its branch.
 
1271
    """Update a tree to have the latest code committed to its branch.
1380
1272
 
1381
1273
    This will perform a merge into the working tree, and may generate
1382
1274
    conflicts. If you have any local changes, you will still
1384
1276
 
1385
1277
    If you want to discard your local changes, you can just do a
1386
1278
    'bzr revert' instead of 'bzr commit' after the update.
1387
 
 
1388
 
    If the tree's branch is bound to a master branch, it will also update
1389
 
    the branch from the master.
1390
1279
    """
1391
1280
 
1392
1281
    _see_also = ['pull', 'working-trees', 'status-flags']
1393
1282
    takes_args = ['dir?']
1394
 
    takes_options = ['revision']
1395
1283
    aliases = ['up']
1396
1284
 
1397
 
    def run(self, dir='.', revision=None):
1398
 
        if revision is not None and len(revision) != 1:
1399
 
            raise errors.BzrCommandError(
1400
 
                        "bzr update --revision takes exactly one revision")
 
1285
    def run(self, dir='.'):
1401
1286
        tree = WorkingTree.open_containing(dir)[0]
1402
 
        branch = tree.branch
1403
1287
        possible_transports = []
1404
 
        master = branch.get_master_branch(
 
1288
        master = tree.branch.get_master_branch(
1405
1289
            possible_transports=possible_transports)
1406
1290
        if master is not None:
1407
 
            branch_location = master.base
1408
1291
            tree.lock_write()
1409
1292
        else:
1410
 
            branch_location = tree.branch.base
1411
1293
            tree.lock_tree_write()
1412
 
        self.add_cleanup(tree.unlock)
1413
 
        # get rid of the final '/' and be ready for display
1414
 
        branch_location = urlutils.unescape_for_display(
1415
 
            branch_location.rstrip('/'),
1416
 
            self.outf.encoding)
1417
 
        existing_pending_merges = tree.get_parent_ids()[1:]
1418
 
        if master is None:
1419
 
            old_tip = None
1420
 
        else:
1421
 
            # may need to fetch data into a heavyweight checkout
1422
 
            # XXX: this may take some time, maybe we should display a
1423
 
            # message
1424
 
            old_tip = branch.update(possible_transports)
1425
 
        if revision is not None:
1426
 
            revision_id = revision[0].as_revision_id(branch)
1427
 
        else:
1428
 
            revision_id = branch.last_revision()
1429
 
        if revision_id == _mod_revision.ensure_null(tree.last_revision()):
1430
 
            revno = branch.revision_id_to_dotted_revno(revision_id)
1431
 
            note("Tree is up to date at revision %s of branch %s" %
1432
 
                ('.'.join(map(str, revno)), branch_location))
1433
 
            return 0
1434
 
        view_info = _get_view_info_for_change_reporter(tree)
1435
 
        change_reporter = delta._ChangeReporter(
1436
 
            unversioned_filter=tree.is_ignored,
1437
 
            view_info=view_info)
1438
1294
        try:
 
1295
            existing_pending_merges = tree.get_parent_ids()[1:]
 
1296
            last_rev = _mod_revision.ensure_null(tree.last_revision())
 
1297
            if last_rev == _mod_revision.ensure_null(
 
1298
                tree.branch.last_revision()):
 
1299
                # may be up to date, check master too.
 
1300
                if master is None or last_rev == _mod_revision.ensure_null(
 
1301
                    master.last_revision()):
 
1302
                    revno = tree.branch.revision_id_to_revno(last_rev)
 
1303
                    note("Tree is up to date at revision %d." % (revno,))
 
1304
                    return 0
 
1305
            view_info = _get_view_info_for_change_reporter(tree)
1439
1306
            conflicts = tree.update(
1440
 
                change_reporter,
1441
 
                possible_transports=possible_transports,
1442
 
                revision=revision_id,
1443
 
                old_tip=old_tip)
1444
 
        except errors.NoSuchRevision, e:
1445
 
            raise errors.BzrCommandError(
1446
 
                                  "branch has no revision %s\n"
1447
 
                                  "bzr update --revision only works"
1448
 
                                  " for a revision in the branch history"
1449
 
                                  % (e.revision))
1450
 
        revno = tree.branch.revision_id_to_dotted_revno(
1451
 
            _mod_revision.ensure_null(tree.last_revision()))
1452
 
        note('Updated to revision %s of branch %s' %
1453
 
             ('.'.join(map(str, revno)), branch_location))
1454
 
        parent_ids = tree.get_parent_ids()
1455
 
        if parent_ids[1:] and parent_ids[1:] != existing_pending_merges:
1456
 
            note('Your local commits will now show as pending merges with '
1457
 
                 "'bzr status', and can be committed with 'bzr commit'.")
1458
 
        if conflicts != 0:
1459
 
            return 1
1460
 
        else:
1461
 
            return 0
 
1307
                delta._ChangeReporter(unversioned_filter=tree.is_ignored,
 
1308
                view_info=view_info), possible_transports=possible_transports)
 
1309
            revno = tree.branch.revision_id_to_revno(
 
1310
                _mod_revision.ensure_null(tree.last_revision()))
 
1311
            note('Updated to revision %d.' % (revno,))
 
1312
            if tree.get_parent_ids()[1:] != existing_pending_merges:
 
1313
                note('Your local commits will now show as pending merges with '
 
1314
                     "'bzr status', and can be committed with 'bzr commit'.")
 
1315
            if conflicts != 0:
 
1316
                return 1
 
1317
            else:
 
1318
                return 0
 
1319
        finally:
 
1320
            tree.unlock()
1462
1321
 
1463
1322
 
1464
1323
class cmd_info(Command):
1465
 
    __doc__ = """Show information about a working tree, branch or repository.
 
1324
    """Show information about a working tree, branch or repository.
1466
1325
 
1467
1326
    This command will show all known locations and formats associated to the
1468
1327
    tree, branch or repository.
1506
1365
 
1507
1366
 
1508
1367
class cmd_remove(Command):
1509
 
    __doc__ = """Remove files or directories.
 
1368
    """Remove files or directories.
1510
1369
 
1511
1370
    This makes bzr stop tracking changes to the specified files. bzr will delete
1512
1371
    them if they can easily be recovered using revert. If no options or
1521
1380
            title='Deletion Strategy', value_switches=True, enum_switch=False,
1522
1381
            safe='Only delete files if they can be'
1523
1382
                 ' safely recovered (default).',
1524
 
            keep='Delete from bzr but leave the working copy.',
 
1383
            keep="Don't delete any files.",
1525
1384
            force='Delete all the specified files, even if they can not be '
1526
1385
                'recovered and even if they are non-empty directories.')]
1527
1386
    aliases = ['rm', 'del']
1534
1393
        if file_list is not None:
1535
1394
            file_list = [f for f in file_list]
1536
1395
 
1537
 
        self.add_cleanup(tree.lock_write().unlock)
1538
 
        # Heuristics should probably all move into tree.remove_smart or
1539
 
        # some such?
1540
 
        if new:
1541
 
            added = tree.changes_from(tree.basis_tree(),
1542
 
                specific_files=file_list).added
1543
 
            file_list = sorted([f[0] for f in added], reverse=True)
1544
 
            if len(file_list) == 0:
1545
 
                raise errors.BzrCommandError('No matching files.')
1546
 
        elif file_list is None:
1547
 
            # missing files show up in iter_changes(basis) as
1548
 
            # versioned-with-no-kind.
1549
 
            missing = []
1550
 
            for change in tree.iter_changes(tree.basis_tree()):
1551
 
                # Find paths in the working tree that have no kind:
1552
 
                if change[1][1] is not None and change[6][1] is None:
1553
 
                    missing.append(change[1][1])
1554
 
            file_list = sorted(missing, reverse=True)
1555
 
            file_deletion_strategy = 'keep'
1556
 
        tree.remove(file_list, verbose=verbose, to_file=self.outf,
1557
 
            keep_files=file_deletion_strategy=='keep',
1558
 
            force=file_deletion_strategy=='force')
 
1396
        tree.lock_write()
 
1397
        try:
 
1398
            # Heuristics should probably all move into tree.remove_smart or
 
1399
            # some such?
 
1400
            if new:
 
1401
                added = tree.changes_from(tree.basis_tree(),
 
1402
                    specific_files=file_list).added
 
1403
                file_list = sorted([f[0] for f in added], reverse=True)
 
1404
                if len(file_list) == 0:
 
1405
                    raise errors.BzrCommandError('No matching files.')
 
1406
            elif file_list is None:
 
1407
                # missing files show up in iter_changes(basis) as
 
1408
                # versioned-with-no-kind.
 
1409
                missing = []
 
1410
                for change in tree.iter_changes(tree.basis_tree()):
 
1411
                    # Find paths in the working tree that have no kind:
 
1412
                    if change[1][1] is not None and change[6][1] is None:
 
1413
                        missing.append(change[1][1])
 
1414
                file_list = sorted(missing, reverse=True)
 
1415
                file_deletion_strategy = 'keep'
 
1416
            tree.remove(file_list, verbose=verbose, to_file=self.outf,
 
1417
                keep_files=file_deletion_strategy=='keep',
 
1418
                force=file_deletion_strategy=='force')
 
1419
        finally:
 
1420
            tree.unlock()
1559
1421
 
1560
1422
 
1561
1423
class cmd_file_id(Command):
1562
 
    __doc__ = """Print file_id of a particular file or directory.
 
1424
    """Print file_id of a particular file or directory.
1563
1425
 
1564
1426
    The file_id is assigned when the file is first added and remains the
1565
1427
    same through all revisions where the file exists, even when it is
1581
1443
 
1582
1444
 
1583
1445
class cmd_file_path(Command):
1584
 
    __doc__ = """Print path of file_ids to a file or directory.
 
1446
    """Print path of file_ids to a file or directory.
1585
1447
 
1586
1448
    This prints one line for each directory down to the target,
1587
1449
    starting at the branch root.
1603
1465
 
1604
1466
 
1605
1467
class cmd_reconcile(Command):
1606
 
    __doc__ = """Reconcile bzr metadata in a branch.
 
1468
    """Reconcile bzr metadata in a branch.
1607
1469
 
1608
1470
    This can correct data mismatches that may have been caused by
1609
1471
    previous ghost operations or bzr upgrades. You should only
1631
1493
 
1632
1494
 
1633
1495
class cmd_revision_history(Command):
1634
 
    __doc__ = """Display the list of revision ids on a branch."""
 
1496
    """Display the list of revision ids on a branch."""
1635
1497
 
1636
1498
    _see_also = ['log']
1637
1499
    takes_args = ['location?']
1647
1509
 
1648
1510
 
1649
1511
class cmd_ancestry(Command):
1650
 
    __doc__ = """List all revisions merged into this branch."""
 
1512
    """List all revisions merged into this branch."""
1651
1513
 
1652
1514
    _see_also = ['log', 'revision-history']
1653
1515
    takes_args = ['location?']
1672
1534
 
1673
1535
 
1674
1536
class cmd_init(Command):
1675
 
    __doc__ = """Make a directory into a versioned branch.
 
1537
    """Make a directory into a versioned branch.
1676
1538
 
1677
1539
    Use this to create an empty branch, or before importing an
1678
1540
    existing project.
1706
1568
                lazy_registry=('bzrlib.bzrdir', 'format_registry'),
1707
1569
                converter=lambda name: bzrdir.format_registry.make_bzrdir(name),
1708
1570
                value_switches=True,
1709
 
                title="Branch format",
 
1571
                title="Branch Format",
1710
1572
                ),
1711
1573
         Option('append-revisions-only',
1712
1574
                help='Never change revnos or the existing log.'
1759
1621
                branch.set_append_revisions_only(True)
1760
1622
            except errors.UpgradeRequired:
1761
1623
                raise errors.BzrCommandError('This branch format cannot be set'
1762
 
                    ' to append-revisions-only.  Try --default.')
 
1624
                    ' to append-revisions-only.  Try --experimental-branch6')
1763
1625
        if not is_quiet():
1764
1626
            from bzrlib.info import describe_layout, describe_format
1765
1627
            try:
1781
1643
 
1782
1644
 
1783
1645
class cmd_init_repository(Command):
1784
 
    __doc__ = """Create a shared repository for branches to share storage space.
 
1646
    """Create a shared repository to hold branches.
1785
1647
 
1786
1648
    New branches created under the repository directory will store their
1787
 
    revisions in the repository, not in the branch directory.  For branches
1788
 
    with shared history, this reduces the amount of storage needed and 
1789
 
    speeds up the creation of new branches.
 
1649
    revisions in the repository, not in the branch directory.
1790
1650
 
1791
 
    If the --no-trees option is given then the branches in the repository
1792
 
    will not have working trees by default.  They will still exist as 
1793
 
    directories on disk, but they will not have separate copies of the 
1794
 
    files at a certain revision.  This can be useful for repositories that
1795
 
    store branches which are interacted with through checkouts or remote
1796
 
    branches, such as on a server.
 
1651
    If the --no-trees option is used then the branches in the repository
 
1652
    will not have working trees by default.
1797
1653
 
1798
1654
    :Examples:
1799
 
        Create a shared repository holding just branches::
 
1655
        Create a shared repositories holding just branches::
1800
1656
 
1801
1657
            bzr init-repo --no-trees repo
1802
1658
            bzr init repo/trunk
1841
1697
 
1842
1698
 
1843
1699
class cmd_diff(Command):
1844
 
    __doc__ = """Show differences in the working tree, between revisions or branches.
 
1700
    """Show differences in the working tree, between revisions or branches.
1845
1701
 
1846
1702
    If no arguments are given, all changes for the current tree are listed.
1847
1703
    If files are given, only the changes in those files are listed.
1868
1724
 
1869
1725
            bzr diff -r1
1870
1726
 
1871
 
        Difference between revision 3 and revision 1::
1872
 
 
1873
 
            bzr diff -r1..3
1874
 
 
1875
 
        Difference between revision 3 and revision 1 for branch xxx::
1876
 
 
1877
 
            bzr diff -r1..3 xxx
1878
 
 
1879
 
        To see the changes introduced in revision X::
1880
 
        
1881
 
            bzr diff -cX
1882
 
 
1883
 
        Note that in the case of a merge, the -c option shows the changes
1884
 
        compared to the left hand parent. To see the changes against
1885
 
        another parent, use::
1886
 
 
1887
 
            bzr diff -r<chosen_parent>..X
1888
 
 
1889
 
        The changes introduced by revision 2 (equivalent to -r1..2)::
1890
 
 
1891
 
            bzr diff -c2
 
1727
        Difference between revision 2 and revision 1::
 
1728
 
 
1729
            bzr diff -r1..2
 
1730
 
 
1731
        Difference between revision 2 and revision 1 for branch xxx::
 
1732
 
 
1733
            bzr diff -r1..2 xxx
1892
1734
 
1893
1735
        Show just the differences for file NEWS::
1894
1736
 
1933
1775
            help='Use this command to compare files.',
1934
1776
            type=unicode,
1935
1777
            ),
1936
 
        RegistryOption('format',
1937
 
            help='Diff format to use.',
1938
 
            lazy_registry=('bzrlib.diff', 'format_registry'),
1939
 
            value_switches=False, title='Diff format'),
1940
1778
        ]
1941
1779
    aliases = ['di', 'dif']
1942
1780
    encoding_type = 'exact'
1943
1781
 
1944
1782
    @display_command
1945
1783
    def run(self, revision=None, file_list=None, diff_options=None,
1946
 
            prefix=None, old=None, new=None, using=None, format=None):
1947
 
        from bzrlib.diff import (get_trees_and_branches_to_diff_locked,
1948
 
            show_diff_trees)
 
1784
            prefix=None, old=None, new=None, using=None):
 
1785
        from bzrlib.diff import _get_trees_to_diff, show_diff_trees
1949
1786
 
1950
1787
        if (prefix is None) or (prefix == '0'):
1951
1788
            # diff -p0 format
1965
1802
            raise errors.BzrCommandError('bzr diff --revision takes exactly'
1966
1803
                                         ' one or two revision specifiers')
1967
1804
 
1968
 
        if using is not None and format is not None:
1969
 
            raise errors.BzrCommandError('--using and --format are mutually '
1970
 
                'exclusive.')
1971
 
 
1972
 
        (old_tree, new_tree,
1973
 
         old_branch, new_branch,
1974
 
         specific_files, extra_trees) = get_trees_and_branches_to_diff_locked(
1975
 
            file_list, revision, old, new, self.add_cleanup, apply_view=True)
 
1805
        old_tree, new_tree, specific_files, extra_trees = \
 
1806
                _get_trees_to_diff(file_list, revision, old, new,
 
1807
                apply_view=True)
1976
1808
        return show_diff_trees(old_tree, new_tree, sys.stdout,
1977
1809
                               specific_files=specific_files,
1978
1810
                               external_diff_options=diff_options,
1979
1811
                               old_label=old_label, new_label=new_label,
1980
 
                               extra_trees=extra_trees, using=using,
1981
 
                               format_cls=format)
 
1812
                               extra_trees=extra_trees, using=using)
1982
1813
 
1983
1814
 
1984
1815
class cmd_deleted(Command):
1985
 
    __doc__ = """List files deleted in the working tree.
 
1816
    """List files deleted in the working tree.
1986
1817
    """
1987
1818
    # TODO: Show files deleted since a previous revision, or
1988
1819
    # between two revisions.
1991
1822
    # level of effort but possibly much less IO.  (Or possibly not,
1992
1823
    # if the directories are very large...)
1993
1824
    _see_also = ['status', 'ls']
1994
 
    takes_options = ['directory', 'show-ids']
 
1825
    takes_options = ['show-ids']
1995
1826
 
1996
1827
    @display_command
1997
 
    def run(self, show_ids=False, directory=u'.'):
1998
 
        tree = WorkingTree.open_containing(directory)[0]
1999
 
        self.add_cleanup(tree.lock_read().unlock)
2000
 
        old = tree.basis_tree()
2001
 
        self.add_cleanup(old.lock_read().unlock)
2002
 
        for path, ie in old.inventory.iter_entries():
2003
 
            if not tree.has_id(ie.file_id):
2004
 
                self.outf.write(path)
2005
 
                if show_ids:
2006
 
                    self.outf.write(' ')
2007
 
                    self.outf.write(ie.file_id)
2008
 
                self.outf.write('\n')
 
1828
    def run(self, show_ids=False):
 
1829
        tree = WorkingTree.open_containing(u'.')[0]
 
1830
        tree.lock_read()
 
1831
        try:
 
1832
            old = tree.basis_tree()
 
1833
            old.lock_read()
 
1834
            try:
 
1835
                for path, ie in old.inventory.iter_entries():
 
1836
                    if not tree.has_id(ie.file_id):
 
1837
                        self.outf.write(path)
 
1838
                        if show_ids:
 
1839
                            self.outf.write(' ')
 
1840
                            self.outf.write(ie.file_id)
 
1841
                        self.outf.write('\n')
 
1842
            finally:
 
1843
                old.unlock()
 
1844
        finally:
 
1845
            tree.unlock()
2009
1846
 
2010
1847
 
2011
1848
class cmd_modified(Command):
2012
 
    __doc__ = """List files modified in working tree.
 
1849
    """List files modified in working tree.
2013
1850
    """
2014
1851
 
2015
1852
    hidden = True
2016
1853
    _see_also = ['status', 'ls']
2017
 
    takes_options = ['directory', 'null']
 
1854
    takes_options = [
 
1855
            Option('null',
 
1856
                   help='Write an ascii NUL (\\0) separator '
 
1857
                   'between files rather than a newline.')
 
1858
            ]
2018
1859
 
2019
1860
    @display_command
2020
 
    def run(self, null=False, directory=u'.'):
2021
 
        tree = WorkingTree.open_containing(directory)[0]
 
1861
    def run(self, null=False):
 
1862
        tree = WorkingTree.open_containing(u'.')[0]
2022
1863
        td = tree.changes_from(tree.basis_tree())
2023
1864
        for path, id, kind, text_modified, meta_modified in td.modified:
2024
1865
            if null:
2028
1869
 
2029
1870
 
2030
1871
class cmd_added(Command):
2031
 
    __doc__ = """List files added in working tree.
 
1872
    """List files added in working tree.
2032
1873
    """
2033
1874
 
2034
1875
    hidden = True
2035
1876
    _see_also = ['status', 'ls']
2036
 
    takes_options = ['directory', 'null']
 
1877
    takes_options = [
 
1878
            Option('null',
 
1879
                   help='Write an ascii NUL (\\0) separator '
 
1880
                   'between files rather than a newline.')
 
1881
            ]
2037
1882
 
2038
1883
    @display_command
2039
 
    def run(self, null=False, directory=u'.'):
2040
 
        wt = WorkingTree.open_containing(directory)[0]
2041
 
        self.add_cleanup(wt.lock_read().unlock)
2042
 
        basis = wt.basis_tree()
2043
 
        self.add_cleanup(basis.lock_read().unlock)
2044
 
        basis_inv = basis.inventory
2045
 
        inv = wt.inventory
2046
 
        for file_id in inv:
2047
 
            if file_id in basis_inv:
2048
 
                continue
2049
 
            if inv.is_root(file_id) and len(basis_inv) == 0:
2050
 
                continue
2051
 
            path = inv.id2path(file_id)
2052
 
            if not os.access(osutils.pathjoin(wt.basedir, path), os.F_OK):
2053
 
                continue
2054
 
            if null:
2055
 
                self.outf.write(path + '\0')
2056
 
            else:
2057
 
                self.outf.write(osutils.quotefn(path) + '\n')
 
1884
    def run(self, null=False):
 
1885
        wt = WorkingTree.open_containing(u'.')[0]
 
1886
        wt.lock_read()
 
1887
        try:
 
1888
            basis = wt.basis_tree()
 
1889
            basis.lock_read()
 
1890
            try:
 
1891
                basis_inv = basis.inventory
 
1892
                inv = wt.inventory
 
1893
                for file_id in inv:
 
1894
                    if file_id in basis_inv:
 
1895
                        continue
 
1896
                    if inv.is_root(file_id) and len(basis_inv) == 0:
 
1897
                        continue
 
1898
                    path = inv.id2path(file_id)
 
1899
                    if not os.access(osutils.abspath(path), os.F_OK):
 
1900
                        continue
 
1901
                    if null:
 
1902
                        self.outf.write(path + '\0')
 
1903
                    else:
 
1904
                        self.outf.write(osutils.quotefn(path) + '\n')
 
1905
            finally:
 
1906
                basis.unlock()
 
1907
        finally:
 
1908
            wt.unlock()
2058
1909
 
2059
1910
 
2060
1911
class cmd_root(Command):
2061
 
    __doc__ = """Show the tree root directory.
 
1912
    """Show the tree root directory.
2062
1913
 
2063
1914
    The root is the nearest enclosing directory with a .bzr control
2064
1915
    directory."""
2088
1939
 
2089
1940
 
2090
1941
class cmd_log(Command):
2091
 
    __doc__ = """Show historical log for a branch or subset of a branch.
 
1942
    """Show historical log for a branch or subset of a branch.
2092
1943
 
2093
1944
    log is bzr's default tool for exploring the history of a branch.
2094
1945
    The branch to use is taken from the first parameter. If no parameters
2205
2056
    :Tips & tricks:
2206
2057
 
2207
2058
      GUI tools and IDEs are often better at exploring history than command
2208
 
      line tools: you may prefer qlog or viz from qbzr or bzr-gtk, the
2209
 
      bzr-explorer shell, or the Loggerhead web interface.  See the Plugin
2210
 
      Guide <http://doc.bazaar.canonical.com/plugins/en/> and
2211
 
      <http://wiki.bazaar.canonical.com/IDEIntegration>.  
 
2059
      line tools. You may prefer qlog or glog from the QBzr and Bzr-Gtk packages
 
2060
      respectively for example. (TortoiseBzr uses qlog for displaying logs.) See
 
2061
      http://bazaar-vcs.org/BzrPlugins and http://bazaar-vcs.org/IDEIntegration.
 
2062
 
 
2063
      Web interfaces are often better at exploring history than command line
 
2064
      tools, particularly for branches on servers. You may prefer Loggerhead
 
2065
      or one of its alternatives. See http://bazaar-vcs.org/WebInterface.
2212
2066
 
2213
2067
      You may find it useful to add the aliases below to ``bazaar.conf``::
2214
2068
 
2255
2109
                   help='Show just the specified revision.'
2256
2110
                   ' See also "help revisionspec".'),
2257
2111
            'log-format',
2258
 
            RegistryOption('authors',
2259
 
                'What names to list as authors - first, all or committer.',
2260
 
                title='Authors',
2261
 
                lazy_registry=('bzrlib.log', 'author_list_registry'),
2262
 
            ),
2263
2112
            Option('levels',
2264
2113
                   short_name='n',
2265
2114
                   help='Number of levels to display - 0 for all, 1 for flat.',
2280
2129
                   help='Show changes made in each revision as a patch.'),
2281
2130
            Option('include-merges',
2282
2131
                   help='Show merged revisions like --levels 0 does.'),
2283
 
            Option('exclude-common-ancestry',
2284
 
                   help='Display only the revisions that are not part'
2285
 
                   ' of both ancestries (require -rX..Y)'
2286
 
                   )
2287
2132
            ]
2288
2133
    encoding_type = 'replace'
2289
2134
 
2299
2144
            message=None,
2300
2145
            limit=None,
2301
2146
            show_diff=False,
2302
 
            include_merges=False,
2303
 
            authors=None,
2304
 
            exclude_common_ancestry=False,
2305
 
            ):
 
2147
            include_merges=False):
2306
2148
        from bzrlib.log import (
2307
2149
            Logger,
2308
2150
            make_log_request_dict,
2309
2151
            _get_info_for_log_files,
2310
2152
            )
2311
2153
        direction = (forward and 'forward') or 'reverse'
2312
 
        if (exclude_common_ancestry
2313
 
            and (revision is None or len(revision) != 2)):
2314
 
            raise errors.BzrCommandError(
2315
 
                '--exclude-common-ancestry requires -r with two revisions')
2316
2154
        if include_merges:
2317
2155
            if levels is None:
2318
2156
                levels = 0
2333
2171
        filter_by_dir = False
2334
2172
        if file_list:
2335
2173
            # find the file ids to log and check for directory filtering
2336
 
            b, file_info_list, rev1, rev2 = _get_info_for_log_files(
2337
 
                revision, file_list, self.add_cleanup)
 
2174
            b, file_info_list, rev1, rev2 = _get_info_for_log_files(revision,
 
2175
                file_list)
2338
2176
            for relpath, file_id, kind in file_info_list:
2339
2177
                if file_id is None:
2340
2178
                    raise errors.BzrCommandError(
2358
2196
                location = '.'
2359
2197
            dir, relpath = bzrdir.BzrDir.open_containing(location)
2360
2198
            b = dir.open_branch()
2361
 
            self.add_cleanup(b.lock_read().unlock)
2362
2199
            rev1, rev2 = _get_revision_range(revision, b, self.name())
2363
2200
 
2364
2201
        # Decide on the type of delta & diff filtering to use
2374
2211
        else:
2375
2212
            diff_type = 'full'
2376
2213
 
2377
 
        # Build the log formatter
2378
 
        if log_format is None:
2379
 
            log_format = log.log_formatter_registry.get_default(b)
2380
 
        # Make a non-encoding output to include the diffs - bug 328007
2381
 
        unencoded_output = ui.ui_factory.make_output_stream(encoding_type='exact')
2382
 
        lf = log_format(show_ids=show_ids, to_file=self.outf,
2383
 
                        to_exact_file=unencoded_output,
2384
 
                        show_timezone=timezone,
2385
 
                        delta_format=get_verbosity_level(),
2386
 
                        levels=levels,
2387
 
                        show_advice=levels is None,
2388
 
                        author_list_handler=authors)
2389
 
 
2390
 
        # Choose the algorithm for doing the logging. It's annoying
2391
 
        # having multiple code paths like this but necessary until
2392
 
        # the underlying repository format is faster at generating
2393
 
        # deltas or can provide everything we need from the indices.
2394
 
        # The default algorithm - match-using-deltas - works for
2395
 
        # multiple files and directories and is faster for small
2396
 
        # amounts of history (200 revisions say). However, it's too
2397
 
        # slow for logging a single file in a repository with deep
2398
 
        # history, i.e. > 10K revisions. In the spirit of "do no
2399
 
        # evil when adding features", we continue to use the
2400
 
        # original algorithm - per-file-graph - for the "single
2401
 
        # file that isn't a directory without showing a delta" case.
2402
 
        partial_history = revision and b.repository._format.supports_chks
2403
 
        match_using_deltas = (len(file_ids) != 1 or filter_by_dir
2404
 
            or delta_type or partial_history)
2405
 
 
2406
 
        # Build the LogRequest and execute it
2407
 
        if len(file_ids) == 0:
2408
 
            file_ids = None
2409
 
        rqst = make_log_request_dict(
2410
 
            direction=direction, specific_fileids=file_ids,
2411
 
            start_revision=rev1, end_revision=rev2, limit=limit,
2412
 
            message_search=message, delta_type=delta_type,
2413
 
            diff_type=diff_type, _match_using_deltas=match_using_deltas,
2414
 
            exclude_common_ancestry=exclude_common_ancestry,
2415
 
            )
2416
 
        Logger(b, rqst).show(lf)
 
2214
        b.lock_read()
 
2215
        try:
 
2216
            # Build the log formatter
 
2217
            if log_format is None:
 
2218
                log_format = log.log_formatter_registry.get_default(b)
 
2219
            lf = log_format(show_ids=show_ids, to_file=self.outf,
 
2220
                            show_timezone=timezone,
 
2221
                            delta_format=get_verbosity_level(),
 
2222
                            levels=levels,
 
2223
                            show_advice=levels is None)
 
2224
 
 
2225
            # Choose the algorithm for doing the logging. It's annoying
 
2226
            # having multiple code paths like this but necessary until
 
2227
            # the underlying repository format is faster at generating
 
2228
            # deltas or can provide everything we need from the indices.
 
2229
            # The default algorithm - match-using-deltas - works for
 
2230
            # multiple files and directories and is faster for small
 
2231
            # amounts of history (200 revisions say). However, it's too
 
2232
            # slow for logging a single file in a repository with deep
 
2233
            # history, i.e. > 10K revisions. In the spirit of "do no
 
2234
            # evil when adding features", we continue to use the
 
2235
            # original algorithm - per-file-graph - for the "single
 
2236
            # file that isn't a directory without showing a delta" case.
 
2237
            partial_history = revision and b.repository._format.supports_chks
 
2238
            match_using_deltas = (len(file_ids) != 1 or filter_by_dir
 
2239
                or delta_type or partial_history)
 
2240
 
 
2241
            # Build the LogRequest and execute it
 
2242
            if len(file_ids) == 0:
 
2243
                file_ids = None
 
2244
            rqst = make_log_request_dict(
 
2245
                direction=direction, specific_fileids=file_ids,
 
2246
                start_revision=rev1, end_revision=rev2, limit=limit,
 
2247
                message_search=message, delta_type=delta_type,
 
2248
                diff_type=diff_type, _match_using_deltas=match_using_deltas)
 
2249
            Logger(b, rqst).show(lf)
 
2250
        finally:
 
2251
            b.unlock()
2417
2252
 
2418
2253
 
2419
2254
def _get_revision_range(revisionspec_list, branch, command_name):
2437
2272
            raise errors.BzrCommandError(
2438
2273
                "bzr %s doesn't accept two revisions in different"
2439
2274
                " branches." % command_name)
2440
 
        if start_spec.spec is None:
2441
 
            # Avoid loading all the history.
2442
 
            rev1 = RevisionInfo(branch, None, None)
2443
 
        else:
2444
 
            rev1 = start_spec.in_history(branch)
 
2275
        rev1 = start_spec.in_history(branch)
2445
2276
        # Avoid loading all of history when we know a missing
2446
2277
        # end of range means the last revision ...
2447
2278
        if end_spec.spec is None:
2476
2307
 
2477
2308
 
2478
2309
class cmd_touching_revisions(Command):
2479
 
    __doc__ = """Return revision-ids which affected a particular file.
 
2310
    """Return revision-ids which affected a particular file.
2480
2311
 
2481
2312
    A more user-friendly interface is "bzr log FILE".
2482
2313
    """
2487
2318
    @display_command
2488
2319
    def run(self, filename):
2489
2320
        tree, relpath = WorkingTree.open_containing(filename)
 
2321
        b = tree.branch
2490
2322
        file_id = tree.path2id(relpath)
2491
 
        b = tree.branch
2492
 
        self.add_cleanup(b.lock_read().unlock)
2493
 
        touching_revs = log.find_touching_revisions(b, file_id)
2494
 
        for revno, revision_id, what in touching_revs:
 
2323
        for revno, revision_id, what in log.find_touching_revisions(b, file_id):
2495
2324
            self.outf.write("%6d %s\n" % (revno, what))
2496
2325
 
2497
2326
 
2498
2327
class cmd_ls(Command):
2499
 
    __doc__ = """List files in a tree.
 
2328
    """List files in a tree.
2500
2329
    """
2501
2330
 
2502
2331
    _see_also = ['status', 'cat']
2508
2337
                   help='Recurse into subdirectories.'),
2509
2338
            Option('from-root',
2510
2339
                   help='Print paths relative to the root of the branch.'),
2511
 
            Option('unknown', short_name='u',
2512
 
                help='Print unknown files.'),
 
2340
            Option('unknown', help='Print unknown files.'),
2513
2341
            Option('versioned', help='Print versioned files.',
2514
2342
                   short_name='V'),
2515
 
            Option('ignored', short_name='i',
2516
 
                help='Print ignored files.'),
2517
 
            Option('kind', short_name='k',
 
2343
            Option('ignored', help='Print ignored files.'),
 
2344
            Option('null',
 
2345
                   help='Write an ascii NUL (\\0) separator '
 
2346
                   'between files rather than a newline.'),
 
2347
            Option('kind',
2518
2348
                   help='List entries of a particular kind: file, directory, symlink.',
2519
2349
                   type=unicode),
2520
 
            'null',
2521
2350
            'show-ids',
2522
 
            'directory',
2523
2351
            ]
2524
2352
    @display_command
2525
2353
    def run(self, revision=None, verbose=False,
2526
2354
            recursive=False, from_root=False,
2527
2355
            unknown=False, versioned=False, ignored=False,
2528
 
            null=False, kind=None, show_ids=False, path=None, directory=None):
 
2356
            null=False, kind=None, show_ids=False, path=None):
2529
2357
 
2530
2358
        if kind and kind not in ('file', 'directory', 'symlink'):
2531
2359
            raise errors.BzrCommandError('invalid kind specified')
2538
2366
 
2539
2367
        if path is None:
2540
2368
            fs_path = '.'
 
2369
            prefix = ''
2541
2370
        else:
2542
2371
            if from_root:
2543
2372
                raise errors.BzrCommandError('cannot specify both --from-root'
2544
2373
                                             ' and PATH')
2545
2374
            fs_path = path
2546
 
        tree, branch, relpath = \
2547
 
            _open_directory_or_containing_tree_or_branch(fs_path, directory)
2548
 
 
2549
 
        # Calculate the prefix to use
2550
 
        prefix = None
 
2375
            prefix = path
 
2376
        tree, branch, relpath = bzrdir.BzrDir.open_containing_tree_or_branch(
 
2377
            fs_path)
2551
2378
        if from_root:
2552
 
            if relpath:
2553
 
                prefix = relpath + '/'
2554
 
        elif fs_path != '.' and not fs_path.endswith('/'):
2555
 
            prefix = fs_path + '/'
2556
 
 
 
2379
            relpath = u''
 
2380
        elif relpath:
 
2381
            relpath += '/'
2557
2382
        if revision is not None or tree is None:
2558
2383
            tree = _get_one_revision_tree('ls', revision, branch=branch)
2559
2384
 
2565
2390
                view_str = views.view_display_str(view_files)
2566
2391
                note("Ignoring files outside view. View is %s" % view_str)
2567
2392
 
2568
 
        self.add_cleanup(tree.lock_read().unlock)
2569
 
        for fp, fc, fkind, fid, entry in tree.list_files(include_root=False,
2570
 
            from_dir=relpath, recursive=recursive):
2571
 
            # Apply additional masking
2572
 
            if not all and not selection[fc]:
2573
 
                continue
2574
 
            if kind is not None and fkind != kind:
2575
 
                continue
2576
 
            if apply_view:
2577
 
                try:
2578
 
                    if relpath:
2579
 
                        fullpath = osutils.pathjoin(relpath, fp)
2580
 
                    else:
2581
 
                        fullpath = fp
2582
 
                    views.check_path_in_view(tree, fullpath)
2583
 
                except errors.FileOutsideView:
2584
 
                    continue
2585
 
 
2586
 
            # Output the entry
2587
 
            if prefix:
2588
 
                fp = osutils.pathjoin(prefix, fp)
2589
 
            kindch = entry.kind_character()
2590
 
            outstring = fp + kindch
2591
 
            ui.ui_factory.clear_term()
2592
 
            if verbose:
2593
 
                outstring = '%-8s %s' % (fc, outstring)
2594
 
                if show_ids and fid is not None:
2595
 
                    outstring = "%-50s %s" % (outstring, fid)
2596
 
                self.outf.write(outstring + '\n')
2597
 
            elif null:
2598
 
                self.outf.write(fp + '\0')
2599
 
                if show_ids:
2600
 
                    if fid is not None:
2601
 
                        self.outf.write(fid)
2602
 
                    self.outf.write('\0')
2603
 
                self.outf.flush()
2604
 
            else:
2605
 
                if show_ids:
2606
 
                    if fid is not None:
2607
 
                        my_id = fid
2608
 
                    else:
2609
 
                        my_id = ''
2610
 
                    self.outf.write('%-50s %s\n' % (outstring, my_id))
2611
 
                else:
2612
 
                    self.outf.write(outstring + '\n')
 
2393
        tree.lock_read()
 
2394
        try:
 
2395
            for fp, fc, fkind, fid, entry in tree.list_files(include_root=False):
 
2396
                if fp.startswith(relpath):
 
2397
                    rp = fp[len(relpath):]
 
2398
                    fp = osutils.pathjoin(prefix, rp)
 
2399
                    if not recursive and '/' in rp:
 
2400
                        continue
 
2401
                    if not all and not selection[fc]:
 
2402
                        continue
 
2403
                    if kind is not None and fkind != kind:
 
2404
                        continue
 
2405
                    if apply_view:
 
2406
                        try:
 
2407
                            views.check_path_in_view(tree, fp)
 
2408
                        except errors.FileOutsideView:
 
2409
                            continue
 
2410
                    kindch = entry.kind_character()
 
2411
                    outstring = fp + kindch
 
2412
                    if verbose:
 
2413
                        outstring = '%-8s %s' % (fc, outstring)
 
2414
                        if show_ids and fid is not None:
 
2415
                            outstring = "%-50s %s" % (outstring, fid)
 
2416
                        self.outf.write(outstring + '\n')
 
2417
                    elif null:
 
2418
                        self.outf.write(fp + '\0')
 
2419
                        if show_ids:
 
2420
                            if fid is not None:
 
2421
                                self.outf.write(fid)
 
2422
                            self.outf.write('\0')
 
2423
                        self.outf.flush()
 
2424
                    else:
 
2425
                        if fid is not None:
 
2426
                            my_id = fid
 
2427
                        else:
 
2428
                            my_id = ''
 
2429
                        if show_ids:
 
2430
                            self.outf.write('%-50s %s\n' % (outstring, my_id))
 
2431
                        else:
 
2432
                            self.outf.write(outstring + '\n')
 
2433
        finally:
 
2434
            tree.unlock()
2613
2435
 
2614
2436
 
2615
2437
class cmd_unknowns(Command):
2616
 
    __doc__ = """List unknown files.
 
2438
    """List unknown files.
2617
2439
    """
2618
2440
 
2619
2441
    hidden = True
2620
2442
    _see_also = ['ls']
2621
 
    takes_options = ['directory']
2622
2443
 
2623
2444
    @display_command
2624
 
    def run(self, directory=u'.'):
2625
 
        for f in WorkingTree.open_containing(directory)[0].unknowns():
 
2445
    def run(self):
 
2446
        for f in WorkingTree.open_containing(u'.')[0].unknowns():
2626
2447
            self.outf.write(osutils.quotefn(f) + '\n')
2627
2448
 
2628
2449
 
2629
2450
class cmd_ignore(Command):
2630
 
    __doc__ = """Ignore specified files or patterns.
 
2451
    """Ignore specified files or patterns.
2631
2452
 
2632
2453
    See ``bzr help patterns`` for details on the syntax of patterns.
2633
2454
 
2634
 
    If a .bzrignore file does not exist, the ignore command
2635
 
    will create one and add the specified files or patterns to the newly
2636
 
    created file. The ignore command will also automatically add the 
2637
 
    .bzrignore file to be versioned. Creating a .bzrignore file without
2638
 
    the use of the ignore command will require an explicit add command.
2639
 
 
2640
2455
    To remove patterns from the ignore list, edit the .bzrignore file.
2641
2456
    After adding, editing or deleting that file either indirectly by
2642
2457
    using this command or directly by using an editor, be sure to commit
2643
2458
    it.
2644
 
    
2645
 
    Bazaar also supports a global ignore file ~/.bazaar/ignore. On Windows
2646
 
    the global ignore file can be found in the application data directory as
2647
 
    C:\\Documents and Settings\\<user>\\Application Data\\Bazaar\\2.0\\ignore.
2648
 
    Global ignores are not touched by this command. The global ignore file
2649
 
    can be edited directly using an editor.
2650
 
 
2651
 
    Patterns prefixed with '!' are exceptions to ignore patterns and take
2652
 
    precedence over regular ignores.  Such exceptions are used to specify
2653
 
    files that should be versioned which would otherwise be ignored.
2654
 
    
2655
 
    Patterns prefixed with '!!' act as regular ignore patterns, but have
2656
 
    precedence over the '!' exception patterns.
2657
2459
 
2658
2460
    Note: ignore patterns containing shell wildcards must be quoted from
2659
2461
    the shell on Unix.
2663
2465
 
2664
2466
            bzr ignore ./Makefile
2665
2467
 
2666
 
        Ignore .class files in all directories...::
 
2468
        Ignore class files in all directories::
2667
2469
 
2668
2470
            bzr ignore "*.class"
2669
2471
 
2670
 
        ...but do not ignore "special.class"::
2671
 
 
2672
 
            bzr ignore "!special.class"
2673
 
 
2674
2472
        Ignore .o files under the lib directory::
2675
2473
 
2676
2474
            bzr ignore "lib/**/*.o"
2682
2480
        Ignore everything but the "debian" toplevel directory::
2683
2481
 
2684
2482
            bzr ignore "RE:(?!debian/).*"
2685
 
        
2686
 
        Ignore everything except the "local" toplevel directory,
2687
 
        but always ignore "*~" autosave files, even under local/::
2688
 
        
2689
 
            bzr ignore "*"
2690
 
            bzr ignore "!./local"
2691
 
            bzr ignore "!!*~"
2692
2483
    """
2693
2484
 
2694
2485
    _see_also = ['status', 'ignored', 'patterns']
2695
2486
    takes_args = ['name_pattern*']
2696
 
    takes_options = ['directory',
2697
 
        Option('default-rules',
2698
 
               help='Display the default ignore rules that bzr uses.')
 
2487
    takes_options = [
 
2488
        Option('old-default-rules',
 
2489
               help='Write out the ignore rules bzr < 0.9 always used.')
2699
2490
        ]
2700
2491
 
2701
 
    def run(self, name_pattern_list=None, default_rules=None,
2702
 
            directory=u'.'):
 
2492
    def run(self, name_pattern_list=None, old_default_rules=None):
2703
2493
        from bzrlib import ignores
2704
 
        if default_rules is not None:
2705
 
            # dump the default rules and exit
2706
 
            for pattern in ignores.USER_DEFAULTS:
2707
 
                self.outf.write("%s\n" % pattern)
 
2494
        if old_default_rules is not None:
 
2495
            # dump the rules and exit
 
2496
            for pattern in ignores.OLD_DEFAULTS:
 
2497
                print pattern
2708
2498
            return
2709
2499
        if not name_pattern_list:
2710
2500
            raise errors.BzrCommandError("ignore requires at least one "
2711
 
                "NAME_PATTERN or --default-rules.")
 
2501
                                  "NAME_PATTERN or --old-default-rules")
2712
2502
        name_pattern_list = [globbing.normalize_pattern(p)
2713
2503
                             for p in name_pattern_list]
2714
2504
        for name_pattern in name_pattern_list:
2716
2506
                (len(name_pattern) > 1 and name_pattern[1] == ':')):
2717
2507
                raise errors.BzrCommandError(
2718
2508
                    "NAME_PATTERN should not be an absolute path")
2719
 
        tree, relpath = WorkingTree.open_containing(directory)
 
2509
        tree, relpath = WorkingTree.open_containing(u'.')
2720
2510
        ignores.tree_ignores_add_patterns(tree, name_pattern_list)
2721
2511
        ignored = globbing.Globster(name_pattern_list)
2722
2512
        matches = []
2726
2516
            if id is not None:
2727
2517
                filename = entry[0]
2728
2518
                if ignored.match(filename):
2729
 
                    matches.append(filename)
 
2519
                    matches.append(filename.encode('utf-8'))
2730
2520
        tree.unlock()
2731
2521
        if len(matches) > 0:
2732
 
            self.outf.write("Warning: the following files are version controlled and"
2733
 
                  " match your ignore pattern:\n%s"
2734
 
                  "\nThese files will continue to be version controlled"
2735
 
                  " unless you 'bzr remove' them.\n" % ("\n".join(matches),))
 
2522
            print "Warning: the following files are version controlled and" \
 
2523
                  " match your ignore pattern:\n%s" \
 
2524
                  "\nThese files will continue to be version controlled" \
 
2525
                  " unless you 'bzr remove' them." % ("\n".join(matches),)
2736
2526
 
2737
2527
 
2738
2528
class cmd_ignored(Command):
2739
 
    __doc__ = """List ignored files and the patterns that matched them.
 
2529
    """List ignored files and the patterns that matched them.
2740
2530
 
2741
2531
    List all the ignored files and the ignore pattern that caused the file to
2742
2532
    be ignored.
2748
2538
 
2749
2539
    encoding_type = 'replace'
2750
2540
    _see_also = ['ignore', 'ls']
2751
 
    takes_options = ['directory']
2752
2541
 
2753
2542
    @display_command
2754
 
    def run(self, directory=u'.'):
2755
 
        tree = WorkingTree.open_containing(directory)[0]
2756
 
        self.add_cleanup(tree.lock_read().unlock)
2757
 
        for path, file_class, kind, file_id, entry in tree.list_files():
2758
 
            if file_class != 'I':
2759
 
                continue
2760
 
            ## XXX: Slightly inefficient since this was already calculated
2761
 
            pat = tree.is_ignored(path)
2762
 
            self.outf.write('%-50s %s\n' % (path, pat))
 
2543
    def run(self):
 
2544
        tree = WorkingTree.open_containing(u'.')[0]
 
2545
        tree.lock_read()
 
2546
        try:
 
2547
            for path, file_class, kind, file_id, entry in tree.list_files():
 
2548
                if file_class != 'I':
 
2549
                    continue
 
2550
                ## XXX: Slightly inefficient since this was already calculated
 
2551
                pat = tree.is_ignored(path)
 
2552
                self.outf.write('%-50s %s\n' % (path, pat))
 
2553
        finally:
 
2554
            tree.unlock()
2763
2555
 
2764
2556
 
2765
2557
class cmd_lookup_revision(Command):
2766
 
    __doc__ = """Lookup the revision-id from a revision-number
 
2558
    """Lookup the revision-id from a revision-number
2767
2559
 
2768
2560
    :Examples:
2769
2561
        bzr lookup-revision 33
2770
2562
    """
2771
2563
    hidden = True
2772
2564
    takes_args = ['revno']
2773
 
    takes_options = ['directory']
2774
2565
 
2775
2566
    @display_command
2776
 
    def run(self, revno, directory=u'.'):
 
2567
    def run(self, revno):
2777
2568
        try:
2778
2569
            revno = int(revno)
2779
2570
        except ValueError:
2780
 
            raise errors.BzrCommandError("not a valid revision-number: %r"
2781
 
                                         % revno)
2782
 
        revid = WorkingTree.open_containing(directory)[0].branch.get_rev_id(revno)
2783
 
        self.outf.write("%s\n" % revid)
 
2571
            raise errors.BzrCommandError("not a valid revision-number: %r" % revno)
 
2572
 
 
2573
        print WorkingTree.open_containing(u'.')[0].branch.get_rev_id(revno)
2784
2574
 
2785
2575
 
2786
2576
class cmd_export(Command):
2787
 
    __doc__ = """Export current or past revision to a destination directory or archive.
 
2577
    """Export current or past revision to a destination directory or archive.
2788
2578
 
2789
2579
    If no revision is specified this exports the last committed revision.
2790
2580
 
2812
2602
      =================       =========================
2813
2603
    """
2814
2604
    takes_args = ['dest', 'branch_or_subdir?']
2815
 
    takes_options = ['directory',
 
2605
    takes_options = [
2816
2606
        Option('format',
2817
2607
               help="Type of file to export to.",
2818
2608
               type=unicode),
2822
2612
        Option('root',
2823
2613
               type=str,
2824
2614
               help="Name of the root directory inside the exported file."),
2825
 
        Option('per-file-timestamps',
2826
 
               help='Set modification time of files to that of the last '
2827
 
                    'revision in which it was changed.'),
2828
2615
        ]
2829
2616
    def run(self, dest, branch_or_subdir=None, revision=None, format=None,
2830
 
        root=None, filters=False, per_file_timestamps=False, directory=u'.'):
 
2617
        root=None, filters=False):
2831
2618
        from bzrlib.export import export
2832
2619
 
2833
2620
        if branch_or_subdir is None:
2834
 
            tree = WorkingTree.open_containing(directory)[0]
 
2621
            tree = WorkingTree.open_containing(u'.')[0]
2835
2622
            b = tree.branch
2836
2623
            subdir = None
2837
2624
        else:
2840
2627
 
2841
2628
        rev_tree = _get_one_revision_tree('export', revision, branch=b, tree=tree)
2842
2629
        try:
2843
 
            export(rev_tree, dest, format, root, subdir, filtered=filters,
2844
 
                   per_file_timestamps=per_file_timestamps)
 
2630
            export(rev_tree, dest, format, root, subdir, filtered=filters)
2845
2631
        except errors.NoSuchExportFormat, e:
2846
2632
            raise errors.BzrCommandError('Unsupported export format: %s' % e.format)
2847
2633
 
2848
2634
 
2849
2635
class cmd_cat(Command):
2850
 
    __doc__ = """Write the contents of a file as of a given revision to standard output.
 
2636
    """Write the contents of a file as of a given revision to standard output.
2851
2637
 
2852
2638
    If no revision is nominated, the last revision is used.
2853
2639
 
2856
2642
    """
2857
2643
 
2858
2644
    _see_also = ['ls']
2859
 
    takes_options = ['directory',
 
2645
    takes_options = [
2860
2646
        Option('name-from-revision', help='The path name in the old tree.'),
2861
2647
        Option('filters', help='Apply content filters to display the '
2862
2648
                'convenience form.'),
2867
2653
 
2868
2654
    @display_command
2869
2655
    def run(self, filename, revision=None, name_from_revision=False,
2870
 
            filters=False, directory=None):
 
2656
            filters=False):
2871
2657
        if revision is not None and len(revision) != 1:
2872
2658
            raise errors.BzrCommandError("bzr cat --revision takes exactly"
2873
2659
                                         " one revision specifier")
2874
2660
        tree, branch, relpath = \
2875
 
            _open_directory_or_containing_tree_or_branch(filename, directory)
2876
 
        self.add_cleanup(branch.lock_read().unlock)
2877
 
        return self._run(tree, branch, relpath, filename, revision,
2878
 
                         name_from_revision, filters)
 
2661
            bzrdir.BzrDir.open_containing_tree_or_branch(filename)
 
2662
        branch.lock_read()
 
2663
        try:
 
2664
            return self._run(tree, branch, relpath, filename, revision,
 
2665
                             name_from_revision, filters)
 
2666
        finally:
 
2667
            branch.unlock()
2879
2668
 
2880
2669
    def _run(self, tree, b, relpath, filename, revision, name_from_revision,
2881
2670
        filtered):
2882
2671
        if tree is None:
2883
2672
            tree = b.basis_tree()
2884
2673
        rev_tree = _get_one_revision_tree('cat', revision, branch=b)
2885
 
        self.add_cleanup(rev_tree.lock_read().unlock)
2886
2674
 
2887
2675
        old_file_id = rev_tree.path2id(relpath)
2888
2676
 
2923
2711
            chunks = content.splitlines(True)
2924
2712
            content = filtered_output_bytes(chunks, filters,
2925
2713
                ContentFilterContext(relpath, rev_tree))
2926
 
            self.cleanup_now()
2927
2714
            self.outf.writelines(content)
2928
2715
        else:
2929
 
            self.cleanup_now()
2930
2716
            self.outf.write(content)
2931
2717
 
2932
2718
 
2933
2719
class cmd_local_time_offset(Command):
2934
 
    __doc__ = """Show the offset in seconds from GMT to local time."""
 
2720
    """Show the offset in seconds from GMT to local time."""
2935
2721
    hidden = True
2936
2722
    @display_command
2937
2723
    def run(self):
2938
 
        self.outf.write("%s\n" % osutils.local_time_offset())
 
2724
        print osutils.local_time_offset()
2939
2725
 
2940
2726
 
2941
2727
 
2942
2728
class cmd_commit(Command):
2943
 
    __doc__ = """Commit changes into a new revision.
 
2729
    """Commit changes into a new revision.
2944
2730
 
2945
2731
    An explanatory message needs to be given for each commit. This is
2946
2732
    often done by using the --message option (getting the message from the
3039
2825
             Option('strict',
3040
2826
                    help="Refuse to commit if there are unknown "
3041
2827
                    "files in the working tree."),
3042
 
             Option('commit-time', type=str,
3043
 
                    help="Manually set a commit time using commit date "
3044
 
                    "format, e.g. '2009-10-10 08:00:00 +0100'."),
3045
2828
             ListOption('fixes', type=str,
3046
2829
                    help="Mark a bug as being fixed by this revision "
3047
2830
                         "(see \"bzr help bugs\")."),
3054
2837
                         "the master branch until a normal commit "
3055
2838
                         "is performed."
3056
2839
                    ),
3057
 
             Option('show-diff', short_name='p',
3058
 
                    help='When no message is supplied, show the diff along'
3059
 
                    ' with the status summary in the message editor.'),
 
2840
              Option('show-diff',
 
2841
                     help='When no message is supplied, show the diff along'
 
2842
                     ' with the status summary in the message editor.'),
3060
2843
             ]
3061
2844
    aliases = ['ci', 'checkin']
3062
2845
 
3081
2864
 
3082
2865
    def run(self, message=None, file=None, verbose=False, selected_list=None,
3083
2866
            unchanged=False, strict=False, local=False, fixes=None,
3084
 
            author=None, show_diff=False, exclude=None, commit_time=None):
 
2867
            author=None, show_diff=False, exclude=None):
3085
2868
        from bzrlib.errors import (
3086
2869
            PointlessCommit,
3087
2870
            ConflictsInTree,
3093
2876
            make_commit_message_template_encoded
3094
2877
        )
3095
2878
 
3096
 
        commit_stamp = offset = None
3097
 
        if commit_time is not None:
3098
 
            try:
3099
 
                commit_stamp, offset = timestamp.parse_patch_date(commit_time)
3100
 
            except ValueError, e:
3101
 
                raise errors.BzrCommandError(
3102
 
                    "Could not parse --commit-time: " + str(e))
3103
 
 
3104
2879
        # TODO: Need a blackbox test for invoking the external editor; may be
3105
2880
        # slightly problematic to run this cross-platform.
3106
2881
 
3126
2901
        if local and not tree.branch.get_bound_location():
3127
2902
            raise errors.LocalRequiresBoundBranch()
3128
2903
 
3129
 
        if message is not None:
3130
 
            try:
3131
 
                file_exists = osutils.lexists(message)
3132
 
            except UnicodeError:
3133
 
                # The commit message contains unicode characters that can't be
3134
 
                # represented in the filesystem encoding, so that can't be a
3135
 
                # file.
3136
 
                file_exists = False
3137
 
            if file_exists:
3138
 
                warning_msg = (
3139
 
                    'The commit message is a file name: "%(f)s".\n'
3140
 
                    '(use --file "%(f)s" to take commit message from that file)'
3141
 
                    % { 'f': message })
3142
 
                ui.ui_factory.show_warning(warning_msg)
3143
 
            if '\r' in message:
3144
 
                message = message.replace('\r\n', '\n')
3145
 
                message = message.replace('\r', '\n')
3146
 
            if file:
3147
 
                raise errors.BzrCommandError(
3148
 
                    "please specify either --message or --file")
3149
 
 
3150
2904
        def get_message(commit_obj):
3151
2905
            """Callback to get commit message"""
3152
 
            if file:
3153
 
                my_message = codecs.open(
3154
 
                    file, 'rt', osutils.get_user_encoding()).read()
3155
 
            elif message is not None:
3156
 
                my_message = message
3157
 
            else:
3158
 
                # No message supplied: make one up.
3159
 
                # text is the status of the tree
3160
 
                text = make_commit_message_template_encoded(tree,
 
2906
            my_message = message
 
2907
            if my_message is None and not file:
 
2908
                t = make_commit_message_template_encoded(tree,
3161
2909
                        selected_list, diff=show_diff,
3162
2910
                        output_encoding=osutils.get_user_encoding())
3163
 
                # start_message is the template generated from hooks
3164
 
                # XXX: Warning - looks like hooks return unicode,
3165
 
                # make_commit_message_template_encoded returns user encoding.
3166
 
                # We probably want to be using edit_commit_message instead to
3167
 
                # avoid this.
3168
2911
                start_message = generate_commit_message_template(commit_obj)
3169
 
                my_message = edit_commit_message_encoded(text,
 
2912
                my_message = edit_commit_message_encoded(t,
3170
2913
                    start_message=start_message)
3171
2914
                if my_message is None:
3172
2915
                    raise errors.BzrCommandError("please specify a commit"
3173
2916
                        " message with either --message or --file")
 
2917
            elif my_message and file:
 
2918
                raise errors.BzrCommandError(
 
2919
                    "please specify either --message or --file")
 
2920
            if file:
 
2921
                my_message = codecs.open(file, 'rt',
 
2922
                                         osutils.get_user_encoding()).read()
3174
2923
            if my_message == "":
3175
2924
                raise errors.BzrCommandError("empty commit message specified")
3176
2925
            return my_message
3177
2926
 
3178
 
        # The API permits a commit with a filter of [] to mean 'select nothing'
3179
 
        # but the command line should not do that.
3180
 
        if not selected_list:
3181
 
            selected_list = None
3182
2927
        try:
3183
2928
            tree.commit(message_callback=get_message,
3184
2929
                        specific_files=selected_list,
3185
2930
                        allow_pointless=unchanged, strict=strict, local=local,
3186
2931
                        reporter=None, verbose=verbose, revprops=properties,
3187
 
                        authors=author, timestamp=commit_stamp,
3188
 
                        timezone=offset,
 
2932
                        authors=author,
3189
2933
                        exclude=safe_relpath_files(tree, exclude))
3190
2934
        except PointlessCommit:
 
2935
            # FIXME: This should really happen before the file is read in;
 
2936
            # perhaps prepare the commit; get the message; then actually commit
3191
2937
            raise errors.BzrCommandError("No changes to commit."
3192
2938
                              " Use --unchanged to commit anyhow.")
3193
2939
        except ConflictsInTree:
3198
2944
            raise errors.BzrCommandError("Commit refused because there are"
3199
2945
                              " unknown files in the working tree.")
3200
2946
        except errors.BoundBranchOutOfDate, e:
3201
 
            e.extra_help = ("\n"
3202
 
                'To commit to master branch, run update and then commit.\n'
3203
 
                'You can also pass --local to commit to continue working '
3204
 
                'disconnected.')
3205
 
            raise
 
2947
            raise errors.BzrCommandError(str(e) + "\n"
 
2948
            'To commit to master branch, run update and then commit.\n'
 
2949
            'You can also pass --local to commit to continue working '
 
2950
            'disconnected.')
3206
2951
 
3207
2952
 
3208
2953
class cmd_check(Command):
3209
 
    __doc__ = """Validate working tree structure, branch consistency and repository history.
 
2954
    """Validate working tree structure, branch consistency and repository history.
3210
2955
 
3211
2956
    This command checks various invariants about branch and repository storage
3212
2957
    to detect data corruption or bzr bugs.
3214
2959
    The working tree and branch checks will only give output if a problem is
3215
2960
    detected. The output fields of the repository check are:
3216
2961
 
3217
 
    revisions
3218
 
        This is just the number of revisions checked.  It doesn't
3219
 
        indicate a problem.
3220
 
 
3221
 
    versionedfiles
3222
 
        This is just the number of versionedfiles checked.  It
3223
 
        doesn't indicate a problem.
3224
 
 
3225
 
    unreferenced ancestors
3226
 
        Texts that are ancestors of other texts, but
3227
 
        are not properly referenced by the revision ancestry.  This is a
3228
 
        subtle problem that Bazaar can work around.
3229
 
 
3230
 
    unique file texts
3231
 
        This is the total number of unique file contents
3232
 
        seen in the checked revisions.  It does not indicate a problem.
3233
 
 
3234
 
    repeated file texts
3235
 
        This is the total number of repeated texts seen
3236
 
        in the checked revisions.  Texts can be repeated when their file
3237
 
        entries are modified, but the file contents are not.  It does not
3238
 
        indicate a problem.
 
2962
        revisions: This is just the number of revisions checked.  It doesn't
 
2963
            indicate a problem.
 
2964
        versionedfiles: This is just the number of versionedfiles checked.  It
 
2965
            doesn't indicate a problem.
 
2966
        unreferenced ancestors: Texts that are ancestors of other texts, but
 
2967
            are not properly referenced by the revision ancestry.  This is a
 
2968
            subtle problem that Bazaar can work around.
 
2969
        unique file texts: This is the total number of unique file contents
 
2970
            seen in the checked revisions.  It does not indicate a problem.
 
2971
        repeated file texts: This is the total number of repeated texts seen
 
2972
            in the checked revisions.  Texts can be repeated when their file
 
2973
            entries are modified, but the file contents are not.  It does not
 
2974
            indicate a problem.
3239
2975
 
3240
2976
    If no restrictions are specified, all Bazaar data that is found at the given
3241
2977
    location will be checked.
3276
3012
 
3277
3013
 
3278
3014
class cmd_upgrade(Command):
3279
 
    __doc__ = """Upgrade branch storage to current format.
 
3015
    """Upgrade branch storage to current format.
3280
3016
 
3281
3017
    The check command or bzr developers may sometimes advise you to run
3282
3018
    this command. When the default format has changed you may also be warned
3300
3036
 
3301
3037
 
3302
3038
class cmd_whoami(Command):
3303
 
    __doc__ = """Show or set bzr user id.
 
3039
    """Show or set bzr user id.
3304
3040
 
3305
3041
    :Examples:
3306
3042
        Show the email of the current user::
3350
3086
 
3351
3087
 
3352
3088
class cmd_nick(Command):
3353
 
    __doc__ = """Print or set the branch nickname.
 
3089
    """Print or set the branch nickname.
3354
3090
 
3355
3091
    If unset, the tree root directory name is used as the nickname.
3356
3092
    To print the current nickname, execute with no argument.
3361
3097
 
3362
3098
    _see_also = ['info']
3363
3099
    takes_args = ['nickname?']
3364
 
    takes_options = ['directory']
3365
 
    def run(self, nickname=None, directory=u'.'):
3366
 
        branch = Branch.open_containing(directory)[0]
 
3100
    def run(self, nickname=None):
 
3101
        branch = Branch.open_containing(u'.')[0]
3367
3102
        if nickname is None:
3368
3103
            self.printme(branch)
3369
3104
        else:
3371
3106
 
3372
3107
    @display_command
3373
3108
    def printme(self, branch):
3374
 
        self.outf.write('%s\n' % branch.nick)
 
3109
        print branch.nick
3375
3110
 
3376
3111
 
3377
3112
class cmd_alias(Command):
3378
 
    __doc__ = """Set/unset and display aliases.
 
3113
    """Set/unset and display aliases.
3379
3114
 
3380
3115
    :Examples:
3381
3116
        Show the current aliases::
3445
3180
 
3446
3181
 
3447
3182
class cmd_selftest(Command):
3448
 
    __doc__ = """Run internal test suite.
 
3183
    """Run internal test suite.
3449
3184
 
3450
3185
    If arguments are given, they are regular expressions that say which tests
3451
3186
    should run.  Tests matching any expression are run, and other tests are
3478
3213
    Tests that need working space on disk use a common temporary directory,
3479
3214
    typically inside $TMPDIR or /tmp.
3480
3215
 
3481
 
    If you set BZR_TEST_PDB=1 when running selftest, failing tests will drop
3482
 
    into a pdb postmortem session.
3483
 
 
3484
3216
    :Examples:
3485
3217
        Run only tests relating to 'ignore'::
3486
3218
 
3495
3227
    def get_transport_type(typestring):
3496
3228
        """Parse and return a transport specifier."""
3497
3229
        if typestring == "sftp":
3498
 
            from bzrlib.tests import stub_sftp
3499
 
            return stub_sftp.SFTPAbsoluteServer
 
3230
            from bzrlib.transport.sftp import SFTPAbsoluteServer
 
3231
            return SFTPAbsoluteServer
3500
3232
        if typestring == "memory":
3501
 
            from bzrlib.tests import test_server
3502
 
            return memory.MemoryServer
 
3233
            from bzrlib.transport.memory import MemoryServer
 
3234
            return MemoryServer
3503
3235
        if typestring == "fakenfs":
3504
 
            from bzrlib.tests import test_server
3505
 
            return test_server.FakeNFSServer
 
3236
            from bzrlib.transport.fakenfs import FakeNFSServer
 
3237
            return FakeNFSServer
3506
3238
        msg = "No known transport type %s. Supported types are: sftp\n" %\
3507
3239
            (typestring)
3508
3240
        raise errors.BzrCommandError(msg)
3523
3255
                     Option('lsprof-timed',
3524
3256
                            help='Generate lsprof output for benchmarked'
3525
3257
                                 ' sections of code.'),
3526
 
                     Option('lsprof-tests',
3527
 
                            help='Generate lsprof output for each test.'),
3528
3258
                     Option('cache-dir', type=str,
3529
3259
                            help='Cache intermediate benchmark output in this '
3530
3260
                                 'directory.'),
3571
3301
            first=False, list_only=False,
3572
3302
            randomize=None, exclude=None, strict=False,
3573
3303
            load_list=None, debugflag=None, starting_with=None, subunit=False,
3574
 
            parallel=None, lsprof_tests=False):
 
3304
            parallel=None):
3575
3305
        from bzrlib.tests import selftest
3576
3306
        import bzrlib.benchmarks as benchmarks
3577
3307
        from bzrlib.benchmarks import tree_creator
3592
3322
                raise errors.BzrCommandError("subunit not available. subunit "
3593
3323
                    "needs to be installed to use --subunit.")
3594
3324
            self.additional_selftest_args['runner_class'] = SubUnitBzrRunner
3595
 
            # On Windows, disable automatic conversion of '\n' to '\r\n' in
3596
 
            # stdout, which would corrupt the subunit stream. 
3597
 
            if sys.platform == "win32" and sys.stdout.fileno() >= 0:
3598
 
                import msvcrt
3599
 
                msvcrt.setmode(sys.stdout.fileno(), os.O_BINARY)
3600
3325
        if parallel:
3601
3326
            self.additional_selftest_args.setdefault(
3602
3327
                'suite_decorators', []).append(parallel)
3606
3331
            verbose = not is_quiet()
3607
3332
            # TODO: should possibly lock the history file...
3608
3333
            benchfile = open(".perf_history", "at", buffering=1)
3609
 
            self.add_cleanup(benchfile.close)
3610
3334
        else:
3611
3335
            test_suite_factory = None
3612
3336
            benchfile = None
3613
 
        selftest_kwargs = {"verbose": verbose,
3614
 
                          "pattern": pattern,
3615
 
                          "stop_on_failure": one,
3616
 
                          "transport": transport,
3617
 
                          "test_suite_factory": test_suite_factory,
3618
 
                          "lsprof_timed": lsprof_timed,
3619
 
                          "lsprof_tests": lsprof_tests,
3620
 
                          "bench_history": benchfile,
3621
 
                          "matching_tests_first": first,
3622
 
                          "list_only": list_only,
3623
 
                          "random_seed": randomize,
3624
 
                          "exclude_pattern": exclude,
3625
 
                          "strict": strict,
3626
 
                          "load_list": load_list,
3627
 
                          "debug_flags": debugflag,
3628
 
                          "starting_with": starting_with
3629
 
                          }
3630
 
        selftest_kwargs.update(self.additional_selftest_args)
3631
 
        result = selftest(**selftest_kwargs)
 
3337
        try:
 
3338
            selftest_kwargs = {"verbose": verbose,
 
3339
                              "pattern": pattern,
 
3340
                              "stop_on_failure": one,
 
3341
                              "transport": transport,
 
3342
                              "test_suite_factory": test_suite_factory,
 
3343
                              "lsprof_timed": lsprof_timed,
 
3344
                              "bench_history": benchfile,
 
3345
                              "matching_tests_first": first,
 
3346
                              "list_only": list_only,
 
3347
                              "random_seed": randomize,
 
3348
                              "exclude_pattern": exclude,
 
3349
                              "strict": strict,
 
3350
                              "load_list": load_list,
 
3351
                              "debug_flags": debugflag,
 
3352
                              "starting_with": starting_with
 
3353
                              }
 
3354
            selftest_kwargs.update(self.additional_selftest_args)
 
3355
            result = selftest(**selftest_kwargs)
 
3356
        finally:
 
3357
            if benchfile is not None:
 
3358
                benchfile.close()
3632
3359
        return int(not result)
3633
3360
 
3634
3361
 
3635
3362
class cmd_version(Command):
3636
 
    __doc__ = """Show version of bzr."""
 
3363
    """Show version of bzr."""
3637
3364
 
3638
3365
    encoding_type = 'replace'
3639
3366
    takes_options = [
3650
3377
 
3651
3378
 
3652
3379
class cmd_rocks(Command):
3653
 
    __doc__ = """Statement of optimism."""
 
3380
    """Statement of optimism."""
3654
3381
 
3655
3382
    hidden = True
3656
3383
 
3657
3384
    @display_command
3658
3385
    def run(self):
3659
 
        self.outf.write("It sure does!\n")
 
3386
        print "It sure does!"
3660
3387
 
3661
3388
 
3662
3389
class cmd_find_merge_base(Command):
3663
 
    __doc__ = """Find and print a base revision for merging two branches."""
 
3390
    """Find and print a base revision for merging two branches."""
3664
3391
    # TODO: Options to specify revisions on either side, as if
3665
3392
    #       merging only part of the history.
3666
3393
    takes_args = ['branch', 'other']
3672
3399
 
3673
3400
        branch1 = Branch.open_containing(branch)[0]
3674
3401
        branch2 = Branch.open_containing(other)[0]
3675
 
        self.add_cleanup(branch1.lock_read().unlock)
3676
 
        self.add_cleanup(branch2.lock_read().unlock)
3677
 
        last1 = ensure_null(branch1.last_revision())
3678
 
        last2 = ensure_null(branch2.last_revision())
3679
 
 
3680
 
        graph = branch1.repository.get_graph(branch2.repository)
3681
 
        base_rev_id = graph.find_unique_lca(last1, last2)
3682
 
 
3683
 
        self.outf.write('merge base is revision %s\n' % base_rev_id)
 
3402
        branch1.lock_read()
 
3403
        try:
 
3404
            branch2.lock_read()
 
3405
            try:
 
3406
                last1 = ensure_null(branch1.last_revision())
 
3407
                last2 = ensure_null(branch2.last_revision())
 
3408
 
 
3409
                graph = branch1.repository.get_graph(branch2.repository)
 
3410
                base_rev_id = graph.find_unique_lca(last1, last2)
 
3411
 
 
3412
                print 'merge base is revision %s' % base_rev_id
 
3413
            finally:
 
3414
                branch2.unlock()
 
3415
        finally:
 
3416
            branch1.unlock()
3684
3417
 
3685
3418
 
3686
3419
class cmd_merge(Command):
3687
 
    __doc__ = """Perform a three-way merge.
 
3420
    """Perform a three-way merge.
3688
3421
 
3689
3422
    The source of the merge can be specified either in the form of a branch,
3690
3423
    or in the form of a path to a file containing a merge directive generated
3719
3452
    committed to record the result of the merge.
3720
3453
 
3721
3454
    merge refuses to run if there are any uncommitted changes, unless
3722
 
    --force is given. The --force option can also be used to create a
3723
 
    merge revision which has more than two parents.
3724
 
 
3725
 
    If one would like to merge changes from the working tree of the other
3726
 
    branch without merging any committed revisions, the --uncommitted option
3727
 
    can be given.
3728
 
 
3729
 
    To select only some changes to merge, use "merge -i", which will prompt
3730
 
    you to apply each diff hunk and file change, similar to "shelve".
 
3455
    --force is given.
3731
3456
 
3732
3457
    :Examples:
3733
3458
        To merge the latest revision from bzr.dev::
3742
3467
 
3743
3468
            bzr merge -r 81..82 ../bzr.dev
3744
3469
 
3745
 
        To apply a merge directive contained in /tmp/merge::
 
3470
        To apply a merge directive contained in /tmp/merge:
3746
3471
 
3747
3472
            bzr merge /tmp/merge
3748
 
 
3749
 
        To create a merge revision with three parents from two branches
3750
 
        feature1a and feature1b:
3751
 
 
3752
 
            bzr merge ../feature1a
3753
 
            bzr merge ../feature1b --force
3754
 
            bzr commit -m 'revision with three parents'
3755
3473
    """
3756
3474
 
3757
3475
    encoding_type = 'exact'
3773
3491
                ' completely merged into the source, pull from the'
3774
3492
                ' source rather than merging.  When this happens,'
3775
3493
                ' you do not need to commit the result.'),
3776
 
        custom_help('directory',
 
3494
        Option('directory',
3777
3495
               help='Branch to merge into, '
3778
 
                    'rather than the one containing the working directory.'),
3779
 
        Option('preview', help='Instead of merging, show a diff of the'
3780
 
               ' merge.'),
3781
 
        Option('interactive', help='Select changes interactively.',
3782
 
            short_name='i')
 
3496
                    'rather than the one containing the working directory.',
 
3497
               short_name='d',
 
3498
               type=unicode,
 
3499
               ),
 
3500
        Option('preview', help='Instead of merging, show a diff of the merge.')
3783
3501
    ]
3784
3502
 
3785
3503
    def run(self, location=None, revision=None, force=False,
3787
3505
            uncommitted=False, pull=False,
3788
3506
            directory=None,
3789
3507
            preview=False,
3790
 
            interactive=False,
3791
3508
            ):
3792
3509
        if merge_type is None:
3793
3510
            merge_type = _mod_merge.Merge3Merger
3799
3516
        verified = 'inapplicable'
3800
3517
        tree = WorkingTree.open_containing(directory)[0]
3801
3518
 
 
3519
        # die as quickly as possible if there are uncommitted changes
3802
3520
        try:
3803
3521
            basis_tree = tree.revision_tree(tree.last_revision())
3804
3522
        except errors.NoSuchRevision:
3805
3523
            basis_tree = tree.basis_tree()
3806
 
 
3807
 
        # die as quickly as possible if there are uncommitted changes
3808
3524
        if not force:
3809
 
            if tree.has_changes():
 
3525
            changes = tree.changes_from(basis_tree)
 
3526
            if changes.has_changed():
3810
3527
                raise errors.UncommittedChanges(tree)
3811
3528
 
3812
3529
        view_info = _get_view_info_for_change_reporter(tree)
3813
3530
        change_reporter = delta._ChangeReporter(
3814
3531
            unversioned_filter=tree.is_ignored, view_info=view_info)
3815
 
        pb = ui.ui_factory.nested_progress_bar()
3816
 
        self.add_cleanup(pb.finished)
3817
 
        self.add_cleanup(tree.lock_write().unlock)
3818
 
        if location is not None:
3819
 
            try:
3820
 
                mergeable = bundle.read_mergeable_from_url(location,
3821
 
                    possible_transports=possible_transports)
3822
 
            except errors.NotABundle:
3823
 
                mergeable = None
 
3532
        cleanups = []
 
3533
        try:
 
3534
            pb = ui.ui_factory.nested_progress_bar()
 
3535
            cleanups.append(pb.finished)
 
3536
            tree.lock_write()
 
3537
            cleanups.append(tree.unlock)
 
3538
            if location is not None:
 
3539
                try:
 
3540
                    mergeable = bundle.read_mergeable_from_url(location,
 
3541
                        possible_transports=possible_transports)
 
3542
                except errors.NotABundle:
 
3543
                    mergeable = None
 
3544
                else:
 
3545
                    if uncommitted:
 
3546
                        raise errors.BzrCommandError('Cannot use --uncommitted'
 
3547
                            ' with bundles or merge directives.')
 
3548
 
 
3549
                    if revision is not None:
 
3550
                        raise errors.BzrCommandError(
 
3551
                            'Cannot use -r with merge directives or bundles')
 
3552
                    merger, verified = _mod_merge.Merger.from_mergeable(tree,
 
3553
                       mergeable, pb)
 
3554
 
 
3555
            if merger is None and uncommitted:
 
3556
                if revision is not None and len(revision) > 0:
 
3557
                    raise errors.BzrCommandError('Cannot use --uncommitted and'
 
3558
                        ' --revision at the same time.')
 
3559
                location = self._select_branch_location(tree, location)[0]
 
3560
                other_tree, other_path = WorkingTree.open_containing(location)
 
3561
                merger = _mod_merge.Merger.from_uncommitted(tree, other_tree,
 
3562
                    pb)
 
3563
                allow_pending = False
 
3564
                if other_path != '':
 
3565
                    merger.interesting_files = [other_path]
 
3566
 
 
3567
            if merger is None:
 
3568
                merger, allow_pending = self._get_merger_from_branch(tree,
 
3569
                    location, revision, remember, possible_transports, pb)
 
3570
 
 
3571
            merger.merge_type = merge_type
 
3572
            merger.reprocess = reprocess
 
3573
            merger.show_base = show_base
 
3574
            self.sanity_check_merger(merger)
 
3575
            if (merger.base_rev_id == merger.other_rev_id and
 
3576
                merger.other_rev_id is not None):
 
3577
                note('Nothing to do.')
 
3578
                return 0
 
3579
            if pull:
 
3580
                if merger.interesting_files is not None:
 
3581
                    raise errors.BzrCommandError('Cannot pull individual files')
 
3582
                if (merger.base_rev_id == tree.last_revision()):
 
3583
                    result = tree.pull(merger.other_branch, False,
 
3584
                                       merger.other_rev_id)
 
3585
                    result.report(self.outf)
 
3586
                    return 0
 
3587
            merger.check_basis(False)
 
3588
            if preview:
 
3589
                return self._do_preview(merger)
3824
3590
            else:
3825
 
                if uncommitted:
3826
 
                    raise errors.BzrCommandError('Cannot use --uncommitted'
3827
 
                        ' with bundles or merge directives.')
3828
 
 
3829
 
                if revision is not None:
3830
 
                    raise errors.BzrCommandError(
3831
 
                        'Cannot use -r with merge directives or bundles')
3832
 
                merger, verified = _mod_merge.Merger.from_mergeable(tree,
3833
 
                   mergeable, None)
3834
 
 
3835
 
        if merger is None and uncommitted:
3836
 
            if revision is not None and len(revision) > 0:
3837
 
                raise errors.BzrCommandError('Cannot use --uncommitted and'
3838
 
                    ' --revision at the same time.')
3839
 
            merger = self.get_merger_from_uncommitted(tree, location, None)
3840
 
            allow_pending = False
3841
 
 
3842
 
        if merger is None:
3843
 
            merger, allow_pending = self._get_merger_from_branch(tree,
3844
 
                location, revision, remember, possible_transports, None)
3845
 
 
3846
 
        merger.merge_type = merge_type
3847
 
        merger.reprocess = reprocess
3848
 
        merger.show_base = show_base
3849
 
        self.sanity_check_merger(merger)
3850
 
        if (merger.base_rev_id == merger.other_rev_id and
3851
 
            merger.other_rev_id is not None):
3852
 
            note('Nothing to do.')
3853
 
            return 0
3854
 
        if pull:
3855
 
            if merger.interesting_files is not None:
3856
 
                raise errors.BzrCommandError('Cannot pull individual files')
3857
 
            if (merger.base_rev_id == tree.last_revision()):
3858
 
                result = tree.pull(merger.other_branch, False,
3859
 
                                   merger.other_rev_id)
3860
 
                result.report(self.outf)
3861
 
                return 0
3862
 
        if merger.this_basis is None:
3863
 
            raise errors.BzrCommandError(
3864
 
                "This branch has no commits."
3865
 
                " (perhaps you would prefer 'bzr pull')")
3866
 
        if preview:
3867
 
            return self._do_preview(merger)
3868
 
        elif interactive:
3869
 
            return self._do_interactive(merger)
3870
 
        else:
3871
 
            return self._do_merge(merger, change_reporter, allow_pending,
3872
 
                                  verified)
3873
 
 
3874
 
    def _get_preview(self, merger):
 
3591
                return self._do_merge(merger, change_reporter, allow_pending,
 
3592
                                      verified)
 
3593
        finally:
 
3594
            for cleanup in reversed(cleanups):
 
3595
                cleanup()
 
3596
 
 
3597
    def _do_preview(self, merger):
 
3598
        from bzrlib.diff import show_diff_trees
3875
3599
        tree_merger = merger.make_merger()
3876
3600
        tt = tree_merger.make_preview_transform()
3877
 
        self.add_cleanup(tt.finalize)
3878
 
        result_tree = tt.get_preview_tree()
3879
 
        return result_tree
3880
 
 
3881
 
    def _do_preview(self, merger):
3882
 
        from bzrlib.diff import show_diff_trees
3883
 
        result_tree = self._get_preview(merger)
3884
 
        show_diff_trees(merger.this_tree, result_tree, self.outf,
3885
 
                        old_label='', new_label='')
 
3601
        try:
 
3602
            result_tree = tt.get_preview_tree()
 
3603
            show_diff_trees(merger.this_tree, result_tree, self.outf,
 
3604
                            old_label='', new_label='')
 
3605
        finally:
 
3606
            tt.finalize()
3886
3607
 
3887
3608
    def _do_merge(self, merger, change_reporter, allow_pending, verified):
3888
3609
        merger.change_reporter = change_reporter
3896
3617
        else:
3897
3618
            return 0
3898
3619
 
3899
 
    def _do_interactive(self, merger):
3900
 
        """Perform an interactive merge.
3901
 
 
3902
 
        This works by generating a preview tree of the merge, then using
3903
 
        Shelver to selectively remove the differences between the working tree
3904
 
        and the preview tree.
3905
 
        """
3906
 
        from bzrlib import shelf_ui
3907
 
        result_tree = self._get_preview(merger)
3908
 
        writer = bzrlib.option.diff_writer_registry.get()
3909
 
        shelver = shelf_ui.Shelver(merger.this_tree, result_tree, destroy=True,
3910
 
                                   reporter=shelf_ui.ApplyReporter(),
3911
 
                                   diff_writer=writer(sys.stdout))
3912
 
        try:
3913
 
            shelver.run()
3914
 
        finally:
3915
 
            shelver.finalize()
3916
 
 
3917
3620
    def sanity_check_merger(self, merger):
3918
3621
        if (merger.show_base and
3919
3622
            not merger.merge_type is _mod_merge.Merge3Merger):
3954
3657
            base_branch, base_path = Branch.open_containing(base_loc,
3955
3658
                possible_transports)
3956
3659
        # Find the revision ids
3957
 
        other_revision_id = None
3958
 
        base_revision_id = None
3959
 
        if revision is not None:
3960
 
            if len(revision) >= 1:
3961
 
                other_revision_id = revision[-1].as_revision_id(other_branch)
3962
 
            if len(revision) == 2:
3963
 
                base_revision_id = revision[0].as_revision_id(base_branch)
3964
 
        if other_revision_id is None:
 
3660
        if revision is None or len(revision) < 1 or revision[-1] is None:
3965
3661
            other_revision_id = _mod_revision.ensure_null(
3966
3662
                other_branch.last_revision())
 
3663
        else:
 
3664
            other_revision_id = revision[-1].as_revision_id(other_branch)
 
3665
        if (revision is not None and len(revision) == 2
 
3666
            and revision[0] is not None):
 
3667
            base_revision_id = revision[0].as_revision_id(base_branch)
 
3668
        else:
 
3669
            base_revision_id = None
3967
3670
        # Remember where we merge from
3968
3671
        if ((remember or tree.branch.get_submit_branch() is None) and
3969
3672
             user_location is not None):
3978
3681
            allow_pending = True
3979
3682
        return merger, allow_pending
3980
3683
 
3981
 
    def get_merger_from_uncommitted(self, tree, location, pb):
3982
 
        """Get a merger for uncommitted changes.
3983
 
 
3984
 
        :param tree: The tree the merger should apply to.
3985
 
        :param location: The location containing uncommitted changes.
3986
 
        :param pb: The progress bar to use for showing progress.
3987
 
        """
3988
 
        location = self._select_branch_location(tree, location)[0]
3989
 
        other_tree, other_path = WorkingTree.open_containing(location)
3990
 
        merger = _mod_merge.Merger.from_uncommitted(tree, other_tree, pb)
3991
 
        if other_path != '':
3992
 
            merger.interesting_files = [other_path]
3993
 
        return merger
3994
 
 
3995
3684
    def _select_branch_location(self, tree, user_location, revision=None,
3996
3685
                                index=None):
3997
3686
        """Select a branch location, according to possible inputs.
4041
3730
 
4042
3731
 
4043
3732
class cmd_remerge(Command):
4044
 
    __doc__ = """Redo a merge.
 
3733
    """Redo a merge.
4045
3734
 
4046
3735
    Use this if you want to try a different merge technique while resolving
4047
3736
    conflicts.  Some merge techniques are better than others, and remerge
4072
3761
 
4073
3762
    def run(self, file_list=None, merge_type=None, show_base=False,
4074
3763
            reprocess=False):
4075
 
        from bzrlib.conflicts import restore
4076
3764
        if merge_type is None:
4077
3765
            merge_type = _mod_merge.Merge3Merger
4078
3766
        tree, file_list = tree_files(file_list)
4079
 
        self.add_cleanup(tree.lock_write().unlock)
4080
 
        parents = tree.get_parent_ids()
4081
 
        if len(parents) != 2:
4082
 
            raise errors.BzrCommandError("Sorry, remerge only works after normal"
4083
 
                                         " merges.  Not cherrypicking or"
4084
 
                                         " multi-merges.")
4085
 
        repository = tree.branch.repository
4086
 
        interesting_ids = None
4087
 
        new_conflicts = []
4088
 
        conflicts = tree.conflicts()
4089
 
        if file_list is not None:
4090
 
            interesting_ids = set()
4091
 
            for filename in file_list:
4092
 
                file_id = tree.path2id(filename)
4093
 
                if file_id is None:
4094
 
                    raise errors.NotVersionedError(filename)
4095
 
                interesting_ids.add(file_id)
4096
 
                if tree.kind(file_id) != "directory":
4097
 
                    continue
 
3767
        tree.lock_write()
 
3768
        try:
 
3769
            parents = tree.get_parent_ids()
 
3770
            if len(parents) != 2:
 
3771
                raise errors.BzrCommandError("Sorry, remerge only works after normal"
 
3772
                                             " merges.  Not cherrypicking or"
 
3773
                                             " multi-merges.")
 
3774
            repository = tree.branch.repository
 
3775
            interesting_ids = None
 
3776
            new_conflicts = []
 
3777
            conflicts = tree.conflicts()
 
3778
            if file_list is not None:
 
3779
                interesting_ids = set()
 
3780
                for filename in file_list:
 
3781
                    file_id = tree.path2id(filename)
 
3782
                    if file_id is None:
 
3783
                        raise errors.NotVersionedError(filename)
 
3784
                    interesting_ids.add(file_id)
 
3785
                    if tree.kind(file_id) != "directory":
 
3786
                        continue
4098
3787
 
4099
 
                for name, ie in tree.inventory.iter_entries(file_id):
4100
 
                    interesting_ids.add(ie.file_id)
4101
 
            new_conflicts = conflicts.select_conflicts(tree, file_list)[0]
4102
 
        else:
4103
 
            # Remerge only supports resolving contents conflicts
4104
 
            allowed_conflicts = ('text conflict', 'contents conflict')
4105
 
            restore_files = [c.path for c in conflicts
4106
 
                             if c.typestring in allowed_conflicts]
4107
 
        _mod_merge.transform_tree(tree, tree.basis_tree(), interesting_ids)
4108
 
        tree.set_conflicts(ConflictList(new_conflicts))
4109
 
        if file_list is not None:
4110
 
            restore_files = file_list
4111
 
        for filename in restore_files:
 
3788
                    for name, ie in tree.inventory.iter_entries(file_id):
 
3789
                        interesting_ids.add(ie.file_id)
 
3790
                new_conflicts = conflicts.select_conflicts(tree, file_list)[0]
 
3791
            else:
 
3792
                # Remerge only supports resolving contents conflicts
 
3793
                allowed_conflicts = ('text conflict', 'contents conflict')
 
3794
                restore_files = [c.path for c in conflicts
 
3795
                                 if c.typestring in allowed_conflicts]
 
3796
            _mod_merge.transform_tree(tree, tree.basis_tree(), interesting_ids)
 
3797
            tree.set_conflicts(ConflictList(new_conflicts))
 
3798
            if file_list is not None:
 
3799
                restore_files = file_list
 
3800
            for filename in restore_files:
 
3801
                try:
 
3802
                    restore(tree.abspath(filename))
 
3803
                except errors.NotConflicted:
 
3804
                    pass
 
3805
            # Disable pending merges, because the file texts we are remerging
 
3806
            # have not had those merges performed.  If we use the wrong parents
 
3807
            # list, we imply that the working tree text has seen and rejected
 
3808
            # all the changes from the other tree, when in fact those changes
 
3809
            # have not yet been seen.
 
3810
            pb = ui.ui_factory.nested_progress_bar()
 
3811
            tree.set_parent_ids(parents[:1])
4112
3812
            try:
4113
 
                restore(tree.abspath(filename))
4114
 
            except errors.NotConflicted:
4115
 
                pass
4116
 
        # Disable pending merges, because the file texts we are remerging
4117
 
        # have not had those merges performed.  If we use the wrong parents
4118
 
        # list, we imply that the working tree text has seen and rejected
4119
 
        # all the changes from the other tree, when in fact those changes
4120
 
        # have not yet been seen.
4121
 
        tree.set_parent_ids(parents[:1])
4122
 
        try:
4123
 
            merger = _mod_merge.Merger.from_revision_ids(None, tree, parents[1])
4124
 
            merger.interesting_ids = interesting_ids
4125
 
            merger.merge_type = merge_type
4126
 
            merger.show_base = show_base
4127
 
            merger.reprocess = reprocess
4128
 
            conflicts = merger.do_merge()
 
3813
                merger = _mod_merge.Merger.from_revision_ids(pb,
 
3814
                                                             tree, parents[1])
 
3815
                merger.interesting_ids = interesting_ids
 
3816
                merger.merge_type = merge_type
 
3817
                merger.show_base = show_base
 
3818
                merger.reprocess = reprocess
 
3819
                conflicts = merger.do_merge()
 
3820
            finally:
 
3821
                tree.set_parent_ids(parents)
 
3822
                pb.finished()
4129
3823
        finally:
4130
 
            tree.set_parent_ids(parents)
 
3824
            tree.unlock()
4131
3825
        if conflicts > 0:
4132
3826
            return 1
4133
3827
        else:
4135
3829
 
4136
3830
 
4137
3831
class cmd_revert(Command):
4138
 
    __doc__ = """Revert files to a previous revision.
 
3832
    """Revert files to a previous revision.
4139
3833
 
4140
3834
    Giving a list of files will revert only those files.  Otherwise, all files
4141
3835
    will be reverted.  If the revision is not specified with '--revision', the
4155
3849
    name.  If you name a directory, all the contents of that directory will be
4156
3850
    reverted.
4157
3851
 
4158
 
    If you have newly added files since the target revision, they will be
4159
 
    removed.  If the files to be removed have been changed, backups will be
4160
 
    created as above.  Directories containing unknown files will not be
4161
 
    deleted.
 
3852
    Any files that have been newly added since that revision will be deleted,
 
3853
    with a backup kept if appropriate.  Directories containing unknown files
 
3854
    will not be deleted.
4162
3855
 
4163
 
    The working tree contains a list of revisions that have been merged but
4164
 
    not yet committed. These revisions will be included as additional parents
4165
 
    of the next commit.  Normally, using revert clears that list as well as
4166
 
    reverting the files.  If any files are specified, revert leaves the list
4167
 
    of uncommitted merges alone and reverts only the files.  Use ``bzr revert
4168
 
    .`` in the tree root to revert all files but keep the recorded merges,
4169
 
    and ``bzr revert --forget-merges`` to clear the pending merge list without
 
3856
    The working tree contains a list of pending merged revisions, which will
 
3857
    be included as parents in the next commit.  Normally, revert clears that
 
3858
    list as well as reverting the files.  If any files are specified, revert
 
3859
    leaves the pending merge list alone and reverts only the files.  Use "bzr
 
3860
    revert ." in the tree root to revert all files but keep the merge record,
 
3861
    and "bzr revert --forget-merges" to clear the pending merge list without
4170
3862
    reverting any files.
4171
 
 
4172
 
    Using "bzr revert --forget-merges", it is possible to apply all of the
4173
 
    changes from a branch in a single revision.  To do this, perform the merge
4174
 
    as desired.  Then doing revert with the "--forget-merges" option will keep
4175
 
    the content of the tree as it was, but it will clear the list of pending
4176
 
    merges.  The next commit will then contain all of the changes that are
4177
 
    present in the other branch, but without any other parent revisions.
4178
 
    Because this technique forgets where these changes originated, it may
4179
 
    cause additional conflicts on later merges involving the same source and
4180
 
    target branches.
4181
3863
    """
4182
3864
 
4183
3865
    _see_also = ['cat', 'export']
4192
3874
    def run(self, revision=None, no_backup=False, file_list=None,
4193
3875
            forget_merges=None):
4194
3876
        tree, file_list = tree_files(file_list)
4195
 
        self.add_cleanup(tree.lock_tree_write().unlock)
4196
 
        if forget_merges:
4197
 
            tree.set_parent_ids(tree.get_parent_ids()[:1])
4198
 
        else:
4199
 
            self._revert_tree_to_revision(tree, revision, file_list, no_backup)
 
3877
        tree.lock_write()
 
3878
        try:
 
3879
            if forget_merges:
 
3880
                tree.set_parent_ids(tree.get_parent_ids()[:1])
 
3881
            else:
 
3882
                self._revert_tree_to_revision(tree, revision, file_list, no_backup)
 
3883
        finally:
 
3884
            tree.unlock()
4200
3885
 
4201
3886
    @staticmethod
4202
3887
    def _revert_tree_to_revision(tree, revision, file_list, no_backup):
4203
3888
        rev_tree = _get_one_revision_tree('revert', revision, tree=tree)
4204
 
        tree.revert(file_list, rev_tree, not no_backup, None,
4205
 
            report_changes=True)
 
3889
        pb = ui.ui_factory.nested_progress_bar()
 
3890
        try:
 
3891
            tree.revert(file_list, rev_tree, not no_backup, pb,
 
3892
                report_changes=True)
 
3893
        finally:
 
3894
            pb.finished()
4206
3895
 
4207
3896
 
4208
3897
class cmd_assert_fail(Command):
4209
 
    __doc__ = """Test reporting of assertion failures"""
 
3898
    """Test reporting of assertion failures"""
4210
3899
    # intended just for use in testing
4211
3900
 
4212
3901
    hidden = True
4216
3905
 
4217
3906
 
4218
3907
class cmd_help(Command):
4219
 
    __doc__ = """Show help on a command or other topic.
 
3908
    """Show help on a command or other topic.
4220
3909
    """
4221
3910
 
4222
3911
    _see_also = ['topics']
4235
3924
 
4236
3925
 
4237
3926
class cmd_shell_complete(Command):
4238
 
    __doc__ = """Show appropriate completions for context.
 
3927
    """Show appropriate completions for context.
4239
3928
 
4240
3929
    For a list of all available commands, say 'bzr shell-complete'.
4241
3930
    """
4250
3939
 
4251
3940
 
4252
3941
class cmd_missing(Command):
4253
 
    __doc__ = """Show unmerged/unpulled revisions between two branches.
 
3942
    """Show unmerged/unpulled revisions between two branches.
4254
3943
 
4255
3944
    OTHER_BRANCH may be local or remote.
4256
3945
 
4257
3946
    To filter on a range of revisions, you can use the command -r begin..end
4258
3947
    -r revision requests a specific revision, -r ..end or -r begin.. are
4259
3948
    also valid.
4260
 
            
4261
 
    :Exit values:
4262
 
        1 - some missing revisions
4263
 
        0 - no missing revisions
4264
3949
 
4265
3950
    :Examples:
4266
3951
 
4334
4019
            restrict = 'remote'
4335
4020
 
4336
4021
        local_branch = Branch.open_containing(u".")[0]
4337
 
        self.add_cleanup(local_branch.lock_read().unlock)
4338
 
 
4339
4022
        parent = local_branch.get_parent()
4340
4023
        if other_branch is None:
4341
4024
            other_branch = parent
4350
4033
        remote_branch = Branch.open(other_branch)
4351
4034
        if remote_branch.base == local_branch.base:
4352
4035
            remote_branch = local_branch
4353
 
        else:
4354
 
            self.add_cleanup(remote_branch.lock_read().unlock)
4355
4036
 
4356
4037
        local_revid_range = _revision_range_to_revid_range(
4357
4038
            _get_revision_range(my_revision, local_branch,
4361
4042
            _get_revision_range(revision,
4362
4043
                remote_branch, self.name()))
4363
4044
 
4364
 
        local_extra, remote_extra = find_unmerged(
4365
 
            local_branch, remote_branch, restrict,
4366
 
            backward=not reverse,
4367
 
            include_merges=include_merges,
4368
 
            local_revid_range=local_revid_range,
4369
 
            remote_revid_range=remote_revid_range)
4370
 
 
4371
 
        if log_format is None:
4372
 
            registry = log.log_formatter_registry
4373
 
            log_format = registry.get_default(local_branch)
4374
 
        lf = log_format(to_file=self.outf,
4375
 
                        show_ids=show_ids,
4376
 
                        show_timezone='original')
4377
 
 
4378
 
        status_code = 0
4379
 
        if local_extra and not theirs_only:
4380
 
            message("You have %d extra revision(s):\n" %
4381
 
                len(local_extra))
4382
 
            for revision in iter_log_revisions(local_extra,
4383
 
                                local_branch.repository,
4384
 
                                verbose):
4385
 
                lf.log_revision(revision)
4386
 
            printed_local = True
4387
 
            status_code = 1
4388
 
        else:
4389
 
            printed_local = False
4390
 
 
4391
 
        if remote_extra and not mine_only:
4392
 
            if printed_local is True:
4393
 
                message("\n\n\n")
4394
 
            message("You are missing %d revision(s):\n" %
4395
 
                len(remote_extra))
4396
 
            for revision in iter_log_revisions(remote_extra,
4397
 
                                remote_branch.repository,
4398
 
                                verbose):
4399
 
                lf.log_revision(revision)
4400
 
            status_code = 1
4401
 
 
4402
 
        if mine_only and not local_extra:
4403
 
            # We checked local, and found nothing extra
4404
 
            message('This branch is up to date.\n')
4405
 
        elif theirs_only and not remote_extra:
4406
 
            # We checked remote, and found nothing extra
4407
 
            message('Other branch is up to date.\n')
4408
 
        elif not (mine_only or theirs_only or local_extra or
4409
 
                  remote_extra):
4410
 
            # We checked both branches, and neither one had extra
4411
 
            # revisions
4412
 
            message("Branches are up to date.\n")
4413
 
        self.cleanup_now()
 
4045
        local_branch.lock_read()
 
4046
        try:
 
4047
            remote_branch.lock_read()
 
4048
            try:
 
4049
                local_extra, remote_extra = find_unmerged(
 
4050
                    local_branch, remote_branch, restrict,
 
4051
                    backward=not reverse,
 
4052
                    include_merges=include_merges,
 
4053
                    local_revid_range=local_revid_range,
 
4054
                    remote_revid_range=remote_revid_range)
 
4055
 
 
4056
                if log_format is None:
 
4057
                    registry = log.log_formatter_registry
 
4058
                    log_format = registry.get_default(local_branch)
 
4059
                lf = log_format(to_file=self.outf,
 
4060
                                show_ids=show_ids,
 
4061
                                show_timezone='original')
 
4062
 
 
4063
                status_code = 0
 
4064
                if local_extra and not theirs_only:
 
4065
                    message("You have %d extra revision(s):\n" %
 
4066
                        len(local_extra))
 
4067
                    for revision in iter_log_revisions(local_extra,
 
4068
                                        local_branch.repository,
 
4069
                                        verbose):
 
4070
                        lf.log_revision(revision)
 
4071
                    printed_local = True
 
4072
                    status_code = 1
 
4073
                else:
 
4074
                    printed_local = False
 
4075
 
 
4076
                if remote_extra and not mine_only:
 
4077
                    if printed_local is True:
 
4078
                        message("\n\n\n")
 
4079
                    message("You are missing %d revision(s):\n" %
 
4080
                        len(remote_extra))
 
4081
                    for revision in iter_log_revisions(remote_extra,
 
4082
                                        remote_branch.repository,
 
4083
                                        verbose):
 
4084
                        lf.log_revision(revision)
 
4085
                    status_code = 1
 
4086
 
 
4087
                if mine_only and not local_extra:
 
4088
                    # We checked local, and found nothing extra
 
4089
                    message('This branch is up to date.\n')
 
4090
                elif theirs_only and not remote_extra:
 
4091
                    # We checked remote, and found nothing extra
 
4092
                    message('Other branch is up to date.\n')
 
4093
                elif not (mine_only or theirs_only or local_extra or
 
4094
                          remote_extra):
 
4095
                    # We checked both branches, and neither one had extra
 
4096
                    # revisions
 
4097
                    message("Branches are up to date.\n")
 
4098
            finally:
 
4099
                remote_branch.unlock()
 
4100
        finally:
 
4101
            local_branch.unlock()
4414
4102
        if not status_code and parent is None and other_branch is not None:
4415
 
            self.add_cleanup(local_branch.lock_write().unlock)
4416
 
            # handle race conditions - a parent might be set while we run.
4417
 
            if local_branch.get_parent() is None:
4418
 
                local_branch.set_parent(remote_branch.base)
 
4103
            local_branch.lock_write()
 
4104
            try:
 
4105
                # handle race conditions - a parent might be set while we run.
 
4106
                if local_branch.get_parent() is None:
 
4107
                    local_branch.set_parent(remote_branch.base)
 
4108
            finally:
 
4109
                local_branch.unlock()
4419
4110
        return status_code
4420
4111
 
4421
4112
 
4422
4113
class cmd_pack(Command):
4423
 
    __doc__ = """Compress the data within a repository.
4424
 
 
4425
 
    This operation compresses the data within a bazaar repository. As
4426
 
    bazaar supports automatic packing of repository, this operation is
4427
 
    normally not required to be done manually.
4428
 
 
4429
 
    During the pack operation, bazaar takes a backup of existing repository
4430
 
    data, i.e. pack files. This backup is eventually removed by bazaar
4431
 
    automatically when it is safe to do so. To save disk space by removing
4432
 
    the backed up pack files, the --clean-obsolete-packs option may be
4433
 
    used.
4434
 
 
4435
 
    Warning: If you use --clean-obsolete-packs and your machine crashes
4436
 
    during or immediately after repacking, you may be left with a state
4437
 
    where the deletion has been written to disk but the new packs have not
4438
 
    been. In this case the repository may be unusable.
4439
 
    """
 
4114
    """Compress the data within a repository."""
4440
4115
 
4441
4116
    _see_also = ['repositories']
4442
4117
    takes_args = ['branch_or_repo?']
4443
 
    takes_options = [
4444
 
        Option('clean-obsolete-packs', 'Delete obsolete packs to save disk space.'),
4445
 
        ]
4446
4118
 
4447
 
    def run(self, branch_or_repo='.', clean_obsolete_packs=False):
 
4119
    def run(self, branch_or_repo='.'):
4448
4120
        dir = bzrdir.BzrDir.open_containing(branch_or_repo)[0]
4449
4121
        try:
4450
4122
            branch = dir.open_branch()
4451
4123
            repository = branch.repository
4452
4124
        except errors.NotBranchError:
4453
4125
            repository = dir.open_repository()
4454
 
        repository.pack(clean_obsolete_packs=clean_obsolete_packs)
 
4126
        repository.pack()
4455
4127
 
4456
4128
 
4457
4129
class cmd_plugins(Command):
4458
 
    __doc__ = """List the installed plugins.
 
4130
    """List the installed plugins.
4459
4131
 
4460
4132
    This command displays the list of installed plugins including
4461
4133
    version of plugin and a short description of each.
4468
4140
    adding new commands, providing additional network transports and
4469
4141
    customizing log output.
4470
4142
 
4471
 
    See the Bazaar Plugin Guide <http://doc.bazaar.canonical.com/plugins/en/>
4472
 
    for further information on plugins including where to find them and how to
4473
 
    install them. Instructions are also provided there on how to write new
4474
 
    plugins using the Python programming language.
 
4143
    See the Bazaar web site, http://bazaar-vcs.org, for further
 
4144
    information on plugins including where to find them and how to
 
4145
    install them. Instructions are also provided there on how to
 
4146
    write new plugins using the Python programming language.
4475
4147
    """
4476
4148
    takes_options = ['verbose']
4477
4149
 
4492
4164
                doc = '(no description)'
4493
4165
            result.append((name_ver, doc, plugin.path()))
4494
4166
        for name_ver, doc, path in sorted(result):
4495
 
            self.outf.write("%s\n" % name_ver)
4496
 
            self.outf.write("   %s\n" % doc)
 
4167
            print name_ver
 
4168
            print '   ', doc
4497
4169
            if verbose:
4498
 
                self.outf.write("   %s\n" % path)
4499
 
            self.outf.write("\n")
 
4170
                print '   ', path
 
4171
            print
4500
4172
 
4501
4173
 
4502
4174
class cmd_testament(Command):
4503
 
    __doc__ = """Show testament (signing-form) of a revision."""
 
4175
    """Show testament (signing-form) of a revision."""
4504
4176
    takes_options = [
4505
4177
            'revision',
4506
4178
            Option('long', help='Produce long-format testament.'),
4518
4190
            b = Branch.open_containing(branch)[0]
4519
4191
        else:
4520
4192
            b = Branch.open(branch)
4521
 
        self.add_cleanup(b.lock_read().unlock)
4522
 
        if revision is None:
4523
 
            rev_id = b.last_revision()
4524
 
        else:
4525
 
            rev_id = revision[0].as_revision_id(b)
4526
 
        t = testament_class.from_revision(b.repository, rev_id)
4527
 
        if long:
4528
 
            sys.stdout.writelines(t.as_text_lines())
4529
 
        else:
4530
 
            sys.stdout.write(t.as_short_text())
 
4193
        b.lock_read()
 
4194
        try:
 
4195
            if revision is None:
 
4196
                rev_id = b.last_revision()
 
4197
            else:
 
4198
                rev_id = revision[0].as_revision_id(b)
 
4199
            t = testament_class.from_revision(b.repository, rev_id)
 
4200
            if long:
 
4201
                sys.stdout.writelines(t.as_text_lines())
 
4202
            else:
 
4203
                sys.stdout.write(t.as_short_text())
 
4204
        finally:
 
4205
            b.unlock()
4531
4206
 
4532
4207
 
4533
4208
class cmd_annotate(Command):
4534
 
    __doc__ = """Show the origin of each line in a file.
 
4209
    """Show the origin of each line in a file.
4535
4210
 
4536
4211
    This prints out the given file with an annotation on the left side
4537
4212
    indicating which revision, author and date introduced the change.
4548
4223
                     Option('long', help='Show commit date in annotations.'),
4549
4224
                     'revision',
4550
4225
                     'show-ids',
4551
 
                     'directory',
4552
4226
                     ]
4553
4227
    encoding_type = 'exact'
4554
4228
 
4555
4229
    @display_command
4556
4230
    def run(self, filename, all=False, long=False, revision=None,
4557
 
            show_ids=False, directory=None):
 
4231
            show_ids=False):
4558
4232
        from bzrlib.annotate import annotate_file, annotate_file_tree
4559
4233
        wt, branch, relpath = \
4560
 
            _open_directory_or_containing_tree_or_branch(filename, directory)
4561
 
        if wt is not None:
4562
 
            self.add_cleanup(wt.lock_read().unlock)
4563
 
        else:
4564
 
            self.add_cleanup(branch.lock_read().unlock)
4565
 
        tree = _get_one_revision_tree('annotate', revision, branch=branch)
4566
 
        self.add_cleanup(tree.lock_read().unlock)
4567
 
        if wt is not None:
4568
 
            file_id = wt.path2id(relpath)
4569
 
        else:
4570
 
            file_id = tree.path2id(relpath)
4571
 
        if file_id is None:
4572
 
            raise errors.NotVersionedError(filename)
4573
 
        file_version = tree.inventory[file_id].revision
4574
 
        if wt is not None and revision is None:
4575
 
            # If there is a tree and we're not annotating historical
4576
 
            # versions, annotate the working tree's content.
4577
 
            annotate_file_tree(wt, file_id, self.outf, long, all,
4578
 
                show_ids=show_ids)
4579
 
        else:
4580
 
            annotate_file(branch, file_version, file_id, long, all, self.outf,
4581
 
                          show_ids=show_ids)
 
4234
            bzrdir.BzrDir.open_containing_tree_or_branch(filename)
 
4235
        if wt is not None:
 
4236
            wt.lock_read()
 
4237
        else:
 
4238
            branch.lock_read()
 
4239
        try:
 
4240
            tree = _get_one_revision_tree('annotate', revision, branch=branch)
 
4241
            if wt is not None:
 
4242
                file_id = wt.path2id(relpath)
 
4243
            else:
 
4244
                file_id = tree.path2id(relpath)
 
4245
            if file_id is None:
 
4246
                raise errors.NotVersionedError(filename)
 
4247
            file_version = tree.inventory[file_id].revision
 
4248
            if wt is not None and revision is None:
 
4249
                # If there is a tree and we're not annotating historical
 
4250
                # versions, annotate the working tree's content.
 
4251
                annotate_file_tree(wt, file_id, self.outf, long, all,
 
4252
                    show_ids=show_ids)
 
4253
            else:
 
4254
                annotate_file(branch, file_version, file_id, long, all, self.outf,
 
4255
                              show_ids=show_ids)
 
4256
        finally:
 
4257
            if wt is not None:
 
4258
                wt.unlock()
 
4259
            else:
 
4260
                branch.unlock()
4582
4261
 
4583
4262
 
4584
4263
class cmd_re_sign(Command):
4585
 
    __doc__ = """Create a digital signature for an existing revision."""
 
4264
    """Create a digital signature for an existing revision."""
4586
4265
    # TODO be able to replace existing ones.
4587
4266
 
4588
4267
    hidden = True # is this right ?
4589
4268
    takes_args = ['revision_id*']
4590
 
    takes_options = ['directory', 'revision']
 
4269
    takes_options = ['revision']
4591
4270
 
4592
 
    def run(self, revision_id_list=None, revision=None, directory=u'.'):
 
4271
    def run(self, revision_id_list=None, revision=None):
4593
4272
        if revision_id_list is not None and revision is not None:
4594
4273
            raise errors.BzrCommandError('You can only supply one of revision_id or --revision')
4595
4274
        if revision_id_list is None and revision is None:
4596
4275
            raise errors.BzrCommandError('You must supply either --revision or a revision_id')
4597
 
        b = WorkingTree.open_containing(directory)[0].branch
4598
 
        self.add_cleanup(b.lock_write().unlock)
4599
 
        return self._run(b, revision_id_list, revision)
 
4276
        b = WorkingTree.open_containing(u'.')[0].branch
 
4277
        b.lock_write()
 
4278
        try:
 
4279
            return self._run(b, revision_id_list, revision)
 
4280
        finally:
 
4281
            b.unlock()
4600
4282
 
4601
4283
    def _run(self, b, revision_id_list, revision):
4602
4284
        import bzrlib.gpg as gpg
4647
4329
 
4648
4330
 
4649
4331
class cmd_bind(Command):
4650
 
    __doc__ = """Convert the current branch into a checkout of the supplied branch.
4651
 
    If no branch is supplied, rebind to the last bound location.
 
4332
    """Convert the current branch into a checkout of the supplied branch.
4652
4333
 
4653
4334
    Once converted into a checkout, commits must succeed on the master branch
4654
4335
    before they will be applied to the local branch.
4655
4336
 
4656
4337
    Bound branches use the nickname of its master branch unless it is set
4657
 
    locally, in which case binding will update the local nickname to be
 
4338
    locally, in which case binding will update the the local nickname to be
4658
4339
    that of the master.
4659
4340
    """
4660
4341
 
4661
4342
    _see_also = ['checkouts', 'unbind']
4662
4343
    takes_args = ['location?']
4663
 
    takes_options = ['directory']
 
4344
    takes_options = []
4664
4345
 
4665
 
    def run(self, location=None, directory=u'.'):
4666
 
        b, relpath = Branch.open_containing(directory)
 
4346
    def run(self, location=None):
 
4347
        b, relpath = Branch.open_containing(u'.')
4667
4348
        if location is None:
4668
4349
            try:
4669
4350
                location = b.get_old_bound_location()
4672
4353
                    'This format does not remember old locations.')
4673
4354
            else:
4674
4355
                if location is None:
4675
 
                    if b.get_bound_location() is not None:
4676
 
                        raise errors.BzrCommandError('Branch is already bound')
4677
 
                    else:
4678
 
                        raise errors.BzrCommandError('No location supplied '
4679
 
                            'and no previous location known')
 
4356
                    raise errors.BzrCommandError('No location supplied and no '
 
4357
                        'previous location known')
4680
4358
        b_other = Branch.open(location)
4681
4359
        try:
4682
4360
            b.bind(b_other)
4688
4366
 
4689
4367
 
4690
4368
class cmd_unbind(Command):
4691
 
    __doc__ = """Convert the current checkout into a regular branch.
 
4369
    """Convert the current checkout into a regular branch.
4692
4370
 
4693
4371
    After unbinding, the local branch is considered independent and subsequent
4694
4372
    commits will be local only.
4696
4374
 
4697
4375
    _see_also = ['checkouts', 'bind']
4698
4376
    takes_args = []
4699
 
    takes_options = ['directory']
 
4377
    takes_options = []
4700
4378
 
4701
 
    def run(self, directory=u'.'):
4702
 
        b, relpath = Branch.open_containing(directory)
 
4379
    def run(self):
 
4380
        b, relpath = Branch.open_containing(u'.')
4703
4381
        if not b.unbind():
4704
4382
            raise errors.BzrCommandError('Local branch is not bound')
4705
4383
 
4706
4384
 
4707
4385
class cmd_uncommit(Command):
4708
 
    __doc__ = """Remove the last committed revision.
 
4386
    """Remove the last committed revision.
4709
4387
 
4710
4388
    --verbose will print out what is being removed.
4711
4389
    --dry-run will go through all the motions, but not actually
4751
4429
            b = control.open_branch()
4752
4430
 
4753
4431
        if tree is not None:
4754
 
            self.add_cleanup(tree.lock_write().unlock)
 
4432
            tree.lock_write()
4755
4433
        else:
4756
 
            self.add_cleanup(b.lock_write().unlock)
4757
 
        return self._run(b, tree, dry_run, verbose, revision, force, local=local)
 
4434
            b.lock_write()
 
4435
        try:
 
4436
            return self._run(b, tree, dry_run, verbose, revision, force,
 
4437
                             local=local)
 
4438
        finally:
 
4439
            if tree is not None:
 
4440
                tree.unlock()
 
4441
            else:
 
4442
                b.unlock()
4758
4443
 
4759
4444
    def _run(self, b, tree, dry_run, verbose, revision, force, local=False):
4760
4445
        from bzrlib.log import log_formatter, show_log
4792
4477
                 end_revision=last_revno)
4793
4478
 
4794
4479
        if dry_run:
4795
 
            self.outf.write('Dry-run, pretending to remove'
4796
 
                            ' the above revisions.\n')
 
4480
            print 'Dry-run, pretending to remove the above revisions.'
 
4481
            if not force:
 
4482
                val = raw_input('Press <enter> to continue')
4797
4483
        else:
4798
 
            self.outf.write('The above revision(s) will be removed.\n')
4799
 
 
4800
 
        if not force:
4801
 
            if not ui.ui_factory.get_boolean('Are you sure'):
4802
 
                self.outf.write('Canceled')
4803
 
                return 0
 
4484
            print 'The above revision(s) will be removed.'
 
4485
            if not force:
 
4486
                val = raw_input('Are you sure [y/N]? ')
 
4487
                if val.lower() not in ('y', 'yes'):
 
4488
                    print 'Canceled'
 
4489
                    return 0
4804
4490
 
4805
4491
        mutter('Uncommitting from {%s} to {%s}',
4806
4492
               last_rev_id, rev_id)
4807
4493
        uncommit(b, tree=tree, dry_run=dry_run, verbose=verbose,
4808
4494
                 revno=revno, local=local)
4809
 
        self.outf.write('You can restore the old tip by running:\n'
4810
 
             '  bzr pull . -r revid:%s\n' % last_rev_id)
 
4495
        note('You can restore the old tip by running:\n'
 
4496
             '  bzr pull . -r revid:%s', last_rev_id)
4811
4497
 
4812
4498
 
4813
4499
class cmd_break_lock(Command):
4814
 
    __doc__ = """Break a dead lock on a repository, branch or working directory.
 
4500
    """Break a dead lock on a repository, branch or working directory.
4815
4501
 
4816
4502
    CAUTION: Locks should only be broken when you are sure that the process
4817
4503
    holding the lock has been stopped.
4818
4504
 
4819
 
    You can get information on what locks are open via the 'bzr info
4820
 
    [location]' command.
 
4505
    You can get information on what locks are open via the 'bzr info' command.
4821
4506
 
4822
4507
    :Examples:
4823
4508
        bzr break-lock
4824
 
        bzr break-lock bzr+ssh://example.com/bzr/foo
4825
4509
    """
4826
4510
    takes_args = ['location?']
4827
4511
 
4836
4520
 
4837
4521
 
4838
4522
class cmd_wait_until_signalled(Command):
4839
 
    __doc__ = """Test helper for test_start_and_stop_bzr_subprocess_send_signal.
 
4523
    """Test helper for test_start_and_stop_bzr_subprocess_send_signal.
4840
4524
 
4841
4525
    This just prints a line to signal when it is ready, then blocks on stdin.
4842
4526
    """
4850
4534
 
4851
4535
 
4852
4536
class cmd_serve(Command):
4853
 
    __doc__ = """Run the bzr server."""
 
4537
    """Run the bzr server."""
4854
4538
 
4855
4539
    aliases = ['server']
4856
4540
 
4857
4541
    takes_options = [
4858
4542
        Option('inet',
4859
4543
               help='Serve on stdin/out for use from inetd or sshd.'),
4860
 
        RegistryOption('protocol',
4861
 
               help="Protocol to serve.",
 
4544
        RegistryOption('protocol', 
 
4545
               help="Protocol to serve.", 
4862
4546
               lazy_registry=('bzrlib.transport', 'transport_server_registry'),
4863
4547
               value_switches=True),
4864
4548
        Option('port',
4867
4551
                    'result in a dynamically allocated port.  The default port '
4868
4552
                    'depends on the protocol.',
4869
4553
               type=str),
4870
 
        custom_help('directory',
4871
 
               help='Serve contents of this directory.'),
 
4554
        Option('directory',
 
4555
               help='Serve contents of this directory.',
 
4556
               type=unicode),
4872
4557
        Option('allow-writes',
4873
4558
               help='By default the server is a readonly server.  Supplying '
4874
4559
                    '--allow-writes enables write access to the contents of '
4875
 
                    'the served directory and below.  Note that ``bzr serve`` '
4876
 
                    'does not perform authentication, so unless some form of '
4877
 
                    'external authentication is arranged supplying this '
4878
 
                    'option leads to global uncontrolled write access to your '
4879
 
                    'file system.'
 
4560
                    'the served directory and below.'
4880
4561
                ),
4881
4562
        ]
4882
4563
 
4915
4596
 
4916
4597
 
4917
4598
class cmd_join(Command):
4918
 
    __doc__ = """Combine a tree into its containing tree.
 
4599
    """Combine a tree into its containing tree.
4919
4600
 
4920
4601
    This command requires the target tree to be in a rich-root format.
4921
4602
 
4961
4642
 
4962
4643
 
4963
4644
class cmd_split(Command):
4964
 
    __doc__ = """Split a subdirectory of a tree into a separate tree.
 
4645
    """Split a subdirectory of a tree into a separate tree.
4965
4646
 
4966
4647
    This command will produce a target tree in a format that supports
4967
4648
    rich roots, like 'rich-root' or 'rich-root-pack'.  These formats cannot be
4983
4664
        try:
4984
4665
            containing_tree.extract(sub_id)
4985
4666
        except errors.RootNotRich:
4986
 
            raise errors.RichRootUpgradeRequired(containing_tree.branch.base)
 
4667
            raise errors.UpgradeRequired(containing_tree.branch.base)
4987
4668
 
4988
4669
 
4989
4670
class cmd_merge_directive(Command):
4990
 
    __doc__ = """Generate a merge directive for auto-merge tools.
 
4671
    """Generate a merge directive for auto-merge tools.
4991
4672
 
4992
4673
    A directive requests a merge to be performed, and also provides all the
4993
4674
    information necessary to do so.  This means it must either include a
5086
4767
 
5087
4768
 
5088
4769
class cmd_send(Command):
5089
 
    __doc__ = """Mail or create a merge-directive for submitting changes.
 
4770
    """Mail or create a merge-directive for submitting changes.
5090
4771
 
5091
4772
    A merge directive provides many things needed for requesting merges:
5092
4773
 
5098
4779
      directly from the merge directive, without retrieving data from a
5099
4780
      branch.
5100
4781
 
5101
 
    `bzr send` creates a compact data set that, when applied using bzr
5102
 
    merge, has the same effect as merging from the source branch.  
5103
 
    
5104
 
    By default the merge directive is self-contained and can be applied to any
5105
 
    branch containing submit_branch in its ancestory without needing access to
5106
 
    the source branch.
5107
 
    
5108
 
    If --no-bundle is specified, then Bazaar doesn't send the contents of the
5109
 
    revisions, but only a structured request to merge from the
5110
 
    public_location.  In that case the public_branch is needed and it must be
5111
 
    up-to-date and accessible to the recipient.  The public_branch is always
5112
 
    included if known, so that people can check it later.
5113
 
 
5114
 
    The submit branch defaults to the parent of the source branch, but can be
5115
 
    overridden.  Both submit branch and public branch will be remembered in
5116
 
    branch.conf the first time they are used for a particular branch.  The
5117
 
    source branch defaults to that containing the working directory, but can
5118
 
    be changed using --from.
5119
 
 
5120
 
    In order to calculate those changes, bzr must analyse the submit branch.
5121
 
    Therefore it is most efficient for the submit branch to be a local mirror.
5122
 
    If a public location is known for the submit_branch, that location is used
5123
 
    in the merge directive.
5124
 
 
5125
 
    The default behaviour is to send the merge directive by mail, unless -o is
5126
 
    given, in which case it is sent to a file.
 
4782
    If --no-bundle is specified, then public_branch is needed (and must be
 
4783
    up-to-date), so that the receiver can perform the merge using the
 
4784
    public_branch.  The public_branch is always included if known, so that
 
4785
    people can check it later.
 
4786
 
 
4787
    The submit branch defaults to the parent, but can be overridden.  Both
 
4788
    submit branch and public branch will be remembered if supplied.
 
4789
 
 
4790
    If a public_branch is known for the submit_branch, that public submit
 
4791
    branch is used in the merge instructions.  This means that a local mirror
 
4792
    can be used as your actual submit branch, once you have set public_branch
 
4793
    for that mirror.
5127
4794
 
5128
4795
    Mail is sent using your preferred mail program.  This should be transparent
5129
4796
    on Windows (it uses MAPI).  On Linux, it requires the xdg-email utility.
5131
4798
 
5132
4799
    To use a specific mail program, set the mail_client configuration option.
5133
4800
    (For Thunderbird 1.5, this works around some bugs.)  Supported values for
5134
 
    specific clients are "claws", "evolution", "kmail", "mail.app" (MacOS X's
5135
 
    Mail.app), "mutt", and "thunderbird"; generic options are "default",
5136
 
    "editor", "emacsclient", "mapi", and "xdg-email".  Plugins may also add
5137
 
    supported clients.
 
4801
    specific clients are "claws", "evolution", "kmail", "mutt", and
 
4802
    "thunderbird"; generic options are "default", "editor", "emacsclient",
 
4803
    "mapi", and "xdg-email".  Plugins may also add supported clients.
5138
4804
 
5139
4805
    If mail is being sent, a to address is required.  This can be supplied
5140
4806
    either on the commandline, by setting the submit_to configuration
5149
4815
 
5150
4816
    The merge directives created by bzr send may be applied using bzr merge or
5151
4817
    bzr pull by specifying a file containing a merge directive as the location.
5152
 
 
5153
 
    bzr send makes extensive use of public locations to map local locations into
5154
 
    URLs that can be used by other people.  See `bzr help configuration` to
5155
 
    set them, and use `bzr info` to display them.
5156
4818
    """
5157
4819
 
5158
4820
    encoding_type = 'exact'
5174
4836
               short_name='f',
5175
4837
               type=unicode),
5176
4838
        Option('output', short_name='o',
5177
 
               help='Write merge directive to this file or directory; '
 
4839
               help='Write merge directive to this file; '
5178
4840
                    'use - for stdout.',
5179
4841
               type=unicode),
5180
 
        Option('strict',
5181
 
               help='Refuse to send if there are uncommitted changes in'
5182
 
               ' the working tree, --no-strict disables the check.'),
5183
4842
        Option('mail-to', help='Mail the request to this address.',
5184
4843
               type=unicode),
5185
4844
        'revision',
5186
4845
        'message',
5187
4846
        Option('body', help='Body for the email.', type=unicode),
5188
4847
        RegistryOption('format',
5189
 
                       help='Use the specified output format.',
5190
 
                       lazy_registry=('bzrlib.send', 'format_registry')),
 
4848
                       help='Use the specified output format.', 
 
4849
                       lazy_registry=('bzrlib.send', 'format_registry'))
5191
4850
        ]
5192
4851
 
5193
4852
    def run(self, submit_branch=None, public_branch=None, no_bundle=False,
5194
4853
            no_patch=False, revision=None, remember=False, output=None,
5195
 
            format=None, mail_to=None, message=None, body=None,
5196
 
            strict=None, **kwargs):
 
4854
            format=None, mail_to=None, message=None, body=None, **kwargs):
5197
4855
        from bzrlib.send import send
5198
4856
        return send(submit_branch, revision, public_branch, remember,
5199
 
                    format, no_bundle, no_patch, output,
5200
 
                    kwargs.get('from', '.'), mail_to, message, body,
5201
 
                    self.outf,
5202
 
                    strict=strict)
 
4857
                         format, no_bundle, no_patch, output,
 
4858
                         kwargs.get('from', '.'), mail_to, message, body,
 
4859
                         self.outf)
5203
4860
 
5204
4861
 
5205
4862
class cmd_bundle_revisions(cmd_send):
5206
 
    __doc__ = """Create a merge-directive for submitting changes.
 
4863
    """Create a merge-directive for submitting changes.
5207
4864
 
5208
4865
    A merge directive provides many things needed for requesting merges:
5209
4866
 
5249
4906
               type=unicode),
5250
4907
        Option('output', short_name='o', help='Write directive to this file.',
5251
4908
               type=unicode),
5252
 
        Option('strict',
5253
 
               help='Refuse to bundle revisions if there are uncommitted'
5254
 
               ' changes in the working tree, --no-strict disables the check.'),
5255
4909
        'revision',
5256
4910
        RegistryOption('format',
5257
4911
                       help='Use the specified output format.',
5265
4919
 
5266
4920
    def run(self, submit_branch=None, public_branch=None, no_bundle=False,
5267
4921
            no_patch=False, revision=None, remember=False, output=None,
5268
 
            format=None, strict=None, **kwargs):
 
4922
            format=None, **kwargs):
5269
4923
        if output is None:
5270
4924
            output = '-'
5271
4925
        from bzrlib.send import send
5272
4926
        return send(submit_branch, revision, public_branch, remember,
5273
4927
                         format, no_bundle, no_patch, output,
5274
4928
                         kwargs.get('from', '.'), None, None, None,
5275
 
                         self.outf, strict=strict)
 
4929
                         self.outf)
5276
4930
 
5277
4931
 
5278
4932
class cmd_tag(Command):
5279
 
    __doc__ = """Create, remove or modify a tag naming a revision.
 
4933
    """Create, remove or modify a tag naming a revision.
5280
4934
 
5281
4935
    Tags give human-meaningful names to revisions.  Commands that take a -r
5282
4936
    (--revision) option can be given -rtag:X, where X is any previously
5290
4944
 
5291
4945
    To rename a tag (change the name but keep it on the same revsion), run ``bzr
5292
4946
    tag new-name -r tag:old-name`` and then ``bzr tag --delete oldname``.
5293
 
 
5294
 
    If no tag name is specified it will be determined through the 
5295
 
    'automatic_tag_name' hook. This can e.g. be used to automatically tag
5296
 
    upstream releases by reading configure.ac. See ``bzr help hooks`` for
5297
 
    details.
5298
4947
    """
5299
4948
 
5300
4949
    _see_also = ['commit', 'tags']
5301
 
    takes_args = ['tag_name?']
 
4950
    takes_args = ['tag_name']
5302
4951
    takes_options = [
5303
4952
        Option('delete',
5304
4953
            help='Delete this tag rather than placing it.',
5305
4954
            ),
5306
 
        custom_help('directory',
5307
 
            help='Branch in which to place the tag.'),
 
4955
        Option('directory',
 
4956
            help='Branch in which to place the tag.',
 
4957
            short_name='d',
 
4958
            type=unicode,
 
4959
            ),
5308
4960
        Option('force',
5309
4961
            help='Replace existing tags.',
5310
4962
            ),
5311
4963
        'revision',
5312
4964
        ]
5313
4965
 
5314
 
    def run(self, tag_name=None,
 
4966
    def run(self, tag_name,
5315
4967
            delete=None,
5316
4968
            directory='.',
5317
4969
            force=None,
5318
4970
            revision=None,
5319
4971
            ):
5320
4972
        branch, relpath = Branch.open_containing(directory)
5321
 
        self.add_cleanup(branch.lock_write().unlock)
5322
 
        if delete:
5323
 
            if tag_name is None:
5324
 
                raise errors.BzrCommandError("No tag specified to delete.")
5325
 
            branch.tags.delete_tag(tag_name)
5326
 
            self.outf.write('Deleted tag %s.\n' % tag_name)
5327
 
        else:
5328
 
            if revision:
5329
 
                if len(revision) != 1:
5330
 
                    raise errors.BzrCommandError(
5331
 
                        "Tags can only be placed on a single revision, "
5332
 
                        "not on a range")
5333
 
                revision_id = revision[0].as_revision_id(branch)
 
4973
        branch.lock_write()
 
4974
        try:
 
4975
            if delete:
 
4976
                branch.tags.delete_tag(tag_name)
 
4977
                self.outf.write('Deleted tag %s.\n' % tag_name)
5334
4978
            else:
5335
 
                revision_id = branch.last_revision()
5336
 
            if tag_name is None:
5337
 
                tag_name = branch.automatic_tag_name(revision_id)
5338
 
                if tag_name is None:
5339
 
                    raise errors.BzrCommandError(
5340
 
                        "Please specify a tag name.")
5341
 
            if (not force) and branch.tags.has_tag(tag_name):
5342
 
                raise errors.TagAlreadyExists(tag_name)
5343
 
            branch.tags.set_tag(tag_name, revision_id)
5344
 
            self.outf.write('Created tag %s.\n' % tag_name)
 
4979
                if revision:
 
4980
                    if len(revision) != 1:
 
4981
                        raise errors.BzrCommandError(
 
4982
                            "Tags can only be placed on a single revision, "
 
4983
                            "not on a range")
 
4984
                    revision_id = revision[0].as_revision_id(branch)
 
4985
                else:
 
4986
                    revision_id = branch.last_revision()
 
4987
                if (not force) and branch.tags.has_tag(tag_name):
 
4988
                    raise errors.TagAlreadyExists(tag_name)
 
4989
                branch.tags.set_tag(tag_name, revision_id)
 
4990
                self.outf.write('Created tag %s.\n' % tag_name)
 
4991
        finally:
 
4992
            branch.unlock()
5345
4993
 
5346
4994
 
5347
4995
class cmd_tags(Command):
5348
 
    __doc__ = """List tags.
 
4996
    """List tags.
5349
4997
 
5350
4998
    This command shows a table of tag names and the revisions they reference.
5351
4999
    """
5352
5000
 
5353
5001
    _see_also = ['tag']
5354
5002
    takes_options = [
5355
 
        custom_help('directory',
5356
 
            help='Branch whose tags should be displayed.'),
 
5003
        Option('directory',
 
5004
            help='Branch whose tags should be displayed.',
 
5005
            short_name='d',
 
5006
            type=unicode,
 
5007
            ),
5357
5008
        RegistryOption.from_kwargs('sort',
5358
5009
            'Sort tags by different criteria.', title='Sorting',
5359
5010
            alpha='Sort tags lexicographically (default).',
5376
5027
        if not tags:
5377
5028
            return
5378
5029
 
5379
 
        self.add_cleanup(branch.lock_read().unlock)
5380
5030
        if revision:
5381
 
            graph = branch.repository.get_graph()
5382
 
            rev1, rev2 = _get_revision_range(revision, branch, self.name())
5383
 
            revid1, revid2 = rev1.rev_id, rev2.rev_id
5384
 
            # only show revisions between revid1 and revid2 (inclusive)
5385
 
            tags = [(tag, revid) for tag, revid in tags if
5386
 
                graph.is_between(revid, revid1, revid2)]
 
5031
            branch.lock_read()
 
5032
            try:
 
5033
                graph = branch.repository.get_graph()
 
5034
                rev1, rev2 = _get_revision_range(revision, branch, self.name())
 
5035
                revid1, revid2 = rev1.rev_id, rev2.rev_id
 
5036
                # only show revisions between revid1 and revid2 (inclusive)
 
5037
                tags = [(tag, revid) for tag, revid in tags if
 
5038
                    graph.is_between(revid, revid1, revid2)]
 
5039
            finally:
 
5040
                branch.unlock()
5387
5041
        if sort == 'alpha':
5388
5042
            tags.sort()
5389
5043
        elif sort == 'time':
5409
5063
                    # which are not in this branch. Fail gracefully ...
5410
5064
                    revno = '?'
5411
5065
                tags[index] = (tag, revno)
5412
 
        self.cleanup_now()
5413
5066
        for tag, revspec in tags:
5414
5067
            self.outf.write('%-20s %s\n' % (tag, revspec))
5415
5068
 
5416
5069
 
5417
5070
class cmd_reconfigure(Command):
5418
 
    __doc__ = """Reconfigure the type of a bzr directory.
 
5071
    """Reconfigure the type of a bzr directory.
5419
5072
 
5420
5073
    A target configuration must be specified.
5421
5074
 
5451
5104
            ),
5452
5105
        Option('bind-to', help='Branch to bind checkout to.', type=str),
5453
5106
        Option('force',
5454
 
            help='Perform reconfiguration even if local changes'
5455
 
            ' will be lost.'),
5456
 
        Option('stacked-on',
5457
 
            help='Reconfigure a branch to be stacked on another branch.',
5458
 
            type=unicode,
5459
 
            ),
5460
 
        Option('unstacked',
5461
 
            help='Reconfigure a branch to be unstacked.  This '
5462
 
                'may require copying substantial data into it.',
5463
 
            ),
 
5107
               help='Perform reconfiguration even if local changes'
 
5108
               ' will be lost.')
5464
5109
        ]
5465
5110
 
5466
 
    def run(self, location=None, target_type=None, bind_to=None, force=False,
5467
 
            stacked_on=None,
5468
 
            unstacked=None):
 
5111
    def run(self, location=None, target_type=None, bind_to=None, force=False):
5469
5112
        directory = bzrdir.BzrDir.open(location)
5470
 
        if stacked_on and unstacked:
5471
 
            raise BzrCommandError("Can't use both --stacked-on and --unstacked")
5472
 
        elif stacked_on is not None:
5473
 
            reconfigure.ReconfigureStackedOn().apply(directory, stacked_on)
5474
 
        elif unstacked:
5475
 
            reconfigure.ReconfigureUnstacked().apply(directory)
5476
 
        # At the moment you can use --stacked-on and a different
5477
 
        # reconfiguration shape at the same time; there seems no good reason
5478
 
        # to ban it.
5479
5113
        if target_type is None:
5480
 
            if stacked_on or unstacked:
5481
 
                return
5482
 
            else:
5483
 
                raise errors.BzrCommandError('No target configuration '
5484
 
                    'specified')
 
5114
            raise errors.BzrCommandError('No target configuration specified')
5485
5115
        elif target_type == 'branch':
5486
5116
            reconfiguration = reconfigure.Reconfigure.to_branch(directory)
5487
5117
        elif target_type == 'tree':
5506
5136
 
5507
5137
 
5508
5138
class cmd_switch(Command):
5509
 
    __doc__ = """Set the branch of a checkout and update.
 
5139
    """Set the branch of a checkout and update.
5510
5140
 
5511
5141
    For lightweight checkouts, this changes the branch being referenced.
5512
5142
    For heavyweight checkouts, this checks that there are no local commits
5524
5154
    /path/to/newbranch.
5525
5155
 
5526
5156
    Bound branches use the nickname of its master branch unless it is set
5527
 
    locally, in which case switching will update the local nickname to be
 
5157
    locally, in which case switching will update the the local nickname to be
5528
5158
    that of the master.
5529
5159
    """
5530
5160
 
5531
 
    takes_args = ['to_location?']
 
5161
    takes_args = ['to_location']
5532
5162
    takes_options = [Option('force',
5533
 
                        help='Switch even if local commits will be lost.'),
5534
 
                     'revision',
5535
 
                     Option('create-branch', short_name='b',
5536
 
                        help='Create the target branch from this one before'
5537
 
                             ' switching to it.'),
5538
 
                    ]
 
5163
                        help='Switch even if local commits will be lost.')
 
5164
                     ]
5539
5165
 
5540
 
    def run(self, to_location=None, force=False, create_branch=False,
5541
 
            revision=None):
 
5166
    def run(self, to_location, force=False):
5542
5167
        from bzrlib import switch
5543
5168
        tree_location = '.'
5544
 
        revision = _get_one_revision('switch', revision)
5545
5169
        control_dir = bzrdir.BzrDir.open_containing(tree_location)[0]
5546
 
        if to_location is None:
5547
 
            if revision is None:
5548
 
                raise errors.BzrCommandError('You must supply either a'
5549
 
                                             ' revision or a location')
5550
 
            to_location = '.'
5551
5170
        try:
5552
5171
            branch = control_dir.open_branch()
5553
5172
            had_explicit_nick = branch.get_config().has_explicit_nickname()
5554
5173
        except errors.NotBranchError:
5555
 
            branch = None
5556
5174
            had_explicit_nick = False
5557
 
        if create_branch:
5558
 
            if branch is None:
5559
 
                raise errors.BzrCommandError('cannot create branch without'
5560
 
                                             ' source branch')
5561
 
            to_location = directory_service.directories.dereference(
5562
 
                              to_location)
5563
 
            if '/' not in to_location and '\\' not in to_location:
5564
 
                # This path is meant to be relative to the existing branch
5565
 
                this_url = self._get_branch_location(control_dir)
5566
 
                to_location = urlutils.join(this_url, '..', to_location)
5567
 
            to_branch = branch.bzrdir.sprout(to_location,
5568
 
                                 possible_transports=[branch.bzrdir.root_transport],
5569
 
                                 source_branch=branch).open_branch()
5570
 
        else:
5571
 
            try:
5572
 
                to_branch = Branch.open(to_location)
5573
 
            except errors.NotBranchError:
5574
 
                this_url = self._get_branch_location(control_dir)
5575
 
                to_branch = Branch.open(
5576
 
                    urlutils.join(this_url, '..', to_location))
5577
 
        if revision is not None:
5578
 
            revision = revision.as_revision_id(to_branch)
5579
 
        switch.switch(control_dir, to_branch, force, revision_id=revision)
 
5175
        try:
 
5176
            to_branch = Branch.open(to_location)
 
5177
        except errors.NotBranchError:
 
5178
            this_url = self._get_branch_location(control_dir)
 
5179
            to_branch = Branch.open(
 
5180
                urlutils.join(this_url, '..', to_location))
 
5181
        switch.switch(control_dir, to_branch, force)
5580
5182
        if had_explicit_nick:
5581
5183
            branch = control_dir.open_branch() #get the new branch!
5582
5184
            branch.nick = to_branch.nick
5602
5204
 
5603
5205
 
5604
5206
class cmd_view(Command):
5605
 
    __doc__ = """Manage filtered views.
 
5207
    """Manage filtered views.
5606
5208
 
5607
5209
    Views provide a mask over the tree so that users can focus on
5608
5210
    a subset of a tree when doing their work. After creating a view,
5756
5358
 
5757
5359
 
5758
5360
class cmd_hooks(Command):
5759
 
    __doc__ = """Show hooks."""
 
5361
    """Show hooks."""
5760
5362
 
5761
5363
    hidden = True
5762
5364
 
5775
5377
                    self.outf.write("    <no hooks installed>\n")
5776
5378
 
5777
5379
 
5778
 
class cmd_remove_branch(Command):
5779
 
    __doc__ = """Remove a branch.
5780
 
 
5781
 
    This will remove the branch from the specified location but 
5782
 
    will keep any working tree or repository in place.
5783
 
 
5784
 
    :Examples:
5785
 
 
5786
 
      Remove the branch at repo/trunk::
5787
 
 
5788
 
        bzr remove-branch repo/trunk
5789
 
 
5790
 
    """
5791
 
 
5792
 
    takes_args = ["location?"]
5793
 
 
5794
 
    aliases = ["rmbranch"]
5795
 
 
5796
 
    def run(self, location=None):
5797
 
        if location is None:
5798
 
            location = "."
5799
 
        branch = Branch.open_containing(location)[0]
5800
 
        branch.bzrdir.destroy_branch()
5801
 
        
5802
 
 
5803
5380
class cmd_shelve(Command):
5804
 
    __doc__ = """Temporarily set aside some changes from the current tree.
 
5381
    """Temporarily set aside some changes from the current tree.
5805
5382
 
5806
5383
    Shelve allows you to temporarily put changes you've made "on the shelf",
5807
5384
    ie. out of the way, until a later time when you can bring them back from
5849
5426
        if writer is None:
5850
5427
            writer = bzrlib.option.diff_writer_registry.get()
5851
5428
        try:
5852
 
            shelver = Shelver.from_args(writer(sys.stdout), revision, all,
5853
 
                file_list, message, destroy=destroy)
5854
 
            try:
5855
 
                shelver.run()
5856
 
            finally:
5857
 
                shelver.finalize()
 
5429
            Shelver.from_args(writer(sys.stdout), revision, all, file_list,
 
5430
                              message, destroy=destroy).run()
5858
5431
        except errors.UserAbort:
5859
5432
            return 0
5860
5433
 
5861
5434
    def run_for_list(self):
5862
5435
        tree = WorkingTree.open_containing('.')[0]
5863
 
        self.add_cleanup(tree.lock_read().unlock)
5864
 
        manager = tree.get_shelf_manager()
5865
 
        shelves = manager.active_shelves()
5866
 
        if len(shelves) == 0:
5867
 
            note('No shelved changes.')
5868
 
            return 0
5869
 
        for shelf_id in reversed(shelves):
5870
 
            message = manager.get_metadata(shelf_id).get('message')
5871
 
            if message is None:
5872
 
                message = '<no message>'
5873
 
            self.outf.write('%3d: %s\n' % (shelf_id, message))
5874
 
        return 1
 
5436
        tree.lock_read()
 
5437
        try:
 
5438
            manager = tree.get_shelf_manager()
 
5439
            shelves = manager.active_shelves()
 
5440
            if len(shelves) == 0:
 
5441
                note('No shelved changes.')
 
5442
                return 0
 
5443
            for shelf_id in reversed(shelves):
 
5444
                message = manager.get_metadata(shelf_id).get('message')
 
5445
                if message is None:
 
5446
                    message = '<no message>'
 
5447
                self.outf.write('%3d: %s\n' % (shelf_id, message))
 
5448
            return 1
 
5449
        finally:
 
5450
            tree.unlock()
5875
5451
 
5876
5452
 
5877
5453
class cmd_unshelve(Command):
5878
 
    __doc__ = """Restore shelved changes.
 
5454
    """Restore shelved changes.
5879
5455
 
5880
5456
    By default, the most recently shelved changes are restored. However if you
5881
5457
    specify a shelf by id those changes will be restored instead.  This works
5889
5465
            enum_switch=False, value_switches=True,
5890
5466
            apply="Apply changes and remove from the shelf.",
5891
5467
            dry_run="Show changes, but do not apply or remove them.",
5892
 
            preview="Instead of unshelving the changes, show the diff that "
5893
 
                    "would result from unshelving.",
5894
 
            delete_only="Delete changes without applying them.",
5895
 
            keep="Apply changes but don't delete them.",
 
5468
            delete_only="Delete changes without applying them."
5896
5469
        )
5897
5470
    ]
5898
5471
    _see_also = ['shelve']
5899
5472
 
5900
5473
    def run(self, shelf_id=None, action='apply'):
5901
5474
        from bzrlib.shelf_ui import Unshelver
5902
 
        unshelver = Unshelver.from_args(shelf_id, action)
5903
 
        try:
5904
 
            unshelver.run()
5905
 
        finally:
5906
 
            unshelver.tree.unlock()
 
5475
        Unshelver.from_args(shelf_id, action).run()
5907
5476
 
5908
5477
 
5909
5478
class cmd_clean_tree(Command):
5910
 
    __doc__ = """Remove unwanted files from working tree.
 
5479
    """Remove unwanted files from working tree.
5911
5480
 
5912
5481
    By default, only unknown files, not ignored files, are deleted.  Versioned
5913
5482
    files are never deleted.
5921
5490
 
5922
5491
    To check what clean-tree will do, use --dry-run.
5923
5492
    """
5924
 
    takes_options = ['directory',
5925
 
                     Option('ignored', help='Delete all ignored files.'),
 
5493
    takes_options = [Option('ignored', help='Delete all ignored files.'),
5926
5494
                     Option('detritus', help='Delete conflict files, merge'
5927
5495
                            ' backups, and failed selftest dirs.'),
5928
5496
                     Option('unknown',
5931
5499
                            ' deleting them.'),
5932
5500
                     Option('force', help='Do not prompt before deleting.')]
5933
5501
    def run(self, unknown=False, ignored=False, detritus=False, dry_run=False,
5934
 
            force=False, directory=u'.'):
 
5502
            force=False):
5935
5503
        from bzrlib.clean_tree import clean_tree
5936
5504
        if not (unknown or ignored or detritus):
5937
5505
            unknown = True
5938
5506
        if dry_run:
5939
5507
            force = True
5940
 
        clean_tree(directory, unknown=unknown, ignored=ignored,
5941
 
                   detritus=detritus, dry_run=dry_run, no_prompt=force)
 
5508
        clean_tree('.', unknown=unknown, ignored=ignored, detritus=detritus,
 
5509
                   dry_run=dry_run, no_prompt=force)
5942
5510
 
5943
5511
 
5944
5512
class cmd_reference(Command):
5945
 
    __doc__ = """list, view and set branch locations for nested trees.
 
5513
    """list, view and set branch locations for nested trees.
5946
5514
 
5947
5515
    If no arguments are provided, lists the branch locations for nested trees.
5948
5516
    If one argument is provided, display the branch location for that tree.
5988
5556
            self.outf.write('%s %s\n' % (path, location))
5989
5557
 
5990
5558
 
5991
 
def _register_lazy_builtins():
5992
 
    # register lazy builtins from other modules; called at startup and should
5993
 
    # be only called once.
5994
 
    for (name, aliases, module_name) in [
5995
 
        ('cmd_bundle_info', [], 'bzrlib.bundle.commands'),
5996
 
        ('cmd_dpush', [], 'bzrlib.foreign'),
5997
 
        ('cmd_version_info', [], 'bzrlib.cmd_version_info'),
5998
 
        ('cmd_resolve', ['resolved'], 'bzrlib.conflicts'),
5999
 
        ('cmd_conflicts', [], 'bzrlib.conflicts'),
6000
 
        ('cmd_sign_my_commits', [], 'bzrlib.sign_my_commits'),
6001
 
        ]:
6002
 
        builtin_command_registry.register_lazy(name, aliases, module_name)
 
5559
# these get imported and then picked up by the scan for cmd_*
 
5560
# TODO: Some more consistent way to split command definitions across files;
 
5561
# we do need to load at least some information about them to know of
 
5562
# aliases.  ideally we would avoid loading the implementation until the
 
5563
# details were needed.
 
5564
from bzrlib.cmd_version_info import cmd_version_info
 
5565
from bzrlib.conflicts import cmd_resolve, cmd_conflicts, restore
 
5566
from bzrlib.bundle.commands import (
 
5567
    cmd_bundle_info,
 
5568
    )
 
5569
from bzrlib.foreign import cmd_dpush
 
5570
from bzrlib.sign_my_commits import cmd_sign_my_commits
 
5571
from bzrlib.weave_commands import cmd_versionedfile_list, \
 
5572
        cmd_weave_plan_merge, cmd_weave_merge_text