/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: Johan Walles
  • Date: 2009-05-07 05:08:46 UTC
  • mfrom: (4342 +trunk)
  • mto: This revision was merged to the branch mainline in revision 4343.
  • Revision ID: johan.walles@gmail.com-20090507050846-nkwvcyauf1eh653q
MergeĀ fromĀ upstream.

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 some of these files,"
 
614
                            " please add them by name.\n")
696
615
 
697
616
 
698
617
class cmd_mkdir(Command):
699
 
    __doc__ = """Create a new versioned directory.
 
618
    """Create a new versioned directory.
700
619
 
701
620
    This is equivalent to creating the directory and then adding it.
702
621
    """
706
625
 
707
626
    def run(self, dir_list):
708
627
        for d in dir_list:
 
628
            os.mkdir(d)
709
629
            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)
 
630
            wt.add([dd])
 
631
            self.outf.write('added %s\n' % d)
718
632
 
719
633
 
720
634
class cmd_relpath(Command):
721
 
    __doc__ = """Show path of a file relative to root"""
 
635
    """Show path of a file relative to root"""
722
636
 
723
637
    takes_args = ['filename']
724
638
    hidden = True
733
647
 
734
648
 
735
649
class cmd_inventory(Command):
736
 
    __doc__ = """Show inventory of the current working copy or a revision.
 
650
    """Show inventory of the current working copy or a revision.
737
651
 
738
652
    It is possible to limit the output to a particular entry
739
653
    type using the --kind option.  For example: --kind file.
760
674
 
761
675
        revision = _get_one_revision('inventory', revision)
762
676
        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()
 
677
        work_tree.lock_read()
 
678
        try:
 
679
            if revision is not None:
 
680
                tree = revision.as_tree(work_tree.branch)
 
681
 
 
682
                extra_trees = [work_tree]
 
683
                tree.lock_read()
 
684
            else:
 
685
                tree = work_tree
 
686
                extra_trees = []
 
687
 
 
688
            if file_list is not None:
 
689
                file_ids = tree.paths2ids(file_list, trees=extra_trees,
 
690
                                          require_versioned=True)
 
691
                # find_ids_across_trees may include some paths that don't
 
692
                # exist in 'tree'.
 
693
                entries = sorted((tree.id2path(file_id), tree.inventory[file_id])
 
694
                                 for file_id in file_ids if file_id in tree)
 
695
            else:
 
696
                entries = tree.inventory.entries()
 
697
        finally:
 
698
            tree.unlock()
 
699
            if tree is not work_tree:
 
700
                work_tree.unlock()
 
701
 
784
702
        for path, entry in entries:
785
703
            if kind and kind != entry.kind:
786
704
                continue
792
710
 
793
711
 
794
712
class cmd_mv(Command):
795
 
    __doc__ = """Move or rename a file.
 
713
    """Move or rename a file.
796
714
 
797
715
    :Usage:
798
716
        bzr mv OLDNAME NEWNAME
831
749
        if len(names_list) < 2:
832
750
            raise errors.BzrCommandError("missing file argument")
833
751
        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)
 
752
        tree.lock_write()
 
753
        try:
 
754
            self._run(tree, names_list, rel_names, after)
 
755
        finally:
 
756
            tree.unlock()
836
757
 
837
758
    def run_auto(self, names_list, after, dry_run):
838
759
        if names_list is not None and len(names_list) > 1:
842
763
            raise errors.BzrCommandError('--after cannot be specified with'
843
764
                                         ' --auto.')
844
765
        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)
 
766
        work_tree.lock_write()
 
767
        try:
 
768
            rename_map.RenameMap.guess_renames(work_tree, dry_run)
 
769
        finally:
 
770
            work_tree.unlock()
847
771
 
848
772
    def _run(self, tree, names_list, rel_names, after):
849
773
        into_existing = osutils.isdir(names_list[-1])
870
794
            # All entries reference existing inventory items, so fix them up
871
795
            # for cicp file-systems.
872
796
            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))
 
797
            for pair in tree.move(rel_names[:-1], rel_names[-1], after=after):
 
798
                self.outf.write("%s => %s\n" % pair)
876
799
        else:
877
800
            if len(names_list) != 2:
878
801
                raise errors.BzrCommandError('to mv multiple files the'
922
845
            dest = osutils.pathjoin(dest_parent, dest_tail)
923
846
            mutter("attempting to move %s => %s", src, dest)
924
847
            tree.rename_one(src, dest, after=after)
925
 
            if not is_quiet():
926
 
                self.outf.write("%s => %s\n" % (src, dest))
 
848
            self.outf.write("%s => %s\n" % (src, dest))
927
849
 
928
850
 
929
851
class cmd_pull(Command):
930
 
    __doc__ = """Turn this branch into a mirror of another branch.
 
852
    """Turn this branch into a mirror of another branch.
931
853
 
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.
 
854
    This command only works on branches that have not diverged.  Branches are
 
855
    considered diverged if the destination branch's most recent commit is one
 
856
    that has not been merged (directly or indirectly) into the parent.
936
857
 
937
858
    If branches have diverged, you can use 'bzr merge' to integrate the changes
938
859
    from one into the other.  Once one branch has merged, the other should
939
860
    be able to pull it again.
940
861
 
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.
 
862
    If you want to forget your local changes and just update your branch to
 
863
    match the remote one, use pull --overwrite.
944
864
 
945
865
    If there is no default location set, the first pull will set it.  After
946
866
    that, you can omit the location to use the default.  To change the
956
876
    takes_options = ['remember', 'overwrite', 'revision',
957
877
        custom_help('verbose',
958
878
            help='Show logs of pulled revisions.'),
959
 
        custom_help('directory',
 
879
        Option('directory',
960
880
            help='Branch to pull into, '
961
 
                 'rather than the one containing the working directory.'),
 
881
                 'rather than the one containing the working directory.',
 
882
            short_name='d',
 
883
            type=unicode,
 
884
            ),
962
885
        Option('local',
963
886
            help="Perform a local pull in a bound "
964
887
                 "branch.  Local pulls are not applied to "
979
902
        try:
980
903
            tree_to = WorkingTree.open_containing(directory)[0]
981
904
            branch_to = tree_to.branch
982
 
            self.add_cleanup(tree_to.lock_write().unlock)
983
905
        except errors.NoWorkingTree:
984
906
            tree_to = None
985
907
            branch_to = Branch.open_containing(directory)[0]
986
 
            self.add_cleanup(branch_to.lock_write().unlock)
987
 
 
 
908
        
988
909
        if local and not branch_to.get_bound_location():
989
910
            raise errors.LocalRequiresBoundBranch()
990
911
 
1020
941
        else:
1021
942
            branch_from = Branch.open(location,
1022
943
                possible_transports=possible_transports)
1023
 
            self.add_cleanup(branch_from.lock_read().unlock)
1024
944
 
1025
945
            if branch_to.get_parent() is None or remember:
1026
946
                branch_to.set_parent(branch_from.base)
1028
948
        if revision is not None:
1029
949
            revision_id = revision.as_revision_id(branch_from)
1030
950
 
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)
 
951
        branch_to.lock_write()
 
952
        try:
 
953
            if tree_to is not None:
 
954
                view_info = _get_view_info_for_change_reporter(tree_to)
 
955
                change_reporter = delta._ChangeReporter(
 
956
                    unversioned_filter=tree_to.is_ignored, view_info=view_info)
 
957
                result = tree_to.pull(branch_from, overwrite, revision_id,
 
958
                                      change_reporter,
 
959
                                      possible_transports=possible_transports,
 
960
                                      local=local)
 
961
            else:
 
962
                result = branch_to.pull(branch_from, overwrite, revision_id,
 
963
                                      local=local)
1042
964
 
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)
 
965
            result.report(self.outf)
 
966
            if verbose and result.old_revid != result.new_revid:
 
967
                log.show_branch_change(branch_to, self.outf, result.old_revno,
 
968
                                       result.old_revid)
 
969
        finally:
 
970
            branch_to.unlock()
1048
971
 
1049
972
 
1050
973
class cmd_push(Command):
1051
 
    __doc__ = """Update a mirror of this branch.
 
974
    """Update a mirror of this branch.
1052
975
 
1053
976
    The target branch will not have its working tree populated because this
1054
977
    is both expensive, and is not supported on remote file systems.
1078
1001
        Option('create-prefix',
1079
1002
               help='Create the path leading up to the branch '
1080
1003
                    'if it does not already exist.'),
1081
 
        custom_help('directory',
 
1004
        Option('directory',
1082
1005
            help='Branch to push from, '
1083
 
                 'rather than the one containing the working directory.'),
 
1006
                 'rather than the one containing the working directory.',
 
1007
            short_name='d',
 
1008
            type=unicode,
 
1009
            ),
1084
1010
        Option('use-existing-dir',
1085
1011
               help='By default push will fail if the target'
1086
1012
                    ' directory exists, but does not already'
1094
1020
                'for the commit history. Only the work not present in the '
1095
1021
                'referenced branch is included in the branch created.',
1096
1022
            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
1023
        ]
1101
1024
    takes_args = ['location?']
1102
1025
    encoding_type = 'replace'
1104
1027
    def run(self, location=None, remember=False, overwrite=False,
1105
1028
        create_prefix=False, verbose=False, revision=None,
1106
1029
        use_existing_dir=False, directory=None, stacked_on=None,
1107
 
        stacked=False, strict=None):
 
1030
        stacked=False):
1108
1031
        from bzrlib.push import _show_push_branch
1109
1032
 
 
1033
        # Get the source branch and revision_id
1110
1034
        if directory is None:
1111
1035
            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
 
1036
        br_from = Branch.open_containing(directory)[0]
1116
1037
        revision = _get_one_revision('push', revision)
1117
1038
        if revision is not None:
1118
1039
            revision_id = revision.in_history(br_from).rev_id
1119
1040
        else:
1120
1041
            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.')
 
1042
 
1126
1043
        # Get the stacked_on branch, if any
1127
1044
        if stacked_on is not None:
1128
1045
            stacked_on = urlutils.normalize_url(stacked_on)
1160
1077
 
1161
1078
 
1162
1079
class cmd_branch(Command):
1163
 
    __doc__ = """Create a new branch that is a copy of an existing branch.
 
1080
    """Create a new copy of a branch.
1164
1081
 
1165
1082
    If the TO_LOCATION is omitted, the last component of the FROM_LOCATION will
1166
1083
    be used.  In other words, "branch ../foo/bar" will attempt to create ./bar.
1179
1096
        help='Hard-link working tree files where possible.'),
1180
1097
        Option('no-tree',
1181
1098
            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
1099
        Option('stacked',
1186
1100
            help='Create a stacked branch referring to the source branch. '
1187
1101
                'The new branch will depend on the availability of the source '
1188
1102
                'branch for all operations.'),
1189
1103
        Option('standalone',
1190
1104
               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
1105
        ]
1199
1106
    aliases = ['get', 'clone']
1200
1107
 
1201
1108
    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
 
1109
            hardlink=False, stacked=False, standalone=False, no_tree=False):
1205
1110
        from bzrlib.tag import _merge_tags_if_possible
 
1111
 
1206
1112
        accelerator_tree, br_from = bzrdir.BzrDir.open_tree_or_branch(
1207
1113
            from_location)
1208
1114
        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)
 
1115
        br_from.lock_read()
1220
1116
        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)
 
1117
            if revision is not None:
 
1118
                revision_id = revision.as_revision_id(br_from)
1226
1119
            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'))
 
1120
                # FIXME - wt.last_revision, fallback to branch, fall back to
 
1121
                # None or perhaps NULL_REVISION to mean copy nothing
 
1122
                # RBC 20060209
 
1123
                revision_id = br_from.last_revision()
 
1124
            if to_location is None:
 
1125
                to_location = urlutils.derive_to_location(from_location)
 
1126
            to_transport = transport.get_transport(to_location)
 
1127
            try:
 
1128
                to_transport.mkdir('.')
 
1129
            except errors.FileExists:
 
1130
                raise errors.BzrCommandError('Target directory "%s" already'
 
1131
                                             ' exists.' % to_location)
 
1132
            except errors.NoSuchFile:
 
1133
                raise errors.BzrCommandError('Parent of "%s" does not exist.'
 
1134
                                             % to_location)
 
1135
            try:
 
1136
                # preserve whatever source format we have.
 
1137
                dir = br_from.bzrdir.sprout(to_transport.base, revision_id,
 
1138
                                            possible_transports=[to_transport],
 
1139
                                            accelerator_tree=accelerator_tree,
 
1140
                                            hardlink=hardlink, stacked=stacked,
 
1141
                                            force_new_repo=standalone,
 
1142
                                            create_tree_if_local=not no_tree,
 
1143
                                            source_branch=br_from)
 
1144
                branch = dir.open_branch()
 
1145
            except errors.NoSuchRevision:
 
1146
                to_transport.delete_tree('.')
 
1147
                msg = "The branch %s has no revision %s." % (from_location,
 
1148
                    revision)
 
1149
                raise errors.BzrCommandError(msg)
 
1150
            _merge_tags_if_possible(br_from, branch)
 
1151
            # If the source branch is stacked, the new branch may
 
1152
            # be stacked whether we asked for that explicitly or not.
 
1153
            # We therefore need a try/except here and not just 'if stacked:'
 
1154
            try:
 
1155
                note('Created new stacked branch referring to %s.' %
 
1156
                    branch.get_stacked_on_url())
 
1157
            except (errors.NotStacked, errors.UnstackableBranchFormat,
 
1158
                errors.UnstackableRepositoryFormat), e:
 
1159
                note('Branched %d revision(s).' % branch.revno())
 
1160
        finally:
 
1161
            br_from.unlock()
1272
1162
 
1273
1163
 
1274
1164
class cmd_checkout(Command):
1275
 
    __doc__ = """Create a new checkout of an existing branch.
 
1165
    """Create a new checkout of an existing branch.
1276
1166
 
1277
1167
    If BRANCH_LOCATION is omitted, checkout will reconstitute a working tree for
1278
1168
    the branch found in '.'. This is useful if you have removed the working tree
1341
1231
 
1342
1232
 
1343
1233
class cmd_renames(Command):
1344
 
    __doc__ = """Show list of renamed files.
 
1234
    """Show list of renamed files.
1345
1235
    """
1346
1236
    # TODO: Option to show renames between two historical versions.
1347
1237
 
1352
1242
    @display_command
1353
1243
    def run(self, dir=u'.'):
1354
1244
        tree = WorkingTree.open_containing(dir)[0]
1355
 
        self.add_cleanup(tree.lock_read().unlock)
1356
 
        new_inv = tree.inventory
1357
 
        old_tree = tree.basis_tree()
1358
 
        self.add_cleanup(old_tree.lock_read().unlock)
1359
 
        old_inv = old_tree.inventory
1360
 
        renames = []
1361
 
        iterator = tree.iter_changes(old_tree, include_unchanged=True)
1362
 
        for f, paths, c, v, p, n, k, e in iterator:
1363
 
            if paths[0] == paths[1]:
1364
 
                continue
1365
 
            if None in (paths):
1366
 
                continue
1367
 
            renames.append(paths)
1368
 
        renames.sort()
1369
 
        for old_name, new_name in renames:
1370
 
            self.outf.write("%s => %s\n" % (old_name, new_name))
 
1245
        tree.lock_read()
 
1246
        try:
 
1247
            new_inv = tree.inventory
 
1248
            old_tree = tree.basis_tree()
 
1249
            old_tree.lock_read()
 
1250
            try:
 
1251
                old_inv = old_tree.inventory
 
1252
                renames = []
 
1253
                iterator = tree.iter_changes(old_tree, include_unchanged=True)
 
1254
                for f, paths, c, v, p, n, k, e in iterator:
 
1255
                    if paths[0] == paths[1]:
 
1256
                        continue
 
1257
                    if None in (paths):
 
1258
                        continue
 
1259
                    renames.append(paths)
 
1260
                renames.sort()
 
1261
                for old_name, new_name in renames:
 
1262
                    self.outf.write("%s => %s\n" % (old_name, new_name))
 
1263
            finally:
 
1264
                old_tree.unlock()
 
1265
        finally:
 
1266
            tree.unlock()
1371
1267
 
1372
1268
 
1373
1269
class cmd_update(Command):
1374
 
    __doc__ = """Update a tree to have the latest code committed to its branch.
 
1270
    """Update a tree to have the latest code committed to its branch.
1375
1271
 
1376
1272
    This will perform a merge into the working tree, and may generate
1377
1273
    conflicts. If you have any local changes, you will still
1379
1275
 
1380
1276
    If you want to discard your local changes, you can just do a
1381
1277
    'bzr revert' instead of 'bzr commit' after the update.
1382
 
 
1383
 
    If the tree's branch is bound to a master branch, it will also update
1384
 
    the branch from the master.
1385
1278
    """
1386
1279
 
1387
1280
    _see_also = ['pull', 'working-trees', 'status-flags']
1388
1281
    takes_args = ['dir?']
1389
 
    takes_options = ['revision']
1390
1282
    aliases = ['up']
1391
1283
 
1392
 
    def run(self, dir='.', revision=None):
1393
 
        if revision is not None and len(revision) != 1:
1394
 
            raise errors.BzrCommandError(
1395
 
                        "bzr update --revision takes exactly one revision")
 
1284
    def run(self, dir='.'):
1396
1285
        tree = WorkingTree.open_containing(dir)[0]
1397
 
        branch = tree.branch
1398
1286
        possible_transports = []
1399
 
        master = branch.get_master_branch(
 
1287
        master = tree.branch.get_master_branch(
1400
1288
            possible_transports=possible_transports)
1401
1289
        if master is not None:
1402
 
            branch_location = master.base
1403
1290
            tree.lock_write()
1404
1291
        else:
1405
 
            branch_location = tree.branch.base
1406
1292
            tree.lock_tree_write()
1407
 
        self.add_cleanup(tree.unlock)
1408
 
        # get rid of the final '/' and be ready for display
1409
 
        branch_location = urlutils.unescape_for_display(
1410
 
            branch_location.rstrip('/'),
1411
 
            self.outf.encoding)
1412
 
        existing_pending_merges = tree.get_parent_ids()[1:]
1413
 
        if master is None:
1414
 
            old_tip = None
1415
 
        else:
1416
 
            # may need to fetch data into a heavyweight checkout
1417
 
            # XXX: this may take some time, maybe we should display a
1418
 
            # message
1419
 
            old_tip = branch.update(possible_transports)
1420
 
        if revision is not None:
1421
 
            revision_id = revision[0].as_revision_id(branch)
1422
 
        else:
1423
 
            revision_id = branch.last_revision()
1424
 
        if revision_id == _mod_revision.ensure_null(tree.last_revision()):
1425
 
            revno = branch.revision_id_to_dotted_revno(revision_id)
1426
 
            note("Tree is up to date at revision %s of branch %s" %
1427
 
                ('.'.join(map(str, revno)), branch_location))
1428
 
            return 0
1429
 
        view_info = _get_view_info_for_change_reporter(tree)
1430
 
        change_reporter = delta._ChangeReporter(
1431
 
            unversioned_filter=tree.is_ignored,
1432
 
            view_info=view_info)
1433
1293
        try:
 
1294
            existing_pending_merges = tree.get_parent_ids()[1:]
 
1295
            last_rev = _mod_revision.ensure_null(tree.last_revision())
 
1296
            if last_rev == _mod_revision.ensure_null(
 
1297
                tree.branch.last_revision()):
 
1298
                # may be up to date, check master too.
 
1299
                if master is None or last_rev == _mod_revision.ensure_null(
 
1300
                    master.last_revision()):
 
1301
                    revno = tree.branch.revision_id_to_revno(last_rev)
 
1302
                    note("Tree is up to date at revision %d." % (revno,))
 
1303
                    return 0
 
1304
            view_info = _get_view_info_for_change_reporter(tree)
1434
1305
            conflicts = tree.update(
1435
 
                change_reporter,
1436
 
                possible_transports=possible_transports,
1437
 
                revision=revision_id,
1438
 
                old_tip=old_tip)
1439
 
        except errors.NoSuchRevision, e:
1440
 
            raise errors.BzrCommandError(
1441
 
                                  "branch has no revision %s\n"
1442
 
                                  "bzr update --revision only works"
1443
 
                                  " for a revision in the branch history"
1444
 
                                  % (e.revision))
1445
 
        revno = tree.branch.revision_id_to_dotted_revno(
1446
 
            _mod_revision.ensure_null(tree.last_revision()))
1447
 
        note('Updated to revision %s of branch %s' %
1448
 
             ('.'.join(map(str, revno)), branch_location))
1449
 
        parent_ids = tree.get_parent_ids()
1450
 
        if parent_ids[1:] and parent_ids[1:] != existing_pending_merges:
1451
 
            note('Your local commits will now show as pending merges with '
1452
 
                 "'bzr status', and can be committed with 'bzr commit'.")
1453
 
        if conflicts != 0:
1454
 
            return 1
1455
 
        else:
1456
 
            return 0
 
1306
                delta._ChangeReporter(unversioned_filter=tree.is_ignored,
 
1307
                view_info=view_info), possible_transports=possible_transports)
 
1308
            revno = tree.branch.revision_id_to_revno(
 
1309
                _mod_revision.ensure_null(tree.last_revision()))
 
1310
            note('Updated to revision %d.' % (revno,))
 
1311
            if tree.get_parent_ids()[1:] != existing_pending_merges:
 
1312
                note('Your local commits will now show as pending merges with '
 
1313
                     "'bzr status', and can be committed with 'bzr commit'.")
 
1314
            if conflicts != 0:
 
1315
                return 1
 
1316
            else:
 
1317
                return 0
 
1318
        finally:
 
1319
            tree.unlock()
1457
1320
 
1458
1321
 
1459
1322
class cmd_info(Command):
1460
 
    __doc__ = """Show information about a working tree, branch or repository.
 
1323
    """Show information about a working tree, branch or repository.
1461
1324
 
1462
1325
    This command will show all known locations and formats associated to the
1463
1326
    tree, branch or repository.
1501
1364
 
1502
1365
 
1503
1366
class cmd_remove(Command):
1504
 
    __doc__ = """Remove files or directories.
 
