~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/builtins.py

Show diffs side-by-side

added added

removed removed

Lines of Context:
1
 
# Copyright (C) 2004, 2005, 2006, 2007, 2008, 2009 Canonical Ltd
 
1
# Copyright (C) 2005-2010 Canonical Ltd
2
2
#
3
3
# This program is free software; you can redistribute it and/or modify
4
4
# it under the terms of the GNU General Public License as published by
31
31
    bundle,
32
32
    btree_index,
33
33
    bzrdir,
 
34
    directory_service,
34
35
    delta,
35
36
    config,
36
37
    errors,
43
44
    reconfigure,
44
45
    rename_map,
45
46
    revision as _mod_revision,
 
47
    static_tuple,
46
48
    symbol_versioning,
 
49
    timestamp,
47
50
    transport,
48
 
    tree as _mod_tree,
49
51
    ui,
50
52
    urlutils,
51
53
    views,
52
54
    )
53
55
from bzrlib.branch import Branch
54
56
from bzrlib.conflicts import ConflictList
 
57
from bzrlib.transport import memory
55
58
from bzrlib.revisionspec import RevisionSpec, RevisionInfo
56
59
from bzrlib.smtp_connection import SMTPConnection
57
60
from bzrlib.workingtree import WorkingTree
58
61
""")
59
62
 
60
 
from bzrlib.commands import Command, display_command
 
63
from bzrlib.commands import (
 
64
    Command,
 
65
    builtin_command_registry,
 
66
    display_command,
 
67
    )
61
68
from bzrlib.option import (
62
69
    ListOption,
63
70
    Option,
79
86
 
80
87
 
81
88
def tree_files_for_add(file_list):
82
 
    """Add handles files a bit differently so it a custom implementation."""
 
89
    """
 
90
    Return a tree and list of absolute paths from a file list.
 
91
 
 
92
    Similar to tree_files, but add handles files a bit differently, so it a
 
93
    custom implementation.  In particular, MutableTreeTree.smart_add expects
 
94
    absolute paths, which it immediately converts to relative paths.
 
95
    """
 
96
    # FIXME Would be nice to just return the relative paths like
 
97
    # internal_tree_files does, but there are a large number of unit tests
 
98
    # that assume the current interface to mutabletree.smart_add
83
99
    if file_list:
84
 
        tree = WorkingTree.open_containing(file_list[0])[0]
 
100
        tree, relpath = WorkingTree.open_containing(file_list[0])
85
101
        if tree.supports_views():
86
102
            view_files = tree.views.lookup_view()
87
103
            if view_files:
88
104
                for filename in file_list:
89
105
                    if not osutils.is_inside_any(view_files, filename):
90
106
                        raise errors.FileOutsideView(filename, view_files)
 
107
        file_list = file_list[:]
 
108
        file_list[0] = tree.abspath(relpath)
91
109
    else:
92
110
        tree = WorkingTree.open_containing(u'.')[0]
93
111
        if tree.supports_views():
110
128
 
111
129
 
112
130
def _get_one_revision_tree(command_name, revisions, branch=None, tree=None):
 
131
    """Get a revision tree. Not suitable for commands that change the tree.
 
132
    
 
133
    Specifically, the basis tree in dirstate trees is coupled to the dirstate
 
134
    and doing a commit/uncommit/pull will at best fail due to changing the
 
135
    basis revision data.
 
136
 
 
137
    If tree is passed in, it should be already locked, for lifetime management
 
138
    of the trees internal cached state.
 
139
    """
113
140
    if branch is None:
114
141
        branch = tree.branch
115
142
    if revisions is None:
205
232
    return view_info
206
233
 
207
234
 
 
235
def _open_directory_or_containing_tree_or_branch(filename, directory):
 
236
    """Open the tree or branch containing the specified file, unless
 
237
    the --directory option is used to specify a different branch."""
 
238
    if directory is not None:
 
239
        return (None, Branch.open(directory), filename)
 
240
    return bzrdir.BzrDir.open_containing_tree_or_branch(filename)
 
241
 
 
242
 
208
243
# TODO: Make sure no commands unconditionally use the working directory as a
209
244
# branch.  If a filename argument is used, the first of them should be used to
210
245
# specify the branch.  (Perhaps this can be factored out into some kind of
212
247
# opens the branch?)
213
248
 
214
249
class cmd_status(Command):
215
 
    """Display status summary.
 
250
    __doc__ = """Display status summary.
216
251
 
217
252
    This reports on versioned and unknown files, reporting them
218
253
    grouped by state.  Possible states are:
238
273
    unknown
239
274
        Not versioned and not matching an ignore pattern.
240
275
 
 
276
    Additionally for directories, symlinks and files with an executable
 
277
    bit, Bazaar indicates their type using a trailing character: '/', '@'
 
278
    or '*' respectively.
 
279
 
241
280
    To see ignored files use 'bzr ignored'.  For details on the
242
281
    changes to file texts, use 'bzr diff'.
243
282
 
301
340
 
302
341
 
303
342
class cmd_cat_revision(Command):
304
 
    """Write out metadata for a revision.
 
343
    __doc__ = """Write out metadata for a revision.
305
344
 
306
345
    The revision to print can either be specified by a specific
307
346
    revision identifier, or you can use --revision.
309
348
 
310
349
    hidden = True
311
350
    takes_args = ['revision_id?']
312
 
    takes_options = ['revision']
 
351
    takes_options = ['directory', 'revision']
313
352
    # cat-revision is more for frontends so should be exact
314
353
    encoding = 'strict'
315
354
 
 
355
    def print_revision(self, revisions, revid):
 
356
        stream = revisions.get_record_stream([(revid,)], 'unordered', True)
 
357
        record = stream.next()
 
358
        if record.storage_kind == 'absent':
 
359
            raise errors.NoSuchRevision(revisions, revid)
 
360
        revtext = record.get_bytes_as('fulltext')
 
361
        self.outf.write(revtext.decode('utf-8'))
 
362
 
316
363
    @display_command
317
 
    def run(self, revision_id=None, revision=None):
 
364
    def run(self, revision_id=None, revision=None, directory=u'.'):
318
365
        if revision_id is not None and revision is not None:
319
366
            raise errors.BzrCommandError('You can only supply one of'
320
367
                                         ' revision_id or --revision')
321
368
        if revision_id is None and revision is None:
322
369
            raise errors.BzrCommandError('You must supply either'
323
370
                                         ' --revision or a revision_id')
324
 
        b = WorkingTree.open_containing(u'.')[0].branch
325
 
 
326
 
        # TODO: jam 20060112 should cat-revision always output utf-8?
327
 
        if revision_id is not None:
328
 
            revision_id = osutils.safe_revision_id(revision_id, warn=False)
329
 
            try:
330
 
                self.outf.write(b.repository.get_revision_xml(revision_id).decode('utf-8'))
331
 
            except errors.NoSuchRevision:
332
 
                msg = "The repository %s contains no revision %s." % (b.repository.base,
333
 
                    revision_id)
334
 
                raise errors.BzrCommandError(msg)
335
 
        elif revision is not None:
336
 
            for rev in revision:
337
 
                if rev is None:
338
 
                    raise errors.BzrCommandError('You cannot specify a NULL'
339
 
                                                 ' revision.')
340
 
                rev_id = rev.as_revision_id(b)
341
 
                self.outf.write(b.repository.get_revision_xml(rev_id).decode('utf-8'))
342
 
 
 
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
        
343
399
 
344
400
class cmd_dump_btree(Command):
345
 
    """Dump the contents of a btree index file to stdout.
 
401
    __doc__ = """Dump the contents of a btree index file to stdout.
346
402
 
347
403
    PATH is a btree index file, it can be any URL. This includes things like
348
404
    .bzr/repository/pack-names, or .bzr/repository/indices/a34b3a...ca4a4.iix
412
468
        for node in bt.iter_all_entries():
413
469
            # Node is made up of:
414
470
            # (index, key, value, [references])
415
 
            self.outf.write('%s\n' % (node[1:],))
 
471
            try:
 
472
                refs = node[3]
 
473
            except IndexError:
 
474
                refs_as_tuples = None
 
475
            else:
 
476
                refs_as_tuples = static_tuple.as_tuples(refs)
 
477
            as_tuple = (tuple(node[1]), node[2], refs_as_tuples)
 
478
            self.outf.write('%s\n' % (as_tuple,))
416
479
 
417
480
 
418
481
class cmd_remove_tree(Command):
419
 
    """Remove the working tree from a given branch/checkout.
 
482
    __doc__ = """Remove the working tree from a given branch/checkout.
420
483
 
421
484
    Since a lightweight checkout is little more than a working tree
422
485
    this will refuse to run against one.
424
487
    To re-create the working tree, use "bzr checkout".
425
488
    """
426
489
    _see_also = ['checkout', 'working-trees']
427
 
    takes_args = ['location?']
 
490
    takes_args = ['location*']
428
491
    takes_options = [
429
492
        Option('force',
430
493
               help='Remove the working tree even if it has '
431
 
                    'uncommitted changes.'),
 
494
                    'uncommitted or shelved changes.'),
432
495
        ]
433
496
 
434
 
    def run(self, location='.', force=False):
435
 
        d = bzrdir.BzrDir.open(location)
436
 
 
437
 
        try:
438
 
            working = d.open_workingtree()
439
 
        except errors.NoWorkingTree:
440
 
            raise errors.BzrCommandError("No working tree to remove")
441
 
        except errors.NotLocalUrl:
442
 
            raise errors.BzrCommandError("You cannot remove the working tree of a "
443
 
                                         "remote path")
444
 
        if not force:
445
 
            changes = working.changes_from(working.basis_tree())
446
 
            if changes.has_changed():
447
 
                raise errors.UncommittedChanges(working)
448
 
 
449
 
        working_path = working.bzrdir.root_transport.base
450
 
        branch_path = working.branch.bzrdir.root_transport.base
451
 
        if working_path != branch_path:
452
 
            raise errors.BzrCommandError("You cannot remove the working tree from "
453
 
                                         "a lightweight checkout")
454
 
 
455
 
        d.destroy_workingtree()
 
497
    def run(self, location_list, force=False):
 
498
        if not location_list:
 
499
            location_list=['.']
 
500
 
 
501
        for location in location_list:
 
502
            d = bzrdir.BzrDir.open(location)
 
503
            
 
504
            try:
 
505
                working = d.open_workingtree()
 
506
            except errors.NoWorkingTree:
 
507
                raise errors.BzrCommandError("No working tree to remove")
 
508
            except errors.NotLocalUrl:
 
509
                raise errors.BzrCommandError("You cannot remove the working tree"
 
510
                                             " of a remote path")
 
511
            if not force:
 
512
                if (working.has_changes()):
 
513
                    raise errors.UncommittedChanges(working)
 
514
                if working.get_shelf_manager().last_shelf() is not None:
 
515
                    raise errors.ShelvedChanges(working)
 
516
 
 
517
            if working.user_url != working.branch.user_url:
 
518
                raise errors.BzrCommandError("You cannot remove the working tree"
 
519
                                             " from a lightweight checkout")
 
520
 
 
521
            d.destroy_workingtree()
456
522
 
457
523
 
458
524
class cmd_revno(Command):
459
 
    """Show current revision number.
 
525
    __doc__ = """Show current revision number.
460
526
 
461
527
    This is equal to the number of revisions on this branch.
462
528
    """
463
529
 
464
530
    _see_also = ['info']
465
531
    takes_args = ['location?']
 
532
    takes_options = [
 
533
        Option('tree', help='Show revno of working tree'),
 
534
        ]
466
535
 
467
536
    @display_command
468
 
    def run(self, location=u'.'):
469
 
        self.outf.write(str(Branch.open_containing(location)[0].revno()))
470
 
        self.outf.write('\n')
 
537
    def run(self, tree=False, location=u'.'):
 
538
        if tree:
 
539
            try:
 
540
                wt = WorkingTree.open_containing(location)[0]
 
541
                self.add_cleanup(wt.lock_read().unlock)
 
542
            except (errors.NoWorkingTree, errors.NotLocalUrl):
 
543
                raise errors.NoWorkingTree(location)
 
544
            revid = wt.last_revision()
 
545
            try:
 
546
                revno_t = wt.branch.revision_id_to_dotted_revno(revid)
 
547
            except errors.NoSuchRevision:
 
548
                revno_t = ('???',)
 
549
            revno = ".".join(str(n) for n in revno_t)
 
550
        else:
 
551
            b = Branch.open_containing(location)[0]
 
552
            self.add_cleanup(b.lock_read().unlock)
 
553
            revno = b.revno()
 
554
        self.cleanup_now()
 
555
        self.outf.write(str(revno) + '\n')
471
556
 
472
557
 
473
558
class cmd_revision_info(Command):
474
 
    """Show revision number and revision id for a given revision identifier.
 
559
    __doc__ = """Show revision number and revision id for a given revision identifier.
475
560
    """
476
561
    hidden = True
477
562
    takes_args = ['revision_info*']
478
563
    takes_options = [
479
564
        'revision',
480
 
        Option('directory',
 
565
        custom_help('directory',
481
566
            help='Branch to examine, '
482
 
                 'rather than the one containing the working directory.',
483
 
            short_name='d',
484
 
            type=unicode,
485
 
            ),
 
567
                 'rather than the one containing the working directory.'),
 
568
        Option('tree', help='Show revno of working tree'),
486
569
        ]
487
570
 
488
571
    @display_command
489
 
    def run(self, revision=None, directory=u'.', revision_info_list=[]):
 
572
    def run(self, revision=None, directory=u'.', tree=False,
 
573
            revision_info_list=[]):
490
574
 
491
 
        revs = []
 
575
        try:
 
576
            wt = WorkingTree.open_containing(directory)[0]
 
577
            b = wt.branch
 
578
            self.add_cleanup(wt.lock_read().unlock)
 
579
        except (errors.NoWorkingTree, errors.NotLocalUrl):
 
580
            wt = None
 
581
            b = Branch.open_containing(directory)[0]
 
582
            self.add_cleanup(b.lock_read().unlock)
 
583
        revision_ids = []
492
584
        if revision is not None:
493
 
            revs.extend(revision)
 
585
            revision_ids.extend(rev.as_revision_id(b) for rev in revision)
494
586
        if revision_info_list is not None:
495
 
            for rev in revision_info_list:
496
 
                revs.append(RevisionSpec.from_string(rev))
497
 
 
498
 
        b = Branch.open_containing(directory)[0]
499
 
 
500
 
        if len(revs) == 0:
501
 
            revs.append(RevisionSpec.from_string('-1'))
502
 
 
503
 
        for rev in revs:
504
 
            revision_id = rev.as_revision_id(b)
 
587
            for rev_str in revision_info_list:
 
588
                rev_spec = RevisionSpec.from_string(rev_str)
 
589
                revision_ids.append(rev_spec.as_revision_id(b))
 
590
        # No arguments supplied, default to the last revision
 
591
        if len(revision_ids) == 0:
 
592
            if tree:
 
593
                if wt is None:
 
594
                    raise errors.NoWorkingTree(directory)
 
595
                revision_ids.append(wt.last_revision())
 
596
            else:
 
597
                revision_ids.append(b.last_revision())
 
598
 
 
599
        revinfos = []
 
600
        maxlen = 0
 
601
        for revision_id in revision_ids:
505
602
            try:
506
 
                revno = '%4d' % (b.revision_id_to_revno(revision_id))
 
603
                dotted_revno = b.revision_id_to_dotted_revno(revision_id)
 
604
                revno = '.'.join(str(i) for i in dotted_revno)
507
605
            except errors.NoSuchRevision:
508
 
                dotted_map = b.get_revision_id_to_revno_map()
509
 
                revno = '.'.join(str(i) for i in dotted_map[revision_id])
510
 
            print '%s %s' % (revno, revision_id)
 
606
                revno = '???'
 
607
            maxlen = max(maxlen, len(revno))
 
608
            revinfos.append([revno, revision_id])
 
609
 
 
610
        self.cleanup_now()
 
611
        for ri in revinfos:
 
612
            self.outf.write('%*s %s\n' % (maxlen, ri[0], ri[1]))
511
613
 
512
614
 
513
615
class cmd_add(Command):
514
 
    """Add specified files or directories.
 
616
    __doc__ = """Add specified files or directories.
515
617
 
516
618
    In non-recursive mode, all the named items are added, regardless
517
619
    of whether they were previously ignored.  A warning is given if
543
645
    branches that will be merged later (without showing the two different
544
646
    adds as a conflict). It is also useful when merging another project
545
647
    into a subdirectory of this one.
 
648
    
 
649
    Any files matching patterns in the ignore list will not be added
 
650
    unless they are explicitly mentioned.
546
651
    """
547
652
    takes_args = ['file*']
548
653
    takes_options = [
556
661
               help='Lookup file ids from this tree.'),
557
662
        ]
558
663
    encoding_type = 'replace'
559
 
    _see_also = ['remove']
 
664
    _see_also = ['remove', 'ignore']
560
665
 
561
666
    def run(self, file_list, no_recurse=False, dry_run=False, verbose=False,
562
667
            file_ids_from=None):
579
684
                should_print=(not is_quiet()))
580
685
 
581
686
        if base_tree:
582
 
            base_tree.lock_read()
583
 
        try:
584
 
            file_list = self._maybe_expand_globs(file_list)
585
 
            tree, file_list = tree_files_for_add(file_list)
586
 
            added, ignored = tree.smart_add(file_list, not
587
 
                no_recurse, action=action, save=not dry_run)
588
 
        finally:
589
 
            if base_tree is not None:
590
 
                base_tree.unlock()
 
687
            self.add_cleanup(base_tree.lock_read().unlock)
 
688
        tree, file_list = tree_files_for_add(file_list)
 
689
        added, ignored = tree.smart_add(file_list, not
 
690
            no_recurse, action=action, save=not dry_run)
 
691
        self.cleanup_now()
591
692
        if len(ignored) > 0:
592
693
            if verbose:
593
694
                for glob in sorted(ignored.keys()):
594
695
                    for path in ignored[glob]:
595
696
                        self.outf.write("ignored %s matching \"%s\"\n"
596
697
                                        % (path, glob))
597
 
            else:
598
 
                match_len = 0
599
 
                for glob, paths in ignored.items():
600
 
                    match_len += len(paths)
601
 
                self.outf.write("ignored %d file(s).\n" % match_len)
602
 
            self.outf.write("If you wish to add some of these files,"
603
 
                            " please add them by name.\n")
604
698
 
605
699
 
606
700
class cmd_mkdir(Command):
607
 
    """Create a new versioned directory.
 
701
    __doc__ = """Create a new versioned directory.
608
702
 
609
703
    This is equivalent to creating the directory and then adding it.
610
704
    """
614
708
 
615
709
    def run(self, dir_list):
616
710
        for d in dir_list:
617
 
            os.mkdir(d)
618
711
            wt, dd = WorkingTree.open_containing(d)
619
 
            wt.add([dd])
620
 
            self.outf.write('added %s\n' % d)
 
712
            base = os.path.dirname(dd)
 
713
            id = wt.path2id(base)
 
714
            if id != None:
 
715
                os.mkdir(d)
 
716
                wt.add([dd])
 
717
                self.outf.write('added %s\n' % d)
 
718
            else:
 
719
                raise errors.NotVersionedError(path=base)
621
720
 
622
721
 
623
722
class cmd_relpath(Command):
624
 
    """Show path of a file relative to root"""
 
723
    __doc__ = """Show path of a file relative to root"""
625
724
 
626
725
    takes_args = ['filename']
627
726
    hidden = True
636
735
 
637
736
 
638
737
class cmd_inventory(Command):
639
 
    """Show inventory of the current working copy or a revision.
 
738
    __doc__ = """Show inventory of the current working copy or a revision.
640
739
 
641
740
    It is possible to limit the output to a particular entry
642
741
    type using the --kind option.  For example: --kind file.
663
762
 
664
763
        revision = _get_one_revision('inventory', revision)
665
764
        work_tree, file_list = tree_files(file_list)
666
 
        work_tree.lock_read()
667
 
        try:
668
 
            if revision is not None:
669
 
                tree = revision.as_tree(work_tree.branch)
670
 
 
671
 
                extra_trees = [work_tree]
672
 
                tree.lock_read()
673
 
            else:
674
 
                tree = work_tree
675
 
                extra_trees = []
676
 
 
677
 
            if file_list is not None:
678
 
                file_ids = tree.paths2ids(file_list, trees=extra_trees,
679
 
                                          require_versioned=True)
680
 
                # find_ids_across_trees may include some paths that don't
681
 
                # exist in 'tree'.
682
 
                entries = sorted((tree.id2path(file_id), tree.inventory[file_id])
683
 
                                 for file_id in file_ids if file_id in tree)
684
 
            else:
685
 
                entries = tree.inventory.entries()
686
 
        finally:
687
 
            tree.unlock()
688
 
            if tree is not work_tree:
689
 
                work_tree.unlock()
690
 
 
 
765
        self.add_cleanup(work_tree.lock_read().unlock)
 
766
        if revision is not None:
 
767
            tree = revision.as_tree(work_tree.branch)
 
768
 
 
769
            extra_trees = [work_tree]
 
770
            self.add_cleanup(tree.lock_read().unlock)
 
771
        else:
 
772
            tree = work_tree
 
773
            extra_trees = []
 
774
 
 
775
        if file_list is not None:
 
776
            file_ids = tree.paths2ids(file_list, trees=extra_trees,
 
777
                                      require_versioned=True)
 
778
            # find_ids_across_trees may include some paths that don't
 
779
            # exist in 'tree'.
 
780
            entries = sorted((tree.id2path(file_id), tree.inventory[file_id])
 
781
                             for file_id in file_ids if file_id in tree)
 
782
        else:
 
783
            entries = tree.inventory.entries()
 
784
 
 
785
        self.cleanup_now()
691
786
        for path, entry in entries:
692
787
            if kind and kind != entry.kind:
693
788
                continue
699
794
 
700
795
 
701
796
class cmd_mv(Command):
702
 
    """Move or rename a file.
 
797
    __doc__ = """Move or rename a file.
703
798
 
704
799
    :Usage:
705
800
        bzr mv OLDNAME NEWNAME
738
833
        if len(names_list) < 2:
739
834
            raise errors.BzrCommandError("missing file argument")
740
835
        tree, rel_names = tree_files(names_list, canonicalize=False)
741
 
        tree.lock_write()
742
 
        try:
743
 
            self._run(tree, names_list, rel_names, after)
744
 
        finally:
745
 
            tree.unlock()
 
836
        self.add_cleanup(tree.lock_tree_write().unlock)
 
837
        self._run(tree, names_list, rel_names, after)
746
838
 
747
839
    def run_auto(self, names_list, after, dry_run):
748
840
        if names_list is not None and len(names_list) > 1:
752
844
            raise errors.BzrCommandError('--after cannot be specified with'
753
845
                                         ' --auto.')
754
846
        work_tree, file_list = tree_files(names_list, default_branch='.')
755
 
        work_tree.lock_write()
756
 
        try:
757
 
            rename_map.RenameMap.guess_renames(work_tree, dry_run)
758
 
        finally:
759
 
            work_tree.unlock()
 
847
        self.add_cleanup(work_tree.lock_tree_write().unlock)
 
848
        rename_map.RenameMap.guess_renames(work_tree, dry_run)
760
849
 
761
850
    def _run(self, tree, names_list, rel_names, after):
762
851
        into_existing = osutils.isdir(names_list[-1])
783
872
            # All entries reference existing inventory items, so fix them up
784
873
            # for cicp file-systems.
785
874
            rel_names = tree.get_canonical_inventory_paths(rel_names)
786
 
            for pair in tree.move(rel_names[:-1], rel_names[-1], after=after):
787
 
                self.outf.write("%s => %s\n" % pair)
 
875
            for src, dest in tree.move(rel_names[:-1], rel_names[-1], after=after):
 
876
                if not is_quiet():
 
877
                    self.outf.write("%s => %s\n" % (src, dest))
788
878
        else:
789
879
            if len(names_list) != 2:
790
880
                raise errors.BzrCommandError('to mv multiple files the'
834
924
            dest = osutils.pathjoin(dest_parent, dest_tail)
835
925
            mutter("attempting to move %s => %s", src, dest)
836
926
            tree.rename_one(src, dest, after=after)
837
 
            self.outf.write("%s => %s\n" % (src, dest))
 
927
            if not is_quiet():
 
928
                self.outf.write("%s => %s\n" % (src, dest))
838
929
 
839
930
 
840
931
class cmd_pull(Command):
841
 
    """Turn this branch into a mirror of another branch.
 
932
    __doc__ = """Turn this branch into a mirror of another branch.
842
933
 
843
 
    This command only works on branches that have not diverged.  Branches are
844
 
    considered diverged if the destination branch's most recent commit is one
845
 
    that has not been merged (directly or indirectly) into the parent.
 
934
    By default, this command only works on branches that have not diverged.
 
935
    Branches are considered diverged if the destination branch's most recent 
 
936
    commit is one that has not been merged (directly or indirectly) into the 
 
937
    parent.
846
938
 
847
939
    If branches have diverged, you can use 'bzr merge' to integrate the changes
848
940
    from one into the other.  Once one branch has merged, the other should
849
941
    be able to pull it again.
850
942
 
851
 
    If you want to forget your local changes and just update your branch to
852
 
    match the remote one, use pull --overwrite.
 
943
    If you want to replace your local changes and just want your branch to
 
944
    match the remote one, use pull --overwrite. This will work even if the two
 
945
    branches have diverged.
853
946
 
854
947
    If there is no default location set, the first pull will set it.  After
855
948
    that, you can omit the location to use the default.  To change the
865
958
    takes_options = ['remember', 'overwrite', 'revision',
866
959
        custom_help('verbose',
867
960
            help='Show logs of pulled revisions.'),
868
 
        Option('directory',
 
961
        custom_help('directory',
869
962
            help='Branch to pull into, '
870
 
                 'rather than the one containing the working directory.',
871
 
            short_name='d',
872
 
            type=unicode,
 
963
                 'rather than the one containing the working directory.'),
 
964
        Option('local',
 
965
            help="Perform a local pull in a bound "
 
966
                 "branch.  Local pulls are not applied to "
 
967
                 "the master branch."
873
968
            ),
874
969
        ]
875
970
    takes_args = ['location?']
877
972
 
878
973
    def run(self, location=None, remember=False, overwrite=False,
879
974
            revision=None, verbose=False,
880
 
            directory=None):
 
975
            directory=None, local=False):
881
976
        # FIXME: too much stuff is in the command class
882
977
        revision_id = None
883
978
        mergeable = None
886
981
        try:
887
982
            tree_to = WorkingTree.open_containing(directory)[0]
888
983
            branch_to = tree_to.branch
 
984
            self.add_cleanup(tree_to.lock_write().unlock)
889
985
        except errors.NoWorkingTree:
890
986
            tree_to = None
891
987
            branch_to = Branch.open_containing(directory)[0]
 
988
            self.add_cleanup(branch_to.lock_write().unlock)
 
989
 
 
990
        if local and not branch_to.get_bound_location():
 
991
            raise errors.LocalRequiresBoundBranch()
892
992
 
893
993
        possible_transports = []
894
994
        if location is not None:
922
1022
        else:
923
1023
            branch_from = Branch.open(location,
924
1024
                possible_transports=possible_transports)
 
1025
            self.add_cleanup(branch_from.lock_read().unlock)
925
1026
 
926
1027
            if branch_to.get_parent() is None or remember:
927
1028
                branch_to.set_parent(branch_from.base)
929
1030
        if revision is not None:
930
1031
            revision_id = revision.as_revision_id(branch_from)
931
1032
 
932
 
        branch_to.lock_write()
933
 
        try:
934
 
            if tree_to is not None:
935
 
                view_info = _get_view_info_for_change_reporter(tree_to)
936
 
                change_reporter = delta._ChangeReporter(
937
 
                    unversioned_filter=tree_to.is_ignored, view_info=view_info)
938
 
                result = tree_to.pull(branch_from, overwrite, revision_id,
939
 
                                      change_reporter,
940
 
                                      possible_transports=possible_transports)
941
 
            else:
942
 
                result = branch_to.pull(branch_from, overwrite, revision_id)
 
1033
        if tree_to is not None:
 
1034
            view_info = _get_view_info_for_change_reporter(tree_to)
 
1035
            change_reporter = delta._ChangeReporter(
 
1036
                unversioned_filter=tree_to.is_ignored,
 
1037
                view_info=view_info)
 
1038
            result = tree_to.pull(
 
1039
                branch_from, overwrite, revision_id, change_reporter,
 
1040
                possible_transports=possible_transports, local=local)
 
1041
        else:
 
1042
            result = branch_to.pull(
 
1043
                branch_from, overwrite, revision_id, local=local)
943
1044
 
944
 
            result.report(self.outf)
945
 
            if verbose and result.old_revid != result.new_revid:
946
 
                log.show_branch_change(branch_to, self.outf, result.old_revno,
947
 
                                       result.old_revid)
948
 
        finally:
949
 
            branch_to.unlock()
 
1045
        result.report(self.outf)
 
1046
        if verbose and result.old_revid != result.new_revid:
 
1047
            log.show_branch_change(
 
1048
                branch_to, self.outf, result.old_revno,
 
1049
                result.old_revid)
950
1050
 
951
1051
 
952
1052
class cmd_push(Command):
953
 
    """Update a mirror of this branch.
 
1053
    __doc__ = """Update a mirror of this branch.
954
1054
 
955
1055
    The target branch will not have its working tree populated because this
956
1056
    is both expensive, and is not supported on remote file systems.
980
1080
        Option('create-prefix',
981
1081
               help='Create the path leading up to the branch '
982
1082
                    'if it does not already exist.'),
983
 
        Option('directory',
 
1083
        custom_help('directory',
984
1084
            help='Branch to push from, '
985
 
                 'rather than the one containing the working directory.',
986
 
            short_name='d',
987
 
            type=unicode,
988
 
            ),
 
1085
                 'rather than the one containing the working directory.'),
989
1086
        Option('use-existing-dir',
990
1087
               help='By default push will fail if the target'
991
1088
                    ' directory exists, but does not already'
999
1096
                'for the commit history. Only the work not present in the '
1000
1097
                'referenced branch is included in the branch created.',
1001
1098
            type=unicode),
 
1099
        Option('strict',
 
1100
               help='Refuse to push if there are uncommitted changes in'
 
1101
               ' the working tree, --no-strict disables the check.'),
1002
1102
        ]
