← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/builtins.py

  • Committer: Robert Collins
  • Date: 2010-06-28 02:41:22 UTC
  • mto: This revision was merged to the branch mainline in revision 5324.
  • Revision ID: robertc@robertcollins.net-20100628024122-g951fzp74f3u6wst
Sanity check that new_trace_file in pop_log_file is valid, and also fix a test that monkey patched get_terminal_encoding.

Show diffs side-by-side

added added

removed removed

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