1367
    """Remove files or directories.
1505
1368
 
1506
1369
    This makes bzr stop tracking changes to the specified files. bzr will delete
1507
1370
    them if they can easily be recovered using revert. If no options or
1516
1379
            title='Deletion Strategy', value_switches=True, enum_switch=False,
1517
1380
            safe='Only delete files if they can be'
1518
1381
                 ' safely recovered (default).',
1519
 
            keep='Delete from bzr but leave the working copy.',
 
1382
            keep="Don't delete any files.",
1520
1383
            force='Delete all the specified files, even if they can not be '
1521
1384
                'recovered and even if they are non-empty directories.')]
1522
1385
    aliases = ['rm', 'del']
1529
1392
        if file_list is not None:
1530
1393
            file_list = [f for f in file_list]
1531
1394
 
1532
 
        self.add_cleanup(tree.lock_write().unlock)
1533
 
        # Heuristics should probably all move into tree.remove_smart or
1534
 
        # some such?
1535
 
        if new:
1536
 
            added = tree.changes_from(tree.basis_tree(),
1537
 
                specific_files=file_list).added
1538
 
            file_list = sorted([f[0] for f in added], reverse=True)
1539
 
            if len(file_list) == 0:
1540
 
                raise errors.BzrCommandError('No matching files.')
1541
 
        elif file_list is None:
1542
 
            # missing files show up in iter_changes(basis) as
1543
 
            # versioned-with-no-kind.
1544
 
            missing = []
1545
 
            for change in tree.iter_changes(tree.basis_tree()):
1546
 
                # Find paths in the working tree that have no kind:
1547
 
                if change[1][1] is not None and change[6][1] is None:
1548
 
                    missing.append(change[1][1])
1549
 
            file_list = sorted(missing, reverse=True)
1550
 
            file_deletion_strategy = 'keep'
1551
 
        tree.remove(file_list, verbose=verbose, to_file=self.outf,
1552
 
            keep_files=file_deletion_strategy=='keep',
1553
 
            force=file_deletion_strategy=='force')
 
1395
        tree.lock_write()
 
1396
        try:
 
1397
            # Heuristics should probably all move into tree.remove_smart or
 
1398
            # some such?
 
1399
            if new:
 
1400
                added = tree.changes_from(tree.basis_tree(),
 
1401
                    specific_files=file_list).added
 
1402
                file_list = sorted([f[0] for f in added], reverse=True)
 
1403
                if len(file_list) == 0:
 
1404
                    raise errors.BzrCommandError('No matching files.')
 
1405
            elif file_list is None:
 
1406
                # missing files show up in iter_changes(basis) as
 
1407
                # versioned-with-no-kind.
 
1408
                missing = []
 
1409
                for change in tree.iter_changes(tree.basis_tree()):
 
1410
                    # Find paths in the working tree that have no kind:
 
1411
                    if change[1][1] is not None and change[6][1] is None:
 
1412
                        missing.append(change[1][1])
 
1413
                file_list = sorted(missing, reverse=True)
 
1414
                file_deletion_strategy = 'keep'
 
1415
            tree.remove(file_list, verbose=verbose, to_file=self.outf,
 
1416
                keep_files=file_deletion_strategy=='keep',
 
1417
                force=file_deletion_strategy=='force')
 
1418
        finally:
 
1419
            tree.unlock()
1554
1420
 
1555
1421
 
1556
1422
class cmd_file_id(Command):
1557
 
    __doc__ = """Print file_id of a particular file or directory.
 
1423
    """Print file_id of a particular file or directory.
1558
1424
 
1559
1425
    The file_id is assigned when the file is first added and remains the
1560
1426
    same through all revisions where the file exists, even when it is
1576
1442
 
1577
1443
 
1578
1444
class cmd_file_path(Command):
1579
 
    __doc__ = """Print path of file_ids to a file or directory.
 
1445
    """Print path of file_ids to a file or directory.
1580
1446
 
1581
1447
    This prints one line for each directory down to the target,
1582
1448
    starting at the branch root.
1598
1464
 
1599
1465
 
1600
1466
class cmd_reconcile(Command):
1601
 
    __doc__ = """Reconcile bzr metadata in a branch.
 
1467
    """Reconcile bzr metadata in a branch.
1602
1468
 
1603
1469
    This can correct data mismatches that may have been caused by
1604
1470
    previous ghost operations or bzr upgrades. You should only
1626
1492
 
1627
1493
 
1628
1494
class cmd_revision_history(Command):
1629
 
    __doc__ = """Display the list of revision ids on a branch."""
 
1495
    """Display the list of revision ids on a branch."""
1630
1496
 
1631
1497
    _see_also = ['log']
1632
1498
    takes_args = ['location?']
1642
1508
 
1643
1509
 
1644
1510
class cmd_ancestry(Command):
1645
 
    __doc__ = """List all revisions merged into this branch."""
 
1511
    """List all revisions merged into this branch."""
1646
1512
 
1647
1513
    _see_also = ['log', 'revision-history']
1648
1514
    takes_args = ['location?']
1667
1533
 
1668
1534
 
1669
1535
class cmd_init(Command):
1670
 
    __doc__ = """Make a directory into a versioned branch.
 
1536
    """Make a directory into a versioned branch.
1671
1537
 
1672
1538
    Use this to create an empty branch, or before importing an
1673
1539
    existing project.
1701
1567
                lazy_registry=('bzrlib.bzrdir', 'format_registry'),
1702
1568
                converter=lambda name: bzrdir.format_registry.make_bzrdir(name),
1703
1569
                value_switches=True,
1704
 
                title="Branch format",
 
1570
                title="Branch Format",
1705
1571
                ),
1706
1572
         Option('append-revisions-only',
1707
1573
                help='Never change revnos or the existing log.'
1754
1620
                branch.set_append_revisions_only(True)
1755
1621
            except errors.UpgradeRequired:
1756
1622
                raise errors.BzrCommandError('This branch format cannot be set'
1757
 
                    ' to append-revisions-only.  Try --default.')
 
1623
                    ' to append-revisions-only.  Try --experimental-branch6')
1758
1624
        if not is_quiet():
1759
1625
            from bzrlib.info import describe_layout, describe_format
1760
1626
            try:
1776
1642
 
1777
1643
 
1778
1644
class cmd_init_repository(Command):
1779
 
    __doc__ = """Create a shared repository for branches to share storage space.
 
1645
    """Create a shared repository to hold branches.
1780
1646
 
1781
1647
    New branches created under the repository directory will store their
1782
 
    revisions in the repository, not in the branch directory.  For branches
1783
 
    with shared history, this reduces the amount of storage needed and 
1784
 
    speeds up the creation of new branches.
 
1648
    revisions in the repository, not in the branch directory.
1785
1649
 
1786
 
    If the --no-trees option is given then the branches in the repository
1787
 
    will not have working trees by default.  They will still exist as 
1788
 
    directories on disk, but they will not have separate copies of the 
1789
 
    files at a certain revision.  This can be useful for repositories that
1790
 
    store branches which are interacted with through checkouts or remote
1791
 
    branches, such as on a server.
 
1650
    If the --no-trees option is used then the branches in the repository
 
1651
    will not have working trees by default.
1792
1652
 
1793
1653
    :Examples:
1794
 
        Create a shared repository holding just branches::
 
1654
        Create a shared repositories holding just branches::
1795
1655
 
1796
1656
            bzr init-repo --no-trees repo
1797
1657
            bzr init repo/trunk
1836
1696
 
1837
1697
 
1838
1698
class cmd_diff(Command):
1839
 
    __doc__ = """Show differences in the working tree, between revisions or branches.
 
1699
    """Show differences in the working tree, between revisions or branches.
1840
1700
 
1841
1701
    If no arguments are given, all changes for the current tree are listed.
1842
1702
    If files are given, only the changes in those files are listed.
1863
1723
 
1864
1724
            bzr diff -r1
1865
1725
 
1866
 
        Difference between revision 3 and revision 1::
1867
 
 
1868
 
            bzr diff -r1..3
1869
 
 
1870
 
        Difference between revision 3 and revision 1 for branch xxx::
1871
 
 
1872
 
            bzr diff -r1..3 xxx
1873
 
 
1874
 
        To see the changes introduced in revision X::
1875
 
        
1876
 
            bzr diff -cX
1877
 
 
1878
 
        Note that in the case of a merge, the -c option shows the changes
1879
 
        compared to the left hand parent. To see the changes against
1880
 
        another parent, use::
1881
 
 
1882
 
            bzr diff -r<chosen_parent>..X
1883
 
 
1884
 
        The changes introduced by revision 2 (equivalent to -r1..2)::
1885
 
 
1886
 
            bzr diff -c2
 
1726
        Difference between revision 2 and revision 1::
 
1727
 
 
1728
            bzr diff -r1..2
 
1729
 
 
1730
        Difference between revision 2 and revision 1 for branch xxx::
 
1731
 
 
1732
            bzr diff -r1..2 xxx
1887
1733
 
1888
1734
        Show just the differences for file NEWS::
1889
1735
 
1928
1774
            help='Use this command to compare files.',
1929
1775
            type=unicode,
1930
1776
            ),
1931
 
        RegistryOption('format',
1932
 
            help='Diff format to use.',
1933
 
            lazy_registry=('bzrlib.diff', 'format_registry'),
1934
 
            value_switches=False, title='Diff format'),
1935
1777
        ]
1936
1778
    aliases = ['di', 'dif']
1937
1779
    encoding_type = 'exact'
1938
1780
 
1939
1781
    @display_command
1940
1782
    def run(self, revision=None, file_list=None, diff_options=None,
1941
 
            prefix=None, old=None, new=None, using=None, format=None):
1942
 
        from bzrlib.diff import (get_trees_and_branches_to_diff_locked,
1943
 
            show_diff_trees)
 
1783
            prefix=None, old=None, new=None, using=None):
 
1784
        from bzrlib.diff import _get_trees_to_diff, show_diff_trees
1944
1785
 
1945
1786
        if (prefix is None) or (prefix == '0'):
1946
1787
            # diff -p0 format
1960
1801
            raise errors.BzrCommandError('bzr diff --revision takes exactly'
1961
1802
                                         ' one or two revision specifiers')
1962
1803
 
1963
 
        if using is not None and format is not None:
1964
 
            raise errors.BzrCommandError('--using and --format are mutually '
1965
 
                'exclusive.')
1966
 
 
1967
 
        (old_tree, new_tree,
1968
 
         old_branch, new_branch,
1969
 
         specific_files, extra_trees) = get_trees_and_branches_to_diff_locked(
1970
 
            file_list, revision, old, new, self.add_cleanup, apply_view=True)
 
1804
        old_tree, new_tree, specific_files, extra_trees = \
 
1805
                _get_trees_to_diff(file_list, revision, old, new,
 
1806
                apply_view=True)
1971
1807
        return show_diff_trees(old_tree, new_tree, sys.stdout,
1972
1808
                               specific_files=specific_files,
1973
1809
                               external_diff_options=diff_options,
1974
1810
                               old_label=old_label, new_label=new_label,
1975
 
                               extra_trees=extra_trees, using=using,
1976
 
                               format_cls=format)
 
1811
                               extra_trees=extra_trees, using=using)
1977
1812
 
1978
1813
 
1979
1814
class cmd_deleted(Command):
1980
 
    __doc__ = """List files deleted in the working tree.
 
1815
    """List files deleted in the working tree.
1981
1816
    """
1982
1817
    # TODO: Show files deleted since a previous revision, or
1983
1818
    # between two revisions.
1986
1821
    # level of effort but possibly much less IO.  (Or possibly not,
1987
1822
    # if the directories are very large...)
1988
1823
    _see_also = ['status', 'ls']
1989
 
    takes_options = ['directory', 'show-ids']
 
1824
    takes_options = ['show-ids']
1990
1825
 
1991
1826
    @display_command
1992
 
    def run(self, show_ids=False, directory=u'.'):
1993
 
        tree = WorkingTree.open_containing(directory)[0]
1994
 
        self.add_cleanup(tree.lock_read().unlock)
1995
 
        old = tree.basis_tree()
1996
 
        self.add_cleanup(old.lock_read().unlock)
1997
 
        for path, ie in old.inventory.iter_entries():
1998
 
            if not tree.has_id(ie.file_id):
1999
 
                self.outf.write(path)
2000
 
                if show_ids:
2001
 
                    self.outf.write(' ')
2002
 
                    self.outf.write(ie.file_id)
2003
 
                self.outf.write('\n')
 
1827
    def run(self, show_ids=False):
 
1828
        tree = WorkingTree.open_containing(u'.')[0]
 
1829
        tree.lock_read()
 
1830
        try:
 
1831
            old = tree.basis_tree()
 
1832
            old.lock_read()
 
1833
            try:
 
1834
                for path, ie in old.inventory.iter_entries():
 
1835
                    if not tree.has_id(ie.file_id):
 
1836
                        self.outf.write(path)
 
1837
                        if show_ids:
 
1838
                            self.outf.write(' ')
 
1839
                            self.outf.write(ie.file_id)
 
1840
                        self.outf.write('\n')
 
1841
            finally:
 
1842
                old.unlock()
 
1843
        finally:
 
1844
            tree.unlock()
2004
1845
 
2005
1846
 
2006
1847
class cmd_modified(Command):
2007
 
    __doc__ = """List files modified in working tree.
 
1848
    """List files modified in working tree.
2008
1849
    """
2009
1850
 
2010
1851
    hidden = True
2011
1852
    _see_also = ['status', 'ls']
2012
 
    takes_options = ['directory', 'null']
 
1853
    takes_options = [
 
1854
            Option('null',
 
1855
                   help='Write an ascii NUL (\\0) separator '
 
1856
                   'between files rather than a newline.')
 
1857
            ]
2013
1858
 
2014
1859
    @display_command
2015
 
    def run(self, null=False, directory=u'.'):
2016
 
        tree = WorkingTree.open_containing(directory)[0]
 
1860
    def run(self, null=False):
 
1861
        tree = WorkingTree.open_containing(u'.')[0]
2017
1862
        td = tree.changes_from(tree.basis_tree())
2018
1863
        for path, id, kind, text_modified, meta_modified in td.modified:
2019
1864
            if null:
2023
1868
 
2024
1869
 
2025
1870
class cmd_added(Command):
2026
 
    __doc__ = """List files added in working tree.
 
1871
    """List files added in working tree.
2027
1872
    """
2028
1873
 
2029
1874
    hidden = True
2030
1875
    _see_also = ['status', 'ls']
2031
 
    takes_options = ['directory', 'null']
 
1876
    takes_options = [
 
1877
            Option('null',
 
1878
                   help='Write an ascii NUL (\\0) separator '
 
1879
                   'between files rather than a newline.')
 
1880
            ]
2032
1881
 
2033
1882
    @display_command
2034
 
    def run(self, null=False, directory=u'.'):
2035
 
        wt = WorkingTree.open_containing(directory)[0]
2036
 
        self.add_cleanup(wt.lock_read().unlock)
2037
 
        basis = wt.basis_tree()
2038
 
        self.add_cleanup(basis.lock_read().unlock)
2039
 
        basis_inv = basis.inventory
2040
 
        inv = wt.inventory
2041
 
        for file_id in inv:
2042
 
            if file_id in basis_inv:
2043
 
                continue
2044
 
            if inv.is_root(file_id) and len(basis_inv) == 0:
2045
 
                continue
2046
 
            path = inv.id2path(file_id)
2047
 
            if not os.access(osutils.pathjoin(wt.basedir, path), os.F_OK):
2048
 
                continue
2049
 
            if null:
2050
 
                self.outf.write(path + '\0')
2051
 
            else:
2052
 
                self.outf.write(osutils.quotefn(path) + '\n')
 
1883
    def run(self, null=False):
 
1884
        wt = WorkingTree.open_containing(u'.')[0]
 
1885
        wt.lock_read()
 
1886
        try:
 
1887
            basis = wt.basis_tree()
 
1888
            basis.lock_read()
 
1889
            try:
 
1890
                basis_inv = basis.inventory
 
1891
                inv = wt.inventory
 
1892
                for file_id in inv:
 
1893
                    if file_id in basis_inv:
 
1894
                        continue
 
1895
                    if inv.is_root(file_id) and len(basis_inv) == 0:
 
1896
                        continue
 
1897
                    path = inv.id2path(file_id)
 
1898
                    if not os.access(osutils.abspath(path), os.F_OK):
 
1899
                        continue
 
1900
                    if null:
 
1901
                        self.outf.write(path + '\0')
 
1902
                    else:
 
1903
                        self.outf.write(osutils.quotefn(path) + '\n')
 
1904
            finally:
 
1905
                basis.unlock()
 
1906
        finally:
 
1907
            wt.unlock()
2053
1908
 
2054
1909
 
2055
1910
class cmd_root(Command):
2056
 
    __doc__ = """Show the tree root directory.
 
1911
    """Show the tree root directory.
2057
1912
 
2058
1913
    The root is the nearest enclosing directory with a .bzr control
2059
1914
    directory."""
2083
1938
 
2084
1939
 
2085
1940
class cmd_log(Command):
2086
 
    __doc__ = """Show historical log for a branch or subset of a branch.
 
1941
    """Show historical log for a branch or subset of a branch.
2087
1942
 
2088
1943
    log is bzr's default tool for exploring the history of a branch.
2089
1944
    The branch to use is taken from the first parameter. If no parameters
2200
2055
    :Tips & tricks:
2201
2056
 
2202
2057
      GUI tools and IDEs are often better at exploring history than command
2203
 
      line tools: you may prefer qlog or viz from qbzr or bzr-gtk, the
2204
 
      bzr-explorer shell, or the Loggerhead web interface.  See the Plugin
2205
 
      Guide <http://doc.bazaar.canonical.com/plugins/en/> and
2206
 
      <http://wiki.bazaar.canonical.com/IDEIntegration>.  
 
2058
      line tools. You may prefer qlog or glog from the QBzr and Bzr-Gtk packages
 
2059
      respectively for example. (TortoiseBzr uses qlog for displaying logs.) See
 
2060
      http://bazaar-vcs.org/BzrPlugins and http://bazaar-vcs.org/IDEIntegration.
 
2061
 
 
2062
      Web interfaces are often better at exploring history than command line
 
2063
      tools, particularly for branches on servers. You may prefer Loggerhead
 
2064
      or one of its alternatives. See http://bazaar-vcs.org/WebInterface.
2207
2065
 
2208
2066
      You may find it useful to add the aliases below to ``bazaar.conf``::
2209
2067
 
2231
2089
 
2232
2090
      When exploring non-mainline history on large projects with deep
2233
2091
      history, the performance of log can be greatly improved by installing
2234
 
      the historycache plugin. This plugin buffers historical information
 
2092
      the revnocache plugin. This plugin buffers historical information
2235
2093
      trading disk space for faster speed.
2236
2094
    """
2237
2095
    takes_args = ['file*']
2250
2108
                   help='Show just the specified revision.'
2251
2109
                   ' See also "help revisionspec".'),
2252
2110
            'log-format',
2253
 
            RegistryOption('authors',
2254
 
                'What names to list as authors - first, all or committer.',
2255
 
                title='Authors',
2256
 
                lazy_registry=('bzrlib.log', 'author_list_registry'),
2257
 
            ),
2258
2111
            Option('levels',
2259
2112
                   short_name='n',
2260
2113
                   help='Number of levels to display - 0 for all, 1 for flat.',
2275
2128
                   help='Show changes made in each revision as a patch.'),
2276
2129
            Option('include-merges',
2277
2130
                   help='Show merged revisions like --levels 0 does.'),
2278
 
            Option('exclude-common-ancestry',
2279
 
                   help='Display only the revisions that are not part'
2280
 
                   ' of both ancestries (require -rX..Y)'
2281
 
                   )
2282
2131
            ]
2283
2132
    encoding_type = 'replace'
2284
2133
 
2294
2143
            message=None,
2295
2144
            limit=None,
2296
2145
            show_diff=False,
2297
 
            include_merges=False,
2298
 
            authors=None,
2299
 
            exclude_common_ancestry=False,
2300
 
            ):
 
2146
            include_merges=False):
2301
2147
        from bzrlib.log import (
2302
2148
            Logger,
2303
2149
            make_log_request_dict,
2304
2150
            _get_info_for_log_files,
2305
2151
            )
2306
2152
        direction = (forward and 'forward') or 'reverse'
2307
 
        if (exclude_common_ancestry
2308
 
            and (revision is None or len(revision) != 2)):
2309
 
            raise errors.BzrCommandError(
2310
 
                '--exclude-common-ancestry requires -r with two revisions')
2311
2153
        if include_merges:
2312
2154
            if levels is None:
2313
2155
                levels = 0
2328
2170
        filter_by_dir = False
2329
2171
        if file_list:
2330
2172
            # find the file ids to log and check for directory filtering
2331
 
            b, file_info_list, rev1, rev2 = _get_info_for_log_files(
2332
 
                revision, file_list, self.add_cleanup)
 
2173
            b, file_info_list, rev1, rev2 = _get_info_for_log_files(revision,
 
2174
                file_list)
2333
2175
            for relpath, file_id, kind in file_info_list:
2334
2176
                if file_id is None:
2335
2177
                    raise errors.BzrCommandError(
2353
2195
                location = '.'
2354
2196
            dir, relpath = bzrdir.BzrDir.open_containing(location)
2355
2197
            b = dir.open_branch()
2356
 
            self.add_cleanup(b.lock_read().unlock)
2357
2198
            rev1, rev2 = _get_revision_range(revision, b, self.name())
2358
2199
 
2359
2200
        # Decide on the type of delta & diff filtering to use
2369
2210
        else:
2370
2211
            diff_type = 'full'
2371
2212
 
2372
 
        # Build the log formatter
2373
 
        if log_format is None:
2374
 
            log_format = log.log_formatter_registry.get_default(b)
2375
 
        # Make a non-encoding output to include the diffs - bug 328007
2376
 
        unencoded_output = ui.ui_factory.make_output_stream(encoding_type='exact')
2377
 
        lf = log_format(show_ids=show_ids, to_file=self.outf,
2378
 
                        to_exact_file=unencoded_output,
2379
 
                        show_timezone=timezone,
2380
 
                        delta_format=get_verbosity_level(),
2381
 
                        levels=levels,
2382
 
                        show_advice=levels is None,
2383
 
                        author_list_handler=authors)
2384
 
 
2385
 
        # Choose the algorithm for doing the logging. It's annoying
2386
 
        # having multiple code paths like this but necessary until
2387
 
        # the underlying repository format is faster at generating
2388
 
        # deltas or can provide everything we need from the indices.
2389
 
        # The default algorithm - match-using-deltas - works for
2390
 
        # multiple files and directories and is faster for small
2391
 
        # amounts of history (200 revisions say). However, it's too
2392
 
        # slow for logging a single file in a repository with deep
2393
 
        # history, i.e. > 10K revisions. In the spirit of "do no
2394
 
        # evil when adding features", we continue to use the
2395
 
        # original algorithm - per-file-graph - for the "single
2396
 
        # file that isn't a directory without showing a delta" case.
2397
 
        partial_history = revision and b.repository._format.supports_chks
2398
 
        match_using_deltas = (len(file_ids) != 1 or filter_by_dir
2399
 
            or delta_type or partial_history)
2400
 
 
2401
 
        # Build the LogRequest and execute it
2402
 
        if len(file_ids) == 0:
2403
 
            file_ids = None
2404
 
        rqst = make_log_request_dict(
2405
 
            direction=direction, specific_fileids=file_ids,
2406
 
            start_revision=rev1, end_revision=rev2, limit=limit,
2407
 
            message_search=message, delta_type=delta_type,
2408
 
            diff_type=diff_type, _match_using_deltas=match_using_deltas,
2409
 
            exclude_common_ancestry=exclude_common_ancestry,
2410
 
            )
2411
 
        Logger(b, rqst).show(lf)
 
2213
        b.lock_read()
 
2214
        try:
 
2215
            # Build the log formatter
 
2216
            if log_format is None:
 
2217
                log_format = log.log_formatter_registry.get_default(b)
 
2218
            lf = log_format(show_ids=show_ids, to_file=self.outf,
 
2219
                            show_timezone=timezone,
 
2220
                            delta_format=get_verbosity_level(),
 
2221
                            levels=levels,
 
2222
                            show_advice=levels is None)
 
2223
 
 
2224
            # Choose the algorithm for doing the logging. It's annoying
 
2225
            # having multiple code paths like this but necessary until
 
2226
            # the underlying repository format is faster at generating
 
2227
            # deltas or can provide everything we need from the indices.
 
2228
            # The default algorithm - match-using-deltas - works for
 
2229
            # multiple files and directories and is faster for small
 
2230
            # amounts of history (200 revisions say). However, it's too
 
2231
            # slow for logging a single file in a repository with deep
 
2232
            # history, i.e. > 10K revisions. In the spirit of "do no
 
2233
            # evil when adding features", we continue to use the
 
2234
            # original algorithm - per-file-graph - for the "single
 
2235
            # file that isn't a directory without showing a delta" case.
 
2236
            partial_history = revision and b.repository._format.supports_chks
 
2237
            match_using_deltas = (len(file_ids) != 1 or filter_by_dir
 
2238
                or delta_type or partial_history)
 
2239
 
 
2240
            # Build the LogRequest and execute it
 
2241
            if len(file_ids) == 0:
 
2242
                file_ids = None
 
2243
            rqst = make_log_request_dict(
 
2244
                direction=direction, specific_fileids=file_ids,
 
2245
                start_revision=rev1, end_revision=rev2, limit=limit,
 
2246
                message_search=message, delta_type=delta_type,
 
2247
                diff_type=diff_type, _match_using_deltas=match_using_deltas)
 
2248
            Logger(b, rqst).show(lf)
 
2249
        finally:
 
2250
            b.unlock()
2412
2251
 
2413
2252
 
2414
2253
def _get_revision_range(revisionspec_list, branch, command_name):
2432
2271
            raise errors.BzrCommandError(
2433
2272
                "bzr %s doesn't accept two revisions in different"
2434
2273
                " branches." % command_name)
2435
 
        if start_spec.spec is None:
2436
 
            # Avoid loading all the history.
2437
 
            rev1 = RevisionInfo(branch, None, None)
2438
 
        else:
2439
 
            rev1 = start_spec.in_history(branch)
 
2274
        rev1 = start_spec.in_history(branch)
2440
2275
        # Avoid loading all of history when we know a missing
2441
2276
        # end of range means the last revision ...
2442
2277
        if end_spec.spec is None:
2471
2306
 
2472
2307
 
2473
2308
class cmd_touching_revisions(Command):
2474
 
    __doc__ = """Return revision-ids which affected a particular file.
 
2309
    """Return revision-ids which affected a particular file.
2475
2310
 
2476
2311
    A more user-friendly interface is "bzr log FILE".
2477
2312
    """
2482
2317
    @display_command
2483
2318
    def run(self, filename):
2484
2319
        tree, relpath = WorkingTree.open_containing(filename)
 
2320
        b = tree.branch
2485
2321
        file_id = tree.path2id(relpath)
2486
 
        b = tree.branch
2487
 
        self.add_cleanup(b.lock_read().unlock)
2488
 
        touching_revs = log.find_touching_revisions(b, file_id)
2489
 
        for revno, revision_id, what in touching_revs:
 
2322
        for revno, revision_id, what in log.find_touching_revisions(b, file_id):
2490
2323
            self.outf.write("%6d %s\n" % (revno, what))
2491
2324
 
2492
2325
 
2493
2326
class cmd_ls(Command):
2494
 
    __doc__ = """List files in a tree.
 
2327
    """List files in a tree.
2495
2328
    """
2496
2329
 
2497
2330
    _see_also = ['status', 'cat']
2503
2336
                   help='Recurse into subdirectories.'),