1003
1103
    takes_args = ['location?']
1004
1104
    encoding_type = 'replace'
1006
1106
    def run(self, location=None, remember=False, overwrite=False,
1007
1107
        create_prefix=False, verbose=False, revision=None,
1008
1108
        use_existing_dir=False, directory=None, stacked_on=None,
1009
 
        stacked=False):
 
1109
        stacked=False, strict=None):
1010
1110
        from bzrlib.push import _show_push_branch
1011
1111
 
1012
 
        # Get the source branch and revision_id
1013
1112
        if directory is None:
1014
1113
            directory = '.'
1015
 
        br_from = Branch.open_containing(directory)[0]
 
1114
        # Get the source branch
 
1115
        (tree, br_from,
 
1116
         _unused) = bzrdir.BzrDir.open_containing_tree_or_branch(directory)
 
1117
        # Get the tip's revision_id
1016
1118
        revision = _get_one_revision('push', revision)
1017
1119
        if revision is not None:
1018
1120
            revision_id = revision.in_history(br_from).rev_id
1019
1121
        else:
1020
 
            revision_id = br_from.last_revision()
1021
 
 
 
1122
            revision_id = None
 
1123
        if tree is not None and revision_id is None:
 
1124
            tree.check_changed_or_out_of_date(
 
1125
                strict, 'push_strict',
 
1126
                more_error='Use --no-strict to force the push.',
 
1127
                more_warning='Uncommitted changes will not be pushed.')
1022
1128
        # Get the stacked_on branch, if any
1023
1129
        if stacked_on is not None:
1024
1130
            stacked_on = urlutils.normalize_url(stacked_on)
1056
1162
 
1057
1163
 
1058
1164
class cmd_branch(Command):
1059
 
    """Create a new copy of a branch.
 
1165
    __doc__ = """Create a new branch that is a copy of an existing branch.
1060
1166
 
1061
1167
    If the TO_LOCATION is omitted, the last component of the FROM_LOCATION will
1062
1168
    be used.  In other words, "branch ../foo/bar" will attempt to create ./bar.
1075
1181
        help='Hard-link working tree files where possible.'),
1076
1182
        Option('no-tree',
1077
1183
            help="Create a branch without a working-tree."),
 
1184
        Option('switch',
 
1185
            help="Switch the checkout in the current directory "
 
1186
                 "to the new branch."),
1078
1187
        Option('stacked',
1079
1188
            help='Create a stacked branch referring to the source branch. '
1080
1189
                'The new branch will depend on the availability of the source '
1081
1190
                'branch for all operations.'),
1082
1191
        Option('standalone',
1083
1192
               help='Do not use a shared repository, even if available.'),
 
1193
        Option('use-existing-dir',
 
1194
               help='By default branch will fail if the target'
 
1195
                    ' directory exists, but does not already'
 
1196
                    ' have a control directory.  This flag will'
 
1197
                    ' allow branch to proceed.'),
 
1198
        Option('bind',
 
1199
            help="Bind new branch to from location."),
1084
1200
        ]
1085
1201
    aliases = ['get', 'clone']
1086
1202
 
1087
1203
    def run(self, from_location, to_location=None, revision=None,
1088
 
            hardlink=False, stacked=False, standalone=False, no_tree=False):
 
1204
            hardlink=False, stacked=False, standalone=False, no_tree=False,
 
1205
            use_existing_dir=False, switch=False, bind=False):
 
1206
        from bzrlib import switch as _mod_switch
1089
1207
        from bzrlib.tag import _merge_tags_if_possible
1090
 
 
1091
1208
        accelerator_tree, br_from = bzrdir.BzrDir.open_tree_or_branch(
1092
1209
            from_location)
1093
1210
        revision = _get_one_revision('branch', revision)
1094
 
        br_from.lock_read()
 
1211
        self.add_cleanup(br_from.lock_read().unlock)
 
1212
        if revision is not None:
 
1213
            revision_id = revision.as_revision_id(br_from)
 
1214
        else:
 
1215
            # FIXME - wt.last_revision, fallback to branch, fall back to
 
1216
            # None or perhaps NULL_REVISION to mean copy nothing
 
1217
            # RBC 20060209
 
1218
            revision_id = br_from.last_revision()
 
1219
        if to_location is None:
 
1220
            to_location = urlutils.derive_to_location(from_location)
 
1221
        to_transport = transport.get_transport(to_location)
1095
1222
        try:
1096
 
            if revision is not None:
1097
 
                revision_id = revision.as_revision_id(br_from)
 
1223
            to_transport.mkdir('.')
 
1224
        except errors.FileExists:
 
1225
            if not use_existing_dir:
 
1226
                raise errors.BzrCommandError('Target directory "%s" '
 
1227
                    'already exists.' % to_location)
1098
1228
            else:
1099
 
                # FIXME - wt.last_revision, fallback to branch, fall back to
1100
 
                # None or perhaps NULL_REVISION to mean copy nothing
1101
 
                # RBC 20060209
1102
 
                revision_id = br_from.last_revision()
1103
 
            if to_location is None:
1104
 
                to_location = urlutils.derive_to_location(from_location)
1105
 
            to_transport = transport.get_transport(to_location)
1106
 
            try:
1107
 
                to_transport.mkdir('.')
1108
 
            except errors.FileExists:
1109
 
                raise errors.BzrCommandError('Target directory "%s" already'
1110
 
                                             ' exists.' % to_location)
1111
 
            except errors.NoSuchFile:
1112
 
                raise errors.BzrCommandError('Parent of "%s" does not exist.'
1113
 
                                             % to_location)
1114
 
            try:
1115
 
                # preserve whatever source format we have.
1116
 
                dir = br_from.bzrdir.sprout(to_transport.base, revision_id,
1117
 
                                            possible_transports=[to_transport],
1118
 
                                            accelerator_tree=accelerator_tree,
1119
 
                                            hardlink=hardlink, stacked=stacked,
1120
 
                                            force_new_repo=standalone,
1121
 
                                            create_tree_if_local=not no_tree,
1122
 
                                            source_branch=br_from)
1123
 
                branch = dir.open_branch()
1124
 
            except errors.NoSuchRevision:
1125
 
                to_transport.delete_tree('.')
1126
 
                msg = "The branch %s has no revision %s." % (from_location,
1127
 
                    revision)
1128
 
                raise errors.BzrCommandError(msg)
1129
 
            _merge_tags_if_possible(br_from, branch)
1130
 
            # If the source branch is stacked, the new branch may
1131
 
            # be stacked whether we asked for that explicitly or not.
1132
 
            # We therefore need a try/except here and not just 'if stacked:'
1133
 
            try:
1134
 
                note('Created new stacked branch referring to %s.' %
1135
 
                    branch.get_stacked_on_url())
1136
 
            except (errors.NotStacked, errors.UnstackableBranchFormat,
1137
 
                errors.UnstackableRepositoryFormat), e:
1138
 
                note('Branched %d revision(s).' % branch.revno())
1139
 
        finally:
1140
 
            br_from.unlock()
 
1229
                try:
 
1230
                    bzrdir.BzrDir.open_from_transport(to_transport)
 
1231
                except errors.NotBranchError:
 
1232
                    pass
 
1233
                else:
 
1234
                    raise errors.AlreadyBranchError(to_location)
 
1235
        except errors.NoSuchFile:
 
1236
            raise errors.BzrCommandError('Parent of "%s" does not exist.'
 
1237
                                         % to_location)
 
1238
        try:
 
1239
            # preserve whatever source format we have.
 
1240
            dir = br_from.bzrdir.sprout(to_transport.base, revision_id,
 
1241
                                        possible_transports=[to_transport],
 
1242
                                        accelerator_tree=accelerator_tree,
 
1243
                                        hardlink=hardlink, stacked=stacked,
 
1244
                                        force_new_repo=standalone,
 
1245
                                        create_tree_if_local=not no_tree,
 
1246
                                        source_branch=br_from)
 
1247
            branch = dir.open_branch()
 
1248
        except errors.NoSuchRevision:
 
1249
            to_transport.delete_tree('.')
 
1250
            msg = "The branch %s has no revision %s." % (from_location,
 
1251
                revision)
 
1252
            raise errors.BzrCommandError(msg)
 
1253
        _merge_tags_if_possible(br_from, branch)
 
1254
        # If the source branch is stacked, the new branch may
 
1255
        # be stacked whether we asked for that explicitly or not.
 
1256
        # We therefore need a try/except here and not just 'if stacked:'
 
1257
        try:
 
1258
            note('Created new stacked branch referring to %s.' %
 
1259
                branch.get_stacked_on_url())
 
1260
        except (errors.NotStacked, errors.UnstackableBranchFormat,
 
1261
            errors.UnstackableRepositoryFormat), e:
 
1262
            note('Branched %d revision(s).' % branch.revno())
 
1263
        if bind:
 
1264
            # Bind to the parent
 
1265
            parent_branch = Branch.open(from_location)
 
1266
            branch.bind(parent_branch)
 
1267
            note('New branch bound to %s' % from_location)
 
1268
        if switch:
 
1269
            # Switch to the new branch
 
1270
            wt, _ = WorkingTree.open_containing('.')
 
1271
            _mod_switch.switch(wt.bzrdir, branch)
 
1272
            note('Switched to branch: %s',
 
1273
                urlutils.unescape_for_display(branch.base, 'utf-8'))
1141
1274
 
1142
1275
 
1143
1276
class cmd_checkout(Command):
1144
 
    """Create a new checkout of an existing branch.
 
1277
    __doc__ = """Create a new checkout of an existing branch.
1145
1278
 
1146
1279
    If BRANCH_LOCATION is omitted, checkout will reconstitute a working tree for
1147
1280
    the branch found in '.'. This is useful if you have removed the working tree
1210
1343
 
1211
1344
 
1212
1345
class cmd_renames(Command):
1213
 
    """Show list of renamed files.
 
1346
    __doc__ = """Show list of renamed files.
1214
1347
    """
1215
1348
    # TODO: Option to show renames between two historical versions.
1216
1349
 
1221
1354
    @display_command
1222
1355
    def run(self, dir=u'.'):
1223
1356
        tree = WorkingTree.open_containing(dir)[0]
1224
 
        tree.lock_read()
1225
 
        try:
1226
 
            new_inv = tree.inventory
1227
 
            old_tree = tree.basis_tree()
1228
 
            old_tree.lock_read()
1229
 
            try:
1230
 
                old_inv = old_tree.inventory
1231
 
                renames = []
1232
 
                iterator = tree.iter_changes(old_tree, include_unchanged=True)
1233
 
                for f, paths, c, v, p, n, k, e in iterator:
1234
 
                    if paths[0] == paths[1]:
1235
 
                        continue
1236
 
                    if None in (paths):
1237
 
                        continue
1238
 
                    renames.append(paths)
1239
 
                renames.sort()
1240
 
                for old_name, new_name in renames:
1241
 
                    self.outf.write("%s => %s\n" % (old_name, new_name))
1242
 
            finally:
1243
 
                old_tree.unlock()
1244
 
        finally:
1245
 
            tree.unlock()
 
1357
        self.add_cleanup(tree.lock_read().unlock)
 
1358
        new_inv = tree.inventory
 
1359
        old_tree = tree.basis_tree()
 
1360
        self.add_cleanup(old_tree.lock_read().unlock)
 
1361
        old_inv = old_tree.inventory
 
1362
        renames = []
 
1363
        iterator = tree.iter_changes(old_tree, include_unchanged=True)
 
1364
        for f, paths, c, v, p, n, k, e in iterator:
 
1365
            if paths[0] == paths[1]:
 
1366
                continue
 
1367
            if None in (paths):
 
1368
                continue
 
1369
            renames.append(paths)
 
1370
        renames.sort()
 
1371
        for old_name, new_name in renames:
 
1372
            self.outf.write("%s => %s\n" % (old_name, new_name))
1246
1373
 
1247
1374
 
1248
1375
class cmd_update(Command):
1249
 
    """Update a tree to have the latest code committed to its branch.
 
1376
    __doc__ = """Update a tree to have the latest code committed to its branch.
1250
1377
 
1251
1378
    This will perform a merge into the working tree, and may generate
1252
1379
    conflicts. If you have any local changes, you will still
1254
1381
 
1255
1382
    If you want to discard your local changes, you can just do a
1256
1383
    'bzr revert' instead of 'bzr commit' after the update.
 
1384
 
 
1385
    If the tree's branch is bound to a master branch, it will also update
 
1386
    the branch from the master.
1257
1387
    """
1258
1388
 
1259
1389
    _see_also = ['pull', 'working-trees', 'status-flags']
1260
1390
    takes_args = ['dir?']
 
1391
    takes_options = ['revision']
1261
1392
    aliases = ['up']
1262
1393
 
1263
 
    def run(self, dir='.'):
 
1394
    def run(self, dir='.', revision=None):
 
1395
        if revision is not None and len(revision) != 1:
 
1396
            raise errors.BzrCommandError(
 
1397
                        "bzr update --revision takes exactly one revision")
1264
1398
        tree = WorkingTree.open_containing(dir)[0]
 
1399
        branch = tree.branch
1265
1400
        possible_transports = []
1266
 
        master = tree.branch.get_master_branch(
 
1401
        master = branch.get_master_branch(
1267
1402
            possible_transports=possible_transports)
1268
1403
        if master is not None:
 
1404
            branch_location = master.base
1269
1405
            tree.lock_write()
1270
1406
        else:
 
1407
            branch_location = tree.branch.base
1271
1408
            tree.lock_tree_write()
 
1409
        self.add_cleanup(tree.unlock)
 
1410
        # get rid of the final '/' and be ready for display
 
1411
        branch_location = urlutils.unescape_for_display(
 
1412
            branch_location.rstrip('/'),
 
1413
            self.outf.encoding)
 
1414
        existing_pending_merges = tree.get_parent_ids()[1:]
 
1415
        if master is None:
 
1416
            old_tip = None
 
1417
        else:
 
1418
            # may need to fetch data into a heavyweight checkout
 
1419
            # XXX: this may take some time, maybe we should display a
 
1420
            # message
 
1421
            old_tip = branch.update(possible_transports)
 
1422
        if revision is not None:
 
1423
            revision_id = revision[0].as_revision_id(branch)
 
1424
        else:
 
1425
            revision_id = branch.last_revision()
 
1426
        if revision_id == _mod_revision.ensure_null(tree.last_revision()):
 
1427
            revno = branch.revision_id_to_dotted_revno(revision_id)
 
1428
            note("Tree is up to date at revision %s of branch %s" %
 
1429
                ('.'.join(map(str, revno)), branch_location))
 
1430
            return 0
 
1431
        view_info = _get_view_info_for_change_reporter(tree)
 
1432
        change_reporter = delta._ChangeReporter(
 
1433
            unversioned_filter=tree.is_ignored,
 
1434
            view_info=view_info)
1272
1435
        try:
1273
 
            existing_pending_merges = tree.get_parent_ids()[1:]
1274
 
            last_rev = _mod_revision.ensure_null(tree.last_revision())
1275
 
            if last_rev == _mod_revision.ensure_null(
1276
 
                tree.branch.last_revision()):
1277
 
                # may be up to date, check master too.
1278
 
                if master is None or last_rev == _mod_revision.ensure_null(
1279
 
                    master.last_revision()):
1280
 
                    revno = tree.branch.revision_id_to_revno(last_rev)
1281
 
                    note("Tree is up to date at revision %d." % (revno,))
1282
 
                    return 0
1283
 
            view_info = _get_view_info_for_change_reporter(tree)
1284
1436
            conflicts = tree.update(
1285
 
                delta._ChangeReporter(unversioned_filter=tree.is_ignored,
1286
 
                view_info=view_info), possible_transports=possible_transports)
1287
 
            revno = tree.branch.revision_id_to_revno(
1288
 
                _mod_revision.ensure_null(tree.last_revision()))
1289
 
            note('Updated to revision %d.' % (revno,))
1290
 
            if tree.get_parent_ids()[1:] != existing_pending_merges:
1291
 
                note('Your local commits will now show as pending merges with '
1292
 
                     "'bzr status', and can be committed with 'bzr commit'.")
1293
 
            if conflicts != 0:
1294
 
                return 1
1295
 
            else:
1296
 
                return 0
1297
 
        finally:
1298
 
            tree.unlock()
 
1437
                change_reporter,
 
1438
                possible_transports=possible_transports,
 
1439
                revision=revision_id,
 
1440
                old_tip=old_tip)
 
1441
        except errors.NoSuchRevision, e:
 
1442
            raise errors.BzrCommandError(
 
1443
                                  "branch has no revision %s\n"
 
1444
                                  "bzr update --revision only works"
 
1445
                                  " for a revision in the branch history"
 
1446
                                  % (e.revision))
 
1447
        revno = tree.branch.revision_id_to_dotted_revno(
 
1448
            _mod_revision.ensure_null(tree.last_revision()))
 
1449
        note('Updated to revision %s of branch %s' %
 
1450
             ('.'.join(map(str, revno)), branch_location))
 
1451
        parent_ids = tree.get_parent_ids()
 
1452
        if parent_ids[1:] and parent_ids[1:] != existing_pending_merges:
 
1453
            note('Your local commits will now show as pending merges with '
 
1454
                 "'bzr status', and can be committed with 'bzr commit'.")
 
1455
        if conflicts != 0:
 
1456
            return 1
 
1457
        else:
 
1458
            return 0
1299
1459
 
1300
1460
 
1301
1461
class cmd_info(Command):
1302
 
    """Show information about a working tree, branch or repository.
 
1462
    __doc__ = """Show information about a working tree, branch or repository.
1303
1463
 
1304
1464
    This command will show all known locations and formats associated to the
1305
1465
    tree, branch or repository.
1343
1503
 
1344
1504
 
1345
1505
class cmd_remove(Command):
1346
 
    """Remove files or directories.
 
1506
    __doc__ = """Remove files or directories.
1347
1507
 
1348
1508
    This makes bzr stop tracking changes to the specified files. bzr will delete
1349
1509
    them if they can easily be recovered using revert. If no options or
1358
1518
            title='Deletion Strategy', value_switches=True, enum_switch=False,
1359
1519
            safe='Only delete files if they can be'
1360
1520
                 ' safely recovered (default).',
1361
 
            keep="Don't delete any files.",
 
1521
            keep='Delete from bzr but leave the working copy.',
1362
1522
            force='Delete all the specified files, even if they can not be '
1363
1523
                'recovered and even if they are non-empty directories.')]
1364
1524
    aliases = ['rm', 'del']
1371
1531
        if file_list is not None:
1372
1532
            file_list = [f for f in file_list]
1373
1533
 
1374
 
        tree.lock_write()
1375
 
        try:
1376
 
            # Heuristics should probably all move into tree.remove_smart or
1377
 
            # some such?
1378
 
            if new:
1379
 
                added = tree.changes_from(tree.basis_tree(),
1380
 
                    specific_files=file_list).added
1381
 
                file_list = sorted([f[0] for f in added], reverse=True)
1382
 
                if len(file_list) == 0:
1383
 
                    raise errors.BzrCommandError('No matching files.')
1384
 
            elif file_list is None:
1385
 
                # missing files show up in iter_changes(basis) as
1386
 
                # versioned-with-no-kind.
1387
 
                missing = []
1388
 
                for change in tree.iter_changes(tree.basis_tree()):
1389
 
                    # Find paths in the working tree that have no kind:
1390
 
                    if change[1][1] is not None and change[6][1] is None:
1391
 
                        missing.append(change[1][1])
1392
 
                file_list = sorted(missing, reverse=True)
1393
 
                file_deletion_strategy = 'keep'
1394
 
            tree.remove(file_list, verbose=verbose, to_file=self.outf,
1395
 
                keep_files=file_deletion_strategy=='keep',
1396
 
                force=file_deletion_strategy=='force')
1397
 
        finally:
1398
 
            tree.unlock()
 
1534
        self.add_cleanup(tree.lock_write().unlock)
 
1535
        # Heuristics should probably all move into tree.remove_smart or
 
1536
        # some such?
 
1537
        if new:
 
1538
            added = tree.changes_from(tree.basis_tree(),
 
1539
                specific_files=file_list).added
 
1540
            file_list = sorted([f[0] for f in added], reverse=True)
 
1541
            if len(file_list) == 0:
 
1542
                raise errors.BzrCommandError('No matching files.')
 
1543
        elif file_list is None:
 
1544
            # missing files show up in iter_changes(basis) as
 
1545
            # versioned-with-no-kind.
 
1546
            missing = []
 
1547
            for change in tree.iter_changes(tree.basis_tree()):
 
1548
                # Find paths in the working tree that have no kind:
 
1549
                if change[1][1] is not None and change[6][1] is None:
 
1550
                    missing.append(change[1][1])
 
1551
            file_list = sorted(missing, reverse=True)
 
1552
            file_deletion_strategy = 'keep'
 
1553
        tree.remove(file_list, verbose=verbose, to_file=self.outf,
 
1554
            keep_files=file_deletion_strategy=='keep',
 
1555
            force=file_deletion_strategy=='force')
1399
1556
 
1400
1557
 
1401
1558
class cmd_file_id(Command):
1402
 
    """Print file_id of a particular file or directory.
 
1559
    __doc__ = """Print file_id of a particular file or directory.
1403
1560
 
1404
1561
    The file_id is assigned when the file is first added and remains the
1405
1562
    same through all revisions where the file exists, even when it is
1421
1578
 
1422
1579
 
1423
1580
class cmd_file_path(Command):
1424
 
    """Print path of file_ids to a file or directory.
 
1581
    __doc__ = """Print path of file_ids to a file or directory.
1425
1582
 
1426
1583
    This prints one line for each directory down to the target,
1427
1584
    starting at the branch root.
1443
1600
 
1444
1601
 
1445
1602
class cmd_reconcile(Command):
1446
 
    """Reconcile bzr metadata in a branch.
 
1603
    __doc__ = """Reconcile bzr metadata in a branch.
1447
1604
 
1448
1605
    This can correct data mismatches that may have been caused by
1449
1606
    previous ghost operations or bzr upgrades. You should only
1471
1628
 
1472
1629
 
1473
1630
class cmd_revision_history(Command):
1474
 
    """Display the list of revision ids on a branch."""
 
1631
    __doc__ = """Display the list of revision ids on a branch."""
1475
1632
 
1476
1633
    _see_also = ['log']
1477
1634
    takes_args = ['location?']
1487
1644
 
1488
1645
 
1489
1646
class cmd_ancestry(Command):
1490
 
    """List all revisions merged into this branch."""
 
1647
    __doc__ = """List all revisions merged into this branch."""
1491
1648
 
1492
1649
    _see_also = ['log', 'revision-history']
1493
1650
    takes_args = ['location?']
1512
1669
 
1513
1670
 
1514
1671
class cmd_init(Command):
1515
 
    """Make a directory into a versioned branch.
 
1672
    __doc__ = """Make a directory into a versioned branch.
1516
1673
 
1517
1674
    Use this to create an empty branch, or before importing an
1518
1675
    existing project.
1546
1703
                lazy_registry=('bzrlib.bzrdir', 'format_registry'),
1547
1704
                converter=lambda name: bzrdir.format_registry.make_bzrdir(name),
1548
1705
                value_switches=True,
1549
 
                title="Branch Format",
 
1706
                title="Branch format",
1550
1707
                ),
1551
1708
         Option('append-revisions-only',
1552
1709
                help='Never change revnos or the existing log.'
1575
1732
                    "\nYou may supply --create-prefix to create all"
1576
1733
                    " leading parent directories."
1577
1734
                    % location)
1578
 
            _create_prefix(to_transport)
 
1735
            to_transport.create_prefix()
1579
1736
 
1580
1737
        try:
1581
1738
            a_bzrdir = bzrdir.BzrDir.open_from_transport(to_transport)
1599
1756
                branch.set_append_revisions_only(True)
1600
1757
            except errors.UpgradeRequired:
1601
1758
                raise errors.BzrCommandError('This branch format cannot be set'
1602
 
                    ' to append-revisions-only.  Try --experimental-branch6')
 
1759
                    ' to append-revisions-only.  Try --default.')
1603
1760
        if not is_quiet():
1604
1761
            from bzrlib.info import describe_layout, describe_format
1605
1762
            try:
1621
1778
 
1622
1779
 
1623
1780
class cmd_init_repository(Command):
1624
 
    """Create a shared repository to hold branches.
 
1781
    __doc__ = """Create a shared repository for branches to share storage space.
1625
1782
 
1626
1783
    New branches created under the repository directory will store their
1627
 
    revisions in the repository, not in the branch directory.
 
1784
    revisions in the repository, not in the branch directory.  For branches
 
1785
    with shared history, this reduces the amount of storage needed and 
 
1786
    speeds up the creation of new branches.
1628
1787
 
1629
 
    If the --no-trees option is used then the branches in the repository
1630
 
    will not have working trees by default.
 
1788
    If the --no-trees option is given then the branches in the repository
 
