/brz/remove-bazaar

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

« back to all changes in this revision

Viewing changes to bzrlib/builtins.py

  • Committer: Canonical.com Patch Queue Manager
  • Date: 2009-04-09 20:23:07 UTC
  • mfrom: (4265.1.4 bbc-merge)
  • Revision ID: pqm@pqm.ubuntu.com-20090409202307-n0depb16qepoe21o
(jam) Change _fetch_uses_deltas = False for CHK repos until we can
        write a better fix.

Show diffs side-by-side

added added

removed removed

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