2504
2337
            Option('from-root',
2505
2338
                   help='Print paths relative to the root of the branch.'),
2506
 
            Option('unknown', short_name='u',
2507
 
                help='Print unknown files.'),
 
2339
            Option('unknown', help='Print unknown files.'),
2508
2340
            Option('versioned', help='Print versioned files.',
2509
2341
                   short_name='V'),
2510
 
            Option('ignored', short_name='i',
2511
 
                help='Print ignored files.'),
2512
 
            Option('kind', short_name='k',
 
2342
            Option('ignored', help='Print ignored files.'),
 
2343
            Option('null',
 
2344
                   help='Write an ascii NUL (\\0) separator '
 
2345
                   'between files rather than a newline.'),
 
2346
            Option('kind',
2513
2347
                   help='List entries of a particular kind: file, directory, symlink.',
2514
2348
                   type=unicode),
2515
 
            'null',
2516
2349
            'show-ids',
2517
 
            'directory',
2518
2350
            ]
2519
2351
    @display_command
2520
2352
    def run(self, revision=None, verbose=False,
2521
2353
            recursive=False, from_root=False,
2522
2354
            unknown=False, versioned=False, ignored=False,
2523
 
            null=False, kind=None, show_ids=False, path=None, directory=None):
 
2355
            null=False, kind=None, show_ids=False, path=None):
2524
2356
 
2525
2357
        if kind and kind not in ('file', 'directory', 'symlink'):
2526
2358
            raise errors.BzrCommandError('invalid kind specified')
2533
2365
 
2534
2366
        if path is None:
2535
2367
            fs_path = '.'
 
2368
            prefix = ''
2536
2369
        else:
2537
2370
            if from_root:
2538
2371
                raise errors.BzrCommandError('cannot specify both --from-root'
2539
2372
                                             ' and PATH')
2540
2373
            fs_path = path
2541
 
        tree, branch, relpath = \
2542
 
            _open_directory_or_containing_tree_or_branch(fs_path, directory)
2543
 
 
2544
 
        # Calculate the prefix to use
2545
 
        prefix = None
 
2374
            prefix = path
 
2375
        tree, branch, relpath = bzrdir.BzrDir.open_containing_tree_or_branch(
 
2376
            fs_path)
2546
2377
        if from_root:
2547
 
            if relpath:
2548
 
                prefix = relpath + '/'
2549
 
        elif fs_path != '.' and not fs_path.endswith('/'):
2550
 
            prefix = fs_path + '/'
2551
 
 
 
2378
            relpath = u''
 
2379
        elif relpath:
 
2380
            relpath += '/'
2552
2381
        if revision is not None or tree is None:
2553
2382
            tree = _get_one_revision_tree('ls', revision, branch=branch)
2554
2383
 
2560
2389
                view_str = views.view_display_str(view_files)
2561
2390
                note("Ignoring files outside view. View is %s" % view_str)
2562
2391
 
2563
 
        self.add_cleanup(tree.lock_read().unlock)
2564
 
        for fp, fc, fkind, fid, entry in tree.list_files(include_root=False,
2565
 
            from_dir=relpath, recursive=recursive):
2566
 
            # Apply additional masking
2567
 
            if not all and not selection[fc]:
2568
 
                continue
2569
 
            if kind is not None and fkind != kind:
2570
 
                continue
2571
 
            if apply_view:
2572
 
                try:
2573
 
                    if relpath:
2574
 
                        fullpath = osutils.pathjoin(relpath, fp)
2575
 
                    else:
2576
 
                        fullpath = fp
2577
 
                    views.check_path_in_view(tree, fullpath)
2578
 
                except errors.FileOutsideView:
2579
 
                    continue
2580
 
 
2581
 
            # Output the entry
2582
 
            if prefix:
2583
 
                fp = osutils.pathjoin(prefix, fp)
2584
 
            kindch = entry.kind_character()
2585
 
            outstring = fp + kindch
2586
 
            ui.ui_factory.clear_term()
2587
 
            if verbose:
2588
 
                outstring = '%-8s %s' % (fc, outstring)
2589
 
                if show_ids and fid is not None:
2590
 
                    outstring = "%-50s %s" % (outstring, fid)
2591
 
                self.outf.write(outstring + '\n')
2592
 
            elif null:
2593
 
                self.outf.write(fp + '\0')
2594
 
                if show_ids:
2595
 
                    if fid is not None:
2596
 
                        self.outf.write(fid)
2597
 
                    self.outf.write('\0')
2598
 
                self.outf.flush()
2599
 
            else:
2600
 
                if show_ids:
2601
 
                    if fid is not None:
2602
 
                        my_id = fid
2603
 
                    else:
2604
 
                        my_id = ''
2605
 
                    self.outf.write('%-50s %s\n' % (outstring, my_id))
2606
 
                else:
2607
 
                    self.outf.write(outstring + '\n')
 
2392
        tree.lock_read()
 
2393
        try:
 
2394
            for fp, fc, fkind, fid, entry in tree.list_files(include_root=False):
 
2395
                if fp.startswith(relpath):
 
2396
                    rp = fp[len(relpath):]
 
2397
                    fp = osutils.pathjoin(prefix, rp)
 
2398
                    if not recursive and '/' in rp:
 
2399
                        continue
 
2400
                    if not all and not selection[fc]:
 
2401
                        continue
 
2402
                    if kind is not None and fkind != kind:
 
2403
                        continue
 
2404
                    if apply_view:
 
2405
                        try:
 
2406
                            views.check_path_in_view(tree, fp)
 
2407
                        except errors.FileOutsideView:
 
2408
                            continue
 
2409
                    kindch = entry.kind_character()
 
2410
                    outstring = fp + kindch
 
2411
                    if verbose:
 
2412
                        outstring = '%-8s %s' % (fc, outstring)
 
2413
                        if show_ids and fid is not None:
 
2414
                            outstring = "%-50s %s" % (outstring, fid)
 
2415
                        self.outf.write(outstring + '\n')
 
2416
                    elif null:
 
2417
                        self.outf.write(fp + '\0')
 
2418
                        if show_ids:
 
2419
                            if fid is not None:
 
2420
                                self.outf.write(fid)
 
2421
                            self.outf.write('\0')
 
2422
                        self.outf.flush()
 
2423
                    else:
 
2424
                        if fid is not None:
 
2425
                            my_id = fid
 
2426
                        else:
 
2427
                            my_id = ''
 
2428
                        if show_ids:
 
2429
                            self.outf.write('%-50s %s\n' % (outstring, my_id))
 
2430
                        else:
 
2431
                            self.outf.write(outstring + '\n')
 
2432
        finally:
 
2433
            tree.unlock()
2608
2434
 
2609
2435
 
2610
2436
class cmd_unknowns(Command):
2611
 
    __doc__ = """List unknown files.
 
2437
    """List unknown files.
2612
2438
    """
2613
2439
 
2614
2440
    hidden = True
2615
2441
    _see_also = ['ls']
2616
 
    takes_options = ['directory']
2617
2442
 
2618
2443
    @display_command
2619
 
    def run(self, directory=u'.'):
2620
 
        for f in WorkingTree.open_containing(directory)[0].unknowns():
 
2444
    def run(self):
 
2445
        for f in WorkingTree.open_containing(u'.')[0].unknowns():
2621
2446
            self.outf.write(osutils.quotefn(f) + '\n')
2622
2447
 
2623
2448
 
2624
2449
class cmd_ignore(Command):
2625
 
    __doc__ = """Ignore specified files or patterns.
 
2450
    """Ignore specified files or patterns.
2626
2451
 
2627
2452
    See ``bzr help patterns`` for details on the syntax of patterns.
2628
2453
 
2629
 
    If a .bzrignore file does not exist, the ignore command
2630
 
    will create one and add the specified files or patterns to the newly
2631
 
    created file. The ignore command will also automatically add the 
2632
 
    .bzrignore file to be versioned. Creating a .bzrignore file without
2633
 
    the use of the ignore command will require an explicit add command.
2634
 
 
2635
2454
    To remove patterns from the ignore list, edit the .bzrignore file.
2636
2455
    After adding, editing or deleting that file either indirectly by
2637
2456
    using this command or directly by using an editor, be sure to commit
2638
2457
    it.
2639
 
    
2640
 
    Bazaar also supports a global ignore file ~/.bazaar/ignore. On Windows
2641
 
    the global ignore file can be found in the application data directory as
2642
 
    C:\\Documents and Settings\\<user>\\Application Data\\Bazaar\\2.0\\ignore.
2643
 
    Global ignores are not touched by this command. The global ignore file
2644
 
    can be edited directly using an editor.
2645
 
 
2646
 
    Patterns prefixed with '!' are exceptions to ignore patterns and take
2647
 
    precedence over regular ignores.  Such exceptions are used to specify
2648
 
    files that should be versioned which would otherwise be ignored.
2649
 
    
2650
 
    Patterns prefixed with '!!' act as regular ignore patterns, but have
2651
 
    precedence over the '!' exception patterns.
2652
2458
 
2653
2459
    Note: ignore patterns containing shell wildcards must be quoted from
2654
2460
    the shell on Unix.
2658
2464
 
2659
2465
            bzr ignore ./Makefile
2660
2466
 
2661
 
        Ignore .class files in all directories...::
 
2467
        Ignore class files in all directories::
2662
2468
 
2663
2469
            bzr ignore "*.class"
2664
2470
 
2665
 
        ...but do not ignore "special.class"::
2666
 
 
2667
 
            bzr ignore "!special.class"
2668
 
 
2669
2471
        Ignore .o files under the lib directory::
2670
2472
 
2671
2473
            bzr ignore "lib/**/*.o"
2677
2479
        Ignore everything but the "debian" toplevel directory::
2678
2480
 
2679
2481
            bzr ignore "RE:(?!debian/).*"
2680
 
        
2681
 
        Ignore everything except the "local" toplevel directory,
2682
 
        but always ignore "*~" autosave files, even under local/::
2683
 
        
2684
 
            bzr ignore "*"
2685
 
            bzr ignore "!./local"
2686
 
            bzr ignore "!!*~"
2687
2482
    """
2688
2483
 
2689
2484
    _see_also = ['status', 'ignored', 'patterns']
2690
2485
    takes_args = ['name_pattern*']
2691
 
    takes_options = ['directory',
2692
 
        Option('default-rules',
2693
 
               help='Display the default ignore rules that bzr uses.')
 
2486
    takes_options = [
 
2487
        Option('old-default-rules',
 
2488
               help='Write out the ignore rules bzr < 0.9 always used.')
2694
2489
        ]
2695
2490
 
2696
 
    def run(self, name_pattern_list=None, default_rules=None,
2697
 
            directory=u'.'):
 
2491
    def run(self, name_pattern_list=None, old_default_rules=None):
2698
2492
        from bzrlib import ignores
2699
 
        if default_rules is not None:
2700
 
            # dump the default rules and exit
2701
 
            for pattern in ignores.USER_DEFAULTS:
2702
 
                self.outf.write("%s\n" % pattern)
 
2493
        if old_default_rules is not None:
 
2494
            # dump the rules and exit
 
2495
            for pattern in ignores.OLD_DEFAULTS:
 
2496
                print pattern
2703
2497
            return
2704
2498
        if not name_pattern_list:
2705
2499
            raise errors.BzrCommandError("ignore requires at least one "
2706
 
                "NAME_PATTERN or --default-rules.")
 
2500
                                  "NAME_PATTERN or --old-default-rules")
2707
2501
        name_pattern_list = [globbing.normalize_pattern(p)
2708
2502
                             for p in name_pattern_list]
2709
2503
        for name_pattern in name_pattern_list:
2711
2505
                (len(name_pattern) > 1 and name_pattern[1] == ':')):
2712
2506
                raise errors.BzrCommandError(
2713
2507
                    "NAME_PATTERN should not be an absolute path")
2714
 
        tree, relpath = WorkingTree.open_containing(directory)
 
2508
        tree, relpath = WorkingTree.open_containing(u'.')
2715
2509
        ignores.tree_ignores_add_patterns(tree, name_pattern_list)
2716
2510
        ignored = globbing.Globster(name_pattern_list)
2717
2511
        matches = []
2721
2515
            if id is not None:
2722
2516
                filename = entry[0]
2723
2517
                if ignored.match(filename):
2724
 
                    matches.append(filename)
 
2518
                    matches.append(filename.encode('utf-8'))
2725
2519
        tree.unlock()
2726
2520
        if len(matches) > 0:
2727
 
            self.outf.write("Warning: the following files are version controlled and"
2728
 
                  " match your ignore pattern:\n%s"
2729
 
                  "\nThese files will continue to be version controlled"
2730
 
                  " unless you 'bzr remove' them.\n" % ("\n".join(matches),))
 
2521
            print "Warning: the following files are version controlled and" \
 
2522
                  " match your ignore pattern:\n%s" \
 
2523
                  "\nThese files will continue to be version controlled" \
 
2524
                  " unless you 'bzr remove' them." % ("\n".join(matches),)
2731
2525
 
2732
2526
 
2733
2527
class cmd_ignored(Command):
2734
 
    __doc__ = """List ignored files and the patterns that matched them.
 
2528
    """List ignored files and the patterns that matched them.
2735
2529
 
2736
2530
    List all the ignored files and the ignore pattern that caused the file to
2737
2531
    be ignored.
2743
2537
 
2744
2538
    encoding_type = 'replace'
2745
2539
    _see_also = ['ignore', 'ls']
2746
 
    takes_options = ['directory']
2747
2540
 
2748
2541
    @display_command
2749
 
    def run(self, directory=u'.'):
2750
 
        tree = WorkingTree.open_containing(directory)[0]
2751
 
        self.add_cleanup(tree.lock_read().unlock)
2752
 
        for path, file_class, kind, file_id, entry in tree.list_files():
2753
 
            if file_class != 'I':
2754
 
                continue
2755
 
            ## XXX: Slightly inefficient since this was already calculated
2756
 
            pat = tree.is_ignored(path)
2757
 
            self.outf.write('%-50s %s\n' % (path, pat))
 
2542
    def run(self):
 
2543
        tree = WorkingTree.open_containing(u'.')[0]
 
2544
        tree.lock_read()
 
2545
        try:
 
2546
            for path, file_class, kind, file_id, entry in tree.list_files():
 
2547
                if file_class != 'I':
 
2548
                    continue
 
2549
                ## XXX: Slightly inefficient since this was already calculated
 
2550
                pat = tree.is_ignored(path)
 
2551
                self.outf.write('%-50s %s\n' % (path, pat))
 
2552
        finally:
 
2553
            tree.unlock()
2758
2554
 
2759
2555
 
2760
2556
class cmd_lookup_revision(Command):
2761
 
    __doc__ = """Lookup the revision-id from a revision-number
 
2557
    """Lookup the revision-id from a revision-number
2762
2558
 
2763
2559
    :Examples:
2764
2560
        bzr lookup-revision 33
2765
2561
    """
2766
2562
    hidden = True
2767
2563
    takes_args = ['revno']
2768
 
    takes_options = ['directory']
2769
2564
 
2770
2565
    @display_command
2771
 
    def run(self, revno, directory=u'.'):
 
2566
    def run(self, revno):
2772
2567
        try:
2773
2568
            revno = int(revno)
2774
2569
        except ValueError:
2775
 
            raise errors.BzrCommandError("not a valid revision-number: %r"
2776
 
                                         % revno)
2777
 
        revid = WorkingTree.open_containing(directory)[0].branch.get_rev_id(revno)
2778
 
        self.outf.write("%s\n" % revid)
 
2570
            raise errors.BzrCommandError("not a valid revision-number: %r" % revno)
 
2571
 
 
2572
        print WorkingTree.open_containing(u'.')[0].branch.get_rev_id(revno)
2779
2573
 
2780
2574
 
2781
2575
class cmd_export(Command):
2782
 
    __doc__ = """Export current or past revision to a destination directory or archive.
 
2576
    """Export current or past revision to a destination directory or archive.
2783
2577
 
2784
2578
    If no revision is specified this exports the last committed revision.
2785
2579
 
2807
2601
      =================       =========================
2808
2602
    """
2809
2603
    takes_args = ['dest', 'branch_or_subdir?']
2810
 
    takes_options = ['directory',
 
2604
    takes_options = [
2811
2605
        Option('format',
2812
2606
               help="Type of file to export to.",
2813
2607
               type=unicode),
2817
2611
        Option('root',
2818
2612
               type=str,
2819
2613
               help="Name of the root directory inside the exported file."),
2820
 
        Option('per-file-timestamps',
2821
 
               help='Set modification time of files to that of the last '
2822
 
                    'revision in which it was changed.'),
2823
2614
        ]
2824
2615
    def run(self, dest, branch_or_subdir=None, revision=None, format=None,
2825
 
        root=None, filters=False, per_file_timestamps=False, directory=u'.'):
 
2616
        root=None, filters=False):
2826
2617
        from bzrlib.export import export
2827
2618
 
2828
2619
        if branch_or_subdir is None:
2829
 
            tree = WorkingTree.open_containing(directory)[0]
 
2620
            tree = WorkingTree.open_containing(u'.')[0]
2830
2621
            b = tree.branch
2831
2622
            subdir = None
2832
2623
        else:
2835
2626
 
2836
2627
        rev_tree = _get_one_revision_tree('export', revision, branch=b, tree=tree)
2837
2628
        try:
2838
 
            export(rev_tree, dest, format, root, subdir, filtered=filters,
2839
 
                   per_file_timestamps=per_file_timestamps)
 
2629
            export(rev_tree, dest, format, root, subdir, filtered=filters)
2840
2630
        except errors.NoSuchExportFormat, e:
2841
2631
            raise errors.BzrCommandError('Unsupported export format: %s' % e.format)
2842
2632
 
2843
2633
 
2844
2634
class cmd_cat(Command):
2845
 
    __doc__ = """Write the contents of a file as of a given revision to standard output.
 
2635
    """Write the contents of a file as of a given revision to standard output.
2846
2636
 
2847
2637
    If no revision is nominated, the last revision is used.
2848
2638
 
2851
2641
    """
2852
2642
 
2853
2643
    _see_also = ['ls']
2854
 
    takes_options = ['directory',
 
2644
    takes_options = [
2855
2645
        Option('name-from-revision', help='The path name in the old tree.'),
2856
2646
        Option('filters', help='Apply content filters to display the '
2857
2647
                'convenience form.'),
2862
2652
 
2863
2653
    @display_command
2864
2654
    def run(self, filename, revision=None, name_from_revision=False,
2865
 
            filters=False, directory=None):
 
2655
            filters=False):
2866
2656
        if revision is not None and len(revision) != 1:
2867
2657
            raise errors.BzrCommandError("bzr cat --revision takes exactly"
2868
2658
                                         " one revision specifier")
2869
2659
        tree, branch, relpath = \
2870
 
            _open_directory_or_containing_tree_or_branch(filename, directory)
2871
 
        self.add_cleanup(branch.lock_read().unlock)
2872
 
        return self._run(tree, branch, relpath, filename, revision,
2873
 
                         name_from_revision, filters)
 
2660
            bzrdir.BzrDir.open_containing_tree_or_branch(filename)
 
2661
        branch.lock_read()
 
2662
        try:
 
2663
            return self._run(tree, branch, relpath, filename, revision,
 
2664
                             name_from_revision, filters)
 
2665
        finally:
 
2666
            branch.unlock()
2874
2667
 
2875
2668
    def _run(self, tree, b, relpath, filename, revision, name_from_revision,
2876
2669
        filtered):
2877
2670
        if tree is None:
2878
2671
            tree = b.basis_tree()
2879
2672
        rev_tree = _get_one_revision_tree('cat', revision, branch=b)
2880
 
        self.add_cleanup(rev_tree.lock_read().unlock)
2881
2673
 
2882
2674
        old_file_id = rev_tree.path2id(relpath)
2883
2675
 
2918
2710
            chunks = content.splitlines(True)
2919
2711
            content = filtered_output_bytes(chunks, filters,
2920
2712
                ContentFilterContext(relpath, rev_tree))
2921
 
            self.cleanup_now()
2922
2713
            self.outf.writelines(content)
2923
2714
        else:
2924
 
            self.cleanup_now()
2925
2715
            self.outf.write(content)
2926
2716
 
2927
2717
 
2928
2718
class cmd_local_time_offset(Command):
2929
 
    __doc__ = """Show the offset in seconds from GMT to local time."""
 
2719
    """Show the offset in seconds from GMT to local time."""
2930
2720
    hidden = True
2931
2721
    @display_command
2932
2722
    def run(self):
2933
 
        self.outf.write("%s\n" % osutils.local_time_offset())
 
2723
        print osutils.local_time_offset()
2934
2724
 
2935
2725
 
2936
2726
 
2937
2727
class cmd_commit(Command):
2938
 
    __doc__ = """Commit changes into a new revision.