1789
    will not have working trees by default.  They will still exist as 
 
1790
    directories on disk, but they will not have separate copies of the 
 
1791
    files at a certain revision.  This can be useful for repositories that
 
1792
    store branches which are interacted with through checkouts or remote
 
1793
    branches, such as on a server.
1631
1794
 
1632
1795
    :Examples:
1633
 
        Create a shared repositories holding just branches::
 
1796
        Create a shared repository holding just branches::
1634
1797
 
1635
1798
            bzr init-repo --no-trees repo
1636
1799
            bzr init repo/trunk
1675
1838
 
1676
1839
 
1677
1840
class cmd_diff(Command):
1678
 
    """Show differences in the working tree, between revisions or branches.
 
1841
    __doc__ = """Show differences in the working tree, between revisions or branches.
1679
1842
 
1680
1843
    If no arguments are given, all changes for the current tree are listed.
1681
1844
    If files are given, only the changes in those files are listed.
1702
1865
 
1703
1866
            bzr diff -r1
1704
1867
 
1705
 
        Difference between revision 2 and revision 1::
1706
 
 
1707
 
            bzr diff -r1..2
1708
 
 
1709
 
        Difference between revision 2 and revision 1 for branch xxx::
1710
 
 
1711
 
            bzr diff -r1..2 xxx
 
1868
        Difference between revision 3 and revision 1::
 
1869
 
 
1870
            bzr diff -r1..3
 
1871
 
 
1872
        Difference between revision 3 and revision 1 for branch xxx::
 
1873
 
 
1874
            bzr diff -r1..3 xxx
 
1875
 
 
1876
        To see the changes introduced in revision X::
 
1877
        
 
1878
            bzr diff -cX
 
1879
 
 
1880
        Note that in the case of a merge, the -c option shows the changes
 
1881
        compared to the left hand parent. To see the changes against
 
1882
        another parent, use::
 
1883
 
 
1884
            bzr diff -r<chosen_parent>..X
 
1885
 
 
1886
        The changes introduced by revision 2 (equivalent to -r1..2)::
 
1887
 
 
1888
            bzr diff -c2
1712
1889
 
1713
1890
        Show just the differences for file NEWS::
1714
1891
 
1753
1930
            help='Use this command to compare files.',
1754
1931
            type=unicode,
1755
1932
            ),
 
1933
        RegistryOption('format',
 
1934
            help='Diff format to use.',
 
1935
            lazy_registry=('bzrlib.diff', 'format_registry'),
 
1936
            value_switches=False, title='Diff format'),
1756
1937
        ]
1757
1938
    aliases = ['di', 'dif']
1758
1939
    encoding_type = 'exact'
1759
1940
 
1760
1941
    @display_command
1761
1942
    def run(self, revision=None, file_list=None, diff_options=None,
1762
 
            prefix=None, old=None, new=None, using=None):
1763
 
        from bzrlib.diff import _get_trees_to_diff, show_diff_trees
 
1943
            prefix=None, old=None, new=None, using=None, format=None):
 
1944
        from bzrlib.diff import (get_trees_and_branches_to_diff_locked,
 
1945
            show_diff_trees)
1764
1946
 
1765
1947
        if (prefix is None) or (prefix == '0'):
1766
1948
            # diff -p0 format
1780
1962
            raise errors.BzrCommandError('bzr diff --revision takes exactly'
1781
1963
                                         ' one or two revision specifiers')
1782
1964
 
1783
 
        old_tree, new_tree, specific_files, extra_trees = \
1784
 
                _get_trees_to_diff(file_list, revision, old, new,
1785
 
                apply_view=True)
 
1965
        if using is not None and format is not None:
 
1966
            raise errors.BzrCommandError('--using and --format are mutually '
 
1967
                'exclusive.')
 
1968
 
 
1969
        (old_tree, new_tree,
 
1970
         old_branch, new_branch,
 
1971
         specific_files, extra_trees) = get_trees_and_branches_to_diff_locked(
 
1972
            file_list, revision, old, new, self.add_cleanup, apply_view=True)
 
1973
        # GNU diff on Windows uses ANSI encoding for filenames
 
1974
        path_encoding = osutils.get_diff_header_encoding()
1786
1975
        return show_diff_trees(old_tree, new_tree, sys.stdout,
1787
1976
                               specific_files=specific_files,
1788
1977
                               external_diff_options=diff_options,
1789
1978
                               old_label=old_label, new_label=new_label,
1790
 
                               extra_trees=extra_trees, using=using)
 
1979
                               extra_trees=extra_trees,
 
1980
                               path_encoding=path_encoding,
 
1981
                               using=using,
 
1982
                               format_cls=format)
1791
1983
 
1792
1984
 
1793
1985
class cmd_deleted(Command):
1794
 
    """List files deleted in the working tree.
 
1986
    __doc__ = """List files deleted in the working tree.
1795
1987
    """
1796
1988
    # TODO: Show files deleted since a previous revision, or
1797
1989
    # between two revisions.
1800
1992
    # level of effort but possibly much less IO.  (Or possibly not,
1801
1993
    # if the directories are very large...)
1802
1994
    _see_also = ['status', 'ls']
1803
 
    takes_options = ['show-ids']
 
1995
    takes_options = ['directory', 'show-ids']
1804
1996
 
1805
1997
    @display_command
1806
 
    def run(self, show_ids=False):
1807
 
        tree = WorkingTree.open_containing(u'.')[0]
1808
 
        tree.lock_read()
1809
 
        try:
1810
 
            old = tree.basis_tree()
1811
 
            old.lock_read()
1812
 
            try:
1813
 
                for path, ie in old.inventory.iter_entries():
1814
 
                    if not tree.has_id(ie.file_id):
1815
 
                        self.outf.write(path)
1816
 
                        if show_ids:
1817
 
                            self.outf.write(' ')
1818
 
                            self.outf.write(ie.file_id)
1819
 
                        self.outf.write('\n')
1820
 
            finally:
1821
 
                old.unlock()
1822
 
        finally:
1823
 
            tree.unlock()
 
1998
    def run(self, show_ids=False, directory=u'.'):
 
1999
        tree = WorkingTree.open_containing(directory)[0]
 
2000
        self.add_cleanup(tree.lock_read().unlock)
 
2001
        old = tree.basis_tree()
 
2002
        self.add_cleanup(old.lock_read().unlock)
 
2003
        for path, ie in old.inventory.iter_entries():
 
2004
            if not tree.has_id(ie.file_id):
 
2005
                self.outf.write(path)
 
2006
                if show_ids:
 
2007
                    self.outf.write(' ')
 
2008
                    self.outf.write(ie.file_id)
 
2009
                self.outf.write('\n')
1824
2010
 
1825
2011
 
1826
2012
class cmd_modified(Command):
1827
 
    """List files modified in working tree.
 
2013
    __doc__ = """List files modified in working tree.
1828
2014
    """
1829
2015
 
1830
2016
    hidden = True
1831
2017
    _see_also = ['status', 'ls']
1832
 
    takes_options = [
1833
 
            Option('null',
1834
 
                   help='Write an ascii NUL (\\0) separator '
1835
 
                   'between files rather than a newline.')
1836
 
            ]
 
2018
    takes_options = ['directory', 'null']
1837
2019
 
1838
2020
    @display_command
1839
 
    def run(self, null=False):
1840
 
        tree = WorkingTree.open_containing(u'.')[0]
 
2021
    def run(self, null=False, directory=u'.'):
 
2022
        tree = WorkingTree.open_containing(directory)[0]
1841
2023
        td = tree.changes_from(tree.basis_tree())
1842
2024
        for path, id, kind, text_modified, meta_modified in td.modified:
1843
2025
            if null:
1847
2029
 
1848
2030
 
1849
2031
class cmd_added(Command):
1850
 
    """List files added in working tree.
 
2032
    __doc__ = """List files added in working tree.
1851
2033
    """
1852
2034
 
1853
2035
    hidden = True
1854
2036
    _see_also = ['status', 'ls']
1855
 
    takes_options = [
1856
 
            Option('null',
1857
 
                   help='Write an ascii NUL (\\0) separator '
1858
 
                   'between files rather than a newline.')
1859
 
            ]
 
2037
    takes_options = ['directory', 'null']
1860
2038
 
1861
2039
    @display_command
1862
 
    def run(self, null=False):
1863
 
        wt = WorkingTree.open_containing(u'.')[0]
1864
 
        wt.lock_read()
1865
 
        try:
1866
 
            basis = wt.basis_tree()
1867
 
            basis.lock_read()
1868
 
            try:
1869
 
                basis_inv = basis.inventory
1870
 
                inv = wt.inventory
1871
 
                for file_id in inv:
1872
 
                    if file_id in basis_inv:
1873
 
                        continue
1874
 
                    if inv.is_root(file_id) and len(basis_inv) == 0:
1875
 
                        continue
1876
 
                    path = inv.id2path(file_id)
1877
 
                    if not os.access(osutils.abspath(path), os.F_OK):
1878
 
                        continue
1879
 
                    if null:
1880
 
                        self.outf.write(path + '\0')
1881
 
                    else:
1882
 
                        self.outf.write(osutils.quotefn(path) + '\n')
1883
 
            finally:
1884
 
                basis.unlock()
1885
 
        finally:
1886
 
            wt.unlock()
 
2040
    def run(self, null=False, directory=u'.'):
 
2041
        wt = WorkingTree.open_containing(directory)[0]
 
2042
        self.add_cleanup(wt.lock_read().unlock)
 
2043
        basis = wt.basis_tree()
 
2044
        self.add_cleanup(basis.lock_read().unlock)
 
2045
        basis_inv = basis.inventory
 
2046
        inv = wt.inventory
 
2047
        for file_id in inv:
 
2048
            if file_id in basis_inv:
 
2049
                continue
 
2050
            if inv.is_root(file_id) and len(basis_inv) == 0:
 
2051
                continue
 
2052
            path = inv.id2path(file_id)
 
2053
            if not os.access(osutils.pathjoin(wt.basedir, path), os.F_OK):
 
2054
                continue
 
2055
            if null:
 
2056
                self.outf.write(path + '\0')
 
2057
            else:
 
2058
                self.outf.write(osutils.quotefn(path) + '\n')
1887
2059
 
1888
2060
 
1889
2061
class cmd_root(Command):
1890
 
    """Show the tree root directory.
 
2062
    __doc__ = """Show the tree root directory.
1891
2063
 
1892
2064
    The root is the nearest enclosing directory with a .bzr control
1893
2065
    directory."""
1917
2089
 
1918
2090
 
1919
2091
class cmd_log(Command):
1920
 
    """Show historical log for a branch or subset of a branch.
 
2092
    __doc__ = """Show historical log for a branch or subset of a branch.
1921
2093
 
1922
2094
    log is bzr's default tool for exploring the history of a branch.
1923
2095
    The branch to use is taken from the first parameter. If no parameters
2034
2206
    :Tips & tricks:
2035
2207
 
2036
2208
      GUI tools and IDEs are often better at exploring history than command
2037
 
      line tools. You may prefer qlog or glog from the QBzr and Bzr-Gtk packages
2038
 
      respectively for example. (TortoiseBzr uses qlog for displaying logs.) See
2039
 
      http://bazaar-vcs.org/BzrPlugins and http://bazaar-vcs.org/IDEIntegration.
2040
 
 
2041
 
      Web interfaces are often better at exploring history than command line
2042
 
      tools, particularly for branches on servers. You may prefer Loggerhead
2043
 
      or one of its alternatives. See http://bazaar-vcs.org/WebInterface.
 
2209
      line tools: you may prefer qlog or viz from qbzr or bzr-gtk, the
 
2210
      bzr-explorer shell, or the Loggerhead web interface.  See the Plugin
 
2211
      Guide <http://doc.bazaar.canonical.com/plugins/en/> and
 
2212
      <http://wiki.bazaar.canonical.com/IDEIntegration>.  
2044
2213
 
2045
2214
      You may find it useful to add the aliases below to ``bazaar.conf``::
2046
2215
 
2068
2237
 
2069
2238
      When exploring non-mainline history on large projects with deep
2070
2239
      history, the performance of log can be greatly improved by installing
2071
 
      the revnocache plugin. This plugin buffers historical information
 
2240
      the historycache plugin. This plugin buffers historical information
2072
2241
      trading disk space for faster speed.
2073
2242
    """
2074
2243
    takes_args = ['file*']
2087
2256
                   help='Show just the specified revision.'
2088
2257
                   ' See also "help revisionspec".'),
2089
2258
            'log-format',
 
2259
            RegistryOption('authors',
 
2260
                'What names to list as authors - first, all or committer.',
 
2261
                title='Authors',
 
2262
                lazy_registry=('bzrlib.log', 'author_list_registry'),
 
2263
            ),
2090
2264
            Option('levels',
2091
2265
                   short_name='n',
2092
2266
                   help='Number of levels to display - 0 for all, 1 for flat.',
2105
2279
            Option('show-diff',
2106
2280
                   short_name='p',
2107
2281
                   help='Show changes made in each revision as a patch.'),
 
2282
            Option('include-merges',
 
2283
                   help='Show merged revisions like --levels 0 does.'),
 
2284
            Option('exclude-common-ancestry',
 
2285
                   help='Display only the revisions that are not part'
 
2286
                   ' of both ancestries (require -rX..Y)'
 
2287
                   )
2108
2288
            ]
2109
2289
    encoding_type = 'replace'
2110
2290
 
2119
2299
            levels=None,
2120
2300
            message=None,
2121
2301
            limit=None,
2122
 
            show_diff=False):
 
2302
            show_diff=False,
 
2303
            include_merges=False,
 
2304
            authors=None,
 
2305
            exclude_common_ancestry=False,
 
2306
            ):
2123
2307
        from bzrlib.log import (
2124
2308
            Logger,
2125
2309
            make_log_request_dict,
2126
2310
            _get_info_for_log_files,
2127
2311
            )
2128
2312
        direction = (forward and 'forward') or 'reverse'
 
2313
        if (exclude_common_ancestry
 
2314
            and (revision is None or len(revision) != 2)):
 
2315
            raise errors.BzrCommandError(
 
2316
                '--exclude-common-ancestry requires -r with two revisions')
 
2317
        if include_merges:
 
2318
            if levels is None:
 
2319
                levels = 0
 
2320
            else:
 
2321
                raise errors.BzrCommandError(
 
2322
                    '--levels and --include-merges are mutually exclusive')
2129
2323
 
2130
2324
        if change is not None:
2131
2325
            if len(change) > 1:
2140
2334
        filter_by_dir = False
2141
2335
        if file_list:
2142
2336
            # find the file ids to log and check for directory filtering
2143
 
            b, file_info_list, rev1, rev2 = _get_info_for_log_files(revision,
2144
 
                file_list)
 
2337
            b, file_info_list, rev1, rev2 = _get_info_for_log_files(
 
2338
                revision, file_list, self.add_cleanup)
2145
2339
            for relpath, file_id, kind in file_info_list:
2146
2340
                if file_id is None:
2147
2341
                    raise errors.BzrCommandError(
2165
2359
                location = '.'
2166
2360
            dir, relpath = bzrdir.BzrDir.open_containing(location)
2167
2361
            b = dir.open_branch()
 
2362
            self.add_cleanup(b.lock_read().unlock)
2168
2363
            rev1, rev2 = _get_revision_range(revision, b, self.name())
2169
2364
 
2170
2365
        # Decide on the type of delta & diff filtering to use
2180
2375
        else:
2181
2376
            diff_type = 'full'
2182
2377
 
2183
 
        b.lock_read()
2184
 
        try:
2185
 
            # Build the log formatter
2186
 
            if log_format is None:
2187
 
                log_format = log.log_formatter_registry.get_default(b)
2188
 
            lf = log_format(show_ids=show_ids, to_file=self.outf,
2189
 
                            show_timezone=timezone,
2190
 
                            delta_format=get_verbosity_level(),
2191
 
                            levels=levels)
2192
 
 
2193
 
            # Choose the algorithm for doing the logging. It's annoying
2194
 
            # having multiple code paths like this but necessary until
2195
 
            # the underlying repository format is faster at generating
2196
 
            # deltas or can provide everything we need from the indices.
2197
 
            # The default algorithm - match-using-deltas - works for
2198
 
            # multiple files and directories and is faster for small
2199
 
            # amounts of history (200 revisions say). However, it's too
2200
 
            # slow for logging a single file in a repository with deep
2201
 
            # history, i.e. > 10K revisions. In the spirit of "do no
2202
 
            # evil when adding features", we continue to use the
2203
 
            # original algorithm - per-file-graph - for the "single
2204
 
            # file that isn't a directory without showing a delta" case.
2205
 
            partial_history = revision and b.repository._format.supports_chks
2206
 
            match_using_deltas = (len(file_ids) != 1 or filter_by_dir
2207
 
                or delta_type or partial_history)
2208
 
 
2209
 
            # Build the LogRequest and execute it
2210
 
            if len(file_ids) == 0:
2211
 
                file_ids = None
2212
 
            rqst = make_log_request_dict(
2213
 
                direction=direction, specific_fileids=file_ids,
2214
 
                start_revision=rev1, end_revision=rev2, limit=limit,
2215
 
                message_search=message, delta_type=delta_type,
2216
 
                diff_type=diff_type, _match_using_deltas=match_using_deltas)
2217
 
            Logger(b, rqst).show(lf)
2218
 
        finally:
2219
 
            b.unlock()
 
2378
        # Build the log formatter
 
2379
        if log_format is None:
 
2380
            log_format = log.log_formatter_registry.get_default(b)
 
2381
        # Make a non-encoding output to include the diffs - bug 328007
 
2382
        unencoded_output = ui.ui_factory.make_output_stream(encoding_type='exact')
 
2383
        lf = log_format(show_ids=show_ids, to_file=self.outf,
 
2384
                        to_exact_file=unencoded_output,
 
2385
                        show_timezone=timezone,
 
2386
                        delta_format=get_verbosity_level(),
 
2387
                        levels=levels,
 
2388
                        show_advice=levels is None,
 
2389
                        author_list_handler=authors)
 
2390
 
 
2391
        # Choose the algorithm for doing the logging. It's annoying
 
2392
        # having multiple code paths like this but necessary until
 
2393
        # the underlying repository format is faster at generating
 
2394
        # deltas or can provide everything we need from the indices.
 
2395
        # The default algorithm - match-using-deltas - works for
 
2396
        # multiple files and directories and is faster for small
 
2397
        # amounts of history (200 revisions say). However, it's too
 
2398
        # slow for logging a single file in a repository with deep
 
2399
        # history, i.e. > 10K revisions. In the spirit of "do no
 
2400
        # evil when adding features", we continue to use the
 
2401
        # original algorithm - per-file-graph - for the "single
 
2402
        # file that isn't a directory without showing a delta" case.
 
2403
        partial_history = revision and b.repository._format.supports_chks
 
2404
        match_using_deltas = (len(file_ids) != 1 or filter_by_dir
 
2405
            or delta_type or partial_history)
 
2406
 
 
2407
        # Build the LogRequest and execute it
 
2408
        if len(file_ids) == 0:
 
2409
            file_ids = None
 
2410
        rqst = make_log_request_dict(
 
2411
            direction=direction, specific_fileids=file_ids,
 
2412
            start_revision=rev1, end_revision=rev2, limit=limit,
 
2413
            message_search=message, delta_type=delta_type,
 
2414
            diff_type=diff_type, _match_using_deltas=match_using_deltas,
 
2415
            exclude_common_ancestry=exclude_common_ancestry,
 
2416
            )
 
2417
        Logger(b, rqst).show(lf)
2220
2418
 
2221
2419
 
2222
2420
def _get_revision_range(revisionspec_list, branch, command_name):
2240
2438
            raise errors.BzrCommandError(
2241
2439
                "bzr %s doesn't accept two revisions in different"
2242
2440
                " branches." % command_name)
2243
 
        rev1 = start_spec.in_history(branch)
 
2441
        if start_spec.spec is None:
 
2442
            # Avoid loading all the history.
 
2443
            rev1 = RevisionInfo(branch, None, None)
 
2444
        else:
 
2445
            rev1 = start_spec.in_history(branch)
2244
2446
        # Avoid loading all of history when we know a missing
2245
2447
        # end of range means the last revision ...
2246
2448
        if end_spec.spec is None:
2275
2477
 
2276
2478
 
2277
2479
class cmd_touching_revisions(Command):
2278
 
    """Return revision-ids which affected a particular file.
 
2480
    __doc__ = """Return revision-ids which affected a particular file.
2279
2481
 
2280
2482
    A more user-friendly interface is "bzr log FILE".
2281
2483
    """
2286
2488
    @display_command
2287
2489
    def run(self, filename):
2288
2490
        tree, relpath = WorkingTree.open_containing(filename)
 
2491
        file_id = tree.path2id(relpath)
2289
2492
        b = tree.branch
2290
 
        file_id = tree.path2id(relpath)
2291
 
        for revno, revision_id, what in log.find_touching_revisions(b, file_id):
 
2493
        self.add_cleanup(b.lock_read().unlock)
 
2494
        touching_revs = log.find_touching_revisions(b, file_id)
 
2495
        for revno, revision_id, what in touching_revs:
2292
2496
            self.outf.write("%6d %s\n" % (revno, what))
2293
2497
 
2294
2498
 
2295
2499
class cmd_ls(Command):
2296
 
    """List files in a tree.
 
2500
    __doc__ = """List files in a tree.
2297
2501
    """
2298
2502
 
2299
2503
    _see_also = ['status', 'cat']
2305
2509
                   help='Recurse into subdirectories.'),
2306
2510
            Option('from-root',
2307
2511
                   help='Print paths relative to the root of the branch.'),
2308
 
            Option('unknown', help='Print unknown files.'),
 
2512
            Option('unknown', short_name='u',
 
2513
                help='Print unknown files.'),
2309
2514
            Option('versioned', help='Print versioned files.',
2310
2515
                   short_name='V'),
2311
 
            Option('ignored', help='Print ignored files.'),
2312
 
            Option('null',
2313
 
                   help='Write an ascii NUL (\\0) separator '
2314
 
                   'between files rather than a newline.'),
2315
 
            Option('kind',
 
2516
            Option('ignored', short_name='i',
 
2517
                help='Print ignored files.'),
 
2518
            Option('kind', short_name='k',
2316
2519
                   help='List entries of a particular kind: file, directory, symlink.',
2317
2520
                   type=unicode),
 
2521
            'null',
2318
2522
            'show-ids',
 
2523
            'directory',
2319
2524
            ]
2320
2525
    @display_command
2321
2526
    def run(self, revision=None, verbose=False,
2322
2527
            recursive=False, from_root=False,
2323
2528
            unknown=False, versioned=False, ignored=False,
2324
 
            null=False, kind=None, show_ids=False, path=None):
 
2529
            null=False, kind=None, show_ids=False, path=None, directory=None):
2325
2530
 
2326
2531
        if kind and kind not in ('file', 'directory', 'symlink'):
2327
2532
            raise errors.BzrCommandError('invalid kind specified')
2334
2539
 
2335
2540
        if path is None:
2336
2541
            fs_path = '.'
2337
 
            prefix = ''
2338
2542
        else:
2339
2543
            if from_root:
2340
2544
                raise errors.BzrCommandError('cannot specify both --from-root'
2341
2545
                                             ' and PATH')
2342
2546
            fs_path = path
2343
 
            prefix = path
2344
 
        tree, branch, relpath = bzrdir.BzrDir.open_containing_tree_or_branch(
2345
 
            fs_path)
 
2547
        tree, branch, relpath = \
 
2548
            _open_directory_or_containing_tree_or_branch(fs_path, directory)
 
2549
 
 
2550
        # Calculate the prefix to use
 
2551
        prefix = None
2346
2552
        if from_root:
2347
 
            relpath = u''
2348
 
        elif relpath:
2349
 
            relpath += '/'
 
2553
            if relpath:
 
2554
                prefix = relpath + '/'
 
2555
        elif fs_path != '.' and not fs_path.endswith('/'):
 
2556
            prefix = fs_path + '/'
 
2557
 
2350
2558
        if revision is not None or tree is None:
2351
2559
            tree = _get_one_revision_tree('ls', revision, branch=branch)
2352
2560
 
2358
2566
                view_str = views.view_display_str(view_files)
2359
2567
                note("Ignoring files outside view. View is %s" % view_str)
2360
2568
 
2361
 
        tree.lock_read()
2362
 
        try:
2363
 
            for fp, fc, fkind, fid, entry in tree.list_files(include_root=False):
2364
 
                if fp.startswith(relpath):
2365
 
                    rp = fp[len(relpath):]
2366
 
                    fp = osutils.pathjoin(prefix, rp)
2367
 
                    if not recursive and '/' in rp:
2368
 
                        continue
2369
 
                    if not all and not selection[fc]:
2370
 
                        continue
2371
 
                    if kind is not None and fkind != kind:
2372
 
                        continue
2373
 
                    if apply_view:
2374
 
                        try:
2375
 
                            views.check_path_in_view(tree, fp)
2376
 
                        except errors.FileOutsideView:
2377
 
                            continue
2378
 
                    kindch = entry.kind_character()
2379
 
                    outstring = fp + kindch
2380
 
                    if verbose:
2381
 
                        outstring = '%-8s %s' % (fc, outstring)
2382
 
                        if show_ids and fid is not None:
2383
 
                            outstring = "%-50s %s" % (outstring, fid)
2384
 
                        self.outf.write(outstring + '\n')
2385
 
                    elif null:
2386
 
                        self.outf.write(fp + '\0')
2387
 
                        if show_ids:
2388
 
                            if fid is not None:
2389
 
                                self.outf.write(fid)
2390
 
                            self.outf.write('\0')
2391
 
                        self.outf.flush()
2392
 
                    else:
2393
 
                        if fid is not None:
2394
 
                            my_id = fid
2395
 
                        else:
2396
 
                            my_id = ''
2397
 
                        if show_ids:
2398
 
                            self.outf.write('%-50s %s\n' % (outstring, my_id))
2399
 
                        else:
2400
 
                            self.outf.write(outstring + '\n')
2401
 
        finally:
2402
 
            tree.unlock()
 
2569
        self.add_cleanup(tree.lock_read().unlock)
 
2570
        for fp, fc, fkind, fid, entry in tree.list_files(include_root=False,
 
2571
            from_dir=relpath, recursive=recursive):
 
2572
            # Apply additional masking
 
2573
            if not all and not selection[fc]:
 
2574
                continue
 
2575
            if kind is not None and fkind != kind:
 
2576
                continue
 
2577
            if apply_view:
 
2578
                try:
 
2579
                    if relpath:
 
2580
                        fullpath = osutils.pathjoin(relpath, fp)
 
2581
                    else:
 
2582
                        fullpath = fp
 
2583
                    views.check_path_in_view(tree, fullpath)
 
2584
                except errors.FileOutsideView:
 
2585
                    continue
 
2586
 
 
2587
            # Output the entry
 
2588
            if prefix:
 
2589
                fp = osutils.pathjoin(prefix, fp)
 
2590
            kindch = entry.kind_character()
 
2591
            outstring = fp + kindch
 
2592
            ui.ui_factory.clear_term()
 
2593
            if verbose:
 
2594
                outstring = '%-8s %s' % (fc, outstring)
 
2595
                if show_ids and fid is not None:
 
2596
                    outstring = "%-50s %s" % (outstring, fid)
 
2597
                self.outf.write(outstring + '\n')
 
2598
            elif null:
 
2599
                self.outf.write(fp + '\0')
 
2600
                if show_ids:
 
2601
                    if fid is not None:
 
2602
                        self.outf.write(fid)
 
2603
                    self.outf.write('\0')
 
2604
                self.outf.flush()
 
2605
            else:
 
2606
                if show_ids:
 
2607
                    if fid is not None:
 
2608
                        my_id = fid
 
2609
                    else:
 
2610
                        my_id = ''
 
2611
                    self.outf.write('%-50s %s\n' % (outstring, my_id))
 
2612
                else:
 
2613
                    self.outf.write(outstring + '\n')
2403
2614
 
2404
2615
 
2405
2616
class cmd_unknowns(Command):
2406
 
    """List unknown files.
 
2617
    __doc__ = """List unknown files.
2407
2618
    """
2408
2619
 
2409
2620
    hidden = True
2410
2621
    _see_also = ['ls']
 
2622
    takes_options = ['directory']
2411
2623
 
2412
2624
    @display_command
2413
 
    def run(self):
2414
 
        for f in WorkingTree.open_containing(u'.')[0].unknowns():
 
2625
    def run(self, directory=u'.'):
 
2626
        for f in WorkingTree.open_containing(directory)[0].unknowns():
2415
2627
            self.outf.write(osutils.quotefn(f) + '\n')
2416
2628
 
2417
2629
 
2418
2630
class cmd_ignore(Command):
2419
 
    """Ignore specified files or patterns.
 
2631
    __doc__ = """Ignore specified files or patterns.
2420
2632
 
2421
2633
    See ``bzr help patterns`` for details on the syntax of patterns.
2422
2634
 
 
2635
    If a .bzrignore file does not exist, the ignore command
 
2636
    will create one and add the specified files or patterns to the newly
 
2637
    created file. The ignore command will also automatically add the 
 
2638
    .bzrignore file to be versioned. Creating a .bzrignore file without
 
2639
    the use of the ignore command will require an explicit add command.
 
2640
 
2423
2641
    To remove patterns from the ignore list, edit the .bzrignore file.
2424
2642
    After adding, editing or deleting that file either indirectly by
2425
2643
    using this command or directly by using an editor, be sure to commit
2426
2644
    it.
 
2645
    
 
2646
    Bazaar also supports a global ignore file ~/.bazaar/ignore. On Windows
 
2647
    the global ignore file can be found in the application data directory as
 
2648
    C:\\Documents and Settings\\<user>\\Application Data\\Bazaar\\2.0\\ignore.
 
2649
    Global ignores are not touched by this command. The global ignore file
 
2650
    can be edited directly using an editor.
 
2651
 
 
2652
    Patterns prefixed with '!' are exceptions to ignore patterns and take
 
2653
    precedence over regular ignores.  Such exceptions are used to specify
 
2654
    files that should be versioned which would otherwise be ignored.
 
2655
    
 
2656
    Patterns prefixed with '!!' act as regular ignore patterns, but have
 
2657
    precedence over the '!' exception patterns.
2427
2658
 
2428
2659
    Note: ignore patterns containing shell wildcards must be quoted from
2429
2660
    the shell on Unix.
2433
2664
 
2434
2665
            bzr ignore ./Makefile
2435
2666
 
2436
 
        Ignore class files in all directories::
 
2667
        Ignore .class files in all directories...::
2437
2668
 
2438
2669
            bzr ignore "*.class"
2439
2670
 
 
2671
        ...but do not ignore "special.class"::
 
2672
 
 
2673
            bzr ignore "!special.class"
 
2674
 
2440
2675
        Ignore .o files under the lib directory::
2441
2676
 
2442
2677
            bzr ignore "lib/**/*.o"
2448
2683
        Ignore everything but the "debian" toplevel directory::
2449
2684
 
2450
2685
            bzr ignore "RE:(?!debian/).*"
 
2686
        
 
2687
        Ignore everything except the "local" toplevel directory,
 
2688
        but always ignore "*~" autosave files, even under local/::
 
2689
        
 
2690
            bzr ignore "*"
 
2691
            bzr ignore "!./local"
 
2692
            bzr ignore "!!*~"
2451
2693
    """
2452
2694
 
2453
2695
    _see_also = ['status', 'ignored', 'patterns']
2454
2696
    takes_args = ['name_pattern*']
2455
 
    takes_options = [
2456
 
        Option('old-default-rules',
2457
 
               help='Write out the ignore rules bzr < 0.9 always used.')
 
2697
    takes_options = ['directory',
 
2698
        Option('default-rules',
 
2699
               help='Display the default ignore rules that bzr uses.')
2458
2700
        ]
2459
2701
 
2460
 
    def run(self, name_pattern_list=None, old_default_rules=None):
 
2702
    def run(self, name_pattern_list=None, default_rules=None,
 
2703
            directory=u'.'):
2461
2704
        from bzrlib import ignores
2462
 
        if old_default_rules is not None:
2463
 
            # dump the rules and exit
2464
 
            for pattern in ignores.OLD_DEFAULTS:
2465
 
                print pattern
 
2705
        if default_rules is not None:
 
2706
            # dump the default rules and exit
 
2707
            for pattern in ignores.USER_DEFAULTS:
 
2708
                self.outf.write("%s\n" % pattern)
2466
2709
            return
2467
2710
        if not name_pattern_list:
2468
2711
            raise errors.BzrCommandError("ignore requires at least one "
2469
 
                                  "NAME_PATTERN or --old-default-rules")
 
2712
                "NAME_PATTERN or --default-rules.")
2470
2713
        name_pattern_list = [globbing.normalize_pattern(p)
2471
2714
                             for p in name_pattern_list]
2472
2715
        for name_pattern in name_pattern_list:
2474
2717
                (len(name_pattern) > 1 and name_pattern[1] == ':')):
2475
2718
                raise errors.BzrCommandError(
2476
2719
                    "NAME_PATTERN should not be an absolute path")
2477
 
        tree, relpath = WorkingTree.open_containing(u'.')
 
2720
        tree, relpath = WorkingTree.open_containing(directory)
2478
2721
        ignores.tree_ignores_add_patterns(tree, name_pattern_list)
2479
2722
        ignored = globbing.Globster(name_pattern_list)
2480
2723
        matches = []
2481
 
        tree.lock_read()
 
2724
        self.add_cleanup(tree.lock_read().unlock)
2482
2725
        for entry in tree.list_files():
2483
2726
            id = entry[3]
2484
2727
            if id is not None:
2485
2728
                filename = entry[0]
2486
2729
                if ignored.match(filename):
2487
 
                    matches.append(filename.encode('utf-8'))
2488
 
        tree.unlock()
 
2730
                    matches.append(filename)
2489
2731
        if len(matches) > 0:
2490
 
            print "Warning: the following files are version controlled and" \
2491
 
                  " match your ignore pattern:\n%s" \
2492
 
                  "\nThese files will continue to be version controlled" \
2493
 
                  " unless you 'bzr remove' them." % ("\n".join(matches),)
 
2732
            self.outf.write("Warning: the following files are version controlled and"
 
2733
                  " match your ignore pattern:\n%s"
 
2734
                  "\nThese files will continue to be version controlled"
 
2735
                  " unless you 'bzr remove' them.\n" % ("\n".join(matches),))
2494
2736
 
2495
2737
 
2496
2738
class cmd_ignored(Command):
2497
 
    """List ignored files and the patterns that matched them.
 
2739
    __doc__ = """List ignored files and the patterns that matched them.
2498
2740
 
2499
2741
    List all the ignored files and the ignore pattern that caused the file to
2500
2742
    be ignored.
2506
2748
 
2507
2749
    encoding_type = 'replace'
2508
2750
    _see_also = ['ignore', 'ls']
 
2751
    takes_options = ['directory']
2509
2752
 
2510
2753
    @display_command
2511
 
    def run(self):
2512
 
        tree = WorkingTree.open_containing(u'.')[0]
2513
 
        tree.lock_read()
2514
 
        try:
2515
 
            for path, file_class, kind, file_id, entry in tree.list_files():
2516
 
                if file_class != 'I':
2517
 
                    continue
2518
 
                ## XXX: Slightly inefficient since this was already calculated
2519
 
                pat = tree.is_ignored(path)
2520
 
                self.outf.write('%-50s %s\n' % (path, pat))
2521
 
        finally:
2522
 
            tree.unlock()
 
2754
    def run(self, directory=u'.'):
 
2755
        tree = WorkingTree.open_containing(directory)[0]
 
2756
        self.add_cleanup(tree.lock_read().unlock)
 
2757
        for path, file_class, kind, file_id, entry in tree.list_files():
 
2758
            if file_class != 'I':
 
2759
                continue
 
2760
            ## XXX: Slightly inefficient since this was already calculated
 
2761
            pat = tree.is_ignored(path)
 
2762
            self.outf.write('%-50s %s\n' % (path, pat))
2523
2763
 
2524
2764
 
2525
2765
class cmd_lookup_revision(Command):
2526
 
    """Lookup the revision-id from a revision-number
 
2766
    __doc__ = """Lookup the revision-id from a revision-number
2527
2767
 
2528
2768
    :Examples:
2529
2769
        bzr lookup-revision 33
2530
2770
    """
2531
2771
    hidden = True
2532
2772
    takes_args = ['revno']
 
2773
    takes_options = ['directory']
2533
2774
 
2534
2775
    @display_command
2535
 
    def run(self, revno):
 
2776
    def run(self, revno, directory=u'.'):
2536
2777
        try:
2537
2778
            revno = int(revno)
2538
2779
        except ValueError:
2539
 
            raise errors.BzrCommandError("not a valid revision-number: %r" % revno)
2540
 
 
2541
 
        print WorkingTree.open_containing(u'.')[0].branch.get_rev_id(revno)
 
2780
            raise errors.BzrCommandError("not a valid revision-number: %r"
 
2781
                                         % revno)
 
2782
        revid = WorkingTree.open_containing(directory)[0].branch.get_rev_id(revno)
 
2783
        self.outf.write("%s\n" % revid)
2542
2784
 
2543
2785
 
2544
2786
class cmd_export(Command):
2545
 
    """Export current or past revision to a destination directory or archive.
 
2787
    __doc__ = """Export current or past revision to a destination directory or archive.
2546
2788
 
2547
2789
    If no revision is specified this exports the last committed revision.
2548
2790
 
2570
2812
      =================       =========================
2571
2813
    """
2572
2814
    takes_args = ['dest', 'branch_or_subdir?']
2573
 
    takes_options = [
 
2815
    takes_options = ['directory',
2574
2816
        Option('format',
2575
2817
               help="Type of file to export to.",
2576
2818
               type=unicode),
2580
2822
        Option('root',
2581
2823
               type=str,
2582
2824
               help="Name of the root directory inside the exported file."),
 
2825
        Option('per-file-timestamps',
 
2826
               help='Set modification time of files to that of the last '
 
2827
                    'revision in which it was changed.'),
2583
2828
        ]
2584
2829
    def run(self, dest, branch_or_subdir=None, revision=None, format=None,
2585
 
        root=None, filters=False):
 
2830
        root=None, filters=False, per_file_timestamps=False, directory=u'.'):
2586
2831
        from bzrlib.export import export
2587
2832
 
2588
2833
        if branch_or_subdir is None:
2589
 
            tree = WorkingTree.open_containing(u'.')[0]
 
2834
            tree = WorkingTree.open_containing(directory)[0]
2590
2835
            b = tree.branch
2591
2836
            subdir = None
2592
2837
        else:
2595
2840
 
2596
2841
        rev_tree = _get_one_revision_tree('export', revision, branch=b, tree=tree)
2597
2842
        try:
2598
 
            export(rev_tree, dest, format, root, subdir, filtered=filters)
 
2843
            export(rev_tree, dest, format, root, subdir, filtered=filters,
 
2844
                   per_file_timestamps=per_file_timestamps)
2599
2845
        except errors.NoSuchExportFormat, e:
2600
2846
            raise errors.BzrCommandError('Unsupported export format: %s' % e.format)
2601
2847
 
2602
2848
 
2603
2849
class cmd_cat(Command):
2604
 
    """Write the contents of a file as of a given revision to standard output.
 
2850
    __doc__ = """Write the contents of a file as of a given revision to standard output.
2605
2851
 
2606
2852
    If no revision is nominated, the last revision is used.
2607
2853
 
2610
2856
    """
2611
2857
 
2612
2858
    _see_also = ['ls']