2939
 
 
2940
 
    An explanatory message needs to be given for each commit. This is
2941
 
    often done by using the --message option (getting the message from the
2942
 
    command line) or by using the --file option (getting the message from
2943
 
    a file). If neither of these options is given, an editor is opened for
2944
 
    the user to enter the message. To see the changed files in the
2945
 
    boilerplate text loaded into the editor, use the --show-diff option.
2946
 
 
2947
 
    By default, the entire tree is committed and the person doing the
2948
 
    commit is assumed to be the author. These defaults can be overridden
2949
 
    as explained below.
2950
 
 
2951
 
    :Selective commits:
2952
 
 
2953
 
      If selected files are specified, only changes to those files are
2954
 
      committed.  If a directory is specified then the directory and
2955
 
      everything within it is committed.
2956
 
  
2957
 
      When excludes are given, they take precedence over selected files.
2958
 
      For example, to commit only changes within foo, but not changes
2959
 
      within foo/bar::
2960
 
  
2961
 
        bzr commit foo -x foo/bar
2962
 
  
2963
 
      A selective commit after a merge is not yet supported.
2964
 
 
2965
 
    :Custom authors:
2966
 
 
2967
 
      If the author of the change is not the same person as the committer,
2968
 
      you can specify the author's name using the --author option. The
2969
 
      name should be in the same format as a committer-id, e.g.
2970
 
      "John Doe <jdoe@example.com>". If there is more than one author of
2971
 
      the change you can specify the option multiple times, once for each
2972
 
      author.
2973
 
  
2974
 
    :Checks:
2975
 
 
2976
 
      A common mistake is to forget to add a new file or directory before
2977
 
      running the commit command. The --strict option checks for unknown
2978
 
      files and aborts the commit if any are found. More advanced pre-commit
2979
 
      checks can be implemented by defining hooks. See ``bzr help hooks``
2980
 
      for details.
2981
 
 
2982
 
    :Things to note:
2983
 
 
2984
 
      If you accidentially commit the wrong changes or make a spelling
2985
 
      mistake in the commit message say, you can use the uncommit command
2986
 
      to undo it. See ``bzr help uncommit`` for details.
2987
 
 
2988
 
      Hooks can also be configured to run after a commit. This allows you
2989
 
      to trigger updates to external systems like bug trackers. The --fixes
2990
 
      option can be used to record the association between a revision and
2991
 
      one or more bugs. See ``bzr help bugs`` for details.
2992
 
 
2993
 
      A selective commit may fail in some cases where the committed
2994
 
      tree would be invalid. Consider::
2995
 
  
2996
 
        bzr init foo
2997
 
        mkdir foo/bar
2998
 
        bzr add foo/bar
2999
 
        bzr commit foo -m "committing foo"
3000
 
        bzr mv foo/bar foo/baz
3001
 
        mkdir foo/bar
3002
 
        bzr add foo/bar
3003
 
        bzr commit foo/bar -m "committing bar but not baz"
3004
 
  
3005
 
      In the example above, the last commit will fail by design. This gives
3006
 
      the user the opportunity to decide whether they want to commit the
3007
 
      rename at the same time, separately first, or not at all. (As a general
3008
 
      rule, when in doubt, Bazaar has a policy of Doing the Safe Thing.)
 
2728
    """Commit changes into a new revision.
 
2729
 
 
2730
    If no arguments are given, the entire tree is committed.
 
2731
 
 
2732
    If selected files are specified, only changes to those files are
 
2733
    committed.  If a directory is specified then the directory and everything
 
2734
    within it is committed.
 
2735
 
 
2736
    When excludes are given, they take precedence over selected files.
 
2737
    For example, too commit only changes within foo, but not changes within
 
2738
    foo/bar::
 
2739
 
 
2740
      bzr commit foo -x foo/bar
 
2741
 
 
2742
    If author of the change is not the same person as the committer, you can
 
2743
    specify the author's name using the --author option. The name should be
 
2744
    in the same format as a committer-id, e.g. "John Doe <jdoe@example.com>".
 
2745
    If there is more than one author of the change you can specify the option
 
2746
    multiple times, once for each author.
 
2747
 
 
2748
    A selected-file commit may fail in some cases where the committed
 
2749
    tree would be invalid. Consider::
 
2750
 
 
2751
      bzr init foo
 
2752
      mkdir foo/bar
 
2753
      bzr add foo/bar
 
2754
      bzr commit foo -m "committing foo"
 
2755
      bzr mv foo/bar foo/baz
 
2756
      mkdir foo/bar
 
2757
      bzr add foo/bar
 
2758
      bzr commit foo/bar -m "committing bar but not baz"
 
2759
 
 
2760
    In the example above, the last commit will fail by design. This gives
 
2761
    the user the opportunity to decide whether they want to commit the
 
2762
    rename at the same time, separately first, or not at all. (As a general
 
2763
    rule, when in doubt, Bazaar has a policy of Doing the Safe Thing.)
 
2764
 
 
2765
    Note: A selected-file commit after a merge is not yet supported.
3009
2766
    """
3010
2767
    # TODO: Run hooks on tree to-be-committed, and after commit.
3011
2768
 
3016
2773
 
3017
2774
    # XXX: verbose currently does nothing
3018
2775
 
3019
 
    _see_also = ['add', 'bugs', 'hooks', 'uncommit']
 
2776
    _see_also = ['bugs', 'uncommit']
3020
2777
    takes_args = ['selected*']
3021
2778
    takes_options = [
3022
2779
            ListOption('exclude', type=str, short_name='x',
3034
2791
             Option('strict',
3035
2792
                    help="Refuse to commit if there are unknown "
3036
2793
                    "files in the working tree."),
3037
 
             Option('commit-time', type=str,
3038
 
                    help="Manually set a commit time using commit date "
3039
 
                    "format, e.g. '2009-10-10 08:00:00 +0100'."),
3040
2794
             ListOption('fixes', type=str,
3041
2795
                    help="Mark a bug as being fixed by this revision "
3042
2796
                         "(see \"bzr help bugs\")."),
3049
2803
                         "the master branch until a normal commit "
3050
2804
                         "is performed."
3051
2805
                    ),
3052
 
             Option('show-diff', short_name='p',
3053
 
                    help='When no message is supplied, show the diff along'
3054
 
                    ' with the status summary in the message editor.'),
 
2806
              Option('show-diff',
 
2807
                     help='When no message is supplied, show the diff along'
 
2808
                     ' with the status summary in the message editor.'),
3055
2809
             ]
3056
2810
    aliases = ['ci', 'checkin']
3057
2811
 
3076
2830
 
3077
2831
    def run(self, message=None, file=None, verbose=False, selected_list=None,
3078
2832
            unchanged=False, strict=False, local=False, fixes=None,
3079
 
            author=None, show_diff=False, exclude=None, commit_time=None):
 
2833
            author=None, show_diff=False, exclude=None):
3080
2834
        from bzrlib.errors import (
3081
2835
            PointlessCommit,
3082
2836
            ConflictsInTree,
3088
2842
            make_commit_message_template_encoded
3089
2843
        )
3090
2844
 
3091
 
        commit_stamp = offset = None
3092
 
        if commit_time is not None:
3093
 
            try:
3094
 
                commit_stamp, offset = timestamp.parse_patch_date(commit_time)
3095
 
            except ValueError, e:
3096
 
                raise errors.BzrCommandError(
3097
 
                    "Could not parse --commit-time: " + str(e))
3098
 
 
3099
2845
        # TODO: Need a blackbox test for invoking the external editor; may be
3100
2846
        # slightly problematic to run this cross-platform.
3101
2847
 
3121
2867
        if local and not tree.branch.get_bound_location():
3122
2868
            raise errors.LocalRequiresBoundBranch()
3123
2869
 
3124
 
        if message is not None:
3125
 
            try:
3126
 
                file_exists = osutils.lexists(message)
3127
 
            except UnicodeError:
3128
 
                # The commit message contains unicode characters that can't be
3129
 
                # represented in the filesystem encoding, so that can't be a
3130
 
                # file.
3131
 
                file_exists = False
3132
 
            if file_exists:
3133
 
                warning_msg = (
3134
 
                    'The commit message is a file name: "%(f)s".\n'
3135
 
                    '(use --file "%(f)s" to take commit message from that file)'
3136
 
                    % { 'f': message })
3137
 
                ui.ui_factory.show_warning(warning_msg)
3138
 
            if '\r' in message:
3139
 
                message = message.replace('\r\n', '\n')
3140
 
                message = message.replace('\r', '\n')
3141
 
            if file:
3142
 
                raise errors.BzrCommandError(
3143
 
                    "please specify either --message or --file")
3144
 
 
3145
2870
        def get_message(commit_obj):
3146
2871
            """Callback to get commit message"""
3147
 
            if file:
3148
 
                f = codecs.open(file, 'rt', osutils.get_user_encoding())
3149
 
                try:
3150
 
                    my_message = f.read()
3151
 
                finally:
3152
 
                    f.close()
3153
 
            elif message is not None:
3154
 
                my_message = message
3155
 
            else:
3156
 
                # No message supplied: make one up.
3157
 
                # text is the status of the tree