2613
 
    takes_options = [
 
2859
    takes_options = ['directory',
2614
2860
        Option('name-from-revision', help='The path name in the old tree.'),
2615
2861
        Option('filters', help='Apply content filters to display the '
2616
2862
                'convenience form.'),
2621
2867
 
2622
2868
    @display_command
2623
2869
    def run(self, filename, revision=None, name_from_revision=False,
2624
 
            filters=False):
 
2870
            filters=False, directory=None):
2625
2871
        if revision is not None and len(revision) != 1:
2626
2872
            raise errors.BzrCommandError("bzr cat --revision takes exactly"
2627
2873
                                         " one revision specifier")
2628
2874
        tree, branch, relpath = \
2629
 
            bzrdir.BzrDir.open_containing_tree_or_branch(filename)
2630
 
        branch.lock_read()
2631
 
        try:
2632
 
            return self._run(tree, branch, relpath, filename, revision,
2633
 
                             name_from_revision, filters)
2634
 
        finally:
2635
 
            branch.unlock()
 
2875
            _open_directory_or_containing_tree_or_branch(filename, directory)
 
2876
        self.add_cleanup(branch.lock_read().unlock)
 
2877
        return self._run(tree, branch, relpath, filename, revision,
 
2878
                         name_from_revision, filters)
2636
2879
 
2637
2880
    def _run(self, tree, b, relpath, filename, revision, name_from_revision,
2638
2881
        filtered):
2639
2882
        if tree is None:
2640
2883
            tree = b.basis_tree()
2641
2884
        rev_tree = _get_one_revision_tree('cat', revision, branch=b)
 
2885
        self.add_cleanup(rev_tree.lock_read().unlock)
2642
2886
 
2643
2887
        old_file_id = rev_tree.path2id(relpath)
2644
2888
 
2679
2923
            chunks = content.splitlines(True)
2680
2924
            content = filtered_output_bytes(chunks, filters,
2681
2925
                ContentFilterContext(relpath, rev_tree))
 
2926
            self.cleanup_now()
2682
2927
            self.outf.writelines(content)
2683
2928
        else:
 
2929
            self.cleanup_now()
2684
2930
            self.outf.write(content)
2685
2931
 
2686
2932
 
2687
2933
class cmd_local_time_offset(Command):
2688
 
    """Show the offset in seconds from GMT to local time."""
 
2934
    __doc__ = """Show the offset in seconds from GMT to local time."""
2689
2935
    hidden = True
2690
2936
    @display_command
2691
2937
    def run(self):
2692
 
        print osutils.local_time_offset()
 
2938
        self.outf.write("%s\n" % osutils.local_time_offset())
2693
2939
 
2694
2940
 
2695
2941
 
2696
2942
class cmd_commit(Command):
2697
 
    """Commit changes into a new revision.
2698
 
 
2699
 
    If no arguments are given, the entire tree is committed.
2700
 
 
2701
 
    If selected files are specified, only changes to those files are
2702
 
    committed.  If a directory is specified then the directory and everything
2703
 
    within it is committed.
2704
 
 
2705
 
    When excludes are given, they take precedence over selected files.
2706
 
    For example, too commit only changes within foo, but not changes within
2707
 
    foo/bar::
2708
 
 
2709
 
      bzr commit foo -x foo/bar
2710
 
 
2711
 
    If author of the change is not the same person as the committer, you can
2712
 
    specify the author's name using the --author option. The name should be
2713
 
    in the same format as a committer-id, e.g. "John Doe <jdoe@example.com>".
2714
 
    If there is more than one author of the change you can specify the option
2715
 
    multiple times, once for each author.
2716
 
 
2717
 
    A selected-file commit may fail in some cases where the committed
2718
 
    tree would be invalid. Consider::
2719
 
 
2720
 
      bzr init foo
2721
 
      mkdir foo/bar
2722
 
      bzr add foo/bar
2723
 
      bzr commit foo -m "committing foo"
2724
 
      bzr mv foo/bar foo/baz
2725
 
      mkdir foo/bar
2726
 
      bzr add foo/bar
2727
 
      bzr commit foo/bar -m "committing bar but not baz"
2728
 
 
2729
 
    In the example above, the last commit will fail by design. This gives
2730
 
    the user the opportunity to decide whether they want to commit the
2731
 
    rename at the same time, separately first, or not at all. (As a general
2732
 
    rule, when in doubt, Bazaar has a policy of Doing the Safe Thing.)
2733
 
 
2734
 
    Note: A selected-file commit after a merge is not yet supported.
 
2943
    __doc__ = """Commit changes into a new revision.
 
2944
 
 
2945
    An explanatory message needs to be given for each commit. This is
 
2946
    often done by using the --message option (getting the message from the
 
2947
    command line) or by using the --file option (getting the message from
 
2948
    a file). If neither of these options is given, an editor is opened for
 
2949
    the user to enter the message. To see the changed files in the
 
2950
    boilerplate text loaded into the editor, use the --show-diff option.
 
2951
 
 
2952
    By default, the entire tree is committed and the person doing the
 
2953
    commit is assumed to be the author. These defaults can be overridden
 
2954
    as explained below.
 
2955
 
 
2956
    :Selective commits:
 
2957
 
 
2958
      If selected files are specified, only changes to those files are
 
2959
      committed.  If a directory is specified then the directory and
 
2960
      everything within it is committed.
 
2961
  
 
2962
      When excludes are given, they take precedence over selected files.
 
2963
      For example, to commit only changes within foo, but not changes
 
2964
      within foo/bar::
 
2965
  
 
2966
        bzr commit foo -x foo/bar
 
2967
  
 
2968
      A selective commit after a merge is not yet supported.
 
2969
 
 
2970
    :Custom authors:
 
2971
 
 
2972
      If the author of the change is not the same person as the committer,
 
2973
      you can specify the author's name using the --author option. The
 
2974
      name should be in the same format as a committer-id, e.g.
 
2975
      "John Doe <jdoe@example.com>". If there is more than one author of
 
2976
      the change you can specify the option multiple times, once for each
 
2977
      author.
 
2978
  
 
2979
    :Checks:
 
2980
 
 
2981
      A common mistake is to forget to add a new file or directory before
 
2982
      running the commit command. The --strict option checks for unknown
 
2983
      files and aborts the commit if any are found. More advanced pre-commit
 
2984
      checks can be implemented by defining hooks. See ``bzr help hooks``
 
2985
      for details.
 
2986
 
 
2987
    :Things to note:
 
2988
 
 
2989
      If you accidentially commit the wrong changes or make a spelling
 
2990
      mistake in the commit message say, you can use the uncommit command
 
2991
      to undo it. See ``bzr help uncommit`` for details.
 
2992
 
 
2993
      Hooks can also be configured to run after a commit. This allows you
 
2994
      to trigger updates to external systems like bug trackers. The --fixes
 
2995
      option can be used to record the association between a revision and
 
2996
      one or more bugs. See ``bzr help bugs`` for details.
 
2997
 
 
2998
      A selective commit may fail in some cases where the committed
 
2999
      tree would be invalid. Consider::
 
3000
  
 
3001
        bzr init foo
 
3002
        mkdir foo/bar
 
3003
        bzr add foo/bar
 
3004
        bzr commit foo -m "committing foo"
 
3005
        bzr mv foo/bar foo/baz
 
3006
        mkdir foo/bar
 
3007
        bzr add foo/bar
 
3008
        bzr commit foo/bar -m "committing bar but not baz"
 
3009
  
 
3010
      In the example above, the last commit will fail by design. This gives
 
3011
      the user the opportunity to decide whether they want to commit the
 
3012
      rename at the same time, separately first, or not at all. (As a general
 
3013
      rule, when in doubt, Bazaar has a policy of Doing the Safe Thing.)
2735
3014
    """
2736
3015
    # TODO: Run hooks on tree to-be-committed, and after commit.
2737
3016
 
2742
3021
 
2743
3022
    # XXX: verbose currently does nothing
2744
3023
 
2745
 
    _see_also = ['bugs', 'uncommit']
 
3024
    _see_also = ['add', 'bugs', 'hooks', 'uncommit']
2746
3025
    takes_args = ['selected*']
2747
3026
    takes_options = [
2748
3027
            ListOption('exclude', type=str, short_name='x',
2760
3039
             Option('strict',
2761
3040
                    help="Refuse to commit if there are unknown "
2762
3041
                    "files in the working tree."),
 
3042
             Option('commit-time', type=str,
 
3043
                    help="Manually set a commit time using commit date "
 
3044
                    "format, e.g. '2009-10-10 08:00:00 +0100'."),
2763
3045
             ListOption('fixes', type=str,
2764
3046
                    help="Mark a bug as being fixed by this revision "
2765
3047
                         "(see \"bzr help bugs\")."),
2772
3054
                         "the master branch until a normal commit "
2773
3055
                         "is performed."
2774
3056
                    ),
2775
 
              Option('show-diff',
2776
 
                     help='When no message is supplied, show the diff along'
2777
 
                     ' with the status summary in the message editor.'),
 
3057
             Option('show-diff', short_name='p',
 
3058
                    help='When no message is supplied, show the diff along'
 
3059
                    ' with the status summary in the message editor.'),
2778
3060
             ]
2779
3061
    aliases = ['ci', 'checkin']
2780
3062
 
2799
3081
 
2800
3082
    def run(self, message=None, file=None, verbose=False, selected_list=None,
2801
3083
            unchanged=False, strict=False, local=False, fixes=None,
2802
 
            author=None, show_diff=False, exclude=None):
 
3084
            author=None, show_diff=False, exclude=None, commit_time=None):
2803
3085
        from bzrlib.errors import (
2804
3086
            PointlessCommit,
2805
3087
            ConflictsInTree,
2811
3093
            make_commit_message_template_encoded
2812
3094
        )
2813
3095
 
 
3096
        commit_stamp = offset = None
 
3097
        if commit_time is not None:
 
3098
            try:
 
3099
                commit_stamp, offset = timestamp.parse_patch_date(commit_time)
 
3100
            except ValueError, e:
 
3101
                raise errors.BzrCommandError(
 
3102
                    "Could not parse --commit-time: " + str(e))
 
3103
 
2814
3104
        # TODO: Need a blackbox test for invoking the external editor; may be
2815
3105
        # slightly problematic to run this cross-platform.
2816
3106
 
2836
3126
        if local and not tree.branch.get_bound_location():
2837
3127
            raise errors.LocalRequiresBoundBranch()
2838
3128
 
 
3129
        if message is not None:
 
3130
            try:
 
3131
                file_exists = osutils.lexists(message)
 
3132
            except UnicodeError:
 
3133
                # The commit message contains unicode characters that can't be
 
3134
                # represented in the filesystem encoding, so that can't be a
 
3135
                # file.
 
3136
                file_exists = False
 
3137
            if file_exists:
 
3138
                warning_msg = (
 
3139
                    'The commit message is a file name: "%(f)s".\n'
 
3140
                    '(use --file "%(f)s" to take commit message from that file)'
 
3141
                    % { 'f': message })
 
3142
                ui.ui_factory.show_warning(warning_msg)
 
3143
            if '\r' in message:
 
3144
                message = message.replace('\r\n', '\n')
 
3145
                message = message.replace('\r', '\n')
 
3146
            if file:
 
3147
                raise errors.BzrCommandError(
 
3148
                    "please specify either --message or --file")
 
3149
 
2839
3150
        def get_message(commit_obj):
2840
3151
            """Callback to get commit message"""
2841
 
            my_message = message
2842
 
            if my_message is None and not file:
2843
 
                t = make_commit_message_template_encoded(tree,
 
3152
            if file:
 
3153
                f = codecs.open(file, 'rt', osutils.get_user_encoding())
 
3154
                try:
 
3155
                    my_message = f.read()
 
3156
                finally:
 
3157
                    f.close()
 
3158
            elif message is not None:
 
3159
                my_message = message
 
3160
            else:
 
3161
                # No message supplied: make one up.
 
3162
                # text is the status of the tree
 
3163
                text = make_commit_message_template_encoded(tree,
2844
3164
                        selected_list, diff=show_diff,
2845
3165
                        output_encoding=osutils.get_user_encoding())
 
3166
                # start_message is the template generated from hooks
 
3167
                # XXX: Warning - looks like hooks return unicode,
 
3168
                # make_commit_message_template_encoded returns user encoding.
 
3169
                # We probably want to be using edit_commit_message instead to
 
3170
                # avoid this.
2846
3171
                start_message = generate_commit_message_template(commit_obj)
2847
 
                my_message = edit_commit_message_encoded(t,
 
3172
                my_message = edit_commit_message_encoded(text,
2848
3173
                    start_message=start_message)
2849
3174
                if my_message is None:
2850
3175
                    raise errors.BzrCommandError("please specify a commit"
2851
3176
                        " message with either --message or --file")
2852
 
            elif my_message and file:
2853
 
                raise errors.BzrCommandError(
2854
 
                    "please specify either --message or --file")
2855
 
            if file:
2856
 
                my_message = codecs.open(file, 'rt',
2857
 
                                         osutils.get_user_encoding()).read()
2858
3177
            if my_message == "":
2859
3178
                raise errors.BzrCommandError("empty commit message specified")
2860
3179
            return my_message
2861
3180
 
 
3181
        # The API permits a commit with a filter of [] to mean 'select nothing'
 
3182
        # but the command line should not do that.
 
3183
        if not selected_list:
 
3184
            selected_list = None
2862
3185
        try:
2863
3186
            tree.commit(message_callback=get_message,
2864
3187
                        specific_files=selected_list,
2865
3188
                        allow_pointless=unchanged, strict=strict, local=local,
2866
3189
                        reporter=None, verbose=verbose, revprops=properties,
2867
 
                        authors=author,
 
3190
                        authors=author, timestamp=commit_stamp,
 
3191
                        timezone=offset,
2868
3192
                        exclude=safe_relpath_files(tree, exclude))
2869
3193
        except PointlessCommit:
2870
 
            # FIXME: This should really happen before the file is read in;
2871
 
            # perhaps prepare the commit; get the message; then actually commit
2872
 
            raise errors.BzrCommandError("no changes to commit."
2873
 
                              " use --unchanged to commit anyhow")
 
3194
            raise errors.BzrCommandError("No changes to commit."
 
3195
                              " Use --unchanged to commit anyhow.")
2874
3196
        except ConflictsInTree:
2875
3197
            raise errors.BzrCommandError('Conflicts detected in working '
2876
3198
                'tree.  Use "bzr conflicts" to list, "bzr resolve FILE" to'
2879
3201
            raise errors.BzrCommandError("Commit refused because there are"
2880
3202
                              " unknown files in the working tree.")
2881
3203
        except errors.BoundBranchOutOfDate, e:
2882
 
            raise errors.BzrCommandError(str(e) + "\n"
2883
 
            'To commit to master branch, run update and then commit.\n'
2884
 
            'You can also pass --local to commit to continue working '
2885
 
            'disconnected.')
 
3204
            e.extra_help = ("\n"
 
3205
                'To commit to master branch, run update and then commit.\n'
 
3206
                'You can also pass --local to commit to continue working '
 
3207
                'disconnected.')
 
3208
            raise
2886
3209
 
2887
3210
 
2888
3211
class cmd_check(Command):
2889
 
    """Validate working tree structure, branch consistency and repository history.
 
3212
    __doc__ = """Validate working tree structure, branch consistency and repository history.
2890
3213
 
2891
3214
    This command checks various invariants about branch and repository storage
2892
3215
    to detect data corruption or bzr bugs.
2894
3217
    The working tree and branch checks will only give output if a problem is
2895
3218
    detected. The output fields of the repository check are:
2896
3219
 
2897
 
        revisions: This is just the number of revisions checked.  It doesn't
2898
 
            indicate a problem.
2899
 
        versionedfiles: This is just the number of versionedfiles checked.  It
2900
 
            doesn't indicate a problem.
2901
 
        unreferenced ancestors: Texts that are ancestors of other texts, but
2902
 
            are not properly referenced by the revision ancestry.  This is a
2903
 
            subtle problem that Bazaar can work around.
2904
 
        unique file texts: This is the total number of unique file contents
2905
 
            seen in the checked revisions.  It does not indicate a problem.
2906
 
        repeated file texts: This is the total number of repeated texts seen
2907
 
            in the checked revisions.  Texts can be repeated when their file
2908
 
            entries are modified, but the file contents are not.  It does not
2909
 
            indicate a problem.
 
3220
    revisions
 
3221
        This is just the number of revisions checked.  It doesn't
 
3222
        indicate a problem.
 
3223
 
 
3224
    versionedfiles
 
3225
        This is just the number of versionedfiles checked.  It
 
3226
        doesn't indicate a problem.
 
3227
 
 
3228
    unreferenced ancestors
 
3229
        Texts that are ancestors of other texts, but
 
3230
        are not properly referenced by the revision ancestry.  This is a
 
3231
        subtle problem that Bazaar can work around.
 
3232
 
 
3233
    unique file texts
 
3234
        This is the total number of unique file contents
 
3235
        seen in the checked revisions.  It does not indicate a problem.
 
3236
 
 
3237
    repeated file texts
 
3238
        This is the total number of repeated texts seen
 
3239
        in the checked revisions.  Texts can be repeated when their file
 
3240
        entries are modified, but the file contents are not.  It does not
 
3241
        indicate a problem.
2910
3242
 
2911
3243
    If no restrictions are specified, all Bazaar data that is found at the given
2912
3244
    location will be checked.
2947
3279
 
2948
3280
 
2949
3281
class cmd_upgrade(Command):
2950
 
    """Upgrade branch storage to current format.
 
3282
    __doc__ = """Upgrade branch storage to current format.
2951
3283
 
2952
3284
    The check command or bzr developers may sometimes advise you to run
2953
3285
    this command. When the default format has changed you may also be warned
2971
3303
 
2972
3304
 
2973
3305
class cmd_whoami(Command):
2974
 
    """Show or set bzr user id.
 
3306
    __doc__ = """Show or set bzr user id.
2975
3307
 
2976
3308
    :Examples:
2977
3309
        Show the email of the current user::
2982
3314
 
2983
3315
            bzr whoami "Frank Chu <fchu@example.com>"
2984
3316
    """
2985
 
    takes_options = [ Option('email',
 
3317
    takes_options = [ 'directory',
 
3318
                      Option('email',
2986
3319
                             help='Display email address only.'),
2987
3320
                      Option('branch',
2988
3321
                             help='Set identity for the current branch instead of '
2992
3325
    encoding_type = 'replace'
2993
3326
 
2994
3327
    @display_command
2995
 
    def run(self, email=False, branch=False, name=None):
 
3328
    def run(self, email=False, branch=False, name=None, directory=None):
2996
3329
        if name is None:
2997
 
            # use branch if we're inside one; otherwise global config
2998
 
            try:
2999
 
                c = Branch.open_containing('.')[0].get_config()
3000
 
            except errors.NotBranchError:
3001
 
                c = config.GlobalConfig()
 
3330
            if directory is None:
 
3331
                # use branch if we're inside one; otherwise global config
 
3332
                try:
 
3333
                    c = Branch.open_containing(u'.')[0].get_config()
 
3334
                except errors.NotBranchError:
 
3335
                    c = config.GlobalConfig()
 
3336
            else:
 
3337
                c = Branch.open(directory).get_config()
3002
3338
            if email:
3003
3339
                self.outf.write(c.user_email() + '\n')
3004
3340
            else:
3014
3350
 
3015
3351
        # use global config unless --branch given
3016
3352
        if branch:
3017
 
            c = Branch.open_containing('.')[0].get_config()
 
3353
            if directory is None:
 
3354
                c = Branch.open_containing(u'.')[0].get_config()
 
3355
            else:
 
3356
                c = Branch.open(directory).get_config()
3018
3357
        else:
3019
3358
            c = config.GlobalConfig()
3020
3359
        c.set_user_option('email', name)
3021
3360
 
3022
3361
 
3023
3362
class cmd_nick(Command):
3024
 
    """Print or set the branch nickname.
 
3363
    __doc__ = """Print or set the branch nickname.
3025
3364
 
3026
3365
    If unset, the tree root directory name is used as the nickname.
3027
3366
    To print the current nickname, execute with no argument.
3032
3371
 
3033
3372
    _see_also = ['info']
3034
3373
    takes_args = ['nickname?']
3035
 
    def run(self, nickname=None):
3036
 
        branch = Branch.open_containing(u'.')[0]
 
3374
    takes_options = ['directory']
 
3375
    def run(self, nickname=None, directory=u'.'):
 
3376
        branch = Branch.open_containing(directory)[0]
3037
3377
        if nickname is None:
3038
3378
            self.printme(branch)
3039
3379
        else:
3041
3381
 
3042
3382
    @display_command
3043
3383
    def printme(self, branch):
3044
 
        print branch.nick
 
3384
        self.outf.write('%s\n' % branch.nick)
3045
3385
 
3046
3386
 
3047
3387
class cmd_alias(Command):
3048
 
    """Set/unset and display aliases.
 
3388
    __doc__ = """Set/unset and display aliases.
3049
3389
 
3050
3390
    :Examples:
3051
3391
        Show the current aliases::
3115
3455
 
3116
3456
 
3117
3457
class cmd_selftest(Command):
3118
 
    """Run internal test suite.
 
3458
    __doc__ = """Run internal test suite.
3119
3459
 
3120
3460
    If arguments are given, they are regular expressions that say which tests
3121
3461
    should run.  Tests matching any expression are run, and other tests are
3148
3488
    Tests that need working space on disk use a common temporary directory,
3149
3489
    typically inside $TMPDIR or /tmp.
3150
3490
 
 
3491
    If you set BZR_TEST_PDB=1 when running selftest, failing tests will drop
 
3492
    into a pdb postmortem session.
 
3493
 
3151
3494
    :Examples:
3152
3495
        Run only tests relating to 'ignore'::
3153
3496
 
3162
3505
    def get_transport_type(typestring):
3163
3506
        """Parse and return a transport specifier."""
3164
3507
        if typestring == "sftp":
3165
 
            from bzrlib.transport.sftp import SFTPAbsoluteServer
3166
 
            return SFTPAbsoluteServer
 
3508
            from bzrlib.tests import stub_sftp
 
3509
            return stub_sftp.SFTPAbsoluteServer
3167
3510
        if typestring == "memory":
3168
 
            from bzrlib.transport.memory import MemoryServer
3169
 
            return MemoryServer
 
3511
            from bzrlib.tests import test_server
 
3512
            return memory.MemoryServer
3170
3513
        if typestring == "fakenfs":
3171
 
            from bzrlib.transport.fakenfs import FakeNFSServer
3172
 
            return FakeNFSServer
 
3514
            from bzrlib.tests import test_server
 
3515
            return test_server.FakeNFSServer
3173
3516
        msg = "No known transport type %s. Supported types are: sftp\n" %\
3174
3517
            (typestring)
3175
3518
        raise errors.BzrCommandError(msg)
3190
3533
                     Option('lsprof-timed',
3191
3534
                            help='Generate lsprof output for benchmarked'
3192
3535
                                 ' sections of code.'),
 
3536
                     Option('lsprof-tests',
 
3537
                            help='Generate lsprof output for each test.'),
3193
3538
                     Option('cache-dir', type=str,
3194
3539
                            help='Cache intermediate benchmark output in this '
3195
3540
                                 'directory.'),
3236
3581
            first=False, list_only=False,
3237
3582
            randomize=None, exclude=None, strict=False,
3238
3583
            load_list=None, debugflag=None, starting_with=None, subunit=False,
3239
 
            parallel=None):
 
3584
            parallel=None, lsprof_tests=False):
3240
3585
        from bzrlib.tests import selftest
3241
3586
        import bzrlib.benchmarks as benchmarks
3242
3587
        from bzrlib.benchmarks import tree_creator
3257
3602
                raise errors.BzrCommandError("subunit not available. subunit "
3258
3603
                    "needs to be installed to use --subunit.")
3259
3604
            self.additional_selftest_args['runner_class'] = SubUnitBzrRunner
 
3605
            # On Windows, disable automatic conversion of '\n' to '\r\n' in
 
3606
            # stdout, which would corrupt the subunit stream. 
 
3607
            # FIXME: This has been fixed in subunit trunk (>0.0.5) so the
 
3608
            # following code can be deleted when it's sufficiently deployed
 
3609
            # -- vila/mgz 20100514
 
3610
            if (sys.platform == "win32"
 
3611
                and getattr(sys.stdout, 'fileno', None) is not None):
 
3612
                import msvcrt
 
3613
                msvcrt.setmode(sys.stdout.fileno(), os.O_BINARY)
3260
3614
        if parallel:
3261
3615
            self.additional_selftest_args.setdefault(
3262
3616
                'suite_decorators', []).append(parallel)
3266
3620
            verbose = not is_quiet()
3267
3621
            # TODO: should possibly lock the history file...
3268
3622
            benchfile = open(".perf_history", "at", buffering=1)
 
3623
            self.add_cleanup(benchfile.close)
3269
3624
        else:
3270
3625
            test_suite_factory = None
3271
3626
            benchfile = None
3272
 
        try:
3273
 
            selftest_kwargs = {"verbose": verbose,
3274
 
                              "pattern": pattern,
3275
 
                              "stop_on_failure": one,
3276
 
                              "transport": transport,
3277
 
                              "test_suite_factory": test_suite_factory,
3278
 
                              "lsprof_timed": lsprof_timed,
3279
 
                              "bench_history": benchfile,
3280
 
                              "matching_tests_first": first,
3281
 
                              "list_only": list_only,
3282
 
                              "random_seed": randomize,
3283
 
                              "exclude_pattern": exclude,
3284
 
                              "strict": strict,
3285
 
                              "load_list": load_list,
3286
 
                              "debug_flags": debugflag,
3287
 
                              "starting_with": starting_with
3288
 
                              }
3289
 
            selftest_kwargs.update(self.additional_selftest_args)
3290
 
            result = selftest(**selftest_kwargs)
3291
 
        finally:
3292
 
            if benchfile is not None:
3293
 
                benchfile.close()
 
3627
        selftest_kwargs = {"verbose": verbose,
 
3628
                          "pattern": pattern,
 
3629
                          "stop_on_failure": one,
 
3630
                          "transport": transport,
 
3631
                          "test_suite_factory": test_suite_factory,
 
3632
                          "lsprof_timed": lsprof_timed,
 
3633
                          "lsprof_tests": lsprof_tests,
 
3634
                          "bench_history": benchfile,
 
3635
                          "matching_tests_first": first,
 
3636
                          "list_only": list_only,
 
3637
                          "random_seed": randomize,
 
3638
                          "exclude_pattern": exclude,
 
3639
                          "strict": strict,
 
3640
                          "load_list": load_list,
 
3641
                          "debug_flags": debugflag,
 
3642
                          "starting_with": starting_with
 
3643
                          }
 
3644
        selftest_kwargs.update(self.additional_selftest_args)
 
3645
        result = selftest(**selftest_kwargs)
3294
3646
        return int(not result)
3295
3647
 
3296
3648
 
3297
3649
class cmd_version(Command):
3298
 
    """Show version of bzr."""
 
3650
    __doc__ = """Show version of bzr."""
3299
3651
 
3300
3652
    encoding_type = 'replace'
3301
3653
    takes_options = [
3312
3664
 
3313
3665
 
3314
3666
class cmd_rocks(Command):
3315
 
    """Statement of optimism."""
 
3667
    __doc__ = """Statement of optimism."""
3316
3668
 
3317
3669
    hidden = True
3318
3670
 
3319
3671
    @display_command
3320
3672
    def run(self):
3321
 
        print "It sure does!"
 
3673
        self.outf.write("It sure does!\n")
3322
3674
 
3323
3675
 
3324
3676
class cmd_find_merge_base(Command):
3325
 
    """Find and print a base revision for merging two branches."""
 
3677
    __doc__ = """Find and print a base revision for merging two branches."""
3326
3678
    # TODO: Options to specify revisions on either side, as if
3327
3679
    #       merging only part of the history.
3328
3680
    takes_args = ['branch', 'other']
3334
3686
 
3335
3687
        branch1 = Branch.open_containing(branch)[0]
3336
3688
        branch2 = Branch.open_containing(other)[0]
3337
 
        branch1.lock_read()
3338
 
        try:
3339
 
            branch2.lock_read()
3340
 
            try:
3341
 
                last1 = ensure_null(branch1.last_revision())
3342
 
                last2 = ensure_null(branch2.last_revision())
3343
 
 
3344
 
                graph = branch1.repository.get_graph(branch2.repository)
3345
 
                base_rev_id = graph.find_unique_lca(last1, last2)
3346
 
 
3347
 
                print 'merge base is revision %s' % base_rev_id
3348
 
            finally:
3349
 
                branch2.unlock()
3350
 
        finally:
3351
 
            branch1.unlock()
 
3689
        self.add_cleanup(branch1.lock_read().unlock)
 
3690
        self.add_cleanup(branch2.lock_read().unlock)
 
3691
        last1 = ensure_null(branch1.last_revision())
 
3692
        last2 = ensure_null(branch2.last_revision())
 
3693
 
 
3694
        graph = branch1.repository.get_graph(branch2.repository)
 
3695
        base_rev_id = graph.find_unique_lca(last1, last2)
 
3696
 
 
3697
        self.outf.write('merge base is revision %s\n' % base_rev_id)
3352
3698
 
3353
3699
 
3354
3700
class cmd_merge(Command):
3355
 
    """Perform a three-way merge.
 
3701
    __doc__ = """Perform a three-way merge.
3356
3702
 
3357
3703
    The source of the merge can be specified either in the form of a branch,
3358
3704
    or in the form of a path to a file containing a merge directive generated
3387
3733
    committed to record the result of the merge.
3388
3734
 
3389
3735
    merge refuses to run if there are any uncommitted changes, unless
3390
 
    --force is given.
 
3736
    --force is given. The --force option can also be used to create a
 
3737
    merge revision which has more than two parents.
 
3738
 
 
3739
    If one would like to merge changes from the working tree of the other
 
3740
    branch without merging any committed revisions, the --uncommitted option
 
3741
    can be given.
 
3742
 
 
3743
    To select only some changes to merge, use "merge -i", which will prompt
 
3744
    you to apply each diff hunk and file change, similar to "shelve".
3391
3745
 
3392
3746
    :Examples:
3393
3747
        To merge the latest revision from bzr.dev::
3402
3756
 
3403
3757
            bzr merge -r 81..82 ../bzr.dev
3404
3758
 
3405
 
        To apply a merge directive contained in /tmp/merge:
 
3759
        To apply a merge directive contained in /tmp/merge::
3406
3760
 
3407
3761
            bzr merge /tmp/merge
 
3762
 
 
3763
        To create a merge revision with three parents from two branches
 
3764
        feature1a and feature1b:
 
3765
 
 
3766
            bzr merge ../feature1a
 
3767
            bzr merge ../feature1b --force
 
3768
            bzr commit -m 'revision with three parents'
3408
3769
    """
3409
3770
 
3410
3771
    encoding_type = 'exact'
3426
3787
                ' completely merged into the source, pull from the'
3427
3788
                ' source rather than merging.  When this happens,'
3428
3789
                ' you do not need to commit the result.'),
3429
 
        Option('directory',
 
3790
        custom_help('directory',
3430
3791
               help='Branch to merge into, '
3431
 
                    'rather than the one containing the working directory.',
3432
 
               short_name='d',
3433
 
               type=unicode,
3434
 
               ),
3435
 
        Option('preview', help='Instead of merging, show a diff of the merge.')
 
3792
                    'rather than the one containing the working directory.'),
 
3793
        Option('preview', help='Instead of merging, show a diff of the'
 
3794
               ' merge.'),
 
3795
        Option('interactive', help='Select changes interactively.',
 
3796
            short_name='i')
3436
3797
    ]
3437
3798
 
3438
3799
    def run(self, location=None, revision=None, force=False,
3440
3801
            uncommitted=False, pull=False,
3441
3802
            directory=None,
3442
3803
            preview=False,
 
3804
            interactive=False,
3443
3805
            ):
3444
3806
        if merge_type is None:
3445
3807
            merge_type = _mod_merge.Merge3Merger
3451
3813
        verified = 'inapplicable'
3452
3814
        tree = WorkingTree.open_containing(directory)[0]
3453
3815
 
3454
 
        # die as quickly as possible if there are uncommitted changes
3455
3816
        try:
3456
3817
            basis_tree = tree.revision_tree(tree.last_revision())
3457
3818
        except errors.NoSuchRevision:
3458
3819
            basis_tree = tree.basis_tree()
 
3820
 
 
3821
        # die as quickly as possible if there are uncommitted changes
3459
3822
        if not force:
3460
 
            changes = tree.changes_from(basis_tree)
3461
 
            if changes.has_changed():
 
3823
            if tree.has_changes():
3462
3824
                raise errors.UncommittedChanges(tree)
3463
3825
 
3464
3826
        view_info = _get_view_info_for_change_reporter(tree)
3465
3827
        change_reporter = delta._ChangeReporter(
3466
3828
            unversioned_filter=tree.is_ignored, view_info=view_info)
3467
 
        cleanups = []
3468
 
        try:
3469
 
            pb = ui.ui_factory.nested_progress_bar()
3470
 
            cleanups.append(pb.finished)
3471
 
            tree.lock_write()
3472
 
            cleanups.append(tree.unlock)
3473
 
            if location is not None:
3474
 
                try:
3475
 
                    mergeable = bundle.read_mergeable_from_url(location,
3476
 
                        possible_transports=possible_transports)
3477
 
                except errors.NotABundle:
3478
 
                    mergeable = None
3479
 
                else:
3480
 
                    if uncommitted:
3481
 
                        raise errors.BzrCommandError('Cannot use --uncommitted'
3482
 
                            ' with bundles or merge directives.')
3483
 
 
3484
 
                    if revision is not None:
3485
 
                        raise errors.BzrCommandError(
3486
 
                            'Cannot use -r with merge directives or bundles')
3487
 
                    merger, verified = _mod_merge.Merger.from_mergeable(tree,
3488
 
                       mergeable, pb)
3489
 
 
3490
 
            if merger is None and uncommitted:
3491
 
                if revision is not None and len(revision) > 0:
3492
 
                    raise errors.BzrCommandError('Cannot use --uncommitted and'
3493
 
                        ' --revision at the same time.')
3494
 
                location = self._select_branch_location(tree, location)[0]
3495
 
                other_tree, other_path = WorkingTree.open_containing(location)
3496
 
                merger = _mod_merge.Merger.from_uncommitted(tree, other_tree,
3497
 
                    pb)
3498
 
                allow_pending = False
3499
 
                if other_path != '':
3500
 
                    merger.interesting_files = [other_path]
3501
 
 
3502
 
            if merger is None:
3503
 
                merger, allow_pending = self._get_merger_from_branch(tree,
3504
 
                    location, revision, remember, possible_transports, pb)
3505
 
 
3506
 
            merger.merge_type = merge_type
3507
 
            merger.reprocess = reprocess
3508
 
            merger.show_base = show_base
3509
 
            self.sanity_check_merger(merger)
3510
 
            if (merger.base_rev_id == merger.other_rev_id and
3511
 
                merger.other_rev_id is not None):
3512
 
                note('Nothing to do.')
 
3829
        pb = ui.ui_factory.nested_progress_bar()
 
3830
        self.add_cleanup(pb.finished)
 
3831
        self.add_cleanup(tree.lock_write().unlock)
 
3832
        if location is not None:
 
3833
            try:
 
3834
                mergeable = bundle.read_mergeable_from_url(location,
 
3835
                    possible_transports=possible_transports)
 
3836
            except errors.NotABundle:
 
3837
                mergeable = None
 
3838
            else:
 
3839
                if uncommitted:
 
3840
                    raise errors.BzrCommandError('Cannot use --uncommitted'
 
3841
                        ' with bundles or merge directives.')
 
3842
 
 
3843
                if revision is not None:
 
3844
                    raise errors.BzrCommandError(
 
3845
                        'Cannot use -r with merge directives or bundles')
 
3846
                merger, verified = _mod_merge.Merger.from_mergeable(tree,
 
3847
                   mergeable, None)
 
3848
 
 
3849
        if merger is None and uncommitted:
 
3850
            if revision is not None and len(revision) > 0:
 
3851
                raise errors.BzrCommandError('Cannot use --uncommitted and'
 
3852
                    ' --revision at the same time.')
 
3853
            merger = self.get_merger_from_uncommitted(tree, location, None)
 
3854
            allow_pending = False
 
3855
 
 
3856
        if merger is None:
 
3857
            merger, allow_pending = self._get_merger_from_branch(tree,
 
3858
                location, revision, remember, possible_transports, None)
 
3859
 
 
3860
        merger.merge_type = merge_type
 
3861
        merger.reprocess = reprocess
 
3862
        merger.show_base = show_base
 
3863
        self.sanity_check_merger(merger)
 
3864
        if (merger.base_rev_id == merger.other_rev_id and
 
3865
            merger.other_rev_id is not None):
 
3866
            note('Nothing to do.')
 
3867
            return 0
 
3868
        if pull:
 
3869
            if merger.interesting_files is not None:
 
3870
                raise errors.BzrCommandError('Cannot pull individual files')
 
3871
            if (merger.base_rev_id == tree.last_revision()):
 
3872
                result = tree.pull(merger.other_branch, False,
 
3873
                                   merger.other_rev_id)
 
3874
                result.report(self.outf)
3513
3875
                return 0
3514
 
            if pull:
3515
 
                if merger.interesting_files is not None:
3516
 
                    raise errors.BzrCommandError('Cannot pull individual files')
3517
 
                if (merger.base_rev_id == tree.last_revision()):
3518
 
                    result = tree.pull(merger.other_branch, False,
3519
 
                                       merger.other_rev_id)
3520
 
                    result.report(self.outf)
3521
 
                    return 0
3522
 
            merger.check_basis(False)
3523
 
            if preview:
3524
 
                return self._do_preview(merger)
3525
 
            else:
3526
 
                return self._do_merge(merger, change_reporter, allow_pending,
3527
 
                                      verified)
3528
 
        finally:
3529
 
            for cleanup in reversed(cleanups):
3530
 
                cleanup()
 
3876
        if merger.this_basis is None:
 
3877
            raise errors.BzrCommandError(
 
3878
                "This branch has no commits."
 
3879
                " (perhaps you would prefer 'bzr pull')")
 
3880
        if preview:
 
3881
            return self._do_preview(merger)
 
3882
        elif interactive:
 
3883
            return self._do_interactive(merger)
 
3884
        else:
 
3885
            return self._do_merge(merger, change_reporter, allow_pending,
 
3886
                                  verified)
 
3887
 
 
3888
    def _get_preview(self, merger):
 
3889
        tree_merger = merger.make_merger()
 
3890
        tt = tree_merger.make_preview_transform()
 
3891
        self.add_cleanup(tt.finalize)
 
3892
        result_tree = tt.get_preview_tree()
 
3893
        return result_tree
3531
3894
 
3532
3895
    def _do_preview(self, merger):
3533
3896
        from bzrlib.diff import show_diff_trees
3534
 
        tree_merger = merger.make_merger()
3535
 
        tt = tree_merger.make_preview_transform()
3536
 
        try:
3537
 
            result_tree = tt.get_preview_tree()
3538
 
            show_diff_trees(merger.this_tree, result_tree, self.outf,
3539
 
                            old_label='', new_label='')
3540
 
        finally:
3541
 
            tt.finalize()
 
3897
        result_tree = self._get_preview(merger)
 
3898
        path_encoding = osutils.get_diff_header_encoding()
 
3899
        show_diff_trees(merger.this_tree, result_tree, self.outf,
 
3900
                        old_label='', new_label='',
 
3901
                        path_encoding=path_encoding)
3542
3902
 
3543
3903
    def _do_merge(self, merger, change_reporter, allow_pending, verified):
3544
3904
        merger.change_reporter = change_reporter
3552
3912
        else:
3553
3913
            return 0
3554
3914
 
 
3915
    def _do_interactive(self, merger):
 
3916
        """Perform an interactive merge.
 
3917
 
 
3918
        This works by generating a preview tree of the merge, then using
 
3919
        Shelver to selectively remove the differences between the working tree
 
3920
        and the preview tree.
 
3921
        """
 
3922
        from bzrlib import shelf_ui
 
3923
        result_tree = self._get_preview(merger)
 
3924
        writer = bzrlib.option.diff_writer_registry.get()
 
3925
        shelver = shelf_ui.Shelver(merger.this_tree, result_tree, destroy=True,
 
3926
                                   reporter=shelf_ui.ApplyReporter(),
 
3927
                                   diff_writer=writer(sys.stdout))
 
3928
        try:
 
3929
            shelver.run()
 
3930
        finally:
 
3931
            shelver.finalize()
 
3932
 
3555
3933
    def sanity_check_merger(self, merger):
3556
3934
        if (merger.show_base and
3557
3935
            not merger.merge_type is _mod_merge.Merge3Merger):
3592
3970
            base_branch, base_path = Branch.open_containing(base_loc,
3593
3971
                possible_transports)
3594
3972
        # Find the revision ids
3595
 
        if revision is None or len(revision) < 1 or revision[-1] is None:
 
3973
        other_revision_id = None
 
3974
        base_revision_id = None
 
3975
        if revision is not None:
 
3976
            if len(revision) >= 1:
 
3977
                other_revision_id = revision[-1].as_revision_id(other_branch)
 
3978
            if len(revision) == 2:
 
3979
                base_revision_id = revision[0].as_revision_id(base_branch)
 
3980
        if other_revision_id is None:
3596
3981
            other_revision_id = _mod_revision.ensure_null(
3597
3982
                other_branch.last_revision())
3598
 
        else:
3599
 
            other_revision_id = revision[-1].as_revision_id(other_branch)
3600
 
        if (revision is not None and len(revision) == 2
3601
 
            and revision[0] is not None):
3602
 
            base_revision_id = revision[0].as_revision_id(base_branch)
3603
 
        else:
3604
 
            base_revision_id = None
3605
3983
        # Remember where we merge from
3606
3984
        if ((remember or tree.branch.get_submit_branch() is None) and
3607
3985
             user_location is not None):
3616
3994
            allow_pending = True
3617
3995
        return merger, allow_pending
3618
3996
 
 
3997
    def get_merger_from_uncommitted(self, tree, location, pb):
 
3998
        """Get a merger for uncommitted changes.
 
3999
 
 
4000
        :param tree: The tree the merger should apply to.
 
4001
        :param location: The location containing uncommitted changes.
 
4002
        :param pb: The progress bar to use for showing progress.
 
4003
        """
 
4004
        location = self._select_branch_location(tree, location)[0]
 
4005
        other_tree, other_path = WorkingTree.open_containing(location)
 
4006
        merger = _mod_merge.Merger.from_uncommitted(tree, other_tree, pb)
 
4007
        if other_path != '':
 
4008
            merger.interesting_files = [other_path]
 
4009
        return merger
 
4010
 
3619
4011
    def _select_branch_location(self, tree, user_location, revision=None,
3620
4012
                                index=None):
3621
4013
        """Select a branch location, according to possible inputs.
3665
4057
 
3666
4058
 
3667
4059
class cmd_remerge(Command):
3668
 
    """Redo a merge.
 
4060
    __doc__ = """Redo a merge.
3669
4061
 
3670
4062
    Use this if you want to try a different merge technique while resolving
3671
4063
    conflicts.  Some merge techniques are better than others, and remerge
3696
4088
 
3697
4089
    def run(self, file_list=None, merge_type=None, show_base=False,
3698
4090
            reprocess=False):
 
4091
        from bzrlib.conflicts import restore
3699
4092
        if merge_type is None:
3700
4093
            merge_type = _mod_merge.Merge3Merger
3701
4094
        tree, file_list = tree_files(file_list)
3702
 
        tree.lock_write()
3703
 
        try:
3704
 
            parents = tree.get_parent_ids()
3705
 
            if len(parents) != 2:
3706
 
                raise errors.BzrCommandError("Sorry, remerge only works after normal"
3707
 
                                             " merges.  Not cherrypicking or"
3708
 
                                             " multi-merges.")
3709
 
            repository = tree.branch.repository
3710
 
            interesting_ids = None
3711
 
            new_conflicts = []
3712
 
            conflicts = tree.conflicts()
3713
 
            if file_list is not None:
3714
 
                interesting_ids = set()
3715
 
                for filename in file_list:
3716
 
                    file_id = tree.path2id(filename)
3717
 
                    if file_id is None:
3718
 
                        raise errors.NotVersionedError(filename)
3719
 
                    interesting_ids.add(file_id)
3720
 
                    if tree.kind(file_id) != "directory":
3721
 
                        continue
 
4095
        self.add_cleanup(tree.lock_write().unlock)
 
4096
        parents = tree.get_parent_ids()
 
4097
        if len(parents) != 2:
 
4098
            raise errors.BzrCommandError("Sorry, remerge only works after normal"
 
4099
                                         " merges.  Not cherrypicking or"
 
4100
                                         " multi-merges.")
 
4101
        repository = tree.branch.repository
 
4102
        interesting_ids = None
 
4103
        new_conflicts = []
 
4104
        conflicts = tree.conflicts()
 
4105
        if file_list is not None:
 
4106
            interesting_ids = set()
 
4107
            for filename in file_list:
 
4108
                file_id = tree.path2id(filename)
 
4109
                if file_id is None:
 
4110
                    raise errors.NotVersionedError(filename)
 
4111
                interesting_ids.add(file_id)
 
4112
                if tree.kind(file_id) != "directory":
 
4113
                    continue
3722
4114
 
3723
 
                    for name, ie in tree.inventory.iter_entries(file_id):
3724
 
                        interesting_ids.add(ie.file_id)
3725
 
                new_conflicts = conflicts.select_conflicts(tree, file_list)[0]
3726
 
            else:
3727
 
                # Remerge only supports resolving contents conflicts
3728
 
                allowed_conflicts = ('text conflict', 'contents conflict')
3729
 
                restore_files = [c.path for c in conflicts
3730
 
                                 if c.typestring in allowed_conflicts]
3731
 
            _mod_merge.transform_tree(tree, tree.basis_tree(), interesting_ids)
3732
 
            tree.set_conflicts(ConflictList(new_conflicts))
3733
 
            if file_list is not None:
3734
 
                restore_files = file_list
3735
 
            for filename in restore_files:
3736
 
                try:
3737
 
                    restore(tree.abspath(filename))
3738
 
                except errors.NotConflicted:
3739
 
                    pass
3740
 
            # Disable pending merges, because the file texts we are remerging
3741
 
            # have not had those merges performed.  If we use the wrong parents
3742
 
            # list, we imply that the working tree text has seen and rejected
3743
 
            # all the changes from the other tree, when in fact those changes
3744
 
            # have not yet been seen.
3745
 
            pb = ui.ui_factory.nested_progress_bar()
3746
 
            tree.set_parent_ids(parents[:1])
 
4115
                for name, ie in tree.inventory.iter_entries(file_id):
 
4116
                    interesting_ids.add(ie.file_id)
 
4117
            new_conflicts = conflicts.select_conflicts(tree, file_list)[0]
 
4118
        else:
 
4119
            # Remerge only supports resolving contents conflicts
 
4120
            allowed_conflicts = ('text conflict', 'contents conflict')
 
4121
            restore_files = [c.path for c in conflicts
 
4122
                             if c.typestring in allowed_conflicts]
 
4123
        _mod_merge.transform_tree(tree, tree.basis_tree(), interesting_ids)
 
4124
        tree.set_conflicts(ConflictList(new_conflicts))
 
4125
        if file_list is not None:
 
4126
            restore_files = file_list
 
4127
        for filename in restore_files:
3747
4128
            try:
3748
 
                merger = _mod_merge.Merger.from_revision_ids(pb,
3749
 
                                                             tree, parents[1])
3750
 
                merger.interesting_ids = interesting_ids
3751
 
                merger.merge_type = merge_type
3752
 
                merger.show_base = show_base
3753
 
                merger.reprocess = reprocess
3754
 
                conflicts = merger.do_merge()
3755
 
            finally:
3756
 
                tree.set_parent_ids(parents)
3757
 
                pb.finished()
 
4129
                restore(tree.abspath(filename))
 
4130
            except errors.NotConflicted:
 
4131
                pass
 
4132
        # Disable pending merges, because the file texts we are remerging
 
4133
        # have not had those merges performed.  If we use the wrong parents
 
4134
        # list, we imply that the working tree text has seen and rejected
 
4135
        # all the changes from the other tree, when in fact those changes
 
4136
        # have not yet been seen.
 
4137
        tree.set_parent_ids(parents[:1])
 
4138
        try:
 
4139
            merger = _mod_merge.Merger.from_revision_ids(None, tree, parents[1])
 
4140
            merger.interesting_ids = interesting_ids
 
4141
            merger.merge_type = merge_type
 
4142
            merger.show_base = show_base
 
4143
            merger.reprocess = reprocess
 
4144
            conflicts = merger.do_merge()
3758
4145
        finally:
3759
 
            tree.unlock()
 
4146
            tree.set_parent_ids(parents)
3760
4147
        if conflicts > 0:
3761
4148
            return 1
3762
4149
        else:
3764
4151
 
3765
4152
 
3766
4153
class cmd_revert(Command):
3767
 
    """Revert files to a previous revision.
 
4154
    __doc__ = """Revert files to a previous revision.
3768
4155
 
3769
4156
    Giving a list of files will revert only those files.  Otherwise, all files
3770
4157
    will be reverted.  If the revision is not specified with '--revision', the
3784
4171
    name.  If you name a directory, all the contents of that directory will be
3785
4172
    reverted.
3786
4173
 
3787
 
    Any files that have been newly added since that revision will be deleted,
3788
 
    with a backup kept if appropriate.  Directories containing unknown files
3789
 
    will not be deleted.
 
4174
    If you have newly added files since the target revision, they will be
 
4175
    removed.  If the files to be removed have been changed, backups will be
 
4176
    created as above.  Directories containing unknown files will not be
 
4177
    deleted.
3790
4178
 
3791
 
    The working tree contains a list of pending merged revisions, which will
3792
 
    be included as parents in the next commit.  Normally, revert clears that
3793
 
    list as well as reverting the files.  If any files are specified, revert
3794
 
    leaves the pending merge list alone and reverts only the files.  Use "bzr
3795
 
    revert ." in the tree root to revert all files but keep the merge record,
3796
 
    and "bzr revert --forget-merges" to clear the pending merge list without
 
4179
    The working tree contains a list of revisions that have been merged but
 
4180
    not yet committed. These revisions will be included as additional parents
 
4181
    of the next commit.  Normally, using revert clears that list as well as
 
4182
    reverting the files.  If any files are specified, revert leaves the list
 
4183
    of uncommitted merges alone and reverts only the files.  Use ``bzr revert
 
4184
    .`` in the tree root to revert all files but keep the recorded merges,
 
4185
    and ``bzr revert --forget-merges`` to clear the pending merge list without
3797
4186
    reverting any files.
 
4187
 
 
4188
    Using "bzr revert --forget-merges", it is possible to apply all of the
 
4189
    changes from a branch in a single revision.  To do this, perform the merge
 
4190
    as desired.  Then doing revert with the "--forget-merges" option will keep
 
4191
    the content of the tree as it was, but it will clear the list of pending
 
4192
    merges.  The next commit will then contain all of the changes that are
 
4193
    present in the other branch, but without any other parent revisions.
 
4194
    Because this technique forgets where these changes originated, it may
 
4195
    cause additional conflicts on later merges involving the same source and
 
4196
    target branches.
3798
4197
    """
3799
4198
 
3800
4199
    _see_also = ['cat', 'export']
3809
4208
    def run(self, revision=None, no_backup=False, file_list=None,
3810
4209
            forget_merges=None):
3811
4210
        tree, file_list = tree_files(file_list)
3812
 
        tree.lock_write()
3813
 
        try:
3814
 
            if forget_merges:
3815
 
                tree.set_parent_ids(tree.get_parent_ids()[:1])
3816
 
            else:
3817
 
                self._revert_tree_to_revision(tree, revision, file_list, no_backup)
3818
 
        finally:
3819
 
            tree.unlock()
 
4211
        self.add_cleanup(tree.lock_tree_write().unlock)
 
4212
        if forget_merges:
 
4213
            tree.set_parent_ids(tree.get_parent_ids()[:1])
 
4214
        else:
 
4215
            self._revert_tree_to_revision(tree, revision, file_list, no_backup)
3820
4216
 
3821
4217
    @staticmethod
3822
4218
    def _revert_tree_to_revision(tree, revision, file_list, no_backup):
3823
4219
        rev_tree = _get_one_revision_tree('revert', revision, tree=tree)
3824
 
        pb = ui.ui_factory.nested_progress_bar()
3825
 
        try:
3826
 
            tree.revert(file_list, rev_tree, not no_backup, pb,
3827
 
                report_changes=True)
3828
 
        finally:
3829
 
            pb.finished()
 
4220
        tree.revert(file_list, rev_tree, not no_backup, None,
 
4221
            report_changes=True)
3830
4222
 
3831
4223
 
3832
4224
class cmd_assert_fail(Command):
3833
 
    """Test reporting of assertion failures"""
 
4225
    __doc__ = """Test reporting of assertion failures"""
3834
4226
    # intended just for use in testing
3835
4227
 
3836
4228
    hidden = True
3840
4232
 
3841
4233
 
3842
4234
class cmd_help(Command):
3843
 
    """Show help on a command or other topic.
 
4235
    __doc__ = """Show help on a command or other topic.
3844
4236
    """
3845
4237
 
3846
4238
    _see_also = ['topics']
3859
4251
 
3860
4252
 
3861
4253
class cmd_shell_complete(Command):
3862
 
    """Show appropriate completions for context.
 
4254
    __doc__ = """Show appropriate completions for context.
3863
4255
 
3864
4256
    For a list of all available commands, say 'bzr shell-complete'.
3865
4257
    """
3874
4266
 
3875
4267
 
3876
4268
class cmd_missing(Command):
3877
 
    """Show unmerged/unpulled revisions between two branches.
 
4269
    __doc__ = """Show unmerged/unpulled revisions between two branches.
3878
4270
 
3879
4271
    OTHER_BRANCH may be local or remote.
3880
4272
 
3881
4273
    To filter on a range of revisions, you can use the command -r begin..end
3882
4274
    -r revision requests a specific revision, -r ..end or -r begin.. are
3883
4275
    also valid.
 
4276
            
 
4277
    :Exit values:
 
4278
        1 - some missing revisions
 
4279
        0 - no missing revisions
3884
4280
 
3885
4281
    :Examples:
3886
4282
 
3907
4303
    _see_also = ['merge', 'pull']
3908
4304
    takes_args = ['other_branch?']
3909
4305
    takes_options = [
 
4306
        'directory',
3910
4307
        Option('reverse', 'Reverse the order of revisions.'),
3911
4308
        Option('mine-only',
3912
4309
               'Display changes in the local branch only.'),
3934
4331
            theirs_only=False,
3935
4332
            log_format=None, long=False, short=False, line=False,
3936
4333
            show_ids=False, verbose=False, this=False, other=False,
3937
 
            include_merges=False, revision=None, my_revision=None):
 
4334
            include_merges=False, revision=None, my_revision=None,
 
4335
            directory=u'.'):
3938
4336
        from bzrlib.missing import find_unmerged, iter_log_revisions
3939
4337
        def message(s):
3940
4338
            if not is_quiet():
3953
4351
        elif theirs_only:
3954
4352
            restrict = 'remote'
3955
4353
 
3956
 
        local_branch = Branch.open_containing(u".")[0]
 
4354
        local_branch = Branch.open_containing(directory)[0]
 
4355
        self.add_cleanup(local_branch.lock_read().unlock)
 
4356
 
3957
4357
        parent = local_branch.get_parent()
3958
4358
        if other_branch is None:
3959
4359
            other_branch = parent
3968
4368
        remote_branch = Branch.open(other_branch)
3969
4369
        if remote_branch.base == local_branch.base:
3970
4370
            remote_branch = local_branch
 
4371
        else:
 
4372
            self.add_cleanup(remote_branch.lock_read().unlock)
3971
4373
 
3972
4374
        local_revid_range = _revision_range_to_revid_range(
3973
4375
            _get_revision_range(my_revision, local_branch,
3977
4379
            _get_revision_range(revision,
3978
4380
                remote_branch, self.name()))
3979
4381
 
3980
 
        local_branch.lock_read()
3981
 
        try:
3982
 
            remote_branch.lock_read()
3983
 
            try:
3984
 
                local_extra, remote_extra = find_unmerged(
3985
 
                    local_branch, remote_branch, restrict,
3986
 
                    backward=not reverse,
3987
 
                    include_merges=include_merges,
3988
 
                    local_revid_range=local_revid_range,
3989
 
                    remote_revid_range=remote_revid_range)
3990
 
 
3991
 
                if log_format is None:
3992
 
                    registry = log.log_formatter_registry
3993
 
                    log_format = registry.get_default(local_branch)
3994
 
                lf = log_format(to_file=self.outf,
3995
 
                                show_ids=show_ids,
3996
 
                                show_timezone='original')
3997
 
 
3998
 
                status_code = 0
3999
 
                if local_extra and not theirs_only:
4000
 
                    message("You have %d extra revision(s):\n" %
4001
 
                        len(local_extra))
4002
 
                    for revision in iter_log_revisions(local_extra,
4003
 
                                        local_branch.repository,
4004
 
                                        verbose):
4005
 
                        lf.log_revision(revision)
4006
 
                    printed_local = True
4007
 
                    status_code = 1
4008
 
                else:
4009
 
                    printed_local = False
4010
 
 
4011
 
                if remote_extra and not mine_only:
4012
 
                    if printed_local is True:
4013
 
                        message("\n\n\n")
4014
 
                    message("You are missing %d revision(s):\n" %
4015
 
                        len(remote_extra))
4016
 
                    for revision in iter_log_revisions(remote_extra,
4017
 
                                        remote_branch.repository,
4018
 
                                        verbose):
4019
 
                        lf.log_revision(revision)
4020
 
                    status_code = 1
4021
 
 
4022
 
                if mine_only and not local_extra:
4023
 
                    # We checked local, and found nothing extra
4024
 
                    message('This branch is up to date.\n')
4025
 
                elif theirs_only and not remote_extra:
4026
 
                    # We checked remote, and found nothing extra
4027
 
                    message('Other branch is up to date.\n')
4028
 
                elif not (mine_only or theirs_only or local_extra or
4029
 
                          remote_extra):
4030
 
                    # We checked both branches, and neither one had extra
4031
 
                    # revisions
4032
 
                    message("Branches are up to date.\n")
4033
 
            finally:
4034
 
                remote_branch.unlock()
4035
 
        finally:
4036
 
            local_branch.unlock()
 
4382
        local_extra, remote_extra = find_unmerged(
 
4383
            local_branch, remote_branch, restrict,
 
4384
            backward=not reverse,
 
4385
            include_merges=include_merges,
 
4386
            local_revid_range=local_revid_range,
 
4387
            remote_revid_range=remote_revid_range)
 
4388
 
 
4389
        if log_format is None:
 
4390
            registry = log.log_formatter_registry
 
4391
            log_format = registry.get_default(local_branch)
 
4392
        lf = log_format(to_file=self.outf,
 
4393
                        show_ids=show_ids,
 
4394
                        show_timezone='original')
 
4395
 
 
4396
        status_code = 0
 
4397
        if local_extra and not theirs_only:
 
4398
            message("You have %d extra revision(s):\n" %
 
4399
                len(local_extra))
 
4400
            for revision in iter_log_revisions(local_extra,
 
4401
                                local_branch.repository,
 
4402
                                verbose):
 
4403
                lf.log_revision(revision)
 
4404
            printed_local = True
 
4405
            status_code = 1
 
4406
        else:
 
4407
            printed_local = False
 
4408
 
 
4409
        if remote_extra and not mine_only:
 
4410
            if printed_local is True:
 
4411
                message("\n\n\n")
 
4412
            message("You are missing %d revision(s):\n" %
 
4413
                len(remote_extra))
 
4414
            for revision in iter_log_revisions(remote_extra,
 
4415
                                remote_branch.repository,
 
4416
                                verbose):
 
4417
                lf.log_revision(revision)
 
4418
            status_code = 1
 
4419
 
 
4420
        if mine_only and not local_extra:
 
4421
            # We checked local, and found nothing extra
 
4422
            message('This branch is up to date.\n')
 
4423
        elif theirs_only and not remote_extra:
 
4424
            # We checked remote, and found nothing extra
 
4425
            message('Other branch is up to date.\n')
 
4426
        elif not (mine_only or theirs_only or local_extra or
 
4427
                  remote_extra):
 
4428
            # We checked both branches, and neither one had extra
 
4429
            # revisions
 
4430
            message("Branches are up to date.\n")
 
4431
        self.cleanup_now()
4037
4432
        if not status_code and parent is None and other_branch is not None:
4038
 
            local_branch.lock_write()
4039
 
            try:
4040
 
                # handle race conditions - a parent might be set while we run.
4041
 
                if local_branch.get_parent() is None:
4042
 
                    local_branch.set_parent(remote_branch.base)
4043
 
            finally:
4044
 
                local_branch.unlock()
 
4433
            self.add_cleanup(local_branch.lock_write().unlock)
 
4434
            # handle race conditions - a parent might be set while we run.
 
4435
            if local_branch.get_parent() is None:
 
4436
                local_branch.set_parent(remote_branch.base)
4045
4437
        return status_code
4046
4438
 
4047
4439
 
4048
4440
class cmd_pack(Command):
4049
 
    """Compress the data within a repository."""
 
4441
    __doc__ = """Compress the data within a repository.
 
4442
 
 
4443
    This operation compresses the data within a bazaar repository. As
 
4444
    bazaar supports automatic packing of repository, this operation is
 
4445
    normally not required to be done manually.
 
4446
 
 
4447
    During the pack operation, bazaar takes a backup of existing repository
 
4448
    data, i.e. pack files. This backup is eventually removed by bazaar
 
4449
    automatically when it is safe to do so. To save disk space by removing
 
4450
    the backed up pack files, the --clean-obsolete-packs option may be
 
4451
    used.
 
4452
 
 
4453
    Warning: If you use --clean-obsolete-packs and your machine crashes
 
4454
    during or immediately after repacking, you may be left with a state
 
4455
    where the deletion has been written to disk but the new packs have not
 
4456
    been. In this case the repository may be unusable.
 
4457
    """
4050
4458
 
4051
4459
    _see_also = ['repositories']
4052
4460
    takes_args = ['branch_or_repo?']
 
4461
    takes_options = [
 
4462
        Option('clean-obsolete-packs', 'Delete obsolete packs to save disk space.'),
 
4463
        ]
4053
4464
 
4054
 
    def run(self, branch_or_repo='.'):
 
4465
    def run(self, branch_or_repo='.', clean_obsolete_packs=False):
4055
4466
        dir = bzrdir.BzrDir.open_containing(branch_or_repo)[0]
4056
4467
        try:
4057
4468
            branch = dir.open_branch()
4058
4469
            repository = branch.repository
4059
4470
        except errors.NotBranchError:
4060
4471
            repository = dir.open_repository()
4061
 
        repository.pack()
 
4472
        repository.pack(clean_obsolete_packs=clean_obsolete_packs)
4062
4473
 
4063
4474
 
4064
4475
class cmd_plugins(Command):
4065
 
    """List the installed plugins.
 
4476
    __doc__ = """List the installed plugins.
4066
4477
 
4067
4478
    This command displays the list of installed plugins including
4068
4479
    version of plugin and a short description of each.
4075
4486
    adding new commands, providing additional network transports and
4076
4487
    customizing log output.
4077
4488
 
4078
 
    See the Bazaar web site, http://bazaar-vcs.org, for further
4079
 
    information on plugins including where to find them and how to
4080
 
    install them. Instructions are also provided there on how to
4081
 
    write new plugins using the Python programming language.
 
4489
    See the Bazaar Plugin Guide <http://doc.bazaar.canonical.com/plugins/en/>
 
4490
    for further information on plugins including where to find them and how to
 
4491
    install them. Instructions are also provided there on how to write new
 
4492
    plugins using the Python programming language.
4082
4493
    """
4083
4494
    takes_options = ['verbose']
4084
4495
 
4099
4510
                doc = '(no description)'
4100
4511
            result.append((name_ver, doc, plugin.path()))
4101
4512
        for name_ver, doc, path in sorted(result):
4102
 
            print name_ver
4103
 
            print '   ', doc
 
4513
            self.outf.write("%s\n" % name_ver)
 
4514
            self.outf.write("   %s\n" % doc)
4104
4515
            if verbose:
4105
 
                print '   ', path
4106
 
            print
 
4516
                self.outf.write("   %s\n" % path)
 
4517
            self.outf.write("\n")
4107
4518
 
4108
4519
 
4109
4520
class cmd_testament(Command):
4110
 
    """Show testament (signing-form) of a revision."""
 
4521
    __doc__ = """Show testament (signing-form) of a revision."""
4111
4522
    takes_options = [
4112
4523
            'revision',
4113
4524
            Option('long', help='Produce long-format testament.'),
4125
4536
            b = Branch.open_containing(branch)[0]
4126
4537
        else:
4127
4538
            b = Branch.open(branch)
4128
 
        b.lock_read()
4129
 
        try:
4130
 
            if revision is None:
4131
 
                rev_id = b.last_revision()
4132
 
            else:
4133
 
                rev_id = revision[0].as_revision_id(b)
4134
 
            t = testament_class.from_revision(b.repository, rev_id)
4135
 
            if long:
4136
 
                sys.stdout.writelines(t.as_text_lines())
4137
 
            else:
4138
 
                sys.stdout.write(t.as_short_text())
4139
 
        finally:
4140
 
            b.unlock()
 
4539
        self.add_cleanup(b.lock_read().unlock)
 
4540
        if revision is None:
 
4541
            rev_id = b.last_revision()
 
4542
        else:
 
4543
            rev_id = revision[0].as_revision_id(b)
 
4544
        t = testament_class.from_revision(b.repository, rev_id)
 
4545
        if long:
 
4546
            sys.stdout.writelines(t.as_text_lines())
 
4547
        else:
 
4548
            sys.stdout.write(t.as_short_text())
4141
4549
 
4142
4550
 
4143
4551
class cmd_annotate(Command):
4144
 
    """Show the origin of each line in a file.
 
4552
    __doc__ = """Show the origin of each line in a file.
4145
4553
 
4146
4554
    This prints out the given file with an annotation on the left side
4147
4555
    indicating which revision, author and date introduced the change.
4158
4566
                     Option('long', help='Show commit date in annotations.'),
4159
4567
                     'revision',
4160
4568
                     'show-ids',
 
4569
                     'directory',
4161
4570
                     ]
4162
4571
    encoding_type = 'exact'
4163
4572
 
4164
4573
    @display_command
4165
4574
    def run(self, filename, all=False, long=False, revision=None,
4166
 
            show_ids=False):
 
4575
            show_ids=False, directory=None):
4167
4576
        from bzrlib.annotate import annotate_file, annotate_file_tree
4168
4577
        wt, branch, relpath = \
4169
 
            bzrdir.BzrDir.open_containing_tree_or_branch(filename)
4170
 
        if wt is not None:
4171
 
            wt.lock_read()
4172
 
        else:
4173
 
            branch.lock_read()
4174
 
        try:
4175
 
            tree = _get_one_revision_tree('annotate', revision, branch=branch)
4176
 
            if wt is not None:
4177
 
                file_id = wt.path2id(relpath)
4178
 
            else:
4179
 
                file_id = tree.path2id(relpath)
4180
 
            if file_id is None:
4181
 
                raise errors.NotVersionedError(filename)
4182
 
            file_version = tree.inventory[file_id].revision
4183
 
            if wt is not None and revision is None:
4184
 
                # If there is a tree and we're not annotating historical
4185
 
                # versions, annotate the working tree's content.
4186
 
                annotate_file_tree(wt, file_id, self.outf, long, all,
4187
 
                    show_ids=show_ids)
4188
 
            else:
4189
 
                annotate_file(branch, file_version, file_id, long, all, self.outf,
4190
 
                              show_ids=show_ids)
4191
 
        finally:
4192
 
            if wt is not None:
4193
 
                wt.unlock()
4194
 
            else:
4195
 
                branch.unlock()
 
4578
            _open_directory_or_containing_tree_or_branch(filename, directory)
 
4579
        if wt is not None:
 
4580
            self.add_cleanup(wt.lock_read().unlock)
 
4581
        else:
 
4582
            self.add_cleanup(branch.lock_read().unlock)
 
4583
        tree = _get_one_revision_tree('annotate', revision, branch=branch)
 
4584
        self.add_cleanup(tree.lock_read().unlock)
 
4585
        if wt is not None:
 
4586
            file_id = wt.path2id(relpath)
 
4587
        else:
 
4588
            file_id = tree.path2id(relpath)
 
4589
        if file_id is None:
 
4590
            raise errors.NotVersionedError(filename)
 
4591
        file_version = tree.inventory[file_id].revision
 
4592
        if wt is not None and revision is None:
 
4593
            # If there is a tree and we're not annotating historical
 
4594
            # versions, annotate the working tree's content.
 
4595
            annotate_file_tree(wt, file_id, self.outf, long, all,
 
4596
                show_ids=show_ids)
 
4597
        else:
 
4598
            annotate_file(branch, file_version, file_id, long, all, self.outf,
 
4599
                          show_ids=show_ids)
4196
4600
 
4197
4601
 
4198
4602
class cmd_re_sign(Command):
4199
 
    """Create a digital signature for an existing revision."""
 
4603
    __doc__ = """Create a digital signature for an existing revision."""
4200
4604
    # TODO be able to replace existing ones.
4201
4605
 
4202
4606
    hidden = True # is this right ?
4203
4607
    takes_args = ['revision_id*']
4204
 
    takes_options = ['revision']
 
4608
    takes_options = ['directory', 'revision']
4205
4609
 
4206
 
    def run(self, revision_id_list=None, revision=None):
 
4610
    def run(self, revision_id_list=None, revision=None, directory=u'.'):
4207
4611
        if revision_id_list is not None and revision is not None:
4208
4612
            raise errors.BzrCommandError('You can only supply one of revision_id or --revision')
4209
4613
        if revision_id_list is None and revision is None:
4210
4614
            raise errors.BzrCommandError('You must supply either --revision or a revision_id')
4211
 
        b = WorkingTree.open_containing(u'.')[0].branch
4212
 
        b.lock_write()
4213
 
        try:
4214
 
            return self._run(b, revision_id_list, revision)
4215
 
        finally:
4216
 
            b.unlock()
 
4615
        b = WorkingTree.open_containing(directory)[0].branch
 
4616
        self.add_cleanup(b.lock_write().unlock)
 
4617
        return self._run(b, revision_id_list, revision)
4217
4618
 
4218
4619
    def _run(self, b, revision_id_list, revision):
4219
4620
        import bzrlib.gpg as gpg
4264
4665
 
4265
4666
 
4266
4667
class cmd_bind(Command):
4267
 
    """Convert the current branch into a checkout of the supplied branch.
 
4668
    __doc__ = """Convert the current branch into a checkout of the supplied branch.
 
4669
    If no branch is supplied, rebind to the last bound location.
4268
4670
 
4269
4671
    Once converted into a checkout, commits must succeed on the master branch
4270
4672
    before they will be applied to the local branch.
4271
4673
 
4272
4674
    Bound branches use the nickname of its master branch unless it is set
4273
 
    locally, in which case binding will update the the local nickname to be
 
4675
    locally, in which case binding will update the local nickname to be
4274
4676
    that of the master.
4275
4677
    """
4276
4678
 
4277
4679
    _see_also = ['checkouts', 'unbind']
4278
4680
    takes_args = ['location?']
4279
 
    takes_options = []
 
4681
    takes_options = ['directory']
4280
4682
 
4281
 
    def run(self, location=None):
4282
 
        b, relpath = Branch.open_containing(u'.')
 
4683
    def run(self, location=None, directory=u'.'):
 
4684
        b, relpath = Branch.open_containing(directory)
4283
4685
        if location is None:
4284
4686
            try:
4285
4687
                location = b.get_old_bound_location()
4288
4690
                    'This format does not remember old locations.')
4289
4691
            else:
4290
4692
                if location is None:
4291
 
                    raise errors.BzrCommandError('No location supplied and no '
4292
 
                        'previous location known')
 
4693
                    if b.get_bound_location() is not None:
 
4694
                        raise errors.BzrCommandError('Branch is already bound')
 
4695
                    else:
 
4696
                        raise errors.BzrCommandError('No location supplied '
 
4697
                            'and no previous location known')
4293
4698
        b_other = Branch.open(location)
4294
4699
        try:
4295
4700
            b.bind(b_other)
4301
4706
 
4302
4707
 
4303
4708
class cmd_unbind(Command):
4304
 
    """Convert the current checkout into a regular branch.
 
4709
    __doc__ = """Convert the current checkout into a regular branch.
4305
4710
 
4306
4711
    After unbinding, the local branch is considered independent and subsequent
4307
4712
    commits will be local only.
4309
4714
 
4310
4715
    _see_also = ['checkouts', 'bind']
4311
4716
    takes_args = []
4312
 
    takes_options = []
 
4717
    takes_options = ['directory']
4313
4718
 
4314
 
    def run(self):
4315
 
        b, relpath = Branch.open_containing(u'.')
 
4719
    def run(self, directory=u'.'):
 
4720
        b, relpath = Branch.open_containing(directory)
4316
4721
        if not b.unbind():
4317
4722
            raise errors.BzrCommandError('Local branch is not bound')
4318
4723
 
4319
4724
 
4320
4725
class cmd_uncommit(Command):
4321
 
    """Remove the last committed revision.
 
4726
    __doc__ = """Remove the last committed revision.
4322
4727
 
4323
4728
    --verbose will print out what is being removed.
4324
4729
    --dry-run will go through all the motions, but not actually
4364
4769
            b = control.open_branch()
4365
4770
 
4366
4771
        if tree is not None:
4367
 
            tree.lock_write()
 
4772
            self.add_cleanup(tree.lock_write().unlock)
4368
4773
        else:
4369
 
            b.lock_write()
4370
 
        try:
4371
 
            return self._run(b, tree, dry_run, verbose, revision, force,
4372
 
                             local=local)
4373
 
        finally:
4374
 
            if tree is not None:
4375
 
                tree.unlock()
4376
 
            else:
4377
 
                b.unlock()
 
4774
            self.add_cleanup(b.lock_write().unlock)
 
4775
        return self._run(b, tree, dry_run, verbose, revision, force, local=local)
4378
4776
 
4379
4777
    def _run(self, b, tree, dry_run, verbose, revision, force, local=False):
4380
4778
        from bzrlib.log import log_formatter, show_log
4412
4810
                 end_revision=last_revno)
4413
4811
 
4414
4812
        if dry_run:
4415
 
            print 'Dry-run, pretending to remove the above revisions.'
4416
 
            if not force:
4417
 
                val = raw_input('Press <enter> to continue')
 
4813
            self.outf.write('Dry-run, pretending to remove'
 
4814
                            ' the above revisions.\n')
4418
4815
        else:
4419
 
            print 'The above revision(s) will be removed.'
4420
 
            if not force:
4421
 
                val = raw_input('Are you sure [y/N]? ')
4422
 
                if val.lower() not in ('y', 'yes'):
4423
 
                    print 'Canceled'
4424
 
                    return 0
 
4816
            self.outf.write('The above revision(s) will be removed.\n')
 
4817
 
 
4818
        if not force:
 
4819
            if not ui.ui_factory.get_boolean('Are you sure'):
 
4820
                self.outf.write('Canceled')
 
4821
                return 0
4425
4822
 
4426
4823
        mutter('Uncommitting from {%s} to {%s}',
4427
4824
               last_rev_id, rev_id)
4428
4825
        uncommit(b, tree=tree, dry_run=dry_run, verbose=verbose,
4429
4826
                 revno=revno, local=local)
4430
 
        note('You can restore the old tip by running:\n'
4431
 
             '  bzr pull . -r revid:%s', last_rev_id)
 
4827
        self.outf.write('You can restore the old tip by running:\n'
 
4828
             '  bzr pull . -r revid:%s\n' % last_rev_id)
4432
4829
 
4433
4830
 
4434
4831
class cmd_break_lock(Command):
4435
 
    """Break a dead lock on a repository, branch or working directory.
 
4832
    __doc__ = """Break a dead lock on a repository, branch or working directory.
4436
4833
 
4437
4834
    CAUTION: Locks should only be broken when you are sure that the process
4438
4835
    holding the lock has been stopped.
4439
4836
 
4440
 
    You can get information on what locks are open via the 'bzr info' command.
 
4837
    You can get information on what locks are open via the 'bzr info
 
4838
    [location]' command.
4441
4839
 
4442
4840
    :Examples:
4443
4841
        bzr break-lock
 
4842
        bzr break-lock bzr+ssh://example.com/bzr/foo
4444
4843
    """
4445
4844
    takes_args = ['location?']
4446
4845
 
4455
4854
 
4456
4855
 
4457
4856
class cmd_wait_until_signalled(Command):
4458
 
    """Test helper for test_start_and_stop_bzr_subprocess_send_signal.
 
4857
    __doc__ = """Test helper for test_start_and_stop_bzr_subprocess_send_signal.
4459
4858
 
4460
4859
    This just prints a line to signal when it is ready, then blocks on stdin.
4461
4860
    """
4469
4868
 
4470
4869
 
4471
4870
class cmd_serve(Command):
4472
 
    """Run the bzr server."""
 
4871
    __doc__ = """Run the bzr server."""
4473
4872
 
4474
4873
    aliases = ['server']
4475
4874
 
4476
4875
    takes_options = [
4477
4876
        Option('inet',
4478
4877
               help='Serve on stdin/out for use from inetd or sshd.'),
 
4878
        RegistryOption('protocol',
 
4879
               help="Protocol to serve.",
 
4880
               lazy_registry=('bzrlib.transport', 'transport_server_registry'),
 
4881
               value_switches=True),
4479
4882
        Option('port',
4480
4883
               help='Listen for connections on nominated port of the form '
4481
4884
                    '[hostname:]portnumber.  Passing 0 as the port number will '
4482
 
                    'result in a dynamically allocated port.  The default port is '
4483
 
                    '4155.',
 
4885
                    'result in a dynamically allocated port.  The default port '
 
4886
                    'depends on the protocol.',
4484
4887
               type=str),
4485
 
        Option('directory',
4486
 
               help='Serve contents of this directory.',
4487
 
               type=unicode),
 
4888
        custom_help('directory',
 
4889
               help='Serve contents of this directory.'),
4488
4890
        Option('allow-writes',
4489
4891
               help='By default the server is a readonly server.  Supplying '
4490
4892
                    '--allow-writes enables write access to the contents of '
4491
 
                    'the served directory and below.'
 
4893
                    'the served directory and below.  Note that ``bzr serve`` '
 
4894
                    'does not perform authentication, so unless some form of '
 
4895
                    'external authentication is arranged supplying this '
 
4896
                    'option leads to global uncontrolled write access to your '
 
4897
                    'file system.'
4492
4898
                ),
4493
4899
        ]
4494
4900
 
4495
 
    def run_smart_server(self, smart_server):
4496
 
        """Run 'smart_server' forever, with no UI output at all."""
4497
 
        # For the duration of this server, no UI output is permitted. note
4498
 
        # that this may cause problems with blackbox tests. This should be
4499
 
        # changed with care though, as we dont want to use bandwidth sending
4500
 
        # progress over stderr to smart server clients!
4501
 
        from bzrlib import lockdir
4502
 
        old_factory = ui.ui_factory
4503
 
        old_lockdir_timeout = lockdir._DEFAULT_TIMEOUT_SECONDS
4504
 
        try:
4505
 
            ui.ui_factory = ui.SilentUIFactory()
4506
 
            lockdir._DEFAULT_TIMEOUT_SECONDS = 0
4507
 
            smart_server.serve()
4508
 
        finally:
4509
 
            ui.ui_factory = old_factory
4510
 
            lockdir._DEFAULT_TIMEOUT_SECONDS = old_lockdir_timeout
4511
 
 
4512
4901
    def get_host_and_port(self, port):
4513
4902
        """Return the host and port to run the smart server on.
4514
4903
 
4515
 
        If 'port' is None, the default host (`medium.BZR_DEFAULT_INTERFACE`)
4516
 
        and port (`medium.BZR_DEFAULT_PORT`) will be used.
 
4904
        If 'port' is None, None will be returned for the host and port.
4517
4905
 
4518
4906
        If 'port' has a colon in it, the string before the colon will be
4519
4907
        interpreted as the host.
4522
4910
        :return: A tuple of (host, port), where 'host' is a host name or IP,
4523
4911
            and port is an integer TCP/IP port.
4524
4912
        """
4525
 
        from bzrlib.smart import medium
4526
 
        host = medium.BZR_DEFAULT_INTERFACE
4527
 
        if port is None:
4528
 
            port = medium.BZR_DEFAULT_PORT
4529
 
        else:
 
4913
        host = None
 
4914
        if port is not None:
4530
4915
            if ':' in port:
4531
4916
                host, port = port.split(':')
4532
4917
            port = int(port)
4533
4918
        return host, port
4534
4919
 
4535
 
    def get_smart_server(self, transport, inet, port):
4536
 
        """Construct a smart server.
4537
 
 
4538
 
        :param transport: The base transport from which branches will be
4539
 
            served.
4540
 
        :param inet: If True, serve over stdin and stdout. Used for running
4541
 
            from inet.
4542
 
        :param port: The port to listen on. By default, it's `
4543
 
            medium.BZR_DEFAULT_PORT`. See `get_host_and_port` for more
4544
 
            information.
4545
 
        :return: A smart server.
4546
 
        """
4547
 
        from bzrlib.smart import medium, server
4548
 
        if inet:
4549
 
            smart_server = medium.SmartServerPipeStreamMedium(
4550
 
                sys.stdin, sys.stdout, transport)
4551
 
        else:
4552
 
            host, port = self.get_host_and_port(port)
4553
 
            smart_server = server.SmartTCPServer(
4554
 
                transport, host=host, port=port)
4555
 
            note('listening on port: %s' % smart_server.port)
4556
 
        return smart_server
4557
 
 
4558
 
    def run(self, port=None, inet=False, directory=None, allow_writes=False):
4559
 
        from bzrlib.transport import get_transport
4560
 
        from bzrlib.transport.chroot import ChrootServer
 
4920
    def run(self, port=None, inet=False, directory=None, allow_writes=False,
 
4921
            protocol=None):
 
4922
        from bzrlib import transport
4561
4923
        if directory is None:
4562
4924
            directory = os.getcwd()
 
4925
        if protocol is None:
 
4926
            protocol = transport.transport_server_registry.get()
 
4927
        host, port = self.get_host_and_port(port)
4563
4928
        url = urlutils.local_path_to_url(directory)
4564
4929
        if not allow_writes:
4565
4930
            url = 'readonly+' + url
4566
 
        chroot_server = ChrootServer(get_transport(url))
4567
 
        chroot_server.setUp()
4568
 
        t = get_transport(chroot_server.get_url())
4569
 
        smart_server = self.get_smart_server(t, inet, port)
4570
 
        self.run_smart_server(smart_server)
 
4931
        t = transport.get_transport(url)
 
4932
        protocol(t, host, port, inet)
4571
4933
 
4572
4934
 
4573
4935
class cmd_join(Command):
4574
 
    """Combine a tree into its containing tree.
 
4936
    __doc__ = """Combine a tree into its containing tree.
4575
4937
 
4576
4938
    This command requires the target tree to be in a rich-root format.
4577
4939
 
4617
4979
 
4618
4980
 
4619
4981
class cmd_split(Command):
4620
 
    """Split a subdirectory of a tree into a separate tree.
 
4982
    __doc__ = """Split a subdirectory of a tree into a separate tree.
4621
4983
 
4622
4984
    This command will produce a target tree in a format that supports
4623
4985
    rich roots, like 'rich-root' or 'rich-root-pack'.  These formats cannot be
4639
5001
        try:
4640
5002
            containing_tree.extract(sub_id)
4641
5003
        except errors.RootNotRich:
4642
 
            raise errors.UpgradeRequired(containing_tree.branch.base)
 
5004
            raise errors.RichRootUpgradeRequired(containing_tree.branch.base)
4643
5005
 
4644
5006
 
4645
5007
class cmd_merge_directive(Command):
4646
 
    """Generate a merge directive for auto-merge tools.
 
5008
    __doc__ = """Generate a merge directive for auto-merge tools.
4647
5009
 
4648
5010
    A directive requests a merge to be performed, and also provides all the
4649
5011
    information necessary to do so.  This means it must either include a
4666
5028
    _see_also = ['send']
4667
5029
 
4668
5030
    takes_options = [
 
5031
        'directory',
4669
5032
        RegistryOption.from_kwargs('patch-type',
4670
5033
            'The type of patch to include in the directive.',
4671
5034
            title='Patch type',
4684
5047
    encoding_type = 'exact'
4685
5048
 
4686
5049
    def run(self, submit_branch=None, public_branch=None, patch_type='bundle',
4687
 
            sign=False, revision=None, mail_to=None, message=None):
 
5050
            sign=False, revision=None, mail_to=None, message=None,
 
5051
            directory=u'.'):
4688
5052
        from bzrlib.revision import ensure_null, NULL_REVISION
4689
5053
        include_patch, include_bundle = {
4690
5054
            'plain': (False, False),
4691
5055
            'diff': (True, False),
4692
5056
            'bundle': (True, True),
4693
5057
            }[patch_type]
4694
 
        branch = Branch.open('.')
 
5058
        branch = Branch.open(directory)
4695
5059
        stored_submit_branch = branch.get_submit_branch()
4696
5060
        if submit_branch is None:
4697
5061
            submit_branch = stored_submit_branch
4742
5106
 
4743
5107
 
4744
5108
class cmd_send(Command):
4745
 
    """Mail or create a merge-directive for submitting changes.
 
5109
    __doc__ = """Mail or create a merge-directive for submitting changes.
4746
5110
 
4747
5111
    A merge directive provides many things needed for requesting merges:
4748
5112
 
4754
5118
      directly from the merge directive, without retrieving data from a
4755
5119
      branch.
4756
5120
 
4757
 
    If --no-bundle is specified, then public_branch is needed (and must be
4758
 
    up-to-date), so that the receiver can perform the merge using the
4759
 
    public_branch.  The public_branch is always included if known, so that
4760
 
    people can check it later.
4761
 
 
4762
 
    The submit branch defaults to the parent, but can be overridden.  Both
4763
 
    submit branch and public branch will be remembered if supplied.
4764
 
 
4765
 
    If a public_branch is known for the submit_branch, that public submit
4766
 
    branch is used in the merge instructions.  This means that a local mirror
4767
 
    can be used as your actual submit branch, once you have set public_branch
4768
 
    for that mirror.
 
5121
    `bzr send` creates a compact data set that, when applied using bzr
 
5122
    merge, has the same effect as merging from the source branch.  
 
5123
    
 
5124
    By default the merge directive is self-contained and can be applied to any
 
5125
    branch containing submit_branch in its ancestory without needing access to
 
5126
    the source branch.
 
5127
    
 
5128
    If --no-bundle is specified, then Bazaar doesn't send the contents of the
 
5129
    revisions, but only a structured request to merge from the
 
5130
    public_location.  In that case the public_branch is needed and it must be
 
5131
    up-to-date and accessible to the recipient.  The public_branch is always
 
5132
    included if known, so that people can check it later.
 
5133
 
 
5134
    The submit branch defaults to the parent of the source branch, but can be
 
5135
    overridden.  Both submit branch and public branch will be remembered in
 
5136
    branch.conf the first time they are used for a particular branch.  The
 
5137
    source branch defaults to that containing the working directory, but can
 
5138
    be changed using --from.
 
5139
 
 
5140
    In order to calculate those changes, bzr must analyse the submit branch.
 
5141
    Therefore it is most efficient for the submit branch to be a local mirror.
 
5142
    If a public location is known for the submit_branch, that location is used
 
5143
    in the merge directive.
 
5144
 
 
5145
    The default behaviour is to send the merge directive by mail, unless -o is
 
5146
    given, in which case it is sent to a file.
4769
5147
 
4770
5148
    Mail is sent using your preferred mail program.  This should be transparent
4771
 
    on Windows (it uses MAPI).  On Linux, it requires the xdg-email utility.
 
5149
    on Windows (it uses MAPI).  On Unix, it requires the xdg-email utility.
4772
5150
    If the preferred client can't be found (or used), your editor will be used.
4773
5151
 
4774
5152
    To use a specific mail program, set the mail_client configuration option.
4775
5153
    (For Thunderbird 1.5, this works around some bugs.)  Supported values for
4776
 
    specific clients are "claws", "evolution", "kmail", "mutt", and
4777
 
    "thunderbird"; generic options are "default", "editor", "emacsclient",
4778
 
    "mapi", and "xdg-email".  Plugins may also add supported clients.
 
5154
    specific clients are "claws", "evolution", "kmail", "mail.app" (MacOS X's
 
5155
    Mail.app), "mutt", and "thunderbird"; generic options are "default",
 
5156
    "editor", "emacsclient", "mapi", and "xdg-email".  Plugins may also add
 
5157
    supported clients.
4779
5158
 
4780
5159
    If mail is being sent, a to address is required.  This can be supplied
4781
5160
    either on the commandline, by setting the submit_to configuration
4790
5169
 
4791
5170
    The merge directives created by bzr send may be applied using bzr merge or
4792
5171
    bzr pull by specifying a file containing a merge directive as the location.
 
5172
 
 
5173
    bzr send makes extensive use of public locations to map local locations into
 
5174
    URLs that can be used by other people.  See `bzr help configuration` to
 
5175
    set them, and use `bzr info` to display them.
4793
5176
    """
4794
5177
 
4795
5178
    encoding_type = 'exact'
4811
5194
               short_name='f',
4812
5195
               type=unicode),
4813
5196
        Option('output', short_name='o',
4814
 
               help='Write merge directive to this file; '
 
5197
               help='Write merge directive to this file or directory; '
4815
5198
                    'use - for stdout.',
4816
5199
               type=unicode),
 
5200
        Option('strict',
 
5201
               help='Refuse to send if there are uncommitted changes in'
 
5202
               ' the working tree, --no-strict disables the check.'),
4817
5203
        Option('mail-to', help='Mail the request to this address.',
4818
5204
               type=unicode),
4819
5205
        'revision',
4820
5206
        'message',
4821
5207
        Option('body', help='Body for the email.', type=unicode),
4822
 
        RegistryOption.from_kwargs('format',
4823
 
        'Use the specified output format.',
4824
 
        **{'4': 'Bundle format 4, Merge Directive 2 (default)',
4825
 
           '0.9': 'Bundle format 0.9, Merge Directive 1',})
 
5208
        RegistryOption('format',
 
5209
                       help='Use the specified output format.',
 
5210
                       lazy_registry=('bzrlib.send', 'format_registry')),
4826
5211
        ]
4827
5212
 
4828
5213
    def run(self, submit_branch=None, public_branch=None, no_bundle=False,
4829
5214
            no_patch=False, revision=None, remember=False, output=None,
4830
 
            format='4', mail_to=None, message=None, body=None, **kwargs):
4831
 
        return self._run(submit_branch, revision, public_branch, remember,
4832
 
                         format, no_bundle, no_patch, output,
4833
 
                         kwargs.get('from', '.'), mail_to, message, body)
4834
 
 
4835
 
    def _run(self, submit_branch, revision, public_branch, remember, format,
4836
 
             no_bundle, no_patch, output, from_, mail_to, message, body):
4837
 
        from bzrlib.revision import NULL_REVISION
4838
 
        branch = Branch.open_containing(from_)[0]
4839
 
        if output is None:
4840
 
            outfile = cStringIO.StringIO()
4841
 
        elif output == '-':
4842
 
            outfile = self.outf
4843
 
        else:
4844
 
            outfile = open(output, 'wb')
4845
 
        # we may need to write data into branch's repository to calculate
4846
 
        # the data to send.
4847
 
        branch.lock_write()
4848
 
        try:
4849
 
            if output is None:
4850
 
                config = branch.get_config()
4851
 
                if mail_to is None:
4852
 
                    mail_to = config.get_user_option('submit_to')
4853
 
                mail_client = config.get_mail_client()
4854
 
                if (not getattr(mail_client, 'supports_body', False)
4855
 
                    and body is not None):
4856
 
                    raise errors.BzrCommandError(
4857
 
                        'Mail client "%s" does not support specifying body' %
4858
 
                        mail_client.__class__.__name__)
4859
 
            if remember and submit_branch is None:
4860
 
                raise errors.BzrCommandError(
4861
 
                    '--remember requires a branch to be specified.')
4862
 
            stored_submit_branch = branch.get_submit_branch()
4863
 
            remembered_submit_branch = None
4864
 
            if submit_branch is None:
4865
 
                submit_branch = stored_submit_branch
4866
 
                remembered_submit_branch = "submit"
4867
 
            else:
4868
 
                if stored_submit_branch is None or remember:
4869
 
                    branch.set_submit_branch(submit_branch)
4870
 
            if submit_branch is None:
4871
 
                submit_branch = branch.get_parent()
4872
 
                remembered_submit_branch = "parent"
4873
 
            if submit_branch is None:
4874
 
                raise errors.BzrCommandError('No submit branch known or'
4875
 
                                             ' specified')
4876
 
            if remembered_submit_branch is not None:
4877
 
                note('Using saved %s location "%s" to determine what '
4878
 
                        'changes to submit.', remembered_submit_branch,
4879
 
                        submit_branch)
4880
 
 
4881
 
            if mail_to is None:
4882
 
                submit_config = Branch.open(submit_branch).get_config()
4883
 
                mail_to = submit_config.get_user_option("child_submit_to")
4884
 
 
4885
 
            stored_public_branch = branch.get_public_branch()
4886
 
            if public_branch is None:
4887
 
                public_branch = stored_public_branch
4888
 
            elif stored_public_branch is None or remember:
4889
 
                branch.set_public_branch(public_branch)
4890
 
            if no_bundle and public_branch is None:
4891
 
                raise errors.BzrCommandError('No public branch specified or'
4892
 
                                             ' known')
4893
 
            base_revision_id = None
4894
 
            revision_id = None
4895
 
            if revision is not None:
4896
 
                if len(revision) > 2:
4897
 
                    raise errors.BzrCommandError('bzr send takes '
4898
 
                        'at most two one revision identifiers')
4899
 
                revision_id = revision[-1].as_revision_id(branch)
4900
 
                if len(revision) == 2:
4901
 
                    base_revision_id = revision[0].as_revision_id(branch)
4902
 
            if revision_id is None:
4903
 
                revision_id = branch.last_revision()
4904
 
            if revision_id == NULL_REVISION:
4905
 
                raise errors.BzrCommandError('No revisions to submit.')
4906
 
            if format == '4':
4907
 
                directive = merge_directive.MergeDirective2.from_objects(
4908
 
                    branch.repository, revision_id, time.time(),
4909
 
                    osutils.local_time_offset(), submit_branch,
4910
 
                    public_branch=public_branch, include_patch=not no_patch,
4911
 
                    include_bundle=not no_bundle, message=message,
4912
 
                    base_revision_id=base_revision_id)
4913
 
            elif format == '0.9':
4914
 
                if not no_bundle:
4915
 
                    if not no_patch:
4916
 
                        patch_type = 'bundle'
4917
 
                    else:
4918
 
                        raise errors.BzrCommandError('Format 0.9 does not'
4919
 
                            ' permit bundle with no patch')
4920
 
                else:
4921
 
                    if not no_patch:
4922
 
                        patch_type = 'diff'
4923
 
                    else:
4924
 
                        patch_type = None
4925
 
                directive = merge_directive.MergeDirective.from_objects(
4926
 
                    branch.repository, revision_id, time.time(),
4927
 
                    osutils.local_time_offset(), submit_branch,
4928
 
                    public_branch=public_branch, patch_type=patch_type,
4929
 
                    message=message)
4930
 
 
4931
 
            outfile.writelines(directive.to_lines())
4932
 
            if output is None:
4933
 
                subject = '[MERGE] '
4934
 
                if message is not None:
4935
 
                    subject += message
4936
 
                else:
4937
 
                    revision = branch.repository.get_revision(revision_id)
4938
 
                    subject += revision.get_summary()
4939
 
                basename = directive.get_disk_name(branch)
4940
 
                mail_client.compose_merge_request(mail_to, subject,
4941
 
                                                  outfile.getvalue(),
4942
 
                                                  basename, body)
4943
 
        finally:
4944
 
            if output != '-':
4945
 
                outfile.close()
4946
 
            branch.unlock()
 
5215
            format=None, mail_to=None, message=None, body=None,
 
5216
            strict=None, **kwargs):
 
5217
        from bzrlib.send import send
 
5218
        return send(submit_branch, revision, public_branch, remember,
 
5219
                    format, no_bundle, no_patch, output,
 
5220
                    kwargs.get('from', '.'), mail_to, message, body,
 
5221
                    self.outf,
 
5222
                    strict=strict)
4947
5223
 
4948
5224
 
4949
5225
class cmd_bundle_revisions(cmd_send):
4950
 
 
4951
 
    """Create a merge-directive for submitting changes.
 
5226
    __doc__ = """Create a merge-directive for submitting changes.
4952
5227
 
4953
5228
    A merge directive provides many things needed for requesting merges:
4954
5229
 
4994
5269
               type=unicode),
4995
5270
        Option('output', short_name='o', help='Write directive to this file.',
4996
5271
               type=unicode),
 
5272
        Option('strict',
 
5273
               help='Refuse to bundle revisions if there are uncommitted'
 
5274
               ' changes in the working tree, --no-strict disables the check.'),
4997
5275
        'revision',
4998
 
        RegistryOption.from_kwargs('format',
4999
 
        'Use the specified output format.',
5000
 
        **{'4': 'Bundle format 4, Merge Directive 2 (default)',
5001
 
           '0.9': 'Bundle format 0.9, Merge Directive 1',})
 
5276
        RegistryOption('format',
 
5277
                       help='Use the specified output format.',
 
5278
                       lazy_registry=('bzrlib.send', 'format_registry')),
5002
5279
        ]
5003
5280
    aliases = ['bundle']
5004
5281
 
5008
5285
 
5009
5286
    def run(self, submit_branch=None, public_branch=None, no_bundle=False,
5010
5287
            no_patch=False, revision=None, remember=False, output=None,
5011
 
            format='4', **kwargs):
 
5288
            format=None, strict=None, **kwargs):
5012
5289
        if output is None:
5013
5290
            output = '-'
5014
 
        return self._run(submit_branch, revision, public_branch, remember,
 
5291
        from bzrlib.send import send
 
5292
        return send(submit_branch, revision, public_branch, remember,
5015
5293
                         format, no_bundle, no_patch, output,
5016
 
                         kwargs.get('from', '.'), None, None, None)
 
5294
                         kwargs.get('from', '.'), None, None, None,
 
5295
                         self.outf, strict=strict)
5017
5296
 
5018
5297
 
5019
5298
class cmd_tag(Command):
5020
 
    """Create, remove or modify a tag naming a revision.
 
5299
    __doc__ = """Create, remove or modify a tag naming a revision.
5021
5300
 
5022
5301
    Tags give human-meaningful names to revisions.  Commands that take a -r
5023
5302
    (--revision) option can be given -rtag:X, where X is any previously
5031
5310
 
5032
5311
    To rename a tag (change the name but keep it on the same revsion), run ``bzr
5033
5312
    tag new-name -r tag:old-name`` and then ``bzr tag --delete oldname``.
 
5313
 
 
5314
    If no tag name is specified it will be determined through the 
 
5315
    'automatic_tag_name' hook. This can e.g. be used to automatically tag
 
5316
    upstream releases by reading configure.ac. See ``bzr help hooks`` for
 
5317
    details.
5034
5318
    """
5035
5319
 
5036
5320
    _see_also = ['commit', 'tags']
5037
 
    takes_args = ['tag_name']
 
5321
    takes_args = ['tag_name?']
5038
5322
    takes_options = [
5039
5323
        Option('delete',
5040
5324
            help='Delete this tag rather than placing it.',
5041
5325
            ),
5042
 
        Option('directory',
5043
 
            help='Branch in which to place the tag.',
5044
 
            short_name='d',
5045
 
            type=unicode,
5046
 
            ),
 
5326
        custom_help('directory',
 
5327
            help='Branch in which to place the tag.'),
5047
5328
        Option('force',
5048
5329
            help='Replace existing tags.',
5049
5330
            ),
5050
5331
        'revision',
5051
5332
        ]
5052
5333
 
5053
 
    def run(self, tag_name,
 
5334
    def run(self, tag_name=None,
5054
5335
            delete=None,
5055
5336
            directory='.',
5056
5337
            force=None,
5057
5338
            revision=None,
5058
5339
            ):
5059
5340
        branch, relpath = Branch.open_containing(directory)
5060
 
        branch.lock_write()
5061
 
        try:
5062
 
            if delete:
5063
 
                branch.tags.delete_tag(tag_name)
5064
 
                self.outf.write('Deleted tag %s.\n' % tag_name)
 
5341
        self.add_cleanup(branch.lock_write().unlock)
 
5342
        if delete:
 
5343
            if tag_name is None:
 
5344
                raise errors.BzrCommandError("No tag specified to delete.")
 
5345
            branch.tags.delete_tag(tag_name)
 
5346
            self.outf.write('Deleted tag %s.\n' % tag_name)
 
5347
        else:
 
5348
            if revision:
 
5349
                if len(revision) != 1:
 
5350
                    raise errors.BzrCommandError(
 
5351
                        "Tags can only be placed on a single revision, "
 
5352
                        "not on a range")
 
5353
                revision_id = revision[0].as_revision_id(branch)
5065
5354
            else:
5066
 
                if revision:
5067
 
                    if len(revision) != 1:
5068
 
                        raise errors.BzrCommandError(
5069
 
                            "Tags can only be placed on a single revision, "
5070
 
                            "not on a range")
5071
 
                    revision_id = revision[0].as_revision_id(branch)
5072
 
                else:
5073
 
                    revision_id = branch.last_revision()
5074
 
                if (not force) and branch.tags.has_tag(tag_name):
5075
 
                    raise errors.TagAlreadyExists(tag_name)
5076
 
                branch.tags.set_tag(tag_name, revision_id)
5077
 
                self.outf.write('Created tag %s.\n' % tag_name)
5078
 
        finally:
5079
 
            branch.unlock()
 
5355
                revision_id = branch.last_revision()
 
5356
            if tag_name is None:
 
5357
                tag_name = branch.automatic_tag_name(revision_id)
 
5358
                if tag_name is None:
 
5359
                    raise errors.BzrCommandError(
 
5360
                        "Please specify a tag name.")
 
5361
            if (not force) and branch.tags.has_tag(tag_name):
 
5362
                raise errors.TagAlreadyExists(tag_name)
 
5363
            branch.tags.set_tag(tag_name, revision_id)
 
5364
            self.outf.write('Created tag %s.\n' % tag_name)
5080
5365
 
5081
5366
 
5082
5367
class cmd_tags(Command):
5083
 
    """List tags.
 
5368
    __doc__ = """List tags.
5084
5369
 
5085
5370
    This command shows a table of tag names and the revisions they reference.
5086
5371
    """
5087
5372
 
5088
5373
    _see_also = ['tag']
5089
5374
    takes_options = [
5090
 
        Option('directory',
5091
 
            help='Branch whose tags should be displayed.',
5092
 
            short_name='d',
5093
 
            type=unicode,
5094
 
            ),
 
5375
        custom_help('directory',
 
5376
            help='Branch whose tags should be displayed.'),
5095
5377
        RegistryOption.from_kwargs('sort',
5096
5378
            'Sort tags by different criteria.', title='Sorting',
5097
5379
            alpha='Sort tags lexicographically (default).',
5114
5396
        if not tags:
5115
5397
            return
5116
5398
 
 
5399
        self.add_cleanup(branch.lock_read().unlock)
5117
5400
        if revision:
5118
 
            branch.lock_read()
5119
 
            try:
5120
 
                graph = branch.repository.get_graph()
5121
 
                rev1, rev2 = _get_revision_range(revision, branch, self.name())
5122
 
                revid1, revid2 = rev1.rev_id, rev2.rev_id
5123
 
                # only show revisions between revid1 and revid2 (inclusive)
5124
 
                tags = [(tag, revid) for tag, revid in tags if
5125
 
                    graph.is_between(revid, revid1, revid2)]
5126
 
            finally:
5127
 
                branch.unlock()
 
5401
            graph = branch.repository.get_graph()
 
5402
            rev1, rev2 = _get_revision_range(revision, branch, self.name())
 
5403
            revid1, revid2 = rev1.rev_id, rev2.rev_id
 
5404
            # only show revisions between revid1 and revid2 (inclusive)
 
5405
            tags = [(tag, revid) for tag, revid in tags if
 
5406
                graph.is_between(revid, revid1, revid2)]
5128
5407
        if sort == 'alpha':
5129
5408
            tags.sort()
5130
5409
        elif sort == 'time':
5140
5419
            tags.sort(key=lambda x: timestamps[x[1]])
5141
5420
        if not show_ids:
5142
5421
            # [ (tag, revid), ... ] -> [ (tag, dotted_revno), ... ]
5143
 
            revno_map = branch.get_revision_id_to_revno_map()
5144
 
            tags = [ (tag, '.'.join(map(str, revno_map.get(revid, ('?',)))))
5145
 
                        for tag, revid in tags ]
 
5422
            for index, (tag, revid) in enumerate(tags):
 
5423
                try:
 
5424
                    revno = branch.revision_id_to_dotted_revno(revid)
 
5425
                    if isinstance(revno, tuple):
 
5426
                        revno = '.'.join(map(str, revno))
 
5427
                except errors.NoSuchRevision:
 
5428
                    # Bad tag data/merges can lead to tagged revisions
 
5429
                    # which are not in this branch. Fail gracefully ...
 
5430
                    revno = '?'
 
5431
                tags[index] = (tag, revno)
 
5432
        self.cleanup_now()
5146
5433
        for tag, revspec in tags:
5147
5434
            self.outf.write('%-20s %s\n' % (tag, revspec))
5148
5435
 
5149
5436
 
5150
5437
class cmd_reconfigure(Command):
5151
 
    """Reconfigure the type of a bzr directory.
 
5438
    __doc__ = """Reconfigure the type of a bzr directory.
5152
5439
 
5153
5440
    A target configuration must be specified.
5154
5441
 
5184
5471
            ),
5185
5472
        Option('bind-to', help='Branch to bind checkout to.', type=str),
5186
5473
        Option('force',
5187
 
               help='Perform reconfiguration even if local changes'
5188
 
               ' will be lost.')
 
5474
            help='Perform reconfiguration even if local changes'
 
5475
            ' will be lost.'),
 
5476
        Option('stacked-on',
 
5477
            help='Reconfigure a branch to be stacked on another branch.',
 
5478
            type=unicode,
 
5479
            ),
 
5480
        Option('unstacked',
 
5481
            help='Reconfigure a branch to be unstacked.  This '
 
5482
                'may require copying substantial data into it.',
 
5483
            ),
5189
5484
        ]
5190
5485
 
5191
 
    def run(self, location=None, target_type=None, bind_to=None, force=False):
 
5486
    def run(self, location=None, target_type=None, bind_to=None, force=False,
 
5487
            stacked_on=None,
 
5488
            unstacked=None):
5192
5489
        directory = bzrdir.BzrDir.open(location)
 
5490
        if stacked_on and unstacked:
 
5491
            raise BzrCommandError("Can't use both --stacked-on and --unstacked")
 
5492
        elif stacked_on is not None:
 
5493
            reconfigure.ReconfigureStackedOn().apply(directory, stacked_on)
 
5494
        elif unstacked:
 
5495
            reconfigure.ReconfigureUnstacked().apply(directory)
 
5496
        # At the moment you can use --stacked-on and a different
 
5497
        # reconfiguration shape at the same time; there seems no good reason
 
5498
        # to ban it.
5193
5499
        if target_type is None:
5194
 
            raise errors.BzrCommandError('No target configuration specified')
 
5500
            if stacked_on or unstacked:
 
5501
                return
 
5502
            else:
 
5503
                raise errors.BzrCommandError('No target configuration '
 
5504
                    'specified')
5195
5505
        elif target_type == 'branch':
5196
5506
            reconfiguration = reconfigure.Reconfigure.to_branch(directory)
5197
5507
        elif target_type == 'tree':
5216
5526
 
5217
5527
 
5218
5528
class cmd_switch(Command):
5219
 
    """Set the branch of a checkout and update.
 
5529
    __doc__ = """Set the branch of a checkout and update.
5220
5530
 
5221
5531
    For lightweight checkouts, this changes the branch being referenced.
5222
5532
    For heavyweight checkouts, this checks that there are no local commits
5234
5544
    /path/to/newbranch.
5235
5545
 
5236
5546
    Bound branches use the nickname of its master branch unless it is set
5237
 
    locally, in which case switching will update the the local nickname to be
 
5547
    locally, in which case switching will update the local nickname to be
5238
5548
    that of the master.
5239
5549
    """
5240
5550
 
5241
 
    takes_args = ['to_location']
5242
 
    takes_options = [Option('force',
5243
 
                        help='Switch even if local commits will be lost.')
5244
 
                     ]
 
5551
    takes_args = ['to_location?']
 
5552
    takes_options = ['directory',
 
5553
                     Option('force',
 
5554
                        help='Switch even if local commits will be lost.'),
 
5555
                     'revision',
 
5556
                     Option('create-branch', short_name='b',
 
5557
                        help='Create the target branch from this one before'
 
5558
                             ' switching to it.'),
 
5559
                    ]
5245
5560
 
5246
 
    def run(self, to_location, force=False):
 
5561
    def run(self, to_location=None, force=False, create_branch=False,
 
5562
            revision=None, directory=u'.'):
5247
5563
        from bzrlib import switch
5248
 
        tree_location = '.'
 
5564
        tree_location = directory
 
5565
        revision = _get_one_revision('switch', revision)
5249
5566
        control_dir = bzrdir.BzrDir.open_containing(tree_location)[0]
5250
 
        branch = control_dir.open_branch()
 
5567
        if to_location is None:
 
5568
            if revision is None:
 
5569
                raise errors.BzrCommandError('You must supply either a'
 
5570
                                             ' revision or a location')
 
5571
            to_location = tree_location
5251
5572
        try:
5252
 
            to_branch = Branch.open(to_location)
 
5573
            branch = control_dir.open_branch()
 
5574
            had_explicit_nick = branch.get_config().has_explicit_nickname()
5253
5575
        except errors.NotBranchError:
5254
 
            this_branch = control_dir.open_branch()
5255
 
            # This may be a heavy checkout, where we want the master branch
5256
 
            this_url = this_branch.get_bound_location()
5257
 
            # If not, use a local sibling
5258
 
            if this_url is None:
5259
 
                this_url = this_branch.base
5260
 
            to_branch = Branch.open(
5261
 
                urlutils.join(this_url, '..', to_location))
5262
 
        switch.switch(control_dir, to_branch, force)
5263
 
        if branch.get_config().has_explicit_nickname():
 
5576
            branch = None
 
5577
            had_explicit_nick = False
 
5578
        if create_branch:
 
5579
            if branch is None:
 
5580
                raise errors.BzrCommandError('cannot create branch without'
 
5581
                                             ' source branch')
 
5582
            to_location = directory_service.directories.dereference(
 
5583
                              to_location)
 
5584
            if '/' not in to_location and '\\' not in to_location:
 
5585
                # This path is meant to be relative to the existing branch
 
5586
                this_url = self._get_branch_location(control_dir)
 
5587
                to_location = urlutils.join(this_url, '..', to_location)
 
5588
            to_branch = branch.bzrdir.sprout(to_location,
 
5589
                                 possible_transports=[branch.bzrdir.root_transport],
 
5590
                                 source_branch=branch).open_branch()
 
5591
        else:
 
5592
            try:
 
5593
                to_branch = Branch.open(to_location)
 
5594
            except errors.NotBranchError:
 
5595
                this_url = self._get_branch_location(control_dir)
 
5596
                to_branch = Branch.open(
 
5597
                    urlutils.join(this_url, '..', to_location))
 
5598
        if revision is not None:
 
5599
            revision = revision.as_revision_id(to_branch)
 
5600
        switch.switch(control_dir, to_branch, force, revision_id=revision)
 
5601
        if had_explicit_nick:
5264
5602
            branch = control_dir.open_branch() #get the new branch!
5265
5603
            branch.nick = to_branch.nick
5266
5604
        note('Switched to branch: %s',
5267
5605
            urlutils.unescape_for_display(to_branch.base, 'utf-8'))
5268
5606
 
 
5607
    def _get_branch_location(self, control_dir):
 
5608
        """Return location of branch for this control dir."""
 
5609
        try:
 
5610
            this_branch = control_dir.open_branch()
 
5611
            # This may be a heavy checkout, where we want the master branch
 
5612
            master_location = this_branch.get_bound_location()
 
5613
            if master_location is not None:
 
5614
                return master_location
 
5615
            # If not, use a local sibling
 
5616
            return this_branch.base
 
5617
        except errors.NotBranchError:
 
5618
            format = control_dir.find_branch_format()
 
5619
            if getattr(format, 'get_reference', None) is not None:
 
5620
                return format.get_reference(control_dir)
 
5621
            else:
 
5622
                return control_dir.root_transport.base
 
5623
 
5269
5624
 
5270
5625
class cmd_view(Command):
5271
 
    """Manage filtered views.
 
5626
    __doc__ = """Manage filtered views.
5272
5627
 
5273
5628
    Views provide a mask over the tree so that users can focus on
5274
5629
    a subset of a tree when doing their work. After creating a view,
5422
5777
 
5423
5778
 
5424
5779
class cmd_hooks(Command):
5425
 
    """Show hooks."""
 
5780
    __doc__ = """Show hooks."""
5426
5781
 
5427
5782
    hidden = True
5428
5783
 
5441
5796
                    self.outf.write("    <no hooks installed>\n")
5442
5797
 
5443
5798
 
 
5799
class cmd_remove_branch(Command):
 
5800
    __doc__ = """Remove a branch.
 
5801
 
 
5802
    This will remove the branch from the specified location but 
 
5803
    will keep any working tree or repository in place.
 
5804
 
 
5805
    :Examples:
 
5806
 
 
5807
      Remove the branch at repo/trunk::
 
5808
 
 
5809
        bzr remove-branch repo/trunk
 
5810
 
 
5811
    """
 
5812
 
 
5813
    takes_args = ["location?"]
 
5814
 
 
5815
    aliases = ["rmbranch"]
 
5816
 
 
5817
    def run(self, location=None):
 
5818
        if location is None:
 
5819
            location = "."
 
5820
        branch = Branch.open_containing(location)[0]
 
5821
        branch.bzrdir.destroy_branch()
 
5822
        
 
5823
 
5444
5824
class cmd_shelve(Command):
5445
 
    """Temporarily set aside some changes from the current tree.
 
5825
    __doc__ = """Temporarily set aside some changes from the current tree.
5446
5826
 
5447
5827
    Shelve allows you to temporarily put changes you've made "on the shelf",
5448
5828
    ie. out of the way, until a later time when you can bring them back from
5469
5849
    takes_args = ['file*']
5470
5850
 
5471
5851
    takes_options = [
 
5852
        'directory',
5472
5853
        'revision',
5473
5854
        Option('all', help='Shelve all changes.'),
5474
5855
        'message',
5483
5864
    _see_also = ['unshelve']
5484
5865
 
5485
5866
    def run(self, revision=None, all=False, file_list=None, message=None,
5486
 
            writer=None, list=False, destroy=False):
 
5867
            writer=None, list=False, destroy=False, directory=u'.'):
5487
5868
        if list:
5488
5869
            return self.run_for_list()
5489
5870
        from bzrlib.shelf_ui import Shelver
5490
5871
        if writer is None:
5491
5872
            writer = bzrlib.option.diff_writer_registry.get()
5492
5873
        try:
5493
 
            Shelver.from_args(writer(sys.stdout), revision, all, file_list,
5494
 
                              message, destroy=destroy).run()
 
5874
            shelver = Shelver.from_args(writer(sys.stdout), revision, all,
 
5875
                file_list, message, destroy=destroy, directory=directory)
 
5876
            try:
 
5877
                shelver.run()
 
5878
            finally:
 
5879
                shelver.finalize()
5495
5880
        except errors.UserAbort:
5496
5881
            return 0
5497
5882
 
5498
5883
    def run_for_list(self):
5499
5884
        tree = WorkingTree.open_containing('.')[0]
5500
 
        tree.lock_read()
5501
 
        try:
5502
 
            manager = tree.get_shelf_manager()
5503
 
            shelves = manager.active_shelves()
5504
 
            if len(shelves) == 0:
5505
 
                note('No shelved changes.')
5506
 
                return 0
5507
 
            for shelf_id in reversed(shelves):
5508
 
                message = manager.get_metadata(shelf_id).get('message')
5509
 
                if message is None:
5510
 
                    message = '<no message>'
5511
 
                self.outf.write('%3d: %s\n' % (shelf_id, message))
5512
 
            return 1
5513
 
        finally:
5514
 
            tree.unlock()
 
5885
        self.add_cleanup(tree.lock_read().unlock)
 
5886
        manager = tree.get_shelf_manager()
 
5887
        shelves = manager.active_shelves()
 
5888
        if len(shelves) == 0:
 
5889
            note('No shelved changes.')
 
5890
            return 0
 
5891
        for shelf_id in reversed(shelves):
 
5892
            message = manager.get_metadata(shelf_id).get('message')
 
5893
            if message is None:
 
5894
                message = '<no message>'
 
5895
            self.outf.write('%3d: %s\n' % (shelf_id, message))
 
5896
        return 1
5515
5897
 
5516
5898
 
5517
5899
class cmd_unshelve(Command):
5518
 
    """Restore shelved changes.
 
5900
    __doc__ = """Restore shelved changes.
5519
5901
 
5520
5902
    By default, the most recently shelved changes are restored. However if you
5521
5903
    specify a shelf by id those changes will be restored instead.  This works
5524
5906
 
5525
5907
    takes_args = ['shelf_id?']
5526
5908
    takes_options = [
 
5909
        'directory',
5527
5910
        RegistryOption.from_kwargs(
5528
5911
            'action', help="The action to perform.",
5529
5912
            enum_switch=False, value_switches=True,
5530
5913
            apply="Apply changes and remove from the shelf.",
5531
5914
            dry_run="Show changes, but do not apply or remove them.",
5532
 
            delete_only="Delete changes without applying them."
 
5915
            preview="Instead of unshelving the changes, show the diff that "
 
5916
                    "would result from unshelving.",
 
5917
            delete_only="Delete changes without applying them.",
 
5918
            keep="Apply changes but don't delete them.",
5533
5919
        )
5534
5920
    ]
5535
5921
    _see_also = ['shelve']
5536
5922
 
5537
 
    def run(self, shelf_id=None, action='apply'):
 
5923
    def run(self, shelf_id=None, action='apply', directory=u'.'):
5538
5924
        from bzrlib.shelf_ui import Unshelver
5539
 
        Unshelver.from_args(shelf_id, action).run()
 
5925
        unshelver = Unshelver.from_args(shelf_id, action, directory=directory)
 
5926
        try:
 
5927
            unshelver.run()
 
5928
        finally:
 
5929
            unshelver.tree.unlock()
5540
5930
 
5541
5931
 
5542
5932
class cmd_clean_tree(Command):
5543
 
    """Remove unwanted files from working tree.
 
5933
    __doc__ = """Remove unwanted files from working tree.
5544
5934
 
5545
5935
    By default, only unknown files, not ignored files, are deleted.  Versioned
5546
5936
    files are never deleted.
5554
5944
 
5555
5945
    To check what clean-tree will do, use --dry-run.
5556
5946
    """
5557
 
    takes_options = [Option('ignored', help='Delete all ignored files.'),
 
5947
    takes_options = ['directory',
 
5948
                     Option('ignored', help='Delete all ignored files.'),
5558
5949
                     Option('detritus', help='Delete conflict files, merge'
5559
5950
                            ' backups, and failed selftest dirs.'),
5560
5951
                     Option('unknown',
5563
5954
                            ' deleting them.'),
5564
5955
                     Option('force', help='Do not prompt before deleting.')]
5565
5956
    def run(self, unknown=False, ignored=False, detritus=False, dry_run=False,
5566
 
            force=False):
 
5957
            force=False, directory=u'.'):
5567
5958
        from bzrlib.clean_tree import clean_tree
5568
5959
        if not (unknown or ignored or detritus):
5569
5960
            unknown = True
5570
5961
        if dry_run:
5571
5962
            force = True
5572
 
        clean_tree('.', unknown=unknown, ignored=ignored, detritus=detritus,
5573
 
                   dry_run=dry_run, no_prompt=force)
5574
 
 
5575
 
 
5576
 
def _create_prefix(cur_transport):
5577
 
    needed = [cur_transport]
5578
 
    # Recurse upwards until we can create a directory successfully
5579
 
    while True:
5580
 
        new_transport = cur_transport.clone('..')
5581
 
        if new_transport.base == cur_transport.base:
5582
 
            raise errors.BzrCommandError(
5583
 
                "Failed to create path prefix for %s."
5584
 
                % cur_transport.base)
5585
 
        try:
5586
 
            new_transport.mkdir('.')
5587
 
        except errors.NoSuchFile:
5588
 
            needed.append(new_transport)
5589
 
            cur_transport = new_transport
 
5963
        clean_tree(directory, unknown=unknown, ignored=ignored,
 
5964
                   detritus=detritus, dry_run=dry_run, no_prompt=force)
 
5965
 
 
5966
 
 
5967
class cmd_reference(Command):
 
5968
    __doc__ = """list, view and set branch locations for nested trees.
 
5969
 
 
5970
    If no arguments are provided, lists the branch locations for nested trees.
 
5971
    If one argument is provided, display the branch location for that tree.
 
5972
    If two arguments are provided, set the branch location for that tree.
 
5973
    """
 
5974
 
 
5975
    hidden = True
 
5976
 
 
5977
    takes_args = ['path?', 'location?']
 
5978
 
 
5979
    def run(self, path=None, location=None):
 
5980
        branchdir = '.'
 
5981
        if path is not None:
 
5982
            branchdir = path
 
5983
        tree, branch, relpath =(
 
5984
            bzrdir.BzrDir.open_containing_tree_or_branch(branchdir))
 
5985
        if path is not None:
 
5986
            path = relpath
 
5987
        if tree is None:
 
5988
            tree = branch.basis_tree()
 
5989
        if path is None:
 
5990
            info = branch._get_all_reference_info().iteritems()
 
5991
            self._display_reference_info(tree, branch, info)
5590
5992
        else:
5591
 
            break
5592
 
    # Now we only need to create child directories
5593
 
    while needed:
5594
 
        cur_transport = needed.pop()
5595
 
        cur_transport.ensure_base()
5596
 
 
5597
 
 
5598
 
# these get imported and then picked up by the scan for cmd_*
5599
 
# TODO: Some more consistent way to split command definitions across files;
5600
 
# we do need to load at least some information about them to know of
5601
 
# aliases.  ideally we would avoid loading the implementation until the
5602
 
# details were needed.
5603
 
from bzrlib.cmd_version_info import cmd_version_info
5604
 
from bzrlib.conflicts import cmd_resolve, cmd_conflicts, restore
5605
 
from bzrlib.bundle.commands import (
5606
 
    cmd_bundle_info,
5607
 
    )
5608
 
from bzrlib.foreign import cmd_dpush
5609
 
from bzrlib.sign_my_commits import cmd_sign_my_commits
5610
 
from bzrlib.weave_commands import cmd_versionedfile_list, \
5611
 
        cmd_weave_plan_merge, cmd_weave_merge_text
 
5993
            file_id = tree.path2id(path)
 
5994
            if file_id is None:
 
5995
                raise errors.NotVersionedError(path)
 
5996
            if location is None:
 
5997
                info = [(file_id, branch.get_reference_info(file_id))]
 
5998
                self._display_reference_info(tree, branch, info)
 
5999
            else:
 
6000
                branch.set_reference_info(file_id, path, location)
 
6001
 
 
6002
    def _display_reference_info(self, tree, branch, info):
 
6003
        ref_list = []
 
6004
        for file_id, (path, location) in info:
 
6005
            try:
 
6006
                path = tree.id2path(file_id)
 
6007
            except errors.NoSuchId:
 
6008
                pass
 
6009
            ref_list.append((path, location))
 
6010
        for path, location in sorted(ref_list):
 
6011
            self.outf.write('%s %s\n' % (path, location))
 
6012
 
 
6013
 
 
6014
def _register_lazy_builtins():
 
6015
    # register lazy builtins from other modules; called at startup and should
 
6016
    # be only called once.
 
6017
    for (name, aliases, module_name) in [
 
6018
        ('cmd_bundle_info', [], 'bzrlib.bundle.commands'),
 
6019
        ('cmd_dpush', [], 'bzrlib.foreign'),
 
6020
        ('cmd_version_info', [], 'bzrlib.cmd_version_info'),
 
6021
        ('cmd_resolve', ['resolved'], 'bzrlib.conflicts'),
 
6022
        ('cmd_conflicts', [], 'bzrlib.conflicts'),
 
6023
        ('cmd_sign_my_commits', [], 'bzrlib.sign_my_commits'),
 
6024
        ]:
 
6025
        builtin_command_registry.register_lazy(name, aliases, module_name)