3158
 
                text = make_commit_message_template_encoded(tree,
 
2872
            my_message = message
 
2873
            if my_message is None and not file:
 
2874
                t = make_commit_message_template_encoded(tree,
3159
2875
                        selected_list, diff=show_diff,
3160
2876
                        output_encoding=osutils.get_user_encoding())
3161
 
                # start_message is the template generated from hooks
3162
 
                # XXX: Warning - looks like hooks return unicode,
3163
 
                # make_commit_message_template_encoded returns user encoding.
3164
 
                # We probably want to be using edit_commit_message instead to
3165
 
                # avoid this.
3166
2877
                start_message = generate_commit_message_template(commit_obj)
3167
 
                my_message = edit_commit_message_encoded(text,
 
2878
                my_message = edit_commit_message_encoded(t,
3168
2879
                    start_message=start_message)
3169
2880
                if my_message is None:
3170
2881
                    raise errors.BzrCommandError("please specify a commit"
3171
2882
                        " message with either --message or --file")
 
2883
            elif my_message and file:
 
2884
                raise errors.BzrCommandError(
 
2885
                    "please specify either --message or --file")
 
2886
            if file:
 
2887
                my_message = codecs.open(file, 'rt',
 
2888
                                         osutils.get_user_encoding()).read()
3172
2889
            if my_message == "":
3173
2890
                raise errors.BzrCommandError("empty commit message specified")
3174
2891
            return my_message
3175
2892
 
3176
 
        # The API permits a commit with a filter of [] to mean 'select nothing'
3177
 
        # but the command line should not do that.
3178
 
        if not selected_list:
3179
 
            selected_list = None
3180
2893
        try:
3181
2894
            tree.commit(message_callback=get_message,
3182
2895
                        specific_files=selected_list,
3183
2896
                        allow_pointless=unchanged, strict=strict, local=local,
3184
2897
                        reporter=None, verbose=verbose, revprops=properties,
3185
 
                        authors=author, timestamp=commit_stamp,
3186
 
                        timezone=offset,
 
2898
                        authors=author,
3187
2899
                        exclude=safe_relpath_files(tree, exclude))
3188
2900
        except PointlessCommit:
3189
 
            raise errors.BzrCommandError("No changes to commit."
3190
 
                              " Use --unchanged to commit anyhow.")
 
2901
            # FIXME: This should really happen before the file is read in;
 
2902
            # perhaps prepare the commit; get the message; then actually commit
 
2903
            raise errors.BzrCommandError("no changes to commit."
 
2904
                              " use --unchanged to commit anyhow")
3191
2905
        except ConflictsInTree:
3192
2906
            raise errors.BzrCommandError('Conflicts detected in working '
3193
2907
                'tree.  Use "bzr conflicts" to list, "bzr resolve FILE" to'
3196
2910
            raise errors.BzrCommandError("Commit refused because there are"
3197
2911
                              " unknown files in the working tree.")
3198
2912
        except errors.BoundBranchOutOfDate, e:
3199
 
            e.extra_help = ("\n"
3200
 
                'To commit to master branch, run update and then commit.\n'
3201
 
                'You can also pass --local to commit to continue working '
3202
 
                'disconnected.')
3203
 
            raise
 
2913
            raise errors.BzrCommandError(str(e) + "\n"
 
2914
            'To commit to master branch, run update and then commit.\n'
 
2915
            'You can also pass --local to commit to continue working '
 
2916
            'disconnected.')
3204
2917
 
3205
2918
 
3206
2919
class cmd_check(Command):
3207
 
    __doc__ = """Validate working tree structure, branch consistency and repository history.
 
2920
    """Validate working tree structure, branch consistency and repository history.
3208
2921
 
3209
2922
    This command checks various invariants about branch and repository storage
3210
2923
    to detect data corruption or bzr bugs.
3212
2925
    The working tree and branch checks will only give output if a problem is
3213
2926
    detected. The output fields of the repository check are:
3214
2927
 
3215
 
    revisions
3216
 
        This is just the number of revisions checked.  It doesn't
3217
 
        indicate a problem.
3218
 
 
3219
 
    versionedfiles
3220
 
        This is just the number of versionedfiles checked.  It
3221
 
        doesn't indicate a problem.
3222
 
 
3223
 
    unreferenced ancestors
3224
 
        Texts that are ancestors of other texts, but
3225
 
        are not properly referenced by the revision ancestry.  This is a
3226
 
        subtle problem that Bazaar can work around.
3227
 
 
3228
 
    unique file texts
3229
 
        This is the total number of unique file contents
3230
 
        seen in the checked revisions.  It does not indicate a problem.
3231
 
 
3232
 
    repeated file texts
3233
 
        This is the total number of repeated texts seen
3234
 
        in the checked revisions.  Texts can be repeated when their file
3235
 
        entries are modified, but the file contents are not.  It does not
3236
 
        indicate a problem.
 
2928
        revisions: This is just the number of revisions checked.  It doesn't
 
2929
            indicate a problem.
 
2930
        versionedfiles: This is just the number of versionedfiles checked.  It
 
2931
            doesn't indicate a problem.
 
2932
        unreferenced ancestors: Texts that are ancestors of other texts, but
 
2933
            are not properly referenced by the revision ancestry.  This is a
 
2934
            subtle problem that Bazaar can work around.
 
2935
        unique file texts: This is the total number of unique file contents
 
2936
            seen in the checked revisions.  It does not indicate a problem.
 
2937
        repeated file texts: This is the total number of repeated texts seen
 
2938
            in the checked revisions.  Texts can be repeated when their file
 
2939
            entries are modified, but the file contents are not.  It does not
 
2940
            indicate a problem.
3237
2941
 
3238
2942
    If no restrictions are specified, all Bazaar data that is found at the given
3239
2943
    location will be checked.
3274
2978
 
3275
2979
 
3276
2980
class cmd_upgrade(Command):
3277
 
    __doc__ = """Upgrade branch storage to current format.
 
2981
    """Upgrade branch storage to current format.
3278
2982
 
3279
2983
    The check command or bzr developers may sometimes advise you to run
3280
2984
    this command. When the default format has changed you may also be warned
3298
3002
 
3299
3003
 
3300
3004
class cmd_whoami(Command):
3301
 
    __doc__ = """Show or set bzr user id.
 
3005
    """Show or set bzr user id.
3302
3006
 
3303
3007
    :Examples:
3304
3008
        Show the email of the current user::
3348
3052
 
3349
3053
 
3350
3054
class cmd_nick(Command):
3351
 
    __doc__ = """Print or set the branch nickname.
 
3055
    """Print or set the branch nickname.
3352
3056
 
3353
3057
    If unset, the tree root directory name is used as the nickname.
3354
3058
    To print the current nickname, execute with no argument.
3359
3063
 
3360
3064
    _see_also = ['info']
3361
3065
    takes_args = ['nickname?']
3362
 
    takes_options = ['directory']
3363
 
    def run(self, nickname=None, directory=u'.'):
3364
 
        branch = Branch.open_containing(directory)[0]
 
3066
    def run(self, nickname=None):
 
3067
        branch = Branch.open_containing(u'.')[0]
3365
3068
        if nickname is None:
3366
3069
            self.printme(branch)
3367
3070
        else:
3369
3072
 
3370
3073
    @display_command
3371
3074
    def printme(self, branch):
3372
 
        self.outf.write('%s\n' % branch.nick)
 
3075
        print branch.nick
3373
3076
 
3374
3077
 
3375
3078
class cmd_alias(Command):
3376
 
    __doc__ = """Set/unset and display aliases.
 
3079
    """Set/unset and display aliases.
3377
3080
 
3378
3081
    :Examples:
3379
3082
        Show the current aliases::
3443
3146
 
3444
3147
 
3445
3148
class cmd_selftest(Command):
3446
 
    __doc__ = """Run internal test suite.
 
3149
    """Run internal test suite.
3447
3150
 
3448
3151
    If arguments are given, they are regular expressions that say which tests
3449
3152
    should run.  Tests matching any expression are run, and other tests are
3476
3179
    Tests that need working space on disk use a common temporary directory,
3477
3180
    typically inside $TMPDIR or /tmp.
3478
3181
 
3479
 
    If you set BZR_TEST_PDB=1 when running selftest, failing tests will drop
3480
 
    into a pdb postmortem session.
3481
 
 
3482
3182
    :Examples:
3483
3183
        Run only tests relating to 'ignore'::
3484
3184
 
3493
3193
    def get_transport_type(typestring):
3494
3194
        """Parse and return a transport specifier."""
3495
3195
        if typestring == "sftp":
3496
 
            from bzrlib.tests import stub_sftp
3497
 
            return stub_sftp.SFTPAbsoluteServer
 
3196
            from bzrlib.transport.sftp import SFTPAbsoluteServer
 
3197
            return SFTPAbsoluteServer
3498
3198
        if typestring == "memory":
3499
 
            from bzrlib.tests import test_server
3500
 
            return memory.MemoryServer
 
3199
            from bzrlib.transport.memory import MemoryServer
 
3200
            return MemoryServer
3501
3201
        if typestring == "fakenfs":
3502
 
            from bzrlib.tests import test_server
3503
 
            return test_server.FakeNFSServer
 
3202
            from bzrlib.transport.fakenfs import FakeNFSServer
 
3203
            return FakeNFSServer
3504
3204
        msg = "No known transport type %s. Supported types are: sftp\n" %\
3505
3205
            (typestring)
3506
3206
        raise errors.BzrCommandError(msg)
3521
3221
                     Option('lsprof-timed',
3522
3222
                            help='Generate lsprof output for benchmarked'
3523
3223
                                 ' sections of code.'),
3524
 
                     Option('lsprof-tests',
3525
 
                            help='Generate lsprof output for each test.'),
3526
3224
                     Option('cache-dir', type=str,
3527
3225
                            help='Cache intermediate benchmark output in this '
3528
3226
                                 'directory.'),
3569
3267
            first=False, list_only=False,
3570
3268
            randomize=None, exclude=None, strict=False,
3571
3269
            load_list=None, debugflag=None, starting_with=None, subunit=False,
3572
 
            parallel=None, lsprof_tests=False):
 
3270
            parallel=None):
3573
3271
        from bzrlib.tests import selftest
3574
3272
        import bzrlib.benchmarks as benchmarks
3575
3273
        from bzrlib.benchmarks import tree_creator
3590
3288
                raise errors.BzrCommandError("subunit not available. subunit "
3591
3289
                    "needs to be installed to use --subunit.")
3592
3290
            self.additional_selftest_args['runner_class'] = SubUnitBzrRunner
3593
 
            # On Windows, disable automatic conversion of '\n' to '\r\n' in
3594
 
            # stdout, which would corrupt the subunit stream. 
3595
 
            # FIXME: This has been fixed in subunit trunk (>0.0.5) so the
3596
 
            # following code can be deleted when it's sufficiently deployed
3597
 
            # -- vila/mgz 20100514
3598
 
            if (sys.platform == "win32"
3599
 
                and getattr(sys.stdout, 'fileno', None) is not None):
3600
 
                import msvcrt
3601
 
                msvcrt.setmode(sys.stdout.fileno(), os.O_BINARY)
3602
3291
        if parallel:
3603
3292
            self.additional_selftest_args.setdefault(
3604
3293
                'suite_decorators', []).append(parallel)
3608
3297
            verbose = not is_quiet()
3609
3298
            # TODO: should possibly lock the history file...
3610
3299
            benchfile = open(".perf_history", "at", buffering=1)
3611
 
            self.add_cleanup(benchfile.close)
3612
3300
        else:
3613
3301
            test_suite_factory = None
3614
3302
            benchfile = None
3615
 
        selftest_kwargs = {"verbose": verbose,
3616
 
                          "pattern": pattern,
3617
 
                          "stop_on_failure": one,
3618
 
                          "transport": transport,
3619
 
                          "test_suite_factory": test_suite_factory,
3620
 
                          "lsprof_timed": lsprof_timed,
3621
 
                          "lsprof_tests": lsprof_tests,
3622
 
                          "bench_history": benchfile,
3623
 
                          "matching_tests_first": first,
3624
 
                          "list_only": list_only,
3625
 
                          "random_seed": randomize,
3626
 
                          "exclude_pattern": exclude,
3627
 
                          "strict": strict,
3628
 
                          "load_list": load_list,
3629
 
                          "debug_flags": debugflag,
3630
 
                          "starting_with": starting_with
3631
 
                          }
3632
 
        selftest_kwargs.update(self.additional_selftest_args)
3633
 
        result = selftest(**selftest_kwargs)
 
3303
        try:
 
3304
            selftest_kwargs = {"verbose": verbose,
 
3305
                              "pattern": pattern,
 
3306
                              "stop_on_failure": one,
 
3307
                              "transport": transport,
 
3308
                              "test_suite_factory": test_suite_factory,
 
3309
                              "lsprof_timed": lsprof_timed,
 
3310
                              "bench_history": benchfile,
 
3311
                              "matching_tests_first": first,
 
3312
                              "list_only": list_only,
 
3313
                              "random_seed": randomize,
 
3314
                              "exclude_pattern": exclude,
 
3315
                              "strict": strict,
 
3316
                              "load_list": load_list,
 
3317
                              "debug_flags": debugflag,
 
3318
                              "starting_with": starting_with
 
3319
                              }
 
3320
            selftest_kwargs.update(self.additional_selftest_args)
 
3321
            result = selftest(**selftest_kwargs)
 
3322
        finally:
 
3323
            if benchfile is not None:
 
3324
                benchfile.close()
3634
3325
        return int(not result)
3635
3326
 
3636
3327
 
3637
3328
class cmd_version(Command):
3638
 
    __doc__ = """Show version of bzr."""
 
3329
    """Show version of bzr."""
3639
3330
 
3640
3331
    encoding_type = 'replace'
3641
3332
    takes_options = [
3652
3343
 
3653
3344
 
3654
3345
class cmd_rocks(Command):
3655
 
    __doc__ = """Statement of optimism."""
 
3346
    """Statement of optimism."""
3656
3347
 
3657
3348
    hidden = True
3658
3349
 
3659
3350
    @display_command
3660
3351
    def run(self):
3661
 
        self.outf.write("It sure does!\n")
 
3352
        print "It sure does!"
3662
3353
 
3663
3354
 
3664
3355
class cmd_find_merge_base(Command):
3665
 
    __doc__ = """Find and print a base revision for merging two branches."""
 
3356
    """Find and print a base revision for merging two branches."""
3666
3357
    # TODO: Options to specify revisions on either side, as if
3667
3358
    #       merging only part of the history.
3668
3359
    takes_args = ['branch', 'other']
3674
3365
 
3675
3366
        branch1 = Branch.open_containing(branch)[0]
3676
3367
        branch2 = Branch.open_containing(other)[0]
3677
 
        self.add_cleanup(branch1.lock_read().unlock)
3678
 
        self.add_cleanup(branch2.lock_read().unlock)
3679
 
        last1 = ensure_null(branch1.last_revision())
3680
 
        last2 = ensure_null(branch2.last_revision())
3681
 
 
3682
 
        graph = branch1.repository.get_graph(branch2.repository)
3683
 
        base_rev_id = graph.find_unique_lca(last1, last2)
3684
 
 
3685
 
        self.outf.write('merge base is revision %s\n' % base_rev_id)
 
3368
        branch1.lock_read()
 
3369
        try:
 
3370
            branch2.lock_read()
 
3371
            try:
 
3372
                last1 = ensure_null(branch1.last_revision())
 
3373
                last2 = ensure_null(branch2.last_revision())
 
3374
 
 
3375
                graph = branch1.repository.get_graph(branch2.repository)
 
3376
                base_rev_id = graph.find_unique_lca(last1, last2)
 
3377
 
 
3378
                print 'merge base is revision %s' % base_rev_id
 
3379
            finally:
 
3380
                branch2.unlock()
 
3381
        finally:
 
3382
            branch1.unlock()
3686
3383
 
3687
3384
 
3688
3385
class cmd_merge(Command):
3689
 
    __doc__ = """Perform a three-way merge.
 
3386
    """Perform a three-way merge.
3690
3387
 
3691
3388
    The source of the merge can be specified either in the form of a branch,
3692
3389
    or in the form of a path to a file containing a merge directive generated
3721
3418
    committed to record the result of the merge.
3722
3419
 
3723
3420
    merge refuses to run if there are any uncommitted changes, unless
3724
 
    --force is given. The --force option can also be used to create a
3725
 
    merge revision which has more than two parents.
3726
 
 
3727
 
    If one would like to merge changes from the working tree of the other
3728
 
    branch without merging any committed revisions, the --uncommitted option
3729
 
    can be given.
3730
 
 
3731
 
    To select only some changes to merge, use "merge -i", which will prompt
3732
 
    you to apply each diff hunk and file change, similar to "shelve".
 
3421
    --force is given.
3733
3422
 
3734
3423
    :Examples:
3735
3424
        To merge the latest revision from bzr.dev::
3744
3433
 
3745
3434
            bzr merge -r 81..82 ../bzr.dev
3746
3435
 
3747
 
        To apply a merge directive contained in /tmp/merge::
 
3436
        To apply a merge directive contained in /tmp/merge:
3748
3437
 
3749
3438
            bzr merge /tmp/merge
3750
 
 
3751
 
        To create a merge revision with three parents from two branches
3752
 
        feature1a and feature1b:
3753
 
 
3754
 
            bzr merge ../feature1a
3755
 
            bzr merge ../feature1b --force
3756
 
            bzr commit -m 'revision with three parents'
3757
3439
    """
3758
3440
 
3759
3441
    encoding_type = 'exact'
3775
3457
                ' completely merged into the source, pull from the'
3776
3458
                ' source rather than merging.  When this happens,'
3777
3459
                ' you do not need to commit the result.'),
3778
 
        custom_help('directory',
 
3460
        Option('directory',
3779
3461
               help='Branch to merge into, '
3780
 
                    'rather than the one containing the working directory.'),
3781
 
        Option('preview', help='Instead of merging, show a diff of the'
3782
 
               ' merge.'),
3783
 
        Option('interactive', help='Select changes interactively.',
3784
 
            short_name='i')
 
3462
                    'rather than the one containing the working directory.',
 
3463
               short_name='d',
 
3464
               type=unicode,
 
3465
               ),
 
3466
        Option('preview', help='Instead of merging, show a diff of the merge.')
3785
3467
    ]
3786
3468
 
3787
3469
    def run(self, location=None, revision=None, force=False,
3789
3471
            uncommitted=False, pull=False,
3790
3472
            directory=None,
3791
3473
            preview=False,
3792
 
            interactive=False,
3793
3474
            ):
3794
3475
        if merge_type is None:
3795
3476
            merge_type = _mod_merge.Merge3Merger
3801
3482
        verified = 'inapplicable'
3802
3483
        tree = WorkingTree.open_containing(directory)[0]
3803
3484
 
 
3485
        # die as quickly as possible if there are uncommitted changes
3804
3486
        try:
3805
3487
            basis_tree = tree.revision_tree(tree.last_revision())
3806
3488
        except errors.NoSuchRevision:
3807
3489
            basis_tree = tree.basis_tree()
3808
 
 
3809
 
        # die as quickly as possible if there are uncommitted changes
3810
3490
        if not force:
3811
 
            if tree.has_changes():
 
3491
            changes = tree.changes_from(basis_tree)
 
3492
            if changes.has_changed():
3812
3493
                raise errors.UncommittedChanges(tree)
3813
3494
 
3814
3495
        view_info = _get_view_info_for_change_reporter(tree)
3815
3496
        change_reporter = delta._ChangeReporter(
3816
3497
            unversioned_filter=tree.is_ignored, view_info=view_info)
3817
 
        pb = ui.ui_factory.nested_progress_bar()
3818
 
        self.add_cleanup(pb.finished)
3819
 
        self.add_cleanup(tree.lock_write().unlock)
3820
 
        if location is not None:
3821
 
            try:
3822
 
                mergeable = bundle.read_mergeable_from_url(location,
3823
 
                    possible_transports=possible_transports)
3824
 
            except errors.NotABundle:
3825
 
                mergeable = None
 
3498
        cleanups = []
 
3499
        try:
 
3500
            pb = ui.ui_factory.nested_progress_bar()
 
3501
            cleanups.append(pb.finished)
 
3502
            tree.lock_write()
 
3503
            cleanups.append(tree.unlock)
 
3504
            if location is not None:
 
3505
                try:
 
3506
                    mergeable = bundle.read_mergeable_from_url(location,
 
3507
                        possible_transports=possible_transports)
 
3508
                except errors.NotABundle:
 
3509
                    mergeable = None
 
3510
                else:
 
3511
                    if uncommitted:
 
3512
                        raise errors.BzrCommandError('Cannot use --uncommitted'
 
3513
                            ' with bundles or merge directives.')
 
3514
 
 
3515
                    if revision is not None:
 
3516
                        raise errors.BzrCommandError(
 
3517
                            'Cannot use -r with merge directives or bundles')
 
3518
                    merger, verified = _mod_merge.Merger.from_mergeable(tree,
 
3519
                       mergeable, pb)
 
3520
 
 
3521
            if merger is None and uncommitted:
 
3522
                if revision is not None and len(revision) > 0:
 
3523
                    raise errors.BzrCommandError('Cannot use --uncommitted and'
 
3524
                        ' --revision at the same time.')
 
3525
                location = self._select_branch_location(tree, location)[0]
 
3526
                other_tree, other_path = WorkingTree.open_containing(location)
 
3527
                merger = _mod_merge.Merger.from_uncommitted(tree, other_tree,
 
3528
                    pb)
 
3529
                allow_pending = False
 
3530
                if other_path != '':
 
3531
                    merger.interesting_files = [other_path]
 
3532
 
 
3533
            if merger is None:
 
3534
                merger, allow_pending = self._get_merger_from_branch(tree,
 
3535
                    location, revision, remember, possible_transports, pb)
 
3536
 
 
3537
            merger.merge_type = merge_type
 
3538
            merger.reprocess = reprocess
 
3539
            merger.show_base = show_base
 
3540
            self.sanity_check_merger(merger)
 
3541
            if (merger.base_rev_id == merger.other_rev_id and
 
3542
                merger.other_rev_id is not None):
 
3543
                note('Nothing to do.')
 
3544
                return 0
 
3545
            if pull:
 
3546
                if merger.interesting_files is not None:
 
3547
                    raise errors.BzrCommandError('Cannot pull individual files')
 
3548
                if (merger.base_rev_id == tree.last_revision()):
 
3549
                    result = tree.pull(merger.other_branch, False,
 
3550
                                       merger.other_rev_id)
 
3551
                    result.report(self.outf)
 
3552
                    return 0
 
3553
            merger.check_basis(False)
 
3554
            if preview:
 
3555
                return self._do_preview(merger)
3826
3556
            else:
3827
 
                if uncommitted:
3828
 
                    raise errors.BzrCommandError('Cannot use --uncommitted'
3829
 
                        ' with bundles or merge directives.')
3830
 
 
3831
 
                if revision is not None:
3832
 
                    raise errors.BzrCommandError(
3833
 
                        'Cannot use -r with merge directives or bundles')
3834
 
                merger, verified = _mod_merge.Merger.from_mergeable(tree,
3835
 
                   mergeable, None)
3836
 
 
3837
 
        if merger is None and uncommitted:
3838
 
            if revision is not None and len(revision) > 0:
3839
 
                raise errors.BzrCommandError('Cannot use --uncommitted and'
3840
 
                    ' --revision at the same time.')
3841
 
            merger = self.get_merger_from_uncommitted(tree, location, None)
3842
 
            allow_pending = False
3843
 
 
3844
 
        if merger is None:
3845
 
            merger, allow_pending = self._get_merger_from_branch(tree,
3846
 
                location, revision, remember, possible_transports, None)
3847
 
 
3848
 
        merger.merge_type = merge_type
3849
 
        merger.reprocess = reprocess
3850
 
        merger.show_base = show_base
3851
 
        self.sanity_check_merger(merger)
3852
 
        if (merger.base_rev_id == merger.other_rev_id and
3853
 
            merger.other_rev_id is not None):
3854
 
            note('Nothing to do.')
3855
 
            return 0
3856
 
        if pull:
3857
 
            if merger.interesting_files is not None:
3858
 
                raise errors.BzrCommandError('Cannot pull individual files')
3859
 
            if (merger.base_rev_id == tree.last_revision()):
3860
 
                result = tree.pull(merger.other_branch, False,
3861
 
                                   merger.other_rev_id)
3862
 
                result.report(self.outf)
3863
 
                return 0
3864
 
        if merger.this_basis is None:
3865
 
            raise errors.BzrCommandError(
3866
 
                "This branch has no commits."
3867
 
                " (perhaps you would prefer 'bzr pull')")
3868
 
        if preview:
3869
 
            return self._do_preview(merger)
3870
 
        elif interactive:
3871
 
            return self._do_interactive(merger)
3872
 
        else:
3873
 
            return self._do_merge(merger, change_reporter, allow_pending,
3874
 
                                  verified)
3875
 
 
3876
 
    def _get_preview(self, merger):
 
3557
                return self._do_merge(merger, change_reporter, allow_pending,
 
3558
                                      verified)
 
3559
        finally:
 
3560
            for cleanup in reversed(cleanups):
 
3561
                cleanup()
 
3562
 
 
3563
    def _do_preview(self, merger):
 
3564
        from bzrlib.diff import show_diff_trees
3877
3565
        tree_merger = merger.make_merger()
3878
3566
        tt = tree_merger.make_preview_transform()
3879
 
        self.add_cleanup(tt.finalize)
3880
 
        result_tree = tt.get_preview_tree()
3881
 
        return result_tree
3882
 
 
3883
 
    def _do_preview(self, merger):
3884
 
        from bzrlib.diff import show_diff_trees
3885
 
        result_tree = self._get_preview(merger)
3886
 
        show_diff_trees(merger.this_tree, result_tree, self.outf,
3887
 
                        old_label='', new_label='')
 
3567
        try:
 
3568
            result_tree = tt.get_preview_tree()
 
3569
            show_diff_trees(merger.this_tree, result_tree, self.outf,
 
3570
                            old_label='', new_label='')
 
3571
        finally:
 
3572
            tt.finalize()
3888
3573
 
3889
3574
    def _do_merge(self, merger, change_reporter, allow_pending, verified):
3890
3575
        merger.change_reporter = change_reporter
3898
3583
        else:
3899
3584
            return 0
3900
3585
 
3901
 
    def _do_interactive(self, merger):
3902
 
        """Perform an interactive merge.
3903
 
 
3904
 
        This works by generating a preview tree of the merge, then using
3905
 
        Shelver to selectively remove the differences between the working tree
3906
 
        and the preview tree.
3907
 
        """
3908
 
        from bzrlib import shelf_ui
3909
 
        result_tree = self._get_preview(merger)
3910
 
        writer = bzrlib.option.diff_writer_registry.get()
3911
 
        shelver = shelf_ui.Shelver(merger.this_tree, result_tree, destroy=True,
3912
 
                                   reporter=shelf_ui.ApplyReporter(),
3913
 
                                   diff_writer=writer(sys.stdout))
3914
 
        try:
3915
 
            shelver.run()
3916
 
        finally:
3917
 
            shelver.finalize()
3918
 
 
3919
3586
    def sanity_check_merger(self, merger):
3920
3587
        if (merger.show_base and
3921
3588
            not merger.merge_type is _mod_merge.Merge3Merger):
3956
3623
            base_branch, base_path = Branch.open_containing(base_loc,
3957
3624
                possible_transports)
3958
3625
        # Find the revision ids
3959
 
        other_revision_id = None
3960
 
        base_revision_id = None
3961
 
        if revision is not None:
3962
 
            if len(revision) >= 1:
3963
 
                other_revision_id = revision[-1].as_revision_id(other_branch)
3964
 
            if len(revision) == 2:
3965
 
                base_revision_id = revision[0].as_revision_id(base_branch)
3966
 
        if other_revision_id is None:
 
3626
        if revision is None or len(revision) < 1 or revision[-1] is None:
3967
3627
            other_revision_id = _mod_revision.ensure_null(
3968
3628
                other_branch.last_revision())
 
3629
        else:
 
3630
            other_revision_id = revision[-1].as_revision_id(other_branch)
 
3631
        if (revision is not None and len(revision) == 2
 
3632
            and revision[0] is not None):
 
3633
            base_revision_id = revision[0].as_revision_id(base_branch)
 
3634
        else:
 
3635
            base_revision_id = None
3969
3636
        # Remember where we merge from
3970
3637
        if ((remember or tree.branch.get_submit_branch() is None) and
3971
3638
             user_location is not None):
3980
3647
            allow_pending = True
3981
3648
        return merger, allow_pending
3982
3649
 
3983
 
    def get_merger_from_uncommitted(self, tree, location, pb):
3984
 
        """Get a merger for uncommitted changes.
3985
 
 
3986
 
        :param tree: The tree the merger should apply to.
3987
 
        :param location: The location containing uncommitted changes.
3988
 
        :param pb: The progress bar to use for showing progress.
3989
 
        """
3990
 
        location = self._select_branch_location(tree, location)[0]
3991
 
        other_tree, other_path = WorkingTree.open_containing(location)
3992
 
        merger = _mod_merge.Merger.from_uncommitted(tree, other_tree, pb)
3993
 
        if other_path != '':
3994
 
            merger.interesting_files = [other_path]
3995
 
        return merger
3996
 
 
3997
3650
    def _select_branch_location(self, tree, user_location, revision=None,
3998
3651
                                index=None):
3999
3652
        """Select a branch location, according to possible inputs.
4043
3696
 
4044
3697
 
4045
3698
class cmd_remerge(Command):
4046
 
    __doc__ = """Redo a merge.
 
3699
    """Redo a merge.
4047
3700
 
4048
3701
    Use this if you want to try a different merge technique while resolving
4049
3702
    conflicts.  Some merge techniques are better than others, and remerge
4074
3727
 
4075
3728
    def run(self, file_list=None, merge_type=None, show_base=False,
4076
3729
            reprocess=False):
4077
 
        from bzrlib.conflicts import restore
4078
3730
        if merge_type is None:
4079
3731
            merge_type = _mod_merge.Merge3Merger
4080
3732
        tree, file_list = tree_files(file_list)
4081
 
        self.add_cleanup(tree.lock_write().unlock)
4082
 
        parents = tree.get_parent_ids()
4083
 
        if len(parents) != 2:
4084
 
            raise errors.BzrCommandError("Sorry, remerge only works after normal"
4085
 
                                         " merges.  Not cherrypicking or"
4086
 
                                         " multi-merges.")
4087
 
        repository = tree.branch.repository
4088
 
        interesting_ids = None
4089
 
        new_conflicts = []
4090
 
        conflicts = tree.conflicts()
4091
 
        if file_list is not None:
4092
 
            interesting_ids = set()
4093
 
            for filename in file_list:
4094
 
                file_id = tree.path2id(filename)
4095
 
                if file_id is None:
4096
 
                    raise errors.NotVersionedError(filename)
4097
 
                interesting_ids.add(file_id)
4098
 
                if tree.kind(file_id) != "directory":
4099
 
                    continue
 
3733
        tree.lock_write()
 
3734
        try:
 
3735
            parents = tree.get_parent_ids()
 
3736
            if len(parents) != 2:
 
3737
                raise errors.BzrCommandError("Sorry, remerge only works after normal"
 
3738
                                             " merges.  Not cherrypicking or"
 
3739
                                             " multi-merges.")
 
3740
            repository = tree.branch.repository
 
3741
            interesting_ids = None
 
3742
            new_conflicts = []
 
3743
            conflicts = tree.conflicts()
 
3744
            if file_list is not None:
 
3745
                interesting_ids = set()
 
3746
                for filename in file_list:
 
3747
                    file_id = tree.path2id(filename)
 
3748
                    if file_id is None:
 
3749
                        raise errors.NotVersionedError(filename)
 
3750
                    interesting_ids.add(file_id)
 
3751
                    if tree.kind(file_id) != "directory":
 
3752
                        continue
4100
3753
 
4101
 
                for name, ie in tree.inventory.iter_entries(file_id):
4102
 
                    interesting_ids.add(ie.file_id)
4103
 
            new_conflicts = conflicts.select_conflicts(tree, file_list)[0]
4104
 
        else:
4105
 
            # Remerge only supports resolving contents conflicts
4106
 
            allowed_conflicts = ('text conflict', 'contents conflict')
4107
 
            restore_files = [c.path for c in conflicts
4108
 
                             if c.typestring in allowed_conflicts]
4109
 
        _mod_merge.transform_tree(tree, tree.basis_tree(), interesting_ids)
4110
 
        tree.set_conflicts(ConflictList(new_conflicts))
4111
 
        if file_list is not None:
4112
 
            restore_files = file_list
4113
 
        for filename in restore_files:
 
3754
                    for name, ie in tree.inventory.iter_entries(file_id):
 
3755
                        interesting_ids.add(ie.file_id)
 
3756
                new_conflicts = conflicts.select_conflicts(tree, file_list)[0]
 
3757
            else:
 
3758
                # Remerge only supports resolving contents conflicts
 
3759
                allowed_conflicts = ('text conflict', 'contents conflict')
 
3760
                restore_files = [c.path for c in conflicts
 
3761
                                 if c.typestring in allowed_conflicts]
 
3762
            _mod_merge.transform_tree(tree, tree.basis_tree(), interesting_ids)
 
3763
            tree.set_conflicts(ConflictList(new_conflicts))
 
3764
            if file_list is not None:
 
3765
                restore_files = file_list
 
3766
            for filename in restore_files:
 
3767
                try:
 
3768
                    restore(tree.abspath(filename))
 
3769
                except errors.NotConflicted:
 
3770
                    pass
 
3771
            # Disable pending merges, because the file texts we are remerging
 
3772
            # have not had those merges performed.  If we use the wrong parents
 
3773
            # list, we imply that the working tree text has seen and rejected
 
3774
            # all the changes from the other tree, when in fact those changes
 
3775
            # have not yet been seen.
 
3776
            pb = ui.ui_factory.nested_progress_bar()
 
3777
            tree.set_parent_ids(parents[:1])
4114
3778
            try:
4115
 
                restore(tree.abspath(filename))
4116
 
            except errors.NotConflicted:
4117
 
                pass
4118
 
        # Disable pending merges, because the file texts we are remerging
4119
 
        # have not had those merges performed.  If we use the wrong parents
4120
 
        # list, we imply that the working tree text has seen and rejected
4121
 
        # all the changes from the other tree, when in fact those changes
4122
 
        # have not yet been seen.
4123
 
        tree.set_parent_ids(parents[:1])
4124
 
        try:
4125
 
            merger = _mod_merge.Merger.from_revision_ids(None, tree, parents[1])
4126
 
            merger.interesting_ids = interesting_ids
4127
 
            merger.merge_type = merge_type
4128
 
            merger.show_base = show_base
4129
 
            merger.reprocess = reprocess
4130
 
            conflicts = merger.do_merge()
 
3779
                merger = _mod_merge.Merger.from_revision_ids(pb,
 
3780
                                                             tree, parents[1])
 
3781
                merger.interesting_ids = interesting_ids
 
3782
                merger.merge_type = merge_type
 
3783
                merger.show_base = show_base
 
3784
                merger.reprocess = reprocess
 
3785
                conflicts = merger.do_merge()
 
3786
            finally:
 
3787
                tree.set_parent_ids(parents)
 
3788
                pb.finished()
4131
3789
        finally:
4132
 
            tree.set_parent_ids(parents)
 
3790
            tree.unlock()
4133
3791
        if conflicts > 0:
4134
3792
            return 1
4135
3793
        else:
4137
3795
 
4138
3796
 
4139
3797
class cmd_revert(Command):
4140
 
    __doc__ = """Revert files to a previous revision.
 
3798
    """Revert files to a previous revision.
4141
3799
 
4142
3800
    Giving a list of files will revert only those files.  Otherwise, all files
4143
3801
    will be reverted.  If the revision is not specified with '--revision', the
4157
3815
    name.  If you name a directory, all the contents of that directory will be
4158
3816
    reverted.
4159
3817
 
4160
 
    If you have newly added files since the target revision, they will be
4161
 
    removed.  If the files to be removed have been changed, backups will be
4162
 
    created as above.  Directories containing unknown files will not be
4163
 
    deleted.
 
3818
    Any files that have been newly added since that revision will be deleted,
 
3819
    with a backup kept if appropriate.  Directories containing unknown files
 
3820
    will not be deleted.
4164
3821
 
4165
 
    The working tree contains a list of revisions that have been merged but
4166
 
    not yet committed. These revisions will be included as additional parents
4167
 
    of the next commit.  Normally, using revert clears that list as well as
4168
 
    reverting the files.  If any files are specified, revert leaves the list
4169
 
    of uncommitted merges alone and reverts only the files.  Use ``bzr revert
4170
 
    .`` in the tree root to revert all files but keep the recorded merges,
4171
 
    and ``bzr revert --forget-merges`` to clear the pending merge list without
 
3822
    The working tree contains a list of pending merged revisions, which will
 
3823
    be included as parents in the next commit.  Normally, revert clears that
 
3824
    list as well as reverting the files.  If any files are specified, revert
 
3825
    leaves the pending merge list alone and reverts only the files.  Use "bzr
 
3826
    revert ." in the tree root to revert all files but keep the merge record,
 
3827
    and "bzr revert --forget-merges" to clear the pending merge list without
4172
3828
    reverting any files.
4173
 
 
4174
 
    Using "bzr revert --forget-merges", it is possible to apply all of the
4175
 
    changes from a branch in a single revision.  To do this, perform the merge
4176
 
    as desired.  Then doing revert with the "--forget-merges" option will keep
4177
 
    the content of the tree as it was, but it will clear the list of pending
4178
 
    merges.  The next commit will then contain all of the changes that are
4179
 
    present in the other branch, but without any other parent revisions.
4180
 
    Because this technique forgets where these changes originated, it may
4181
 
    cause additional conflicts on later merges involving the same source and
4182
 
    target branches.
4183
3829
    """
4184
3830
 
4185
3831
    _see_also = ['cat', 'export']
4194
3840
    def run(self, revision=None, no_backup=False, file_list=None,
4195
3841
            forget_merges=None):
4196
3842
        tree, file_list = tree_files(file_list)
4197
 
        self.add_cleanup(tree.lock_tree_write().unlock)
4198
 
        if forget_merges:
4199
 
            tree.set_parent_ids(tree.get_parent_ids()[:1])
4200
 
        else:
4201
 
            self._revert_tree_to_revision(tree, revision, file_list, no_backup)
 
3843
        tree.lock_write()
 
3844
        try:
 
3845
            if forget_merges:
 
3846
                tree.set_parent_ids(tree.get_parent_ids()[:1])
 
3847
            else:
 
3848
                self._revert_tree_to_revision(tree, revision, file_list, no_backup)
 
3849
        finally:
 
3850
            tree.unlock()
4202
3851
 
4203
3852
    @staticmethod
4204
3853
    def _revert_tree_to_revision(tree, revision, file_list, no_backup):
4205
3854
        rev_tree = _get_one_revision_tree('revert', revision, tree=tree)
4206
 
        tree.revert(file_list, rev_tree, not no_backup, None,
4207
 
            report_changes=True)
 
3855
        pb = ui.ui_factory.nested_progress_bar()
 
3856
        try:
 
3857
            tree.revert(file_list, rev_tree, not no_backup, pb,
 
3858
                report_changes=True)
 
3859
        finally:
 
3860
            pb.finished()
4208
3861
 
4209
3862
 
4210
3863
class cmd_assert_fail(Command):
4211
 
    __doc__ = """Test reporting of assertion failures"""
 
3864
    """Test reporting of assertion failures"""
4212
3865
    # intended just for use in testing
4213
3866
 
4214
3867
    hidden = True
4218
3871
 
4219
3872
 
4220
3873
class cmd_help(Command):
4221
 
    __doc__ = """Show help on a command or other topic.
 
3874
    """Show help on a command or other topic.
4222
3875
    """
4223
3876
 
4224
3877
    _see_also = ['topics']
4237
3890
 
4238
3891
 
4239
3892
class cmd_shell_complete(Command):
4240
 
    __doc__ = """Show appropriate completions for context.
 
3893
    """Show appropriate completions for context.
4241
3894
 
4242
3895
    For a list of all available commands, say 'bzr shell-complete'.
4243
3896
    """
4252
3905
 
4253
3906
 
4254
3907
class cmd_missing(Command):
4255
 
    __doc__ = """Show unmerged/unpulled revisions between two branches.
 
3908
    """Show unmerged/unpulled revisions between two branches.
4256
3909
 
4257
3910
    OTHER_BRANCH may be local or remote.
4258
3911
 
4259
3912
    To filter on a range of revisions, you can use the command -r begin..end
4260
3913
    -r revision requests a specific revision, -r ..end or -r begin.. are
4261
3914
    also valid.
4262
 
            
4263
 
    :Exit values:
4264
 
        1 - some missing revisions
4265
 
        0 - no missing revisions
4266
3915
 
4267
3916
    :Examples:
4268
3917
 
4336
3985
            restrict = 'remote'
4337
3986
 
4338
3987
        local_branch = Branch.open_containing(u".")[0]
4339
 
        self.add_cleanup(local_branch.lock_read().unlock)
4340
 
 
4341
3988
        parent = local_branch.get_parent()
4342
3989
        if other_branch is None:
4343
3990
            other_branch = parent
4352
3999
        remote_branch = Branch.open(other_branch)
4353
4000
        if remote_branch.base == local_branch.base:
4354
4001
            remote_branch = local_branch
4355
 
        else:
4356
 
            self.add_cleanup(remote_branch.lock_read().unlock)
4357
4002
 
4358
4003
        local_revid_range = _revision_range_to_revid_range(
4359
4004
            _get_revision_range(my_revision, local_branch,
4363
4008
            _get_revision_range(revision,
4364
4009
                remote_branch, self.name()))
4365
4010
 
4366
 
        local_extra, remote_extra = find_unmerged(
4367
 
            local_branch, remote_branch, restrict,
4368
 
            backward=not reverse,
4369
 
            include_merges=include_merges,
4370
 
            local_revid_range=local_revid_range,
4371
 
            remote_revid_range=remote_revid_range)
4372
 
 
4373
 
        if log_format is None:
4374
 
            registry = log.log_formatter_registry
4375
 
            log_format = registry.get_default(local_branch)
4376
 
        lf = log_format(to_file=self.outf,
4377
 
                        show_ids=show_ids,
4378
 
                        show_timezone='original')
4379
 
 
4380
 
        status_code = 0
4381
 
        if local_extra and not theirs_only:
4382
 
            message("You have %d extra revision(s):\n" %
4383
 
                len(local_extra))
4384
 
            for revision in iter_log_revisions(local_extra,
4385
 
                                local_branch.repository,
4386
 
                                verbose):
4387
 
                lf.log_revision(revision)
4388
 
            printed_local = True
4389
 
            status_code = 1
4390
 
        else:
4391
 
            printed_local = False
4392
 
 
4393
 
        if remote_extra and not mine_only:
4394
 
            if printed_local is True:
4395
 
                message("\n\n\n")
4396
 
            message("You are missing %d revision(s):\n" %
4397
 
                len(remote_extra))
4398
 
            for revision in iter_log_revisions(remote_extra,
4399
 
                                remote_branch.repository,
4400
 
                                verbose):
4401
 
                lf.log_revision(revision)
4402
 
            status_code = 1
4403
 
 
4404
 
        if mine_only and not local_extra:
4405
 
            # We checked local, and found nothing extra
4406
 
            message('This branch is up to date.\n')
4407
 
        elif theirs_only and not remote_extra:
4408
 
            # We checked remote, and found nothing extra
4409
 
            message('Other branch is up to date.\n')
4410
 
        elif not (mine_only or theirs_only or local_extra or
4411
 
                  remote_extra):
4412
 
            # We checked both branches, and neither one had extra
4413
 
            # revisions
4414
 
            message("Branches are up to date.\n")
4415
 
        self.cleanup_now()
 
4011
        local_branch.lock_read()
 
4012
        try:
 
4013
            remote_branch.lock_read()
 
4014
            try:
 
4015
                local_extra, remote_extra = find_unmerged(
 
4016
                    local_branch, remote_branch, restrict,
 
4017
                    backward=not reverse,
 
4018
                    include_merges=include_merges,
 
4019
                    local_revid_range=local_revid_range,
 
4020
                    remote_revid_range=remote_revid_range)
 
4021
 
 
4022
                if log_format is None:
 
4023
                    registry = log.log_formatter_registry
 
4024
                    log_format = registry.get_default(local_branch)
 
4025
                lf = log_format(to_file=self.outf,
 
4026
                                show_ids=show_ids,
 
4027
                                show_timezone='original')
 
4028
 
 
4029
                status_code = 0
 
4030
                if local_extra and not theirs_only:
 
4031
                    message("You have %d extra revision(s):\n" %
 
4032
                        len(local_extra))
 
4033
                    for revision in iter_log_revisions(local_extra,
 
4034
                                        local_branch.repository,
 
4035
                                        verbose):
 
4036
                        lf.log_revision(revision)
 
4037
                    printed_local = True
 
4038
                    status_code = 1
 
4039
                else:
 
4040
                    printed_local = False
 
4041
 
 
4042
                if remote_extra and not mine_only:
 
4043
                    if printed_local is True:
 
4044
                        message("\n\n\n")
 
4045
                    message("You are missing %d revision(s):\n" %
 
4046
                        len(remote_extra))
 
4047
                    for revision in iter_log_revisions(remote_extra,
 
4048
                                        remote_branch.repository,
 
4049
                                        verbose):
 
4050
                        lf.log_revision(revision)
 
4051
                    status_code = 1
 
4052
 
 
4053
                if mine_only and not local_extra:
 
4054
                    # We checked local, and found nothing extra
 
4055
                    message('This branch is up to date.\n')
 
4056
                elif theirs_only and not remote_extra:
 
4057
                    # We checked remote, and found nothing extra
 
4058
                    message('Other branch is up to date.\n')
 
4059
                elif not (mine_only or theirs_only or local_extra or
 
4060
                          remote_extra):
 
4061
                    # We checked both branches, and neither one had extra
 
4062
                    # revisions
 
4063
                    message("Branches are up to date.\n")
 
4064
            finally:
 
4065
                remote_branch.unlock()
 
4066
        finally:
 
4067
            local_branch.unlock()
4416
4068
        if not status_code and parent is None and other_branch is not None:
4417
 
            self.add_cleanup(local_branch.lock_write().unlock)
4418
 
            # handle race conditions - a parent might be set while we run.
4419
 
            if local_branch.get_parent() is None:
4420
 
                local_branch.set_parent(remote_branch.base)
 
4069
            local_branch.lock_write()
 
4070
            try:
 
4071
                # handle race conditions - a parent might be set while we run.
 
4072
                if local_branch.get_parent() is None:
 
4073
                    local_branch.set_parent(remote_branch.base)
 
4074
            finally:
 
4075
                local_branch.unlock()
4421
4076
        return status_code
4422
4077
 
4423
4078
 
4424
4079
class cmd_pack(Command):
4425
 
    __doc__ = """Compress the data within a repository.
4426
 
 
4427
 
    This operation compresses the data within a bazaar repository. As
4428
 
    bazaar supports automatic packing of repository, this operation is
4429
 
    normally not required to be done manually.
4430
 
 
4431
 
    During the pack operation, bazaar takes a backup of existing repository
4432
 
    data, i.e. pack files. This backup is eventually removed by bazaar
4433
 
    automatically when it is safe to do so. To save disk space by removing
4434
 
    the backed up pack files, the --clean-obsolete-packs option may be
4435
 
    used.
4436
 
 
4437
 
    Warning: If you use --clean-obsolete-packs and your machine crashes
4438
 
    during or immediately after repacking, you may be left with a state
4439
 
    where the deletion has been written to disk but the new packs have not
4440
 
    been. In this case the repository may be unusable.
4441
 
    """
 
4080
    """Compress the data within a repository."""
4442
4081
 
4443
4082
    _see_also = ['repositories']
4444
4083
    takes_args = ['branch_or_repo?']
4445
 
    takes_options = [
4446
 
        Option('clean-obsolete-packs', 'Delete obsolete packs to save disk space.'),
4447
 
        ]
4448
4084
 
4449
 
    def run(self, branch_or_repo='.', clean_obsolete_packs=False):
 
4085
    def run(self, branch_or_repo='.'):
4450
4086
        dir = bzrdir.BzrDir.open_containing(branch_or_repo)[0]
4451
4087
        try:
4452
4088
            branch = dir.open_branch()
4453
4089
            repository = branch.repository
4454
4090
        except errors.NotBranchError:
4455
4091
            repository = dir.open_repository()
4456
 
        repository.pack(clean_obsolete_packs=clean_obsolete_packs)
 
4092
        repository.pack()
4457
4093
 
4458
4094
 
4459
4095
class cmd_plugins(Command):
4460
 
    __doc__ = """List the installed plugins.
 
4096
    """List the installed plugins.
4461
4097
 
4462
4098
    This command displays the list of installed plugins including
4463
4099
    version of plugin and a short description of each.
4470
4106
    adding new commands, providing additional network transports and
4471
4107
    customizing log output.
4472
4108
 
4473
 
    See the Bazaar Plugin Guide <http://doc.bazaar.canonical.com/plugins/en/>
4474
 
    for further information on plugins including where to find them and how to
4475
 
    install them. Instructions are also provided there on how to write new
4476
 
    plugins using the Python programming language.
 
4109
    See the Bazaar web site, http://bazaar-vcs.org, for further
 
4110
    information on plugins including where to find them and how to
 
4111
    install them. Instructions are also provided there on how to
 
4112
    write new plugins using the Python programming language.
4477
4113
    """
4478
4114
    takes_options = ['verbose']
4479
4115
 
4494
4130
                doc = '(no description)'
4495
4131
            result.append((name_ver, doc, plugin.path()))
4496
4132
        for name_ver, doc, path in sorted(result):
4497
 
            self.outf.write("%s\n" % name_ver)
4498
 
            self.outf.write("   %s\n" % doc)
 
4133
            print name_ver
 
4134
            print '   ', doc
4499
4135
            if verbose:
4500
 
                self.outf.write("   %s\n" % path)
4501
 
            self.outf.write("\n")
 
4136
                print '   ', path
 
4137
            print
4502
4138
 
4503
4139
 
4504
4140
class cmd_testament(Command):
4505
 
    __doc__ = """Show testament (signing-form) of a revision."""
 
4141
    """Show testament (signing-form) of a revision."""
4506
4142
    takes_options = [
4507
4143
            'revision',
4508
4144
            Option('long', help='Produce long-format testament.'),
4520
4156
            b = Branch.open_containing(branch)[0]
4521
4157
        else:
4522
4158
            b = Branch.open(branch)
4523
 
        self.add_cleanup(b.lock_read().unlock)
4524
 
        if revision is None:
4525
 
            rev_id = b.last_revision()
4526
 
        else:
4527
 
            rev_id = revision[0].as_revision_id(b)
4528
 
        t = testament_class.from_revision(b.repository, rev_id)
4529
 
        if long:
4530
 
            sys.stdout.writelines(t.as_text_lines())
4531
 
        else:
4532
 
            sys.stdout.write(t.as_short_text())
 
4159
        b.lock_read()
 
4160
        try:
 
4161
            if revision is None:
 
4162
                rev_id = b.last_revision()
 
4163
            else:
 
4164
                rev_id = revision[0].as_revision_id(b)
 
4165
            t = testament_class.from_revision(b.repository, rev_id)
 
4166
            if long:
 
4167
                sys.stdout.writelines(t.as_text_lines())
 
4168
            else:
 
4169
                sys.stdout.write(t.as_short_text())
 
4170
        finally:
 
4171
            b.unlock()
4533
4172
 
4534
4173
 
4535
4174
class cmd_annotate(Command):
4536
 
    __doc__ = """Show the origin of each line in a file.
 
4175
    """Show the origin of each line in a file.
4537
4176
 
4538
4177
    This prints out the given file with an annotation on the left side
4539
4178
    indicating which revision, author and date introduced the change.
4550
4189
                     Option('long', help='Show commit date in annotations.'),
4551
4190
                     'revision',
4552
4191
                     'show-ids',
4553
 
                     'directory',
4554
4192
                     ]
4555
4193
    encoding_type = 'exact'
4556
4194
 
4557
4195
    @display_command
4558
4196
    def run(self, filename, all=False, long=False, revision=None,
4559
 
            show_ids=False, directory=None):
 
4197
            show_ids=False):
4560
4198
        from bzrlib.annotate import annotate_file, annotate_file_tree
4561
4199
        wt, branch, relpath = \
4562
 
            _open_directory_or_containing_tree_or_branch(filename, directory)
4563
 
        if wt is not None:
4564
 
            self.add_cleanup(wt.lock_read().unlock)
4565
 
        else:
4566
 
            self.add_cleanup(branch.lock_read().unlock)
4567
 
        tree = _get_one_revision_tree('annotate', revision, branch=branch)
4568
 
        self.add_cleanup(tree.lock_read().unlock)
4569
 
        if wt is not None:
4570
 
            file_id = wt.path2id(relpath)
4571
 
        else:
4572
 
            file_id = tree.path2id(relpath)
4573
 
        if file_id is None:
4574
 
            raise errors.NotVersionedError(filename)
4575
 
        file_version = tree.inventory[file_id].revision
4576
 
        if wt is not None and revision is None:
4577
 
            # If there is a tree and we're not annotating historical
4578
 
            # versions, annotate the working tree's content.
4579
 
            annotate_file_tree(wt, file_id, self.outf, long, all,
4580
 
                show_ids=show_ids)
4581
 
        else:
4582
 
            annotate_file(branch, file_version, file_id, long, all, self.outf,
4583
 
                          show_ids=show_ids)
 
4200
            bzrdir.BzrDir.open_containing_tree_or_branch(filename)
 
4201
        if wt is not None:
 
4202
            wt.lock_read()
 
4203
        else:
 
4204
            branch.lock_read()
 
4205
        try:
 
4206
            tree = _get_one_revision_tree('annotate', revision, branch=branch)
 
4207
            if wt is not None:
 
4208
                file_id = wt.path2id(relpath)
 
4209
            else:
 
4210
                file_id = tree.path2id(relpath)
 
4211
            if file_id is None:
 
4212
                raise errors.NotVersionedError(filename)
 
4213
            file_version = tree.inventory[file_id].revision
 
4214
            if wt is not None and revision is None:
 
4215
                # If there is a tree and we're not annotating historical
 
4216
                # versions, annotate the working tree's content.
 
4217
                annotate_file_tree(wt, file_id, self.outf, long, all,
 
4218
                    show_ids=show_ids)
 
4219
            else:
 
4220
                annotate_file(branch, file_version, file_id, long, all, self.outf,
 
4221
                              show_ids=show_ids)
 
4222
        finally:
 
4223
            if wt is not None:
 
4224
                wt.unlock()
 
4225
            else:
 
4226
                branch.unlock()
4584
4227
 
4585
4228
 
4586
4229
class cmd_re_sign(Command):
4587
 
    __doc__ = """Create a digital signature for an existing revision."""
 
4230
    """Create a digital signature for an existing revision."""
4588
4231
    # TODO be able to replace existing ones.
4589
4232
 
4590
4233
    hidden = True # is this right ?
4591
4234
    takes_args = ['revision_id*']
4592
 
    takes_options = ['directory', 'revision']
 
4235
    takes_options = ['revision']
4593
4236
 
4594
 
    def run(self, revision_id_list=None, revision=None, directory=u'.'):
 
4237
    def run(self, revision_id_list=None, revision=None):
4595
4238
        if revision_id_list is not None and revision is not None:
4596
4239
            raise errors.BzrCommandError('You can only supply one of revision_id or --revision')
4597
4240
        if revision_id_list is None and revision is None:
4598
4241
            raise errors.BzrCommandError('You must supply either --revision or a revision_id')
4599
 
        b = WorkingTree.open_containing(directory)[0].branch
4600
 
        self.add_cleanup(b.lock_write().unlock)
4601
 
        return self._run(b, revision_id_list, revision)
 
4242
        b = WorkingTree.open_containing(u'.')[0].branch
 
4243
        b.lock_write()
 
4244
        try:
 
4245
            return self._run(b, revision_id_list, revision)
 
4246
        finally:
 
4247
            b.unlock()
4602
4248
 
4603
4249
    def _run(self, b, revision_id_list, revision):
4604
4250
        import bzrlib.gpg as gpg
4649
4295
 
4650
4296
 
4651
4297
class cmd_bind(Command):
4652
 
    __doc__ = """Convert the current branch into a checkout of the supplied branch.
4653
 
    If no branch is supplied, rebind to the last bound location.
 
4298
    """Convert the current branch into a checkout of the supplied branch.
4654
4299
 
4655
4300
    Once converted into a checkout, commits must succeed on the master branch
4656
4301
    before they will be applied to the local branch.
4657
4302
 
4658
4303
    Bound branches use the nickname of its master branch unless it is set
4659
 
    locally, in which case binding will update the local nickname to be
 
4304
    locally, in which case binding will update the the local nickname to be
4660
4305
    that of the master.
4661
4306
    """
4662
4307
 
4663
4308
    _see_also = ['checkouts', 'unbind']
4664
4309
    takes_args = ['location?']
4665
 
    takes_options = ['directory']
 
4310
    takes_options = []
4666
4311
 
4667
 
    def run(self, location=None, directory=u'.'):
4668
 
        b, relpath = Branch.open_containing(directory)
 
4312
    def run(self, location=None):
 
4313
        b, relpath = Branch.open_containing(u'.')
4669
4314
        if location is None:
4670
4315
            try:
4671
4316
                location = b.get_old_bound_location()
4674
4319
                    'This format does not remember old locations.')
4675
4320
            else:
4676
4321
                if location is None:
4677
 
                    if b.get_bound_location() is not None:
4678
 
                        raise errors.BzrCommandError('Branch is already bound')
4679
 
                    else:
4680
 
                        raise errors.BzrCommandError('No location supplied '
4681
 
                            'and no previous location known')
 
4322
                    raise errors.BzrCommandError('No location supplied and no '
 
4323
                        'previous location known')
4682
4324
        b_other = Branch.open(location)
4683
4325
        try:
4684
4326
            b.bind(b_other)
4690
4332
 
4691
4333
 
4692
4334
class cmd_unbind(Command):
4693
 
    __doc__ = """Convert the current checkout into a regular branch.
 
4335
    """Convert the current checkout into a regular branch.
4694
4336
 
4695
4337
    After unbinding, the local branch is considered independent and subsequent
4696
4338
    commits will be local only.
4698
4340
 
4699
4341
    _see_also = ['checkouts', 'bind']
4700
4342
    takes_args = []
4701
 
    takes_options = ['directory']
 
4343
    takes_options = []
4702
4344
 
4703
 
    def run(self, directory=u'.'):
4704
 
        b, relpath = Branch.open_containing(directory)
 
4345
    def run(self):
 
4346
        b, relpath = Branch.open_containing(u'.')
4705
4347
        if not b.unbind():
4706
4348
            raise errors.BzrCommandError('Local branch is not bound')
4707
4349
 
4708
4350
 
4709
4351
class cmd_uncommit(Command):
4710
 
    __doc__ = """Remove the last committed revision.
 
4352
    """Remove the last committed revision.
4711
4353
 
4712
4354
    --verbose will print out what is being removed.
4713
4355
    --dry-run will go through all the motions, but not actually
4753
4395
            b = control.open_branch()
4754
4396
 
4755
4397
        if tree is not None:
4756
 
            self.add_cleanup(tree.lock_write().unlock)
 
4398
            tree.lock_write()
4757
4399
        else:
4758
 
            self.add_cleanup(b.lock_write().unlock)
4759
 
        return self._run(b, tree, dry_run, verbose, revision, force, local=local)
 
4400
            b.lock_write()
 
4401
        try:
 
4402
            return self._run(b, tree, dry_run, verbose, revision, force,
 
4403
                             local=local)
 
4404
        finally:
 
4405
            if tree is not None:
 
4406
                tree.unlock()
 
4407
            else:
 
4408
                b.unlock()
4760
4409
 
4761
4410
    def _run(self, b, tree, dry_run, verbose, revision, force, local=False):
4762
4411
        from bzrlib.log import log_formatter, show_log
4794
4443
                 end_revision=last_revno)
4795
4444
 
4796
4445
        if dry_run:
4797
 
            self.outf.write('Dry-run, pretending to remove'
4798
 
                            ' the above revisions.\n')
 
4446
            print 'Dry-run, pretending to remove the above revisions.'
 
4447
            if not force:
 
4448
                val = raw_input('Press <enter> to continue')
4799
4449
        else:
4800
 
            self.outf.write('The above revision(s) will be removed.\n')
4801
 
 
4802
 
        if not force:
4803
 
            if not ui.ui_factory.get_boolean('Are you sure'):
4804
 
                self.outf.write('Canceled')
4805
 
                return 0
 
4450
            print 'The above revision(s) will be removed.'
 
4451
            if not force:
 
4452
                val = raw_input('Are you sure [y/N]? ')
 
4453
                if val.lower() not in ('y', 'yes'):
 
4454
                    print 'Canceled'
 
4455
                    return 0
4806
4456
 
4807
4457
        mutter('Uncommitting from {%s} to {%s}',
4808
4458
               last_rev_id, rev_id)
4809
4459
        uncommit(b, tree=tree, dry_run=dry_run, verbose=verbose,
4810
4460
                 revno=revno, local=local)
4811
 
        self.outf.write('You can restore the old tip by running:\n'
4812
 
             '  bzr pull . -r revid:%s\n' % last_rev_id)
 
4461
        note('You can restore the old tip by running:\n'
 
4462
             '  bzr pull . -r revid:%s', last_rev_id)
4813
4463
 
4814
4464
 
4815
4465
class cmd_break_lock(Command):
4816
 
    __doc__ = """Break a dead lock on a repository, branch or working directory.
 
4466
    """Break a dead lock on a repository, branch or working directory.
4817
4467
 
4818
4468
    CAUTION: Locks should only be broken when you are sure that the process
4819
4469
    holding the lock has been stopped.
4820
4470
 
4821
 
    You can get information on what locks are open via the 'bzr info
4822
 
    [location]' command.
 
4471
    You can get information on what locks are open via the 'bzr info' command.
4823
4472
 
4824
4473
    :Examples:
4825
4474
        bzr break-lock
4826
 
        bzr break-lock bzr+ssh://example.com/bzr/foo
4827
4475
    """
4828
4476
    takes_args = ['location?']
4829
4477
 
4838
4486
 
4839
4487
 
4840
4488
class cmd_wait_until_signalled(Command):
4841
 
    __doc__ = """Test helper for test_start_and_stop_bzr_subprocess_send_signal.
 
4489
    """Test helper for test_start_and_stop_bzr_subprocess_send_signal.
4842
4490
 
4843
4491
    This just prints a line to signal when it is ready, then blocks on stdin.
4844
4492
    """
4852
4500
 
4853
4501
 
4854
4502
class cmd_serve(Command):
4855
 
    __doc__ = """Run the bzr server."""
 
4503
    """Run the bzr server."""
4856
4504
 
4857
4505
    aliases = ['server']
4858
4506
 
4859
4507
    takes_options = [
4860
4508
        Option('inet',
4861
4509
               help='Serve on stdin/out for use from inetd or sshd.'),
4862
 
        RegistryOption('protocol',
4863
 
               help="Protocol to serve.",
4864
 
               lazy_registry=('bzrlib.transport', 'transport_server_registry'),
4865
 
               value_switches=True),
4866
4510
        Option('port',
4867
4511
               help='Listen for connections on nominated port of the form '
4868
4512
                    '[hostname:]portnumber.  Passing 0 as the port number will '
4869
 
                    'result in a dynamically allocated port.  The default port '
4870
 
                    'depends on the protocol.',
 
4513
                    'result in a dynamically allocated port.  The default port is '
 
4514
                    '4155.',
4871
4515
               type=str),
4872
 
        custom_help('directory',
4873
 
               help='Serve contents of this directory.'),
 
4516
        Option('directory',
 
4517
               help='Serve contents of this directory.',
 
4518
               type=unicode),
4874
4519
        Option('allow-writes',
4875
4520
               help='By default the server is a readonly server.  Supplying '
4876
4521
                    '--allow-writes enables write access to the contents of '
4877
 
                    'the served directory and below.  Note that ``bzr serve`` '
4878
 
                    'does not perform authentication, so unless some form of '
4879
 
                    'external authentication is arranged supplying this '
4880
 
                    'option leads to global uncontrolled write access to your '
4881
 
                    'file system.'
 
4522
                    'the served directory and below.'
4882
4523
                ),
4883
4524
        ]
4884
4525
 
 
4526
    def run_smart_server(self, smart_server):
 
4527
        """Run 'smart_server' forever, with no UI output at all."""
 
4528
        # For the duration of this server, no UI output is permitted. note
 
4529
        # that this may cause problems with blackbox tests. This should be
 
4530
        # changed with care though, as we dont want to use bandwidth sending
 
4531
        # progress over stderr to smart server clients!
 
4532
        from bzrlib import lockdir
 
4533
        old_factory = ui.ui_factory
 
4534
        old_lockdir_timeout = lockdir._DEFAULT_TIMEOUT_SECONDS
 
4535
        try:
 
4536
            ui.ui_factory = ui.SilentUIFactory()
 
4537
            lockdir._DEFAULT_TIMEOUT_SECONDS = 0
 
4538
            smart_server.serve()
 
4539
        finally:
 
4540
            ui.ui_factory = old_factory
 
4541
            lockdir._DEFAULT_TIMEOUT_SECONDS = old_lockdir_timeout
 
4542
 
4885
4543
    def get_host_and_port(self, port):
4886
4544
        """Return the host and port to run the smart server on.
4887
4545
 
4888
 
        If 'port' is None, None will be returned for the host and port.
 
4546
        If 'port' is None, the default host (`medium.BZR_DEFAULT_INTERFACE`)
 
4547
        and port (`medium.BZR_DEFAULT_PORT`) will be used.
4889
4548
 
4890
4549
        If 'port' has a colon in it, the string before the colon will be
4891
4550
        interpreted as the host.
4894
4553
        :return: A tuple of (host, port), where 'host' is a host name or IP,
4895
4554
            and port is an integer TCP/IP port.
4896
4555
        """
4897
 
        host = None
4898
 
        if port is not None:
 
4556
        from bzrlib.smart import medium
 
4557
        host = medium.BZR_DEFAULT_INTERFACE
 
4558
        if port is None:
 
4559
            port = medium.BZR_DEFAULT_PORT
 
4560
        else:
4899
4561
            if ':' in port:
4900
4562
                host, port = port.split(':')
4901
4563
            port = int(port)
4902
4564
        return host, port
4903
4565
 
4904
 
    def run(self, port=None, inet=False, directory=None, allow_writes=False,
4905
 
            protocol=None):
4906
 
        from bzrlib.transport import get_transport, transport_server_registry
 
4566
    def get_smart_server(self, transport, inet, port):
 
4567
        """Construct a smart server.
 
4568
 
 
4569
        :param transport: The base transport from which branches will be
 
4570
            served.
 
4571
        :param inet: If True, serve over stdin and stdout. Used for running
 
4572
            from inet.
 
4573
        :param port: The port to listen on. By default, it's `
 
4574
            medium.BZR_DEFAULT_PORT`. See `get_host_and_port` for more
 
4575
            information.
 
4576
        :return: A smart server.
 
4577
        """
 
4578
        from bzrlib.smart import medium, server
 
4579
        if inet:
 
4580
            smart_server = medium.SmartServerPipeStreamMedium(
 
4581
                sys.stdin, sys.stdout, transport)
 
4582
        else:
 
4583
            host, port = self.get_host_and_port(port)
 
4584
            smart_server = server.SmartTCPServer(
 
4585
                transport, host=host, port=port)
 
4586
            note('listening on port: %s' % smart_server.port)
 
4587
        return smart_server
 
4588
 
 
4589
    def run(self, port=None, inet=False, directory=None, allow_writes=False):
 
4590
        from bzrlib.transport import get_transport
 
4591
        from bzrlib.transport.chroot import ChrootServer
4907
4592
        if directory is None:
4908
4593
            directory = os.getcwd()
4909
 
        if protocol is None:
4910
 
            protocol = transport_server_registry.get()
4911
 
        host, port = self.get_host_and_port(port)
4912
4594
        url = urlutils.local_path_to_url(directory)
4913
4595
        if not allow_writes:
4914
4596
            url = 'readonly+' + url
4915
 
        transport = get_transport(url)
4916
 
        protocol(transport, host, port, inet)
 
4597
        chroot_server = ChrootServer(get_transport(url))
 
4598
        chroot_server.setUp()
 
4599
        t = get_transport(chroot_server.get_url())
 
4600
        smart_server = self.get_smart_server(t, inet, port)
 
4601
        self.run_smart_server(smart_server)
4917
4602
 
4918
4603
 
4919
4604
class cmd_join(Command):
4920
 
    __doc__ = """Combine a tree into its containing tree.
 
4605
    """Combine a tree into its containing tree.
4921
4606
 
4922
4607
    This command requires the target tree to be in a rich-root format.
4923
4608
 
4963
4648
 
4964
4649
 
4965
4650
class cmd_split(Command):
4966
 
    __doc__ = """Split a subdirectory of a tree into a separate tree.
 
4651
    """Split a subdirectory of a tree into a separate tree.
4967
4652
 
4968
4653
    This command will produce a target tree in a format that supports
4969
4654
    rich roots, like 'rich-root' or 'rich-root-pack'.  These formats cannot be
4985
4670
        try:
4986
4671
            containing_tree.extract(sub_id)
4987
4672
        except errors.RootNotRich:
4988
 
            raise errors.RichRootUpgradeRequired(containing_tree.branch.base)
 
4673
            raise errors.UpgradeRequired(containing_tree.branch.base)
4989
4674
 
4990
4675
 
4991
4676
class cmd_merge_directive(Command):
4992
 
    __doc__ = """Generate a merge directive for auto-merge tools.
 
4677
    """Generate a merge directive for auto-merge tools.
4993
4678
 
4994
4679
    A directive requests a merge to be performed, and also provides all the
4995
4680
    information necessary to do so.  This means it must either include a
5088
4773
 
5089
4774
 
5090
4775
class cmd_send(Command):
5091
 
    __doc__ = """Mail or create a merge-directive for submitting changes.
 
4776
    """Mail or create a merge-directive for submitting changes.
5092
4777
 
5093
4778
    A merge directive provides many things needed for requesting merges:
5094
4779
 
5100
4785
      directly from the merge directive, without retrieving data from a
5101
4786
      branch.
5102
4787
 
5103
 
    `bzr send` creates a compact data set that, when applied using bzr
5104
 
    merge, has the same effect as merging from the source branch.  
5105
 
    
5106
 
    By default the merge directive is self-contained and can be applied to any
5107
 
    branch containing submit_branch in its ancestory without needing access to
5108
 
    the source branch.
5109
 
    
5110
 
    If --no-bundle is specified, then Bazaar doesn't send the contents of the
5111
 
    revisions, but only a structured request to merge from the
5112
 
    public_location.  In that case the public_branch is needed and it must be
5113
 
    up-to-date and accessible to the recipient.  The public_branch is always
5114
 
    included if known, so that people can check it later.
5115
 
 
5116
 
    The submit branch defaults to the parent of the source branch, but can be
5117
 
    overridden.  Both submit branch and public branch will be remembered in
5118
 
    branch.conf the first time they are used for a particular branch.  The
5119
 
    source branch defaults to that containing the working directory, but can
5120
 
    be changed using --from.
5121
 
 
5122
 
    In order to calculate those changes, bzr must analyse the submit branch.
5123
 
    Therefore it is most efficient for the submit branch to be a local mirror.
5124
 
    If a public location is known for the submit_branch, that location is used
5125
 
    in the merge directive.
5126
 
 
5127
 
    The default behaviour is to send the merge directive by mail, unless -o is
5128
 
    given, in which case it is sent to a file.
 
4788
    If --no-bundle is specified, then public_branch is needed (and must be
 
4789
    up-to-date), so that the receiver can perform the merge using the
 
4790
    public_branch.  The public_branch is always included if known, so that
 
4791
    people can check it later.
 
4792
 
 
4793
    The submit branch defaults to the parent, but can be overridden.  Both
 
4794
    submit branch and public branch will be remembered if supplied.
 
4795
 
 
4796
    If a public_branch is known for the submit_branch, that public submit
 
4797
    branch is used in the merge instructions.  This means that a local mirror
 
4798
    can be used as your actual submit branch, once you have set public_branch
 
4799
    for that mirror.
5129
4800
 
5130
4801
    Mail is sent using your preferred mail program.  This should be transparent
5131
 
    on Windows (it uses MAPI).  On Unix, it requires the xdg-email utility.
 
4802
    on Windows (it uses MAPI).  On Linux, it requires the xdg-email utility.
5132
4803
    If the preferred client can't be found (or used), your editor will be used.
5133
4804
 
5134
4805
    To use a specific mail program, set the mail_client configuration option.
5135
4806
    (For Thunderbird 1.5, this works around some bugs.)  Supported values for
5136
 
    specific clients are "claws", "evolution", "kmail", "mail.app" (MacOS X's
5137
 
    Mail.app), "mutt", and "thunderbird"; generic options are "default",
5138
 
    "editor", "emacsclient", "mapi", and "xdg-email".  Plugins may also add
5139
 
    supported clients.
 
4807
    specific clients are "claws", "evolution", "kmail", "mutt", and
 
4808
    "thunderbird"; generic options are "default", "editor", "emacsclient",
 
4809
    "mapi", and "xdg-email".  Plugins may also add supported clients.
5140
4810
 
5141
4811
    If mail is being sent, a to address is required.  This can be supplied
5142
4812
    either on the commandline, by setting the submit_to configuration
5151
4821
 
5152
4822
    The merge directives created by bzr send may be applied using bzr merge or
5153
4823
    bzr pull by specifying a file containing a merge directive as the location.
5154
 
 
5155
 
    bzr send makes extensive use of public locations to map local locations into
5156
 
    URLs that can be used by other people.  See `bzr help configuration` to
5157
 
    set them, and use `bzr info` to display them.
5158
4824
    """
5159
4825
 
5160
4826
    encoding_type = 'exact'
5176
4842
               short_name='f',
5177
4843
               type=unicode),
5178
4844
        Option('output', short_name='o',
5179
 
               help='Write merge directive to this file or directory; '
 
4845
               help='Write merge directive to this file; '
5180
4846
                    'use - for stdout.',
5181
4847
               type=unicode),
5182
 
        Option('strict',
5183
 
               help='Refuse to send if there are uncommitted changes in'
5184
 
               ' the working tree, --no-strict disables the check.'),
5185
4848
        Option('mail-to', help='Mail the request to this address.',
5186
4849
               type=unicode),
5187
4850
        'revision',
5188
4851
        'message',
5189
4852
        Option('body', help='Body for the email.', type=unicode),
5190
 
        RegistryOption('format',
5191
 
                       help='Use the specified output format.',
5192
 
                       lazy_registry=('bzrlib.send', 'format_registry')),
 
4853
        RegistryOption.from_kwargs('format',
 
4854
        'Use the specified output format.',
 
4855
        **{'4': 'Bundle format 4, Merge Directive 2 (default)',
 
4856
           '0.9': 'Bundle format 0.9, Merge Directive 1',})
5193
4857
        ]
5194
4858
 
5195
4859
    def run(self, submit_branch=None, public_branch=None, no_bundle=False,
5196
4860
            no_patch=False, revision=None, remember=False, output=None,
5197
 
            format=None, mail_to=None, message=None, body=None,
5198
 
            strict=None, **kwargs):
5199
 
        from bzrlib.send import send
5200
 
        return send(submit_branch, revision, public_branch, remember,
5201
 
                    format, no_bundle, no_patch, output,
5202
 
                    kwargs.get('from', '.'), mail_to, message, body,
5203
 
                    self.outf,
5204
 
                    strict=strict)
 
4861
            format='4', mail_to=None, message=None, body=None, **kwargs):
 
4862
        return self._run(submit_branch, revision, public_branch, remember,
 
4863
                         format, no_bundle, no_patch, output,
 
4864
                         kwargs.get('from', '.'), mail_to, message, body)
 
4865
 
 
4866
    def _run(self, submit_branch, revision, public_branch, remember, format,
 
4867
             no_bundle, no_patch, output, from_, mail_to, message, body):
 
4868
        from bzrlib.revision import NULL_REVISION
 
4869
        branch = Branch.open_containing(from_)[0]
 
4870
        if output is None:
 
4871
            outfile = cStringIO.StringIO()
 
4872
        elif output == '-':
 
4873
            outfile = self.outf
 
4874
        else:
 
4875
            outfile = open(output, 'wb')
 
4876
        # we may need to write data into branch's repository to calculate
 
4877
        # the data to send.
 
4878
        branch.lock_write()
 
4879
        try:
 
4880
            if output is None:
 
4881
                config = branch.get_config()
 
4882
                if mail_to is None:
 
4883
                    mail_to = config.get_user_option('submit_to')
 
4884
                mail_client = config.get_mail_client()
 
4885
                if (not getattr(mail_client, 'supports_body', False)
 
4886
                    and body is not None):
 
4887
                    raise errors.BzrCommandError(
 
4888
                        'Mail client "%s" does not support specifying body' %
 
4889
                        mail_client.__class__.__name__)
 
4890
            if remember and submit_branch is None:
 
4891
                raise errors.BzrCommandError(
 
4892
                    '--remember requires a branch to be specified.')
 
4893
            stored_submit_branch = branch.get_submit_branch()
 
4894
            remembered_submit_branch = None
 
4895
            if submit_branch is None:
 
4896
                submit_branch = stored_submit_branch
 
4897
                remembered_submit_branch = "submit"
 
4898
            else:
 
4899
                if stored_submit_branch is None or remember:
 
4900
                    branch.set_submit_branch(submit_branch)
 
4901
            if submit_branch is None:
 
4902
                submit_branch = branch.get_parent()
 
4903
                remembered_submit_branch = "parent"
 
4904
            if submit_branch is None:
 
4905
                raise errors.BzrCommandError('No submit branch known or'
 
4906
                                             ' specified')
 
4907
            if remembered_submit_branch is not None:
 
4908
                note('Using saved %s location "%s" to determine what '
 
4909
                        'changes to submit.', remembered_submit_branch,
 
4910
                        submit_branch)
 
4911
 
 
4912
            if mail_to is None:
 
4913
                submit_config = Branch.open(submit_branch).get_config()
 
4914
                mail_to = submit_config.get_user_option("child_submit_to")
 
4915
 
 
4916
            stored_public_branch = branch.get_public_branch()
 
4917
            if public_branch is None:
 
4918
                public_branch = stored_public_branch
 
4919
            elif stored_public_branch is None or remember:
 
4920
                branch.set_public_branch(public_branch)
 
4921
            if no_bundle and public_branch is None:
 
4922
                raise errors.BzrCommandError('No public branch specified or'
 
4923
                                             ' known')
 
4924
            base_revision_id = None
 
4925
            revision_id = None
 
4926
            if revision is not None:
 
4927
                if len(revision) > 2:
 
4928
                    raise errors.BzrCommandError('bzr send takes '
 
4929
                        'at most two one revision identifiers')
 
4930
                revision_id = revision[-1].as_revision_id(branch)
 
4931
                if len(revision) == 2:
 
4932
                    base_revision_id = revision[0].as_revision_id(branch)
 
4933
            if revision_id is None:
 
4934
                revision_id = branch.last_revision()
 
4935
            if revision_id == NULL_REVISION:
 
4936
                raise errors.BzrCommandError('No revisions to submit.')
 
4937
            if format == '4':
 
4938
                directive = merge_directive.MergeDirective2.from_objects(
 
4939
                    branch.repository, revision_id, time.time(),
 
4940
                    osutils.local_time_offset(), submit_branch,
 
4941
                    public_branch=public_branch, include_patch=not no_patch,
 
4942
                    include_bundle=not no_bundle, message=message,
 
4943
                    base_revision_id=base_revision_id)
 
4944
            elif format == '0.9':
 
4945
                if not no_bundle:
 
4946
                    if not no_patch:
 
4947
                        patch_type = 'bundle'
 
4948
                    else:
 
4949
                        raise errors.BzrCommandError('Format 0.9 does not'
 
4950
                            ' permit bundle with no patch')
 
4951
                else:
 
4952
                    if not no_patch:
 
4953
                        patch_type = 'diff'
 
4954
                    else:
 
4955
                        patch_type = None
 
4956
                directive = merge_directive.MergeDirective.from_objects(
 
4957
                    branch.repository, revision_id, time.time(),
 
4958
                    osutils.local_time_offset(), submit_branch,
 
4959
                    public_branch=public_branch, patch_type=patch_type,
 
4960
                    message=message)
 
4961
 
 
4962
            outfile.writelines(directive.to_lines())
 
4963
            if output is None:
 
4964
                subject = '[MERGE] '
 
4965
                if message is not None:
 
4966
                    subject += message
 
4967
                else:
 
4968
                    revision = branch.repository.get_revision(revision_id)
 
4969
                    subject += revision.get_summary()
 
4970
                basename = directive.get_disk_name(branch)
 
4971
                mail_client.compose_merge_request(mail_to, subject,
 
4972
                                                  outfile.getvalue(),
 
4973
                                                  basename, body)
 
4974
        finally:
 
4975
            if output != '-':
 
4976
                outfile.close()
 
4977
            branch.unlock()
5205
4978
 
5206
4979
 
5207
4980
class cmd_bundle_revisions(cmd_send):
5208
 
    __doc__ = """Create a merge-directive for submitting changes.
 
4981
 
 
4982
    """Create a merge-directive for submitting changes.
5209
4983
 
5210
4984
    A merge directive provides many things needed for requesting merges:
5211
4985
 
5251
5025
               type=unicode),
5252
5026
        Option('output', short_name='o', help='Write directive to this file.',
5253
5027
               type=unicode),
5254
 
        Option('strict',
5255
 
               help='Refuse to bundle revisions if there are uncommitted'
5256
 
               ' changes in the working tree, --no-strict disables the check.'),
5257
5028
        'revision',
5258
 
        RegistryOption('format',
5259
 
                       help='Use the specified output format.',
5260
 
                       lazy_registry=('bzrlib.send', 'format_registry')),
 
5029
        RegistryOption.from_kwargs('format',
 
5030
        'Use the specified output format.',
 
5031
        **{'4': 'Bundle format 4, Merge Directive 2 (default)',
 
5032
           '0.9': 'Bundle format 0.9, Merge Directive 1',})
5261
5033
        ]
5262
5034
    aliases = ['bundle']
5263
5035
 
5267
5039
 
5268
5040
    def run(self, submit_branch=None, public_branch=None, no_bundle=False,
5269
5041
            no_patch=False, revision=None, remember=False, output=None,
5270
 
            format=None, strict=None, **kwargs):
 
5042
            format='4', **kwargs):
5271
5043
        if output is None:
5272
5044
            output = '-'
5273
 
        from bzrlib.send import send
5274
 
        return send(submit_branch, revision, public_branch, remember,
 
5045
        return self._run(submit_branch, revision, public_branch, remember,
5275
5046
                         format, no_bundle, no_patch, output,
5276
 
                         kwargs.get('from', '.'), None, None, None,
5277
 
                         self.outf, strict=strict)
 
5047
                         kwargs.get('from', '.'), None, None, None)
5278
5048
 
5279
5049
 
5280
5050
class cmd_tag(Command):
5281
 
    __doc__ = """Create, remove or modify a tag naming a revision.
 
5051
    """Create, remove or modify a tag naming a revision.
5282
5052
 
5283
5053
    Tags give human-meaningful names to revisions.  Commands that take a -r
5284
5054
    (--revision) option can be given -rtag:X, where X is any previously
5292
5062
 
5293
5063
    To rename a tag (change the name but keep it on the same revsion), run ``bzr
5294
5064
    tag new-name -r tag:old-name`` and then ``bzr tag --delete oldname``.
5295
 
 
5296
 
    If no tag name is specified it will be determined through the 
5297
 
    'automatic_tag_name' hook. This can e.g. be used to automatically tag
5298
 
    upstream releases by reading configure.ac. See ``bzr help hooks`` for
5299
 
    details.
5300
5065
    """
5301
5066
 
5302
5067
    _see_also = ['commit', 'tags']
5303
 
    takes_args = ['tag_name?']
 
5068
    takes_args = ['tag_name']
5304
5069
    takes_options = [
5305
5070
        Option('delete',
5306
5071
            help='Delete this tag rather than placing it.',
5307
5072
            ),
5308
 
        custom_help('directory',
5309
 
            help='Branch in which to place the tag.'),
 
5073
        Option('directory',
 
5074
            help='Branch in which to place the tag.',
 
5075
            short_name='d',
 
5076
            type=unicode,
 
5077
            ),
5310
5078
        Option('force',
5311
5079
            help='Replace existing tags.',
5312
5080
            ),
5313
5081
        'revision',
5314
5082
        ]
5315
5083
 
5316
 
    def run(self, tag_name=None,
 
5084
    def run(self, tag_name,
5317
5085
            delete=None,
5318
5086
            directory='.',
5319
5087
            force=None,
5320
5088
            revision=None,
5321
5089
            ):
5322
5090
        branch, relpath = Branch.open_containing(directory)
5323
 
        self.add_cleanup(branch.lock_write().unlock)
5324
 
        if delete:
5325
 
            if tag_name is None:
5326
 
                raise errors.BzrCommandError("No tag specified to delete.")
5327
 
            branch.tags.delete_tag(tag_name)
5328
 
            self.outf.write('Deleted tag %s.\n' % tag_name)
5329
 
        else:
5330
 
            if revision:
5331
 
                if len(revision) != 1:
5332
 
                    raise errors.BzrCommandError(
5333
 
                        "Tags can only be placed on a single revision, "
5334
 
                        "not on a range")
5335
 
                revision_id = revision[0].as_revision_id(branch)
 
5091
        branch.lock_write()
 
5092
        try:
 
5093
            if delete:
 
5094
                branch.tags.delete_tag(tag_name)
 
5095
                self.outf.write('Deleted tag %s.\n' % tag_name)
5336
5096
            else:
5337
 
                revision_id = branch.last_revision()
5338
 
            if tag_name is None:
5339
 
                tag_name = branch.automatic_tag_name(revision_id)
5340
 
                if tag_name is None:
5341
 
                    raise errors.BzrCommandError(
5342
 
                        "Please specify a tag name.")
5343
 
            if (not force) and branch.tags.has_tag(tag_name):
5344
 
                raise errors.TagAlreadyExists(tag_name)
5345
 
            branch.tags.set_tag(tag_name, revision_id)
5346
 
            self.outf.write('Created tag %s.\n' % tag_name)
 
5097
                if revision:
 
5098
                    if len(revision) != 1:
 
5099
                        raise errors.BzrCommandError(
 
5100
                            "Tags can only be placed on a single revision, "
 
5101
                            "not on a range")
 
5102
                    revision_id = revision[0].as_revision_id(branch)
 
5103
                else:
 
5104
                    revision_id = branch.last_revision()
 
5105
                if (not force) and branch.tags.has_tag(tag_name):
 
5106
                    raise errors.TagAlreadyExists(tag_name)
 
5107
                branch.tags.set_tag(tag_name, revision_id)
 
5108
                self.outf.write('Created tag %s.\n' % tag_name)
 
5109
        finally:
 
5110
            branch.unlock()
5347
5111
 
5348
5112
 
5349
5113
class cmd_tags(Command):
5350
 
    __doc__ = """List tags.
 
5114
    """List tags.
5351
5115
 
5352
5116
    This command shows a table of tag names and the revisions they reference.
5353
5117
    """
5354
5118
 
5355
5119
    _see_also = ['tag']
5356
5120
    takes_options = [
5357
 
        custom_help('directory',
5358
 
            help='Branch whose tags should be displayed.'),
 
5121
        Option('directory',
 
5122
            help='Branch whose tags should be displayed.',
 
5123
            short_name='d',
 
5124
            type=unicode,
 
5125
            ),
5359
5126
        RegistryOption.from_kwargs('sort',
5360
5127
            'Sort tags by different criteria.', title='Sorting',
5361
5128
            alpha='Sort tags lexicographically (default).',
5378
5145
        if not tags:
5379
5146
            return
5380
5147
 
5381
 
        self.add_cleanup(branch.lock_read().unlock)
5382
5148
        if revision:
5383
 
            graph = branch.repository.get_graph()
5384
 
            rev1, rev2 = _get_revision_range(revision, branch, self.name())
5385
 
            revid1, revid2 = rev1.rev_id, rev2.rev_id
5386
 
            # only show revisions between revid1 and revid2 (inclusive)
5387
 
            tags = [(tag, revid) for tag, revid in tags if
5388
 
                graph.is_between(revid, revid1, revid2)]
 
5149
            branch.lock_read()
 
5150
            try:
 
5151
                graph = branch.repository.get_graph()
 
5152
                rev1, rev2 = _get_revision_range(revision, branch, self.name())
 
5153
                revid1, revid2 = rev1.rev_id, rev2.rev_id
 
5154
                # only show revisions between revid1 and revid2 (inclusive)
 
5155
                tags = [(tag, revid) for tag, revid in tags if
 
5156
                    graph.is_between(revid, revid1, revid2)]
 
5157
            finally:
 
5158
                branch.unlock()
5389
5159
        if sort == 'alpha':
5390
5160
            tags.sort()
5391
5161
        elif sort == 'time':
5401
5171
            tags.sort(key=lambda x: timestamps[x[1]])
5402
5172
        if not show_ids:
5403
5173
            # [ (tag, revid), ... ] -> [ (tag, dotted_revno), ... ]
5404
 
            for index, (tag, revid) in enumerate(tags):
5405
 
                try:
5406
 
                    revno = branch.revision_id_to_dotted_revno(revid)
5407
 
                    if isinstance(revno, tuple):
5408
 
                        revno = '.'.join(map(str, revno))
5409
 
                except errors.NoSuchRevision:
5410
 
                    # Bad tag data/merges can lead to tagged revisions
5411
 
                    # which are not in this branch. Fail gracefully ...
5412
 
                    revno = '?'
5413
 
                tags[index] = (tag, revno)
5414
 
        self.cleanup_now()
 
5174
            revno_map = branch.get_revision_id_to_revno_map()
 
5175
            tags = [ (tag, '.'.join(map(str, revno_map.get(revid, ('?',)))))
 
5176
                        for tag, revid in tags ]
5415
5177
        for tag, revspec in tags:
5416
5178
            self.outf.write('%-20s %s\n' % (tag, revspec))
5417
5179
 
5418
5180
 
5419
5181
class cmd_reconfigure(Command):
5420
 
    __doc__ = """Reconfigure the type of a bzr directory.
 
5182
    """Reconfigure the type of a bzr directory.
5421
5183
 
5422
5184
    A target configuration must be specified.
5423
5185
 
5453
5215
            ),
5454
5216
        Option('bind-to', help='Branch to bind checkout to.', type=str),
5455
5217
        Option('force',
5456
 
            help='Perform reconfiguration even if local changes'
5457
 
            ' will be lost.'),
5458
 
        Option('stacked-on',
5459
 
            help='Reconfigure a branch to be stacked on another branch.',
5460
 
            type=unicode,
5461
 
            ),
5462
 
        Option('unstacked',
5463
 
            help='Reconfigure a branch to be unstacked.  This '
5464
 
                'may require copying substantial data into it.',
5465
 
            ),
 
5218
               help='Perform reconfiguration even if local changes'
 
5219
               ' will be lost.')
5466
5220
        ]
5467
5221
 
5468
 
    def run(self, location=None, target_type=None, bind_to=None, force=False,
5469
 
            stacked_on=None,
5470
 
            unstacked=None):
 
5222
    def run(self, location=None, target_type=None, bind_to=None, force=False):
5471
5223
        directory = bzrdir.BzrDir.open(location)
5472
 
        if stacked_on and unstacked:
5473
 
            raise BzrCommandError("Can't use both --stacked-on and --unstacked")
5474
 
        elif stacked_on is not None:
5475
 
            reconfigure.ReconfigureStackedOn().apply(directory, stacked_on)
5476
 
        elif unstacked:
5477
 
            reconfigure.ReconfigureUnstacked().apply(directory)
5478
 
        # At the moment you can use --stacked-on and a different
5479
 
        # reconfiguration shape at the same time; there seems no good reason
5480
 
        # to ban it.
5481
5224
        if target_type is None:
5482
 
            if stacked_on or unstacked:
5483
 
                return
5484
 
            else:
5485
 
                raise errors.BzrCommandError('No target configuration '
5486
 
                    'specified')
 
5225
            raise errors.BzrCommandError('No target configuration specified')
5487
5226
        elif target_type == 'branch':
5488
5227
            reconfiguration = reconfigure.Reconfigure.to_branch(directory)
5489
5228
        elif target_type == 'tree':
5508
5247
 
5509
5248
 
5510
5249
class cmd_switch(Command):
5511
 
    __doc__ = """Set the branch of a checkout and update.
 
5250
    """Set the branch of a checkout and update.
5512
5251
 
5513
5252
    For lightweight checkouts, this changes the branch being referenced.
5514
5253
    For heavyweight checkouts, this checks that there are no local commits
5526
5265
    /path/to/newbranch.
5527
5266
 
5528
5267
    Bound branches use the nickname of its master branch unless it is set
5529
 
    locally, in which case switching will update the local nickname to be
 
5268
    locally, in which case switching will update the the local nickname to be
5530
5269
    that of the master.
5531
5270
    """
5532
5271
 
5533
 
    takes_args = ['to_location?']
 
5272
    takes_args = ['to_location']
5534
5273
    takes_options = [Option('force',
5535
 
                        help='Switch even if local commits will be lost.'),
5536
 
                     'revision',
5537
 
                     Option('create-branch', short_name='b',
5538
 
                        help='Create the target branch from this one before'
5539
 
                             ' switching to it.'),
5540
 
                    ]
 
5274
                        help='Switch even if local commits will be lost.')
 
5275
                     ]
5541
5276
 
5542
 
    def run(self, to_location=None, force=False, create_branch=False,
5543
 
            revision=None):
 
5277
    def run(self, to_location, force=False):
5544
5278
        from bzrlib import switch
5545
5279
        tree_location = '.'
5546
 
        revision = _get_one_revision('switch', revision)
5547
5280
        control_dir = bzrdir.BzrDir.open_containing(tree_location)[0]
5548
 
        if to_location is None:
5549
 
            if revision is None:
5550
 
                raise errors.BzrCommandError('You must supply either a'
5551
 
                                             ' revision or a location')
5552
 
            to_location = '.'
 
5281
        branch = control_dir.open_branch()
5553
5282
        try:
5554
 
            branch = control_dir.open_branch()
5555
 
            had_explicit_nick = branch.get_config().has_explicit_nickname()
 
5283
            to_branch = Branch.open(to_location)
5556
5284
        except errors.NotBranchError:
5557
 
            branch = None
5558
 
            had_explicit_nick = False
5559
 
        if create_branch:
5560
 
            if branch is None:
5561
 
                raise errors.BzrCommandError('cannot create branch without'
5562
 
                                             ' source branch')
5563
 
            to_location = directory_service.directories.dereference(
5564
 
                              to_location)
5565
 
            if '/' not in to_location and '\\' not in to_location:
5566
 
                # This path is meant to be relative to the existing branch
5567
 
                this_url = self._get_branch_location(control_dir)
5568
 
                to_location = urlutils.join(this_url, '..', to_location)
5569
 
            to_branch = branch.bzrdir.sprout(to_location,
5570
 
                                 possible_transports=[branch.bzrdir.root_transport],
5571
 
                                 source_branch=branch).open_branch()
5572
 
        else:
5573
 
            try:
5574
 
                to_branch = Branch.open(to_location)
5575
 
            except errors.NotBranchError:
5576
 
                this_url = self._get_branch_location(control_dir)
5577
 
                to_branch = Branch.open(
5578
 
                    urlutils.join(this_url, '..', to_location))
5579
 
        if revision is not None:
5580
 
            revision = revision.as_revision_id(to_branch)
5581
 
        switch.switch(control_dir, to_branch, force, revision_id=revision)
5582
 
        if had_explicit_nick:
 
5285
            this_branch = control_dir.open_branch()
 
5286
            # This may be a heavy checkout, where we want the master branch
 
5287
            this_url = this_branch.get_bound_location()
 
5288
            # If not, use a local sibling
 
5289
            if this_url is None:
 
5290
                this_url = this_branch.base
 
5291
            to_branch = Branch.open(
 
5292
                urlutils.join(this_url, '..', to_location))
 
5293
        switch.switch(control_dir, to_branch, force)
 
5294
        if branch.get_config().has_explicit_nickname():
5583
5295
            branch = control_dir.open_branch() #get the new branch!
5584
5296
            branch.nick = to_branch.nick
5585
5297
        note('Switched to branch: %s',
5586
5298
            urlutils.unescape_for_display(to_branch.base, 'utf-8'))
5587
5299
 
5588
 
    def _get_branch_location(self, control_dir):
5589
 
        """Return location of branch for this control dir."""
5590
 
        try:
5591
 
            this_branch = control_dir.open_branch()
5592
 
            # This may be a heavy checkout, where we want the master branch
5593
 
            master_location = this_branch.get_bound_location()
5594
 
            if master_location is not None:
5595
 
                return master_location
5596
 
            # If not, use a local sibling
5597
 
            return this_branch.base
5598
 
        except errors.NotBranchError:
5599
 
            format = control_dir.find_branch_format()
5600
 
            if getattr(format, 'get_reference', None) is not None:
5601
 
                return format.get_reference(control_dir)
5602
 
            else:
5603
 
                return control_dir.root_transport.base
5604
 
 
5605
5300
 
5606
5301
class cmd_view(Command):
5607
 
    __doc__ = """Manage filtered views.
 
5302
    """Manage filtered views.
5608
5303
 
5609
5304
    Views provide a mask over the tree so that users can focus on
5610
5305
    a subset of a tree when doing their work. After creating a view,
5758
5453
 
5759
5454
 
5760
5455
class cmd_hooks(Command):
5761
 
    __doc__ = """Show hooks."""
 
5456
    """Show hooks."""
5762
5457
 
5763
5458
    hidden = True
5764
5459
 
5777
5472
                    self.outf.write("    <no hooks installed>\n")
5778
5473
 
5779
5474
 
5780
 
class cmd_remove_branch(Command):
5781
 
    __doc__ = """Remove a branch.
5782
 
 
5783
 
    This will remove the branch from the specified location but 
5784
 
    will keep any working tree or repository in place.
5785
 
 
5786
 
    :Examples:
5787
 
 
5788
 
      Remove the branch at repo/trunk::
5789
 
 
5790
 
        bzr remove-branch repo/trunk
5791
 
 
5792
 
    """
5793
 
 
5794
 
    takes_args = ["location?"]
5795
 
 
5796
 
    aliases = ["rmbranch"]
5797
 
 
5798
 
    def run(self, location=None):
5799
 
        if location is None:
5800
 
            location = "."
5801
 
        branch = Branch.open_containing(location)[0]
5802
 
        branch.bzrdir.destroy_branch()
5803
 
        
5804
 
 
5805
5475
class cmd_shelve(Command):
5806
 
    __doc__ = """Temporarily set aside some changes from the current tree.
 
5476
    """Temporarily set aside some changes from the current tree.
5807
5477
 
5808
5478
    Shelve allows you to temporarily put changes you've made "on the shelf",
5809
5479
    ie. out of the way, until a later time when you can bring them back from
5851
5521
        if writer is None:
5852
5522
            writer = bzrlib.option.diff_writer_registry.get()
5853
5523
        try:
5854
 
            shelver = Shelver.from_args(writer(sys.stdout), revision, all,
5855
 
                file_list, message, destroy=destroy)
5856
 
            try:
5857
 
                shelver.run()
5858
 
            finally:
5859
 
                shelver.finalize()
 
5524
            Shelver.from_args(writer(sys.stdout), revision, all, file_list,
 
5525
                              message, destroy=destroy).run()
5860
5526
        except errors.UserAbort:
5861
5527
            return 0
5862
5528
 
5863
5529
    def run_for_list(self):
5864
5530
        tree = WorkingTree.open_containing('.')[0]
5865
 
        self.add_cleanup(tree.lock_read().unlock)
5866
 
        manager = tree.get_shelf_manager()
5867
 
        shelves = manager.active_shelves()
5868
 
        if len(shelves) == 0:
5869
 
            note('No shelved changes.')
5870
 
            return 0
5871
 
        for shelf_id in reversed(shelves):
5872
 
            message = manager.get_metadata(shelf_id).get('message')
5873
 
            if message is None:
5874
 
                message = '<no message>'
5875
 
            self.outf.write('%3d: %s\n' % (shelf_id, message))
5876
 
        return 1
 
5531
        tree.lock_read()
 
5532
        try:
 
5533
            manager = tree.get_shelf_manager()
 
5534
            shelves = manager.active_shelves()
 
5535
            if len(shelves) == 0:
 
5536
                note('No shelved changes.')
 
5537
                return 0
 
5538
            for shelf_id in reversed(shelves):
 
5539
                message = manager.get_metadata(shelf_id).get('message')
 
5540
                if message is None:
 
5541
                    message = '<no message>'
 
5542
                self.outf.write('%3d: %s\n' % (shelf_id, message))
 
5543
            return 1
 
5544
        finally:
 
5545
            tree.unlock()
5877
5546
 
5878
5547
 
5879
5548
class cmd_unshelve(Command):
5880
 
    __doc__ = """Restore shelved changes.
 
5549
    """Restore shelved changes.
5881
5550
 
5882
5551
    By default, the most recently shelved changes are restored. However if you
5883
5552
    specify a shelf by id those changes will be restored instead.  This works
5891
5560
            enum_switch=False, value_switches=True,
5892
5561
            apply="Apply changes and remove from the shelf.",
5893
5562
            dry_run="Show changes, but do not apply or remove them.",
5894
 
            preview="Instead of unshelving the changes, show the diff that "
5895
 
                    "would result from unshelving.",
5896
 
            delete_only="Delete changes without applying them.",
5897
 
            keep="Apply changes but don't delete them.",
 
5563
            delete_only="Delete changes without applying them."
5898
5564
        )
5899
5565
    ]
5900
5566
    _see_also = ['shelve']
5901
5567
 
5902
5568
    def run(self, shelf_id=None, action='apply'):
5903
5569
        from bzrlib.shelf_ui import Unshelver
5904
 
        unshelver = Unshelver.from_args(shelf_id, action)
5905
 
        try:
5906
 
            unshelver.run()
5907
 
        finally:
5908
 
            unshelver.tree.unlock()
 
5570
        Unshelver.from_args(shelf_id, action).run()
5909
5571
 
5910
5572
 
5911
5573
class cmd_clean_tree(Command):
5912
 
    __doc__ = """Remove unwanted files from working tree.
 
5574
    """Remove unwanted files from working tree.
5913
5575
 
5914
5576
    By default, only unknown files, not ignored files, are deleted.  Versioned
5915
5577
    files are never deleted.
5923
5585
 
5924
5586
    To check what clean-tree will do, use --dry-run.
5925
5587
    """
5926
 
    takes_options = ['directory',
5927
 
                     Option('ignored', help='Delete all ignored files.'),
 
5588
    takes_options = [Option('ignored', help='Delete all ignored files.'),
5928
5589
                     Option('detritus', help='Delete conflict files, merge'
5929
5590
                            ' backups, and failed selftest dirs.'),
5930
5591
                     Option('unknown',
5933
5594
                            ' deleting them.'),
5934
5595
                     Option('force', help='Do not prompt before deleting.')]
5935
5596
    def run(self, unknown=False, ignored=False, detritus=False, dry_run=False,
5936
 
            force=False, directory=u'.'):
 
5597
            force=False):
5937
5598
        from bzrlib.clean_tree import clean_tree
5938
5599
        if not (unknown or ignored or detritus):
5939
5600
            unknown = True
5940
5601
        if dry_run:
5941
5602
            force = True
5942
 
        clean_tree(directory, unknown=unknown, ignored=ignored,
5943
 
                   detritus=detritus, dry_run=dry_run, no_prompt=force)
 
5603
        clean_tree('.', unknown=unknown, ignored=ignored, detritus=detritus,
 
5604
                   dry_run=dry_run, no_prompt=force)
5944
5605
 
5945
5606
 
5946
5607
class cmd_reference(Command):
5947
 
    __doc__ = """list, view and set branch locations for nested trees.
 
5608
    """list, view and set branch locations for nested trees.
5948
5609
 
5949
5610
    If no arguments are provided, lists the branch locations for nested trees.
5950
5611
    If one argument is provided, display the branch location for that tree.
5990
5651
            self.outf.write('%s %s\n' % (path, location))
5991
5652
 
5992
5653
 
5993
 
def _register_lazy_builtins():
5994
 
    # register lazy builtins from other modules; called at startup and should
5995
 
    # be only called once.
5996
 
    for (name, aliases, module_name) in [
5997
 
        ('cmd_bundle_info', [], 'bzrlib.bundle.commands'),
5998
 
        ('cmd_dpush', [], 'bzrlib.foreign'),
5999
 
        ('cmd_version_info', [], 'bzrlib.cmd_version_info'),
6000
 
        ('cmd_resolve', ['resolved'], 'bzrlib.conflicts'),
6001
 
        ('cmd_conflicts', [], 'bzrlib.conflicts'),
6002
 
        ('cmd_sign_my_commits', [], 'bzrlib.sign_my_commits'),
6003
 
        ]:
6004
 
        builtin_command_registry.register_lazy(name, aliases, module_name)
 
5654
# these get imported and then picked up by the scan for cmd_*
 
5655
# TODO: Some more consistent way to split command definitions across files;
 
5656
# we do need to load at least some information about them to know of
 
5657
# aliases.  ideally we would avoid loading the implementation until the
 
5658
# details were needed.
 
5659
from bzrlib.cmd_version_info import cmd_version_info
 
5660
from bzrlib.conflicts import cmd_resolve, cmd_conflicts, restore
 
5661
from bzrlib.bundle.commands import (
 
5662
    cmd_bundle_info,
 
5663
    )
 
5664
from bzrlib.foreign import cmd_dpush
 
5665
from bzrlib.sign_my_commits import cmd_sign_my_commits
 
5666
from bzrlib.weave_commands import cmd_versionedfile_list, \
 
5667
        cmd_weave_plan_merge, cmd_weave_merge_text